interceptor concept introduced: entity adapter fields referenced in a
[mir.git] / source / mircoders / localizer / basic / MirBasicProducerLocalizer.java
index ead78d6..16aee46 100755 (executable)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2001, 2002  The Mir-coders group
+ * Copyright (C) 2001, 2002 The Mir-coders group
  *
  * This file is part of Mir.
  *
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  * In addition, as a special exception, The Mir-coders gives permission to link
- * the code of this program with the com.oreilly.servlet library, any library
- * licensed under the Apache Software License, The Sun (tm) Java Advanced
- * Imaging library (JAI), The Sun JIMI library (or with modified versions of
- * the above that use the same license as the above), and distribute linked
- * combinations including the two.  You must obey the GNU General Public
- * License in all respects for all of the code used other than the above
- * mentioned libraries.  If you modify this file, you may extend this exception
- * to your version of the file, but you are not obligated to do so.  If you do
- * not wish to do so, delete this exception statement from your version.
+ * the code of this program with  any library licensed under the Apache Software License,
+ * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
+ * (or with modified versions of the above that use the same license as the above),
+ * and distribute linked combinations including the two.  You must obey the
+ * GNU General Public License in all respects for all of the code used other than
+ * the above mentioned libraries.  If you modify this file, you may extend this
+ * exception to your version of the file, but you are not obligated to do so.
+ * If you do not wish to do so, delete this exception statement from your version.
  */
-
 package mircoders.localizer.basic;
 
