sunspot_solr 2.2.0 → 2.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9c1914c2c766805f204440436b477639f441c59157f8ea8cf3d3ff2b3247c0e
+  data.tar.gz: c7a5a0862b69755a76d39bbcaa6b739bdf519c94398c80097da009b8aa322a8c
+SHA512:
+  metadata.gz: 324bd411649634ab9b317773c82069cfb91f40f1fe27ffe908122e975903a9243bb214daf5e9814c873cadcc0ed638297e54dbe05593000c2631d20ae326f7c1
+  data.tar.gz: d54998daedd15e13503a8854bdd64fc39136e81481187256682752139bc9bd92fa053bfc3498bd82e440083f81b7f614a2a407f8324be78158f72c5c27f4c75c

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -1,3 +1,3 @@
 source "http://rubygems.org"
 
-gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec

data/bin/sunspot-solr

@@ -26,10 +26,6 @@ opts = OptionParser.new do |opts|
     server.bind_address = b
   end
 
-  opts.on '-d', '--data-directory=DIRECTORY', 'Solr data directory' do |d|
-    server.solr_data_dir = File.expand_path(d)
-  end
-
   opts.on '-s', '--solr-home=HOME', 'Solr home directory (should contain conf/ directory)' do |s|
     server.solr_home = File.expand_path(s)
   end
@@ -50,12 +46,8 @@ opts = OptionParser.new do |opts|
     server.log_file = File.expand_path(lf)
   end
 
-  opts.on '--max-memory=MEMORY', 'Specify the maximum size of the memory allocation pool' do |mm|
-    server.max_memory = mm
-  end
-
-  opts.on '--min-memory=MEMORY', 'Specify the initial size of the memory allocation pool' do |mm|
-    server.min_memory = mm
+  opts.on '--memory=MEMORY', 'Specify the size of the memory allocation pool' do |m|
+    server.memory = m
   end
 end
 

data/lib/sunspot/solr/installer.rb

@@ -1,24 +1,82 @@
-%w(task_helper config_installer).each do |file|
-  require File.join(File.dirname(__FILE__), 'installer', file)
-end
+require "fileutils"
+require "pathname"
 
 module Sunspot
   module Solr
     class Installer
       class <<self
         def execute(solr_home, options = {})
-          new(solr_home, options).execute
+          new(Pathname(solr_home).expand_path, options).execute
+        end
+      end
+
+      attr_reader :config_path, :options
+
+      class << self
+        def execute(config_path, options = {})
+          new(config_path, options).execute
         end
+      end
 
-        private :new
+      def initialize(config_path, options)
+        @config_path = config_path
+        @options     = options
       end
 
-      def initialize(solr_home, options)
-        @solr_home, @options = solr_home, options
+      def force?
+        !!@options[:force]
+      end
+
+      def verbose?
+        !!@options[:verbose]
       end
 
       def execute
-        ConfigInstaller.execute(File.join(@solr_home, 'conf'), @options)
+        return if sunspot_config_path == config_path
+
+        config_source_files.each do |source_path|
+          destination_path = get_destination_path(source_path)
+
+          if destination_path.exist?
+            next unless force?
+            output "Removing existing file #{ destination_path }"
+          end
+
+          destination_dir = destination_path.dirname
+          unless destination_dir.exist?
+            output "Creating directory #{ destination_dir }"
+            destination_dir.mkpath
+          end
+
+          output "Copying #{ source_path } => #{ destination_path }"
+          FileUtils.copy(source_path, destination_path)
+        end
+      end
+
+      def sunspot_config_path
+        @sunspot_config_path ||= Pathname(__FILE__).join("../../../../solr/solr")
+      end
+
+      def config_source_files
+        @config_source_files ||= glob_source_files
+      end
+
+      private
+
+      def get_destination_path(source_path)
+        source_path.sub(sunspot_config_path.to_s, config_path.to_s)
+      end
+
+      def glob_source_files
+        source_files = []
+        source_files += Pathname.glob(sunspot_config_path.join("solr.xml"))
+        source_files += Pathname.glob(sunspot_config_path.join("configsets/**/*"))
+        source_files += Pathname.glob(sunspot_config_path.join("**/core.properties"))
+        source_files.select(&:file?).map(&:expand_path)
+      end
+
+      def output message
+        STDOUT.puts(message) if verbose?
       end
     end
   end

