├── .travis.yml ├── .gitignore ├── src ├── test │ └── java │ │ └── scripts │ │ └── ScriptsTest.java └── main │ └── java │ └── scripts │ └── Scripts.java ├── README.adoc ├── pom.xml └── LICENSE /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | 3 | jdk: 4 | - oraclejdk8 5 | 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | \#* 3 | target 4 | out 5 | .project 6 | .classpath 7 | .settings 8 | .externalToolBuilders/ 9 | .scala_dependencies 10 | .factorypath 11 | .cache 12 | .cache-main 13 | .cache-tests 14 | *.iws 15 | *.ipr 16 | *.iml 17 | .idea 18 | .DS_Store 19 | .shell_history 20 | .mailmap 21 | .java-version 22 | .cache-main 23 | .cache-tests 24 | Thumbs.db 25 | .cache-main 26 | .cache-tests 27 | neo4j-home 28 | dependency-reduced-pom.xml 29 | -------------------------------------------------------------------------------- /src/test/java/scripts/ScriptsTest.java: -------------------------------------------------------------------------------- 1 | package scripts; 2 | 3 | import org.junit.Rule; 4 | import org.junit.Test; 5 | 6 | import org.neo4j.driver.v1.*; 7 | import org.neo4j.harness.junit.Neo4jRule; 8 | 9 | import static java.util.Arrays.asList; 10 | 11 | import static org.hamcrest.MatcherAssert.assertThat; 12 | import static org.hamcrest.core.IsEqual.equalTo; 13 | import static org.neo4j.driver.v1.Values.parameters; 14 | 15 | public class ScriptsTest 16 | { 17 | @Rule 18 | public Neo4jRule neo4j = new Neo4jRule().withConfig("dbms.security.procedures.unrestricted","scripts.*").withProcedure( Scripts.class ).withFunction( Scripts.class ); 19 | 20 | @Test 21 | public void shouldAllowCreatingAndRunningJSProcedures() throws Throwable 22 | { 23 | try( Driver driver = GraphDatabase.driver( neo4j.boltURI() , 24 | Config.build().withEncryptionLevel(Config.EncryptionLevel.NONE).toConfig()) ) 25 | { 26 | 27 | try (Session session = driver.session()) { 28 | 29 | long nodeId = session.run("CREATE (p:User {name:'Brookreson'}) RETURN id(p)") 30 | .single() 31 | .get(0).asLong(); 32 | 33 | 34 | session.run("CALL scripts.function({name}, {code})", parameters("name", "users", "code", "function users() { return collection(db.findNodes(label('User'))); }")); 35 | 36 | StatementResult result = session.run("CALL scripts.run('users',null)"); 37 | Value value = result.single().get("value"); 38 | System.out.println(value.asObject()); 39 | assertThat(value.asNode().id(), equalTo(nodeId)); 40 | result = session.run("RETURN scripts.run('users') AS value"); 41 | value = result.single().get("value"); 42 | System.out.println(value.asObject()); 43 | assertThat(value.get(0).asNode().id(), equalTo(nodeId)); 44 | } 45 | } 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | = Neo4j Script Procedures 2 | 3 | image:https://travis-ci.org/neo4j-contrib/neo4j-script-procedures.svg?branch=3.1["Build Status", link="https://travis-ci.org/neo4j-contrib/neo4j-script-procedures"] 4 | 5 | This project demonstrates how to create dynamic procedures and functions on top of Neo4j's built in infrastructure. 6 | 7 | You can create JavaScript functions in your database that can be later run using the 'nashorn' engine. 8 | 9 | [Note] 10 | This project requires Neo4j 3.x 11 | 12 | == Installation 13 | 14 | 1. Download the jar from the http://github.com/neo4j-contrib/neo4j-script-procedures/releases/latest[latest release] 15 | 2. Copy it into your `$NEO4J_HOME/plugins` directory. 16 | 3. Add `dbms.security.procedures.unrestricted=scripts.*` to `$NEO4J_HOME/conf/neo4j.conf` 17 | 4. Restart your server. 18 | 19 | == Operations 20 | 21 | The operations are: 22 | 23 | .create function 24 | [source,cypher] 25 | ---- 26 | CALL scripts.function({name}, {code}) 27 | 28 | {"name" : "users", 29 | "code" : "function users() { return collection(db.findNodes(label('User'))) }"} 30 | ---- 31 | 32 | .run function as procedure 33 | [source,cypher] 34 | ---- 35 | CALL scripts.run({name}[, {params}]) 36 | 37 | CALL scripts.run('users', null) 38 | CALL scripts.run('users') 39 | 40 | -> returns one user per row 41 | ---- 42 | 43 | .run function as function 44 | [source,cypher] 45 | ---- 46 | RETURN scripts.run({name}[, {params}]) 47 | 48 | RETURN scripts.run('users', null) as users 49 | 50 | or 51 | 52 | RETURN scripts.run('users') as users 53 | 54 | -> returns a list of users 55 | ---- 56 | 57 | .list functions 58 | [source,cypher] 59 | ---- 60 | CALL scripts.list() 61 | ---- 62 | 63 | .helper functions 64 | [source,javascript] 65 | ---- 66 | function label(s) { return org.neo4j.graphdb.Label.label(s); } 67 | 68 | function type(s) { return org.neo4j.graphdb.RelationshipType.withName(s); } 69 | 70 | function collection(it) { r=[]; while (it.hasNext()) r.push(it.next()); return Java.to(r); } 71 | ---- 72 | 73 | == Building it yourself 74 | 75 | This project uses maven, to build a jar-file with the procedure in this 76 | project, simply package the project with maven: 77 | 78 | mvn clean package 79 | 80 | This will produce a jar-file,`target/neo4j-script-procedures-*-SNAPSHOT.jar`, that can be copied in the `$NEO4J_HOME/plugins` directory of your Neo4j instance. 81 | 82 | == License 83 | 84 | Apache License V2, see LICENSE 85 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 4 | 4.0.0 5 | 6 | org.neo4j.procedures 7 | neo4j-script-procedures 8 | 3.4.0 9 | 10 | jar 11 | Neo4j Script Procedures 12 | 13 | 14 | UTF-8 15 | 1.8 16 | ${encoding} 17 | ${encoding} 18 | ${java.version} 19 | ${java.version} 20 | 3.4.10 21 | 22 | 23 | 24 | 25 | org.neo4j 26 | neo4j 27 | ${neo4j.version} 28 | provided 29 | 30 | 31 | 32 | net.biville.florent 33 | neo4j-sproc-compiler 34 | 1.1 35 | true 36 | provided 37 | 38 | 39 | 40 | org.neo4j.test 41 | neo4j-harness 42 | ${neo4j.version} 43 | test 44 | 45 | 46 | 47 | org.neo4j.driver 48 | neo4j-java-driver 49 | 1.7.0 50 | test 51 | 52 | 53 | 54 | junit 55 | junit 56 | 4.12 57 | test 58 | 59 | 60 | 61 | 62 | 63 | 64 | maven-shade-plugin 65 | 2.4.3 66 | 67 | 68 | package 69 | 70 | shade 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /src/main/java/scripts/Scripts.java: -------------------------------------------------------------------------------- 1 | package scripts; 2 | 3 | import java.util.List; 4 | import java.util.stream.Stream; 5 | import java.util.stream.StreamSupport; 6 | 7 | import org.neo4j.graphdb.GraphDatabaseService; 8 | import org.neo4j.kernel.internal.GraphDatabaseAPI; 9 | import org.neo4j.kernel.impl.core.EmbeddedProxySPI; 10 | import org.neo4j.kernel.impl.core.GraphProperties; 11 | import org.neo4j.kernel.impl.core.GraphPropertiesProxy; 12 | import org.neo4j.logging.Log; 13 | import org.neo4j.procedure.Context; 14 | import org.neo4j.procedure.Name; 15 | import org.neo4j.procedure.Mode; 16 | import org.neo4j.procedure.PerformsWrites; 17 | import org.neo4j.procedure.Procedure; 18 | import org.neo4j.procedure.UserFunction; 19 | 20 | import javax.script.Invocable; 21 | import javax.script.ScriptEngine; 22 | import javax.script.ScriptEngineManager; 23 | import javax.script.ScriptException; 24 | 25 | import static org.neo4j.helpers.collection.MapUtil.stringMap; 26 | 27 | public class Scripts { 28 | 29 | private static String PREFIX = "script.function."; 30 | public static final Object[] NO_OBJECTS = new Object[0]; 31 | 32 | @Context 33 | public GraphDatabaseAPI db; 34 | 35 | @Context 36 | public Log log; 37 | 38 | private static final GraphPropertiesProxy NO_GRAPH_PROPERTIES = new GraphPropertiesProxy(null); 39 | private static GraphProperties graphProperties = NO_GRAPH_PROPERTIES; 40 | 41 | private static ThreadLocal engine = new ThreadLocal<>(); 42 | 43 | private GraphProperties graphProperties() { 44 | if (graphProperties == NO_GRAPH_PROPERTIES) 45 | graphProperties = this.db.getDependencyResolver().resolveDependency(EmbeddedProxySPI.class).newGraphPropertiesProxy(); 46 | return graphProperties; 47 | } 48 | private ScriptEngine getEngine() { 49 | if (engine.get() == null) { 50 | ScriptEngine js = new ScriptEngineManager().getEngineByName("nashorn"); 51 | addFunctions(js, 52 | "function label(s) org.neo4j.graphdb.Label.label(s)", 53 | "function type(s) org.neo4j.graphdb.RelationshipType.withName(s)", 54 | "function collection(it) { r=[]; while (it.hasNext()) r.push(it.next()); return Java.to(r); }"); 55 | engine.set(js); 56 | } 57 | return engine.get(); 58 | } 59 | 60 | private void addFunctions(ScriptEngine js, String...script) { 61 | try { 62 | for (String s : script) js.eval(s); 63 | } catch (ScriptException e) { 64 | throw new RuntimeException(e); 65 | } 66 | } 67 | 68 | @UserFunction("scripts.run") 69 | public Object runFunction(@Name("name") String name, @Name(value="params",defaultValue="[]") List params) throws ScriptException, NoSuchMethodException { 70 | ScriptEngine js = getEngine(); 71 | String code = (String) graphProperties().getProperty(PREFIX + name, null); 72 | if (code == null) 73 | throw new RuntimeException("Function " + name + " not defined, use CALL function('name','code') "); 74 | 75 | js.put("db", db); 76 | js.put("log", log); 77 | js.eval(String.format("function %s(){ return (%s).apply(this, arguments) }", name, code)); 78 | return ((Invocable) js).invokeFunction(name, params == null ? NO_OBJECTS : params.toArray()); 79 | } 80 | 81 | @Procedure 82 | public Stream run(@Name("name") String name, @Name(value="params",defaultValue="[]") List params) throws ScriptException, NoSuchMethodException { 83 | Object value = runFunction(name, params); 84 | if (value instanceof Object[]) { 85 | return Stream.of((Object[]) value).map(Result::new); 86 | } 87 | if (value instanceof Iterable) { 88 | return StreamSupport.stream(((Iterable)value).spliterator(),false).map(Result::new); 89 | } 90 | return Stream.of(new Result(value)); 91 | } 92 | 93 | @Procedure(mode=Mode.WRITE) 94 | public Stream function(@Name("name") String name, @Name("code") String code) throws ScriptException { 95 | ScriptEngine js = getEngine(); 96 | js.eval("function(){" + code + "}"); 97 | GraphProperties props = graphProperties(); 98 | boolean replaced = props.hasProperty(PREFIX + name); 99 | props.setProperty(PREFIX + name, code); 100 | return Stream.of(new Result(String.format("%s Function %s", replaced ? "Updated" : "Added", name))); 101 | } 102 | 103 | @Procedure(mode=Mode.WRITE) 104 | public Stream delete(@Name("name") String name) { 105 | GraphProperties props = graphProperties(); 106 | props.removeProperty(PREFIX + name); 107 | return Stream.of(new Result(String.format("Function '%s' removed", name))); 108 | } 109 | 110 | 111 | @Procedure 112 | public Stream list() { 113 | return StreamSupport.stream(graphProperties.getPropertyKeys().spliterator(), false).filter(s -> s.startsWith(PREFIX )).map(Result::new); 114 | } 115 | 116 | public static class Result { 117 | public Object value; 118 | 119 | public Result(Object value) { 120 | this.value = value; 121 | } 122 | 123 | } 124 | 125 | } 126 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------