Changeset 2929

Timestamp:

Nov 17, 2006, 9:36:17 AM (16 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #298: Add administrator page for viewing disk usage statistics

Location:

trunk

Files:

• src/core/common-queries.xml (modified) (2 diffs)
• src/core/net/sf/basedb/core/DbControl.java (modified) (1 diff)
• src/core/net/sf/basedb/core/DiskUsage.java (modified) (4 diffs)
• src/core/net/sf/basedb/core/Install.java (modified) (1 diff)
• src/core/net/sf/basedb/core/Metadata.java (modified) (4 diffs)
• src/core/net/sf/basedb/core/Update.java (modified) (4 diffs)
• src/core/net/sf/basedb/core/data/DiskUsageData.java (modified) (1 diff)
• www/admin/diskusage/details (added)
• www/admin/diskusage/details/index.jsp (added)
• www/admin/diskusage/details/view_details.jsp (added)
• www/admin/diskusage/index.jsp (modified) (4 diffs)
• www/admin/diskusage/list_groups.jsp (added)
• www/admin/diskusage/list_users.jsp (added)
• www/admin/diskusage/overview.jsp (modified) (1 diff)

trunk/src/core/common-queries.xml

@@ -451 +451 @@
   </query>
   
+  <query id="GET_DISKCONSUMABLE_ITEMS_FOR_USER" type="HQL">
+    <sql>
+      SELECT o
+      FROM net.sf.basedb.core.data.DiskConsumableData o
+      WHERE o.owner = :user
+    </sql>
+    <description>
+      Get all diskconsumable items that are owned by the specified user.
+    </description>
+  </query>
+
+  
   <query id="LOAD_USER_CLIENT_SETTINGS" type="HQL">
     <sql>
@@ -2431 +2443 @@
   </query>
 
+  <query id="SET_ITEMTYPE_ON_DISKUSAGE" type="HQL">
+    <sql>
+      UPDATE DiskUsageData du
+      SET du.itemType = :itemType
+      WHERE du.id IN (:itemList)
+      AND du.itemType IS NULL
+    </sql>
+    <description>
+      A HQL query that sets the item type for disk usage items.
+    </description>
+  </query>
+
+  <query id="LOAD_DISKUSAGEID_FOR_FILES" type="HQL">
+    <sql>
+      SELECT f.diskUsage.id 
+      FROM FileData f
+    </sql>
+    <description>
+      A HQL query that loads the disk usage ID for all files.
+    </description>
+  </query>
+  
+  <query id="LOAD_DISKUSAGEID_FOR_EXPERIMENTS" type="HQL">
+    <sql>
+      SELECT xp.diskUsage.id 
+      FROM ExperimentData xp
+    </sql>
+    <description>
+      A HQL query that loads the disk usage ID for all experiments.
+    </description>
+  </query>
+  
+  <query id="LOAD_DISKUSAGEID_FOR_RAWBIOASSAYS" type="HQL">
+    <sql>
+      SELECT rba.diskUsage.id 
+      FROM RawBioAssayData rba
+    </sql>
+    <description>
+      A HQL query that loads the disk usage ID for all raw bioassays.
+    </description>
+  </query>
+
 </predefined-queries>

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

@@ -520 +520 @@
     
     // Update the disk usage information
+    currentDiskUsage.setItemType(dcItem.getType().getValue());
     currentDiskUsage.setBytes(bytes);
     currentDiskUsage.setLocation(location.getValue());

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

@@ -60 +60 @@
       the logged in user has generic READ permission for disk usage in which case
       all items will be returned
+    @param group The group to retrieve the disk usage for
     @return An {@link ItemQuery} object
   */
-  public static ItemQuery<DiskUsage> getQuery(User user)
+  public static ItemQuery<DiskUsage> getQuery(User user, Group group)
   {
     ItemQuery<DiskUsage> query = null;
@@ -79 +80 @@
       query = new ItemQuery<DiskUsage>(DiskUsage.class);
     }
+    if (group != null)
+    {
+      query.restrictPermanent(
+        Restrictions.eq(
+          Hql.property("group"), 
+          Hql.entity(group)
+        )
+      );
+    }
     return query;
   }
