feat(common,directory): #WB-1404, framework extension for actualites app requirements (#622)

* feat(common): #WB-1404, add a hook for running post-SQL scripts tasks

* Add a method to get details on users' structures

Author: jcbe-ode

common/src/main/java/org/entcore/common/http/BaseServer.java

@@ -35,6 +35,7 @@
 
 import io.vertx.core.Promise;
 import io.vertx.core.shareddata.LocalMap;
+
 import org.entcore.common.cache.CacheFilter;
 import org.entcore.common.cache.CacheService;
 import org.entcore.common.cache.RedisCacheService;
@@ -62,6 +63,7 @@
 import org.entcore.common.utils.Config;
 import org.entcore.common.utils.Mfa;
 import org.entcore.common.utils.Zip;
+
 import io.vertx.core.AsyncResult;
 import io.vertx.core.Handler;
 import io.vertx.core.buffer.Buffer;
@@ -71,6 +73,8 @@
 import java.io.File;
 import java.util.*;
 
+import io.vertx.core.Future;
+
 public abstract class BaseServer extends Server {
 	public static final String ONDEPLOY_I18N = "ondeploy.i18n";
 	private static String moduleName;
@@ -254,8 +258,10 @@ protected void initModulesHelpers(String node) {
 				getEventBus(vertx),
 				postgresConfig.getString("sqlAdminAdress", "sql.persistor.admin")
 			);
+			final String initScriptsPath = FileResolver.absolutePath(config.getString("init-scripts", "sql"));
 			DB migration = new DB(vertx, sqlAdmin, schema);
-			migration.loadScripts(FileResolver.absolutePath(config.getString("init-scripts", "sql")));
+			migration.loadScripts(initScriptsPath)
+				.compose(Void -> postSqlScripts());
 		}
 		if (config.getBoolean("elasticsearch", false)) {
 			if (config.getJsonObject("elasticsearchConfig") != null) {
@@ -406,4 +412,13 @@ public String getSchema() {
 		return schema;
 	}
 
+	/** 
+	 * An overridable hook allowing additional non-sql tasks to be done
+	 * after all SQL migration scripts have been applied.
+	 * @return a future
+	 */
+	protected Future<Void> postSqlScripts() {
+		return Future.succeededFuture();
+	}
+
 }

common/src/main/java/org/entcore/common/sql/DB.java

@@ -99,24 +99,29 @@ public void handle(AsyncResult<List<String>> asyncResult) {
 						final String filename = f.substring(f.lastIndexOf(File.separatorChar) + 1);
 						if (!excludeFileNames.contains(filename)) {
 							vertx.fileSystem().readFile(f, bufferAsyncResult -> {
-                if (bufferAsyncResult.succeeded()) {
-                  String script = bufferAsyncResult.result().toString();
-                  script = script.replaceAll("\\-\\-\\s.*(\r|\n|$)", "").replaceAll("(\r|\n|\t)", " ");
-                  s.raw(script);
-                  newFiles.add(new JsonArray().add(filename));
-                } else {
-                  log.error("Error reading file : " + f, bufferAsyncResult.cause());
-                }
-                if (count.decrementAndGet() == 0) {
-                  commit(schema, s, newFiles).onComplete(promise);
-                }
-              });
+								if (bufferAsyncResult.succeeded()) {
+									String script = bufferAsyncResult.result().toString();
+									script = script.replaceAll("\\-\\-\\s.*(\r|\n|$)", "").replaceAll("(\r|\n|\t)", " ");
+									s.raw(script);
+									newFiles.add(new JsonArray().add(filename));
+								} else {
+									log.error("Error reading file : " + f, bufferAsyncResult.cause());
+								}
+								if (count.decrementAndGet() == 0) {
+									commit(schema, s, newFiles).onComplete(promise);
+								}
+							});
 						} else {
 							count.decrementAndGet();
 						}
 					}
