Changeset 5077

Timestamp:

Aug 26, 2009, 2:03:37 PM (13 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #1182: Groups with hidden members

Location:

trunk

Files:

• src/core/common-queries.xml (modified) (1 diff)
• src/core/net/sf/basedb/core/Group.java (modified) (1 diff)
• src/core/net/sf/basedb/core/Install.java (modified) (5 diffs)
• src/core/net/sf/basedb/core/Keyring.java (modified) (7 diffs)
• src/core/net/sf/basedb/core/SessionControl.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/Update.java (modified) (4 diffs)
• src/core/net/sf/basedb/core/data/GroupData.java (modified) (1 diff)
• src/test/TestGroup.java (modified) (3 diffs)
• www/admin/groups/edit_group.jsp (modified) (4 diffs)
• www/admin/groups/index.jsp (modified) (1 diff)
• www/admin/groups/list_groups.jsp (modified) (2 diffs)
• www/admin/groups/view_group.jsp (modified) (1 diff)

trunk/src/core/common-queries.xml

@@ -3609 +3609 @@
     </description>
   </query>
+  <query id="SET_HIDDENMEMBERS_ON_GROUPS" type="HQL">
+    <sql>
+      UPDATE GroupData grp
+      SET grp.hiddenMembers = :hiddenMembers
+      WHERE grp.hiddenMembers IS NULL
+    </sql>
+    <description>
+      An HQL query that sets the hiddenMembers flag on all
+      groups with a null value.
+    </description>
+  </query>
+  <query id="GET_GROUPS_WITH_NONHIDDENMEMBERS" type="HQL">
+    <sql>
+      SELECT grp.id 
+      FROM GroupData grp
+      WHERE grp.hiddenMembers = false
+      AND grp.id IN (:groups)
+    </sql>
+    <description>
+      A HQL query that selects the ID of the groups among a given set of
+      groups that has 'hiddenMembers=false'
+    </description>
+  </query>
 
 </predefined-queries>

trunk/src/core/net/sf/basedb/core/Group.java

@@ -396 +396 @@
     }
     getData().setDefault(isDefault);
+  }
+  
+  /**
+    Does this group have hidden members? In a group with hidden members
+    one user doesn't get read permission to other members of the same
+    group.
+    @return TRUE if the members are hidden
+    @since 2.13
+  */
+  public boolean hasHiddenMembers()
+  {
+    return getData().getHiddenMembers();
+  }
+  
+  /**
+    Set the hidden members flag for this group.
+    @throws PermissionDeniedException If the logged in user doesn't
+      have {@link Permission#WRITE} permission for the group, or if
+      this group is the {@link #EVERYONE} group
+    @since 2.13
+  */
+  public void setHiddenMembers(boolean hiddenMembers)
+  {
+    checkPermission(Permission.WRITE);
+    if (getId() == SystemItems.getId(EVERYONE))
+    {
+      throw new PermissionDeniedException("Not allowed to add members to the EVERYONE group.");
+    }
+    getData().setHiddenMembers(hiddenMembers);
   }
   

trunk/src/core/net/sf/basedb/core/Install.java

@@ -114 +114 @@
     method.
   */
-  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(74).intValue();
+  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(75).intValue();
   
   public static synchronized void createTables(boolean update, final ProgressReporter progress)
@@ -229 +229 @@
   
       if (progress != null) progress.display((int)(5*progress_factor), "--Creating groups...");
-      GroupData groupEveryone = createGroup(Group.EVERYONE, "Everyone", false, "Everyone are members of this group.");
+      GroupData groupEveryone = createGroup(Group.EVERYONE, "Everyone", false, true, "Everyone are members of this group.");
   
       if (progress != null) progress.display((int)(6*progress_factor), "--Creating keys...");
@@ -1189 +1189 @@
     Create a {@link Group}.
   */
