erchef-solr 11.4.0

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,66 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2008, 2010 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require File.dirname(__FILE__) + '/lib/chef/solr/version'
+
+require 'rubygems'
+require 'rake'
+require 'rubygems/package_task'
+require '../chef/tasks/rspec.rb'
+
+spec = eval(File.read(File.dirname(__FILE__) + "/chef-solr.gemspec"))
+
+desc "Create solr archives"
+task :tar_solr do
+  %w{solr-home solr-jetty}.each do |tar|
+    Dir.chdir(File.dirname(__FILE__) + "/solr/#{tar}") { sh "tar cvzf ../#{tar}.tar.gz *" }
+  end
+end
+
+task :gem => :tar_solr
+
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem"
+task :install => :package do
+  sh %{gem install pkg/chef-solr-#{Chef::Solr::VERSION} --no-rdoc --no-ri}
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  sh %{gem uninstall chef-solr -x -v #{Chef::Solr::VERSION} }
+end
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = Chef::Solr::VERSION
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "chef-solr #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :spec

data/bin/chef-solr

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2009 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "chef", "lib")))
+
+require 'rubygems'
+require 'chef/solr/application/solr'
+
+Chef::Solr::Application::Solr.new.run
+

data/bin/chef-solr-installer

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+#
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2009, 2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'rubygems'
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+$:.unshift(File.expand_path('../../../chef/lib', __FILE__))
+require 'chef/solr/solr_installer'
+
+Chef::SolrInstaller.new(ARGV).run
+

data/lib/chef/solr.rb

@@ -0,0 +1 @@
+require 'chef/solr/version'

data/lib/chef/solr/application/solr.rb

