Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: d81ce78bbb400ce7b0f1693cfdfa90db151872b6 (plain) (blame)
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
/*********************************************************************
 * Copyright (c) 2004, 2007 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.ats.core.review;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.eclipse.osee.ats.api.AtsApi;
import org.eclipse.osee.ats.api.IAtsWorkItem;
import org.eclipse.osee.ats.api.data.AtsAttributeTypes;
import org.eclipse.osee.ats.api.notify.AtsNotificationEventFactory;
import org.eclipse.osee.ats.api.notify.AtsNotifyType;
import org.eclipse.osee.ats.api.review.IAtsPeerReviewRoleManager;
import org.eclipse.osee.ats.api.review.IAtsPeerToPeerReview;
import org.eclipse.osee.ats.api.review.Role;
import org.eclipse.osee.ats.api.review.UserRole;
import org.eclipse.osee.ats.api.user.AtsUser;
import org.eclipse.osee.ats.api.user.IAtsUserService;
import org.eclipse.osee.ats.api.util.IAtsChangeSet;
import org.eclipse.osee.ats.api.workdef.IAttributeResolver;
import org.eclipse.osee.framework.core.data.IAttribute;
import org.eclipse.osee.framework.jdk.core.type.OseeCoreException;
import org.eclipse.osee.framework.jdk.core.util.AXml;

/**
 * @author Donald G. Dunne
 */
public class UserRoleManager implements IAtsPeerReviewRoleManager {

   protected final static String ROLE_ITEM_TAG = "Role";
   private final Matcher roleMatcher =
      java.util.regex.Pattern.compile("<" + ROLE_ITEM_TAG + ">(.*?)</" + ROLE_ITEM_TAG + ">",
         Pattern.DOTALL | Pattern.MULTILINE).matcher("");
   private List<UserRole> roles;
   protected final IAtsUserService userService;
   protected final IAttributeResolver attrResolver;
   protected final IAtsPeerToPeerReview peerRev;
   protected final AtsApi atsApi;

   public UserRoleManager(IAtsPeerToPeerReview peerRev, AtsApi atsApi) {
      this.atsApi = atsApi;
      this.attrResolver = atsApi.getAttributeResolver();
      this.userService = atsApi.getUserService();
      this.peerRev = peerRev;
   }

   public void ensureLoaded() {
      if (roles == null) {
         roles = new ArrayList<>();
         if (attrResolver != null) {
            for (String xml : attrResolver.getAttributesToStringList(peerRev, AtsAttributeTypes.Role)) {
               roleMatcher.reset(xml);
               while (roleMatcher.find()) {
                  UserRole item = new UserRole(roleMatcher.group());
                  roles.add(item);
               }
            }
         }
      }
   }

   @Override
   public List<UserRole> getUserRoles() {
      ensureLoaded();
      return roles;
   }

   @Override
   public List<UserRole> getUserRoles(Role role) {
      List<UserRole> roles = new ArrayList<>();
      for (UserRole uRole : getUserRoles()) {
         if (uRole.getRole() == role) {
            roles.add(uRole);
         }
      }
      return roles;
   }

   @Override
   public List<AtsUser> getRoleUsers(Role role) {
      List<AtsUser> users = new ArrayList<>();
      for (UserRole uRole : getUserRoles()) {
         if (uRole.getRole() == role && !users.contains(userService.getUserByUserId(uRole.getUserId()))) {
            users.add(userService.getUserByUserId(uRole.getUserId()));
         }
      }
      return users;
   }

   @Override
   public List<AtsUser> getRoleUsers(Collection<UserRole> roles) {
      List<AtsUser> users = new ArrayList<>();
      for (UserRole uRole : roles) {
         if (!users.contains(userService.getUserByUserId(uRole.getUserId()))) {
            users.add(userService.getUserByUserId(uRole.getUserId()));
         }
      }
      return users;
   }

   @Override
   public void addOrUpdateUserRole(UserRole userRole) {
      List<UserRole> roleItems = getUserRoles();
      boolean found = false;
      for (UserRole uRole : roleItems) {
         if (userRole.equals(uRole)) {
            uRole.update(userRole);
            found = true;
         }
      }
      if (!found) {
         roleItems.add(userRole);
         if (!peerRev.getAssignees().contains(getUser(userRole, atsApi))) {
            peerRev.getStateMgr().addAssignee(getUser(userRole, atsApi));
         }
      }
   }

