sunspot_solr 2.2.0 → 2.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae13b8a2b57aedb34ad05a13224a9279f30da9a2
+  data.tar.gz: 7ffbf0136174428990ab58f8c5ed4caad9e64b40
+SHA512:
+  metadata.gz: 31b8e5adb0b4ca3e7d370bf19707c4fbacaec113dbc30047da722757b8fde09ce1de6616a4019552e1ad9e5b05a4df565058309a32dff3cf719bf9e24e60ac6e
+  data.tar.gz: f1655c00e200d8cf553bc15ca97fb3fb069d8f95aabbb60ecc4d197999cd67498d5422f39c8a778c7c27d65d1f176810c70aa4490bddb7243bf41171a283c2c3

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

data/lib/sunspot/solr/installer.rb

@@ -18,7 +18,7 @@ module Sunspot
       end
 
       def execute
-        ConfigInstaller.execute(File.join(@solr_home, 'conf'), @options)
+        ConfigInstaller.execute(File.join(@solr_home, 'configsets'), @options)
       end
     end
   end

data/lib/sunspot/solr/installer/config_installer.rb

@@ -1,10 +1,15 @@
 require 'fileutils'
+require 'rake/file_list'
 
 module Sunspot
   module Solr
     class Installer
       class ConfigInstaller
         include TaskHelper
+        include FileUtils
+
+        attr_accessor :config_path, :force
+        alias_method :force?, :force
 
         class <<self
           def execute(config_path, options = {})
@@ -13,39 +18,68 @@ module Sunspot
         end
 
         def initialize(config_path, options)
-          @config_path = config_path
+          self.config_path = File.expand_path config_path
+          self.force   = !!options[:force]
           @verbose = !!options[:verbose]
-          @force   = !!options[:force]
         end
 
         def execute
-          sunspot_config_path = File.join(File.dirname(__FILE__), '..', '..',
-                                          '..', '..', 'solr', 'solr', 'conf')
-          return if File.expand_path(sunspot_config_path) == File.expand_path(@config_path)
-
-          FileUtils.mkdir_p(@config_path)
-          Dir.glob(File.join(sunspot_config_path, '*.*')).each do |file|
-            file = File.expand_path(file)
-            dest = File.join(@config_path, File.basename(file))
+          return if sunspot_config_path == config_path
 
+          sunspot_config_files do |file, dest|
             if File.exist?(dest)
-              if @force
-                say("Removing existing file #{dest}")
-              else
-                next
-              end
+              next unless force?
+              say("Removing existing file #{dest}")
+            end
+
+            dir = dest.pathmap('%d')
+            unless File.exist?(dir)
+              say("Creating directory #{dir}")
+              mkdir_p dir
             end
 
+            next if File.directory? file
+
             say("Copying #{file} => #{dest}")
-            FileUtils.cp(file, dest)
+            cp(file, dest)
           end
+        end
+
+        private
+
+        def sunspot_config_files(&blk)
+          src, dest = expand_files(config_source_files), expand_files(config_dest_files)
+          src.zip(dest).each(&blk)
+        end
+
+        def config_dest_files
+          @config_dest_files ||= config_source_files.pathmap("%{^#{sunspot_config_path},#{config_path}}p")
+        end
 
-          # Also copy the solr.xml file for multi core support
-          file = File.expand_path('../solr.xml', sunspot_config_path)
-          dest = File.expand_path(File.join(@config_path, ".."), File.basename(file))
-          say("Copying #{file} => #{dest}")
-          FileUtils.cp(file, dest)
+        def config_source_files
+          @config_source_files ||= glob_source_files
+        end
+
+        def glob_source_files
+          list = Rake::FileList.new("#{sunspot_config_path}/**/*") do |fl| 
+            fl.include "#{sunspot_config_path}/../solr.xml", "#{sunspot_config_path}/../**/core.properties"
+          end
+
+          list.map! { |path| path.first(2) == '..' ? File.join(sunspot_config_path, path) : path }
+
+          list
+        end
+
+        def sunspot_config_path
+          @sunspot_config_path ||= File.expand_path sunspot_relative_config_path
+        end
+
+        def sunspot_relative_config_path
+          File.join File.dirname(__FILE__), '..', '..', '..', '..', 'solr', 'solr', 'configsets'
+        end
 
