├── .gitignore ├── LICENSE ├── README.md ├── elasticsearch-hamming-plugin.iml ├── elasticsearch-hamming.iml ├── pom.xml ├── release.sh ├── releases └── elasticsearch-hamming-0.0.1.zip └── src ├── main ├── assemblies │ └── plugin.xml ├── java │ └── com │ │ └── okjike │ │ └── elastic │ │ └── plugin │ │ ├── HammingDistanceNativeScriptPlugin.java │ │ └── hamming │ │ └── HammingDistanceService.java ├── plugin-metadata │ └── plugin-descriptor.properties └── resources │ └── .gitignore └── test ├── java └── HammingDistanceTest.java └── resources └── .gitignore /.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | .idea 3 | 4 | *.class 5 | 6 | # Mobile Tools for Java (J2ME) 7 | .mtj.tmp/ 8 | 9 | # Package Files # 10 | *.jar 11 | *.war 12 | *.ear 13 | 14 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 15 | hs_err_pid* 16 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Elasticsearch Hamming Plugin 2 | 3 | ## Install 4 | 5 | ```shell 6 | $ cd /tmp 7 | $ wget https://github.com/joway/elasticsearch-hamming-plugin/raw/master/releases/elasticsearch-hamming-0.0.1.zip 8 | $ /usr/share/elasticsearch/bin/elasticsearch-plugin install file://`pwd`/elasticsearch-hamming-0.0.1.zip 9 | $ echo "script.inline: true" >> /etc/elasticsearch/elasticsearch.yml && echo "script.stored: true" >> /etc/elasticsearch/elasticsearch.yml 10 | ``` 11 | 12 | ## Usage 13 | 14 | **POST** `/{index_name}/_search` : 15 | 16 | 17 | ```json 18 | { 19 | "query": { 20 | "function_score": { 21 | "query": { 22 | "match_all": {} 23 | }, 24 | "functions": [ 25 | { 26 | "script_score": { 27 | "script": { 28 | "inline": "hamming_distance_native", 29 | "lang": "native", 30 | "params": { 31 | "hash": "3dd3c609f30cd16c", 32 | "field": "phash" 33 | } 34 | } 35 | } 36 | } 37 | ] 38 | } 39 | } 40 | } 41 | ``` 42 | -------------------------------------------------------------------------------- /elasticsearch-hamming-plugin.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | -------------------------------------------------------------------------------- /elasticsearch-hamming.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 3 | 4.0.0 4 | tr.awakening 5 | elasticsearch-hamming 6 | 0.0.1 7 | elasticsearch-hamming 8 | This plugin provides a hamming distance function 9 | 10 | 5.3.0 11 | com.okjike.elastic.plugin.HammingDistanceNativeScriptPlugin 12 | 13 | 1.8 14 | 1.8 15 | 16 | 17 | 18 | 19 | src/main/resources 20 | false 21 | 22 | *.properties 23 | 24 | 25 | 26 | 27 | 28 | 29 | maven-compiler-plugin 30 | 3.3 31 | 32 | ${maven.compiler.source} 33 | ${maven.compiler.target} 34 | UTF-8 35 | 36 | 37 | 38 | maven-assembly-plugin 39 | 2.6 40 | 41 | false 42 | ${project.build.directory}/releases/ 43 | 44 | ${basedir}/src/main/assemblies/plugin.xml 45 | 46 | 47 | 48 | 49 | package 50 | 51 | single 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | org.elasticsearch 61 | elasticsearch 62 | ${elasticsearch.version} 63 | provided 64 | 65 | 66 | junit 67 | junit 68 | 4.12 69 | test 70 | 71 | 72 | org.hamcrest 73 | hamcrest-core 74 | 1.3 75 | test 76 | 77 | 78 | 79 | -------------------------------------------------------------------------------- /release.sh: -------------------------------------------------------------------------------- 1 | cp -r target/releases/ releases/ 2 | -------------------------------------------------------------------------------- /releases/elasticsearch-hamming-0.0.1.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/joway/elasticsearch-hamming-plugin/dcfc04c8c2ba07017105e3187a35997682f8664f/releases/elasticsearch-hamming-0.0.1.zip -------------------------------------------------------------------------------- /src/main/assemblies/plugin.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | plugin 4 | 5 | zip 6 | 7 | false 8 | 9 | 10 | ${basedir}/src/main/plugin-metadata/plugin-descriptor.properties 11 | elasticsearch 12 | true 13 | 14 | 15 | 16 | 17 | elasticsearch 18 | true 19 | true 20 | 21 | org.elasticsearch:elasticsearch 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /src/main/java/com/okjike/elastic/plugin/HammingDistanceNativeScriptPlugin.java: -------------------------------------------------------------------------------- 1 | package com.okjike.elastic.plugin; 2 | 3 | import com.okjike.elastic.plugin.hamming.HammingDistanceService; 4 | import org.elasticsearch.common.inject.internal.Nullable; 5 | import org.elasticsearch.common.xcontent.support.XContentMapValues; 6 | import org.elasticsearch.plugins.Plugin; 7 | import org.elasticsearch.plugins.ScriptPlugin; 8 | import org.elasticsearch.script.AbstractDoubleSearchScript; 9 | import org.elasticsearch.script.ExecutableScript; 10 | import org.elasticsearch.script.NativeScriptFactory; 11 | 12 | import java.util.Collections; 13 | import java.util.List; 14 | import java.util.Map; 15 | 16 | public class HammingDistanceNativeScriptPlugin extends Plugin implements ScriptPlugin { 17 | private static final String NAME = "hamming_distance_native"; 18 | 19 | @Override 20 | public List getNativeScripts() { 21 | return Collections.singletonList(new HammingNativeScriptFactory()); 22 | } 23 | 24 | public static class HammingNativeScriptFactory implements NativeScriptFactory { 25 | @Override 26 | public ExecutableScript newScript(@Nullable Map params) { 27 | String hash = params == null ? null : 28 | XContentMapValues.nodeStringValue(params.get("hash"), null); 29 | String field = params == null ? null : 30 | XContentMapValues.nodeStringValue(params.get("field"), null); 31 | if (hash == null) { 32 | throw new IllegalArgumentException("Missing parameter [hash]"); 33 | } 34 | if (field == null) { 35 | throw new IllegalArgumentException("Missing parameter [field]"); 36 | } 37 | return new HammingNativeScript(hash, field); 38 | } 39 | 40 | @Override 41 | public boolean needsScores() { 42 | return false; 43 | } 44 | 45 | @Override 46 | public String getName() { 47 | return NAME; 48 | } 49 | } 50 | 51 | public static class HammingNativeScript extends AbstractDoubleSearchScript { 52 | 53 | private final String hash; 54 | private final String field; 55 | 56 | HammingNativeScript(String hash, String field) { 57 | this.hash = hash; 58 | this.field = field; 59 | } 60 | 61 | @Override 62 | public double runAsDouble() { 63 | String sourceHash = (String) source().get(field); 64 | int distance = HammingDistanceService.hammingDistanceScore(hash, sourceHash); 65 | return distance; 66 | } 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /src/main/java/com/okjike/elastic/plugin/hamming/HammingDistanceService.java: -------------------------------------------------------------------------------- 1 | package com.okjike.elastic.plugin.hamming; 2 | 3 | import java.math.BigInteger; 4 | 5 | public class HammingDistanceService { 6 | 7 | public static int hammingDistance(String lhs, String rhs) { 8 | return new BigInteger(lhs, 16).xor(new BigInteger(rhs, 16)).bitCount(); 9 | } 10 | 11 | public static int hammingDistanceScore(String lhs, String rhs) { 12 | return Math.max(lhs.length(), rhs.length()) * 4 - hammingDistance(lhs, rhs); 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/main/plugin-metadata/plugin-descriptor.properties: -------------------------------------------------------------------------------- 1 | description=${project.description}. 2 | version=${project.version} 3 | name=${project.artifactId} 4 | classname=com.okjike.elastic.plugin.HammingDistanceNativeScriptPlugin 5 | java.version=1.8 6 | elasticsearch.version=5.3.0 7 | -------------------------------------------------------------------------------- /src/main/resources/.gitignore: -------------------------------------------------------------------------------- 1 | # Ignore everything in this directory 2 | * 3 | # Except this file 4 | !.gitignore 5 | -------------------------------------------------------------------------------- /src/test/java/HammingDistanceTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * To change this license header, choose License Headers in Project Properties. 3 | * To change this template file, choose Tools | Templates 4 | * and open the template in the editor. 5 | */ 6 | 7 | import org.junit.After; 8 | import org.junit.AfterClass; 9 | import org.junit.Before; 10 | import org.junit.BeforeClass; 11 | import org.junit.Test; 12 | import com.okjike.elastic.plugin.hamming.HammingDistanceService; 13 | 14 | /** 15 | * 16 | * @author PC 17 | */ 18 | public class HammingDistanceTest { 19 | 20 | public HammingDistanceTest() { 21 | } 22 | 23 | @BeforeClass 24 | public static void setUpClass() { 25 | } 26 | 27 | @AfterClass 28 | public static void tearDownClass() { 29 | } 30 | 31 | @Before 32 | public void setUp() { 33 | } 34 | 35 | @After 36 | public void tearDown() { 37 | } 38 | 39 | @Test 40 | public void maximumHammingDistance(){ 41 | String hash1 = "0000000000000000"; 42 | String hash2 = "FFFFFFFFFFFFFFFF"; 43 | 44 | int diff = HammingDistanceService.hammingDistance(hash1, hash2); 45 | System.out.println(diff); 46 | assert(diff==64); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/test/resources/.gitignore: -------------------------------------------------------------------------------- 1 | # Ignore everything in this directory 2 | * 3 | # Except this file 4 | !.gitignore 5 | --------------------------------------------------------------------------------