solr_search_sanitizer 0.1.0

data/README.md

@@ -0,0 +1,8 @@
+SolrSearchSanitizer
+===================
+
+A gem to provide a way of sanitizing SOLR searches containing advanced search characters and nested parentheses.  This gem assumes that ECommerce stores do not advertise this advanced functionality of SOLR to users and so the query must be sanitized to prevent incorrect syntax.
+
+Copyright (c) 2011 minustehbare, released under the New BSD License
+
+

data/lib/solr_search_sanitizer/sanitizer.rb

@@ -0,0 +1,121 @@
+module SolrSearchSanitizer
+  module Sanitizer
+    BOOLEAN_OPERATORS_REGEXP = /\b(AND)\b|\b(OR)\b|\b(NOT)\b|\B(&&)\B|\B(!)\B|\B(\|\|)\B/
+    BRACKET_REGEXP = /((\()|(\))|(\{)|(\})|(\[)|(\]))/
+    WILDCARD_REGEXP = /((\*)|(\?))/
+    #FUZZY_REGEXP = /[\w|\"](~)[\d]?/
+    FUZZY_REGEXP = /(~)/
+    #BOOST_REGEXP = /[\w|\"](\^)[\d]?/
+    BOOST_REGEXP = /(\^)/
+    #BOOLEAN_MODIFIER_REGEXP = /((\+)|(-))[(\w+(\b))|(\".+\")]/
+    BOOLEAN_MODIFIER_REGEXP = /((\+)|(-))/
+    MISC_REGEXP = /(\")|(:)/
+    
+    ####################
+    #
+    # All REGEXP definitions match characters or keywords that are part of the Apache Lucene Query Parser Sytntax
+    #
+    # BOOLEAN_OPERATOR_REGEXP => matches boolean operators on multiple search terms
+    #
+    # BRACKET_REGEXP => matches parentheses and brackets and braces that group search clauses or define range searches
+    #
+    # WILDCARD_REGEXP => matches ? or * characters in the search that act as single or multiple character wildcards within a search term
+    #
+    # FUZZY_REGEXP => matches the ~ character at the end of a search term or phrase
+    #
+    # BOOST_REGEXP => matches the ^ character at the end of a search term or phrase
+    #
+    # BOOLEAN_MODIFIER_REGEXP => matches + or - characters at the start of search terms/phrases
+    #
+    # MISC_REGEXP => matches (currently) : and " characters that are used for defining phrases or field values
+    #
+    ####################
+    
+    def escape_boolean_operators(query)
+      return nil unless query
+      new_query = query.gsub(BOOLEAN_OPERATORS_REGEXP, '&&' => '\\&\\&', '||' => '\\|\\|', '!' => '\\!', 'AND' => 'and', 'NOT' => 'not', 'OR' => 'or')
+    end
+    
+    def remove_boolean_operators(query)
+      return nil unless query
+      new_query = query.gsub(BOOLEAN_OPERATORS_REGEXP, '')
+    end
+    
+    def escape_brackets(query)
+      return nil unless query
+      new_query = query.gsub(BRACKET_REGEXP, '\\\\\1')
+    end
+    
+    def remove_brackets(query)
+      return nil unless query
+      new_query = query.gsub(BRACKET_REGEXP, '')
+    end
+    
+    def escape_wildcards(query)
+      return nil unless query
+      new_query = query.gsub(WILDCARD_REGEXP, '\\\\\1')
+    end
+    
+    def remove_wildcards(query)
+      return nil unless query
+      new_query = query.gsub(WILDCARD_REGEXP, '')
+    end
+    
+    def escape_fuzzy(query)
+      return nil unless query
+      new_query = query.gsub(FUZZY_REGEXP, '\\\\\1')
+    end
+    
+    def remove_fuzzy(query)
+      return nil unless query
+      new_query = query.gsub(FUZZY_REGEXP, '')
+    end
+    
+    def escape_boost(query)
+      return nil unless query
+      new_query = query.gsub(BOOST_REGEXP, '\\\\\1')
+    end
+    
+    def remove_boost(query)
+      return nil unless query
+      new_query = query.gsub(BOOST_REGEXP, '')
+    end
+    
+    def escape_boolean_modifiers(query)
+      return nil unless query
+      new_query = query.gsub(BOOLEAN_MODIFIER_REGEXP, '\\\\\1')
+    end
+    
+    def remove_boolean_modifiers(query)
+      return nil unless query
+      new_query = query.gsub(BOOLEAN_MODIFIER_REGEXP, '')
+    end
+    
+    # : (colon) characters in SOLR searches are modified by acts_as_solr_reloaded
+    # after they are escaped
+    #
+    # without sanitization, some_field:some_value => some_field_t:some_value from acts_as_solr
+    # with sanitization, some_field:some_value => some_field\_t:some_value
+    #
+    # for this reason we simply remove the : from the search entirely since it cannot be escaped
+    def escape_misc(query)
+      return nil unless query
+      new_query = query.gsub(MISC_REGEXP, '"' => '\\"', ':' => '')
+    end
+    
+    def remove_misc(query)
+      return nil unless query
+      new_query = query.gsub(MISC_REGEXP, '')
+    end
+    
+    def escape_special_characters(query)
+      new_query = escape_boolean_operators(query)
+      new_query = escape_brackets(new_query)
+      new_query = escape_wildcards(new_query)
+      new_query = escape_fuzzy(new_query)
+      new_query = escape_boost(new_query)
+      new_query = escape_boolean_modifiers(new_query)
+      new_query = escape_misc(new_query)
+    end
+  end
+end

data/solr_search_sanitizer.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'solr_search_sanitizer'
+  s.version     = '0.1.0'
+  s.summary     = 'Provides sanitizer methods for SOLR queries.'
+  s.description = 'Provides sanitizer methods for SOLR queries.'
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.author            = 'minustehbare'
+  s.email             = 'minustehbare@gmail.com'
+  # s.homepage          = 'http://www.rubyonrails.org'
+  # s.rubyforge_project = 'actionmailer'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: solr_search_sanitizer
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- minustehbare
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-14 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Provides sanitizer methods for SOLR queries.
+email: minustehbare@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- lib/solr_search_sanitizer/sanitizer.rb
+- solr_search_sanitizer.gemspec
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: 
+- none
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Provides sanitizer methods for SOLR queries.
+test_files: []
+