+        def expand_files(filelist)
+          filelist.map { |file| File.expand_path file }
         end
       end
     end

data/lib/sunspot/solr/java.rb

@@ -6,7 +6,7 @@ module Sunspot
       NULL_DEVICE = RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL' : '/dev/null'
 
       def self.installed?
-        system "java -version >#{NULL_DEVICE} 2>&1"
+        !system("java -version >#{NULL_DEVICE} 2>&1").nil?
       end
     end
   end

data/lib/sunspot/solr/server.rb

@@ -13,15 +13,15 @@ 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_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
@@ -91,19 +91,14 @@ module Sunspot
       def run
         bootstrap
 
-        command = ['java']
+        command = %w[./solr start -f]
         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 << "-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 +113,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 +147,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_executable
+        @solr_executable || SOLR_EXECUTABLE
       end
 
-      def solr_home
-        File.expand_path(@solr_home || File.join(File.dirname(solr_jar), 'solr'))
+      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) { exec(*command) }
       end
 
       #
@@ -189,7 +189,7 @@ 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

data/solr/.gitignore

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

data/solr/README.txt

@@ -13,30 +13,169 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-Solr example configuration
---------------------------
 
-To run this example configuration, use 
+Welcome to the Apache Solr project!
+-----------------------------------
 
-  java -jar start.jar
+Solr is the popular, blazing fast open source enterprise search platform
+from the Apache Lucene project.
 
-in this directory, and when Solr is started connect to 
+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
 
-  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:
+Getting Started
+---------------
 
-  cd exampledocs
-  ./post.sh *.xml
+To start Solr for the first time after installation, simply do:
 
-See also README.txt in the solr subdirectory, and check
-http://wiki.apache.org/solr/SolrResources for a list of tutorials and
-introductory articles.
+  bin/solr start
 
-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.
+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.

data/solr/bin/init.d/solr

@@ -0,0 +1,78 @@
+#!/bin/sh
+# 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.
+
+### BEGIN INIT INFO
+# Provides:          solr
+# Required-Start:    $remote_fs $syslog
+# Required-Stop:     $remote_fs $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Description:       Controls Apache Solr as a Service
+### END INIT INFO
+
+# Example of a very simple *nix init script that delegates commands to the bin/solr script
+# Typical usage is to do:
+#
+#   cp bin/init.d/solr /etc/init.d/solr
+#   chmod 755 /etc/init.d/solr
+#   chown root:root /etc/init.d/solr
+#   update-rc.d solr defaults
+#   update-rc.d solr enable
+
+# Where you extracted the Solr distribution bundle
+SOLR_INSTALL_DIR=/opt/solr
+
+if [ ! -d "$SOLR_INSTALL_DIR" ]; then
+  echo "$SOLR_INSTALL_DIR not found! Please check the SOLR_INSTALL_DIR setting in your $0 script."
+  exit 1
+fi
+
+# Path to an include file that defines environment specific settings to override default
+# variables used by the bin/solr script. It's highly recommended to define this script so
+# that you can keep the Solr binary files separated from live files (pid, logs, index data, etc)
+# see bin/solr.in.sh for an example
+SOLR_ENV=/var/solr/solr.in.sh
+
+if [ ! -f "$SOLR_ENV" ]; then
+  echo "$SOLR_ENV not found! Please check the SOLR_ENV setting in your $0 script."
+  exit 1
+fi
+
+# Specify the user to run Solr as; if not set, then Solr will run as root.
+# Running Solr as root is not recommended for production environments
+RUNAS=solr
+
+# verify the specified run as user exists
+runas_uid=`id -u $RUNAS`
+if [ $? -ne 0 ]; then
+  echo "User $RUNAS not found! Please create the $RUNAS user before running this script."
+  exit 1
+fi
+
+case "$1" in
+  start|stop|restart|status)
+    SOLR_CMD=$1
+    ;;
+  *)
+    echo "Usage: $0 {start|stop|restart|status}"
+    exit
+esac
+
+if [ -n "$RUNAS" ]; then
+  su -c "SOLR_INCLUDE=$SOLR_ENV $SOLR_INSTALL_DIR/bin/solr $SOLR_CMD" - $RUNAS
+else
+  SOLR_INCLUDE=$SOLR_ENV $SOLR_INSTALL_DIR/bin/solr $SOLR_CMD
+fi