Changeset 4379

Timestamp:

Aug 5, 2008, 2:22:52 PM (14 years ago)

Author:

Nicklas Nordborg

Message:

References #1082: Make it possible to re-enter parameters for a failed job

Major changes are now in place. Need more testing to find non-working plug-ins and to cover all possible paths for a job.

Location:

trunk

Files:

• src/core/net/sf/basedb/core/Install.java (modified) (1 diff)
• src/core/net/sf/basedb/core/Job.java (modified) (3 diffs)
• src/core/net/sf/basedb/core/PluginRequest.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/PluginResponse.java (modified) (1 diff)
• src/core/net/sf/basedb/core/Update.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/data/JobData.java (modified) (1 diff)
• www/common/plugin/index.jsp (modified) (3 diffs)
• www/views/jobs/view_job.jsp (modified) (2 diffs)

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

@@ -107 +107 @@
     method.
   */
-  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(61).intValue();
+  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(62).intValue();
   
   public static synchronized void createTables(boolean update, final ProgressReporter progress)

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

@@ -683 +683 @@
     return getData().getServer();
   }
+  
+  /**
+    Checks if this job has saved information about the context that was active
+    when this job was created. If context information is available it is possible
+    to re-configure a failed job.
+    @see #configure(GuiContext)
+    @see #getLastGuiContext()
+    @return TRUE if context information is available, FALSE otherwise
+    @since 2.8
+  */
+  public boolean hasContext()
+  {
+    return getData().getContextItem() != null && getData().getContextType() != null;
+  }
+  
+  /**
+    Get the gui-context that was active when this job was created.
+    @return The active context, or null if not known
+    @since 2.8
+  */
+  public GuiContext getLastGuiContext()
+  {
+    GuiContext context = null;
+    if (hasContext())
+    {
+      context = new GuiContext(Item.fromValue(getData().getContextItem()), 
+          GuiContext.Type.fromValue(getData().getContextType()), getData().getSubContext());
+    }
+    return context;
+  }
+  
   
   /**
@@ -1590 +1621 @@
     {
       JobData data = job.getData();
-      data.setStatus(Status.WAITING.getValue());
+      data.setStatus(Job.Status.WAITING.getValue());
+      data.setPercentComplete(0);
+      data.setStarted(null);
+      data.setEnded(null);
+      data.setStatusMessage(null);
+      data.setStackTrace(null);
+      data.setServer(null);
+      data.setJobAgentId(null);
       data.setEstimatedExecutionTime(response.getEstimatedExecutionTime().getValue());
     }
@@ -1786 +1824 @@
 
     /**
+      The job is beeing prepared for execution.
+    */
+    PREPARED(5, "Preparing", true),
+
+    
+    /**
       The job is executing.
     */
     EXECUTING(2, "Executing", false),
-    
-    /**
-      The job has finished successfully.
-    */
-    DONE(3, "Done", false),
-
-    /**
-      The job has finished with an error.
-    */
-    ERROR(4, "Error", false),
-    
-    /**
-      The job is beeing prepared for execution.
-    */
-    PREPARED(5, "Preparing", true),
-    
+
     /**
       The {@link Signal#ABORT} signal has been sent to the
       job, but it has not yet responded.
     */
-    ABORTING(6, "Aborting", false);
-
+    ABORTING(6, "Aborting", false),
+    
+    /**
+      The job has finished successfully.
+    */
+    DONE(3, "Done", false),
+
+    /**
+      The job has finished with an error.
+    */
+    ERROR(4, "Error", false);
+    
     /**
       Maps the integer that is stored in the database.

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

@@ -26 +26 @@
 package net.sf.basedb.core;
 
+import net.sf.basedb.core.data.JobData;
 import net.sf.basedb.core.plugin.GuiContext;
 import net.sf.basedb.core.plugin.Plugin;
@@ -246 +247 @@
     Save all parameters that have got values in this request/response session.
   */
-  void saveParameters(DbControl dc)
+  void saveParameters(DbControl dc, GuiContext context)
   {
     if (jobParameters != null && !jobParameters.isWriteProtected() && job != null)
     {
       Job theJob = job.isInDatabase() ? Job.getById(dc, job.getId()) : job;
+      JobData jobData = theJob.getData();
+      if (pluginConfiguration != null)
+      {
+        jobData.setParameterVersion(pluginConfiguration.getParameterVersion());
+      }
+      if (context != null)
+      {
+        jobData.setContextItem(context.getItem().getValue());
+        jobData.setContextType(context.getType().getValue());
+        jobData.setSubContext(context.getSubContext());
+        
+      }
+      else
+      {
+        jobData.setContextItem(null);
+        jobData.setContextType(null);
+        jobData.setSubContext(null);
+      }
       jobParameters.saveParameters(theJob, parameterInfo);
     }

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

@@ -146 +146 @@
       throw new PermissionDeniedException("Can't save parameters since response status is: " + getStatus());
     }
-    request.saveParameters(dc);
+    request.saveParameters(dc, request.getGuiContext());
   }
   

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

@@ -699 +699 @@
     </td>
   </tr>