-  private static GroupData createGroup(String systemId, String name, boolean isDefault, String description)
+  private static GroupData createGroup(String systemId, String name, boolean isDefault, 
+    boolean hiddenMembers, String description)
     throws BaseException
   {
@@ -1215 +1216 @@
           // Set default property if upgrading
           group.setDefault(isDefault);
+        }
+        if (schemaVersion.getSchemaVersion() < 75)
+        {
+          // Set default property if upgrading
+          group.setHiddenMembers(hiddenMembers);
         }
         log.info("createGroup: EXISTS [SYSTEM ID="+systemId+"; name="+name+"]");
@@ -1227 +1233 @@
         group.setDescription(description);
         group.setDefault(isDefault);
+        group.setHiddenMembers(hiddenMembers);
         HibernateUtil.saveData(session, group);
         HibernateUtil.commit(tx);

trunk/src/core/net/sf/basedb/core/Keyring.java

@@ -114 +114 @@
   */
   private Set<Integer> groups;
+  
+  /**
+    A subset of the 'groups' set that holds the id of the groups
+    that has hiddenMembers = false
+  */
+  private Set<Integer> groupsWithNonHiddenMembers;
 
   /**
@@ -227 +233 @@
     this.projectPermissions = parent.projectPermissions;
     this.groups = parent.groups;
+    this.groupsWithNonHiddenMembers = parent.groupsWithNonHiddenMembers;
     this.users = parent.users;
     this.projects = parent.projects;
@@ -332 +339 @@
   /**
     Loads group membership for the user and put that information
-    in the {@link #groups} variable.
+    in the {@link #groups} and {@link #groupsWithNonHiddenMembers} variables.
   */
   private void loadGroups(org.hibernate.Session session)
@@ -379 +386 @@
       temp.add(EVERYONE);
       groups = Collections.unmodifiableSet(temp);
+      
+      // Load the subset of groups that has hiddenMembers = false
+      query = HibernateUtil.getPredefinedQuery(session, "GET_GROUPS_WITH_NONHIDDENMEMBERS");
+      /*
+        SELECT grp.id 
+        FROM GroupData grp
+        WHERE grp.hiddenMembers = false
+        AND grp.id IN (:groups)
+      */
+      query.setParameterList("groups", groups, org.hibernate.Hibernate.INTEGER);
+      temp = new HashSet<Integer>(HibernateUtil.loadList(Integer.class, query, null));
+      groupsWithNonHiddenMembers = Collections.unmodifiableSet(temp);
     }
     catch (HibernateException ex)
@@ -459 +478 @@
     try
     {
-      if (groups.size() > 0)
+      if (groupsWithNonHiddenMembers.size() > 0)
       {
         // Get the users which are members of the same groups
-        org.hibernate.Query query = HibernateUtil.getPredefinedQuery(session, "GET_USER_IDS_FOR_GROUPS");
-        /*
-          SELECT ug.userId
-          FROM UserGroups ug
-          WHERE ug.groupId IN (:groups)
-        */
-        query.setParameterList("groups", groups, org.hibernate.Hibernate.INTEGER);
-        temp.addAll(HibernateUtil.loadList(Integer.class, query, null));
-        
-        // Get the users that have a quota group among the same groups
-        query = HibernateUtil.getPredefinedQuery(session, "GET_USER_IDS_FOR_QUOTAGROUPS");
-        /*
-          SELECT usr.id
-          FROM UserData usr
-          WHERE usr.quotaGroup.id IN (:groups)
-        */
-        query.setParameterList("groups", groups, org.hibernate.Hibernate.INTEGER);
-        temp.addAll(HibernateUtil.loadList(Integer.class, query, null));
+        temp.addAll(User.getAllMembers(session, groupsWithNonHiddenMembers));
       }
       
@@ -508 +510 @@
         // Load the direct groups and subgroups
         Set<Integer> projectGroups = Group.getGroupsRecursive(session, HibernateUtil.loadList(Integer.class, query, null));
-
+        
+        // Finally, filter away groups that has hiddenMembers=true
+        query = HibernateUtil.getPredefinedQuery(session, "GET_GROUPS_WITH_NONHIDDENMEMBERS");
+        /*
+          SELECT grp.id 
+          FROM GroupData grp
+          WHERE grp.hiddenMembers = false
+          AND grp.id IN (:groups)
+        */
+        query.setParameterList("groups", projectGroups, org.hibernate.Hibernate.INTEGER);
+        projectGroups.retainAll(HibernateUtil.loadList(Integer.class, query, null));
+        
         // Load users that are members of the project groups
-        temp.addAll(User.getAllMembers(session, projectGroups));
-        
+        temp.addAll(User.getAllMembers(session, projectGroups));  
       }
       users = Collections.unmodifiableSet(temp);