-					if (count.get() == 0 && newFiles.size() > 0) {
-						commit(schema, s, newFiles).onComplete(promise);
+					if (count.get() == 0) {
+						if(newFiles.size() > 0) {
+							commit(schema, s, newFiles).onComplete(promise);
+						} else {
+							// No script has been played = success
+							promise.complete();
+						}
 					}
 				} else {
 					log.error("Error reading sql directory : " + path, asyncResult.cause());

directory/src/main/java/org/entcore/directory/controllers/DirectoryController.java

@@ -578,6 +578,12 @@ public void directoryHandler(final Message<JsonObject> message) {
 				JsonArray structuresToExclude = message.body().getJsonArray("structures-to-exclude");
 				userService.getMainStructure(userId, structuresToExclude, BusResponseHandler.busResponseHandler(message));
 				break;
+			case "getUsersStructures" : {
+				JsonArray userIds = message.body().getJsonArray("userIds", new JsonArray());
+				JsonArray fields = message.body().getJsonArray("fields");
+				userService.getUsersStructures(userIds, fields, busArrayHandler(message));
+				break;
+			}
 			case "list-users":
 				JsonArray userIds = message.body().getJsonArray("userIds", new JsonArray());
 				JsonArray groupIds = message.body().getJsonArray("groupIds", new JsonArray());

directory/src/main/java/org/entcore/directory/services/UserService.java

@@ -19,16 +19,17 @@
 
 package org.entcore.directory.services;
 
+import java.util.List;
+
+import org.entcore.common.user.UserInfos;
+import org.entcore.directory.pojo.TransversalSearchQuery;
+
 import fr.wseduc.webutils.Either;
 import io.vertx.core.Future;
 import io.vertx.core.Handler;
 import io.vertx.core.http.HttpServerRequest;
 import io.vertx.core.json.JsonArray;
 import io.vertx.core.json.JsonObject;
-import org.entcore.common.user.UserInfos;
-import org.entcore.directory.pojo.TransversalSearchQuery;
-
-import java.util.List;
 
 public interface UserService {
 
@@ -161,6 +162,15 @@ void listByLevel(String levelContains, String levelNotContains, String profile,
 
 	void getMainStructure(String userId, JsonArray structuresToExclude, Handler<Either<String, JsonObject>> result);
 
+	/**
+	 * Get some details about the structures that a list of users are attached to.
+	 * @param userIds IDs of users
+	 * @param fields fields of the structure nodes, to be returned in details. Default to ["id"]
+	 * @return an array of JsonObjects, such as 
+	 * 		{ userId: "ID of the user", structures: [{id: "ID of the structure", ... other queried fields...}] }
+	 */
+	void getUsersStructures(JsonArray userIds, JsonArray fields, Handler<Either<String, JsonArray>> handler);
+
 	void getAttachmentSchool(String userId, JsonArray structuresToExclude, Handler<Either<String, JsonObject>> result);
 
 	Future<JsonObject> getUsersDisplayNames(JsonArray userIds);

directory/src/main/java/org/entcore/directory/services/impl/DefaultUserService.java

@@ -1321,6 +1321,30 @@ public void getMainStructure(String userId, JsonArray structuresToExclude, Handl
 	}
 
 
+	public void getUsersStructures(JsonArray userIds, JsonArray fields, Handler<Either<String, JsonArray>> handler) {
+		if (fields == null || fields.size() == 0) {
+			fields = new JsonArray().add("id");
+		}
+		final StringBuilder query = new StringBuilder(
+				"MATCH (u:User)-[:IN]->(ProfileGroup)-[:DEPENDS]->(s:Structure) " +
+				"WHERE u.id IN {userIds} " +
+				"RETURN u.id as userId, COLLECT(distinct {");
+		for (Object field : fields) {
+			query.append(field).append(": s.").append(field).append(",");
+		}
+		query.deleteCharAt(query.length() - 1).append("}) as structures ");
+
+	    JsonObject params = new JsonObject().put("userIds", userIds);
+	    neo.execute(query.toString(), params, validResultHandler(res->{
+	        if (res.isRight()) {
+	            final JsonArray result = res.right().getValue();
+	            handler.handle(new Either.Right<>(result));
+	        } else {
+	            handler.handle(res);
+	        }
+	    }));
+	}
+
 	public void getAttachmentSchool(String userId, JsonArray structuresToExclude, Handler<Either<String, JsonObject>> handler) {
 		String query =
 				"MATCH (u:User {id : {userId}})-[:ADMINISTRATIVE_ATTACHMENT]->(s:Structure) WHERE NOT s.id IN {structuresIds} " +