+  <tr>
+    <td>62</td>
+    <td>
+      Added:
+      <ul>
+      <li>{@link net.sf.basedb.core.data.JobData#getContextItem()}. 
+      <li>{@link net.sf.basedb.core.data.JobData#getContextType()}. 
+      <li>{@link net.sf.basedb.core.data.JobData#getSubContext()}. 
+      </ul>
+      No special database update is needed. Only increase the schema version.
+    </td>
+  </tr>
   
   </table>
@@ -982 +994 @@
       }
       
-      if (schemaVersion < 61)
-      {
-        if (progress != null) progress.display((int)(60*progress_factor), "--Updating schema version: " + schemaVersion + " -> 61...");
-        schemaVersion = setSchemaVersionInTransaction(session, 61);
+      if (schemaVersion < 62)
+      {
+        if (progress != null) progress.display((int)(61*progress_factor), "--Updating schema version: " + schemaVersion + " -> 62...");
+        schemaVersion = setSchemaVersionInTransaction(session, 62);
       }
       

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

@@ -383 +383 @@
   }
 
+  private Integer contextItem;
+  /**
+    The item type of the context that was active when configuring
+    this job. null = no context was known
+    @hibernate.property column="`context_item`" type="int"
+    @since 2.8
+  */
+  public Integer getContextItem()
+  {
+    return contextItem;
+  }
+  /**
+    @since 2.8
+  */
+  public void setContextItem(Integer contextItem)
+  {
+    this.contextItem = contextItem;
+  }
+  
+  private Integer contextType;
+  /**
+    The context type that was active when configuring
+    this job. 0 = single item, 1 = list
+    @hibernate.property column="`context_type`" type="int"
+    @since 2.8
+  */
+  public Integer getContextType()
+  {
+    return contextType;
+  }
+  /**
+    @since 2.8
+  */
+  public void setContextType(Integer contextType)
+  {
+    this.contextType = contextType;
+  }
+  
+  /**
+    The maximum allowed length of the subcontext name.
+    @since 2.8
+  */
+  public static final int MAX_SUBCONTEXT_LENGTH = 255;
+  private String subContext;
+  /**
+    The name of the subcontext that was active whjen configuring
+    this job.
+    @hibernate.property column="`subcontext`" type="string" length="255" not-null="false"
+    @since 2.8
+  */
+  public String getSubContext()
+  {
+    return subContext;
+  }
+  /**
+    @since 2.8
+  */
+  public void setSubContext(String subContext)
+  {
+    this.subContext = subContext;
+  }
+  
   /**
     The maximum allowed length of the signal transporter string.

trunk/www/common/plugin/index.jsp

@@ -326 +326 @@
     Job job = Job.getById(dc, jobId);
     
-    // TODO - This is not meaningful unless we can get a context
-    //int pluginDefinitionId = Values.getInt(request.getParameter("plugindefinition_id"));
-    //int pluginConfigurationId = Values.getInt(request.getParameter("pluginconfiguration_id"));
-    
     //Item itemType = Item.valueOf(request.getParameter("item_type"));
     //String subContext = Values.getString(request.getParameter("subcontext"), "");
     //GuiContext.Type contextType = GuiContext.Type.valueOf(request.getParameter("context_type"));
-    //GuiContext context = new GuiContext(itemType, contextType, subContext);
+    GuiContext context = job.getLastGuiContext();
     
     PluginDefinition plugin = job.getPluginDefinition();
     PluginConfiguration pluginConfig = job.getPluginConfiguration();
     
-    PluginConfigurationRequest pcRequest = job.configure(null);
+    PluginConfigurationRequest pcRequest = job.configure(context);
     sc.setSessionSetting("plugin.configure.request", pcRequest);
     sc.setSessionSetting("plugin.configure.job", job);
@@ -522 +518 @@
     dc = sc.newDbControl();
     Job job = (Job)sc.getSessionSetting("plugin.configure.job");
+    if (job.isInDatabase()) 
+    {
+      dc.reattachItem(job);
+    }
+    else
+    {
+      dc.saveItem(job);
+    }
+    
     PluginResponse pluginResponse = (PluginResponse)sc.getSessionSetting("plugin.configure.response");
     boolean executeImmediately =
@@ -530 +535 @@
     job.setSendMessage(Values.getBoolean(request.getParameter("send_message")));
     job.setRemoveJobWhenFinished(Values.getBoolean(request.getParameter("remove_job")));
-    dc.saveItem(job);
     
     if (!executeImmediately)

trunk/www/views/jobs/view_job.jsp

@@ -169 +169 @@
     location.href = 'index.jsp?ID=<%=ID%>&cmd=RestartJob&item_id=<%=itemId%>&useLatestConfiguration='+useLatestConfiguration;
   }
+  function reconfigureJob()
+  {
+    location.href = '../../common/plugin/index.jsp?ID=<%=ID%>&cmd=ConfigureJob&job_id=<%=itemId%>';
+  }
+  
     function deleteItemPermanently()
     {
@@ -526 +531 @@
       {
         %>
-        <base:button onclick="restartJob()" title="Restart job" image="refresh.gif" />
+        <base:button onclick="restartJob()" title="Restart job" 
+          image="refresh.gif" 
+          tooltip="Try to run this job again with the same parameters"
+        />
+        <base:button onclick="reconfigureJob()" title="Re-configure job"
+          image="runplugin.gif"
+          tooltip="Change the parameters for this job and try again"
+          visible="<%=job.hasContext()%>"
+        />
         <%
       }