@@ -894 +906 @@
   }
   
-  Set<Integer> getGroups()
+  Set<Integer> getGroups(boolean onlyWithNonHiddenMembers)
   {
     if (getReload()) reload();
-    return groups;
-  }
-  
+    return onlyWithNonHiddenMembers ? groupsWithNonHiddenMembers : groups;
+  }
+  
+  /**
+    Get all users that share group membership with the logged in user.
+    Only groups membership in groups that has hiddenMembers=false are 
+    considered.
+  */
   Set<Integer> getUsers()
   {

trunk/src/core/net/sf/basedb/core/SessionControl.java

@@ -1058 +1058 @@
   public boolean isMemberOf(Group group)
   {
-    return loginInfo == null ? false : loginInfo.keyring.getGroups().contains(group.getId());
+    return loginInfo == null ? false : loginInfo.keyring.getGroups(false).contains(group.getId());
   }
   
@@ -1113 +1113 @@
   public Set<Integer> getGroups()
   {
-    return loginInfo == null ? null : loginInfo.keyring.getGroups();
+    return loginInfo == null ? null : loginInfo.keyring.getGroups(false);
   }
 

trunk/src/core/net/sf/basedb/core/Update.java

@@ -43 +43 @@
 import net.sf.basedb.core.data.FileData;
 import net.sf.basedb.core.data.FormulaData;
+import net.sf.basedb.core.data.GroupData;
 import net.sf.basedb.core.data.JobData;
 import net.sf.basedb.core.data.MeasuredBioMaterialData;
@@ -831 +832 @@
     </td>
   </tr>
+  <tr>
+    <td>75</td>
+    <td>
+      Added {@link GroupData#getHiddenMembers()}.
+      The update sets the value for all existing groups to false.
+    </td>
+  </tr>
   </table>
 
@@ -1113 +1121 @@
       }
       
-      // Schemaversion 61-74 only updates the version number
-      if (schemaVersion < 74)
-      {
-        if (progress != null) progress.display((int)(73*progress_factor), "--Updating schema version: " + schemaVersion + " -> 74...");
-        schemaVersion = setSchemaVersionInTransaction(session, 74);
+      // Schemaversion 61-75 only updates the version number
+      if (schemaVersion < 75)
+      {
+        if (progress != null) progress.display((int)(74*progress_factor), "--Updating schema version: " + schemaVersion + " -> 75...");
+        schemaVersion = setSchemaVersionInTransaction(session, 75);
       }
       
@@ -3037 +3045 @@
         }
         
+        if (schemaVersion < 75)
+        {
+          // Set hiddenMembers=false on all groups
+          org.hibernate.Query query = HibernateUtil.getPredefinedQuery(session, 
+            "SET_HIDDENMEMBERS_ON_GROUPS");
+          /*
+            UPDATE GroupData grp
+            SET grp.hiddenMembers = :hiddenMembers
+            WHERE grp.hiddenMembers IS NULL
+          */
+          query.setBoolean("hiddenMembers", false);
+          HibernateUtil.executeUpdate(query);
+        }
+        
         //  Commit the changes
         HibernateUtil.commit(tx);

trunk/src/core/net/sf/basedb/core/data/GroupData.java

@@ -228 +228 @@
   }
   
+  private boolean hiddenMembers;
+  /**
+    A flag indicating if members of the group should be hidden
+    to each other or not.
+    @since 2.13
+    @hibernate.property column="`hidden_members`" type="boolean" not-null="true"
+  */
+  public boolean getHiddenMembers()
+  {
+    return hiddenMembers;
+  }
+  public void setHiddenMembers(boolean hiddenMembers)
+  {
+    this.hiddenMembers = hiddenMembers;
+  }
+  
+  
 }

