update readme

Author: waderwu

Dockerfile

@@ -0,0 +1,8 @@
+From neo4j:5.12.0
+
+LABEL maintainer="yxxx <[email protected]>"
+
+COPY target/bytecodedl-pathfinder-1.0.0.jar /var/lib/neo4j/plugins
+
+ENV NEO4J_AUTH=neo4j/bytecodedl \
+    NEO4J_dbms_security_procedures_unrestricted=bytecodedl.*

README.md

@@ -5,11 +5,20 @@
 
 ### 简介
 
-实现了自定义procedure `bytecodedl.findOnePath` 
-具体函数签名如下
-
-`findOnePath(@Name("start") Node start, @Name("end") Node end, @Name("maxLength") String maxLength, @Name("minLength") String minLength, @Name("callProperty") String callProperty)`
+实现了自定义procedure
+- `bytecodedl.findOnePath`
+  - `findOnePath(@Name("start") Node start, @Name("end") Node end, @Name("maxLength") Long maxLength @Name("callProperty") String callProperty)`
+- `bytecodedl.biFindOnePath`
+  - `biFindOnePath(@Name("start") Node start, @Name("end") Node end, @Name("maxLength") Long maxLength @Name("callProperty") String callProperty)`
 
 功能包括：
-- 从start到end找到任意一条路径就返回，长度在minlength和maxlength之间
-- 然后找到该路径第一个存在multi dispatch的边，同时返回所有的边
+- 从start到end找到长度小于maxlength任意一条路径就返回 -> 速度较快
+- 然后找到该路径第一个存在multi dispatch的边，同时返回所有的dispatch结果 -> 方便排查virtual invoke存在多个callee的情况
+
+### 安装
+
+- 手动安装
+  - 从[releases](https://github.com/BytecodeDL/bytecodedl-pathfinder-neo4j-procedure/releases/)下载最新的jar, 然后放到neo4j的`/var/lib/neo4j/plugins`目录
+  - 然后在`/var/lib/neo4j/conf/neo4j.conf`增加一行`dbms.security.procedures.unrestricted=bytecodedl.*`
+- docker
+- 

src/main/java/com/bytecodedl/pathfinder/FindAnyOnePath.java

@@ -32,26 +32,14 @@ public class FindAnyOnePath {
     @Procedure(name = "bytecodedl.findOnePath", mode = Mode.READ)
     @Description("find one path from start to end under maxlength, also show first multi dispatch")
     public Stream<PathRecord> findOnePath(@Name("start") Node start, @Name("end") Node end, @Name("maxLength") long maxLength, @Name("callProperty") String callProperty){
-        final Traverser traverse = tx.traversalDescription()
+        final Traverser traverser = tx.traversalDescription()
                 .breadthFirst()
                 .evaluator(Evaluators.toDepth((int)maxLength))
                 .expand(PathExpanders.forTypeAndDirection(RelationshipType.withName("Call"), Direction.OUTGOING ))
                 .uniqueness(Uniqueness.NODE_GLOBAL)
                 .traverse(start);
 
-        Optional<Path> optionalPath = StreamSupport
-                .stream(traverse.spliterator(), false).findFirst();
-
-        if (optionalPath.isPresent()){
-            Path path = optionalPath.get();
-            List<Relationship> multiDispatchRelationship = getFirstMultiDispatch(path, callProperty);
-            List<Path> pathList = multiDispatchRelationship.stream().map(this::relationShipToPath).collect(Collectors.toList());
-            pathList.add(path);
-            return pathList.stream().map(PathRecord::new);
-        }else {
-            return StreamSupport
-                    .stream(traverse.spliterator(), false).map(PathRecord::new);
-        }
+        return returnWithFirstMultiDispatch(traverser, callProperty);
     }
 
     @Procedure(name = "bytecodedl.biFindOnePath", mode = Mode.READ)
@@ -61,7 +49,7 @@ public Stream<PathRecord> biFindOnePath(@Name("start") Node start, @Name("end")
         PathExpander expander = PathExpanders.forTypeAndDirection(RelationshipType.withName("Call"), Direction.OUTGOING );
         int maxDepth = (int) maxLength;
 
-        final Traverser traverse = tx.bidirectionalTraversalDescription()
+        final Traverser traverser = tx.bidirectionalTraversalDescription()
                 .startSide(
                         base.expand(expander)
                                 .evaluator(Evaluators.toDepth(maxDepth / 2))
@@ -71,19 +59,23 @@ public Stream<PathRecord> biFindOnePath(@Name("start") Node start, @Name("end")
                 )
                 .traverse(start, end);
 
+        return returnWithFirstMultiDispatch(traverser, callProperty);
+
+    }
+
+    public Stream<PathRecord> returnWithFirstMultiDispatch(Traverser traverser, String callProperty){
         Optional<Path> optionalPath = StreamSupport
-                .stream(traverse.spliterator(), false).findFirst();
+                .stream(traverser.spliterator(), false).findFirst();
 
         if (optionalPath.isPresent()){
             Path path = optionalPath.get();
-//            System.out.println(path);
             List<Relationship> multiDispatchRelationship = getFirstMultiDispatch(path, callProperty);
             List<Path> pathList = multiDispatchRelationship.stream().map(this::relationShipToPath).collect(Collectors.toList());
             pathList.add(path);
             return pathList.stream().map(PathRecord::new);
         }else {
             return StreamSupport
-                    .stream(traverse.spliterator(), false).map(PathRecord::new);
+                    .stream(traverser.spliterator(), false).map(PathRecord::new);
         }
     }