Changeset 3480

Timestamp:

Jun 13, 2007, 12:39:31 PM (16 years ago)

Author:

Martin Svensson

Message:

References #426 Option to flag an import/export job to be removed, when finished successfully, is now implemented.
Need to be documented too....

Location:

trunk

Files:

• src/core/common-queries.xml (modified) (1 diff)
• src/core/net/sf/basedb/core/Install.java (modified) (1 diff)
• src/core/net/sf/basedb/core/Job.java (modified) (4 diffs)
• src/core/net/sf/basedb/core/Update.java (modified) (3 diffs)
• src/core/net/sf/basedb/core/data/JobData.java (modified) (1 diff)
• www/common/plugin/finish_job.jsp (modified) (4 diffs)
• www/common/plugin/index.jsp (modified) (1 diff)
• www/my_base/user/preferences.jsp (modified) (1 diff)
• www/my_base/user/submit_user.jsp (modified) (1 diff)

trunk/src/core/common-queries.xml

@@ -2580 +2580 @@
   </query>
   
+  <query id="SET_REMOVE_JOB_ON_JOBS" type="HQL">
+    <sql>
+      UPDATE JobData j
+      SET j.removeJobWhenFinished = false
+      WHERE j.removeJobWhenFinished IS NULL
+    </sql>
+    <description>
+      A HQL query that sets the deleteJobWhenFinished to false 
+      on all jobs with a null value.
+    </description>
+  </query>  
+  
   <query id="GET_INTERNAL_FILES_WITH_NO_LAST_UPDATE" type="HQL">
     <sql>

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

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

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

@@ -35 +35 @@
 import net.sf.basedb.core.plugin.Request;
 import net.sf.basedb.core.plugin.Response;
+import net.sf.basedb.core.plugin.Plugin.MainType;
 
 import java.util.Collection;
@@ -131 +132 @@
     jobData.setCreated(new Date());
     jobData.setSendMessage(true);
+    jobData.setRemoveJobWhenFinished(false);
     return j;
   }
@@ -379 +381 @@
     checkPermission(Permission.WRITE);
     getData().setSendMessage(sendMessage);
+  }
+  
+  /**
+    If the job should be deleted after it's done successfully
+  */
+  public boolean getRemoveJobWhenFinished()
+  {
+    return getData().getRemoveJobWhenFinished();
+  }
+  
+  /**
+    Set if the job should be deleted after it has finished successfully.
+    @throws PermissionDeniedException If the logged in user doesn't have 
+      write permission
+  */
+  public void setRemoveJobWhenFinished(boolean removeJobWhenFinished)
+  {
+    checkPermission(Permission.WRITE);
+    getData().setRemoveJobWhenFinished(removeJobWhenFinished);
   }
 
@@ -1208 +1229 @@
         {
           job.doneOk(response.getMessage());
+          PluginDefinition pd = null;
+          boolean isImportOrExport = false;
+          try
+          {
+            pd = job.getPluginDefinition();
+            MainType pluginMainType = pd.getMainType();
+            isImportOrExport = pluginMainType.equals(MainType.EXPORT) || (pluginMainType.equals(MainType.IMPORT));
+          }
+          catch(PermissionDeniedException pex)
+          {
+            isImportOrExport = false;
+          }
+          job.setRemoved(job.getRemoveJobWhenFinished() && isImportOrExport);
         }
         dc.commit();

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

@@ -385 +385 @@
       The update sets the <code>isDefault</code> value to false for all existing 
       groups and roles with a null value.
+    </td>
+  </tr>
+  
+  <tr>
+    <td>33</td>
+    <td>
+      <ul>
+      <li>Added {@link net.sf.basedb.core.data.JobData#getDeleteJobWhenFinished()}.
+      </ul>
+      The update sets the <code>deleteJobWhenFinished</code> value to false for all existing jobs.
     </td>
   </tr>
@@ -558 +568 @@
         schemaVersion = setSchemaVersionInTransaction(session, 32);
       }