trunk/src/test/TestGroup.java

@@ -93 +93 @@
         g.setName("Test group");
         g.setDescription("Added at "+new Date());
+        g.setHiddenMembers(true);
       }
       dc.saveItem(g);
@@ -193 +194 @@
     if (!TestUtil.getSilent())
     {
-      write("   \tID \tName      \tDescription");
-      write("-- \t-- \t--------- \t-----------");
+      write("   \tID \tName      \tHidden members\tDescription");
+      write("-- \t-- \t--------- \t--------------\t-----------");
     }
   }
@@ -200 +201 @@
     throws BaseException
   {
-    if (!TestUtil.getSilent()) System.out.println(i+":\t"+g.getId()+"\t"+g.getName()+"\t"+g.getDescription());
+    if (!TestUtil.getSilent()) 
+    {
+      System.out.println(i+":\t"+g.getId()+"\t"+g.getName()+"\t" + g.hasHiddenMembers() + 
+        "\t"+g.getDescription());
+    }
   }
   static void write_item(int i, User u)

trunk/www/admin/groups/edit_group.jsp

@@ -69 +69 @@
   boolean isEveryone = false;
   boolean isDefault = false;
+  boolean hiddenMembers = false;
   final QuotaType total = QuotaType.getById(dc, SystemItems.getId(QuotaType.TOTAL));
   Quota currentQuota = null;
@@ -94 +95 @@
     }
     isDefault = Values.getBoolean(cc.getPropertyValue("default"), false);
+    hiddenMembers = Values.getBoolean(cc.getPropertyValue("hiddenMembers"), false);
   }
   else
@@ -102 +104 @@
     isEveryone = Group.EVERYONE.equals(group.getSystemId());
     isDefault = group.isDefault();
+    hiddenMembers = group.hasHiddenMembers();
 
     try
@@ -271 +274 @@
           <input type="radio" name="is_default" value="0" <%=!isDefault ? "checked" : ""%>>no
           <input type="radio" name="is_default" value="1" <%=isDefault ? "checked" : ""%>>yes
+        </td>
+      </tr> 
+      <tr>
+        <td class="prompt">Hidden members</td>
+        <td>
+          <input type="radio" name="hidden_members" value="0" <%=!hiddenMembers ? "checked" : ""%>>no
+          <input type="radio" name="hidden_members" value="1" <%=hiddenMembers ? "checked" : ""%>>yes
         </td>
       </tr> 

trunk/www/admin/groups/index.jsp

@@ -173 +173 @@
     group.setDescription(Values.getStringOrNull(request.getParameter("description")));
     group.setDefault(Values.getBoolean(request.getParameter("is_default"), false));
+    group.setHiddenMembers(Values.getBoolean(request.getParameter("hidden_members"), false));
     int quotaId = Values.getInt(request.getParameter("quota_id"), -1);
     if (quotaId >= 0) // < 0 = denied or unchanged

trunk/www/admin/groups/list_groups.jsp

@@ -267 +267 @@
         datatype="boolean"
         title="Is default"
+        sortable="true" 
+        filterable="true"
+        exportable="true"
+      />
+      <tbl:columndef 
+        id="hiddenMembers"
+        property="hiddenMembers"
+        datatype="boolean"
+        title="Hidden members"
         sortable="true" 
         filterable="true"
@@ -456 +465 @@
                   /></tbl:cell>
                 <tbl:cell column="isDefault"><%=item.isDefault() ? "yes" : "no" %></tbl:cell>
+                <tbl:cell column="hiddenMembers"><%=item.hasHiddenMembers() ? "yes" : "no" %></tbl:cell>
                 <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>
                 <tbl:cell column="groups">

trunk/www/admin/groups/view_group.jsp

@@ -229 +229 @@
         <td class="prompt">Is default</td>
         <td><%=group.isDefault() ? "yes" : "no"%></td>
+      </tr>
+      <tr>
+        <td class="prompt">Hidden members</td>
+        <td><%=group.hasHiddenMembers() ? "yes" : "no"%></td>
       </tr>
       <tr>