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
|
/*********************************************************************
* Copyright (c) 2012 Boeing
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Boeing - initial API and implementation
**********************************************************************/
package org.eclipse.osee.orcs.core.internal;
import static org.eclipse.osee.framework.core.enums.CoreBranches.COMMON;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Callable;
import org.eclipse.osee.activity.api.ActivityLog;
import org.eclipse.osee.framework.core.data.ArtifactId;
import org.eclipse.osee.framework.core.data.ArtifactToken;
import org.eclipse.osee.framework.core.data.ArtifactTypeId;
import org.eclipse.osee.framework.core.data.OrcsTypeJoin;
import org.eclipse.osee.framework.core.data.TransactionId;
import org.eclipse.osee.framework.core.data.Tuple2Type;
import org.eclipse.osee.framework.core.data.UserId;
import org.eclipse.osee.framework.core.data.UserToken;
import org.eclipse.osee.framework.core.enums.CoreArtifactTokens;
import org.eclipse.osee.framework.core.enums.CoreArtifactTypes;
import org.eclipse.osee.framework.core.enums.CoreAttributeTypes;
import org.eclipse.osee.framework.core.enums.CoreBranches;
import org.eclipse.osee.framework.core.enums.CoreRelationTypes;
import org.eclipse.osee.framework.core.enums.CoreTupleTypes;
import org.eclipse.osee.framework.core.enums.CoreUserGroups;
import org.eclipse.osee.framework.core.enums.SystemUser;
import org.eclipse.osee.framework.core.exception.OseeAccessDeniedException;
import org.eclipse.osee.framework.jdk.core.result.XConsoleLogger;
import org.eclipse.osee.framework.jdk.core.type.NamedId;
import org.eclipse.osee.framework.jdk.core.type.OseeStateException;
import org.eclipse.osee.jdbc.JdbcClient;
import org.eclipse.osee.jdbc.OseePreparedStatement;
import org.eclipse.osee.logger.Log;
import org.eclipse.osee.orcs.OrcsAdmin;
import org.eclipse.osee.orcs.OrcsApi;
import org.eclipse.osee.orcs.OrcsMetaData;
import org.eclipse.osee.orcs.OrcsSession;
import org.eclipse.osee.orcs.core.ds.DataStoreAdmin;
import org.eclipse.osee.orcs.core.internal.admin.FetchDatastoreMetadataCallable;
import org.eclipse.osee.orcs.core.internal.admin.MigrateDatastoreAdminCallable;
import org.eclipse.osee.orcs.data.ArtifactReadable;
import org.eclipse.osee.orcs.search.QueryBuilder;
import org.eclipse.osee.orcs.transaction.TransactionBuilder;
/**
* @author Roberto E. Escobar
*/
public class OrcsAdminImpl implements OrcsAdmin {
private final OrcsApi orcsApi;
private final Log logger;
private final OrcsSession session;
private final DataStoreAdmin dataStoreAdmin;
private final QueryBuilder fromCommon;
private final JdbcClient jdbcClient;
public OrcsAdminImpl(OrcsApi orcsApi, Log logger, OrcsSession session, DataStoreAdmin dataStoreAdmin) {
this.orcsApi = orcsApi;
this.logger = logger;
this.session = session;
this.dataStoreAdmin = dataStoreAdmin;
fromCommon = orcsApi.getQueryFactory().fromBranch(COMMON);
jdbcClient = dataStoreAdmin.getJdbcClient();
}
@Override
public TransactionId createDatastoreAndSystemBranches() {
ActivityLog activityLog = orcsApi.getActivityLog();
try {
activityLog.setEnabled(false);
dataStoreAdmin.createDataStore();
return new CreateSystemBranches(orcsApi).create();
} finally {
activityLog.setEnabled(true);
}
}
@Override
public void registerMissingOrcsTypeJoins() {
TransactionBuilder tx = orcsApi.getTransactionFactory().createTransaction(COMMON, SystemUser.OseeSystem,
"Add missing orcs type joins.");
addMissingJoins(tx, CoreTupleTypes.ArtifactTypeJoin, orcsApi.tokenService().getArtifactTypeJoins());
addMissingJoins(tx, CoreTupleTypes.AttributeTypeJoin, orcsApi.tokenService().getAttributeTypeJoins());
addMissingJoins(tx, CoreTupleTypes.RelationTypeJoin, orcsApi.tokenService().getRelationTypeJoins());
tx.commit();
}
private <J extends OrcsTypeJoin<J, T>, T extends NamedId> void addMissingJoins(TransactionBuilder tx, Tuple2Type<J, T> tupleType, Collection<J> registeredJoins) {
List<J> joinsInDb = new ArrayList<>();
orcsApi.getQueryFactory().tupleQuery().getTuple2UniqueE1(tupleType, COMMON, joinsInDb::add);
for (J join : registeredJoins) {
if (!joinsInDb.contains(join)) {
tx.addOrcsTypeJoin(join);
}
}
}
@Override
public void createSynonymsAndGrants() {
for (String table : Arrays.asList("OSEE_ACCOUNT_SESSION", "OSEE_ACTIVITY", "OSEE_ACTIVITY_TYPE", "OSEE_ARTIFACT",
"OSEE_ARTIFACT_ACL", "OSEE_ATTRIBUTE", "OSEE_BRANCH", "OSEE_BRANCH_ACL", "OSEE_CONFLICT",
"OSEE_IMPORT_INDEX_MAP", "OSEE_IMPORT_MAP", "OSEE_IMPORT_SAVE_POINT", "OSEE_IMPORT_SOURCE", "OSEE_INFO",
"OSEE_JOIN_ARTIFACT", "OSEE_JOIN_CHAR_ID", "OSEE_JOIN_CLEANUP", "OSEE_JOIN_EXPORT_IMPORT", "OSEE_JOIN_ID",
"OSEE_JOIN_ID4", "OSEE_JOIN_TRANSACTION", "OSEE_KEY_VALUE", "OSEE_MERGE", "OSEE_OAUTH_AUTHORIZATION",
"OSEE_OAUTH_CLIENT_CREDENTIAL", "OSEE_OAUTH_TOKEN", "OSEE_PERMISSION", "OSEE_RELATION_LINK",
"OSEE_SCHEMA_VERSION", "OSEE_SEARCH_TAGS", "OSEE_SEQUENCE", "OSEE_SERVER_LOOKUP", "OSEE_SESSION",
"OSEE_TAG_GAMMA_QUEUE", "OSEE_TUPLE2", "OSEE_TUPLE3", "OSEE_TUPLE4", "OSEE_TXS", "OSEE_TXS_ARCHIVED",
"OSEE_TX_DETAILS")) {
try {
jdbcClient.runCall("create public synonym " + table + " for " + table);
} catch (Exception ex) {
XConsoleLogger.err("Error creating synonym for table " + table);
}
try {
jdbcClient.runCall("grant insert, update, delete, select on " + table + " to osee_client_role");
} catch (Exception ex) {
XConsoleLogger.err("Error granting permissions for table " + table);
}
}
}
@Override
public void createDemoBranches() {
new CreateDemoBranches(orcsApi).populate();
}
@Override
public Callable<OrcsMetaData> migrateDatastore() {
return new MigrateDatastoreAdminCallable(logger, session, dataStoreAdmin);
}
@Override
public Callable<OrcsMetaData> createFetchOrcsMetaData() {
return new FetchDatastoreMetadataCallable(logger, session, dataStoreAdmin);
}
@Override
public boolean isDataStoreInitialized() {
try {
orcsApi.getQueryFactory().fromBranch(COMMON).andIds(CoreArtifactTokens.DefaultHierarchyRoot);
return true;
} catch (Exception ex) {
return false;
}
}
@Override
public void requireRole(UserId user, ArtifactId role) {
if (!fromCommon.andId(role).andRelatedTo(CoreRelationTypes.Users_User, role).exists()) {
throw new OseeAccessDeniedException("User [%s] not in user group [%s]", user, role);
}
}
@Override
public void createUsers(TransactionBuilder tx, Iterable<UserToken> users) {
if (tx.getAuthor().notEqual(SystemUser.OseeSystem)) {
requireRole(tx.getAuthor(), CoreUserGroups.OseeAdmin);
}
// Create UserGroups Header if not already created
ArtifactToken userGroupHeader = orcsApi.getQueryFactory().fromBranch(CoreBranches.COMMON).andId(
CoreArtifactTokens.UserGroups).getArtifactOrNull();
if (userGroupHeader == null) {
ArtifactToken oseeConfig = orcsApi.getQueryFactory().fromBranch(CoreBranches.COMMON).andId(
CoreArtifactTokens.OseeConfiguration).getArtifactOrNull();
userGroupHeader = tx.createArtifact(oseeConfig, CoreArtifactTokens.UserGroups);
}
// Create users and relate to user groups
Map<ArtifactToken, ArtifactToken> userGroupToArtifact = new HashMap<>();
List<ArtifactReadable> defaultGroups =
orcsApi.getQueryFactory().fromBranch(CoreBranches.COMMON).andAttributeIs(CoreAttributeTypes.DefaultGroup,
"true").getResults().getList();
List<ArtifactReadable> existingUsers = orcsApi.getQueryFactory().fromBranch(CoreBranches.COMMON).andTypeEquals(
CoreArtifactTypes.User).getResults().getList();
for (UserToken userToken : users) {
if (existingUsers.contains(userToken)) {
throw new OseeStateException("User %s already exists", userToken);
}
ArtifactId user = tx.createArtifact(userToken);
tx.setSoleAttributeValue(user, CoreAttributeTypes.Active, userToken.isActive());
tx.setSoleAttributeValue(user, CoreAttributeTypes.UserId, userToken.getUserId());
tx.setSoleAttributeValue(user, CoreAttributeTypes.Email, userToken.getEmail());
Collection<ArtifactToken> roles = userToken.getRoles();
for (ArtifactToken userGroup : roles) {
ArtifactToken userGroupArt = getOrCreate(userGroup, userGroupToArtifact, tx, userGroupHeader);
tx.relate(userGroupArt, CoreRelationTypes.Users_User, user);
}
for (ArtifactToken userGroup : defaultGroups) {
ArtifactToken userGroupArt = getOrCreate(userGroup, userGroupToArtifact, tx, userGroupHeader);
tx.relate(userGroupArt, CoreRelationTypes.Users_User, user);
}
setUserInfo(tx, userToken, defaultGroups);
}
}
private ArtifactToken getOrCreate(ArtifactToken userGroup, Map<ArtifactToken, ArtifactToken> userGroupToArtifact, TransactionBuilder tx, ArtifactToken userGroupHeader) {
ArtifactToken userGroupArt = userGroupToArtifact.get(userGroup);
if (userGroupArt == null) {
userGroupArt = orcsApi.getQueryFactory().fromBranch(CoreBranches.COMMON).andId(userGroup).getArtifactOrNull();
}
if (userGroupArt == null) {
userGroupArt = tx.createArtifact(userGroup);
tx.addChild(userGroupHeader, userGroupArt);
}
userGroupToArtifact.put(userGroup, userGroupArt);
return userGroupArt;
}
@Override
public void createUser(TransactionBuilder tx, UserToken userToken) {
if (tx.getAuthor().notEqual(SystemUser.OseeSystem)) {
requireRole(tx.getAuthor(), CoreUserGroups.OseeAdmin);
}
List<ArtifactId> defaultGroups =
orcsApi.getQueryFactory().fromBranch(CoreBranches.COMMON).andAttributeIs(CoreAttributeTypes.DefaultGroup,
"true").asArtifactIds();
setUserInfo(tx, userToken, defaultGroups);
}
private void setUserInfo(TransactionBuilder tx, UserToken userToken, List<? extends ArtifactId> defaultGroups) {
ArtifactId userId = tx.createArtifact(userToken);
tx.setSoleAttributeValue(userId, CoreAttributeTypes.Active, userToken.isActive());
tx.setSoleAttributeValue(userId, CoreAttributeTypes.UserId, userToken.getUserId());
tx.setSoleAttributeValue(userId, CoreAttributeTypes.Email, userToken.getEmail());
for (ArtifactToken userRole : userToken.getRoles()) {
tx.relate(userRole, CoreRelationTypes.Users_User, userId);
}
for (ArtifactId userGroup : defaultGroups) {
tx.relate(userGroup, CoreRelationTypes.Users_User, userId);
}
for (String loginId : userToken.getLoginIds()) {
tx.createAttribute(userToken, CoreAttributeTypes.LoginId, loginId);
}
}
@Override
public void changeArtifactTypeOutsideofHistory(ArtifactTypeId artifactType, List<? extends ArtifactId> artifacts) {
String sql = "UPDATE osee_artifact SET art_type_id = ? WHERE art_id = ?";
OseePreparedStatement batchStatement = jdbcClient.getBatchStatement(sql);
artifacts.forEach(art -> batchStatement.addToBatch(artifactType, art));
batchStatement.execute();
}
@Override
public void updateBootstrapUser(UserId accountId) {
dataStoreAdmin.updateBootstrapUser(accountId);
}
@Override
public long purgeUnusedBinaryAttributes() {
return dataStoreAdmin.purgeUnusedBinaryAttributes();
}
}
|