@@ -86 +96 @@
     return new DiskUsageStatistics(dc);
   }
+  
+    
+  /**
+    The item this diks usage information belongs to.
+  */
+  private DiskConsumable item;
   
   /**
@@ -146 +162 @@
   }
   // -------------------------------------------
+  
+  
+  /**
+    Get the item this disk usage holds information for
+    @return The <code>DiskConsumable</code> item
+    @throws PermissionDeniedException If the logged in user doesn't have 
+      read permission to the item
+    @throws BaseException If there is another error
+    @since 2.2
+  */
+  public DiskConsumable getItem()
+    throws PermissionDeniedException, BaseException
+  {
+    if (item == null)
+    { 
+      Item type = getItemType();
+      DbControl dc = getDbControl();
+      String hql = "SELECT item"+
+        " FROM "+type.getDataClass().getName()+" item"+
+        " WHERE item.diskUsage = :diskUsage";
+      org.hibernate.Query query = HibernateUtil.createQuery(dc.getHibernateSession(), hql);
+      query.setEntity("diskUsage", this.getData());
+      item = (DiskConsumable)dc.getItem(type.getItemClass(), HibernateUtil.loadData(type.getDataClass(), query));
+    }
+    return item;
+  }
+
+  /**
+    Get the {@link Item} type of the item this annotation set belongs to.
+    @since 2.2
+  */
+  public Item getItemType()
+  {
+    return Item.fromValue(getData().getItemType());
+  }
+
   
   /**

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

@@ -102 +102 @@
     method.
   */
-  public static final int NEW_SCHEMA_VERSION = 24;
+  public static final int NEW_SCHEMA_VERSION = 25;
 
   public static synchronized void createTables(boolean update, final ProgressReporter progress)

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

@@ -52 +52 @@
   private static Set<Item> removableItems;
   private static Set<Item> ownableItems;
+  private static Set<Item> diskConsumableItems;
 
   private static boolean isInitialised = false;
@@ -62 +63 @@
     removableItems = Collections.unmodifiableSet(getImplementingItems(Removable.class));
     ownableItems = Collections.unmodifiableSet(getImplementingItems(Ownable.class));
+    diskConsumableItems = Collections.unmodifiableSet(getImplementingItems(DiskConsumable.class));
     isInitialised = true;
   }
@@ -74 +76 @@
     shareableItems = null;
     removableItems = null;
+    ownableItems = null;
+    diskConsumableItems = null;
   }
 
@@ -157 +161 @@
   }
   
