Updated to work with elasticsearch v2.x

Author: ndtreviv

README.md

@@ -5,13 +5,15 @@
 # Introduction
 This repository contains native scoring scripts for use with elasticsearch. 
 
-**Disclaimer:** They have only been tested with elasticsearch v1.7.3, and even then against a very strict document set.
+**Disclaimer:** They have only been tested with elasticsearch v2.3.1, and even then against a very strict document set.
 
 ## Hamming Distance
 This script will calculate the hamming distance between two hex-encoded bit-strings (ie: strings made up of 1’s and 0’s and then hexidecimally encoded), one hash being passed in as a parameter: `param_hash`, and the other being stored in a field also identified by a parameter: `param_field`.
 
 It will then return your search results scored accordingly, where the smallest distance (ie: most similar strings) appear nearer the top of the results list.
 
+**Note:** If the parameter hash and the document hash are not the same length, the result will be a score of `0.0f`.
+
 ### Caveats
 The hashes must be the same length in every document, or the relative scoring won’t be accurate.
 
@@ -32,8 +34,8 @@ The first hash is sent in as a parameter: `param_hash`, the other is expected to
 Include the following in your elasticsearch.yml config file:
 
     script.native:
-        hamming_distance.type: com.example.elasticsearch.plugins.HammingDistanceScriptFactory
-        euclidean_distance.type: com.example.elasticsearch.plugins.EuclideanDistanceScriptFactory
+        hamming_distance.type: com.cameraforensics.elasticsearch.plugins.HammingDistanceScriptFactory
+        euclidean_distance.type: com.cameraforensics.elasticsearch.plugins.EuclideanDistanceScriptFactory
 
 **Note:** If you don’t do this, they still show up on the plugins list (see later) but you’ll get errors when you try to use either of them saying that elasticsearch can’t find the plugin.
 
@@ -44,8 +46,8 @@ The results will be located in: `PLUGIN_NAME/build/libs/`
 
 For example:
 
-* `hammingdistance/build/libs/hammingdistance-0.1.0.jar`
-* `euclideandistance/build/libs/euclideandistance-0.1.0.jar`
+* `hammingdistance/build/libs/hammingdistance-2.3.1.0.jar`
+* `euclideandistance/build/libs/euclideandistance-2.3.1.0.jar`
 
 **Note:** This has been built using Gradle v2.7.
 
@@ -54,6 +56,8 @@ Don't bother using the elasticsearch plugin script to install it - it's just a p
 
 Instead put the .jar file in `%ELASTICSEARCH_HOME%/plugins/hamming_distance` for hamming distance, and `%ELASTICSEARCH_HOME%/plugins/euclidean_distance` for euclidean distance, then restart elasticsearch.
 
+**Note:** If you installed elasticsearch according to docs, this `%ELASTICSEARCH_HOME%` will default to `/usr/share/elasticsearch/`
+
 If all has gone well, you'll see them being loaded on elasticsearch startup:
 
     [1982-07-06 12:02:43,765][INFO ][plugins                  ] [Junta] loaded [marvel, hamming_distance, euclidean_distance], sites [marvel]
@@ -64,9 +68,9 @@ AND when you call the list of plugins they’ll be there:
 
 produces something like:
 
-    name        component                version type url
-    Junta       hamming_distance         0.1.0   j
-    Junta       euclidean_distance       0.1.0   j
+    name        component                version   type url
+    Junta       hamming_distance         2.3.1.0   j
+    Junta       euclidean_distance       2.3.1.0   j
 
 
 # Usage Examples

build.gradle

@@ -1,5 +1,5 @@
 group 'com.cameraforensics'
-version '0.1.0'
+version '2.3.1.0'
 
 apply plugin: 'java'
 apply plugin: 'java'

euclideandistance/build.gradle

@@ -1,14 +1,14 @@
 group 'com.cameraforensics'