   @Override
   public void removeUserRole(UserRole userRole) {
      List<UserRole> roleItems = getUserRoles();
      roleItems.remove(userRole);
   }

   private List<UserRole> getStoredUserRoles() {
      // Add new ones: items in userRoles that are not in dbuserRoles
      List<UserRole> storedUserRoles = new ArrayList<>();
      for (IAttribute<Object> attr : atsApi.getAttributeResolver().getAttributes(peerRev, AtsAttributeTypes.Role)) {
         UserRole storedRole = new UserRole((String) attr.getValue());
         storedUserRoles.add(storedRole);
      }
      return storedUserRoles;
   }

   @Override
   public void saveToArtifact(IAtsChangeSet changes) {
      try {
         List<UserRole> storedUserRoles = getStoredUserRoles();

         // Change existing ones
         for (IAttribute<Object> attr : atsApi.getAttributeResolver().getAttributes(peerRev, AtsAttributeTypes.Role)) {
            UserRole storedRole = new UserRole((String) attr.getValue());
            for (UserRole pItem : getUserRoles()) {
               if (pItem.equals(storedRole)) {
                  changes.setAttribute(peerRev, attr, AXml.addTagData(ROLE_ITEM_TAG, pItem.toXml()));
               }
            }
         }
         List<UserRole> userRoles = getUserRoles();
         List<UserRole> updatedStoredUserRoles = getStoredUserRoles();
         // Remove deleted ones; items in dbuserRoles that are not in userRoles
         for (UserRole delUserRole : org.eclipse.osee.framework.jdk.core.util.Collections.setComplement(
            updatedStoredUserRoles, userRoles)) {
            for (IAttribute<Object> attr : atsApi.getAttributeResolver().getAttributes(peerRev,
               AtsAttributeTypes.Role)) {
               UserRole storedRole = new UserRole((String) attr.getValue());
               if (storedRole.equals(delUserRole)) {
                  changes.deleteAttribute(peerRev, attr);
               }
            }
         }
         for (UserRole newRole : org.eclipse.osee.framework.jdk.core.util.Collections.setComplement(userRoles,
            updatedStoredUserRoles)) {
            changes.addAttribute(peerRev, AtsAttributeTypes.Role, AXml.addTagData(ROLE_ITEM_TAG, newRole.toXml()));
         }
         rollupHoursSpentToReviewState(peerRev);
         validateUserRolesCompleted(storedUserRoles, userRoles, changes);
      } catch (OseeCoreException ex) {
         atsApi.getLogger().error(ex, "Can't create ats review role document");
      }
   }

   private void rollupHoursSpentToReviewState(IAtsPeerToPeerReview peerRev) {
      double hoursSpent = 0.0;
      for (UserRole role : getUserRoles()) {
         hoursSpent += role.getHoursSpent() == null ? 0 : role.getHoursSpent();
      }
      peerRev.getStateMgr().setMetrics(peerRev.getStateDefinition(), hoursSpent,
         peerRev.getStateMgr().getPercentComplete(peerRev.getStateMgr().getCurrentStateName()), true,
         atsApi.getUserService().getCurrentUser(), new Date());
   }

   private void validateUserRolesCompleted(List<UserRole> currentUserRoles, List<UserRole> newUserRoles, IAtsChangeSet changes) {
      //all reviewers are complete; send notification to author/moderator
      int numCurrentCompleted = 0, numNewCompleted = 0;
      for (UserRole role : newUserRoles) {
         if (role.getRole() == Role.Reviewer) {
            if (!role.isCompleted()) {
               return;
            } else {
               numNewCompleted++;
            }
         }
      }
      for (UserRole role : currentUserRoles) {
         if (role.getRole() == Role.Reviewer) {
            if (role.isCompleted()) {
               numCurrentCompleted++;
            }
         }
      }
      if (numNewCompleted != numCurrentCompleted) {
         try {
            changes.addWorkItemNotificationEvent(
               AtsNotificationEventFactory.getWorkItemNotificationEvent(atsApi.getUserService().getCurrentUser(),
                  (IAtsWorkItem) peerRev, AtsNotifyType.Peer_Reviewers_Completed));
         } catch (OseeCoreException ex) {
            atsApi.getLogger().error(ex, "Error adding ATS Notification Event");
         }
      }
   }

   public static AtsUser getUser(UserRole item, AtsApi atsApi) {
      return atsApi.getUserService().getUserByUserId(item.getUserId());
   }

}

Back to the top