-
Notifications
You must be signed in to change notification settings - Fork 17
Expand file tree
/
Copy pathSecurityEngineUtils.java
More file actions
3468 lines (3202 loc) · 143 KB
/
Copy pathSecurityEngineUtils.java
File metadata and controls
3468 lines (3202 loc) · 143 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*******************************************************************************
* 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.auth.utils;
import java.io.IOException;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.UUID;
import java.util.stream.Collectors;
import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.javatuples.Pair;
import prerna.auth.AccessPermissionEnum;
import prerna.auth.AccessToken;
import prerna.auth.AuthProvider;
import prerna.auth.User;
import prerna.engine.api.IEngine;
import prerna.engine.api.IRDBMSEngine;
import prerna.engine.api.IRawSelectWrapper;
import prerna.engine.impl.SmssUtilities;
import prerna.notifications.NotificationDbUtils;
import prerna.query.querystruct.SelectQueryStruct;
import prerna.query.querystruct.filters.AndQueryFilter;
import prerna.query.querystruct.filters.IQueryFilter;
import prerna.query.querystruct.filters.OrQueryFilter;
import prerna.query.querystruct.filters.SimpleQueryFilter;
import prerna.query.querystruct.joins.IRelation;
import prerna.query.querystruct.joins.SubqueryRelationship;
import prerna.query.querystruct.selectors.QueryColumnOrderBySelector;
import prerna.query.querystruct.selectors.QueryColumnSelector;
import prerna.query.querystruct.selectors.QueryFunctionHelper;
import prerna.query.querystruct.selectors.QueryFunctionSelector;
import prerna.query.querystruct.selectors.QueryIfSelector;
import prerna.rdf.engine.wrappers.WrapperManager;
import prerna.sablecc2.om.PixelDataType;
import prerna.sablecc2.om.execptions.SemossPixelException;
import prerna.util.ConnectionUtils;
import prerna.util.Constants;
import prerna.util.DIHelper;
import prerna.util.EmailUtility;
import prerna.util.NotificationConstants;
import prerna.util.QueryExecutionUtility;
import prerna.util.SystemEngineRegistry;
import prerna.util.Utility;
import prerna.util.sql.AbstractSqlQueryUtil;
public class SecurityEngineUtils extends AbstractSecurityUtils {
private static final Logger classLogger = LogManager.getLogger(SecurityEngineUtils.class);
/**
* Add an entire database into the security db
*
* @param engineId
*
* PLEASE DEFINE GLOBAL
* {@link #addEngine(String, boolean, User)}
*/
@Deprecated
public static void addEngine(String engineId, User user) {
if (ignoreDatabase(engineId)) {
// dont add local master or security db to security db
return;
}
// default engine is not global
addEngine(engineId, false, user);
}
/**
* Add an entire database into the security db
*
* @param engineId
*/
public static void addEngine(String engineId, boolean global, User user) {
if (ignoreDatabase(engineId)) {
// dont add local master or security db to security db
return;
}
String smssFile = DIHelper.getInstance().getEngineProperty(engineId + "_" + Constants.STORE) + "";
Properties prop = Utility.loadProperties(smssFile);
String engineName = prop.getProperty(Constants.ENGINE_ALIAS);
if (engineName == null) {
engineName = engineId;
}
String displayName = prop.getProperty(Constants.ENGINE_DISPLAY_NAME);
if (displayName == null || displayName.trim().isEmpty()) {
displayName = engineName;
}
Object[] typeAndCost = getEngineTypeAndSubTypeAndCost(prop);
IEngine.CATALOG_TYPE engineType = (IEngine.CATALOG_TYPE) typeAndCost[0];
boolean engineExists = containsEngineId(engineId);
if (engineExists) {
updateEngineTypeAndSubType(engineId, engineType, (String) typeAndCost[1]);
classLogger.info("Security database already contains engine of type {} with unique id = {}", typeAndCost[0],
Utility.cleanLogString(SmssUtilities.getUniqueName(prop)));
} else {
addEngine(engineId, engineName, displayName, engineType, (String) typeAndCost[1], (String) typeAndCost[2],
global, user);
}
if (engineType == IEngine.CATALOG_TYPE.MODEL) {
try {
SecurityModelMetadataUtils.upsertModelMetadata(engineId, prop);
} catch (Exception e) {
classLogger.error("Failed to save model metadata for engine {}. The engine is cataloged without it",
Utility.cleanLogString(engineId), e);
}
}
// TODO: need to see when we should be updating the database metadata
// if(engineExists) {
// // update database properties anyway ... in case global was shifted for
// example
// updateDatabase(databaseId, databaseName, typeAndCost[0], typeAndCost[1],
// global);
// }
classLogger.info("Finished adding engine = {}", Utility.cleanLogString(engineId));
}
/**
* Utility method to get the engine type, subtype, and cost This returns
* ENGINETYPE as the enum IEngine.CATALOG_TYPE and not the String format it is
* stored in
*
* @param prop
* @return
*/
public static Object[] getEngineTypeAndSubTypeAndCost(Properties smssProp) {
IEngine.CATALOG_TYPE engineType = null;
String engineSubType = null;
String engineCost = "$";
String rawType = smssProp.get(Constants.ENGINE_TYPE).toString();
try {
IEngine emptyClass = (IEngine) Class.forName(rawType).getConstructor().newInstance();
engineType = emptyClass.getCatalogType();
engineSubType = emptyClass.getCatalogSubType(smssProp);
} catch (Exception e) {
classLogger.warn("Unknown class name = {}", rawType);
}
return new Object[] { engineType, engineSubType, engineCost };
}
/**
* This returns ENGINETYPE as the enum IEngine.CATALOG_TYPE and not the String
* format it is stored in
*
* @param engineId
* @return
*/
public static IEngine.CATALOG_TYPE getEngineType(String engineId) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
SelectQueryStruct qs = new SelectQueryStruct();
qs.addSelector(new QueryColumnSelector("ENGINE__ENGINETYPE"));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINE__ENGINEID", "==", engineId));
List<Object[]> results = QueryExecutionUtility.flushRsToListOfObjArray(securityDb, qs);
if (results == null || results.isEmpty()) {
throw new IllegalArgumentException("Could not find engine with id " + engineId);
}
Object[] result = results.get(0);
return IEngine.CATALOG_TYPE.valueOf(result[0] + "");
}
/**
* This returns ENGINETYPE as the enum IEngine.CATALOG_TYPE and not the String
* format it is stored in
*
* @param engineId
* @return
*/
public static Object[] getEngineTypeAndSubtype(String engineId) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
SelectQueryStruct qs = new SelectQueryStruct();
qs.addSelector(new QueryColumnSelector("ENGINE__ENGINETYPE"));
qs.addSelector(new QueryColumnSelector("ENGINE__ENGINESUBTYPE"));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINE__ENGINEID", "==", engineId));
List<Object[]> results = QueryExecutionUtility.flushRsToListOfObjArray(securityDb, qs);
if (results == null || results.isEmpty()) {
throw new IllegalArgumentException("Could not find engine with id " + engineId);
}
Object[] result = results.get(0);
result[0] = IEngine.CATALOG_TYPE.valueOf(result[0] + "");
return results.get(0);
}
/**
*
* @param engineId
* @param engineName
* @param engineType
* @param engineSubType
* @param engineCost
* @param global
* @param user
*/
public static void addEngine(String engineId, String engineName, IEngine.CATALOG_TYPE engineType,
String engineSubType, String engineCost, boolean global, User user) {
addEngine(engineId, engineName, engineName, engineType, engineSubType, engineCost, global, user);
}
public static void addEngine(String engineId, String engineName, String engineDisplayName,
IEngine.CATALOG_TYPE engineType, String engineSubType, String engineCost, boolean global, User user) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
String query = "INSERT INTO ENGINE (ENGINEID, ENGINENAME, ENGINETYPE, ENGINESUBTYPE, COST, GLOBAL, DISCOVERABLE, CREATEDBY, CREATEDBYTYPE, DATECREATED, ENGINEDISPLAYNAME) "
+ "VALUES (?,?,?,?,?,?,?,?,?,?,?)";
try {
QueryExecutionUtility.executeUpdate(securityDb, query, ps -> {
int parameterIndex = 1;
ps.setString(parameterIndex++, engineId);
securityDb.getQueryUtil().setNullableString(ps, parameterIndex++, engineName);
ps.setString(parameterIndex++, engineType.toString());
securityDb.getQueryUtil().setNullableString(ps, parameterIndex++, engineSubType);
securityDb.getQueryUtil().setNullableString(ps, parameterIndex++, engineCost);
ps.setBoolean(parameterIndex++, global);
ps.setBoolean(parameterIndex++, false);
if (user != null) {
AuthProvider ap = user.getPrimaryLogin();
AccessToken token = user.getAccessToken(ap);
ps.setString(parameterIndex++, token.getId());
ps.setString(parameterIndex++, ap.toString());
} else {
ps.setNull(parameterIndex++, java.sql.Types.VARCHAR);
ps.setNull(parameterIndex++, java.sql.Types.VARCHAR);
}
ps.setTimestamp(parameterIndex++, Utility.getCurrentSqlTimestampUTC());
if (engineDisplayName == null || engineDisplayName.trim().isEmpty()) {
ps.setString(parameterIndex++, engineName);
} else {
ps.setString(parameterIndex++, engineDisplayName);
}
});
} catch (RuntimeException e) {
throw e;
} catch (Exception e) {
classLogger.error("Failed to create the engine record in the security database", e);
}
}
public static void updateEngineTypeAndSubType(String engineId, IEngine.CATALOG_TYPE engineType,
String engineSubType) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
String query = "UPDATE ENGINE SET ENGINETYPE=?, ENGINESUBTYPE=? WHERE ENGINEID=?";
try {
QueryExecutionUtility.executeUpdate(securityDb, query, ps -> {
int parameterIndex = 1;
ps.setString(parameterIndex++, engineType.toString());
ps.setString(parameterIndex++, engineSubType);
ps.setString(parameterIndex++, engineId);
});
} catch (RuntimeException e) {
throw e;
} catch (Exception e) {
classLogger.error("Failed to update engine type and subtype", e);
}
}
public static void addEngineOwner(String engineId, String userId) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
// make sure user doesn't already exist for this database
if (getUserEnginePermission(userId, engineId) != null) {
// that means there is already a value
throw new IllegalArgumentException("This user already has access to this engine");
}
String query = "INSERT INTO ENGINEPERMISSION (USERID, PERMISSION, ENGINEID, VISIBILITY, DATEADDED) VALUES (?,?,?,?,?)";
try {
QueryExecutionUtility.executeUpdate(securityDb, query, ps -> {
int parameterIndex = 1;
ps.setString(parameterIndex++, userId);
ps.setInt(parameterIndex++, AccessPermissionEnum.OWNER.getId());
ps.setString(parameterIndex++, engineId);
ps.setBoolean(parameterIndex++, true);
ps.setTimestamp(parameterIndex++, Utility.getCurrentSqlTimestampUTC());
});
} catch (RuntimeException e) {
throw e;
} catch (Exception e) {
classLogger.error("Failed to add engine owner", e);
}
}
/**
* Get the database alias for a id
*
* @return
*/
public static String getEngineAliasForId(String id) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
// String query = "SELECT ENGINENAME FROM ENGINE WHERE ENGINEID='" + id + "'";
// IRawSelectWrapper wrapper =
// WrapperManager.getInstance().getRawWrapper(securityDb, query);
SelectQueryStruct qs = new SelectQueryStruct();
qs.addSelector(new QueryColumnSelector("ENGINE__ENGINENAME"));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINE__ENGINEID", "==", id));
List<String> results = QueryExecutionUtility.flushToListString(securityDb, qs);
if (results.isEmpty()) {
return null;
}
return results.get(0);
}
/**
* Get the database alias for a id
*
* @return
*/
public static Map<Object, Object> getEngineAliasForIds(Collection<String> ids) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
SelectQueryStruct qs = new SelectQueryStruct();
qs.addSelector(new QueryColumnSelector("ENGINE__ENGINEID"));
qs.addSelector(new QueryColumnSelector("ENGINE__ENGINENAME"));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINE__ENGINEID", "==", ids));
return QueryExecutionUtility.flushRsToKeyValueMap(securityDb, qs);
}
/**
* Get the display name for an engine id. Falls back to canonical name
* (ENGINENAME) if display name is null or blank.
*
* @param id
* @return
*/
public static String getEngineDisplayNameForId(String id) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
SelectQueryStruct qs = new SelectQueryStruct();
qs.addSelector(new QueryColumnSelector("ENGINE__ENGINEDISPLAYNAME"));
qs.addSelector(new QueryColumnSelector("ENGINE__ENGINENAME"));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINE__ENGINEID", "==", id));
List<Object[]> results = QueryExecutionUtility.flushRsToListOfObjArray(securityDb, qs);
if (results.isEmpty()) {
return null;
}
Object[] row = results.get(0);
String displayName = row[0] != null ? row[0].toString() : null;
String canonicalName = row[1] != null ? row[1].toString() : null;
if (displayName == null || displayName.trim().isEmpty()) {
return canonicalName;
}
return displayName;
}
/**
* Set the display name for an engine. Only the engine owner can perform this
* action.
*
* @param user
* @param engineId
* @param newDisplayName
* @return
* @throws IllegalAccessException
*/
public static boolean setEngineDisplayName(User user, String engineId, String newDisplayName)
throws IllegalAccessException {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
if (!SecurityUserEngineUtils.userIsOwner(user, engineId)) {
throw new IllegalAccessException(
"The user doesn't have the permission to change the engine display name. Only the owner can perform this action.");
}
if (newDisplayName == null || newDisplayName.trim().isEmpty()) {
throw new IllegalArgumentException("Display name cannot be null or blank.");
}
try {
QueryExecutionUtility.executeUpdate(securityDb, "UPDATE ENGINE SET ENGINEDISPLAYNAME=? WHERE ENGINEID=?",
ps -> {
int parameterIndex = 1;
ps.setString(parameterIndex++, newDisplayName);
ps.setString(parameterIndex++, engineId);
});
} catch (Exception e) {
classLogger.error("Failed to update engine display name", e);
throw new IllegalArgumentException("An error occurred updating the engine display name");
}
return true;
}
/**
* Get what permission the user has for a given engine
*
* @param userId
* @param engineId
* @return
*/
public static String getActualUserEnginePermission(User user, String engineId) {
String userPermission = SecurityUserEngineUtils.getActualUserEnginePermission(user, engineId);
List<String> groupUserPermissions = SecurityUserEngineUtils.getActualGroupUserEnginePermission(user, engineId);
return SecurityUserEngineUtils.getHighestEnginePermission(userPermission, groupUserPermissions);
}
/**
*
* @return
*/
public static List<String> getAllEngineIds() {
return getAllEngineIds(null);
}
/**
* Get a list of the database ids
*
* @return
*/
public static List<String> getAllEngineIds(List<String> engineTypes) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
// String query = "SELECT DISTINCT ENGINEID FROM ENGINE";
// IRawSelectWrapper wrapper =
// WrapperManager.getInstance().getRawWrapper(securityDb, query);
SelectQueryStruct qs = new SelectQueryStruct();
qs.addSelector(new QueryColumnSelector("ENGINE__ENGINEID"));
if (engineTypes != null && !engineTypes.isEmpty()) {
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINE__ENGINETYPE", "==", engineTypes));
}
return QueryExecutionUtility.flushToListString(securityDb, qs);
}
/**
* Get markdown for a given engine
*
* @param user
* @param engineId
* @return
*/
public static String getEngineMarkdown(User user, String engineId) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
SelectQueryStruct qs = new SelectQueryStruct();
qs.addSelector(new QueryColumnSelector("ENGINEMETA__METAVALUE"));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINEMETA__METAKEY", "==", Constants.MARKDOWN));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINEMETA__ENGINEID", "==", engineId));
{
SelectQueryStruct qs1 = new SelectQueryStruct();
qs1.addSelector(new QueryColumnSelector("ENGINE__ENGINEID"));
{
OrQueryFilter orFilter = new OrQueryFilter();
orFilter.addFilter(SimpleQueryFilter.makeColToValFilter("ENGINE__DISCOVERABLE", "==",
Arrays.asList(true, null), PixelDataType.BOOLEAN));
orFilter.addFilter(
SimpleQueryFilter.makeColToValFilter("ENGINEPERMISSION__USERID", "==", getUserFiltersQs(user)));
qs1.addExplicitFilter(orFilter);
}
qs1.addRelation("ENGINE", "ENGINEPERMISSION", "join");
IRelation subQuery = new SubqueryRelationship(qs1, "ENGINE", "join",
new String[] { "ENGINE__ENGINEID", "ENGINEMETA__ENGINEID", "=" });
qs.addRelation(subQuery);
}
return QueryExecutionUtility.flushToString(securityDb, qs);
}
/**
* Initialize an engine's markdown metadata without replacing existing content.
*
* @param engineId engine whose metadata should be initialized
* @param defaultMarkdown markdown supplied by the engine implementation
*/
public static void setDefaultEngineMarkdown(String engineId, String defaultMarkdown) {
if (defaultMarkdown == null || defaultMarkdown.trim().isEmpty()) {
return;
}
Map<String, Object> metadata = getAggregateEngineMetadata(engineId, List.of(Constants.MARKDOWN), false);
if (hasMetadataValue(metadata.get(Constants.MARKDOWN))) {
return;
}
Map<String, Object> defaultMetadata = new HashMap<>();
defaultMetadata.put(Constants.MARKDOWN, defaultMarkdown);
updateEngineMetadata(engineId, defaultMetadata);
}
private static boolean hasMetadataValue(Object value) {
if (value == null) {
return false;
}
if (value instanceof Collection) {
for (Object item : (Collection<?>) value) {
if (hasMetadataValue(item)) {
return true;
}
}
return false;
}
return !value.toString().trim().isEmpty();
}
/**
* Get the engine permissions for a specific user
*
* @param singleUserId
* @param engineId
* @return
*/
public static Integer getUserEnginePermission(String singleUserId, String engineId) {
return SecurityUserEngineUtils.getUserEnginePermission(singleUserId, engineId);
}
/**
* Get the request pending database permission for a specific user
*
* @param singleUserId
* @param databaseId
* @return
*/
public static Integer getUserAccessRequestEnginePermission(String userId, String databaseId) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
SelectQueryStruct qs = new SelectQueryStruct();
qs.addSelector(new QueryColumnSelector("ENGINEACCESSREQUEST__PERMISSION"));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINEACCESSREQUEST__REQUEST_USERID", "==", userId));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINEACCESSREQUEST__ENGINEID", "==", databaseId));
qs.addExplicitFilter(
SimpleQueryFilter.makeColToValFilter("ENGINEACCESSREQUEST__APPROVER_DECISION", "==", null));
return QueryExecutionUtility.flushToInteger(securityDb, qs);
}
/**
* Approving user access requests and giving user access in permissions
*
* @param userId
* @param userType
* @param engineId
* @param requests
*/
public static void approveEngineUserAccessRequests(User user, String engineId, List<Map<String, String>> requests,
String endDate) throws IllegalAccessException {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
// make sure user has right permission level to approve access requests
int userPermissionLvl = getMaxUserEnginePermission(user, engineId);
if (!AccessPermissionEnum.isEditor(userPermissionLvl)) {
throw new IllegalAccessException("Insufficient privileges to modify this engine's permissions.");
}
// get user permissions of all requests
List<String> permissions = new ArrayList<String>();
for (Map<String, String> i : requests) {
permissions.add(i.get("permission"));
}
// if user is not an owner, check to make sure they cannot grant owner access
if (!AccessPermissionEnum.isEditor(userPermissionLvl)) {
throw new IllegalArgumentException("You cannot grant user access to others.");
} else {
if (!AccessPermissionEnum.isOwner(userPermissionLvl) && permissions.contains("OWNER")) {
throw new IllegalArgumentException("As a non-owner, you cannot grant owner access.");
}
}
Timestamp startDate = Utility.getCurrentSqlTimestampUTC();
Timestamp verifiedEndDate = null;
if (endDate != null) {
verifiedEndDate = AbstractSecurityUtils.calculateEndDate(endDate);
}
// bulk delete
String deleteQ = "DELETE FROM ENGINEPERMISSION WHERE USERID=? AND ENGINEID=?";
PreparedStatement deletePs = null;
try {
deletePs = securityDb.getPreparedStatement(deleteQ);
for (int i = 0; i < requests.size(); i++) {
int parameterIndex = 1;
deletePs.setString(parameterIndex++, requests.get(i).get("userid"));
deletePs.setString(parameterIndex++, engineId);
deletePs.addBatch();
}
deletePs.executeBatch();
if (!deletePs.getConnection().getAutoCommit()) {
deletePs.getConnection().commit();
}
} catch (Exception e) {
classLogger.error("Failed to approve engine user access requests", e);
throw new IllegalArgumentException(
"An error occurred while deleting enginepermission with detailed message = " + e.getMessage());
} finally {
ConnectionUtils.closeAllConnectionsIfPooling(securityDb, deletePs);
}
// insert new user permissions in bulk
String insertQ = "INSERT INTO ENGINEPERMISSION (USERID, ENGINEID, PERMISSION, VISIBILITY, PERMISSIONGRANTEDBY, PERMISSIONGRANTEDBYTYPE, DATEADDED, ENDDATE) VALUES(?,?,?,?,?,?,?,?)";
PreparedStatement insertPs = null;
Pair<String, String> userDetails = User.getPrimaryUserIdAndTypePair(user);
try {
insertPs = securityDb.getPreparedStatement(insertQ);
for (int i = 0; i < requests.size(); i++) {
int parameterIndex = 1;
insertPs.setString(parameterIndex++, requests.get(i).get("userid"));
insertPs.setString(parameterIndex++, engineId);
insertPs.setInt(parameterIndex++,
AccessPermissionEnum.getIdByPermission(requests.get(i).get("permission")));
insertPs.setBoolean(parameterIndex++, true);
insertPs.setString(parameterIndex++, userDetails.getValue0());
insertPs.setString(parameterIndex++, userDetails.getValue1());
insertPs.setTimestamp(parameterIndex++, startDate);
insertPs.setTimestamp(parameterIndex++, verifiedEndDate);
insertPs.addBatch();
}
insertPs.executeBatch();
if (!insertPs.getConnection().getAutoCommit()) {
insertPs.getConnection().commit();
}
} catch (Exception e) {
classLogger.error("Failed to approve engine user access requests", e);
} finally {
ConnectionUtils.closeAllConnectionsIfPooling(securityDb, insertPs);
}
// now we do the new bulk update to engineaccessrequest table
String updateQ = "UPDATE ENGINEACCESSREQUEST SET PERMISSION = ?, APPROVER_USERID = ?, APPROVER_TYPE = ?, APPROVER_DECISION = ?, APPROVER_TIMESTAMP = ? WHERE ID = ? AND ENGINEID = ?";
PreparedStatement updatePs = null;
try {
java.sql.Timestamp timestamp = Utility.getCurrentSqlTimestampUTC();
updatePs = securityDb.getPreparedStatement(updateQ);
AccessToken token = user.getAccessToken(user.getPrimaryLogin());
String userId = token.getId();
String userType = token.getProvider().toString();
for (int i = 0; i < requests.size(); i++) {
int index = 1;
// set
updatePs.setInt(index++, AccessPermissionEnum.getIdByPermission(requests.get(i).get("permission")));
updatePs.setString(index++, userId);
updatePs.setString(index++, userType);
updatePs.setString(index++, "APPROVED");
updatePs.setTimestamp(index++, timestamp);
// where
updatePs.setString(index++, requests.get(i).get("requestid"));
updatePs.setString(index++, engineId);
updatePs.addBatch();
}
updatePs.executeBatch();
if (!updatePs.getConnection().getAutoCommit()) {
updatePs.getConnection().commit();
}
// Adding Notification
if (Utility.isNotificationDatabaseEnabled()) {
String engineType = String.valueOf(getEngineType(engineId)).toLowerCase();
for (int i = 0; i < requests.size(); i++) {
NotificationDbUtils.createNotification(user, requests.get(i).get("userid"),
requests.get(i).get("type"), engineId, NotificationConstants.Type.REQUEST_APPROVAL,
engineType, NotificationConstants.Priority.MEDIUM, null, requests.get(i).get("permission"),
NotificationConstants.DisplaySurface.BELL);
// Adding email notification
EmailUtility.sendAccessRequestApprovalEmailNotification(user, requests.get(i).get("userid"),
engineId, requests.get(i).get("permission"), EmailUtility.RESOURCE_TYPE.ENGINE);
}
}
} catch (Exception e) {
classLogger.error("Failed to approve engine user access requests", e);
throw new IllegalArgumentException(
"An error occurred while updating user access request detailed message = " + e.getMessage());
} finally {
ConnectionUtils.closeAllConnectionsIfPooling(securityDb, updatePs);
}
}
/**
* Denying user access requests to engine
*
* @param userId
* @param userType
* @param engineId
* @param requests
*/
public static void denyEngineUserAccessRequests(User user, String engineId, List<String> requestIds)
throws IllegalAccessException {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
// make sure user has right permission level to approve acces requests
int userPermissionLvl = getMaxUserEnginePermission(user, engineId);
if (!AccessPermissionEnum.isEditor(userPermissionLvl)) {
throw new IllegalAccessException("Insufficient privileges to modify this engine's permissions.");
}
// only database owners can deny user access requests
if (!AccessPermissionEnum.isOwner(userPermissionLvl)) {
throw new IllegalArgumentException("Insufficient privileges to deny user access requests.");
}
// bulk update to engineaccessrequest table
String updateQ = "UPDATE ENGINEACCESSREQUEST SET APPROVER_USERID = ?, APPROVER_TYPE = ?, APPROVER_DECISION = ?, APPROVER_TIMESTAMP = ? WHERE ID = ? AND ENGINEID = ?";
PreparedStatement ps = null;
try {
java.sql.Timestamp timestamp = Utility.getCurrentSqlTimestampUTC();
ps = securityDb.getPreparedStatement(updateQ);
AccessToken token = user.getAccessToken(user.getPrimaryLogin());
String userId = token.getId();
String userType = token.getProvider().toString();
for (int i = 0; i < requestIds.size(); i++) {
int index = 1;
// set
ps.setString(index++, userId);
ps.setString(index++, userType);
ps.setString(index++, "DENIED");
ps.setTimestamp(index++, timestamp);
// where
ps.setString(index++, requestIds.get(i));
ps.setString(index++, engineId);
ps.addBatch();
}
ps.executeBatch();
if (!ps.getConnection().getAutoCommit()) {
ps.getConnection().commit();
}
// Adding Notification
if (Utility.isNotificationDatabaseEnabled()) {
String engineType = String.valueOf(getEngineType(engineId)).toLowerCase();
for (int i = 0; i < requestIds.size(); i++) {
String requestId = requestIds.get(i);
List<Map<String, Object>> deniedUserDetails = getUserDetailsFromEngineAccessRequest(requestId);
String permission = AccessPermissionEnum
.getPermissionValueById((Integer) deniedUserDetails.get(i).get("permission"));
NotificationDbUtils.createNotification(user, (String) deniedUserDetails.get(i).get("userId"),
(String) deniedUserDetails.get(i).get("type"), engineId,
NotificationConstants.Type.REQUEST_DENIAL, engineType,
NotificationConstants.Priority.MEDIUM, null, permission,
NotificationConstants.DisplaySurface.BELL);
}
}
} catch (Exception e) {
classLogger.error("Failed to deny engine user access requests", e);
throw new IllegalArgumentException(
"An error occurred while updating user access request detailed message = " + e.getMessage());
} finally {
ConnectionUtils.closeAllConnectionsIfPooling(securityDb, ps);
}
}
/**
* Get the request pending engine permission for a specific user
*
* @param singleUserId
* @param engineId
* @return
*/
public static List<Map<String, Object>> getUserAccessRequestsByEngine(String engineId) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
SelectQueryStruct qs = new SelectQueryStruct();
qs.addSelector(new QueryColumnSelector("ENGINEACCESSREQUEST__ID"));
qs.addSelector(new QueryColumnSelector("ENGINEACCESSREQUEST__REQUEST_USERID"));
qs.addSelector(new QueryColumnSelector("ENGINEACCESSREQUEST__REQUEST_TYPE"));
qs.addSelector(new QueryColumnSelector("SMSS_USER__NAME"));
qs.addSelector(new QueryColumnSelector("SMSS_USER__EMAIL"));
qs.addSelector(new QueryColumnSelector("SMSS_USER__USERNAME"));
qs.addSelector(new QueryColumnSelector("ENGINEACCESSREQUEST__REQUEST_TIMESTAMP"));
qs.addSelector(new QueryColumnSelector("ENGINEACCESSREQUEST__ENGINEID"));
qs.addSelector(new QueryColumnSelector("ENGINEACCESSREQUEST__PERMISSION"));
qs.addSelector(new QueryColumnSelector("ENGINEACCESSREQUEST__APPROVER_USERID"));
qs.addSelector(new QueryColumnSelector("ENGINEACCESSREQUEST__APPROVER_TYPE"));
qs.addSelector(new QueryColumnSelector("ENGINEACCESSREQUEST__APPROVER_DECISION"));
qs.addSelector(new QueryColumnSelector("ENGINEACCESSREQUEST__APPROVER_TIMESTAMP"));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINEACCESSREQUEST__ENGINEID", "==", engineId));
qs.addExplicitFilter(
SimpleQueryFilter.makeColToValFilter("ENGINEACCESSREQUEST__APPROVER_DECISION", "==", "NEW_REQUEST"));
qs.addRelation("ENGINEACCESSREQUEST__REQUEST_USERID", "SMSS_USER__ID", "inner.join");
qs.addRelation("ENGINEACCESSREQUEST__REQUEST_TYPE", "SMSS_USER__TYPE", "inner.join");
return QueryExecutionUtility.flushRsToMap(securityDb, qs);
}
/**
* Validate if the given engineId exists in the database.
*
* @param engineId
* @return
*/
public static boolean engineExists(String engineId) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
SelectQueryStruct qs = new SelectQueryStruct();
qs.addSelector(new QueryColumnSelector("ENGINE__ENGINEID"));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINE__ENGINEID", "==", engineId));
try (IRawSelectWrapper wrapper = WrapperManager.getInstance().getRawWrapper(securityDb, qs)) {
if (wrapper.hasNext()) {
return true;
}
} catch (Exception e) {
classLogger.error("Failed to check whether engine exists", e);
}
return false;
}
/**
* See if specific engine is global
*
* @return
*/
public static boolean engineIsGlobal(String engineId) {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
// String query = "SELECT ENGINEID FROM ENGINE WHERE GLOBAL=TRUE and ENGINEID='"
// + databaseId + "'";
// IRawSelectWrapper wrapper =
// WrapperManager.getInstance().getRawWrapper(securityDb, query);
SelectQueryStruct qs = new SelectQueryStruct();
qs.addSelector(new QueryColumnSelector("ENGINE__ENGINEID"));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINE__GLOBAL", "==", true, PixelDataType.BOOLEAN));
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINE__ENGINEID", "==", engineId));
try (IRawSelectWrapper wrapper = WrapperManager.getInstance().getRawWrapper(securityDb, qs)) {
if (wrapper.hasNext()) {
return true;
}
} catch (Exception e) {
classLogger.error("Failed to determine whether engine is global", e);
}
return false;
}
/**
* Determine if the user is the owner of an database
*
* @param userFilters
* @param databaseId
* @return
*/
public static boolean userIsOwner(User user, String databaseId) {
return SecurityUserEngineUtils.userIsOwner(getUserFiltersQs(user), databaseId)
|| SecurityGroupEngineUtils.userGroupIsOwner(user, databaseId);
}
/**
* Determine if the user can modify the engine
*
* @param databaseId
* @param userId
* @return
*/
public static boolean userCanEditEngine(User user, String databaseId) {
return SecurityUserEngineUtils.userCanEditEngine(user, databaseId)
|| SecurityGroupEngineUtils.userGroupCanEditEngine(user, databaseId);
}
/**
* Determine if a user can view a engine
*
* @param user
* @param engineId
* @return
*/
public static boolean userCanViewEngine(User user, String engineId) {
return SecurityUserEngineUtils.userCanViewEngine(user, engineId)
|| SecurityGroupEngineUtils.userGroupCanViewEngine(user, engineId);
}
/**
* Determine if the user can edit the engine
*
* @param userId
* @param engineId
* @return
*/
static int getMaxUserEnginePermission(User user, String engineId) {
return SecurityUserEngineUtils.getMaxUserEnginePermission(user, engineId);
}
///////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////////
/*
* Query for database users
*/
/**
*
* @param databaseId
* @return
*/
public static List<Map<String, Object>> getDisplayDatabaseOwnersAndEditors(String databaseId) {
return SecurityUserEngineUtils.getDisplayEngineOwnersAndEditors(databaseId);
}
/**
* Retrieve the list of users for a given database
*
* @param user
* @param engineId
* @param searchParam
* @param permission
* @param limit
* @param offset
* @return
* @throws IllegalAccessException
*/
public static List<Map<String, Object>> getEngineUsers(User user, String engineId, String searchParam,
String permission, long limit, long offset) throws IllegalAccessException {
if (!userCanViewEngine(user, engineId)) {
throw new IllegalAccessException("The user does not have access to view this engine");
}
return SecurityUserEngineUtils.getEngineUsers(engineId, searchParam, permission, limit, offset);
}
/**
*
* @param user
* @param engineId
* @param userId
* @param permission
* @return
* @throws IllegalAccessException
*/
public static long getEngineUsersCount(User user, String engineId, String searchParam, String permission)
throws IllegalAccessException {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
if (!userCanViewEngine(user, engineId)) {
throw new IllegalAccessException("The user does not have access to view this engine");
}
boolean hasSearchParam = searchParam != null && !(searchParam = searchParam.trim()).isEmpty();
boolean hasPermission = permission != null && !(permission = permission.trim()).isEmpty();
SelectQueryStruct qs = new SelectQueryStruct();
QueryFunctionSelector fSelector = new QueryFunctionSelector();
fSelector.setAlias("count");
fSelector.setFunction(QueryFunctionHelper.COUNT);
fSelector.addInnerSelector(new QueryColumnSelector("SMSS_USER__ID"));
qs.addSelector(fSelector);
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINEPERMISSION__ENGINEID", "==", engineId));
if (hasSearchParam) {
OrQueryFilter or = new OrQueryFilter();
or.addFilter(SimpleQueryFilter.makeColToValFilter("ENGINEPERMISSION__USERID", "?like", searchParam));
or.addFilter(SimpleQueryFilter.makeColToValFilter("SMSS_USER__NAME", "?like", searchParam));
or.addFilter(SimpleQueryFilter.makeColToValFilter("SMSS_USER__USERNAME", "?like", searchParam));
or.addFilter(SimpleQueryFilter.makeColToValFilter("SMSS_USER__EMAIL", "?like", searchParam));
qs.addExplicitFilter(or);
}
if (hasPermission) {
qs.addExplicitFilter(SimpleQueryFilter.makeColToValFilter("ENGINEPERMISSION__PERMISSION", "==",
AccessPermissionEnum.getIdByPermission(permission)));
}
qs.addRelation("SMSS_USER", "ENGINEPERMISSION", "inner.join");
qs.addRelation("ENGINEPERMISSION", "PERMISSION", "inner.join");
return QueryExecutionUtility.flushToLong(securityDb, qs);
}
/**
*
* @param user
* @param newUserId
* @param engineId
* @param permission
* @param endDate
* @param usageRestriction
* @param usageFrequency
* @param maxTokens
* @param maxResponseTime
* @throws IllegalAccessException
*/
public static void addEngineUser(User user, String newUserId, String engineId, String permission, String endDate,
String usageRestriction, String usageFrequency, int maxTokens, double maxResponseTime)
throws IllegalAccessException {
IRDBMSEngine securityDb = SystemEngineRegistry.getSecurityDb();
// make sure user can edit the database
int userPermissionLvl = getMaxUserEnginePermission(user, engineId);
if (!AccessPermissionEnum.isEditor(userPermissionLvl)) {
throw new IllegalAccessException("Insufficient privileges to modify this engine's permissions.");
}
// make sure user doesn't already exist for this database