data/lib/sunspot/solr/java.rb

@@ -1,12 +1,25 @@
-require 'rbconfig'
+require "rbconfig"
 
 module Sunspot
   module Solr
     module Java
-      NULL_DEVICE = RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL' : '/dev/null'
+      class << self
+        def ensure_install!
+          if installed?
+            true
+          else
+            raise Sunspot::Solr::Server::JavaMissing, "You need a Java Runtime Environment to run the Solr server"
+          end
+        end
 
-      def self.installed?
-        system "java -version >#{NULL_DEVICE} 2>&1"
+        def installed?
+          system("java", "-version", [:out, :err] => null_device)
+          $?.exitstatus.zero?
+        end
+
+        def null_device
+          RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ ? "NUL" : "/dev/null"
+        end
       end
     end
   end

data/lib/sunspot/solr/server.rb

@@ -13,19 +13,18 @@ module Sunspot
       JavaMissing = Class.new(ServerError)
 
       # Name of the sunspot executable (shell script)
-      SOLR_START_JAR = File.expand_path(
-        File.join(File.dirname(__FILE__), '..', '..', '..', 'solr', 'start.jar')
+      SOLR_EXECUTABLE = File.expand_path(
+        File.join(File.dirname(__FILE__), '..', '..', '..', 'solr', 'bin', 'solr')
       )
 
       LOG_LEVELS = Set['SEVERE', 'WARNING', 'INFO', 'CONFIG', 'FINE', 'FINER', 'FINEST']
 
-      attr_accessor :min_memory, :max_memory, :bind_address, :port, :log_file
+      attr_accessor :memory, :bind_address, :port, :log_file
 
-      attr_writer :pid_dir, :pid_file, :solr_data_dir, :solr_home, :solr_jar
+      attr_writer :pid_dir, :pid_file, :solr_home, :solr_executable
 
-      def initialize(*args)
-        ensure_java_installed
-        super(*args)
+      def initialize
+        Sunspot::Solr::Java.ensure_install!
       end
 
       #
@@ -91,19 +90,13 @@ module Sunspot
       def run
         bootstrap
 
-        command = ['java']
-        command << "-Xms#{min_memory}" if min_memory
-        command << "-Xmx#{max_memory}" if max_memory
-        command << "-Djetty.port=#{port}" if port
-        command << "-Djetty.host=#{bind_address}" if bind_address
-        command << "-Dsolr.data.dir=#{solr_data_dir}" if solr_data_dir
-        command << "-Dsolr.solr.home=#{solr_home}" if solr_home
-        command << "-Djava.util.logging.config.file=#{logging_config_path}" if logging_config_path
-        command << "-Djava.awt.headless=true"
-        command << '-jar' << File.basename(solr_jar)
-        FileUtils.cd(File.dirname(solr_jar)) do
-          exec(*command)
-        end
+        command = %w[./solr start -f]
+        command << "-m" << "#{memory}" if memory
+        command << "-p" << "#{port}" if port
+        command << "-h" << "#{bind_address}" if bind_address
+        command << "-s" << "#{solr_home}" if solr_home
+
+        exec_in_solr_executable_directory(command)
       end
 
       #
@@ -118,6 +111,7 @@ module Sunspot
           pid = IO.read(pid_path).to_i
           begin
             Process.kill('TERM', pid)
+            exec_in_solr_executable_directory(['./solr', 'stop', '-p', "#{port}"]) if port
           rescue Errno::ESRCH
             raise NotRunningError, "Process with PID #{pid} is no longer running"
           ensure
@@ -151,16 +145,20 @@ module Sunspot
         File.expand_path(@pid_dir || FileUtils.pwd)
       end
 
-      def solr_data_dir
-        File.expand_path(@solr_data_dir || Dir.tmpdir)
+      def solr_home
+        File.expand_path(@solr_home || File.join(File.dirname(solr_executable), '..', 'solr'))
       end
 
-      def solr_home
-        File.expand_path(@solr_home || File.join(File.dirname(solr_jar), 'solr'))
+      def solr_executable
+        @solr_executable || SOLR_EXECUTABLE
+      end
+
+      def solr_executable_directory
+        @solr_executable_directory ||= File.dirname(solr_executable)
       end
 
-      def solr_jar
-        @solr_jar || SOLR_START_JAR
+      def exec_in_solr_executable_directory(command)
+        FileUtils.cd(solr_executable_directory) { system(*command) }
       end
 
       #
@@ -189,23 +187,13 @@ module Sunspot
       # Boolean:: success
       #
       def create_solr_directories
-        [solr_data_dir, pid_dir].each do |path|
+        [pid_dir].each do |path|
           FileUtils.mkdir_p(path) unless File.exists?(path)
         end
       end
 
       private
 
-      def ensure_java_installed
-        unless defined?(@java_installed)
-          @java_installed = Sunspot::Solr::Java.installed?
-          unless @java_installed
-            raise JavaMissing.new("You need a Java Runtime Environment to run the Solr server")
-          end
-        end
-        @java_installed
-      end
-
       def logging_config_path
         return @logging_config_path if defined?(@logging_config_path)
         @logging_config_path =

data/solr/.gitignore

@@ -0,0 +1,2 @@
+server/logs/*
+logs/*

data/solr/README.txt

@@ -1,42 +1,181 @@
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements.  See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You 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.
-
-Solr example configuration
---------------------------
-
-To run this example configuration, use 
-
-  java -jar start.jar
-
-in this directory, and when Solr is started connect to 
-
-  http://localhost:8983/solr/admin/
-
-To add documents to the index, use the post.sh script in the exampledocs
-subdirectory (while Solr is running), for example:
-
-  cd exampledocs
-  ./post.sh *.xml
-
-See also README.txt in the solr subdirectory, and check
-http://wiki.apache.org/solr/SolrResources for a list of tutorials and
-introductory articles.
-
-NOTE: This Solr example server references SolrCell jars outside of the server
-directory with <lib> statements in the solrconfig.xml.  If you make a copy of
-this example server and wish to use the ExtractingRequestHandler (SolrCell),
-you will need to copy the required jars into solr/lib or update the paths to
-the jars in your solrconfig.xml.
-
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+
+
+Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+from the Apache Lucene project.
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+http://lucene.apache.org/solr
+
+
+Getting Started
+---------------
+
+To start Solr for the first time after installation, simply do:
+
+  bin/solr start
+
+This will launch a standalone Solr server in the background of your shell,
+listening on port 8983. Alternatively, you can launch Solr in "cloud" mode,
+which allows you to scale out using sharding and replication. To launch Solr
+in cloud mode, do:
+
+  bin/solr start -cloud
+
+To see all available options for starting Solr, please do:
+
+  bin/solr start -help
+
+After starting Solr, create either a core or collection depending on whether
+Solr is running in standalone (core) or SolrCloud mode (collection) by doing:
+
+  bin/solr create -c <name>
+
+This will create a collection that uses a data-driven schema which tries to guess
+the correct field type when you add documents to the index. To see all available
+options for creating a new collection, execute:
+
+  bin/solr create -help
+
+After starting Solr, direct your Web browser to the Solr Admin Console at:
+
+  http://localhost:8983/solr/
+
+
+Solr Examples
+---------------
+
+Solr includes a few examples to help you get started. To run a specific example, do:
+
+  bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+
+    cloud        : SolrCloud example
+    dih          : Data Import Handler (rdbms, mail, rss, tika)
+    schemaless   : Schema-less example (schema is inferred from data during indexing)
+    techproducts : Kitchen sink example providing comprehensive examples of Solr features
+
+For instance, if you want to run the Solr Data Import Handler example, do:
+
+  bin/solr -e dih
+
+
+Indexing Documents
+---------------
+
+To add documents to the index, use bin/post.  For example:
+
+     bin/post -c <collection_name> example/exampledocs/*.xml
+
+For more information about Solr examples please read...
+
+ * example/solr/README.txt
+   For more information about the "Solr Home" and Solr specific configuration
+ * http://lucene.apache.org/solr/quickstart.html
+   For a Quick Start guide
+ * http://lucene.apache.org/solr/resources.html
+   For a list of other tutorials and introductory articles.
+
+or linked from "docs/index.html" in a binary distribution.
+
+Also, there are Solr clients for many programming languages, see 
+   http://wiki.apache.org/solr/IntegratingSolr
+
+
+Files included in an Apache Solr binary distribution
+----------------------------------------------------
+
+server/
+  A self-contained Solr instance, complete with a sample
+  configuration and documents to index. Please see: bin/solr start -help
+  for more information about starting a Solr server.
+
+dist/solr-XX.war
+  The Apache Solr Application.  Deploy this WAR file to any servlet
+  container to run Apache Solr.
+
+dist/solr-<component>-XX.jar
+  The Apache Solr libraries.  To compile Apache Solr Plugins,
+  one or more of these will be required.  The core library is
+  required at a minimum. (see http://wiki.apache.org/solr/SolrPlugins
+  for more information).
+
+docs/index.html
+  The Apache Solr Javadoc API documentation and Tutorial
+
+
+Instructions for Building Apache Solr from Source
+-------------------------------------------------
+
+1. Download the Java SE 7 JDK (Java Development Kit) or later from http://java.sun.com/
+   You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin) 
+   folder included on your command path. To test this, issue a "java -version" command 
+   from your shell (command prompt) and verify that the Java version is 1.7 or later.
+
+2. Download the Apache Ant binary distribution (1.8.2+) from 
+   http://ant.apache.org/  You will need Ant installed and the $ANT_HOME/bin (Windows: 
+   %ANT_HOME%\bin) folder included on your command path. To test this, issue a 
+   "ant -version" command from your shell (command prompt) and verify that Ant is 
+   available. 
+
+   You will also need to install Apache Ivy binary distribution (2.2.0) from 
+   http://ant.apache.org/ivy/ and place ivy-2.2.0.jar file in ~/.ant/lib -- if you skip 
+   this step, the Solr build system will offer to do it for you.
+
+3. Download the Apache Solr distribution, linked from the above web site. 
+   Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+   Alternately, you can obtain a copy of the latest Apache Solr source code
+   directly from the Subversion repository:
+
+     http://lucene.apache.org/solr/versioncontrol.html
+
+4. Navigate to the "solr" folder and issue an "ant" command to see the available options
+   for building, testing, and packaging Solr.
+  
+   NOTE: 
+   To see Solr in action, you may want to use the "ant server" command to build
+   and package Solr into the server/webapps directory. See also server/README.txt.
+
+
+Export control
+-------------------------------------------------
+This distribution includes cryptographic software.  The country in
+which you currently reside may have restrictions on the import,
+possession, use, and/or re-export to another country, of
+encryption software.  BEFORE using any encryption software, please
+check your country's laws, regulations and policies concerning the
+import, possession, or use, and re-export of encryption software, to
+see if this is permitted.  See <http://www.wassenaar.org/> for more
+information.
+
+The U.S. Government Department of Commerce, Bureau of Industry and
+Security (BIS), has classified this software as Export Commodity
+Control Number (ECCN) 5D002.C.1, which includes information security
+software using or performing cryptographic functions with asymmetric
+algorithms.  The form and manner of this Apache Software Foundation
+distribution makes it eligible for export under the License Exception
+ENC Technology Software Unrestricted (TSU) exception (see the BIS
+Export Administration Regulations, Section 740.13) for both object
+code and source code.
+
+The following provides more details on the included cryptographic
+software:
+    Apache Solr uses the Apache Tika which uses the Bouncy Castle generic encryption libraries for
+    extracting text content and metadata from encrypted PDF files.
+    See http://www.bouncycastle.org/ for more details on Bouncy Castle.