-version '0.1.0'
+version '2.3.1.0'
 
 sourceCompatibility = JavaVersion.VERSION_1_7
 targetCompatibility = JavaVersion.VERSION_1_7
 
 jar {
     baseName = 'euclideandistance'
-    version =  '0.1.0'
+    version =  '2.3.1.0'
 }
 
 dependencies {
-    compile 'org.elasticsearch:elasticsearch:1.7.3'
+    compile 'org.elasticsearch:elasticsearch:2.3.1'
 }

euclideandistance/src/main/java/com/cameraforensics/elasticsearch/plugins/EuclideanDistancePlugin.java

@@ -1,15 +1,24 @@
 package com.cameraforensics.elasticsearch.plugins;
 
-import org.elasticsearch.plugins.AbstractPlugin;
+import org.elasticsearch.plugins.Plugin;
+import org.elasticsearch.script.ScriptModule;
+
+public class EuclideanDistancePlugin extends Plugin {
+
+    private static final String PLUGIN_NAME = "euclidean_distance";
 
-public class EuclideanDistancePlugin extends AbstractPlugin {
     @Override
     public String name() {
-        return "euclidean_distance";
+        return PLUGIN_NAME;
     }
 
     @Override
     public String description() {
         return "A scoring function to calculate the euclidean distance between two hex encoded strings.";
     }
+
+    public void onModule(ScriptModule scriptModule) {
+        scriptModule.registerScript(PLUGIN_NAME, EuclideanDistanceScriptFactory.class);
+    }
+
 }

euclideandistance/src/main/java/com/cameraforensics/elasticsearch/plugins/EuclideanDistanceScriptFactory.java

@@ -11,4 +11,9 @@ public class EuclideanDistanceScriptFactory implements NativeScriptFactory {
     public ExecutableScript newScript(@Nullable Map<String, Object> params) {
         return new EuclideanDistanceScript(params);
     }
+
+    @Override
+    public boolean needsScores() {
+        return false;
+    }
 }

euclideandistance/src/main/resources/es-plugin.properties

@@ -0,0 +1,7 @@
+name=euclidean_distance
+description=A scoring function to calculate the euclidean distance between two hex encoded strings.
+version=2.3.1.0
+jvm=true
+classname=com.cameraforensics.elasticsearch.plugins.EuclideanDistancePlugin
+java.version=1.7
+elasticsearch.version=2.3.1

euclideandistance/src/main/resources/plugin-descriptor.properties

@@ -1,4 +1,4 @@
-#Fri Sep 16 10:09:19 BST 2016
+#Fri Sep 16 10:12:38 BST 2016
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME

gradle/wrapper/gradle-wrapper.properties

@@ -1,14 +1,14 @@
 group 'com.cameraforensics'
-version '0.1.0'
+version '2.3.1.0'
 
 sourceCompatibility = JavaVersion.VERSION_1_7
 targetCompatibility = JavaVersion.VERSION_1_7
 
 jar {
     baseName = 'hammingdistance'
-    version =  '0.1.0'
+    version =  '2.3.1.0'
 }
 
 dependencies {
-    compile 'org.elasticsearch:elasticsearch:1.7.3'
+    compile 'org.elasticsearch:elasticsearch:2.3.1'
 }

hammingdistance/build.gradle

@@ -1,15 +1,23 @@
 package com.cameraforensics.elasticsearch.plugins;
 
-import org.elasticsearch.plugins.AbstractPlugin;
+import org.elasticsearch.plugins.Plugin;
+import org.elasticsearch.script.ScriptModule;
+
+public class HammingDistancePlugin extends Plugin {
+
+    private final String PLUGIN_NAME = "hamming_distance";
 
-public class HammingDistancePlugin extends AbstractPlugin {
     @Override
     public String name() {
-        return "hamming_distance";
+        return PLUGIN_NAME;
     }
 
     @Override
     public String description() {
         return "A scoring function to calculate hamming distance between two hex encoded strings.";
     }
+
+    public void onModule(ScriptModule scriptModule) {
+        scriptModule.registerScript(PLUGIN_NAME, HammingDistanceScriptFactory.class);
+    }
 }