├── demo ├── .gitignore ├── requirements.txt ├── elasticsearch.yml ├── Dockerfile ├── README.md └── demo.py ├── licenses ├── hebmorph-lucene-LICENSE.txt └── hebmorph-lucene-NOTICE.txt ├── settings.gradle ├── NOTICE ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── setup.sh ├── .gitignore ├── plugin-security.policy ├── .travis.yml ├── plugin-security-commercial.policy ├── src ├── test │ ├── resources │ │ └── rest-api-spec │ │ │ └── test │ │ │ └── 10_basic.yml │ └── java │ │ └── com │ │ └── code972 │ │ └── elasticsearch │ │ ├── rest │ │ └── action │ │ │ └── TestRestHebrewAnalyzerCheckWordAction.java │ │ └── plugins │ │ └── index │ │ └── analysis │ │ ├── HebrewAnalysisPluginTests.java │ │ └── HebrewAnalysisQueryRestIT.java └── main │ └── java │ └── com │ └── code972 │ └── elasticsearch │ ├── plugins │ ├── index │ │ └── analysis │ │ │ ├── NiqqudFilterTokenFilterFactory.java │ │ │ ├── MarkHebrewTokensFilterFactory.java │ │ │ ├── AddSuffixTokenFilterFactory.java │ │ │ ├── HebrewExactAnalyzerProvider.java │ │ │ ├── HebrewIndexingAnalyzerProvider.java │ │ │ ├── HebrewQueryAnalyzerProvider.java │ │ │ ├── HebrewQueryLightAnalyzerProvider.java │ │ │ ├── HebrewLemmatizerTokenFilterFactory.java │ │ │ └── HebrewTokenizerFactory.java │ └── rest │ │ └── action │ │ └── RestHebrewAnalyzerCheckWordAction.java │ └── HebrewAnalysisPlugin.java ├── plugin-descriptor.properties.template ├── LICENSE ├── gradlew.bat ├── README.md ├── gradlew └── agpl-3.0.txt /demo/.gitignore: -------------------------------------------------------------------------------- 1 | data/ 2 | -------------------------------------------------------------------------------- /licenses/hebmorph-lucene-LICENSE.txt: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /licenses/hebmorph-lucene-NOTICE.txt: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /demo/requirements.txt: -------------------------------------------------------------------------------- 1 | click 2 | elasticsearch 3 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'elasticsearch-analysis-hebrew' 2 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | Elasticsearch analysis-hebrew plugin and HebMorph 2 | Copyright 2010-2017 Itamar Syn-Hershko 3 | -------------------------------------------------------------------------------- /demo/elasticsearch.yml: -------------------------------------------------------------------------------- 1 | discovery.zen.minimum_master_nodes: 1 2 | xpack.security.enabled: false 3 | network.host: 0.0.0.0 4 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/synhershko/elasticsearch-analysis-hebrew/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /setup.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | wget https://raw.githubusercontent.com/elastic/elasticsearch/v$1/buildSrc/version.properties -O gradle.properties -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | plugin-metadata/ 2 | target/ 3 | releases/ 4 | .idea/ 5 | build/ 6 | .gradle/ 7 | hspell-data-files/ 8 | gradle.properties 9 | *.iml 10 | -------------------------------------------------------------------------------- /plugin-security.policy: -------------------------------------------------------------------------------- 1 | grant { 2 | permission java.io.FilePermission "/var/lib/hspell-data-files", "read"; 3 | permission java.io.FilePermission "/var/lib/hspell-data-files/*", "read"; 4 | }; 5 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | jdk: 3 | - oraclejdk10 4 | 5 | cache: 6 | directories: 7 | - $HOME/.gradle 8 | 9 | script: 10 | - ./setup.sh 6.4.1 11 | - ./gradlew clean updateSHAs check 12 | -------------------------------------------------------------------------------- /plugin-security-commercial.policy: -------------------------------------------------------------------------------- 1 | grant { 2 | permission java.lang.RuntimePermission "accessClassInPackage.sun.reflect.generics.reflectiveObjects"; 3 | 4 | permission java.io.FilePermission "/var/lib/hebmorph/dictionary.dict", "read"; 5 | }; 6 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.0-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /src/test/resources/rest-api-spec/test/10_basic.yml: -------------------------------------------------------------------------------- 1 | "analysis-hebrew plugin installed": 2 | - do: 3 | cluster.state: {} 4 | 5 | - set: {master_node: master} 6 | 7 | - do: 8 | nodes.info: {} 9 | 10 | - match: { nodes.$master.plugins.0.name: analysis-hebrew } 11 | -------------------------------------------------------------------------------- /plugin-descriptor.properties.template: -------------------------------------------------------------------------------- 1 | # Elasticsearch plugin descriptor file 2 | jvm=true 3 | name=analysis-hebrew 4 | description=Hebrew analyzer powered by HebMorph 5 | classname=com.code972.elasticsearch.HebrewAnalysisPlugin 6 | elasticsearch.version=ES-PLUGIN-VERSION 7 | java.version=1.8 8 | version=ES-PLUGIN-VERSION 9 | -------------------------------------------------------------------------------- /demo/Dockerfile: -------------------------------------------------------------------------------- 1 | ARG ES_VERSION 2 | FROM docker.elastic.co/elasticsearch/elasticsearch:$ES_VERSION 3 | EXPOSE 9200 4 | ARG ES_VERSION 5 | ADD elasticsearch.yml /usr/share/elasticsearch/config/ 6 | USER root 7 | RUN chown elasticsearch:elasticsearch config/elasticsearch.yml 8 | USER elasticsearch 9 | WORKDIR /usr/share/elasticsearch 10 | RUN ./bin/elasticsearch-plugin install https://bintray.com/synhershko/elasticsearch-analysis-hebrew/download_file?file_path=elasticsearch-analysis-hebrew-$ES_VERSION.zip 11 | -------------------------------------------------------------------------------- /demo/README.md: -------------------------------------------------------------------------------- 1 | # Demo 2 | 3 | ## Prerequisites 4 | 5 | Make sure you have an Elasticsearch cluster with the Hebrew plugin installed and ready. 6 | 7 | If not, you can build and run a Docker image (everything you need is provided in this folder as well): 8 | 9 | ```bash 10 | export ES_VERSION=5.5.0 11 | docker build --build-arg ES_VERSION=$ES_VERSION -t code972/elasticsearch-analysis-hebrew:v$ES_VERSION . 12 | docker run -p 0.0.0.0:9200:9200 -t code972/elasticsearch-analysis-hebrew:v$ES_VERSION 13 | ``` 14 | 15 | Also required is Python 3 and running the packages installation (`sudo pip3 install -r requirements.txt`). 16 | 17 | ## Running 18 | 19 | Setting up: 20 | 21 | ```bash 22 | python3 demo.py create_index 23 | python3 demo.py index_files --path (path, or put files in a folder called data) 24 | ``` 25 | 26 | And then searching: 27 | 28 | ```bash 29 | ➜ demo git:(master) ✗ python3 tester.py search בדיקה 30 | {'took': 108, 'timed_out': False, '_shards': {'total': 5, 'successful': 5, 'failed': 0}, 'hits': {'total': 1, 'max_score': 0.627985, 'hits': [...]}}]}} 31 | ``` 32 | 33 | The hits array is going to show the IDs, scores and highlighted snippets for each hit. 34 | -------------------------------------------------------------------------------- /src/test/java/com/code972/elasticsearch/rest/action/TestRestHebrewAnalyzerCheckWordAction.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.rest.action; 21 | 22 | /** 23 | * Created by synhershko on 24/06/14. 24 | */ 25 | /*public class TestRestHebrewAnalyzerCheckWordAction { 26 | 27 | @Test 28 | public void testGetLemmas() throws IOException { 29 | assertTrue(getLemmas("בדיקה").size() > 0); 30 | } 31 | } 32 | */ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | HebMorph is copyright (C) 2010-2017, Itamar Syn-Hershko. 2 | 3 | HebMorph relies on Hspell, copyright (C) 2000-2011, Nadav Har'El and Dan Kenigsberg. 4 | 5 | This file is part of HebMorph and elasticsearch-analysis-hebrew. 6 | 7 | This program is free software: you can redistribute it and/or modify 8 | it under the terms of the GNU Affero General Public License v3 as 9 | published by the Free Software Foundation. 10 | 11 | This program is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU Affero General Public License for more details. 15 | 16 | You should have received a copy of the GNU Affero General Public License 17 | along with this program. If not, see . 18 | 19 | Note that not only the programs in the distribution, but also the 20 | dictionary files and the generated word lists, are licensed under the AGPLv3. 21 | There is no warranty of any kind for the contents of this distribution. 22 | 23 | The hspell dictionary files distributed with HebMorph are provided with 24 | the license to be used ONLY for search by HebMorph. To get an official 25 | hspell distribution under the AGPLv3 license, visit their site. -------------------------------------------------------------------------------- /src/test/java/com/code972/elasticsearch/plugins/index/analysis/HebrewAnalysisPluginTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.plugins.index.analysis; 21 | 22 | import com.code972.elasticsearch.HebrewAnalysisPlugin; 23 | import org.elasticsearch.plugins.Plugin; 24 | import org.elasticsearch.test.ESIntegTestCase; 25 | 26 | import java.util.Collection; 27 | import java.util.Collections; 28 | 29 | /** 30 | * Created by synhershko on 10/07/2017. 31 | */ 32 | public class HebrewAnalysisPluginTests extends ESIntegTestCase { 33 | /** 34 | * Returns a collection of plugins that should be loaded on each node. 35 | */ 36 | @Override 37 | protected Collection> nodePlugins() { 38 | return Collections.singletonList(HebrewAnalysisPlugin.class); 39 | } 40 | 41 | public void testPlugin() { 42 | assert(true); 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /src/test/java/com/code972/elasticsearch/plugins/index/analysis/HebrewAnalysisQueryRestIT.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.plugins.index.analysis; 21 | 22 | import com.carrotsearch.randomizedtesting.annotations.Name; 23 | import com.carrotsearch.randomizedtesting.annotations.ParametersFactory; 24 | import org.elasticsearch.test.rest.yaml.ClientYamlTestCandidate; 25 | import org.elasticsearch.test.rest.yaml.ESClientYamlSuiteTestCase; 26 | 27 | /** 28 | * This IT is necessary for the gradle build to pass. 29 | * Test cases are yaml files residing under test resources. 30 | */ 31 | public class HebrewAnalysisQueryRestIT extends ESClientYamlSuiteTestCase { 32 | 33 | public HebrewAnalysisQueryRestIT(@Name("yaml") ClientYamlTestCandidate testCandidate) { 34 | super(testCandidate); 35 | } 36 | 37 | @ParametersFactory 38 | public static Iterable parameters() throws Exception { 39 | return ESClientYamlSuiteTestCase.createParameters(); 40 | } 41 | } -------------------------------------------------------------------------------- /src/main/java/com/code972/elasticsearch/plugins/index/analysis/NiqqudFilterTokenFilterFactory.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.plugins.index.analysis; 21 | 22 | import org.apache.lucene.analysis.TokenStream; 23 | import org.apache.lucene.analysis.hebrew.TokenFilters.NiqqudFilter; 24 | import org.elasticsearch.common.inject.Inject; 25 | import org.elasticsearch.common.settings.Settings; 26 | import org.elasticsearch.env.Environment; 27 | import org.elasticsearch.index.IndexSettings; 28 | import org.elasticsearch.index.analysis.AbstractTokenFilterFactory; 29 | 30 | public class NiqqudFilterTokenFilterFactory extends AbstractTokenFilterFactory { 31 | 32 | @Inject 33 | public NiqqudFilterTokenFilterFactory(IndexSettings indexSettings, Environment env, String name, Settings settings) { 34 | super(indexSettings, name, settings); 35 | } 36 | 37 | @Override 38 | public TokenStream create(TokenStream tokenStream) { 39 | return new NiqqudFilter(tokenStream); 40 | } 41 | } -------------------------------------------------------------------------------- /src/main/java/com/code972/elasticsearch/plugins/index/analysis/MarkHebrewTokensFilterFactory.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.plugins.index.analysis; 21 | 22 | import org.apache.lucene.analysis.TokenStream; 23 | import org.apache.lucene.analysis.hebrew.TokenFilters.MarkHebrewTokensFilter; 24 | import org.elasticsearch.common.inject.Inject; 25 | import org.elasticsearch.common.settings.Settings; 26 | import org.elasticsearch.env.Environment; 27 | import org.elasticsearch.index.IndexSettings; 28 | import org.elasticsearch.index.analysis.AbstractTokenFilterFactory; 29 | 30 | public class MarkHebrewTokensFilterFactory extends AbstractTokenFilterFactory { 31 | 32 | @Inject 33 | public MarkHebrewTokensFilterFactory(IndexSettings indexSettings, Environment env, String name, Settings settings) { 34 | super(indexSettings, name, settings); 35 | } 36 | 37 | @Override 38 | public TokenStream create(TokenStream tokenStream) { 39 | return new MarkHebrewTokensFilter(tokenStream); 40 | } 41 | } -------------------------------------------------------------------------------- /src/main/java/com/code972/elasticsearch/plugins/index/analysis/AddSuffixTokenFilterFactory.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.plugins.index.analysis; 21 | 22 | import org.apache.lucene.analysis.TokenStream; 23 | import org.apache.lucene.analysis.hebrew.TokenFilters.AddSuffixTokenFilter; 24 | import org.elasticsearch.common.inject.Inject; 25 | import org.elasticsearch.common.settings.Settings; 26 | import org.elasticsearch.env.Environment; 27 | import org.elasticsearch.index.IndexSettings; 28 | import org.elasticsearch.index.analysis.AbstractTokenFilterFactory; 29 | 30 | public class AddSuffixTokenFilterFactory extends AbstractTokenFilterFactory { 31 | 32 | private final char suffix; 33 | 34 | @Inject 35 | public AddSuffixTokenFilterFactory(IndexSettings indexSettings, Environment env, String name, Settings settings) { 36 | super(indexSettings, name, settings); 37 | this.suffix = settings.get("suffix", "$").charAt(0); 38 | } 39 | 40 | @Override 41 | public TokenStream create(TokenStream tokenStream) { 42 | return new AddSuffixTokenFilter(tokenStream, suffix); 43 | } 44 | } -------------------------------------------------------------------------------- /src/main/java/com/code972/elasticsearch/plugins/index/analysis/HebrewExactAnalyzerProvider.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.plugins.index.analysis; 21 | 22 | import com.code972.hebmorph.datastructures.DictHebMorph; 23 | import org.apache.lucene.analysis.hebrew.HebrewExactAnalyzer; 24 | import org.elasticsearch.common.inject.Inject; 25 | import org.elasticsearch.common.settings.Settings; 26 | import org.elasticsearch.env.Environment; 27 | import org.elasticsearch.index.IndexSettings; 28 | import org.elasticsearch.index.analysis.AbstractIndexAnalyzerProvider; 29 | 30 | public class HebrewExactAnalyzerProvider extends AbstractIndexAnalyzerProvider { 31 | private final HebrewExactAnalyzer analyzer; 32 | 33 | @Inject 34 | public HebrewExactAnalyzerProvider(IndexSettings indexSettings, Environment env, String name, Settings settings, 35 | final DictHebMorph dict) { 36 | super(indexSettings, name, settings); 37 | analyzer = new HebrewExactAnalyzer(dict); 38 | analyzer.setVersion(this.version); 39 | } 40 | 41 | @Override 42 | public HebrewExactAnalyzer get() { 43 | return analyzer; 44 | } 45 | } -------------------------------------------------------------------------------- /src/main/java/com/code972/elasticsearch/plugins/index/analysis/HebrewIndexingAnalyzerProvider.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.plugins.index.analysis; 21 | 22 | import com.code972.hebmorph.datastructures.DictHebMorph; 23 | import org.apache.lucene.analysis.hebrew.HebrewIndexingAnalyzer; 24 | import org.elasticsearch.common.inject.Inject; 25 | import org.elasticsearch.common.settings.Settings; 26 | import org.elasticsearch.env.Environment; 27 | import org.elasticsearch.index.IndexSettings; 28 | import org.elasticsearch.index.analysis.AbstractIndexAnalyzerProvider; 29 | 30 | public class HebrewIndexingAnalyzerProvider extends AbstractIndexAnalyzerProvider { 31 | private final HebrewIndexingAnalyzer analyzer; 32 | 33 | @Inject 34 | public HebrewIndexingAnalyzerProvider(IndexSettings indexSettings, Environment env, String name, Settings settings, 35 | final DictHebMorph dict) { 36 | super(indexSettings, name, settings); 37 | analyzer = new HebrewIndexingAnalyzer(dict); 38 | analyzer.setVersion(this.version); 39 | } 40 | 41 | @Override 42 | public HebrewIndexingAnalyzer get() { 43 | return analyzer; 44 | } 45 | } -------------------------------------------------------------------------------- /src/main/java/com/code972/elasticsearch/plugins/index/analysis/HebrewQueryAnalyzerProvider.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.plugins.index.analysis; 21 | 22 | import com.code972.hebmorph.datastructures.DictHebMorph; 23 | import org.apache.lucene.analysis.hebrew.HebrewQueryAnalyzer; 24 | import org.elasticsearch.common.inject.Inject; 25 | import org.elasticsearch.common.settings.Settings; 26 | import org.elasticsearch.env.Environment; 27 | import org.elasticsearch.index.IndexSettings; 28 | import org.elasticsearch.index.analysis.AbstractIndexAnalyzerProvider; 29 | 30 | public class HebrewQueryAnalyzerProvider extends AbstractIndexAnalyzerProvider { 31 | private final HebrewQueryAnalyzer hebrewAnalyzer; 32 | 33 | @Inject 34 | public HebrewQueryAnalyzerProvider(IndexSettings indexSettings, Environment env, String name, Settings settings, 35 | final DictHebMorph dict) { 36 | super(indexSettings, name, settings); 37 | hebrewAnalyzer = new HebrewQueryAnalyzer(dict); 38 | hebrewAnalyzer.setVersion(this.version); 39 | } 40 | 41 | @Override 42 | public HebrewQueryAnalyzer get() { 43 | return hebrewAnalyzer; 44 | } 45 | } -------------------------------------------------------------------------------- /src/main/java/com/code972/elasticsearch/plugins/index/analysis/HebrewQueryLightAnalyzerProvider.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.plugins.index.analysis; 21 | 22 | import com.code972.hebmorph.datastructures.DictHebMorph; 23 | import org.apache.lucene.analysis.hebrew.HebrewQueryLightAnalyzer; 24 | import org.elasticsearch.common.inject.Inject; 25 | import org.elasticsearch.common.settings.Settings; 26 | import org.elasticsearch.env.Environment; 27 | import org.elasticsearch.index.IndexSettings; 28 | import org.elasticsearch.index.analysis.AbstractIndexAnalyzerProvider; 29 | 30 | public class HebrewQueryLightAnalyzerProvider extends AbstractIndexAnalyzerProvider { 31 | private final HebrewQueryLightAnalyzer hebrewAnalyzer; 32 | 33 | @Inject 34 | public HebrewQueryLightAnalyzerProvider(IndexSettings indexSettings, Environment env, String name, Settings settings, 35 | final DictHebMorph dict) { 36 | super(indexSettings, name, settings); 37 | hebrewAnalyzer = new HebrewQueryLightAnalyzer(dict); 38 | hebrewAnalyzer.setVersion(this.version); 39 | } 40 | 41 | @Override 42 | public HebrewQueryLightAnalyzer get() { 43 | return hebrewAnalyzer; 44 | } 45 | } -------------------------------------------------------------------------------- /src/main/java/com/code972/elasticsearch/plugins/index/analysis/HebrewLemmatizerTokenFilterFactory.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.plugins.index.analysis; 21 | 22 | import com.code972.hebmorph.datastructures.DictHebMorph; 23 | import org.apache.lucene.analysis.TokenStream; 24 | import org.apache.lucene.analysis.hebrew.TokenFilters.HebrewLemmatizerTokenFilter; 25 | import org.elasticsearch.common.inject.Inject; 26 | import org.elasticsearch.common.settings.Settings; 27 | import org.elasticsearch.env.Environment; 28 | import org.elasticsearch.index.IndexSettings; 29 | import org.elasticsearch.index.analysis.AbstractTokenFilterFactory; 30 | 31 | 32 | public class HebrewLemmatizerTokenFilterFactory extends AbstractTokenFilterFactory { 33 | 34 | private final boolean lemmatizeExact; 35 | private final DictHebMorph dict; 36 | 37 | @Inject 38 | public HebrewLemmatizerTokenFilterFactory(IndexSettings indexSettings, Environment env, String name, Settings settings, 39 | final DictHebMorph dict) { 40 | super(indexSettings, name, settings); 41 | this.dict = dict; 42 | lemmatizeExact = settings.getAsBoolean("lemmatize_exact",false); 43 | } 44 | 45 | @Override 46 | public TokenStream create(TokenStream tokenStream) { 47 | return new HebrewLemmatizerTokenFilter(tokenStream, dict, lemmatizeExact, lemmatizeExact); 48 | } 49 | } -------------------------------------------------------------------------------- /src/main/java/com/code972/elasticsearch/plugins/index/analysis/HebrewTokenizerFactory.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.plugins.index.analysis; 21 | 22 | import com.code972.hebmorph.datastructures.DictHebMorph; 23 | import com.code972.hebmorph.datastructures.DictRadix; 24 | import org.apache.lucene.analysis.Tokenizer; 25 | import org.apache.lucene.analysis.hebrew.HebrewTokenizer; 26 | import org.elasticsearch.common.inject.Inject; 27 | import org.elasticsearch.common.settings.Settings; 28 | import org.elasticsearch.env.Environment; 29 | import org.elasticsearch.index.IndexSettings; 30 | import org.elasticsearch.index.analysis.AbstractTokenizerFactory; 31 | 32 | public class HebrewTokenizerFactory extends AbstractTokenizerFactory { 33 | 34 | @Inject 35 | public HebrewTokenizerFactory(IndexSettings indexSettings, Environment env, String name, Settings settings, 36 | final DictHebMorph dict) { 37 | super(indexSettings, settings, name); 38 | this.dict = dict; 39 | } 40 | 41 | private DictHebMorph dict; 42 | private DictRadix SPECIAL_TOKENIZATION_CASES = null; 43 | private static final char originalTermSuffix = '$'; 44 | 45 | @Override 46 | public Tokenizer create() { 47 | HebrewTokenizer tokenizer = new HebrewTokenizer(dict.getPref(), SPECIAL_TOKENIZATION_CASES); 48 | tokenizer.setSuffixForExactMatch(originalTermSuffix); 49 | return tokenizer; 50 | } 51 | } -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 33 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 34 | 35 | @rem Find java.exe 36 | if defined JAVA_HOME goto findJavaFromJavaHome 37 | 38 | set JAVA_EXE=java.exe 39 | %JAVA_EXE% -version >NUL 2>&1 40 | if "%ERRORLEVEL%" == "0" goto init 41 | 42 | echo. 43 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 44 | echo. 45 | echo Please set the JAVA_HOME variable in your environment to match the 46 | echo location of your Java installation. 47 | 48 | goto fail 49 | 50 | :findJavaFromJavaHome 51 | set JAVA_HOME=%JAVA_HOME:"=% 52 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 53 | 54 | if exist "%JAVA_EXE%" goto init 55 | 56 | echo. 57 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 58 | echo. 59 | echo Please set the JAVA_HOME variable in your environment to match the 60 | echo location of your Java installation. 61 | 62 | goto fail 63 | 64 | :init 65 | @rem Get command-line arguments, handling Windows variants 66 | 67 | if not "%OS%" == "Windows_NT" goto win9xME_args 68 | 69 | :win9xME_args 70 | @rem Slurp the command line arguments. 71 | set CMD_LINE_ARGS= 72 | set _SKIP=2 73 | 74 | :win9xME_args_slurp 75 | if "x%~1" == "x" goto execute 76 | 77 | set CMD_LINE_ARGS=%* 78 | 79 | :execute 80 | @rem Setup the command line 81 | 82 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 83 | 84 | @rem Execute Gradle 85 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 86 | 87 | :end 88 | @rem End local scope for the variables with windows NT shell 89 | if "%ERRORLEVEL%"=="0" goto mainEnd 90 | 91 | :fail 92 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 93 | rem the _cmd.exe /c_ return code! 94 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 95 | exit /b 1 96 | 97 | :mainEnd 98 | if "%OS%"=="Windows_NT" endlocal 99 | 100 | :omega 101 | -------------------------------------------------------------------------------- /demo/demo.py: -------------------------------------------------------------------------------- 1 | import os, json 2 | 3 | import click 4 | from elasticsearch import helpers, Elasticsearch 5 | 6 | DEFAULT_INDEX_NAME = 'hebrew-texts' 7 | es = Elasticsearch(hosts=['http://localhost:9200']) 8 | 9 | 10 | @click.group() 11 | def cli(): 12 | pass 13 | 14 | 15 | @cli.command() 16 | @click.option('--index-name', default=DEFAULT_INDEX_NAME, help='Index name to use') 17 | @click.option('--path', default='data', help='Data path to index') 18 | def index_files(path, index_name): 19 | docs = [] 20 | for filename in os.listdir(path): 21 | doc = None 22 | if filename.endswith(".json"): 23 | doc = json.load(os.path.join(path, filename)) 24 | elif filename.endswith(".html") or filename.endswith(".htm") or filename.endswith(".txt"): 25 | with open(os.path.join(path, filename), 'r') as f: 26 | contents = f.read() 27 | doc = {'content': contents} 28 | 29 | if doc: 30 | print("Indexing " + os.path.join(path, filename)) 31 | doc['filename'] = filename 32 | docs.append(doc) 33 | 34 | total, errors = helpers.bulk(es, [{ 35 | '_op_type': 'index', 36 | '_index': index_name, 37 | '_type': 'doc', 38 | '_source': doc 39 | } for doc in docs]) 40 | 41 | assert not errors 42 | print("Indexed total of %d documents" % total) 43 | 44 | 45 | @cli.command() 46 | @click.option('--index-name', default=DEFAULT_INDEX_NAME, help='Index name to use') 47 | def create_index(index_name): 48 | es.indices.create(index_name, { 49 | "settings": { 50 | "analysis": { 51 | "analyzer": { 52 | "hebrew_html": { 53 | "type": "custom", 54 | "char_filter": ["html_strip"], 55 | "tokenizer": "hebrew", 56 | "filter": ["niqqud", "hebrew_lemmatizer", "add_suffix"] 57 | } 58 | } 59 | } 60 | }, 61 | "mappings": { 62 | "doc": { 63 | "properties": { 64 | "content": { 65 | "analyzer": "hebrew", 66 | "type": "text", 67 | "term_vector": "with_positions_offsets", 68 | "fields": { 69 | "no_html": { 70 | "analyzer": "hebrew_html", 71 | "type": "text", 72 | "term_vector": "with_positions_offsets" 73 | } 74 | } 75 | } 76 | } 77 | } 78 | } 79 | }) 80 | print("Index %s was created successfully" % index_name) 81 | 82 | 83 | @cli.command() 84 | @click.option('--index-name', default=DEFAULT_INDEX_NAME, help='Index name to use') 85 | def delete_index(index_name): 86 | if es.indices.exists(index_name): 87 | es.indices.delete(index_name) 88 | print("Index %s no longer exists" % index_name) 89 | 90 | 91 | @cli.command() 92 | @click.argument('query') 93 | @click.option('--index-name', default=DEFAULT_INDEX_NAME, help='Index name to use') 94 | def search(query, index_name): 95 | print(es.search(index=index_name, body={ 96 | '_source': ['filename'], 97 | 'query': {'match': {'content': {'query': query, 'operator': 'and'}}}, 98 | 'highlight': { 99 | 'fields': { 100 | 'content': {"fragment_size": 250, "number_of_fragments": 5}, 101 | 'content.no_html': {"fragment_size": 250, "number_of_fragments": 5} 102 | } 103 | } 104 | })) 105 | 106 | 107 | @cli.command() 108 | @click.option('--index-name', default=DEFAULT_INDEX_NAME, help='Index name to use') 109 | def index_dummy(index_name): 110 | docs = [{'content': 'בפברואר', 'filename': '1'}] 111 | 112 | total, errors = helpers.bulk(es, [{ 113 | '_op_type': 'index', 114 | '_index': index_name, 115 | '_type': 'doc', 116 | '_source': doc 117 | } for doc in docs]) 118 | 119 | assert not errors 120 | print("Indexed total of %d documents" % total) 121 | 122 | 123 | if __name__ == '__main__': 124 | cli() 125 | -------------------------------------------------------------------------------- /src/main/java/com/code972/elasticsearch/plugins/rest/action/RestHebrewAnalyzerCheckWordAction.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch.plugins.rest.action; 21 | 22 | import com.code972.elasticsearch.HebrewAnalysisPlugin; 23 | import com.code972.hebmorph.WordType; 24 | import com.code972.hebmorph.datastructures.DictHebMorph; 25 | import org.apache.lucene.analysis.Analyzer; 26 | import org.apache.lucene.analysis.TokenStream; 27 | import org.apache.lucene.analysis.hebrew.HebrewAnalyzer; 28 | import org.apache.lucene.analysis.hebrew.HebrewQueryLightAnalyzer; 29 | import org.apache.lucene.analysis.tokenattributes.CharTermAttribute; 30 | import org.elasticsearch.client.node.NodeClient; 31 | import org.elasticsearch.common.inject.Inject; 32 | import org.elasticsearch.common.xcontent.XContentBuilder; 33 | import org.elasticsearch.rest.BaseRestHandler; 34 | import org.elasticsearch.rest.BytesRestResponse; 35 | import org.elasticsearch.rest.RestController; 36 | import org.elasticsearch.rest.RestRequest; 37 | import org.elasticsearch.rest.RestStatus; 38 | 39 | import java.io.IOException; 40 | import java.util.ArrayList; 41 | import java.util.List; 42 | 43 | import static org.elasticsearch.rest.RestRequest.Method.GET; 44 | 45 | /** 46 | * REST endpoint for getting lemmas for a given word 47 | */ 48 | public class RestHebrewAnalyzerCheckWordAction extends BaseRestHandler { 49 | @Inject 50 | public RestHebrewAnalyzerCheckWordAction(RestController controller) { 51 | super(); 52 | controller.registerHandler(GET, "/_hebrew/check-word/{word}", this); 53 | } 54 | 55 | @Override 56 | public String getName() { 57 | return "hebrew_analyzer_check_word"; 58 | } 59 | 60 | @Override 61 | protected RestChannelConsumer prepareRequest(final RestRequest request, final NodeClient nodeClient) throws IOException { 62 | final String word = request.param("word"); 63 | final boolean tolerate = request.paramAsBoolean("tolerate", true); 64 | 65 | return channel -> { 66 | final DictHebMorph dict; 67 | if ((dict = HebrewAnalysisPlugin.getDictionary()) == null) 68 | throw new IllegalStateException("Dictionary was not initialized"); 69 | 70 | final XContentBuilder builder = channel.newBuilder().startObject(); 71 | final WordType wordType = HebrewAnalyzer.isRecognizedWord(word, tolerate, dict); 72 | builder.field("word", word); 73 | builder.field("wordType", wordType); 74 | if (wordType != WordType.UNRECOGNIZED && wordType != WordType.NON_HEBREW) { 75 | builder.startArray("lemmas"); 76 | for (String lemma : getLemmas(word, dict)) { 77 | builder.value(lemma); 78 | } 79 | builder.endArray(); 80 | } 81 | builder.endObject(); 82 | channel.sendResponse(new BytesRestResponse(RestStatus.OK, builder)); 83 | }; 84 | } 85 | 86 | private List getLemmas(final String word, final DictHebMorph dict) throws IOException { 87 | final List ret = new ArrayList<>(); 88 | final Analyzer a = new HebrewQueryLightAnalyzer(dict); 89 | final TokenStream ts = a.tokenStream("foo", word); 90 | ts.reset(); 91 | 92 | while (ts.incrementToken()) { 93 | CharTermAttribute cta = ts.getAttribute(CharTermAttribute.class); 94 | ret.add(new String(cta.buffer(), 0, cta.length())); 95 | } 96 | ts.close(); 97 | return ret; 98 | } 99 | } 100 | 101 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Hebrew analyzer for Elasticsearch 2 | 3 | Powered by HebMorph (https://github.com/synhershko/HebMorph) and licensed under the AGPL3 4 | 5 | [![](https://travis-ci.org/synhershko/elasticsearch-analysis-hebrew.svg?branch=master)](https://travis-ci.org/synhershko/elasticsearch-analysis-hebrew) [ ![Download](https://api.bintray.com/packages/synhershko/elasticsearch-analysis-hebrew/elasticsearch-analysis-hebrew-plugin/images/download.svg) ](https://bintray.com/synhershko/elasticsearch-analysis-hebrew/elasticsearch-analysis-hebrew-plugin/_latestVersion) 6 | 7 | ## Installation 8 | 9 | First, install the plugin by invoking the command which fits your elasticsearch version (older versions can be found at the bottom): 10 | 11 | ``` 12 | ./bin/elasticsearch-plugin install https://bintray.com/synhershko/elasticsearch-analysis-hebrew/download_file?file_path=elasticsearch-analysis-hebrew-5.3.0.zip 13 | ``` 14 | 15 | For earlier versions (2.x and before) the installation looks a bit different: 16 | 17 | ``` 18 | ./bin/plugin install https://bintray.com/synhershko/elasticsearch-analysis-hebrew/download_file?file_path=elasticsearch-analysis-hebrew-2.4.2 19 | ``` 20 | 21 | During installation, you may be prompted for additional permissions: 22 | 23 | ``` 24 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ 25 | @ WARNING: plugin requires additional permissions @ 26 | @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ 27 | * java.io.FilePermission /var/lib/hebmorph/dictionary.dict read 28 | * java.io.FilePermission /var/lib/hspell-data-files read 29 | * java.io.FilePermission /var/lib/hspell-data-files/* read 30 | * java.lang.RuntimePermission accessClassInPackage.sun.reflect.generics.reflectiveObjects 31 | See http://docs.oracle.com/javase/8/docs/technotes/guides/security/permissions.html 32 | for descriptions of what these permissions allow and the associated risks. 33 | 34 | Continue with installation? [y/N]y 35 | ``` 36 | 37 | This is normal - please confirm by typing y and hitting Enter. 38 | 39 | Then be sure to restart the ElasticSearch service. 40 | 41 | ## Dictionaries 42 | 43 | This plugin uses dictionary files for it's operation. The open-source version is using hspell data files. In the 5.x versions, the dictionaries are bundled in the plugin download itself. 44 | 45 | For earlier versions, you will need to obtain the Hebrew dictionary files yourself. The open-sourced hspell files can be downloaded here: https://github.com/synhershko/HebMorph/tree/master/hspell-data-files. Download the entire folder and copy it to be either in the plugin's folder (meaning, `plugins/analysis-hebrew/hspell-data-files`) or under `/var/lib/hspell-data-files`. 46 | 47 | Elasticsearch can also be configured to load the dictionary from another folder, this is done by adding the following line to elasticsearch.yml file: 48 | 49 | ``` 50 | hebrew.dict.path: /PATH/TO/HSPELL/FOLDER 51 | ``` 52 | 53 | You will also need to edit `plugin-security.policy` accordingly. 54 | 55 | The dictionary used in by the commercial verion follows a similar pattern. 56 | 57 | You can confirm installation by launching elasticsearch and seeing the following in the logs: 58 | 59 | ``` 60 | [2017-03-22T15:43:05,927][INFO ][c.c.e.HebrewAnalysisPlugin] Defaulting to HSpell dictionary loader 61 | [2017-03-22T15:43:07,751][INFO ][c.c.e.HebrewAnalysisPlugin] Trying to load hspell from path plugins/analysis-hebrew/hspell-data-files/ 62 | [2017-03-22T15:43:07,751][INFO ][c.c.e.HebrewAnalysisPlugin] Dictionary 'hspell' loaded successfully from path plugins/analysis-hebrew/hspell-data-files/ 63 | ``` 64 | 65 | The easiest way to make sure the plugin is installed correctly is to request `/_hebrew/check-word/בדיקה` on your server (for example: browse to http://localhost:9200/_hebrew/check-word/בדיקה). If it loads, it means everything is set up and you are good to go. 66 | 67 | ## Commercial 68 | 69 | Hebmorph is released open-sourced, alongside with hspell dictionary files. The Commercial option will grant you further support in making Hebrew search even better, and it comes with a proprietary dictionary. For more information, check out http://code972.com/hebmorph. 70 | 71 | ## Usage 72 | 73 | Use "hebrew" as analyzer name for fields containing Hebrew text 74 | 75 | Query using "hebrew_query" or "hebrew_query_light" to enable exact matches support. "hebrew_exact" analyzer is available for query_string / match queries to be searched exact without lemma expansion. 76 | 77 | Because Hebrew uses quote marks to mark acronyms, it is recommended to use the match family queries and not query_string. This is the official recommendation anyway. This plugin does not currently ship with a QueryParser implementation that can be used to power query_string queries. 78 | 79 | Here is a sample Sense / Console syntax demonstrating usage of the analyzers in this plugin: 80 | 81 | ``` 82 | GET /_hebrew/check-word/בדיקה 83 | 84 | PUT test-hebrew 85 | { 86 | "mappings": { 87 | "test": { 88 | "properties": { 89 | "content": { 90 | "type": "text", 91 | "analyzer": "hebrew" 92 | } 93 | } 94 | } 95 | } 96 | } 97 | 98 | PUT test-hebrew/test/1 99 | { 100 | "content": "בדיקות" 101 | } 102 | 103 | POST test-hebrew/_search 104 | { 105 | "query": { 106 | "match": { 107 | "content": "בדיקה" 108 | } 109 | } 110 | } 111 | ``` 112 | 113 | ## Older Versions 114 | 115 | Elasticsearch versions 1.4.0 - 1.7.3: 116 | 117 | ``` 118 | bin/plugin --install analysis-hebrew --url https://bintray.com/artifact/download/synhershko/elasticsearch-analysis-hebrew/elasticsearch-analysis-hebrew-1.7.zip 119 | ``` 120 | 121 | Even older versions: 122 | 123 | ~/elasticsearch-0.90.11$ bin/plugin --install analysis-hebrew --url https://bintray.com/artifact/download/synhershko/elasticsearch-analysis-hebrew/elasticsearch-analysis-hebrew-1.0.zip 124 | 125 | ~/elasticsearch-1.0.0$ bin/plugin --install analysis-hebrew --url https://bintray.com/artifact/download/synhershko/elasticsearch-analysis-hebrew/elasticsearch-analysis-hebrew-1.2.zip 126 | 127 | ~/elasticsearch-1.2.1$ bin/plugin --install analysis-hebrew --url https://bintray.com/artifact/download/synhershko/elasticsearch-analysis-hebrew/elasticsearch-analysis-hebrew-1.4.zip 128 | 129 | ~/elasticsearch-1.3.2$ bin/plugin --install analysis-hebrew --url https://bintray.com/artifact/download/synhershko/elasticsearch-analysis-hebrew/elasticsearch-analysis-hebrew-1.5.zip 130 | 131 | ## License 132 | 133 | AGPL3, see LICENSE 134 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> \(.*\)$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | # Determine the Java command to use to start the JVM. 86 | if [ -n "$JAVA_HOME" ] ; then 87 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 88 | # IBM's JDK on AIX uses strange locations for the executables 89 | JAVACMD="$JAVA_HOME/jre/sh/java" 90 | else 91 | JAVACMD="$JAVA_HOME/bin/java" 92 | fi 93 | if [ ! -x "$JAVACMD" ] ; then 94 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 95 | 96 | Please set the JAVA_HOME variable in your environment to match the 97 | location of your Java installation." 98 | fi 99 | else 100 | JAVACMD="java" 101 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 102 | 103 | Please set the JAVA_HOME variable in your environment to match the 104 | location of your Java installation." 105 | fi 106 | 107 | # Increase the maximum file descriptors if we can. 108 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 109 | MAX_FD_LIMIT=`ulimit -H -n` 110 | if [ $? -eq 0 ] ; then 111 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 112 | MAX_FD="$MAX_FD_LIMIT" 113 | fi 114 | ulimit -n $MAX_FD 115 | if [ $? -ne 0 ] ; then 116 | warn "Could not set maximum file descriptor limit: $MAX_FD" 117 | fi 118 | else 119 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 120 | fi 121 | fi 122 | 123 | # For Darwin, add options to specify how the application appears in the dock 124 | if $darwin; then 125 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 126 | fi 127 | 128 | # For Cygwin or MSYS, switch paths to Windows format before running java 129 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then 130 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 131 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 132 | JAVACMD=`cygpath --unix "$JAVACMD"` 133 | 134 | # We build the pattern for arguments to be converted via cygpath 135 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 136 | SEP="" 137 | for dir in $ROOTDIRSRAW ; do 138 | ROOTDIRS="$ROOTDIRS$SEP$dir" 139 | SEP="|" 140 | done 141 | OURCYGPATTERN="(^($ROOTDIRS))" 142 | # Add a user-defined pattern to the cygpath arguments 143 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 144 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 145 | fi 146 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 147 | i=0 148 | for arg in "$@" ; do 149 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 150 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 151 | 152 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 153 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 154 | else 155 | eval `echo args$i`="\"$arg\"" 156 | fi 157 | i=`expr $i + 1` 158 | done 159 | case $i in 160 | 0) set -- ;; 161 | 1) set -- "$args0" ;; 162 | 2) set -- "$args0" "$args1" ;; 163 | 3) set -- "$args0" "$args1" "$args2" ;; 164 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;; 165 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 166 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 167 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 168 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 169 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 170 | esac 171 | fi 172 | 173 | # Escape application args 174 | save () { 175 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 176 | echo " " 177 | } 178 | APP_ARGS=`save "$@"` 179 | 180 | # Collect all arguments for the java command, following the shell quoting and substitution rules 181 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 182 | 183 | exec "$JAVACMD" "$@" 184 | -------------------------------------------------------------------------------- /src/main/java/com/code972/elasticsearch/HebrewAnalysisPlugin.java: -------------------------------------------------------------------------------- 1 | /* 2 | * HebMorph's elasticsearch-analysis-hebrew 3 | * Copyright (C) 2010-2017 Itamar Syn-Hershko 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU Affero General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Affero General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU Affero General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | package com.code972.elasticsearch; 21 | 22 | 23 | import com.code972.elasticsearch.plugins.index.analysis.AddSuffixTokenFilterFactory; 24 | import com.code972.elasticsearch.plugins.index.analysis.HebrewExactAnalyzerProvider; 25 | import com.code972.elasticsearch.plugins.index.analysis.HebrewIndexingAnalyzerProvider; 26 | import com.code972.elasticsearch.plugins.index.analysis.HebrewLemmatizerTokenFilterFactory; 27 | import com.code972.elasticsearch.plugins.index.analysis.HebrewQueryAnalyzerProvider; 28 | import com.code972.elasticsearch.plugins.index.analysis.HebrewQueryLightAnalyzerProvider; 29 | import com.code972.elasticsearch.plugins.index.analysis.HebrewTokenizerFactory; 30 | import com.code972.elasticsearch.plugins.index.analysis.MarkHebrewTokensFilterFactory; 31 | import com.code972.elasticsearch.plugins.index.analysis.NiqqudFilterTokenFilterFactory; 32 | import com.code972.elasticsearch.plugins.rest.action.RestHebrewAnalyzerCheckWordAction; 33 | import com.code972.hebmorph.DictionaryLoader; 34 | import com.code972.hebmorph.datastructures.DictHebMorph; 35 | import com.code972.hebmorph.hspell.HSpellDictionaryLoader; 36 | import org.apache.logging.log4j.LogManager; 37 | import org.apache.logging.log4j.Logger; 38 | import org.apache.lucene.analysis.Analyzer; 39 | import org.elasticsearch.SpecialPermission; 40 | import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver; 41 | import org.elasticsearch.cluster.node.DiscoveryNodes; 42 | import org.elasticsearch.common.SuppressForbidden; 43 | import org.elasticsearch.common.settings.ClusterSettings; 44 | import org.elasticsearch.common.settings.IndexScopedSettings; 45 | import org.elasticsearch.common.settings.Settings; 46 | import org.elasticsearch.common.settings.SettingsFilter; 47 | import org.elasticsearch.env.Environment; 48 | import org.elasticsearch.index.analysis.AnalyzerProvider; 49 | import org.elasticsearch.index.analysis.TokenFilterFactory; 50 | import org.elasticsearch.index.analysis.TokenizerFactory; 51 | import org.elasticsearch.indices.analysis.AnalysisModule; 52 | import org.elasticsearch.plugins.ActionPlugin; 53 | import org.elasticsearch.plugins.AnalysisPlugin; 54 | import org.elasticsearch.plugins.Plugin; 55 | import org.elasticsearch.rest.RestController; 56 | import org.elasticsearch.rest.RestHandler; 57 | 58 | import java.io.IOException; 59 | import java.lang.reflect.Constructor; 60 | import java.lang.reflect.InvocationTargetException; 61 | import java.nio.file.Files; 62 | import java.nio.file.Path; 63 | import java.nio.file.Paths; 64 | import java.security.AccessController; 65 | import java.security.PrivilegedAction; 66 | import java.util.HashMap; 67 | import java.util.List; 68 | import java.util.Map; 69 | import java.util.function.Supplier; 70 | 71 | import static java.util.Collections.singletonList; 72 | import static java.util.Collections.singletonMap; 73 | import static java.util.Collections.unmodifiableMap; 74 | 75 | 76 | /** 77 | * The Hebrew analysis plugin entry point, locating and loading the dictionary and configuring 78 | * the tokenizer, token filters and analyzers 79 | */ 80 | public final class HebrewAnalysisPlugin extends Plugin implements ActionPlugin, AnalysisPlugin { 81 | 82 | private final Logger log = LogManager.getLogger(this.getClass()); 83 | 84 | private final String commercialDictionaryLoaderClass = "com.code972.hebmorph.dictionary.impl.HebMorphDictionaryLoader"; 85 | 86 | private static DictHebMorph dict; 87 | public static DictHebMorph getDictionary() { 88 | return dict; 89 | } 90 | 91 | /** 92 | * Attempts to load a dictionary from paths specified in elasticsearch.yml. 93 | * If hebrew.dict.path is defined, try loading that first. 94 | * 95 | * @param settings settings 96 | */ 97 | public HebrewAnalysisPlugin(final Settings settings, final Path configPath) { 98 | super(); 99 | 100 | final SecurityManager sm = System.getSecurityManager(); 101 | if (sm != null) { 102 | // unprivileged code such as scripts do not have SpecialPermission 103 | sm.checkPermission(new SpecialPermission()); 104 | } 105 | 106 | // Figure out which DictionaryLoader class to use for loading the dictionary 107 | DictionaryLoader dictLoader = (DictionaryLoader) AccessController.doPrivileged((PrivilegedAction) () -> { 108 | try { 109 | final Class clz; 110 | if ((clz = Class.forName(commercialDictionaryLoaderClass)) != null) { 111 | log.info("Dictionary loader available ({})", clz.getSimpleName()); 112 | try { 113 | Constructor ctor = Class.forName(commercialDictionaryLoaderClass).getConstructor(); 114 | return (DictionaryLoader) ctor.newInstance(); 115 | } catch (NoSuchMethodException | IllegalAccessException | InstantiationException | InvocationTargetException e) { 116 | log.error("Unable to load the HebMorph dictionary", e); 117 | } 118 | } 119 | } catch (ClassNotFoundException ignored) { 120 | // If external dictionary loaders are not present, we default to the one provided with OSS HebMorph 121 | } 122 | return null; 123 | }); 124 | 125 | if (dictLoader == null) { 126 | log.info("Defaulting to HSpell dictionary loader"); 127 | dictLoader = new HSpellDictionaryLoader(); 128 | } 129 | 130 | // If path was specified in settings, try that path first 131 | final String pathFromSettings = settings.get("hebrew.dict.path"); 132 | if (pathFromSettings != null && !pathFromSettings.isEmpty()) { 133 | log.info("Trying to load {} dictionary from path {}", dictLoader.dictionaryLoaderName(), pathFromSettings); 134 | final DictHebMorph tmp = AccessController.doPrivileged(new LoadDictAction(pathFromSettings, dictLoader)); 135 | if (tmp != null) { 136 | dict = tmp; 137 | log.info("Dictionary '{}' loaded successfully from path {}", dictLoader.dictionaryLoaderName(), pathFromSettings); 138 | return; 139 | } 140 | } 141 | 142 | final Environment env = new Environment(settings, configPath); 143 | for (final String path : dictLoader.getPossiblePaths(env.pluginsFile().resolve("analysis-hebrew").toAbsolutePath().toString())) { 144 | log.info("Trying to load {} from path {}", dictLoader.dictionaryLoaderName(), path); 145 | final DictHebMorph tmp = AccessController.doPrivileged(new LoadDictAction(path, dictLoader)); 146 | if (tmp != null) { 147 | dict = tmp; 148 | log.info("Dictionary '{}' loaded successfully from path {}", dictLoader.dictionaryLoaderName(), path); 149 | return; 150 | } 151 | } 152 | 153 | log.error("Could not load any dictionary. Hebrew analysis plugin is essentially disabled."); 154 | } 155 | 156 | private class LoadDictAction implements PrivilegedAction { 157 | 158 | private final String path; 159 | private final DictionaryLoader loader; 160 | 161 | LoadDictAction(final String path, DictionaryLoader dictLoader) { 162 | this.path = path; 163 | this.loader = dictLoader; 164 | } 165 | 166 | @Override 167 | @SuppressForbidden(reason = "Paths are loaded using Environment so are safe to use") 168 | public DictHebMorph run() { 169 | try { 170 | if (Files.exists(Paths.get(path))) { 171 | try { 172 | return loader.loadDictionaryFromPath(path); 173 | } catch (IOException e) { 174 | log.warn(e); 175 | } 176 | } 177 | } catch (java.security.AccessControlException e) { 178 | log.warn(e); 179 | } 180 | return null; 181 | } 182 | } 183 | 184 | @Override 185 | public List getRestHandlers(Settings settings, RestController restController, 186 | ClusterSettings clusterSettings, IndexScopedSettings indexScopedSettings, 187 | SettingsFilter settingsFilter, 188 | IndexNameExpressionResolver indexNameExpressionResolver, 189 | Supplier nodesInCluster) { 190 | return singletonList(new RestHebrewAnalyzerCheckWordAction(restController)); 191 | } 192 | 193 | @Override 194 | public Map> getTokenFilters() { 195 | final Map> extra = new HashMap<>(); 196 | extra.put("hebrew_lemmatizer", (indexSettings, env, name, settings) -> 197 | new HebrewLemmatizerTokenFilterFactory(indexSettings, env, name, settings, dict)); 198 | extra.put("niqqud", NiqqudFilterTokenFilterFactory::new); 199 | extra.put("add_suffix", AddSuffixTokenFilterFactory::new); 200 | extra.put("mark_hebrew_tokens", MarkHebrewTokensFilterFactory::new); 201 | return unmodifiableMap(extra); 202 | } 203 | 204 | @Override 205 | public Map> getTokenizers() { 206 | return singletonMap("hebrew", (indexSettings, env, name, settings) -> 207 | new HebrewTokenizerFactory(indexSettings, env, name, settings, dict)); 208 | } 209 | 210 | @Override 211 | public Map>> getAnalyzers() { 212 | final Map>> extra = 213 | new HashMap<>(); 214 | extra.put("hebrew", (indexSettings, env, name, settings) -> 215 | new HebrewIndexingAnalyzerProvider(indexSettings, env, name, settings, dict)); 216 | extra.put("hebrew_query", (indexSettings, env, name, settings) -> 217 | new HebrewQueryAnalyzerProvider(indexSettings, env, name, settings, dict)); 218 | extra.put("hebrew_query_light", (indexSettings, env, name, settings) -> 219 | new HebrewQueryLightAnalyzerProvider(indexSettings, env, name, settings, dict)); 220 | extra.put("hebrew_exact", (indexSettings, env, name, settings) -> 221 | new HebrewExactAnalyzerProvider(indexSettings, env, name, settings, dict)); 222 | return unmodifiableMap(extra); 223 | } 224 | } 225 | -------------------------------------------------------------------------------- /agpl-3.0.txt: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------