();
// remove all roles and then add back those that were checked
for (int i = 0; i < participants.size(); i++) {
@@ -7806,6 +7841,9 @@
}
realmEdit.addMember(id, roleId, activeGrant,
fromProvider);
+ String currentUserId = (String) state.getAttribute(STATE_CM_CURRENT_USERID);
+ String[] userAuditString = {s.getId(),participant.getEid(),roleId,userAuditService.USER_AUDIT_ACTION_UPDATE,userAuditRegistration.getDatabaseSourceKey(),currentUserId};
+ userAuditList.add(userAuditString);
// construct the event string
String userUpdatedString = "uid=" + id;
@@ -7864,6 +7902,9 @@
}
realmEdit.removeMember(userId);
usersDeleted.add("uid=" + userId);
+ String currentUserId = (String) state.getAttribute(STATE_CM_CURRENT_USERID);
+ String[] userAuditString = {s.getId(),user.getEid(),role.getId(),userAuditService.USER_AUDIT_ACTION_REMOVE,userAuditRegistration.getDatabaseSourceKey(),currentUserId};
+ userAuditList.add(userAuditString);
}
}
}
@@ -7896,6 +7937,13 @@
}
}
AuthzGroupService.save(realmEdit);
+
+ // do the audit logging - Doing this in one bulk call to the database will cause the actual audit stamp to be off by maybe 1 second at the most
+ // but seems to be a better solution than call this multiple time for every update
+ if (!userAuditList.isEmpty())
+ {
+ userAuditRegistration.addToUserAuditing(userAuditList);
+ }
// then update all related group realms for the role
doUpdate_related_group_participants(s, realmId);
Index: userauditservice/api/pom.xml
===================================================================
--- userauditservice/api/pom.xml (revision 0)
+++ userauditservice/api/pom.xml (working copy)
@@ -0,0 +1,43 @@
+
+ 4.0.0
+
+
+ org.sakaiproject.userauditservice
+ userauditservice
+ 2.10-SNAPSHOT
+
+
+ Sakai Userauditservice API (userauditservice-api)
+ org.sakaiproject.userauditservice
+ userauditservice-api
+
+ Sakai Project
+ http://sakaiproject.org/
+
+ 2013
+ Userauditservice interfaces (API)
+ jar
+
+
+ shared
+
+
+
+
+ org.simpleframework
+ simple-xml
+
+
+
+
+
+
+ ${basedir}/src/java
+
+ **/*.xml
+
+ false
+
+
+
+
Index: userauditservice/api/src/java/org/sakaiproject/userauditservice/api/UserAuditRegistration.java
===================================================================
--- userauditservice/api/src/java/org/sakaiproject/userauditservice/api/UserAuditRegistration.java (revision 0)
+++ userauditservice/api/src/java/org/sakaiproject/userauditservice/api/UserAuditRegistration.java (working copy)
@@ -0,0 +1,57 @@
+/**********************************************************************************
+ * $URL$
+ * $Id$
+ ***********************************************************************************
+ *
+ * Copyright (c) 2013 The Sakai Foundation
+ *
+ * Licensed under the Educational Community 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.opensource.org/licenses/ECL-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.
+ *
+ **********************************************************************************/
+
+package org.sakaiproject.userauditservice.api;
+
+import java.util.List;
+
+/**
+ *
+ * UserAuditRegistrationService controls calls relating to tracking user auditing.
+ *
+ */
+public interface UserAuditRegistration
+{
+ /** One character key a tool will use to show where the change came from */
+ public String getDatabaseSourceKey();
+
+ /** The text to register that will be associated with the databaseSourceKey */
+ public String getSourceText(String[] parameter);
+
+ /**
+ * Processes a list of String[] to add records into the database about
+ * @param userAuditList List of String[] to process
+ */
+ public void addToUserAuditing(List userAuditList);
+
+ /**
+ * Method to delete all the user auditing log entries for a site. Used when deleting a site
+ * @param siteId String site id to delete user auditing logs
+ */
+ public void deleteUserAuditingFromSite(String siteId);
+
+ /**
+ * This method will allow registering tools to supply their own location for resource loaders
+ * @param location
+ * @return
+ */
+ public Object getResourceLoader(String location);
+}
Index: userauditservice/api/src/java/org/sakaiproject/userauditservice/api/UserAuditService.java
===================================================================
--- userauditservice/api/src/java/org/sakaiproject/userauditservice/api/UserAuditService.java (revision 0)
+++ userauditservice/api/src/java/org/sakaiproject/userauditservice/api/UserAuditService.java (working copy)
@@ -0,0 +1,58 @@
+/**********************************************************************************
+ * $URL$
+ * $Id$
+ ***********************************************************************************
+ *
+ * Copyright (c) 2013 The Sakai Foundation
+ *
+ * Licensed under the Educational Community 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.opensource.org/licenses/ECL-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.
+ *
+ **********************************************************************************/
+
+package org.sakaiproject.userauditservice.api;
+
+import java.util.List;
+
+/**
+ * Service interface that allows tools to register their own database key and associated text for User Auditing
+ *
+ */
+public interface UserAuditService {
+
+ /** Database action value for logging a user was added to a site */
+ static final String USER_AUDIT_ACTION_ADD = "A";
+
+ /** Database action value for logging a user was removed from a site */
+ static final String USER_AUDIT_ACTION_REMOVE = "D";
+
+ /** Database action value for logging a user was updated in a site, typically in a different role */
+ static final String USER_AUDIT_ACTION_UPDATE = "U";
+
+ /**
+ * Method to register a UserAuditRegistration object
+ * @param ua
+ */
+ public void register(UserAuditRegistration uar);
+
+ /**
+ * Gets all UserAuditRegistration objects that have been registered
+ * @return
+ */
+ public List getRegisteredItems();
+
+ /**
+ * Get the keys for all UserAuditRegistration objects that have been registered
+ * @return
+ */
+ public List getKeys();
+}
Index: userauditservice/deploy/pom.xml
===================================================================
--- userauditservice/deploy/pom.xml (revision 0)
+++ userauditservice/deploy/pom.xml (working copy)
@@ -0,0 +1,38 @@
+
+ 4.0.0
+
+
+ org.sakaiproject.userauditservice
+ userauditservice
+ 2.10-SNAPSHOT
+
+
+ Sakai Userauditservice Deploy POM
+ org.sakaiproject.userauditservice
+ userauditservice-deploy
+ 2.10-SNAPSHOT
+ pom
+
+ Userauditservice deploy POM.
+
+
+ Sakai Project
+ http://sakaiproject.org/
+
+ 2013
+
+
+ shared
+
+
+
+
+
+ org.simpleframework
+ simple-xml
+ ${sakai.simple-xml.version}
+ compile
+
+
+
+
Index: userauditservice/deploy/shared/pom.xml
===================================================================
--- userauditservice/deploy/shared/pom.xml (revision 0)
+++ userauditservice/deploy/shared/pom.xml (working copy)
@@ -0,0 +1,34 @@
+
+
+ 4.0.0
+
+
+ org.sakaiproject.userauditservice
+ userauditservice-deploy
+ 2.10-SNAPSHOT
+
+
+ Sakai userauditservice Shared Deploy
+ org.sakaiproject.userauditservice
+ userauditservice-shared
+ pom
+
+ userauditservice shared deploy POM.
+
+
+ Sakai Project
+ http://sakaiproject.org/
+
+ 2013
+
+
+ shared
+
+
+
+
+ org.simpleframework
+ simple-xml
+
+
+
\ No newline at end of file
Index: userauditservice/impl/pom.xml
===================================================================
--- userauditservice/impl/pom.xml (revision 0)
+++ userauditservice/impl/pom.xml (working copy)
@@ -0,0 +1,54 @@
+
+ 4.0.0
+
+
+ org.sakaiproject.userauditservice
+ userauditservice
+ 2.10-SNAPSHOT
+ ../pom.xml
+
+
+ Sakai Userauditservice Implementation (userauditservice-impl)
+ org.sakaiproject.userauditservice
+ userauditservice-impl
+
+ Sakai Project
+ http://sakaiproject.org/
+
+ 2013
+ Userauditservice implementation
+ jar
+
+
+
+
+
+
+
+ ${project.groupId}
+ userauditservice-api
+
+
+ org.sakaiproject.kernel
+ sakai-kernel-api
+
+
+
+
+
+
+ ${basedir}/src/java
+
+ **/*.xml
+
+ false
+
+
+ ${basedir}/src/sql
+
+ **/*.sql
+
+
+
+
+
Index: userauditservice/impl/src/java/org/sakaiproject/userauditservice/impl/UserAuditServiceImpl.java
===================================================================
--- userauditservice/impl/src/java/org/sakaiproject/userauditservice/impl/UserAuditServiceImpl.java (revision 0)
+++ userauditservice/impl/src/java/org/sakaiproject/userauditservice/impl/UserAuditServiceImpl.java (working copy)
@@ -0,0 +1,110 @@
+/**********************************************************************************
+ * $URL$
+ * $Id$
+ ***********************************************************************************
+ *
+ * Copyright (c) 2013 The Sakai Foundation
+ *
+ * Licensed under the Educational Community 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.opensource.org/licenses/ECL-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.
+ *
+ **********************************************************************************/
+
+package org.sakaiproject.userauditservice.impl;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.sakaiproject.db.api.SqlService;
+import org.sakaiproject.userauditservice.api.UserAuditRegistration;
+import org.sakaiproject.userauditservice.api.UserAuditService;
+
+public class UserAuditServiceImpl implements UserAuditService {
+
+ private List registeredItems = new ArrayList();
+ private List keys = new ArrayList();
+
+ /**
+ * {@inheritDoc}
+ */
+ public void register(UserAuditRegistration uar) {
+ getRegisteredItems().add(uar);
+ getKeys().add(uar.getDatabaseSourceKey());
+ }
+
+ /**
+ * Setter
+ * @param registeredItems
+ */
+ public void setRegisteredItems(List registeredItems) {
+ this.registeredItems = registeredItems;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public List getRegisteredItems() {
+ return registeredItems;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public List getKeys() {
+ return keys;
+ }
+
+ /**
+ * Setter
+ * @param keys
+ */
+ public void setKeys(List keys) {
+ this.keys = keys;
+ }
+
+ /** Dependency: SqlService */
+ protected SqlService m_sqlService = null;
+
+ /**
+ * Dependency: SqlService.
+ *
+ * @param service
+ * The SqlService.
+ */
+ public void setSqlService(SqlService service)
+ {
+ m_sqlService = service;
+ }
+
+ /** Configuration: to run the ddl on init or not. */
+ protected boolean m_autoDdl = false;
+
+ /**
+ * Configuration: to run the ddl on init or not.
+ *
+ * @param value
+ * the auto ddl value.
+ */
+ public void setAutoDdl(String value)
+ {
+ m_autoDdl = Boolean.valueOf(value).booleanValue();
+ }
+
+ public void init() {
+ // if we are auto-creating our schema, check and create
+ if (m_autoDdl)
+ {
+ m_sqlService.ddl(this.getClass().getClassLoader(), "user_audits");
+ }
+ }
+
+}
Index: userauditservice/impl/src/sql/hsqldb/user_audits.sql
===================================================================
--- userauditservice/impl/src/sql/hsqldb/user_audits.sql (revision 0)
+++ userauditservice/impl/src/sql/hsqldb/user_audits.sql (working copy)
@@ -0,0 +1,12 @@
+-- SAK-23634 - new table to track user add/drop/update actions done in sites
+create table USER_AUDITS_LOG (
+ ID bigint generated by default as identity (start with 1),
+ SITE_ID varchar(255) not null,
+ USER_ID varchar(255) not null,
+ ROLE_NAME varchar(255) not null,
+ ACTION_TAKEN varchar(1) not null,
+ AUDIT_STAMP timestamp not null,
+ SOURCE varchar(1),
+ ACTION_USER_ID varchar(255),
+ PRIMARY KEY(ID)
+);
\ No newline at end of file
Index: userauditservice/impl/src/sql/mysql/user_audits.sql
===================================================================
--- userauditservice/impl/src/sql/mysql/user_audits.sql (revision 0)
+++ userauditservice/impl/src/sql/mysql/user_audits.sql (working copy)
@@ -0,0 +1,12 @@
+-- SAK-23634 - new table to track user add/drop/update actions done in sites
+create table USER_AUDITS_LOG (
+ ID bigint AUTO_INCREMENT NOT NULL,
+ SITE_ID varchar(255) not null,
+ USER_ID varchar(255) not null,
+ ROLE_NAME varchar(255) not null,
+ ACTION_TAKEN varchar(1) not null,
+ AUDIT_STAMP timestamp not null,
+ SOURCE varchar(1),
+ ACTION_USER_ID varchar(255),
+ PRIMARY KEY(ID)
+);
\ No newline at end of file
Index: userauditservice/impl/src/sql/oracle/user_audits.sql
===================================================================
--- userauditservice/impl/src/sql/oracle/user_audits.sql (revision 0)
+++ userauditservice/impl/src/sql/oracle/user_audits.sql (working copy)
@@ -0,0 +1,14 @@
+-- SAK-23634 - new table to track user add/drop/update actions done in sites
+create table USER_AUDITS_LOG (
+ ID number(19,0) not null,
+ SITE_ID varchar2(255) not null,
+ USER_ID varchar2(255) not null,
+ ROLE_NAME varchar2(255) not null,
+ ACTION_TAKEN varchar2(1) not null,
+ AUDIT_STAMP timestamp not null,
+ SOURCE varchar2(1),
+ ACTION_USER_ID varchar2(255),
+ PRIMARY KEY(ID)
+);
+
+CREATE SEQUENCE USER_AUDITS_LOG_SEQ;
\ No newline at end of file
Index: userauditservice/pack/pom.xml
===================================================================
--- userauditservice/pack/pom.xml (revision 0)
+++ userauditservice/pack/pom.xml (working copy)
@@ -0,0 +1,41 @@
+
+ 4.0.0
+
+
+ org.sakaiproject.userauditservice
+ userauditservice
+ 2.10-SNAPSHOT
+
+
+ Sakai Userauditservice Components Package (userauditservice-pack)
+ org.sakaiproject.userauditservice
+ userauditservice-pack
+
+ Sakai Project
+ http://sakaiproject.org/
+
+ 2013
+
+ Userauditservice components pack (special Sakai convention).
+
+ sakai-component
+
+
+ components
+
+
+
+
+ ${project.groupId}
+ userauditservice-impl
+ runtime
+
+
+ ${project.groupId}
+ userauditservice-util
+ runtime
+
+
+
+
+
\ No newline at end of file
Index: userauditservice/pack/src/webapp/WEB-INF/components.xml
===================================================================
--- userauditservice/pack/src/webapp/WEB-INF/components.xml (revision 0)
+++ userauditservice/pack/src/webapp/WEB-INF/components.xml (working copy)
@@ -0,0 +1,18 @@
+
+
+
+
+
+