+  /**
+    Get a set containing all {@link DiskConsumable} item types. 
+    The set cannot be modified.
+  */
+  public static Set<Item> getDiskConsumableItems()
+  {
+    return diskConsumableItems;
+  }
+
   /**
     Cache of Metadata instances. Only one instance for each type

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

@@ -296 +296 @@
       <li>File parameters are stored as item parameters. The update will
         move existing file parameter into the ItemValues table.
+      </ul>
+    </td>
+  </tr>
+
+  <tr>
+    <td>25</td>
+    <td>
+      <ul>
+      <li>Added {@link net.sf.basedb.core.data.DiskUsageData#getItemType()}.
+        The update will first set all null values to the correct item type
+        by checking the diskconsumable items.
       </ul>
     </td>
@@ -425 +436 @@
         "--NOTE! The \"FileValues\" table is no longer used by BASE. It may be removed from the database.");
       }
+      
+      if (schemaVersion < 25)
+      {
+        if (progress != null) progress.display((int)(24*progress_factor), "--Updating schema version: " + schemaVersion + " -> 25...");
+        schemaVersion = updateToSchemaVersion25(session);
+      }
 
       /*
-      if (schemaVersion < 25)
-      {
-        if (progress != null) progress.display((int)(24*progress_factor), "--Updating schema version: " + schemaVersion + " -> 25...");
-        schemaVersion = setSchemaVersionInTransaction(session, 25);
+      if (schemaVersion < 26)
+      {
+        if (progress != null) progress.display((int)(25*progress_factor), "--Updating schema version: " + schemaVersion + " -> 26...");
+        schemaVersion = setSchemaVersionInTransaction(session, 26);
         - or - 
-        schemaVersion = updateToSchemaVersion25(session);
+        schemaVersion = updateToSchemaVersion26(session);
       }
       ... etc... 
@@ -843 +860 @@
       // Commit the changes
       HibernateUtil.commit(tx);
-      log.info("updateToSchemaVersion2: OK");
+      log.info("updateToSchemaVersion24: OK");
     }
     catch (BaseException ex)
@@ -854 +871 @@
   }
 
-
-  
+  /**
+    Set the itemType property on all DiskUsageData items.
+    @return The new schema version (=25)
+  */
+  private static int updateToSchemaVersion25(org.hibernate.Session session)
+    throws BaseException
+  {
+    final int schemaVersion = 25;
+    org.hibernate.Transaction tx = null;
+    try
+    {
+      tx = HibernateUtil.newTransaction(session);
+
+      // Query for setting the item type
+      org.hibernate.Query duQuery = HibernateUtil.getPredefinedQuery(session, 
+        "SET_ITEMTYPE_ON_DISKUSAGE");
+      /*
+        UPDATE DiskUsageData du
+        SET du.itemType = :itemType
+        WHERE du.id IN (:itemList)
+      */
+      
+      // Files
+      org.hibernate.Query query = HibernateUtil.getPredefinedQuery(session, 
+        "LOAD_DISKUSAGEID_FOR_FILES");
+      /**
+        SELECT f.diskUsage.id 
+        FROM FileData f
+      */
+      List<Integer> ids = HibernateUtil.loadList(Integer.class, query);
+      if (ids.size() > 0)
+      {
+        duQuery.setParameter("itemType", Item.FILE.getValue(), org.hibernate.Hibernate.INTEGER);
+        duQuery.setParameterList("itemList", ids, org.hibernate.Hibernate.INTEGER);
+        HibernateUtil.executeUpdate(duQuery);
+      }
+      
+      // Experiments
+      query = HibernateUtil.getPredefinedQuery(session, 
+        "LOAD_DISKUSAGEID_FOR_EXPERIMENTS");
+      /**
+        SELECT xp.diskUsage.id 
+        FROM ExperimentData xp
+      */
+      ids = HibernateUtil.loadList(Integer.class, query);
+      if (ids.size() > 0)
+      {
+        duQuery.setParameter("itemType", Item.EXPERIMENT.getValue(), org.hibernate.Hibernate.INTEGER);
+        duQuery.setParameterList("itemList", ids, org.hibernate.Hibernate.INTEGER);
+        HibernateUtil.executeUpdate(duQuery);
+      }
+
+      // Raw bioassays
+      query = HibernateUtil.getPredefinedQuery(session, 
+        "LOAD_DISKUSAGEID_FOR_RAWBIOASSAYS");
+      /**
+        SELECT rba.diskUsage.id 
+        FROM RawBioAssayData rba
+      */
+      ids = HibernateUtil.loadList(Integer.class, query);
+      if (ids.size() > 0)
+      {
+        duQuery.setParameter("itemType", Item.RAWBIOASSAY.getValue(), org.hibernate.Hibernate.INTEGER);
+        duQuery.setParameterList("itemList", ids, org.hibernate.Hibernate.INTEGER);
+        HibernateUtil.executeUpdate(duQuery);
+      }
+      
+      // Update the shcema version number
+      setSchemaVersion(session, schemaVersion);
+  
+      // Commit the changes
+      HibernateUtil.commit(tx);
+      log.info("updateToSchemaVersion25: OK");
+    }
+    catch (BaseException ex)
+    {
+      if (tx != null) HibernateUtil.rollback(tx); 
+      log.error("updateToSchemaVersion25: FAILED", ex);
+      throw ex;
+    }
+    return schemaVersion;
+  }
+
+
   /**
     Adjust the existing items in the database to be compatible with the latest mappings.

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

@@ -45 +45 @@
   public DiskUsageData()
   {}
+  
+  private int itemType;
+  /**
+    Get the item type this annotation set is associated with.
+    @hibernate.property column="`item_type`" type="int" not-null="true" update="false"
+    @since 2.2
+  */
+  public int getItemType()
+  {
+    return itemType;
+  }
+  public void setItemType(int itemType)
+  {
+    this.itemType = itemType;
+  }
   
   private int location;

