source/mir/producer/ExecuteProgramProducerNode.java

   1 /*
   2  * Copyright (C) 2001, 2002 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License,
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30 package mir.producer;
  31
  32 import mir.log.LoggerWrapper;
  33 import mir.util.ParameterExpander;
  34
  35 import java.util.Map;
  36
  37 public class ExecuteProgramProducerNode extends AbstractProducerNode  {
  38   private String scriptExpression;
  39   private String maxDurationExpression;
  40   private String outputVariableExpression;
  41   private String returnValueVariableExpression;
  42
  43   public ExecuteProgramProducerNode(String aScriptExpression, String aMaxDurationExpression, String anOutputVariableExpression,
  44                                     String aReturnValueVariableExpression) {
  45     scriptExpression = aScriptExpression;
  46     maxDurationExpression = aMaxDurationExpression;
  47     outputVariableExpression = anOutputVariableExpression;
  48     returnValueVariableExpression = aReturnValueVariableExpression;
  49   }
  50
  51   public void produce(Map aValueMap, String aVerb, LoggerWrapper aLogger) throws ProducerFailure {
  52     String script;
  53     long maxDuration;
  54
  55     try {
  56       script = ParameterExpander.expandExpression(aValueMap, scriptExpression);
  57       maxDuration = ParameterExpander.evaluateIntegerExpressionWithDefault(aValueMap, maxDurationExpression, 0);
  58
  59       ProcessRunner runner = new ProcessRunner(aLogger, script);
  60       runner.start();
  61
  62       synchronized (runner) {
  63         runner.wait(maxDuration);
  64       }
  65       runner.interrupt();
  66
  67       if (runner.getFinished()) {
  68         aLogger.info(script + " terminated successfully, return value = " + runner.getReturnValue() + ".");
  69
  70         if (returnValueVariableExpression != null) {
  71           ParameterExpander.setValueForKey(aValueMap,
  72               ParameterExpander.expandExpression(aValueMap, returnValueVariableExpression),
  73               new Integer(runner.getReturnValue()));
  74         }
  75
  76       }
  77       else {
  78         aLogger.info(script + " interrupted prematurely after " + maxDuration + "ms.");
  79       }
  80     }
  81     catch (Throwable e) {
  82       aLogger.error("Error while executing " + scriptExpression + " : " + e.toString());
  83     }
  84   }
  85
  86   private static class ProcessRunner extends Thread {
  87     private String script;
  88     private boolean finished = false;
  89     private int returnValue = 0;
  90     private LoggerWrapper logger;
  91
  92     public ProcessRunner(LoggerWrapper aLogger, String aScript) {
  93       script = aScript;
  94       logger = aLogger;
  95     }
  96
  97     public boolean getFinished() {
  98       return finished;
  99     }
 100
 101     public int getReturnValue() {
 102       return returnValue;
 103     }
 104
 105     public void run() {
 106       Process process = null;
 107       try {
 108         process = Runtime.getRuntime().exec(script);
 109         returnValue = process.waitFor();
 110
 111         finished = true;
 112
 113         synchronized (this) {
 114           this.notify();
 115         }
 116       }
 117       catch (InterruptedException e) {
 118         if (process!=null) {
 119           process.destroy();
 120         }
 121       }
 122       catch (Exception e) {
 123         logger.error(script + " failed to execute: " + e.getMessage());
 124       }
 125     }
 126   }
 127
 128 }