@@ -0,0 +1,275 @@
+#
+# Author:: AJ Christensen (<aj@opscode.com)
+# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require 'rexml/document'
+require 'chef/log'
+require 'chef/config'
+require 'chef/application'
+require 'chef/daemon'
+require 'chef/solr'
+
+class Chef
+  class Solr
+    class Application
+      class Solr < Chef::Application
+
+        attr_accessor :logfile
+
+        option :config_file,
+          :short => "-c CONFIG",
+          :long  => "--config CONFIG",
+          :default => "/etc/chef/solr.rb",
+          :description => "The configuration file to use"
+
+        option :log_level,
+          :short        => "-l LEVEL",
+          :long         => "--log_level LEVEL",
+          :description  => "Set the log level (debug, info, warn, error, fatal)",
+          :proc         => lambda { |l| l.to_sym }
+
+        option :log_location,
+          :short        => "-L LOGLOCATION",
+          :long         => "--logfile LOGLOCATION",
+          :description  => "Set the log file location, defaults to STDOUT - recommended for daemonizing",
+          :proc         => nil
+
+        option :pid_file,
+          :short        => "-P PID_FILE",
+          :long         => "--pid PIDFILE",
+          :description  => "Set the PID file location, defaults to /tmp/chef-solr.pid",
+          :proc         => nil
+
+        option :help,
+          :short        => "-h",
+          :long         => "--help",
+          :description  => "Show this message",
+          :on           => :tail,
+          :boolean      => true,
+          :show_options => true,
+          :exit         => 0
+
+        option :user,
+          :short => "-u USER",
+          :long => "--user USER",
+          :description => "User to set privilege to",
+          :proc => nil
+
+        option :group,
+          :short => "-g GROUP",
+          :long => "--group GROUP",
+          :description => "Group to set privilege to",
+          :proc => nil
+
+        option :daemonize,
+          :short => "-d",
+          :long => "--daemonize",
+          :description => "Daemonize the process",
+          :proc => lambda { |p| true }
+
+        option :solr_jetty_path,
+          :short => "-W PATH",
+          :long => "--solr-jetty-dir PATH",
+          :description => "Where to place the Solr Jetty instance"
+
+        option :solr_data_path,
+          :short => "-D PATH",
+          :long => "--solr-data-dir PATH",
+          :description => "Where the Solr data lives"
+
+        option :solr_home_path,
+          :short => "-H PATH",
+          :long => "--solr-home-dir PATH",
+          :description => "Solr home directory"
+
+        option :solr_heap_size,
+          :short => "-x SIZE",
+          :long => "--solor-heap-size SIZE",
+          :description => "Set the size of the Java Heap"
+
+        option :solr_java_opts,
+          :short => "-j OPTS",
+          :long => "--java-opts OPTS",
+          :description => "Raw options passed to Java"
+
+        option :version,
+          :short => "-v",
+          :long => "--version",
+          :description => "Show chef-solr version",
+          :boolean => true,
+          :proc => lambda {|v| puts "chef-solr: #{::Chef::Solr::VERSION}"},
+          :exit => 0
+
+        def initialize
+          super
+        end
+
+        def schema_file_path
+          @schema_file_path ||= File.join(Chef::Config[:solr_home_path], 'conf', 'schema.xml')
+        end
+
+        def solr_config_file_path
+          @solr_config_file_path ||= File.join(Chef::Config[:solr_home_path], 'conf', 'solrconfig.xml')
+        end
+
+        def schema_document
+          @schema_document ||= begin
+            File.open(schema_file_path, 'r') do |xmlsux|
+              REXML::Document.new(xmlsux)
+            end
+          end
+        end
+
+        def config_document
+          @config_document ||=begin
+            File.open(solr_config_file_path, 'r') do |xmlsux|
+              REXML::Document.new(xmlsux)
+            end
+          end
+        end
+
+        def schema_attributes
+          @schema_attributes ||= REXML::XPath.first(schema_document, '/schema').attributes
+        end
+
+        def solr_main_index_elements
+          location = '/config/mainIndex/'
+          @solr_main_index_elements ||= REXML::XPath.first(config_document, location).elements
+        end
+
+        def solr_schema_name
+          schema_attributes["name"]
+        end
+
+        def solr_schema_version
+          schema_attributes["version"]
+        end
+
+        def solr_main_index_max_field_length
+          @solr_main_index_max_field_length ||=begin
+            field_length_el = solr_main_index_elements.select do |el|
+              el.name == 'maxFieldLength'
+            end
+
+            field_length_el.empty? ? nil : field_length_el.first.text.to_i
+          end
+        end
+
+        def valid_schema_name?
+          solr_schema_name == Chef::Solr::SCHEMA_NAME
+        end
+
+        def valid_schema_version?
+          solr_schema_version == Chef::Solr::SCHEMA_VERSION
+        end
+
+        def check_value_of_main_index_max_field_length
+          if solr_main_index_max_field_length
+            unless solr_main_index_max_field_length > 10000
+              message  = "The maxFieldLimit for the mainIndex is set to #{solr_main_index_max_field_length}.  "
+              message << "It's recommended to increase this value (in #{solr_config_file_path})."
+              Chef::Log.warn message
+            end
+          else
+            Chef::Log.warn "Unable to determine the maxFieldLimit for the mainIndex (in #{solr_config_file_path})"
+          end
+        end
+
+        def solr_home_exist?
+          File.directory?(Chef::Config[:solr_home_path])
+        end
+
+        def solr_data_dir_exist?
+          File.directory?(Chef::Config[:solr_data_path])
+        end
+
+        def solr_jetty_home_exist?
+          File.directory?(Chef::Config[:solr_jetty_path])
+        end
+
+        def assert_solr_installed!
+          unless solr_home_exist? && solr_data_dir_exist? && solr_jetty_home_exist?
+            Chef::Log.fatal "Chef Solr is not installed or solr_home_path, solr_data_path, and solr_jetty_path are misconfigured."
+            Chef::Log.fatal "Your current configuration is:"
+            Chef::Log.fatal "solr_home_path:  #{Chef::Config[:solr_home_path]}"
+            Chef::Log.fatal "solr_data_path:  #{Chef::Config[:solr_data_path]}"
+            Chef::Log.fatal "solr_jetty_path: #{Chef::Config[:solr_jetty_path]}"
+            Chef::Log.fatal "You can install Chef Solr using the chef-solr-installer script."
+            exit 1
+          end
+        end
+
+        def assert_valid_schema!
+          unless valid_schema_name? && valid_schema_version?
+            Chef::Log.fatal "Your Chef Solr installation needs to be upgraded."
+            Chef::Log.fatal "Expected schema version #{Chef::Solr::SCHEMA_VERSION} but version #{solr_schema_version} is installed."
+            Chef::Log.fatal "Use chef-solr-installer to upgrade your Solr install after backing up your data."
+            exit 1
+          end
+        end
+
+        def setup_application
+          assert_solr_installed!
+          assert_valid_schema!
+          check_value_of_main_index_max_field_length
+
+          # Need to redirect stdout and stderr so Java process inherits them.
+          # If -L wasn't specified, Chef::Config[:log_location] will be an IO
+          # object, otherwise it will be a String.
+          #
+          # Open this as a privileged user and hang onto it
+          if Chef::Config[:log_location].kind_of?(String)
+            @logfile = File.new(Chef::Config[:log_location], "a")
+          end
+
+          Chef::Log.level = Chef::Config[:log_level]
+
+          Chef::Daemon.change_privilege
+        end
+
+        def run_application
+          if Chef::Config[:daemonize]
+            Chef::Daemon.daemonize("chef-solr")
+          end
+
+          Dir.chdir(Chef::Config[:solr_jetty_path]) do
+            command = "java -Xmx#{Chef::Config[:solr_heap_size]} -Xms#{Chef::Config[:solr_heap_size]}"
+            command << " -Dsolr.data.dir=#{Chef::Config[:solr_data_path]}"
+            command << " -Dsolr.solr.home=#{Chef::Config[:solr_home_path]}"
+            command << " #{Chef::Config[:solr_java_opts]}" if Chef::Config[:solr_java_opts]
+            command << " -jar #{File.join(Chef::Config[:solr_jetty_path], 'start.jar')}"
+            Chef::Log.info("Starting Solr with #{command}")
+
+            # Opened earlier before we dropped privileges, don't need it anymore
+            close_and_reopen_log_file if @logfile
+
+            Kernel.exec(command)
+
+          end
+        end
+
+        def close_and_reopen_log_file
+          Chef::Log.close
+
+          STDOUT.reopen(@logfile)
+          STDERR.reopen(@logfile)
+        end
+
+      end
+    end
+  end
+end