sunspot_solr-xaop 1.2.1

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,24 @@
+= Sunspot::Solr
+
+Sunspot::Solr is a packaged distribution of Solr for use with the
+Sunspot[http://outoftime.github.com/sunspot] and
+Sunspot::Rails[https://github.com/outoftime/sunspot/tree/master/sunspot_rails]
+gems.  See those gems' documentation for more information.
+
+== Installation
+
+  gem install sunspot_solr
+
+In order to start the daemon, run:
+
+  sunspot-solr start -- [-d /path/to/data/directory] [-p port] [-s path/to/solr/home] [--pid-dir=path/to/pid/dir]
+
+If you don't specify a data directory, your Solr index will be stored in your
+operating system's temporary directory.
+
+If you specify a solr home, the directory must contain a <code>conf</code>
+directory, which should contain at least <code>schema.xml</code> and
+<code>solrconfig.xml</code>. Be sure to copy the <code>schema.xml</code> out of
+the Sunspot gem's <code>solr/solr/conf</code> directory. Sunspot relies on the
+field name patterns defined in the packaged <code>schema.xml</code>, so those
+cannot be modified.

data/bin/sunspot-solr

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+begin
+  require 'fileutils'
+  require 'tempfile'
+  require 'tmpdir'
+  require 'optparse'
+  require File.join(File.dirname(__FILE__), '..', 'lib', 'sunspot', 'solr', 'server')
+rescue LoadError => e
+  if require 'rubygems'
+    retry
+  else
+    raise(e)
+  end
+end
+
+server = Sunspot::Solr::Server.new
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: sunspot-solr start [options]"
+
+  opts.on '-p', '--port=PORT', 'Port on which to run Solr (default 8983)' do |p|
+    server.port = p
+  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
+
+  opts.on '-j', '--solr-jar=JAR', 'Solr start jar' do |j|
+    server.solr_jar = File.expand_path(j)
+  end
+
+  opts.on '--pid-dir=PID_DIR', 'Directory for pid files' do |pd|
+    server.pid_dir = File.expand_path(pd)
+  end
+
+  opts.on '-l', '--log-level=LOG_LEVEL', 'Solr logging level' do |l|
+    server.log_level = l
+  end
+
+  opts.on '--log-file=LOG_FILE', 'Path to Solr log file' do |lf|
+    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
+  end
+end.parse!
+
+begin
+  case ARGV[0]
+  when 'start'
+    server.start
+  when 'run'
+    server.run
+  when 'stop'
+    server.stop
+  when 'restart'
+    server.stop
+    server.start
+  else
+    abort("Usage: sunspot-solr (start|stop|run)")
+  end
+rescue Sunspot::Solr::Server::ServerError => e
+  abort(e.message)
+end

data/lib/sunspot/solr/server.rb

@@ -0,0 +1,171 @@
+require 'escape'
+require 'set'
+require 'tempfile'
+require 'sunspot/java'
+
+module Sunspot
+  module Solr
+    class Server #:nodoc:
+      # Raised if #stop is called but the server is not running
+      ServerError = Class.new(RuntimeError)
+      AlreadyRunningError = Class.new(ServerError)
+      NotRunningError = Class.new(ServerError)
+      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')
+      )
+
+      LOG_LEVELS = Set['SEVERE', 'WARNING', 'INFO', 'CONFIG', 'FINE', 'FINER', 'FINEST']
+
+      attr_accessor :min_memory, :max_memory, :port, :solr_data_dir, :solr_home, :log_file
+      attr_writer :pid_dir, :pid_file, :log_level, :solr_data_dir, :solr_home, :solr_jar
+
+      def initialize(*args)
+        ensure_java_installed
+        super(*args)
+      end
+
+      #
+      # Start the sunspot-solr server. Bootstrap solr_home first,
+      # if neccessary.
+      #
+      # ==== Returns
+      #
+      # Boolean:: success
+      #
+      def start
+        if File.exist?(pid_path)
+          existing_pid = IO.read(pid_path).to_i
+          begin
+            Process.kill(0, existing_pid)
+            raise(AlreadyRunningError, "Server is already running with PID #{existing_pid}")
+          rescue Errno::ESRCH
+            STDERR.puts("Removing stale PID file at #{pid_path}")
+            FileUtils.rm(pid_path)
+          end
+        end
+        fork do
+          pid = fork do
+            Process.setsid
+            STDIN.reopen('/dev/null')
+            STDOUT.reopen('/dev/null', 'a')
+            STDERR.reopen(STDOUT)
+            run
+          end
+          FileUtils.mkdir_p(pid_dir)
+          File.open(pid_path, 'w') do |file|
+            file << pid
+          end
+        end
+      end
+
+      #
+      # Run the sunspot-solr server in the foreground. Boostrap
+      # solr_home first, if neccessary.
+      #
+      # ==== Returns
+      #
+      # Boolean:: success
+      #
+      def run
+        command = ['java']
+        command << "-Xms#{min_memory}" if min_memory
+        command << "-Xmx#{max_memory}" if max_memory
+        command << "-Djetty.port=#{port}" if port
+        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 << '-jar' << File.basename(solr_jar)
+        FileUtils.cd(File.dirname(solr_jar)) do
+          exec(Escape.shell_command(command))
+        end
+      end
+
+      #
+      # Stop the sunspot-solr server.
+      #
+      # ==== Returns
+      #
+      # Boolean:: success
+      #
+      def stop
+        if File.exist?(pid_path)
+          pid = IO.read(pid_path).to_i
+          begin
+            Process.kill('TERM', pid)
+          rescue Errno::ESRCH
+            raise NotRunningError, "Process with PID #{pid} is no longer running"
+          ensure
+            FileUtils.rm(pid_path)
+          end
+        else
+          raise NotRunningError, "No PID file at #{pid_path}"
+        end
+      end
+
+      def log_level=(level)
+        unless LOG_LEVELS.include?(level.to_s.upcase)
+          raise(ArgumentError, "#{level} is not a valid log level: Use one of #{LOG_LEVELS.to_a.join(',')}")
+        end
+        @log_level = level.to_s.upcase
+      end
+
+      def log_level
+        @log_level || 'WARNING'
+      end
+
+      def pid_path
+        File.join(pid_dir, pid_file)
+      end
+
+      def pid_file
+        @pid_file || 'sunspot-solr.pid'
+      end
+
+      def pid_dir
+        File.expand_path(@pid_dir || FileUtils.pwd)
+      end
+
+      def solr_data_dir
+        File.expand_path(@solr_data_dir || Dir.tmpdir)
+      end
+
+      def solr_home
+        File.expand_path(@solr_home || File.join(File.dirname(solr_jar), 'solr'))
+      end
+
+      def solr_jar
+        @solr_jar || SOLR_START_JAR
+      end
+
+      private
+
+      def ensure_java_installed
+        unless defined?(@java_installed)
+          @java_installed = Sunspot::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 =
+          if log_file
+            logging_config = Tempfile.new('logging.properties')
+            logging_config.puts("handlers = java.util.logging.FileHandler")
+            logging_config.puts("java.util.logging.FileHandler.level = #{log_level.to_s.upcase}")
+            logging_config.puts("java.util.logging.FileHandler.pattern = #{log_file}")
+            logging_config.puts("java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter")
+            logging_config.flush
+            logging_config.close
+            logging_config.path
+          end
+      end
+    end
+  end
+end

data/lib/sunspot_solr.rb

@@ -0,0 +1 @@
+require 'sunspot/solr/server'

data/solr/README.txt

@@ -0,0 +1,42 @@
+# 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.
+

data/solr/etc/jetty.xml

@@ -0,0 +1,218 @@
+<?xml version="1.0"?>
+<!DOCTYPE Configure PUBLIC "-//Mort Bay Consulting//DTD Configure//EN" "http://jetty.mortbay.org/configure.dtd">
+
+<!-- =============================================================== -->
+<!-- Configure the Jetty Server                                      -->
+<!--                                                                 -->
+<!-- Documentation of this file format can be found at:              -->
+<!-- http://docs.codehaus.org/display/JETTY/jetty.xml                -->
+<!--                                                                 -->
+<!-- =============================================================== -->
+
+
+<Configure id="Server" class="org.mortbay.jetty.Server">
+
+    <!-- Increase the maximum POST size to 1 MB to be able to handle large shard requests -->
+    <Call class="java.lang.System" name="setProperty">
+      <Arg>org.mortbay.jetty.Request.maxFormContentSize</Arg>
+      <Arg>1000000</Arg>
+    </Call>
+
+    <!-- =========================================================== -->
+    <!-- Server Thread Pool                                          -->
+    <!-- =========================================================== -->
+    <Set name="ThreadPool">
+      <!-- Default bounded blocking threadpool 
+      -->
+      <New class="org.mortbay.thread.BoundedThreadPool">
+        <Set name="minThreads">10</Set>
+        <Set name="lowThreads">50</Set>
+        <Set name="maxThreads">10000</Set>
+      </New>
+
+      <!-- Optional Java 5 bounded threadpool with job queue 
+      <New class="org.mortbay.thread.concurrent.ThreadPool">
+        <Arg type="int">0</Arg>
+        <Set name="corePoolSize">10</Set>
+        <Set name="maximumPoolSize">250</Set>
+      </New>
+      -->
+    </Set>
+
+
+
+    <!-- =========================================================== -->
+    <!-- Set connectors                                              -->
+    <!-- =========================================================== -->
+    <!-- One of each type!                                           -->
+    <!-- =========================================================== -->
+
+    <!-- Use this connector for many frequently idle connections
+         and for threadless continuations.
+    <Call name="addConnector">
+      <Arg>
+          <New class="org.mortbay.jetty.nio.SelectChannelConnector">
+            <Set name="port"><SystemProperty name="jetty.port" default="8983"/></Set>
+            <Set name="maxIdleTime">30000</Set>
+            <Set name="Acceptors">2</Set>
+            <Set name="confidentialPort">8443</Set>
+          </New>
+      </Arg>
+    </Call>
+   -->     
+
+    <!-- Use this connector if NIO is not available. -->
+    <!-- This connector is currently being used for Solr because the
+         nio.SelectChannelConnector showed poor performance under WindowsXP
+         from a single client with non-persistent connections (35s vs ~3min)
+         to complete 10,000 requests)
+    -->
+    <Call name="addConnector">
+      <Arg>
+          <New class="org.mortbay.jetty.bio.SocketConnector">
+            <Set name="port"><SystemProperty name="jetty.port" default="8983"/></Set>
+            <Set name="maxIdleTime">50000</Set>
+            <Set name="lowResourceMaxIdleTime">1500</Set>
+            <!-- Increase header buffer size from default of 4KB to 64KB to 
+                 prevent Solr from reaching this limit during large queries
+            -->
+            <Set name="headerBufferSize">65536</Set>
+          </New>
+      </Arg>
+    </Call>
+
+    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+    <!-- To add a HTTPS SSL listener                                     -->
+    <!-- see jetty-ssl.xml to add an ssl connector. use                  -->
+    <!-- java -jar start.jar etc/jetty.xml etc/jetty-ssl.xml             -->
+    <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+    
+    <!-- =========================================================== -->
+    <!-- Set up global session ID manager                            -->
+    <!-- =========================================================== -->
+    <!--
+    <Set name="sessionIdManager">
+      <New class="org.mortbay.jetty.servlet.HashSessionIdManager">
+        <Set name="workerName">node1</Set>
+      </New>
+    </Set>
+    -->
+
+    <!-- =========================================================== -->
+    <!-- Set handler Collection Structure                            --> 
+    <!-- =========================================================== -->
+    <Set name="handler">
+      <New id="Handlers" class="org.mortbay.jetty.handler.HandlerCollection">
+        <Set name="handlers">
+         <Array type="org.mortbay.jetty.Handler">
+           <Item>
+             <New id="Contexts" class="org.mortbay.jetty.handler.ContextHandlerCollection"/>
+           </Item>
+           <Item>
+             <New id="DefaultHandler" class="org.mortbay.jetty.handler.DefaultHandler"/>
+           </Item>
+           <Item>
+             <New id="RequestLog" class="org.mortbay.jetty.handler.RequestLogHandler"/>
+           </Item>
+         </Array>
+        </Set>
+      </New>
+    </Set>
+    
+    <!-- =========================================================== -->
+    <!-- Configure the context deployer                              -->
+    <!-- A context deployer will deploy contexts described in        -->
+    <!-- configuration files discovered in a directory.              -->
+    <!-- The configuration directory can be scanned for hot          -->
+    <!-- deployments at the configured scanInterval.                 -->
+    <!--                                                             -->
+    <!-- This deployer is configured to deploy contexts configured   -->
+    <!-- in the $JETTY_HOME/contexts directory                       -->
+    <!--                                                             -->
+    <!-- =========================================================== -->
+    <Call name="addLifeCycle">
+      <Arg>
+        <New class="org.mortbay.jetty.deployer.ContextDeployer">
+          <Set name="contexts"><Ref id="Contexts"/></Set>
+          <Set name="configurationDir"><SystemProperty name="jetty.home" default="."/>/contexts</Set>
+          <Set name="scanInterval">1</Set>
+        </New>
+      </Arg>
+    </Call>
+
+    <!-- =========================================================== -->
+    <!-- Configure the webapp deployer.                              -->
+    <!-- A webapp  deployer will deploy standard webapps discovered  -->
+    <!-- in a directory at startup, without the need for additional  -->
+    <!-- configuration files.    It does not support hot deploy or   -->
+    <!-- non standard contexts (see ContextDeployer above).          -->
+    <!--                                                             -->
+    <!-- This deployer is configured to deploy webapps from the      -->
+    <!-- $JETTY_HOME/webapps directory                               -->
+    <!--                                                             -->
+    <!-- Normally only one type of deployer need be used.            -->
+    <!--                                                             -->
+    <!-- =========================================================== -->
+    <Call name="addLifeCycle">
+      <Arg>
+        <New class="org.mortbay.jetty.deployer.WebAppDeployer">
+          <Set name="contexts"><Ref id="Contexts"/></Set>
+          <Set name="webAppDir"><SystemProperty name="jetty.home" default="."/>/webapps</Set>
+				  <Set name="parentLoaderPriority">false</Set>
+				  <Set name="extract">true</Set>
+				  <Set name="allowDuplicates">false</Set>
+          <Set name="defaultsDescriptor"><SystemProperty name="jetty.home" default="."/>/etc/webdefault.xml</Set>
+        </New>
+      </Arg>
+    </Call>
+
+    <!-- =========================================================== -->
+    <!-- Configure Authentication Realms                             -->
+    <!-- Realms may be configured for the entire server here, or     -->
+    <!-- they can be configured for a specific web app in a context  -->
+    <!-- configuration (see $(jetty.home)/contexts/test.xml for an   -->
+    <!-- example).                                                   -->
+    <!-- =========================================================== -->
+    <Set name="UserRealms">
+      <Array type="org.mortbay.jetty.security.UserRealm">
+        <!--
+        <Item>
+          <New class="org.mortbay.jetty.security.HashUserRealm">
+            <Set name="name">Test Realm</Set>
+            <Set name="config"><SystemProperty name="jetty.home" default="."/>/etc/realm.properties</Set>
+          </New>
+        </Item>
+	-->
+      </Array>
+    </Set>
+
+    <!-- =========================================================== -->
+    <!-- Configure Request Log                                       -->
+    <!-- Request logs  may be configured for the entire server here, -->
+    <!-- or they can be configured for a specific web app in a       -->
+    <!-- contexts configuration (see $(jetty.home)/contexts/test.xml -->
+    <!-- for an example).                                            -->
+    <!-- =========================================================== -->
+    <!--
+    <Ref id="RequestLog">
+      <Set name="requestLog">
+        <New id="RequestLogImpl" class="org.mortbay.jetty.NCSARequestLog">
+          <Arg><SystemProperty name="jetty.logs" default="./logs"/>/yyyy_mm_dd.request.log</Arg>
+          <Set name="retainDays">90</Set>
+          <Set name="append">true</Set>
+          <Set name="extended">false</Set>
+          <Set name="LogTimeZone">GMT</Set>
+        </New>
+      </Set>
+    </Ref>
+    -->
+
+    <!-- =========================================================== -->
+    <!-- extra options                                               -->
+    <!-- =========================================================== -->
+    <Set name="stopAtShutdown">true</Set>
+    <!-- ensure/prevent Server: header being sent to browsers        -->
+    <Set name="sendServerVersion">true</Set>
+
+</Configure>
+