diff --git a/.vscode/eclipse-java-formatter.xml b/.vscode/eclipse-java-formatter.xml
index cd46484b46f..09a4961004a 100644
--- a/.vscode/eclipse-java-formatter.xml
+++ b/.vscode/eclipse-java-formatter.xml
@@ -1,2 +1,407 @@
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/.vscode/settings.json b/.vscode/settings.json
index 50b4fcb95f5..360f9c0ce0e 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -1,5 +1,11 @@
{
"java.format.settings.url": ".vscode/eclipse-java-formatter.xml",
"java.format.settings.profile": "Eclipse [built-in]",
- "editor.formatOnSave": true
+ "editor.formatOnSave": true,
+ "[java]": {
+ "editor.defaultFormatter": "redhat.java",
+ "editor.detectIndentation": false,
+ "editor.insertSpaces": false,
+ "editor.tabSize": 4
+ }
}
\ No newline at end of file
diff --git a/AGENTS.md b/AGENTS.md
index 54490eafdd7..c2ebe6da57d 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -28,3 +28,40 @@ So a user is always the pair, stored and passed together, never the id alone:
New code always keeps the pair. When a change works with a table, method or API that has only
the user id, it adds the type beside it.
+
+## A reactor describes itself in its definition
+
+A reactor tells its MCP tool, its help text and the SDKs what it does by overriding
+`getReactorDefinition()` (`prerna.reactor.ReactorDefinition`). It calls
+`super.getReactorDefinition()`, which starts from `keysToGet` and `keyRequired`, and adds
+its description, its keys' descriptions and types, and its output:
+
+```java
+@Override
+public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition()
+ .description("Stop the current execution of a pixel job")
+ .key(ReactorKeysEnum.ID, "The id for the job")
+ .key(PATHS_KEY, key -> key.list(String.class).description("The file paths"))
+ .output(String.class, "Whether the job was stopped");
+}
+```
+
+- **Metadata only.** `keysToGet` and `keyRequired` still decide how a call's inputs are read.
+ The definition can say more, such as `key.required(true)`, without changing that.
+- **No keys on purpose.** A reactor that takes no input says `.noKeys()`.
+- **Admin reactors say so first.** A reactor only admins can run starts its description with
+ `Admin Only: `, such as `"Admin Only: Returns every engine on the server, ..."`. A reactor that
+ admins can run with extra access, but other users can run too, does not.
+- **Parents describe only shared keys.** A parent's definition describes only the keys every
+ reactor below it takes. Text several reactors share lives in the parent as a constant, such as
+ `TEAM_ID_DESCRIPTION`, and each reactor describes the keys it takes with it. A reactor that does
+ not take its parent's keys starts from `startDefinition()` instead of
+ `super.getReactorDefinition()`. Describing a key a reactor does not take, or listing a key twice
+ in `keysToGet`, is reported, with the class to fix, and fails the OpenAPI export.
+- **Reading it.** Code that needs a reactor's description or a key's type calls
+ `getReactorDefinition()`, not `getReactorDescription`, `getDescriptionForKey` or
+ `getKeyTypeForMCP`.
+- **Migrating.** Those three methods are deprecated. New code does not override them, and a
+ change that touches a reactor still overriding them moves the values into
+ `getReactorDefinition()`, as each method's javadoc shows, and deletes the old methods.
diff --git a/pom.xml b/pom.xml
index 96a649a5120..70f7b7f56c1 100644
--- a/pom.xml
+++ b/pom.xml
@@ -61,6 +61,8 @@
cannot share a single property. -->
2.22.42.22
+
+ 2.2.3033.7.2-jre3.1.8
@@ -1989,6 +1991,13 @@
jackson-annotations${jackson2.annotations.version}
+
+
+
+ io.swagger.core.v3
+ swagger-annotations-jakarta
+ ${swagger.version}
+ com.fasterxml.jackson.datatype
diff --git a/src/prerna/auth/utils/reactors/admin/AdminEngineInfoReactor.java b/src/prerna/auth/utils/reactors/admin/AdminEngineInfoReactor.java
index fa89d0379b5..14050683720 100644
--- a/src/prerna/auth/utils/reactors/admin/AdminEngineInfoReactor.java
+++ b/src/prerna/auth/utils/reactors/admin/AdminEngineInfoReactor.java
@@ -36,6 +36,7 @@
import prerna.auth.utils.SecurityEngineUtils;
import prerna.auth.utils.SecurityQueryUtils;
import prerna.reactor.AbstractReactor;
+import prerna.reactor.ReactorDefinition;
import prerna.sablecc2.om.GenRowStruct;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.PixelOperationType;
@@ -43,40 +44,41 @@
import prerna.sablecc2.om.nounmeta.NounMetadata;
public class AdminEngineInfoReactor extends AbstractReactor {
-
+
public AdminEngineInfoReactor() {
- this.keysToGet = new String[]{ReactorKeysEnum.ENGINE.getKey(), ReactorKeysEnum.META_KEYS.getKey()};
+ this.keysToGet = new String[] { ReactorKeysEnum.ENGINE.getKey(), ReactorKeysEnum.META_KEYS.getKey() };
}
@Override
public NounMetadata execute() {
User user = this.insight.getUser();
SecurityAdminUtils adminUtils = SecurityAdminUtils.getInstance(user);
- if(adminUtils == null) {
+ if (adminUtils == null) {
throw new IllegalArgumentException("User must be an admin to perform this function");
}
organizeKeys();
String engineId = this.keyValue.get(this.keysToGet[0]);
-
- if(engineId == null || engineId.isEmpty()) {
+
+ if (engineId == null || engineId.isEmpty()) {
throw new IllegalArgumentException("Must input an engine id");
}
engineId = SecurityQueryUtils.testUserEngineIdForAlias(this.insight.getUser(), engineId);
- List> baseInfo = adminUtils.getAllEngineSettings(Arrays.asList(engineId), null, null, null, null, null);
- if(baseInfo == null || baseInfo.isEmpty()) {
+ List> baseInfo = adminUtils.getAllEngineSettings(Arrays.asList(engineId), null, null, null,
+ null, null);
+ if (baseInfo == null || baseInfo.isEmpty()) {
throw new IllegalArgumentException("Could not find any engine data");
}
-
+
// we filtered to a single database
Map databaseInfo = baseInfo.get(0);
databaseInfo.putAll(SecurityEngineUtils.getAggregateEngineMetadata(engineId, getMetaKeys(), true));
return new NounMetadata(databaseInfo, PixelDataType.CUSTOM_DATA_STRUCTURE, PixelOperationType.ENGINE_INFO);
}
-
+
private List getMetaKeys() {
GenRowStruct grs = this.store.getGenRowStruct(ReactorKeysEnum.META_KEYS.getKey());
- if(grs != null && !grs.isEmpty()) {
+ if (grs != null && !grs.isEmpty()) {
return grs.getAllStrValues();
}
@@ -84,37 +86,31 @@ private List getMetaKeys() {
}
@Override
- public String getReactorDescription() {
- return """
- Admin-only: returns the full settings/metadata record for a single engine regardless of the caller's \
- engine permissions. The calling user must be an application admin or the reactor throws \
- "User must be an admin to perform this function".
+ public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition()
+ .description(
+ """
+ Admin Only: Returns the full settings/metadata record for a single engine regardless of the caller's \
+ engine permissions. The calling user must be an application admin or the reactor throws \
+ "User must be an admin to perform this function".
- This is the admin counterpart to EngineInfo, which instead enforces the caller's view/discoverable access.
+ This is the admin counterpart to EngineInfo, which instead enforces the caller's view/discoverable access.
- Inputs:
- engine (required) - the engine id.
- metaKeys (optional) - restrict the returned metadata tags to this list; omit to return all metadata.
+ Inputs:
+ engine (required) - the engine id.
+ metaKeys (optional) - restrict the returned metadata tags to this list; omit to return all metadata.
- Returns a single map (ENGINE_INFO/CUSTOM_DATA_STRUCTURE) containing:
- Core engine fields: engine_id, engine_name, engine_display_name, engine_type, engine_subtype,
- engine_cost, engine_discoverable, engine_global, engine_tool_app, engine_created_by,
- engine_created_by_type, engine_date_created, low_engine_name.
- Legacy aliases (deprecated, kept for backwards compatibility - prefer the engine_* fields above):
- database_id, database_name, database_tool_app, database_global, low_database_name,
- app_id, app_name, app_display_name, app_global, tool_app.
- Metadata: one entry per metadata tag (e.g. tag, domain, etc.); a tag with multiple values is returned as a list.
- """;
- }
-
- @Override
- protected String getDescriptionForKey(String key) {
- if (ReactorKeysEnum.ENGINE.getKey().equals(key)) {
- return "Id of the engine to look up";
- } else if (ReactorKeysEnum.META_KEYS.getKey().equals(key)) {
- return "Optional list of metadata tag names to return for the engine; omit to return all metadata tags";
- }
- return super.getDescriptionForKey(key);
+ Returns a single map (ENGINE_INFO/CUSTOM_DATA_STRUCTURE) containing:
+ Core engine fields: engine_id, engine_name, engine_display_name, engine_type, engine_subtype,
+ engine_cost, engine_discoverable, engine_global, engine_tool_app, engine_created_by,
+ engine_created_by_type, engine_date_created, low_engine_name.
+ Legacy aliases (deprecated, kept for backwards compatibility - prefer the engine_* fields above):
+ database_id, database_name, database_tool_app, database_global, low_database_name,
+ app_id, app_name, app_display_name, app_global, tool_app.
+ Metadata: one entry per metadata tag (e.g. tag, domain, etc.); a tag with multiple values is returned as a list.
+ """)
+ .key(ReactorKeysEnum.ENGINE, "Id of the engine to look up").key(ReactorKeysEnum.META_KEYS,
+ "Optional list of metadata tag names to return for the engine; omit to return all metadata tags");
}
}
\ No newline at end of file
diff --git a/src/prerna/auth/utils/reactors/admin/AdminExportEnterpriseUsageReactor.java b/src/prerna/auth/utils/reactors/admin/AdminExportEnterpriseUsageReactor.java
index 83271605d07..0d9f61c3b5c 100644
--- a/src/prerna/auth/utils/reactors/admin/AdminExportEnterpriseUsageReactor.java
+++ b/src/prerna/auth/utils/reactors/admin/AdminExportEnterpriseUsageReactor.java
@@ -79,6 +79,7 @@
import prerna.logging.SemossLogUtils;
import prerna.om.InsightFile;
import prerna.reactor.AbstractReactor;
+import prerna.reactor.ReactorDefinition;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.PixelOperationType;
import prerna.sablecc2.om.nounmeta.NounMetadata;
@@ -764,7 +765,27 @@ private static String title(String value) {
}
@Override
- public String getReactorDescription() {
- return "Exports Admin-Only Enterprise Usage Reports As Audited CSV Or PDF Downloads.";
+ public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition()
+ .description("Admin Only: Exports enterprise usage reports as audited CSV or PDF downloads.")
+ .key("app",
+ "Filters to apps whose id or name contains this text, or to the exact app id given after a leading =. Audit logs match the app id only.")
+ .key("comparisonEndDate",
+ "Last day, as YYYY-MM-DD, of the benchmark period the overview view compares against. When neither comparison date is given, the overview compares against the same number of days just before startDate.")
+ .key("comparisonStartDate",
+ "First day, as YYYY-MM-DD, of the benchmark period the overview view compares against. When neither comparison date is given, the overview compares against the same number of days just before startDate.")
+ .key("dimension",
+ "What the ranking view groups model usage by: user, app or model. The ranking export lists the top 20.")
+ .key("engine",
+ "Filters to engines whose id or name contains this text, or to the exact engine id given after a leading =.")
+ .key("format",
+ "The file to export: csv, the default, or pdf. A pdf export supports the overview view only.")
+ .key("model", "The engine filter, used when engine is not given. It matches the same way engine does.")
+ .key("source",
+ "Which logs to report on: model, the default, activity or audit. An audit export supports the logs view only, and the ranking view needs the model source.")
+ .key("user",
+ "Filters to users whose id or name contains this text, or to the exact user id given after a leading =. Audit logs match the acting or the affected user.")
+ .key("view",
+ "The report to export: overview, the default, ranking or logs. The logs view holds up to the newest 5000 rows.");
}
}
diff --git a/src/prerna/auth/utils/reactors/admin/AdminGetEnterpriseUsageDetailReactor.java b/src/prerna/auth/utils/reactors/admin/AdminGetEnterpriseUsageDetailReactor.java
index dda694be24d..c4f2e6ef765 100644
--- a/src/prerna/auth/utils/reactors/admin/AdminGetEnterpriseUsageDetailReactor.java
+++ b/src/prerna/auth/utils/reactors/admin/AdminGetEnterpriseUsageDetailReactor.java
@@ -30,6 +30,7 @@
import prerna.auth.utils.EnterpriseUsageUtils;
import prerna.auth.utils.SecurityAdminUtils;
import prerna.reactor.AbstractReactor;
+import prerna.reactor.ReactorDefinition;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.nounmeta.NounMetadata;
@@ -54,7 +55,11 @@ public NounMetadata execute() {
}
@Override
- public String getReactorDescription() {
- return "Administrator-only retrieval of retained activity content, a model message pair, or an audit event's old and new values, or why its request was denied, by recordId. Pairing and identity boundaries are resolved on the server.";
+ public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition().description(
+ "Admin Only: Retrieval of retained activity content, a model message pair, or an audit event's old and new values, or why its request was denied, by recordId. Pairing and identity boundaries are resolved on the server.")
+ .key("recordId",
+ "The id of the record to read: a message id for the model source, a log id for the activity source, or an event id for the audit source.")
+ .key("source", "Where the record is kept: model, activity or audit.");
}
}
diff --git a/src/prerna/auth/utils/reactors/admin/AdminGetEnterpriseUsageFilterOptionsReactor.java b/src/prerna/auth/utils/reactors/admin/AdminGetEnterpriseUsageFilterOptionsReactor.java
index ddb821bcb02..f1a01bd2cee 100644
--- a/src/prerna/auth/utils/reactors/admin/AdminGetEnterpriseUsageFilterOptionsReactor.java
+++ b/src/prerna/auth/utils/reactors/admin/AdminGetEnterpriseUsageFilterOptionsReactor.java
@@ -30,6 +30,7 @@
import prerna.auth.utils.EnterpriseUsageUtils;
import prerna.auth.utils.SecurityAdminUtils;
import prerna.reactor.AbstractReactor;
+import prerna.reactor.ReactorDefinition;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.nounmeta.NounMetadata;
@@ -55,7 +56,11 @@ public NounMetadata execute() {
}
@Override
- public String getReactorDescription() {
- return "Lists Registered User IDs, Names And Authentication Types, App IDs And Names, Or Engine IDs And Names For Enterprise Usage Filters. Supports Bound Search, Exact ID Resolution And Bounded Pagination.";
+ public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition().description(
+ "Admin Only: Lists registered user IDs, names and authentication types, app IDs and names, or engine IDs and names for enterprise usage filters. Supports bound search, exact ID resolution and bounded pagination.")
+ .key("dimension", "Which catalog to list: user, app or engine.")
+ .key("id", "An exact id to look up in the catalog. When it is given, search is not used.")
+ .key("limit", key -> key.type(Integer.class)).key("offset", key -> key.type(Integer.class));
}
}
diff --git a/src/prerna/auth/utils/reactors/admin/AdminGetEnterpriseUsageReactor.java b/src/prerna/auth/utils/reactors/admin/AdminGetEnterpriseUsageReactor.java
index 9e07776693f..622f6828bd9 100644
--- a/src/prerna/auth/utils/reactors/admin/AdminGetEnterpriseUsageReactor.java
+++ b/src/prerna/auth/utils/reactors/admin/AdminGetEnterpriseUsageReactor.java
@@ -30,6 +30,7 @@
import prerna.auth.utils.EnterpriseUsageUtils;
import prerna.auth.utils.SecurityAdminUtils;
import prerna.reactor.AbstractReactor;
+import prerna.reactor.ReactorDefinition;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.nounmeta.NounMetadata;
@@ -59,7 +60,22 @@ public NounMetadata execute() {
}
@Override
- public String getReactorDescription() {
- return "Administrator-only enterprise usage summary, daily trends, latency, feedback, rankings, or paginated metadata from model/activity logs, or a summary and paginated metadata of the audit trail's access changes, denied requests and usage limit changes. Model summaries, trends and rankings include their cost in millionths of a dollar, recorded and estimated; model log rows include their token parts, cost and whom the call was billed to. Dates are inclusive; filters match name/ID fragments or =exact IDs. No SQL input is accepted.";
+ public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition().description(
+ "Admin Only: Enterprise usage summary, daily trends, latency, feedback, rankings, or paginated metadata from model/activity logs, or a summary and paginated metadata of the audit trail's access changes, denied requests and usage limit changes. Model summaries, trends and rankings include their cost in millionths of a dollar, recorded and estimated; model log rows include their token parts, cost and whom the call was billed to. Dates are inclusive; filters match name/ID fragments or =exact IDs. No SQL input is accepted.")
+ .key("app",
+ "Filters to apps whose id or name contains this text, or to the exact app id given after a leading =. Audit logs match the app id only.")
+ .key("dimension",
+ "What the ranking view groups model usage by: user, app or model. Used by the ranking view only.")
+ .key("engine",
+ "Filters to engines whose id or name contains this text, or to the exact engine id given after a leading =.")
+ .key("limit", key -> key.type(Integer.class))
+ .key("model", "The engine filter, used when engine is not given. It matches the same way engine does.")
+ .key("offset", key -> key.type(Integer.class))
+ .key("source", "Which logs to read: model, activity or audit.")
+ .key("user",
+ "Filters to users whose id or name contains this text, or to the exact user id given after a leading =. Audit logs match the acting or the affected user.")
+ .key("view",
+ "The report to return: summary, trend, latency, feedback, ranking or logs. The activity source supports summary, trend and logs, and the audit source supports summary and logs.");
}
}
diff --git a/src/prerna/auth/utils/reactors/admin/AdminGetLlmFeedbackCountReactor.java b/src/prerna/auth/utils/reactors/admin/AdminGetLlmFeedbackCountReactor.java
index 836685eff72..05db05aab81 100644
--- a/src/prerna/auth/utils/reactors/admin/AdminGetLlmFeedbackCountReactor.java
+++ b/src/prerna/auth/utils/reactors/admin/AdminGetLlmFeedbackCountReactor.java
@@ -34,48 +34,45 @@
import prerna.auth.utils.SecurityAdminUtils;
import prerna.engine.impl.model.inferencetracking.ModelInferenceLogsUtils;
import prerna.reactor.AbstractReactor;
+import prerna.reactor.ReactorDefinition;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.ReactorKeysEnum;
import prerna.sablecc2.om.nounmeta.NounMetadata;
public class AdminGetLlmFeedbackCountReactor extends AbstractReactor {
- public AdminGetLlmFeedbackCountReactor() {
- this.keysToGet = new String[] {
- ReactorKeysEnum.START_DATE.getKey(),
- ReactorKeysEnum.END_DATE.getKey(),
- ReactorKeysEnum.PROJECT.getKey(),
- "userId",
- ReactorKeysEnum.ENGINE.getKey()
- };
- }
+ public AdminGetLlmFeedbackCountReactor() {
+ this.keysToGet = new String[] { ReactorKeysEnum.START_DATE.getKey(), ReactorKeysEnum.END_DATE.getKey(),
+ ReactorKeysEnum.PROJECT.getKey(), "userId", ReactorKeysEnum.ENGINE.getKey() };
+ }
- @Override
- public NounMetadata execute() {
- User user = this.insight.getUser();
- SecurityAdminUtils adminUtils = SecurityAdminUtils.getInstance(user);
- if (adminUtils == null) {
- throw new IllegalArgumentException("User must be an admin to perform this function");
- }
- organizeKeys();
+ @Override
+ public NounMetadata execute() {
+ User user = this.insight.getUser();
+ SecurityAdminUtils adminUtils = SecurityAdminUtils.getInstance(user);
+ if (adminUtils == null) {
+ throw new IllegalArgumentException("User must be an admin to perform this function");
+ }
+ organizeKeys();
- String startDate = this.keyValue.get(this.keysToGet[0]);
- String endDate = this.keyValue.get(this.keysToGet[1]);
- String projectId = this.keyValue.get(this.keysToGet[2]);
- String userId = this.keyValue.get(this.keysToGet[3]);
- String engineId = this.keyValue.get(this.keysToGet[4]);
+ String startDate = this.keyValue.get(this.keysToGet[0]);
+ String endDate = this.keyValue.get(this.keysToGet[1]);
+ String projectId = this.keyValue.get(this.keysToGet[2]);
+ String userId = this.keyValue.get(this.keysToGet[3]);
+ String engineId = this.keyValue.get(this.keysToGet[4]);
- List> feedbackCounts = ModelInferenceLogsUtils.getFeedbackCountForAdmin(
- startDate, endDate, projectId, userId, engineId);
+ List> feedbackCounts = ModelInferenceLogsUtils.getFeedbackCountForAdmin(startDate, endDate,
+ projectId, userId, engineId);
- return new NounMetadata(feedbackCounts, PixelDataType.FORMATTED_DATA_SET);
- }
+ return new NounMetadata(feedbackCounts, PixelDataType.FORMATTED_DATA_SET);
+ }
- @Override
- protected String getDescriptionForKey(String key) {
- if (key.equals("userId")) {
- return "The user id to filter feedback counts by";
- }
- return super.getDescriptionForKey(key);
- }
+ @Override
+ public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition().description(
+ "Admin Only: Returns the total, positive and negative counts of feedback on model responses, optionally filtered by date range, project, user and model engine.")
+ .key(ReactorKeysEnum.ENGINE, "The id of the model engine whose feedback to count.")
+ .key(ReactorKeysEnum.PROJECT, "The id of the project whose rooms' feedback to count.")
+ .key("userId", "The user id to filter feedback counts by");
+ }
}
diff --git a/src/prerna/auth/utils/reactors/admin/AdminGetLlmFeedbackReactor.java b/src/prerna/auth/utils/reactors/admin/AdminGetLlmFeedbackReactor.java
index c2c8d2d68f3..3768c0a5a44 100644
--- a/src/prerna/auth/utils/reactors/admin/AdminGetLlmFeedbackReactor.java
+++ b/src/prerna/auth/utils/reactors/admin/AdminGetLlmFeedbackReactor.java
@@ -34,52 +34,50 @@
import prerna.auth.utils.SecurityAdminUtils;
import prerna.engine.impl.model.inferencetracking.ModelInferenceLogsUtils;
import prerna.reactor.AbstractReactor;
+import prerna.reactor.ReactorDefinition;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.ReactorKeysEnum;
import prerna.sablecc2.om.nounmeta.NounMetadata;
public class AdminGetLlmFeedbackReactor extends AbstractReactor {
- public AdminGetLlmFeedbackReactor() {
- this.keysToGet = new String[] {
- ReactorKeysEnum.LIMIT.getKey(),
- ReactorKeysEnum.OFFSET.getKey(),
- ReactorKeysEnum.START_DATE.getKey(),
- ReactorKeysEnum.END_DATE.getKey(),
- ReactorKeysEnum.PROJECT.getKey(),
- "userId",
- ReactorKeysEnum.ENGINE.getKey()
- };
- }
+ public AdminGetLlmFeedbackReactor() {
+ this.keysToGet = new String[] { ReactorKeysEnum.LIMIT.getKey(), ReactorKeysEnum.OFFSET.getKey(),
+ ReactorKeysEnum.START_DATE.getKey(), ReactorKeysEnum.END_DATE.getKey(),
+ ReactorKeysEnum.PROJECT.getKey(), "userId", ReactorKeysEnum.ENGINE.getKey() };
+ }
- @Override
- public NounMetadata execute() {
- User user = this.insight.getUser();
- SecurityAdminUtils adminUtils = SecurityAdminUtils.getInstance(user);
- if (adminUtils == null) {
- throw new IllegalArgumentException("User must be an admin to perform this function");
- }
- organizeKeys();
+ @Override
+ public NounMetadata execute() {
+ User user = this.insight.getUser();
+ SecurityAdminUtils adminUtils = SecurityAdminUtils.getInstance(user);
+ if (adminUtils == null) {
+ throw new IllegalArgumentException("User must be an admin to perform this function");
+ }
+ organizeKeys();
- String limit = this.keyValue.get(this.keysToGet[0]);
- String offset = this.keyValue.get(this.keysToGet[1]);
- String startDate = this.keyValue.get(this.keysToGet[2]);
- String endDate = this.keyValue.get(this.keysToGet[3]);
- String projectId = this.keyValue.get(this.keysToGet[4]);
- String userId = this.keyValue.get(this.keysToGet[5]);
- String engineId = this.keyValue.get(this.keysToGet[6]);
+ String limit = this.keyValue.get(this.keysToGet[0]);
+ String offset = this.keyValue.get(this.keysToGet[1]);
+ String startDate = this.keyValue.get(this.keysToGet[2]);
+ String endDate = this.keyValue.get(this.keysToGet[3]);
+ String projectId = this.keyValue.get(this.keysToGet[4]);
+ String userId = this.keyValue.get(this.keysToGet[5]);
+ String engineId = this.keyValue.get(this.keysToGet[6]);
- List> feedbackList = ModelInferenceLogsUtils.getFeedbackForAdmin(
- limit, offset, startDate, endDate, projectId, userId, engineId);
+ List> feedbackList = ModelInferenceLogsUtils.getFeedbackForAdmin(limit, offset, startDate,
+ endDate, projectId, userId, engineId);
- return new NounMetadata(feedbackList, PixelDataType.FORMATTED_DATA_SET);
- }
+ return new NounMetadata(feedbackList, PixelDataType.FORMATTED_DATA_SET);
+ }
- @Override
- protected String getDescriptionForKey(String key) {
- if (key.equals("userId")) {
- return "The user id to filter feedback by";
- }
- return super.getDescriptionForKey(key);
- }
+ @Override
+ public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition().description(
+ "Admin Only: Returns feedback on model responses, newest first, with each response, the prompt it answered, its user, model engine and project. Filters by date range, project, user and model engine, and pages with limit and offset.")
+ .key(ReactorKeysEnum.ENGINE, "The id of the model engine whose feedback to return.")
+ .key(ReactorKeysEnum.LIMIT, key -> key.type(Integer.class))
+ .key(ReactorKeysEnum.OFFSET, key -> key.type(Integer.class))
+ .key(ReactorKeysEnum.PROJECT, "The id of the project whose rooms' feedback to return.")
+ .key("userId", "The user id to filter feedback by");
+ }
}
diff --git a/src/prerna/auth/utils/reactors/admin/AdminGetSystemInfoReactor.java b/src/prerna/auth/utils/reactors/admin/AdminGetSystemInfoReactor.java
index 74b92a3208d..9bfdba72619 100644
--- a/src/prerna/auth/utils/reactors/admin/AdminGetSystemInfoReactor.java
+++ b/src/prerna/auth/utils/reactors/admin/AdminGetSystemInfoReactor.java
@@ -36,6 +36,7 @@
import prerna.cluster.sync.impl.ClusterSynchronizerFactory;
import prerna.cluster.util.ClusterUtil;
import prerna.reactor.AbstractReactor;
+import prerna.reactor.ReactorDefinition;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.nounmeta.NounMetadata;
@@ -78,11 +79,11 @@ public NounMetadata execute() {
}
@Override
- public String getReactorDescription() {
- return """
- Admin only reactor returning a map with properties about the instance including:
+ public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition().description("""
+ Admin Only: Returns a map with properties about the instance including:
hostname, ipaddress, isCluster, storageProvider, isClusterScheduler, isClusterZK
- """;
+ """).noKeys();
}
}
diff --git a/src/prerna/auth/utils/reactors/admin/AdminMyEnginesReactor.java b/src/prerna/auth/utils/reactors/admin/AdminMyEnginesReactor.java
index a0276e6c9d2..7364bd51dd0 100644
--- a/src/prerna/auth/utils/reactors/admin/AdminMyEnginesReactor.java
+++ b/src/prerna/auth/utils/reactors/admin/AdminMyEnginesReactor.java
@@ -27,7 +27,6 @@
*******************************************************************************/
package prerna.auth.utils.reactors.admin;
-import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
@@ -43,6 +42,7 @@
import prerna.auth.utils.SecurityEngineUtils;
import prerna.engine.api.IRawSelectWrapper;
import prerna.reactor.AbstractReactor;
+import prerna.reactor.ReactorDefinition;
import prerna.sablecc2.om.GenRowStruct;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.PixelOperationType;
@@ -113,9 +113,8 @@ public NounMetadata execute() {
}
if (!noMeta) {
- IRawSelectWrapper wrapper = null;
- try {
- wrapper = SecurityEngineUtils.getEngineMetadataWrapper(index.keySet(), getMetaKeys(), true);
+ try (IRawSelectWrapper wrapper = SecurityEngineUtils.getEngineMetadataWrapper(index.keySet(),
+ getMetaKeys(), true)) {
while (wrapper.hasNext()) {
Object[] data = wrapper.next().getValues();
String databaseId = (String) data[0];
@@ -146,21 +145,10 @@ public NounMetadata execute() {
}
} catch (Exception e) {
classLogger.error("Failed to attach engine metadata values to the admin engine list response", e);
- } finally {
- if (wrapper != null) {
- try {
- wrapper.close();
- } catch (IOException e) {
- classLogger.error(
- "Failed to close metadata wrapper while building admin engine list response", e);
- }
- }
}
}
if (includeUserT) {
- IRawSelectWrapper wrapper = null;
- try {
- wrapper = UserCatalogVoteUtils.getAllVotesWrapper(index.keySet());
+ try (IRawSelectWrapper wrapper = UserCatalogVoteUtils.getAllVotesWrapper(index.keySet())) {
while (wrapper.hasNext()) {
Object[] data = wrapper.next().getValues();
String databaseId = (String) data[0];
@@ -172,15 +160,6 @@ public NounMetadata execute() {
}
} catch (Exception e) {
classLogger.error("Failed to attach vote totals to the admin engine list response", e);
- } finally {
- if (wrapper != null) {
- try {
- wrapper.close();
- } catch (IOException e) {
- classLogger.error("Failed to close vote wrapper while building admin engine list response",
- e);
- }
- }
}
Map voted = UserCatalogVoteUtils
@@ -258,25 +237,30 @@ private Map getMetaMap() {
}
@Override
- protected String getDescriptionForKey(String key) {
- if (key.equals(ReactorKeysEnum.SORT.getKey())) {
- return "The sort is a map with key and direction. Supported keys are 'ENGINENAME' and 'DATECREATED'. Use values like 'ASC' or 'DESC'. 'ENGINENAME' sorting is case-insensitive.";
- } else if (key.equals(ReactorKeysEnum.ENGINE.getKey())) {
- return "This is an optional engine filter";
- } else if (key.equals(EFFECTIVE_PERMISSIONS)) {
- return """
- Keep only the resources on which permissionUser holds one of these levels: 1 (owner), 2 (edit), \
- or 3 (read only). Counts that user's direct grants and their custom groups' grants; identity \
- provider groups are known only while the user is signed in, so they are not counted.""";
- } else if (key.equals(PERMISSION_USER)) {
- return "The id of the user whose permission effectivePermissions checks.";
- } else if (key.equals(CREATED_BY)) {
- return """
- Keep only the resources created by one of these creators. Each is a map with the creator's \
- login "id" and login "type", such as {"id": "abc", "type": "MICROSOFT"}; both must match.""";
- } else if (key.equals(CREATED_BY_ME)) {
- return "When true, keep only the resources the calling user created, under any login in their session.";
- }
- return super.getDescriptionForKey(key);
+ public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition().description(
+ "Admin Only: Returns every engine on the server, filtered by id, type, search text, metadata, creator or a user's permission level, and sorted by name unless sort says otherwise. Each engine carries its metadata unless noMeta is true, and its upvote count and whether the caller upvoted it when userT is true.")
+ .key(ReactorKeysEnum.ENGINE_TYPE, key -> key.list(String.class))
+ .key(ReactorKeysEnum.LIMIT, key -> key.type(Integer.class))
+ .key(ReactorKeysEnum.META_FILTERS, key -> key.type(Map.class))
+ .key(ReactorKeysEnum.META_KEYS, key -> key.list(String.class))
+ .key(ReactorKeysEnum.NO_META, key -> key.type(Boolean.class))
+ .key(ReactorKeysEnum.OFFSET, key -> key.type(Integer.class))
+ .key(ReactorKeysEnum.INCLUDE_USERTRACKING_KEY, key -> key.type(Boolean.class))
+ .key(ReactorKeysEnum.ENGINE,
+ key -> key.list(String.class).description("This is an optional engine filter"))
+ .key(ReactorKeysEnum.SORT, key -> key.type(Map.class).description(
+ "The sort is a map with key and direction. Supported keys are 'ENGINENAME' and 'DATECREATED'. Use values like 'ASC' or 'DESC'. 'ENGINENAME' sorting is case-insensitive."))
+ .key(PERMISSION_USER, "The id of the user whose permission effectivePermissions checks.")
+ .key(EFFECTIVE_PERMISSIONS, key -> key.list(Integer.class).description(
+ """
+ Keep only the resources on which permissionUser holds one of these levels: 1 (owner), 2 (edit), \
+ or 3 (read only). Counts that user's direct grants and their custom groups' grants; identity \
+ provider groups are known only while the user is signed in, so they are not counted."""))
+ .key(CREATED_BY, key -> key.list(Map.class).description("""
+ Keep only the resources created by one of these creators. Each is a map with the creator's \
+ login "id" and login "type", such as {"id": "abc", "type": "MICROSOFT"}; both must match."""))
+ .key(CREATED_BY_ME, key -> key.type(Boolean.class).description(
+ "When true, keep only the resources the calling user created, under any login in their session."));
}
}
diff --git a/src/prerna/auth/utils/reactors/admin/AdminMyProjectsReactor.java b/src/prerna/auth/utils/reactors/admin/AdminMyProjectsReactor.java
index 2d7d7b2b93c..0dc0b336813 100644
--- a/src/prerna/auth/utils/reactors/admin/AdminMyProjectsReactor.java
+++ b/src/prerna/auth/utils/reactors/admin/AdminMyProjectsReactor.java
@@ -27,7 +27,6 @@
*******************************************************************************/
package prerna.auth.utils.reactors.admin;
-import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
@@ -43,6 +42,7 @@
import prerna.auth.utils.SecurityProjectUtils;
import prerna.engine.api.IRawSelectWrapper;
import prerna.reactor.AbstractReactor;
+import prerna.reactor.ReactorDefinition;
import prerna.sablecc2.om.GenRowStruct;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.PixelOperationType;
@@ -114,9 +114,8 @@ public NounMetadata execute() {
}
if (!noMeta) {
- IRawSelectWrapper wrapper = null;
- try {
- wrapper = SecurityProjectUtils.getProjectMetadataWrapper(index.keySet(), getMetaKeys(), true);
+ try (IRawSelectWrapper wrapper = SecurityProjectUtils.getProjectMetadataWrapper(index.keySet(),
+ getMetaKeys(), true)) {
while (wrapper.hasNext()) {
Object[] data = wrapper.next().getValues();
String projectId = (String) data[0];
@@ -147,15 +146,6 @@ public NounMetadata execute() {
}
} catch (Exception e) {
classLogger.error("Failed to attach project metadata values to the admin project list response", e);
- } finally {
- if (wrapper != null) {
- try {
- wrapper.close();
- } catch (IOException e) {
- classLogger.error(
- "Failed to close metadata wrapper while building admin project list response", e);
- }
- }
}
}
// if(includeUserT) {
@@ -257,25 +247,31 @@ private Map getMetaMap() {
}
@Override
- protected String getDescriptionForKey(String key) {
- if (key.equals(ReactorKeysEnum.SORT.getKey())) {
- return "The sort is a map with key and direction. Supported keys are 'PROJECTNAME', 'DATECREATED', and 'DATELASTEDITED' (or 'DATE_LAST_EDITED').";
- } else if (key.equals(ReactorKeysEnum.PROJECT.getKey())) {
- return "This is an optional project filter";
- } else if (key.equals(EFFECTIVE_PERMISSIONS)) {
- return """
- Keep only the resources on which permissionUser holds one of these levels: 1 (owner), 2 (edit), \
- or 3 (read only). Counts that user's direct grants and their custom groups' grants; identity \
- provider groups are known only while the user is signed in, so they are not counted.""";
- } else if (key.equals(PERMISSION_USER)) {
- return "The id of the user whose permission effectivePermissions checks.";
- } else if (key.equals(CREATED_BY)) {
- return """
- Keep only the resources created by one of these creators. Each is a map with the creator's \
- login "id" and login "type", such as {"id": "abc", "type": "MICROSOFT"}; both must match.""";
- } else if (key.equals(CREATED_BY_ME)) {
- return "When true, keep only the resources the calling user created, under any login in their session.";
- }
- return super.getDescriptionForKey(key);
+ public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition().description(
+ "Admin Only: Returns every project on the server, filtered by id, type, search text, metadata, creator or a user's permission level, and sorted by name unless sort says otherwise. Each project carries its metadata unless noMeta is true.")
+ .key(ReactorKeysEnum.LIMIT, key -> key.type(Integer.class))
+ .key(ReactorKeysEnum.META_FILTERS, key -> key.type(Map.class))
+ .key(ReactorKeysEnum.META_KEYS, key -> key.list(String.class))
+ .key(ReactorKeysEnum.NO_META, key -> key.type(Boolean.class))
+ .key(ReactorKeysEnum.OFFSET, key -> key.type(Integer.class))
+ .key(ReactorKeysEnum.PROJECT_TYPE,
+ key -> key.list(String.class).description("Keeps only the projects of these types."))
+ .key(ReactorKeysEnum.INCLUDE_USERTRACKING_KEY, key -> key.type(Boolean.class))
+ .key(ReactorKeysEnum.PROJECT,
+ key -> key.list(String.class).description("This is an optional project filter"))
+ .key(ReactorKeysEnum.SORT, key -> key.type(Map.class).description(
+ "The sort is a map with key and direction. Supported keys are 'PROJECTNAME', 'DATECREATED', and 'DATELASTEDITED' (or 'DATE_LAST_EDITED')."))
+ .key(PERMISSION_USER, "The id of the user whose permission effectivePermissions checks.")
+ .key(EFFECTIVE_PERMISSIONS, key -> key.list(Integer.class).description(
+ """
+ Keep only the resources on which permissionUser holds one of these levels: 1 (owner), 2 (edit), \
+ or 3 (read only). Counts that user's direct grants and their custom groups' grants; identity \
+ provider groups are known only while the user is signed in, so they are not counted."""))
+ .key(CREATED_BY, key -> key.list(Map.class).description("""
+ Keep only the resources created by one of these creators. Each is a map with the creator's \
+ login "id" and login "type", such as {"id": "abc", "type": "MICROSOFT"}; both must match."""))
+ .key(CREATED_BY_ME, key -> key.type(Boolean.class).description(
+ "When true, keep only the resources the calling user created, under any login in their session."));
}
}
diff --git a/src/prerna/auth/utils/reactors/admin/AdminProjectInfoReactor.java b/src/prerna/auth/utils/reactors/admin/AdminProjectInfoReactor.java
index 30a2d1660da..ce2ddca2695 100644
--- a/src/prerna/auth/utils/reactors/admin/AdminProjectInfoReactor.java
+++ b/src/prerna/auth/utils/reactors/admin/AdminProjectInfoReactor.java
@@ -37,6 +37,7 @@
import prerna.auth.utils.SecurityProjectUtils;
import prerna.project.api.IProject;
import prerna.reactor.AbstractReactor;
+import prerna.reactor.ReactorDefinition;
import prerna.sablecc2.om.GenRowStruct;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.PixelOperationType;
@@ -124,38 +125,32 @@ private void addRemoteMCPInfo(Map projectInfo, String projectId)
}
@Override
- public String getReactorDescription() {
- return """
- Admin-only: returns the full settings/metadata record for a single project regardless of the caller's \
- project permissions. The calling user must be an application admin or the reactor throws \
- "User must be an admin to perform this function".
-
- This is the admin counterpart to ProjectInfo, which instead enforces the caller's view/discoverable access.
-
- Inputs:
- project (required) - the project id.
- metaKeys (optional) - restrict the returned metadata tags to this list; omit to return all metadata.
-
- Returns a single map (PROJECT_INFO/CUSTOM_DATA_STRUCTURE) containing:
- Core project fields: project_id, project_name, project_display_name, project_type, project_cost,
- project_global, project_discoverable, project_is_template, project_catalog_name, project_created_by, project_created_by_type,
- project_date_created, project_date_last_edited, low_project_name.
- Portal fields: project_has_portal, project_portal_name, project_portal_published_date, project_published_user,
- project_published_user_type, project_reactors_compiled_date, project_reactors_compiled_user,
- project_reactors_compiled_user_type.
- Metadata: one entry per metadata tag (e.g. tag, domain, etc.); a tag with multiple values is returned as a list.
- GitHub: if the project is linked to a GitHub repo, the link fields are returned prefixed with gh_ (e.g. gh_repo).
- """;
- }
-
- @Override
- protected String getDescriptionForKey(String key) {
- if (ReactorKeysEnum.PROJECT.getKey().equals(key)) {
- return "Id of the project to look up";
- } else if (ReactorKeysEnum.META_KEYS.getKey().equals(key)) {
- return "Optional list of metadata tag names to return for the project; omit to return all metadata tags";
- }
- return super.getDescriptionForKey(key);
+ public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition()
+ .description(
+ """
+ Admin Only: Returns the full settings/metadata record for a single project regardless of the caller's \
+ project permissions. The calling user must be an application admin or the reactor throws \
+ "User must be an admin to perform this function".
+
+ This is the admin counterpart to ProjectInfo, which instead enforces the caller's view/discoverable access.
+
+ Inputs:
+ project (required) - the project id.
+ metaKeys (optional) - restrict the returned metadata tags to this list; omit to return all metadata.
+
+ Returns a single map (PROJECT_INFO/CUSTOM_DATA_STRUCTURE) containing:
+ Core project fields: project_id, project_name, project_display_name, project_type, project_cost,
+ project_global, project_discoverable, project_is_template, project_catalog_name, project_created_by, project_created_by_type,
+ project_date_created, project_date_last_edited, low_project_name.
+ Portal fields: project_has_portal, project_portal_name, project_portal_published_date, project_published_user,
+ project_published_user_type, project_reactors_compiled_date, project_reactors_compiled_user,
+ project_reactors_compiled_user_type.
+ Metadata: one entry per metadata tag (e.g. tag, domain, etc.); a tag with multiple values is returned as a list.
+ GitHub: if the project is linked to a GitHub repo, the link fields are returned prefixed with gh_ (e.g. gh_repo).
+ """)
+ .key(ReactorKeysEnum.PROJECT, "Id of the project to look up").key(ReactorKeysEnum.META_KEYS,
+ "Optional list of metadata tag names to return for the project; omit to return all metadata tags");
}
}
diff --git a/src/prerna/auth/utils/reactors/admin/AdminSqlQueryReactor.java b/src/prerna/auth/utils/reactors/admin/AdminSqlQueryReactor.java
index f97b679aa41..85b91a84b94 100644
--- a/src/prerna/auth/utils/reactors/admin/AdminSqlQueryReactor.java
+++ b/src/prerna/auth/utils/reactors/admin/AdminSqlQueryReactor.java
@@ -47,6 +47,7 @@
import prerna.query.querystruct.AbstractQueryStruct;
import prerna.query.querystruct.HardSelectQueryStruct;
import prerna.reactor.AbstractReactor;
+import prerna.reactor.ReactorDefinition;
import prerna.sablecc2.om.NounStore;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.ReactorKeysEnum;
@@ -285,8 +286,13 @@ private int parseLimit(String limitStr) {
}
@Override
- public String getReactorDescription() {
- return "Admin-only SQL query execution with pagination support (limit and offset), bypassing normal permission checks";
+ public ReactorDefinition getReactorDefinition() {
+ return super.getReactorDefinition().description(
+ "Admin Only: SQL query execution with pagination support (limit and offset), bypassing normal permission checks")
+ .key("commit",
+ key -> key.type(Boolean.class).description(
+ "A true or false flag sent with statements that change data; false when not given."))
+ .key(ReactorKeysEnum.LIMIT, key -> key.type(Integer.class));
}
}
diff --git a/src/prerna/collaboration/BrainDraftFormat.java b/src/prerna/collaboration/BrainDraftFormat.java
index 4cd83d67a09..d71cc56ad65 100644
--- a/src/prerna/collaboration/BrainDraftFormat.java
+++ b/src/prerna/collaboration/BrainDraftFormat.java
@@ -1,3 +1,30 @@
+/*******************************************************************************
+ * Copyright 2015 Defense Health Agency (DHA)
+ *
+ * If your use of this software does not include any GPLv2 components:
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ----------------------------------------------------------------------------
+ * If your use of this software includes any GPLv2 components:
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *******************************************************************************/
package prerna.collaboration;
import java.sql.Timestamp;
@@ -30,7 +57,10 @@
import prerna.auth.User;
import prerna.util.Utility;
-/** How drafts written for the owner look in Outlook: their font, single spaced lines, and their signature. */
+/**
+ * How drafts written for the owner look in Outlook: their font, single spaced
+ * lines, and their signature.
+ */
public final class BrainDraftFormat {
private static final Logger classLogger = LogManager.getLogger(BrainDraftFormat.class);
@@ -46,7 +76,8 @@ public final class BrainDraftFormat {
private static final Pattern FAMILY = Pattern.compile("font-family\\s*:\\s*([^;]+)", Pattern.CASE_INSENSITIVE);
private static final Pattern SIZE = Pattern.compile("font-size\\s*:\\s*([0-9.]+)\\s*(pt|px)",
Pattern.CASE_INSENSITIVE);
- // where Outlook and Gmail put the signature they insert; mobile "Get Outlook" lines are not one
+ // where Outlook and Gmail put the signature they insert; mobile "Get Outlook"
+ // lines are not one
private static final Pattern FORWARD = Pattern.compile("^\\s*(fw|fwd)\\s*:", Pattern.CASE_INSENSITIVE);
private static final String SIGNATURE = "#Signature, [id^=x_Signature], div.gmail_signature";
@@ -58,8 +89,9 @@ public record Format(String font, int size, String signatureHtml) {
}
/**
- * The Collaboration owner's draft look; null when Collaboration is off, the user has no Brain settings or they
- * cannot be read, so the mail connectors keep their own formatting for everyone else.
+ * The Collaboration owner's draft look; null when Collaboration is off, the
+ * user has no Brain settings or they cannot be read, so the mail connectors
+ * keep their own formatting for everyone else.
*/
public static Format forOwner(User user) {
try {
@@ -74,8 +106,8 @@ public static Format forOwner(User user) {
boolean on = !Boolean.FALSE.equals(CollaborationDbUtils.getBoolean(rs, "DRAFT_SIGNATURE_ON"));
String signature = CollaborationDbUtils.getString(rs, "DRAFT_SIGNATURE_HTML");
return new Format(font == null || font.isBlank() ? DEFAULT_FONT : font,
- size == null ? DEFAULT_SIZE : size, on && signature != null && !signature.isBlank()
- ? signature : null);
+ size == null ? DEFAULT_SIZE : size,
+ on && signature != null && !signature.isBlank() ? signature : null);
}, owner.getValue0(), owner.getValue1());
return format;
} catch (Exception e) {
@@ -85,7 +117,10 @@ public static Format forOwner(User user) {
}
}
- /** Collaboration's own drafts: the owner's look, or the default one before they have Brain settings. */
+ /**
+ * Collaboration's own drafts: the owner's look, or the default one before they
+ * have Brain settings.
+ */
public static String html(User user, String text) {
Format format = forOwner(user);
return html(format == null ? new Format(DEFAULT_FONT, DEFAULT_SIZE, null) : format, text);
@@ -96,7 +131,10 @@ public static String body(Format format, String body, boolean html) {
return html ? htmlBody(format, body) : html(format, body);
}
- /** Plain text as Outlook-style HTML: one div per line (no paragraph gaps), the owner's font, their signature. */
+ /**
+ * Plain text as Outlook-style HTML: one div per line (no paragraph gaps), the
+ * owner's font, their signature.
+ */
public static String html(Format format, String text) {
if (format.signatureHtml() != null) {
text = stripTyped(text, signatureKeys(format.signatureHtml()));
@@ -118,8 +156,8 @@ public static String html(Format format, String text) {
}
/**
- * HTML from the editor in the owner's look: no paragraph gaps (Outlook's own mail has none), their font, and their
- * signature unless it is already there.
+ * HTML from the editor in the owner's look: no paragraph gaps (Outlook's own
+ * mail has none), their font, and their signature unless it is already there.
*/
public static String htmlBody(Format format, String html) {
Document doc = Jsoup.parseBodyFragment(html == null ? "" : html);
@@ -140,13 +178,18 @@ public static String htmlBody(Format format, String html) {
return out.append("").toString();
}
- /** The text without a signature typed at its end, when the owner's saved one is added anyway. */
+ /**
+ * The text without a signature typed at its end, when the owner's saved one is
+ * added anyway.
+ */
public static String withoutTypedSignature(User user, String text) {
Format format = forOwner(user);
- return format == null || format.signatureHtml() == null ? text : stripTyped(text, signatureKeys(format.signatureHtml()));
+ return format == null || format.signatureHtml() == null ? text
+ : stripTyped(text, signatureKeys(format.signatureHtml()));
}
- // the signature's lines, letters and digits only, so "571-363-9720" matches "571 363 9720"
+ // the signature's lines, letters and digits only, so "571-363-9720" matches
+ // "571 363 9720"
static Set signatureKeys(String html) {
Document doc = Jsoup.parseBodyFragment(html);
doc.select("br").after("\n");
@@ -208,7 +251,8 @@ private static void stripTyped(Document doc, Set keys) {
typed.add(block);
}
if (matched >= 2) {
- // with the blank lines between it and the body; the signature brings its own gap
+ // with the blank lines between it and the body; the signature brings its own
+ // gap
typed.forEach(Element::remove);
}
}
@@ -216,11 +260,15 @@ private static void stripTyped(Document doc, Set keys) {
private static String cssFamily(String font) {
String name = FONT_NAME.matcher(font).matches() ? font : DEFAULT_FONT;
// Outlook names Aptos by its cloud font aliases too
- return DEFAULT_FONT.equals(name) ? "Aptos, Aptos_EmbeddedFont, Aptos_MSFontService, Calibri, Helvetica, sans-serif"
+ return DEFAULT_FONT.equals(name)
+ ? "Aptos, Aptos_EmbeddedFont, Aptos_MSFontService, Calibri, Helvetica, sans-serif"
: "'" + name + "', Calibri, Helvetica, sans-serif";
}
- /** The owner's name and address, so a draft shows who it is from before it is sent; null when unknown. */
+ /**
+ * The owner's name and address, so a draft shows who it is from before it is
+ * sent; null when unknown.
+ */
public static String[] sender(User user) {
AccessToken token = user == null ? null : user.getAccessToken(AuthProvider.MICROSOFT);
if (token == null || token.getEmail() == null || token.getEmail().isBlank()) {
@@ -233,7 +281,10 @@ static boolean validFont(String font) {
return font != null && FONT_NAME.matcher(font).matches();
}
- /** Their own signature HTML, made safe to put back in a draft; null when nothing is left. */
+ /**
+ * Their own signature HTML, made safe to put back in a draft; null when nothing
+ * is left.
+ */
static String clean(String html) {
if (html == null || html.isBlank()) {
return null;
@@ -242,7 +293,8 @@ static String clean(String html) {
Document doc = Jsoup.parseBodyFragment(Jsoup.clean(html, safe));
// inline cid images do not travel with a copied signature
doc.select("img:not([src])").remove();
- // Outlook's own stylesheet zeroes paragraph margins; inline it so lines do not spread apart
+ // Outlook's own stylesheet zeroes paragraph margins; inline it so lines do not
+ // spread apart
for (Element block : doc.select("p, div")) {
if (!block.attr("style").contains("margin")) {
block.attr("style", ("margin: 0; " + block.attr("style")).strip());
@@ -258,7 +310,10 @@ static String clean(String html) {
// ---- learning from sent mail ----
- /** What sent mail shows: the signature most used and the body font most used; empty fields when not found. */
+ /**
+ * What sent mail shows: the signature most used and the body font most used;
+ * empty fields when not found.
+ */
public static Map learn(User user) {
Pair owner = CollaborationDbUtils.ownerOf(user);
List sentFolders = BrainMailFolders.load(owner.getValue0(), owner.getValue1()).byId().values().stream()
@@ -269,11 +324,10 @@ public static Map learn(User user) {
params.addAll(sentFolders);
String inSent = sentFolders.isEmpty() ? ""
: " OR FOLDER IN (" + String.join(",", Collections.nCopies(sentFolders.size(), "?")) + ")";
- List ids = CollaborationDbUtils.query(
- CollaborationDbUtils.page("SELECT GRAPH_ID FROM BRAIN_MESSAGE WHERE OWNER_ID = ? AND OWNER_TYPE = ? "
+ List ids = CollaborationDbUtils.query(CollaborationDbUtils.page(
+ "SELECT GRAPH_ID FROM BRAIN_MESSAGE WHERE OWNER_ID = ? AND OWNER_TYPE = ? "
+ "AND RECEIVED_AT >= ? AND (FOLDER LIKE ?" + inSent + ") ORDER BY RECEIVED_AT DESC",
- SENT_TO_READ, 0),
- rs -> rs.getString("GRAPH_ID"), params.toArray());
+ SENT_TO_READ, 0), rs -> rs.getString("GRAPH_ID"), params.toArray());
Map signatures = new LinkedHashMap<>();
Map signatureHtml = new HashMap<>();
Map fonts = new LinkedHashMap<>();
@@ -282,7 +336,8 @@ public static Map learn(User user) {
int read = 0;
for (BrainMessageSource.Fetched fetched : BrainMessageSource.current().fetchAll(user, "email", null, ids)) {
Map message = fetched.message();
- // a forward carries someone else's signature; a routine's styled result mailed to the owner carries none
+ // a forward carries someone else's signature; a routine's styled result mailed
+ // to the owner carries none
if (message == null || FORWARD.matcher(String.valueOf(message.get("subject"))).find()
|| BrainStyleLearning.toThemselves(message)) {
continue;
@@ -343,7 +398,10 @@ public static Map learn(User user) {
return out;
}
- /** Copies what sent mail shows into the settings; with onlyMissing, keeps anything already set. */
+ /**
+ * Copies what sent mail shows into the settings; with onlyMissing, keeps
+ * anything already set.
+ */
public static Map learnInto(User user, boolean onlyMissing) {
Map learned = learn(user);
Pair owner = CollaborationDbUtils.ownerOf(user);
@@ -354,7 +412,8 @@ public static Map learnInto(User user, boolean onlyMissing) {
List sets = new ArrayList<>();
List