trunk/www/admin/diskusage/index.jsp

@@ -48 +48 @@
 String subContext = request.getParameter("subcontext");
 final String overviewPage = "overview.jsp?ID="+ID;
-final String userPage = "list_users.jsp?ID="+ID;
-final String groupPage = "list_groups.jsp?ID="+ID;
+final String listUsersPage = "list_users.jsp?ID="+ID;
+final String listGroupsPage = "list_groups.jsp?ID="+ID;
+final String viewUserPage = "view_user.jsp?ID="+ID;
+final String viewGroupPage = "view_group.jsp?ID="+ID;
 
 String forward = null;
@@ -64 +66 @@
     redirect = overviewPage;
   }
-  else if ("PerUser".equals(cmd))
+  else if ("ListUsers".equals(cmd))
   {
     Base.getAndSetCurrentContext(sc, itemType, "perUser", null, defaultContext, true);
-    redirect = userPage;
+    redirect = listUsersPage;
   }
-  else if ("PerGroup".equals(cmd))
+  else if ("ListGroups".equals(cmd))
   {
     Base.getAndSetCurrentContext(sc, itemType, "perGroup", null, defaultContext, true);
-    redirect = groupPage;
+    redirect = listGroupsPage;
   }
-
   else if ("UpdateContext".equals(cmd))
   {
@@ -81 +82 @@
     String ss = request.getParameter("showStatistics");
     if (ss != null) cc.setSetting("showStatistics", ss);
-    redirect = "perUser".equals(subContext) ? userPage : "perGroup".equals(subContext) ? groupPage : overviewPage;
+    redirect = "perUser".equals(subContext) ? listUsersPage : "perGroup".equals(subContext) ? listGroupsPage : overviewPage;
   }
   else if ("LoadContext".equals(cmd))
@@ -88 +89 @@
     int contextId = Values.getInt(request.getParameter("context"));
     Base.loadContext(sc, contextId, defaultContext);
-    redirect = "perUser".equals(subContext) ? userPage : "perGroup".equals(subContext) ? groupPage : overviewPage;
+    redirect = "perUser".equals(subContext) ? listUsersPage : "perGroup".equals(subContext) ? listGroupsPage : overviewPage;
+  }
+  else if ("ViewUser".equals(cmd))
+  {
+    // Display the view page for a single item 
+    ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, "perUser", pageContext, defaultContext);
+    forward = viewUserPage;
+  }
+  else if ("ViewGroup".equals(cmd))
+  {
+    // Display the view page for a single item 
+    ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, "perGroup", pageContext, defaultContext);
+    forward = viewGroupPage;
   }
   else

trunk/www/admin/diskusage/overview.jsp

@@ -80 +80 @@
       if (tabId == 'users')
       {
-        location.href = 'index.jsp?ID=<%=ID%>&cmd=PerUser';
+        location.href = 'index.jsp?ID=<%=ID%>&cmd=ListUsers';
       }
       else if (tabId == 'groups')
       {
-        location.href = 'index.jsp?ID=<%=ID%>&cmd=PerGroup';
+        location.href = 'index.jsp?ID=<%=ID%>&cmd=ListGroups';
       }
       else