-      
-      
+            
+      if (schemaVersion < 33)
+      {
+        if (progress != null) progress.display((int)(32*progress_factor), "--Updating schema version: " + schemaVersion + " -> 33...");        
+        schemaVersion = setSchemaVersionInTransaction(session, 33);
+      }
       /*
-      if (schemaVersion < 33)
-      {
-        if (progress != null) progress.display((int)(32*progress_factor), "--Updating schema version: " + schemaVersion + " -> 33...");
-        schemaVersion = setSchemaVersionInTransaction(session, 33);
+      if (schemaVersion < 34)
+      {
+        if (progress != null) progress.display((int)(33*progress_factor), "--Updating schema version: " + schemaVersion + " -> 34...");
+        schemaVersion = setSchemaVersionInTransaction(session, 34);
         - or - 
-        schemaVersion = updateToSchemaVersion33(session);
+        schemaVersion = updateToSchemaVersion34(session);
       }
       ... etc... 
@@ -1514 +1528 @@
         }
         
+        if (schemaVersion < 33)
+        {
+          // Set delete_job to false for jobs with null value
+          org.hibernate.Query query = HibernateUtil.getPredefinedQuery(session, 
+              "SET_REMOVE_JOB_ON_JOBS");
+          /*
+            UPDATE JobData j
+            SET j.removeJobWhenFinished = false
+            WHERE j.removeJobWhenFinished IS NULL
+          */
+          HibernateUtil.executeUpdate(query);
+        }
+        
         //  Commit the changes
         HibernateUtil.commit(tx);

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

@@ -157 +157 @@
   }
   
+  private boolean removeJobWhenFinished;
+  /**
+    If the core should delete the job when it's finished successfully.
+    @hibernate.property column="`remove_job`" type="boolean" not-null="true"
+  */
+  public boolean getRemoveJobWhenFinished()
+  {
+    return removeJobWhenFinished;
+  }
+  public void setRemoveJobWhenFinished(boolean removeJobWhenFinished)
+  {
+    this.removeJobWhenFinished = removeJobWhenFinished;
+  }
+  
   private int status;
   /**

trunk/www/common/plugin/finish_job.jsp

@@ -65 +65 @@
   PluginConfiguration pluginConfig = job.getPluginConfiguration(); // (PluginConfiguration)sc.getSessionSetting("plugin.configure.config");
   boolean sendMessage = Values.getBoolean(sc.getUserClientSetting("plugins.sendmessage"), true);
+  boolean removeJobWhenFinished = Values.getBoolean(sc.getUserClientSetting("plugins.removejob"), false);
   %>
   <base:page type="popup" title="Set job name and options">
@@ -93 +94 @@
         <td class="prompt">Plugin</td>
         <td><%=HTML.encodeTags(plugin.getName())%></td>
-        </td>
       </tr>
       <tr valign="top" id="configurations">
@@ -107 +107 @@
         </td>
       </tr>
-      <tr valign=top>
+      <tr valign="top">
         <td class="prompt">Job description</td>
         <td nowrap>
@@ -125 +125 @@
       </tr>
       
+      <tr>
+        <td class="prompt">Remove job</td>
+        <%
+        if (plugin.getMainType().equals(Plugin.MainType.EXPORT) || 
+            plugin.getMainType().equals(Plugin.MainType.IMPORT))
+        {
+          %>
+          <td>
+            <input type="checkbox" name="remove_job" value="1" <%=removeJobWhenFinished ? "checked" : "" %>>
+            <a href="javascript:document.forms['plugin'].remove_job.click();">Remove job when finished</a>
+          </td>
+          <%
+        }
+        else
+        {
+          %>
+          <td><i>- n/a -</i></td>
+          <%
+        }
+        %>
+      </tr>
+            
       </table>
       <div align=right>&nbsp;<i><base:icon image="required.gif" /> = required information</i></div>

trunk/www/common/plugin/index.jsp

@@ -475 +475 @@
     job.setDescription(Values.getStringOrNull(request.getParameter("description")));
     job.setSendMessage(Values.getBoolean(request.getParameter("send_message")));
+    job.setRemoveJobWhenFinished(Values.getBoolean(request.getParameter("remove_job")));
     dc.saveItem(job);
     if (pluginResponse != null) pluginResponse.saveParameters(dc);

trunk/www/my_base/user/preferences.jsp

@@ -431 +431 @@
       </td>
     </tr>
+    <tr>
+      <td class="prompt">Remove jobs</td>     
+      <td>
+        <%
+        boolean removeJobWhenFinished = Values.getBoolean(sc.getUserClientSetting("plugins.removejob"), false);
+        %>
+        <input type="checkbox" name="removejob" value="1" <%=removeJobWhenFinished ? "checked" : "" %>>
+        <a href="javascript:document.forms['preferences'].removejob.click();">Remove import and export jobs when they are finished.</a>
+      </td>
+    </tr>
     </table>
   </t:tab>

trunk/www/my_base/user/submit_user.jsp

@@ -131 +131 @@
     
     sc.setUserClientSetting("plugins.sendmessage", Values.getString(request.getParameter("sendmessage"), "0"));
+    sc.setUserClientSetting("plugins.removejob", Values.getString(request.getParameter("removejob"), "0"));
     String[] mostRecent = request.getParameterValues("enabled");
     sc.setUserClientSetting("menu.mostRecent",