-import java.util.*;
-import java.io.*;
-import mir.producer.*;
-import mir.generator.*;
-import mir.producer.reader.*;
-import mir.misc.*;
-import mir.util.*;
-import mir.entity.adapter.*;
-import mircoders.global.*;
-import mircoders.global.*;
-import mircoders.localizer.*;
-import mircoders.producer.reader.*;
-import mircoders.producer.*;
+import java.io.File;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
+import mir.entity.adapter.EntityAdapterModel;
+import mir.generator.Generator;
+import mir.generator.WriterEngine;
+import mir.log.LoggerWrapper;
+import mir.producer.reader.DefaultProducerNodeBuilders;
+import mir.producer.reader.ProducerConfigReader;
+import mir.producer.reader.ProducerNodeBuilderLibrary;
+import mir.util.StringRoutines;
+import mircoders.global.MirGlobal;
+import mircoders.global.ProducerEngine;
+import mircoders.localizer.MirLocalizerExc;
+import mircoders.localizer.MirLocalizerFailure;
+import mircoders.localizer.MirProducerLocalizer;
+import mircoders.producer.reader.SupplementalProducerNodeBuilders;
 
 public class MirBasicProducerLocalizer implements MirProducerLocalizer {
-  private Map producerFactories;
-  protected FileMonitor fileMonitor;
+  private Map producerRecipes;
+  private List producerRecipeNames;
+
   protected EntityAdapterModel model;
-  protected Generator.GeneratorLibrary generatorLibrary;
+  protected Generator.Library generatorLibrary;
   protected WriterEngine writerEngine;
 
-  protected static Logfile logger = Logfile.getInstance( MirGlobal.getConfigProperty("Home") + "/" + MirGlobal.getConfigProperty("Mir.Localizer.Logfile"));
+  protected LoggerWrapper logger;
 
   public MirBasicProducerLocalizer() {
-
     try {
-      producerFactories = new HashMap();
+      logger = new LoggerWrapper("Localizer.Basic.Producer");
+
+      producerRecipes = new HashMap();
+      producerRecipeNames = new ArrayList();
+
+      String[] recipes = MirGlobal.config().getStringArray("Mir.Localizer.Producer.ProducerRecipes");
+      for (int i = 0; i<recipes.length; i++) {
+        try {
+          List parts = StringRoutines.separateString(recipes[i], "=");
+          if (parts.size() == 2) {
+            String key = ((String) parts.get(0)).trim();
+            producerRecipes.put(key, ProducerEngine.ProducerTask.parseProducerTaskList(
+                ((String) parts.get(1)).trim()));
+            producerRecipeNames.add(key);
+          }
+          else {
+            throw new Exception("'=' expected");
+          }
+        }
+        catch (Throwable t) {
+          logger.error("Error while processing producer recipe '" + recipes[i] + "': " + t.toString());
+        }
+      }
+
+      // for backward compatibility:
+      String allNewProducers = MirGlobal.config().getString("Mir.Localizer.Producer.AllNewProducers");
+      if (allNewProducers!=null && allNewProducers.length()>0) {
+        producerRecipes.put("allnew", ProducerEngine.ProducerTask.parseProducerTaskList(allNewProducers));
+
+        if (!producerRecipeNames.contains("allnew")) {
+          producerRecipeNames.add("allnew");
+        }
+      }
+
       model = MirGlobal.localizer().dataModel().adapterModel();
-      generatorLibrary = MirGlobal.localizer().generators().makeGeneratorLibrary();
+      generatorLibrary = MirGlobal.localizer().generators().makeProducerGeneratorLibrary();
       writerEngine = MirGlobal.localizer().generators().makeWriterEngine();
     }
     catch (Throwable t) {
-      logger.printError("MirBasicProducerLocalizer(): Exception "+t.getMessage());
+      logger.error("MirBasicProducerLocalizer(): Exception "+t.getMessage());
       model = new EntityAdapterModel();
     }
   }
 
-  public Map factories() throws MirLocalizerException {
-    if (fileMonitor==null || producerFactories == null || fileMonitor.hasChanged()) {
-      try {
-        Map newProducers = new HashMap();
-        FileMonitor newFileMonitor = new FileMonitor();
-        setupFactories(newProducers, newFileMonitor);
-
-        producerFactories = newProducers;
-        fileMonitor = newFileMonitor;
-      }
-      catch (Throwable t) {
-        logger.printError("MirBasicProducerLocalizer.factories(): Unable to setup factories: "+t.getMessage());
-      }
-    }
-
-    return producerFactories;
-  };
-
-  protected void setupContentFactory(CompositeProducerNode aProducerNode) {
+  public List getRecipeNames() throws MirLocalizerExc, MirLocalizerFailure {
+    return producerRecipeNames;
   }
 
-  protected void setupStartPageFactory(CompositeProducerNode aProducerNode) {
-  }
+  public void produceRecipe(String aName) throws MirLocalizerExc, MirLocalizerFailure {
+    if (producerRecipes.containsKey(aName)) {
+      Iterator i = ((List) producerRecipes.get(aName)).iterator();
 
-  protected void setupSynchronizationFactory(CompositeProducerNode aProducerNode) {
-    if(MirGlobal.getConfigBooleanProperty("Rsync")){
-      aProducerNode.addSubNode(
-        new ScriptCallingProducerNode(MirGlobal.getConfigProperty("Rsync.Script.Path"))
-      );
-    }
-  }
+      while (i.hasNext()) {
+        ProducerEngine.ProducerTask task = (ProducerEngine.ProducerTask) i.next();
 
-  protected void setupStaticFactory(CompositeProducerNode aProducerNode) {
+        try {
+          MirGlobal.getProducerEngine().addTask(task);
+        }
+        catch (Throwable t) {
+          logger.error("Error recipe "+aName+" tasks "+
+              task.getProducer()+"::"+task.getVerb()+": " + t.toString());
+        }
+      }
+    }
+    else
+      throw new MirLocalizerExc("Unknown recipe name: " + aName);
   }
 
-  protected void setupTopicsFactory(CompositeProducerNode aProducerNode) {
+  public void beforeProducerTask(String aFactory, String aVerb) {
   }
 
-  protected void setupProducerNodeBuilderLibrary(ProducerNodeBuilderLibrary aLibrary) {
-    DefaultProducerNodeBuilders.registerBuilders(aLibrary, model, generatorLibrary, writerEngine);
-    SupplementalProducerNodeBuilders.registerBuilders(aLibrary, model);
+  public void afterProducerTask(String aFactory, String aVerb) {
   }
 
-  protected void setupFactories(Map aFactoriesMap, FileMonitor aFileMonitor) throws MirLocalizerException, MirLocalizerFailure {
-    ProducerConfigReader reader;
-    ProducerNodeBuilderLibrary library = new ProducerNodeBuilderLibrary();
-    setupProducerNodeBuilderLibrary(library);
-    List usedFiles = new Vector();
-
-    aFileMonitor.clear();
-    reader = new ProducerConfigReader();
-    reader.parseFile(MirGlobal.getConfigProperty("Home") + "/" + MirGlobal.getConfigProperty("Mir.Localizer.ProducerConfigFile"), library, aFactoriesMap, usedFiles);
-
-    Iterator i = usedFiles.iterator();
-    while (i.hasNext())
-      aFileMonitor.addFile((File) i.next());
-
-    setupFactories(aFactoriesMap);
+  /**
+   * Loads factories from a file with a {@link ProducerConfigReader}
+   */
+  public List loadFactories() throws MirLocalizerExc {
+      try {
+        List producers = new ArrayList();
+        ProducerConfigReader reader;
+        ProducerNodeBuilderLibrary library = new ProducerNodeBuilderLibrary();
+        setupProducerNodeBuilderLibrary(library);
+        reader = new ProducerConfigReader();
+        File inputFile =
+            MirGlobal.config().getFile("Mir.Localizer.ProducerConfigFile");
+        reader.parse(inputFile, library, producers);
+
+        logger.info("MirBasicProducerLocalizer.loadFactories(): successfully loaded factories");
+
+        return producers;
+      }
+      catch (Throwable t) {
+        logger.error("MirBasicProducerLocalizer.loadFactories(): Unable to load factories: "+
+            t.getMessage());
+        throw new MirLocalizerFailure(t);
+      }
   }
 
-  protected void setupFactories(Map aFactoriesMap ) throws MirLocalizerException, MirLocalizerFailure {
-    CompositeProducerNode node;
-
+  /**
+   * Sets up a {@link ProducerNodeBuilderLibrary} for use by the producer
+   * definition reader. Can be overridden by subclasses to tweak the standard
+   * library.
+   */
+  protected void setupProducerNodeBuilderLibrary(ProducerNodeBuilderLibrary aLibrary) throws MirLocalizerFailure {
     try {
-      node = new CompositeProducerNode();
-      setupContentFactory( node );
-      if (node.getNrSubNodes()>0)
-        aFactoriesMap.put("content", new NodedProducerFactory(node));
-
-      node = new CompositeProducerNode();
-      setupStartPageFactory( node );
-      if (node.getNrSubNodes()>0)
-        aFactoriesMap.put("startpage", new NodedProducerFactory(node));
-
-      node = new CompositeProducerNode();
-      setupSynchronizationFactory( node );
-      if (node.getNrSubNodes()>0)
-        aFactoriesMap.put("synchronization", new NodedProducerFactory(node));
-
-      node = new CompositeProducerNode();
-      setupStaticFactory( node );
-      if (node.getNrSubNodes()>0)
-        aFactoriesMap.put("static", new NodedProducerFactory(node));
-
-      node = new CompositeProducerNode();
-      setupTopicsFactory( node );
-      if (node.getNrSubNodes()>0)
-        aFactoriesMap.put("topics", new NodedProducerFactory(node));
-
-      aFactoriesMap.put("media",
-                   new CompositeProducerFactory( new ProducerFactory[] {
-                      new OldProducerAdapterFactory(new ProducerImages()),
-                      new OldProducerAdapterFactory(new ProducerAudio()),
-                      new OldProducerAdapterFactory(new ProducerVideo()),
-                      new OldProducerAdapterFactory(new ProducerOther())
-                  } )
-      );
+      DefaultProducerNodeBuilders.registerBuilders(
+          aLibrary, model, generatorLibrary, 
+          MirGlobal.localizer().producerAssistant().createGenerationInterceptor(),
+          writerEngine,
+          MirGlobal.config().getHome(),
+          MirGlobal.config().getFile("Producer.StorageRoot"));
+      SupplementalProducerNodeBuilders.registerBuilders(aLibrary, MirGlobal.config().getHome());
     }
-    catch (Exception e) {
-      throw new MirLocalizerFailure(e);
+    catch (Throwable t) {
+      throw new MirLocalizerFailure(t.getMessage(), t);
     }
-  };
+  }
+
 }